2 Defines data types and constants introduced in UEFI.
4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __UEFI_BASETYPE_H__
16 #define __UEFI_BASETYPE_H__
21 // Basic data type definitions introduced in UEFI.
25 /// 128-bit buffer containing a unique identifier value.
27 typedef GUID EFI_GUID
;
29 /// Function return status for EFI API.
31 typedef RETURN_STATUS EFI_STATUS
;
33 /// A collection of related interfaces.
35 typedef VOID
*EFI_HANDLE
;
37 /// Handle to an event structure.
39 typedef VOID
*EFI_EVENT
;
41 /// Task priority level.
43 typedef UINTN EFI_TPL
;
45 /// Logical block address.
47 typedef UINT64 EFI_LBA
;
50 /// 64-bit physical memory address.
52 typedef UINT64 EFI_PHYSICAL_ADDRESS
;
55 /// 64-bit virtual memory address.
57 typedef UINT64 EFI_VIRTUAL_ADDRESS
;
60 /// EFI Time Abstraction:
67 /// Nanosecond: 0 - 999,999,999
68 /// TimeZone: -1440 to 1440 or 2047
86 /// 4-byte buffer. An IPv4 internet protocol address.
93 /// 16-byte buffer. An IPv6 internet protocol address.
100 /// 32-byte buffer containing a network Media Access Control address.
107 /// 16-byte buffer aligned on a 4-byte boundary.
108 /// An IPv4 or IPv6 internet protocol address.
118 /// Enumeration of EFI_STATUS.
120 #define EFI_SUCCESS RETURN_SUCCESS
121 #define EFI_LOAD_ERROR RETURN_LOAD_ERROR
122 #define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER
123 #define EFI_UNSUPPORTED RETURN_UNSUPPORTED
124 #define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE
125 #define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL
126 #define EFI_NOT_READY RETURN_NOT_READY
127 #define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR
128 #define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED
129 #define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES
130 #define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED
131 #define EFI_VOLUME_FULL RETURN_VOLUME_FULL
132 #define EFI_NO_MEDIA RETURN_NO_MEDIA
133 #define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED
134 #define EFI_NOT_FOUND RETURN_NOT_FOUND
135 #define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED
136 #define EFI_NO_RESPONSE RETURN_NO_RESPONSE
137 #define EFI_NO_MAPPING RETURN_NO_MAPPING
138 #define EFI_TIMEOUT RETURN_TIMEOUT
139 #define EFI_NOT_STARTED RETURN_NOT_STARTED
140 #define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED
141 #define EFI_ABORTED RETURN_ABORTED
142 #define EFI_ICMP_ERROR RETURN_ICMP_ERROR
143 #define EFI_TFTP_ERROR RETURN_TFTP_ERROR
144 #define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR
145 #define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION
146 #define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION
147 #define EFI_CRC_ERROR RETURN_CRC_ERROR
148 #define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA
149 #define EFI_END_OF_FILE RETURN_END_OF_FILE
150 #define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE
152 #define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
153 #define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
154 #define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
155 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
159 /// Define macro to encode the status code.
161 #define EFIERR(_a) ENCODE_ERROR(_a)
163 #define EFI_ERROR(A) RETURN_ERROR(A)
166 /// ICMP error definitions
168 #define EFI_NETWORK_UNREACHABLE EFIERR(100)
169 #define EFI_HOST_UNREACHABLE EFIERR(101)
170 #define EFI_PROTOCOL_UNREACHABLE EFIERR(102)
171 #define EFI_PORT_UNREACHABLE EFIERR(103)
175 /// Tcp connection status definitions
177 #define EFI_CONNECTION_FIN EFIERR(104)
178 #define EFI_CONNECTION_RESET EFIERR(105)
179 #define EFI_CONNECTION_REFUSED EFIERR(106)
183 // The EFI memory allocation functions work in units of EFI_PAGEs that are
184 // 4KB. This should in no way be confused with the page size of the processor.
185 // An EFI_PAGE is just the quanta of memory in EFI.
187 #define EFI_PAGE_SIZE SIZE_4KB
188 #define EFI_PAGE_MASK 0xFFF
189 #define EFI_PAGE_SHIFT 12
192 Macro that converts a size, in bytes, to a number of EFI_PAGESs.
194 @param Size A size in bytes. This parameter is assumed to be type UINTN.
195 Passing in a parameter that is larger than UINTN may produce
198 @return The number of EFI_PAGESs associated with the number of bytes specified
202 #define EFI_SIZE_TO_PAGES(Size) (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))
205 Macro that converts a number of EFI_PAGEs to a size in bytes.
207 @param Pages The number of EFI_PAGES. This parameter is assumed to be
208 type UINTN. Passing in a parameter that is larger than
209 UINTN may produce unexpected results.
211 @return The number of bytes associated with the number of EFI_PAGEs specified
215 #define EFI_PAGES_TO_SIZE(Pages) ((Pages) << EFI_PAGE_SHIFT)
218 /// PE32+ Machine type for IA32 UEFI images.
220 #define EFI_IMAGE_MACHINE_IA32 0x014C
223 /// PE32+ Machine type for IA64 UEFI images.
225 #define EFI_IMAGE_MACHINE_IA64 0x0200
228 /// PE32+ Machine type for EBC UEFI images.
230 #define EFI_IMAGE_MACHINE_EBC 0x0EBC
233 /// PE32+ Machine type for X64 UEFI images.
235 #define EFI_IMAGE_MACHINE_X64 0x8664
238 /// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.
240 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2
243 #if defined (MDE_CPU_IA32)
245 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
246 (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
248 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
250 #elif defined (MDE_CPU_IPF)
252 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
253 (((Machine) == EFI_IMAGE_MACHINE_IA64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
255 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
257 #elif defined (MDE_CPU_X64)
259 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
260 (((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
262 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
264 #elif defined (MDE_CPU_ARM)
266 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
267 (((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
269 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
271 #elif defined (MDE_CPU_EBC)
274 /// This is just to make sure you can cross compile with the EBC compiler.
275 /// It does not make sense to have a PE loader coded in EBC.
277 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
279 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
282 #error Unknown Processor Type