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 - 2008, Intel Corporation. <BR>
30 All rights reserved. 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_PEIM_DRIVER
,
82 EFI_FV_FILETYPE_DXE_CORE
,
83 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
87 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH File
;
88 EFI_DEVICE_PATH_PROTOCOL End
;
89 } FV_FILEPATH_DEVICE_PATH
;
91 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.
171 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.
172 @retval EFI_ALREADY_STARTED The driver has already been started. Only one
173 DriverName may be active in the system at any one
178 CoreAddToDriverList (
179 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
180 IN EFI_HANDLE FvHandle
,
181 IN EFI_GUID
*DriverName
185 Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.
187 @param Fv The FIRMWARE_VOLUME protocol installed on the FV.
188 @param FvHandle The handle which FVB protocol installed on.
189 @param DriverName The driver guid specified.
191 @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.
192 @retval EFI_VOLUME_CORRUPTED Corrupted volume.
193 @retval EFI_SUCCESS Function successfully returned.
197 CoreProcessFvImageFile (
198 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
199 IN EFI_HANDLE FvHandle
,
200 IN EFI_GUID
*DriverName
205 Enter critical section by gaining lock on mDispatcherLock.
209 CoreAcquireDispatcherLock (
213 CoreAcquireLock (&mDispatcherLock
);
218 Exit critical section by releasing lock on mDispatcherLock.
222 CoreReleaseDispatcherLock (
226 CoreReleaseLock (&mDispatcherLock
);
231 Read Depex and pre-process the Depex for Before and After. If Section Extraction
232 protocol returns an error via ReadSection defer the reading of the Depex.
234 @param DriverEntry Driver to work on.
236 @retval EFI_SUCCESS Depex read and preprossesed
237 @retval EFI_PROTOCOL_ERROR The section extraction protocol returned an error
238 and Depex reading needs to be retried.
239 @retval Error DEPEX not found.
243 CoreGetDepexSectionAndPreProccess (
244 IN EFI_CORE_DRIVER_ENTRY
*DriverEntry
248 EFI_SECTION_TYPE SectionType
;
249 UINT32 AuthenticationStatus
;
250 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
253 Fv
= DriverEntry
->Fv
;
256 // Grab Depex info, it will never be free'ed.
258 SectionType
= EFI_SECTION_DXE_DEPEX
;
259 Status
= Fv
->ReadSection (
261 &DriverEntry
->FileName
,
265 (UINTN
*)&DriverEntry
->DepexSize
,
266 &AuthenticationStatus
268 if (EFI_ERROR (Status
)) {
269 if (Status
== EFI_PROTOCOL_ERROR
) {
271 // The section extraction protocol failed so set protocol error flag
273 DriverEntry
->DepexProtocolError
= TRUE
;
276 // If no Depex assume UEFI 2.0 driver model
278 DriverEntry
->Depex
= NULL
;
279 DriverEntry
->Dependent
= TRUE
;
280 DriverEntry
->DepexProtocolError
= FALSE
;
284 // Set Before, After, and Unrequested state information based on Depex
285 // Driver will be put in Dependent or Unrequested state
287 CorePreProcessDepex (DriverEntry
);
288 DriverEntry
->DepexProtocolError
= FALSE
;
296 Check every driver and locate a matching one. If the driver is found, the Unrequested
297 state flag is cleared.
299 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
300 the firmware file specified by DriverName.
301 @param DriverName The Driver name to put in the Dependent state.
303 @retval EFI_SUCCESS The DriverName was found and it's SOR bit was
305 @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was
312 IN EFI_HANDLE FirmwareVolumeHandle
,
313 IN EFI_GUID
*DriverName
317 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
320 // Check every driver
322 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
323 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
324 if (DriverEntry
->FvHandle
== FirmwareVolumeHandle
&&
325 DriverEntry
->Unrequested
&&
326 CompareGuid (DriverName
, &DriverEntry
->FileName
)) {
328 // Move the driver from the Unrequested to the Dependent state
330 CoreAcquireDispatcherLock ();
331 DriverEntry
->Unrequested
= FALSE
;
332 DriverEntry
->Dependent
= TRUE
;
333 CoreReleaseDispatcherLock ();
338 return EFI_NOT_FOUND
;
344 Convert a driver from the Untrused back to the Scheduled state.
346 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains
347 the firmware file specified by DriverName.
348 @param DriverName The Driver name to put in the Scheduled state
350 @retval EFI_SUCCESS The file was found in the untrusted state, and it
351 was promoted to the trusted state.
352 @retval EFI_NOT_FOUND The file was not found in the untrusted state.
358 IN EFI_HANDLE FirmwareVolumeHandle
,
359 IN EFI_GUID
*DriverName
363 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
366 // Check every driver
368 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
369 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
370 if (DriverEntry
->FvHandle
== FirmwareVolumeHandle
&&
371 DriverEntry
->Untrusted
&&
372 CompareGuid (DriverName
, &DriverEntry
->FileName
)) {
374 // Transition driver from Untrusted to Scheduled state.
376 CoreAcquireDispatcherLock ();
377 DriverEntry
->Untrusted
= FALSE
;
378 DriverEntry
->Scheduled
= TRUE
;
379 InsertTailList (&mScheduledQueue
, &DriverEntry
->ScheduledLink
);
380 CoreReleaseDispatcherLock ();
385 return EFI_NOT_FOUND
;
391 This is the main Dispatcher for DXE and it exits when there are no more
392 drivers to run. Drain the mScheduledQueue and load and start a PE
393 image for each driver. Search the mDiscoveredList to see if any driver can
394 be placed on the mScheduledQueue. If no drivers are placed on the
395 mScheduledQueue exit the function. On exit it is assumed the Bds()
396 will be called, and when the Bds() exits the Dispatcher will be called
399 @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running
400 @retval EFI_NOT_FOUND No DXE Drivers were dispatched
401 @retval EFI_SUCCESS One or more DXE Drivers were dispatched
411 EFI_STATUS ReturnStatus
;
413 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
416 if (gDispatcherRunning
) {
418 // If the dispatcher is running don't let it be restarted.
420 return EFI_ALREADY_STARTED
;
423 gDispatcherRunning
= TRUE
;
426 ReturnStatus
= EFI_NOT_FOUND
;
429 // Drain the Scheduled Queue
431 while (!IsListEmpty (&mScheduledQueue
)) {
433 mScheduledQueue
.ForwardLink
,
434 EFI_CORE_DRIVER_ENTRY
,
436 EFI_CORE_DRIVER_ENTRY_SIGNATURE
440 // Load the DXE Driver image into memory. If the Driver was transitioned from
441 // Untrused to Scheduled it would have already been loaded so we may need to
442 // skip the LoadImage
444 if (DriverEntry
->ImageHandle
== NULL
) {
445 Status
= CoreLoadImage (
448 DriverEntry
->FvFileDevicePath
,
451 &DriverEntry
->ImageHandle
455 // Update the driver state to reflect that it's been loaded
457 if (EFI_ERROR (Status
)) {
458 CoreAcquireDispatcherLock ();
460 if (Status
== EFI_SECURITY_VIOLATION
) {
462 // Take driver from Scheduled to Untrused state
464 DriverEntry
->Untrusted
= TRUE
;
467 // The DXE Driver could not be loaded, and do not attempt to load or start it again.
468 // Take driver from Scheduled to Initialized.
470 // This case include the Never Trusted state if EFI_ACCESS_DENIED is returned
472 DriverEntry
->Initialized
= TRUE
;
475 DriverEntry
->Scheduled
= FALSE
;
476 RemoveEntryList (&DriverEntry
->ScheduledLink
);
478 CoreReleaseDispatcherLock ();
481 // If it's an error don't try the StartImage
487 CoreAcquireDispatcherLock ();
489 DriverEntry
->Scheduled
= FALSE
;
490 DriverEntry
->Initialized
= TRUE
;
491 RemoveEntryList (&DriverEntry
->ScheduledLink
);
493 CoreReleaseDispatcherLock ();
495 CoreReportProgressCodeSpecific (
496 FixedPcdGet32(PcdStatusCodeValueDxeDriverBegin
),
497 DriverEntry
->ImageHandle
499 Status
= CoreStartImage (DriverEntry
->ImageHandle
, NULL
, NULL
);
500 CoreReportProgressCodeSpecific (
501 FixedPcdGet32(PcdStatusCodeValueDxeDriverEnd
),
502 DriverEntry
->ImageHandle
505 ReturnStatus
= EFI_SUCCESS
;
509 // Search DriverList for items to place on Scheduled Queue
512 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
513 DriverEntry
= CR (Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
515 if (DriverEntry
->DepexProtocolError
){
517 // If Section Extraction Protocol did not let the Depex be read before retry the read
519 Status
= CoreGetDepexSectionAndPreProccess (DriverEntry
);
522 if (DriverEntry
->Dependent
) {
523 if (CoreIsSchedulable (DriverEntry
)) {
524 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
529 } while (ReadyToRun
);
531 gDispatcherRunning
= FALSE
;
538 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you
539 must add any driver with a before dependency on InsertedDriverEntry first.
540 You do this by recursively calling this routine. After all the Befores are
541 processed you can add InsertedDriverEntry to the mScheduledQueue.
542 Then you can add any driver with an After dependency on InsertedDriverEntry
543 by recursively calling this routine.
545 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue
549 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (
550 IN EFI_CORE_DRIVER_ENTRY
*InsertedDriverEntry
554 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
557 // Process Before Dependency
559 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
560 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
561 if (DriverEntry
->Before
&& DriverEntry
->Dependent
) {
562 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
564 // Recursively process BEFORE
566 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
572 // Convert driver from Dependent to Scheduled state
574 CoreAcquireDispatcherLock ();
576 InsertedDriverEntry
->Dependent
= FALSE
;
577 InsertedDriverEntry
->Scheduled
= TRUE
;
578 InsertTailList (&mScheduledQueue
, &InsertedDriverEntry
->ScheduledLink
);
580 CoreReleaseDispatcherLock ();
583 // Process After Dependency
585 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
586 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
587 if (DriverEntry
->After
&& DriverEntry
->Dependent
) {
588 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
590 // Recursively process AFTER
592 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
600 Return TRUE if the Fv has been processed, FALSE if not.
602 @param FvHandle The handle of a FV that's being tested
604 @retval TRUE Fv protocol on FvHandle has been processed
605 @retval FALSE Fv protocol on FvHandle has not yet been processed
610 IN EFI_HANDLE FvHandle
614 KNOWN_HANDLE
*KnownHandle
;
616 for (Link
= mFvHandleList
.ForwardLink
; Link
!= &mFvHandleList
; Link
= Link
->ForwardLink
) {
617 KnownHandle
= CR(Link
, KNOWN_HANDLE
, Link
, KNOWN_HANDLE_SIGNATURE
);
618 if (KnownHandle
->Handle
== FvHandle
) {
627 Remember that Fv protocol on FvHandle has had it's drivers placed on the
628 mDiscoveredList. This fucntion adds entries on the mFvHandleList. Items are
629 never removed/freed from the mFvHandleList.
631 @param FvHandle The handle of a FV that has been processed
635 FvIsBeingProcesssed (
636 IN EFI_HANDLE FvHandle
639 KNOWN_HANDLE
*KnownHandle
;
641 KnownHandle
= CoreAllocateBootServicesPool (sizeof (KNOWN_HANDLE
));
642 ASSERT (KnownHandle
!= NULL
);
644 KnownHandle
->Signature
= KNOWN_HANDLE_SIGNATURE
;
645 KnownHandle
->Handle
= FvHandle
;
646 InsertTailList (&mFvHandleList
, &KnownHandle
->Link
);
653 Convert FvHandle and DriverName into an EFI device path
655 @param Fv Fv protocol, needed to read Depex info out of
657 @param FvHandle Handle for Fv, needed in the
658 EFI_CORE_DRIVER_ENTRY so that the PE image can be
659 read out of the FV at a later time.
660 @param DriverName Name of driver to add to mDiscoveredList.
662 @return Pointer to device path constructed from FvHandle and DriverName
665 EFI_DEVICE_PATH_PROTOCOL
*
667 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
668 IN EFI_HANDLE FvHandle
,
669 IN EFI_GUID
*DriverName
673 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
674 EFI_DEVICE_PATH_PROTOCOL
*FileNameDevicePath
;
677 // Remember the device path of the FV
679 Status
= CoreHandleProtocol (FvHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&FvDevicePath
);
680 if (EFI_ERROR (Status
)) {
681 FileNameDevicePath
= NULL
;
684 // Build a device path to the file in the FV to pass into gBS->LoadImage
686 EfiInitializeFwVolDevicepathNode (&mFvDevicePath
.File
, DriverName
);
687 mFvDevicePath
.End
.Type
= EFI_END_ENTIRE_DEVICE_PATH
;
688 mFvDevicePath
.End
.SubType
= END_ENTIRE_DEVICE_PATH_SUBTYPE
;
689 SetDevicePathNodeLength (&mFvDevicePath
.End
, sizeof (EFI_DEVICE_PATH_PROTOCOL
));
691 FileNameDevicePath
= CoreAppendDevicePath (
693 (EFI_DEVICE_PATH_PROTOCOL
*)&mFvDevicePath
697 return FileNameDevicePath
;
703 Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,
704 and initilize any state variables. Read the Depex from the FV and store it
705 in DriverEntry. Pre-process the Depex to set the SOR, Before and After state.
706 The Discovered list is never free'ed and contains booleans that represent the
707 other possible DXE driver states.
709 @param Fv Fv protocol, needed to read Depex info out of
711 @param FvHandle Handle for Fv, needed in the
712 EFI_CORE_DRIVER_ENTRY so that the PE image can be
713 read out of the FV at a later time.
714 @param DriverName Name of driver to add to mDiscoveredList.
716 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.
717 @retval EFI_ALREADY_STARTED The driver has already been started. Only one
718 DriverName may be active in the system at any one
723 CoreAddToDriverList (
724 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
725 IN EFI_HANDLE FvHandle
,
726 IN EFI_GUID
*DriverName
729 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
733 // Create the Driver Entry for the list. ZeroPool initializes lots of variables to
736 DriverEntry
= CoreAllocateZeroBootServicesPool (sizeof (EFI_CORE_DRIVER_ENTRY
));
737 ASSERT (DriverEntry
!= NULL
);
739 DriverEntry
->Signature
= EFI_CORE_DRIVER_ENTRY_SIGNATURE
;
740 CopyGuid (&DriverEntry
->FileName
, DriverName
);
741 DriverEntry
->FvHandle
= FvHandle
;
742 DriverEntry
->Fv
= Fv
;
743 DriverEntry
->FvFileDevicePath
= CoreFvToDevicePath (Fv
, FvHandle
, DriverName
);
745 CoreGetDepexSectionAndPreProccess (DriverEntry
);
747 CoreAcquireDispatcherLock ();
749 InsertTailList (&mDiscoveredList
, &DriverEntry
->Link
);
751 CoreReleaseDispatcherLock ();
758 Check if a FV Image type file (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) is
759 described by a EFI_HOB_FIRMWARE_VOLUME2 Hob.
761 @param FvHandle The handle which FVB protocol installed on.
762 @param DriverName The driver guid specified.
764 @retval TRUE This file is found in a EFI_HOB_FIRMWARE_VOLUME2
766 @retval FALSE Not found.
771 IN EFI_HANDLE FvHandle
,
772 IN CONST EFI_GUID
*DriverName
775 EFI_PEI_HOB_POINTERS HobFv2
;
777 HobFv2
.Raw
= GetHobList ();
779 while ((HobFv2
.Raw
= GetNextHob (EFI_HOB_TYPE_FV2
, HobFv2
.Raw
)) != NULL
) {
780 if (CompareGuid (DriverName
, &HobFv2
.FirmwareVolume2
->FileName
)) {
783 HobFv2
.Raw
= GET_NEXT_HOB (HobFv2
);
792 Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.
794 @param Fv The FIRMWARE_VOLUME protocol installed on the FV.
795 @param FvHandle The handle which FVB protocol installed on.
796 @param DriverName The driver guid specified.
798 @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.
799 @retval EFI_VOLUME_CORRUPTED Corrupted volume.
800 @retval EFI_SUCCESS Function successfully returned.
804 CoreProcessFvImageFile (
805 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
806 IN EFI_HANDLE FvHandle
,
807 IN EFI_GUID
*DriverName
811 EFI_SECTION_TYPE SectionType
;
812 UINT32 AuthenticationStatus
;
816 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
820 // Read the first (and only the first) firmware volume section
822 SectionType
= EFI_SECTION_FIRMWARE_VOLUME_IMAGE
;
827 AlignedBuffer
= NULL
;
828 Status
= Fv
->ReadSection (
835 &AuthenticationStatus
837 if (!EFI_ERROR (Status
)) {
839 // FvImage should be at its required alignment.
841 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) Buffer
;
842 FvAlignment
= 1 << ((FvHeader
->Attributes
& EFI_FVB2_ALIGNMENT
) >> 16);
844 // FvAlignment must be more than 8 bytes required by FvHeader structure.
846 if (FvAlignment
< 8) {
850 // Allocate the aligned buffer for the FvImage.
852 AlignedBuffer
= AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize
), (UINTN
) FvAlignment
);
853 if (AlignedBuffer
== NULL
) {
854 Status
= EFI_OUT_OF_RESOURCES
;
857 // Move FvImage into the aligned buffer and release the original buffer.
859 CopyMem (AlignedBuffer
, Buffer
, BufferSize
);
860 CoreFreePool (Buffer
);
863 // Produce a FVB protocol for the file
865 Status
= ProduceFVBProtocolOnBuffer (
866 (EFI_PHYSICAL_ADDRESS
) (UINTN
) AlignedBuffer
,
874 if (EFI_ERROR (Status
)) {
876 // ReadSection or Produce FVB failed, Free data buffer
878 if (Buffer
!= NULL
) {
879 CoreFreePool (Buffer
);
882 if (AlignedBuffer
!= NULL
) {
883 FreeAlignedPages (AlignedBuffer
, EFI_SIZE_TO_PAGES (BufferSize
));
892 Event notification that is fired every time a FV dispatch protocol is added.
893 More than one protocol may have been added when this event is fired, so you
894 must loop on CoreLocateHandle () to see how many protocols were added and
895 do the following to each FV:
896 If the Fv has already been processed, skip it. If the Fv has not been
897 processed then mark it as being processed, as we are about to process it.
898 Read the Fv and add any driver in the Fv to the mDiscoveredList.The
899 mDiscoveredList is never free'ed and contains variables that define
900 the other states the DXE driver transitions to..
901 While you are at it read the A Priori file into memory.
902 Place drivers in the A Priori list onto the mScheduledQueue.
904 @param Event The Event that is being processed, not used.
905 @param Context Event Context, not used.
910 CoreFwVolEventProtocolNotify (
916 EFI_STATUS GetNextFileStatus
;
917 EFI_STATUS SecurityStatus
;
918 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
919 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
924 EFI_FV_FILETYPE Type
;
925 EFI_FV_FILE_ATTRIBUTES Attributes
;
927 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
928 EFI_GUID
*AprioriFile
;
929 UINTN AprioriEntryCount
;
932 UINT32 AuthenticationStatus
;
937 BufferSize
= sizeof (EFI_HANDLE
);
938 Status
= CoreLocateHandle (
941 mFwVolEventRegistration
,
945 if (EFI_ERROR (Status
)) {
947 // If no more notification events exit
952 if (FvHasBeenProcessed (FvHandle
)) {
954 // This Fv has already been processed so lets skip it!
959 Status
= CoreHandleProtocol (FvHandle
, &gEfiFirmwareVolumeDispatchProtocolGuid
, (VOID
**)&Fv
);
960 if (EFI_ERROR (Status
)) {
962 // If no dispatch protocol then skip, but do not marked as being processed as it
963 // may show up later.
969 // Since we are about to process this Fv mark it as processed.
971 FvIsBeingProcesssed (FvHandle
);
973 Status
= CoreHandleProtocol (FvHandle
, &gEfiFirmwareVolume2ProtocolGuid
, (VOID
**)&Fv
);
974 if (EFI_ERROR (Status
)) {
976 // The Handle has a FirmwareVolumeDispatch protocol and should also contiain
977 // a FirmwareVolume protocol thus we should never get here.
983 Status
= CoreHandleProtocol (FvHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&FvDevicePath
);
984 if (EFI_ERROR (Status
)) {
986 // The Firmware volume doesn't have device path, can't be dispatched.
992 // Evaluate the authentication status of the Firmware Volume through
993 // Security Architectural Protocol
995 if (gSecurity
!= NULL
) {
996 SecurityStatus
= gSecurity
->FileAuthenticationState (
1001 if (SecurityStatus
!= EFI_SUCCESS
) {
1003 // Security check failed. The firmware volume should not be used for any purpose.
1010 // Discover Drivers in FV and add them to the Discovered Driver List.
1011 // Process EFI_FV_FILETYPE_DRIVER type and then EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER
1012 // EFI_FV_FILETYPE_DXE_CORE is processed to produce a Loaded Image protocol for the core
1013 // EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE is processed to create a Fvb
1015 for (Index
= 0; Index
< sizeof (mDxeFileTypes
) / sizeof (EFI_FV_FILETYPE
); Index
++) {
1017 // Initialize the search key
1021 Type
= mDxeFileTypes
[Index
];
1022 GetNextFileStatus
= Fv
->GetNextFile (
1030 if (!EFI_ERROR (GetNextFileStatus
)) {
1031 if (Type
== EFI_FV_FILETYPE_DXE_CORE
) {
1033 // If this is the DXE core fill in it's DevicePath & DeviceHandle
1035 if (gDxeCoreLoadedImage
->FilePath
== NULL
) {
1036 if (CompareGuid (&NameGuid
, gDxeCoreFileName
)) {
1038 // Maybe One specail Fv cantains only one DXE_CORE module, so its device path must
1039 // be initialized completely.
1041 EfiInitializeFwVolDevicepathNode (&mFvDevicePath
.File
, &NameGuid
);
1042 mFvDevicePath
.End
.Type
= EFI_END_ENTIRE_DEVICE_PATH
;
1043 mFvDevicePath
.End
.SubType
= END_ENTIRE_DEVICE_PATH_SUBTYPE
;
1044 SetDevicePathNodeLength (&mFvDevicePath
.End
, sizeof (EFI_DEVICE_PATH_PROTOCOL
));
1046 gDxeCoreLoadedImage
->FilePath
= CoreDuplicateDevicePath (
1047 (EFI_DEVICE_PATH_PROTOCOL
*)&mFvDevicePath
1049 gDxeCoreLoadedImage
->DeviceHandle
= FvHandle
;
1052 } else if (Type
== EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
) {
1054 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already
1057 if (FvFoundInHobFv2 (FvHandle
, &NameGuid
)) {
1061 // Found a firmware volume image. Produce a firmware volume block
1062 // protocol for it so it gets dispatched from. This is usually a
1065 CoreProcessFvImageFile (Fv
, FvHandle
, &NameGuid
);
1068 // Transition driver from Undiscovered to Discovered state
1070 CoreAddToDriverList (Fv
, FvHandle
, &NameGuid
);
1073 } while (!EFI_ERROR (GetNextFileStatus
));
1077 // Read the array of GUIDs from the Apriori file if it is present in the firmware volume
1080 Status
= Fv
->ReadSection (
1085 (VOID
**)&AprioriFile
,
1087 &AuthenticationStatus
1089 if (!EFI_ERROR (Status
)) {
1090 AprioriEntryCount
= SizeOfBuffer
/ sizeof (EFI_GUID
);
1092 AprioriEntryCount
= 0;
1096 // Put drivers on Apriori List on the Scheduled queue. The Discovered List includes
1097 // drivers not in the current FV and these must be skipped since the a priori list
1098 // is only valid for the FV that it resided in.
1100 CoreAcquireDispatcherLock ();
1102 for (Index
= 0; Index
< AprioriEntryCount
; Index
++) {
1103 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
1104 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
1105 if (CompareGuid (&DriverEntry
->FileName
, &AprioriFile
[Index
]) &&
1106 (FvHandle
== DriverEntry
->FvHandle
)) {
1107 DriverEntry
->Dependent
= FALSE
;
1108 DriverEntry
->Scheduled
= TRUE
;
1109 InsertTailList (&mScheduledQueue
, &DriverEntry
->ScheduledLink
);
1115 CoreReleaseDispatcherLock ();
1118 // Free data allocated by Fv->ReadSection ()
1120 CoreFreePool (AprioriFile
);
1127 Initialize the dispatcher. Initialize the notification function that runs when
1128 an FV2 protocol is added to the system.
1132 CoreInitializeDispatcher (
1136 mFwVolEvent
= CoreCreateProtocolNotifyEvent (
1137 &gEfiFirmwareVolume2ProtocolGuid
,
1139 CoreFwVolEventProtocolNotify
,
1141 &mFwVolEventRegistration
,
1147 // Function only used in debug builds
1151 Traverse the discovered list for any drivers that were discovered but not loaded
1152 because the dependency experessions evaluated to false.
1156 CoreDisplayDiscoveredNotDispatched (
1161 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
1163 for (Link
= mDiscoveredList
.ForwardLink
;Link
!=&mDiscoveredList
; Link
= Link
->ForwardLink
) {
1164 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
1165 if (DriverEntry
->Dependent
) {
1166 DEBUG ((DEBUG_LOAD
, "Driver %g was discovered but not loaded!!\n", &DriverEntry
->FileName
));