2 The internal header file includes the common header files, defines
3 internal structure and functions used by DxeCore module.
5 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 #include <Protocol/LoadedImage.h>
24 #include <Protocol/GuidedSectionExtraction.h>
25 #include <Protocol/DevicePath.h>
26 #include <Protocol/Runtime.h>
27 #include <Protocol/LoadFile.h>
28 #include <Protocol/DriverBinding.h>
29 #include <Protocol/VariableWrite.h>
30 #include <Protocol/PlatformDriverOverride.h>
31 #include <Protocol/Variable.h>
32 #include <Protocol/Timer.h>
33 #include <Protocol/SimpleFileSystem.h>
34 #include <Protocol/Bds.h>
35 #include <Protocol/RealTimeClock.h>
36 #include <Protocol/WatchdogTimer.h>
37 #include <Protocol/FirmwareVolume2.h>
38 #include <Protocol/MonotonicCounter.h>
39 #include <Protocol/StatusCode.h>
40 #include <Protocol/Decompress.h>
41 #include <Protocol/LoadPe32Image.h>
42 #include <Protocol/FirmwareVolumeDispatch.h>
43 #include <Protocol/Security.h>
44 #include <Protocol/Ebc.h>
45 #include <Protocol/Reset.h>
46 #include <Protocol/Cpu.h>
47 #include <Protocol/Metronome.h>
48 #include <Protocol/FirmwareVolumeBlock.h>
49 #include <Protocol/Capsule.h>
50 #include <Protocol/BusSpecificDriverOverride.h>
51 #include <Protocol/Performance.h>
52 #include <Protocol/TcgService.h>
53 #include <Protocol/TcgPlatform.h>
54 #include <Guid/MemoryTypeInformation.h>
55 #include <Guid/FirmwareFileSystem2.h>
56 #include <Guid/HobList.h>
57 #include <Guid/DebugImageInfoTable.h>
58 #include <Guid/FileInfo.h>
59 #include <Guid/Apriori.h>
60 #include <Guid/DxeServices.h>
61 #include <Guid/MemoryAllocationHob.h>
62 #include <Guid/EventLegacyBios.h>
63 #include <Guid/EventGroup.h>
66 #include <Library/DxeCoreEntryPoint.h>
67 #include <Library/DebugLib.h>
68 #include <Library/UefiLib.h>
69 #include <Library/BaseLib.h>
70 #include <Library/HobLib.h>
71 #include <Library/PerformanceLib.h>
72 #include <Library/UefiDecompressLib.h>
73 #include <Library/ExtractGuidedSectionLib.h>
74 #include <Library/CacheMaintenanceLib.h>
75 #include <Library/BaseMemoryLib.h>
76 #include <Library/PeCoffLib.h>
77 #include <Library/PcdLib.h>
78 #include <Library/MemoryAllocationLib.h>
79 #include <Library/DevicePathLib.h>
80 #include <Library/UefiBootServicesTableLib.h>
81 #include <Library/ReportStatusCodeLib.h>
83 #include "DebugImageInfo.h"
85 #include "FwVolBlock.h"
86 #include "FwVolDriver.h"
94 // attributes for reserved memory before it is promoted to system memory
96 #define EFI_MEMORY_PRESENT 0x0100000000000000ULL
97 #define EFI_MEMORY_INITIALIZED 0x0200000000000000ULL
98 #define EFI_MEMORY_TESTED 0x0400000000000000ULL
101 // range for memory mapped port I/O on IPF
103 #define EFI_MEMORY_PORT_IO 0x4000000000000000ULL
107 /// EFI_DEP_REPLACE_TRUE - Used to dynamically patch the dependecy expression
108 /// to save time. A EFI_DEP_PUSH is evauated one an
109 /// replaced with EFI_DEP_REPLACE_TRUE. If PI spec's Vol 2
110 /// Driver Execution Environment Core Interface use 0xff
111 /// as new DEPEX opcode. EFI_DEP_REPLACE_TRUE should be
112 /// defined to a new value that is not conflicting with PI spec.
114 #define EFI_DEP_REPLACE_TRUE 0xff
117 /// Define the initial size of the dependency expression evaluation stack
119 #define DEPEX_STACK_SIZE_INCREMENT 0x1000
122 EFI_GUID
*ProtocolGuid
;
127 } ARCHITECTURAL_PROTOCOL_ENTRY
;
130 // DXE Dispatcher Data structures
133 #define KNOWN_HANDLE_SIGNATURE EFI_SIGNATURE_32('k','n','o','w')
136 LIST_ENTRY Link
; // mFvHandleList
141 #define EFI_CORE_DRIVER_ENTRY_SIGNATURE EFI_SIGNATURE_32('d','r','v','r')
144 LIST_ENTRY Link
; // mDriverList
146 LIST_ENTRY ScheduledLink
; // mScheduledQueue
150 EFI_DEVICE_PATH_PROTOCOL
*FvFileDevicePath
;
151 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
158 EFI_GUID BeforeAfterGuid
;
165 BOOLEAN DepexProtocolError
;
167 EFI_HANDLE ImageHandle
;
169 } EFI_CORE_DRIVER_ENTRY
;
172 //The data structure of GCD memory map entry
174 #define EFI_GCD_MAP_SIGNATURE EFI_SIGNATURE_32('g','c','d','m')
178 EFI_PHYSICAL_ADDRESS BaseAddress
;
182 EFI_GCD_MEMORY_TYPE GcdMemoryType
;
183 EFI_GCD_IO_TYPE GcdIoType
;
184 EFI_HANDLE ImageHandle
;
185 EFI_HANDLE DeviceHandle
;
189 // DXE Core Global Variables
191 extern EFI_SYSTEM_TABLE
*gDxeCoreST
;
192 extern EFI_RUNTIME_SERVICES
*gDxeCoreRT
;
193 extern EFI_DXE_SERVICES
*gDxeCoreDS
;
194 extern EFI_HANDLE gDxeCoreImageHandle
;
196 extern EFI_DECOMPRESS_PROTOCOL gEfiDecompress
;
198 extern EFI_RUNTIME_ARCH_PROTOCOL
*gRuntime
;
199 extern EFI_CPU_ARCH_PROTOCOL
*gCpu
;
200 extern EFI_WATCHDOG_TIMER_ARCH_PROTOCOL
*gWatchdogTimer
;
201 extern EFI_METRONOME_ARCH_PROTOCOL
*gMetronome
;
202 extern EFI_TIMER_ARCH_PROTOCOL
*gTimer
;
203 extern EFI_SECURITY_ARCH_PROTOCOL
*gSecurity
;
204 extern EFI_BDS_ARCH_PROTOCOL
*gBds
;
206 extern EFI_TPL gEfiCurrentTpl
;
208 extern EFI_GUID
*gDxeCoreFileName
;
209 extern EFI_LOADED_IMAGE_PROTOCOL
*gDxeCoreLoadedImage
;
211 extern EFI_MEMORY_TYPE_INFORMATION gMemoryTypeInformation
[EfiMaxMemoryType
+ 1];
213 extern BOOLEAN gDispatcherRunning
;
214 extern EFI_RUNTIME_ARCH_PROTOCOL gRuntimeTemplate
;
217 // Service Initialization Functions
223 Called to initialize the pool.
233 Called to initialize the memory map and add descriptors to
234 the current descriptor list.
235 The first descriptor that is added must be general usable
236 memory as the addition allocates heap.
238 @param Type The type of memory to add
239 @param Start The starting address in the memory range Must be
241 @param NumberOfPages The number of pages in the range
242 @param Attribute Attributes of the memory to add
244 @return None. The range is added to the memory map
248 CoreAddMemoryDescriptor (
249 IN EFI_MEMORY_TYPE Type
,
250 IN EFI_PHYSICAL_ADDRESS Start
,
251 IN UINT64 NumberOfPages
,
257 Release memory lock on mGcdMemorySpaceLock.
261 CoreReleaseGcdMemoryLock (
267 Acquire memory lock on mGcdMemorySpaceLock.
271 CoreAcquireGcdMemoryLock (
277 External function. Initializes memory services based on the memory
278 descriptor HOBs. This function is responsible for priming the memory
279 map, so memory allocations and resource allocations can be made.
280 The first part of this function can not depend on any memory services
281 until at least one memory descriptor is provided to the memory services.
283 @param HobStart The start address of the HOB.
284 @param MemoryBaseAddress Start address of memory region found to init DXE
286 @param MemoryLength Length of memory region found to init DXE core.
288 @retval EFI_SUCCESS Memory services successfully initialized.
292 CoreInitializeMemoryServices (
294 OUT EFI_PHYSICAL_ADDRESS
*MemoryBaseAddress
,
295 OUT UINT64
*MemoryLength
301 External function. Initializes the GCD and memory services based on the memory
302 descriptor HOBs. This function is responsible for priming the GCD map and the
303 memory map, so memory allocations and resource allocations can be made. The
304 HobStart will be relocated to a pool buffer.
306 @param HobStart The start address of the HOB
307 @param MemoryBaseAddress Start address of memory region found to init DXE
309 @param MemoryLength Length of memory region found to init DXE core.
311 @retval EFI_SUCCESS GCD services successfully initialized.
315 CoreInitializeGcdServices (
316 IN OUT VOID
**HobStart
,
317 IN EFI_PHYSICAL_ADDRESS MemoryBaseAddress
,
318 IN UINT64 MemoryLength
323 Initializes "event" support.
325 @retval EFI_SUCCESS Always return success
329 CoreInitializeEventServices (
335 Add the Image Services to EFI Boot Services Table and install the protocol
336 interfaces for this image.
338 @param HobStart The HOB to initialize
344 CoreInitializeImageServices (
350 Creates an event that is fired everytime a Protocol of a specific type is installed.
354 CoreNotifyOnArchProtocolInstallation (
360 Return TRUE if all AP services are availible.
362 @retval EFI_SUCCESS All AP services are available
363 @retval EFI_NOT_FOUND At least one AP service is not available
367 CoreAllEfiServicesAvailable (
373 Calcualte the 32-bit CRC in a EFI table using the service provided by the
376 @param Hdr Pointer to an EFI standard header
381 IN OUT EFI_TABLE_HEADER
*Hdr
386 Called by the platform code to process a tick.
388 @param Duration The number of 100ns elasped since the last call
400 Initialize the dispatcher. Initialize the notification function that runs when
401 an FV2 protocol is added to the system.
405 CoreInitializeDispatcher (
411 This is the POSTFIX version of the dependency evaluator. This code does
412 not need to handle Before or After, as it is not valid to call this
413 routine in this case. The SOR is just ignored and is a nop in the grammer.
414 POSTFIX means all the math is done on top of the stack.
416 @param DriverEntry DriverEntry element to update.
418 @retval TRUE If driver is ready to run.
419 @retval FALSE If driver is not ready to run or some fatal error
425 IN EFI_CORE_DRIVER_ENTRY
*DriverEntry
430 Preprocess dependency expression and update DriverEntry to reflect the
431 state of Before, After, and SOR dependencies. If DriverEntry->Before
432 or DriverEntry->After is set it will never be cleared. If SOR is set
433 it will be cleared by CoreSchedule(), and then the driver can be
436 @param DriverEntry DriverEntry element to update .
438 @retval EFI_SUCCESS It always works.
442 CorePreProcessDepex (
443 IN EFI_CORE_DRIVER_ENTRY
*DriverEntry
449 Terminates all boot services.
451 @param ImageHandle Handle that identifies the exiting image.
452 @param MapKey Key to the latest memory map.
454 @retval EFI_SUCCESS Boot Services terminated
455 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
460 CoreExitBootServices (
461 IN EFI_HANDLE ImageHandle
,
467 Make sure the memory map is following all the construction rules,
468 it is the last time to check memory map error before exit boot services.
470 @param MapKey Memory map key
472 @retval EFI_INVALID_PARAMETER Memory map not consistent with construction
474 @retval EFI_SUCCESS Valid memory map.
478 CoreTerminateMemoryMap (
484 Signals all events in the EventGroup.
486 @param EventGroup The list to signal
490 CoreNotifySignalList (
491 IN EFI_GUID
*EventGroup
497 Boot Service called to add, modify, or remove a system configuration table from
498 the EFI System Table.
500 @param Guid Pointer to the GUID for the entry to add, update, or
502 @param Table Pointer to the configuration table for the entry to add,
503 update, or remove, may be NULL.
505 @return EFI_SUCCESS Guid, Table pair added, updated, or removed.
506 @return EFI_INVALID_PARAMETER Input GUID not valid.
507 @return EFI_NOT_FOUND Attempted to delete non-existant entry
508 @return EFI_OUT_OF_RESOURCES Not enough memory available
513 CoreInstallConfigurationTable (
521 Raise the task priority level to the new level.
522 High level is implemented by disabling processor interrupts.
524 @param NewTpl New task priority level
526 @return The previous task priority level
538 Lowers the task priority to the previous value. If the new
539 priority unmasks events at a higher priority, they are dispatched.
541 @param NewTpl New, lower, task priority
553 Introduces a fine-grained stall.
555 @param Microseconds The number of microseconds to stall execution.
557 @retval EFI_SUCCESS Execution was stalled for at least the requested
558 amount of microseconds.
559 @retval EFI_NOT_AVAILABLE_YET gMetronome is not available yet
565 IN UINTN Microseconds
571 Sets the system's watchdog timer.
573 @param Timeout The number of seconds to set the watchdog timer to.
574 A value of zero disables the timer.
575 @param WatchdogCode The numeric code to log on a watchdog timer timeout
576 event. The firmware reserves codes 0x0000 to 0xFFFF.
577 Loaders and operating systems may use other timeout
579 @param DataSize The size, in bytes, of WatchdogData.
580 @param WatchdogData A data buffer that includes a Null-terminated Unicode
581 string, optionally followed by additional binary data.
582 The string is a description that the call may use to
583 further indicate the reason to be logged with a
586 @return EFI_SUCCESS Timeout has been set
587 @return EFI_NOT_AVAILABLE_YET WatchdogTimer is not available yet
588 @return EFI_UNSUPPORTED System does not have a timer (currently not used)
589 @return EFI_DEVICE_ERROR Could not complete due to hardware error
594 CoreSetWatchdogTimer (
596 IN UINT64 WatchdogCode
,
598 IN CHAR16
*WatchdogData OPTIONAL
604 Wrapper function to CoreInstallProtocolInterfaceNotify. This is the public API which
605 Calls the private one which contains a BOOLEAN parameter for notifications
607 @param UserHandle The handle to install the protocol handler on,
608 or NULL if a new handle is to be allocated
609 @param Protocol The protocol to add to the handle
610 @param InterfaceType Indicates whether Interface is supplied in
612 @param Interface The interface for the protocol being added
619 CoreInstallProtocolInterface (
620 IN OUT EFI_HANDLE
*UserHandle
,
621 IN EFI_GUID
*Protocol
,
622 IN EFI_INTERFACE_TYPE InterfaceType
,
628 Installs a protocol interface into the boot services environment.
630 @param UserHandle The handle to install the protocol handler on,
631 or NULL if a new handle is to be allocated
632 @param Protocol The protocol to add to the handle
633 @param InterfaceType Indicates whether Interface is supplied in
635 @param Interface The interface for the protocol being added
636 @param Notify indicates whether notify the notification list
639 @retval EFI_INVALID_PARAMETER Invalid parameter
640 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
641 @retval EFI_SUCCESS Protocol interface successfully installed
645 CoreInstallProtocolInterfaceNotify (
646 IN OUT EFI_HANDLE
*UserHandle
,
647 IN EFI_GUID
*Protocol
,
648 IN EFI_INTERFACE_TYPE InterfaceType
,
656 Installs a list of protocol interface into the boot services environment.
657 This function calls InstallProtocolInterface() in a loop. If any error
658 occures all the protocols added by this function are removed. This is
659 basically a lib function to save space.
661 @param Handle The handle to install the protocol handlers on,
662 or NULL if a new handle is to be allocated
663 @param ... EFI_GUID followed by protocol instance. A NULL
664 terminates the list. The pairs are the
665 arguments to InstallProtocolInterface(). All the
666 protocols are added to Handle.
668 @retval EFI_INVALID_PARAMETER Handle is NULL.
669 @retval EFI_SUCCESS Protocol interfaces successfully installed.
674 CoreInstallMultipleProtocolInterfaces (
675 IN OUT EFI_HANDLE
*Handle
,
682 Uninstalls a list of protocol interface in the boot services environment.
683 This function calls UnisatllProtocolInterface() in a loop. This is
684 basically a lib function to save space.
686 @param Handle The handle to uninstall the protocol
687 @param ... EFI_GUID followed by protocol instance. A NULL
688 terminates the list. The pairs are the
689 arguments to UninstallProtocolInterface(). All
690 the protocols are added to Handle.
697 CoreUninstallMultipleProtocolInterfaces (
698 IN EFI_HANDLE Handle
,
705 Reinstall a protocol interface on a device handle. The OldInterface for Protocol is replaced by the NewInterface.
707 @param UserHandle Handle on which the interface is to be
709 @param Protocol The numeric ID of the interface
710 @param OldInterface A pointer to the old interface
711 @param NewInterface A pointer to the new interface
713 @retval EFI_SUCCESS The protocol interface was installed
714 @retval EFI_NOT_FOUND The OldInterface on the handle was not found
715 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
720 CoreReinstallProtocolInterface (
721 IN EFI_HANDLE UserHandle
,
722 IN EFI_GUID
*Protocol
,
723 IN VOID
*OldInterface
,
724 IN VOID
*NewInterface
730 Uninstalls all instances of a protocol:interfacer from a handle.
731 If the last protocol interface is remove from the handle, the
734 @param UserHandle The handle to remove the protocol handler from
735 @param Protocol The protocol, of protocol:interface, to remove
736 @param Interface The interface, of protocol:interface, to remove
738 @retval EFI_INVALID_PARAMETER Protocol is NULL.
739 @retval EFI_SUCCESS Protocol interface successfully uninstalled.
744 CoreUninstallProtocolInterface (
745 IN EFI_HANDLE UserHandle
,
746 IN EFI_GUID
*Protocol
,
753 Queries a handle to determine if it supports a specified protocol.
755 @param UserHandle The handle being queried.
756 @param Protocol The published unique identifier of the protocol.
757 @param Interface Supplies the address where a pointer to the
758 corresponding Protocol Interface is returned.
760 @return The requested protocol interface for the handle
766 IN EFI_HANDLE UserHandle
,
767 IN EFI_GUID
*Protocol
,
774 Locates the installed protocol handler for the handle, and
775 invokes it to obtain the protocol interface. Usage information
776 is registered in the protocol data base.
778 @param UserHandle The handle to obtain the protocol interface on
779 @param Protocol The ID of the protocol
780 @param Interface The location to return the protocol interface
781 @param ImageHandle The handle of the Image that is opening the
782 protocol interface specified by Protocol and
784 @param ControllerHandle The controller handle that is requiring this
786 @param Attributes The open mode of the protocol interface
787 specified by Handle and Protocol.
789 @retval EFI_INVALID_PARAMETER Protocol is NULL.
790 @retval EFI_SUCCESS Get the protocol interface.
796 IN EFI_HANDLE UserHandle
,
797 IN EFI_GUID
*Protocol
,
798 OUT VOID
**Interface OPTIONAL
,
799 IN EFI_HANDLE ImageHandle
,
800 IN EFI_HANDLE ControllerHandle
,
807 Return information about Opened protocols in the system
809 @param UserHandle The handle to close the protocol interface on
810 @param Protocol The ID of the protocol
811 @param EntryBuffer A pointer to a buffer of open protocol
812 information in the form of
813 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
814 @param EntryCount Number of EntryBuffer entries
819 CoreOpenProtocolInformation (
820 IN EFI_HANDLE UserHandle
,
821 IN EFI_GUID
*Protocol
,
822 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
823 OUT UINTN
*EntryCount
829 Closes a protocol on a handle that was opened using OpenProtocol().
831 @param UserHandle The handle for the protocol interface that was
832 previously opened with OpenProtocol(), and is
834 @param Protocol The published unique identifier of the protocol.
835 It is the caller's responsibility to pass in a
837 @param AgentHandle The handle of the agent that is closing the
839 @param ControllerHandle If the agent that opened a protocol is a driver
840 that follows the EFI Driver Model, then this
841 parameter is the controller handle that required
842 the protocol interface. If the agent does not
843 follow the EFI Driver Model, then this parameter
844 is optional and may be NULL.
846 @retval EFI_SUCCESS The protocol instance was closed.
847 @retval EFI_INVALID_PARAMETER Handle, AgentHandle or ControllerHandle is not a
849 @retval EFI_NOT_FOUND Can not find the specified protocol or
856 IN EFI_HANDLE UserHandle
,
857 IN EFI_GUID
*Protocol
,
858 IN EFI_HANDLE AgentHandle
,
859 IN EFI_HANDLE ControllerHandle
865 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
868 @param UserHandle The handle from which to retrieve the list of
869 protocol interface GUIDs.
870 @param ProtocolBuffer A pointer to the list of protocol interface GUID
871 pointers that are installed on Handle.
872 @param ProtocolBufferCount A pointer to the number of GUID pointers present
875 @retval EFI_SUCCESS The list of protocol interface GUIDs installed
876 on Handle was returned in ProtocolBuffer. The
877 number of protocol interface GUIDs was returned
878 in ProtocolBufferCount.
879 @retval EFI_INVALID_PARAMETER Handle is NULL.
880 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
881 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
882 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
883 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the
889 CoreProtocolsPerHandle (
890 IN EFI_HANDLE UserHandle
,
891 OUT EFI_GUID
***ProtocolBuffer
,
892 OUT UINTN
*ProtocolBufferCount
898 Add a new protocol notification record for the request protocol.
900 @param Protocol The requested protocol to add the notify
902 @param Event The event to signal
903 @param Registration Returns the registration record
905 @retval EFI_INVALID_PARAMETER Invalid parameter
906 @retval EFI_SUCCESS Successfully returned the registration record
912 CoreRegisterProtocolNotify (
913 IN EFI_GUID
*Protocol
,
915 OUT VOID
**Registration
921 Locates the requested handle(s) and returns them in Buffer.
923 @param SearchType The type of search to perform to locate the
925 @param Protocol The protocol to search for
926 @param SearchKey Dependant on SearchType
927 @param BufferSize On input the size of Buffer. On output the
928 size of data returned.
929 @param Buffer The buffer to return the results in
931 @retval EFI_BUFFER_TOO_SMALL Buffer too small, required buffer size is
932 returned in BufferSize.
933 @retval EFI_INVALID_PARAMETER Invalid parameter
934 @retval EFI_SUCCESS Successfully found the requested handle(s) and
935 returns them in Buffer.
941 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
942 IN EFI_GUID
*Protocol OPTIONAL
,
943 IN VOID
*SearchKey OPTIONAL
,
944 IN OUT UINTN
*BufferSize
,
945 OUT EFI_HANDLE
*Buffer
951 Locates the handle to a device on the device path that best matches the specified protocol.
953 @param Protocol The protocol to search for.
954 @param DevicePath On input, a pointer to a pointer to the device
955 path. On output, the device path pointer is
956 modified to point to the remaining part of the
958 @param Device A pointer to the returned device handle.
960 @retval EFI_SUCCESS The resulting handle was returned.
961 @retval EFI_NOT_FOUND No handles matched the search.
962 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
967 CoreLocateDevicePath (
968 IN EFI_GUID
*Protocol
,
969 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
970 OUT EFI_HANDLE
*Device
976 Function returns an array of handles that support the requested protocol
977 in a buffer allocated from pool. This is a version of CoreLocateHandle()
978 that allocates a buffer for the caller.
980 @param SearchType Specifies which handle(s) are to be returned.
981 @param Protocol Provides the protocol to search by. This
982 parameter is only valid for SearchType
984 @param SearchKey Supplies the search key depending on the
986 @param NumberHandles The number of handles returned in Buffer.
987 @param Buffer A pointer to the buffer to return the requested
988 array of handles that support Protocol.
990 @retval EFI_SUCCESS The result array of handles was returned.
991 @retval EFI_NOT_FOUND No handles match the search.
992 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the
994 @retval EFI_INVALID_PARAMETER One or more paramters are not valid.
999 CoreLocateHandleBuffer (
1000 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1001 IN EFI_GUID
*Protocol OPTIONAL
,
1002 IN VOID
*SearchKey OPTIONAL
,
1003 IN OUT UINTN
*NumberHandles
,
1004 OUT EFI_HANDLE
**Buffer
1010 Return the first Protocol Interface that matches the Protocol GUID. If
1011 Registration is pasased in return a Protocol Instance that was just add
1012 to the system. If Retistration is NULL return the first Protocol Interface
1015 @param Protocol The protocol to search for
1016 @param Registration Optional Registration Key returned from
1017 RegisterProtocolNotify()
1018 @param Interface Return the Protocol interface (instance).
1020 @retval EFI_SUCCESS If a valid Interface is returned
1021 @retval EFI_INVALID_PARAMETER Invalid parameter
1022 @retval EFI_NOT_FOUND Protocol interface not found
1027 CoreLocateProtocol (
1028 IN EFI_GUID
*Protocol
,
1029 IN VOID
*Registration OPTIONAL
,
1030 OUT VOID
**Interface
1035 return handle database key.
1038 @return Handle database key.
1042 CoreGetHandleDatabaseKey (
1048 Go connect any handles that were created or modified while a image executed.
1050 @param Key The Key to show that the handle has been
1055 CoreConnectHandlesByKey (
1062 Connects one or more drivers to a controller.
1064 @param ControllerHandle Handle of the controller to be
1066 @param DriverImageHandle DriverImageHandle A pointer to an
1067 ordered list of driver image
1069 @param RemainingDevicePath RemainingDevicePath A pointer to
1070 the device path that specifies a
1071 child of the controller specified
1072 by ControllerHandle.
1073 @param Recursive Whether the function would be
1074 called recursively or not.
1076 @return Status code.
1081 CoreConnectController (
1082 IN EFI_HANDLE ControllerHandle
,
1083 IN EFI_HANDLE
*DriverImageHandle OPTIONAL
,
1084 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
,
1085 IN BOOLEAN Recursive
1091 Disonnects a controller from a driver
1093 @param ControllerHandle ControllerHandle The handle of
1094 the controller from which
1097 @param DriverImageHandle DriverImageHandle The driver to
1098 disconnect from ControllerHandle.
1099 @param ChildHandle ChildHandle The handle of the
1102 @retval EFI_SUCCESS One or more drivers were
1103 disconnected from the controller.
1104 @retval EFI_SUCCESS On entry, no drivers are managing
1106 @retval EFI_SUCCESS DriverImageHandle is not NULL,
1107 and on entry DriverImageHandle is
1108 not managing ControllerHandle.
1109 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid
1111 @retval EFI_INVALID_PARAMETER DriverImageHandle is not NULL,
1112 and it is not a valid EFI_HANDLE.
1113 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it
1114 is not a valid EFI_HANDLE.
1115 @retval EFI_OUT_OF_RESOURCES There are not enough resources
1116 available to disconnect any
1117 drivers from ControllerHandle.
1118 @retval EFI_DEVICE_ERROR The controller could not be
1119 disconnected because of a device
1125 CoreDisconnectController (
1126 IN EFI_HANDLE ControllerHandle
,
1127 IN EFI_HANDLE DriverImageHandle OPTIONAL
,
1128 IN EFI_HANDLE ChildHandle OPTIONAL
1134 Allocates pages from the memory map.
1136 @param Type The type of allocation to perform
1137 @param MemoryType The type of memory to turn the allocated pages
1139 @param NumberOfPages The number of pages to allocate
1140 @param Memory A pointer to receive the base allocated memory
1143 @return Status. On success, Memory is filled in with the base address allocated
1144 @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in
1146 @retval EFI_NOT_FOUND Could not allocate pages match the requirement.
1147 @retval EFI_OUT_OF_RESOURCES No enough pages to allocate.
1148 @retval EFI_SUCCESS Pages successfully allocated.
1154 IN EFI_ALLOCATE_TYPE Type
,
1155 IN EFI_MEMORY_TYPE MemoryType
,
1156 IN UINTN NumberOfPages
,
1157 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
1163 Frees previous allocated pages.
1165 @param Memory Base address of memory being freed
1166 @param NumberOfPages The number of pages to free
1168 @retval EFI_NOT_FOUND Could not find the entry that covers the range
1169 @retval EFI_INVALID_PARAMETER Address not aligned
1170 @return EFI_SUCCESS -Pages successfully freed.
1176 IN EFI_PHYSICAL_ADDRESS Memory
,
1177 IN UINTN NumberOfPages
1183 This function returns a copy of the current memory map. The map is an array of
1184 memory descriptors, each of which describes a contiguous block of memory.
1186 @param MemoryMapSize A pointer to the size, in bytes, of the
1187 MemoryMap buffer. On input, this is the size of
1188 the buffer allocated by the caller. On output,
1189 it is the size of the buffer returned by the
1190 firmware if the buffer was large enough, or the
1191 size of the buffer needed to contain the map if
1192 the buffer was too small.
1193 @param MemoryMap A pointer to the buffer in which firmware places
1194 the current memory map.
1195 @param MapKey A pointer to the location in which firmware
1196 returns the key for the current memory map.
1197 @param DescriptorSize A pointer to the location in which firmware
1198 returns the size, in bytes, of an individual
1199 EFI_MEMORY_DESCRIPTOR.
1200 @param DescriptorVersion A pointer to the location in which firmware
1201 returns the version number associated with the
1202 EFI_MEMORY_DESCRIPTOR.
1204 @retval EFI_SUCCESS The memory map was returned in the MemoryMap
1206 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current
1207 buffer size needed to hold the memory map is
1208 returned in MemoryMapSize.
1209 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1215 IN OUT UINTN
*MemoryMapSize
,
1216 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
1218 OUT UINTN
*DescriptorSize
,
1219 OUT UINT32
*DescriptorVersion
1225 Allocate pool of a particular type.
1227 @param PoolType Type of pool to allocate
1228 @param Size The amount of pool to allocate
1229 @param Buffer The address to return a pointer to the allocated
1232 @retval EFI_INVALID_PARAMETER PoolType not valid
1233 @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed.
1234 @retval EFI_SUCCESS Pool successfully allocated.
1240 IN EFI_MEMORY_TYPE PoolType
,
1250 @param Buffer The allocated pool entry to free
1252 @retval EFI_INVALID_PARAMETER Buffer is not a valid value.
1253 @retval EFI_SUCCESS Pool successfully freed.
1265 Loads an EFI image into memory and returns a handle to the image.
1267 @param BootPolicy If TRUE, indicates that the request originates
1268 from the boot manager, and that the boot
1269 manager is attempting to load FilePath as a
1271 @param ParentImageHandle The caller's image handle.
1272 @param FilePath The specific file path from which the image is
1274 @param SourceBuffer If not NULL, a pointer to the memory location
1275 containing a copy of the image to be loaded.
1276 @param SourceSize The size in bytes of SourceBuffer.
1277 @param ImageHandle Pointer to the returned image handle that is
1278 created when the image is successfully loaded.
1280 @retval EFI_SUCCESS The image was loaded into memory.
1281 @retval EFI_NOT_FOUND The FilePath was not found.
1282 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1283 @retval EFI_UNSUPPORTED The image type is not supported, or the device
1284 path cannot be parsed to locate the proper
1285 protocol for loading the file.
1286 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
1293 IN BOOLEAN BootPolicy
,
1294 IN EFI_HANDLE ParentImageHandle
,
1295 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1296 IN VOID
*SourceBuffer OPTIONAL
,
1297 IN UINTN SourceSize
,
1298 OUT EFI_HANDLE
*ImageHandle
1306 @param ImageHandle Handle that identifies the image to be
1309 @retval EFI_SUCCESS The image has been unloaded.
1310 @retval EFI_UNSUPPORTED The image has been sarted, and does not support
1312 @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image handle.
1318 IN EFI_HANDLE ImageHandle
1324 Transfer control to a loaded image's entry point.
1326 @param ImageHandle Handle of image to be started.
1327 @param ExitDataSize Pointer of the size to ExitData
1328 @param ExitData Pointer to a pointer to a data buffer that
1329 includes a Null-terminated Unicode string,
1330 optionally followed by additional binary data.
1331 The string is a description that the caller may
1332 use to further indicate the reason for the
1335 @retval EFI_INVALID_PARAMETER Invalid parameter
1336 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1337 @retval EFI_SUCCESS Successfully transfer control to the image's
1344 IN EFI_HANDLE ImageHandle
,
1345 OUT UINTN
*ExitDataSize
,
1346 OUT CHAR16
**ExitData OPTIONAL
1352 Terminates the currently loaded EFI image and returns control to boot services.
1354 @param ImageHandle Handle that identifies the image. This
1355 parameter is passed to the image on entry.
1356 @param Status The image's exit code.
1357 @param ExitDataSize The size, in bytes, of ExitData. Ignored if
1358 ExitStatus is EFI_SUCCESS.
1359 @param ExitData Pointer to a data buffer that includes a
1360 Null-terminated Unicode string, optionally
1361 followed by additional binary data. The string
1362 is a description that the caller may use to
1363 further indicate the reason for the image's
1366 @retval EFI_INVALID_PARAMETER Image handle is NULL or it is not current
1368 @retval EFI_SUCCESS Successfully terminates the currently loaded
1370 @retval EFI_ACCESS_DENIED Should never reach there.
1371 @retval EFI_OUT_OF_RESOURCES Could not allocate pool
1377 IN EFI_HANDLE ImageHandle
,
1378 IN EFI_STATUS Status
,
1379 IN UINTN ExitDataSize
,
1380 IN CHAR16
*ExitData OPTIONAL
1386 Creates a general-purpose event structure.
1388 @param Type The type of event to create and its mode and
1390 @param NotifyTpl The task priority level of event notifications
1391 @param NotifyFunction Pointer to the events notification function
1392 @param NotifyContext Pointer to the notification functions context;
1393 corresponds to parameter "Context" in the
1394 notification function
1395 @param Event Pointer to the newly created event if the call
1396 succeeds; undefined otherwise
1398 @retval EFI_SUCCESS The event structure was created
1399 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
1400 @retval EFI_OUT_OF_RESOURCES The event could not be allocated
1407 IN EFI_TPL NotifyTpl
,
1408 IN EFI_EVENT_NOTIFY NotifyFunction
, OPTIONAL
1409 IN VOID
*NotifyContext
, OPTIONAL
1410 OUT EFI_EVENT
*Event
1416 Creates a general-purpose event structure
1418 @param Type The type of event to create and its mode and
1420 @param NotifyTpl The task priority level of event notifications
1421 @param NotifyFunction Pointer to the events notification function
1422 @param NotifyContext Pointer to the notification functions context;
1423 corresponds to parameter "Context" in the
1424 notification function
1425 @param EventGroup GUID for EventGroup if NULL act the same as
1427 @param Event Pointer to the newly created event if the call
1428 succeeds; undefined otherwise
1430 @retval EFI_SUCCESS The event structure was created
1431 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
1432 @retval EFI_OUT_OF_RESOURCES The event could not be allocated
1439 IN EFI_TPL NotifyTpl
,
1440 IN EFI_EVENT_NOTIFY NotifyFunction
, OPTIONAL
1441 IN CONST VOID
*NotifyContext
, OPTIONAL
1442 IN CONST EFI_GUID
*EventGroup
, OPTIONAL
1443 OUT EFI_EVENT
*Event
1449 Sets the type of timer and the trigger time for a timer event.
1451 @param UserEvent The timer event that is to be signaled at the
1453 @param Type The type of time that is specified in
1455 @param TriggerTime The number of 100ns units until the timer
1458 @retval EFI_SUCCESS The event has been set to be signaled at the
1460 @retval EFI_INVALID_PARAMETER Event or Type is not valid
1466 IN EFI_EVENT UserEvent
,
1467 IN EFI_TIMER_DELAY Type
,
1468 IN UINT64 TriggerTime
1474 Signals the event. Queues the event to be notified if needed.
1476 @param UserEvent The event to signal .
1478 @retval EFI_INVALID_PARAMETER Parameters are not valid.
1479 @retval EFI_SUCCESS The event was signaled.
1485 IN EFI_EVENT UserEvent
1491 Stops execution until an event is signaled.
1493 @param NumberOfEvents The number of events in the UserEvents array
1494 @param UserEvents An array of EFI_EVENT
1495 @param UserIndex Pointer to the index of the event which
1496 satisfied the wait condition
1498 @retval EFI_SUCCESS The event indicated by Index was signaled.
1499 @retval EFI_INVALID_PARAMETER The event indicated by Index has a notification
1500 function or Event was not a valid type
1501 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION
1507 IN UINTN NumberOfEvents
,
1508 IN EFI_EVENT
*UserEvents
,
1509 OUT UINTN
*UserIndex
1515 Closes an event and frees the event structure.
1517 @param UserEvent Event to close
1519 @retval EFI_INVALID_PARAMETER Parameters are not valid.
1520 @retval EFI_SUCCESS The event has been closed
1526 IN EFI_EVENT UserEvent
1532 Check the status of an event.
1534 @param UserEvent The event to check
1536 @retval EFI_SUCCESS The event is in the signaled state
1537 @retval EFI_NOT_READY The event is not in the signaled state
1538 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL
1544 IN EFI_EVENT UserEvent
1549 Adds reserved memory, system memory, or memory-mapped I/O resources to the
1550 global coherency domain of the processor.
1552 @param GcdMemoryType Memory type of the memory space.
1553 @param BaseAddress Base address of the memory space.
1554 @param Length Length of the memory space.
1555 @param Capabilities alterable attributes of the memory space.
1557 @retval EFI_SUCCESS Merged this memory space into GCD map.
1562 CoreAddMemorySpace (
1563 IN EFI_GCD_MEMORY_TYPE GcdMemoryType
,
1564 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1566 IN UINT64 Capabilities
1571 Allocates nonexistent memory, reserved memory, system memory, or memorymapped
1572 I/O resources from the global coherency domain of the processor.
1574 @param GcdAllocateType The type of allocate operation
1575 @param GcdMemoryType The desired memory type
1576 @param Alignment Align with 2^Alignment
1577 @param Length Length to allocate
1578 @param BaseAddress Base address to allocate
1579 @param ImageHandle The image handle consume the allocated space.
1580 @param DeviceHandle The device handle consume the allocated space.
1582 @retval EFI_INVALID_PARAMETER Invalid parameter.
1583 @retval EFI_NOT_FOUND No descriptor contains the desired space.
1584 @retval EFI_SUCCESS Memory space successfully allocated.
1589 CoreAllocateMemorySpace (
1590 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType
,
1591 IN EFI_GCD_MEMORY_TYPE GcdMemoryType
,
1594 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
1595 IN EFI_HANDLE ImageHandle
,
1596 IN EFI_HANDLE DeviceHandle OPTIONAL
1601 Frees nonexistent memory, reserved memory, system memory, or memory-mapped
1602 I/O resources from the global coherency domain of the processor.
1604 @param BaseAddress Base address of the memory space.
1605 @param Length Length of the memory space.
1607 @retval EFI_SUCCESS Space successfully freed.
1612 CoreFreeMemorySpace (
1613 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1619 Removes reserved memory, system memory, or memory-mapped I/O resources from
1620 the global coherency domain of the processor.
1622 @param BaseAddress Base address of the memory space.
1623 @param Length Length of the memory space.
1625 @retval EFI_SUCCESS Successfully remove a segment of memory space.
1630 CoreRemoveMemorySpace (
1631 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1637 Retrieves the descriptor for a memory region containing a specified address.
1639 @param BaseAddress Specified start address
1640 @param Descriptor Specified length
1642 @retval EFI_INVALID_PARAMETER Invalid parameter
1643 @retval EFI_SUCCESS Successfully get memory space descriptor.
1648 CoreGetMemorySpaceDescriptor (
1649 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1650 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR
*Descriptor
1655 Modifies the attributes for a memory region in the global coherency domain of the
1658 @param BaseAddress Specified start address
1659 @param Length Specified length
1660 @param Attributes Specified attributes
1662 @retval EFI_SUCCESS Successfully set attribute of a segment of
1668 CoreSetMemorySpaceAttributes (
1669 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1671 IN UINT64 Attributes
1676 Returns a map of the memory resources in the global coherency domain of the
1679 @param NumberOfDescriptors Number of descriptors.
1680 @param MemorySpaceMap Descriptor array
1682 @retval EFI_INVALID_PARAMETER Invalid parameter
1683 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1684 @retval EFI_SUCCESS Successfully get memory space map.
1689 CoreGetMemorySpaceMap (
1690 OUT UINTN
*NumberOfDescriptors
,
1691 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR
**MemorySpaceMap
1696 Adds reserved I/O or I/O resources to the global coherency domain of the processor.
1698 @param GcdIoType IO type of the segment.
1699 @param BaseAddress Base address of the segment.
1700 @param Length Length of the segment.
1702 @retval EFI_SUCCESS Merged this segment into GCD map.
1703 @retval EFI_INVALID_PARAMETER Parameter not valid
1709 IN EFI_GCD_IO_TYPE GcdIoType
,
1710 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1716 Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency
1717 domain of the processor.
1719 @param GcdAllocateType The type of allocate operation
1720 @param GcdIoType The desired IO type
1721 @param Alignment Align with 2^Alignment
1722 @param Length Length to allocate
1723 @param BaseAddress Base address to allocate
1724 @param ImageHandle The image handle consume the allocated space.
1725 @param DeviceHandle The device handle consume the allocated space.
1727 @retval EFI_INVALID_PARAMETER Invalid parameter.
1728 @retval EFI_NOT_FOUND No descriptor contains the desired space.
1729 @retval EFI_SUCCESS IO space successfully allocated.
1734 CoreAllocateIoSpace (
1735 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType
,
1736 IN EFI_GCD_IO_TYPE GcdIoType
,
1739 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
1740 IN EFI_HANDLE ImageHandle
,
1741 IN EFI_HANDLE DeviceHandle OPTIONAL
1746 Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency
1747 domain of the processor.
1749 @param BaseAddress Base address of the segment.
1750 @param Length Length of the segment.
1752 @retval EFI_SUCCESS Space successfully freed.
1758 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1764 Removes reserved I/O or I/O resources from the global coherency domain of the
1767 @param BaseAddress Base address of the segment.
1768 @param Length Length of the segment.
1770 @retval EFI_SUCCESS Successfully removed a segment of IO space.
1776 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1782 Retrieves the descriptor for an I/O region containing a specified address.
1784 @param BaseAddress Specified start address
1785 @param Descriptor Specified length
1787 @retval EFI_INVALID_PARAMETER Descriptor is NULL.
1788 @retval EFI_SUCCESS Successfully get the IO space descriptor.
1793 CoreGetIoSpaceDescriptor (
1794 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1795 OUT EFI_GCD_IO_SPACE_DESCRIPTOR
*Descriptor
1800 Returns a map of the I/O resources in the global coherency domain of the processor.
1802 @param NumberOfDescriptors Number of descriptors.
1803 @param IoSpaceMap Descriptor array
1805 @retval EFI_INVALID_PARAMETER Invalid parameter
1806 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1807 @retval EFI_SUCCESS Successfully get IO space map.
1813 OUT UINTN
*NumberOfDescriptors
,
1814 OUT EFI_GCD_IO_SPACE_DESCRIPTOR
**IoSpaceMap
1819 This is the main Dispatcher for DXE and it exits when there are no more
1820 drivers to run. Drain the mScheduledQueue and load and start a PE
1821 image for each driver. Search the mDiscoveredList to see if any driver can
1822 be placed on the mScheduledQueue. If no drivers are placed on the
1823 mScheduledQueue exit the function. On exit it is assumed the Bds()
1824 will be called, and when the Bds() exits the Dispatcher will be called
1827 @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running
1828 @retval EFI_NOT_FOUND No DXE Drivers were dispatched
1829 @retval EFI_SUCCESS One or more DXE Drivers were dispatched
1839 Check every driver and locate a matching one. If the driver is found, the Unrequested
1840 state flag is cleared.
1842 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
1843 the firmware file specified by DriverName.
1844 @param DriverName The Driver name to put in the Dependent state.
1846 @retval EFI_SUCCESS The DriverName was found and it's SOR bit was
1848 @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was
1855 IN EFI_HANDLE FirmwareVolumeHandle
,
1856 IN EFI_GUID
*DriverName
1861 Convert a driver from the Untrused back to the Scheduled state.
1863 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
1864 the firmware file specified by DriverName.
1865 @param DriverName The Driver name to put in the Scheduled state
1867 @retval EFI_SUCCESS The file was found in the untrusted state, and it
1868 was promoted to the trusted state.
1869 @retval EFI_NOT_FOUND The file was not found in the untrusted state.
1875 IN EFI_HANDLE FirmwareVolumeHandle
,
1876 IN EFI_GUID
*DriverName
1881 Helper function called as part of the code needed
1882 to allocate the proper sized buffer for various
1885 @param Status Current status
1886 @param Buffer Current allocated buffer, or NULL
1887 @param BufferSize Current buffer size needed
1889 @retval TRUE if the buffer was reallocated and the caller
1890 should try the API again.
1891 @retval FALSE buffer could not be allocated and the caller
1892 should not try the API again.
1897 IN OUT EFI_STATUS
*Status
,
1898 IN OUT VOID
**Buffer
,
1904 This routine is the driver initialization entry point. It initializes the
1905 libraries, and registers two notification functions. These notification
1906 functions are responsible for building the FV stack dynamically.
1908 @param ImageHandle The image handle.
1909 @param SystemTable The system table.
1911 @retval EFI_SUCCESS Function successfully returned.
1917 IN EFI_HANDLE ImageHandle
,
1918 IN EFI_SYSTEM_TABLE
*SystemTable
1923 Entry point of the section extraction code. Initializes an instance of the
1924 section extraction interface and installs it on a new handle.
1926 @param ImageHandle A handle for the image that is initializing this driver
1927 @param SystemTable A pointer to the EFI system table
1929 @retval EFI_SUCCESS Driver initialized successfully
1930 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources
1935 InitializeSectionExtraction (
1936 IN EFI_HANDLE ImageHandle
,
1937 IN EFI_SYSTEM_TABLE
*SystemTable
1942 This DXE service routine is used to process a firmware volume. In
1943 particular, it can be called by BDS to process a single firmware
1944 volume found in a capsule.
1946 @param FvHeader pointer to a firmware volume header
1947 @param Size the size of the buffer pointed to by FvHeader
1948 @param FVProtocolHandle the handle on which a firmware volume protocol
1949 was produced for the firmware volume passed in.
1951 @retval EFI_OUT_OF_RESOURCES if an FVB could not be produced due to lack of
1953 @retval EFI_VOLUME_CORRUPTED if the volume was corrupted
1954 @retval EFI_SUCCESS a firmware volume protocol was produced for the
1960 CoreProcessFirmwareVolume (
1963 OUT EFI_HANDLE
*FVProtocolHandle
1967 //Functions used during debug buils
1971 Displays Architectural protocols that were not loaded and are required for DXE
1972 core to function. Only used in Debug Builds.
1976 CoreDisplayMissingArchProtocols (
1982 Traverse the discovered list for any drivers that were discovered but not loaded
1983 because the dependency experessions evaluated to false.
1987 CoreDisplayDiscoveredNotDispatched (
1993 Place holder function until all the Boot Services and Runtime Services are
1996 @return EFI_NOT_AVAILABLE_YET
2001 CoreEfiNotAvailableYetArg0 (
2007 Place holder function until all the Boot Services and Runtime Services are
2010 @param Arg1 Undefined
2012 @return EFI_NOT_AVAILABLE_YET
2017 CoreEfiNotAvailableYetArg1 (
2023 Place holder function until all the Boot Services and Runtime Services are available.
2025 @param Arg1 Undefined
2026 @param Arg2 Undefined
2028 @return EFI_NOT_AVAILABLE_YET
2033 CoreEfiNotAvailableYetArg2 (
2040 Place holder function until all the Boot Services and Runtime Services are available.
2042 @param Arg1 Undefined
2043 @param Arg2 Undefined
2044 @param Arg3 Undefined
2046 @return EFI_NOT_AVAILABLE_YET
2051 CoreEfiNotAvailableYetArg3 (
2059 Place holder function until all the Boot Services and Runtime Services are available.
2061 @param Arg1 Undefined
2062 @param Arg2 Undefined
2063 @param Arg3 Undefined
2064 @param Arg4 Undefined
2066 @return EFI_NOT_AVAILABLE_YET
2071 CoreEfiNotAvailableYetArg4 (
2080 Place holder function until all the Boot Services and Runtime Services are available.
2082 @param Arg1 Undefined
2083 @param Arg2 Undefined
2084 @param Arg3 Undefined
2085 @param Arg4 Undefined
2086 @param Arg5 Undefined
2088 @return EFI_NOT_AVAILABLE_YET
2093 CoreEfiNotAvailableYetArg5 (
2103 Given a compressed source buffer, this function retrieves the size of the
2104 uncompressed buffer and the size of the scratch buffer required to decompress
2105 the compressed source buffer.
2107 The GetInfo() function retrieves the size of the uncompressed buffer and the
2108 temporary scratch buffer required to decompress the buffer specified by Source
2109 and SourceSize. If the size of the uncompressed buffer or the size of the
2110 scratch buffer cannot be determined from the compressed data specified by
2111 Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the
2112 size of the uncompressed buffer is returned in DestinationSize, the size of
2113 the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned.
2114 The GetInfo() function does not have scratch buffer available to perform a
2115 thorough checking of the validity of the source data. It just retrieves the
2116 "Original Size" field from the beginning bytes of the source data and output
2117 it as DestinationSize. And ScratchSize is specific to the decompression
2120 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
2121 @param Source The source buffer containing the compressed data.
2122 @param SourceSize The size, in bytes, of the source buffer.
2123 @param DestinationSize A pointer to the size, in bytes, of the
2124 uncompressed buffer that will be generated when the
2125 compressed buffer specified by Source and
2126 SourceSize is decompressed.
2127 @param ScratchSize A pointer to the size, in bytes, of the scratch
2128 buffer that is required to decompress the
2129 compressed buffer specified by Source and
2132 @retval EFI_SUCCESS The size of the uncompressed data was returned in
2133 DestinationSize and the size of the scratch buffer
2134 was returned in ScratchSize.
2135 @retval EFI_INVALID_PARAMETER The size of the uncompressed data or the size of
2136 the scratch buffer cannot be determined from the
2137 compressed data specified by Source and
2143 DxeMainUefiDecompressGetInfo (
2144 IN EFI_DECOMPRESS_PROTOCOL
*This
,
2146 IN UINT32 SourceSize
,
2147 OUT UINT32
*DestinationSize
,
2148 OUT UINT32
*ScratchSize
2153 Decompresses a compressed source buffer.
2155 The Decompress() function extracts decompressed data to its original form.
2156 This protocol is designed so that the decompression algorithm can be
2157 implemented without using any memory services. As a result, the Decompress()
2158 Function is not allowed to call AllocatePool() or AllocatePages() in its
2159 implementation. It is the caller's responsibility to allocate and free the
2160 Destination and Scratch buffers.
2161 If the compressed source data specified by Source and SourceSize is
2162 sucessfully decompressed into Destination, then EFI_SUCCESS is returned. If
2163 the compressed source data specified by Source and SourceSize is not in a
2164 valid compressed data format, then EFI_INVALID_PARAMETER is returned.
2166 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
2167 @param Source The source buffer containing the compressed data.
2168 @param SourceSize SourceSizeThe size of source data.
2169 @param Destination On output, the destination buffer that contains
2170 the uncompressed data.
2171 @param DestinationSize The size of the destination buffer. The size of
2172 the destination buffer needed is obtained from
2173 EFI_DECOMPRESS_PROTOCOL.GetInfo().
2174 @param Scratch A temporary scratch buffer that is used to perform
2176 @param ScratchSize The size of scratch buffer. The size of the
2177 scratch buffer needed is obtained from GetInfo().
2179 @retval EFI_SUCCESS Decompression completed successfully, and the
2180 uncompressed buffer is returned in Destination.
2181 @retval EFI_INVALID_PARAMETER The source buffer specified by Source and
2182 SourceSize is corrupted (not in a valid
2188 DxeMainUefiDecompress (
2189 IN EFI_DECOMPRESS_PROTOCOL
*This
,
2191 IN UINT32 SourceSize
,
2192 IN OUT VOID
*Destination
,
2193 IN UINT32 DestinationSize
,
2194 IN OUT VOID
*Scratch
,
2195 IN UINT32 ScratchSize
2199 SEP member function. This function creates and returns a new section stream
2200 handle to represent the new section stream.
2202 @param SectionStreamLength Size in bytes of the section stream.
2203 @param SectionStream Buffer containing the new section stream.
2204 @param SectionStreamHandle A pointer to a caller allocated UINTN that on
2205 output contains the new section stream handle.
2207 @retval EFI_SUCCESS The section stream is created successfully.
2208 @retval EFI_OUT_OF_RESOURCES memory allocation failed.
2209 @retval EFI_INVALID_PARAMETER Section stream does not end concident with end
2216 IN UINTN SectionStreamLength
,
2217 IN VOID
*SectionStream
,
2218 OUT UINTN
*SectionStreamHandle
2224 SEP member function. Retrieves requested section from section stream.
2226 @param SectionStreamHandle The section stream from which to extract the
2228 @param SectionType A pointer to the type of section to search for.
2229 @param SectionDefinitionGuid If the section type is EFI_SECTION_GUID_DEFINED,
2230 then SectionDefinitionGuid indicates which of
2231 these types of sections to search for.
2232 @param SectionInstance Indicates which instance of the requested
2234 @param Buffer Double indirection to buffer. If *Buffer is
2235 non-null on input, then the buffer is caller
2236 allocated. If Buffer is NULL, then the buffer
2237 is callee allocated. In either case, the
2238 requried buffer size is returned in *BufferSize.
2239 @param BufferSize On input, indicates the size of *Buffer if
2240 *Buffer is non-null on input. On output,
2241 indicates the required size (allocated size if
2242 callee allocated) of *Buffer.
2243 @param AuthenticationStatus A pointer to a caller-allocated UINT32 that
2244 indicates the authentication status of the
2245 output buffer. If the input section's
2246 GuidedSectionHeader.Attributes field
2247 has the EFI_GUIDED_SECTION_AUTH_STATUS_VALID
2248 bit as clear, AuthenticationStatus must return
2249 zero. Both local bits (19:16) and aggregate
2250 bits (3:0) in AuthenticationStatus are returned
2251 by ExtractSection(). These bits reflect the
2252 status of the extraction operation. The bit
2253 pattern in both regions must be the same, as
2254 the local and aggregate authentication statuses
2255 have equivalent meaning at this level. If the
2256 function returns anything other than
2257 EFI_SUCCESS, the value of *AuthenticationStatus
2260 @retval EFI_SUCCESS Section was retrieved successfully
2261 @retval EFI_PROTOCOL_ERROR A GUID defined section was encountered in the
2262 section stream with its
2263 EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,
2264 but there was no corresponding GUIDed Section
2265 Extraction Protocol in the handle database.
2266 *Buffer is unmodified.
2267 @retval EFI_NOT_FOUND An error was encountered when parsing the
2268 SectionStream. This indicates the SectionStream
2269 is not correctly formatted.
2270 @retval EFI_NOT_FOUND The requested section does not exist.
2271 @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
2273 @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
2274 @retval EFI_WARN_TOO_SMALL The size of the caller allocated input buffer is
2275 insufficient to contain the requested section.
2276 The input buffer is filled and section contents
2283 IN UINTN SectionStreamHandle
,
2284 IN EFI_SECTION_TYPE
*SectionType
,
2285 IN EFI_GUID
*SectionDefinitionGuid
,
2286 IN UINTN SectionInstance
,
2288 IN OUT UINTN
*BufferSize
,
2289 OUT UINT32
*AuthenticationStatus
2294 SEP member function. Deletes an existing section stream
2296 @param StreamHandleToClose Indicates the stream to close
2298 @retval EFI_SUCCESS The section stream is closed sucessfully.
2299 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
2300 @retval EFI_INVALID_PARAMETER Section stream does not end concident with end
2306 CloseSectionStream (
2307 IN UINTN StreamHandleToClose