1 /** @file
2   Defines data types and constants introduced in UEFI.
3 
4 Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
5 Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR>
6 Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
7 
8 SPDX-License-Identifier: BSD-2-Clause-Patent
9 
10 **/
11 
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 
21 ///
22 /// 128-bit buffer containing a unique identifier value.
23 ///
24 typedef GUID EFI_GUID;
25 ///
26 /// Function return status for EFI API.
27 ///
28 typedef RETURN_STATUS EFI_STATUS;
29 ///
30 /// A collection of related interfaces.
31 ///
32 typedef VOID *EFI_HANDLE;
33 ///
34 /// Handle to an event structure.
35 ///
36 typedef VOID *EFI_EVENT;
37 ///
38 /// Task priority level.
39 ///
40 typedef UINTN EFI_TPL;
41 ///
42 /// Logical block address.
43 ///
44 typedef UINT64 EFI_LBA;
45 
46 ///
47 /// 64-bit physical memory address.
48 ///
49 typedef UINT64 EFI_PHYSICAL_ADDRESS;
50 
51 ///
52 /// 64-bit virtual memory address.
53 ///
54 typedef UINT64 EFI_VIRTUAL_ADDRESS;
55 
56 ///
57 /// EFI Time Abstraction:
58 ///  Year:       1900 - 9999
59 ///  Month:      1 - 12
60 ///  Day:        1 - 31
61 ///  Hour:       0 - 23
62 ///  Minute:     0 - 59
63 ///  Second:     0 - 59
64 ///  Nanosecond: 0 - 999,999,999
65 ///  TimeZone:   -1440 to 1440 or 2047
66 ///
67 typedef 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 
81 ///
82 /// 4-byte buffer. An IPv4 internet protocol address.
83 ///
84 typedef IPv4_ADDRESS EFI_IPv4_ADDRESS;
85 
86 ///
87 /// 16-byte buffer. An IPv6 internet protocol address.
88 ///
89 typedef IPv6_ADDRESS EFI_IPv6_ADDRESS;
90 
91 ///
92 /// 32-byte buffer containing a network Media Access Control address.
93 ///
94 typedef struct {
95   UINT8    Addr[32];
96 } EFI_MAC_ADDRESS;
97 
98 ///
99 /// 16-byte buffer aligned on a 4-byte boundary.
100 /// An IPv4 or IPv6 internet protocol address.
101 ///
102 typedef union {
103   UINT32              Addr[4];
104   EFI_IPv4_ADDRESS    v4;
105   EFI_IPv6_ADDRESS    v6;
106 } EFI_IP_ADDRESS;
107 
108 ///
109 /// Enumeration of EFI_STATUS.
110 ///@{
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
151 ///@}
152 
153 ///
154 /// Define macro to encode the status code.
155 ///
156 #define EFIERR(_a)  ENCODE_ERROR(_a)
157 
158 #define EFI_ERROR(A)  RETURN_ERROR(A)
159 
160 ///
161 /// ICMP error definitions
162 ///@{
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)
167 ///@}
168 
169 ///
170 /// Tcp connection status definitions
171 ///@{
172 #define EFI_CONNECTION_FIN      EFIERR(104)
173 #define EFI_CONNECTION_RESET    EFIERR(105)
174 #define EFI_CONNECTION_REFUSED  EFIERR(106)
175 ///@}
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 
186 /**
187   Macro that converts a size, in bytes, to a number of EFI_PAGESs.
188 
189   @param  Size      A size in bytes.  This parameter is assumed to be type UINTN.
190                     Passing in a parameter that is larger than UINTN may produce
191                     unexpected results.
192 
193   @return  The number of EFI_PAGESs associated with the number of bytes specified
194            by Size.
195 
196 **/
197 #define EFI_SIZE_TO_PAGES(Size)  (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))
198 
199 /**
200   Macro that converts a number of EFI_PAGEs to a size in bytes.
201 
202   @param  Pages     The number of EFI_PAGES.  This parameter is assumed to be
203                     type UINTN.  Passing in a parameter that is larger than
204                     UINTN may produce unexpected results.
205 
206   @return  The number of bytes associated with the number of EFI_PAGEs specified
207            by Pages.
208 
209 **/
210 #define EFI_PAGES_TO_SIZE(Pages)  ((Pages) << EFI_PAGE_SHIFT)
211 
212 ///
213 /// PE32+ Machine type for IA32 UEFI images.
214 ///
215 #define EFI_IMAGE_MACHINE_IA32  0x014C
216 
217 ///
218 /// PE32+ Machine type for IA64 UEFI images.
219 ///
220 #define EFI_IMAGE_MACHINE_IA64  0x0200
221 
222 ///
223 /// PE32+ Machine type for EBC UEFI images.
224 ///
225 #define EFI_IMAGE_MACHINE_EBC  0x0EBC
226 
227 ///
228 /// PE32+ Machine type for X64 UEFI images.
229 ///
230 #define EFI_IMAGE_MACHINE_X64  0x8664
231 
232 ///
233 /// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.
234 ///
235 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED  0x01C2
236 
237 ///
238 /// PE32+ Machine type for AARCH64 A64 images.
239 ///
240 #define EFI_IMAGE_MACHINE_AARCH64  0xAA64
241 
242 ///
243 /// PE32+ Machine type for RISC-V 32/64/128
244 ///
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 
285 ///
286 /// This is just to make sure you can cross compile with the EBC compiler.
287 /// It does not make sense to have a PE loader coded in EBC.
288 ///
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
310