summaryrefslogtreecommitdiff
path: root/Include/EdkIICommon.h
blob: 210692761644ba844f3a6872d88de1e2ed26ad40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2009, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093        **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************

//**********************************************************************
// $Header: /Alaska/SOURCE/Core/EdkIICompLib/EdkIICommon.h 2     5/13/11 5:50p Artems $
//
// $Revision: 2 $
//
// $Date: 5/13/11 5:50p $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Core/EdkIICompLib/EdkIICommon.h $
// 
// 2     5/13/11 5:50p Artems
// Renamed function EfiCompareGuid with native EdkII CompareGuid
// 
// 1     5/05/11 5:04p Artems
// EdkII compatibility library headers
// 
// 
//**********************************************************************
//<AMI_FHDR_START>
//
// Name:	<EdkIICommon.h>
//
// Description:	
//
//<AMI_FHDR_END>
//**********************************************************************
#ifndef __EDKII_COMMON__H__
#define __EDKII_COMMON__H__
#ifdef __cplusplus
extern "C" {
#endif

#include <Efi.h>
#include <Protocol/DevicePath.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextOut.h>

#ifndef END_DEVICE_PATH_TYPE
#define END_DEVICE_PATH_TYPE                 0x7f
#endif

#define END_ENTIRE_DEVICE_PATH_SUBTYPE       0xFF
#define EFI_DP_TYPE_MASK                     0x7F
#define EFI_DP_TYPE_UNPACKED                 0x80
#define END_INSTANCE_DEVICE_PATH_SUBTYPE     0x01

#define DevicePathType(a)           ( ((a)->Type) & EFI_DP_TYPE_MASK )
#define DevicePathSubType(a)        ( (a)->SubType )
#define DevicePathNodeLength(a)     ( ((a)->Length[0]) | ((a)->Length[1] << 8) )

#define IsDevicePathEndType(a)      ( DevicePathType(a) == END_DEVICE_PATH_TYPE )
#define IsDevicePathEndSubType(a)   ( (a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
#define IsDevicePathEnd(a)          ( IsDevicePathEndType(a) && IsDevicePathEndSubType(a) )
#define NextDevicePathNode(a)       ( (EFI_DEVICE_PATH_PROTOCOL *) ( ((UINT8 *) (a)) + DevicePathNodeLength(a)))

#define SIGNATURE_16(A,B)             ((A) | (B<<8))
#define SIGNATURE_32(A,B,C,D)         (SIGNATURE_16(A,B)     | (SIGNATURE_16(C,D)     << 16))
#define SIGNATURE_64(A,B,C,D,E,F,G,H) (SIGNATURE_32(A,B,C,D) | ((UINT64)(SIGNATURE_32(E,F,G,H)) << 32))

#define MIN(a,b)   (((a) < (b)) ? (a) : (b))
#define MAX(a,b)   (((a) > (b)) ? (a) : (b))

#define CHAR_NULL             0x0000
#define CHAR_BACKSPACE        0x0008
#define CHAR_TAB              0x0009
#define CHAR_LINEFEED         0x000A
#define CHAR_CARRIAGE_RETURN  0x000D

#define SCAN_NULL EFI_SCAN_NULL
#define SCAN_UP         EFI_SCAN_UP
#define SCAN_DOWN       EFI_SCAN_DN
#define SCAN_RIGHT      EFI_SCAN_RIGHT
#define SCAN_LEFT       EFI_SCAN_LEFT
#define SCAN_HOME       EFI_SCAN_HOME
#define SCAN_END        EFI_SCAN_END
#define SCAN_INSERT     EFI_SCAN_INS
#define SCAN_DELETE     EFI_SCAN_DEL
#define SCAN_PAGE_UP    EFI_SCAN_PGUP
#define SCAN_PAGE_DOWN  EFI_SCAN_PGDN
#define SCAN_F1         EFI_SCAN_F1
#define SCAN_F2         EFI_SCAN_F2
#define SCAN_F3         EFI_SCAN_F3
#define SCAN_F4         EFI_SCAN_F4
#define SCAN_F5         EFI_SCAN_F5
#define SCAN_F6         EFI_SCAN_F6
#define SCAN_F7         EFI_SCAN_F7
#define SCAN_F8         EFI_SCAN_F8
#define SCAN_F9         EFI_SCAN_F9
#define SCAN_F10        EFI_SCAN_F10
#define SCAN_F11        EFI_SCAN_F11
#define SCAN_F12        EFI_SCAN_F12
#define SCAN_ESC        EFI_SCAN_ESC


#define _EFI_INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))

#ifndef VA_START

typedef CHAR8 *VA_LIST;
#define VA_START(ap, v) (ap = (VA_LIST) & (v) + _EFI_INT_SIZE_OF (v))
#define VA_ARG(ap, t)   (*(t *) ((ap += _EFI_INT_SIZE_OF (t)) - _EFI_INT_SIZE_OF (t)))
#define VA_END(ap)      (ap = (VA_LIST) 0)

#endif


EFI_BOOT_SERVICES		*gBS;
EFI_RUNTIME_SERVICES	*gRT;
EFI_SYSTEM_TABLE        *gST;

INTN CompareMem(
    IN VOID  *DestinationBuffer,
    IN VOID  *SourceBuffer,
    IN UINTN Length
);


VOID* CopyMem (
    OUT VOID  *DestinationBuffer,
    IN  VOID  *SourceBuffer,
    IN UINTN  Length
);

VOID* SetMem16 (
    OUT VOID   *Buffer,
    IN UINTN   Length,
    IN UINT16  Value
);


BOOLEAN CompareGuid(
    IN EFI_GUID  *Guid1,
    IN EFI_GUID  *Guid2
);


VOID* AllocateCopyPool(
    IN UINTN       AllocationSize,
    IN CONST VOID  *Buffer
);

VOID* AllocateZeroPool(
    IN UINTN  AllocationSize
);

VOID* AllocateRuntimePool(
    IN UINTN  AllocationSize
);

VOID* AllocatePool(
    IN UINTN  AllocationSize
);

VOID* ReallocatePool (
    IN UINTN  OldSize,
    IN UINTN  NewSize,
    IN VOID   *OldBuffer  OPTIONAL
);

VOID FreePool(
    IN VOID   *Buffer
);

EFI_DEVICE_PATH_PROTOCOL* DevicePathFromHandle(
    IN EFI_HANDLE Handle
);

UINTN GetDevicePathSize(
    IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath
);

UINTN UnicodeSPrint (
    OUT CHAR16  *StartOfBuffer,
    IN  UINTN   BufferSize,
    IN  CHAR16  *FormatString,
    ...
);

UINTN UnicodeVSPrint (
    OUT CHAR16  *StartOfBuffer,
    IN  UINTN   BufferSize,
    IN  CHAR16  *FormatString,
    IN  VA_LIST Marker
);

EFI_STATUS EfiGetSystemConfigurationTable(
    IN  EFI_GUID  *TableGuid,
    OUT VOID      **Table
);


VOID* ZeroMem (
    OUT VOID  *Buffer,
    IN UINTN  Length
);


EFI_GUID* CopyGuid (
    OUT EFI_GUID  *DestinationGuid,
    IN  EFI_GUID  *SourceGuid
);

VOID InitEfiPointers(
    IN EFI_HANDLE        ImageHandle,
    IN EFI_SYSTEM_TABLE  *SystemTable
);

VOID
EFIAPI
CreatePopUp (
  IN  UINTN          Attribute,                
  OUT EFI_INPUT_KEY  *Key,      OPTIONAL
  ...
  );

UINTN StrLen (
  IN CHAR16              *String
);

INTN StrCmp (
  IN CHAR16 *FirstString,
  IN CHAR16 *SecondString
);

UINTN StrSize (
  IN CHAR16              *String
);

CHAR16* StrCpy (
    OUT CHAR16 *Destination,
    IN  CHAR16 *Source
);

CHAR16* StrCat (
    IN OUT  CHAR16 *Destination,
    IN      CHAR16 *Source
);

UINTN AsciiStrLen (
    IN CHAR8 *String
);

CHAR16* ConvertDeviceNodeToText (
    IN CONST EFI_DEVICE_PATH_PROTOCOL  *DeviceNode,
    IN BOOLEAN                         DisplayOnly,
    IN BOOLEAN                         AllowShortcuts
);

CHAR16* ConvertDevicePathToText (
    IN CONST EFI_DEVICE_PATH_PROTOCOL   *DevicePath,
    IN BOOLEAN                          DisplayOnly,
    IN BOOLEAN                          AllowShortcuts
);

VOID* GetEfiGlobalVariable (
    IN CHAR16 *Name
);

/****** DO NOT WRITE BELOW THIS LINE *******/
#ifdef __cplusplus
}
#endif
#endif
//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2009, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093        **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************