2 Defines data types and constants introduced in UEFI.
4 Copyright (c) 2006 - 2008, Intel Corporation<BR>
5 Portions Copyright (c) 2008-2009 Apple Inc.<BR>
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __UEFI_BASETYPE_H__
17 #define __UEFI_BASETYPE_H__
22 // Basic data type definitions introduced in UEFI.
26 /// 128-bit buffer containing a unique identifier value.
28 typedef GUID EFI_GUID
;
30 /// Function return status for EFI API
32 typedef RETURN_STATUS EFI_STATUS
;
34 /// A collection of related interfaces.
36 typedef VOID
*EFI_HANDLE
;
38 /// Handle to an event structure.
40 typedef VOID
*EFI_EVENT
;
42 /// Task priority level.
44 typedef UINTN EFI_TPL
;
46 /// Logical block address.
48 typedef UINT64 EFI_LBA
;
51 /// 64-bit physical memory address.
53 typedef UINT64 EFI_PHYSICAL_ADDRESS
;
56 /// 64-bit virtual memory address.
58 typedef UINT64 EFI_VIRTUAL_ADDRESS
;
61 /// EFI Time Abstraction:
68 /// Nanosecond: 0 - 999,999,999
69 /// TimeZone: -1440 to 1440 or 2047
87 /// 4-byte buffer. An IPv4 internet protocol address.
94 /// 16-byte buffer. An IPv6 internet protocol address
101 /// 32-byte buffer containing a network Media Access Control address.
108 /// 16-byte buffer aligned on a 4-byte boundary.
109 /// An IPv4 or IPv6 internet protocol address.
119 // Enumeration of EFI_STATUS.
121 #define EFI_SUCCESS RETURN_SUCCESS
122 #define EFI_LOAD_ERROR RETURN_LOAD_ERROR
123 #define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER
124 #define EFI_UNSUPPORTED RETURN_UNSUPPORTED
125 #define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE
126 #define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL
127 #define EFI_NOT_READY RETURN_NOT_READY
128 #define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR
129 #define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED
130 #define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES
131 #define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED
132 #define EFI_VOLUME_FULL RETURN_VOLUME_FULL
133 #define EFI_NO_MEDIA RETURN_NO_MEDIA
134 #define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED
135 #define EFI_NOT_FOUND RETURN_NOT_FOUND
136 #define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED
137 #define EFI_NO_RESPONSE RETURN_NO_RESPONSE
138 #define EFI_NO_MAPPING RETURN_NO_MAPPING
139 #define EFI_TIMEOUT RETURN_TIMEOUT
140 #define EFI_NOT_STARTED RETURN_NOT_STARTED
141 #define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED
142 #define EFI_ABORTED RETURN_ABORTED
143 #define EFI_ICMP_ERROR RETURN_ICMP_ERROR
144 #define EFI_TFTP_ERROR RETURN_TFTP_ERROR
145 #define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR
146 #define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION
147 #define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION
148 #define EFI_CRC_ERROR RETURN_CRC_ERROR
149 #define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA
150 #define EFI_END_OF_FILE RETURN_END_OF_FILE
151 #define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE
153 #define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
154 #define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
155 #define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
156 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
160 // Define macro to encode the status code.
162 #define EFIERR(_a) ENCODE_ERROR(_a)
164 #define EFI_ERROR(A) RETURN_ERROR(A)
169 // The EFI memory allocation functions work in units of EFI_PAGEs that are
170 // 4K. This should in no way be confused with the page size of the processor.
171 // An EFI_PAGE is just the quanta of memory in EFI.
173 #define EFI_PAGE_SIZE 0x1000
174 #define EFI_PAGE_MASK 0xFFF
175 #define EFI_PAGE_SHIFT 12
177 #define EFI_SIZE_TO_PAGES(a) (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))
179 #define EFI_PAGES_TO_SIZE(a) ( (a) << EFI_PAGE_SHIFT)
182 /// PE32+ Machine type for IA32 UEFI images
184 #define EFI_IMAGE_MACHINE_IA32 0x014C
187 /// PE32+ Machine type for IA64 UEFI images
189 #define EFI_IMAGE_MACHINE_IA64 0x0200
192 /// PE32+ Machine type for EBC UEFI images
194 #define EFI_IMAGE_MACHINE_EBC 0x0EBC
197 /// PE32+ Machine type for X64 UEFI images
199 #define EFI_IMAGE_MACHINE_X64 0x8664
202 /// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images
204 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2
207 #if defined (MDE_CPU_IA32)
209 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
210 (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
212 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
214 #elif defined (MDE_CPU_IPF)
216 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
217 (((Machine) == EFI_IMAGE_MACHINE_IA64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
219 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
221 #elif defined (MDE_CPU_X64)
223 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
224 (((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
226 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
228 #elif defined (MDE_CPU_ARM)
230 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
231 (((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
233 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
235 #elif defined (MDE_CPU_EBC)
238 /// This is just to make sure you can cross compile with the EBC compiler.
239 /// It does not make sense to have a PE loader coded in EBC. You need to
240 /// understand the basic.
242 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
244 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
247 #error Unknown Processor Type