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