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 DEBUG ((DEBUG_INFO
, "Loading driver %g\n", &DriverEntry
->FileName
));
446 Status
= CoreLoadImage (
449 DriverEntry
->FvFileDevicePath
,
452 &DriverEntry
->ImageHandle
456 // Update the driver state to reflect that it's been loaded
458 if (EFI_ERROR (Status
)) {
459 CoreAcquireDispatcherLock ();
461 if (Status
== EFI_SECURITY_VIOLATION
) {
463 // Take driver from Scheduled to Untrused state
465 DriverEntry
->Untrusted
= TRUE
;
468 // The DXE Driver could not be loaded, and do not attempt to load or start it again.
469 // Take driver from Scheduled to Initialized.
471 // This case include the Never Trusted state if EFI_ACCESS_DENIED is returned
473 DriverEntry
->Initialized
= TRUE
;
476 DriverEntry
->Scheduled
= FALSE
;
477 RemoveEntryList (&DriverEntry
->ScheduledLink
);
479 CoreReleaseDispatcherLock ();
482 // If it's an error don't try the StartImage
488 CoreAcquireDispatcherLock ();
490 DriverEntry
->Scheduled
= FALSE
;
491 DriverEntry
->Initialized
= TRUE
;
492 RemoveEntryList (&DriverEntry
->ScheduledLink
);
494 CoreReleaseDispatcherLock ();
497 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
499 FixedPcdGet32(PcdStatusCodeValueDxeDriverBegin
),
500 &DriverEntry
->ImageHandle
,
501 sizeof (DriverEntry
->ImageHandle
)
504 Status
= CoreStartImage (DriverEntry
->ImageHandle
, NULL
, NULL
);
506 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
508 FixedPcdGet32(PcdStatusCodeValueDxeDriverEnd
),
509 &DriverEntry
->ImageHandle
,
510 sizeof (DriverEntry
->ImageHandle
)
513 ReturnStatus
= EFI_SUCCESS
;
517 // Search DriverList for items to place on Scheduled Queue
520 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
521 DriverEntry
= CR (Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
523 if (DriverEntry
->DepexProtocolError
){
525 // If Section Extraction Protocol did not let the Depex be read before retry the read
527 Status
= CoreGetDepexSectionAndPreProccess (DriverEntry
);
530 if (DriverEntry
->Dependent
) {
531 if (CoreIsSchedulable (DriverEntry
)) {
532 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
537 } while (ReadyToRun
);
539 gDispatcherRunning
= FALSE
;
546 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you
547 must add any driver with a before dependency on InsertedDriverEntry first.
548 You do this by recursively calling this routine. After all the Befores are
549 processed you can add InsertedDriverEntry to the mScheduledQueue.
550 Then you can add any driver with an After dependency on InsertedDriverEntry
551 by recursively calling this routine.
553 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue
557 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (
558 IN EFI_CORE_DRIVER_ENTRY
*InsertedDriverEntry
562 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
565 // Process Before Dependency
567 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
568 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
569 if (DriverEntry
->Before
&& DriverEntry
->Dependent
) {
570 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
572 // Recursively process BEFORE
574 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
580 // Convert driver from Dependent to Scheduled state
582 CoreAcquireDispatcherLock ();
584 InsertedDriverEntry
->Dependent
= FALSE
;
585 InsertedDriverEntry
->Scheduled
= TRUE
;
586 InsertTailList (&mScheduledQueue
, &InsertedDriverEntry
->ScheduledLink
);
588 CoreReleaseDispatcherLock ();
591 // Process After Dependency
593 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
594 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
595 if (DriverEntry
->After
&& DriverEntry
->Dependent
) {
596 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
598 // Recursively process AFTER
600 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
608 Return TRUE if the Fv has been processed, FALSE if not.
610 @param FvHandle The handle of a FV that's being tested
612 @retval TRUE Fv protocol on FvHandle has been processed
613 @retval FALSE Fv protocol on FvHandle has not yet been processed
618 IN EFI_HANDLE FvHandle
622 KNOWN_HANDLE
*KnownHandle
;
624 for (Link
= mFvHandleList
.ForwardLink
; Link
!= &mFvHandleList
; Link
= Link
->ForwardLink
) {
625 KnownHandle
= CR(Link
, KNOWN_HANDLE
, Link
, KNOWN_HANDLE_SIGNATURE
);
626 if (KnownHandle
->Handle
== FvHandle
) {
635 Remember that Fv protocol on FvHandle has had it's drivers placed on the
636 mDiscoveredList. This fucntion adds entries on the mFvHandleList. Items are
637 never removed/freed from the mFvHandleList.
639 @param FvHandle The handle of a FV that has been processed
643 FvIsBeingProcesssed (
644 IN EFI_HANDLE FvHandle
647 KNOWN_HANDLE
*KnownHandle
;
649 KnownHandle
= AllocatePool (sizeof (KNOWN_HANDLE
));
650 ASSERT (KnownHandle
!= NULL
);
652 KnownHandle
->Signature
= KNOWN_HANDLE_SIGNATURE
;
653 KnownHandle
->Handle
= FvHandle
;
654 InsertTailList (&mFvHandleList
, &KnownHandle
->Link
);
661 Convert FvHandle and DriverName into an EFI device path
663 @param Fv Fv protocol, needed to read Depex info out of
665 @param FvHandle Handle for Fv, needed in the
666 EFI_CORE_DRIVER_ENTRY so that the PE image can be
667 read out of the FV at a later time.
668 @param DriverName Name of driver to add to mDiscoveredList.
670 @return Pointer to device path constructed from FvHandle and DriverName
673 EFI_DEVICE_PATH_PROTOCOL
*
675 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
676 IN EFI_HANDLE FvHandle
,
677 IN EFI_GUID
*DriverName
681 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
682 EFI_DEVICE_PATH_PROTOCOL
*FileNameDevicePath
;
685 // Remember the device path of the FV
687 Status
= CoreHandleProtocol (FvHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&FvDevicePath
);
688 if (EFI_ERROR (Status
)) {
689 FileNameDevicePath
= NULL
;
692 // Build a device path to the file in the FV to pass into gBS->LoadImage
694 EfiInitializeFwVolDevicepathNode (&mFvDevicePath
.File
, DriverName
);
695 SetDevicePathEndNode (&mFvDevicePath
.End
);
697 FileNameDevicePath
= AppendDevicePath (
699 (EFI_DEVICE_PATH_PROTOCOL
*)&mFvDevicePath
703 return FileNameDevicePath
;
709 Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,
710 and initilize any state variables. Read the Depex from the FV and store it
711 in DriverEntry. Pre-process the Depex to set the SOR, Before and After state.
712 The Discovered list is never free'ed and contains booleans that represent the
713 other possible DXE driver states.
715 @param Fv Fv protocol, needed to read Depex info out of
717 @param FvHandle Handle for Fv, needed in the
718 EFI_CORE_DRIVER_ENTRY so that the PE image can be
719 read out of the FV at a later time.
720 @param DriverName Name of driver to add to mDiscoveredList.
722 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.
723 @retval EFI_ALREADY_STARTED The driver has already been started. Only one
724 DriverName may be active in the system at any one
729 CoreAddToDriverList (
730 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
731 IN EFI_HANDLE FvHandle
,
732 IN EFI_GUID
*DriverName
735 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
739 // Create the Driver Entry for the list. ZeroPool initializes lots of variables to
742 DriverEntry
= AllocateZeroPool (sizeof (EFI_CORE_DRIVER_ENTRY
));
743 ASSERT (DriverEntry
!= NULL
);
745 DriverEntry
->Signature
= EFI_CORE_DRIVER_ENTRY_SIGNATURE
;
746 CopyGuid (&DriverEntry
->FileName
, DriverName
);
747 DriverEntry
->FvHandle
= FvHandle
;
748 DriverEntry
->Fv
= Fv
;
749 DriverEntry
->FvFileDevicePath
= CoreFvToDevicePath (Fv
, FvHandle
, DriverName
);
751 CoreGetDepexSectionAndPreProccess (DriverEntry
);
753 CoreAcquireDispatcherLock ();
755 InsertTailList (&mDiscoveredList
, &DriverEntry
->Link
);
757 CoreReleaseDispatcherLock ();
764 Check if a FV Image type file (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) is
765 described by a EFI_HOB_FIRMWARE_VOLUME2 Hob.
767 @param FvHandle The handle which FVB protocol installed on.
768 @param DriverName The driver guid specified.
770 @retval TRUE This file is found in a EFI_HOB_FIRMWARE_VOLUME2
772 @retval FALSE Not found.
777 IN EFI_HANDLE FvHandle
,
778 IN CONST EFI_GUID
*DriverName
781 EFI_PEI_HOB_POINTERS HobFv2
;
783 HobFv2
.Raw
= GetHobList ();
785 while ((HobFv2
.Raw
= GetNextHob (EFI_HOB_TYPE_FV2
, HobFv2
.Raw
)) != NULL
) {
786 if (CompareGuid (DriverName
, &HobFv2
.FirmwareVolume2
->FileName
)) {
789 HobFv2
.Raw
= GET_NEXT_HOB (HobFv2
);
798 Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.
800 @param Fv The FIRMWARE_VOLUME protocol installed on the FV.
801 @param FvHandle The handle which FVB protocol installed on.
802 @param DriverName The driver guid specified.
804 @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.
805 @retval EFI_VOLUME_CORRUPTED Corrupted volume.
806 @retval EFI_SUCCESS Function successfully returned.
810 CoreProcessFvImageFile (
811 IN EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
,
812 IN EFI_HANDLE FvHandle
,
813 IN EFI_GUID
*DriverName
817 EFI_SECTION_TYPE SectionType
;
818 UINT32 AuthenticationStatus
;
822 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
826 // Read the first (and only the first) firmware volume section
828 SectionType
= EFI_SECTION_FIRMWARE_VOLUME_IMAGE
;
833 AlignedBuffer
= NULL
;
834 Status
= Fv
->ReadSection (
841 &AuthenticationStatus
843 if (!EFI_ERROR (Status
)) {
845 // FvImage should be at its required alignment.
847 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) Buffer
;
848 FvAlignment
= 1 << ((FvHeader
->Attributes
& EFI_FVB2_ALIGNMENT
) >> 16);
850 // FvAlignment must be more than 8 bytes required by FvHeader structure.
852 if (FvAlignment
< 8) {
856 // Allocate the aligned buffer for the FvImage.
858 AlignedBuffer
= AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize
), (UINTN
) FvAlignment
);
859 if (AlignedBuffer
== NULL
) {
860 Status
= EFI_OUT_OF_RESOURCES
;
863 // Move FvImage into the aligned buffer and release the original buffer.
865 CopyMem (AlignedBuffer
, Buffer
, BufferSize
);
866 CoreFreePool (Buffer
);
869 // Produce a FVB protocol for the file
871 Status
= ProduceFVBProtocolOnBuffer (
872 (EFI_PHYSICAL_ADDRESS
) (UINTN
) AlignedBuffer
,
880 if (EFI_ERROR (Status
)) {
882 // ReadSection or Produce FVB failed, Free data buffer
884 if (Buffer
!= NULL
) {
888 if (AlignedBuffer
!= NULL
) {
889 FreeAlignedPages (AlignedBuffer
, EFI_SIZE_TO_PAGES (BufferSize
));
898 Event notification that is fired every time a FV dispatch protocol is added.
899 More than one protocol may have been added when this event is fired, so you
900 must loop on CoreLocateHandle () to see how many protocols were added and
901 do the following to each FV:
902 If the Fv has already been processed, skip it. If the Fv has not been
903 processed then mark it as being processed, as we are about to process it.
904 Read the Fv and add any driver in the Fv to the mDiscoveredList.The
905 mDiscoveredList is never free'ed and contains variables that define
906 the other states the DXE driver transitions to..
907 While you are at it read the A Priori file into memory.
908 Place drivers in the A Priori list onto the mScheduledQueue.
910 @param Event The Event that is being processed, not used.
911 @param Context Event Context, not used.
916 CoreFwVolEventProtocolNotify (
922 EFI_STATUS GetNextFileStatus
;
923 EFI_STATUS SecurityStatus
;
924 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
925 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
930 EFI_FV_FILETYPE Type
;
931 EFI_FV_FILE_ATTRIBUTES Attributes
;
933 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
934 EFI_GUID
*AprioriFile
;
935 UINTN AprioriEntryCount
;
938 UINT32 AuthenticationStatus
;
943 BufferSize
= sizeof (EFI_HANDLE
);
944 Status
= CoreLocateHandle (
947 mFwVolEventRegistration
,
951 if (EFI_ERROR (Status
)) {
953 // If no more notification events exit
958 if (FvHasBeenProcessed (FvHandle
)) {
960 // This Fv has already been processed so lets skip it!
965 Status
= CoreHandleProtocol (FvHandle
, &gEfiFirmwareVolumeDispatchProtocolGuid
, (VOID
**)&Fv
);
966 if (EFI_ERROR (Status
)) {
968 // If no dispatch protocol then skip, but do not marked as being processed as it
969 // may show up later.
975 // Since we are about to process this Fv mark it as processed.
977 FvIsBeingProcesssed (FvHandle
);
979 Status
= CoreHandleProtocol (FvHandle
, &gEfiFirmwareVolume2ProtocolGuid
, (VOID
**)&Fv
);
980 if (EFI_ERROR (Status
)) {
982 // The Handle has a FirmwareVolumeDispatch protocol and should also contiain
983 // a FirmwareVolume protocol thus we should never get here.
989 Status
= CoreHandleProtocol (FvHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&FvDevicePath
);
990 if (EFI_ERROR (Status
)) {
992 // The Firmware volume doesn't have device path, can't be dispatched.
998 // Evaluate the authentication status of the Firmware Volume through
999 // Security Architectural Protocol
1001 if (gSecurity
!= NULL
) {
1002 SecurityStatus
= gSecurity
->FileAuthenticationState (
1007 if (SecurityStatus
!= EFI_SUCCESS
) {
1009 // Security check failed. The firmware volume should not be used for any purpose.
1016 // Discover Drivers in FV and add them to the Discovered Driver List.
1017 // Process EFI_FV_FILETYPE_DRIVER type and then EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER
1018 // EFI_FV_FILETYPE_DXE_CORE is processed to produce a Loaded Image protocol for the core
1019 // EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE is processed to create a Fvb
1021 for (Index
= 0; Index
< sizeof (mDxeFileTypes
) / sizeof (EFI_FV_FILETYPE
); Index
++) {
1023 // Initialize the search key
1027 Type
= mDxeFileTypes
[Index
];
1028 GetNextFileStatus
= Fv
->GetNextFile (
1036 if (!EFI_ERROR (GetNextFileStatus
)) {
1037 if (Type
== EFI_FV_FILETYPE_DXE_CORE
) {
1039 // If this is the DXE core fill in it's DevicePath & DeviceHandle
1041 if (gDxeCoreLoadedImage
->FilePath
== NULL
) {
1042 if (CompareGuid (&NameGuid
, gDxeCoreFileName
)) {
1044 // Maybe One specail Fv cantains only one DXE_CORE module, so its device path must
1045 // be initialized completely.
1047 EfiInitializeFwVolDevicepathNode (&mFvDevicePath
.File
, &NameGuid
);
1048 SetDevicePathEndNode (&mFvDevicePath
.End
);
1050 gDxeCoreLoadedImage
->FilePath
= DuplicateDevicePath (
1051 (EFI_DEVICE_PATH_PROTOCOL
*)&mFvDevicePath
1053 gDxeCoreLoadedImage
->DeviceHandle
= FvHandle
;
1056 } else if (Type
== EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
) {
1058 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already
1061 if (FvFoundInHobFv2 (FvHandle
, &NameGuid
)) {
1065 // Found a firmware volume image. Produce a firmware volume block
1066 // protocol for it so it gets dispatched from. This is usually a
1069 CoreProcessFvImageFile (Fv
, FvHandle
, &NameGuid
);
1072 // Transition driver from Undiscovered to Discovered state
1074 CoreAddToDriverList (Fv
, FvHandle
, &NameGuid
);
1077 } while (!EFI_ERROR (GetNextFileStatus
));
1081 // Read the array of GUIDs from the Apriori file if it is present in the firmware volume
1084 Status
= Fv
->ReadSection (
1089 (VOID
**)&AprioriFile
,
1091 &AuthenticationStatus
1093 if (!EFI_ERROR (Status
)) {
1094 AprioriEntryCount
= SizeOfBuffer
/ sizeof (EFI_GUID
);
1096 AprioriEntryCount
= 0;
1100 // Put drivers on Apriori List on the Scheduled queue. The Discovered List includes
1101 // drivers not in the current FV and these must be skipped since the a priori list
1102 // is only valid for the FV that it resided in.
1104 CoreAcquireDispatcherLock ();
1106 for (Index
= 0; Index
< AprioriEntryCount
; Index
++) {
1107 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
1108 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
1109 if (CompareGuid (&DriverEntry
->FileName
, &AprioriFile
[Index
]) &&
1110 (FvHandle
== DriverEntry
->FvHandle
)) {
1111 DriverEntry
->Dependent
= FALSE
;
1112 DriverEntry
->Scheduled
= TRUE
;
1113 InsertTailList (&mScheduledQueue
, &DriverEntry
->ScheduledLink
);
1119 CoreReleaseDispatcherLock ();
1122 // Free data allocated by Fv->ReadSection ()
1124 CoreFreePool (AprioriFile
);
1131 Initialize the dispatcher. Initialize the notification function that runs when
1132 an FV2 protocol is added to the system.
1136 CoreInitializeDispatcher (
1140 mFwVolEvent
= EfiCreateProtocolNotifyEvent (
1141 &gEfiFirmwareVolume2ProtocolGuid
,
1143 CoreFwVolEventProtocolNotify
,
1145 &mFwVolEventRegistration
1150 // Function only used in debug builds
1154 Traverse the discovered list for any drivers that were discovered but not loaded
1155 because the dependency experessions evaluated to false.
1159 CoreDisplayDiscoveredNotDispatched (
1164 EFI_CORE_DRIVER_ENTRY
*DriverEntry
;
1166 for (Link
= mDiscoveredList
.ForwardLink
;Link
!=&mDiscoveredList
; Link
= Link
->ForwardLink
) {
1167 DriverEntry
= CR(Link
, EFI_CORE_DRIVER_ENTRY
, Link
, EFI_CORE_DRIVER_ENTRY_SIGNATURE
);
1168 if (DriverEntry
->Dependent
) {
1169 DEBUG ((DEBUG_LOAD
, "Driver %g was discovered but not loaded!!\n", &DriverEntry
->FileName
));