projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 959ccb23 | 1 | /** @file\r |
| e0c047a0 | 2 | Include file that supports UEFI.\r |
| 959ccb23 | 3 | \r |
| fee5ea2c HW |
4 | This include file must contain things defined in the UEFI 2.7 specification.\r |
| 5 | If a code construct is defined in the UEFI 2.7 specification it must be included\r | |
| 959ccb23 | 6 | by this include file.\r |
| 7 | \r | |
| 228a9c29 | 8 | Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r |
| d3abb40d AC |
9 | Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\r |
| 10 | \r | |
| 9344f092 | 11 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 959ccb23 | 12 | \r |
| 959ccb23 | 13 | **/\r |
| 14 | \r | |
| 15 | #ifndef __UEFI_SPEC_H__\r | |
| 16 | #define __UEFI_SPEC_H__\r | |
| 17 | \r | |
| 18 | #include <Uefi/UefiMultiPhase.h>\r | |
| 19 | \r | |
| 20 | #include <Protocol/DevicePath.h>\r | |
| 21 | #include <Protocol/SimpleTextIn.h>\r | |
| 2be21afb | 22 | #include <Protocol/SimpleTextInEx.h>\r |
| 959ccb23 | 23 | #include <Protocol/SimpleTextOut.h>\r |
| 24 | \r | |
| 8b13229b | 25 | ///\r |
| 2a3f6a21 | 26 | /// Enumeration of EFI memory allocation types.\r |
| 8b13229b | 27 | ///\r |
| 959ccb23 | 28 | typedef enum {\r |
| 2a3f6a21 | 29 | ///\r |
| af2dc6a7 | 30 | /// Allocate any available range of pages that satisfies the request.\r |
| 2a3f6a21 | 31 | ///\r |
| 959ccb23 | 32 | AllocateAnyPages,\r |
| 2a3f6a21 | 33 | ///\r |
| 9095d37b | 34 | /// Allocate any available range of pages whose uppermost address is less than\r |
| af2dc6a7 | 35 | /// or equal to a specified maximum address.\r |
| 2a3f6a21 | 36 | ///\r |
| 959ccb23 | 37 | AllocateMaxAddress,\r |
| 2a3f6a21 | 38 | ///\r |
| af2dc6a7 | 39 | /// Allocate pages at a specified address.\r |
| 2a3f6a21 | 40 | ///\r |
| 959ccb23 | 41 | AllocateAddress,\r |
| 2a3f6a21 | 42 | ///\r |
| af2dc6a7 | 43 | /// Maximum enumeration value that may be used for bounds checking.\r |
| 2a3f6a21 | 44 | ///\r |
| 959ccb23 | 45 | MaxAllocateType\r |
| 46 | } EFI_ALLOCATE_TYPE;\r | |
| 47 | \r | |
| 5413e8e8 | 48 | //\r |
| 49 | // Bit definitions for EFI_TIME.Daylight\r | |
| 50 | //\r | |
| 51 | #define EFI_TIME_ADJUST_DAYLIGHT 0x01\r | |
| 52 | #define EFI_TIME_IN_DAYLIGHT 0x02\r | |
| 53 | \r | |
| 8b13229b | 54 | ///\r |
| af2dc6a7 | 55 | /// Value definition for EFI_TIME.TimeZone.\r |
| 8b13229b | 56 | ///\r |
| 5413e8e8 | 57 | #define EFI_UNSPECIFIED_TIMEZONE 0x07FF\r |
| 959ccb23 | 58 | \r |
| 59 | //\r | |
| e0c047a0 | 60 | // Memory cacheability attributes\r |
| 959ccb23 | 61 | //\r |
| e919c766 SZ |
62 | #define EFI_MEMORY_UC 0x0000000000000001ULL\r |
| 63 | #define EFI_MEMORY_WC 0x0000000000000002ULL\r | |
| 64 | #define EFI_MEMORY_WT 0x0000000000000004ULL\r | |
| 65 | #define EFI_MEMORY_WB 0x0000000000000008ULL\r | |
| 66 | #define EFI_MEMORY_UCE 0x0000000000000010ULL\r | |
| 959ccb23 | 67 | //\r |
| e0c047a0 | 68 | // Physical memory protection attributes\r |
| 959ccb23 | 69 | //\r |
| ecde59b2 SZ |
70 | // Note: UEFI spec 2.5 and following: use EFI_MEMORY_RO as write-protected physical memory\r |
| 71 | // protection attribute. Also, EFI_MEMORY_WP means cacheability attribute.\r | |
| 72 | //\r | |
| e919c766 SZ |
73 | #define EFI_MEMORY_WP 0x0000000000001000ULL\r |
| 74 | #define EFI_MEMORY_RP 0x0000000000002000ULL\r | |
| 75 | #define EFI_MEMORY_XP 0x0000000000004000ULL\r | |
| 76 | #define EFI_MEMORY_RO 0x0000000000020000ULL\r | |
| e0c047a0 | 77 | //\r |
| 9095d37b | 78 | // Physical memory persistence attribute.\r |
| 6c98edac LG |
79 | // The memory region supports byte-addressable non-volatility.\r |
| 80 | //\r | |
| e919c766 SZ |
81 | #define EFI_MEMORY_NV 0x0000000000008000ULL\r |
| 82 | //\r | |
| 83 | // The memory region provides higher reliability relative to other memory in the system.\r | |
| 84 | // If all memory has the same reliability, then this bit is not used.\r | |
| 85 | //\r | |
| 86 | #define EFI_MEMORY_MORE_RELIABLE 0x0000000000010000ULL\r | |
| c18708d2 HQ |
87 | \r |
| 88 | //\r | |
| 89 | // Note: UEFI spec 2.8 and following:\r | |
| 90 | //\r | |
| 91 | // Specific-purpose memory (SPM). The memory is earmarked for\r | |
| 92 | // specific purposes such as for specific device drivers or applications.\r | |
| 93 | // The SPM attribute serves as a hint to the OS to avoid allocating this\r | |
| 94 | // memory for core OS data or code that can not be relocated.\r | |
| 95 | //\r | |
| 96 | #define EFI_MEMORY_SP 0x0000000000040000ULL\r | |
| 97 | //\r | |
| 98 | // If this flag is set, the memory region is capable of being\r | |
| 82d00077 | 99 | // protected with the CPU's memory cryptographic\r |
| c18708d2 | 100 | // capabilities. If this flag is clear, the memory region is not\r |
| 82d00077 | 101 | // capable of being protected with the CPU's memory\r |
| c18708d2 HQ |
102 | // cryptographic capabilities or the CPU does not support CPU\r |
| 103 | // memory cryptographic capabilities.\r | |
| 104 | //\r | |
| 105 | #define EFI_MEMORY_CPU_CRYPTO 0x0000000000080000ULL\r | |
| 106 | \r | |
| 6c98edac | 107 | //\r |
| e0c047a0 | 108 | // Runtime memory attribute\r |
| 109 | //\r | |
| e919c766 | 110 | #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL\r |
| 959ccb23 | 111 | \r |
| 82d00077 OY |
112 | //\r |
| 113 | // Attributes bitmasks, grouped by type\r | |
| 114 | //\r | |
| 115 | #define EFI_CACHE_ATTRIBUTE_MASK (EFI_MEMORY_UC | EFI_MEMORY_WC | EFI_MEMORY_WT | EFI_MEMORY_WB | EFI_MEMORY_UCE | EFI_MEMORY_WP)\r | |
| 116 | #define EFI_MEMORY_ATTRIBUTE_MASK (EFI_MEMORY_RP | EFI_MEMORY_XP | EFI_MEMORY_RO | EFI_MEMORY_SP | EFI_MEMORY_CPU_CRYPTO)\r | |
| 117 | \r | |
| 8b13229b | 118 | ///\r |
| af2dc6a7 | 119 | /// Memory descriptor version number.\r |
| 8b13229b | 120 | ///\r |
| 959ccb23 | 121 | #define EFI_MEMORY_DESCRIPTOR_VERSION 1\r |
| e0c047a0 | 122 | \r |
| 123 | ///\r | |
| af2dc6a7 | 124 | /// Definition of an EFI memory descriptor.\r |
| e0c047a0 | 125 | ///\r |
| 959ccb23 | 126 | typedef struct {\r |
| 2a3f6a21 | 127 | ///\r |
| 5779d550 DB |
128 | /// Type of the memory region.\r |
| 129 | /// Type EFI_MEMORY_TYPE is defined in the\r | |
| 130 | /// AllocatePages() function description.\r | |
| 2a3f6a21 | 131 | ///\r |
| 00edb218 | 132 | UINT32 Type;\r |
| 2a3f6a21 | 133 | ///\r |
| 5779d550 DB |
134 | /// Physical address of the first byte in the memory region. PhysicalStart must be\r |
| 135 | /// aligned on a 4 KiB boundary, and must not be above 0xfffffffffffff000. Type\r | |
| 136 | /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function description\r | |
| 2a3f6a21 | 137 | ///\r |
| 00edb218 | 138 | EFI_PHYSICAL_ADDRESS PhysicalStart;\r |
| 2a3f6a21 | 139 | ///\r |
| 5779d550 DB |
140 | /// Virtual address of the first byte in the memory region.\r |
| 141 | /// VirtualStart must be aligned on a 4 KiB boundary,\r | |
| 142 | /// and must not be above 0xfffffffffffff000.\r | |
| 2a3f6a21 | 143 | ///\r |
| 00edb218 | 144 | EFI_VIRTUAL_ADDRESS VirtualStart;\r |
| 2a3f6a21 | 145 | ///\r |
| 5779d550 DB |
146 | /// NumberOfPagesNumber of 4 KiB pages in the memory region.\r |
| 147 | /// NumberOfPages must not be 0, and must not be any value\r | |
| 148 | /// that would represent a memory page with a start address,\r | |
| 149 | /// either physical or virtual, above 0xfffffffffffff000.\r | |
| 2a3f6a21 | 150 | ///\r |
| 00edb218 | 151 | UINT64 NumberOfPages;\r |
| 2a3f6a21 | 152 | ///\r |
| 153 | /// Attributes of the memory region that describe the bit mask of capabilities\r | |
| 9095d37b | 154 | /// for that memory region, and not necessarily the current settings for that\r |
| 2a3f6a21 | 155 | /// memory region.\r |
| 156 | ///\r | |
| 00edb218 | 157 | UINT64 Attribute;\r |
| 959ccb23 | 158 | } EFI_MEMORY_DESCRIPTOR;\r |
| 159 | \r | |
| 959ccb23 | 160 | /**\r |
| 161 | Allocates memory pages from the system.\r | |
| 162 | \r | |
| d3d92557 FT |
163 | @param[in] Type The type of allocation to perform.\r |
| 164 | @param[in] MemoryType The type of memory to allocate.\r | |
| ff9331e6 SZ |
165 | MemoryType values in the range 0x70000000..0x7FFFFFFF\r |
| 166 | are reserved for OEM use. MemoryType values in the range\r | |
| 167 | 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders\r | |
| 379f1cfe | 168 | that are provided by operating system vendors.\r |
| d3d92557 FT |
169 | @param[in] Pages The number of contiguous 4 KB pages to allocate.\r |
| 170 | @param[in, out] Memory The pointer to a physical address. On input, the way in which the address is\r | |
| 171 | used depends on the value of Type.\r | |
| 959ccb23 | 172 | \r |
| 173 | @retval EFI_SUCCESS The requested pages were allocated.\r | |
| 174 | @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or\r | |
| 175 | AllocateMaxAddress or AllocateAddress.\r | |
| 176 | 2) MemoryType is in the range\r | |
| ff9331e6 | 177 | EfiMaxMemoryType..0x6FFFFFFF.\r |
| 3e058701 | 178 | 3) Memory is NULL.\r |
| 379f1cfe | 179 | 4) MemoryType is EfiPersistentMemory.\r |
| 959ccb23 | 180 | @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r |
| 181 | @retval EFI_NOT_FOUND The requested pages could not be found.\r | |
| 182 | \r | |
| 183 | **/\r | |
| 184 | typedef\r | |
| 185 | EFI_STATUS\r | |
| 8b13229b | 186 | (EFIAPI *EFI_ALLOCATE_PAGES)(\r |
| 959ccb23 | 187 | IN EFI_ALLOCATE_TYPE Type,\r |
| 188 | IN EFI_MEMORY_TYPE MemoryType,\r | |
| 189 | IN UINTN Pages,\r | |
| 190 | IN OUT EFI_PHYSICAL_ADDRESS *Memory\r | |
| 191 | );\r | |
| 192 | \r | |
| 193 | /**\r | |
| 194 | Frees memory pages.\r | |
| 195 | \r | |
| d3d92557 FT |
196 | @param[in] Memory The base physical address of the pages to be freed.\r |
| 197 | @param[in] Pages The number of contiguous 4 KB pages to free.\r | |
| 959ccb23 | 198 | \r |
| 199 | @retval EFI_SUCCESS The requested pages were freed.\r | |
| 200 | @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.\r | |
| 201 | @retval EFI_NOT_FOUND The requested memory pages were not allocated with\r | |
| 202 | AllocatePages().\r | |
| 203 | \r | |
| 204 | **/\r | |
| 205 | typedef\r | |
| 206 | EFI_STATUS\r | |
| 8b13229b | 207 | (EFIAPI *EFI_FREE_PAGES)(\r |
| 959ccb23 | 208 | IN EFI_PHYSICAL_ADDRESS Memory,\r |
| 209 | IN UINTN Pages\r | |
| 210 | );\r | |
| 211 | \r | |
| 212 | /**\r | |
| 213 | Returns the current memory map.\r | |
| 214 | \r | |
| d3d92557 FT |
215 | @param[in, out] MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.\r |
| 216 | On input, this is the size of the buffer allocated by the caller.\r | |
| 217 | On output, it is the size of the buffer returned by the firmware if\r | |
| 218 | the buffer was large enough, or the size of the buffer needed to contain\r | |
| 219 | the map if the buffer was too small.\r | |
| ff95c0fc | 220 | @param[out] MemoryMap A pointer to the buffer in which firmware places the current memory\r |
| d3d92557 FT |
221 | map.\r |
| 222 | @param[out] MapKey A pointer to the location in which firmware returns the key for the\r | |
| 223 | current memory map.\r | |
| 224 | @param[out] DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of\r | |
| 225 | an individual EFI_MEMORY_DESCRIPTOR.\r | |
| 226 | @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number\r | |
| 227 | associated with the EFI_MEMORY_DESCRIPTOR.\r | |
| 959ccb23 | 228 | \r |
| 229 | @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.\r | |
| 230 | @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size\r | |
| 231 | needed to hold the memory map is returned in MemoryMapSize.\r | |
| 232 | @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.\r | |
| 233 | 2) The MemoryMap buffer is not too small and MemoryMap is\r | |
| 234 | NULL.\r | |
| 235 | \r | |
| 236 | **/\r | |
| 237 | typedef\r | |
| 238 | EFI_STATUS\r | |
| 8b13229b | 239 | (EFIAPI *EFI_GET_MEMORY_MAP)(\r |
| 959ccb23 | 240 | IN OUT UINTN *MemoryMapSize,\r |
| ff95c0fc | 241 | OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,\r |
| 959ccb23 | 242 | OUT UINTN *MapKey,\r |
| 243 | OUT UINTN *DescriptorSize,\r | |
| 244 | OUT UINT32 *DescriptorVersion\r | |
| 245 | );\r | |
| 246 | \r | |
| 247 | /**\r | |
| 248 | Allocates pool memory.\r | |
| 249 | \r | |
| d3d92557 | 250 | @param[in] PoolType The type of pool to allocate.\r |
| ff9331e6 SZ |
251 | MemoryType values in the range 0x70000000..0x7FFFFFFF\r |
| 252 | are reserved for OEM use. MemoryType values in the range\r | |
| 253 | 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders\r | |
| 379f1cfe | 254 | that are provided by operating system vendors.\r |
| d3d92557 FT |
255 | @param[in] Size The number of bytes to allocate from the pool.\r |
| 256 | @param[out] Buffer A pointer to a pointer to the allocated buffer if the call succeeds;\r | |
| 959ccb23 | 257 | undefined otherwise.\r |
| 258 | \r | |
| 259 | @retval EFI_SUCCESS The requested number of bytes was allocated.\r | |
| 260 | @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.\r | |
| 379f1cfe SZ |
261 | @retval EFI_INVALID_PARAMETER Buffer is NULL.\r |
| 262 | PoolType is in the range EfiMaxMemoryType..0x6FFFFFFF.\r | |
| 263 | PoolType is EfiPersistentMemory.\r | |
| 959ccb23 | 264 | \r |
| 265 | **/\r | |
| 266 | typedef\r | |
| 267 | EFI_STATUS\r | |
| 8b13229b | 268 | (EFIAPI *EFI_ALLOCATE_POOL)(\r |
| 959ccb23 | 269 | IN EFI_MEMORY_TYPE PoolType,\r |
| 270 | IN UINTN Size,\r | |
| 271 | OUT VOID **Buffer\r | |
| 272 | );\r | |
| 273 | \r | |
| 274 | /**\r | |
| 275 | Returns pool memory to the system.\r | |
| 276 | \r | |
| d3d92557 | 277 | @param[in] Buffer The pointer to the buffer to free.\r |
| 959ccb23 | 278 | \r |
| 279 | @retval EFI_SUCCESS The memory was returned to the system.\r | |
| 280 | @retval EFI_INVALID_PARAMETER Buffer was invalid.\r | |
| 281 | \r | |
| 282 | **/\r | |
| 283 | typedef\r | |
| 284 | EFI_STATUS\r | |
| 8b13229b | 285 | (EFIAPI *EFI_FREE_POOL)(\r |
| 959ccb23 | 286 | IN VOID *Buffer\r |
| 287 | );\r | |
| 288 | \r | |
| 289 | /**\r | |
| 290 | Changes the runtime addressing mode of EFI firmware from physical to virtual.\r | |
| 291 | \r | |
| d3d92557 FT |
292 | @param[in] MemoryMapSize The size in bytes of VirtualMap.\r |
| 293 | @param[in] DescriptorSize The size in bytes of an entry in the VirtualMap.\r | |
| 294 | @param[in] DescriptorVersion The version of the structure entries in VirtualMap.\r | |
| 295 | @param[in] VirtualMap An array of memory descriptors which contain new virtual\r | |
| 959ccb23 | 296 | address mapping information for all runtime ranges.\r |
| 297 | \r | |
| 298 | @retval EFI_SUCCESS The virtual address map has been applied.\r | |
| 299 | @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in\r | |
| 300 | virtual address mapped mode.\r | |
| 301 | @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.\r | |
| 302 | @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory\r | |
| 303 | map that requires a mapping.\r | |
| 304 | @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found\r | |
| 305 | in the memory map.\r | |
| 306 | \r | |
| 307 | **/\r | |
| 308 | typedef\r | |
| 309 | EFI_STATUS\r | |
| 8b13229b | 310 | (EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP)(\r |
| 959ccb23 | 311 | IN UINTN MemoryMapSize,\r |
| 312 | IN UINTN DescriptorSize,\r | |
| 313 | IN UINT32 DescriptorVersion,\r | |
| 314 | IN EFI_MEMORY_DESCRIPTOR *VirtualMap\r | |
| 315 | );\r | |
| 316 | \r | |
| 317 | /**\r | |
| 318 | Connects one or more drivers to a controller.\r | |
| 319 | \r | |
| d3d92557 FT |
320 | @param[in] ControllerHandle The handle of the controller to which driver(s) are to be connected.\r |
| 321 | @param[in] DriverImageHandle A pointer to an ordered list handles that support the\r | |
| 322 | EFI_DRIVER_BINDING_PROTOCOL.\r | |
| 323 | @param[in] RemainingDevicePath A pointer to the device path that specifies a child of the\r | |
| 324 | controller specified by ControllerHandle.\r | |
| 325 | @param[in] Recursive If TRUE, then ConnectController() is called recursively\r | |
| 326 | until the entire tree of controllers below the controller specified\r | |
| 327 | by ControllerHandle have been created. If FALSE, then\r | |
| 328 | the tree of controllers is only expanded one level.\r | |
| 959ccb23 | 329 | \r |
| 330 | @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.\r | |
| 331 | 2) No drivers were connected to ControllerHandle, but\r | |
| 332 | RemainingDevicePath is not NULL, and it is an End Device\r | |
| 333 | Path Node.\r | |
| 18bd7e85 | 334 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r |
| 959ccb23 | 335 | @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances\r |
| 336 | present in the system.\r | |
| 337 | 2) No drivers were connected to ControllerHandle.\r | |
| 9095d37b LG |
338 | @retval EFI_SECURITY_VIOLATION\r |
| 339 | The user has no permission to start UEFI device drivers on the device path\r | |
| b92b1209 | 340 | associated with the ControllerHandle or specified by the RemainingDevicePath.\r |
| 959ccb23 | 341 | **/\r |
| 342 | typedef\r | |
| 343 | EFI_STATUS\r | |
| 8b13229b | 344 | (EFIAPI *EFI_CONNECT_CONTROLLER)(\r |
| 959ccb23 | 345 | IN EFI_HANDLE ControllerHandle,\r |
| 346 | IN EFI_HANDLE *DriverImageHandle, OPTIONAL\r | |
| 347 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath, OPTIONAL\r | |
| 348 | IN BOOLEAN Recursive\r | |
| 349 | );\r | |
| 350 | \r | |
| 351 | /**\r | |
| 352 | Disconnects one or more drivers from a controller.\r | |
| 353 | \r | |
| d3d92557 FT |
354 | @param[in] ControllerHandle The handle of the controller from which driver(s) are to be disconnected.\r |
| 355 | @param[in] DriverImageHandle The driver to disconnect from ControllerHandle.\r | |
| 356 | If DriverImageHandle is NULL, then all the drivers currently managing\r | |
| 357 | ControllerHandle are disconnected from ControllerHandle.\r | |
| 358 | @param[in] ChildHandle The handle of the child to destroy.\r | |
| 359 | If ChildHandle is NULL, then all the children of ControllerHandle are\r | |
| 360 | destroyed before the drivers are disconnected from ControllerHandle.\r | |
| 959ccb23 | 361 | \r |
| 362 | @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.\r | |
| 363 | 2) On entry, no drivers are managing ControllerHandle.\r | |
| 364 | 3) DriverImageHandle is not NULL, and on entry\r | |
| 365 | DriverImageHandle is not managing ControllerHandle.\r | |
| d9de7921 | 366 | @retval EFI_INVALID_PARAMETER 1) ControllerHandle is NULL.\r |
| e0c047a0 | 367 | 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.\r |
| 368 | 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.\r | |
| 369 | 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.\r | |
| 959ccb23 | 370 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from\r |
| 371 | ControllerHandle.\r | |
| 372 | @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.\r | |
| 373 | \r | |
| 374 | **/\r | |
| 375 | typedef\r | |
| 376 | EFI_STATUS\r | |
| 8b13229b | 377 | (EFIAPI *EFI_DISCONNECT_CONTROLLER)(\r |
| 959ccb23 | 378 | IN EFI_HANDLE ControllerHandle,\r |
| 379 | IN EFI_HANDLE DriverImageHandle, OPTIONAL\r | |
| 380 | IN EFI_HANDLE ChildHandle OPTIONAL\r | |
| 381 | );\r | |
| 382 | \r | |
| 383 | \r | |
| 384 | \r | |
| 385 | //\r | |
| 386 | // ConvertPointer DebugDisposition type.\r | |
| 387 | //\r | |
| 388 | #define EFI_OPTIONAL_PTR 0x00000001\r | |
| 959ccb23 | 389 | \r |
| 390 | /**\r | |
| 391 | Determines the new virtual address that is to be used on subsequent memory accesses.\r | |
| 392 | \r | |
| d3d92557 FT |
393 | @param[in] DebugDisposition Supplies type information for the pointer being converted.\r |
| 394 | @param[in, out] Address A pointer to a pointer that is to be fixed to be the value needed\r | |
| 395 | for the new virtual address mappings being applied.\r | |
| 959ccb23 | 396 | \r |
| 397 | @retval EFI_SUCCESS The pointer pointed to by Address was modified.\r | |
| 398 | @retval EFI_INVALID_PARAMETER 1) Address is NULL.\r | |
| 399 | 2) *Address is NULL and DebugDisposition does\r | |
| 400 | not have the EFI_OPTIONAL_PTR bit set.\r | |
| 401 | @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part\r | |
| 402 | of the current memory map. This is normally fatal.\r | |
| 403 | \r | |
| 404 | **/\r | |
| 405 | typedef\r | |
| 406 | EFI_STATUS\r | |
| 8b13229b | 407 | (EFIAPI *EFI_CONVERT_POINTER)(\r |
| 959ccb23 | 408 | IN UINTN DebugDisposition,\r |
| 409 | IN OUT VOID **Address\r | |
| 410 | );\r | |
| 411 | \r | |
| 412 | \r | |
| 413 | //\r | |
| ac644614 | 414 | // These types can be ORed together as needed - for example,\r |
| 93ce5aca | 415 | // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or\r |
| 959ccb23 | 416 | // EVT_NOTIFY_SIGNAL.\r |
| 417 | //\r | |
| 00edb218 A |
418 | #define EVT_TIMER 0x80000000\r |
| 419 | #define EVT_RUNTIME 0x40000000\r | |
| 00edb218 A |
420 | #define EVT_NOTIFY_WAIT 0x00000100\r |
| 421 | #define EVT_NOTIFY_SIGNAL 0x00000200\r | |
| 93ce5aca | 422 | \r |
| 00edb218 | 423 | #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201\r |
| 93ce5aca | 424 | #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202\r |
| 959ccb23 | 425 | \r |
| 426 | //\r | |
| ac644614 | 427 | // The event's NotifyContext pointer points to a runtime memory\r |
| d0c64728 | 428 | // address.\r |
| 959ccb23 | 429 | // The event is deprecated in UEFI2.0 and later specifications.\r |
| d0c64728 | 430 | //\r |
| 959ccb23 | 431 | #define EVT_RUNTIME_CONTEXT 0x20000000\r |
| 432 | \r | |
| 433 | \r | |
| 434 | /**\r | |
| 435 | Invoke a notification event\r | |
| 436 | \r | |
| d3d92557 FT |
437 | @param[in] Event Event whose notification function is being invoked.\r |
| 438 | @param[in] Context The pointer to the notification function's context,\r | |
| 439 | which is implementation-dependent.\r | |
| 959ccb23 | 440 | \r |
| 441 | **/\r | |
| 442 | typedef\r | |
| 443 | VOID\r | |
| 8b13229b | 444 | (EFIAPI *EFI_EVENT_NOTIFY)(\r |
| 959ccb23 | 445 | IN EFI_EVENT Event,\r |
| 446 | IN VOID *Context\r | |
| 447 | );\r | |
| 448 | \r | |
| 449 | /**\r | |
| 450 | Creates an event.\r | |
| 451 | \r | |
| d3d92557 FT |
452 | @param[in] Type The type of event to create and its mode and attributes.\r |
| 453 | @param[in] NotifyTpl The task priority level of event notifications, if needed.\r | |
| 454 | @param[in] NotifyFunction The pointer to the event's notification function, if any.\r | |
| 455 | @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter\r | |
| 959ccb23 | 456 | Context in the notification function.\r |
| d3d92557 | 457 | @param[out] Event The pointer to the newly created event if the call succeeds; undefined\r |
| 959ccb23 | 458 | otherwise.\r |
| 459 | \r | |
| 460 | @retval EFI_SUCCESS The event structure was created.\r | |
| 461 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
| 462 | @retval EFI_OUT_OF_RESOURCES The event could not be allocated.\r | |
| 463 | \r | |
| 464 | **/\r | |
| 465 | typedef\r | |
| 466 | EFI_STATUS\r | |
| 8b13229b | 467 | (EFIAPI *EFI_CREATE_EVENT)(\r |
| 959ccb23 | 468 | IN UINT32 Type,\r |
| 469 | IN EFI_TPL NotifyTpl,\r | |
| 470 | IN EFI_EVENT_NOTIFY NotifyFunction,\r | |
| 471 | IN VOID *NotifyContext,\r | |
| 472 | OUT EFI_EVENT *Event\r | |
| 473 | );\r | |
| 474 | \r | |
| 475 | /**\r | |
| 476 | Creates an event in a group.\r | |
| 477 | \r | |
| d3d92557 FT |
478 | @param[in] Type The type of event to create and its mode and attributes.\r |
| 479 | @param[in] NotifyTpl The task priority level of event notifications,if needed.\r | |
| 480 | @param[in] NotifyFunction The pointer to the event's notification function, if any.\r | |
| 481 | @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter\r | |
| 959ccb23 | 482 | Context in the notification function.\r |
| d3d92557 | 483 | @param[in] EventGroup The pointer to the unique identifier of the group to which this event belongs.\r |
| e0c047a0 | 484 | If this is NULL, then the function behaves as if the parameters were passed\r |
| 485 | to CreateEvent.\r | |
| d3d92557 | 486 | @param[out] Event The pointer to the newly created event if the call succeeds; undefined\r |
| 959ccb23 | 487 | otherwise.\r |
| 488 | \r | |
| 489 | @retval EFI_SUCCESS The event structure was created.\r | |
| 490 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
| 491 | @retval EFI_OUT_OF_RESOURCES The event could not be allocated.\r | |
| 492 | \r | |
| 493 | **/\r | |
| 494 | typedef\r | |
| 495 | EFI_STATUS\r | |
| 8b13229b | 496 | (EFIAPI *EFI_CREATE_EVENT_EX)(\r |
| 959ccb23 | 497 | IN UINT32 Type,\r |
| e0c047a0 | 498 | IN EFI_TPL NotifyTpl,\r |
| 959ccb23 | 499 | IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,\r |
| 500 | IN CONST VOID *NotifyContext OPTIONAL,\r | |
| 501 | IN CONST EFI_GUID *EventGroup OPTIONAL,\r | |
| 502 | OUT EFI_EVENT *Event\r | |
| 503 | );\r | |
| 504 | \r | |
| e0c047a0 | 505 | ///\r |
| 506 | /// Timer delay types\r | |
| 507 | ///\r | |
| 959ccb23 | 508 | typedef enum {\r |
| 2a3f6a21 | 509 | ///\r |
| af2dc6a7 | 510 | /// An event's timer settings is to be cancelled and not trigger time is to be set/\r |
| 2a3f6a21 | 511 | ///\r |
| 959ccb23 | 512 | TimerCancel,\r |
| 2a3f6a21 | 513 | ///\r |
| 93e8d03c | 514 | /// An event is to be signaled periodically at a specified interval from the current time.\r |
| 2a3f6a21 | 515 | ///\r |
| 959ccb23 | 516 | TimerPeriodic,\r |
| 2a3f6a21 | 517 | ///\r |
| 93e8d03c | 518 | /// An event is to be signaled once at a specified interval from the current time.\r |
| 2a3f6a21 | 519 | ///\r |
| 959ccb23 | 520 | TimerRelative\r |
| 521 | } EFI_TIMER_DELAY;\r | |
| 522 | \r | |
| 523 | /**\r | |
| 524 | Sets the type of timer and the trigger time for a timer event.\r | |
| 525 | \r | |
| d3d92557 FT |
526 | @param[in] Event The timer event that is to be signaled at the specified time.\r |
| 527 | @param[in] Type The type of time that is specified in TriggerTime.\r | |
| 528 | @param[in] TriggerTime The number of 100ns units until the timer expires.\r | |
| e0c047a0 | 529 | A TriggerTime of 0 is legal.\r |
| 530 | If Type is TimerRelative and TriggerTime is 0, then the timer\r | |
| 531 | event will be signaled on the next timer tick.\r | |
| 532 | If Type is TimerPeriodic and TriggerTime is 0, then the timer\r | |
| 533 | event will be signaled on every timer tick.\r | |
| 959ccb23 | 534 | \r |
| 535 | @retval EFI_SUCCESS The event has been set to be signaled at the requested time.\r | |
| 536 | @retval EFI_INVALID_PARAMETER Event or Type is not valid.\r | |
| 537 | \r | |
| 538 | **/\r | |
| 539 | typedef\r | |
| 540 | EFI_STATUS\r | |
| 8b13229b | 541 | (EFIAPI *EFI_SET_TIMER)(\r |
| 959ccb23 | 542 | IN EFI_EVENT Event,\r |
| 543 | IN EFI_TIMER_DELAY Type,\r | |
| 544 | IN UINT64 TriggerTime\r | |
| 545 | );\r | |
| 546 | \r | |
| 547 | /**\r | |
| 548 | Signals an event.\r | |
| 549 | \r | |
| d3d92557 | 550 | @param[in] Event The event to signal.\r |
| 959ccb23 | 551 | \r |
| 552 | @retval EFI_SUCCESS The event has been signaled.\r | |
| 553 | \r | |
| 554 | **/\r | |
| 555 | typedef\r | |
| 556 | EFI_STATUS\r | |
| 8b13229b | 557 | (EFIAPI *EFI_SIGNAL_EVENT)(\r |
| 959ccb23 | 558 | IN EFI_EVENT Event\r |
| 559 | );\r | |
| 560 | \r | |
| 561 | /**\r | |
| 562 | Stops execution until an event is signaled.\r | |
| 563 | \r | |
| d3d92557 FT |
564 | @param[in] NumberOfEvents The number of events in the Event array.\r |
| 565 | @param[in] Event An array of EFI_EVENT.\r | |
| 566 | @param[out] Index The pointer to the index of the event which satisfied the wait condition.\r | |
| 959ccb23 | 567 | \r |
| 568 | @retval EFI_SUCCESS The event indicated by Index was signaled.\r | |
| 569 | @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.\r | |
| 570 | 2) The event indicated by Index is of type\r | |
| 571 | EVT_NOTIFY_SIGNAL.\r | |
| 572 | @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.\r | |
| 573 | \r | |
| 574 | **/\r | |
| 575 | typedef\r | |
| 576 | EFI_STATUS\r | |
| 8b13229b | 577 | (EFIAPI *EFI_WAIT_FOR_EVENT)(\r |
| 959ccb23 | 578 | IN UINTN NumberOfEvents,\r |
| 579 | IN EFI_EVENT *Event,\r | |
| 580 | OUT UINTN *Index\r | |
| 581 | );\r | |
| 582 | \r | |
| 583 | /**\r | |
| 584 | Closes an event.\r | |
| 585 | \r | |
| d3d92557 | 586 | @param[in] Event The event to close.\r |
| 959ccb23 | 587 | \r |
| 588 | @retval EFI_SUCCESS The event has been closed.\r | |
| 589 | \r | |
| 590 | **/\r | |
| 591 | typedef\r | |
| 592 | EFI_STATUS\r | |
| 8b13229b | 593 | (EFIAPI *EFI_CLOSE_EVENT)(\r |
| 959ccb23 | 594 | IN EFI_EVENT Event\r |
| 595 | );\r | |
| 596 | \r | |
| 597 | /**\r | |
| 598 | Checks whether an event is in the signaled state.\r | |
| 599 | \r | |
| d3d92557 | 600 | @param[in] Event The event to check.\r |
| 959ccb23 | 601 | \r |
| 602 | @retval EFI_SUCCESS The event is in the signaled state.\r | |
| 603 | @retval EFI_NOT_READY The event is not in the signaled state.\r | |
| 604 | @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.\r | |
| 605 | \r | |
| 606 | **/\r | |
| 607 | typedef\r | |
| 608 | EFI_STATUS\r | |
| 8b13229b | 609 | (EFIAPI *EFI_CHECK_EVENT)(\r |
| 959ccb23 | 610 | IN EFI_EVENT Event\r |
| 611 | );\r | |
| 612 | \r | |
| 613 | \r | |
| 614 | //\r | |
| e0c047a0 | 615 | // Task priority level\r |
| 959ccb23 | 616 | //\r |
| 617 | #define TPL_APPLICATION 4\r | |
| 618 | #define TPL_CALLBACK 8\r | |
| 619 | #define TPL_NOTIFY 16\r | |
| 620 | #define TPL_HIGH_LEVEL 31\r | |
| 621 | \r | |
| 622 | \r | |
| 623 | /**\r | |
| 624 | Raises a task's priority level and returns its previous level.\r | |
| 625 | \r | |
| d3d92557 | 626 | @param[in] NewTpl The new task priority level.\r |
| 959ccb23 | 627 | \r |
| e0c047a0 | 628 | @return Previous task priority level\r |
| 959ccb23 | 629 | \r |
| 630 | **/\r | |
| 631 | typedef\r | |
| 632 | EFI_TPL\r | |
| 8b13229b | 633 | (EFIAPI *EFI_RAISE_TPL)(\r |
| 959ccb23 | 634 | IN EFI_TPL NewTpl\r |
| 635 | );\r | |
| 636 | \r | |
| 637 | /**\r | |
| 638 | Restores a task's priority level to its previous value.\r | |
| 639 | \r | |
| d3d92557 | 640 | @param[in] OldTpl The previous task priority level to restore.\r |
| 959ccb23 | 641 | \r |
| 642 | **/\r | |
| 643 | typedef\r | |
| 644 | VOID\r | |
| 8b13229b | 645 | (EFIAPI *EFI_RESTORE_TPL)(\r |
| 959ccb23 | 646 | IN EFI_TPL OldTpl\r |
| 647 | );\r | |
| 648 | \r | |
| 649 | /**\r | |
| 650 | Returns the value of a variable.\r | |
| 651 | \r | |
| d3d92557 FT |
652 | @param[in] VariableName A Null-terminated string that is the name of the vendor's\r |
| 653 | variable.\r | |
| 654 | @param[in] VendorGuid A unique identifier for the vendor.\r | |
| 655 | @param[out] Attributes If not NULL, a pointer to the memory location to return the\r | |
| 656 | attributes bitmask for the variable.\r | |
| 657 | @param[in, out] DataSize On input, the size in bytes of the return Data buffer.\r | |
| 658 | On output the size of data returned in Data.\r | |
| 61ce1aea SZ |
659 | @param[out] Data The buffer to return the contents of the variable. May be NULL\r |
| 660 | with a zero DataSize in order to determine the size buffer needed.\r | |
| 959ccb23 | 661 | \r |
| e0c047a0 | 662 | @retval EFI_SUCCESS The function completed successfully.\r |
| 663 | @retval EFI_NOT_FOUND The variable was not found.\r | |
| 664 | @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.\r | |
| 665 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
| 666 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
| 667 | @retval EFI_INVALID_PARAMETER DataSize is NULL.\r | |
| 668 | @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.\r | |
| 669 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
| 670 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
| 959ccb23 | 671 | \r |
| 672 | **/\r | |
| 673 | typedef\r | |
| 674 | EFI_STATUS\r | |
| 8b13229b | 675 | (EFIAPI *EFI_GET_VARIABLE)(\r |
| 959ccb23 | 676 | IN CHAR16 *VariableName,\r |
| 677 | IN EFI_GUID *VendorGuid,\r | |
| 678 | OUT UINT32 *Attributes, OPTIONAL\r | |
| 679 | IN OUT UINTN *DataSize,\r | |
| 61ce1aea | 680 | OUT VOID *Data OPTIONAL\r |
| 959ccb23 | 681 | );\r |
| 682 | \r | |
| 683 | /**\r | |
| 684 | Enumerates the current variable names.\r | |
| 685 | \r | |
| 6ca2bfa5 SZ |
686 | @param[in, out] VariableNameSize The size of the VariableName buffer. The size must be large\r |
| 687 | enough to fit input string supplied in VariableName buffer.\r | |
| d3d92557 FT |
688 | @param[in, out] VariableName On input, supplies the last VariableName that was returned\r |
| 689 | by GetNextVariableName(). On output, returns the Nullterminated\r | |
| 690 | string of the current variable.\r | |
| 691 | @param[in, out] VendorGuid On input, supplies the last VendorGuid that was returned by\r | |
| 692 | GetNextVariableName(). On output, returns the\r | |
| 693 | VendorGuid of the current variable.\r | |
| 959ccb23 | 694 | \r |
| 695 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 696 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
| 697 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r | |
| 6ca2bfa5 | 698 | VariableNameSize has been updated with the size needed to complete the request.\r |
| e0c047a0 | 699 | @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r |
| 700 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
| 701 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
| 6ca2bfa5 SZ |
702 | @retval EFI_INVALID_PARAMETER The input values of VariableName and VendorGuid are not a name and\r |
| 703 | GUID of an existing variable.\r | |
| 704 | @retval EFI_INVALID_PARAMETER Null-terminator is not found in the first VariableNameSize bytes of\r | |
| 705 | the input VariableName buffer.\r | |
| 959ccb23 | 706 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r |
| 707 | \r | |
| 708 | **/\r | |
| 709 | typedef\r | |
| 710 | EFI_STATUS\r | |
| 8b13229b | 711 | (EFIAPI *EFI_GET_NEXT_VARIABLE_NAME)(\r |
| 959ccb23 | 712 | IN OUT UINTN *VariableNameSize,\r |
| 713 | IN OUT CHAR16 *VariableName,\r | |
| 714 | IN OUT EFI_GUID *VendorGuid\r | |
| 715 | );\r | |
| 716 | \r | |
| 717 | /**\r | |
| 718 | Sets the value of a variable.\r | |
| 719 | \r | |
| d3d92557 | 720 | @param[in] VariableName A Null-terminated string that is the name of the vendor's variable.\r |
| db27cda5 | 721 | Each VariableName is unique for each VendorGuid. VariableName must\r |
| 722 | contain 1 or more characters. If VariableName is an empty string,\r | |
| 723 | then EFI_INVALID_PARAMETER is returned.\r | |
| d3d92557 FT |
724 | @param[in] VendorGuid A unique identifier for the vendor.\r |
| 725 | @param[in] Attributes Attributes bitmask to set for the variable.\r | |
| 403170bb | 726 | @param[in] DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE or\r |
| 9095d37b LG |
727 | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero\r |
| 728 | causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is\r | |
| 729 | set, then a SetVariable() call with a DataSize of zero will not cause any change to\r | |
| 730 | the variable value (the timestamp associated with the variable may be updated however\r | |
| 731 | even if no new data value is provided,see the description of the\r | |
| 732 | EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not\r | |
| 733 | be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).\r | |
| d3d92557 | 734 | @param[in] Data The contents for the variable.\r |
| 959ccb23 | 735 | \r |
| e0c047a0 | 736 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r |
| 737 | defined by the Attributes.\r | |
| 6675a21f | 738 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the\r |
| e0c047a0 | 739 | DataSize exceeds the maximum allowed.\r |
| db27cda5 | 740 | @retval EFI_INVALID_PARAMETER VariableName is an empty string.\r |
| e0c047a0 | 741 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r |
| 742 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
| 743 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
| 744 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
| 403170bb ZC |
745 | @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set,\r |
| 746 | but the AuthInfo does NOT pass the validation check carried out by the firmware.\r | |
| 9095d37b | 747 | \r |
| e0c047a0 | 748 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r |
| 959ccb23 | 749 | \r |
| 750 | **/\r | |
| 751 | typedef\r | |
| 752 | EFI_STATUS\r | |
| 8b13229b | 753 | (EFIAPI *EFI_SET_VARIABLE)(\r |
| 959ccb23 | 754 | IN CHAR16 *VariableName,\r |
| 755 | IN EFI_GUID *VendorGuid,\r | |
| 756 | IN UINT32 Attributes,\r | |
| 757 | IN UINTN DataSize,\r | |
| 758 | IN VOID *Data\r | |
| 759 | );\r | |
| 760 | \r | |
| 761 | \r | |
| e0c047a0 | 762 | ///\r |
| 763 | /// This provides the capabilities of the\r | |
| 764 | /// real time clock device as exposed through the EFI interfaces.\r | |
| 765 | ///\r | |
| 959ccb23 | 766 | typedef struct {\r |
| 1bf79370 LG |
767 | ///\r |
| 768 | /// Provides the reporting resolution of the real-time clock device in\r | |
| 769 | /// counts per second. For a normal PC-AT CMOS RTC device, this\r | |
| 770 | /// value would be 1 Hz, or 1, to indicate that the device only reports\r | |
| 771 | /// the time to the resolution of 1 second.\r | |
| 772 | ///\r | |
| 00edb218 | 773 | UINT32 Resolution;\r |
| 1bf79370 LG |
774 | ///\r |
| 775 | /// Provides the timekeeping accuracy of the real-time clock in an\r | |
| 776 | /// error rate of 1E-6 parts per million. For a clock with an accuracy\r | |
| 777 | /// of 50 parts per million, the value in this field would be\r | |
| 778 | /// 50,000,000.\r | |
| 779 | ///\r | |
| 00edb218 | 780 | UINT32 Accuracy;\r |
| 1bf79370 | 781 | ///\r |
| de2314f8 | 782 | /// A TRUE indicates that a time set operation clears the device's\r |
| 1bf79370 LG |
783 | /// time below the Resolution reporting level. A FALSE\r |
| 784 | /// indicates that the state below the Resolution level of the\r | |
| 785 | /// device is not cleared when the time is set. Normal PC-AT CMOS\r | |
| 786 | /// RTC devices set this value to FALSE.\r | |
| 787 | ///\r | |
| 00edb218 | 788 | BOOLEAN SetsToZero;\r |
| 959ccb23 | 789 | } EFI_TIME_CAPABILITIES;\r |
| 790 | \r | |
| 791 | /**\r | |
| 792 | Returns the current time and date information, and the time-keeping capabilities\r | |
| 793 | of the hardware platform.\r | |
| 794 | \r | |
| d3d92557 FT |
795 | @param[out] Time A pointer to storage to receive a snapshot of the current time.\r |
| 796 | @param[out] Capabilities An optional pointer to a buffer to receive the real time clock\r | |
| 959ccb23 | 797 | device's capabilities.\r |
| 798 | \r | |
| 799 | @retval EFI_SUCCESS The operation completed successfully.\r | |
| 800 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
| 801 | @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.\r | |
| 802 | \r | |
| 803 | **/\r | |
| 804 | typedef\r | |
| 805 | EFI_STATUS\r | |
| 8b13229b | 806 | (EFIAPI *EFI_GET_TIME)(\r |
| 959ccb23 | 807 | OUT EFI_TIME *Time,\r |
| 808 | OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL\r | |
| 809 | );\r | |
| 810 | \r | |
| 811 | /**\r | |
| 812 | Sets the current local time and date information.\r | |
| 813 | \r | |
| d3d92557 | 814 | @param[in] Time A pointer to the current time.\r |
| 959ccb23 | 815 | \r |
| 816 | @retval EFI_SUCCESS The operation completed successfully.\r | |
| 817 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
| 818 | @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.\r | |
| 819 | \r | |
| 820 | **/\r | |
| 821 | typedef\r | |
| 822 | EFI_STATUS\r | |
| 8b13229b | 823 | (EFIAPI *EFI_SET_TIME)(\r |
| 959ccb23 | 824 | IN EFI_TIME *Time\r |
| 825 | );\r | |
| 826 | \r | |
| 827 | /**\r | |
| 828 | Returns the current wakeup alarm clock setting.\r | |
| 829 | \r | |
| d3d92557 FT |
830 | @param[out] Enabled Indicates if the alarm is currently enabled or disabled.\r |
| 831 | @param[out] Pending Indicates if the alarm signal is pending and requires acknowledgement.\r | |
| 832 | @param[out] Time The current alarm setting.\r | |
| 959ccb23 | 833 | \r |
| 834 | @retval EFI_SUCCESS The alarm settings were returned.\r | |
| e0c047a0 | 835 | @retval EFI_INVALID_PARAMETER Enabled is NULL.\r |
| 836 | @retval EFI_INVALID_PARAMETER Pending is NULL.\r | |
| 837 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
| 959ccb23 | 838 | @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r |
| e0c047a0 | 839 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r |
| 959ccb23 | 840 | \r |
| 841 | **/\r | |
| 842 | typedef\r | |
| 843 | EFI_STATUS\r | |
| 8b13229b | 844 | (EFIAPI *EFI_GET_WAKEUP_TIME)(\r |
| 959ccb23 | 845 | OUT BOOLEAN *Enabled,\r |
| 846 | OUT BOOLEAN *Pending,\r | |
| 847 | OUT EFI_TIME *Time\r | |
| 848 | );\r | |
| 849 | \r | |
| 850 | /**\r | |
| 851 | Sets the system wakeup alarm clock time.\r | |
| 852 | \r | |
| d3d92557 FT |
853 | @param[in] Enable Enable or disable the wakeup alarm.\r |
| 854 | @param[in] Time If Enable is TRUE, the time to set the wakeup alarm for.\r | |
| e0c047a0 | 855 | If Enable is FALSE, then this parameter is optional, and may be NULL.\r |
| 959ccb23 | 856 | \r |
| 857 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If\r | |
| 858 | Enable is FALSE, then the wakeup alarm was disabled.\r | |
| 859 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
| 860 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
| 861 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
| 862 | \r | |
| 863 | **/\r | |
| 864 | typedef\r | |
| 865 | EFI_STATUS\r | |
| 8b13229b | 866 | (EFIAPI *EFI_SET_WAKEUP_TIME)(\r |
| 959ccb23 | 867 | IN BOOLEAN Enable,\r |
| 868 | IN EFI_TIME *Time OPTIONAL\r | |
| 869 | );\r | |
| 870 | \r | |
| 959ccb23 | 871 | /**\r |
| 872 | Loads an EFI image into memory.\r | |
| 873 | \r | |
| d3d92557 FT |
874 | @param[in] BootPolicy If TRUE, indicates that the request originates from the boot\r |
| 875 | manager, and that the boot manager is attempting to load\r | |
| 876 | FilePath as a boot selection. Ignored if SourceBuffer is\r | |
| 877 | not NULL.\r | |
| 878 | @param[in] ParentImageHandle The caller's image handle.\r | |
| 879 | @param[in] DevicePath The DeviceHandle specific file path from which the image is\r | |
| 880 | loaded.\r | |
| 881 | @param[in] SourceBuffer If not NULL, a pointer to the memory location containing a copy\r | |
| 882 | of the image to be loaded.\r | |
| 883 | @param[in] SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.\r | |
| 884 | @param[out] ImageHandle The pointer to the returned image handle that is created when the\r | |
| 885 | image is successfully loaded.\r | |
| 886 | \r | |
| 887 | @retval EFI_SUCCESS Image was loaded into memory correctly.\r | |
| 888 | @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.\r | |
| 889 | @retval EFI_INVALID_PARAMETER One or more parametes are invalid.\r | |
| 890 | @retval EFI_UNSUPPORTED The image type is not supported.\r | |
| 891 | @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.\r | |
| 892 | @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not\r | |
| 893 | understood.\r | |
| 894 | @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.\r | |
| 9095d37b | 895 | @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the\r |
| d3d92557 | 896 | image from being loaded. NULL is returned in *ImageHandle.\r |
| 9095d37b LG |
897 | @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a\r |
| 898 | valid EFI_LOADED_IMAGE_PROTOCOL. However, the current\r | |
| d3d92557 | 899 | platform policy specifies that the image should not be started.\r |
| 959ccb23 | 900 | **/\r |
| 901 | typedef\r | |
| 902 | EFI_STATUS\r | |
| 8b13229b | 903 | (EFIAPI *EFI_IMAGE_LOAD)(\r |
| 959ccb23 | 904 | IN BOOLEAN BootPolicy,\r |
| 905 | IN EFI_HANDLE ParentImageHandle,\r | |
| e0c047a0 | 906 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r |
| 959ccb23 | 907 | IN VOID *SourceBuffer OPTIONAL,\r |
| 908 | IN UINTN SourceSize,\r | |
| 909 | OUT EFI_HANDLE *ImageHandle\r | |
| 910 | );\r | |
| 911 | \r | |
| 912 | /**\r | |
| 913 | Transfers control to a loaded image's entry point.\r | |
| 914 | \r | |
| d3d92557 FT |
915 | @param[in] ImageHandle Handle of image to be started.\r |
| 916 | @param[out] ExitDataSize The pointer to the size, in bytes, of ExitData.\r | |
| 917 | @param[out] ExitData The pointer to a pointer to a data buffer that includes a Null-terminated\r | |
| 918 | string, optionally followed by additional binary data.\r | |
| 959ccb23 | 919 | \r |
| b92b1209 LG |
920 | @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image\r |
| 921 | has already been initialized with StartImage.\r | |
| 922 | @retval EFI_SECURITY_VIOLATION The current platform policy specifies that the image should not be started.\r | |
| e0c047a0 | 923 | @return Exit code from image\r |
| 959ccb23 | 924 | \r |
| 925 | **/\r | |
| 926 | typedef\r | |
| 927 | EFI_STATUS\r | |
| 8b13229b | 928 | (EFIAPI *EFI_IMAGE_START)(\r |
| 959ccb23 | 929 | IN EFI_HANDLE ImageHandle,\r |
| 930 | OUT UINTN *ExitDataSize,\r | |
| 931 | OUT CHAR16 **ExitData OPTIONAL\r | |
| 932 | );\r | |
| 933 | \r | |
| 934 | /**\r | |
| 935 | Terminates a loaded EFI image and returns control to boot services.\r | |
| 936 | \r | |
| 9095d37b | 937 | @param[in] ImageHandle Handle that identifies the image. This parameter is passed to the\r |
| fbf926ad | 938 | image on entry.\r |
| d3d92557 FT |
939 | @param[in] ExitStatus The image's exit code.\r |
| 940 | @param[in] ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.\r | |
| 941 | @param[in] ExitData The pointer to a data buffer that includes a Null-terminated string,\r | |
| 9095d37b LG |
942 | optionally followed by additional binary data. The string is a\r |
| 943 | description that the caller may use to further indicate the reason\r | |
| 944 | for the image's exit. ExitData is only valid if ExitStatus\r | |
| 945 | is something other than EFI_SUCCESS. The ExitData buffer\r | |
| fbf926ad | 946 | must be allocated by calling AllocatePool().\r |
| 959ccb23 | 947 | \r |
| 948 | @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.\r | |
| 949 | @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and\r | |
| 950 | started with LoadImage() and StartImage(), but the\r | |
| 951 | image is not the currently executing image.\r | |
| 952 | \r | |
| 953 | **/\r | |
| 954 | typedef\r | |
| 955 | EFI_STATUS\r | |
| 8b13229b | 956 | (EFIAPI *EFI_EXIT)(\r |
| 959ccb23 | 957 | IN EFI_HANDLE ImageHandle,\r |
| 958 | IN EFI_STATUS ExitStatus,\r | |
| 959 | IN UINTN ExitDataSize,\r | |
| 960 | IN CHAR16 *ExitData OPTIONAL\r | |
| 961 | );\r | |
| 962 | \r | |
| 963 | /**\r | |
| 964 | Unloads an image.\r | |
| 965 | \r | |
| d3d92557 | 966 | @param[in] ImageHandle Handle that identifies the image to be unloaded.\r |
| 959ccb23 | 967 | \r |
| 968 | @retval EFI_SUCCESS The image has been unloaded.\r | |
| 969 | @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.\r | |
| 959ccb23 | 970 | \r |
| 971 | **/\r | |
| 972 | typedef\r | |
| 973 | EFI_STATUS\r | |
| 8b13229b | 974 | (EFIAPI *EFI_IMAGE_UNLOAD)(\r |
| 959ccb23 | 975 | IN EFI_HANDLE ImageHandle\r |
| 976 | );\r | |
| 977 | \r | |
| 978 | /**\r | |
| 979 | Terminates all boot services.\r | |
| 980 | \r | |
| d3d92557 FT |
981 | @param[in] ImageHandle Handle that identifies the exiting image.\r |
| 982 | @param[in] MapKey Key to the latest memory map.\r | |
| 959ccb23 | 983 | \r |
| 984 | @retval EFI_SUCCESS Boot services have been terminated.\r | |
| 985 | @retval EFI_INVALID_PARAMETER MapKey is incorrect.\r | |
| 986 | \r | |
| 987 | **/\r | |
| 988 | typedef\r | |
| 989 | EFI_STATUS\r | |
| 8b13229b | 990 | (EFIAPI *EFI_EXIT_BOOT_SERVICES)(\r |
| 959ccb23 | 991 | IN EFI_HANDLE ImageHandle,\r |
| 992 | IN UINTN MapKey\r | |
| 993 | );\r | |
| 994 | \r | |
| 995 | /**\r | |
| 996 | Induces a fine-grained stall.\r | |
| 997 | \r | |
| d3d92557 | 998 | @param[in] Microseconds The number of microseconds to stall execution.\r |
| 959ccb23 | 999 | \r |
| 1000 | @retval EFI_SUCCESS Execution was stalled at least the requested number of\r | |
| 1001 | Microseconds.\r | |
| 1002 | \r | |
| 1003 | **/\r | |
| 1004 | typedef\r | |
| 1005 | EFI_STATUS\r | |
| 8b13229b | 1006 | (EFIAPI *EFI_STALL)(\r |
| 959ccb23 | 1007 | IN UINTN Microseconds\r |
| 1008 | );\r | |
| 1009 | \r | |
| 1010 | /**\r | |
| 1011 | Sets the system's watchdog timer.\r | |
| 1012 | \r | |
| d3d92557 FT |
1013 | @param[in] Timeout The number of seconds to set the watchdog timer to.\r |
| 1014 | @param[in] WatchdogCode The numeric code to log on a watchdog timer timeout event.\r | |
| 1015 | @param[in] DataSize The size, in bytes, of WatchdogData.\r | |
| 1016 | @param[in] WatchdogData A data buffer that includes a Null-terminated string, optionally\r | |
| 959ccb23 | 1017 | followed by additional binary data.\r |
| 1018 | \r | |
| 1019 | @retval EFI_SUCCESS The timeout has been set.\r | |
| 1020 | @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.\r | |
| 1021 | @retval EFI_UNSUPPORTED The system does not have a watchdog timer.\r | |
| af2dc6a7 | 1022 | @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware\r |
| 959ccb23 | 1023 | error.\r |
| 1024 | \r | |
| 1025 | **/\r | |
| 1026 | typedef\r | |
| 1027 | EFI_STATUS\r | |
| 8b13229b | 1028 | (EFIAPI *EFI_SET_WATCHDOG_TIMER)(\r |
| 959ccb23 | 1029 | IN UINTN Timeout,\r |
| 1030 | IN UINT64 WatchdogCode,\r | |
| 1031 | IN UINTN DataSize,\r | |
| 1032 | IN CHAR16 *WatchdogData OPTIONAL\r | |
| 1033 | );\r | |
| 1034 | \r | |
| 959ccb23 | 1035 | /**\r |
| 1036 | Resets the entire platform.\r | |
| 1037 | \r | |
| d3d92557 FT |
1038 | @param[in] ResetType The type of reset to perform.\r |
| 1039 | @param[in] ResetStatus The status code for the reset.\r | |
| e963b746 | 1040 | @param[in] DataSize The size, in bytes, of ResetData.\r |
| d3d92557 | 1041 | @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or\r |
| 959ccb23 | 1042 | EfiResetShutdown the data buffer starts with a Null-terminated\r |
| fbf926ad | 1043 | string, optionally followed by additional binary data.\r |
| e963b746 | 1044 | The string is a description that the caller may use to further\r |
| 228a9c29 | 1045 | indicate the reason for the system reset.\r |
| 28426918 DB |
1046 | For a ResetType of EfiResetPlatformSpecific the data buffer\r |
| 1047 | also starts with a Null-terminated string that is followed\r | |
| 1048 | by an EFI_GUID that describes the specific type of reset to perform.\r | |
| 959ccb23 | 1049 | **/\r |
| 1050 | typedef\r | |
| 1051 | VOID\r | |
| 8b13229b | 1052 | (EFIAPI *EFI_RESET_SYSTEM)(\r |
| 959ccb23 | 1053 | IN EFI_RESET_TYPE ResetType,\r |
| 1054 | IN EFI_STATUS ResetStatus,\r | |
| 1055 | IN UINTN DataSize,\r | |
| b058028b | 1056 | IN VOID *ResetData OPTIONAL\r |
| 959ccb23 | 1057 | );\r |
| 1058 | \r | |
| 1059 | /**\r | |
| 1060 | Returns a monotonically increasing count for the platform.\r | |
| 1061 | \r | |
| d3d92557 | 1062 | @param[out] Count The pointer to returned value.\r |
| 959ccb23 | 1063 | \r |
| 1064 | @retval EFI_SUCCESS The next monotonic count was returned.\r | |
| 1065 | @retval EFI_INVALID_PARAMETER Count is NULL.\r | |
| 1066 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
| 1067 | \r | |
| 1068 | **/\r | |
| 1069 | typedef\r | |
| 1070 | EFI_STATUS\r | |
| 8b13229b | 1071 | (EFIAPI *EFI_GET_NEXT_MONOTONIC_COUNT)(\r |
| 959ccb23 | 1072 | OUT UINT64 *Count\r |
| 1073 | );\r | |
| 1074 | \r | |
| 1075 | /**\r | |
| 1076 | Returns the next high 32 bits of the platform's monotonic counter.\r | |
| 1077 | \r | |
| d3d92557 | 1078 | @param[out] HighCount The pointer to returned value.\r |
| 959ccb23 | 1079 | \r |
| 1080 | @retval EFI_SUCCESS The next high monotonic count was returned.\r | |
| 1081 | @retval EFI_INVALID_PARAMETER HighCount is NULL.\r | |
| 1082 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
| 1083 | \r | |
| 1084 | **/\r | |
| 1085 | typedef\r | |
| 1086 | EFI_STATUS\r | |
| 8b13229b | 1087 | (EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT)(\r |
| 959ccb23 | 1088 | OUT UINT32 *HighCount\r |
| 1089 | );\r | |
| 1090 | \r | |
| 1091 | /**\r | |
| 1092 | Computes and returns a 32-bit CRC for a data buffer.\r | |
| 1093 | \r | |
| d3d92557 FT |
1094 | @param[in] Data A pointer to the buffer on which the 32-bit CRC is to be computed.\r |
| 1095 | @param[in] DataSize The number of bytes in the buffer Data.\r | |
| 1096 | @param[out] Crc32 The 32-bit CRC that was computed for the data buffer specified by Data\r | |
| 959ccb23 | 1097 | and DataSize.\r |
| 1098 | \r | |
| 1099 | @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in\r | |
| 1100 | Crc32.\r | |
| e0c047a0 | 1101 | @retval EFI_INVALID_PARAMETER Data is NULL.\r |
| 1102 | @retval EFI_INVALID_PARAMETER Crc32 is NULL.\r | |
| 1103 | @retval EFI_INVALID_PARAMETER DataSize is 0.\r | |
| 959ccb23 | 1104 | \r |
| 1105 | **/\r | |
| 1106 | typedef\r | |
| 1107 | EFI_STATUS\r | |
| 8b13229b | 1108 | (EFIAPI *EFI_CALCULATE_CRC32)(\r |
| 959ccb23 | 1109 | IN VOID *Data,\r |
| 1110 | IN UINTN DataSize,\r | |
| 1111 | OUT UINT32 *Crc32\r | |
| 1112 | );\r | |
| 1113 | \r | |
| 1114 | /**\r | |
| 1115 | Copies the contents of one buffer to another buffer.\r | |
| 1116 | \r | |
| d3d92557 FT |
1117 | @param[in] Destination The pointer to the destination buffer of the memory copy.\r |
| 1118 | @param[in] Source The pointer to the source buffer of the memory copy.\r | |
| 1119 | @param[in] Length Number of bytes to copy from Source to Destination.\r | |
| 959ccb23 | 1120 | \r |
| 1121 | **/\r | |
| 1122 | typedef\r | |
| 1123 | VOID\r | |
| 8b13229b | 1124 | (EFIAPI *EFI_COPY_MEM)(\r |
| 959ccb23 | 1125 | IN VOID *Destination,\r |
| 1126 | IN VOID *Source,\r | |
| 1127 | IN UINTN Length\r | |
| 1128 | );\r | |
| 1129 | \r | |
| 1130 | /**\r | |
| 1131 | The SetMem() function fills a buffer with a specified value.\r | |
| 1132 | \r | |
| d3d92557 FT |
1133 | @param[in] Buffer The pointer to the buffer to fill.\r |
| 1134 | @param[in] Size Number of bytes in Buffer to fill.\r | |
| 1135 | @param[in] Value Value to fill Buffer with.\r | |
| 959ccb23 | 1136 | \r |
| 1137 | **/\r | |
| 1138 | typedef\r | |
| 1139 | VOID\r | |
| 8b13229b | 1140 | (EFIAPI *EFI_SET_MEM)(\r |
| 959ccb23 | 1141 | IN VOID *Buffer,\r |
| 1142 | IN UINTN Size,\r | |
| 1143 | IN UINT8 Value\r | |
| 1144 | );\r | |
| 1145 | \r | |
| 2a3f6a21 | 1146 | ///\r |
| 1147 | /// Enumeration of EFI Interface Types\r | |
| 1148 | ///\r | |
| 959ccb23 | 1149 | typedef enum {\r |
| 2a3f6a21 | 1150 | ///\r |
| 1151 | /// Indicates that the supplied protocol interface is supplied in native form.\r | |
| 1152 | ///\r | |
| 959ccb23 | 1153 | EFI_NATIVE_INTERFACE\r |
| 1154 | } EFI_INTERFACE_TYPE;\r | |
| 1155 | \r | |
| 1156 | /**\r | |
| 1157 | Installs a protocol interface on a device handle. If the handle does not exist, it is created and added\r | |
| 1158 | to the list of handles in the system. InstallMultipleProtocolInterfaces() performs\r | |
| 1159 | more error checking than InstallProtocolInterface(), so it is recommended that\r | |
| 1160 | InstallMultipleProtocolInterfaces() be used in place of\r | |
| 1161 | InstallProtocolInterface()\r | |
| 1162 | \r | |
| d3d92557 FT |
1163 | @param[in, out] Handle A pointer to the EFI_HANDLE on which the interface is to be installed.\r |
| 1164 | @param[in] Protocol The numeric ID of the protocol interface.\r | |
| 1165 | @param[in] InterfaceType Indicates whether Interface is supplied in native form.\r | |
| 1166 | @param[in] Interface A pointer to the protocol interface.\r | |
| 959ccb23 | 1167 | \r |
| 1168 | @retval EFI_SUCCESS The protocol interface was installed.\r | |
| 1169 | @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.\r | |
| e0c047a0 | 1170 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
| 1171 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
| 1172 | @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.\r | |
| 1173 | @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.\r | |
| 959ccb23 | 1174 | \r |
| 1175 | **/\r | |
| 1176 | typedef\r | |
| 1177 | EFI_STATUS\r | |
| 8b13229b | 1178 | (EFIAPI *EFI_INSTALL_PROTOCOL_INTERFACE)(\r |
| 959ccb23 | 1179 | IN OUT EFI_HANDLE *Handle,\r |
| 1180 | IN EFI_GUID *Protocol,\r | |
| 1181 | IN EFI_INTERFACE_TYPE InterfaceType,\r | |
| 1182 | IN VOID *Interface\r | |
| 1183 | );\r | |
| 1184 | \r | |
| 1185 | /**\r | |
| 1186 | Installs one or more protocol interfaces into the boot services environment.\r | |
| 1187 | \r | |
| d3d92557 | 1188 | @param[in, out] Handle The pointer to a handle to install the new protocol interfaces on,\r |
| 4a23eaa9 | 1189 | or a pointer to NULL if a new handle is to be allocated.\r |
| 959ccb23 | 1190 | @param ... A variable argument list containing pairs of protocol GUIDs and protocol\r |
| 1191 | interfaces.\r | |
| 1192 | \r | |
| 1193 | @retval EFI_SUCCESS All the protocol interface was installed.\r | |
| 1194 | @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r | |
| 1195 | @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in\r | |
| 1196 | the handle database.\r | |
| 5a7b9bbe SQ |
1197 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
| 1198 | @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.\r | |
| 959ccb23 | 1199 | \r |
| 1200 | **/\r | |
| 1201 | typedef\r | |
| 1202 | EFI_STATUS\r | |
| 8b13229b | 1203 | (EFIAPI *EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES)(\r |
| 959ccb23 | 1204 | IN OUT EFI_HANDLE *Handle,\r |
| 1205 | ...\r | |
| 1206 | );\r | |
| 1207 | \r | |
| 1208 | /**\r | |
| 1209 | Reinstalls a protocol interface on a device handle.\r | |
| 1210 | \r | |
| d3d92557 FT |
1211 | @param[in] Handle Handle on which the interface is to be reinstalled.\r |
| 1212 | @param[in] Protocol The numeric ID of the interface.\r | |
| 1213 | @param[in] OldInterface A pointer to the old interface. NULL can be used if a structure is not\r | |
| 959ccb23 | 1214 | associated with Protocol.\r |
| d3d92557 | 1215 | @param[in] NewInterface A pointer to the new interface.\r |
| 959ccb23 | 1216 | \r |
| 1217 | @retval EFI_SUCCESS The protocol interface was reinstalled.\r | |
| 1218 | @retval EFI_NOT_FOUND The OldInterface on the handle was not found.\r | |
| 1219 | @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,\r | |
| 1220 | because OldInterface is still being used by a\r | |
| 1221 | driver that will not release it.\r | |
| 18bd7e85 | 1222 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
| e0c047a0 | 1223 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
| 959ccb23 | 1224 | \r |
| 1225 | **/\r | |
| 1226 | typedef\r | |
| 1227 | EFI_STATUS\r | |
| 8b13229b | 1228 | (EFIAPI *EFI_REINSTALL_PROTOCOL_INTERFACE)(\r |
| 959ccb23 | 1229 | IN EFI_HANDLE Handle,\r |
| 1230 | IN EFI_GUID *Protocol,\r | |
| 1231 | IN VOID *OldInterface,\r | |
| 1232 | IN VOID *NewInterface\r | |
| 1233 | );\r | |
| 1234 | \r | |
| 1235 | /**\r | |
| 1236 | Removes a protocol interface from a device handle. It is recommended that\r | |
| 1237 | UninstallMultipleProtocolInterfaces() be used in place of\r | |
| 1238 | UninstallProtocolInterface().\r | |
| 1239 | \r | |
| d3d92557 FT |
1240 | @param[in] Handle The handle on which the interface was installed.\r |
| 1241 | @param[in] Protocol The numeric ID of the interface.\r | |
| 1242 | @param[in] Interface A pointer to the interface.\r | |
| 959ccb23 | 1243 | \r |
| 1244 | @retval EFI_SUCCESS The interface was removed.\r | |
| 1245 | @retval EFI_NOT_FOUND The interface was not found.\r | |
| 1246 | @retval EFI_ACCESS_DENIED The interface was not removed because the interface\r | |
| 1247 | is still being used by a driver.\r | |
| 18bd7e85 | 1248 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
| e0c047a0 | 1249 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
| 959ccb23 | 1250 | \r |
| 1251 | **/\r | |
| 1252 | typedef\r | |
| 1253 | EFI_STATUS\r | |
| 8b13229b | 1254 | (EFIAPI *EFI_UNINSTALL_PROTOCOL_INTERFACE)(\r |
| 959ccb23 | 1255 | IN EFI_HANDLE Handle,\r |
| 1256 | IN EFI_GUID *Protocol,\r | |
| 1257 | IN VOID *Interface\r | |
| 1258 | );\r | |
| 1259 | \r | |
| 1260 | /**\r | |
| 1261 | Removes one or more protocol interfaces into the boot services environment.\r | |
| 1262 | \r | |
| d3d92557 | 1263 | @param[in] Handle The handle to remove the protocol interfaces from.\r |
| 959ccb23 | 1264 | @param ... A variable argument list containing pairs of protocol GUIDs and\r |
| 1265 | protocol interfaces.\r | |
| 1266 | \r | |
| 1267 | @retval EFI_SUCCESS All the protocol interfaces were removed.\r | |
| 1268 | @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.\r | |
| 1269 | \r | |
| 1270 | **/\r | |
| 1271 | typedef\r | |
| 1272 | EFI_STATUS\r | |
| 8b13229b | 1273 | (EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES)(\r |
| 959ccb23 | 1274 | IN EFI_HANDLE Handle,\r |
| 1275 | ...\r | |
| 1276 | );\r | |
| 1277 | \r | |
| 1278 | /**\r | |
| 1279 | Queries a handle to determine if it supports a specified protocol.\r | |
| 1280 | \r | |
| d3d92557 FT |
1281 | @param[in] Handle The handle being queried.\r |
| 1282 | @param[in] Protocol The published unique identifier of the protocol.\r | |
| 1283 | @param[out] Interface Supplies the address where a pointer to the corresponding Protocol\r | |
| 959ccb23 | 1284 | Interface is returned.\r |
| e0c047a0 | 1285 | \r |
| 959ccb23 | 1286 | @retval EFI_SUCCESS The interface information for the specified protocol was returned.\r |
| 1287 | @retval EFI_UNSUPPORTED The device does not support the specified protocol.\r | |
| 18bd7e85 | 1288 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
| e0c047a0 | 1289 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
| 1290 | @retval EFI_INVALID_PARAMETER Interface is NULL.\r | |
| 959ccb23 | 1291 | \r |
| 1292 | **/\r | |
| 1293 | typedef\r | |
| 1294 | EFI_STATUS\r | |
| 8b13229b | 1295 | (EFIAPI *EFI_HANDLE_PROTOCOL)(\r |
| 959ccb23 | 1296 | IN EFI_HANDLE Handle,\r |
| 1297 | IN EFI_GUID *Protocol,\r | |
| 1298 | OUT VOID **Interface\r | |
| 1299 | );\r | |
| 1300 | \r | |
| 1301 | #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001\r | |
| 1302 | #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002\r | |
| 1303 | #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004\r | |
| 1304 | #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008\r | |
| 1305 | #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010\r | |
| 1306 | #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020\r | |
| 1307 | \r | |
| 1308 | /**\r | |
| 1309 | Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the\r | |
| 1310 | handle, it opens the protocol on behalf of the calling agent.\r | |
| 1311 | \r | |
| d3d92557 FT |
1312 | @param[in] Handle The handle for the protocol interface that is being opened.\r |
| 1313 | @param[in] Protocol The published unique identifier of the protocol.\r | |
| 1314 | @param[out] Interface Supplies the address where a pointer to the corresponding Protocol\r | |
| 959ccb23 | 1315 | Interface is returned.\r |
| d3d92557 | 1316 | @param[in] AgentHandle The handle of the agent that is opening the protocol interface\r |
| 959ccb23 | 1317 | specified by Protocol and Interface.\r |
| d3d92557 | 1318 | @param[in] ControllerHandle If the agent that is opening a protocol is a driver that follows the\r |
| 959ccb23 | 1319 | UEFI Driver Model, then this parameter is the controller handle\r |
| 1320 | that requires the protocol interface. If the agent does not follow\r | |
| 1321 | the UEFI Driver Model, then this parameter is optional and may\r | |
| 1322 | be NULL.\r | |
| d3d92557 | 1323 | @param[in] Attributes The open mode of the protocol interface specified by Handle\r |
| 959ccb23 | 1324 | and Protocol.\r |
| 1325 | \r | |
| 1326 | @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the\r | |
| 1327 | protocol interface was returned in Interface.\r | |
| 1328 | @retval EFI_UNSUPPORTED Handle does not support Protocol.\r | |
| 1329 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
| 1330 | @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.\r | |
| 1331 | @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent\r | |
| 1332 | handle is the same as AgentHandle.\r | |
| 1333 | \r | |
| 1334 | **/\r | |
| 1335 | typedef\r | |
| 1336 | EFI_STATUS\r | |
| 8b13229b | 1337 | (EFIAPI *EFI_OPEN_PROTOCOL)(\r |
| 959ccb23 | 1338 | IN EFI_HANDLE Handle,\r |
| 1339 | IN EFI_GUID *Protocol,\r | |
| e0c047a0 | 1340 | OUT VOID **Interface, OPTIONAL\r |
| 959ccb23 | 1341 | IN EFI_HANDLE AgentHandle,\r |
| e0c047a0 | 1342 | IN EFI_HANDLE ControllerHandle,\r |
| 959ccb23 | 1343 | IN UINT32 Attributes\r |
| 1344 | );\r | |
| 1345 | \r | |
| 1346 | \r | |
| 1347 | /**\r | |
| 1348 | Closes a protocol on a handle that was opened using OpenProtocol().\r | |
| 1349 | \r | |
| d3d92557 | 1350 | @param[in] Handle The handle for the protocol interface that was previously opened\r |
| 959ccb23 | 1351 | with OpenProtocol(), and is now being closed.\r |
| d3d92557 FT |
1352 | @param[in] Protocol The published unique identifier of the protocol.\r |
| 1353 | @param[in] AgentHandle The handle of the agent that is closing the protocol interface.\r | |
| 1354 | @param[in] ControllerHandle If the agent that opened a protocol is a driver that follows the\r | |
| 959ccb23 | 1355 | UEFI Driver Model, then this parameter is the controller handle\r |
| 1356 | that required the protocol interface.\r | |
| 1357 | \r | |
| 1358 | @retval EFI_SUCCESS The protocol instance was closed.\r | |
| d9de7921 RN |
1359 | @retval EFI_INVALID_PARAMETER 1) Handle is NULL.\r |
| 1360 | 2) AgentHandle is NULL.\r | |
| e0c047a0 | 1361 | 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.\r |
| 1362 | 4) Protocol is NULL.\r | |
| 959ccb23 | 1363 | @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.\r |
| 1364 | 2) The protocol interface specified by Handle and Protocol is not\r | |
| 1365 | currently open by AgentHandle and ControllerHandle.\r | |
| 1366 | \r | |
| 1367 | **/\r | |
| 1368 | typedef\r | |
| 1369 | EFI_STATUS\r | |
| 8b13229b | 1370 | (EFIAPI *EFI_CLOSE_PROTOCOL)(\r |
| 959ccb23 | 1371 | IN EFI_HANDLE Handle,\r |
| 1372 | IN EFI_GUID *Protocol,\r | |
| 1373 | IN EFI_HANDLE AgentHandle,\r | |
| 1374 | IN EFI_HANDLE ControllerHandle\r | |
| 1375 | );\r | |
| 1376 | \r | |
| 2a3f6a21 | 1377 | ///\r |
| 1378 | /// EFI Oprn Protocol Information Entry\r | |
| 1379 | ///\r | |
| 959ccb23 | 1380 | typedef struct {\r |
| 1381 | EFI_HANDLE AgentHandle;\r | |
| 1382 | EFI_HANDLE ControllerHandle;\r | |
| 1383 | UINT32 Attributes;\r | |
| 1384 | UINT32 OpenCount;\r | |
| 1385 | } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY;\r | |
| 1386 | \r | |
| 1387 | /**\r | |
| 1388 | Retrieves the list of agents that currently have a protocol interface opened.\r | |
| 1389 | \r | |
| d3d92557 FT |
1390 | @param[in] Handle The handle for the protocol interface that is being queried.\r |
| 1391 | @param[in] Protocol The published unique identifier of the protocol.\r | |
| 1392 | @param[out] EntryBuffer A pointer to a buffer of open protocol information in the form of\r | |
| 959ccb23 | 1393 | EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.\r |
| d3d92557 | 1394 | @param[out] EntryCount A pointer to the number of entries in EntryBuffer.\r |
| 959ccb23 | 1395 | \r |
| 1396 | @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the\r | |
| 1397 | number of entries was returned EntryCount.\r | |
| 1398 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.\r | |
| 1399 | @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.\r | |
| 1400 | \r | |
| 1401 | **/\r | |
| 1402 | typedef\r | |
| 1403 | EFI_STATUS\r | |
| 8b13229b | 1404 | (EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION)(\r |
| 959ccb23 | 1405 | IN EFI_HANDLE Handle,\r |
| 1406 | IN EFI_GUID *Protocol,\r | |
| e0c047a0 | 1407 | OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,\r |
| 959ccb23 | 1408 | OUT UINTN *EntryCount\r |
| 1409 | );\r | |
| 1410 | \r | |
| 1411 | /**\r | |
| 1412 | Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated\r | |
| 1413 | from pool.\r | |
| 1414 | \r | |
| d3d92557 FT |
1415 | @param[in] Handle The handle from which to retrieve the list of protocol interface\r |
| 1416 | GUIDs.\r | |
| 1417 | @param[out] ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are\r | |
| 1418 | installed on Handle.\r | |
| 1419 | @param[out] ProtocolBufferCount A pointer to the number of GUID pointers present in\r | |
| 1420 | ProtocolBuffer.\r | |
| 959ccb23 | 1421 | \r |
| 1422 | @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in\r | |
| 1423 | ProtocolBuffer. The number of protocol interface GUIDs was\r | |
| 1424 | returned in ProtocolBufferCount.\r | |
| 1425 | @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.\r | |
| e0c047a0 | 1426 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
| 1427 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r | |
| 1428 | @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.\r | |
| 1429 | @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.\r | |
| 959ccb23 | 1430 | \r |
| 1431 | **/\r | |
| 1432 | typedef\r | |
| 1433 | EFI_STATUS\r | |
| 8b13229b | 1434 | (EFIAPI *EFI_PROTOCOLS_PER_HANDLE)(\r |
| 959ccb23 | 1435 | IN EFI_HANDLE Handle,\r |
| 1436 | OUT EFI_GUID ***ProtocolBuffer,\r | |
| 1437 | OUT UINTN *ProtocolBufferCount\r | |
| 1438 | );\r | |
| 1439 | \r | |
| 1440 | /**\r | |
| 1441 | Creates an event that is to be signaled whenever an interface is installed for a specified protocol.\r | |
| 1442 | \r | |
| d3d92557 FT |
1443 | @param[in] Protocol The numeric ID of the protocol for which the event is to be registered.\r |
| 1444 | @param[in] Event Event that is to be signaled whenever a protocol interface is registered\r | |
| 959ccb23 | 1445 | for Protocol.\r |
| d3d92557 | 1446 | @param[out] Registration A pointer to a memory location to receive the registration value.\r |
| 959ccb23 | 1447 | \r |
| 1448 | @retval EFI_SUCCESS The notification event has been registered.\r | |
| 1449 | @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.\r | |
| e0c047a0 | 1450 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
| 1451 | @retval EFI_INVALID_PARAMETER Event is NULL.\r | |
| 1452 | @retval EFI_INVALID_PARAMETER Registration is NULL.\r | |
| 959ccb23 | 1453 | \r |
| 1454 | **/\r | |
| 1455 | typedef\r | |
| 1456 | EFI_STATUS\r | |
| 8b13229b | 1457 | (EFIAPI *EFI_REGISTER_PROTOCOL_NOTIFY)(\r |
| 959ccb23 | 1458 | IN EFI_GUID *Protocol,\r |
| 1459 | IN EFI_EVENT Event,\r | |
| 1460 | OUT VOID **Registration\r | |
| 1461 | );\r | |
| 1462 | \r | |
| 2a3f6a21 | 1463 | ///\r |
| 1464 | /// Enumeration of EFI Locate Search Types\r | |
| 1465 | ///\r | |
| 959ccb23 | 1466 | typedef enum {\r |
| 2a3f6a21 | 1467 | ///\r |
| 1468 | /// Retrieve all the handles in the handle database.\r | |
| 1469 | ///\r | |
| 959ccb23 | 1470 | AllHandles,\r |
| 2a3f6a21 | 1471 | ///\r |
| 1472 | /// Retrieve the next handle fron a RegisterProtocolNotify() event.\r | |
| 1473 | ///\r | |
| 959ccb23 | 1474 | ByRegisterNotify,\r |
| 2a3f6a21 | 1475 | ///\r |
| 9095d37b | 1476 | /// Retrieve the set of handles from the handle database that support a\r |
| 2a3f6a21 | 1477 | /// specified protocol.\r |
| 1478 | ///\r | |
| 959ccb23 | 1479 | ByProtocol\r |
| 1480 | } EFI_LOCATE_SEARCH_TYPE;\r | |
| 1481 | \r | |
| 1482 | /**\r | |
| 1483 | Returns an array of handles that support a specified protocol.\r | |
| 1484 | \r | |
| d3d92557 FT |
1485 | @param[in] SearchType Specifies which handle(s) are to be returned.\r |
| 1486 | @param[in] Protocol Specifies the protocol to search by.\r | |
| 1487 | @param[in] SearchKey Specifies the search key.\r | |
| 1488 | @param[in, out] BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of\r | |
| 959ccb23 | 1489 | the array returned in Buffer (if the buffer was large enough) or the\r |
| 1490 | size, in bytes, of the buffer needed to obtain the array (if the buffer was\r | |
| 1491 | not large enough).\r | |
| d3d92557 | 1492 | @param[out] Buffer The buffer in which the array is returned.\r |
| 959ccb23 | 1493 | \r |
| 1494 | @retval EFI_SUCCESS The array of handles was returned.\r | |
| 1495 | @retval EFI_NOT_FOUND No handles match the search.\r | |
| 1496 | @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.\r | |
| e0c047a0 | 1497 | @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.\r |
| 1498 | @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.\r | |
| 1499 | @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.\r | |
| 1500 | @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.\r | |
| 1501 | @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.\r | |
| 959ccb23 | 1502 | \r |
| 1503 | **/\r | |
| 1504 | typedef\r | |
| 1505 | EFI_STATUS\r | |
| 8b13229b | 1506 | (EFIAPI *EFI_LOCATE_HANDLE)(\r |
| 959ccb23 | 1507 | IN EFI_LOCATE_SEARCH_TYPE SearchType,\r |
| 1508 | IN EFI_GUID *Protocol, OPTIONAL\r | |
| 1509 | IN VOID *SearchKey, OPTIONAL\r | |
| 1510 | IN OUT UINTN *BufferSize,\r | |
| 1511 | OUT EFI_HANDLE *Buffer\r | |
| 1512 | );\r | |
| 1513 | \r | |
| 1514 | /**\r | |
| 1515 | Locates the handle to a device on the device path that supports the specified protocol.\r | |
| 1516 | \r | |
| d3d92557 FT |
1517 | @param[in] Protocol Specifies the protocol to search for.\r |
| 1518 | @param[in, out] DevicePath On input, a pointer to a pointer to the device path. On output, the device\r | |
| 959ccb23 | 1519 | path pointer is modified to point to the remaining part of the device\r |
| 1520 | path.\r | |
| d3d92557 | 1521 | @param[out] Device A pointer to the returned device handle.\r |
| 959ccb23 | 1522 | \r |
| 1523 | @retval EFI_SUCCESS The resulting handle was returned.\r | |
| 1524 | @retval EFI_NOT_FOUND No handles match the search.\r | |
| e0c047a0 | 1525 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
| 1526 | @retval EFI_INVALID_PARAMETER DevicePath is NULL.\r | |
| 1527 | @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.\r | |
| 959ccb23 | 1528 | \r |
| 1529 | **/\r | |
| 1530 | typedef\r | |
| 1531 | EFI_STATUS\r | |
| 8b13229b | 1532 | (EFIAPI *EFI_LOCATE_DEVICE_PATH)(\r |
| 959ccb23 | 1533 | IN EFI_GUID *Protocol,\r |
| 1534 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,\r | |
| 1535 | OUT EFI_HANDLE *Device\r | |
| 1536 | );\r | |
| 1537 | \r | |
| 1538 | /**\r | |
| 1539 | Adds, updates, or removes a configuration table entry from the EFI System Table.\r | |
| 1540 | \r | |
| d3d92557 FT |
1541 | @param[in] Guid A pointer to the GUID for the entry to add, update, or remove.\r |
| 1542 | @param[in] Table A pointer to the configuration table for the entry to add, update, or\r | |
| 959ccb23 | 1543 | remove. May be NULL.\r |
| 1544 | \r | |
| 1545 | @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.\r | |
| 1546 | @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.\r | |
| bfe0572b | 1547 | @retval EFI_INVALID_PARAMETER Guid is NULL.\r |
| 959ccb23 | 1548 | @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.\r |
| 1549 | \r | |
| 1550 | **/\r | |
| 1551 | typedef\r | |
| 1552 | EFI_STATUS\r | |
| 8b13229b | 1553 | (EFIAPI *EFI_INSTALL_CONFIGURATION_TABLE)(\r |
| 959ccb23 | 1554 | IN EFI_GUID *Guid,\r |
| 1555 | IN VOID *Table\r | |
| 1556 | );\r | |
| 1557 | \r | |
| 959ccb23 | 1558 | /**\r |
| 1559 | Returns an array of handles that support the requested protocol in a buffer allocated from pool.\r | |
| 1560 | \r | |
| d3d92557 FT |
1561 | @param[in] SearchType Specifies which handle(s) are to be returned.\r |
| 1562 | @param[in] Protocol Provides the protocol to search by.\r | |
| e0c047a0 | 1563 | This parameter is only valid for a SearchType of ByProtocol.\r |
| d3d92557 | 1564 | @param[in] SearchKey Supplies the search key depending on the SearchType.\r |
| ff95c0fc | 1565 | @param[out] NoHandles The number of handles returned in Buffer.\r |
| d3d92557 | 1566 | @param[out] Buffer A pointer to the buffer to return the requested array of handles that\r |
| 959ccb23 | 1567 | support Protocol.\r |
| 1568 | \r | |
| 1569 | @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of\r | |
| 1570 | handles in Buffer was returned in NoHandles.\r | |
| 1571 | @retval EFI_NOT_FOUND No handles match the search.\r | |
| 1572 | @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.\r | |
| e0c047a0 | 1573 | @retval EFI_INVALID_PARAMETER NoHandles is NULL.\r |
| 1574 | @retval EFI_INVALID_PARAMETER Buffer is NULL.\r | |
| 959ccb23 | 1575 | \r |
| 1576 | **/\r | |
| 1577 | typedef\r | |
| 1578 | EFI_STATUS\r | |
| 8b13229b | 1579 | (EFIAPI *EFI_LOCATE_HANDLE_BUFFER)(\r |
| 959ccb23 | 1580 | IN EFI_LOCATE_SEARCH_TYPE SearchType,\r |
| 1581 | IN EFI_GUID *Protocol, OPTIONAL\r | |
| 1582 | IN VOID *SearchKey, OPTIONAL\r | |
| ff95c0fc | 1583 | OUT UINTN *NoHandles,\r |
| 959ccb23 | 1584 | OUT EFI_HANDLE **Buffer\r |
| 1585 | );\r | |
| 1586 | \r | |
| 1587 | /**\r | |
| 1588 | Returns the first protocol instance that matches the given protocol.\r | |
| 1589 | \r | |
| d3d92557 FT |
1590 | @param[in] Protocol Provides the protocol to search for.\r |
| 1591 | @param[in] Registration Optional registration key returned from\r | |
| 959ccb23 | 1592 | RegisterProtocolNotify().\r |
| d3d92557 | 1593 | @param[out] Interface On return, a pointer to the first interface that matches Protocol and\r |
| 959ccb23 | 1594 | Registration.\r |
| 1595 | \r | |
| 1596 | @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in\r | |
| 1597 | Interface.\r | |
| 1598 | @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and\r | |
| 1599 | Registration.\r | |
| 1600 | @retval EFI_INVALID_PARAMETER Interface is NULL.\r | |
| d65f7eeb | 1601 | Protocol is NULL.\r |
| 959ccb23 | 1602 | \r |
| 1603 | **/\r | |
| 1604 | typedef\r | |
| 1605 | EFI_STATUS\r | |
| 8b13229b | 1606 | (EFIAPI *EFI_LOCATE_PROTOCOL)(\r |
| 959ccb23 | 1607 | IN EFI_GUID *Protocol,\r |
| 1608 | IN VOID *Registration, OPTIONAL\r | |
| 1609 | OUT VOID **Interface\r | |
| 1610 | );\r | |
| 1611 | \r | |
| 2a3f6a21 | 1612 | ///\r |
| 1613 | /// EFI Capsule Block Descriptor\r | |
| 1614 | ///\r | |
| 959ccb23 | 1615 | typedef struct {\r |
| 1bf79370 LG |
1616 | ///\r |
| 1617 | /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.\r | |
| 1618 | ///\r | |
| 2a3f6a21 | 1619 | UINT64 Length;\r |
| 959ccb23 | 1620 | union {\r |
| 1bf79370 LG |
1621 | ///\r |
| 1622 | /// Physical address of the data block. This member of the union is\r | |
| 1623 | /// used if Length is not equal to zero.\r | |
| 1624 | ///\r | |
| 959ccb23 | 1625 | EFI_PHYSICAL_ADDRESS DataBlock;\r |
| 1bf79370 LG |
1626 | ///\r |
| 1627 | /// Physical address of another block of\r | |
| 1628 | /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This\r | |
| 1629 | /// member of the union is used if Length is equal to zero. If\r | |
| 1630 | /// ContinuationPointer is zero this entry represents the end of the list.\r | |
| 1631 | ///\r | |
| 959ccb23 | 1632 | EFI_PHYSICAL_ADDRESS ContinuationPointer;\r |
| 1633 | } Union;\r | |
| 45ad5569 | 1634 | } EFI_CAPSULE_BLOCK_DESCRIPTOR;\r |
| 959ccb23 | 1635 | \r |
| 2a3f6a21 | 1636 | ///\r |
| af2dc6a7 | 1637 | /// EFI Capsule Header.\r |
| 2a3f6a21 | 1638 | ///\r |
| 959ccb23 | 1639 | typedef struct {\r |
| 1bf79370 LG |
1640 | ///\r |
| 1641 | /// A GUID that defines the contents of a capsule.\r | |
| 1642 | ///\r | |
| 959ccb23 | 1643 | EFI_GUID CapsuleGuid;\r |
| 1bf79370 LG |
1644 | ///\r |
| 1645 | /// The size of the capsule header. This may be larger than the size of\r | |
| 1646 | /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply\r | |
| 1647 | /// extended header entries\r | |
| 1648 | ///\r | |
| 959ccb23 | 1649 | UINT32 HeaderSize;\r |
| 1bf79370 LG |
1650 | ///\r |
| 1651 | /// Bit-mapped list describing the capsule attributes. The Flag values\r | |
| f6d2bcc6 | 1652 | /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values\r |
| a0d58c21 | 1653 | /// of 0x10000 - 0xFFFFFFFF are defined by this specification\r |
| 1bf79370 | 1654 | ///\r |
| 959ccb23 | 1655 | UINT32 Flags;\r |
| 1bf79370 LG |
1656 | ///\r |
| 1657 | /// Size in bytes of the capsule.\r | |
| 1658 | ///\r | |
| 959ccb23 | 1659 | UINT32 CapsuleImageSize;\r |
| 45ad5569 | 1660 | } EFI_CAPSULE_HEADER;\r |
| 959ccb23 | 1661 | \r |
| 1bf79370 LG |
1662 | ///\r |
| 1663 | /// The EFI System Table entry must point to an array of capsules\r | |
| 1664 | /// that contain the same CapsuleGuid value. The array must be\r | |
| 1665 | /// prefixed by a UINT32 that represents the size of the array of capsules.\r | |
| 1666 | ///\r | |
| 176a6bb3 | 1667 | typedef struct {\r |
| 1bf79370 LG |
1668 | ///\r |
| 1669 | /// the size of the array of capsules.\r | |
| 1670 | ///\r | |
| 176a6bb3 | 1671 | UINT32 CapsuleArrayNumber;\r |
| 1bf79370 LG |
1672 | ///\r |
| 1673 | /// Point to an array of capsules that contain the same CapsuleGuid value.\r | |
| 1674 | ///\r | |
| 176a6bb3 LG |
1675 | VOID* CapsulePtr[1];\r |
| 1676 | } EFI_CAPSULE_TABLE;\r | |
| 1677 | \r | |
| 959ccb23 | 1678 | #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000\r |
| 1679 | #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000\r | |
| eaa8a234 | 1680 | #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000\r |
| 959ccb23 | 1681 | \r |
| 1682 | /**\r | |
| 1683 | Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended\r | |
| 1684 | consumption, the firmware may process the capsule immediately. If the payload should persist\r | |
| 1685 | across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must\r | |
| 1686 | be passed into ResetSystem() and will cause the capsule to be processed by the firmware as\r | |
| 1687 | part of the reset process.\r | |
| 1688 | \r | |
| d3d92557 FT |
1689 | @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r |
| 1690 | being passed into update capsule.\r | |
| 1691 | @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
| 1692 | CaspuleHeaderArray.\r | |
| 1693 | @param[in] ScatterGatherList Physical pointer to a set of\r | |
| 1694 | EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r | |
| 1695 | location in physical memory of a set of capsules.\r | |
| 959ccb23 | 1696 | \r |
| 1697 | @retval EFI_SUCCESS Valid capsule was passed. If\r | |
| 1698 | CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the\r | |
| 1699 | capsule has been successfully processed by the firmware.\r | |
| eaa8a234 | 1700 | @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were\r |
| 1701 | set in the capsule header.\r | |
| a0d58c21 | 1702 | @retval EFI_INVALID_PARAMETER CapsuleCount is 0.\r |
| 959ccb23 | 1703 | @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r |
| e0c047a0 | 1704 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.\r |
| 9095d37b LG |
1705 | @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule\r |
| 1706 | is compatible with this platform but is not capable of being submitted or processed\r | |
| efdabc6c | 1707 | in runtime. The caller may resubmit the capsule prior to ExitBootServices().\r |
| 9095d37b | 1708 | @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates\r |
| efdabc6c | 1709 | the capsule is compatible with this platform but there are insufficient resources to process.\r |
| 959ccb23 | 1710 | \r |
| 1711 | **/\r | |
| 1712 | typedef\r | |
| 1713 | EFI_STATUS\r | |
| 8b13229b | 1714 | (EFIAPI *EFI_UPDATE_CAPSULE)(\r |
| 531febc2 | 1715 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
| 959ccb23 | 1716 | IN UINTN CapsuleCount,\r |
| 1717 | IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r | |
| 1718 | );\r | |
| 1719 | \r | |
| 1720 | /**\r | |
| 1721 | Returns if the capsule can be supported via UpdateCapsule().\r | |
| 1722 | \r | |
| d3d92557 FT |
1723 | @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r |
| 1724 | being passed into update capsule.\r | |
| 1725 | @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
| 1726 | CaspuleHeaderArray.\r | |
| 1727 | @param[out] MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can\r | |
| 1728 | support as an argument to UpdateCapsule() via\r | |
| 1729 | CapsuleHeaderArray and ScatterGatherList.\r | |
| 1730 | @param[out] ResetType Returns the type of reset required for the capsule update.\r | |
| 959ccb23 | 1731 | \r |
| 1732 | @retval EFI_SUCCESS Valid answer returned.\r | |
| 1733 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r | |
| 1734 | MaximumCapsuleSize and ResetType are undefined.\r | |
| 1735 | @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r | |
| 9095d37b LG |
1736 | @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule\r |
| 1737 | is compatible with this platform but is not capable of being submitted or processed\r | |
| efdabc6c | 1738 | in runtime. The caller may resubmit the capsule prior to ExitBootServices().\r |
| 9095d37b | 1739 | @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates\r |
| efdabc6c | 1740 | the capsule is compatible with this platform but there are insufficient resources to process.\r |
| 959ccb23 | 1741 | \r |
| 1742 | **/\r | |
| 1743 | typedef\r | |
| 1744 | EFI_STATUS\r | |
| 8b13229b | 1745 | (EFIAPI *EFI_QUERY_CAPSULE_CAPABILITIES)(\r |
| 531febc2 | 1746 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
| 959ccb23 | 1747 | IN UINTN CapsuleCount,\r |
| 1748 | OUT UINT64 *MaximumCapsuleSize,\r | |
| 1749 | OUT EFI_RESET_TYPE *ResetType\r | |
| 1750 | );\r | |
| 1751 | \r | |
| 1752 | /**\r | |
| 1753 | Returns information about the EFI variables.\r | |
| 1754 | \r | |
| d3d92557 FT |
1755 | @param[in] Attributes Attributes bitmask to specify the type of variables on\r |
| 1756 | which to return information.\r | |
| 1757 | @param[out] MaximumVariableStorageSize On output the maximum size of the storage space\r | |
| 1758 | available for the EFI variables associated with the\r | |
| 1759 | attributes specified.\r | |
| 1760 | @param[out] RemainingVariableStorageSize Returns the remaining size of the storage space\r | |
| 1761 | available for the EFI variables associated with the\r | |
| 1762 | attributes specified.\r | |
| 1763 | @param[out] MaximumVariableSize Returns the maximum size of the individual EFI\r | |
| 1764 | variables associated with the attributes specified.\r | |
| 959ccb23 | 1765 | \r |
| 1766 | @retval EFI_SUCCESS Valid answer returned.\r | |
| 1767 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied\r | |
| 1768 | @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r | |
| 1769 | MaximumVariableStorageSize,\r | |
| 1770 | RemainingVariableStorageSize, MaximumVariableSize\r | |
| 1771 | are undefined.\r | |
| 1772 | \r | |
| 1773 | **/\r | |
| 1774 | typedef\r | |
| 1775 | EFI_STATUS\r | |
| 8b13229b | 1776 | (EFIAPI *EFI_QUERY_VARIABLE_INFO)(\r |
| 959ccb23 | 1777 | IN UINT32 Attributes,\r |
| 1778 | OUT UINT64 *MaximumVariableStorageSize,\r | |
| 1779 | OUT UINT64 *RemainingVariableStorageSize,\r | |
| 1780 | OUT UINT64 *MaximumVariableSize\r | |
| 1781 | );\r | |
| 1782 | \r | |
| b5eb03cf | 1783 | //\r |
| 1784 | // Firmware should stop at a firmware user interface on next boot\r | |
| 1785 | //\r | |
| 566771b0 | 1786 | #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001\r |
| 1787 | #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002\r | |
| 1788 | #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004\r | |
| 1789 | #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008\r | |
| 1790 | #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010\r | |
| 83952535 | 1791 | #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040\r |
| 154e243a | 1792 | #define EFI_OS_INDICATIONS_JSON_CONFIG_DATA_REFRESH 0x0000000000000080\r |
| 959ccb23 | 1793 | \r |
| 1794 | //\r | |
| 1795 | // EFI Runtime Services Table\r | |
| 1796 | //\r | |
| 07636730 | 1797 | #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')\r |
| 2552fd58 | 1798 | #define EFI_2_80_SYSTEM_TABLE_REVISION ((2 << 16) | (80))\r |
| fee5ea2c | 1799 | #define EFI_2_70_SYSTEM_TABLE_REVISION ((2 << 16) | (70))\r |
| ed5e386a | 1800 | #define EFI_2_60_SYSTEM_TABLE_REVISION ((2 << 16) | (60))\r |
| b2e1b498 | 1801 | #define EFI_2_50_SYSTEM_TABLE_REVISION ((2 << 16) | (50))\r |
| b4319afb | 1802 | #define EFI_2_40_SYSTEM_TABLE_REVISION ((2 << 16) | (40))\r |
| aee17e89 | 1803 | #define EFI_2_31_SYSTEM_TABLE_REVISION ((2 << 16) | (31))\r |
| add9c350 | 1804 | #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))\r |
| 1805 | #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))\r | |
| 2a3f6a21 | 1806 | #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))\r |
| 1807 | #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))\r | |
| 1808 | #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))\r | |
| 1809 | #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))\r | |
| fee5ea2c | 1810 | #define EFI_SYSTEM_TABLE_REVISION EFI_2_70_SYSTEM_TABLE_REVISION\r |
| 78322c85 | 1811 | #define EFI_SPECIFICATION_VERSION EFI_SYSTEM_TABLE_REVISION\r |
| 2a3f6a21 | 1812 | \r |
| 07636730 | 1813 | #define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')\r |
| 78322c85 | 1814 | #define EFI_RUNTIME_SERVICES_REVISION EFI_SPECIFICATION_VERSION\r |
| 959ccb23 | 1815 | \r |
| e0c047a0 | 1816 | ///\r |
| af2dc6a7 | 1817 | /// EFI Runtime Services Table.\r |
| e0c047a0 | 1818 | ///\r |
| 959ccb23 | 1819 | typedef struct {\r |
| e0c047a0 | 1820 | ///\r |
| 1821 | /// The table header for the EFI Runtime Services Table.\r | |
| 1822 | ///\r | |
| c9a0a0fc | 1823 | EFI_TABLE_HEADER Hdr;\r |
| 00edb218 A |
1824 | \r |
| 1825 | //\r | |
| 1826 | // Time Services\r | |
| 1827 | //\r | |
| 1828 | EFI_GET_TIME GetTime;\r | |
| 1829 | EFI_SET_TIME SetTime;\r | |
| 1830 | EFI_GET_WAKEUP_TIME GetWakeupTime;\r | |
| 1831 | EFI_SET_WAKEUP_TIME SetWakeupTime;\r | |
| 1832 | \r | |
| 1833 | //\r | |
| 1834 | // Virtual Memory Services\r | |
| 1835 | //\r | |
| 1836 | EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap;\r | |
| 1837 | EFI_CONVERT_POINTER ConvertPointer;\r | |
| 1838 | \r | |
| 1839 | //\r | |
| 1840 | // Variable Services\r | |
| 1841 | //\r | |
| 1842 | EFI_GET_VARIABLE GetVariable;\r | |
| 1843 | EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName;\r | |
| 1844 | EFI_SET_VARIABLE SetVariable;\r | |
| 1845 | \r | |
| 1846 | //\r | |
| 1847 | // Miscellaneous Services\r | |
| 1848 | //\r | |
| 1849 | EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount;\r | |
| 1850 | EFI_RESET_SYSTEM ResetSystem;\r | |
| 1851 | \r | |
| 1852 | //\r | |
| 1853 | // UEFI 2.0 Capsule Services\r | |
| 1854 | //\r | |
| 1855 | EFI_UPDATE_CAPSULE UpdateCapsule;\r | |
| 1856 | EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities;\r | |
| 1857 | \r | |
| 1858 | //\r | |
| 1859 | // Miscellaneous UEFI 2.0 Service\r | |
| 1860 | //\r | |
| 1861 | EFI_QUERY_VARIABLE_INFO QueryVariableInfo;\r | |
| 959ccb23 | 1862 | } EFI_RUNTIME_SERVICES;\r |
| 1863 | \r | |
| 1864 | \r | |
| 07636730 | 1865 | #define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')\r |
| 78322c85 | 1866 | #define EFI_BOOT_SERVICES_REVISION EFI_SPECIFICATION_VERSION\r |
| 959ccb23 | 1867 | \r |
| e0c047a0 | 1868 | ///\r |
| af2dc6a7 | 1869 | /// EFI Boot Services Table.\r |
| e0c047a0 | 1870 | ///\r |
| 959ccb23 | 1871 | typedef struct {\r |
| e0c047a0 | 1872 | ///\r |
| 1873 | /// The table header for the EFI Boot Services Table.\r | |
| 1874 | ///\r | |
| c9a0a0fc | 1875 | EFI_TABLE_HEADER Hdr;\r |
| d0c64728 | 1876 | \r |
| 00edb218 A |
1877 | //\r |
| 1878 | // Task Priority Services\r | |
| 1879 | //\r | |
| 1880 | EFI_RAISE_TPL RaiseTPL;\r | |
| 1881 | EFI_RESTORE_TPL RestoreTPL;\r | |
| 1882 | \r | |
| 1883 | //\r | |
| 1884 | // Memory Services\r | |
| 1885 | //\r | |
| 1886 | EFI_ALLOCATE_PAGES AllocatePages;\r | |
| 1887 | EFI_FREE_PAGES FreePages;\r | |
| 1888 | EFI_GET_MEMORY_MAP GetMemoryMap;\r | |
| 1889 | EFI_ALLOCATE_POOL AllocatePool;\r | |
| 1890 | EFI_FREE_POOL FreePool;\r | |
| 1891 | \r | |
| 1892 | //\r | |
| 1893 | // Event & Timer Services\r | |
| 1894 | //\r | |
| 1895 | EFI_CREATE_EVENT CreateEvent;\r | |
| 1896 | EFI_SET_TIMER SetTimer;\r | |
| 1897 | EFI_WAIT_FOR_EVENT WaitForEvent;\r | |
| 1898 | EFI_SIGNAL_EVENT SignalEvent;\r | |
| 1899 | EFI_CLOSE_EVENT CloseEvent;\r | |
| 1900 | EFI_CHECK_EVENT CheckEvent;\r | |
| 1901 | \r | |
| 1902 | //\r | |
| 1903 | // Protocol Handler Services\r | |
| 1904 | //\r | |
| 1905 | EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface;\r | |
| 1906 | EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface;\r | |
| 1907 | EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface;\r | |
| 1908 | EFI_HANDLE_PROTOCOL HandleProtocol;\r | |
| 1909 | VOID *Reserved;\r | |
| 1910 | EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify;\r | |
| 1911 | EFI_LOCATE_HANDLE LocateHandle;\r | |
| 1912 | EFI_LOCATE_DEVICE_PATH LocateDevicePath;\r | |
| 1913 | EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable;\r | |
| 1914 | \r | |
| 1915 | //\r | |
| 1916 | // Image Services\r | |
| 1917 | //\r | |
| 1918 | EFI_IMAGE_LOAD LoadImage;\r | |
| 1919 | EFI_IMAGE_START StartImage;\r | |
| 1920 | EFI_EXIT Exit;\r | |
| 1921 | EFI_IMAGE_UNLOAD UnloadImage;\r | |
| 1922 | EFI_EXIT_BOOT_SERVICES ExitBootServices;\r | |
| 1923 | \r | |
| 1924 | //\r | |
| 1925 | // Miscellaneous Services\r | |
| 1926 | //\r | |
| 1927 | EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount;\r | |
| 1928 | EFI_STALL Stall;\r | |
| 1929 | EFI_SET_WATCHDOG_TIMER SetWatchdogTimer;\r | |
| 1930 | \r | |
| 1931 | //\r | |
| 1932 | // DriverSupport Services\r | |
| 1933 | //\r | |
| 1934 | EFI_CONNECT_CONTROLLER ConnectController;\r | |
| 1935 | EFI_DISCONNECT_CONTROLLER DisconnectController;\r | |
| 1936 | \r | |
| 1937 | //\r | |
| 1938 | // Open and Close Protocol Services\r | |
| 1939 | //\r | |
| 1940 | EFI_OPEN_PROTOCOL OpenProtocol;\r | |
| 1941 | EFI_CLOSE_PROTOCOL CloseProtocol;\r | |
| 1942 | EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation;\r | |
| 1943 | \r | |
| 1944 | //\r | |
| 1945 | // Library Services\r | |
| 1946 | //\r | |
| 1947 | EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle;\r | |
| 1948 | EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer;\r | |
| 1949 | EFI_LOCATE_PROTOCOL LocateProtocol;\r | |
| 1950 | EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces;\r | |
| 1951 | EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces;\r | |
| 1952 | \r | |
| 1953 | //\r | |
| 1954 | // 32-bit CRC Services\r | |
| 1955 | //\r | |
| 1956 | EFI_CALCULATE_CRC32 CalculateCrc32;\r | |
| 1957 | \r | |
| 1958 | //\r | |
| 1959 | // Miscellaneous Services\r | |
| 1960 | //\r | |
| 1961 | EFI_COPY_MEM CopyMem;\r | |
| 1962 | EFI_SET_MEM SetMem;\r | |
| 00edb218 | 1963 | EFI_CREATE_EVENT_EX CreateEventEx;\r |
| 959ccb23 | 1964 | } EFI_BOOT_SERVICES;\r |
| 1965 | \r | |
| e0c047a0 | 1966 | ///\r |
| 1967 | /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the\r | |
| 1968 | /// EFI System Table.\r | |
| 1969 | ///\r | |
| 2a3f6a21 | 1970 | typedef struct {\r |
| e0c047a0 | 1971 | ///\r |
| 1972 | /// The 128-bit GUID value that uniquely identifies the system configuration table.\r | |
| 1973 | ///\r | |
| 00edb218 | 1974 | EFI_GUID VendorGuid;\r |
| e0c047a0 | 1975 | ///\r |
| 1976 | /// A pointer to the table associated with VendorGuid.\r | |
| 1977 | ///\r | |
| 00edb218 | 1978 | VOID *VendorTable;\r |
| 959ccb23 | 1979 | } EFI_CONFIGURATION_TABLE;\r |
| 1980 | \r | |
| e0c047a0 | 1981 | ///\r |
| 1982 | /// EFI System Table\r | |
| 1983 | ///\r | |
| 2a3f6a21 | 1984 | typedef struct {\r |
| e0c047a0 | 1985 | ///\r |
| 1986 | /// The table header for the EFI System Table.\r | |
| 1987 | ///\r | |
| c9a0a0fc | 1988 | EFI_TABLE_HEADER Hdr;\r |
| e0c047a0 | 1989 | ///\r |
| fbf926ad | 1990 | /// A pointer to a null terminated string that identifies the vendor\r |
| 1991 | /// that produces the system firmware for the platform.\r | |
| e0c047a0 | 1992 | ///\r |
| 00edb218 | 1993 | CHAR16 *FirmwareVendor;\r |
| e0c047a0 | 1994 | ///\r |
| 1995 | /// A firmware vendor specific value that identifies the revision\r | |
| 1996 | /// of the system firmware for the platform.\r | |
| 1997 | ///\r | |
| 00edb218 | 1998 | UINT32 FirmwareRevision;\r |
| e0c047a0 | 1999 | ///\r |
| eaf75bf4 | 2000 | /// The handle for the active console input device. This handle must support\r |
| 2001 | /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.\r | |
| e0c047a0 | 2002 | ///\r |
| 00edb218 | 2003 | EFI_HANDLE ConsoleInHandle;\r |
| e0c047a0 | 2004 | ///\r |
| 11ca63ec | 2005 | /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is\r |
| e0c047a0 | 2006 | /// associated with ConsoleInHandle.\r |
| 2007 | ///\r | |
| 00edb218 | 2008 | EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;\r |
| e0c047a0 | 2009 | ///\r |
| 2010 | /// The handle for the active console output device.\r | |
| 2011 | ///\r | |
| 00edb218 | 2012 | EFI_HANDLE ConsoleOutHandle;\r |
| e0c047a0 | 2013 | ///\r |
| 11ca63ec | 2014 | /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r |
| e0c047a0 | 2015 | /// that is associated with ConsoleOutHandle.\r |
| 2016 | ///\r | |
| 00edb218 | 2017 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut;\r |
| e0c047a0 | 2018 | ///\r |
| 2019 | /// The handle for the active standard error console device.\r | |
| eaf75bf4 | 2020 | /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r |
| e0c047a0 | 2021 | ///\r |
| 00edb218 | 2022 | EFI_HANDLE StandardErrorHandle;\r |
| e0c047a0 | 2023 | ///\r |
| 11ca63ec | 2024 | /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r |
| e0c047a0 | 2025 | /// that is associated with StandardErrorHandle.\r |
| 2026 | ///\r | |
| 00edb218 | 2027 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *StdErr;\r |
| e0c047a0 | 2028 | ///\r |
| 2029 | /// A pointer to the EFI Runtime Services Table.\r | |
| 2030 | ///\r | |
| 00edb218 | 2031 | EFI_RUNTIME_SERVICES *RuntimeServices;\r |
| e0c047a0 | 2032 | ///\r |
| 2033 | /// A pointer to the EFI Boot Services Table.\r | |
| 2034 | ///\r | |
| 00edb218 | 2035 | EFI_BOOT_SERVICES *BootServices;\r |
| e0c047a0 | 2036 | ///\r |
| 2037 | /// The number of system configuration tables in the buffer ConfigurationTable.\r | |
| 2038 | ///\r | |
| 00edb218 | 2039 | UINTN NumberOfTableEntries;\r |
| e0c047a0 | 2040 | ///\r |
| 2041 | /// A pointer to the system configuration tables.\r | |
| 2042 | /// The number of entries in the table is NumberOfTableEntries.\r | |
| 2043 | ///\r | |
| 00edb218 | 2044 | EFI_CONFIGURATION_TABLE *ConfigurationTable;\r |
| 2a3f6a21 | 2045 | } EFI_SYSTEM_TABLE;\r |
| 2046 | \r | |
| 2047 | /**\r | |
| 2048 | This is the declaration of an EFI image entry point. This entry point is\r | |
| 2049 | the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r | |
| 2050 | both device drivers and bus drivers.\r | |
| 2051 | \r | |
| d3d92557 FT |
2052 | @param[in] ImageHandle The firmware allocated handle for the UEFI image.\r |
| 2053 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
| 2a3f6a21 | 2054 | \r |
| 2055 | @retval EFI_SUCCESS The operation completed successfully.\r | |
| af2dc6a7 | 2056 | @retval Others An unexpected error occurred.\r |
| 2a3f6a21 | 2057 | **/\r |
| 2058 | typedef\r | |
| 2059 | EFI_STATUS\r | |
| 2060 | (EFIAPI *EFI_IMAGE_ENTRY_POINT)(\r | |
| 2061 | IN EFI_HANDLE ImageHandle,\r | |
| 2062 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
| 2063 | );\r | |
| 959ccb23 | 2064 | \r |
| faa32beb RN |
2065 | //\r |
| 2066 | // EFI Load Option. This data structure describes format of UEFI boot option variables.\r | |
| 2067 | //\r | |
| 2068 | // NOTE: EFI Load Option is a byte packed buffer of variable length fields.\r | |
| 2069 | // The first two fields have fixed length. They are declared as members of the\r | |
| 2070 | // EFI_LOAD_OPTION structure. All the other fields are variable length fields.\r | |
| 2071 | // They are listed in the comment block below for reference purposes.\r | |
| 2072 | //\r | |
| 2073 | #pragma pack(1)\r | |
| 2074 | typedef struct _EFI_LOAD_OPTION {\r | |
| 2075 | ///\r | |
| 2076 | /// The attributes for this load option entry. All unused bits must be zero\r | |
| 2077 | /// and are reserved by the UEFI specification for future growth.\r | |
| 2078 | ///\r | |
| 2079 | UINT32 Attributes;\r | |
| 2080 | ///\r | |
| 2081 | /// Length in bytes of the FilePathList. OptionalData starts at offset\r | |
| 2082 | /// sizeof(UINT32) + sizeof(UINT16) + StrSize(Description) + FilePathListLength\r | |
| 2083 | /// of the EFI_LOAD_OPTION descriptor.\r | |
| 2084 | ///\r | |
| 2085 | UINT16 FilePathListLength;\r | |
| 2086 | ///\r | |
| 2087 | /// The user readable description for the load option.\r | |
| 2088 | /// This field ends with a Null character.\r | |
| 2089 | ///\r | |
| 2090 | // CHAR16 Description[];\r | |
| 2091 | ///\r | |
| 2092 | /// A packed array of UEFI device paths. The first element of the array is a\r | |
| 2093 | /// device path that describes the device and location of the Image for this\r | |
| 2094 | /// load option. The FilePathList[0] is specific to the device type. Other\r | |
| 2095 | /// device paths may optionally exist in the FilePathList, but their usage is\r | |
| 2096 | /// OSV specific. Each element in the array is variable length, and ends at\r | |
| 2097 | /// the device path end structure. Because the size of Description is\r | |
| 2098 | /// arbitrary, this data structure is not guaranteed to be aligned on a\r | |
| 2099 | /// natural boundary. This data structure may have to be copied to an aligned\r | |
| 2100 | /// natural boundary before it is used.\r | |
| 2101 | ///\r | |
| 2102 | // EFI_DEVICE_PATH_PROTOCOL FilePathList[];\r | |
| 2103 | ///\r | |
| 2104 | /// The remaining bytes in the load option descriptor are a binary data buffer\r | |
| 2105 | /// that is passed to the loaded image. If the field is zero bytes long, a\r | |
| 2106 | /// NULL pointer is passed to the loaded image. The number of bytes in\r | |
| 2107 | /// OptionalData can be computed by subtracting the starting offset of\r | |
| 2108 | /// OptionalData from total size in bytes of the EFI_LOAD_OPTION.\r | |
| 2109 | ///\r | |
| 2110 | // UINT8 OptionalData[];\r | |
| 2111 | } EFI_LOAD_OPTION;\r | |
| 2112 | #pragma pack()\r | |
| 2113 | \r | |
| 95cba3ee A |
2114 | //\r |
| 2115 | // EFI Load Options Attributes\r | |
| 2116 | //\r | |
| 573b8a86 RN |
2117 | #define LOAD_OPTION_ACTIVE 0x00000001\r |
| 2118 | #define LOAD_OPTION_FORCE_RECONNECT 0x00000002\r | |
| 2119 | #define LOAD_OPTION_HIDDEN 0x00000008\r | |
| 2120 | #define LOAD_OPTION_CATEGORY 0x00001F00\r | |
| 2121 | \r | |
| 2122 | #define LOAD_OPTION_CATEGORY_BOOT 0x00000000\r | |
| 2123 | #define LOAD_OPTION_CATEGORY_APP 0x00000100\r | |
| 2124 | \r | |
| 2125 | #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001\r | |
| 2126 | #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002\r | |
| 2127 | #define EFI_BOOT_OPTION_SUPPORT_SYSPREP 0x00000010\r | |
| 2128 | #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300\r | |
| 95cba3ee | 2129 | \r |
| 2a3f6a21 | 2130 | ///\r |
| 2131 | /// EFI Boot Key Data\r | |
| 2132 | ///\r | |
| d4468cdf RN |
2133 | typedef union {\r |
| 2134 | struct {\r | |
| 2135 | ///\r | |
| 2136 | /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.\r | |
| 2137 | ///\r | |
| 2138 | UINT32 Revision : 8;\r | |
| 2139 | ///\r | |
| 2140 | /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).\r | |
| 2141 | ///\r | |
| 2142 | UINT32 ShiftPressed : 1;\r | |
| 2143 | ///\r | |
| 2144 | /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).\r | |
| 2145 | ///\r | |
| 2146 | UINT32 ControlPressed : 1;\r | |
| 2147 | ///\r | |
| 2148 | /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).\r | |
| 2149 | ///\r | |
| 2150 | UINT32 AltPressed : 1;\r | |
| 2151 | ///\r | |
| 2152 | /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).\r | |
| 2153 | ///\r | |
| 2154 | UINT32 LogoPressed : 1;\r | |
| 2155 | ///\r | |
| 2156 | /// The Menu key must be pressed (1) or must not be pressed (0).\r | |
| 2157 | ///\r | |
| 2158 | UINT32 MenuPressed : 1;\r | |
| 2159 | ///\r | |
| 2160 | /// The SysReq key must be pressed (1) or must not be pressed (0).\r | |
| 2161 | ///\r | |
| 2162 | UINT32 SysReqPressed : 1;\r | |
| 2163 | UINT32 Reserved : 16;\r | |
| 2164 | ///\r | |
| 2165 | /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If\r | |
| 2166 | /// zero, then only the shift state is considered. If more than one, then the boot option will\r | |
| 2167 | /// only be launched if all of the specified keys are pressed with the same shift state.\r | |
| 2168 | ///\r | |
| 2169 | UINT32 InputKeyCount : 2;\r | |
| 2170 | } Options;\r | |
| 2171 | UINT32 PackedValue;\r | |
| 2172 | } EFI_BOOT_KEY_DATA;\r | |
| 95cba3ee | 2173 | \r |
| 2a3f6a21 | 2174 | ///\r |
| af2dc6a7 | 2175 | /// EFI Key Option.\r |
| 2a3f6a21 | 2176 | ///\r |
| 53cdd439 | 2177 | #pragma pack(1)\r |
| 95cba3ee | 2178 | typedef struct {\r |
| 1bf79370 LG |
2179 | ///\r |
| 2180 | /// Specifies options about how the key will be processed.\r | |
| 2181 | ///\r | |
| 2182 | EFI_BOOT_KEY_DATA KeyData;\r | |
| 2183 | ///\r | |
| 2184 | /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to\r | |
| 2185 | /// which BootOption refers. If the CRC-32s do not match this value, then this key\r | |
| 2186 | /// option is ignored.\r | |
| 2187 | ///\r | |
| 2a3f6a21 | 2188 | UINT32 BootOptionCrc;\r |
| 1bf79370 LG |
2189 | ///\r |
| 2190 | /// The Boot#### option which will be invoked if this key is pressed and the boot option\r | |
| 2191 | /// is active (LOAD_OPTION_ACTIVE is set).\r | |
| 2192 | ///\r | |
| 2a3f6a21 | 2193 | UINT16 BootOption;\r |
| 1bf79370 LG |
2194 | ///\r |
| 2195 | /// The key codes to compare against those returned by the\r | |
| 2196 | /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.\r | |
| 2197 | /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.\r | |
| 2198 | ///\r | |
| 2199 | //EFI_INPUT_KEY Keys[];\r | |
| 95cba3ee | 2200 | } EFI_KEY_OPTION;\r |
| 53cdd439 | 2201 | #pragma pack()\r |
| 95cba3ee | 2202 | \r |
| 959ccb23 | 2203 | //\r |
| 2204 | // EFI File location to boot from on removable media devices\r | |
| 2205 | //\r | |
| 2206 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"\r | |
| 2207 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"\r | |
| 2208 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"\r | |
| ebd04fc2 | 2209 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM L"\\EFI\\BOOT\\BOOTARM.EFI"\r |
| b4319afb | 2210 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64 L"\\EFI\\BOOT\\BOOTAA64.EFI"\r |
| d3abb40d | 2211 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_RISCV64 L"\\EFI\\BOOT\\BOOTRISCV64.EFI"\r |
| 959ccb23 | 2212 | \r |
| 2213 | #if defined (MDE_CPU_IA32)\r | |
| 2214 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32\r | |
| 959ccb23 | 2215 | #elif defined (MDE_CPU_X64)\r |
| 2216 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64\r | |
| 2217 | #elif defined (MDE_CPU_EBC)\r | |
| ebd04fc2 | 2218 | #elif defined (MDE_CPU_ARM)\r |
| 2219 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_ARM\r | |
| b4319afb HL |
2220 | #elif defined (MDE_CPU_AARCH64)\r |
| 2221 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64\r | |
| d3abb40d AC |
2222 | #elif defined (MDE_CPU_RISCV64)\r |
| 2223 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_RISCV64\r | |
| 959ccb23 | 2224 | #else\r |
| 2225 | #error Unknown Processor Type\r | |
| 2226 | #endif\r | |
| 2227 | \r | |
| 1cf40fbc CC |
2228 | //\r |
| 2229 | // The directory within the active EFI System Partition defined for delivery of capsule to firmware\r | |
| 2230 | //\r | |
| 2231 | #define EFI_CAPSULE_FILE_DIRECTORY L"\\EFI\\UpdateCapsule\\"\r | |
| 2232 | \r | |
| 959ccb23 | 2233 | #include <Uefi/UefiPxe.h>\r |
| 2234 | #include <Uefi/UefiGpt.h>\r | |
| 2235 | #include <Uefi/UefiInternalFormRepresentation.h>\r | |
| 2236 | \r | |
| 2237 | #endif\r |