MdeModulePkg: Clean up source files

[mirror_edk2.git] / MdeModulePkg / Universal / EsrtDxe / EsrtDxe.c

diff --git a/MdeModulePkg/Universal/EsrtDxe/EsrtDxe.c b/MdeModulePkg/Universal/EsrtDxe/EsrtDxe.c
index 16b18e0a54dea7545ea4c005c165d5ed57435743..cab8d69e35ad9ce136ca988f6e1b18851de4d901 100644 (file)
--- a/MdeModulePkg/Universal/EsrtDxe/EsrtDxe.c
+++ b/MdeModulePkg/Universal/EsrtDxe/EsrtDxe.c
@@ -1,7 +1,7 @@
 /** @file\r
   Esrt management module.\r
 \r
 /** @file\r
   Esrt management module.\r
 \r

-Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\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
 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


@@ -20,7 +20,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 ESRT_PRIVATE_DATA mPrivate;\r
 \r
 \r
 ESRT_PRIVATE_DATA mPrivate;\r
 \r

-ESRT_MANAGEMENT_PROTOCOL  mEsrtManagementProtocolTemplate = { \r
+ESRT_MANAGEMENT_PROTOCOL  mEsrtManagementProtocolTemplate = {\r

                             EsrtDxeGetEsrtEntry,\r
                             EsrtDxeUpdateEsrtEntry,\r
                             EsrtDxeRegisterEsrtEntry,\r
                             EsrtDxeGetEsrtEntry,\r
                             EsrtDxeUpdateEsrtEntry,\r
                             EsrtDxeRegisterEsrtEntry,\r


@@ -30,11 +30,11 @@ ESRT_MANAGEMENT_PROTOCOL  mEsrtManagementProtocolTemplate = {
                             };\r
 \r
 /**\r
                             };\r
 \r
 /**\r

-  Get ESRT entry from ESRT Cache by FwClass Guid \r
+  Get ESRT entry from ESRT Cache by FwClass Guid\r
+\r
+  @param[in]       FwClass                FwClass of Esrt entry to get\r
+  @param[in, out]  Entry                  Esrt entry returned\r

 \r
 \r

-  @param[in]       FwClass                FwClass of Esrt entry to get  \r
-  @param[in, out]  Entry                  Esrt entry returned \r
-  \r

   @retval EFI_SUCCESS                   The variable saving this Esrt Entry exists.\r
   @retval EF_NOT_FOUND                  No correct variable found.\r
   @retval EFI_WRITE_PROTECTED           ESRT Cache repository is locked\r
   @retval EFI_SUCCESS                   The variable saving this Esrt Entry exists.\r
   @retval EF_NOT_FOUND                  No correct variable found.\r
   @retval EFI_WRITE_PROTECTED           ESRT Cache repository is locked\r


@@ -94,7 +94,7 @@ EsrtDxeGetEsrtEntry(
   Update one ESRT entry in ESRT Cache.\r
 \r
   @param[in]  Entry                         Esrt entry to be updated\r
   Update one ESRT entry in ESRT Cache.\r
 \r
   @param[in]  Entry                         Esrt entry to be updated\r

-  \r
+\r

   @retval EFI_SUCCESS                   Successfully update an ESRT entry in cache.\r
   @retval EFI_INVALID_PARAMETER         Entry does't exist in ESRT Cache\r
   @retval EFI_WRITE_PROTECTED           ESRT Cache repositoy is locked\r
   @retval EFI_SUCCESS                   Successfully update an ESRT entry in cache.\r
   @retval EFI_INVALID_PARAMETER         Entry does't exist in ESRT Cache\r
   @retval EFI_WRITE_PROTECTED           ESRT Cache repositoy is locked\r


@@ -107,7 +107,7 @@ EsrtDxeUpdateEsrtEntry(
   )\r
 {\r
   EFI_STATUS                Status;\r
   )\r
 {\r
   EFI_STATUS                Status;\r

-  \r
+\r

   if (Entry == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
   if (Entry == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r


@@ -139,11 +139,11 @@ EsrtDxeUpdateEsrtEntry(
 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  Non-FMP instance to unregister Esrt Entry from ESRT Cache. \r
+  Non-FMP instance to unregister Esrt Entry from ESRT Cache.\r

 \r
 \r

-  @param[in]    FwClass                FwClass of Esrt entry to Unregister  \r
-  \r
-  @retval EFI_SUCCESS             Insert all entries Successfully \r
+  @param[in]    FwClass                FwClass of Esrt entry to Unregister\r
+\r
+  @retval EFI_SUCCESS             Insert all entries Successfully\r

   @retval EFI_NOT_FOUND           Entry of FwClass does not exsit\r
 \r
 **/\r
   @retval EFI_NOT_FOUND           Entry of FwClass does not exsit\r
 \r
 **/\r


@@ -153,7 +153,7 @@ EsrtDxeUnRegisterEsrtEntry(
   IN  EFI_GUID        *FwClass\r
   )\r
 {\r
   IN  EFI_GUID        *FwClass\r
   )\r
 {\r

-  EFI_STATUS Status; \r
+  EFI_STATUS Status;\r

 \r
   if (FwClass == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
 \r
   if (FwClass == NULL) {\r
     return EFI_INVALID_PARAMETER;\r


@@ -228,7 +228,7 @@ EFI_STATUS
 EFIAPI\r
 EsrtDxeSyncFmp(\r
   VOID\r
 EFIAPI\r
 EsrtDxeSyncFmp(\r
   VOID\r

-  ) \r
+  )\r

 {\r
   EFI_STATUS                                Status;\r
   UINTN                                     Index1;\r
 {\r
   EFI_STATUS                                Status;\r
   UINTN                                     Index1;\r


@@ -238,8 +238,8 @@ EsrtDxeSyncFmp(
   EFI_FIRMWARE_MANAGEMENT_PROTOCOL          **FmpBuf;\r
   UINTN                                     NumberOfHandles;\r
   UINTN                                     *DescriptorSizeBuf;\r
   EFI_FIRMWARE_MANAGEMENT_PROTOCOL          **FmpBuf;\r
   UINTN                                     NumberOfHandles;\r
   UINTN                                     *DescriptorSizeBuf;\r

-  EFI_FIRMWARE_IMAGE_DESCRIPTOR             **FmpImageInfoBuf;  \r
-  EFI_FIRMWARE_IMAGE_DESCRIPTOR             *TempFmpImageInfo;  \r
+  EFI_FIRMWARE_IMAGE_DESCRIPTOR             **FmpImageInfoBuf;\r
+  EFI_FIRMWARE_IMAGE_DESCRIPTOR             *TempFmpImageInfo;\r

   UINT8                                     *FmpImageInfoCountBuf;\r
   UINT32                                    *FmpImageInfoDescriptorVerBuf;\r
   UINTN                                     ImageInfoSize;\r
   UINT8                                     *FmpImageInfoCountBuf;\r
   UINT32                                    *FmpImageInfoDescriptorVerBuf;\r
   UINTN                                     ImageInfoSize;\r


@@ -270,11 +270,11 @@ EsrtDxeSyncFmp(
                   &HandleBuffer\r
                   );\r
 \r
                   &HandleBuffer\r
                   );\r
 \r

- \r
-  if (Status == EFI_NOT_FOUND) { \r
+\r
+  if (Status == EFI_NOT_FOUND) {\r

     EntryNumNew = 0;\r
     goto UPDATE_REPOSITORY;\r
     EntryNumNew = 0;\r
     goto UPDATE_REPOSITORY;\r

-  } else if (EFI_ERROR(Status)){ \r
+  } else if (EFI_ERROR(Status)){\r

     goto END;\r
   }\r
 \r
     goto END;\r
   }\r
 \r


@@ -295,7 +295,7 @@ EsrtDxeSyncFmp(
 \r
   FmpImageInfoBuf = AllocateZeroPool(sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR *) * NumberOfHandles);\r
   if (FmpImageInfoBuf == NULL) {\r
 \r
   FmpImageInfoBuf = AllocateZeroPool(sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR *) * NumberOfHandles);\r
   if (FmpImageInfoBuf == NULL) {\r

-    Status = EFI_OUT_OF_RESOURCES;    \r
+    Status = EFI_OUT_OF_RESOURCES;\r

     goto END;\r
   }\r
 \r
     goto END;\r
   }\r
 \r


@@ -380,14 +380,14 @@ EsrtDxeSyncFmp(
 \r
   //\r
   // Create new FMP cache repository based on FmpImageInfoBuf\r
 \r
   //\r
   // Create new FMP cache repository based on FmpImageInfoBuf\r

-  // \r
+  //\r

   for (Index2 = 0; Index2 < NumberOfHandles; Index2++){\r
     TempFmpImageInfo = FmpImageInfoBuf[Index2];\r
     for (Index3 = 0; Index3 < FmpImageInfoCountBuf[Index2]; Index3++){\r
   for (Index2 = 0; Index2 < NumberOfHandles; Index2++){\r
     TempFmpImageInfo = FmpImageInfoBuf[Index2];\r
     for (Index3 = 0; Index3 < FmpImageInfoCountBuf[Index2]; Index3++){\r

-      if ((TempFmpImageInfo->AttributesSupported & IMAGE_ATTRIBUTE_IN_USE) != 0 \r
+      if ((TempFmpImageInfo->AttributesSupported & IMAGE_ATTRIBUTE_IN_USE) != 0\r

       && (TempFmpImageInfo->AttributesSetting & IMAGE_ATTRIBUTE_IN_USE) != 0){\r
         //\r
       && (TempFmpImageInfo->AttributesSetting & IMAGE_ATTRIBUTE_IN_USE) != 0){\r
         //\r

-        // Always put the first smallest version of Image info into ESRT cache \r
+        // Always put the first smallest version of Image info into ESRT cache\r

         //\r
         for(Index1 = 0; Index1 < EntryNumNew; Index1++) {\r
           if (CompareGuid(&EsrtRepositoryNew[Index1].FwClass, &TempFmpImageInfo->ImageTypeId)) {\r
         //\r
         for(Index1 = 0; Index1 < EntryNumNew; Index1++) {\r
           if (CompareGuid(&EsrtRepositoryNew[Index1].FwClass, &TempFmpImageInfo->ImageTypeId)) {\r


@@ -402,7 +402,7 @@ EsrtDxeSyncFmp(
         //\r
         if (Index1 == EntryNumNew){\r
           SetEsrtEntryFromFmpInfo(&EsrtRepositoryNew[EntryNumNew], TempFmpImageInfo, FmpImageInfoDescriptorVerBuf[Index2]);\r
         //\r
         if (Index1 == EntryNumNew){\r
           SetEsrtEntryFromFmpInfo(&EsrtRepositoryNew[EntryNumNew], TempFmpImageInfo, FmpImageInfoDescriptorVerBuf[Index2]);\r

-          EntryNumNew++; \r
+          EntryNumNew++;\r

           if (EntryNumNew >= PcdGet32(PcdMaxFmpEsrtCacheNum)) {\r
             break;\r
           }\r
           if (EntryNumNew >= PcdGet32(PcdMaxFmpEsrtCacheNum)) {\r
             break;\r
           }\r


@@ -471,10 +471,10 @@ END:
 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  This function locks up Esrt repository to be readonly. It should be called \r
+  This function locks up Esrt repository to be readonly. It should be called\r

   before gEfiEndOfDxeEventGroupGuid event signaled\r
 \r
   before gEfiEndOfDxeEventGroupGuid event signaled\r
 \r

-  @retval EFI_SUCCESS              Locks up FMP Non-FMP repository successfully \r
+  @retval EFI_SUCCESS              Locks up FMP Non-FMP repository successfully\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -514,14 +514,14 @@ EsrtReadyToBootEventNotify (
   IN EFI_EVENT        Event,\r
   IN VOID             *Context\r
   )\r
   IN EFI_EVENT        Event,\r
   IN VOID             *Context\r
   )\r

-{  \r
+{\r

   EFI_STATUS                 Status;\r
   EFI_SYSTEM_RESOURCE_TABLE  *EsrtTable;\r
   EFI_SYSTEM_RESOURCE_ENTRY  *FmpEsrtRepository;\r
   EFI_SYSTEM_RESOURCE_ENTRY  *NonFmpEsrtRepository;\r
   UINTN                      FmpRepositorySize;\r
   UINTN                      NonFmpRepositorySize;\r
   EFI_STATUS                 Status;\r
   EFI_SYSTEM_RESOURCE_TABLE  *EsrtTable;\r
   EFI_SYSTEM_RESOURCE_ENTRY  *FmpEsrtRepository;\r
   EFI_SYSTEM_RESOURCE_ENTRY  *NonFmpEsrtRepository;\r
   UINTN                      FmpRepositorySize;\r
   UINTN                      NonFmpRepositorySize;\r

-  \r
+\r

 \r
   FmpEsrtRepository    = NULL;\r
   NonFmpEsrtRepository = NULL;\r
 \r
   FmpEsrtRepository    = NULL;\r
   NonFmpEsrtRepository = NULL;\r


@@ -583,8 +583,8 @@ EsrtReadyToBootEventNotify (
     goto EXIT;\r
   }\r
 \r
     goto EXIT;\r
   }\r
 \r

-  EsrtTable->FwResourceVersion  = EFI_SYSTEM_RESOURCE_TABLE_FIRMWARE_RESOURCE_VERSION;                                            \r
-  EsrtTable->FwResourceCount    = (UINT32)((NonFmpRepositorySize + FmpRepositorySize) / sizeof(EFI_SYSTEM_RESOURCE_ENTRY));  \r
+  EsrtTable->FwResourceVersion  = EFI_SYSTEM_RESOURCE_TABLE_FIRMWARE_RESOURCE_VERSION;\r
+  EsrtTable->FwResourceCount    = (UINT32)((NonFmpRepositorySize + FmpRepositorySize) / sizeof(EFI_SYSTEM_RESOURCE_ENTRY));\r

   EsrtTable->FwResourceCountMax = PcdGet32(PcdMaxNonFmpEsrtCacheNum) + PcdGet32(PcdMaxFmpEsrtCacheNum);\r
 \r
   if (NonFmpRepositorySize != 0 && NonFmpEsrtRepository != NULL) {\r
   EsrtTable->FwResourceCountMax = PcdGet32(PcdMaxNonFmpEsrtCacheNum) + PcdGet32(PcdMaxFmpEsrtCacheNum);\r
 \r
   if (NonFmpRepositorySize != 0 && NonFmpEsrtRepository != NULL) {\r


@@ -617,7 +617,7 @@ EXIT:
 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  The module Entry Point of the Esrt DXE driver that manages cached ESRT repository \r
+  The module Entry Point of the Esrt DXE driver that manages cached ESRT repository\r

   & publishes ESRT table\r
 \r
   @param[in]  ImageHandle    The firmware allocated handle for the EFI image.\r
   & publishes ESRT table\r
 \r
   @param[in]  ImageHandle    The firmware allocated handle for the EFI image.\r


@@ -633,7 +633,7 @@ EsrtDxeEntryPoint (
   IN EFI_HANDLE         ImageHandle,\r
   IN EFI_SYSTEM_TABLE   *SystemTable\r
   )\r
   IN EFI_HANDLE         ImageHandle,\r
   IN EFI_SYSTEM_TABLE   *SystemTable\r
   )\r

-{  \r
+{\r

   EFI_STATUS                    Status;\r
 \r
   EfiInitializeLock (&mPrivate.FmpLock,    TPL_CALLBACK);\r
   EFI_STATUS                    Status;\r
 \r
   EfiInitializeLock (&mPrivate.FmpLock,    TPL_CALLBACK);\r