]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c
IntelFrameworkPkg UefiLib: Make the event empty function public
[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Dispatcher / Dispatcher.c
CommitLineData
162ed594 1/** @file\r
797a9d67 2 DXE Dispatcher.\r
28a00297 3\r
4 Step #1 - When a FV protocol is added to the system every driver in the FV\r
022c6d45 5 is added to the mDiscoveredList. The SOR, Before, and After Depex are\r
6 pre-processed as drivers are added to the mDiscoveredList. If an Apriori\r
7 file exists in the FV those drivers are addeded to the\r
8 mScheduledQueue. The mFvHandleList is used to make sure a\r
28a00297 9 FV is only processed once.\r
10\r
11 Step #2 - Dispatch. Remove driver from the mScheduledQueue and load and\r
022c6d45 12 start it. After mScheduledQueue is drained check the\r
13 mDiscoveredList to see if any item has a Depex that is ready to\r
28a00297 14 be placed on the mScheduledQueue.\r
15\r
022c6d45 16 Step #3 - Adding to the mScheduledQueue requires that you process Before\r
28a00297 17 and After dependencies. This is done recursively as the call to add\r
022c6d45 18 to the mScheduledQueue checks for Before and recursively adds\r
19 all Befores. It then addes the item that was passed in and then\r
28a00297 20 processess the After dependecies by recursively calling the routine.\r
21\r
22 Dispatcher Rules:\r
022c6d45 23 The rules for the dispatcher are in chapter 10 of the DXE CIS. Figure 10-3\r
28a00297 24 is the state diagram for the DXE dispatcher\r
25\r
26 Depex - Dependency Expresion.\r
27 SOR - Schedule On Request - Don't schedule if this bit is set.\r
28\r
c74a25f0 29Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
cd5ebaa0 30This program and the accompanying materials\r
23c98c94 31are licensed and made available under the terms and conditions of the BSD License\r
32which accompanies this distribution. The full text of the license may be found at\r
33http://opensource.org/licenses/bsd-license.php\r
34\r
35THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
36WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
797a9d67 37\r
38**/\r
28a00297 39\r
9c4ac31c 40#include "DxeMain.h"\r
28a00297 41\r
42//\r
43// The Driver List contains one copy of every driver that has been discovered.\r
44// Items are never removed from the driver list. List of EFI_CORE_DRIVER_ENTRY\r
45//\r
022c6d45 46LIST_ENTRY mDiscoveredList = INITIALIZE_LIST_HEAD_VARIABLE (mDiscoveredList);\r
28a00297 47\r
48//\r
49// Queue of drivers that are ready to dispatch. This queue is a subset of the\r
50// mDiscoveredList.list of EFI_CORE_DRIVER_ENTRY.\r
51//\r
52LIST_ENTRY mScheduledQueue = INITIALIZE_LIST_HEAD_VARIABLE (mScheduledQueue);\r
53\r
54//\r
55// List of handles who's Fv's have been parsed and added to the mFwDriverList.\r
56//\r
57LIST_ENTRY mFvHandleList = INITIALIZE_LIST_HEAD_VARIABLE (mFvHandleList); // list of KNOWN_HANDLE\r
58\r
59//\r
60// Lock for mDiscoveredList, mScheduledQueue, gDispatcherRunning.\r
61//\r
62EFI_LOCK mDispatcherLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_HIGH_LEVEL);\r
63\r
64\r
65//\r
66// Flag for the DXE Dispacher. TRUE if dispatcher is execuing.\r
67//\r
68BOOLEAN gDispatcherRunning = FALSE;\r
69\r
70//\r
71// Module globals to manage the FwVol registration notification event\r
72//\r
73EFI_EVENT mFwVolEvent;\r
74VOID *mFwVolEventRegistration;\r
75\r
76//\r
77// List of file types supported by dispatcher\r
78//\r
022c6d45 79EFI_FV_FILETYPE mDxeFileTypes[] = {\r
80 EFI_FV_FILETYPE_DRIVER,\r
202c3279 81 EFI_FV_FILETYPE_COMBINED_SMM_DXE,\r
022c6d45 82 EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER,\r
28a00297 83 EFI_FV_FILETYPE_DXE_CORE,\r
84 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE\r
85};\r
86\r
87typedef struct {\r
88 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH File;\r
89 EFI_DEVICE_PATH_PROTOCOL End;\r
90} FV_FILEPATH_DEVICE_PATH;\r
91\r
e407ceec
LG
92FV_FILEPATH_DEVICE_PATH mFvDevicePath;\r
93\r
28a00297 94//\r
95// Function Prototypes\r
96//\r
162ed594 97/**\r
98 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you\r
99 must add any driver with a before dependency on InsertedDriverEntry first.\r
100 You do this by recursively calling this routine. After all the Befores are\r
101 processed you can add InsertedDriverEntry to the mScheduledQueue.\r
102 Then you can add any driver with an After dependency on InsertedDriverEntry\r
103 by recursively calling this routine.\r
104\r
105 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue\r
106\r
107**/\r
28a00297 108VOID\r
109CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (\r
110 IN EFI_CORE_DRIVER_ENTRY *InsertedDriverEntry\r
111 );\r
022c6d45 112\r
162ed594 113/**\r
114 Event notification that is fired every time a FV dispatch protocol is added.\r
115 More than one protocol may have been added when this event is fired, so you\r
116 must loop on CoreLocateHandle () to see how many protocols were added and\r
117 do the following to each FV:\r
118 If the Fv has already been processed, skip it. If the Fv has not been\r
119 processed then mark it as being processed, as we are about to process it.\r
120 Read the Fv and add any driver in the Fv to the mDiscoveredList.The\r
121 mDiscoveredList is never free'ed and contains variables that define\r
122 the other states the DXE driver transitions to..\r
123 While you are at it read the A Priori file into memory.\r
124 Place drivers in the A Priori list onto the mScheduledQueue.\r
125\r
022c6d45 126 @param Event The Event that is being processed, not used.\r
162ed594 127 @param Context Event Context, not used.\r
128\r
129**/\r
28a00297 130VOID\r
131EFIAPI\r
132CoreFwVolEventProtocolNotify (\r
133 IN EFI_EVENT Event,\r
134 IN VOID *Context\r
135 );\r
136\r
162ed594 137/**\r
022c6d45 138 Convert FvHandle and DriverName into an EFI device path\r
162ed594 139\r
022c6d45 140 @param Fv Fv protocol, needed to read Depex info out of\r
141 FLASH.\r
142 @param FvHandle Handle for Fv, needed in the\r
143 EFI_CORE_DRIVER_ENTRY so that the PE image can be\r
144 read out of the FV at a later time.\r
145 @param DriverName Name of driver to add to mDiscoveredList.\r
162ed594 146\r
147 @return Pointer to device path constructed from FvHandle and DriverName\r
148\r
149**/\r
28a00297 150EFI_DEVICE_PATH_PROTOCOL *\r
151CoreFvToDevicePath (\r
0c2b5da8 152 IN EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv,\r
28a00297 153 IN EFI_HANDLE FvHandle,\r
154 IN EFI_GUID *DriverName\r
155 );\r
156\r
162ed594 157/**\r
158 Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,\r
159 and initilize any state variables. Read the Depex from the FV and store it\r
160 in DriverEntry. Pre-process the Depex to set the SOR, Before and After state.\r
161 The Discovered list is never free'ed and contains booleans that represent the\r
162 other possible DXE driver states.\r
163\r
022c6d45 164 @param Fv Fv protocol, needed to read Depex info out of\r
165 FLASH.\r
166 @param FvHandle Handle for Fv, needed in the\r
167 EFI_CORE_DRIVER_ENTRY so that the PE image can be\r
168 read out of the FV at a later time.\r
169 @param DriverName Name of driver to add to mDiscoveredList.\r
d3592549 170 @param Type Fv File Type of file to add to mDiscoveredList.\r
162ed594 171\r
022c6d45 172 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.\r
173 @retval EFI_ALREADY_STARTED The driver has already been started. Only one\r
174 DriverName may be active in the system at any one\r
162ed594 175 time.\r
176\r
177**/\r
28a00297 178EFI_STATUS\r
179CoreAddToDriverList (\r
23c98c94 180 IN EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv,\r
181 IN EFI_HANDLE FvHandle,\r
d3592549
LG
182 IN EFI_GUID *DriverName,\r
183 IN EFI_FV_FILETYPE Type\r
28a00297 184 );\r
185\r
162ed594 186/**\r
187 Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.\r
188\r
022c6d45 189 @param Fv The FIRMWARE_VOLUME protocol installed on the FV.\r
190 @param FvHandle The handle which FVB protocol installed on.\r
191 @param DriverName The driver guid specified.\r
162ed594 192\r
022c6d45 193 @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.\r
194 @retval EFI_VOLUME_CORRUPTED Corrupted volume.\r
162ed594 195 @retval EFI_SUCCESS Function successfully returned.\r
196\r
197**/\r
022c6d45 198EFI_STATUS\r
28a00297 199CoreProcessFvImageFile (\r
0c2b5da8 200 IN EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv,\r
28a00297 201 IN EFI_HANDLE FvHandle,\r
202 IN EFI_GUID *DriverName\r
203 );\r
204\r
162ed594 205\r
206/**\r
207 Enter critical section by gaining lock on mDispatcherLock.\r
208\r
209**/\r
28a00297 210VOID\r
211CoreAcquireDispatcherLock (\r
212 VOID\r
213 )\r
28a00297 214{\r
215 CoreAcquireLock (&mDispatcherLock);\r
216}\r
217\r
162ed594 218\r
219/**\r
220 Exit critical section by releasing lock on mDispatcherLock.\r
221\r
222**/\r
28a00297 223VOID\r
224CoreReleaseDispatcherLock (\r
225 VOID\r
226 )\r
28a00297 227{\r
228 CoreReleaseLock (&mDispatcherLock);\r
229}\r
230\r
28a00297 231\r
162ed594 232/**\r
28a00297 233 Read Depex and pre-process the Depex for Before and After. If Section Extraction\r
234 protocol returns an error via ReadSection defer the reading of the Depex.\r
235\r
022c6d45 236 @param DriverEntry Driver to work on.\r
28a00297 237\r
022c6d45 238 @retval EFI_SUCCESS Depex read and preprossesed\r
239 @retval EFI_PROTOCOL_ERROR The section extraction protocol returned an error\r
240 and Depex reading needs to be retried.\r
162ed594 241 @retval Error DEPEX not found.\r
28a00297 242\r
162ed594 243**/\r
162ed594 244EFI_STATUS\r
245CoreGetDepexSectionAndPreProccess (\r
246 IN EFI_CORE_DRIVER_ENTRY *DriverEntry\r
247 )\r
28a00297 248{\r
249 EFI_STATUS Status;\r
250 EFI_SECTION_TYPE SectionType;\r
251 UINT32 AuthenticationStatus;\r
0c2b5da8 252 EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
28a00297 253\r
022c6d45 254\r
28a00297 255 Fv = DriverEntry->Fv;\r
256\r
257 //\r
258 // Grab Depex info, it will never be free'ed.\r
259 //\r
260 SectionType = EFI_SECTION_DXE_DEPEX;\r
261 Status = Fv->ReadSection (\r
022c6d45 262 DriverEntry->Fv,\r
28a00297 263 &DriverEntry->FileName,\r
022c6d45 264 SectionType,\r
265 0,\r
266 &DriverEntry->Depex,\r
28a00297 267 (UINTN *)&DriverEntry->DepexSize,\r
268 &AuthenticationStatus\r
269 );\r
270 if (EFI_ERROR (Status)) {\r
271 if (Status == EFI_PROTOCOL_ERROR) {\r
272 //\r
273 // The section extraction protocol failed so set protocol error flag\r
274 //\r
275 DriverEntry->DepexProtocolError = TRUE;\r
276 } else {\r
277 //\r
8a7d75b0 278 // If no Depex assume UEFI 2.0 driver model\r
28a00297 279 //\r
280 DriverEntry->Depex = NULL;\r
281 DriverEntry->Dependent = TRUE;\r
282 DriverEntry->DepexProtocolError = FALSE;\r
283 }\r
284 } else {\r
285 //\r
286 // Set Before, After, and Unrequested state information based on Depex\r
287 // Driver will be put in Dependent or Unrequested state\r
288 //\r
289 CorePreProcessDepex (DriverEntry);\r
290 DriverEntry->DepexProtocolError = FALSE;\r
022c6d45 291 }\r
28a00297 292\r
293 return Status;\r
294}\r
295\r
162ed594 296\r
297/**\r
298 Check every driver and locate a matching one. If the driver is found, the Unrequested\r
299 state flag is cleared.\r
300\r
022c6d45 301 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains\r
302 the firmware file specified by DriverName.\r
303 @param DriverName The Driver name to put in the Dependent state.\r
162ed594 304\r
022c6d45 305 @retval EFI_SUCCESS The DriverName was found and it's SOR bit was\r
306 cleared\r
307 @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was\r
308 not set.\r
162ed594 309\r
310**/\r
28a00297 311EFI_STATUS\r
312EFIAPI\r
313CoreSchedule (\r
314 IN EFI_HANDLE FirmwareVolumeHandle,\r
315 IN EFI_GUID *DriverName\r
316 )\r
28a00297 317{\r
318 LIST_ENTRY *Link;\r
319 EFI_CORE_DRIVER_ENTRY *DriverEntry;\r
320\r
321 //\r
322 // Check every driver\r
323 //\r
324 for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
325 DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
326 if (DriverEntry->FvHandle == FirmwareVolumeHandle &&\r
022c6d45 327 DriverEntry->Unrequested &&\r
28a00297 328 CompareGuid (DriverName, &DriverEntry->FileName)) {\r
329 //\r
330 // Move the driver from the Unrequested to the Dependent state\r
331 //\r
332 CoreAcquireDispatcherLock ();\r
333 DriverEntry->Unrequested = FALSE;\r
334 DriverEntry->Dependent = TRUE;\r
335 CoreReleaseDispatcherLock ();\r
022c6d45 336\r
6a55eea3 337 DEBUG ((DEBUG_DISPATCH, "Schedule FFS(%g) - EFI_SUCCESS\n", DriverName));\r
338 \r
28a00297 339 return EFI_SUCCESS;\r
340 }\r
341 }\r
6a55eea3 342 \r
343 DEBUG ((DEBUG_DISPATCH, "Schedule FFS(%g) - EFI_NOT_FOUND\n", DriverName));\r
344 \r
022c6d45 345 return EFI_NOT_FOUND;\r
28a00297 346}\r
347\r
348\r
162ed594 349\r
350/**\r
e94a9ff7 351 Convert a driver from the Untrused back to the Scheduled state.\r
162ed594 352\r
022c6d45 353 @param FirmwareVolumeHandle The handle of the Firmware Volume that contains\r
354 the firmware file specified by DriverName.\r
355 @param DriverName The Driver name to put in the Scheduled state\r
162ed594 356\r
022c6d45 357 @retval EFI_SUCCESS The file was found in the untrusted state, and it\r
358 was promoted to the trusted state.\r
359 @retval EFI_NOT_FOUND The file was not found in the untrusted state.\r
162ed594 360\r
361**/\r
28a00297 362EFI_STATUS\r
363EFIAPI\r
364CoreTrust (\r
365 IN EFI_HANDLE FirmwareVolumeHandle,\r
366 IN EFI_GUID *DriverName\r
367 )\r
28a00297 368{\r
369 LIST_ENTRY *Link;\r
370 EFI_CORE_DRIVER_ENTRY *DriverEntry;\r
371\r
372 //\r
373 // Check every driver\r
374 //\r
375 for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
376 DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
377 if (DriverEntry->FvHandle == FirmwareVolumeHandle &&\r
022c6d45 378 DriverEntry->Untrusted &&\r
28a00297 379 CompareGuid (DriverName, &DriverEntry->FileName)) {\r
380 //\r
381 // Transition driver from Untrusted to Scheduled state.\r
382 //\r
383 CoreAcquireDispatcherLock ();\r
384 DriverEntry->Untrusted = FALSE;\r
385 DriverEntry->Scheduled = TRUE;\r
386 InsertTailList (&mScheduledQueue, &DriverEntry->ScheduledLink);\r
387 CoreReleaseDispatcherLock ();\r
022c6d45 388\r
28a00297 389 return EFI_SUCCESS;\r
390 }\r
391 }\r
022c6d45 392 return EFI_NOT_FOUND;\r
28a00297 393}\r
394\r
395\r
202c3279 396/**\r
397 An empty function to pass error checking of CreateEventEx ().\r
398\r
399 @param Event Event whose notification function is being invoked.\r
400 @param Context Pointer to the notification function's context,\r
401 which is implementation-dependent.\r
402\r
403**/\r
404VOID\r
405EFIAPI\r
54cd17e9 406CoreEmptyCallbackFunction (\r
202c3279 407 IN EFI_EVENT Event,\r
408 IN VOID *Context\r
409 )\r
410{\r
411 return;\r
412}\r
28a00297 413\r
162ed594 414/**\r
415 This is the main Dispatcher for DXE and it exits when there are no more\r
28a00297 416 drivers to run. Drain the mScheduledQueue and load and start a PE\r
162ed594 417 image for each driver. Search the mDiscoveredList to see if any driver can\r
28a00297 418 be placed on the mScheduledQueue. If no drivers are placed on the\r
419 mScheduledQueue exit the function. On exit it is assumed the Bds()\r
162ed594 420 will be called, and when the Bds() exits the Dispatcher will be called\r
28a00297 421 again.\r
422\r
022c6d45 423 @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running\r
424 @retval EFI_NOT_FOUND No DXE Drivers were dispatched\r
425 @retval EFI_SUCCESS One or more DXE Drivers were dispatched\r
28a00297 426\r
162ed594 427**/\r
162ed594 428EFI_STATUS\r
429EFIAPI\r
430CoreDispatcher (\r
431 VOID\r
432 )\r
28a00297 433{\r
434 EFI_STATUS Status;\r
435 EFI_STATUS ReturnStatus;\r
436 LIST_ENTRY *Link;\r
437 EFI_CORE_DRIVER_ENTRY *DriverEntry;\r
438 BOOLEAN ReadyToRun;\r
202c3279 439 EFI_EVENT DxeDispatchEvent;\r
440 \r
28a00297 441\r
442 if (gDispatcherRunning) {\r
443 //\r
444 // If the dispatcher is running don't let it be restarted.\r
445 //\r
446 return EFI_ALREADY_STARTED;\r
447 }\r
448\r
449 gDispatcherRunning = TRUE;\r
450\r
202c3279 451 Status = CoreCreateEventEx (\r
452 EVT_NOTIFY_SIGNAL,\r
453 TPL_NOTIFY,\r
54cd17e9 454 CoreEmptyCallbackFunction,\r
202c3279 455 NULL,\r
456 &gEfiEventDxeDispatchGuid,\r
457 &DxeDispatchEvent\r
458 );\r
459 if (EFI_ERROR (Status)) {\r
460 return Status;\r
461 }\r
28a00297 462\r
463 ReturnStatus = EFI_NOT_FOUND;\r
464 do {\r
465 //\r
466 // Drain the Scheduled Queue\r
467 //\r
468 while (!IsListEmpty (&mScheduledQueue)) {\r
469 DriverEntry = CR (\r
470 mScheduledQueue.ForwardLink,\r
471 EFI_CORE_DRIVER_ENTRY,\r
472 ScheduledLink,\r
473 EFI_CORE_DRIVER_ENTRY_SIGNATURE\r
474 );\r
475\r
476 //\r
477 // Load the DXE Driver image into memory. If the Driver was transitioned from\r
478 // Untrused to Scheduled it would have already been loaded so we may need to\r
479 // skip the LoadImage\r
480 //\r
d3592549 481 if (DriverEntry->ImageHandle == NULL && !DriverEntry->IsFvImage) {\r
94903510 482 DEBUG ((DEBUG_INFO, "Loading driver %g\n", &DriverEntry->FileName));\r
28a00297 483 Status = CoreLoadImage (\r
022c6d45 484 FALSE,\r
485 gDxeCoreImageHandle,\r
28a00297 486 DriverEntry->FvFileDevicePath,\r
022c6d45 487 NULL,\r
488 0,\r
28a00297 489 &DriverEntry->ImageHandle\r
490 );\r
491\r
492 //\r
493 // Update the driver state to reflect that it's been loaded\r
494 //\r
495 if (EFI_ERROR (Status)) {\r
496 CoreAcquireDispatcherLock ();\r
497\r
498 if (Status == EFI_SECURITY_VIOLATION) {\r
499 //\r
500 // Take driver from Scheduled to Untrused state\r
501 //\r
502 DriverEntry->Untrusted = TRUE;\r
503 } else {\r
504 //\r
505 // The DXE Driver could not be loaded, and do not attempt to load or start it again.\r
022c6d45 506 // Take driver from Scheduled to Initialized.\r
28a00297 507 //\r
508 // This case include the Never Trusted state if EFI_ACCESS_DENIED is returned\r
509 //\r
510 DriverEntry->Initialized = TRUE;\r
511 }\r
512\r
513 DriverEntry->Scheduled = FALSE;\r
514 RemoveEntryList (&DriverEntry->ScheduledLink);\r
022c6d45 515\r
28a00297 516 CoreReleaseDispatcherLock ();\r
022c6d45 517\r
28a00297 518 //\r
519 // If it's an error don't try the StartImage\r
520 //\r
521 continue;\r
522 }\r
523 }\r
524\r
525 CoreAcquireDispatcherLock ();\r
526\r
527 DriverEntry->Scheduled = FALSE;\r
528 DriverEntry->Initialized = TRUE;\r
529 RemoveEntryList (&DriverEntry->ScheduledLink);\r
022c6d45 530\r
28a00297 531 CoreReleaseDispatcherLock ();\r
532\r
2680a308 533 \r
d3592549
LG
534 if (DriverEntry->IsFvImage) {\r
535 //\r
536 // Produce a firmware volume block protocol for FvImage so it gets dispatched from. \r
537 //\r
538 Status = CoreProcessFvImageFile (DriverEntry->Fv, DriverEntry->FvHandle, &DriverEntry->FileName);\r
539 } else {\r
540 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (\r
541 EFI_PROGRESS_CODE,\r
542 (EFI_SOFTWARE_DXE_CORE | EFI_SW_PC_INIT_BEGIN),\r
543 &DriverEntry->ImageHandle,\r
544 sizeof (DriverEntry->ImageHandle)\r
545 );\r
328ce03e 546 ASSERT (DriverEntry->ImageHandle != NULL);\r
d3592549
LG
547 \r
548 Status = CoreStartImage (DriverEntry->ImageHandle, NULL, NULL);\r
549 \r
550 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (\r
551 EFI_PROGRESS_CODE,\r
552 (EFI_SOFTWARE_DXE_CORE | EFI_SW_PC_INIT_END),\r
553 &DriverEntry->ImageHandle,\r
554 sizeof (DriverEntry->ImageHandle)\r
555 );\r
556 }\r
28a00297 557\r
558 ReturnStatus = EFI_SUCCESS;\r
559 }\r
560\r
0e4483bc
LG
561 //\r
562 // Now DXE Dispatcher finished one round of dispatch, signal an event group\r
563 // so that SMM Dispatcher get chance to dispatch SMM Drivers which depend\r
564 // on UEFI protocols\r
565 //\r
566 if (!EFI_ERROR (ReturnStatus)) {\r
567 CoreSignalEvent (DxeDispatchEvent);\r
568 }\r
569\r
28a00297 570 //\r
571 // Search DriverList for items to place on Scheduled Queue\r
572 //\r
573 ReadyToRun = FALSE;\r
574 for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
575 DriverEntry = CR (Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
576\r
577 if (DriverEntry->DepexProtocolError){\r
578 //\r
579 // If Section Extraction Protocol did not let the Depex be read before retry the read\r
580 //\r
581 Status = CoreGetDepexSectionAndPreProccess (DriverEntry);\r
022c6d45 582 }\r
28a00297 583\r
584 if (DriverEntry->Dependent) {\r
585 if (CoreIsSchedulable (DriverEntry)) {\r
022c6d45 586 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry);\r
28a00297 587 ReadyToRun = TRUE;\r
022c6d45 588 }\r
6a55eea3 589 } else {\r
590 if (DriverEntry->Unrequested) {\r
591 DEBUG ((DEBUG_DISPATCH, "Evaluate DXE DEPEX for FFS(%g)\n", &DriverEntry->FileName));\r
592 DEBUG ((DEBUG_DISPATCH, " SOR = Not Requested\n"));\r
593 DEBUG ((DEBUG_DISPATCH, " RESULT = FALSE\n"));\r
594 }\r
28a00297 595 }\r
596 }\r
597 } while (ReadyToRun);\r
598\r
202c3279 599 //\r
600 // Close DXE dispatch Event\r
601 //\r
602 CoreCloseEvent (DxeDispatchEvent);\r
603\r
28a00297 604 gDispatcherRunning = FALSE;\r
605\r
606 return ReturnStatus;\r
607}\r
608\r
28a00297 609\r
162ed594 610/**\r
611 Insert InsertedDriverEntry onto the mScheduledQueue. To do this you\r
28a00297 612 must add any driver with a before dependency on InsertedDriverEntry first.\r
613 You do this by recursively calling this routine. After all the Befores are\r
162ed594 614 processed you can add InsertedDriverEntry to the mScheduledQueue.\r
615 Then you can add any driver with an After dependency on InsertedDriverEntry\r
28a00297 616 by recursively calling this routine.\r
617\r
162ed594 618 @param InsertedDriverEntry The driver to insert on the ScheduledLink Queue\r
28a00297 619\r
162ed594 620**/\r
162ed594 621VOID\r
622CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (\r
623 IN EFI_CORE_DRIVER_ENTRY *InsertedDriverEntry\r
624 )\r
28a00297 625{\r
626 LIST_ENTRY *Link;\r
627 EFI_CORE_DRIVER_ENTRY *DriverEntry;\r
628\r
629 //\r
630 // Process Before Dependency\r
631 //\r
632 for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
633 DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
6a55eea3 634 if (DriverEntry->Before && DriverEntry->Dependent && DriverEntry != InsertedDriverEntry) {\r
635 DEBUG ((DEBUG_DISPATCH, "Evaluate DXE DEPEX for FFS(%g)\n", &DriverEntry->FileName));\r
636 DEBUG ((DEBUG_DISPATCH, " BEFORE FFS(%g) = ", &DriverEntry->BeforeAfterGuid));\r
28a00297 637 if (CompareGuid (&InsertedDriverEntry->FileName, &DriverEntry->BeforeAfterGuid)) {\r
638 //\r
639 // Recursively process BEFORE\r
640 //\r
6a55eea3 641 DEBUG ((DEBUG_DISPATCH, "TRUE\n END\n RESULT = TRUE\n"));\r
28a00297 642 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry);\r
6a55eea3 643 } else {\r
644 DEBUG ((DEBUG_DISPATCH, "FALSE\n END\n RESULT = FALSE\n"));\r
28a00297 645 }\r
646 }\r
647 }\r
648\r
649 //\r
650 // Convert driver from Dependent to Scheduled state\r
651 //\r
652 CoreAcquireDispatcherLock ();\r
653\r
654 InsertedDriverEntry->Dependent = FALSE;\r
655 InsertedDriverEntry->Scheduled = TRUE;\r
656 InsertTailList (&mScheduledQueue, &InsertedDriverEntry->ScheduledLink);\r
022c6d45 657\r
28a00297 658 CoreReleaseDispatcherLock ();\r
659\r
660 //\r
661 // Process After Dependency\r
662 //\r
663 for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
664 DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
6a55eea3 665 if (DriverEntry->After && DriverEntry->Dependent && DriverEntry != InsertedDriverEntry) {\r
666 DEBUG ((DEBUG_DISPATCH, "Evaluate DXE DEPEX for FFS(%g)\n", &DriverEntry->FileName));\r
667 DEBUG ((DEBUG_DISPATCH, " AFTER FFS(%g) = ", &DriverEntry->BeforeAfterGuid));\r
28a00297 668 if (CompareGuid (&InsertedDriverEntry->FileName, &DriverEntry->BeforeAfterGuid)) {\r
669 //\r
670 // Recursively process AFTER\r
671 //\r
6a55eea3 672 DEBUG ((DEBUG_DISPATCH, "TRUE\n END\n RESULT = TRUE\n"));\r
28a00297 673 CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry);\r
6a55eea3 674 } else {\r
675 DEBUG ((DEBUG_DISPATCH, "FALSE\n END\n RESULT = FALSE\n"));\r
28a00297 676 }\r
677 }\r
678 }\r
679}\r
680\r
28a00297 681\r
162ed594 682/**\r
28a00297 683 Return TRUE if the Fv has been processed, FALSE if not.\r
684\r
022c6d45 685 @param FvHandle The handle of a FV that's being tested\r
28a00297 686\r
022c6d45 687 @retval TRUE Fv protocol on FvHandle has been processed\r
e94a9ff7 688 @retval FALSE Fv protocol on FvHandle has not yet been processed\r
28a00297 689\r
162ed594 690**/\r
162ed594 691BOOLEAN\r
692FvHasBeenProcessed (\r
693 IN EFI_HANDLE FvHandle\r
694 )\r
28a00297 695{\r
696 LIST_ENTRY *Link;\r
697 KNOWN_HANDLE *KnownHandle;\r
698\r
699 for (Link = mFvHandleList.ForwardLink; Link != &mFvHandleList; Link = Link->ForwardLink) {\r
700 KnownHandle = CR(Link, KNOWN_HANDLE, Link, KNOWN_HANDLE_SIGNATURE);\r
701 if (KnownHandle->Handle == FvHandle) {\r
702 return TRUE;\r
703 }\r
704 }\r
705 return FALSE;\r
706}\r
707\r
28a00297 708\r
162ed594 709/**\r
28a00297 710 Remember that Fv protocol on FvHandle has had it's drivers placed on the\r
2fc46f86
LG
711 mDiscoveredList. This fucntion adds entries on the mFvHandleList if new \r
712 entry is different from one in mFvHandleList by checking FvImage Guid.\r
713 Items are never removed/freed from the mFvHandleList.\r
28a00297 714\r
162ed594 715 @param FvHandle The handle of a FV that has been processed\r
28a00297 716\r
2fc46f86
LG
717 @return A point to new added FvHandle entry. If FvHandle with the same FvImage guid\r
718 has been added, NULL will return. \r
719\r
162ed594 720**/\r
2fc46f86 721KNOWN_HANDLE * \r
162ed594 722FvIsBeingProcesssed (\r
723 IN EFI_HANDLE FvHandle\r
724 )\r
28a00297 725{\r
2fc46f86
LG
726 EFI_STATUS Status;\r
727 EFI_GUID FvNameGuid;\r
728 BOOLEAN FvNameGuidIsFound;\r
729 UINT32 ExtHeaderOffset;\r
730 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;\r
731 EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
732 EFI_FV_BLOCK_MAP_ENTRY *BlockMap;\r
733 UINTN LbaOffset;\r
734 UINTN Index;\r
735 EFI_LBA LbaIndex;\r
736 LIST_ENTRY *Link;\r
737 KNOWN_HANDLE *KnownHandle;\r
738\r
ac30bca0
SZ
739 FwVolHeader = NULL;\r
740\r
2fc46f86
LG
741 //\r
742 // Get the FirmwareVolumeBlock protocol on that handle\r
743 //\r
744 FvNameGuidIsFound = FALSE;\r
745 Status = CoreHandleProtocol (FvHandle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **)&Fvb);\r
746 if (!EFI_ERROR (Status)) {\r
747 //\r
748 // Get the full FV header based on FVB protocol.\r
749 //\r
bdc9d5a5 750 ASSERT (Fvb != NULL);\r
2fc46f86 751 Status = GetFwVolHeader (Fvb, &FwVolHeader);\r
bdc9d5a5
LG
752 if (!EFI_ERROR (Status)) {\r
753 ASSERT (FwVolHeader != NULL);\r
754 if (VerifyFvHeaderChecksum (FwVolHeader) && FwVolHeader->ExtHeaderOffset != 0) {\r
755 ExtHeaderOffset = (UINT32) FwVolHeader->ExtHeaderOffset;\r
756 BlockMap = FwVolHeader->BlockMap;\r
757 LbaIndex = 0;\r
758 LbaOffset = 0;\r
759 //\r
760 // Find LbaIndex and LbaOffset for FV extension header based on BlockMap.\r
761 //\r
762 while ((BlockMap->NumBlocks != 0) || (BlockMap->Length != 0)) {\r
763 for (Index = 0; Index < BlockMap->NumBlocks && ExtHeaderOffset >= BlockMap->Length; Index ++) {\r
764 ExtHeaderOffset -= BlockMap->Length;\r
765 LbaIndex ++;\r
766 }\r
767 //\r
768 // Check whether FvExtHeader is crossing the multi block range.\r
769 //\r
770 if (Index < BlockMap->NumBlocks) {\r
771 LbaOffset = ExtHeaderOffset;\r
772 break;\r
773 }\r
774 BlockMap++;\r
2fc46f86
LG
775 }\r
776 //\r
bdc9d5a5 777 // Read FvNameGuid from FV extension header.\r
2fc46f86 778 //\r
bdc9d5a5
LG
779 Status = ReadFvbData (Fvb, &LbaIndex, &LbaOffset, sizeof (FvNameGuid), (UINT8 *) &FvNameGuid);\r
780 if (!EFI_ERROR (Status)) {\r
781 FvNameGuidIsFound = TRUE;\r
2fc46f86 782 }\r
2fc46f86 783 }\r
bdc9d5a5 784 CoreFreePool (FwVolHeader);\r
2fc46f86 785 }\r
2fc46f86
LG
786 }\r
787\r
788 if (FvNameGuidIsFound) {\r
789 //\r
790 // Check whether the FV image with the found FvNameGuid has been processed.\r
791 //\r
792 for (Link = mFvHandleList.ForwardLink; Link != &mFvHandleList; Link = Link->ForwardLink) {\r
793 KnownHandle = CR(Link, KNOWN_HANDLE, Link, KNOWN_HANDLE_SIGNATURE);\r
794 if (CompareGuid (&FvNameGuid, &KnownHandle->FvNameGuid)) {\r
795 DEBUG ((EFI_D_ERROR, "FvImage on FvHandle %p and %p has the same FvNameGuid %g.\n", FvHandle, KnownHandle->Handle, FvNameGuid));\r
796 return NULL;\r
797 }\r
798 }\r
799 }\r
28a00297 800\r
2fc46f86 801 KnownHandle = AllocateZeroPool (sizeof (KNOWN_HANDLE));\r
28a00297 802 ASSERT (KnownHandle != NULL);\r
803\r
804 KnownHandle->Signature = KNOWN_HANDLE_SIGNATURE;\r
805 KnownHandle->Handle = FvHandle;\r
2fc46f86
LG
806 if (FvNameGuidIsFound) {\r
807 CopyGuid (&KnownHandle->FvNameGuid, &FvNameGuid);\r
808 }\r
28a00297 809 InsertTailList (&mFvHandleList, &KnownHandle->Link);\r
2fc46f86 810 return KnownHandle;\r
28a00297 811}\r
812\r
813\r
814\r
162ed594 815\r
816/**\r
817 Convert FvHandle and DriverName into an EFI device path\r
818\r
022c6d45 819 @param Fv Fv protocol, needed to read Depex info out of\r
820 FLASH.\r
821 @param FvHandle Handle for Fv, needed in the\r
822 EFI_CORE_DRIVER_ENTRY so that the PE image can be\r
823 read out of the FV at a later time.\r
824 @param DriverName Name of driver to add to mDiscoveredList.\r
162ed594 825\r
826 @return Pointer to device path constructed from FvHandle and DriverName\r
827\r
828**/\r
28a00297 829EFI_DEVICE_PATH_PROTOCOL *\r
830CoreFvToDevicePath (\r
0c2b5da8 831 IN EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv,\r
28a00297 832 IN EFI_HANDLE FvHandle,\r
833 IN EFI_GUID *DriverName\r
834 )\r
28a00297 835{\r
836 EFI_STATUS Status;\r
837 EFI_DEVICE_PATH_PROTOCOL *FvDevicePath;\r
838 EFI_DEVICE_PATH_PROTOCOL *FileNameDevicePath;\r
839\r
840 //\r
841 // Remember the device path of the FV\r
842 //\r
843 Status = CoreHandleProtocol (FvHandle, &gEfiDevicePathProtocolGuid, (VOID **)&FvDevicePath);\r
844 if (EFI_ERROR (Status)) {\r
845 FileNameDevicePath = NULL;\r
846 } else {\r
847 //\r
848 // Build a device path to the file in the FV to pass into gBS->LoadImage\r
849 //\r
850 EfiInitializeFwVolDevicepathNode (&mFvDevicePath.File, DriverName);\r
1232b214 851 SetDevicePathEndNode (&mFvDevicePath.End);\r
28a00297 852\r
9c4ac31c 853 FileNameDevicePath = AppendDevicePath (\r
022c6d45 854 FvDevicePath,\r
28a00297 855 (EFI_DEVICE_PATH_PROTOCOL *)&mFvDevicePath\r
856 );\r
857 }\r
858\r
859 return FileNameDevicePath;\r
860}\r
861\r
862\r
863\r
162ed594 864/**\r
865 Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,\r
28a00297 866 and initilize any state variables. Read the Depex from the FV and store it\r
867 in DriverEntry. Pre-process the Depex to set the SOR, Before and After state.\r
868 The Discovered list is never free'ed and contains booleans that represent the\r
869 other possible DXE driver states.\r
870\r
022c6d45 871 @param Fv Fv protocol, needed to read Depex info out of\r
872 FLASH.\r
873 @param FvHandle Handle for Fv, needed in the\r
874 EFI_CORE_DRIVER_ENTRY so that the PE image can be\r
875 read out of the FV at a later time.\r
876 @param DriverName Name of driver to add to mDiscoveredList.\r
d3592549 877 @param Type Fv File Type of file to add to mDiscoveredList.\r
28a00297 878\r
022c6d45 879 @retval EFI_SUCCESS If driver was added to the mDiscoveredList.\r
880 @retval EFI_ALREADY_STARTED The driver has already been started. Only one\r
881 DriverName may be active in the system at any one\r
162ed594 882 time.\r
28a00297 883\r
162ed594 884**/\r
885EFI_STATUS\r
886CoreAddToDriverList (\r
887 IN EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv,\r
888 IN EFI_HANDLE FvHandle,\r
d3592549
LG
889 IN EFI_GUID *DriverName,\r
890 IN EFI_FV_FILETYPE Type\r
162ed594 891 )\r
28a00297 892{\r
893 EFI_CORE_DRIVER_ENTRY *DriverEntry;\r
894\r
022c6d45 895\r
28a00297 896 //\r
022c6d45 897 // Create the Driver Entry for the list. ZeroPool initializes lots of variables to\r
28a00297 898 // NULL or FALSE.\r
899 //\r
9c4ac31c 900 DriverEntry = AllocateZeroPool (sizeof (EFI_CORE_DRIVER_ENTRY));\r
28a00297 901 ASSERT (DriverEntry != NULL);\r
d3592549
LG
902 if (Type == EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) {\r
903 DriverEntry->IsFvImage = TRUE;\r
904 }\r
28a00297 905\r
906 DriverEntry->Signature = EFI_CORE_DRIVER_ENTRY_SIGNATURE;\r
e94a9ff7 907 CopyGuid (&DriverEntry->FileName, DriverName);\r
28a00297 908 DriverEntry->FvHandle = FvHandle;\r
909 DriverEntry->Fv = Fv;\r
910 DriverEntry->FvFileDevicePath = CoreFvToDevicePath (Fv, FvHandle, DriverName);\r
911\r
912 CoreGetDepexSectionAndPreProccess (DriverEntry);\r
022c6d45 913\r
28a00297 914 CoreAcquireDispatcherLock ();\r
022c6d45 915\r
28a00297 916 InsertTailList (&mDiscoveredList, &DriverEntry->Link);\r
917\r
918 CoreReleaseDispatcherLock ();\r
919\r
920 return EFI_SUCCESS;\r
921}\r
922\r
bbc0f1bb 923\r
162ed594 924/**\r
bbc0f1bb 925 Check if a FV Image type file (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) is\r
926 described by a EFI_HOB_FIRMWARE_VOLUME2 Hob.\r
927\r
2fc46f86 928 @param FvNameGuid The FV image guid specified.\r
022c6d45 929 @param DriverName The driver guid specified.\r
bbc0f1bb 930\r
022c6d45 931 @retval TRUE This file is found in a EFI_HOB_FIRMWARE_VOLUME2\r
932 Hob.\r
162ed594 933 @retval FALSE Not found.\r
bbc0f1bb 934\r
162ed594 935**/\r
162ed594 936BOOLEAN\r
937FvFoundInHobFv2 (\r
2fc46f86 938 IN CONST EFI_GUID *FvNameGuid,\r
162ed594 939 IN CONST EFI_GUID *DriverName\r
940 )\r
bbc0f1bb 941{\r
942 EFI_PEI_HOB_POINTERS HobFv2;\r
022c6d45 943\r
bbc0f1bb 944 HobFv2.Raw = GetHobList ();\r
022c6d45 945\r
bbc0f1bb 946 while ((HobFv2.Raw = GetNextHob (EFI_HOB_TYPE_FV2, HobFv2.Raw)) != NULL) {\r
2fc46f86
LG
947 //\r
948 // Compare parent FvNameGuid and FileGuid both.\r
949 //\r
950 if (CompareGuid (DriverName, &HobFv2.FirmwareVolume2->FileName) &&\r
951 CompareGuid (FvNameGuid, &HobFv2.FirmwareVolume2->FvName)) {\r
b0d803fe 952 return TRUE;\r
bbc0f1bb 953 }\r
954 HobFv2.Raw = GET_NEXT_HOB (HobFv2);\r
955 }\r
956\r
957 return FALSE;\r
958}\r
28a00297 959\r
960\r
162ed594 961\r
962/**\r
963 Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.\r
964\r
022c6d45 965 @param Fv The FIRMWARE_VOLUME protocol installed on the FV.\r
966 @param FvHandle The handle which FVB protocol installed on.\r
967 @param DriverName The driver guid specified.\r
162ed594 968\r
022c6d45 969 @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.\r
970 @retval EFI_VOLUME_CORRUPTED Corrupted volume.\r
162ed594 971 @retval EFI_SUCCESS Function successfully returned.\r
972\r
973**/\r
022c6d45 974EFI_STATUS\r
28a00297 975CoreProcessFvImageFile (\r
0c2b5da8 976 IN EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv,\r
28a00297 977 IN EFI_HANDLE FvHandle,\r
978 IN EFI_GUID *DriverName\r
979 )\r
28a00297 980{\r
981 EFI_STATUS Status;\r
982 EFI_SECTION_TYPE SectionType;\r
983 UINT32 AuthenticationStatus;\r
984 VOID *Buffer;\r
38837959 985 VOID *AlignedBuffer;\r
28a00297 986 UINTN BufferSize;\r
38837959 987 EFI_FIRMWARE_VOLUME_HEADER *FvHeader;\r
022c6d45 988 UINT32 FvAlignment;\r
022ff6bb 989 EFI_DEVICE_PATH_PROTOCOL *FvFileDevicePath;\r
28a00297 990\r
991 //\r
992 // Read the first (and only the first) firmware volume section\r
993 //\r
e94a9ff7 994 SectionType = EFI_SECTION_FIRMWARE_VOLUME_IMAGE;\r
995 FvHeader = NULL;\r
996 FvAlignment = 0;\r
997 Buffer = NULL;\r
998 BufferSize = 0;\r
38837959 999 AlignedBuffer = NULL;\r
28a00297 1000 Status = Fv->ReadSection (\r
022c6d45 1001 Fv,\r
1002 DriverName,\r
1003 SectionType,\r
1004 0,\r
1005 &Buffer,\r
e94a9ff7 1006 &BufferSize,\r
1007 &AuthenticationStatus\r
1008 );\r
28a00297 1009 if (!EFI_ERROR (Status)) {\r
022ff6bb
SZ
1010 //\r
1011 // Evaluate the authentication status of the Firmware Volume through\r
1012 // Security Architectural Protocol\r
1013 //\r
1014 if (gSecurity != NULL) {\r
1015 FvFileDevicePath = CoreFvToDevicePath (Fv, FvHandle, DriverName);\r
1016 Status = gSecurity->FileAuthenticationState (\r
1017 gSecurity,\r
1018 AuthenticationStatus,\r
1019 FvFileDevicePath\r
1020 );\r
1021 if (FvFileDevicePath != NULL) {\r
1022 FreePool (FvFileDevicePath);\r
1023 }\r
1024\r
1025 if (Status != EFI_SUCCESS) {\r
1026 //\r
1027 // Security check failed. The firmware volume should not be used for any purpose.\r
1028 //\r
1029 if (Buffer != NULL) {\r
1030 FreePool (Buffer);\r
1031 }\r
1032 return Status;\r
1033 }\r
1034 }\r
1035\r
28a00297 1036 //\r
38837959 1037 // FvImage should be at its required alignment.\r
28a00297 1038 //\r
38837959 1039 FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) Buffer;\r
6d9a0f28 1040 //\r
3837e91c
SZ
1041 // If EFI_FVB2_WEAK_ALIGNMENT is set in the volume header then the first byte of the volume\r
1042 // can be aligned on any power-of-two boundary. A weakly aligned volume can not be moved from\r
1043 // its initial linked location and maintain its alignment.\r
6d9a0f28 1044 //\r
3837e91c 1045 if ((FvHeader->Attributes & EFI_FVB2_WEAK_ALIGNMENT) != EFI_FVB2_WEAK_ALIGNMENT) {\r
38837959 1046 //\r
3837e91c 1047 // Get FvHeader alignment\r
38837959 1048 //\r
3837e91c 1049 FvAlignment = 1 << ((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);\r
38837959 1050 //\r
3837e91c 1051 // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value.\r
38837959 1052 //\r
3837e91c
SZ
1053 if (FvAlignment < 8) {\r
1054 FvAlignment = 8;\r
1055 }\r
1056 //\r
1057 // Allocate the aligned buffer for the FvImage.\r
1058 //\r
1059 AlignedBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), (UINTN) FvAlignment);\r
1060 if (AlignedBuffer == NULL) {\r
1061 FreePool (Buffer);\r
1062 return EFI_OUT_OF_RESOURCES;\r
1063 } else {\r
1064 //\r
1065 // Move FvImage into the aligned buffer and release the original buffer.\r
1066 //\r
1067 CopyMem (AlignedBuffer, Buffer, BufferSize);\r
1068 FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) AlignedBuffer;\r
1069 CoreFreePool (Buffer);\r
1070 Buffer = NULL;\r
1071 }\r
38837959 1072 }\r
3837e91c
SZ
1073 //\r
1074 // Produce a FVB protocol for the file\r
1075 //\r
1076 Status = ProduceFVBProtocolOnBuffer (\r
1077 (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,\r
1078 (UINT64)BufferSize,\r
1079 FvHandle,\r
1080 AuthenticationStatus,\r
1081 NULL\r
1082 );\r
28a00297 1083 }\r
1084\r
022c6d45 1085 if (EFI_ERROR (Status)) {\r
38837959
LG
1086 //\r
1087 // ReadSection or Produce FVB failed, Free data buffer\r
1088 //\r
1089 if (Buffer != NULL) {\r
9c4ac31c 1090 FreePool (Buffer);\r
38837959 1091 }\r
022c6d45 1092\r
38837959 1093 if (AlignedBuffer != NULL) {\r
b2c5e194 1094 FreeAlignedPages (AlignedBuffer, EFI_SIZE_TO_PAGES (BufferSize));\r
38837959 1095 }\r
28a00297 1096 }\r
1097\r
1098 return Status;\r
1099}\r
1100\r
28a00297 1101\r
162ed594 1102/**\r
1103 Event notification that is fired every time a FV dispatch protocol is added.\r
28a00297 1104 More than one protocol may have been added when this event is fired, so you\r
1105 must loop on CoreLocateHandle () to see how many protocols were added and\r
1106 do the following to each FV:\r
162ed594 1107 If the Fv has already been processed, skip it. If the Fv has not been\r
28a00297 1108 processed then mark it as being processed, as we are about to process it.\r
162ed594 1109 Read the Fv and add any driver in the Fv to the mDiscoveredList.The\r
28a00297 1110 mDiscoveredList is never free'ed and contains variables that define\r
162ed594 1111 the other states the DXE driver transitions to..\r
28a00297 1112 While you are at it read the A Priori file into memory.\r
1113 Place drivers in the A Priori list onto the mScheduledQueue.\r
1114\r
022c6d45 1115 @param Event The Event that is being processed, not used.\r
162ed594 1116 @param Context Event Context, not used.\r
28a00297 1117\r
162ed594 1118**/\r
162ed594 1119VOID\r
1120EFIAPI\r
1121CoreFwVolEventProtocolNotify (\r
1122 IN EFI_EVENT Event,\r
1123 IN VOID *Context\r
1124 )\r
28a00297 1125{\r
1126 EFI_STATUS Status;\r
1127 EFI_STATUS GetNextFileStatus;\r
0c2b5da8 1128 EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
28a00297 1129 EFI_DEVICE_PATH_PROTOCOL *FvDevicePath;\r
1130 EFI_HANDLE FvHandle;\r
1131 UINTN BufferSize;\r
1132 EFI_GUID NameGuid;\r
1133 UINTN Key;\r
1134 EFI_FV_FILETYPE Type;\r
1135 EFI_FV_FILE_ATTRIBUTES Attributes;\r
1136 UINTN Size;\r
1137 EFI_CORE_DRIVER_ENTRY *DriverEntry;\r
1138 EFI_GUID *AprioriFile;\r
1139 UINTN AprioriEntryCount;\r
1140 UINTN Index;\r
1141 LIST_ENTRY *Link;\r
1142 UINT32 AuthenticationStatus;\r
1143 UINTN SizeOfBuffer;\r
d3592549 1144 VOID *DepexBuffer;\r
2fc46f86 1145 KNOWN_HANDLE *KnownHandle;\r
28a00297 1146\r
4e1005ec
ED
1147 FvHandle = NULL;\r
1148\r
28a00297 1149 while (TRUE) {\r
1150 BufferSize = sizeof (EFI_HANDLE);\r
1151 Status = CoreLocateHandle (\r
e94a9ff7 1152 ByRegisterNotify,\r
1153 NULL,\r
1154 mFwVolEventRegistration,\r
1155 &BufferSize,\r
1156 &FvHandle\r
1157 );\r
28a00297 1158 if (EFI_ERROR (Status)) {\r
1159 //\r
1160 // If no more notification events exit\r
1161 //\r
1162 return;\r
1163 }\r
1164\r
1165 if (FvHasBeenProcessed (FvHandle)) {\r
1166 //\r
1167 // This Fv has already been processed so lets skip it!\r
1168 //\r
1169 continue;\r
1170 }\r
1171\r
28a00297 1172 //\r
1173 // Since we are about to process this Fv mark it as processed.\r
1174 //\r
2fc46f86
LG
1175 KnownHandle = FvIsBeingProcesssed (FvHandle);\r
1176 if (KnownHandle == NULL) {\r
1177 //\r
1178 // The FV with the same FV name guid has already been processed. \r
1179 // So lets skip it!\r
1180 //\r
1181 continue;\r
1182 }\r
28a00297 1183\r
0c2b5da8 1184 Status = CoreHandleProtocol (FvHandle, &gEfiFirmwareVolume2ProtocolGuid, (VOID **)&Fv);\r
d2fbaaab 1185 if (EFI_ERROR (Status) || Fv == NULL) {\r
28a00297 1186 //\r
cd539d48 1187 // FvHandle must have Firmware Volume2 protocol thus we should never get here.\r
28a00297 1188 //\r
1189 ASSERT (FALSE);\r
1190 continue;\r
1191 }\r
022c6d45 1192\r
28a00297 1193 Status = CoreHandleProtocol (FvHandle, &gEfiDevicePathProtocolGuid, (VOID **)&FvDevicePath);\r
1194 if (EFI_ERROR (Status)) {\r
1195 //\r
1196 // The Firmware volume doesn't have device path, can't be dispatched.\r
1197 //\r
1198 continue;\r
1199 }\r
022c6d45 1200\r
28a00297 1201 //\r
022c6d45 1202 // Discover Drivers in FV and add them to the Discovered Driver List.\r
1203 // Process EFI_FV_FILETYPE_DRIVER type and then EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER\r
28a00297 1204 // EFI_FV_FILETYPE_DXE_CORE is processed to produce a Loaded Image protocol for the core\r
1205 // EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE is processed to create a Fvb\r
1206 //\r
e94a9ff7 1207 for (Index = 0; Index < sizeof (mDxeFileTypes) / sizeof (EFI_FV_FILETYPE); Index++) {\r
28a00297 1208 //\r
1209 // Initialize the search key\r
1210 //\r
1211 Key = 0;\r
1212 do {\r
1213 Type = mDxeFileTypes[Index];\r
1214 GetNextFileStatus = Fv->GetNextFile (\r
022c6d45 1215 Fv,\r
28a00297 1216 &Key,\r
022c6d45 1217 &Type,\r
1218 &NameGuid,\r
1219 &Attributes,\r
28a00297 1220 &Size\r
1221 );\r
1222 if (!EFI_ERROR (GetNextFileStatus)) {\r
1223 if (Type == EFI_FV_FILETYPE_DXE_CORE) {\r
1224 //\r
1225 // If this is the DXE core fill in it's DevicePath & DeviceHandle\r
1226 //\r
1227 if (gDxeCoreLoadedImage->FilePath == NULL) {\r
1228 if (CompareGuid (&NameGuid, gDxeCoreFileName)) {\r
1229 //\r
1230 // Maybe One specail Fv cantains only one DXE_CORE module, so its device path must\r
1231 // be initialized completely.\r
1232 //\r
1233 EfiInitializeFwVolDevicepathNode (&mFvDevicePath.File, &NameGuid);\r
1232b214 1234 SetDevicePathEndNode (&mFvDevicePath.End);\r
28a00297 1235\r
9c4ac31c 1236 gDxeCoreLoadedImage->FilePath = DuplicateDevicePath (\r
28a00297 1237 (EFI_DEVICE_PATH_PROTOCOL *)&mFvDevicePath\r
1238 );\r
1239 gDxeCoreLoadedImage->DeviceHandle = FvHandle;\r
1240 }\r
1241 }\r
1242 } else if (Type == EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) {\r
bbc0f1bb 1243 //\r
022c6d45 1244 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already\r
bbc0f1bb 1245 // been extracted.\r
1246 //\r
2fc46f86 1247 if (FvFoundInHobFv2 (&KnownHandle->FvNameGuid, &NameGuid)) {\r
bbc0f1bb 1248 continue;\r
1249 }\r
d3592549 1250\r
28a00297 1251 //\r
d3592549 1252 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has SMM depex section.\r
28a00297 1253 //\r
d3592549
LG
1254 DepexBuffer = NULL;\r
1255 SizeOfBuffer = 0;\r
1256 Status = Fv->ReadSection (\r
1257 Fv,\r
1258 &NameGuid,\r
1259 EFI_SECTION_SMM_DEPEX,\r
1260 0,\r
1261 &DepexBuffer,\r
1262 &SizeOfBuffer,\r
1263 &AuthenticationStatus\r
1264 );\r
1265 if (!EFI_ERROR (Status)) {\r
1266 //\r
c74a25f0
LG
1267 // If SMM depex section is found, this FV image is invalid to be supported.\r
1268 // ASSERT FALSE to report this FV image. \r
d3592549
LG
1269 //\r
1270 FreePool (DepexBuffer);\r
c74a25f0 1271 ASSERT (FALSE);\r
d3592549
LG
1272 }\r
1273\r
1274 //\r
1275 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has DXE depex section.\r
1276 //\r
1277 DepexBuffer = NULL;\r
1278 SizeOfBuffer = 0;\r
1279 Status = Fv->ReadSection (\r
1280 Fv,\r
1281 &NameGuid,\r
1282 EFI_SECTION_DXE_DEPEX,\r
1283 0,\r
1284 &DepexBuffer,\r
1285 &SizeOfBuffer,\r
1286 &AuthenticationStatus\r
1287 );\r
1288 if (EFI_ERROR (Status)) {\r
1289 //\r
1290 // If no depex section, produce a firmware volume block protocol for it so it gets dispatched from. \r
1291 //\r
1292 CoreProcessFvImageFile (Fv, FvHandle, &NameGuid);\r
1293 } else {\r
1294 //\r
1295 // If depex section is found, this FV image will be dispatched until its depex is evaluated to TRUE.\r
1296 //\r
1297 FreePool (DepexBuffer);\r
1298 CoreAddToDriverList (Fv, FvHandle, &NameGuid, Type);\r
1299 }\r
28a00297 1300 } else {\r
1301 //\r
1302 // Transition driver from Undiscovered to Discovered state\r
1303 //\r
d3592549 1304 CoreAddToDriverList (Fv, FvHandle, &NameGuid, Type);\r
28a00297 1305 }\r
1306 }\r
1307 } while (!EFI_ERROR (GetNextFileStatus));\r
1308 }\r
022c6d45 1309\r
28a00297 1310 //\r
1311 // Read the array of GUIDs from the Apriori file if it is present in the firmware volume\r
1312 //\r
1313 AprioriFile = NULL;\r
1314 Status = Fv->ReadSection (\r
1315 Fv,\r
1316 &gAprioriGuid,\r
1317 EFI_SECTION_RAW,\r
1318 0,\r
1319 (VOID **)&AprioriFile,\r
1320 &SizeOfBuffer,\r
1321 &AuthenticationStatus\r
1322 );\r
1323 if (!EFI_ERROR (Status)) {\r
1324 AprioriEntryCount = SizeOfBuffer / sizeof (EFI_GUID);\r
1325 } else {\r
1326 AprioriEntryCount = 0;\r
1327 }\r
1328\r
1329 //\r
1330 // Put drivers on Apriori List on the Scheduled queue. The Discovered List includes\r
1331 // drivers not in the current FV and these must be skipped since the a priori list\r
1332 // is only valid for the FV that it resided in.\r
1333 //\r
022c6d45 1334\r
28a00297 1335 for (Index = 0; Index < AprioriEntryCount; Index++) {\r
1336 for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
1337 DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
1338 if (CompareGuid (&DriverEntry->FileName, &AprioriFile[Index]) &&\r
1339 (FvHandle == DriverEntry->FvHandle)) {\r
6a55eea3 1340 CoreAcquireDispatcherLock ();\r
28a00297 1341 DriverEntry->Dependent = FALSE;\r
1342 DriverEntry->Scheduled = TRUE;\r
1343 InsertTailList (&mScheduledQueue, &DriverEntry->ScheduledLink);\r
6a55eea3 1344 CoreReleaseDispatcherLock ();\r
1345 DEBUG ((DEBUG_DISPATCH, "Evaluate DXE DEPEX for FFS(%g)\n", &DriverEntry->FileName));\r
1346 DEBUG ((DEBUG_DISPATCH, " RESULT = TRUE (Apriori)\n"));\r
28a00297 1347 break;\r
1348 }\r
1349 }\r
1350 }\r
1351\r
28a00297 1352 //\r
022c6d45 1353 // Free data allocated by Fv->ReadSection ()\r
28a00297 1354 //\r
022c6d45 1355 CoreFreePool (AprioriFile);\r
28a00297 1356 }\r
1357}\r
1358\r
1359\r
28a00297 1360\r
162ed594 1361/**\r
28a00297 1362 Initialize the dispatcher. Initialize the notification function that runs when\r
e94a9ff7 1363 an FV2 protocol is added to the system.\r
28a00297 1364\r
162ed594 1365**/\r
1366VOID\r
1367CoreInitializeDispatcher (\r
1368 VOID\r
1369 )\r
28a00297 1370{\r
7899b797 1371 mFwVolEvent = EfiCreateProtocolNotifyEvent (\r
022c6d45 1372 &gEfiFirmwareVolume2ProtocolGuid,\r
28a00297 1373 TPL_CALLBACK,\r
1374 CoreFwVolEventProtocolNotify,\r
1375 NULL,\r
7899b797 1376 &mFwVolEventRegistration\r
28a00297 1377 );\r
1378}\r
1379\r
1380//\r
1381// Function only used in debug builds\r
1382//\r
162ed594 1383\r
1384/**\r
1385 Traverse the discovered list for any drivers that were discovered but not loaded\r
1386 because the dependency experessions evaluated to false.\r
1387\r
1388**/\r
28a00297 1389VOID\r
1390CoreDisplayDiscoveredNotDispatched (\r
1391 VOID\r
1392 )\r
28a00297 1393{\r
1394 LIST_ENTRY *Link;\r
1395 EFI_CORE_DRIVER_ENTRY *DriverEntry;\r
1396\r
1397 for (Link = mDiscoveredList.ForwardLink;Link !=&mDiscoveredList; Link = Link->ForwardLink) {\r
1398 DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
1399 if (DriverEntry->Dependent) {\r
162ed594 1400 DEBUG ((DEBUG_LOAD, "Driver %g was discovered but not loaded!!\n", &DriverEntry->FileName));\r
28a00297 1401 }\r
1402 }\r
1403}\r