[staging/FmpDevicePkg-master][PATCH V2] FmpDevicePkg FmpDxe: Add comment in mFmpDeviceLocked's declaration

[staging/FmpDevicePkg-master][PATCH V2] FmpDevicePkg FmpDxe: Add comment in mFmpDeviceLocked's declaration

[Star Zeng]

Add comment in mFmpDeviceLocked's declaration to make it more clear.

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>
---
 FmpDevicePkg/FmpDxe/FmpDxe.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/FmpDevicePkg/FmpDxe/FmpDxe.c b/FmpDevicePkg/FmpDxe/FmpDxe.c
index 3544afd3dee7..fb02e34f708f 100644
--- a/FmpDevicePkg/FmpDxe/FmpDxe.c
+++ b/FmpDevicePkg/FmpDxe/FmpDxe.c
@@ -89,6 +89,13 @@ UINT64  mImageId      = 0x1;
 CHAR16  *mVersionName = NULL;
 
 EFI_EVENT  mFmpDeviceLockEvent;
+//
+// Indicates if an attempt has been made to lock a 
+// FLASH storage device by calling FmpDeviceLock().
+// A FLASH storage device may not support being locked,
+// so this variable is set to TRUE even if FmpDeviceLock()
+// returns an error.
+//
 BOOLEAN    mFmpDeviceLocked = FALSE;
 
 /**
-- 
2.7.0.windows.1

Re: [staging/FmpDevicePkg-master][PATCH V2] FmpDevicePkg FmpDxe: Add comment in mFmpDeviceLocked's declaration

[Kinney, Michael D]

Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>

Mike

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-
> bounces@lists.01.org] On Behalf Of Star Zeng
> Sent: Saturday, July 28, 2018 6:51 AM
> To: edk2-devel@lists.01.org
> Cc: Kinney, Michael D <michael.d.kinney@intel.com>;
> Zeng, Star <star.zeng@intel.com>
> Subject: [edk2] [staging/FmpDevicePkg-master][PATCH V2]
> FmpDevicePkg FmpDxe: Add comment in mFmpDeviceLocked's
> declaration
> 
> Add comment in mFmpDeviceLocked's declaration to make
> it more clear.
> 
> 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>
> ---
>  FmpDevicePkg/FmpDxe/FmpDxe.c | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/FmpDevicePkg/FmpDxe/FmpDxe.c
> b/FmpDevicePkg/FmpDxe/FmpDxe.c
> index 3544afd3dee7..fb02e34f708f 100644
> --- a/FmpDevicePkg/FmpDxe/FmpDxe.c
> +++ b/FmpDevicePkg/FmpDxe/FmpDxe.c
> @@ -89,6 +89,13 @@ UINT64  mImageId      = 0x1;
>  CHAR16  *mVersionName = NULL;
> 
>  EFI_EVENT  mFmpDeviceLockEvent;
> +//
> +// Indicates if an attempt has been made to lock a
> +// FLASH storage device by calling FmpDeviceLock().
> +// A FLASH storage device may not support being
> locked,
> +// so this variable is set to TRUE even if
> FmpDeviceLock()
> +// returns an error.
> +//
>  BOOLEAN    mFmpDeviceLocked = FALSE;
> 
>  /**
> --
> 2.7.0.windows.1
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel