3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Runtime Architectural Protocol as defined in the DXE CIS
20 This code is used to produce the EFI runtime virtual switch over
22 THIS IS VERY DANGEROUS CODE BE VERY CAREFUL IF YOU CHANGE IT
24 The transition for calling EFI Runtime functions in physical mode to calling
25 them in virtual mode is very very complex. Every pointer in needs to be
26 converted from physical mode to virtual mode. Be very careful walking linked
27 lists! Then to make it really hard the code it's self needs be relocated into
28 the new virtual address space.
30 So here is the concept. The code in this module will never ever be called in
31 virtual mode. This is the code that collects the information needed to convert
32 to virtual mode (DXE core registers runtime stuff with this code). Since this
33 code is used to fixup all runtime images, it CAN NOT fix it's self up. So some
34 code has to stay behind and that is us.
36 Also you need to be careful about when you allocate memory, as once we are in
37 runtime (including our EVT_SIGNAL_EXIT_BOOT_SERVICES event) you can no longer
40 Any runtime driver that gets loaded before us will not be callable in virtual
41 mode. This is due to the fact that the DXE core can not register the info
42 needed with us. This is good, since it keeps the code in this file from
48 - Move the CalculateCrc32 function from Runtime Arch Protocol to Boot Service.
49 Runtime Arch Protocol definition no longer contains CalculateCrc32. Boot Service
50 Table now contains an item named CalculateCrc32.
60 EFI_MEMORY_DESCRIPTOR
*mVirtualMap
= NULL
;
61 UINTN mVirtualMapDescriptorSize
;
62 UINTN mVirtualMapMaxIndex
;
66 // The handle onto which the Runtime Architectural Protocol instance is installed
68 EFI_HANDLE mRuntimeHandle
= NULL
;
71 // The Runtime Architectural Protocol instance produced by this driver
73 EFI_RUNTIME_ARCH_PROTOCOL mRuntime
= {
74 INITIALIZE_LIST_HEAD_VARIABLE (mRuntime
.ImageHead
),
75 INITIALIZE_LIST_HEAD_VARIABLE (mRuntime
.EventHead
),
78 // Make sure Size != sizeof (EFI_MEMORY_DESCRIPTOR). This will
79 // prevent people from having pointer math bugs in their code.
80 // now you have to use *DescriptorSize to make things work.
82 sizeof (EFI_MEMORY_DESCRIPTOR
) + sizeof (UINT64
) - (sizeof (EFI_MEMORY_DESCRIPTOR
) % sizeof (UINT64
)),
83 EFI_MEMORY_DESCRIPTOR_VERSION
,
95 RuntimeDriverCalculateEfiHdrCrc (
96 IN OUT EFI_TABLE_HEADER
*Hdr
102 Calcualte the 32-bit CRC in a EFI table using the Runtime Drivers
103 internal function. The EFI Boot Services Table can not be used because
104 the EFI Boot Services Table was destroyed at ExitBootServices()
108 Hdr - Pointer to an EFI standard header
121 RuntimeDriverCalculateCrc32 ((UINT8
*) Hdr
, Hdr
->HeaderSize
, &Crc
);
127 RuntimeDriverConvertPointer (
128 IN UINTN DebugDisposition
,
129 IN OUT VOID
**ConvertAddress
135 Determines the new virtual address that is to be used on subsequent memory accesses.
139 DebugDisposition - Supplies type information for the pointer being converted.
140 ConvertAddress - A pointer to a pointer that is to be fixed to be the value needed
141 for the new virtual address mappings being applied.
145 EFI_SUCCESS - The pointer pointed to by Address was modified.
146 EFI_NOT_FOUND - The pointer pointed to by Address was not found to be part
147 of the current memory map. This is normally fatal.
148 EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
153 VOID
*PlabelConvertAddress
;
154 UINT64 VirtEndOfRange
;
155 EFI_MEMORY_DESCRIPTOR
*VirtEntry
;
159 // Make sure ConvertAddress is a valid pointer
161 if (ConvertAddress
== NULL
) {
162 return EFI_INVALID_PARAMETER
;
165 // Get the address to convert
167 Address
= (UINTN
) *ConvertAddress
;
170 // If this is a null pointer, return if it's allowed
173 if (DebugDisposition
& EFI_OPTIONAL_POINTER
) {
177 return EFI_INVALID_PARAMETER
;
180 PlabelConvertAddress
= NULL
;
181 VirtEntry
= mVirtualMap
;
182 for (Index
= 0; Index
< mVirtualMapMaxIndex
; Index
++) {
184 // To prevent the inclusion of 64-bit math functions a UINTN was placed in
185 // front of VirtEntry->NumberOfPages to cast it to a 32-bit thing on IA-32
186 // platforms. If you get this ASSERT remove the UINTN and do a 64-bit
189 ASSERT (((UINTN
) VirtEntry
->NumberOfPages
< 0xffffffff) || (sizeof (UINTN
) > 4));
191 if ((VirtEntry
->Attribute
& EFI_MEMORY_RUNTIME
) == EFI_MEMORY_RUNTIME
) {
192 if (Address
>= VirtEntry
->PhysicalStart
) {
193 VirtEndOfRange
= VirtEntry
->PhysicalStart
+ (((UINTN
) VirtEntry
->NumberOfPages
) * EFI_PAGE_SIZE
);
194 if (Address
< VirtEndOfRange
) {
196 // Compute new address
198 *ConvertAddress
= (VOID
*) (Address
- (UINTN
) VirtEntry
->PhysicalStart
+ (UINTN
) VirtEntry
->VirtualStart
);
200 } else if (Address
< (VirtEndOfRange
+ 0x200000)) {
202 // On Itanium GP defines a window +/- 2 MB inside an image.
203 // The compiler may asign a GP value outside of the image. Thus
204 // it could fall out side of any of our valid regions
206 PlabelConvertAddress
= (VOID
*) (Address
- (UINTN
) VirtEntry
->PhysicalStart
+ (UINTN
) VirtEntry
->VirtualStart
);
211 VirtEntry
= NextMemoryDescriptor (VirtEntry
, mVirtualMapDescriptorSize
);
214 if (DebugDisposition
& EFI_IPF_GP_POINTER
) {
216 // If it's an IPF GP and the GP was outside the image handle that case.
218 if (PlabelConvertAddress
!= NULL
) {
219 *ConvertAddress
= PlabelConvertAddress
;
224 return EFI_NOT_FOUND
;
228 RuntimeDriverConvertInternalPointer (
229 IN OUT VOID
**ConvertAddress
235 Determines the new virtual address that is to be used on subsequent memory accesses
236 for internal pointers.
240 ConvertAddress - A pointer to a pointer that is to be fixed to be the value needed
241 for the new virtual address mappings being applied.
245 EFI_SUCCESS - The pointer pointed to by Address was modified.
246 EFI_NOT_FOUND - The pointer pointed to by Address was not found to be part
247 of the current memory map. This is normally fatal.
248 EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
252 return RuntimeDriverConvertPointer (0x0, ConvertAddress
);
257 RuntimeDriverSetVirtualAddressMap (
258 IN UINTN MemoryMapSize
,
259 IN UINTN DescriptorSize
,
260 IN UINT32 DescriptorVersion
,
261 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
267 Changes the runtime addressing mode of EFI firmware from physical to virtual.
271 MemoryMapSize - The size in bytes of VirtualMap.
272 DescriptorSize - The size in bytes of an entry in the VirtualMap.
273 DescriptorVersion - The version of the structure entries in VirtualMap.
274 VirtualMap - An array of memory descriptors which contain new virtual
275 address mapping information for all runtime ranges.
279 EFI_SUCCESS - The virtual address map has been applied.
280 EFI_UNSUPPORTED - EFI firmware is not at runtime, or the EFI firmware is already in
281 virtual address mapped mode.
282 EFI_INVALID_PARAMETER - DescriptorSize or DescriptorVersion is invalid.
283 EFI_NO_MAPPING - A virtual address was not supplied for a range in the memory
284 map that requires a mapping.
285 EFI_NOT_FOUND - A virtual address was supplied for an address that is not found
291 EFI_RUNTIME_EVENT_ENTRY
*RuntimeEvent
;
292 EFI_RUNTIME_IMAGE_ENTRY
*RuntimeImage
;
296 EFI_DRIVER_OS_HANDOFF_HEADER
*DriverOsHandoffHeader
;
297 EFI_DRIVER_OS_HANDOFF
*DriverOsHandoff
;
298 EFI_PHYSICAL_ADDRESS VirtImageBase
;
299 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
300 EFI_CAPSULE_TABLE
*CapsuleTable
;
304 // Can only switch to virtual addresses once the memory map is locked down,
305 // and can only set it once
307 if (!mRuntime
.AtRuntime
|| mRuntime
.VirtualMode
) {
308 return EFI_UNSUPPORTED
;
311 // Only understand the original descriptor format
313 if (DescriptorVersion
!= EFI_MEMORY_DESCRIPTOR_VERSION
|| DescriptorSize
< sizeof (EFI_MEMORY_DESCRIPTOR
)) {
314 return EFI_INVALID_PARAMETER
;
317 // We are now committed to go to virtual mode, so lets get to it!
319 mRuntime
.VirtualMode
= TRUE
;
322 // ConvertPointer() needs this mVirtualMap to do the conversion. So set up
323 // globals we need to parse the virtual address map.
325 mVirtualMapDescriptorSize
= DescriptorSize
;
326 mVirtualMapMaxIndex
= MemoryMapSize
/ DescriptorSize
;
327 mVirtualMap
= VirtualMap
;
330 // Currently the bug in StatusCode/RuntimeLib has been fixed, it will
331 // check whether in Runtime or not (this is judged by looking at
332 // mEfiAtRuntime global So this ReportStatusCode will work
336 (EFI_SOFTWARE_EFI_BOOT_SERVICE
| EFI_SW_RS_PC_SET_VIRTUAL_ADDRESS_MAP
)
340 // Signal all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE events.
341 // All runtime events are stored in a list in Runtime AP.
343 for (Link
= mRuntime
.EventHead
.ForwardLink
; Link
!= &mRuntime
.EventHead
; Link
= Link
->ForwardLink
) {
344 RuntimeEvent
= _CR (Link
, EFI_RUNTIME_EVENT_ENTRY
, Link
);
345 if ((RuntimeEvent
->Type
& EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
) == EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
) {
346 RuntimeEvent
->NotifyFunction (
348 RuntimeEvent
->NotifyContext
354 // Relocate runtime images. All runtime images are stored in a list in Runtime AP.
356 for (Link
= mRuntime
.ImageHead
.ForwardLink
; Link
!= &mRuntime
.ImageHead
; Link
= Link
->ForwardLink
) {
357 RuntimeImage
= _CR (Link
, EFI_RUNTIME_IMAGE_ENTRY
, Link
);
359 // We don't want to relocate our selves, as we only run in physical mode.
361 if (mMyImageBase
!= RuntimeImage
->ImageBase
) {
363 VirtImageBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) RuntimeImage
->ImageBase
;
364 Status
= RuntimeDriverConvertPointer (0, (VOID
**) &VirtImageBase
);
365 ASSERT_EFI_ERROR (Status
);
367 PeCoffLoaderRelocateImageForRuntime (
368 (EFI_PHYSICAL_ADDRESS
) (UINTN
) RuntimeImage
->ImageBase
,
370 (UINTN
) RuntimeImage
->ImageSize
,
371 RuntimeImage
->RelocationData
374 InvalidateInstructionCacheRange (RuntimeImage
->ImageBase
, (UINTN
)RuntimeImage
->ImageSize
);
379 // Convert all the Runtime Services except ConvertPointer() and SetVirtualAddressMap()
380 // and recompute the CRC-32
382 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->GetTime
);
383 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->SetTime
);
384 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->GetWakeupTime
);
385 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->SetWakeupTime
);
386 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->ResetSystem
);
387 #if (EFI_SPECIFICATION_VERSION < 0x00020000)
388 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->ReportStatusCode
);
390 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->GetNextHighMonotonicCount
);
391 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->GetVariable
);
392 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->SetVariable
);
393 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->GetNextVariableName
);
394 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
395 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->QueryVariableInfo
);
396 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->UpdateCapsule
);
397 RuntimeDriverConvertInternalPointer ((VOID
**) &gRT
->QueryCapsuleCapabilities
);
399 RuntimeDriverCalculateEfiHdrCrc (&gRT
->Hdr
);
402 // Convert the UGA OS Handoff Table if it is present in the Configuration Table
404 for (Index
= 0; Index
< gST
->NumberOfTableEntries
; Index
++) {
405 if (CompareGuid (&gEfiUgaIoProtocolGuid
, &(gST
->ConfigurationTable
[Index
].VendorGuid
))) {
406 DriverOsHandoffHeader
= gST
->ConfigurationTable
[Index
].VendorTable
;
407 for (Index1
= 0; Index1
< DriverOsHandoffHeader
->NumberOfEntries
; Index1
++) {
408 DriverOsHandoff
= (EFI_DRIVER_OS_HANDOFF
*)
410 (UINTN
) DriverOsHandoffHeader
+
411 DriverOsHandoffHeader
->HeaderSize
+
413 DriverOsHandoffHeader
->SizeOfEntries
415 RuntimeDriverConvertPointer (EFI_OPTIONAL_POINTER
, (VOID
**) &DriverOsHandoff
->DevicePath
);
416 RuntimeDriverConvertPointer (EFI_OPTIONAL_POINTER
, (VOID
**) &DriverOsHandoff
->PciRomImage
);
419 RuntimeDriverConvertPointer (EFI_OPTIONAL_POINTER
, (VOID
**) &(gST
->ConfigurationTable
[Index
].VendorTable
));
422 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
423 if (CompareGuid (&gEfiCapsuleGuid
, &(gST
->ConfigurationTable
[Index
].VendorGuid
))) {
424 CapsuleTable
= gST
->ConfigurationTable
[Index
].VendorTable
;
425 for (Index1
= 0; Index1
< CapsuleTable
->CapsuleArrayNumber
; Index1
++) {
426 RuntimeDriverConvertPointer (EFI_OPTIONAL_POINTER
, (VOID
**) &CapsuleTable
->CapsulePtr
[Index1
]);
428 RuntimeDriverConvertPointer (EFI_OPTIONAL_POINTER
, (VOID
**) &(gST
->ConfigurationTable
[Index
].VendorTable
));
433 // Convert the runtime fields of the EFI System Table and recompute the CRC-32
435 RuntimeDriverConvertInternalPointer ((VOID
**) &gST
->FirmwareVendor
);
436 RuntimeDriverConvertInternalPointer ((VOID
**) &gST
->ConfigurationTable
);
437 RuntimeDriverConvertInternalPointer ((VOID
**) &gST
->RuntimeServices
);
438 RuntimeDriverCalculateEfiHdrCrc (&gST
->Hdr
);
441 // At this point, gRT and gST are physical pointers, but the contents of these tables
442 // have been converted to runtime.
445 // mVirtualMap is only valid during SetVirtualAddressMap() call
454 RuntimeDriverInitialize (
455 IN EFI_HANDLE ImageHandle
,
456 IN EFI_SYSTEM_TABLE
*SystemTable
461 Install Runtime AP. This code includes the EfiDriverLib, but it functions at
462 RT in physical mode. The only Lib services are gBS, gRT, and the DEBUG and
463 ASSERT macros (they do ReportStatusCode).
466 (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)
470 EFI_SUCEESS - Runtime Driver Architectural Protocol Installed
472 Other - Return value from gBS->InstallMultipleProtocolInterfaces
477 EFI_LOADED_IMAGE_PROTOCOL
*MyLoadedImage
;
480 // This image needs to be exclued from relocation for virtual mode, so cache
481 // a copy of the Loaded Image protocol to test later.
483 Status
= gBS
->HandleProtocol (
485 &gEfiLoadedImageProtocolGuid
,
488 ASSERT_EFI_ERROR (Status
);
489 mMyImageBase
= MyLoadedImage
->ImageBase
;
492 // Initialize the table used to compute 32-bit CRCs
494 RuntimeDriverInitializeCrc32Table ();
497 // Fill in the entries of the EFI Boot Services and EFI Runtime Services Tables
499 gBS
->CalculateCrc32
= RuntimeDriverCalculateCrc32
;
500 gRT
->SetVirtualAddressMap
= RuntimeDriverSetVirtualAddressMap
;
501 gRT
->ConvertPointer
= RuntimeDriverConvertPointer
;
504 // Install the Runtime Architectural Protocol onto a new handle
506 Status
= gBS
->InstallMultipleProtocolInterfaces (
508 &gEfiRuntimeArchProtocolGuid
,
512 ASSERT_EFI_ERROR (Status
);