xref: /freebsd/sys/contrib/edk2/Include/Uefi/UefiBaseType.h (revision 580fcf642ea2d5a1e60f24947d1c2e97007e44e9)
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 Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>
8 
9 SPDX-License-Identifier: BSD-2-Clause-Patent
10 
11 **/
12 
13 #ifndef __UEFI_BASETYPE_H__
14 #define __UEFI_BASETYPE_H__
15 
16 #include <Base.h>
17 
18 //
19 // Basic data type definitions introduced in UEFI.
20 //
21 
22 ///
23 /// 128-bit buffer containing a unique identifier value.
24 ///
25 typedef GUID EFI_GUID;
26 ///
27 /// Function return status for EFI API.
28 ///
29 typedef RETURN_STATUS EFI_STATUS;
30 ///
31 /// A collection of related interfaces.
32 ///
33 typedef VOID *EFI_HANDLE;
34 ///
35 /// Handle to an event structure.
36 ///
37 typedef VOID *EFI_EVENT;
38 ///
39 /// Task priority level.
40 ///
41 typedef UINTN EFI_TPL;
42 ///
43 /// Logical block address.
44 ///
45 typedef UINT64 EFI_LBA;
46 
47 ///
48 /// 64-bit physical memory address.
49 ///
50 typedef UINT64 EFI_PHYSICAL_ADDRESS;
51 
52 ///
53 /// 64-bit virtual memory address.
54 ///
55 typedef UINT64 EFI_VIRTUAL_ADDRESS;
56 
57 ///
58 /// EFI Time Abstraction:
59 ///  Year:       1900 - 9999
60 ///  Month:      1 - 12
61 ///  Day:        1 - 31
62 ///  Hour:       0 - 23
63 ///  Minute:     0 - 59
64 ///  Second:     0 - 59
65 ///  Nanosecond: 0 - 999,999,999
66 ///  TimeZone:   -1440 to 1440 or 2047
67 ///
68 typedef struct {
69   UINT16    Year;
70   UINT8     Month;
71   UINT8     Day;
72   UINT8     Hour;
73   UINT8     Minute;
74   UINT8     Second;
75   UINT8     Pad1;
76   UINT32    Nanosecond;
77   INT16     TimeZone;
78   UINT8     Daylight;
79   UINT8     Pad2;
80 } EFI_TIME;
81 
82 ///
83 /// 4-byte buffer. An IPv4 internet protocol address.
84 ///
85 typedef IPv4_ADDRESS EFI_IPv4_ADDRESS;
86 
87 ///
88 /// 16-byte buffer. An IPv6 internet protocol address.
89 ///
90 typedef IPv6_ADDRESS EFI_IPv6_ADDRESS;
91 
92 ///
93 /// 32-byte buffer containing a network Media Access Control address.
94 ///
95 typedef struct {
96   UINT8    Addr[32];
97 } EFI_MAC_ADDRESS;
98 
99 ///
100 /// 16-byte buffer aligned on a 4-byte boundary.
101 /// An IPv4 or IPv6 internet protocol address.
102 ///
103 typedef union {
104   UINT32              Addr[4];
105   EFI_IPv4_ADDRESS    v4;
106   EFI_IPv6_ADDRESS    v6;
107 } EFI_IP_ADDRESS;
108 
109 ///
110 /// Enumeration of EFI_STATUS.
111 ///@{
112 #define EFI_SUCCESS               RETURN_SUCCESS
113 #define EFI_LOAD_ERROR            RETURN_LOAD_ERROR
114 #define EFI_INVALID_PARAMETER     RETURN_INVALID_PARAMETER
115 #define EFI_UNSUPPORTED           RETURN_UNSUPPORTED
116 #define EFI_BAD_BUFFER_SIZE       RETURN_BAD_BUFFER_SIZE
117 #define EFI_BUFFER_TOO_SMALL      RETURN_BUFFER_TOO_SMALL
118 #define EFI_NOT_READY             RETURN_NOT_READY
119 #define EFI_DEVICE_ERROR          RETURN_DEVICE_ERROR
120 #define EFI_WRITE_PROTECTED       RETURN_WRITE_PROTECTED
121 #define EFI_OUT_OF_RESOURCES      RETURN_OUT_OF_RESOURCES
122 #define EFI_VOLUME_CORRUPTED      RETURN_VOLUME_CORRUPTED
123 #define EFI_VOLUME_FULL           RETURN_VOLUME_FULL
124 #define EFI_NO_MEDIA              RETURN_NO_MEDIA
125 #define EFI_MEDIA_CHANGED         RETURN_MEDIA_CHANGED
126 #define EFI_NOT_FOUND             RETURN_NOT_FOUND
127 #define EFI_ACCESS_DENIED         RETURN_ACCESS_DENIED
128 #define EFI_NO_RESPONSE           RETURN_NO_RESPONSE
129 #define EFI_NO_MAPPING            RETURN_NO_MAPPING
130 #define EFI_TIMEOUT               RETURN_TIMEOUT
131 #define EFI_NOT_STARTED           RETURN_NOT_STARTED
132 #define EFI_ALREADY_STARTED       RETURN_ALREADY_STARTED
133 #define EFI_ABORTED               RETURN_ABORTED
134 #define EFI_ICMP_ERROR            RETURN_ICMP_ERROR
135 #define EFI_TFTP_ERROR            RETURN_TFTP_ERROR
136 #define EFI_PROTOCOL_ERROR        RETURN_PROTOCOL_ERROR
137 #define EFI_INCOMPATIBLE_VERSION  RETURN_INCOMPATIBLE_VERSION
138 #define EFI_SECURITY_VIOLATION    RETURN_SECURITY_VIOLATION
139 #define EFI_CRC_ERROR             RETURN_CRC_ERROR
140 #define EFI_END_OF_MEDIA          RETURN_END_OF_MEDIA
141 #define EFI_END_OF_FILE           RETURN_END_OF_FILE
142 #define EFI_INVALID_LANGUAGE      RETURN_INVALID_LANGUAGE
143 #define EFI_COMPROMISED_DATA      RETURN_COMPROMISED_DATA
144 #define EFI_IP_ADDRESS_CONFLICT   RETURN_IP_ADDRESS_CONFLICT
145 #define EFI_HTTP_ERROR            RETURN_HTTP_ERROR
146 
147 #define EFI_WARN_UNKNOWN_GLYPH     RETURN_WARN_UNKNOWN_GLYPH
148 #define EFI_WARN_DELETE_FAILURE    RETURN_WARN_DELETE_FAILURE
149 #define EFI_WARN_WRITE_FAILURE     RETURN_WARN_WRITE_FAILURE
150 #define EFI_WARN_BUFFER_TOO_SMALL  RETURN_WARN_BUFFER_TOO_SMALL
151 #define EFI_WARN_STALE_DATA        RETURN_WARN_STALE_DATA
152 #define EFI_WARN_FILE_SYSTEM       RETURN_WARN_FILE_SYSTEM
153 #define EFI_WARN_RESET_REQUIRED    RETURN_WARN_RESET_REQUIRED
154 ///@}
155 
156 ///
157 /// Define macro to encode the status code.
158 ///
159 #define EFIERR(_a)  ENCODE_ERROR(_a)
160 
161 #define EFI_ERROR(A)  RETURN_ERROR(A)
162 
163 ///
164 /// ICMP error definitions
165 ///@{
166 #define EFI_NETWORK_UNREACHABLE   EFIERR(100)
167 #define EFI_HOST_UNREACHABLE      EFIERR(101)
168 #define EFI_PROTOCOL_UNREACHABLE  EFIERR(102)
169 #define EFI_PORT_UNREACHABLE      EFIERR(103)
170 ///@}
171 
172 ///
173 /// Tcp connection status definitions
174 ///@{
175 #define EFI_CONNECTION_FIN      EFIERR(104)
176 #define EFI_CONNECTION_RESET    EFIERR(105)
177 #define EFI_CONNECTION_REFUSED  EFIERR(106)
178 ///@}
179 
180 //
181 // The EFI memory allocation functions work in units of EFI_PAGEs that are
182 // 4KB. This should in no way be confused with the page size of the processor.
183 // An EFI_PAGE is just the quanta of memory in EFI.
184 //
185 #define EFI_PAGE_SIZE   SIZE_4KB
186 #define EFI_PAGE_MASK   0xFFF
187 #define EFI_PAGE_SHIFT  12
188 
189 /**
190   Macro that converts a size, in bytes, to a number of EFI_PAGESs.
191 
192   @param  Size      A size in bytes.  This parameter is assumed to be type UINTN.
193                     Passing in a parameter that is larger than UINTN may produce
194                     unexpected results.
195 
196   @return  The number of EFI_PAGESs associated with the number of bytes specified
197            by Size.
198 
199 **/
200 #define EFI_SIZE_TO_PAGES(Size)  (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))
201 
202 /**
203   Macro that converts a number of EFI_PAGEs to a size in bytes.
204 
205   @param  Pages     The number of EFI_PAGES.  This parameter is assumed to be
206                     type UINTN.  Passing in a parameter that is larger than
207                     UINTN may produce unexpected results.
208 
209   @return  The number of bytes associated with the number of EFI_PAGEs specified
210            by Pages.
211 
212 **/
213 #define EFI_PAGES_TO_SIZE(Pages)  ((Pages) << EFI_PAGE_SHIFT)
214 
215 ///
216 /// PE32+ Machine type for IA32 UEFI images.
217 ///
218 #define EFI_IMAGE_MACHINE_IA32  0x014C
219 
220 ///
221 /// PE32+ Machine type for IA64 UEFI images.
222 ///
223 #define EFI_IMAGE_MACHINE_IA64  0x0200
224 
225 ///
226 /// PE32+ Machine type for EBC UEFI images.
227 ///
228 #define EFI_IMAGE_MACHINE_EBC  0x0EBC
229 
230 ///
231 /// PE32+ Machine type for X64 UEFI images.
232 ///
233 #define EFI_IMAGE_MACHINE_X64  0x8664
234 
235 ///
236 /// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.
237 ///
238 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED  0x01C2
239 
240 ///
241 /// PE32+ Machine type for AARCH64 A64 images.
242 ///
243 #define EFI_IMAGE_MACHINE_AARCH64  0xAA64
244 
245 ///
246 /// PE32+ Machine type for RISC-V 32/64/128
247 ///
248 #define EFI_IMAGE_MACHINE_RISCV32   0x5032
249 #define EFI_IMAGE_MACHINE_RISCV64   0x5064
250 #define EFI_IMAGE_MACHINE_RISCV128  0x5128
251 
252 ///
253 /// PE32+ Machine type for LoongArch 32/64 images.
254 ///
255 #define EFI_IMAGE_MACHINE_LOONGARCH32  0x6232
256 #define EFI_IMAGE_MACHINE_LOONGARCH64  0x6264
257 
258 #if !defined (EFI_IMAGE_MACHINE_TYPE_VALUE) && !defined (EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
259   #if   defined (MDE_CPU_IA32)
260 
261 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
262   ((Machine) == EFI_IMAGE_MACHINE_IA32)
263 
264 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_X64)
265 
266   #elif defined (MDE_CPU_X64)
267 
268 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
269   ((Machine) == EFI_IMAGE_MACHINE_X64)
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)  ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
276 
277 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)
278 
279   #elif defined (MDE_CPU_AARCH64)
280 
281 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
282   ((Machine) == EFI_IMAGE_MACHINE_AARCH64)
283 
284 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)
285 
286   #elif defined (MDE_CPU_RISCV64)
287 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
288   ((Machine) == EFI_IMAGE_MACHINE_RISCV64)
289 
290 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)
291 
292   #elif defined (MDE_CPU_LOONGARCH64)
293 
294 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
295     ((Machine) == EFI_IMAGE_MACHINE_LOONGARCH64)
296 
297 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)
298 
299   #elif defined (MDE_CPU_EBC)
300 
301 ///
302 /// This is just to make sure you can cross compile with the EBC compiler.
303 /// It does not make sense to have a PE loader coded in EBC.
304 ///
305 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_EBC)
306 
307 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)
308 
309   #else
310     #error Unknown Processor Type
311   #endif
312 #else
313   #if defined (EFI_IMAGE_MACHINE_TYPE_VALUE)
314 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_TYPE_VALUE)
315   #else
316 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine)  (FALSE)
317   #endif
318   #if defined (EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
319 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
320   #else
321 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)
322   #endif
323 #endif
324 
325 #endif
326