From: Star Zeng <star.zeng@intel.com>
Date: Sat, 28 Jul 2018 01:57:01 +0000 (+0800)
Subject: FmpDevicePkg FmpDxe: Add comment in mFmpDeviceLocked's declaration
X-Git-Tag: edk2-stable201903~1277
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=0760f5fe96509ed8510cfe2ecab9305859e6f368;hp=f1a921cab2b8d5ca587059795ff57d9fc92b8995

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>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
---

diff --git a/FmpDevicePkg/FmpDxe/FmpDxe.c b/FmpDevicePkg/FmpDxe/FmpDxe.c
index 3544afd3de..fb02e34f70 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;
 
 /**