2 Defines data types and constants introduced in UEFI.
4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
5 Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR>
7 This program and the accompanying materials are licensed and made available under
8 the terms and conditions of the BSD License that accompanies this distribution.
9 The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef __UEFI_BASETYPE_H__
18 #define __UEFI_BASETYPE_H__
23 // Basic data type definitions introduced in UEFI.
27 /// 128-bit buffer containing a unique identifier value.
29 typedef GUID EFI_GUID
;
31 /// Function return status for EFI API.
33 typedef RETURN_STATUS EFI_STATUS
;
35 /// A collection of related interfaces.
37 typedef VOID
*EFI_HANDLE
;
39 /// Handle to an event structure.
41 typedef VOID
*EFI_EVENT
;
43 /// Task priority level.
45 typedef UINTN EFI_TPL
;
47 /// Logical block address.
49 typedef UINT64 EFI_LBA
;
52 /// 64-bit physical memory address.
54 typedef UINT64 EFI_PHYSICAL_ADDRESS
;
57 /// 64-bit virtual memory address.
59 typedef UINT64 EFI_VIRTUAL_ADDRESS
;
62 /// EFI Time Abstraction:
69 /// Nanosecond: 0 - 999,999,999
70 /// TimeZone: -1440 to 1440 or 2047
88 /// 4-byte buffer. An IPv4 internet protocol address.
95 /// 16-byte buffer. An IPv6 internet protocol address.
102 /// 32-byte buffer containing a network Media Access Control address.
109 /// 16-byte buffer aligned on a 4-byte boundary.
110 /// An IPv4 or IPv6 internet protocol address.
120 /// Enumeration of EFI_STATUS.
122 #define EFI_SUCCESS RETURN_SUCCESS
123 #define EFI_LOAD_ERROR RETURN_LOAD_ERROR
124 #define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER
125 #define EFI_UNSUPPORTED RETURN_UNSUPPORTED
126 #define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE
127 #define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL
128 #define EFI_NOT_READY RETURN_NOT_READY
129 #define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR
130 #define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED
131 #define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES
132 #define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED
133 #define EFI_VOLUME_FULL RETURN_VOLUME_FULL
134 #define EFI_NO_MEDIA RETURN_NO_MEDIA
135 #define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED
136 #define EFI_NOT_FOUND RETURN_NOT_FOUND
137 #define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED
138 #define EFI_NO_RESPONSE RETURN_NO_RESPONSE
139 #define EFI_NO_MAPPING RETURN_NO_MAPPING
140 #define EFI_TIMEOUT RETURN_TIMEOUT
141 #define EFI_NOT_STARTED RETURN_NOT_STARTED
142 #define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED
143 #define EFI_ABORTED RETURN_ABORTED
144 #define EFI_ICMP_ERROR RETURN_ICMP_ERROR
145 #define EFI_TFTP_ERROR RETURN_TFTP_ERROR
146 #define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR
147 #define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION
148 #define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION
149 #define EFI_CRC_ERROR RETURN_CRC_ERROR
150 #define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA
151 #define EFI_END_OF_FILE RETURN_END_OF_FILE
152 #define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE
153 #define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA
154 #define EFI_HTTP_ERROR RETURN_HTTP_ERROR
156 #define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
157 #define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
158 #define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
159 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
160 #define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA
164 /// Define macro to encode the status code.
166 #define EFIERR(_a) ENCODE_ERROR(_a)
168 #define EFI_ERROR(A) RETURN_ERROR(A)
171 /// ICMP error definitions
173 #define EFI_NETWORK_UNREACHABLE EFIERR(100)
174 #define EFI_HOST_UNREACHABLE EFIERR(101)
175 #define EFI_PROTOCOL_UNREACHABLE EFIERR(102)
176 #define EFI_PORT_UNREACHABLE EFIERR(103)
180 /// Tcp connection status definitions
182 #define EFI_CONNECTION_FIN EFIERR(104)
183 #define EFI_CONNECTION_RESET EFIERR(105)
184 #define EFI_CONNECTION_REFUSED EFIERR(106)
188 // The EFI memory allocation functions work in units of EFI_PAGEs that are
189 // 4KB. This should in no way be confused with the page size of the processor.
190 // An EFI_PAGE is just the quanta of memory in EFI.
192 #define EFI_PAGE_SIZE SIZE_4KB
193 #define EFI_PAGE_MASK 0xFFF
194 #define EFI_PAGE_SHIFT 12
197 Macro that converts a size, in bytes, to a number of EFI_PAGESs.
199 @param Size A size in bytes. This parameter is assumed to be type UINTN.
200 Passing in a parameter that is larger than UINTN may produce
203 @return The number of EFI_PAGESs associated with the number of bytes specified
207 #define EFI_SIZE_TO_PAGES(Size) (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))
210 Macro that converts a number of EFI_PAGEs to a size in bytes.
212 @param Pages The number of EFI_PAGES. This parameter is assumed to be
213 type UINTN. Passing in a parameter that is larger than
214 UINTN may produce unexpected results.
216 @return The number of bytes associated with the number of EFI_PAGEs specified
220 #define EFI_PAGES_TO_SIZE(Pages) ((Pages) << EFI_PAGE_SHIFT)
223 /// PE32+ Machine type for IA32 UEFI images.
225 #define EFI_IMAGE_MACHINE_IA32 0x014C
228 /// PE32+ Machine type for IA64 UEFI images.
230 #define EFI_IMAGE_MACHINE_IA64 0x0200
233 /// PE32+ Machine type for EBC UEFI images.
235 #define EFI_IMAGE_MACHINE_EBC 0x0EBC
238 /// PE32+ Machine type for X64 UEFI images.
240 #define EFI_IMAGE_MACHINE_X64 0x8664
243 /// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.
245 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2
248 /// PE32+ Machine type for AARCH64 A64 images.
250 #define EFI_IMAGE_MACHINE_AARCH64 0xAA64
253 #if defined (MDE_CPU_IA32)
255 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
256 (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
258 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
260 #elif defined (MDE_CPU_IPF)
262 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
263 (((Machine) == EFI_IMAGE_MACHINE_IA64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
265 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
267 #elif defined (MDE_CPU_X64)
269 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
270 (((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
272 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
274 #elif defined (MDE_CPU_ARM)
276 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
277 (((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
279 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
281 #elif defined (MDE_CPU_AARCH64)
283 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
284 (((Machine) == EFI_IMAGE_MACHINE_AARCH64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
286 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
288 #elif defined (MDE_CPU_EBC)
291 /// This is just to make sure you can cross compile with the EBC compiler.
292 /// It does not make sense to have a PE loader coded in EBC.
294 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
296 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
299 #error Unknown Processor Type