4 Step #1 - When a FV protocol is added to the system every driver in the FV
5 is added to the mDiscoveredList. The SOR, Before, and After Depex are
6 pre-processed as drivers are added to the mDiscoveredList. If an Apriori
7 file exists in the FV those drivers are addeded to the
8 mScheduledQueue. The mFvHandleList is used to make sure a
9 FV is only processed once.
11 Step #2 - Dispatch. Remove driver from the mScheduledQueue and load and
12 start it. After mScheduledQueue is drained check the
13 mDiscoveredList to see if any item has a Depex that is ready to
14 be placed on the mScheduledQueue.
16 Step #3 - Adding to the mScheduledQueue requires that you process Before
17 and After dependencies. This is done recursively as the call to add
18 to the mScheduledQueue checks for Before and recursively adds
19 all Befores. It then addes the item that was passed in and then
20 processess the After dependecies by recursively calling the routine.
23 The rules for the dispatcher are in chapter 10 of the DXE CIS. Figure 10-3
24 is the state diagram for the DXE dispatcher
26 Depex - Dependency Expresion.
27 SOR - Schedule On Request - Don't schedule if this bit is set.
29 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
30 This program and the accompanying materials
31 are licensed and made available under the terms and conditions of the BSD License
32 which accompanies this distribution. The full text of the license may be found at
33 http://opensource.org/licenses/bsd-license.php
35 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
36 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
43 // The Driver List contains one copy of every driver that has been discovered.
44 // Items are never removed from the driver list. List of EFI_CORE_DRIVER_ENTRY
46 LIST_ENTRY mDiscoveredList
= INITIALIZE_LIST_HEAD_VARIABLE (mDiscoveredList
);
49 // Queue of drivers that are ready to dispatch. This queue is a subset of the
50 // mDiscoveredList.list of EFI_CORE_DRIVER_ENTRY.
52 LIST_ENTRY mScheduledQueue
= INITIALIZE_LIST_HEAD_VARIABLE (mScheduledQueue
);
55 // List of handles who's Fv's have been parsed and added to the mFwDriverList.
57 LIST_ENTRY mFvHandleList
= INITIALIZE_LIST_HEAD_VARIABLE (mFvHandleList
); // list of KNOWN_HANDLE
60 // Lock for mDiscoveredList, mScheduledQueue, gDispatcherRunning.
62 EFI_LOCK mDispatcherLock
= EFI_INITIALIZE_LOCK_VARIABLE (TPL_HIGH_LEVEL
);
66 // Flag for the DXE Dispacher. TRUE if dispatcher is execuing.
68 BOOLEAN gDispatcherRunning
= FALSE
;
71 // Module globals to manage the FwVol registration notification event
73 EFI_EVENT mFwVolEvent
;
74 VOID
*mFwVolEventRegistration
;
77 // List of file types supported by dispatcher
79 EFI_FV_FILETYPE mDxeFileTypes
[] = {
80 EFI_FV_FILETYPE_DRIVER
,
81 EFI_FV_FILETYPE_COMBINED_SMM_DXE
,
82 EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER
,
83 EFI_FV_FILETYPE_DXE_CORE
,
84 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
88 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH File
;
89 EFI_DEVICE_PATH_PROTOCOL End
;
90 } FV_FILEPATH_DEVICE_PATH
;
92 FV_FILEPATH_DEVICE_PATH mFvDevicePath
;
95 // Function Prototypes
98 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you
99 must add any driver with a before dependency on InsertedDriverEntry first.
100 You do this by recursively calling this routine. After all the Befores are
101 processed you can add InsertedDriverEntry to the mScheduledQueue.
102 Then you can add any driver with an After dependency on InsertedDriverEntry
103 by recursively calling this routine.
105 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue
109 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (
110 IN EFI_CORE_DRIVER_ENTRY
*InsertedDriverEntry
114 Event notification that is fired every time a FV dispatch protocol is added.
115 More than one protocol may have been added when this event is fired, so you
116 must loop on CoreLocateHandle () to see how many protocols were added and
117 do the following to each FV:
118 If the Fv has already been processed, skip it. If the Fv has not been
119 processed then mark it as being processed, as we are about to process it.
120 Read the Fv and add any driver in the Fv to the mDiscoveredList.The
121 mDiscoveredList is never free'ed and contains variables that define
122 the other states the DXE driver transitions to..
123 While you are at it read the A Priori file into memory.
124 Place drivers in the A Priori list onto the mScheduledQueue.
126 @param Event The Event that is being processed, not used.
127 @param Context Event Context, not used.
132 CoreFwVolEventProtocolNotify (
138 Convert FvHandle and DriverName into an EFI device path
140 @param Fv Fv protocol, needed to read Depex info out of
142 @param FvHandle Handle for Fv, needed in the
143 EFI_CORE_DRIVER_ENTRY so that the PE image can be
144 read out of the FV at a later time.
145 @param DriverName Name of driver to add to mDiscoveredList.
147 @return Pointer to device path constructed from FvHandle and DriverName
150 EFI_DEVICE_PATH_PROTOCOL
*
152 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
153 IN EFI_HANDLE FvHandle
,
154 IN EFI_GUID
*DriverName
158 Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,
159 and initilize any state variables. Read the Depex from the FV and store it
160 in DriverEntry. Pre-process the Depex to set the SOR, Before and After state.
161 The Discovered list is never free'ed and contains booleans that represent the
162 other possible DXE driver states.
164 @param Fv Fv protocol, needed to read Depex info out of
166 @param FvHandle Handle for Fv, needed in the
167 EFI_CORE_DRIVER_ENTRY so that the PE image can be
168 read out of the FV at a later time.
169 @param DriverName Name of driver to add to mDiscoveredList.
170 @param Type Fv File Type of file to add to mDiscoveredList.
172 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.
173 @retval EFI_ALREADY_STARTED The driver has already been started. Only one
174 DriverName may be active in the system at any one
179 CoreAddToDriverList (
180 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
181 IN EFI_HANDLE FvHandle
,
182 IN EFI_GUID
*DriverName
,
183 IN EFI_FV_FILETYPE Type
187 Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.
189 @param Fv The FIRMWARE_VOLUME protocol installed on the FV.
190 @param FvHandle The handle which FVB protocol installed on.
191 @param DriverName The driver guid specified.
193 @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.
194 @retval EFI_VOLUME_CORRUPTED Corrupted volume.
195 @retval EFI_SUCCESS Function successfully returned.
199 CoreProcessFvImageFile (
200 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
201 IN EFI_HANDLE FvHandle
,
202 IN EFI_GUID
*DriverName
207 Enter critical section by gaining lock on mDispatcherLock.
211 CoreAcquireDispatcherLock (
215 CoreAcquireLock (&mDispatcherLock
);
220 Exit critical section by releasing lock on mDispatcherLock.
224 CoreReleaseDispatcherLock (
228 CoreReleaseLock (&mDispatcherLock
);
233 Read Depex and pre-process the Depex for Before and After. If Section Extraction
234 protocol returns an error via ReadSection defer the reading of the Depex.
236 @param DriverEntry Driver to work on.
238 @retval EFI_SUCCESS Depex read and preprossesed
239 @retval EFI_PROTOCOL_ERROR The section extraction protocol returned an error
240 and Depex reading needs to be retried.
241 @retval Error DEPEX not found.
245 CoreGetDepexSectionAndPreProccess (
246 IN EFI_CORE_DRIVER_ENTRY
*DriverEntry
250 EFI_SECTION_TYPE SectionType
;
251 UINT32 AuthenticationStatus
;
252 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
255 Fv
= DriverEntry
->Fv
;
258 // Grab Depex info, it will never be free'ed.
260 SectionType
= EFI_SECTION_DXE_DEPEX
;
261 Status
= Fv
->ReadSection (
263 &DriverEntry
->FileName
,
267 (UINTN
*)&DriverEntry
->DepexSize
,
268 &AuthenticationStatus
270 if (EFI_ERROR (Status
)) {
271 if (Status
== EFI_PROTOCOL_ERROR
) {
273 // The section extraction protocol failed so set protocol error flag
275 DriverEntry
->DepexProtocolError
= TRUE
;
278 // If no Depex assume UEFI 2.0 driver model
280 DriverEntry
->Depex
= NULL
;
281 DriverEntry
->Dependent
= TRUE
;
282 DriverEntry
->DepexProtocolError
= FALSE
;
286 // Set Before, After, and Unrequested state information based on Depex
287 // Driver will be put in Dependent or Unrequested state
289 CorePreProcessDepex (DriverEntry
);
290 DriverEntry
->DepexProtocolError
= FALSE
;
298 Check every driver and locate a matching one. If the driver is found, the Unrequested
299 state flag is cleared.
301 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
302 the firmware file specified by DriverName.
303 @param DriverName The Driver name to put in the Dependent state.
305 @retval EFI_SUCCESS The DriverName was found and it's SOR bit was
307 @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was
314 IN EFI_HANDLE FirmwareVolumeHandle
,
315 IN EFI_GUID
*DriverName
319 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
322 // Check every driver
324 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
325 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
326 if (DriverEntry
->FvHandle
== FirmwareVolumeHandle
&&
327 DriverEntry
->Unrequested
&&
328 CompareGuid (DriverName
, &DriverEntry
->FileName
)) {
330 // Move the driver from the Unrequested to the Dependent state
332 CoreAcquireDispatcherLock ();
333 DriverEntry
->Unrequested
= FALSE
;
334 DriverEntry
->Dependent
= TRUE
;
335 CoreReleaseDispatcherLock ();
337 DEBUG ((DEBUG_DISPATCH
, "Schedule FFS(%g) - EFI_SUCCESS\n", DriverName
));
343 DEBUG ((DEBUG_DISPATCH
, "Schedule FFS(%g) - EFI_NOT_FOUND\n", DriverName
));
345 return EFI_NOT_FOUND
;
351 Convert a driver from the Untrused back to the Scheduled state.
353 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
354 the firmware file specified by DriverName.
355 @param DriverName The Driver name to put in the Scheduled state
357 @retval EFI_SUCCESS The file was found in the untrusted state, and it
358 was promoted to the trusted state.
359 @retval EFI_NOT_FOUND The file was not found in the untrusted state.
365 IN EFI_HANDLE FirmwareVolumeHandle
,
366 IN EFI_GUID
*DriverName
370 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
373 // Check every driver
375 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
376 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
377 if (DriverEntry
->FvHandle
== FirmwareVolumeHandle
&&
378 DriverEntry
->Untrusted
&&
379 CompareGuid (DriverName
, &DriverEntry
->FileName
)) {
381 // Transition driver from Untrusted to Scheduled state.
383 CoreAcquireDispatcherLock ();
384 DriverEntry
->Untrusted
= FALSE
;
385 DriverEntry
->Scheduled
= TRUE
;
386 InsertTailList (&mScheduledQueue
, &DriverEntry
->ScheduledLink
);
387 CoreReleaseDispatcherLock ();
392 return EFI_NOT_FOUND
;
396 This is the main Dispatcher for DXE and it exits when there are no more
397 drivers to run. Drain the mScheduledQueue and load and start a PE
398 image for each driver. Search the mDiscoveredList to see if any driver can
399 be placed on the mScheduledQueue. If no drivers are placed on the
400 mScheduledQueue exit the function. On exit it is assumed the Bds()
401 will be called, and when the Bds() exits the Dispatcher will be called
404 @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running
405 @retval EFI_NOT_FOUND No DXE Drivers were dispatched
406 @retval EFI_SUCCESS One or more DXE Drivers were dispatched
416 EFI_STATUS ReturnStatus
;
418 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
420 EFI_EVENT DxeDispatchEvent
;
422 PERF_FUNCTION_BEGIN ();
424 if (gDispatcherRunning
) {
426 // If the dispatcher is running don't let it be restarted.
428 return EFI_ALREADY_STARTED
;
431 gDispatcherRunning
= TRUE
;
433 Status
= CoreCreateEventEx (
436 EfiEventEmptyFunction
,
438 &gEfiEventDxeDispatchGuid
,
441 if (EFI_ERROR (Status
)) {
445 ReturnStatus
= EFI_NOT_FOUND
;
448 // Drain the Scheduled Queue
450 while (!IsListEmpty (&mScheduledQueue
)) {
452 mScheduledQueue
.ForwardLink
,
453 EFI_CORE_DRIVER_ENTRY
,
455 EFI_CORE_DRIVER_ENTRY_SIGNATURE
459 // Load the DXE Driver image into memory. If the Driver was transitioned from
460 // Untrused to Scheduled it would have already been loaded so we may need to
461 // skip the LoadImage
463 if (DriverEntry
->ImageHandle
== NULL
&& !DriverEntry
->IsFvImage
) {
464 DEBUG ((DEBUG_INFO
, "Loading driver %g\n", &DriverEntry
->FileName
));
465 Status
= CoreLoadImage (
468 DriverEntry
->FvFileDevicePath
,
471 &DriverEntry
->ImageHandle
475 // Update the driver state to reflect that it's been loaded
477 if (EFI_ERROR (Status
)) {
478 CoreAcquireDispatcherLock ();
480 if (Status
== EFI_SECURITY_VIOLATION
) {
482 // Take driver from Scheduled to Untrused state
484 DriverEntry
->Untrusted
= TRUE
;
487 // The DXE Driver could not be loaded, and do not attempt to load or start it again.
488 // Take driver from Scheduled to Initialized.
490 // This case include the Never Trusted state if EFI_ACCESS_DENIED is returned
492 DriverEntry
->Initialized
= TRUE
;
495 DriverEntry
->Scheduled
= FALSE
;
496 RemoveEntryList (&DriverEntry
->ScheduledLink
);
498 CoreReleaseDispatcherLock ();
501 // If it's an error don't try the StartImage
507 CoreAcquireDispatcherLock ();
509 DriverEntry
->Scheduled
= FALSE
;
510 DriverEntry
->Initialized
= TRUE
;
511 RemoveEntryList (&DriverEntry
->ScheduledLink
);
513 CoreReleaseDispatcherLock ();
516 if (DriverEntry
->IsFvImage
) {
518 // Produce a firmware volume block protocol for FvImage so it gets dispatched from.
520 Status
= CoreProcessFvImageFile (DriverEntry
->Fv
, DriverEntry
->FvHandle
, &DriverEntry
->FileName
);
522 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
524 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_PC_INIT_BEGIN
),
525 &DriverEntry
->ImageHandle
,
526 sizeof (DriverEntry
->ImageHandle
)
528 ASSERT (DriverEntry
->ImageHandle
!= NULL
);
530 Status
= CoreStartImage (DriverEntry
->ImageHandle
, NULL
, NULL
);
532 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
534 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_PC_INIT_END
),
535 &DriverEntry
->ImageHandle
,
536 sizeof (DriverEntry
->ImageHandle
)
540 ReturnStatus
= EFI_SUCCESS
;
544 // Now DXE Dispatcher finished one round of dispatch, signal an event group
545 // so that SMM Dispatcher get chance to dispatch SMM Drivers which depend
548 if (!EFI_ERROR (ReturnStatus
)) {
549 CoreSignalEvent (DxeDispatchEvent
);
553 // Search DriverList for items to place on Scheduled Queue
556 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
557 DriverEntry
= CR (Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
559 if (DriverEntry
->DepexProtocolError
){
561 // If Section Extraction Protocol did not let the Depex be read before retry the read
563 Status
= CoreGetDepexSectionAndPreProccess (DriverEntry
);
566 if (DriverEntry
->Dependent
) {
567 if (CoreIsSchedulable (DriverEntry
)) {
568 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
572 if (DriverEntry
->Unrequested
) {
573 DEBUG ((DEBUG_DISPATCH
, "Evaluate DXE DEPEX for FFS(%g)\n", &DriverEntry
->FileName
));
574 DEBUG ((DEBUG_DISPATCH
, " SOR = Not Requested\n"));
575 DEBUG ((DEBUG_DISPATCH
, " RESULT = FALSE\n"));
579 } while (ReadyToRun
);
582 // Close DXE dispatch Event
584 CoreCloseEvent (DxeDispatchEvent
);
586 gDispatcherRunning
= FALSE
;
588 PERF_FUNCTION_END ();
595 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you
596 must add any driver with a before dependency on InsertedDriverEntry first.
597 You do this by recursively calling this routine. After all the Befores are
598 processed you can add InsertedDriverEntry to the mScheduledQueue.
599 Then you can add any driver with an After dependency on InsertedDriverEntry
600 by recursively calling this routine.
602 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue
606 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (
607 IN EFI_CORE_DRIVER_ENTRY
*InsertedDriverEntry
611 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
614 // Process Before Dependency
616 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
617 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
618 if (DriverEntry
->Before
&& DriverEntry
->Dependent
&& DriverEntry
!= InsertedDriverEntry
) {
619 DEBUG ((DEBUG_DISPATCH
, "Evaluate DXE DEPEX for FFS(%g)\n", &DriverEntry
->FileName
));
620 DEBUG ((DEBUG_DISPATCH
, " BEFORE FFS(%g) = ", &DriverEntry
->BeforeAfterGuid
));
621 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
623 // Recursively process BEFORE
625 DEBUG ((DEBUG_DISPATCH
, "TRUE\n END\n RESULT = TRUE\n"));
626 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
628 DEBUG ((DEBUG_DISPATCH
, "FALSE\n END\n RESULT = FALSE\n"));
634 // Convert driver from Dependent to Scheduled state
636 CoreAcquireDispatcherLock ();
638 InsertedDriverEntry
->Dependent
= FALSE
;
639 InsertedDriverEntry
->Scheduled
= TRUE
;
640 InsertTailList (&mScheduledQueue
, &InsertedDriverEntry
->ScheduledLink
);
642 CoreReleaseDispatcherLock ();
645 // Process After Dependency
647 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
648 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
649 if (DriverEntry
->After
&& DriverEntry
->Dependent
&& DriverEntry
!= InsertedDriverEntry
) {
650 DEBUG ((DEBUG_DISPATCH
, "Evaluate DXE DEPEX for FFS(%g)\n", &DriverEntry
->FileName
));
651 DEBUG ((DEBUG_DISPATCH
, " AFTER FFS(%g) = ", &DriverEntry
->BeforeAfterGuid
));
652 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
654 // Recursively process AFTER
656 DEBUG ((DEBUG_DISPATCH
, "TRUE\n END\n RESULT = TRUE\n"));
657 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
659 DEBUG ((DEBUG_DISPATCH
, "FALSE\n END\n RESULT = FALSE\n"));
667 Return TRUE if the Fv has been processed, FALSE if not.
669 @param FvHandle The handle of a FV that's being tested
671 @retval TRUE Fv protocol on FvHandle has been processed
672 @retval FALSE Fv protocol on FvHandle has not yet been processed
677 IN EFI_HANDLE FvHandle
681 KNOWN_HANDLE
*KnownHandle
;
683 for (Link
= mFvHandleList
.ForwardLink
; Link
!= &mFvHandleList
; Link
= Link
->ForwardLink
) {
684 KnownHandle
= CR(Link
, KNOWN_HANDLE
, Link
, KNOWN_HANDLE_SIGNATURE
);
685 if (KnownHandle
->Handle
== FvHandle
) {
694 Remember that Fv protocol on FvHandle has had it's drivers placed on the
695 mDiscoveredList. This fucntion adds entries on the mFvHandleList if new
696 entry is different from one in mFvHandleList by checking FvImage Guid.
697 Items are never removed/freed from the mFvHandleList.
699 @param FvHandle The handle of a FV that has been processed
701 @return A point to new added FvHandle entry. If FvHandle with the same FvImage guid
702 has been added, NULL will return.
706 FvIsBeingProcesssed (
707 IN EFI_HANDLE FvHandle
712 BOOLEAN FvNameGuidIsFound
;
713 UINT32 ExtHeaderOffset
;
714 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
;
715 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
716 EFI_FV_BLOCK_MAP_ENTRY
*BlockMap
;
721 KNOWN_HANDLE
*KnownHandle
;
726 // Get the FirmwareVolumeBlock protocol on that handle
728 FvNameGuidIsFound
= FALSE
;
729 Status
= CoreHandleProtocol (FvHandle
, &gEfiFirmwareVolumeBlockProtocolGuid
, (VOID
**)&Fvb
);
730 if (!EFI_ERROR (Status
)) {
732 // Get the full FV header based on FVB protocol.
734 ASSERT (Fvb
!= NULL
);
735 Status
= GetFwVolHeader (Fvb
, &FwVolHeader
);
736 if (!EFI_ERROR (Status
)) {
737 ASSERT (FwVolHeader
!= NULL
);
738 if (VerifyFvHeaderChecksum (FwVolHeader
) && FwVolHeader
->ExtHeaderOffset
!= 0) {
739 ExtHeaderOffset
= (UINT32
) FwVolHeader
->ExtHeaderOffset
;
740 BlockMap
= FwVolHeader
->BlockMap
;
744 // Find LbaIndex and LbaOffset for FV extension header based on BlockMap.
746 while ((BlockMap
->NumBlocks
!= 0) || (BlockMap
->Length
!= 0)) {
747 for (Index
= 0; Index
< BlockMap
->NumBlocks
&& ExtHeaderOffset
>= BlockMap
->Length
; Index
++) {
748 ExtHeaderOffset
-= BlockMap
->Length
;
752 // Check whether FvExtHeader is crossing the multi block range.
754 if (Index
< BlockMap
->NumBlocks
) {
755 LbaOffset
= ExtHeaderOffset
;
761 // Read FvNameGuid from FV extension header.
763 Status
= ReadFvbData (Fvb
, &LbaIndex
, &LbaOffset
, sizeof (FvNameGuid
), (UINT8
*) &FvNameGuid
);
764 if (!EFI_ERROR (Status
)) {
765 FvNameGuidIsFound
= TRUE
;
768 CoreFreePool (FwVolHeader
);
772 if (FvNameGuidIsFound
) {
774 // Check whether the FV image with the found FvNameGuid has been processed.
776 for (Link
= mFvHandleList
.ForwardLink
; Link
!= &mFvHandleList
; Link
= Link
->ForwardLink
) {
777 KnownHandle
= CR(Link
, KNOWN_HANDLE
, Link
, KNOWN_HANDLE_SIGNATURE
);
778 if (CompareGuid (&FvNameGuid
, &KnownHandle
->FvNameGuid
)) {
779 DEBUG ((EFI_D_ERROR
, "FvImage on FvHandle %p and %p has the same FvNameGuid %g.\n", FvHandle
, KnownHandle
->Handle
, &FvNameGuid
));
785 KnownHandle
= AllocateZeroPool (sizeof (KNOWN_HANDLE
));
786 ASSERT (KnownHandle
!= NULL
);
788 KnownHandle
->Signature
= KNOWN_HANDLE_SIGNATURE
;
789 KnownHandle
->Handle
= FvHandle
;
790 if (FvNameGuidIsFound
) {
791 CopyGuid (&KnownHandle
->FvNameGuid
, &FvNameGuid
);
793 InsertTailList (&mFvHandleList
, &KnownHandle
->Link
);
801 Convert FvHandle and DriverName into an EFI device path
803 @param Fv Fv protocol, needed to read Depex info out of
805 @param FvHandle Handle for Fv, needed in the
806 EFI_CORE_DRIVER_ENTRY so that the PE image can be
807 read out of the FV at a later time.
808 @param DriverName Name of driver to add to mDiscoveredList.
810 @return Pointer to device path constructed from FvHandle and DriverName
813 EFI_DEVICE_PATH_PROTOCOL
*
815 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
816 IN EFI_HANDLE FvHandle
,
817 IN EFI_GUID
*DriverName
821 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
822 EFI_DEVICE_PATH_PROTOCOL
*FileNameDevicePath
;
825 // Remember the device path of the FV
827 Status
= CoreHandleProtocol (FvHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&FvDevicePath
);
828 if (EFI_ERROR (Status
)) {
829 FileNameDevicePath
= NULL
;
832 // Build a device path to the file in the FV to pass into gBS->LoadImage
834 EfiInitializeFwVolDevicepathNode (&mFvDevicePath
.File
, DriverName
);
835 SetDevicePathEndNode (&mFvDevicePath
.End
);
837 FileNameDevicePath
= AppendDevicePath (
839 (EFI_DEVICE_PATH_PROTOCOL
*)&mFvDevicePath
843 return FileNameDevicePath
;
849 Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,
850 and initilize any state variables. Read the Depex from the FV and store it
851 in DriverEntry. Pre-process the Depex to set the SOR, Before and After state.
852 The Discovered list is never free'ed and contains booleans that represent the
853 other possible DXE driver states.
855 @param Fv Fv protocol, needed to read Depex info out of
857 @param FvHandle Handle for Fv, needed in the
858 EFI_CORE_DRIVER_ENTRY so that the PE image can be
859 read out of the FV at a later time.
860 @param DriverName Name of driver to add to mDiscoveredList.
861 @param Type Fv File Type of file to add to mDiscoveredList.
863 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.
864 @retval EFI_ALREADY_STARTED The driver has already been started. Only one
865 DriverName may be active in the system at any one
870 CoreAddToDriverList (
871 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
872 IN EFI_HANDLE FvHandle
,
873 IN EFI_GUID
*DriverName
,
874 IN EFI_FV_FILETYPE Type
877 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
881 // Create the Driver Entry for the list. ZeroPool initializes lots of variables to
884 DriverEntry
= AllocateZeroPool (sizeof (EFI_CORE_DRIVER_ENTRY
));
885 ASSERT (DriverEntry
!= NULL
);
886 if (Type
== EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
) {
887 DriverEntry
->IsFvImage
= TRUE
;
890 DriverEntry
->Signature
= EFI_CORE_DRIVER_ENTRY_SIGNATURE
;
891 CopyGuid (&DriverEntry
->FileName
, DriverName
);
892 DriverEntry
->FvHandle
= FvHandle
;
893 DriverEntry
->Fv
= Fv
;
894 DriverEntry
->FvFileDevicePath
= CoreFvToDevicePath (Fv
, FvHandle
, DriverName
);
896 CoreGetDepexSectionAndPreProccess (DriverEntry
);
898 CoreAcquireDispatcherLock ();
900 InsertTailList (&mDiscoveredList
, &DriverEntry
->Link
);
902 CoreReleaseDispatcherLock ();
909 Check if a FV Image type file (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) is
910 described by a EFI_HOB_FIRMWARE_VOLUME2 Hob.
912 @param FvNameGuid The FV image guid specified.
913 @param DriverName The driver guid specified.
915 @retval TRUE This file is found in a EFI_HOB_FIRMWARE_VOLUME2
917 @retval FALSE Not found.
922 IN CONST EFI_GUID
*FvNameGuid
,
923 IN CONST EFI_GUID
*DriverName
926 EFI_PEI_HOB_POINTERS HobFv2
;
928 HobFv2
.Raw
= GetHobList ();
930 while ((HobFv2
.Raw
= GetNextHob (EFI_HOB_TYPE_FV2
, HobFv2
.Raw
)) != NULL
) {
932 // Compare parent FvNameGuid and FileGuid both.
934 if (CompareGuid (DriverName
, &HobFv2
.FirmwareVolume2
->FileName
) &&
935 CompareGuid (FvNameGuid
, &HobFv2
.FirmwareVolume2
->FvName
)) {
938 HobFv2
.Raw
= GET_NEXT_HOB (HobFv2
);
945 Find USED_SIZE FV_EXT_TYPE entry in FV extension header and get the FV used size.
947 @param[in] FvHeader Pointer to FV header.
948 @param[out] FvUsedSize Pointer to FV used size returned,
949 only valid if USED_SIZE FV_EXT_TYPE entry is found.
950 @param[out] EraseByte Pointer to erase byte returned,
951 only valid if USED_SIZE FV_EXT_TYPE entry is found.
953 @retval TRUE USED_SIZE FV_EXT_TYPE entry is found,
954 FV used size and erase byte are returned.
955 @retval FALSE No USED_SIZE FV_EXT_TYPE entry found.
960 IN EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
,
961 OUT UINT32
*FvUsedSize
,
965 UINT16 ExtHeaderOffset
;
966 EFI_FIRMWARE_VOLUME_EXT_HEADER
*ExtHeader
;
967 EFI_FIRMWARE_VOLUME_EXT_ENTRY
*ExtEntryList
;
968 EFI_FIRMWARE_VOLUME_EXT_ENTRY_USED_SIZE_TYPE
*ExtEntryUsedSize
;
970 ExtHeaderOffset
= ReadUnaligned16 (&FvHeader
->ExtHeaderOffset
);
971 if (ExtHeaderOffset
!= 0) {
972 ExtHeader
= (EFI_FIRMWARE_VOLUME_EXT_HEADER
*) ((UINT8
*) FvHeader
+ ExtHeaderOffset
);
973 ExtEntryList
= (EFI_FIRMWARE_VOLUME_EXT_ENTRY
*) (ExtHeader
+ 1);
974 while ((UINTN
) ExtEntryList
< ((UINTN
) ExtHeader
+ ReadUnaligned32 (&ExtHeader
->ExtHeaderSize
))) {
975 if (ReadUnaligned16 (&ExtEntryList
->ExtEntryType
) == EFI_FV_EXT_TYPE_USED_SIZE_TYPE
) {
977 // USED_SIZE FV_EXT_TYPE entry is found.
979 ExtEntryUsedSize
= (EFI_FIRMWARE_VOLUME_EXT_ENTRY_USED_SIZE_TYPE
*) ExtEntryList
;
980 *FvUsedSize
= ReadUnaligned32 (&ExtEntryUsedSize
->UsedSize
);
981 if ((ReadUnaligned32 (&FvHeader
->Attributes
) & EFI_FVB2_ERASE_POLARITY
) != 0) {
988 "FV at 0x%x has 0x%x used size, and erase byte is 0x%02x\n",
995 ExtEntryList
= (EFI_FIRMWARE_VOLUME_EXT_ENTRY
*)
996 ((UINT8
*) ExtEntryList
+ ReadUnaligned16 (&ExtEntryList
->ExtEntrySize
));
1001 // No USED_SIZE FV_EXT_TYPE entry found.
1007 Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.
1009 @param Fv The FIRMWARE_VOLUME protocol installed on the FV.
1010 @param FvHandle The handle which FVB protocol installed on.
1011 @param DriverName The driver guid specified.
1013 @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.
1014 @retval EFI_VOLUME_CORRUPTED Corrupted volume.
1015 @retval EFI_SUCCESS Function successfully returned.
1019 CoreProcessFvImageFile (
1020 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
1021 IN EFI_HANDLE FvHandle
,
1022 IN EFI_GUID
*DriverName
1026 EFI_SECTION_TYPE SectionType
;
1027 UINT32 AuthenticationStatus
;
1029 VOID
*AlignedBuffer
;
1031 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
1033 EFI_DEVICE_PATH_PROTOCOL
*FvFileDevicePath
;
1038 // Read the first (and only the first) firmware volume section
1040 SectionType
= EFI_SECTION_FIRMWARE_VOLUME_IMAGE
;
1045 AlignedBuffer
= NULL
;
1046 Status
= Fv
->ReadSection (
1053 &AuthenticationStatus
1055 if (!EFI_ERROR (Status
)) {
1057 // Evaluate the authentication status of the Firmware Volume through
1058 // Security Architectural Protocol
1060 if (gSecurity
!= NULL
) {
1061 FvFileDevicePath
= CoreFvToDevicePath (Fv
, FvHandle
, DriverName
);
1062 Status
= gSecurity
->FileAuthenticationState (
1064 AuthenticationStatus
,
1067 if (FvFileDevicePath
!= NULL
) {
1068 FreePool (FvFileDevicePath
);
1071 if (Status
!= EFI_SUCCESS
) {
1073 // Security check failed. The firmware volume should not be used for any purpose.
1075 if (Buffer
!= NULL
) {
1083 // FvImage should be at its required alignment.
1085 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) Buffer
;
1087 // If EFI_FVB2_WEAK_ALIGNMENT is set in the volume header then the first byte of the volume
1088 // can be aligned on any power-of-two boundary. A weakly aligned volume can not be moved from
1089 // its initial linked location and maintain its alignment.
1091 if ((ReadUnaligned32 (&FvHeader
->Attributes
) & EFI_FVB2_WEAK_ALIGNMENT
) != EFI_FVB2_WEAK_ALIGNMENT
) {
1093 // Get FvHeader alignment
1095 FvAlignment
= 1 << ((ReadUnaligned32 (&FvHeader
->Attributes
) & EFI_FVB2_ALIGNMENT
) >> 16);
1097 // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value.
1099 if (FvAlignment
< 8) {
1105 "%a() FV at 0x%x, FvAlignment required is 0x%x\n",
1112 // Check FvImage alignment.
1114 if ((UINTN
) FvHeader
% FvAlignment
!= 0) {
1116 // Allocate the aligned buffer for the FvImage.
1118 AlignedBuffer
= AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize
), (UINTN
) FvAlignment
);
1119 if (AlignedBuffer
== NULL
) {
1121 return EFI_OUT_OF_RESOURCES
;
1124 // Move FvImage into the aligned buffer and release the original buffer.
1126 if (GetFvUsedSize (FvHeader
, &FvUsedSize
, &EraseByte
)) {
1128 // Copy the used bytes and fill the rest with the erase value.
1130 CopyMem (AlignedBuffer
, FvHeader
, (UINTN
) FvUsedSize
);
1132 (UINT8
*) AlignedBuffer
+ FvUsedSize
,
1133 (UINTN
) (BufferSize
- FvUsedSize
),
1137 CopyMem (AlignedBuffer
, Buffer
, BufferSize
);
1139 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) AlignedBuffer
;
1140 CoreFreePool (Buffer
);
1146 // Produce a FVB protocol for the file
1148 Status
= ProduceFVBProtocolOnBuffer (
1149 (EFI_PHYSICAL_ADDRESS
) (UINTN
) FvHeader
,
1152 AuthenticationStatus
,
1157 if (EFI_ERROR (Status
)) {
1159 // ReadSection or Produce FVB failed, Free data buffer
1161 if (Buffer
!= NULL
) {
1165 if (AlignedBuffer
!= NULL
) {
1166 FreeAlignedPages (AlignedBuffer
, EFI_SIZE_TO_PAGES (BufferSize
));
1175 Event notification that is fired every time a FV dispatch protocol is added.
1176 More than one protocol may have been added when this event is fired, so you
1177 must loop on CoreLocateHandle () to see how many protocols were added and
1178 do the following to each FV:
1179 If the Fv has already been processed, skip it. If the Fv has not been
1180 processed then mark it as being processed, as we are about to process it.
1181 Read the Fv and add any driver in the Fv to the mDiscoveredList.The
1182 mDiscoveredList is never free'ed and contains variables that define
1183 the other states the DXE driver transitions to..
1184 While you are at it read the A Priori file into memory.
1185 Place drivers in the A Priori list onto the mScheduledQueue.
1187 @param Event The Event that is being processed, not used.
1188 @param Context Event Context, not used.
1193 CoreFwVolEventProtocolNotify (
1199 EFI_STATUS GetNextFileStatus
;
1200 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
1201 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
1202 EFI_HANDLE FvHandle
;
1206 EFI_FV_FILETYPE Type
;
1207 EFI_FV_FILE_ATTRIBUTES Attributes
;
1209 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
1210 EFI_GUID
*AprioriFile
;
1211 UINTN AprioriEntryCount
;
1214 UINT32 AuthenticationStatus
;
1217 KNOWN_HANDLE
*KnownHandle
;
1222 BufferSize
= sizeof (EFI_HANDLE
);
1223 Status
= CoreLocateHandle (
1226 mFwVolEventRegistration
,
1230 if (EFI_ERROR (Status
)) {
1232 // If no more notification events exit
1237 if (FvHasBeenProcessed (FvHandle
)) {
1239 // This Fv has already been processed so lets skip it!
1245 // Since we are about to process this Fv mark it as processed.
1247 KnownHandle
= FvIsBeingProcesssed (FvHandle
);
1248 if (KnownHandle
== NULL
) {
1250 // The FV with the same FV name guid has already been processed.
1256 Status
= CoreHandleProtocol (FvHandle
, &gEfiFirmwareVolume2ProtocolGuid
, (VOID
**)&Fv
);
1257 if (EFI_ERROR (Status
) || Fv
== NULL
) {
1259 // FvHandle must have Firmware Volume2 protocol thus we should never get here.
1265 Status
= CoreHandleProtocol (FvHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&FvDevicePath
);
1266 if (EFI_ERROR (Status
)) {
1268 // The Firmware volume doesn't have device path, can't be dispatched.
1274 // Discover Drivers in FV and add them to the Discovered Driver List.
1275 // Process EFI_FV_FILETYPE_DRIVER type and then EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER
1276 // EFI_FV_FILETYPE_DXE_CORE is processed to produce a Loaded Image protocol for the core
1277 // EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE is processed to create a Fvb
1279 for (Index
= 0; Index
< sizeof (mDxeFileTypes
) / sizeof (EFI_FV_FILETYPE
); Index
++) {
1281 // Initialize the search key
1285 Type
= mDxeFileTypes
[Index
];
1286 GetNextFileStatus
= Fv
->GetNextFile (
1294 if (!EFI_ERROR (GetNextFileStatus
)) {
1295 if (Type
== EFI_FV_FILETYPE_DXE_CORE
) {
1297 // If this is the DXE core fill in it's DevicePath & DeviceHandle
1299 if (gDxeCoreLoadedImage
->FilePath
== NULL
) {
1300 if (CompareGuid (&NameGuid
, gDxeCoreFileName
)) {
1302 // Maybe One specail Fv cantains only one DXE_CORE module, so its device path must
1303 // be initialized completely.
1305 EfiInitializeFwVolDevicepathNode (&mFvDevicePath
.File
, &NameGuid
);
1306 SetDevicePathEndNode (&mFvDevicePath
.End
);
1308 gDxeCoreLoadedImage
->FilePath
= DuplicateDevicePath (
1309 (EFI_DEVICE_PATH_PROTOCOL
*)&mFvDevicePath
1311 gDxeCoreLoadedImage
->DeviceHandle
= FvHandle
;
1314 } else if (Type
== EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
) {
1316 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already
1319 if (FvFoundInHobFv2 (&KnownHandle
->FvNameGuid
, &NameGuid
)) {
1324 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has SMM depex section.
1328 Status
= Fv
->ReadSection (
1331 EFI_SECTION_SMM_DEPEX
,
1335 &AuthenticationStatus
1337 if (!EFI_ERROR (Status
)) {
1339 // If SMM depex section is found, this FV image is invalid to be supported.
1340 // ASSERT FALSE to report this FV image.
1342 FreePool (DepexBuffer
);
1347 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has DXE depex section.
1351 Status
= Fv
->ReadSection (
1354 EFI_SECTION_DXE_DEPEX
,
1358 &AuthenticationStatus
1360 if (EFI_ERROR (Status
)) {
1362 // If no depex section, produce a firmware volume block protocol for it so it gets dispatched from.
1364 CoreProcessFvImageFile (Fv
, FvHandle
, &NameGuid
);
1367 // If depex section is found, this FV image will be dispatched until its depex is evaluated to TRUE.
1369 FreePool (DepexBuffer
);
1370 CoreAddToDriverList (Fv
, FvHandle
, &NameGuid
, Type
);
1374 // Transition driver from Undiscovered to Discovered state
1376 CoreAddToDriverList (Fv
, FvHandle
, &NameGuid
, Type
);
1379 } while (!EFI_ERROR (GetNextFileStatus
));
1383 // Read the array of GUIDs from the Apriori file if it is present in the firmware volume
1386 Status
= Fv
->ReadSection (
1391 (VOID
**)&AprioriFile
,
1393 &AuthenticationStatus
1395 if (!EFI_ERROR (Status
)) {
1396 AprioriEntryCount
= SizeOfBuffer
/ sizeof (EFI_GUID
);
1398 AprioriEntryCount
= 0;
1402 // Put drivers on Apriori List on the Scheduled queue. The Discovered List includes
1403 // drivers not in the current FV and these must be skipped since the a priori list
1404 // is only valid for the FV that it resided in.
1407 for (Index
= 0; Index
< AprioriEntryCount
; Index
++) {
1408 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
1409 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
1410 if (CompareGuid (&DriverEntry
->FileName
, &AprioriFile
[Index
]) &&
1411 (FvHandle
== DriverEntry
->FvHandle
)) {
1412 CoreAcquireDispatcherLock ();
1413 DriverEntry
->Dependent
= FALSE
;
1414 DriverEntry
->Scheduled
= TRUE
;
1415 InsertTailList (&mScheduledQueue
, &DriverEntry
->ScheduledLink
);
1416 CoreReleaseDispatcherLock ();
1417 DEBUG ((DEBUG_DISPATCH
, "Evaluate DXE DEPEX for FFS(%g)\n", &DriverEntry
->FileName
));
1418 DEBUG ((DEBUG_DISPATCH
, " RESULT = TRUE (Apriori)\n"));
1425 // Free data allocated by Fv->ReadSection ()
1427 CoreFreePool (AprioriFile
);
1434 Initialize the dispatcher. Initialize the notification function that runs when
1435 an FV2 protocol is added to the system.
1439 CoreInitializeDispatcher (
1443 PERF_FUNCTION_BEGIN ();
1445 mFwVolEvent
= EfiCreateProtocolNotifyEvent (
1446 &gEfiFirmwareVolume2ProtocolGuid
,
1448 CoreFwVolEventProtocolNotify
,
1450 &mFwVolEventRegistration
1453 PERF_FUNCTION_END ();
1457 // Function only used in debug builds
1461 Traverse the discovered list for any drivers that were discovered but not loaded
1462 because the dependency experessions evaluated to false.
1466 CoreDisplayDiscoveredNotDispatched (
1471 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
1473 for (Link
= mDiscoveredList
.ForwardLink
;Link
!=&mDiscoveredList
; Link
= Link
->ForwardLink
) {
1474 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
1475 if (DriverEntry
->Dependent
) {
1476 DEBUG ((DEBUG_LOAD
, "Driver %g was discovered but not loaded!!\n", &DriverEntry
->FileName
));