iPXE
UefiBaseType.h
Go to the documentation of this file.
1 /** @file
2  Defines data types and constants introduced in UEFI.
3 
4 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
5 Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR>
6 
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.
11 
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.
14 
15 **/
16 
17 #ifndef __UEFI_BASETYPE_H__
18 #define __UEFI_BASETYPE_H__
19 
20 FILE_LICENCE ( BSD3 );
21 
22 #include <ipxe/efi/Base.h>
23 
24 //
25 // Basic data type definitions introduced in UEFI.
26 //
27 
28 ///
29 /// 128-bit buffer containing a unique identifier value.
30 ///
31 typedef GUID EFI_GUID;
32 ///
33 /// Function return status for EFI API.
34 ///
36 ///
37 /// A collection of related interfaces.
38 ///
39 typedef VOID *EFI_HANDLE;
40 ///
41 /// Handle to an event structure.
42 ///
43 typedef VOID *EFI_EVENT;
44 ///
45 /// Task priority level.
46 ///
47 typedef UINTN EFI_TPL;
48 ///
49 /// Logical block address.
50 ///
51 typedef UINT64 EFI_LBA;
52 
53 ///
54 /// 64-bit physical memory address.
55 ///
57 
58 ///
59 /// 64-bit virtual memory address.
60 ///
62 
63 ///
64 /// EFI Time Abstraction:
65 /// Year: 1900 - 9999
66 /// Month: 1 - 12
67 /// Day: 1 - 31
68 /// Hour: 0 - 23
69 /// Minute: 0 - 59
70 /// Second: 0 - 59
71 /// Nanosecond: 0 - 999,999,999
72 /// TimeZone: -1440 to 1440 or 2047
73 ///
74 typedef struct {
86 } EFI_TIME;
87 
88 
89 ///
90 /// 4-byte buffer. An IPv4 internet protocol address.
91 ///
93 
94 ///
95 /// 16-byte buffer. An IPv6 internet protocol address.
96 ///
98 
99 ///
100 /// 32-byte buffer containing a network Media Access Control address.
101 ///
102 typedef struct {
103  UINT8 Addr[32];
105 
106 ///
107 /// 16-byte buffer aligned on a 4-byte boundary.
108 /// An IPv4 or IPv6 internet protocol address.
109 ///
110 typedef union {
111  UINT32 Addr[4];
115 
116 
117 ///
118 /// Enumeration of EFI_STATUS.
119 ///@{
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
151 #define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA
152 #define EFI_HTTP_ERROR RETURN_HTTP_ERROR
153 
154 #define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
155 #define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
156 #define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
157 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
158 #define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA
159 #define EFI_WARN_FILE_SYSTEM RETURN_WARN_FILE_SYSTEM
160 ///@}
161 
162 ///
163 /// Define macro to encode the status code.
164 ///
165 #define EFIERR(_a) ENCODE_ERROR(_a)
166 
167 #define EFI_ERROR(A) RETURN_ERROR(A)
168 
169 ///
170 /// ICMP error definitions
171 ///@{
172 #define EFI_NETWORK_UNREACHABLE EFIERR(100)
173 #define EFI_HOST_UNREACHABLE EFIERR(101)
174 #define EFI_PROTOCOL_UNREACHABLE EFIERR(102)
175 #define EFI_PORT_UNREACHABLE EFIERR(103)
176 ///@}
177 
178 ///
179 /// Tcp connection status definitions
180 ///@{
181 #define EFI_CONNECTION_FIN EFIERR(104)
182 #define EFI_CONNECTION_RESET EFIERR(105)
183 #define EFI_CONNECTION_REFUSED EFIERR(106)
184 ///@}
185 
186 //
187 // The EFI memory allocation functions work in units of EFI_PAGEs that are
188 // 4KB. This should in no way be confused with the page size of the processor.
189 // An EFI_PAGE is just the quanta of memory in EFI.
190 //
191 #define EFI_PAGE_SIZE SIZE_4KB
192 #define EFI_PAGE_MASK 0xFFF
193 #define EFI_PAGE_SHIFT 12
194 
195 /**
196  Macro that converts a size, in bytes, to a number of EFI_PAGESs.
197 
198  @param Size A size in bytes. This parameter is assumed to be type UINTN.
199  Passing in a parameter that is larger than UINTN may produce
200  unexpected results.
201 
202  @return The number of EFI_PAGESs associated with the number of bytes specified
203  by Size.
204 
205 **/
206 #define EFI_SIZE_TO_PAGES(Size) (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))
207 
208 /**
209  Macro that converts a number of EFI_PAGEs to a size in bytes.
210 
211  @param Pages The number of EFI_PAGES. This parameter is assumed to be
212  type UINTN. Passing in a parameter that is larger than
213  UINTN may produce unexpected results.
214 
215  @return The number of bytes associated with the number of EFI_PAGEs specified
216  by Pages.
217 
218 **/
219 #define EFI_PAGES_TO_SIZE(Pages) ((Pages) << EFI_PAGE_SHIFT)
220 
221 ///
222 /// PE32+ Machine type for IA32 UEFI images.
223 ///
224 #define EFI_IMAGE_MACHINE_IA32 0x014C
225 
226 ///
227 /// PE32+ Machine type for IA64 UEFI images.
228 ///
229 #define EFI_IMAGE_MACHINE_IA64 0x0200
230 
231 ///
232 /// PE32+ Machine type for EBC UEFI images.
233 ///
234 #define EFI_IMAGE_MACHINE_EBC 0x0EBC
235 
236 ///
237 /// PE32+ Machine type for X64 UEFI images.
238 ///
239 #define EFI_IMAGE_MACHINE_X64 0x8664
240 
241 ///
242 /// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.
243 ///
244 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2
245 
246 ///
247 /// PE32+ Machine type for AARCH64 A64 images.
248 ///
249 #define EFI_IMAGE_MACHINE_AARCH64 0xAA64
250 
251 
252 #if defined (MDE_CPU_IA32)
253 
254 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
255  (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
256 
257 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
258 
259 #elif defined (MDE_CPU_IPF)
260 
261 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
262  (((Machine) == EFI_IMAGE_MACHINE_IA64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
263 
264 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
265 
266 #elif defined (MDE_CPU_X64)
267 
268 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
269  (((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
270 
271 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
272 
273 #elif defined (MDE_CPU_ARM)
274 
275 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
276  (((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
277 
278 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
279 
280 #elif defined (MDE_CPU_AARCH64)
281 
282 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
283  (((Machine) == EFI_IMAGE_MACHINE_AARCH64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
284 
285 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
286 
287 #elif defined (MDE_CPU_EBC)
288 
289 ///
290 /// This is just to make sure you can cross compile with the EBC compiler.
291 /// It does not make sense to have a PE loader coded in EBC.
292 ///
293 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
294 
295 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
296 
297 #else
298 #error Unknown Processor Type
299 #endif
300 
301 #endif
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
32-byte buffer containing a network Media Access Control address.
Definition: UefiBaseType.h:102
VOID * EFI_EVENT
Handle to an event structure.
Definition: UefiBaseType.h:43
FILE_LICENCE(BSD3)
unsigned int UINT32
Definition: ProcessorBind.h:56
unsigned char UINT8
Definition: ProcessorBind.h:62
UINT64 EFI_PHYSICAL_ADDRESS
64-bit physical memory address.
Definition: UefiBaseType.h:56
EFI_IPv4_ADDRESS v4
Definition: UefiBaseType.h:112
IPv6_ADDRESS EFI_IPv6_ADDRESS
16-byte buffer.
Definition: UefiBaseType.h:97
UINT8 Pad2
Definition: UefiBaseType.h:85
UINT8 Day
Definition: UefiBaseType.h:77
16-byte buffer.
Definition: Base.h:280
UINT8 Minute
Definition: UefiBaseType.h:79
16-byte buffer aligned on a 4-byte boundary.
Definition: UefiBaseType.h:110
UINT64 EFI_LBA
Logical block address.
Definition: UefiBaseType.h:51
UINT8 Pad1
Definition: UefiBaseType.h:81
UINT8 Second
Definition: UefiBaseType.h:80
UINT32 Nanosecond
Definition: UefiBaseType.h:82
4-byte buffer.
Definition: Base.h:273
UINT8 Hour
Definition: UefiBaseType.h:78
short INT16
Definition: ProcessorBind.h:60
unsigned short UINT16
Definition: ProcessorBind.h:58
UINT16 Year
Definition: UefiBaseType.h:75
INT16 TimeZone
Definition: UefiBaseType.h:83
UINT64 UINTN
Unsigned value of native width.
Definition: ProcessorBind.h:71
EFI_IPv6_ADDRESS v6
Definition: UefiBaseType.h:113
#define VOID
Undeclared type.
Definition: Base.h:319
unsigned long long UINT64
Definition: ProcessorBind.h:54
IPv4_ADDRESS EFI_IPv4_ADDRESS
4-byte buffer.
Definition: UefiBaseType.h:92
UINT8 Month
Definition: UefiBaseType.h:76
EFI Time Abstraction: Year: 1900 - 9999 Month: 1 - 12 Day: 1 - 31 Hour: 0 - 23 Minute: 0 - 59 Second:...
Definition: UefiBaseType.h:74
VOID * EFI_HANDLE
A collection of related interfaces.
Definition: UefiBaseType.h:39
UINTN EFI_TPL
Task priority level.
Definition: UefiBaseType.h:47
GUID EFI_GUID
128-bit buffer containing a unique identifier value.
Definition: UefiBaseType.h:31
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
UINTN RETURN_STATUS
Definition: Base.h:918
UINT8 Daylight
Definition: UefiBaseType.h:84
Root include file for Mde Package Base type modules.
UINT64 EFI_VIRTUAL_ADDRESS
64-bit virtual memory address.
Definition: UefiBaseType.h:61