Code scrub DxeIpl, Runtime, DevicePath, FvbServicesLib, DiskIo, Partition, English...

[mirror_edk2.git] / MdeModulePkg / Core / RuntimeDxe / Runtime.c

diff --git a/MdeModulePkg/Core/RuntimeDxe/Runtime.c b/MdeModulePkg/Core/RuntimeDxe/Runtime.c
index 8fdc6fad9dd5c5163c21f9b8976051ecaa194c2c..66c02b2f5b79716930b4e3ca12f2b9763824b18b 100644 (file)
--- a/MdeModulePkg/Core/RuntimeDxe/Runtime.c
+++ b/MdeModulePkg/Core/RuntimeDxe/Runtime.c
@@ -1,5 +1,6 @@
 /** @file\r
-  Runtime Architectural Protocol as defined in the DXE CIS.\r
+  This file implements Runtime Architectural Protocol as defined in the\r
+  Platform Initialization specification 1.0 VOLUME 2 DXE Core Interface.\r
 \r
   This code is used to produce the EFI runtime virtual switch over\r
 \r
@@ -14,7 +15,7 @@
   So here is the concept. The code in this module will never ever be called in\r
   virtual mode. This is the code that collects the information needed to convert\r
   to virtual mode (DXE core registers runtime stuff with this code). Since this\r
-  code is used to fixup all runtime images, it CAN NOT fix it's self up. So some\r
+  code is used to fix up all runtime images, it CAN NOT fix it's self up. So some\r
   code has to stay behind and that is us.\r
 \r
   Also you need to be careful about when you allocate memory, as once we are in\r
@@ -34,7 +35,7 @@ Revision History:
   Table now contains an item named CalculateCrc32.\r
 \r
 \r
-Copyright (c) 2006, Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2008, 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
@@ -86,7 +87,7 @@ EFI_RUNTIME_ARCH_PROTOCOL     mRuntime = {
 //\r
 /**\r
 \r
-  Calcualte the 32-bit CRC in a EFI table using the Runtime Drivers\r
+  Calculate 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
   This is a internal function.\r
@@ -158,10 +159,10 @@ RuntimeDriverConvertPointer (
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  VirtEntry             = mVirtualMap;\r
+  VirtEntry = mVirtualMap;\r
   for (Index = 0; Index < mVirtualMapMaxIndex; Index++) {\r
     //\r
-    // To prevent the inclusion of 64-bit math functions a UINTN was placed in\r
+    //  To prevent the inclusion of 64-bit math functions a UINTN was placed in\r
     //  front of VirtEntry->NumberOfPages to cast it to a 32-bit thing on IA-32\r
     //  platforms. If you get this ASSERT remove the UINTN and do a 64-bit\r
     //  multiply.\r
@@ -315,7 +316,7 @@ RuntimeDriverSetVirtualAddressMap (
         RuntimeImage->RelocationData\r
         );\r
 \r
-      InvalidateInstructionCacheRange (RuntimeImage->ImageBase, (UINTN)RuntimeImage->ImageSize);\r
+      InvalidateInstructionCacheRange (RuntimeImage->ImageBase, (UINTN) RuntimeImage->ImageSize);\r
     }\r
   }\r
 \r
@@ -362,17 +363,16 @@ RuntimeDriverSetVirtualAddressMap (
 }\r
 \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
+  Entry Point for Runtime driver.\r
 \r
+  This function installs Runtime Architectural Protocol and registers CalculateCrc32 boot services table,\r
+  SetVirtualAddressMap & ConvertPointer runtime services table.\r
 \r
   @param ImageHandle     Image handle of this driver.\r
-  @param SystemTable     Pointer to the EFI System Table.\r
+  @param SystemTable     a Pointer to the EFI System Table.\r
 \r
-  @retval  EFI_SUCEESS  Runtime Driver Architectural Protocol Installed\r
-  @return  Other value if gBS->InstallMultipleProtocolInterfaces fails. Check\r
-           gBS->InstallMultipleProtocolInterfaces for details.\r
+  @retval  EFI_SUCEESS  Runtime Driver Architectural Protocol is successfully installed\r
+  @return  Others       Some error occurs when installing Runtime Driver Architectural Protocol.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -386,7 +386,7 @@ RuntimeDriverInitialize (
   EFI_LOADED_IMAGE_PROTOCOL *MyLoadedImage;\r
 \r
   //\r
-  // This image needs to be exclued from relocation for virtual mode, so cache\r
+  // This image needs to be excluded from relocation for virtual mode, so cache\r
   // a copy of the Loaded Image protocol to test later.\r
   //\r
   Status = gBS->HandleProtocol (\r
@@ -420,5 +420,5 @@ RuntimeDriverInitialize (
                   );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
-  return EFI_SUCCESS;\r
+  return Status;\r
 }\r