2 The internal header file includes the common header files, defines
3 internal structure and functions used by DxeCore module.
5 Copyright (c) 2006 - 2010, 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/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/TcgService.h>
52 #include <Protocol/HiiPackageList.h>
53 #include <Protocol/SmmBase2.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>
64 #include <Guid/LoadModuleAtFixedAddress.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>
82 #include <Library/TimerLib.h>
83 #include <Library/DxeServicesLib.h>
87 // attributes for reserved memory before it is promoted to system memory
89 #define EFI_MEMORY_PRESENT 0x0100000000000000ULL
90 #define EFI_MEMORY_INITIALIZED 0x0200000000000000ULL
91 #define EFI_MEMORY_TESTED 0x0400000000000000ULL
94 // range for memory mapped port I/O on IPF
96 #define EFI_MEMORY_PORT_IO 0x4000000000000000ULL
100 /// EFI_DEP_REPLACE_TRUE - Used to dynamically patch the dependecy expression
101 /// to save time. A EFI_DEP_PUSH is evauated one an
102 /// replaced with EFI_DEP_REPLACE_TRUE. If PI spec's Vol 2
103 /// Driver Execution Environment Core Interface use 0xff
104 /// as new DEPEX opcode. EFI_DEP_REPLACE_TRUE should be
105 /// defined to a new value that is not conflicting with PI spec.
107 #define EFI_DEP_REPLACE_TRUE 0xff
110 /// Define the initial size of the dependency expression evaluation stack
112 #define DEPEX_STACK_SIZE_INCREMENT 0x1000
115 EFI_GUID
*ProtocolGuid
;
120 } EFI_CORE_PROTOCOL_NOTIFY_ENTRY
;
123 // DXE Dispatcher Data structures
126 #define KNOWN_HANDLE_SIGNATURE SIGNATURE_32('k','n','o','w')
129 LIST_ENTRY Link
; // mFvHandleList
134 #define EFI_CORE_DRIVER_ENTRY_SIGNATURE SIGNATURE_32('d','r','v','r')
137 LIST_ENTRY Link
; // mDriverList
139 LIST_ENTRY ScheduledLink
; // mScheduledQueue
143 EFI_DEVICE_PATH_PROTOCOL
*FvFileDevicePath
;
144 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
151 EFI_GUID BeforeAfterGuid
;
158 BOOLEAN DepexProtocolError
;
160 EFI_HANDLE ImageHandle
;
162 } EFI_CORE_DRIVER_ENTRY
;
165 //The data structure of GCD memory map entry
167 #define EFI_GCD_MAP_SIGNATURE SIGNATURE_32('g','c','d','m')
171 EFI_PHYSICAL_ADDRESS BaseAddress
;
175 EFI_GCD_MEMORY_TYPE GcdMemoryType
;
176 EFI_GCD_IO_TYPE GcdIoType
;
177 EFI_HANDLE ImageHandle
;
178 EFI_HANDLE DeviceHandle
;
182 // DXE Core Global Variables
184 extern EFI_SYSTEM_TABLE
*gDxeCoreST
;
185 extern EFI_RUNTIME_SERVICES
*gDxeCoreRT
;
186 extern EFI_DXE_SERVICES
*gDxeCoreDS
;
187 extern EFI_HANDLE gDxeCoreImageHandle
;
189 extern EFI_DECOMPRESS_PROTOCOL gEfiDecompress
;
191 extern EFI_RUNTIME_ARCH_PROTOCOL
*gRuntime
;
192 extern EFI_CPU_ARCH_PROTOCOL
*gCpu
;
193 extern EFI_WATCHDOG_TIMER_ARCH_PROTOCOL
*gWatchdogTimer
;
194 extern EFI_METRONOME_ARCH_PROTOCOL
*gMetronome
;
195 extern EFI_TIMER_ARCH_PROTOCOL
*gTimer
;
196 extern EFI_SECURITY_ARCH_PROTOCOL
*gSecurity
;
197 extern EFI_BDS_ARCH_PROTOCOL
*gBds
;
198 extern EFI_SMM_BASE2_PROTOCOL
*gSmmBase2
;
200 extern EFI_TPL gEfiCurrentTpl
;
202 extern EFI_GUID
*gDxeCoreFileName
;
203 extern EFI_LOADED_IMAGE_PROTOCOL
*gDxeCoreLoadedImage
;
205 extern EFI_MEMORY_TYPE_INFORMATION gMemoryTypeInformation
[EfiMaxMemoryType
+ 1];
207 extern BOOLEAN gDispatcherRunning
;
208 extern EFI_RUNTIME_ARCH_PROTOCOL gRuntimeTemplate
;
210 extern EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE gLoadModuleAtFixAddressConfigurationTable
;
211 extern BOOLEAN gLoadFixedAddressCodeMemoryReady
;
213 // Service Initialization Functions
219 Called to initialize the pool.
229 Called to initialize the memory map and add descriptors to
230 the current descriptor list.
231 The first descriptor that is added must be general usable
232 memory as the addition allocates heap.
234 @param Type The type of memory to add
235 @param Start The starting address in the memory range Must be
237 @param NumberOfPages The number of pages in the range
238 @param Attribute Attributes of the memory to add
240 @return None. The range is added to the memory map
244 CoreAddMemoryDescriptor (
245 IN EFI_MEMORY_TYPE Type
,
246 IN EFI_PHYSICAL_ADDRESS Start
,
247 IN UINT64 NumberOfPages
,
253 Release memory lock on mGcdMemorySpaceLock.
257 CoreReleaseGcdMemoryLock (
263 Acquire memory lock on mGcdMemorySpaceLock.
267 CoreAcquireGcdMemoryLock (
273 External function. Initializes memory services based on the memory
274 descriptor HOBs. This function is responsible for priming the memory
275 map, so memory allocations and resource allocations can be made.
276 The first part of this function can not depend on any memory services
277 until at least one memory descriptor is provided to the memory services.
279 @param HobStart The start address of the HOB.
280 @param MemoryBaseAddress Start address of memory region found to init DXE
282 @param MemoryLength Length of memory region found to init DXE core.
284 @retval EFI_SUCCESS Memory services successfully initialized.
288 CoreInitializeMemoryServices (
290 OUT EFI_PHYSICAL_ADDRESS
*MemoryBaseAddress
,
291 OUT UINT64
*MemoryLength
297 External function. Initializes the GCD and memory services based on the memory
298 descriptor HOBs. This function is responsible for priming the GCD map and the
299 memory map, so memory allocations and resource allocations can be made. The
300 HobStart will be relocated to a pool buffer.
302 @param HobStart The start address of the HOB
303 @param MemoryBaseAddress Start address of memory region found to init DXE
305 @param MemoryLength Length of memory region found to init DXE core.
307 @retval EFI_SUCCESS GCD services successfully initialized.
311 CoreInitializeGcdServices (
312 IN OUT VOID
**HobStart
,
313 IN EFI_PHYSICAL_ADDRESS MemoryBaseAddress
,
314 IN UINT64 MemoryLength
319 Initializes "event" support.
321 @retval EFI_SUCCESS Always return success
325 CoreInitializeEventServices (
331 Add the Image Services to EFI Boot Services Table and install the protocol
332 interfaces for this image.
334 @param HobStart The HOB to initialize
340 CoreInitializeImageServices (
346 Creates an event that is fired everytime a Protocol of a specific type is installed.
350 CoreNotifyOnProtocolInstallation (
356 Return TRUE if all AP services are availible.
358 @retval EFI_SUCCESS All AP services are available
359 @retval EFI_NOT_FOUND At least one AP service is not available
363 CoreAllEfiServicesAvailable (
369 Calcualte the 32-bit CRC in a EFI table using the service provided by the
372 @param Hdr Pointer to an EFI standard header
377 IN OUT EFI_TABLE_HEADER
*Hdr
382 Called by the platform code to process a tick.
384 @param Duration The number of 100ns elasped since the last call
396 Initialize the dispatcher. Initialize the notification function that runs when
397 an FV2 protocol is added to the system.
401 CoreInitializeDispatcher (
407 This is the POSTFIX version of the dependency evaluator. This code does
408 not need to handle Before or After, as it is not valid to call this
409 routine in this case. The SOR is just ignored and is a nop in the grammer.
410 POSTFIX means all the math is done on top of the stack.
412 @param DriverEntry DriverEntry element to update.
414 @retval TRUE If driver is ready to run.
415 @retval FALSE If driver is not ready to run or some fatal error
421 IN EFI_CORE_DRIVER_ENTRY
*DriverEntry
426 Preprocess dependency expression and update DriverEntry to reflect the
427 state of Before, After, and SOR dependencies. If DriverEntry->Before
428 or DriverEntry->After is set it will never be cleared. If SOR is set
429 it will be cleared by CoreSchedule(), and then the driver can be
432 @param DriverEntry DriverEntry element to update .
434 @retval EFI_SUCCESS It always works.
438 CorePreProcessDepex (
439 IN EFI_CORE_DRIVER_ENTRY
*DriverEntry
445 Terminates all boot services.
447 @param ImageHandle Handle that identifies the exiting image.
448 @param MapKey Key to the latest memory map.
450 @retval EFI_SUCCESS Boot Services terminated
451 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
456 CoreExitBootServices (
457 IN EFI_HANDLE ImageHandle
,
463 Make sure the memory map is following all the construction rules,
464 it is the last time to check memory map error before exit boot services.
466 @param MapKey Memory map key
468 @retval EFI_INVALID_PARAMETER Memory map not consistent with construction
470 @retval EFI_SUCCESS Valid memory map.
474 CoreTerminateMemoryMap (
480 Signals all events in the EventGroup.
482 @param EventGroup The list to signal
486 CoreNotifySignalList (
487 IN EFI_GUID
*EventGroup
493 Boot Service called to add, modify, or remove a system configuration table from
494 the EFI System Table.
496 @param Guid Pointer to the GUID for the entry to add, update, or
498 @param Table Pointer to the configuration table for the entry to add,
499 update, or remove, may be NULL.
501 @return EFI_SUCCESS Guid, Table pair added, updated, or removed.
502 @return EFI_INVALID_PARAMETER Input GUID not valid.
503 @return EFI_NOT_FOUND Attempted to delete non-existant entry
504 @return EFI_OUT_OF_RESOURCES Not enough memory available
509 CoreInstallConfigurationTable (
517 Raise the task priority level to the new level.
518 High level is implemented by disabling processor interrupts.
520 @param NewTpl New task priority level
522 @return The previous task priority level
534 Lowers the task priority to the previous value. If the new
535 priority unmasks events at a higher priority, they are dispatched.
537 @param NewTpl New, lower, task priority
549 Introduces a fine-grained stall.
551 @param Microseconds The number of microseconds to stall execution.
553 @retval EFI_SUCCESS Execution was stalled for at least the requested
554 amount of microseconds.
555 @retval EFI_NOT_AVAILABLE_YET gMetronome is not available yet
561 IN UINTN Microseconds
567 Sets the system's watchdog timer.
569 @param Timeout The number of seconds to set the watchdog timer to.
570 A value of zero disables the timer.
571 @param WatchdogCode The numeric code to log on a watchdog timer timeout
572 event. The firmware reserves codes 0x0000 to 0xFFFF.
573 Loaders and operating systems may use other timeout
575 @param DataSize The size, in bytes, of WatchdogData.
576 @param WatchdogData A data buffer that includes a Null-terminated Unicode
577 string, optionally followed by additional binary data.
578 The string is a description that the call may use to
579 further indicate the reason to be logged with a
582 @return EFI_SUCCESS Timeout has been set
583 @return EFI_NOT_AVAILABLE_YET WatchdogTimer is not available yet
584 @return EFI_UNSUPPORTED System does not have a timer (currently not used)
585 @return EFI_DEVICE_ERROR Could not complete due to hardware error
590 CoreSetWatchdogTimer (
592 IN UINT64 WatchdogCode
,
594 IN CHAR16
*WatchdogData OPTIONAL
600 Wrapper function to CoreInstallProtocolInterfaceNotify. This is the public API which
601 Calls the private one which contains a BOOLEAN parameter for notifications
603 @param UserHandle The handle to install the protocol handler on,
604 or NULL if a new handle is to be allocated
605 @param Protocol The protocol to add to the handle
606 @param InterfaceType Indicates whether Interface is supplied in
608 @param Interface The interface for the protocol being added
615 CoreInstallProtocolInterface (
616 IN OUT EFI_HANDLE
*UserHandle
,
617 IN EFI_GUID
*Protocol
,
618 IN EFI_INTERFACE_TYPE InterfaceType
,
624 Installs a protocol interface into the boot services environment.
626 @param UserHandle The handle to install the protocol handler on,
627 or NULL if a new handle is to be allocated
628 @param Protocol The protocol to add to the handle
629 @param InterfaceType Indicates whether Interface is supplied in
631 @param Interface The interface for the protocol being added
632 @param Notify indicates whether notify the notification list
635 @retval EFI_INVALID_PARAMETER Invalid parameter
636 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
637 @retval EFI_SUCCESS Protocol interface successfully installed
641 CoreInstallProtocolInterfaceNotify (
642 IN OUT EFI_HANDLE
*UserHandle
,
643 IN EFI_GUID
*Protocol
,
644 IN EFI_INTERFACE_TYPE InterfaceType
,
652 Installs a list of protocol interface into the boot services environment.
653 This function calls InstallProtocolInterface() in a loop. If any error
654 occures all the protocols added by this function are removed. This is
655 basically a lib function to save space.
657 @param Handle The handle to install the protocol handlers on,
658 or NULL if a new handle is to be allocated
659 @param ... EFI_GUID followed by protocol instance. A NULL
660 terminates the list. The pairs are the
661 arguments to InstallProtocolInterface(). All the
662 protocols are added to Handle.
664 @retval EFI_INVALID_PARAMETER Handle is NULL.
665 @retval EFI_SUCCESS Protocol interfaces successfully installed.
670 CoreInstallMultipleProtocolInterfaces (
671 IN OUT EFI_HANDLE
*Handle
,
678 Uninstalls a list of protocol interface in the boot services environment.
679 This function calls UnisatllProtocolInterface() in a loop. This is
680 basically a lib function to save space.
682 @param Handle The handle to uninstall the protocol
683 @param ... EFI_GUID followed by protocol instance. A NULL
684 terminates the list. The pairs are the
685 arguments to UninstallProtocolInterface(). All
686 the protocols are added to Handle.
693 CoreUninstallMultipleProtocolInterfaces (
694 IN EFI_HANDLE Handle
,
701 Reinstall a protocol interface on a device handle. The OldInterface for Protocol is replaced by the NewInterface.
703 @param UserHandle Handle on which the interface is to be
705 @param Protocol The numeric ID of the interface
706 @param OldInterface A pointer to the old interface
707 @param NewInterface A pointer to the new interface
709 @retval EFI_SUCCESS The protocol interface was installed
710 @retval EFI_NOT_FOUND The OldInterface on the handle was not found
711 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
716 CoreReinstallProtocolInterface (
717 IN EFI_HANDLE UserHandle
,
718 IN EFI_GUID
*Protocol
,
719 IN VOID
*OldInterface
,
720 IN VOID
*NewInterface
726 Uninstalls all instances of a protocol:interfacer from a handle.
727 If the last protocol interface is remove from the handle, the
730 @param UserHandle The handle to remove the protocol handler from
731 @param Protocol The protocol, of protocol:interface, to remove
732 @param Interface The interface, of protocol:interface, to remove
734 @retval EFI_INVALID_PARAMETER Protocol is NULL.
735 @retval EFI_SUCCESS Protocol interface successfully uninstalled.
740 CoreUninstallProtocolInterface (
741 IN EFI_HANDLE UserHandle
,
742 IN EFI_GUID
*Protocol
,
749 Queries a handle to determine if it supports a specified protocol.
751 @param UserHandle The handle being queried.
752 @param Protocol The published unique identifier of the protocol.
753 @param Interface Supplies the address where a pointer to the
754 corresponding Protocol Interface is returned.
756 @return The requested protocol interface for the handle
762 IN EFI_HANDLE UserHandle
,
763 IN EFI_GUID
*Protocol
,
770 Locates the installed protocol handler for the handle, and
771 invokes it to obtain the protocol interface. Usage information
772 is registered in the protocol data base.
774 @param UserHandle The handle to obtain the protocol interface on
775 @param Protocol The ID of the protocol
776 @param Interface The location to return the protocol interface
777 @param ImageHandle The handle of the Image that is opening the
778 protocol interface specified by Protocol and
780 @param ControllerHandle The controller handle that is requiring this
782 @param Attributes The open mode of the protocol interface
783 specified by Handle and Protocol.
785 @retval EFI_INVALID_PARAMETER Protocol is NULL.
786 @retval EFI_SUCCESS Get the protocol interface.
792 IN EFI_HANDLE UserHandle
,
793 IN EFI_GUID
*Protocol
,
794 OUT VOID
**Interface OPTIONAL
,
795 IN EFI_HANDLE ImageHandle
,
796 IN EFI_HANDLE ControllerHandle
,
803 Return information about Opened protocols in the system
805 @param UserHandle The handle to close the protocol interface on
806 @param Protocol The ID of the protocol
807 @param EntryBuffer A pointer to a buffer of open protocol
808 information in the form of
809 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
810 @param EntryCount Number of EntryBuffer entries
815 CoreOpenProtocolInformation (
816 IN EFI_HANDLE UserHandle
,
817 IN EFI_GUID
*Protocol
,
818 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
819 OUT UINTN
*EntryCount
825 Closes a protocol on a handle that was opened using OpenProtocol().
827 @param UserHandle The handle for the protocol interface that was
828 previously opened with OpenProtocol(), and is
830 @param Protocol The published unique identifier of the protocol.
831 It is the caller's responsibility to pass in a
833 @param AgentHandle The handle of the agent that is closing the
835 @param ControllerHandle If the agent that opened a protocol is a driver
836 that follows the EFI Driver Model, then this
837 parameter is the controller handle that required
838 the protocol interface. If the agent does not
839 follow the EFI Driver Model, then this parameter
840 is optional and may be NULL.
842 @retval EFI_SUCCESS The protocol instance was closed.
843 @retval EFI_INVALID_PARAMETER Handle, AgentHandle or ControllerHandle is not a
845 @retval EFI_NOT_FOUND Can not find the specified protocol or
852 IN EFI_HANDLE UserHandle
,
853 IN EFI_GUID
*Protocol
,
854 IN EFI_HANDLE AgentHandle
,
855 IN EFI_HANDLE ControllerHandle
861 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
864 @param UserHandle The handle from which to retrieve the list of
865 protocol interface GUIDs.
866 @param ProtocolBuffer A pointer to the list of protocol interface GUID
867 pointers that are installed on Handle.
868 @param ProtocolBufferCount A pointer to the number of GUID pointers present
871 @retval EFI_SUCCESS The list of protocol interface GUIDs installed
872 on Handle was returned in ProtocolBuffer. The
873 number of protocol interface GUIDs was returned
874 in ProtocolBufferCount.
875 @retval EFI_INVALID_PARAMETER Handle is NULL.
876 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
877 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
878 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
879 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the
885 CoreProtocolsPerHandle (
886 IN EFI_HANDLE UserHandle
,
887 OUT EFI_GUID
***ProtocolBuffer
,
888 OUT UINTN
*ProtocolBufferCount
894 Add a new protocol notification record for the request protocol.
896 @param Protocol The requested protocol to add the notify
898 @param Event The event to signal
899 @param Registration Returns the registration record
901 @retval EFI_INVALID_PARAMETER Invalid parameter
902 @retval EFI_SUCCESS Successfully returned the registration record
908 CoreRegisterProtocolNotify (
909 IN EFI_GUID
*Protocol
,
911 OUT VOID
**Registration
916 Removes all the events in the protocol database that match Event.
918 @param Event The event to search for in the protocol
921 @return EFI_SUCCESS when done searching the entire database.
925 CoreUnregisterProtocolNotify (
931 Locates the requested handle(s) and returns them in Buffer.
933 @param SearchType The type of search to perform to locate the
935 @param Protocol The protocol to search for
936 @param SearchKey Dependant on SearchType
937 @param BufferSize On input the size of Buffer. On output the
938 size of data returned.
939 @param Buffer The buffer to return the results in
941 @retval EFI_BUFFER_TOO_SMALL Buffer too small, required buffer size is
942 returned in BufferSize.
943 @retval EFI_INVALID_PARAMETER Invalid parameter
944 @retval EFI_SUCCESS Successfully found the requested handle(s) and
945 returns them in Buffer.
951 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
952 IN EFI_GUID
*Protocol OPTIONAL
,
953 IN VOID
*SearchKey OPTIONAL
,
954 IN OUT UINTN
*BufferSize
,
955 OUT EFI_HANDLE
*Buffer
961 Locates the handle to a device on the device path that best matches the specified protocol.
963 @param Protocol The protocol to search for.
964 @param DevicePath On input, a pointer to a pointer to the device
965 path. On output, the device path pointer is
966 modified to point to the remaining part of the
968 @param Device A pointer to the returned device handle.
970 @retval EFI_SUCCESS The resulting handle was returned.
971 @retval EFI_NOT_FOUND No handles matched the search.
972 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
977 CoreLocateDevicePath (
978 IN EFI_GUID
*Protocol
,
979 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
980 OUT EFI_HANDLE
*Device
986 Function returns an array of handles that support the requested protocol
987 in a buffer allocated from pool. This is a version of CoreLocateHandle()
988 that allocates a buffer for the caller.
990 @param SearchType Specifies which handle(s) are to be returned.
991 @param Protocol Provides the protocol to search by. This
992 parameter is only valid for SearchType
994 @param SearchKey Supplies the search key depending on the
996 @param NumberHandles The number of handles returned in Buffer.
997 @param Buffer A pointer to the buffer to return the requested
998 array of handles that support Protocol.
1000 @retval EFI_SUCCESS The result array of handles was returned.
1001 @retval EFI_NOT_FOUND No handles match the search.
1002 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the
1004 @retval EFI_INVALID_PARAMETER One or more paramters are not valid.
1009 CoreLocateHandleBuffer (
1010 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1011 IN EFI_GUID
*Protocol OPTIONAL
,
1012 IN VOID
*SearchKey OPTIONAL
,
1013 IN OUT UINTN
*NumberHandles
,
1014 OUT EFI_HANDLE
**Buffer
1020 Return the first Protocol Interface that matches the Protocol GUID. If
1021 Registration is passed in, return a Protocol Instance that was just add
1022 to the system. If Registration is NULL return the first Protocol Interface
1025 @param Protocol The protocol to search for
1026 @param Registration Optional Registration Key returned from
1027 RegisterProtocolNotify()
1028 @param Interface Return the Protocol interface (instance).
1030 @retval EFI_SUCCESS If a valid Interface is returned
1031 @retval EFI_INVALID_PARAMETER Invalid parameter
1032 @retval EFI_NOT_FOUND Protocol interface not found
1037 CoreLocateProtocol (
1038 IN EFI_GUID
*Protocol
,
1039 IN VOID
*Registration OPTIONAL
,
1040 OUT VOID
**Interface
1045 return handle database key.
1048 @return Handle database key.
1052 CoreGetHandleDatabaseKey (
1058 Go connect any handles that were created or modified while a image executed.
1060 @param Key The Key to show that the handle has been
1065 CoreConnectHandlesByKey (
1072 Connects one or more drivers to a controller.
1074 @param ControllerHandle Handle of the controller to be
1076 @param DriverImageHandle DriverImageHandle A pointer to an
1077 ordered list of driver image
1079 @param RemainingDevicePath RemainingDevicePath A pointer to
1080 the device path that specifies a
1081 child of the controller specified
1082 by ControllerHandle.
1083 @param Recursive Whether the function would be
1084 called recursively or not.
1086 @return Status code.
1091 CoreConnectController (
1092 IN EFI_HANDLE ControllerHandle
,
1093 IN EFI_HANDLE
*DriverImageHandle OPTIONAL
,
1094 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
,
1095 IN BOOLEAN Recursive
1101 Disonnects a controller from a driver
1103 @param ControllerHandle ControllerHandle The handle of
1104 the controller from which
1107 @param DriverImageHandle DriverImageHandle The driver to
1108 disconnect from ControllerHandle.
1109 @param ChildHandle ChildHandle The handle of the
1112 @retval EFI_SUCCESS One or more drivers were
1113 disconnected from the controller.
1114 @retval EFI_SUCCESS On entry, no drivers are managing
1116 @retval EFI_SUCCESS DriverImageHandle is not NULL,
1117 and on entry DriverImageHandle is
1118 not managing ControllerHandle.
1119 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid
1121 @retval EFI_INVALID_PARAMETER DriverImageHandle is not NULL,
1122 and it is not a valid EFI_HANDLE.
1123 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it
1124 is not a valid EFI_HANDLE.
1125 @retval EFI_OUT_OF_RESOURCES There are not enough resources
1126 available to disconnect any
1127 drivers from ControllerHandle.
1128 @retval EFI_DEVICE_ERROR The controller could not be
1129 disconnected because of a device
1135 CoreDisconnectController (
1136 IN EFI_HANDLE ControllerHandle
,
1137 IN EFI_HANDLE DriverImageHandle OPTIONAL
,
1138 IN EFI_HANDLE ChildHandle OPTIONAL
1144 Allocates pages from the memory map.
1146 @param Type The type of allocation to perform
1147 @param MemoryType The type of memory to turn the allocated pages
1149 @param NumberOfPages The number of pages to allocate
1150 @param Memory A pointer to receive the base allocated memory
1153 @return Status. On success, Memory is filled in with the base address allocated
1154 @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in
1156 @retval EFI_NOT_FOUND Could not allocate pages match the requirement.
1157 @retval EFI_OUT_OF_RESOURCES No enough pages to allocate.
1158 @retval EFI_SUCCESS Pages successfully allocated.
1164 IN EFI_ALLOCATE_TYPE Type
,
1165 IN EFI_MEMORY_TYPE MemoryType
,
1166 IN UINTN NumberOfPages
,
1167 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
1173 Frees previous allocated pages.
1175 @param Memory Base address of memory being freed
1176 @param NumberOfPages The number of pages to free
1178 @retval EFI_NOT_FOUND Could not find the entry that covers the range
1179 @retval EFI_INVALID_PARAMETER Address not aligned
1180 @return EFI_SUCCESS -Pages successfully freed.
1186 IN EFI_PHYSICAL_ADDRESS Memory
,
1187 IN UINTN NumberOfPages
1193 This function returns a copy of the current memory map. The map is an array of
1194 memory descriptors, each of which describes a contiguous block of memory.
1196 @param MemoryMapSize A pointer to the size, in bytes, of the
1197 MemoryMap buffer. On input, this is the size of
1198 the buffer allocated by the caller. On output,
1199 it is the size of the buffer returned by the
1200 firmware if the buffer was large enough, or the
1201 size of the buffer needed to contain the map if
1202 the buffer was too small.
1203 @param MemoryMap A pointer to the buffer in which firmware places
1204 the current memory map.
1205 @param MapKey A pointer to the location in which firmware
1206 returns the key for the current memory map.
1207 @param DescriptorSize A pointer to the location in which firmware
1208 returns the size, in bytes, of an individual
1209 EFI_MEMORY_DESCRIPTOR.
1210 @param DescriptorVersion A pointer to the location in which firmware
1211 returns the version number associated with the
1212 EFI_MEMORY_DESCRIPTOR.
1214 @retval EFI_SUCCESS The memory map was returned in the MemoryMap
1216 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current
1217 buffer size needed to hold the memory map is
1218 returned in MemoryMapSize.
1219 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1225 IN OUT UINTN
*MemoryMapSize
,
1226 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
1228 OUT UINTN
*DescriptorSize
,
1229 OUT UINT32
*DescriptorVersion
1235 Allocate pool of a particular type.
1237 @param PoolType Type of pool to allocate
1238 @param Size The amount of pool to allocate
1239 @param Buffer The address to return a pointer to the allocated
1242 @retval EFI_INVALID_PARAMETER PoolType not valid
1243 @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed.
1244 @retval EFI_SUCCESS Pool successfully allocated.
1250 IN EFI_MEMORY_TYPE PoolType
,
1260 @param Buffer The allocated pool entry to free
1262 @retval EFI_INVALID_PARAMETER Buffer is not a valid value.
1263 @retval EFI_SUCCESS Pool successfully freed.
1275 Loads an EFI image into memory and returns a handle to the image.
1277 @param BootPolicy If TRUE, indicates that the request originates
1278 from the boot manager, and that the boot
1279 manager is attempting to load FilePath as a
1281 @param ParentImageHandle The caller's image handle.
1282 @param FilePath The specific file path from which the image is
1284 @param SourceBuffer If not NULL, a pointer to the memory location
1285 containing a copy of the image to be loaded.
1286 @param SourceSize The size in bytes of SourceBuffer.
1287 @param ImageHandle Pointer to the returned image handle that is
1288 created when the image is successfully loaded.
1290 @retval EFI_SUCCESS The image was loaded into memory.
1291 @retval EFI_NOT_FOUND The FilePath was not found.
1292 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1293 @retval EFI_UNSUPPORTED The image type is not supported, or the device
1294 path cannot be parsed to locate the proper
1295 protocol for loading the file.
1296 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient
1303 IN BOOLEAN BootPolicy
,
1304 IN EFI_HANDLE ParentImageHandle
,
1305 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1306 IN VOID
*SourceBuffer OPTIONAL
,
1307 IN UINTN SourceSize
,
1308 OUT EFI_HANDLE
*ImageHandle
1316 @param ImageHandle Handle that identifies the image to be
1319 @retval EFI_SUCCESS The image has been unloaded.
1320 @retval EFI_UNSUPPORTED The image has been sarted, and does not support
1322 @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image handle.
1328 IN EFI_HANDLE ImageHandle
1334 Transfer control to a loaded image's entry point.
1336 @param ImageHandle Handle of image to be started.
1337 @param ExitDataSize Pointer of the size to ExitData
1338 @param ExitData Pointer to a pointer to a data buffer that
1339 includes a Null-terminated Unicode string,
1340 optionally followed by additional binary data.
1341 The string is a description that the caller may
1342 use to further indicate the reason for the
1345 @retval EFI_INVALID_PARAMETER Invalid parameter
1346 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1347 @retval EFI_SUCCESS Successfully transfer control to the image's
1354 IN EFI_HANDLE ImageHandle
,
1355 OUT UINTN
*ExitDataSize
,
1356 OUT CHAR16
**ExitData OPTIONAL
1362 Terminates the currently loaded EFI image and returns control to boot services.
1364 @param ImageHandle Handle that identifies the image. This
1365 parameter is passed to the image on entry.
1366 @param Status The image's exit code.
1367 @param ExitDataSize The size, in bytes, of ExitData. Ignored if
1368 ExitStatus is EFI_SUCCESS.
1369 @param ExitData Pointer to a data buffer that includes a
1370 Null-terminated Unicode string, optionally
1371 followed by additional binary data. The string
1372 is a description that the caller may use to
1373 further indicate the reason for the image's
1376 @retval EFI_INVALID_PARAMETER Image handle is NULL or it is not current
1378 @retval EFI_SUCCESS Successfully terminates the currently loaded
1380 @retval EFI_ACCESS_DENIED Should never reach there.
1381 @retval EFI_OUT_OF_RESOURCES Could not allocate pool
1387 IN EFI_HANDLE ImageHandle
,
1388 IN EFI_STATUS Status
,
1389 IN UINTN ExitDataSize
,
1390 IN CHAR16
*ExitData OPTIONAL
1396 Creates a general-purpose event structure.
1398 @param Type The type of event to create and its mode and
1400 @param NotifyTpl The task priority level of event notifications
1401 @param NotifyFunction Pointer to the events notification function
1402 @param NotifyContext Pointer to the notification functions context;
1403 corresponds to parameter "Context" in the
1404 notification function
1405 @param Event Pointer to the newly created event if the call
1406 succeeds; undefined otherwise
1408 @retval EFI_SUCCESS The event structure was created
1409 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
1410 @retval EFI_OUT_OF_RESOURCES The event could not be allocated
1417 IN EFI_TPL NotifyTpl
,
1418 IN EFI_EVENT_NOTIFY NotifyFunction
, OPTIONAL
1419 IN VOID
*NotifyContext
, OPTIONAL
1420 OUT EFI_EVENT
*Event
1426 Creates a general-purpose event structure
1428 @param Type The type of event to create and its mode and
1430 @param NotifyTpl The task priority level of event notifications
1431 @param NotifyFunction Pointer to the events notification function
1432 @param NotifyContext Pointer to the notification functions context;
1433 corresponds to parameter "Context" in the
1434 notification function
1435 @param EventGroup GUID for EventGroup if NULL act the same as
1437 @param Event Pointer to the newly created event if the call
1438 succeeds; undefined otherwise
1440 @retval EFI_SUCCESS The event structure was created
1441 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
1442 @retval EFI_OUT_OF_RESOURCES The event could not be allocated
1449 IN EFI_TPL NotifyTpl
,
1450 IN EFI_EVENT_NOTIFY NotifyFunction
, OPTIONAL
1451 IN CONST VOID
*NotifyContext
, OPTIONAL
1452 IN CONST EFI_GUID
*EventGroup
, OPTIONAL
1453 OUT EFI_EVENT
*Event
1459 Sets the type of timer and the trigger time for a timer event.
1461 @param UserEvent The timer event that is to be signaled at the
1463 @param Type The type of time that is specified in
1465 @param TriggerTime The number of 100ns units until the timer
1468 @retval EFI_SUCCESS The event has been set to be signaled at the
1470 @retval EFI_INVALID_PARAMETER Event or Type is not valid
1476 IN EFI_EVENT UserEvent
,
1477 IN EFI_TIMER_DELAY Type
,
1478 IN UINT64 TriggerTime
1484 Signals the event. Queues the event to be notified if needed.
1486 @param UserEvent The event to signal .
1488 @retval EFI_INVALID_PARAMETER Parameters are not valid.
1489 @retval EFI_SUCCESS The event was signaled.
1495 IN EFI_EVENT UserEvent
1501 Stops execution until an event is signaled.
1503 @param NumberOfEvents The number of events in the UserEvents array
1504 @param UserEvents An array of EFI_EVENT
1505 @param UserIndex Pointer to the index of the event which
1506 satisfied the wait condition
1508 @retval EFI_SUCCESS The event indicated by Index was signaled.
1509 @retval EFI_INVALID_PARAMETER The event indicated by Index has a notification
1510 function or Event was not a valid type
1511 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION
1517 IN UINTN NumberOfEvents
,
1518 IN EFI_EVENT
*UserEvents
,
1519 OUT UINTN
*UserIndex
1525 Closes an event and frees the event structure.
1527 @param UserEvent Event to close
1529 @retval EFI_INVALID_PARAMETER Parameters are not valid.
1530 @retval EFI_SUCCESS The event has been closed
1536 IN EFI_EVENT UserEvent
1542 Check the status of an event.
1544 @param UserEvent The event to check
1546 @retval EFI_SUCCESS The event is in the signaled state
1547 @retval EFI_NOT_READY The event is not in the signaled state
1548 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL
1554 IN EFI_EVENT UserEvent
1559 Adds reserved memory, system memory, or memory-mapped I/O resources to the
1560 global coherency domain of the processor.
1562 @param GcdMemoryType Memory type of the memory space.
1563 @param BaseAddress Base address of the memory space.
1564 @param Length Length of the memory space.
1565 @param Capabilities alterable attributes of the memory space.
1567 @retval EFI_SUCCESS Merged this memory space into GCD map.
1572 CoreAddMemorySpace (
1573 IN EFI_GCD_MEMORY_TYPE GcdMemoryType
,
1574 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1576 IN UINT64 Capabilities
1581 Allocates nonexistent memory, reserved memory, system memory, or memorymapped
1582 I/O resources from the global coherency domain of the processor.
1584 @param GcdAllocateType The type of allocate operation
1585 @param GcdMemoryType The desired memory type
1586 @param Alignment Align with 2^Alignment
1587 @param Length Length to allocate
1588 @param BaseAddress Base address to allocate
1589 @param ImageHandle The image handle consume the allocated space.
1590 @param DeviceHandle The device handle consume the allocated space.
1592 @retval EFI_INVALID_PARAMETER Invalid parameter.
1593 @retval EFI_NOT_FOUND No descriptor contains the desired space.
1594 @retval EFI_SUCCESS Memory space successfully allocated.
1599 CoreAllocateMemorySpace (
1600 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType
,
1601 IN EFI_GCD_MEMORY_TYPE GcdMemoryType
,
1604 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
1605 IN EFI_HANDLE ImageHandle
,
1606 IN EFI_HANDLE DeviceHandle OPTIONAL
1611 Frees nonexistent memory, reserved memory, system memory, or memory-mapped
1612 I/O resources from the global coherency domain of the processor.
1614 @param BaseAddress Base address of the memory space.
1615 @param Length Length of the memory space.
1617 @retval EFI_SUCCESS Space successfully freed.
1622 CoreFreeMemorySpace (
1623 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1629 Removes reserved memory, system memory, or memory-mapped I/O resources from
1630 the global coherency domain of the processor.
1632 @param BaseAddress Base address of the memory space.
1633 @param Length Length of the memory space.
1635 @retval EFI_SUCCESS Successfully remove a segment of memory space.
1640 CoreRemoveMemorySpace (
1641 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1647 Retrieves the descriptor for a memory region containing a specified address.
1649 @param BaseAddress Specified start address
1650 @param Descriptor Specified length
1652 @retval EFI_INVALID_PARAMETER Invalid parameter
1653 @retval EFI_SUCCESS Successfully get memory space descriptor.
1658 CoreGetMemorySpaceDescriptor (
1659 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1660 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR
*Descriptor
1665 Modifies the attributes for a memory region in the global coherency domain of the
1668 @param BaseAddress Specified start address
1669 @param Length Specified length
1670 @param Attributes Specified attributes
1672 @retval EFI_SUCCESS Successfully set attribute of a segment of
1678 CoreSetMemorySpaceAttributes (
1679 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1681 IN UINT64 Attributes
1686 Returns a map of the memory resources in the global coherency domain of the
1689 @param NumberOfDescriptors Number of descriptors.
1690 @param MemorySpaceMap Descriptor array
1692 @retval EFI_INVALID_PARAMETER Invalid parameter
1693 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1694 @retval EFI_SUCCESS Successfully get memory space map.
1699 CoreGetMemorySpaceMap (
1700 OUT UINTN
*NumberOfDescriptors
,
1701 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR
**MemorySpaceMap
1706 Adds reserved I/O or I/O resources to the global coherency domain of the processor.
1708 @param GcdIoType IO type of the segment.
1709 @param BaseAddress Base address of the segment.
1710 @param Length Length of the segment.
1712 @retval EFI_SUCCESS Merged this segment into GCD map.
1713 @retval EFI_INVALID_PARAMETER Parameter not valid
1719 IN EFI_GCD_IO_TYPE GcdIoType
,
1720 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1726 Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency
1727 domain of the processor.
1729 @param GcdAllocateType The type of allocate operation
1730 @param GcdIoType The desired IO type
1731 @param Alignment Align with 2^Alignment
1732 @param Length Length to allocate
1733 @param BaseAddress Base address to allocate
1734 @param ImageHandle The image handle consume the allocated space.
1735 @param DeviceHandle The device handle consume the allocated space.
1737 @retval EFI_INVALID_PARAMETER Invalid parameter.
1738 @retval EFI_NOT_FOUND No descriptor contains the desired space.
1739 @retval EFI_SUCCESS IO space successfully allocated.
1744 CoreAllocateIoSpace (
1745 IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType
,
1746 IN EFI_GCD_IO_TYPE GcdIoType
,
1749 IN OUT EFI_PHYSICAL_ADDRESS
*BaseAddress
,
1750 IN EFI_HANDLE ImageHandle
,
1751 IN EFI_HANDLE DeviceHandle OPTIONAL
1756 Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency
1757 domain of the processor.
1759 @param BaseAddress Base address of the segment.
1760 @param Length Length of the segment.
1762 @retval EFI_SUCCESS Space successfully freed.
1768 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1774 Removes reserved I/O or I/O resources from the global coherency domain of the
1777 @param BaseAddress Base address of the segment.
1778 @param Length Length of the segment.
1780 @retval EFI_SUCCESS Successfully removed a segment of IO space.
1786 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1792 Retrieves the descriptor for an I/O region containing a specified address.
1794 @param BaseAddress Specified start address
1795 @param Descriptor Specified length
1797 @retval EFI_INVALID_PARAMETER Descriptor is NULL.
1798 @retval EFI_SUCCESS Successfully get the IO space descriptor.
1803 CoreGetIoSpaceDescriptor (
1804 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1805 OUT EFI_GCD_IO_SPACE_DESCRIPTOR
*Descriptor
1810 Returns a map of the I/O resources in the global coherency domain of the processor.
1812 @param NumberOfDescriptors Number of descriptors.
1813 @param IoSpaceMap Descriptor array
1815 @retval EFI_INVALID_PARAMETER Invalid parameter
1816 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
1817 @retval EFI_SUCCESS Successfully get IO space map.
1823 OUT UINTN
*NumberOfDescriptors
,
1824 OUT EFI_GCD_IO_SPACE_DESCRIPTOR
**IoSpaceMap
1829 This is the main Dispatcher for DXE and it exits when there are no more
1830 drivers to run. Drain the mScheduledQueue and load and start a PE
1831 image for each driver. Search the mDiscoveredList to see if any driver can
1832 be placed on the mScheduledQueue. If no drivers are placed on the
1833 mScheduledQueue exit the function. On exit it is assumed the Bds()
1834 will be called, and when the Bds() exits the Dispatcher will be called
1837 @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running
1838 @retval EFI_NOT_FOUND No DXE Drivers were dispatched
1839 @retval EFI_SUCCESS One or more DXE Drivers were dispatched
1849 Check every driver and locate a matching one. If the driver is found, the Unrequested
1850 state flag is cleared.
1852 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
1853 the firmware file specified by DriverName.
1854 @param DriverName The Driver name to put in the Dependent state.
1856 @retval EFI_SUCCESS The DriverName was found and it's SOR bit was
1858 @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was
1865 IN EFI_HANDLE FirmwareVolumeHandle
,
1866 IN EFI_GUID
*DriverName
1871 Convert a driver from the Untrused back to the Scheduled state.
1873 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
1874 the firmware file specified by DriverName.
1875 @param DriverName The Driver name to put in the Scheduled state
1877 @retval EFI_SUCCESS The file was found in the untrusted state, and it
1878 was promoted to the trusted state.
1879 @retval EFI_NOT_FOUND The file was not found in the untrusted state.
1885 IN EFI_HANDLE FirmwareVolumeHandle
,
1886 IN EFI_GUID
*DriverName
1891 This routine is the driver initialization entry point. It initializes the
1892 libraries, and registers two notification functions. These notification
1893 functions are responsible for building the FV stack dynamically.
1895 @param ImageHandle The image handle.
1896 @param SystemTable The system table.
1898 @retval EFI_SUCCESS Function successfully returned.
1904 IN EFI_HANDLE ImageHandle
,
1905 IN EFI_SYSTEM_TABLE
*SystemTable
1910 Entry point of the section extraction code. Initializes an instance of the
1911 section extraction interface and installs it on a new handle.
1913 @param ImageHandle A handle for the image that is initializing this driver
1914 @param SystemTable A pointer to the EFI system table
1916 @retval EFI_SUCCESS Driver initialized successfully
1917 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources
1922 InitializeSectionExtraction (
1923 IN EFI_HANDLE ImageHandle
,
1924 IN EFI_SYSTEM_TABLE
*SystemTable
1929 This DXE service routine is used to process a firmware volume. In
1930 particular, it can be called by BDS to process a single firmware
1931 volume found in a capsule.
1933 @param FvHeader pointer to a firmware volume header
1934 @param Size the size of the buffer pointed to by FvHeader
1935 @param FVProtocolHandle the handle on which a firmware volume protocol
1936 was produced for the firmware volume passed in.
1938 @retval EFI_OUT_OF_RESOURCES if an FVB could not be produced due to lack of
1940 @retval EFI_VOLUME_CORRUPTED if the volume was corrupted
1941 @retval EFI_SUCCESS a firmware volume protocol was produced for the
1947 CoreProcessFirmwareVolume (
1950 OUT EFI_HANDLE
*FVProtocolHandle
1954 //Functions used during debug buils
1958 Displays Architectural protocols that were not loaded and are required for DXE
1959 core to function. Only used in Debug Builds.
1963 CoreDisplayMissingArchProtocols (
1969 Traverse the discovered list for any drivers that were discovered but not loaded
1970 because the dependency experessions evaluated to false.
1974 CoreDisplayDiscoveredNotDispatched (
1980 Place holder function until all the Boot Services and Runtime Services are
1983 @return EFI_NOT_AVAILABLE_YET
1988 CoreEfiNotAvailableYetArg0 (
1994 Place holder function until all the Boot Services and Runtime Services are
1997 @param Arg1 Undefined
1999 @return EFI_NOT_AVAILABLE_YET
2004 CoreEfiNotAvailableYetArg1 (
2010 Place holder function until all the Boot Services and Runtime Services are available.
2012 @param Arg1 Undefined
2013 @param Arg2 Undefined
2015 @return EFI_NOT_AVAILABLE_YET
2020 CoreEfiNotAvailableYetArg2 (
2027 Place holder function until all the Boot Services and Runtime Services are available.
2029 @param Arg1 Undefined
2030 @param Arg2 Undefined
2031 @param Arg3 Undefined
2033 @return EFI_NOT_AVAILABLE_YET
2038 CoreEfiNotAvailableYetArg3 (
2046 Place holder function until all the Boot Services and Runtime Services are available.
2048 @param Arg1 Undefined
2049 @param Arg2 Undefined
2050 @param Arg3 Undefined
2051 @param Arg4 Undefined
2053 @return EFI_NOT_AVAILABLE_YET
2058 CoreEfiNotAvailableYetArg4 (
2067 Place holder function until all the Boot Services and Runtime Services are available.
2069 @param Arg1 Undefined
2070 @param Arg2 Undefined
2071 @param Arg3 Undefined
2072 @param Arg4 Undefined
2073 @param Arg5 Undefined
2075 @return EFI_NOT_AVAILABLE_YET
2080 CoreEfiNotAvailableYetArg5 (
2090 Given a compressed source buffer, this function retrieves the size of the
2091 uncompressed buffer and the size of the scratch buffer required to decompress
2092 the compressed source buffer.
2094 The GetInfo() function retrieves the size of the uncompressed buffer and the
2095 temporary scratch buffer required to decompress the buffer specified by Source
2096 and SourceSize. If the size of the uncompressed buffer or the size of the
2097 scratch buffer cannot be determined from the compressed data specified by
2098 Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the
2099 size of the uncompressed buffer is returned in DestinationSize, the size of
2100 the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned.
2101 The GetInfo() function does not have scratch buffer available to perform a
2102 thorough checking of the validity of the source data. It just retrieves the
2103 "Original Size" field from the beginning bytes of the source data and output
2104 it as DestinationSize. And ScratchSize is specific to the decompression
2107 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
2108 @param Source The source buffer containing the compressed data.
2109 @param SourceSize The size, in bytes, of the source buffer.
2110 @param DestinationSize A pointer to the size, in bytes, of the
2111 uncompressed buffer that will be generated when the
2112 compressed buffer specified by Source and
2113 SourceSize is decompressed.
2114 @param ScratchSize A pointer to the size, in bytes, of the scratch
2115 buffer that is required to decompress the
2116 compressed buffer specified by Source and
2119 @retval EFI_SUCCESS The size of the uncompressed data was returned in
2120 DestinationSize and the size of the scratch buffer
2121 was returned in ScratchSize.
2122 @retval EFI_INVALID_PARAMETER The size of the uncompressed data or the size of
2123 the scratch buffer cannot be determined from the
2124 compressed data specified by Source and
2130 DxeMainUefiDecompressGetInfo (
2131 IN EFI_DECOMPRESS_PROTOCOL
*This
,
2133 IN UINT32 SourceSize
,
2134 OUT UINT32
*DestinationSize
,
2135 OUT UINT32
*ScratchSize
2140 Decompresses a compressed source buffer.
2142 The Decompress() function extracts decompressed data to its original form.
2143 This protocol is designed so that the decompression algorithm can be
2144 implemented without using any memory services. As a result, the Decompress()
2145 Function is not allowed to call AllocatePool() or AllocatePages() in its
2146 implementation. It is the caller's responsibility to allocate and free the
2147 Destination and Scratch buffers.
2148 If the compressed source data specified by Source and SourceSize is
2149 sucessfully decompressed into Destination, then EFI_SUCCESS is returned. If
2150 the compressed source data specified by Source and SourceSize is not in a
2151 valid compressed data format, then EFI_INVALID_PARAMETER is returned.
2153 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
2154 @param Source The source buffer containing the compressed data.
2155 @param SourceSize SourceSizeThe size of source data.
2156 @param Destination On output, the destination buffer that contains
2157 the uncompressed data.
2158 @param DestinationSize The size of the destination buffer. The size of
2159 the destination buffer needed is obtained from
2160 EFI_DECOMPRESS_PROTOCOL.GetInfo().
2161 @param Scratch A temporary scratch buffer that is used to perform
2163 @param ScratchSize The size of scratch buffer. The size of the
2164 scratch buffer needed is obtained from GetInfo().
2166 @retval EFI_SUCCESS Decompression completed successfully, and the
2167 uncompressed buffer is returned in Destination.
2168 @retval EFI_INVALID_PARAMETER The source buffer specified by Source and
2169 SourceSize is corrupted (not in a valid
2175 DxeMainUefiDecompress (
2176 IN EFI_DECOMPRESS_PROTOCOL
*This
,
2178 IN UINT32 SourceSize
,
2179 IN OUT VOID
*Destination
,
2180 IN UINT32 DestinationSize
,
2181 IN OUT VOID
*Scratch
,
2182 IN UINT32 ScratchSize
2186 SEP member function. This function creates and returns a new section stream
2187 handle to represent the new section stream.
2189 @param SectionStreamLength Size in bytes of the section stream.
2190 @param SectionStream Buffer containing the new section stream.
2191 @param SectionStreamHandle A pointer to a caller allocated UINTN that on
2192 output contains the new section stream handle.
2194 @retval EFI_SUCCESS The section stream is created successfully.
2195 @retval EFI_OUT_OF_RESOURCES memory allocation failed.
2196 @retval EFI_INVALID_PARAMETER Section stream does not end concident with end
2203 IN UINTN SectionStreamLength
,
2204 IN VOID
*SectionStream
,
2205 OUT UINTN
*SectionStreamHandle
2211 SEP member function. Retrieves requested section from section stream.
2213 @param SectionStreamHandle The section stream from which to extract the
2215 @param SectionType A pointer to the type of section to search for.
2216 @param SectionDefinitionGuid If the section type is EFI_SECTION_GUID_DEFINED,
2217 then SectionDefinitionGuid indicates which of
2218 these types of sections to search for.
2219 @param SectionInstance Indicates which instance of the requested
2221 @param Buffer Double indirection to buffer. If *Buffer is
2222 non-null on input, then the buffer is caller
2223 allocated. If Buffer is NULL, then the buffer
2224 is callee allocated. In either case, the
2225 requried buffer size is returned in *BufferSize.
2226 @param BufferSize On input, indicates the size of *Buffer if
2227 *Buffer is non-null on input. On output,
2228 indicates the required size (allocated size if
2229 callee allocated) of *Buffer.
2230 @param AuthenticationStatus A pointer to a caller-allocated UINT32 that
2231 indicates the authentication status of the
2232 output buffer. If the input section's
2233 GuidedSectionHeader.Attributes field
2234 has the EFI_GUIDED_SECTION_AUTH_STATUS_VALID
2235 bit as clear, AuthenticationStatus must return
2236 zero. Both local bits (19:16) and aggregate
2237 bits (3:0) in AuthenticationStatus are returned
2238 by ExtractSection(). These bits reflect the
2239 status of the extraction operation. The bit
2240 pattern in both regions must be the same, as
2241 the local and aggregate authentication statuses
2242 have equivalent meaning at this level. If the
2243 function returns anything other than
2244 EFI_SUCCESS, the value of *AuthenticationStatus
2247 @retval EFI_SUCCESS Section was retrieved successfully
2248 @retval EFI_PROTOCOL_ERROR A GUID defined section was encountered in the
2249 section stream with its
2250 EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,
2251 but there was no corresponding GUIDed Section
2252 Extraction Protocol in the handle database.
2253 *Buffer is unmodified.
2254 @retval EFI_NOT_FOUND An error was encountered when parsing the
2255 SectionStream. This indicates the SectionStream
2256 is not correctly formatted.
2257 @retval EFI_NOT_FOUND The requested section does not exist.
2258 @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
2260 @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
2261 @retval EFI_WARN_TOO_SMALL The size of the caller allocated input buffer is
2262 insufficient to contain the requested section.
2263 The input buffer is filled and section contents
2270 IN UINTN SectionStreamHandle
,
2271 IN EFI_SECTION_TYPE
*SectionType
,
2272 IN EFI_GUID
*SectionDefinitionGuid
,
2273 IN UINTN SectionInstance
,
2275 IN OUT UINTN
*BufferSize
,
2276 OUT UINT32
*AuthenticationStatus
2281 SEP member function. Deletes an existing section stream
2283 @param StreamHandleToClose Indicates the stream to close
2285 @retval EFI_SUCCESS The section stream is closed sucessfully.
2286 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
2287 @retval EFI_INVALID_PARAMETER Section stream does not end concident with end
2293 CloseSectionStream (
2294 IN UINTN StreamHandleToClose
2298 Creates and initializes the DebugImageInfo Table. Also creates the configuration
2299 table and registers it into the system table.
2302 This function allocates memory, frees it, and then allocates memory at an
2303 address within the initial allocation. Since this function is called early
2304 in DXE core initialization (before drivers are dispatched), this should not
2309 CoreInitializeDebugImageInfoTable (
2315 Update the CRC32 in the Debug Table.
2316 Since the CRC32 service is made available by the Runtime driver, we have to
2317 wait for the Runtime Driver to be installed before the CRC32 can be computed.
2318 This function is called elsewhere by the core when the runtime architectural
2319 protocol is produced.
2323 CoreUpdateDebugTableCrc32 (
2329 Adds a new DebugImageInfo structure to the DebugImageInfo Table. Re-Allocates
2330 the table if it's not large enough to accomidate another entry.
2332 @param ImageInfoType type of debug image information
2333 @param LoadedImage pointer to the loaded image protocol for the image being
2335 @param ImageHandle image handle for the image being loaded
2339 CoreNewDebugImageInfoEntry (
2340 IN UINT32 ImageInfoType
,
2341 IN EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
,
2342 IN EFI_HANDLE ImageHandle
2347 Removes and frees an entry from the DebugImageInfo Table.
2349 @param ImageHandle image handle for the image being unloaded
2353 CoreRemoveDebugImageInfoEntry (
2354 EFI_HANDLE ImageHandle
2359 This routine consumes FV hobs and produces instances of FW_VOL_BLOCK_PROTOCOL as appropriate.
2361 @param ImageHandle The image handle.
2362 @param SystemTable The system table.
2364 @retval EFI_SUCCESS Successfully initialized firmware volume block
2370 FwVolBlockDriverInit (
2371 IN EFI_HANDLE ImageHandle
,
2372 IN EFI_SYSTEM_TABLE
*SystemTable
2377 This routine produces a firmware volume block protocol on a given
2380 @param BaseAddress base address of the firmware volume image
2381 @param Length length of the firmware volume image
2382 @param ParentHandle handle of parent firmware volume, if this image
2383 came from an FV image file in another firmware
2384 volume (ala capsules)
2385 @param FvProtocol Firmware volume block protocol produced.
2387 @retval EFI_VOLUME_CORRUPTED Volume corrupted.
2388 @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated.
2389 @retval EFI_SUCCESS Successfully produced a FVB protocol on given
2394 ProduceFVBProtocolOnBuffer (
2395 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
2397 IN EFI_HANDLE ParentHandle
,
2398 OUT EFI_HANDLE
*FvProtocol OPTIONAL
2403 Raising to the task priority level of the mutual exclusion
2404 lock, and then acquires ownership of the lock.
2406 @param Lock The lock to acquire
2418 Initialize a basic mutual exclusion lock. Each lock
2419 provides mutual exclusion access at it's task priority
2420 level. Since there is no-premption (at any TPL) or
2421 multiprocessor support, acquiring the lock only consists
2422 of raising to the locks TPL.
2424 @param Lock The EFI_LOCK structure to initialize
2426 @retval EFI_SUCCESS Lock Owned.
2427 @retval EFI_ACCESS_DENIED Reentrant Lock Acquisition, Lock not Owned.
2431 CoreAcquireLockOrFail (
2437 Releases ownership of the mutual exclusion lock, and
2438 restores the previous task priority level.
2440 @param Lock The lock to release
2442 @return Lock unowned