MdeModulePkg: Clean up source files

[mirror_edk2.git] / MdeModulePkg / Universal / EsrtDxe / EsrtImpl.h

diff --git a/MdeModulePkg/Universal/EsrtDxe/EsrtImpl.h b/MdeModulePkg/Universal/EsrtDxe/EsrtImpl.h
index a238dfb8f78eab21f1bcdf2ebdd53b7deb46b818..e0e9673c7087f4e9d2fc39f761d39996666d57f4 100644 (file)
--- a/MdeModulePkg/Universal/EsrtDxe/EsrtImpl.h
+++ b/MdeModulePkg/Universal/EsrtDxe/EsrtImpl.h
@@ -1,7 +1,7 @@
 /** @file\r
   Esrt management implementation head file.\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
@@ -36,12 +36,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 //\r
 // Name of  Variable for Non-FMP ESRT Repository\r
-// \r
+//\r
 #define EFI_ESRT_NONFMP_VARIABLE_NAME    L"EsrtNonFmp"\r
 \r
 //\r
 // Name of Variable for FMP\r
-// \r
+//\r
 #define EFI_ESRT_FMP_VARIABLE_NAME       L"EsrtFmp"\r
 \r
 //\r
@@ -56,7 +56,7 @@ typedef struct {
   // Ready to boot event\r
   //\r
   EFI_EVENT             Event;\r
-  \r
+\r
   //\r
   // Updates to Fmp storage must be locked.\r
   //\r
@@ -70,12 +70,12 @@ typedef struct {
 \r
 \r
 /**\r
-  Find Esrt Entry stored in ESRT repository. \r
+  Find Esrt Entry stored in ESRT repository.\r
 \r
   @param[in]     FwClass           Firmware class guid in Esrt entry\r
   @param[in]     Attribute         Esrt from Non FMP or FMP instance\r
   @param[out]    Entry             Esrt entry returned\r
-  \r
+\r
   @retval EFI_SUCCESS            Successfully find an Esrt entry\r
   @retval EF_NOT_FOUND           No Esrt entry found\r
 \r
@@ -92,7 +92,7 @@ GetEsrtEntry (
 \r
   @param[in]  Entry                Esrt entry to be set\r
   @param[in]  Attribute            Esrt from Esrt private protocol or FMP instance\r
-  \r
+\r
   @retval EFI_SUCCESS          Successfully set a variable.\r
 \r
 **/\r
@@ -103,14 +103,14 @@ InsertEsrtEntry(
   );\r
 \r
 /**\r
-  Delete ESRT Entry from ESRT repository. \r
+  Delete ESRT Entry from ESRT repository.\r
 \r
-  @param[in]    FwClass              FwClass of Esrt entry to delete  \r
+  @param[in]    FwClass              FwClass of Esrt entry to delete\r
   @param[in]    Attribute            Esrt from Esrt private protocol or FMP instance\r
-  \r
-  @retval EFI_SUCCESS         Insert all entries Successfully \r
+\r
+  @retval EFI_SUCCESS         Insert all entries Successfully\r
   @retval EFI_NOT_FOUND       ESRT entry with FwClass doesn't exsit\r
-  \r
+\r
 **/\r
 EFI_STATUS\r
 DeleteEsrtEntry(\r
@@ -123,7 +123,7 @@ DeleteEsrtEntry(
 \r
   @param[in]    Entry                Esrt entry to be set\r
   @param[in]    Attribute            Esrt from Non Esrt or FMP instance\r
-  \r
+\r
   @retval EFI_SUCCESS          Successfully Update a variable.\r
   @retval EFI_NOT_FOUND        The Esrt enry doesn't exist\r
 \r
@@ -140,9 +140,9 @@ UpdateEsrtEntry(
   @param[in, out]    EsrtEntry             Esrt entry to be Init\r
   @param[in]         FmpImageInfo          FMP image info descriptor\r
   @param[in]         DescriptorVersion     FMP Image info descriptor version\r
-  \r
+\r
 **/\r
-VOID \r
+VOID\r
 SetEsrtEntryFromFmpInfo (\r
   IN OUT EFI_SYSTEM_RESOURCE_ENTRY   *EsrtEntry,\r
   IN EFI_FIRMWARE_IMAGE_DESCRIPTOR   *FmpImageInfo,\r
@@ -150,11 +150,11 @@ SetEsrtEntryFromFmpInfo (
   );\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
-  @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
@@ -171,7 +171,7 @@ EsrtDxeGetEsrtEntry(
   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 is locked\r
@@ -184,11 +184,11 @@ EsrtDxeUpdateEsrtEntry(
   );\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
+  @param[in]    FwClass                FwClass of Esrt entry to Unregister\r
 \r
-  @param[in]    FwClass                FwClass of Esrt entry to Unregister  \r
-  \r
-  @retval EFI_SUCCESS             Insert all entries Successfully \r
+  @retval EFI_SUCCESS             Insert all entries Successfully\r
   @retval EFI_NOT_FOUND           Entry of FwClass does not exsit\r
 \r
 **/\r
@@ -229,10 +229,10 @@ EsrtDxeSyncFmp(
   );\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
-  @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