FmpDevicePkg: Fix code style issue
authorStar Zeng <star.zeng@intel.com>
Mon, 30 Jul 2018 09:47:57 +0000 (17:47 +0800)
committerKinney, Michael D <michael.d.kinney@intel.com>
Thu, 2 Aug 2018 21:46:19 +0000 (14:46 -0700)
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
FmpDevicePkg/FmpDevicePkg.uni
FmpDevicePkg/FmpDxe/DetectTestKey.c
FmpDevicePkg/FmpDxe/FmpDxe.c
FmpDevicePkg/FmpDxe/VariableSupport.c
FmpDevicePkg/FmpDxe/VariableSupport.h
FmpDevicePkg/Include/Library/CapsuleUpdatePolicyLib.h
FmpDevicePkg/Include/Library/FmpDeviceLib.h
FmpDevicePkg/Include/Library/FmpPayloadHeaderLib.h
FmpDevicePkg/Library/CapsuleUpdatePolicyLibNull/CapsuleUpdatePolicyLibNull.c
FmpDevicePkg/Library/FmpDeviceLibNull/FmpDeviceLib.c
FmpDevicePkg/Library/FmpPayloadHeaderLibV1/FmpPayloadHeaderLib.c

index fed1da4..a922ff4 100644 (file)
                                                                                                           "value of 0 disables the watchdog timer.  The default value is 0 (watchdog"\r
                                                                                                           "disabled)."\r
 \r
-#string STR_gEfiSecurityPkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_PROMPT  #language en-US "One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images"\r
-#string STR_gEfiSecurityPkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_HELP    #language en-US "Provides one or more PKCS7 certificates used to verify a firmware device"\r
-                                                                                                 "capsule update image.  This PCD is encoded using the Variable-Length Opaque"\r
-                                                                                                 "Data format of RFC 4506 External Data Representation Standard (XDR)."\r
-                                                                                                 "The default value is empty with 0 certificates."\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_PROMPT  #language en-US "One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images"\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_HELP    #language en-US "Provides one or more PKCS7 certificates used to verify a firmware device"\r
+                                                                                               "capsule update image.  This PCD is encoded using the Variable-Length Opaque"\r
+                                                                                               "Data format of RFC 4506 External Data Representation Standard (XDR)."\r
+                                                                                               "The default value is empty with 0 certificates."\r
 \r
-#string STR_gEfiSecurityPkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_PROMPT  #language en-US "Firmware Device Lock Event GUID."\r
-#string STR_gEfiSecurityPkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_HELP    #language en-US "An event GUID that locks the firmware device when the event is signaled."\r
-                                                                                            "If this PCD is not a valid GUID value, then the firmware device is locked"\r
-                                                                                            "when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled.  The"\r
-                                                                                            "default value is empty, so by default the firmware device is locked at the"\r
-                                                                                            "end of the DXE phase."\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_PROMPT  #language en-US "Firmware Device Lock Event GUID."\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_HELP    #language en-US "An event GUID that locks the firmware device when the event is signaled."\r
+                                                                                          "If this PCD is not a valid GUID value, then the firmware device is locked"\r
+                                                                                          "when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled.  The"\r
+                                                                                          "default value is empty, so by default the firmware device is locked at the"\r
+                                                                                          "end of the DXE phase."\r
 \r
 \r
index 0a6e37e..6dedbdf 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   Detects if PcdFmpDevicePkcs7CertBufferXdr contains a test key.\r
 \r
   Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r
index 095ceba..0f3396c 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   Produces a Firmware Management Protocol that supports updates to a firmware\r
   image stored in a firmware device with platform and firmware device specific\r
   information provided through PCDs and libraries.\r
@@ -90,7 +90,7 @@ CHAR16  *mVersionName = NULL;
 \r
 EFI_EVENT  mFmpDeviceLockEvent;\r
 //\r
-// Indicates if an attempt has been made to lock a \r
+// Indicates if an attempt has been made to lock a\r
 // FLASH storage device by calling FmpDeviceLock().\r
 // A FLASH storage device may not support being locked,\r
 // so this variable is set to TRUE even if FmpDeviceLock()\r
@@ -474,11 +474,11 @@ cleanup:
   This function allows a copy of the current firmware image to be created and saved.\r
   The saved copy could later been used, for example, in firmware image recovery or rollback.\r
 \r
-  @param[in]  This               A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r
-  @param[in]  ImageIndex         A unique number identifying the firmware image(s) within the device.\r
+  @param[in]      This           A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r
+  @param[in]      ImageIndex     A unique number identifying the firmware image(s) within the device.\r
                                  The number is between 1 and DescriptorCount.\r
-  @param[out] Image              Points to the buffer where the current image is copied to.\r
-  @param[out] ImageSize          On entry, points to the size of the buffer pointed to by Image, in bytes.\r
+  @param[in, out] Image          Points to the buffer where the current image is copied to.\r
+  @param[in, out] ImageSize      On entry, points to the size of the buffer pointed to by Image, in bytes.\r
                                  On return, points to the length of the image, in bytes.\r
 \r
   @retval EFI_SUCCESS            The device was successfully updated with the new image.\r
@@ -646,7 +646,7 @@ CheckTheImage (
   IN  UINT8                             ImageIndex,\r
   IN  CONST VOID                        *Image,\r
   IN  UINTN                             ImageSize,\r
-  OUT UINT32                            *ImageUpdateable\r
+  OUT UINT32                            *ImageUpdatable\r
   )\r
 {\r
   EFI_STATUS  Status;\r
@@ -677,8 +677,8 @@ CheckTheImage (
     PopulateDescriptor();\r
   }\r
 \r
-  if (ImageUpdateable == NULL) {\r
-    DEBUG ((DEBUG_ERROR, "FmpDxe: CheckImage() - ImageUpdateable Pointer Parameter is NULL.\n"));\r
+  if (ImageUpdatable == NULL) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe: CheckImage() - ImageUpdatable Pointer Parameter is NULL.\n"));\r
     Status = EFI_INVALID_PARAMETER;\r
     goto cleanup;\r
   }\r
@@ -686,14 +686,14 @@ CheckTheImage (
   //\r
   //Set to valid and then if any tests fail it will update this flag.\r
   //\r
-  *ImageUpdateable = IMAGE_UPDATABLE_VALID;\r
+  *ImageUpdatable = IMAGE_UPDATABLE_VALID;\r
 \r
   if (Image == NULL) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe: CheckImage() - Image Pointer Parameter is NULL.\n"));\r
     //\r
     // not sure if this is needed\r
     //\r
-    *ImageUpdateable = IMAGE_UPDATABLE_INVALID;\r
+    *ImageUpdatable = IMAGE_UPDATABLE_INVALID;\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -767,7 +767,7 @@ CheckTheImage (
   //\r
   if (ImageIndex != 1) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe: CheckImage() - Image Index Invalid.\n"));\r
-    *ImageUpdateable = IMAGE_UPDATABLE_INVALID_TYPE;\r
+    *ImageUpdatable = IMAGE_UPDATABLE_INVALID_TYPE;\r
     Status = EFI_SUCCESS;\r
     goto cleanup;\r
   }\r
@@ -785,7 +785,7 @@ CheckTheImage (
   Status = GetFmpPayloadHeaderVersion (FmpPayloadHeader, FmpPayloadSize, &Version);\r
   if (EFI_ERROR (Status)) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe: CheckTheImage() - GetFmpPayloadHeaderVersion failed %r.\n", Status));\r
-    *ImageUpdateable = IMAGE_UPDATABLE_INVALID;\r
+    *ImageUpdatable = IMAGE_UPDATABLE_INVALID;\r
     Status = EFI_SUCCESS;\r
     goto cleanup;\r
   }\r
@@ -799,7 +799,7 @@ CheckTheImage (
       "FmpDxe: CheckTheImage() - Version Lower than lowest supported version. 0x%08X < 0x%08X\n",\r
       Version, mDesc.LowestSupportedImageVersion)\r
       );\r
-    *ImageUpdateable = IMAGE_UPDATABLE_INVALID_OLD;\r
+    *ImageUpdatable = IMAGE_UPDATABLE_INVALID_OLD;\r
     Status = EFI_SUCCESS;\r
     goto cleanup;\r
   }\r
@@ -810,7 +810,7 @@ CheckTheImage (
   Status = GetFmpPayloadHeaderSize (FmpPayloadHeader, FmpPayloadSize, &FmpHeaderSize);\r
   if (EFI_ERROR (Status)) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe: CheckTheImage() - GetFmpPayloadHeaderSize failed %r.\n", Status));\r
-    *ImageUpdateable = IMAGE_UPDATABLE_INVALID;\r
+    *ImageUpdatable = IMAGE_UPDATABLE_INVALID;\r
     Status = EFI_SUCCESS;\r
     goto cleanup;\r
   }\r
@@ -830,7 +830,7 @@ CheckTheImage (
   //\r
   // FmpDeviceLib CheckImage function to do any specific checks\r
   //\r
-  Status = FmpDeviceCheckImage ((((UINT8 *)Image) + AllHeaderSize), RawSize, ImageUpdateable);\r
+  Status = FmpDeviceCheckImage ((((UINT8 *)Image) + AllHeaderSize), RawSize, ImageUpdatable);\r
   if (EFI_ERROR (Status)) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe: CheckTheImage() - FmpDeviceLib CheckImage failed. Status = %r\n", Status));\r
   }\r
@@ -909,6 +909,8 @@ SetTheImage (
   EFI_STATUS  GetAttributesStatus;\r
   UINT64      AttributesSupported;\r
   UINT64      AttributesSetting;\r
+  UINT32      Version;\r
+  UINT32      LowestSupportedVersion;\r
 \r
   Status             = EFI_SUCCESS;\r
   Updateable         = 0;\r
@@ -1103,7 +1105,7 @@ SetTheImage (
   // Update the version stored in variable\r
   //\r
   if (!mRuntimeVersionSupported) {\r
-    UINT32 Version = DEFAULT_VERSION;\r
+    Version = DEFAULT_VERSION;\r
     GetFmpPayloadHeaderVersion (FmpHeader, FmpPayloadSize, &Version);\r
     SetVersionInVariable (Version);\r
   }\r
@@ -1112,9 +1114,9 @@ SetTheImage (
   // Update lowest supported variable\r
   //\r
   {\r
-    UINT32 Version = DEFAULT_LOWESTSUPPORTEDVERSION;\r
-    GetFmpPayloadHeaderLowestSupportedVersion (FmpHeader, FmpPayloadSize, &Version);\r
-    SetLowestSupportedVersionInVariable (Version);\r
+    LowestSupportedVersion = DEFAULT_LOWESTSUPPORTEDVERSION;\r
+    GetFmpPayloadHeaderLowestSupportedVersion (FmpHeader, FmpPayloadSize, &LowestSupportedVersion);\r
+    SetLowestSupportedVersionInVariable (LowestSupportedVersion);\r
   }\r
 \r
   LastAttemptStatus = LAST_ATTEMPT_STATUS_SUCCESS;\r
index 6a4330a..b7e4cb9 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   UEFI variable support functions for Firmware Management Protocol based\r
   firmware updates.\r
 \r
@@ -305,8 +305,8 @@ SetVersionInVariable (
 \r
   UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpLsv"\r
 \r
-  @param[in] LowestSupported  The lowest supported version of the firmware image\r
-                              in the firmware device.\r
+  @param[in] LowestSupportedVersion The lowest supported version of the firmware image\r
+                                    in the firmware device.\r
 \r
 **/\r
 VOID\r
index e7e34f5..62c213e 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   UEFI variable support functions for Firmware Management Protocol based\r
   firmware updates.\r
 \r
@@ -128,8 +128,8 @@ SetVersionInVariable (
 \r
   UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpLsv"\r
 \r
-  @param[in] LowestSupported  The lowest supported version of the firmware image\r
-                              in the firmware device.\r
+  @param[in] LowestSupportedVersion The lowest supported version of the firmware image\r
+                                    in the firmware device.\r
 \r
 **/\r
 VOID\r
index acd3ce5..b5fffc9 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   Provides platform policy services used during a capsule update.\r
 \r
   Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r
@@ -63,7 +63,7 @@ CheckSystemPower (
 EFI_STATUS\r
 EFIAPI\r
 CheckSystemThermal (\r
-  IN OUT BOOLEAN  *Good\r
+  OUT BOOLEAN   *Good\r
   );\r
 \r
 /**\r
@@ -82,7 +82,7 @@ CheckSystemThermal (
 EFI_STATUS\r
 EFIAPI\r
 CheckSystemEnvironment (\r
-  IN OUT BOOLEAN  *Good\r
+  OUT BOOLEAN   *Good\r
   );\r
 \r
 /**\r
index 08125f0..e882b14 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   Provides firmware device specific services to support updates of a firmware\r
   image stored in a firmware device.\r
 \r
@@ -147,8 +147,8 @@ FmpDeviceGetImageTypeIdGuidPtr (
 EFI_STATUS\r
 EFIAPI\r
 FmpDeviceGetAttributes (\r
-  IN OUT UINT64  *Supported,\r
-  IN OUT UINT64  *Setting\r
+  OUT UINT64    *Supported,\r
+  OUT UINT64    *Setting\r
   );\r
 \r
 /**\r
@@ -256,9 +256,9 @@ FmpDeviceGetVersion (
         a copy currently stored firmware image.  This can be used to support\r
         features such as recovery and rollback.\r
 \r
-  @param[out]    Image      Pointer to a caller allocated buffer where the\r
+  @param[out]     Image     Pointer to a caller allocated buffer where the\r
                             currently stored firmware image is copied to.\r
-  @param[in out] ImageSize  Pointer the size, in bytes, of the Image buffer.\r
+  @param[in, out] ImageSize Pointer the size, in bytes, of the Image buffer.\r
                             On return, points to the size, in bytes, of firmware\r
                             image currently stored in the firmware device.\r
 \r
@@ -282,8 +282,8 @@ FmpDeviceGetVersion (
 EFI_STATUS\r
 EFIAPI\r
 FmpDeviceGetImage (\r
-  IN OUT    VOID   *Image,\r
-  IN IN OUT UINTN  *ImageSize\r
+  OUT    VOID   *Image,\r
+  IN OUT UINTN  *ImageSize\r
   );\r
 \r
 /**\r
@@ -305,9 +305,9 @@ FmpDeviceGetImage (
 \r
   @retval EFI_SUCCESS            The image was successfully checked.  Additional\r
                                  status information is returned in\r
-                                 ImageUpdateable.\r
+                                 ImageUpdatable.\r
   @retval EFI_INVALID_PARAMETER  Image is NULL.\r
-  @retval EFI_INVALID_PARAMETER  ImageUpdateable is NULL.\r
+  @retval EFI_INVALID_PARAMETER  ImageUpdatable is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -315,7 +315,7 @@ EFIAPI
 FmpDeviceCheckImage (\r
   IN  CONST VOID  *Image,\r
   IN  UINTN       ImageSize,\r
-  OUT UINT32      *ImageUpdateable\r
+  OUT UINT32      *ImageUpdatable\r
   );\r
 \r
 /**\r
index cb5622e..f959cbb 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   Provides services to retrieve values from a capsule's FMP Payload Header.\r
   The structure is not included in the library class.  Instead, services are\r
   provided to retrieve information from the FMP Payload Header.  If information\r
@@ -92,9 +92,9 @@ GetFmpPayloadHeaderVersion (
 EFI_STATUS\r
 EFIAPI\r
 GetFmpPayloadHeaderLowestSupportedVersion (\r
-  IN     CONST VOID   *Header,\r
-  IN     CONST UINTN  FmpPayloadSize,\r
-  IN OUT UINT32       *LowestSupportedVersion\r
+  IN  CONST VOID    *Header,\r
+  IN  CONST UINTN   FmpPayloadSize,\r
+  OUT UINT32        *LowestSupportedVersion\r
   );\r
 \r
 #endif\r
index d86d6ba..3f49b69 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   Provides platform policy services used during a capsule update.\r
 \r
   Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r
@@ -67,7 +67,7 @@ CheckSystemPower (
 EFI_STATUS\r
 EFIAPI\r
 CheckSystemThermal (\r
-  IN OUT BOOLEAN  *Good\r
+  OUT BOOLEAN   *Good\r
   )\r
 {\r
   *Good = TRUE;\r
@@ -90,7 +90,7 @@ CheckSystemThermal (
 EFI_STATUS\r
 EFIAPI\r
 CheckSystemEnvironment (\r
-  IN OUT BOOLEAN  *Good\r
+  OUT BOOLEAN   *Good\r
   )\r
 {\r
   *Good = TRUE;\r
index 03e8750..c918c5b 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   Provides firmware device specific services to support updates of a firmware\r
   image stored in a firmware device.\r
 \r
@@ -79,7 +79,7 @@ RegisterFmpInstaller (
 EFI_STATUS\r
 EFIAPI\r
 FmpDeviceGetSize (\r
-  IN UINTN  *Size\r
+  OUT UINTN  *Size\r
   )\r
 {\r
   if (Size == NULL) {\r
@@ -138,8 +138,8 @@ FmpDeviceGetImageTypeIdGuidPtr (
 EFI_STATUS\r
 EFIAPI\r
 FmpDeviceGetAttributes (\r
-  IN OUT UINT64  *Supported,\r
-  IN OUT UINT64  *Setting\r
+  OUT UINT64    *Supported,\r
+  OUT UINT64    *Setting\r
   )\r
 {\r
   if (Supported == NULL || Setting == NULL) {\r
@@ -268,9 +268,9 @@ FmpDeviceGetVersion (
         a copy currently stored firmware image.  This can be used to support\r
         features such as recovery and rollback.\r
 \r
-  @param[out]    Image      Pointer to a caller allocated buffer where the\r
+  @param[out]     Image     Pointer to a caller allocated buffer where the\r
                             currently stored firmware image is copied to.\r
-  @param[in out] ImageSize  Pointer the size, in bytes, of the Image buffer.\r
+  @param[in, out] ImageSize Pointer the size, in bytes, of the Image buffer.\r
                             On return, points to the size, in bytes, of firmware\r
                             image currently stored in the firmware device.\r
 \r
@@ -294,8 +294,8 @@ FmpDeviceGetVersion (
 EFI_STATUS\r
 EFIAPI\r
 FmpDeviceGetImage (\r
-  IN OUT    VOID   *Image,\r
-  IN IN OUT UINTN  *ImageSize\r
+  OUT    VOID   *Image,\r
+  IN OUT UINTN  *ImageSize\r
   )\r
 {\r
   return EFI_UNSUPPORTED;\r
@@ -320,9 +320,9 @@ FmpDeviceGetImage (
 \r
   @retval EFI_SUCCESS            The image was successfully checked.  Additional\r
                                  status information is returned in\r
-                                 ImageUpdateable.\r
+                                 ImageUpdatable.\r
   @retval EFI_INVALID_PARAMETER  Image is NULL.\r
-  @retval EFI_INVALID_PARAMETER  ImageUpdateable is NULL.\r
+  @retval EFI_INVALID_PARAMETER  ImageUpdatable is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -330,7 +330,7 @@ EFIAPI
 FmpDeviceCheckImage (\r
   IN  CONST VOID  *Image,\r
   IN  UINTN       ImageSize,\r
-  OUT UINT32      *ImageUpdateable\r
+  OUT UINT32      *ImageUpdatable\r
   )\r
 {\r
   return EFI_SUCCESS;\r
index 5f08e8b..b7cf044 100644 (file)
@@ -1,4 +1,4 @@
-/**  @file\r
+/** @file\r
   Provides services to retrieve values from Version 1 of a capsule's FMP Payload\r
   Header. The FMP Payload Header structure is not defined in the library class.\r
   Instead, services are provided to retrieve information from the FMP Payload\r
@@ -159,9 +159,9 @@ GetFmpPayloadHeaderVersion (
 EFI_STATUS\r
 EFIAPI\r
 GetFmpPayloadHeaderLowestSupportedVersion (\r
-  IN     CONST VOID   *Header,\r
-  IN     CONST UINTN  FmpPayloadSize,\r
-  IN OUT UINT32       *LowestSupportedVersion\r
+  IN  CONST VOID    *Header,\r
+  IN  CONST UINTN   FmpPayloadSize,\r
+  OUT UINT32        *LowestSupportedVersion\r
   )\r
 {\r
   FMP_PAYLOAD_HEADER  *FmpPayloadHeader;\r