1 /** @file 2 Defines data types and constants introduced in UEFI. 3 4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> 5 Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR> 6 7 SPDX-License-Identifier: BSD-2-Clause-Patent 8 9 **/ 10 11 #ifndef __UEFI_BASETYPE_H__ 12 #define __UEFI_BASETYPE_H__ 13 14 #include <Base.h> 15 16 // 17 // Basic data type definitions introduced in UEFI. 18 // 19 20 /// 21 /// 128-bit buffer containing a unique identifier value. 22 /// 23 typedef GUID EFI_GUID; 24 /// 25 /// Function return status for EFI API. 26 /// 27 typedef RETURN_STATUS EFI_STATUS; 28 /// 29 /// A collection of related interfaces. 30 /// 31 typedef VOID *EFI_HANDLE; 32 /// 33 /// Handle to an event structure. 34 /// 35 typedef VOID *EFI_EVENT; 36 /// 37 /// Task priority level. 38 /// 39 typedef UINTN EFI_TPL; 40 /// 41 /// Logical block address. 42 /// 43 typedef UINT64 EFI_LBA; 44 45 /// 46 /// 64-bit physical memory address. 47 /// 48 typedef UINT64 EFI_PHYSICAL_ADDRESS; 49 50 /// 51 /// 64-bit virtual memory address. 52 /// 53 typedef UINT64 EFI_VIRTUAL_ADDRESS; 54 55 /// 56 /// EFI Time Abstraction: 57 /// Year: 1900 - 9999 58 /// Month: 1 - 12 59 /// Day: 1 - 31 60 /// Hour: 0 - 23 61 /// Minute: 0 - 59 62 /// Second: 0 - 59 63 /// Nanosecond: 0 - 999,999,999 64 /// TimeZone: -1440 to 1440 or 2047 65 /// 66 typedef struct { 67 UINT16 Year; 68 UINT8 Month; 69 UINT8 Day; 70 UINT8 Hour; 71 UINT8 Minute; 72 UINT8 Second; 73 UINT8 Pad1; 74 UINT32 Nanosecond; 75 INT16 TimeZone; 76 UINT8 Daylight; 77 UINT8 Pad2; 78 } EFI_TIME; 79 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 /// 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_HTTP_ERROR RETURN_HTTP_ERROR 145 146 #define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH 147 #define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE 148 #define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE 149 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL 150 #define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA 151 #define EFI_WARN_FILE_SYSTEM RETURN_WARN_FILE_SYSTEM 152 ///@} 153 154 /// 155 /// Define macro to encode the status code. 156 /// 157 #define EFIERR(_a) ENCODE_ERROR(_a) 158 159 #define EFI_ERROR(A) RETURN_ERROR(A) 160 161 /// 162 /// ICMP error definitions 163 ///@{ 164 #define EFI_NETWORK_UNREACHABLE EFIERR(100) 165 #define EFI_HOST_UNREACHABLE EFIERR(101) 166 #define EFI_PROTOCOL_UNREACHABLE EFIERR(102) 167 #define EFI_PORT_UNREACHABLE EFIERR(103) 168 ///@} 169 170 /// 171 /// Tcp connection status definitions 172 ///@{ 173 #define EFI_CONNECTION_FIN EFIERR(104) 174 #define EFI_CONNECTION_RESET EFIERR(105) 175 #define EFI_CONNECTION_REFUSED EFIERR(106) 176 ///@} 177 178 // 179 // The EFI memory allocation functions work in units of EFI_PAGEs that are 180 // 4KB. This should in no way be confused with the page size of the processor. 181 // An EFI_PAGE is just the quanta of memory in EFI. 182 // 183 #define EFI_PAGE_SIZE SIZE_4KB 184 #define EFI_PAGE_MASK 0xFFF 185 #define EFI_PAGE_SHIFT 12 186 187 /** 188 Macro that converts a size, in bytes, to a number of EFI_PAGESs. 189 190 @param Size A size in bytes. This parameter is assumed to be type UINTN. 191 Passing in a parameter that is larger than UINTN may produce 192 unexpected results. 193 194 @return The number of EFI_PAGESs associated with the number of bytes specified 195 by Size. 196 197 **/ 198 #define EFI_SIZE_TO_PAGES(Size) (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0)) 199 200 /** 201 Macro that converts a number of EFI_PAGEs to a size in bytes. 202 203 @param Pages The number of EFI_PAGES. This parameter is assumed to be 204 type UINTN. Passing in a parameter that is larger than 205 UINTN may produce unexpected results. 206 207 @return The number of bytes associated with the number of EFI_PAGEs specified 208 by Pages. 209 210 **/ 211 #define EFI_PAGES_TO_SIZE(Pages) ((Pages) << EFI_PAGE_SHIFT) 212 213 /// 214 /// PE32+ Machine type for IA32 UEFI images. 215 /// 216 #define EFI_IMAGE_MACHINE_IA32 0x014C 217 218 /// 219 /// PE32+ Machine type for IA64 UEFI images. 220 /// 221 #define EFI_IMAGE_MACHINE_IA64 0x0200 222 223 /// 224 /// PE32+ Machine type for EBC UEFI images. 225 /// 226 #define EFI_IMAGE_MACHINE_EBC 0x0EBC 227 228 /// 229 /// PE32+ Machine type for X64 UEFI images. 230 /// 231 #define EFI_IMAGE_MACHINE_X64 0x8664 232 233 /// 234 /// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images. 235 /// 236 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2 237 238 /// 239 /// PE32+ Machine type for AARCH64 A64 images. 240 /// 241 #define EFI_IMAGE_MACHINE_AARCH64 0xAA64 242 243 244 #if defined (MDE_CPU_IA32) 245 246 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \ 247 ((Machine) == EFI_IMAGE_MACHINE_IA32) 248 249 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64) 250 251 #elif defined (MDE_CPU_X64) 252 253 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \ 254 ((Machine) == EFI_IMAGE_MACHINE_X64) 255 256 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32) 257 258 #elif defined (MDE_CPU_ARM) 259 260 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) 261 262 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) 263 264 #elif defined (MDE_CPU_AARCH64) 265 266 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \ 267 ((Machine) == EFI_IMAGE_MACHINE_AARCH64) 268 269 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) 270 271 #elif defined (MDE_CPU_EBC) 272 273 /// 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. 276 /// 277 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC) 278 279 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) 280 281 #else 282 #error Unknown Processor Type 283 #endif 284 285 #endif 286