4 Step #1 - When a FV protocol is added to the system every driver in the FV
5 is added to the mDiscoveredList. The 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 similar to the DXE dispatcher.
25 The rules for DXE dispatcher are in chapter 10 of the DXE CIS. Figure 10-3
26 is the state diagram for the DXE dispatcher
28 Depex - Dependency Expresion.
30 Copyright (c) 2014, Hewlett-Packard Development Company, L.P.
31 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
32 Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>
34 This program and the accompanying materials are licensed and made available
35 under the terms and conditions of the BSD License which accompanies this
36 distribution. The full text of the license may be found at
37 http://opensource.org/licenses/bsd-license.php
39 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
40 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
44 #include "StandaloneMmCore.h"
47 // MM Dispatcher Data structures
49 #define KNOWN_HANDLE_SIGNATURE SIGNATURE_32('k','n','o','w')
53 LIST_ENTRY Link
; // mFvHandleList
58 // Function Prototypes
62 MmCoreFfsFindMmDriver (
63 IN EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
67 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you
68 must add any driver with a before dependency on InsertedDriverEntry first.
69 You do this by recursively calling this routine. After all the Befores are
70 processed you can add InsertedDriverEntry to the mScheduledQueue.
71 Then you can add any driver with an After dependency on InsertedDriverEntry
72 by recursively calling this routine.
74 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue
78 MmInsertOnScheduledQueueWhileProcessingBeforeAndAfter (
79 IN EFI_MM_DRIVER_ENTRY
*InsertedDriverEntry
83 // The Driver List contains one copy of every driver that has been discovered.
84 // Items are never removed from the driver list. List of EFI_MM_DRIVER_ENTRY
86 LIST_ENTRY mDiscoveredList
= INITIALIZE_LIST_HEAD_VARIABLE (mDiscoveredList
);
89 // Queue of drivers that are ready to dispatch. This queue is a subset of the
90 // mDiscoveredList.list of EFI_MM_DRIVER_ENTRY.
92 LIST_ENTRY mScheduledQueue
= INITIALIZE_LIST_HEAD_VARIABLE (mScheduledQueue
);
95 // List of handles who's Fv's have been parsed and added to the mFwDriverList.
97 LIST_ENTRY mFvHandleList
= INITIALIZE_LIST_HEAD_VARIABLE (mFvHandleList
);
100 // Flag for the MM Dispacher. TRUE if dispatcher is execuing.
102 BOOLEAN gDispatcherRunning
= FALSE
;
105 // Flag for the MM Dispacher. TRUE if there is one or more MM drivers ready to be dispatched
107 BOOLEAN gRequestDispatch
= FALSE
;
110 // The global variable is defined for Loading modules at fixed address feature to track the MM code
111 // memory range usage. It is a bit mapped array in which every bit indicates the correspoding
112 // memory page available or not.
114 GLOBAL_REMOVE_IF_UNREFERENCED UINT64
*mMmCodeMemoryRangeUsageBitMap
=NULL
;
117 To check memory usage bit map array to figure out if the memory range in which the image will be loaded
118 is available or not. If memory range is avaliable, the function will mark the correponding bits to 1
119 which indicates the memory range is used. The function is only invoked when load modules at fixed address
122 @param ImageBase The base addres the image will be loaded at.
123 @param ImageSize The size of the image
125 @retval EFI_SUCCESS The memory range the image will be loaded in is available
126 @retval EFI_NOT_FOUND The memory range the image will be loaded in is not available
129 CheckAndMarkFixLoadingMemoryUsageBitMap (
130 IN EFI_PHYSICAL_ADDRESS ImageBase
,
134 UINT32 MmCodePageNumber
;
136 EFI_PHYSICAL_ADDRESS MmCodeBase
;
137 UINTN BaseOffsetPageNumber
;
138 UINTN TopOffsetPageNumber
;
142 // Build tool will calculate the smm code size and then patch the PcdLoadFixAddressMmCodePageNumber
144 MmCodePageNumber
= 0;
145 MmCodeSize
= EFI_PAGES_TO_SIZE (MmCodePageNumber
);
146 MmCodeBase
= gLoadModuleAtFixAddressMmramBase
;
149 // If the memory usage bit map is not initialized, do it. Every bit in the array
150 // indicate the status of the corresponding memory page, available or not
152 if (mMmCodeMemoryRangeUsageBitMap
== NULL
) {
153 mMmCodeMemoryRangeUsageBitMap
= AllocateZeroPool (((MmCodePageNumber
/ 64) + 1) * sizeof (UINT64
));
157 // If the Dxe code memory range is not allocated or the bit map array allocation failed, return EFI_NOT_FOUND
159 if (mMmCodeMemoryRangeUsageBitMap
== NULL
) {
160 return EFI_NOT_FOUND
;
164 // see if the memory range for loading the image is in the MM code range.
166 if (MmCodeBase
+ MmCodeSize
< ImageBase
+ ImageSize
|| MmCodeBase
> ImageBase
) {
167 return EFI_NOT_FOUND
;
171 // Test if the memory is avalaible or not.
173 BaseOffsetPageNumber
= (UINTN
)EFI_SIZE_TO_PAGES ((UINT32
)(ImageBase
- MmCodeBase
));
174 TopOffsetPageNumber
= (UINTN
)EFI_SIZE_TO_PAGES ((UINT32
)(ImageBase
+ ImageSize
- MmCodeBase
));
175 for (Index
= BaseOffsetPageNumber
; Index
< TopOffsetPageNumber
; Index
++) {
176 if ((mMmCodeMemoryRangeUsageBitMap
[Index
/ 64] & LShiftU64 (1, (Index
% 64))) != 0) {
178 // This page is already used.
180 return EFI_NOT_FOUND
;
185 // Being here means the memory range is available. So mark the bits for the memory range
187 for (Index
= BaseOffsetPageNumber
; Index
< TopOffsetPageNumber
; Index
++) {
188 mMmCodeMemoryRangeUsageBitMap
[Index
/ 64] |= LShiftU64 (1, (Index
% 64));
194 Get the fixed loading address from image header assigned by build tool. This function only be called
195 when Loading module at Fixed address feature enabled.
197 @param ImageContext Pointer to the image context structure that describes the PE/COFF
198 image that needs to be examined by this function.
199 @retval EFI_SUCCESS An fixed loading address is assigned to this image by build tools .
200 @retval EFI_NOT_FOUND The image has no assigned fixed loadding address.
204 GetPeCoffImageFixLoadingAssignedAddress(
205 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
208 UINTN SectionHeaderOffset
;
210 EFI_IMAGE_SECTION_HEADER SectionHeader
;
211 EFI_IMAGE_OPTIONAL_HEADER_UNION
*ImgHdr
;
212 EFI_PHYSICAL_ADDRESS FixLoadingAddress
;
215 UINT16 NumberOfSections
;
216 UINT64 ValueInSectionHeader
;
218 FixLoadingAddress
= 0;
219 Status
= EFI_NOT_FOUND
;
222 // Get PeHeader pointer
224 ImgHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)((CHAR8
* )ImageContext
->Handle
+ ImageContext
->PeCoffHeaderOffset
);
225 SectionHeaderOffset
= ImageContext
->PeCoffHeaderOffset
+ sizeof (UINT32
) + sizeof (EFI_IMAGE_FILE_HEADER
) +
226 ImgHdr
->Pe32
.FileHeader
.SizeOfOptionalHeader
;
227 NumberOfSections
= ImgHdr
->Pe32
.FileHeader
.NumberOfSections
;
230 // Get base address from the first section header that doesn't point to code section.
232 for (Index
= 0; Index
< NumberOfSections
; Index
++) {
234 // Read section header from file
236 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
237 Status
= ImageContext
->ImageRead (
238 ImageContext
->Handle
,
243 if (EFI_ERROR (Status
)) {
247 Status
= EFI_NOT_FOUND
;
249 if ((SectionHeader
.Characteristics
& EFI_IMAGE_SCN_CNT_CODE
) == 0) {
251 // Build tool will save the address in PointerToRelocations & PointerToLineNumbers fields
252 // in the first section header that doesn't point to code section in image header. So there
253 // is an assumption that when the feature is enabled, if a module with a loading address
254 // assigned by tools, the PointerToRelocations & PointerToLineNumbers fields should not be
255 // Zero, or else, these 2 fields should be set to Zero
257 ValueInSectionHeader
= ReadUnaligned64 ((UINT64
*)&SectionHeader
.PointerToRelocations
);
258 if (ValueInSectionHeader
!= 0) {
260 // Found first section header that doesn't point to code section in which build tool saves the
261 // offset to SMRAM base as image base in PointerToRelocations & PointerToLineNumbers fields
263 FixLoadingAddress
= (EFI_PHYSICAL_ADDRESS
)(gLoadModuleAtFixAddressMmramBase
+ (INT64
)ValueInSectionHeader
);
265 // Check if the memory range is available.
267 Status
= CheckAndMarkFixLoadingMemoryUsageBitMap (FixLoadingAddress
, (UINTN
)(ImageContext
->ImageSize
+ ImageContext
->SectionAlignment
));
268 if (!EFI_ERROR(Status
)) {
270 // The assigned address is valid. Return the specified loading address
272 ImageContext
->ImageAddress
= FixLoadingAddress
;
277 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
279 DEBUG ((DEBUG_INFO
|DEBUG_LOAD
, "LOADING MODULE FIXED INFO: Loading module at fixed address %x, Status = %r\n",
280 FixLoadingAddress
, Status
));
284 Loads an EFI image into SMRAM.
286 @param DriverEntry EFI_MM_DRIVER_ENTRY instance
294 IN OUT EFI_MM_DRIVER_ENTRY
*DriverEntry
300 EFI_PHYSICAL_ADDRESS DstBuffer
;
301 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
303 DEBUG ((DEBUG_INFO
, "MmLoadImage - %g\n", &DriverEntry
->FileName
));
305 Buffer
= AllocateCopyPool (DriverEntry
->Pe32DataSize
, DriverEntry
->Pe32Data
);
306 if (Buffer
== NULL
) {
307 return EFI_OUT_OF_RESOURCES
;
310 Status
= EFI_SUCCESS
;
313 // Initialize ImageContext
315 ImageContext
.Handle
= Buffer
;
316 ImageContext
.ImageRead
= PeCoffLoaderImageReadFromMemory
;
319 // Get information about the image being loaded
321 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
322 if (EFI_ERROR (Status
)) {
323 if (Buffer
!= NULL
) {
329 PageCount
= (UINTN
)EFI_SIZE_TO_PAGES ((UINTN
)ImageContext
.ImageSize
+ ImageContext
.SectionAlignment
);
330 DstBuffer
= (UINTN
)(-1);
332 Status
= MmAllocatePages (
334 EfiRuntimeServicesCode
,
338 if (EFI_ERROR (Status
)) {
339 if (Buffer
!= NULL
) {
345 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
)DstBuffer
;
348 // Align buffer on section boundry
350 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
- 1;
351 ImageContext
.ImageAddress
&= ~((EFI_PHYSICAL_ADDRESS
)(ImageContext
.SectionAlignment
- 1));
354 // Load the image to our new buffer
356 Status
= PeCoffLoaderLoadImage (&ImageContext
);
357 if (EFI_ERROR (Status
)) {
358 if (Buffer
!= NULL
) {
361 MmFreePages (DstBuffer
, PageCount
);
366 // Relocate the image in our new buffer
368 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
369 if (EFI_ERROR (Status
)) {
370 if (Buffer
!= NULL
) {
373 MmFreePages (DstBuffer
, PageCount
);
378 // Flush the instruction cache so the image data are written before we execute it
380 InvalidateInstructionCacheRange ((VOID
*)(UINTN
) ImageContext
.ImageAddress
, (UINTN
) ImageContext
.ImageSize
);
383 // Save Image EntryPoint in DriverEntry
385 DriverEntry
->ImageEntryPoint
= ImageContext
.EntryPoint
;
386 DriverEntry
->ImageBuffer
= DstBuffer
;
387 DriverEntry
->NumberOfPage
= PageCount
;
389 if (mEfiSystemTable
!= NULL
) {
390 Status
= mEfiSystemTable
->BootServices
->AllocatePool (
392 sizeof (EFI_LOADED_IMAGE_PROTOCOL
),
393 (VOID
**)&DriverEntry
->LoadedImage
395 if (EFI_ERROR (Status
)) {
396 if (Buffer
!= NULL
) {
399 MmFreePages (DstBuffer
, PageCount
);
403 ZeroMem (DriverEntry
->LoadedImage
, sizeof (EFI_LOADED_IMAGE_PROTOCOL
));
405 // Fill in the remaining fields of the Loaded Image Protocol instance.
406 // Note: ImageBase is an SMRAM address that can not be accessed outside of SMRAM if SMRAM window is closed.
408 DriverEntry
->LoadedImage
->Revision
= EFI_LOADED_IMAGE_PROTOCOL_REVISION
;
409 DriverEntry
->LoadedImage
->ParentHandle
= NULL
;
410 DriverEntry
->LoadedImage
->SystemTable
= mEfiSystemTable
;
411 DriverEntry
->LoadedImage
->DeviceHandle
= NULL
;
412 DriverEntry
->LoadedImage
->FilePath
= NULL
;
414 DriverEntry
->LoadedImage
->ImageBase
= (VOID
*)(UINTN
)DriverEntry
->ImageBuffer
;
415 DriverEntry
->LoadedImage
->ImageSize
= ImageContext
.ImageSize
;
416 DriverEntry
->LoadedImage
->ImageCodeType
= EfiRuntimeServicesCode
;
417 DriverEntry
->LoadedImage
->ImageDataType
= EfiRuntimeServicesData
;
420 // Create a new image handle in the UEFI handle database for the MM Driver
422 DriverEntry
->ImageHandle
= NULL
;
423 Status
= mEfiSystemTable
->BootServices
->InstallMultipleProtocolInterfaces (
424 &DriverEntry
->ImageHandle
,
425 &gEfiLoadedImageProtocolGuid
,
426 DriverEntry
->LoadedImage
,
432 // Print the load address and the PDB file name if it is available
438 CHAR8 EfiFileName
[256];
440 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
,
441 "Loading MM driver at 0x%11p EntryPoint=0x%11p ",
442 (VOID
*)(UINTN
) ImageContext
.ImageAddress
,
443 FUNCTION_ENTRY_POINT (ImageContext
.EntryPoint
)));
446 // Print Module Name by Pdb file path.
447 // Windows and Unix style file path are all trimmed correctly.
449 if (ImageContext
.PdbPointer
!= NULL
) {
451 for (Index
= 0; ImageContext
.PdbPointer
[Index
] != 0; Index
++) {
452 if ((ImageContext
.PdbPointer
[Index
] == '\\') || (ImageContext
.PdbPointer
[Index
] == '/')) {
453 StartIndex
= Index
+ 1;
458 // Copy the PDB file name to our temporary string, and replace .pdb with .efi
459 // The PDB file name is limited in the range of 0~255.
460 // If the length is bigger than 255, trim the redudant characters to avoid overflow in array boundary.
462 for (Index
= 0; Index
< sizeof (EfiFileName
) - 4; Index
++) {
463 EfiFileName
[Index
] = ImageContext
.PdbPointer
[Index
+ StartIndex
];
464 if (EfiFileName
[Index
] == 0) {
465 EfiFileName
[Index
] = '.';
467 if (EfiFileName
[Index
] == '.') {
468 EfiFileName
[Index
+ 1] = 'e';
469 EfiFileName
[Index
+ 2] = 'f';
470 EfiFileName
[Index
+ 3] = 'i';
471 EfiFileName
[Index
+ 4] = 0;
476 if (Index
== sizeof (EfiFileName
) - 4) {
477 EfiFileName
[Index
] = 0;
479 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "%a", EfiFileName
));
481 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "\n"));
486 // Free buffer allocated by Fv->ReadSection.
488 // The UEFI Boot Services FreePool() function must be used because Fv->ReadSection
489 // used the UEFI Boot Services AllocatePool() function
496 Preprocess dependency expression and update DriverEntry to reflect the
497 state of Before and After dependencies. If DriverEntry->Before
498 or DriverEntry->After is set it will never be cleared.
500 @param DriverEntry DriverEntry element to update .
502 @retval EFI_SUCCESS It always works.
507 IN EFI_MM_DRIVER_ENTRY
*DriverEntry
512 Iterator
= DriverEntry
->Depex
;
513 DriverEntry
->Dependent
= TRUE
;
515 if (*Iterator
== EFI_DEP_BEFORE
) {
516 DriverEntry
->Before
= TRUE
;
517 } else if (*Iterator
== EFI_DEP_AFTER
) {
518 DriverEntry
->After
= TRUE
;
521 if (DriverEntry
->Before
|| DriverEntry
->After
) {
522 CopyMem (&DriverEntry
->BeforeAfterGuid
, Iterator
+ 1, sizeof (EFI_GUID
));
529 Read Depex and pre-process the Depex for Before and After. If Section Extraction
530 protocol returns an error via ReadSection defer the reading of the Depex.
532 @param DriverEntry Driver to work on.
534 @retval EFI_SUCCESS Depex read and preprossesed
535 @retval EFI_PROTOCOL_ERROR The section extraction protocol returned an error
536 and Depex reading needs to be retried.
537 @retval Error DEPEX not found.
541 MmGetDepexSectionAndPreProccess (
542 IN EFI_MM_DRIVER_ENTRY
*DriverEntry
550 if (DriverEntry
->Depex
== NULL
) {
551 Status
= EFI_NOT_FOUND
;
553 Status
= EFI_SUCCESS
;
555 if (EFI_ERROR (Status
)) {
556 if (Status
== EFI_PROTOCOL_ERROR
) {
558 // The section extraction protocol failed so set protocol error flag
560 DriverEntry
->DepexProtocolError
= TRUE
;
563 // If no Depex assume depend on all architectural protocols
565 DriverEntry
->Depex
= NULL
;
566 DriverEntry
->Dependent
= TRUE
;
567 DriverEntry
->DepexProtocolError
= FALSE
;
571 // Set Before and After state information based on Depex
572 // Driver will be put in Dependent state
574 MmPreProcessDepex (DriverEntry
);
575 DriverEntry
->DepexProtocolError
= FALSE
;
582 This is the main Dispatcher for MM and it exits when there are no more
583 drivers to run. Drain the mScheduledQueue and load and start a PE
584 image for each driver. Search the mDiscoveredList to see if any driver can
585 be placed on the mScheduledQueue. If no drivers are placed on the
586 mScheduledQueue exit the function.
588 @retval EFI_SUCCESS All of the MM Drivers that could be dispatched
589 have been run and the MM Entry Point has been
591 @retval EFI_NOT_READY The MM Driver that registered the MM Entry Point
593 @retval EFI_NOT_FOUND There are no MM Drivers available to be dispatched.
594 @retval EFI_ALREADY_STARTED The MM Dispatcher is already running
604 EFI_MM_DRIVER_ENTRY
*DriverEntry
;
606 BOOLEAN PreviousMmEntryPointRegistered
;
608 DEBUG ((DEBUG_INFO
, "MmDispatcher\n"));
610 if (!gRequestDispatch
) {
611 DEBUG ((DEBUG_INFO
, " !gRequestDispatch\n"));
612 return EFI_NOT_FOUND
;
615 if (gDispatcherRunning
) {
616 DEBUG ((DEBUG_INFO
, " gDispatcherRunning\n"));
618 // If the dispatcher is running don't let it be restarted.
620 return EFI_ALREADY_STARTED
;
623 gDispatcherRunning
= TRUE
;
627 // Drain the Scheduled Queue
629 DEBUG ((DEBUG_INFO
, " Drain the Scheduled Queue\n"));
630 while (!IsListEmpty (&mScheduledQueue
)) {
632 mScheduledQueue
.ForwardLink
,
635 EFI_MM_DRIVER_ENTRY_SIGNATURE
637 DEBUG ((DEBUG_INFO
, " DriverEntry (Scheduled) - %g\n", &DriverEntry
->FileName
));
640 // Load the MM Driver image into memory. If the Driver was transitioned from
641 // Untrused to Scheduled it would have already been loaded so we may need to
642 // skip the LoadImage
644 if (DriverEntry
->ImageHandle
== NULL
) {
645 Status
= MmLoadImage (DriverEntry
);
648 // Update the driver state to reflect that it's been loaded
650 if (EFI_ERROR (Status
)) {
652 // The MM Driver could not be loaded, and do not attempt to load or start it again.
653 // Take driver from Scheduled to Initialized.
655 DriverEntry
->Initialized
= TRUE
;
656 DriverEntry
->Scheduled
= FALSE
;
657 RemoveEntryList (&DriverEntry
->ScheduledLink
);
660 // If it's an error don't try the StartImage
666 DriverEntry
->Scheduled
= FALSE
;
667 DriverEntry
->Initialized
= TRUE
;
668 RemoveEntryList (&DriverEntry
->ScheduledLink
);
671 // Cache state of MmEntryPointRegistered before calling entry point
673 PreviousMmEntryPointRegistered
= gMmCorePrivate
->MmEntryPointRegistered
;
676 // For each MM driver, pass NULL as ImageHandle
678 if (mEfiSystemTable
== NULL
) {
679 DEBUG ((DEBUG_INFO
, "StartImage - 0x%x (Standalone Mode)\n", DriverEntry
->ImageEntryPoint
));
680 Status
= ((MM_IMAGE_ENTRY_POINT
)(UINTN
)DriverEntry
->ImageEntryPoint
) (DriverEntry
->ImageHandle
, &gMmCoreMmst
);
682 DEBUG ((DEBUG_INFO
, "StartImage - 0x%x (Tradition Mode)\n", DriverEntry
->ImageEntryPoint
));
683 Status
= ((EFI_IMAGE_ENTRY_POINT
)(UINTN
)DriverEntry
->ImageEntryPoint
) (
684 DriverEntry
->ImageHandle
,
688 if (EFI_ERROR(Status
)) {
689 DEBUG ((DEBUG_INFO
, "StartImage Status - %r\n", Status
));
690 MmFreePages(DriverEntry
->ImageBuffer
, DriverEntry
->NumberOfPage
);
693 if (!PreviousMmEntryPointRegistered
&& gMmCorePrivate
->MmEntryPointRegistered
) {
695 // Return immediately if the MM Entry Point was registered by the MM
696 // Driver that was just dispatched. The MM IPL will reinvoke the MM
697 // Core Dispatcher. This is required so MM Mode may be enabled as soon
698 // as all the dependent MM Drivers for MM Mode have been dispatched.
699 // Once the MM Entry Point has been registered, then MM Mode will be
702 gRequestDispatch
= TRUE
;
703 gDispatcherRunning
= FALSE
;
704 return EFI_NOT_READY
;
709 // Search DriverList for items to place on Scheduled Queue
711 DEBUG ((DEBUG_INFO
, " Search DriverList for items to place on Scheduled Queue\n"));
713 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
714 DriverEntry
= CR (Link
, EFI_MM_DRIVER_ENTRY
, Link
, EFI_MM_DRIVER_ENTRY_SIGNATURE
);
715 DEBUG ((DEBUG_INFO
, " DriverEntry (Discovered) - %g\n", &DriverEntry
->FileName
));
717 if (DriverEntry
->DepexProtocolError
) {
719 // If Section Extraction Protocol did not let the Depex be read before retry the read
721 Status
= MmGetDepexSectionAndPreProccess (DriverEntry
);
724 if (DriverEntry
->Dependent
) {
725 if (MmIsSchedulable (DriverEntry
)) {
726 MmInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
731 } while (ReadyToRun
);
734 // If there is no more MM driver to dispatch, stop the dispatch request
736 DEBUG ((DEBUG_INFO
, " no more MM driver to dispatch, stop the dispatch request\n"));
737 gRequestDispatch
= FALSE
;
738 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
739 DriverEntry
= CR (Link
, EFI_MM_DRIVER_ENTRY
, Link
, EFI_MM_DRIVER_ENTRY_SIGNATURE
);
740 DEBUG ((DEBUG_INFO
, " DriverEntry (Discovered) - %g\n", &DriverEntry
->FileName
));
742 if (!DriverEntry
->Initialized
) {
744 // We have MM driver pending to dispatch
746 gRequestDispatch
= TRUE
;
751 gDispatcherRunning
= FALSE
;
757 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you
758 must add any driver with a before dependency on InsertedDriverEntry first.
759 You do this by recursively calling this routine. After all the Befores are
760 processed you can add InsertedDriverEntry to the mScheduledQueue.
761 Then you can add any driver with an After dependency on InsertedDriverEntry
762 by recursively calling this routine.
764 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue
768 MmInsertOnScheduledQueueWhileProcessingBeforeAndAfter (
769 IN EFI_MM_DRIVER_ENTRY
*InsertedDriverEntry
773 EFI_MM_DRIVER_ENTRY
*DriverEntry
;
776 // Process Before Dependency
778 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
779 DriverEntry
= CR(Link
, EFI_MM_DRIVER_ENTRY
, Link
, EFI_MM_DRIVER_ENTRY_SIGNATURE
);
780 if (DriverEntry
->Before
&& DriverEntry
->Dependent
&& DriverEntry
!= InsertedDriverEntry
) {
781 DEBUG ((DEBUG_DISPATCH
, "Evaluate MM DEPEX for FFS(%g)\n", &DriverEntry
->FileName
));
782 DEBUG ((DEBUG_DISPATCH
, " BEFORE FFS(%g) = ", &DriverEntry
->BeforeAfterGuid
));
783 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
785 // Recursively process BEFORE
787 DEBUG ((DEBUG_DISPATCH
, "TRUE\n END\n RESULT = TRUE\n"));
788 MmInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
790 DEBUG ((DEBUG_DISPATCH
, "FALSE\n END\n RESULT = FALSE\n"));
796 // Convert driver from Dependent to Scheduled state
799 InsertedDriverEntry
->Dependent
= FALSE
;
800 InsertedDriverEntry
->Scheduled
= TRUE
;
801 InsertTailList (&mScheduledQueue
, &InsertedDriverEntry
->ScheduledLink
);
805 // Process After Dependency
807 for (Link
= mDiscoveredList
.ForwardLink
; Link
!= &mDiscoveredList
; Link
= Link
->ForwardLink
) {
808 DriverEntry
= CR(Link
, EFI_MM_DRIVER_ENTRY
, Link
, EFI_MM_DRIVER_ENTRY_SIGNATURE
);
809 if (DriverEntry
->After
&& DriverEntry
->Dependent
&& DriverEntry
!= InsertedDriverEntry
) {
810 DEBUG ((DEBUG_DISPATCH
, "Evaluate MM DEPEX for FFS(%g)\n", &DriverEntry
->FileName
));
811 DEBUG ((DEBUG_DISPATCH
, " AFTER FFS(%g) = ", &DriverEntry
->BeforeAfterGuid
));
812 if (CompareGuid (&InsertedDriverEntry
->FileName
, &DriverEntry
->BeforeAfterGuid
)) {
814 // Recursively process AFTER
816 DEBUG ((DEBUG_DISPATCH
, "TRUE\n END\n RESULT = TRUE\n"));
817 MmInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry
);
819 DEBUG ((DEBUG_DISPATCH
, "FALSE\n END\n RESULT = FALSE\n"));
826 Return TRUE if the Fv has been processed, FALSE if not.
828 @param FvHandle The handle of a FV that's being tested
830 @retval TRUE Fv protocol on FvHandle has been processed
831 @retval FALSE Fv protocol on FvHandle has not yet been
837 IN EFI_HANDLE FvHandle
841 KNOWN_HANDLE
*KnownHandle
;
843 for (Link
= mFvHandleList
.ForwardLink
; Link
!= &mFvHandleList
; Link
= Link
->ForwardLink
) {
844 KnownHandle
= CR (Link
, KNOWN_HANDLE
, Link
, KNOWN_HANDLE_SIGNATURE
);
845 if (KnownHandle
->Handle
== FvHandle
) {
853 Remember that Fv protocol on FvHandle has had it's drivers placed on the
854 mDiscoveredList. This fucntion adds entries on the mFvHandleList. Items are
855 never removed/freed from the mFvHandleList.
857 @param FvHandle The handle of a FV that has been processed
861 FvIsBeingProcesssed (
862 IN EFI_HANDLE FvHandle
865 KNOWN_HANDLE
*KnownHandle
;
867 DEBUG ((DEBUG_INFO
, "FvIsBeingProcesssed - 0x%08x\n", FvHandle
));
869 KnownHandle
= AllocatePool (sizeof (KNOWN_HANDLE
));
870 ASSERT (KnownHandle
!= NULL
);
872 KnownHandle
->Signature
= KNOWN_HANDLE_SIGNATURE
;
873 KnownHandle
->Handle
= FvHandle
;
874 InsertTailList (&mFvHandleList
, &KnownHandle
->Link
);
878 Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,
879 and initilize any state variables. Read the Depex from the FV and store it
880 in DriverEntry. Pre-process the Depex to set the Before and After state.
881 The Discovered list is never free'ed and contains booleans that represent the
882 other possible MM driver states.
884 @param Fv Fv protocol, needed to read Depex info out of
886 @param FvHandle Handle for Fv, needed in the
887 EFI_MM_DRIVER_ENTRY so that the PE image can be
888 read out of the FV at a later time.
889 @param DriverName Name of driver to add to mDiscoveredList.
891 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.
892 @retval EFI_ALREADY_STARTED The driver has already been started. Only one
893 DriverName may be active in the system at any one
899 IN EFI_HANDLE FvHandle
,
901 IN UINTN Pe32DataSize
,
904 IN EFI_GUID
*DriverName
907 EFI_MM_DRIVER_ENTRY
*DriverEntry
;
909 DEBUG ((DEBUG_INFO
, "MmAddToDriverList - %g (0x%08x)\n", DriverName
, Pe32Data
));
912 // Create the Driver Entry for the list. ZeroPool initializes lots of variables to
915 DriverEntry
= AllocateZeroPool (sizeof (EFI_MM_DRIVER_ENTRY
));
916 ASSERT (DriverEntry
!= NULL
);
918 DriverEntry
->Signature
= EFI_MM_DRIVER_ENTRY_SIGNATURE
;
919 CopyGuid (&DriverEntry
->FileName
, DriverName
);
920 DriverEntry
->FvHandle
= FvHandle
;
921 DriverEntry
->Pe32Data
= Pe32Data
;
922 DriverEntry
->Pe32DataSize
= Pe32DataSize
;
923 DriverEntry
->Depex
= Depex
;
924 DriverEntry
->DepexSize
= DepexSize
;
926 MmGetDepexSectionAndPreProccess (DriverEntry
);
928 InsertTailList (&mDiscoveredList
, &DriverEntry
->Link
);
929 gRequestDispatch
= TRUE
;
935 This function is the main entry point for an MM handler dispatch
936 or communicate-based callback.
938 Event notification that is fired every time a FV dispatch protocol is added.
939 More than one protocol may have been added when this event is fired, so you
940 must loop on MmLocateHandle () to see how many protocols were added and
941 do the following to each FV:
942 If the Fv has already been processed, skip it. If the Fv has not been
943 processed then mark it as being processed, as we are about to process it.
944 Read the Fv and add any driver in the Fv to the mDiscoveredList.The
945 mDiscoveredList is never free'ed and contains variables that define
946 the other states the MM driver transitions to..
947 While you are at it read the A Priori file into memory.
948 Place drivers in the A Priori list onto the mScheduledQueue.
950 @param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
951 @param Context Points to an optional handler context which was specified when the handler was registered.
952 @param CommBuffer A pointer to a collection of data in memory that will
953 be conveyed from a non-MM environment into an MM environment.
954 @param CommBufferSize The size of the CommBuffer.
961 MmDriverDispatchHandler (
962 IN EFI_HANDLE DispatchHandle
,
963 IN CONST VOID
*Context
, OPTIONAL
964 IN OUT VOID
*CommBuffer
, OPTIONAL
965 IN OUT UINTN
*CommBufferSize OPTIONAL
970 DEBUG ((DEBUG_INFO
, "MmDriverDispatchHandler\n"));
973 // Execute the MM Dispatcher on any newly discovered FVs and previously
974 // discovered MM drivers that have been discovered but not dispatched.
976 Status
= MmDispatcher ();
979 // Check to see if CommBuffer and CommBufferSize are valid
981 if (CommBuffer
!= NULL
&& CommBufferSize
!= NULL
) {
982 if (*CommBufferSize
> 0) {
983 if (Status
== EFI_NOT_READY
) {
985 // If a the MM Core Entry Point was just registered, then set flag to
986 // request the MM Dispatcher to be restarted.
988 *(UINT8
*)CommBuffer
= COMM_BUFFER_MM_DISPATCH_RESTART
;
989 } else if (!EFI_ERROR (Status
)) {
991 // Set the flag to show that the MM Dispatcher executed without errors
993 *(UINT8
*)CommBuffer
= COMM_BUFFER_MM_DISPATCH_SUCCESS
;
996 // Set the flag to show that the MM Dispatcher encountered an error
998 *(UINT8
*)CommBuffer
= COMM_BUFFER_MM_DISPATCH_ERROR
;
1007 This function is the main entry point for an MM handler dispatch
1008 or communicate-based callback.
1010 @param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
1011 @param Context Points to an optional handler context which was specified when the handler was registered.
1012 @param CommBuffer A pointer to a collection of data in memory that will
1013 be conveyed from a non-MM environment into an MM environment.
1014 @param CommBufferSize The size of the CommBuffer.
1021 MmFvDispatchHandler (
1022 IN EFI_HANDLE DispatchHandle
,
1023 IN CONST VOID
*Context
, OPTIONAL
1024 IN OUT VOID
*CommBuffer
, OPTIONAL
1025 IN OUT UINTN
*CommBufferSize OPTIONAL
1029 EFI_MM_COMMUNICATE_FV_DISPATCH_DATA
*CommunicationFvDispatchData
;
1030 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
1032 DEBUG ((DEBUG_INFO
, "MmFvDispatchHandler\n"));
1034 CommunicationFvDispatchData
= CommBuffer
;
1036 DEBUG ((DEBUG_INFO
, " Dispatch - 0x%016lx - 0x%016lx\n", CommunicationFvDispatchData
->Address
,
1037 CommunicationFvDispatchData
->Size
));
1039 FwVolHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*)(UINTN
)CommunicationFvDispatchData
->Address
;
1041 MmCoreFfsFindMmDriver (FwVolHeader
);
1044 // Execute the MM Dispatcher on any newly discovered FVs and previously
1045 // discovered MM drivers that have been discovered but not dispatched.
1047 Status
= MmDispatcher ();
1053 Traverse the discovered list for any drivers that were discovered but not loaded
1054 because the dependency experessions evaluated to false.
1058 MmDisplayDiscoveredNotDispatched (
1063 EFI_MM_DRIVER_ENTRY
*DriverEntry
;
1065 for (Link
= mDiscoveredList
.ForwardLink
;Link
!=&mDiscoveredList
; Link
= Link
->ForwardLink
) {
1066 DriverEntry
= CR (Link
, EFI_MM_DRIVER_ENTRY
, Link
, EFI_MM_DRIVER_ENTRY_SIGNATURE
);
1067 if (DriverEntry
->Dependent
) {
1068 DEBUG ((DEBUG_LOAD
, "MM Driver %g was discovered but not loaded!!\n", &DriverEntry
->FileName
));