]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Core/Dxe/DxeMain/DxeMain.c
Cleanup HOB DEBUG prints
[mirror_edk2.git] / MdeModulePkg / Core / Dxe / DxeMain / DxeMain.c
1 /** @file
2 DXE Core Main Entry Point
3
4 Copyright (c) 2006 - 2010, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "DxeMain.h"
16
17 //
18 // DXE Core Global Variables for Protocols from PEI
19 //
20 EFI_HANDLE mDecompressHandle = NULL;
21
22 //
23 // DXE Core globals for Architecture Protocols
24 //
25 EFI_SECURITY_ARCH_PROTOCOL *gSecurity = NULL;
26 EFI_CPU_ARCH_PROTOCOL *gCpu = NULL;
27 EFI_METRONOME_ARCH_PROTOCOL *gMetronome = NULL;
28 EFI_TIMER_ARCH_PROTOCOL *gTimer = NULL;
29 EFI_BDS_ARCH_PROTOCOL *gBds = NULL;
30 EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *gWatchdogTimer = NULL;
31
32 //
33 // DXE Core globals for optional protocol dependencies
34 //
35 EFI_SMM_BASE2_PROTOCOL *gSmmBase2 = NULL;
36
37 //
38 // DXE Core Global used to update core loaded image protocol handle
39 //
40 EFI_GUID *gDxeCoreFileName;
41 EFI_LOADED_IMAGE_PROTOCOL *gDxeCoreLoadedImage;
42
43 //
44 // DXE Core Module Variables
45 //
46 EFI_BOOT_SERVICES mBootServices = {
47 {
48 EFI_BOOT_SERVICES_SIGNATURE, // Signature
49 EFI_BOOT_SERVICES_REVISION, // Revision
50 sizeof (EFI_BOOT_SERVICES), // HeaderSize
51 0, // CRC32
52 0 // Reserved
53 },
54 (EFI_RAISE_TPL) CoreRaiseTpl, // RaiseTPL
55 (EFI_RESTORE_TPL) CoreRestoreTpl, // RestoreTPL
56 (EFI_ALLOCATE_PAGES) CoreAllocatePages, // AllocatePages
57 (EFI_FREE_PAGES) CoreFreePages, // FreePages
58 (EFI_GET_MEMORY_MAP) CoreGetMemoryMap, // GetMemoryMap
59 (EFI_ALLOCATE_POOL) CoreAllocatePool, // AllocatePool
60 (EFI_FREE_POOL) CoreFreePool, // FreePool
61 (EFI_CREATE_EVENT) CoreCreateEvent, // CreateEvent
62 (EFI_SET_TIMER) CoreSetTimer, // SetTimer
63 (EFI_WAIT_FOR_EVENT) CoreWaitForEvent, // WaitForEvent
64 (EFI_SIGNAL_EVENT) CoreSignalEvent, // SignalEvent
65 (EFI_CLOSE_EVENT) CoreCloseEvent, // CloseEvent
66 (EFI_CHECK_EVENT) CoreCheckEvent, // CheckEvent
67 (EFI_INSTALL_PROTOCOL_INTERFACE) CoreInstallProtocolInterface, // InstallProtocolInterface
68 (EFI_REINSTALL_PROTOCOL_INTERFACE) CoreReinstallProtocolInterface, // ReinstallProtocolInterface
69 (EFI_UNINSTALL_PROTOCOL_INTERFACE) CoreUninstallProtocolInterface, // UninstallProtocolInterface
70 (EFI_HANDLE_PROTOCOL) CoreHandleProtocol, // HandleProtocol
71 (VOID *) NULL, // Reserved
72 (EFI_REGISTER_PROTOCOL_NOTIFY) CoreRegisterProtocolNotify, // RegisterProtocolNotify
73 (EFI_LOCATE_HANDLE) CoreLocateHandle, // LocateHandle
74 (EFI_LOCATE_DEVICE_PATH) CoreLocateDevicePath, // LocateDevicePath
75 (EFI_INSTALL_CONFIGURATION_TABLE) CoreInstallConfigurationTable, // InstallConfigurationTable
76 (EFI_IMAGE_LOAD) CoreLoadImage, // LoadImage
77 (EFI_IMAGE_START) CoreStartImage, // StartImage
78 (EFI_EXIT) CoreExit, // Exit
79 (EFI_IMAGE_UNLOAD) CoreUnloadImage, // UnloadImage
80 (EFI_EXIT_BOOT_SERVICES) CoreExitBootServices, // ExitBootServices
81 (EFI_GET_NEXT_MONOTONIC_COUNT) CoreEfiNotAvailableYetArg1, // GetNextMonotonicCount
82 (EFI_STALL) CoreStall, // Stall
83 (EFI_SET_WATCHDOG_TIMER) CoreSetWatchdogTimer, // SetWatchdogTimer
84 (EFI_CONNECT_CONTROLLER) CoreConnectController, // ConnectController
85 (EFI_DISCONNECT_CONTROLLER) CoreDisconnectController, // DisconnectController
86 (EFI_OPEN_PROTOCOL) CoreOpenProtocol, // OpenProtocol
87 (EFI_CLOSE_PROTOCOL) CoreCloseProtocol, // CloseProtocol
88 (EFI_OPEN_PROTOCOL_INFORMATION) CoreOpenProtocolInformation, // OpenProtocolInformation
89 (EFI_PROTOCOLS_PER_HANDLE) CoreProtocolsPerHandle, // ProtocolsPerHandle
90 (EFI_LOCATE_HANDLE_BUFFER) CoreLocateHandleBuffer, // LocateHandleBuffer
91 (EFI_LOCATE_PROTOCOL) CoreLocateProtocol, // LocateProtocol
92 (EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES) CoreInstallMultipleProtocolInterfaces, // InstallMultipleProtocolInterfaces
93 (EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES) CoreUninstallMultipleProtocolInterfaces, // UninstallMultipleProtocolInterfaces
94 (EFI_CALCULATE_CRC32) CoreEfiNotAvailableYetArg3, // CalculateCrc32
95 (EFI_COPY_MEM) CopyMem, // CopyMem
96 (EFI_SET_MEM) SetMem, // SetMem
97 (EFI_CREATE_EVENT_EX) CoreCreateEventEx // CreateEventEx
98 };
99
100 EFI_DXE_SERVICES mDxeServices = {
101 {
102 DXE_SERVICES_SIGNATURE, // Signature
103 DXE_SERVICES_REVISION, // Revision
104 sizeof (DXE_SERVICES), // HeaderSize
105 0, // CRC32
106 0 // Reserved
107 },
108 (EFI_ADD_MEMORY_SPACE) CoreAddMemorySpace, // AddMemorySpace
109 (EFI_ALLOCATE_MEMORY_SPACE) CoreAllocateMemorySpace, // AllocateMemorySpace
110 (EFI_FREE_MEMORY_SPACE) CoreFreeMemorySpace, // FreeMemorySpace
111 (EFI_REMOVE_MEMORY_SPACE) CoreRemoveMemorySpace, // RemoveMemorySpace
112 (EFI_GET_MEMORY_SPACE_DESCRIPTOR) CoreGetMemorySpaceDescriptor, // GetMemorySpaceDescriptor
113 (EFI_SET_MEMORY_SPACE_ATTRIBUTES) CoreSetMemorySpaceAttributes, // SetMemorySpaceAttributes
114 (EFI_GET_MEMORY_SPACE_MAP) CoreGetMemorySpaceMap, // GetMemorySpaceMap
115 (EFI_ADD_IO_SPACE) CoreAddIoSpace, // AddIoSpace
116 (EFI_ALLOCATE_IO_SPACE) CoreAllocateIoSpace, // AllocateIoSpace
117 (EFI_FREE_IO_SPACE) CoreFreeIoSpace, // FreeIoSpace
118 (EFI_REMOVE_IO_SPACE) CoreRemoveIoSpace, // RemoveIoSpace
119 (EFI_GET_IO_SPACE_DESCRIPTOR) CoreGetIoSpaceDescriptor, // GetIoSpaceDescriptor
120 (EFI_GET_IO_SPACE_MAP) CoreGetIoSpaceMap, // GetIoSpaceMap
121 (EFI_DISPATCH) CoreDispatcher, // Dispatch
122 (EFI_SCHEDULE) CoreSchedule, // Schedule
123 (EFI_TRUST) CoreTrust, // Trust
124 (EFI_PROCESS_FIRMWARE_VOLUME) CoreProcessFirmwareVolume, // ProcessFirmwareVolume
125 };
126
127 EFI_SYSTEM_TABLE mEfiSystemTableTemplate = {
128 {
129 EFI_SYSTEM_TABLE_SIGNATURE, // Signature
130 EFI_SYSTEM_TABLE_REVISION, // Revision
131 sizeof (EFI_SYSTEM_TABLE), // HeaderSize
132 0, // CRC32
133 0 // Reserved
134 },
135 NULL, // FirmwareVendor
136 0, // FirmwareRevision
137 NULL, // ConsoleInHandle
138 NULL, // ConIn
139 NULL, // ConsoleOutHandle
140 NULL, // ConOut
141 NULL, // StandardErrorHandle
142 NULL, // StdErr
143 NULL, // RuntimeServices
144 &mBootServices, // BootServices
145 0, // NumberOfConfigurationTableEntries
146 NULL // ConfigurationTable
147 };
148
149 EFI_RUNTIME_SERVICES mEfiRuntimeServicesTableTemplate = {
150 {
151 EFI_RUNTIME_SERVICES_SIGNATURE, // Signature
152 EFI_RUNTIME_SERVICES_REVISION, // Revision
153 sizeof (EFI_RUNTIME_SERVICES), // HeaderSize
154 0, // CRC32
155 0 // Reserved
156 },
157 (EFI_GET_TIME) CoreEfiNotAvailableYetArg2, // GetTime
158 (EFI_SET_TIME) CoreEfiNotAvailableYetArg1, // SetTime
159 (EFI_GET_WAKEUP_TIME) CoreEfiNotAvailableYetArg3, // GetWakeupTime
160 (EFI_SET_WAKEUP_TIME) CoreEfiNotAvailableYetArg2, // SetWakeupTime
161 (EFI_SET_VIRTUAL_ADDRESS_MAP) CoreEfiNotAvailableYetArg4, // SetVirtualAddressMap
162 (EFI_CONVERT_POINTER) CoreEfiNotAvailableYetArg2, // ConvertPointer
163 (EFI_GET_VARIABLE) CoreEfiNotAvailableYetArg5, // GetVariable
164 (EFI_GET_NEXT_VARIABLE_NAME) CoreEfiNotAvailableYetArg3, // GetNextVariableName
165 (EFI_SET_VARIABLE) CoreEfiNotAvailableYetArg5, // SetVariable
166 (EFI_GET_NEXT_HIGH_MONO_COUNT) CoreEfiNotAvailableYetArg1, // GetNextHighMonotonicCount
167 (EFI_RESET_SYSTEM) CoreEfiNotAvailableYetArg4, // ResetSystem
168 (EFI_UPDATE_CAPSULE) CoreEfiNotAvailableYetArg3, // UpdateCapsule
169 (EFI_QUERY_CAPSULE_CAPABILITIES) CoreEfiNotAvailableYetArg4, // QueryCapsuleCapabilities
170 (EFI_QUERY_VARIABLE_INFO) CoreEfiNotAvailableYetArg4 // QueryVariableInfo
171 };
172
173 EFI_RUNTIME_ARCH_PROTOCOL gRuntimeTemplate = {
174 INITIALIZE_LIST_HEAD_VARIABLE (gRuntimeTemplate.ImageHead),
175 INITIALIZE_LIST_HEAD_VARIABLE (gRuntimeTemplate.EventHead),
176
177 //
178 // Make sure Size != sizeof (EFI_MEMORY_DESCRIPTOR). This will
179 // prevent people from having pointer math bugs in their code.
180 // now you have to use *DescriptorSize to make things work.
181 //
182 sizeof (EFI_MEMORY_DESCRIPTOR) + sizeof (UINT64) - (sizeof (EFI_MEMORY_DESCRIPTOR) % sizeof (UINT64)),
183 EFI_MEMORY_DESCRIPTOR_VERSION,
184 0,
185 NULL,
186 NULL,
187 FALSE,
188 FALSE
189 };
190
191 EFI_RUNTIME_ARCH_PROTOCOL *gRuntime = &gRuntimeTemplate;
192
193 //
194 // DXE Core Global Variables for the EFI System Table, Boot Services Table,
195 // DXE Services Table, and Runtime Services Table
196 //
197 EFI_DXE_SERVICES *gDxeCoreDS = &mDxeServices;
198 EFI_SYSTEM_TABLE *gDxeCoreST = NULL;
199
200 //
201 // For debug initialize gDxeCoreRT to template. gDxeCoreRT must be allocated from RT memory
202 // but gDxeCoreRT is used for ASSERT () and DEBUG () type macros so lets give it
203 // a value that will not cause debug infrastructure to crash early on.
204 //
205 EFI_RUNTIME_SERVICES *gDxeCoreRT = &mEfiRuntimeServicesTableTemplate;
206 EFI_HANDLE gDxeCoreImageHandle = NULL;
207
208
209 //
210 // EFI Decompress Protocol
211 //
212 EFI_DECOMPRESS_PROTOCOL gEfiDecompress = {
213 DxeMainUefiDecompressGetInfo,
214 DxeMainUefiDecompress
215 };
216
217 //
218 // For Loading modules at fixed address feature, the configuration table is to cache the top address below which to load
219 // Runtime code&boot time code
220 //
221 GLOBAL_REMOVE_IF_UNREFERENCED EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE gLoadModuleAtFixAddressConfigurationTable = {0, 0};
222
223 // Main entry point to the DXE Core
224 //
225
226 /**
227 Main entry point to DXE Core.
228
229 @param HobStart Pointer to the beginning of the HOB List from PEI.
230
231 @return This function should never return.
232
233 **/
234 VOID
235 EFIAPI
236 DxeMain (
237 IN VOID *HobStart
238 )
239 {
240 EFI_STATUS Status;
241 EFI_PHYSICAL_ADDRESS MemoryBaseAddress;
242 UINT64 MemoryLength;
243
244 //
245 // Initialize Memory Services
246 //
247 CoreInitializeMemoryServices (&HobStart, &MemoryBaseAddress, &MemoryLength);
248
249 //
250 // Allocate the EFI System Table and EFI Runtime Service Table from EfiRuntimeServicesData
251 // Use the templates to initialize the contents of the EFI System Table and EFI Runtime Services Table
252 //
253 gDxeCoreST = AllocateRuntimeCopyPool (sizeof (EFI_SYSTEM_TABLE), &mEfiSystemTableTemplate);
254 ASSERT (gDxeCoreST != NULL);
255
256 gDxeCoreRT = AllocateRuntimeCopyPool (sizeof (EFI_RUNTIME_SERVICES), &mEfiRuntimeServicesTableTemplate);
257 ASSERT (gDxeCoreRT != NULL);
258
259 gDxeCoreST->RuntimeServices = gDxeCoreRT;
260
261 //
262 // Start the Image Services.
263 //
264 Status = CoreInitializeImageServices (HobStart);
265 ASSERT_EFI_ERROR (Status);
266
267 //
268 // Call constructor for all libraries
269 //
270 ProcessLibraryConstructorList (gDxeCoreImageHandle, gDxeCoreST);
271 PERF_END (NULL,"PEI", NULL, 0) ;
272 PERF_START (NULL,"DXE", NULL, 0) ;
273
274 //
275 // Initialize the Global Coherency Domain Services
276 //
277 Status = CoreInitializeGcdServices (&HobStart, MemoryBaseAddress, MemoryLength);
278 ASSERT_EFI_ERROR (Status);
279
280 //
281 // Install the DXE Services Table into the EFI System Tables's Configuration Table
282 //
283 Status = CoreInstallConfigurationTable (&gEfiDxeServicesTableGuid, gDxeCoreDS);
284 ASSERT_EFI_ERROR (Status);
285
286 //
287 // Install the HOB List into the EFI System Tables's Configuration Table
288 //
289 Status = CoreInstallConfigurationTable (&gEfiHobListGuid, HobStart);
290 ASSERT_EFI_ERROR (Status);
291
292 //
293 // Install Memory Type Information Table into the EFI System Tables's Configuration Table
294 //
295 Status = CoreInstallConfigurationTable (&gEfiMemoryTypeInformationGuid, &gMemoryTypeInformation);
296 ASSERT_EFI_ERROR (Status);
297
298 //
299 // If Loading modules At fixed address feature is enabled, install Load moduels at fixed address
300 // Configuration Table so that user could easily to retrieve the top address to load Dxe and PEI
301 // Code and Tseg base to load SMM driver.
302 //
303 if (PcdGet64(PcdLoadModuleAtFixAddressEnable) != 0) {
304 Status = CoreInstallConfigurationTable (&gLoadFixedAddressConfigurationTableGuid, &gLoadModuleAtFixAddressConfigurationTable);
305 ASSERT_EFI_ERROR (Status);
306 }
307 //
308 // Report Status Code here for DXE_ENTRY_POINT once it is available
309 //
310 REPORT_STATUS_CODE (
311 EFI_PROGRESS_CODE,
312 (EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_ENTRY_POINT)
313 );
314
315 //
316 // Create the aligned system table pointer structure that is used by external
317 // debuggers to locate the system table... Also, install debug image info
318 // configuration table.
319 //
320 CoreInitializeDebugImageInfoTable ();
321 CoreNewDebugImageInfoEntry (
322 EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL,
323 gDxeCoreLoadedImage,
324 gDxeCoreImageHandle
325 );
326
327 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "HOBLIST address in DXE = 0x%p\n", HobStart));
328
329 DEBUG_CODE_BEGIN ();
330 EFI_PEI_HOB_POINTERS Hob;
331
332 for (Hob.Raw = HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {
333 if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_MEMORY_ALLOCATION) {
334 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Memory Allocation 0x%08x 0x%0lx - 0x%0lx\n", \
335 Hob.MemoryAllocation->AllocDescriptor.MemoryType, \
336 Hob.MemoryAllocation->AllocDescriptor.MemoryBaseAddress, \
337 Hob.MemoryAllocation->AllocDescriptor.MemoryBaseAddress + Hob.MemoryAllocation->AllocDescriptor.MemoryLength - 1));
338 }
339 }
340 for (Hob.Raw = HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {
341 if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_FV2) {
342 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "FV2 Hob 0x%0lx - 0x%0lx\n", Hob.FirmwareVolume2->BaseAddress, Hob.FirmwareVolume2->BaseAddress + Hob.FirmwareVolume2->Length - 1));
343 } else if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_FV) {
344 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "FV Hob 0x%0lx - 0x%0lx\n", Hob.FirmwareVolume->BaseAddress, Hob.FirmwareVolume->BaseAddress + Hob.FirmwareVolume2->Length - 1));
345 }
346 }
347 DEBUG_CODE_END ();
348
349 //
350 // Initialize the Event Services
351 //
352 Status = CoreInitializeEventServices ();
353 ASSERT_EFI_ERROR (Status);
354
355
356 //
357 // Get the Protocols that were passed in from PEI to DXE through GUIDed HOBs
358 //
359 // These Protocols are not architectural. This implementation is sharing code between
360 // PEI and DXE in order to save FLASH space. These Protocols could also be implemented
361 // as part of the DXE Core. However, that would also require the DXE Core to be ported
362 // each time a different CPU is used, a different Decompression algorithm is used, or a
363 // different Image type is used. By placing these Protocols in PEI, the DXE Core remains
364 // generic, and only PEI and the Arch Protocols need to be ported from Platform to Platform,
365 // and from CPU to CPU.
366 //
367
368 //
369 // Publish the EFI, Tiano, and Custom Decompress protocols for use by other DXE components
370 //
371 Status = CoreInstallMultipleProtocolInterfaces (
372 &mDecompressHandle,
373 &gEfiDecompressProtocolGuid, &gEfiDecompress,
374 NULL
375 );
376 ASSERT_EFI_ERROR (Status);
377
378 //
379 // Register for the GUIDs of the Architectural Protocols, so the rest of the
380 // EFI Boot Services and EFI Runtime Services tables can be filled in.
381 // Also register for the GUIDs of optional protocols.
382 //
383 CoreNotifyOnProtocolInstallation ();
384
385 //
386 // Produce Firmware Volume Protocols, one for each FV in the HOB list.
387 //
388 Status = FwVolBlockDriverInit (gDxeCoreImageHandle, gDxeCoreST);
389 ASSERT_EFI_ERROR (Status);
390
391 Status = FwVolDriverInit (gDxeCoreImageHandle, gDxeCoreST);
392 ASSERT_EFI_ERROR (Status);
393
394 //
395 // Produce the Section Extraction Protocol
396 //
397 Status = InitializeSectionExtraction (gDxeCoreImageHandle, gDxeCoreST);
398 ASSERT_EFI_ERROR (Status);
399
400 //
401 // Initialize the DXE Dispatcher
402 //
403 PERF_START (NULL,"CoreInitializeDispatcher", "DxeMain", 0) ;
404 CoreInitializeDispatcher ();
405 PERF_END (NULL,"CoreInitializeDispatcher", "DxeMain", 0) ;
406
407 //
408 // Invoke the DXE Dispatcher
409 //
410 PERF_START (NULL, "CoreDispatcher", "DxeMain", 0);
411 CoreDispatcher ();
412 PERF_END (NULL, "CoreDispatcher", "DxeMain", 0);
413
414 //
415 // Display Architectural protocols that were not loaded if this is DEBUG build
416 //
417 DEBUG_CODE_BEGIN ();
418 CoreDisplayMissingArchProtocols ();
419 DEBUG_CODE_END ();
420
421 //
422 // Display any drivers that were not dispatched because dependency expression
423 // evaluated to false if this is a debug build
424 //
425 DEBUG_CODE_BEGIN ();
426 CoreDisplayDiscoveredNotDispatched ();
427 DEBUG_CODE_END ();
428
429 //
430 // Assert if the Architectural Protocols are not present.
431 //
432 ASSERT_EFI_ERROR (CoreAllEfiServicesAvailable ());
433
434 //
435 // Report Status code before transfer control to BDS
436 //
437 REPORT_STATUS_CODE (
438 EFI_PROGRESS_CODE,
439 (EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT)
440 );
441
442 //
443 // Transfer control to the BDS Architectural Protocol
444 //
445 gBds->Entry (gBds);
446
447 //
448 // BDS should never return
449 //
450 ASSERT (FALSE);
451 CpuDeadLoop ();
452 }
453
454
455
456 /**
457 Place holder function until all the Boot Services and Runtime Services are
458 available.
459
460 @return EFI_NOT_AVAILABLE_YET
461
462 **/
463 EFI_STATUS
464 EFIAPI
465 CoreEfiNotAvailableYetArg0 (
466 VOID
467 )
468 {
469 //
470 // This function should never be executed. If it does, then the architectural protocols
471 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
472 // DXE Core and all the Architectural Protocols are complete.
473 //
474
475 return EFI_NOT_AVAILABLE_YET;
476 }
477
478
479 /**
480 Place holder function until all the Boot Services and Runtime Services are
481 available.
482
483 @param Arg1 Undefined
484
485 @return EFI_NOT_AVAILABLE_YET
486
487 **/
488 EFI_STATUS
489 EFIAPI
490 CoreEfiNotAvailableYetArg1 (
491 UINTN Arg1
492 )
493 {
494 //
495 // This function should never be executed. If it does, then the architectural protocols
496 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
497 // DXE Core and all the Architectural Protocols are complete.
498 //
499
500 return EFI_NOT_AVAILABLE_YET;
501 }
502
503
504 /**
505 Place holder function until all the Boot Services and Runtime Services are available.
506
507 @param Arg1 Undefined
508 @param Arg2 Undefined
509
510 @return EFI_NOT_AVAILABLE_YET
511
512 **/
513 EFI_STATUS
514 EFIAPI
515 CoreEfiNotAvailableYetArg2 (
516 UINTN Arg1,
517 UINTN Arg2
518 )
519 {
520 //
521 // This function should never be executed. If it does, then the architectural protocols
522 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
523 // DXE Core and all the Architectural Protocols are complete.
524 //
525
526 return EFI_NOT_AVAILABLE_YET;
527 }
528
529
530 /**
531 Place holder function until all the Boot Services and Runtime Services are available.
532
533 @param Arg1 Undefined
534 @param Arg2 Undefined
535 @param Arg3 Undefined
536
537 @return EFI_NOT_AVAILABLE_YET
538
539 **/
540 EFI_STATUS
541 EFIAPI
542 CoreEfiNotAvailableYetArg3 (
543 UINTN Arg1,
544 UINTN Arg2,
545 UINTN Arg3
546 )
547 {
548 //
549 // This function should never be executed. If it does, then the architectural protocols
550 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
551 // DXE Core and all the Architectural Protocols are complete.
552 //
553
554 return EFI_NOT_AVAILABLE_YET;
555 }
556
557
558 /**
559 Place holder function until all the Boot Services and Runtime Services are available.
560
561 @param Arg1 Undefined
562 @param Arg2 Undefined
563 @param Arg3 Undefined
564 @param Arg4 Undefined
565
566 @return EFI_NOT_AVAILABLE_YET
567
568 **/
569 EFI_STATUS
570 EFIAPI
571 CoreEfiNotAvailableYetArg4 (
572 UINTN Arg1,
573 UINTN Arg2,
574 UINTN Arg3,
575 UINTN Arg4
576 )
577 {
578 //
579 // This function should never be executed. If it does, then the architectural protocols
580 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
581 // DXE Core and all the Architectural Protocols are complete.
582 //
583
584 return EFI_NOT_AVAILABLE_YET;
585 }
586
587
588 /**
589 Place holder function until all the Boot Services and Runtime Services are available.
590
591 @param Arg1 Undefined
592 @param Arg2 Undefined
593 @param Arg3 Undefined
594 @param Arg4 Undefined
595 @param Arg5 Undefined
596
597 @return EFI_NOT_AVAILABLE_YET
598
599 **/
600 EFI_STATUS
601 EFIAPI
602 CoreEfiNotAvailableYetArg5 (
603 UINTN Arg1,
604 UINTN Arg2,
605 UINTN Arg3,
606 UINTN Arg4,
607 UINTN Arg5
608 )
609 {
610 //
611 // This function should never be executed. If it does, then the architectural protocols
612 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
613 // DXE Core and all the Architectural Protocols are complete.
614 //
615
616 return EFI_NOT_AVAILABLE_YET;
617 }
618
619
620 /**
621 Calcualte the 32-bit CRC in a EFI table using the service provided by the
622 gRuntime service.
623
624 @param Hdr Pointer to an EFI standard header
625
626 **/
627 VOID
628 CalculateEfiHdrCrc (
629 IN OUT EFI_TABLE_HEADER *Hdr
630 )
631 {
632 UINT32 Crc;
633
634 Hdr->CRC32 = 0;
635
636 //
637 // If gBS->CalculateCrce32 () == CoreEfiNotAvailableYet () then
638 // Crc will come back as zero if we set it to zero here
639 //
640 Crc = 0;
641 gBS->CalculateCrc32 ((UINT8 *)Hdr, Hdr->HeaderSize, &Crc);
642 Hdr->CRC32 = Crc;
643 }
644
645
646 /**
647 Terminates all boot services.
648
649 @param ImageHandle Handle that identifies the exiting image.
650 @param MapKey Key to the latest memory map.
651
652 @retval EFI_SUCCESS Boot Services terminated
653 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
654
655 **/
656 EFI_STATUS
657 EFIAPI
658 CoreExitBootServices (
659 IN EFI_HANDLE ImageHandle,
660 IN UINTN MapKey
661 )
662 {
663 EFI_STATUS Status;
664
665 //
666 // Terminate memory services if the MapKey matches
667 //
668 Status = CoreTerminateMemoryMap (MapKey);
669 if (EFI_ERROR (Status)) {
670 return Status;
671 }
672
673 //
674 // Disable Timer
675 //
676 gTimer->SetTimerPeriod (gTimer, 0);
677
678 //
679 // Notify other drivers that we are exiting boot services.
680 //
681 CoreNotifySignalList (&gEfiEventExitBootServicesGuid);
682
683 //
684 // Disable CPU Interrupts
685 //
686 gCpu->DisableInterrupt (gCpu);
687
688 //
689 // Report that ExitBootServices() has been called
690 //
691 REPORT_STATUS_CODE (
692 EFI_PROGRESS_CODE,
693 (EFI_SOFTWARE_EFI_BOOT_SERVICE | EFI_SW_BS_PC_EXIT_BOOT_SERVICES)
694 );
695
696 //
697 // Clear the non-runtime values of the EFI System Table
698 //
699 gDxeCoreST->BootServices = NULL;
700 gDxeCoreST->ConIn = NULL;
701 gDxeCoreST->ConsoleInHandle = NULL;
702 gDxeCoreST->ConOut = NULL;
703 gDxeCoreST->ConsoleOutHandle = NULL;
704 gDxeCoreST->StdErr = NULL;
705 gDxeCoreST->StandardErrorHandle = NULL;
706
707 //
708 // Recompute the 32-bit CRC of the EFI System Table
709 //
710 CalculateEfiHdrCrc (&gDxeCoreST->Hdr);
711
712 //
713 // Zero out the Boot Service Table
714 //
715 ZeroMem (gBS, sizeof (EFI_BOOT_SERVICES));
716 gBS = NULL;
717
718 //
719 // Update the AtRuntime field in Runtiem AP.
720 //
721 gRuntime->AtRuntime = TRUE;
722
723 return Status;
724 }
725
726
727 /**
728 Given a compressed source buffer, this function retrieves the size of the
729 uncompressed buffer and the size of the scratch buffer required to decompress
730 the compressed source buffer.
731
732 The GetInfo() function retrieves the size of the uncompressed buffer and the
733 temporary scratch buffer required to decompress the buffer specified by Source
734 and SourceSize. If the size of the uncompressed buffer or the size of the
735 scratch buffer cannot be determined from the compressed data specified by
736 Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the
737 size of the uncompressed buffer is returned in DestinationSize, the size of
738 the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned.
739 The GetInfo() function does not have scratch buffer available to perform a
740 thorough checking of the validity of the source data. It just retrieves the
741 "Original Size" field from the beginning bytes of the source data and output
742 it as DestinationSize. And ScratchSize is specific to the decompression
743 implementation.
744
745 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
746 @param Source The source buffer containing the compressed data.
747 @param SourceSize The size, in bytes, of the source buffer.
748 @param DestinationSize A pointer to the size, in bytes, of the
749 uncompressed buffer that will be generated when the
750 compressed buffer specified by Source and
751 SourceSize is decompressed.
752 @param ScratchSize A pointer to the size, in bytes, of the scratch
753 buffer that is required to decompress the
754 compressed buffer specified by Source and
755 SourceSize.
756
757 @retval EFI_SUCCESS The size of the uncompressed data was returned in
758 DestinationSize and the size of the scratch buffer
759 was returned in ScratchSize.
760 @retval EFI_INVALID_PARAMETER The size of the uncompressed data or the size of
761 the scratch buffer cannot be determined from the
762 compressed data specified by Source and
763 SourceSize.
764
765 **/
766 EFI_STATUS
767 EFIAPI
768 DxeMainUefiDecompressGetInfo (
769 IN EFI_DECOMPRESS_PROTOCOL *This,
770 IN VOID *Source,
771 IN UINT32 SourceSize,
772 OUT UINT32 *DestinationSize,
773 OUT UINT32 *ScratchSize
774 )
775 {
776 if (Source == NULL || DestinationSize == NULL || ScratchSize == NULL) {
777 return EFI_INVALID_PARAMETER;
778 }
779 return UefiDecompressGetInfo (Source, SourceSize, DestinationSize, ScratchSize);
780 }
781
782
783 /**
784 Decompresses a compressed source buffer.
785
786 The Decompress() function extracts decompressed data to its original form.
787 This protocol is designed so that the decompression algorithm can be
788 implemented without using any memory services. As a result, the Decompress()
789 Function is not allowed to call AllocatePool() or AllocatePages() in its
790 implementation. It is the caller's responsibility to allocate and free the
791 Destination and Scratch buffers.
792 If the compressed source data specified by Source and SourceSize is
793 sucessfully decompressed into Destination, then EFI_SUCCESS is returned. If
794 the compressed source data specified by Source and SourceSize is not in a
795 valid compressed data format, then EFI_INVALID_PARAMETER is returned.
796
797 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
798 @param Source The source buffer containing the compressed data.
799 @param SourceSize SourceSizeThe size of source data.
800 @param Destination On output, the destination buffer that contains
801 the uncompressed data.
802 @param DestinationSize The size of the destination buffer. The size of
803 the destination buffer needed is obtained from
804 EFI_DECOMPRESS_PROTOCOL.GetInfo().
805 @param Scratch A temporary scratch buffer that is used to perform
806 the decompression.
807 @param ScratchSize The size of scratch buffer. The size of the
808 scratch buffer needed is obtained from GetInfo().
809
810 @retval EFI_SUCCESS Decompression completed successfully, and the
811 uncompressed buffer is returned in Destination.
812 @retval EFI_INVALID_PARAMETER The source buffer specified by Source and
813 SourceSize is corrupted (not in a valid
814 compressed format).
815
816 **/
817 EFI_STATUS
818 EFIAPI
819 DxeMainUefiDecompress (
820 IN EFI_DECOMPRESS_PROTOCOL *This,
821 IN VOID *Source,
822 IN UINT32 SourceSize,
823 IN OUT VOID *Destination,
824 IN UINT32 DestinationSize,
825 IN OUT VOID *Scratch,
826 IN UINT32 ScratchSize
827 )
828 {
829 EFI_STATUS Status;
830 UINT32 TestDestinationSize;
831 UINT32 TestScratchSize;
832
833 if (Source == NULL || Destination== NULL || Scratch == NULL) {
834 return EFI_INVALID_PARAMETER;
835 }
836
837 Status = UefiDecompressGetInfo (Source, SourceSize, &TestDestinationSize, &TestScratchSize);
838 if (EFI_ERROR (Status)) {
839 return Status;
840 }
841
842 if (ScratchSize < TestScratchSize || DestinationSize < TestDestinationSize) {
843 return RETURN_INVALID_PARAMETER;
844 }
845
846 return UefiDecompress (Source, Destination, Scratch);
847 }