-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-Module Name:\r
-\r
- Runtime.c\r
-\r
-Abstract:\r
-\r
- Runtime Architectural Protocol as defined in the DXE CIS\r
+/** @file\r
+ Runtime Architectural Protocol as defined in the DXE CIS.\r
\r
This code is used to produce the EFI runtime virtual switch over\r
\r
Runtime Arch Protocol definition no longer contains CalculateCrc32. Boot Service\r
Table now contains an item named CalculateCrc32.\r
\r
---*/\r
+\r
+Copyright (c) 2006, Intel Corporation. <BR>\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
\r
#include "Runtime.h"\r
\r
//\r
// Worker Functions\r
//\r
-STATIC\r
-VOID\r
-RuntimeDriverCalculateEfiHdrCrc (\r
- IN OUT EFI_TABLE_HEADER *Hdr\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Calcualte the 32-bit CRC in a EFI table using the Runtime Drivers\r
internal function. The EFI Boot Services Table can not be used because\r
- the EFI Boot Services Table was destroyed at ExitBootServices()\r
-\r
-Arguments:\r
+ the EFI Boot Services Table was destroyed at ExitBootServices().\r
+ This is a internal function.\r
\r
- Hdr - Pointer to an EFI standard header\r
\r
-Returns:\r
+ @param Hdr Pointer to an EFI standard header\r
\r
- None\r
-\r
---*/\r
+**/\r
+VOID\r
+RuntimeDriverCalculateEfiHdrCrc (\r
+ IN OUT EFI_TABLE_HEADER *Hdr\r
+ )\r
{\r
UINT32 Crc;\r
\r
Hdr->CRC32 = Crc;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-RuntimeDriverConvertPointer (\r
- IN UINTN DebugDisposition,\r
- IN OUT VOID **ConvertAddress\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Determines the new virtual address that is to be used on subsequent memory accesses.\r
\r
-Arguments:\r
-\r
- DebugDisposition - Supplies type information for the pointer being converted.\r
- ConvertAddress - A pointer to a pointer that is to be fixed to be the value needed\r
- for the new virtual address mappings being applied.\r
\r
-Returns:\r
+ @param DebugDisposition Supplies type information for the pointer being converted.\r
+ @param ConvertAddress A pointer to a pointer that is to be fixed to be the value needed\r
+ for the new virtual address mappings being applied.\r
\r
- EFI_SUCCESS - The pointer pointed to by Address was modified.\r
- EFI_NOT_FOUND - The pointer pointed to by Address was not found to be part\r
- of the current memory map. This is normally fatal.\r
- EFI_INVALID_PARAMETER - One of the parameters has an invalid value.\r
+ @retval EFI_SUCCESS The pointer pointed to by Address was modified.\r
+ @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part\r
+ of the current memory map. This is normally fatal.\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RuntimeDriverConvertPointer (\r
+ IN UINTN DebugDisposition,\r
+ IN OUT VOID **ConvertAddress\r
+ )\r
{\r
UINTN Address;\r
UINT64 VirtEndOfRange;\r
// If this is a null pointer, return if it's allowed\r
//\r
if (Address == 0) {\r
- if (DebugDisposition & EFI_OPTIONAL_POINTER) {\r
+ if ((DebugDisposition & EFI_OPTIONAL_POINTER) != 0) {\r
return EFI_SUCCESS;\r
}\r
\r
return EFI_NOT_FOUND;\r
}\r
\r
-STATIC\r
-EFI_STATUS\r
-RuntimeDriverConvertInternalPointer (\r
- IN OUT VOID **ConvertAddress\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Determines the new virtual address that is to be used on subsequent memory accesses\r
for internal pointers.\r
+ This is a internal function.\r
\r
-Arguments:\r
\r
- ConvertAddress - A pointer to a pointer that is to be fixed to be the value needed\r
- for the new virtual address mappings being applied.\r
+ @param ConvertAddress A pointer to a pointer that is to be fixed to be the value needed\r
+ for the new virtual address mappings being applied.\r
\r
-Returns:\r
+ @retval EFI_SUCCESS The pointer pointed to by Address was modified.\r
+ @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part\r
+ of the current memory map. This is normally fatal.\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
\r
- EFI_SUCCESS - The pointer pointed to by Address was modified.\r
- EFI_NOT_FOUND - The pointer pointed to by Address was not found to be part\r
- of the current memory map. This is normally fatal.\r
- EFI_INVALID_PARAMETER - One of the parameters has an invalid value.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+RuntimeDriverConvertInternalPointer (\r
+ IN OUT VOID **ConvertAddress\r
+ )\r
{\r
return RuntimeDriverConvertPointer (0x0, ConvertAddress);\r
}\r
\r
+/**\r
+\r
+ Changes the runtime addressing mode of EFI firmware from physical to virtual.\r
+\r
+\r
+ @param MemoryMapSize The size in bytes of VirtualMap.\r
+ @param DescriptorSize The size in bytes of an entry in the VirtualMap.\r
+ @param DescriptorVersion The version of the structure entries in VirtualMap.\r
+ @param VirtualMap An array of memory descriptors which contain new virtual\r
+ address mapping information for all runtime ranges.\r
+\r
+ @retval EFI_SUCCESS The virtual address map has been applied.\r
+ @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in\r
+ virtual address mapped mode.\r
+ @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.\r
+ @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory\r
+ map that requires a mapping.\r
+ @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found\r
+ in the memory map.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverSetVirtualAddressMap (\r
IN UINT32 DescriptorVersion,\r
IN EFI_MEMORY_DESCRIPTOR *VirtualMap\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Changes the runtime addressing mode of EFI firmware from physical to virtual.\r
-\r
-Arguments:\r
-\r
- MemoryMapSize - The size in bytes of VirtualMap.\r
- DescriptorSize - The size in bytes of an entry in the VirtualMap.\r
- DescriptorVersion - The version of the structure entries in VirtualMap.\r
- VirtualMap - An array of memory descriptors which contain new virtual\r
- address mapping information for all runtime ranges.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The virtual address map has been applied.\r
- EFI_UNSUPPORTED - EFI firmware is not at runtime, or the EFI firmware is already in\r
- virtual address mapped mode.\r
- EFI_INVALID_PARAMETER - DescriptorSize or DescriptorVersion is invalid.\r
- EFI_NO_MAPPING - A virtual address was not supplied for a range in the memory\r
- map that requires a mapping.\r
- EFI_NOT_FOUND - A virtual address was supplied for an address that is not found\r
- in the memory map.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_RUNTIME_EVENT_ENTRY *RuntimeEvent;\r
RuntimeDriverCalculateEfiHdrCrc (&gRT->Hdr);\r
\r
//\r
- // BugBug: PI requires System Configuration Tables Conversion.\r
- // Currently, we do not implement it.\r
+ // UEFI don't require System Configuration Tables Conversion.\r
//\r
\r
//\r
return EFI_SUCCESS;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-RuntimeDriverInitialize (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
Install Runtime AP. This code includes the EfiDriverLib, but it functions at\r
RT in physical mode. The only Lib services are gBS, gRT, and the DEBUG and\r
ASSERT macros (they do ReportStatusCode).\r
\r
-Arguments:\r
- (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
\r
-Returns:\r
+ @param ImageHandle Image handle of this driver.\r
+ @param SystemTable Pointer to the EFI System Table.\r
\r
- EFI_SUCEESS - Runtime Driver Architectural Protocol Installed\r
+ @retval EFI_SUCEESS Runtime Driver Architectural Protocol Installed\r
+ @return Other value if gBS->InstallMultipleProtocolInterfaces fails. Check\r
+ gBS->InstallMultipleProtocolInterfaces for details.\r
\r
- Other - Return value from gBS->InstallMultipleProtocolInterfaces\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RuntimeDriverInitialize (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_LOADED_IMAGE_PROTOCOL *MyLoadedImage;\r
projects / mirror_edk2.git / blobdiff