]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Core/Dxe/DxeMain/DxeMain.c
36a7ec6be6ba8b80cb4c93027ff7d6f4308efefe
[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 %08x %0lx - %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 %08x %0lx - %0lx\n", Hob.FirmwareVolume2->BaseAddress, Hob.FirmwareVolume2->BaseAddress + Hob.FirmwareVolume2->Length - 1, Hob.ResourceDescriptor->ResourceType));
343 } else if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_FV) {
344 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "FV Hob %08x %0lx - %0lx\n", Hob.FirmwareVolume->BaseAddress, Hob.FirmwareVolume->BaseAddress + Hob.FirmwareVolume2->Length - 1, Hob.ResourceDescriptor->ResourceType));
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 //
382 CoreNotifyOnArchProtocolInstallation ();
383
384 //
385 // Produce Firmware Volume Protocols, one for each FV in the HOB list.
386 //
387 Status = FwVolBlockDriverInit (gDxeCoreImageHandle, gDxeCoreST);
388 ASSERT_EFI_ERROR (Status);
389
390 Status = FwVolDriverInit (gDxeCoreImageHandle, gDxeCoreST);
391 ASSERT_EFI_ERROR (Status);
392
393 //
394 // Produce the Section Extraction Protocol
395 //
396 Status = InitializeSectionExtraction (gDxeCoreImageHandle, gDxeCoreST);
397 ASSERT_EFI_ERROR (Status);
398
399 //
400 // Initialize the DXE Dispatcher
401 //
402 PERF_START (NULL,"CoreInitializeDispatcher", "DxeMain", 0) ;
403 CoreInitializeDispatcher ();
404 PERF_END (NULL,"CoreInitializeDispatcher", "DxeMain", 0) ;
405
406 //
407 // Invoke the DXE Dispatcher
408 //
409 PERF_START (NULL, "CoreDispatcher", "DxeMain", 0);
410 CoreDispatcher ();
411 PERF_END (NULL, "CoreDispatcher", "DxeMain", 0);
412
413 //
414 // Display Architectural protocols that were not loaded if this is DEBUG build
415 //
416 DEBUG_CODE_BEGIN ();
417 CoreDisplayMissingArchProtocols ();
418 DEBUG_CODE_END ();
419
420 //
421 // Display any drivers that were not dispatched because dependency expression
422 // evaluated to false if this is a debug build
423 //
424 DEBUG_CODE_BEGIN ();
425 CoreDisplayDiscoveredNotDispatched ();
426 DEBUG_CODE_END ();
427
428 //
429 // Assert if the Architectural Protocols are not present.
430 //
431 ASSERT_EFI_ERROR (CoreAllEfiServicesAvailable ());
432
433 //
434 // Report Status code before transfer control to BDS
435 //
436 REPORT_STATUS_CODE (
437 EFI_PROGRESS_CODE,
438 (EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT)
439 );
440
441 //
442 // Transfer control to the BDS Architectural Protocol
443 //
444 gBds->Entry (gBds);
445
446 //
447 // BDS should never return
448 //
449 ASSERT (FALSE);
450 CpuDeadLoop ();
451 }
452
453
454
455 /**
456 Place holder function until all the Boot Services and Runtime Services are
457 available.
458
459 @return EFI_NOT_AVAILABLE_YET
460
461 **/
462 EFI_STATUS
463 EFIAPI
464 CoreEfiNotAvailableYetArg0 (
465 VOID
466 )
467 {
468 //
469 // This function should never be executed. If it does, then the architectural protocols
470 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
471 // DXE Core and all the Architectural Protocols are complete.
472 //
473
474 return EFI_NOT_AVAILABLE_YET;
475 }
476
477
478 /**
479 Place holder function until all the Boot Services and Runtime Services are
480 available.
481
482 @param Arg1 Undefined
483
484 @return EFI_NOT_AVAILABLE_YET
485
486 **/
487 EFI_STATUS
488 EFIAPI
489 CoreEfiNotAvailableYetArg1 (
490 UINTN Arg1
491 )
492 {
493 //
494 // This function should never be executed. If it does, then the architectural protocols
495 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
496 // DXE Core and all the Architectural Protocols are complete.
497 //
498
499 return EFI_NOT_AVAILABLE_YET;
500 }
501
502
503 /**
504 Place holder function until all the Boot Services and Runtime Services are available.
505
506 @param Arg1 Undefined
507 @param Arg2 Undefined
508
509 @return EFI_NOT_AVAILABLE_YET
510
511 **/
512 EFI_STATUS
513 EFIAPI
514 CoreEfiNotAvailableYetArg2 (
515 UINTN Arg1,
516 UINTN Arg2
517 )
518 {
519 //
520 // This function should never be executed. If it does, then the architectural protocols
521 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
522 // DXE Core and all the Architectural Protocols are complete.
523 //
524
525 return EFI_NOT_AVAILABLE_YET;
526 }
527
528
529 /**
530 Place holder function until all the Boot Services and Runtime Services are available.
531
532 @param Arg1 Undefined
533 @param Arg2 Undefined
534 @param Arg3 Undefined
535
536 @return EFI_NOT_AVAILABLE_YET
537
538 **/
539 EFI_STATUS
540 EFIAPI
541 CoreEfiNotAvailableYetArg3 (
542 UINTN Arg1,
543 UINTN Arg2,
544 UINTN Arg3
545 )
546 {
547 //
548 // This function should never be executed. If it does, then the architectural protocols
549 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
550 // DXE Core and all the Architectural Protocols are complete.
551 //
552
553 return EFI_NOT_AVAILABLE_YET;
554 }
555
556
557 /**
558 Place holder function until all the Boot Services and Runtime Services are available.
559
560 @param Arg1 Undefined
561 @param Arg2 Undefined
562 @param Arg3 Undefined
563 @param Arg4 Undefined
564
565 @return EFI_NOT_AVAILABLE_YET
566
567 **/
568 EFI_STATUS
569 EFIAPI
570 CoreEfiNotAvailableYetArg4 (
571 UINTN Arg1,
572 UINTN Arg2,
573 UINTN Arg3,
574 UINTN Arg4
575 )
576 {
577 //
578 // This function should never be executed. If it does, then the architectural protocols
579 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
580 // DXE Core and all the Architectural Protocols are complete.
581 //
582
583 return EFI_NOT_AVAILABLE_YET;
584 }
585
586
587 /**
588 Place holder function until all the Boot Services and Runtime Services are available.
589
590 @param Arg1 Undefined
591 @param Arg2 Undefined
592 @param Arg3 Undefined
593 @param Arg4 Undefined
594 @param Arg5 Undefined
595
596 @return EFI_NOT_AVAILABLE_YET
597
598 **/
599 EFI_STATUS
600 EFIAPI
601 CoreEfiNotAvailableYetArg5 (
602 UINTN Arg1,
603 UINTN Arg2,
604 UINTN Arg3,
605 UINTN Arg4,
606 UINTN Arg5
607 )
608 {
609 //
610 // This function should never be executed. If it does, then the architectural protocols
611 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
612 // DXE Core and all the Architectural Protocols are complete.
613 //
614
615 return EFI_NOT_AVAILABLE_YET;
616 }
617
618
619 /**
620 Calcualte the 32-bit CRC in a EFI table using the service provided by the
621 gRuntime service.
622
623 @param Hdr Pointer to an EFI standard header
624
625 **/
626 VOID
627 CalculateEfiHdrCrc (
628 IN OUT EFI_TABLE_HEADER *Hdr
629 )
630 {
631 UINT32 Crc;
632
633 Hdr->CRC32 = 0;
634
635 //
636 // If gBS->CalculateCrce32 () == CoreEfiNotAvailableYet () then
637 // Crc will come back as zero if we set it to zero here
638 //
639 Crc = 0;
640 gBS->CalculateCrc32 ((UINT8 *)Hdr, Hdr->HeaderSize, &Crc);
641 Hdr->CRC32 = Crc;
642 }
643
644
645 /**
646 Terminates all boot services.
647
648 @param ImageHandle Handle that identifies the exiting image.
649 @param MapKey Key to the latest memory map.
650
651 @retval EFI_SUCCESS Boot Services terminated
652 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
653
654 **/
655 EFI_STATUS
656 EFIAPI
657 CoreExitBootServices (
658 IN EFI_HANDLE ImageHandle,
659 IN UINTN MapKey
660 )
661 {
662 EFI_STATUS Status;
663
664 //
665 // Terminate memory services if the MapKey matches
666 //
667 Status = CoreTerminateMemoryMap (MapKey);
668 if (EFI_ERROR (Status)) {
669 return Status;
670 }
671
672 //
673 // Disable Timer
674 //
675 gTimer->SetTimerPeriod (gTimer, 0);
676
677 //
678 // Notify other drivers that we are exiting boot services.
679 //
680 CoreNotifySignalList (&gEfiEventExitBootServicesGuid);
681
682 //
683 // Disable CPU Interrupts
684 //
685 gCpu->DisableInterrupt (gCpu);
686
687 //
688 // Report that ExitBootServices() has been called
689 //
690 REPORT_STATUS_CODE (
691 EFI_PROGRESS_CODE,
692 (EFI_SOFTWARE_EFI_BOOT_SERVICE | EFI_SW_BS_PC_EXIT_BOOT_SERVICES)
693 );
694
695 //
696 // Clear the non-runtime values of the EFI System Table
697 //
698 gDxeCoreST->BootServices = NULL;
699 gDxeCoreST->ConIn = NULL;
700 gDxeCoreST->ConsoleInHandle = NULL;
701 gDxeCoreST->ConOut = NULL;
702 gDxeCoreST->ConsoleOutHandle = NULL;
703 gDxeCoreST->StdErr = NULL;
704 gDxeCoreST->StandardErrorHandle = NULL;
705
706 //
707 // Recompute the 32-bit CRC of the EFI System Table
708 //
709 CalculateEfiHdrCrc (&gDxeCoreST->Hdr);
710
711 //
712 // Zero out the Boot Service Table
713 //
714 ZeroMem (gBS, sizeof (EFI_BOOT_SERVICES));
715 gBS = NULL;
716
717 //
718 // Update the AtRuntime field in Runtiem AP.
719 //
720 gRuntime->AtRuntime = TRUE;
721
722 return Status;
723 }
724
725
726 /**
727 Given a compressed source buffer, this function retrieves the size of the
728 uncompressed buffer and the size of the scratch buffer required to decompress
729 the compressed source buffer.
730
731 The GetInfo() function retrieves the size of the uncompressed buffer and the
732 temporary scratch buffer required to decompress the buffer specified by Source
733 and SourceSize. If the size of the uncompressed buffer or the size of the
734 scratch buffer cannot be determined from the compressed data specified by
735 Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the
736 size of the uncompressed buffer is returned in DestinationSize, the size of
737 the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned.
738 The GetInfo() function does not have scratch buffer available to perform a
739 thorough checking of the validity of the source data. It just retrieves the
740 "Original Size" field from the beginning bytes of the source data and output
741 it as DestinationSize. And ScratchSize is specific to the decompression
742 implementation.
743
744 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
745 @param Source The source buffer containing the compressed data.
746 @param SourceSize The size, in bytes, of the source buffer.
747 @param DestinationSize A pointer to the size, in bytes, of the
748 uncompressed buffer that will be generated when the
749 compressed buffer specified by Source and
750 SourceSize is decompressed.
751 @param ScratchSize A pointer to the size, in bytes, of the scratch
752 buffer that is required to decompress the
753 compressed buffer specified by Source and
754 SourceSize.
755
756 @retval EFI_SUCCESS The size of the uncompressed data was returned in
757 DestinationSize and the size of the scratch buffer
758 was returned in ScratchSize.
759 @retval EFI_INVALID_PARAMETER The size of the uncompressed data or the size of
760 the scratch buffer cannot be determined from the
761 compressed data specified by Source and
762 SourceSize.
763
764 **/
765 EFI_STATUS
766 EFIAPI
767 DxeMainUefiDecompressGetInfo (
768 IN EFI_DECOMPRESS_PROTOCOL *This,
769 IN VOID *Source,
770 IN UINT32 SourceSize,
771 OUT UINT32 *DestinationSize,
772 OUT UINT32 *ScratchSize
773 )
774 {
775 if (Source == NULL || DestinationSize == NULL || ScratchSize == NULL) {
776 return EFI_INVALID_PARAMETER;
777 }
778 return UefiDecompressGetInfo (Source, SourceSize, DestinationSize, ScratchSize);
779 }
780
781
782 /**
783 Decompresses a compressed source buffer.
784
785 The Decompress() function extracts decompressed data to its original form.
786 This protocol is designed so that the decompression algorithm can be
787 implemented without using any memory services. As a result, the Decompress()
788 Function is not allowed to call AllocatePool() or AllocatePages() in its
789 implementation. It is the caller's responsibility to allocate and free the
790 Destination and Scratch buffers.
791 If the compressed source data specified by Source and SourceSize is
792 sucessfully decompressed into Destination, then EFI_SUCCESS is returned. If
793 the compressed source data specified by Source and SourceSize is not in a
794 valid compressed data format, then EFI_INVALID_PARAMETER is returned.
795
796 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
797 @param Source The source buffer containing the compressed data.
798 @param SourceSize SourceSizeThe size of source data.
799 @param Destination On output, the destination buffer that contains
800 the uncompressed data.
801 @param DestinationSize The size of the destination buffer. The size of
802 the destination buffer needed is obtained from
803 EFI_DECOMPRESS_PROTOCOL.GetInfo().
804 @param Scratch A temporary scratch buffer that is used to perform
805 the decompression.
806 @param ScratchSize The size of scratch buffer. The size of the
807 scratch buffer needed is obtained from GetInfo().
808
809 @retval EFI_SUCCESS Decompression completed successfully, and the
810 uncompressed buffer is returned in Destination.
811 @retval EFI_INVALID_PARAMETER The source buffer specified by Source and
812 SourceSize is corrupted (not in a valid
813 compressed format).
814
815 **/
816 EFI_STATUS
817 EFIAPI
818 DxeMainUefiDecompress (
819 IN EFI_DECOMPRESS_PROTOCOL *This,
820 IN VOID *Source,
821 IN UINT32 SourceSize,
822 IN OUT VOID *Destination,
823 IN UINT32 DestinationSize,
824 IN OUT VOID *Scratch,
825 IN UINT32 ScratchSize
826 )
827 {
828 EFI_STATUS Status;
829 UINT32 TestDestinationSize;
830 UINT32 TestScratchSize;
831
832 if (Source == NULL || Destination== NULL || Scratch == NULL) {
833 return EFI_INVALID_PARAMETER;
834 }
835
836 Status = UefiDecompressGetInfo (Source, SourceSize, &TestDestinationSize, &TestScratchSize);
837 if (EFI_ERROR (Status)) {
838 return Status;
839 }
840
841 if (ScratchSize < TestScratchSize || DestinationSize < TestDestinationSize) {
842 return RETURN_INVALID_PARAMETER;
843 }
844
845 return UefiDecompress (Source, Destination, Scratch);
846 }