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 3544afd3dee744131f2bd3f1b129ff36ba64b4b3..fb02e34f708f68092bdc13feab4fe2793081ef1d 100644 (file)
--- a/FmpDevicePkg/FmpDxe/FmpDxe.c
+++ b/FmpDevicePkg/FmpDxe/FmpDxe.c
@@ -89,6 +89,13 @@ UINT64  mImageId      = 0x1;
 CHAR16  *mVersionName = NULL;\r
 \r
 EFI_EVENT  mFmpDeviceLockEvent;\r
+//\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
+// returns an error.\r
+//\r
 BOOLEAN    mFmpDeviceLocked = FALSE;\r
 \r
 /**\r