EmbeddedPkg: Fix typos in comments

[mirror_edk2.git] / EmbeddedPkg / Library / HalRuntimeServicesExampleLib / Capsule.c

diff --git a/EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Capsule.c b/EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Capsule.c
index 3764bd567098159ba0e75b48abfcc0bdb3eb1122..0b1e6b086235bb2c39b114b459c0c1b50f6838a1 100644 (file)
--- a/EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Capsule.c
+++ b/EmbeddedPkg/Library/HalRuntimeServicesExampleLib/Capsule.c
@@ -2,7 +2,7 @@
   Generic Capsule services\r
 \r
   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
-  \r
+\r
   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
@@ -19,7 +19,7 @@
 //\r
 //Max size capsule services support are platform policy,to populate capsules we just need\r
 //memory to maintain them across reset,it is not a problem. And to special capsules ,for\r
-//example,update flash,it is mostly decided by the platform. Here is a sample size for \r
+//example,update flash,it is mostly decided by the platform. Here is a sample size for\r
 //different type capsules.\r
 //\r
 #define MAX_SIZE_POPULATE              (0)\r
@@ -34,8 +34,8 @@ SupportUpdateCapsuleRest (
   )\r
 {\r
   //\r
-  //If the platform has a way to guarantee the memory integrity across a system reset, return \r
-  //TRUE, else FALSE. \r
+  //If the platform has a way to guarantee the memory integrity across a system reset, return\r
+  //TRUE, else FALSE.\r
   //\r
   return FALSE;\r
 }\r
@@ -54,7 +54,7 @@ SupportCapsuleSize (
   //\r
   *MaxSizePopulate    = MAX_SIZE_POPULATE;\r
   *MaxSizeNonPopulate = MAX_SIZE_NON_POPULATE;\r
-  return; \r
+  return;\r
 }\r
 \r
 \r
@@ -77,7 +77,7 @@ Arguments:
   CapsuleHeaderArray             A array of pointers to capsule headers passed in\r
   CapsuleCount                   The number of capsule\r
   ScatterGatherList              Physical address of datablock list points to capsule\r
-  \r
+\r
 Returns:\r
 \r
   EFI STATUS\r
@@ -85,8 +85,8 @@ Returns:
                                  not set, the capsule has been successfully processed by the firmware.\r
                                  If it set, the ScattlerGatherList is successfully to be set.\r
   EFI_INVALID_PARAMETER          CapsuleCount is less than 1,CapsuleGuid is not supported.\r
-  EFI_DEVICE_ERROR               Failed to SetVariable or AllocatePool or ProcessFirmwareVolume. \r
-  \r
+  EFI_DEVICE_ERROR               Failed to SetVariable or AllocatePool or ProcessFirmwareVolume.\r
+\r
 --*/\r
 {\r
   UINTN                     CapsuleSize;\r
@@ -110,17 +110,17 @@ Returns:
   for (ArrayNumber = 0; ArrayNumber < CapsuleCount; ArrayNumber++) {\r
     CapsuleHeader = CapsuleHeaderArray[ArrayNumber];\r
     if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE)) == CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) {\r
-      return EFI_INVALID_PARAMETER;      \r
+      return EFI_INVALID_PARAMETER;\r
     }\r
     if (!CompareGuid (&CapsuleHeader->CapsuleGuid, &gEfiCapsuleGuid)) {\r
       if ((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) == 0) {\r
         return EFI_UNSUPPORTED;\r
-      }  \r
-    }   \r
+      }\r
+    }\r
   }\r
 \r
   //\r
-  //Assume that capsules have the same flags on reseting or not. \r
+  //Assume that capsules have the same flags on resetting or not.\r
   //\r
   CapsuleHeader = CapsuleHeaderArray[0];\r
 \r
@@ -131,28 +131,28 @@ Returns:
     if (!SupportUpdateCapsuleRest()) {\r
       return EFI_UNSUPPORTED;\r
     }\r
-    \r
+\r
     if (ScatterGatherList == 0) {\r
       return EFI_INVALID_PARAMETER;\r
     } else {\r
       Status = EfiSetVariable (\r
-                 EFI_CAPSULE_VARIABLE_NAME,  \r
-                 &gEfiCapsuleVendorGuid,     \r
-                 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,  \r
-                 sizeof (UINTN), \r
-                 (VOID *) &ScatterGatherList \r
+                 EFI_CAPSULE_VARIABLE_NAME,\r
+                 &gEfiCapsuleVendorGuid,\r
+                 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+                 sizeof (UINTN),\r
+                 (VOID *) &ScatterGatherList\r
                  );\r
-      if (Status != EFI_SUCCESS) { \r
+      if (Status != EFI_SUCCESS) {\r
         return EFI_DEVICE_ERROR;\r
       }\r
     }\r
     return EFI_SUCCESS;\r
   }\r
-  \r
+\r
   //\r
   //The rest occurs in the condition of non-reset mode\r
   //\r
-  if (EfiAtRuntime ()) { \r
+  if (EfiAtRuntime ()) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -169,7 +169,7 @@ Returns:
     gBS->CopyMem (BufferPtr, (UINT8*)CapsuleHeader+ CapsuleHeader->HeaderSize, CapsuleSize);\r
 \r
     //\r
-    //Call DXE service ProcessFirmwareVolume to process immediatelly \r
+    //Call DXE service ProcessFirmwareVolume to process immediatelly\r
     //\r
     Status = gDS->ProcessFirmwareVolume (BufferPtr, CapsuleSize, &FvHandle);\r
     if (Status != EFI_SUCCESS) {\r
@@ -184,7 +184,7 @@ Returns:
 Done:\r
   if (BufferPtr != NULL) {\r
     gBS->FreePool (BufferPtr);\r
-  }     \r
+  }\r
   return EFI_DEVICE_ERROR;\r
 }\r
 \r
@@ -231,10 +231,10 @@ Returns:
 \r
   if ((MaxiumCapsuleSize == NULL) ||(ResetType == NULL)) {\r
     return EFI_INVALID_PARAMETER;\r
-  }  \r
+  }\r
 \r
   CapsuleHeader = NULL;\r
-  \r
+\r
   //\r
   //Compare GUIDs with EFI_CAPSULE_GUID, if capsule header contains CAPSULE_FLAGS_PERSIST_ACROSS_RESET\r
   //and CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flags,whatever the GUID is ,the service supports.\r
@@ -242,20 +242,20 @@ Returns:
   for (ArrayNumber = 0; ArrayNumber < CapsuleCount; ArrayNumber++) {\r
     CapsuleHeader = CapsuleHeaderArray[ArrayNumber];\r
     if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE)) == CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) {\r
-      return EFI_INVALID_PARAMETER;      \r
+      return EFI_INVALID_PARAMETER;\r
     }\r
     if (!CompareGuid (&CapsuleHeader->CapsuleGuid, &gEfiCapsuleGuid)) {\r
       if ((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) == 0) {\r
         return EFI_UNSUPPORTED;\r
       }\r
-    }  \r
+    }\r
   }\r
 \r
   SupportCapsuleSize(&MaxSizePopulate,&MaxSizeNonPopulate);\r
   //\r
-  //Assume that capsules have the same flags on reseting or not. \r
+  //Assume that capsules have the same flags on resetting or not.\r
   //\r
-  CapsuleHeader = CapsuleHeaderArray[0];  \r
+  CapsuleHeader = CapsuleHeaderArray[0];\r
   if ((CapsuleHeader->Flags & CAPSULE_FLAGS_PERSIST_ACROSS_RESET) != 0) {\r
     //\r
     //Check if the platform supports update capsule across a system reset\r
@@ -264,11 +264,11 @@ Returns:
       return EFI_UNSUPPORTED;\r
     }\r
     *ResetType = EfiResetWarm;\r
-    *MaxiumCapsuleSize = MaxSizePopulate;    \r
+    *MaxiumCapsuleSize = MaxSizePopulate;\r
   } else {\r
     *ResetType = EfiResetCold;\r
     *MaxiumCapsuleSize = MaxSizeNonPopulate;\r
-  }  \r
+  }\r
   return EFI_SUCCESS;\r
 }\r
 \r