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