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