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