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