MdeModulePkg: Minor comments update to GetNextHighMonotonicCount()

Description of the GetNextHighMonotonicCount does not state that the counter
is incremented on calling this function. However, the example usage of this
API documented relies on this behavior.

UEFI 2.6 spec is to update description to match usage documented.

The high 32-bit value is nonvolatile and is increased by 1 whenever the system
resets whenever the low 32-bit count (returned by GetNextMonoticCount()) overflows.

->

The high 32-bit value is nonvolatile and is increased by 1 whenever the system
resets, whenever GetNextHighMonotonicCount() is called, or whenever the low
32-bit count (returned by GetNextMonoticCount()) overflows.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Feng Tian <feng.tian@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@19773 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounter.c b/MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounter.c
index ddb0d2ed4991258512d258478f6020efb840b425..2bfede668106bf7bec27e0eba317108298451174 100644 (file)
--- a/MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounter.c
+++ b/MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounter.c
@@ -2,7 +2,7 @@
   Produce the UEFI boot service GetNextMonotonicCount() and runtime service\r
   GetNextHighMonotonicCount().\r
 \r
-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, 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
@@ -107,8 +107,9 @@ MonotonicCounterDriverGetNextMonotonicCount (
   comprised of two 32 bit quantities:  the high 32 bits and the low 32 bits.\r
   During boot service time the low 32 bit value is volatile:  it is reset to\r
   zero on every system reset and is increased by 1 on every call to GetNextMonotonicCount().\r
-  The high 32 bit value is non-volatile and is increased by 1 whenever the system resets\r
-  or whenever the low 32 bit count [returned by GetNextMonoticCount()] overflows.\r
+  The high 32 bit value is non-volatile and is increased by 1 whenever the system resets,\r
+  whenever GetNextHighMonotonicCount() is called, or whenever the low 32 bit count\r
+  (returned by GetNextMonoticCount()) overflows.\r
   The GetNextMonotonicCount() function is only available at boot services time.\r
   If the operating system wishes to extend the platform monotonic counter to runtime,\r
   it may do so by utilizing GetNextHighMonotonicCount().  To do this, before calling\r