2 The internal header file includes the common header files, defines
3 internal structure and functions used by DxeCore module.
5 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
6 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/LoadFile2.h>
29 #include <Protocol/DriverBinding.h>
30 #include <Protocol/VariableWrite.h>
31 #include <Protocol/PlatformDriverOverride.h>
32 #include <Protocol/Variable.h>
33 #include <Protocol/Timer.h>
34 #include <Protocol/SimpleFileSystem.h>
35 #include <Protocol/Bds.h>
36 #include <Protocol/RealTimeClock.h>
37 #include <Protocol/WatchdogTimer.h>
38 #include <Protocol/FirmwareVolume2.h>
39 #include <Protocol/MonotonicCounter.h>
40 #include <Protocol/StatusCode.h>
41 #include <Protocol/Decompress.h>
42 #include <Protocol/LoadPe32Image.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/DriverFamilyOverride.h>
52 #include <Protocol/TcgService.h>
53 #include <Protocol/HiiPackageList.h>
54 #include <Protocol/SmmBase2.h>
55 #include <Guid/MemoryTypeInformation.h>
56 #include <Guid/FirmwareFileSystem2.h>
57 #include <Guid/FirmwareFileSystem3.h>
58 #include <Guid/HobList.h>
59 #include <Guid/DebugImageInfoTable.h>
60 #include <Guid/FileInfo.h>
61 #include <Guid/Apriori.h>
62 #include <Guid/DxeServices.h>
63 #include <Guid/MemoryAllocationHob.h>
64 #include <Guid/EventLegacyBios.h>
65 #include <Guid/EventGroup.h>
66 #include <Guid/LoadModuleAtFixedAddress.h>
67 #include <Guid/IdleLoopEvent.h>
69 #include <Library/DxeCoreEntryPoint.h>
70 #include <Library/DebugLib.h>
71 #include <Library/UefiLib.h>
72 #include <Library/BaseLib.h>
73 #include <Library/HobLib.h>
74 #include <Library/PerformanceLib.h>
75 #include <Library/UefiDecompressLib.h>
76 #include <Library/ExtractGuidedSectionLib.h>
77 #include <Library/CacheMaintenanceLib.h>
78 #include <Library/BaseMemoryLib.h>
79 #include <Library/PeCoffLib.h>
80 #include <Library/PeCoffGetEntryPointLib.h>
81 #include <Library/PeCoffExtraActionLib.h>
82 #include <Library/PcdLib.h>
83 #include <Library/MemoryAllocationLib.h>
84 #include <Library/DevicePathLib.h>
85 #include <Library/UefiBootServicesTableLib.h>
86 #include <Library/ReportStatusCodeLib.h>
87 #include <Library/TimerLib.h>
88 #include <Library/DxeServicesLib.h>
89 #include <Library/DebugAgentLib.h>
93 // attributes for reserved memory before it is promoted to system memory
95 #define EFI_MEMORY_PRESENT 0x0100000000000000ULL
96 #define EFI_MEMORY_INITIALIZED 0x0200000000000000ULL
97 #define EFI_MEMORY_TESTED 0x0400000000000000ULL
100 // range for memory mapped port I/O on IPF
102 #define EFI_MEMORY_PORT_IO 0x4000000000000000ULL
106 /// EFI_DEP_REPLACE_TRUE - Used to dynamically patch the dependecy expression
107 /// to save time. A EFI_DEP_PUSH is evauated one an
108 /// replaced with EFI_DEP_REPLACE_TRUE. If PI spec's Vol 2
109 /// Driver Execution Environment Core Interface use 0xff
110 /// as new DEPEX opcode. EFI_DEP_REPLACE_TRUE should be
111 /// defined to a new value that is not conflicting with PI spec.
113 #define EFI_DEP_REPLACE_TRUE 0xff
116 /// Define the initial size of the dependency expression evaluation stack
118 #define DEPEX_STACK_SIZE_INCREMENT 0x1000
121 EFI_GUID
*ProtocolGuid
;
126 } EFI_CORE_PROTOCOL_NOTIFY_ENTRY
;
129 // DXE Dispatcher Data structures
132 #define KNOWN_HANDLE_SIGNATURE SIGNATURE_32('k','n','o','w')
135 LIST_ENTRY Link
; // mFvHandleList
140 #define EFI_CORE_DRIVER_ENTRY_SIGNATURE SIGNATURE_32('d','r','v','r')
143 LIST_ENTRY Link
; // mDriverList
145 LIST_ENTRY ScheduledLink
; // mScheduledQueue
149 EFI_DEVICE_PATH_PROTOCOL
*FvFileDevicePath
;
150 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
157 EFI_GUID BeforeAfterGuid
;
164 BOOLEAN DepexProtocolError
;
166 EFI_HANDLE ImageHandle
;
168 } EFI_CORE_DRIVER_ENTRY
;
171 //The data structure of GCD memory map entry
173 #define EFI_GCD_MAP_SIGNATURE SIGNATURE_32('g','c','d','m')
177 EFI_PHYSICAL_ADDRESS BaseAddress
;
181 EFI_GCD_MEMORY_TYPE GcdMemoryType
;
182 EFI_GCD_IO_TYPE GcdIoType
;
183 EFI_HANDLE ImageHandle
;
184 EFI_HANDLE DeviceHandle
;
188 // DXE Core Global Variables
190 extern EFI_SYSTEM_TABLE
*gDxeCoreST
;
191 extern EFI_RUNTIME_SERVICES
*gDxeCoreRT
;
192 extern EFI_DXE_SERVICES
*gDxeCoreDS
;
193 extern EFI_HANDLE gDxeCoreImageHandle
;
195 extern EFI_DECOMPRESS_PROTOCOL gEfiDecompress
;
197 extern EFI_RUNTIME_ARCH_PROTOCOL
*gRuntime
;
198 extern EFI_CPU_ARCH_PROTOCOL
*gCpu
;
199 extern EFI_WATCHDOG_TIMER_ARCH_PROTOCOL
*gWatchdogTimer
;
200 extern EFI_METRONOME_ARCH_PROTOCOL
*gMetronome
;
201 extern EFI_TIMER_ARCH_PROTOCOL
*gTimer
;
202 extern EFI_SECURITY_ARCH_PROTOCOL
*gSecurity
;
203 extern EFI_BDS_ARCH_PROTOCOL
*gBds
;
204 extern EFI_SMM_BASE2_PROTOCOL
*gSmmBase2
;
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
;
216 extern EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE gLoadModuleAtFixAddressConfigurationTable
;
217 extern BOOLEAN gLoadFixedAddressCodeMemoryReady
;
219 // Service Initialization Functions
225 Called to initialize the pool.
235 Called to initialize the memory map and add descriptors to
236 the current descriptor list.
237 The first descriptor that is added must be general usable
238 memory as the addition allocates heap.
240 @param Type The type of memory to add
241 @param Start The starting address in the memory range Must be
243 @param NumberOfPages The number of pages in the range
244 @param Attribute Attributes of the memory to add
246 @return None. The range is added to the memory map
250 CoreAddMemoryDescriptor (
251 IN EFI_MEMORY_TYPE Type
,
252 IN EFI_PHYSICAL_ADDRESS Start
,
253 IN UINT64 NumberOfPages
,
259 Release memory lock on mGcdMemorySpaceLock.
263 CoreReleaseGcdMemoryLock (
269 Acquire memory lock on mGcdMemorySpaceLock.
273 CoreAcquireGcdMemoryLock (
279 External function. Initializes memory services based on the memory
280 descriptor HOBs. This function is responsible for priming the memory
281 map, so memory allocations and resource allocations can be made.
282 The first part of this function can not depend on any memory services
283 until at least one memory descriptor is provided to the memory services.
285 @param HobStart The start address of the HOB.
286 @param MemoryBaseAddress Start address of memory region found to init DXE
288 @param MemoryLength Length of memory region found to init DXE core.
290 @retval EFI_SUCCESS Memory services successfully initialized.
294 CoreInitializeMemoryServices (
296 OUT EFI_PHYSICAL_ADDRESS
*MemoryBaseAddress
,
297 OUT UINT64
*MemoryLength
303 External function. Initializes the GCD and memory services based on the memory
304 descriptor HOBs. This function is responsible for priming the GCD map and the
305 memory map, so memory allocations and resource allocations can be made. The
306 HobStart will be relocated to a pool buffer.
308 @param HobStart The start address of the HOB
309 @param MemoryBaseAddress Start address of memory region found to init DXE
311 @param MemoryLength Length of memory region found to init DXE core.
313 @retval EFI_SUCCESS GCD services successfully initialized.
317 CoreInitializeGcdServices (
318 IN OUT VOID
**HobStart
,
319 IN EFI_PHYSICAL_ADDRESS MemoryBaseAddress
,
320 IN UINT64 MemoryLength
325 Initializes "event" support.
327 @retval EFI_SUCCESS Always return success
331 CoreInitializeEventServices (
337 Add the Image Services to EFI Boot Services Table and install the protocol
338 interfaces for this image.
340 @param HobStart The HOB to initialize
346 CoreInitializeImageServices (
352 Creates an event that is fired everytime a Protocol of a specific type is installed.
356 CoreNotifyOnProtocolInstallation (
362 Return TRUE if all AP services are availible.
364 @retval EFI_SUCCESS All AP services are available
365 @retval EFI_NOT_FOUND At least one AP service is not available
369 CoreAllEfiServicesAvailable (
375 Calcualte the 32-bit CRC in a EFI table using the service provided by the
378 @param Hdr Pointer to an EFI standard header
383 IN OUT EFI_TABLE_HEADER
*Hdr
388 Called by the platform code to process a tick.
390 @param Duration The number of 100ns elasped since the last call
402 Initialize the dispatcher. Initialize the notification function that runs when
403 an FV2 protocol is added to the system.
407 CoreInitializeDispatcher (
413 This is the POSTFIX version of the dependency evaluator. This code does
414 not need to handle Before or After, as it is not valid to call this
415 routine in this case. The SOR is just ignored and is a nop in the grammer.
416 POSTFIX means all the math is done on top of the stack.
418 @param DriverEntry DriverEntry element to update.
420 @retval TRUE If driver is ready to run.
421 @retval FALSE If driver is not ready to run or some fatal error
427 IN EFI_CORE_DRIVER_ENTRY
*DriverEntry
432 Preprocess dependency expression and update DriverEntry to reflect the
433 state of Before, After, and SOR dependencies. If DriverEntry->Before
434 or DriverEntry->After is set it will never be cleared. If SOR is set
435 it will be cleared by CoreSchedule(), and then the driver can be
438 @param DriverEntry DriverEntry element to update .
440 @retval EFI_SUCCESS It always works.
444 CorePreProcessDepex (
445 IN EFI_CORE_DRIVER_ENTRY
*DriverEntry
451 Terminates all boot services.
453 @param ImageHandle Handle that identifies the exiting image.
454 @param MapKey Key to the latest memory map.
456 @retval EFI_SUCCESS Boot Services terminated
457 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
462 CoreExitBootServices (
463 IN EFI_HANDLE ImageHandle
,
469 Make sure the memory map is following all the construction rules,
470 it is the last time to check memory map error before exit boot services.
472 @param MapKey Memory map key
474 @retval EFI_INVALID_PARAMETER Memory map not consistent with construction
476 @retval EFI_SUCCESS Valid memory map.
480 CoreTerminateMemoryMap (
486 Signals all events in the EventGroup.
488 @param EventGroup The list to signal
492 CoreNotifySignalList (
493 IN EFI_GUID
*EventGroup
499 Boot Service called to add, modify, or remove a system configuration table from
500 the EFI System Table.
502 @param Guid Pointer to the GUID for the entry to add, update, or
504 @param Table Pointer to the configuration table for the entry to add,
505 update, or remove, may be NULL.
507 @return EFI_SUCCESS Guid, Table pair added, updated, or removed.
508 @return EFI_INVALID_PARAMETER Input GUID not valid.
509 @return EFI_NOT_FOUND Attempted to delete non-existant entry
510 @return EFI_OUT_OF_RESOURCES Not enough memory available
515 CoreInstallConfigurationTable (
523 Raise the task priority level to the new level.
524 High level is implemented by disabling processor interrupts.
526 @param NewTpl New task priority level
528 @return The previous task priority level
540 Lowers the task priority to the previous value. If the new
541 priority unmasks events at a higher priority, they are dispatched.
543 @param NewTpl New, lower, task priority
555 Introduces a fine-grained stall.
557 @param Microseconds The number of microseconds to stall execution.
559 @retval EFI_SUCCESS Execution was stalled for at least the requested
560 amount of microseconds.
561 @retval EFI_NOT_AVAILABLE_YET gMetronome is not available yet
567 IN UINTN Microseconds
573 Sets the system's watchdog timer.
575 @param Timeout The number of seconds to set the watchdog timer to.
576 A value of zero disables the timer.
577 @param WatchdogCode The numeric code to log on a watchdog timer timeout
578 event. The firmware reserves codes 0x0000 to 0xFFFF.
579 Loaders and operating systems may use other timeout
581 @param DataSize The size, in bytes, of WatchdogData.
582 @param WatchdogData A data buffer that includes a Null-terminated Unicode
583 string, optionally followed by additional binary data.
584 The string is a description that the call may use to
585 further indicate the reason to be logged with a
588 @return EFI_SUCCESS Timeout has been set
589 @return EFI_NOT_AVAILABLE_YET WatchdogTimer is not available yet
590 @return EFI_UNSUPPORTED System does not have a timer (currently not used)
591 @return EFI_DEVICE_ERROR Could not complete due to hardware error
596 CoreSetWatchdogTimer (
598 IN UINT64 WatchdogCode
,
600 IN CHAR16
*WatchdogData OPTIONAL
606 Wrapper function to CoreInstallProtocolInterfaceNotify. This is the public API which
607 Calls the private one which contains a BOOLEAN parameter for notifications
609 @param UserHandle The handle to install the protocol handler on,
610 or NULL if a new handle is to be allocated
611 @param Protocol The protocol to add to the handle
612 @param InterfaceType Indicates whether Interface is supplied in
614 @param Interface The interface for the protocol being added
621 CoreInstallProtocolInterface (
622 IN OUT EFI_HANDLE
*UserHandle
,
623 IN EFI_GUID
*Protocol
,
624 IN EFI_INTERFACE_TYPE InterfaceType
,
630 Installs a protocol interface into the boot services environment.
632 @param UserHandle The handle to install the protocol handler on,
633 or NULL if a new handle is to be allocated
634 @param Protocol The protocol to add to the handle
635 @param InterfaceType Indicates whether Interface is supplied in
637 @param Interface The interface for the protocol being added
638 @param Notify indicates whether notify the notification list
641 @retval EFI_INVALID_PARAMETER Invalid parameter
642 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
643 @retval EFI_SUCCESS Protocol interface successfully installed
647 CoreInstallProtocolInterfaceNotify (
648 IN OUT EFI_HANDLE
*UserHandle
,
649 IN EFI_GUID
*Protocol
,
650 IN EFI_INTERFACE_TYPE InterfaceType
,
658 Installs a list of protocol interface into the boot services environment.
659 This function calls InstallProtocolInterface() in a loop. If any error
660 occures all the protocols added by this function are removed. This is
661 basically a lib function to save space.
663 @param Handle The handle to install the protocol handlers on,
664 or NULL if a new handle is to be allocated
665 @param ... EFI_GUID followed by protocol instance. A NULL
666 terminates the list. The pairs are the
667 arguments to InstallProtocolInterface(). All the
668 protocols are added to Handle.
670 @retval EFI_INVALID_PARAMETER Handle is NULL.
671 @retval EFI_SUCCESS Protocol interfaces successfully installed.
676 CoreInstallMultipleProtocolInterfaces (
677 IN OUT EFI_HANDLE
*Handle
,
684 Uninstalls a list of protocol interface in the boot services environment.
685 This function calls UnisatllProtocolInterface() in a loop. This is
686 basically a lib function to save space.
688 @param Handle The handle to uninstall the protocol
689 @param ... EFI_GUID followed by protocol instance. A NULL
690 terminates the list. The pairs are the
691 arguments to UninstallProtocolInterface(). All
692 the protocols are added to Handle.
699 CoreUninstallMultipleProtocolInterfaces (
700 IN EFI_HANDLE Handle
,
707 Reinstall a protocol interface on a device handle. The OldInterface for Protocol is replaced by the NewInterface.
709 @param UserHandle Handle on which the interface is to be
711 @param Protocol The numeric ID of the interface
712 @param OldInterface A pointer to the old interface
713 @param NewInterface A pointer to the new interface
715 @retval EFI_SUCCESS The protocol interface was installed
716 @retval EFI_NOT_FOUND The OldInterface on the handle was not found
717 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
722 CoreReinstallProtocolInterface (
723 IN EFI_HANDLE UserHandle
,
724 IN EFI_GUID
*Protocol
,
725 IN VOID
*OldInterface
,
726 IN VOID
*NewInterface
732 Uninstalls all instances of a protocol:interfacer from a handle.
733 If the last protocol interface is remove from the handle, the
736 @param UserHandle The handle to remove the protocol handler from
737 @param Protocol The protocol, of protocol:interface, to remove
738 @param Interface The interface, of protocol:interface, to remove
740 @retval EFI_INVALID_PARAMETER Protocol is NULL.
741 @retval EFI_SUCCESS Protocol interface successfully uninstalled.
746 CoreUninstallProtocolInterface (
747 IN EFI_HANDLE UserHandle
,
748 IN EFI_GUID
*Protocol
,
755 Queries a handle to determine if it supports a specified protocol.
757 @param UserHandle The handle being queried.
758 @param Protocol The published unique identifier of the protocol.
759 @param Interface Supplies the address where a pointer to the
760 corresponding Protocol Interface is returned.
762 @return The requested protocol interface for the handle
768 IN EFI_HANDLE UserHandle
,
769 IN EFI_GUID
*Protocol
,
776 Locates the installed protocol handler for the handle, and
777 invokes it to obtain the protocol interface. Usage information
778 is registered in the protocol data base.
780 @param UserHandle The handle to obtain the protocol interface on
781 @param Protocol The ID of the protocol
782 @param Interface The location to return the protocol interface
783 @param ImageHandle The handle of the Image that is opening the
784 protocol interface specified by Protocol and
786 @param ControllerHandle The controller handle that is requiring this
788 @param Attributes The open mode of the protocol interface
789 specified by Handle and Protocol.
791 @retval EFI_INVALID_PARAMETER Protocol is NULL.
792 @retval EFI_SUCCESS Get the protocol interface.
798 IN EFI_HANDLE UserHandle
,
799 IN EFI_GUID
*Protocol
,
800 OUT VOID
**Interface OPTIONAL
,
801 IN EFI_HANDLE ImageHandle
,
802 IN EFI_HANDLE ControllerHandle
,
809 Return information about Opened protocols in the system
811 @param UserHandle The handle to close the protocol interface on
812 @param Protocol The ID of the protocol
813 @param EntryBuffer A pointer to a buffer of open protocol
814 information in the form of
815 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
816 @param EntryCount Number of EntryBuffer entries
821 CoreOpenProtocolInformation (
822 IN EFI_HANDLE UserHandle
,
823 IN EFI_GUID
*Protocol
,
824 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
825 OUT UINTN
*EntryCount
831 Closes a protocol on a handle that was opened using OpenProtocol().
833 @param UserHandle The handle for the protocol interface that was
834 previously opened with OpenProtocol(), and is
836 @param Protocol The published unique identifier of the protocol.
837 It is the caller's responsibility to pass in a
839 @param AgentHandle The handle of the agent that is closing the
841 @param ControllerHandle If the agent that opened a protocol is a driver
842 that follows the EFI Driver Model, then this
843 parameter is the controller handle that required
844 the protocol interface. If the agent does not
845 follow the EFI Driver Model, then this parameter
846 is optional and may be NULL.
848 @retval EFI_SUCCESS The protocol instance was closed.
849 @retval EFI_INVALID_PARAMETER Handle, AgentHandle or ControllerHandle is not a
851 @retval EFI_NOT_FOUND Can not find the specified protocol or
858 IN EFI_HANDLE UserHandle
,
859 IN EFI_GUID
*Protocol
,
860 IN EFI_HANDLE AgentHandle
,
861 IN EFI_HANDLE ControllerHandle
867 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
870 @param UserHandle The handle from which to retrieve the list of
871 protocol interface GUIDs.
872 @param ProtocolBuffer A pointer to the list of protocol interface GUID
873 pointers that are installed on Handle.
874 @param ProtocolBufferCount A pointer to the number of GUID pointers present
877 @retval EFI_SUCCESS The list of protocol interface GUIDs installed
878 on Handle was returned in ProtocolBuffer. The
879 number of protocol interface GUIDs was returned
880 in ProtocolBufferCount.
881 @retval EFI_INVALID_PARAMETER Handle is NULL.
882 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
883 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
884 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
885 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the
891 CoreProtocolsPerHandle (
892 IN EFI_HANDLE UserHandle
,
893 OUT EFI_GUID
***ProtocolBuffer
,
894 OUT UINTN
*ProtocolBufferCount
900 Add a new protocol notification record for the request protocol.
902 @param Protocol The requested protocol to add the notify
904 @param Event The event to signal
905 @param Registration Returns the registration record
907 @retval EFI_INVALID_PARAMETER Invalid parameter
908 @retval EFI_SUCCESS Successfully returned the registration record
914 CoreRegisterProtocolNotify (
915 IN EFI_GUID
*Protocol
,
917 OUT VOID
**Registration
922 Removes all the events in the protocol database that match Event.
924 @param Event The event to search for in the protocol
927 @return EFI_SUCCESS when done searching the entire database.
931 CoreUnregisterProtocolNotify (
937 Locates the requested handle(s) and returns them in Buffer.
939 @param SearchType The type of search to perform to locate the
941 @param Protocol The protocol to search for
942 @param SearchKey Dependant on SearchType
943 @param BufferSize On input the size of Buffer. On output the
944 size of data returned.
945 @param Buffer The buffer to return the results in
947 @retval EFI_BUFFER_TOO_SMALL Buffer too small, required buffer size is
948 returned in BufferSize.
949 @retval EFI_INVALID_PARAMETER Invalid parameter
950 @retval EFI_SUCCESS Successfully found the requested handle(s) and
951 returns them in Buffer.
957 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
958 IN EFI_GUID
*Protocol OPTIONAL
,
959 IN VOID
*SearchKey OPTIONAL
,
960 IN OUT UINTN
*BufferSize
,
961 OUT EFI_HANDLE
*Buffer
967 Locates the handle to a device on the device path that best matches the specified protocol.
969 @param Protocol The protocol to search for.
970 @param DevicePath On input, a pointer to a pointer to the device
971 path. On output, the device path pointer is
972 modified to point to the remaining part of the
974 @param Device A pointer to the returned device handle.
976 @retval EFI_SUCCESS The resulting handle was returned.
977 @retval EFI_NOT_FOUND No handles matched the search.
978 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
983 CoreLocateDevicePath (
984 IN EFI_GUID
*Protocol
,
985 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
986 OUT EFI_HANDLE
*Device
992 Function returns an array of handles that support the requested protocol
993 in a buffer allocated from pool. This is a version of CoreLocateHandle()
994 that allocates a buffer for the caller.
996 @param SearchType Specifies which handle(s) are to be returned.
997 @param Protocol Provides the protocol to search by. This
998 parameter is only valid for SearchType
1000 @param SearchKey Supplies the search key depending on the
1002 @param NumberHandles The number of handles returned in Buffer.
1003 @param Buffer A pointer to the buffer to return the requested
1004 array of handles that support Protocol.
1006 @retval EFI_SUCCESS The result array of handles was returned.
1007 @retval EFI_NOT_FOUND No handles match the search.
1008 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the
1010 @retval EFI_INVALID_PARAMETER One or more paramters are not valid.
1015 CoreLocateHandleBuffer (
1016 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1017 IN EFI_GUID
*Protocol OPTIONAL
,
1018 IN VOID
*SearchKey OPTIONAL
,
1019 IN OUT UINTN
*NumberHandles
,
1020 OUT EFI_HANDLE
**Buffer
1026 Return the first Protocol Interface that matches the Protocol GUID. If
1027 Registration is passed in, return a Protocol Instance that was just add
1028 to the system. If Registration is NULL return the first Protocol Interface
1031 @param Protocol The protocol to search for
1032 @param Registration Optional Registration Key returned from
1033 RegisterProtocolNotify()
1034 @param Interface Return the Protocol interface (instance).
1036 @retval EFI_SUCCESS If a valid Interface is returned
1037 @retval EFI_INVALID_PARAMETER Invalid parameter
1038 @retval EFI_NOT_FOUND Protocol interface not found
1043 CoreLocateProtocol (
1044 IN EFI_GUID
*Protocol
,
1045 IN VOID
*Registration OPTIONAL
,
1046 OUT VOID
**Interface
1051 return handle database key.
1054 @return Handle database key.
1058 CoreGetHandleDatabaseKey (
1064 Go connect any handles that were created or modified while a image executed.
1066 @param Key The Key to show that the handle has been
1071 CoreConnectHandlesByKey (
1078 Connects one or more drivers to a controller.
1080 @param ControllerHandle Handle of the controller to be
1082 @param DriverImageHandle DriverImageHandle A pointer to an
1083 ordered list of driver image
1085 @param RemainingDevicePath RemainingDevicePath A pointer to
1086 the device path that specifies a
1087 child of the controller specified
1088 by ControllerHandle.
1089 @param Recursive Whether the function would be
1090 called recursively or not.
1092 @return Status code.
1097 CoreConnectController (
1098 IN EFI_HANDLE ControllerHandle
,
1099 IN EFI_HANDLE
*DriverImageHandle OPTIONAL
,
1100 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
,
1101 IN BOOLEAN Recursive
1107 Disonnects a controller from a driver
1109 @param ControllerHandle ControllerHandle The handle of
1110 the controller from which
1113 @param DriverImageHandle DriverImageHandle The driver to
1114 disconnect from ControllerHandle.
1115 @param ChildHandle ChildHandle The handle of the
1118 @retval EFI_SUCCESS One or more drivers were
1119 disconnected from the controller.
1120 @retval EFI_SUCCESS On entry, no drivers are managing
1122 @retval EFI_SUCCESS DriverImageHandle is not NULL,
1123 and on entry DriverImageHandle is
1124 not managing ControllerHandle.
1125 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
1126 @retval EFI_INVALID_PARAMETER DriverImageHandle is not NULL,
1127 and it is not a valid EFI_HANDLE.
1128 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it
1129 is not a valid EFI_HANDLE.
1130 @retval EFI_OUT_OF_RESOURCES There are not enough resources
1131 available to disconnect any
1132 drivers from ControllerHandle.
1133 @retval EFI_DEVICE_ERROR The controller could not be
1134 disconnected because of a device
1140 CoreDisconnectController (
1141 IN EFI_HANDLE ControllerHandle
,
1142 IN EFI_HANDLE DriverImageHandle OPTIONAL
,
1143 IN EFI_HANDLE ChildHandle OPTIONAL
1149 Allocates pages from the memory map.
1151 @param Type The type of allocation to perform
1152 @param MemoryType The type of memory to turn the allocated pages
1154 @param NumberOfPages The number of pages to allocate
1155 @param Memory A pointer to receive the base allocated memory
1158 @return Status. On success, Memory is filled in with the base address allocated
1159 @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in
1161 @retval EFI_NOT_FOUND Could not allocate pages match the requirement.
1162 @retval EFI_OUT_OF_RESOURCES No enough pages to allocate.
1163 @retval EFI_SUCCESS Pages successfully allocated.
1169 IN EFI_ALLOCATE_TYPE Type
,
1170 IN EFI_MEMORY_TYPE MemoryType
,
1171 IN UINTN NumberOfPages
,
1172 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
1178 Frees previous allocated pages.
1180 @param Memory Base address of memory being freed
1181 @param NumberOfPages The number of pages to free
1183 @retval EFI_NOT_FOUND Could not find the entry that covers the range
1184 @retval EFI_INVALID_PARAMETER Address not aligned
1185 @return EFI_SUCCESS -Pages successfully freed.
1191 IN EFI_PHYSICAL_ADDRESS Memory
,
1192 IN UINTN NumberOfPages
1198 This function returns a copy of the current memory map. The map is an array of
1199 memory descriptors, each of which describes a contiguous block of memory.
1201 @param MemoryMapSize A pointer to the size, in bytes, of the
1202 MemoryMap buffer. On input, this is the size of
1203 the buffer allocated by the caller. On output,
1204 it is the size of the buffer returned by the
1205 firmware if the buffer was large enough, or the
1206 size of the buffer needed to contain the map if
1207 the buffer was too small.
1208 @param MemoryMap A pointer to the buffer in which firmware places
1209 the current memory map.
1210 @param MapKey A pointer to the location in which firmware
1211 returns the key for the current memory map.
1212 @param DescriptorSize A pointer to the location in which firmware
1213 returns the size, in bytes, of an individual
1214 EFI_MEMORY_DESCRIPTOR.
1215 @param DescriptorVersion A pointer to the location in which firmware
1216 returns the version number associated with the
1217 EFI_MEMORY_DESCRIPTOR.
1219 @retval EFI_SUCCESS The memory map was returned in the MemoryMap
1221 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current
1222 buffer size needed to hold the memory map is
1223 returned in MemoryMapSize.
1224 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1230 IN OUT UINTN
*MemoryMapSize
,
1231 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
1233 OUT UINTN
*DescriptorSize
,
1234 OUT UINT32
*DescriptorVersion
1240 Allocate pool of a particular type.
1242 @param PoolType Type of pool to allocate
1243 @param Size The amount of pool to allocate
1244 @param Buffer The address to return a pointer to the allocated
1247 @retval EFI_INVALID_PARAMETER PoolType not valid
1248 @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed.
1249 @retval EFI_SUCCESS Pool successfully allocated.
1255 IN EFI_MEMORY_TYPE PoolType
,
1265 @param Buffer The allocated pool entry to free
1267 @retval EFI_INVALID_PARAMETER Buffer is not a valid value.
1268 @retval EFI_SUCCESS Pool successfully freed.
1280 Loads an EFI image into memory and returns a handle to the image.
1282 @param BootPolicy If TRUE, indicates that the request originates
1283 from the boot manager, and that the boot
1284 manager is attempting to load FilePath as a
1286 @param ParentImageHandle The caller's image handle.
1287 @param FilePath The specific file path from which the image is
1289 @param SourceBuffer If not NULL, a pointer to the memory location
1290 containing a copy of the image to be loaded.
1291 @param SourceSize The size in bytes of SourceBuffer.
1292 @param ImageHandle Pointer to the returned image handle that is
1293 created when the image is successfully loaded.
1295 @retval EFI_SUCCESS The image was loaded into memory.
1296 @retval EFI_NOT_FOUND The FilePath was not found.
1297 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1298 @retval EFI_UNSUPPORTED The image type is not supported, or the device
1299 path cannot be parsed to locate the proper
1300 protocol for loading the file.
1301 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
1303 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
1305 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
1306 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
1307 image from being loaded. NULL is returned in *ImageHandle.
1308 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
1309 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
1310 platform policy specifies that the image should not be started.
1316 IN BOOLEAN BootPolicy
,
1317 IN EFI_HANDLE ParentImageHandle
,
1318 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1319 IN VOID
*SourceBuffer OPTIONAL
,
1320 IN UINTN SourceSize
,
1321 OUT EFI_HANDLE
*ImageHandle
1329 @param ImageHandle Handle that identifies the image to be
1332 @retval EFI_SUCCESS The image has been unloaded.
1333 @retval EFI_UNSUPPORTED The image has been sarted, and does not support
1335 @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image handle.
1341 IN EFI_HANDLE ImageHandle
1347 Transfer control to a loaded image's entry point.
1349 @param ImageHandle Handle of image to be started.
1350 @param ExitDataSize Pointer of the size to ExitData
1351 @param ExitData Pointer to a pointer to a data buffer that
1352 includes a Null-terminated string,
1353 optionally followed by additional binary data.
1354 The string is a description that the caller may
1355 use to further indicate the reason for the
1358 @retval EFI_INVALID_PARAMETER Invalid parameter
1359 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1360 @retval EFI_SUCCESS Successfully transfer control to the image's
1367 IN EFI_HANDLE ImageHandle
,
1368 OUT UINTN
*ExitDataSize
,
1369 OUT CHAR16
**ExitData OPTIONAL
1375 Terminates the currently loaded EFI image and returns control to boot services.
1377 @param ImageHandle Handle that identifies the image. This
1378 parameter is passed to the image on entry.
1379 @param Status The image's exit code.
1380 @param ExitDataSize The size, in bytes, of ExitData. Ignored if
1381 ExitStatus is EFI_SUCCESS.
1382 @param ExitData Pointer to a data buffer that includes a
1383 Null-terminated Unicode string, optionally
1384 followed by additional binary data. The string
1385 is a description that the caller may use to
1386 further indicate the reason for the image's
1389 @retval EFI_INVALID_PARAMETER Image handle is NULL or it is not current
1391 @retval EFI_SUCCESS Successfully terminates the currently loaded
1393 @retval EFI_ACCESS_DENIED Should never reach there.
1394 @retval EFI_OUT_OF_RESOURCES Could not allocate pool
1400 IN EFI_HANDLE ImageHandle
,
1401 IN EFI_STATUS Status
,
1402 IN UINTN ExitDataSize
,
1403 IN CHAR16
*ExitData OPTIONAL
1409 Creates a general-purpose event structure.
1411 @param Type The type of event to create and its mode and
1413 @param NotifyTpl The task priority level of event notifications
1414 @param NotifyFunction Pointer to the events notification function
1415 @param NotifyContext Pointer to the notification functions context;
1416 corresponds to parameter "Context" in the
1417 notification function
1418 @param Event Pointer to the newly created event if the call
1419 succeeds; undefined otherwise
1421 @retval EFI_SUCCESS The event structure was created
1422 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
1423 @retval EFI_OUT_OF_RESOURCES The event could not be allocated
1430 IN EFI_TPL NotifyTpl
,
1431 IN EFI_EVENT_NOTIFY NotifyFunction
, OPTIONAL
1432 IN VOID
*NotifyContext
, OPTIONAL
1433 OUT EFI_EVENT
*Event
1439 Creates a general-purpose event structure
1441 @param Type The type of event to create and its mode and
1443 @param NotifyTpl The task priority level of event notifications
1444 @param NotifyFunction Pointer to the events notification function
1445 @param NotifyContext Pointer to the notification functions context;
1446 corresponds to parameter "Context" in the
1447 notification function
1448 @param EventGroup GUID for EventGroup if NULL act the same as
1450 @param Event Pointer to the newly created event if the call
1451 succeeds; undefined otherwise
1453 @retval EFI_SUCCESS The event structure was created
1454 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
1455 @retval EFI_OUT_OF_RESOURCES The event could not be allocated
1462 IN EFI_TPL NotifyTpl
,
1463 IN EFI_EVENT_NOTIFY NotifyFunction
, OPTIONAL
1464 IN CONST VOID
*NotifyContext
, OPTIONAL
1465 IN CONST EFI_GUID
*EventGroup
, OPTIONAL
1466 OUT EFI_EVENT
*Event
1472 Sets the type of timer and the trigger time for a timer event.
1474 @param UserEvent The timer event that is to be signaled at the
1476 @param Type The type of time that is specified in
1478 @param TriggerTime The number of 100ns units until the timer
1481 @retval EFI_SUCCESS The event has been set to be signaled at the
1483 @retval EFI_INVALID_PARAMETER Event or Type is not valid
1489 IN EFI_EVENT UserEvent
,
1490 IN EFI_TIMER_DELAY Type
,
1491 IN UINT64 TriggerTime
1497 Signals the event. Queues the event to be notified if needed.
1499 @param UserEvent The event to signal .
1501 @retval EFI_INVALID_PARAMETER Parameters are not valid.
1502 @retval EFI_SUCCESS The event was signaled.
1508 IN EFI_EVENT UserEvent
1514 Stops execution until an event is signaled.
1516 @param NumberOfEvents The number of events in the UserEvents array
1517 @param UserEvents An array of EFI_EVENT
1518 @param UserIndex Pointer to the index of the event which
1519 satisfied the wait condition
1521 @retval EFI_SUCCESS The event indicated by Index was signaled.
1522 @retval EFI_INVALID_PARAMETER The event indicated by Index has a notification
1523 function or Event was not a valid type
1524 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION
1530 IN UINTN NumberOfEvents
,
1531 IN EFI_EVENT
*UserEvents
,
1532 OUT UINTN
*UserIndex
1538 Closes an event and frees the event structure.
1540 @param UserEvent Event to close
1542 @retval EFI_INVALID_PARAMETER Parameters are not valid.
1543 @retval EFI_SUCCESS The event has been closed
1549 IN EFI_EVENT UserEvent
1555 Check the status of an event.
1557 @param UserEvent The event to check
1559 @retval EFI_SUCCESS The event is in the signaled state
1560 @retval EFI_NOT_READY The event is not in the signaled state
1561 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL
1567 IN EFI_EVENT UserEvent
1572 Adds reserved memory, system memory, or memory-mapped I/O resources to the
1573 global coherency domain of the processor.
1575 @param GcdMemoryType Memory type of the memory space.
1576 @param BaseAddress Base address of the memory space.
1577 @param Length Length of the memory space.
1578 @param Capabilities alterable attributes of the memory space.
1580 @retval EFI_SUCCESS Merged this memory space into GCD map.
1585 CoreAddMemorySpace (
1586 IN EFI_GCD_MEMORY_TYPE GcdMemoryType
,
1587 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1589 IN UINT64 Capabilities
1594 Allocates nonexistent memory, reserved memory, system memory, or memorymapped
1595 I/O resources from the global coherency domain of the processor.
1597 @param GcdAllocateType The type of allocate operation
1598 @param GcdMemoryType The desired memory type
1599 @param Alignment Align with 2^Alignment
1600 @param Length Length to allocate
1601 @param BaseAddress Base address to allocate
1602 @param ImageHandle The image handle consume the allocated space.
1603 @param DeviceHandle The device handle consume the allocated space.
1605 @retval EFI_INVALID_PARAMETER Invalid parameter.
1606 @retval EFI_NOT_FOUND No descriptor contains the desired space.
1607 @retval EFI_SUCCESS Memory space successfully allocated.
1612 CoreAllocateMemorySpace (
1613 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType
,
1614 IN EFI_GCD_MEMORY_TYPE GcdMemoryType
,
1617 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
1618 IN EFI_HANDLE ImageHandle
,
1619 IN EFI_HANDLE DeviceHandle OPTIONAL
1624 Frees nonexistent memory, reserved memory, system memory, or memory-mapped
1625 I/O resources from the global coherency domain of the processor.
1627 @param BaseAddress Base address of the memory space.
1628 @param Length Length of the memory space.
1630 @retval EFI_SUCCESS Space successfully freed.
1635 CoreFreeMemorySpace (
1636 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1642 Removes reserved memory, system memory, or memory-mapped I/O resources from
1643 the global coherency domain of the processor.
1645 @param BaseAddress Base address of the memory space.
1646 @param Length Length of the memory space.
1648 @retval EFI_SUCCESS Successfully remove a segment of memory space.
1653 CoreRemoveMemorySpace (
1654 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1660 Retrieves the descriptor for a memory region containing a specified address.
1662 @param BaseAddress Specified start address
1663 @param Descriptor Specified length
1665 @retval EFI_INVALID_PARAMETER Invalid parameter
1666 @retval EFI_SUCCESS Successfully get memory space descriptor.
1671 CoreGetMemorySpaceDescriptor (
1672 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1673 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR
*Descriptor
1678 Modifies the attributes for a memory region in the global coherency domain of the
1681 @param BaseAddress Specified start address
1682 @param Length Specified length
1683 @param Attributes Specified attributes
1685 @retval EFI_SUCCESS Successfully set attribute of a segment of
1691 CoreSetMemorySpaceAttributes (
1692 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1694 IN UINT64 Attributes
1699 Returns a map of the memory resources in the global coherency domain of the
1702 @param NumberOfDescriptors Number of descriptors.
1703 @param MemorySpaceMap Descriptor array
1705 @retval EFI_INVALID_PARAMETER Invalid parameter
1706 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1707 @retval EFI_SUCCESS Successfully get memory space map.
1712 CoreGetMemorySpaceMap (
1713 OUT UINTN
*NumberOfDescriptors
,
1714 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR
**MemorySpaceMap
1719 Adds reserved I/O or I/O resources to the global coherency domain of the processor.
1721 @param GcdIoType IO type of the segment.
1722 @param BaseAddress Base address of the segment.
1723 @param Length Length of the segment.
1725 @retval EFI_SUCCESS Merged this segment into GCD map.
1726 @retval EFI_INVALID_PARAMETER Parameter not valid
1732 IN EFI_GCD_IO_TYPE GcdIoType
,
1733 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1739 Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency
1740 domain of the processor.
1742 @param GcdAllocateType The type of allocate operation
1743 @param GcdIoType The desired IO type
1744 @param Alignment Align with 2^Alignment
1745 @param Length Length to allocate
1746 @param BaseAddress Base address to allocate
1747 @param ImageHandle The image handle consume the allocated space.
1748 @param DeviceHandle The device handle consume the allocated space.
1750 @retval EFI_INVALID_PARAMETER Invalid parameter.
1751 @retval EFI_NOT_FOUND No descriptor contains the desired space.
1752 @retval EFI_SUCCESS IO space successfully allocated.
1757 CoreAllocateIoSpace (
1758 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType
,
1759 IN EFI_GCD_IO_TYPE GcdIoType
,
1762 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
1763 IN EFI_HANDLE ImageHandle
,
1764 IN EFI_HANDLE DeviceHandle OPTIONAL
1769 Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency
1770 domain of the processor.
1772 @param BaseAddress Base address of the segment.
1773 @param Length Length of the segment.
1775 @retval EFI_SUCCESS Space successfully freed.
1781 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1787 Removes reserved I/O or I/O resources from the global coherency domain of the
1790 @param BaseAddress Base address of the segment.
1791 @param Length Length of the segment.
1793 @retval EFI_SUCCESS Successfully removed a segment of IO space.
1799 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1805 Retrieves the descriptor for an I/O region containing a specified address.
1807 @param BaseAddress Specified start address
1808 @param Descriptor Specified length
1810 @retval EFI_INVALID_PARAMETER Descriptor is NULL.
1811 @retval EFI_SUCCESS Successfully get the IO space descriptor.
1816 CoreGetIoSpaceDescriptor (
1817 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1818 OUT EFI_GCD_IO_SPACE_DESCRIPTOR
*Descriptor
1823 Returns a map of the I/O resources in the global coherency domain of the processor.
1825 @param NumberOfDescriptors Number of descriptors.
1826 @param IoSpaceMap Descriptor array
1828 @retval EFI_INVALID_PARAMETER Invalid parameter
1829 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1830 @retval EFI_SUCCESS Successfully get IO space map.
1836 OUT UINTN
*NumberOfDescriptors
,
1837 OUT EFI_GCD_IO_SPACE_DESCRIPTOR
**IoSpaceMap
1842 This is the main Dispatcher for DXE and it exits when there are no more
1843 drivers to run. Drain the mScheduledQueue and load and start a PE
1844 image for each driver. Search the mDiscoveredList to see if any driver can
1845 be placed on the mScheduledQueue. If no drivers are placed on the
1846 mScheduledQueue exit the function. On exit it is assumed the Bds()
1847 will be called, and when the Bds() exits the Dispatcher will be called
1850 @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running
1851 @retval EFI_NOT_FOUND No DXE Drivers were dispatched
1852 @retval EFI_SUCCESS One or more DXE Drivers were dispatched
1862 Check every driver and locate a matching one. If the driver is found, the Unrequested
1863 state flag is cleared.
1865 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
1866 the firmware file specified by DriverName.
1867 @param DriverName The Driver name to put in the Dependent state.
1869 @retval EFI_SUCCESS The DriverName was found and it's SOR bit was
1871 @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was
1878 IN EFI_HANDLE FirmwareVolumeHandle
,
1879 IN EFI_GUID
*DriverName
1884 Convert a driver from the Untrused back to the Scheduled state.
1886 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
1887 the firmware file specified by DriverName.
1888 @param DriverName The Driver name to put in the Scheduled state
1890 @retval EFI_SUCCESS The file was found in the untrusted state, and it
1891 was promoted to the trusted state.
1892 @retval EFI_NOT_FOUND The file was not found in the untrusted state.
1898 IN EFI_HANDLE FirmwareVolumeHandle
,
1899 IN EFI_GUID
*DriverName
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
2259 @param IsFfs3Fv Indicates the FV format.
2261 @retval EFI_SUCCESS Section was retrieved successfully
2262 @retval EFI_PROTOCOL_ERROR A GUID defined section was encountered in the
2263 section stream with its
2264 EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,
2265 but there was no corresponding GUIDed Section
2266 Extraction Protocol in the handle database.
2267 *Buffer is unmodified.
2268 @retval EFI_NOT_FOUND An error was encountered when parsing the
2269 SectionStream. This indicates the SectionStream
2270 is not correctly formatted.
2271 @retval EFI_NOT_FOUND The requested section does not exist.
2272 @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
2274 @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
2275 @retval EFI_WARN_TOO_SMALL The size of the caller allocated input buffer is
2276 insufficient to contain the requested section.
2277 The input buffer is filled and section contents
2284 IN UINTN SectionStreamHandle
,
2285 IN EFI_SECTION_TYPE
*SectionType
,
2286 IN EFI_GUID
*SectionDefinitionGuid
,
2287 IN UINTN SectionInstance
,
2289 IN OUT UINTN
*BufferSize
,
2290 OUT UINT32
*AuthenticationStatus
,
2296 SEP member function. Deletes an existing section stream
2298 @param StreamHandleToClose Indicates the stream to close
2300 @retval EFI_SUCCESS The section stream is closed sucessfully.
2301 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
2302 @retval EFI_INVALID_PARAMETER Section stream does not end concident with end
2308 CloseSectionStream (
2309 IN UINTN StreamHandleToClose
2313 Creates and initializes the DebugImageInfo Table. Also creates the configuration
2314 table and registers it into the system table.
2317 This function allocates memory, frees it, and then allocates memory at an
2318 address within the initial allocation. Since this function is called early
2319 in DXE core initialization (before drivers are dispatched), this should not
2324 CoreInitializeDebugImageInfoTable (
2330 Update the CRC32 in the Debug Table.
2331 Since the CRC32 service is made available by the Runtime driver, we have to
2332 wait for the Runtime Driver to be installed before the CRC32 can be computed.
2333 This function is called elsewhere by the core when the runtime architectural
2334 protocol is produced.
2338 CoreUpdateDebugTableCrc32 (
2344 Adds a new DebugImageInfo structure to the DebugImageInfo Table. Re-Allocates
2345 the table if it's not large enough to accomidate another entry.
2347 @param ImageInfoType type of debug image information
2348 @param LoadedImage pointer to the loaded image protocol for the image being
2350 @param ImageHandle image handle for the image being loaded
2354 CoreNewDebugImageInfoEntry (
2355 IN UINT32 ImageInfoType
,
2356 IN EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
,
2357 IN EFI_HANDLE ImageHandle
2362 Removes and frees an entry from the DebugImageInfo Table.
2364 @param ImageHandle image handle for the image being unloaded
2368 CoreRemoveDebugImageInfoEntry (
2369 EFI_HANDLE ImageHandle
2374 This routine consumes FV hobs and produces instances of FW_VOL_BLOCK_PROTOCOL as appropriate.
2376 @param ImageHandle The image handle.
2377 @param SystemTable The system table.
2379 @retval EFI_SUCCESS Successfully initialized firmware volume block
2385 FwVolBlockDriverInit (
2386 IN EFI_HANDLE ImageHandle
,
2387 IN EFI_SYSTEM_TABLE
*SystemTable
2392 This routine produces a firmware volume block protocol on a given
2395 @param BaseAddress base address of the firmware volume image
2396 @param Length length of the firmware volume image
2397 @param ParentHandle handle of parent firmware volume, if this image
2398 came from an FV image file in another firmware
2399 volume (ala capsules)
2400 @param FvProtocol Firmware volume block protocol produced.
2402 @retval EFI_VOLUME_CORRUPTED Volume corrupted.
2403 @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated.
2404 @retval EFI_SUCCESS Successfully produced a FVB protocol on given
2409 ProduceFVBProtocolOnBuffer (
2410 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
2412 IN EFI_HANDLE ParentHandle
,
2413 OUT EFI_HANDLE
*FvProtocol OPTIONAL
2418 Raising to the task priority level of the mutual exclusion
2419 lock, and then acquires ownership of the lock.
2421 @param Lock The lock to acquire
2433 Initialize a basic mutual exclusion lock. Each lock
2434 provides mutual exclusion access at it's task priority
2435 level. Since there is no-premption (at any TPL) or
2436 multiprocessor support, acquiring the lock only consists
2437 of raising to the locks TPL.
2439 @param Lock The EFI_LOCK structure to initialize
2441 @retval EFI_SUCCESS Lock Owned.
2442 @retval EFI_ACCESS_DENIED Reentrant Lock Acquisition, Lock not Owned.
2446 CoreAcquireLockOrFail (
2452 Releases ownership of the mutual exclusion lock, and
2453 restores the previous task priority level.
2455 @param Lock The lock to release
2457 @return Lock unowned
2467 An empty function to pass error checking of CreateEventEx ().
2469 @param Event Event whose notification function is being invoked.
2470 @param Context Pointer to the notification function's context,
2471 which is implementation-dependent.
2476 CoreEmptyCallbackFunction (