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 STATIC 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
401 @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running
402 @retval EFI_NOT_FOUND No DXE Drivers were dispatched
403 @retval EFI_SUCCESS One or more DXE Drivers were dispatched
413 EFI_STATUS ReturnStatus
;
415 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
418 if (gDispatcherRunning
) {
420 // If the dispatcher is running don't let it be restarted.
422 return EFI_ALREADY_STARTED
;
425 gDispatcherRunning
= TRUE
;
428 ReturnStatus
= EFI_NOT_FOUND
;
431 // Drain the Scheduled Queue
433 while (!IsListEmpty (&mScheduledQueue
)) {
435 mScheduledQueue
.ForwardLink
,
436 EFI_CORE_DRIVER_ENTRY
,
438 EFI_CORE_DRIVER_ENTRY_SIGNATURE
442 // Load the DXE Driver image into memory. If the Driver was transitioned from
443 // Untrused to Scheduled it would have already been loaded so we may need to
444 // skip the LoadImage
446 if (DriverEntry
->ImageHandle
== NULL
) {
447 Status
= CoreLoadImage (
450 DriverEntry
->FvFileDevicePath
,
453 &DriverEntry
->ImageHandle
457 // Update the driver state to reflect that it's been loaded
459 if (EFI_ERROR (Status
)) {
460 CoreAcquireDispatcherLock ();
462 if (Status
== EFI_SECURITY_VIOLATION
) {
464 // Take driver from Scheduled to Untrused state
466 DriverEntry
->Untrusted
= TRUE
;
469 // The DXE Driver could not be loaded, and do not attempt to load or start it again.
470 // Take driver from Scheduled to Initialized.
472 // This case include the Never Trusted state if EFI_ACCESS_DENIED is returned
474 DriverEntry
->Initialized
= TRUE
;
477 DriverEntry
->Scheduled
= FALSE
;
478 RemoveEntryList (&DriverEntry
->ScheduledLink
);
480 CoreReleaseDispatcherLock ();
483 // If it's an error don't try the StartImage
489 CoreAcquireDispatcherLock ();
491 DriverEntry
->Scheduled
= FALSE
;
492 DriverEntry
->Initialized
= TRUE
;
493 RemoveEntryList (&DriverEntry
->ScheduledLink
);
495 CoreReleaseDispatcherLock ();
497 CoreReportProgressCodeSpecific (
498 FixedPcdGet32(PcdStatusCodeValueDxeDriverBegin
),
499 DriverEntry
->ImageHandle
501 Status
= CoreStartImage (DriverEntry
->ImageHandle
, NULL
, NULL
);
502 CoreReportProgressCodeSpecific (
503 FixedPcdGet32(PcdStatusCodeValueDxeDriverEnd
),
504 DriverEntry
->ImageHandle
507 ReturnStatus
= EFI_SUCCESS
;
511 // Search DriverList for items to place on Scheduled Queue
514 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
515 DriverEntry
= CR (Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
517 if (DriverEntry
->DepexProtocolError
){
519 // If Section Extraction Protocol did not let the Depex be read before retry the read
521 Status
= CoreGetDepexSectionAndPreProccess (DriverEntry
);
524 if (DriverEntry
->Dependent
) {
525 if (CoreIsSchedulable (DriverEntry
)) {
526 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
531 } while (ReadyToRun
);
533 gDispatcherRunning
= FALSE
;
540 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you
541 must add any driver with a before dependency on InsertedDriverEntry first.
542 You do this by recursively calling this routine. After all the Befores are
543 processed you can add InsertedDriverEntry to the mScheduledQueue.
544 Then you can add any driver with an After dependency on InsertedDriverEntry
545 by recursively calling this routine.
547 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue
551 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (
552 IN EFI_CORE_DRIVER_ENTRY
*InsertedDriverEntry
556 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
559 // Process Before Dependency
561 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
562 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
563 if (DriverEntry
->Before
&& DriverEntry
->Dependent
) {
564 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
566 // Recursively process BEFORE
568 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
574 // Convert driver from Dependent to Scheduled state
576 CoreAcquireDispatcherLock ();
578 InsertedDriverEntry
->Dependent
= FALSE
;
579 InsertedDriverEntry
->Scheduled
= TRUE
;
580 InsertTailList (&mScheduledQueue
, &InsertedDriverEntry
->ScheduledLink
);
582 CoreReleaseDispatcherLock ();
585 // Process After Dependency
587 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
588 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
589 if (DriverEntry
->After
&& DriverEntry
->Dependent
) {
590 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
592 // Recursively process AFTER
594 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
602 Return TRUE if the Fv has been processed, FALSE if not.
604 @param FvHandle The handle of a FV that's being tested
606 @retval TRUE Fv protocol on FvHandle has been processed
607 @retval FALSE Fv protocol on FvHandle has not yet been
613 IN EFI_HANDLE FvHandle
617 KNOWN_HANDLE
*KnownHandle
;
619 for (Link
= mFvHandleList
.ForwardLink
; Link
!= &mFvHandleList
; Link
= Link
->ForwardLink
) {
620 KnownHandle
= CR(Link
, KNOWN_HANDLE
, Link
, KNOWN_HANDLE_SIGNATURE
);
621 if (KnownHandle
->Handle
== FvHandle
) {
630 Remember that Fv protocol on FvHandle has had it's drivers placed on the
631 mDiscoveredList. This fucntion adds entries on the mFvHandleList. Items are
632 never removed/freed from the mFvHandleList.
634 @param FvHandle The handle of a FV that has been processed
638 FvIsBeingProcesssed (
639 IN EFI_HANDLE FvHandle
642 KNOWN_HANDLE
*KnownHandle
;
644 KnownHandle
= CoreAllocateBootServicesPool (sizeof (KNOWN_HANDLE
));
645 ASSERT (KnownHandle
!= NULL
);
647 KnownHandle
->Signature
= KNOWN_HANDLE_SIGNATURE
;
648 KnownHandle
->Handle
= FvHandle
;
649 InsertTailList (&mFvHandleList
, &KnownHandle
->Link
);
656 Convert FvHandle and DriverName into an EFI device path
658 @param Fv Fv protocol, needed to read Depex info out of
660 @param FvHandle Handle for Fv, needed in the
661 EFI_CORE_DRIVER_ENTRY so that the PE image can be
662 read out of the FV at a later time.
663 @param DriverName Name of driver to add to mDiscoveredList.
665 @return Pointer to device path constructed from FvHandle and DriverName
668 EFI_DEVICE_PATH_PROTOCOL
*
670 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
671 IN EFI_HANDLE FvHandle
,
672 IN EFI_GUID
*DriverName
676 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
677 EFI_DEVICE_PATH_PROTOCOL
*FileNameDevicePath
;
680 // Remember the device path of the FV
682 Status
= CoreHandleProtocol (FvHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&FvDevicePath
);
683 if (EFI_ERROR (Status
)) {
684 FileNameDevicePath
= NULL
;
687 // Build a device path to the file in the FV to pass into gBS->LoadImage
689 EfiInitializeFwVolDevicepathNode (&mFvDevicePath
.File
, DriverName
);
690 mFvDevicePath
.End
.Type
= EFI_END_ENTIRE_DEVICE_PATH
;
691 mFvDevicePath
.End
.SubType
= END_ENTIRE_DEVICE_PATH_SUBTYPE
;
692 SetDevicePathNodeLength (&mFvDevicePath
.End
, sizeof (EFI_DEVICE_PATH_PROTOCOL
));
694 FileNameDevicePath
= CoreAppendDevicePath (
696 (EFI_DEVICE_PATH_PROTOCOL
*)&mFvDevicePath
700 return FileNameDevicePath
;
707 Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,
708 and initilize any state variables. Read the Depex from the FV and store it
709 in DriverEntry. Pre-process the Depex to set the SOR, Before and After state.
710 The Discovered list is never free'ed and contains booleans that represent the
711 other possible DXE driver states.
713 @param Fv Fv protocol, needed to read Depex info out of
715 @param FvHandle Handle for Fv, needed in the
716 EFI_CORE_DRIVER_ENTRY so that the PE image can be
717 read out of the FV at a later time.
718 @param DriverName Name of driver to add to mDiscoveredList.
720 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.
721 @retval EFI_ALREADY_STARTED The driver has already been started. Only one
722 DriverName may be active in the system at any one
727 CoreAddToDriverList (
728 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
729 IN EFI_HANDLE FvHandle
,
730 IN EFI_GUID
*DriverName
733 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
737 // Create the Driver Entry for the list. ZeroPool initializes lots of variables to
740 DriverEntry
= CoreAllocateZeroBootServicesPool (sizeof (EFI_CORE_DRIVER_ENTRY
));
741 ASSERT (DriverEntry
!= NULL
);
743 DriverEntry
->Signature
= EFI_CORE_DRIVER_ENTRY_SIGNATURE
;
744 CopyMem (&DriverEntry
->FileName
, DriverName
, sizeof (EFI_GUID
));
745 DriverEntry
->FvHandle
= FvHandle
;
746 DriverEntry
->Fv
= Fv
;
747 DriverEntry
->FvFileDevicePath
= CoreFvToDevicePath (Fv
, FvHandle
, DriverName
);
749 CoreGetDepexSectionAndPreProccess (DriverEntry
);
751 CoreAcquireDispatcherLock ();
753 InsertTailList (&mDiscoveredList
, &DriverEntry
->Link
);
755 CoreReleaseDispatcherLock ();
762 Check if a FV Image type file (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) is
763 described by a EFI_HOB_FIRMWARE_VOLUME2 Hob.
765 @param FvHandle The handle which FVB protocol installed on.
766 @param DriverName The driver guid specified.
768 @retval TRUE This file is found in a EFI_HOB_FIRMWARE_VOLUME2
770 @retval FALSE Not found.
775 IN EFI_HANDLE FvHandle
,
776 IN CONST EFI_GUID
*DriverName
779 EFI_PEI_HOB_POINTERS HobFv2
;
781 HobFv2
.Raw
= GetHobList ();
783 while ((HobFv2
.Raw
= GetNextHob (EFI_HOB_TYPE_FV2
, HobFv2
.Raw
)) != NULL
) {
784 if (CompareGuid (DriverName
, &HobFv2
.FirmwareVolume2
->FileName
)) {
787 HobFv2
.Raw
= GET_NEXT_HOB (HobFv2
);
796 Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.
798 @param Fv The FIRMWARE_VOLUME protocol installed on the FV.
799 @param FvHandle The handle which FVB protocol installed on.
800 @param DriverName The driver guid specified.
802 @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.
803 @retval EFI_VOLUME_CORRUPTED Corrupted volume.
804 @retval EFI_SUCCESS Function successfully returned.
808 CoreProcessFvImageFile (
809 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
810 IN EFI_HANDLE FvHandle
,
811 IN EFI_GUID
*DriverName
815 EFI_SECTION_TYPE SectionType
;
816 UINT32 AuthenticationStatus
;
820 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
824 // Read the first (and only the first) firmware volume section
826 SectionType
= EFI_SECTION_FIRMWARE_VOLUME_IMAGE
;
831 AlignedBuffer
= NULL
;
832 Status
= Fv
->ReadSection (
839 &AuthenticationStatus
841 if (!EFI_ERROR (Status
)) {
843 // FvImage should be at its required alignment.
845 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) Buffer
;
846 FvAlignment
= 1 << ((FvHeader
->Attributes
& EFI_FVB2_ALIGNMENT
) >> 16);
848 // FvAlignment must be more than 8 bytes required by FvHeader structure.
850 if (FvAlignment
< 8) {
853 AlignedBuffer
= AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize
), (UINTN
) FvAlignment
);
854 if (AlignedBuffer
== NULL
) {
855 Status
= EFI_OUT_OF_RESOURCES
;
858 // Move FvImage into the aligned buffer and release the original buffer.
860 CopyMem (AlignedBuffer
, Buffer
, BufferSize
);
861 CoreFreePool (Buffer
);
864 // Produce a FVB protocol for the file
866 Status
= ProduceFVBProtocolOnBuffer (
867 (EFI_PHYSICAL_ADDRESS
) (UINTN
) AlignedBuffer
,
875 if (EFI_ERROR (Status
)) {
877 // ReadSection or Produce FVB failed, Free data buffer
879 if (Buffer
!= NULL
) {
880 CoreFreePool (Buffer
);
883 if (AlignedBuffer
!= NULL
) {
884 FreeAlignedPages (AlignedBuffer
, EFI_SIZE_TO_PAGES (BufferSize
));
893 Event notification that is fired every time a FV dispatch protocol is added.
894 More than one protocol may have been added when this event is fired, so you
895 must loop on CoreLocateHandle () to see how many protocols were added and
896 do the following to each FV:
897 If the Fv has already been processed, skip it. If the Fv has not been
898 processed then mark it as being processed, as we are about to process it.
899 Read the Fv and add any driver in the Fv to the mDiscoveredList.The
900 mDiscoveredList is never free'ed and contains variables that define
901 the other states the DXE driver transitions to..
902 While you are at it read the A Priori file into memory.
903 Place drivers in the A Priori list onto the mScheduledQueue.
905 @param Event The Event that is being processed, not used.
906 @param Context Event Context, not used.
911 CoreFwVolEventProtocolNotify (
917 EFI_STATUS GetNextFileStatus
;
918 EFI_STATUS SecurityStatus
;
919 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
920 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
925 EFI_FV_FILETYPE Type
;
926 EFI_FV_FILE_ATTRIBUTES Attributes
;
928 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
929 EFI_GUID
*AprioriFile
;
930 UINTN AprioriEntryCount
;
933 UINT32 AuthenticationStatus
;
938 BufferSize
= sizeof (EFI_HANDLE
);
939 Status
= CoreLocateHandle (
942 mFwVolEventRegistration
,
946 if (EFI_ERROR (Status
)) {
948 // If no more notification events exit
953 if (FvHasBeenProcessed (FvHandle
)) {
955 // This Fv has already been processed so lets skip it!
960 Status
= CoreHandleProtocol (FvHandle
, &gEfiFirmwareVolumeDispatchProtocolGuid
, (VOID
**)&Fv
);
961 if (EFI_ERROR (Status
)) {
963 // If no dispatch protocol then skip, but do not marked as being processed as it
964 // may show up later.
970 // Since we are about to process this Fv mark it as processed.
972 FvIsBeingProcesssed (FvHandle
);
975 Status
= CoreHandleProtocol (FvHandle
, &gEfiFirmwareVolume2ProtocolGuid
, (VOID
**)&Fv
);
976 if (EFI_ERROR (Status
)) {
978 // The Handle has a FirmwareVolumeDispatch protocol and should also contiain
979 // a FirmwareVolume protocol thus we should never get here.
985 Status
= CoreHandleProtocol (FvHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&FvDevicePath
);
986 if (EFI_ERROR (Status
)) {
988 // The Firmware volume doesn't have device path, can't be dispatched.
994 // Evaluate the authentication status of the Firmware Volume through
995 // Security Architectural Protocol
997 if (gSecurity
!= NULL
) {
998 SecurityStatus
= gSecurity
->FileAuthenticationState (
1003 if (SecurityStatus
!= EFI_SUCCESS
) {
1005 // Security check failed. The firmware volume should not be used for any purpose.
1012 // Discover Drivers in FV and add them to the Discovered Driver List.
1013 // Process EFI_FV_FILETYPE_DRIVER type and then EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER
1014 // EFI_FV_FILETYPE_DXE_CORE is processed to produce a Loaded Image protocol for the core
1015 // EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE is processed to create a Fvb
1017 for (Index
= 0; Index
< sizeof (mDxeFileTypes
)/sizeof (EFI_FV_FILETYPE
); Index
++) {
1019 // Initialize the search key
1023 Type
= mDxeFileTypes
[Index
];
1024 GetNextFileStatus
= Fv
->GetNextFile (
1032 if (!EFI_ERROR (GetNextFileStatus
)) {
1033 if (Type
== EFI_FV_FILETYPE_DXE_CORE
) {
1035 // If this is the DXE core fill in it's DevicePath & DeviceHandle
1037 if (gDxeCoreLoadedImage
->FilePath
== NULL
) {
1038 if (CompareGuid (&NameGuid
, gDxeCoreFileName
)) {
1040 // Maybe One specail Fv cantains only one DXE_CORE module, so its device path must
1041 // be initialized completely.
1043 EfiInitializeFwVolDevicepathNode (&mFvDevicePath
.File
, &NameGuid
);
1044 mFvDevicePath
.End
.Type
= EFI_END_ENTIRE_DEVICE_PATH
;
1045 mFvDevicePath
.End
.SubType
= END_ENTIRE_DEVICE_PATH_SUBTYPE
;
1046 SetDevicePathNodeLength (&mFvDevicePath
.End
, sizeof (EFI_DEVICE_PATH_PROTOCOL
));
1048 gDxeCoreLoadedImage
->FilePath
= CoreDuplicateDevicePath (
1049 (EFI_DEVICE_PATH_PROTOCOL
*)&mFvDevicePath
1051 gDxeCoreLoadedImage
->DeviceHandle
= FvHandle
;
1054 } else if (Type
== EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
) {
1056 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already
1059 if (FvFoundInHobFv2 (FvHandle
, &NameGuid
)) {
1063 // Found a firmware volume image. Produce a firmware volume block
1064 // protocol for it so it gets dispatched from. This is usually a
1067 CoreProcessFvImageFile (Fv
, FvHandle
, &NameGuid
);
1070 // Transition driver from Undiscovered to Discovered state
1072 CoreAddToDriverList (Fv
, FvHandle
, &NameGuid
);
1075 } while (!EFI_ERROR (GetNextFileStatus
));
1079 // Read the array of GUIDs from the Apriori file if it is present in the firmware volume
1082 Status
= Fv
->ReadSection (
1087 (VOID
**)&AprioriFile
,
1089 &AuthenticationStatus
1091 if (!EFI_ERROR (Status
)) {
1092 AprioriEntryCount
= SizeOfBuffer
/ sizeof (EFI_GUID
);
1094 AprioriEntryCount
= 0;
1098 // Put drivers on Apriori List on the Scheduled queue. The Discovered List includes
1099 // drivers not in the current FV and these must be skipped since the a priori list
1100 // is only valid for the FV that it resided in.
1102 CoreAcquireDispatcherLock ();
1104 for (Index
= 0; Index
< AprioriEntryCount
; Index
++) {
1105 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
1106 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
1107 if (CompareGuid (&DriverEntry
->FileName
, &AprioriFile
[Index
]) &&
1108 (FvHandle
== DriverEntry
->FvHandle
)) {
1109 DriverEntry
->Dependent
= FALSE
;
1110 DriverEntry
->Scheduled
= TRUE
;
1111 InsertTailList (&mScheduledQueue
, &DriverEntry
->ScheduledLink
);
1117 CoreReleaseDispatcherLock ();
1120 // Free data allocated by Fv->ReadSection ()
1122 CoreFreePool (AprioriFile
);
1129 Initialize the dispatcher. Initialize the notification function that runs when
1130 a FV protocol is added to the system.
1134 CoreInitializeDispatcher (
1138 mFwVolEvent
= CoreCreateProtocolNotifyEvent (
1139 &gEfiFirmwareVolume2ProtocolGuid
,
1141 CoreFwVolEventProtocolNotify
,
1143 &mFwVolEventRegistration
,
1149 // Function only used in debug builds
1153 Traverse the discovered list for any drivers that were discovered but not loaded
1154 because the dependency experessions evaluated to false.
1158 CoreDisplayDiscoveredNotDispatched (
1163 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
1165 for (Link
= mDiscoveredList
.ForwardLink
;Link
!=&mDiscoveredList
; Link
= Link
->ForwardLink
) {
1166 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
1167 if (DriverEntry
->Dependent
) {
1168 DEBUG ((DEBUG_LOAD
, "Driver %g was discovered but not loaded!!\n", &DriverEntry
->FileName
));