Update comments for Protocol definitions to match UEFI spec. And add the missing...

[mirror_edk2.git] / MdePkg / Include / Protocol / Cpu.h

diff --git a/MdePkg/Include/Protocol/Cpu.h b/MdePkg/Include/Protocol/Cpu.h
index 53ad24d6d5b985e88cba5a8fcdea0f39db2a3f57..1f3a3c1523622d42f54ad5cf80c3a79743928fc5 100644 (file)
--- a/MdePkg/Include/Protocol/Cpu.h
+++ b/MdePkg/Include/Protocol/Cpu.h
@@ -206,7 +206,8 @@ EFI_STATUS
                            must be between 0 and NumberOfTimers-1.\r
   @param  TimerValue       Pointer to the returned timer value.\r
   @param  TimerPeriod      A pointer to the amount of time that passes in femtoseconds for each increment\r
-                           of TimerValue.\r
+                           of TimerValue. If TimerValue does not increment at a predictable rate, then 0 is\r
+                           returned. This parameter is optional and may be NULL.\r
 \r
   @retval EFI_SUCCESS           The processor timer value specified by TimerIndex was returned in TimerValue.\r
   @retval EFI_DEVICE_ERROR      An error occurred attempting to read one of the processor's timers.\r