TianoCore EDK2 master
UefiBaseType.h
Go to the documentation of this file.
1
12#ifndef __UEFI_BASETYPE_H__
13#define __UEFI_BASETYPE_H__
14
15#include <Base.h>
16
17//
18// Basic data type definitions introduced in UEFI.
19//
20
24typedef GUID EFI_GUID;
28typedef RETURN_STATUS EFI_STATUS;
32typedef VOID *EFI_HANDLE;
36typedef VOID *EFI_EVENT;
40typedef UINTN EFI_TPL;
44typedef UINT64 EFI_LBA;
45
49typedef UINT64 EFI_PHYSICAL_ADDRESS;
50
54typedef UINT64 EFI_VIRTUAL_ADDRESS;
55
67typedef struct {
68 UINT16 Year;
69 UINT8 Month;
70 UINT8 Day;
71 UINT8 Hour;
72 UINT8 Minute;
73 UINT8 Second;
74 UINT8 Pad1;
75 UINT32 Nanosecond;
76 INT16 TimeZone;
77 UINT8 Daylight;
78 UINT8 Pad2;
79} EFI_TIME;
80
85
90
94typedef struct {
95 UINT8 Addr[32];
97
102typedef union {
103 UINT32 Addr[4];
107
111#define EFI_SUCCESS RETURN_SUCCESS
112#define EFI_LOAD_ERROR RETURN_LOAD_ERROR
113#define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER
114#define EFI_UNSUPPORTED RETURN_UNSUPPORTED
115#define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE
116#define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL
117#define EFI_NOT_READY RETURN_NOT_READY
118#define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR
119#define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED
120#define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES
121#define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED
122#define EFI_VOLUME_FULL RETURN_VOLUME_FULL
123#define EFI_NO_MEDIA RETURN_NO_MEDIA
124#define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED
125#define EFI_NOT_FOUND RETURN_NOT_FOUND
126#define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED
127#define EFI_NO_RESPONSE RETURN_NO_RESPONSE
128#define EFI_NO_MAPPING RETURN_NO_MAPPING
129#define EFI_TIMEOUT RETURN_TIMEOUT
130#define EFI_NOT_STARTED RETURN_NOT_STARTED
131#define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED
132#define EFI_ABORTED RETURN_ABORTED
133#define EFI_ICMP_ERROR RETURN_ICMP_ERROR
134#define EFI_TFTP_ERROR RETURN_TFTP_ERROR
135#define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR
136#define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION
137#define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION
138#define EFI_CRC_ERROR RETURN_CRC_ERROR
139#define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA
140#define EFI_END_OF_FILE RETURN_END_OF_FILE
141#define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE
142#define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA
143#define EFI_HTTP_ERROR RETURN_HTTP_ERROR
144
145#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
146#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
147#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
148#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
149#define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA
150#define EFI_WARN_FILE_SYSTEM RETURN_WARN_FILE_SYSTEM
152
156#define EFIERR(_a) ENCODE_ERROR(_a)
157
158#define EFI_ERROR(A) RETURN_ERROR(A)
159
163#define EFI_NETWORK_UNREACHABLE EFIERR(100)
164#define EFI_HOST_UNREACHABLE EFIERR(101)
165#define EFI_PROTOCOL_UNREACHABLE EFIERR(102)
166#define EFI_PORT_UNREACHABLE EFIERR(103)
168
172#define EFI_CONNECTION_FIN EFIERR(104)
173#define EFI_CONNECTION_RESET EFIERR(105)
174#define EFI_CONNECTION_REFUSED EFIERR(106)
176
177//
178// The EFI memory allocation functions work in units of EFI_PAGEs that are
179// 4KB. This should in no way be confused with the page size of the processor.
180// An EFI_PAGE is just the quanta of memory in EFI.
181//
182#define EFI_PAGE_SIZE SIZE_4KB
183#define EFI_PAGE_MASK 0xFFF
184#define EFI_PAGE_SHIFT 12
185
197#define EFI_SIZE_TO_PAGES(Size) (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))
198
210#define EFI_PAGES_TO_SIZE(Pages) ((Pages) << EFI_PAGE_SHIFT)
211
215#define EFI_IMAGE_MACHINE_IA32 0x014C
216
220#define EFI_IMAGE_MACHINE_IA64 0x0200
221
225#define EFI_IMAGE_MACHINE_EBC 0x0EBC
226
230#define EFI_IMAGE_MACHINE_X64 0x8664
231
235#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2
236
240#define EFI_IMAGE_MACHINE_AARCH64 0xAA64
241
245#define EFI_IMAGE_MACHINE_RISCV32 0x5032
246#define EFI_IMAGE_MACHINE_RISCV64 0x5064
247#define EFI_IMAGE_MACHINE_RISCV128 0x5128
248
249#if !defined (EFI_IMAGE_MACHINE_TYPE_VALUE) && !defined (EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
250 #if defined (MDE_CPU_IA32)
251
252#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
253 ((Machine) == EFI_IMAGE_MACHINE_IA32)
254
255#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
256
257 #elif defined (MDE_CPU_X64)
258
259#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
260 ((Machine) == EFI_IMAGE_MACHINE_X64)
261
262#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
263
264 #elif defined (MDE_CPU_ARM)
265
266#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
267
268#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
269
270 #elif defined (MDE_CPU_AARCH64)
271
272#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
273 ((Machine) == EFI_IMAGE_MACHINE_AARCH64)
274
275#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
276
277 #elif defined (MDE_CPU_RISCV64)
278#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
279 ((Machine) == EFI_IMAGE_MACHINE_RISCV64)
280
281#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
282
283 #elif defined (MDE_CPU_EBC)
284
289#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
290
291#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
292
293 #else
294 #error Unknown Processor Type
295 #endif
296#else
297 #if defined (EFI_IMAGE_MACHINE_TYPE_VALUE)
298#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_TYPE_VALUE)
299 #else
300#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) (FALSE)
301 #endif
302 #if defined (EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
303#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
304 #else
305#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
306 #endif
307#endif
308
309#endif
UINT64 UINTN
UINT64 EFI_PHYSICAL_ADDRESS
Definition: UefiBaseType.h:49
UINT64 EFI_LBA
Definition: UefiBaseType.h:44
UINT64 EFI_VIRTUAL_ADDRESS
Definition: UefiBaseType.h:54
IPv6_ADDRESS EFI_IPv6_ADDRESS
Definition: UefiBaseType.h:89
RETURN_STATUS EFI_STATUS
Definition: UefiBaseType.h:28
VOID * EFI_EVENT
Definition: UefiBaseType.h:36
UINTN EFI_TPL
Definition: UefiBaseType.h:40
GUID EFI_GUID
Definition: UefiBaseType.h:24
IPv4_ADDRESS EFI_IPv4_ADDRESS
Definition: UefiBaseType.h:84
VOID * EFI_HANDLE
Definition: UefiBaseType.h:32
Definition: Base.h:213