TickNumber from a known time source in the platform. If TickNumber of \r
ticks are detected, then EFI_SUCCESS is returned. The actual time passed \r
between entry of this function and the first tick is between 0 and \r
- TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod \r
+ TickPeriod 100 nS units. To guarantee that at least TickPeriod \r
time has elapsed, wait for two ticks. This function waits for a hardware \r
event to determine when a tick occurs. It is possible for interrupt \r
processing, or exception processing to interrupt the execution of the \r
IN UINT32 TickNumber\r
);\r
\r
-/**\r
- Interface stucture for the Metronome Architectural Protocol.\r
-\r
- @par Protocol Description:\r
- This protocol provides access to a known time source in the platform to the\r
- core. The core uses this known time source to produce core services that \r
- require calibrated delays. \r
-\r
- @param WaitForTick\r
- Waits for a specified number of ticks from a known time source \r
- in the platform. The actual time passed between entry of this \r
- function and the first tick is between 0 and TickPeriod 100 nS \r
- units. If you want to guarantee that at least TickPeriod time \r
- has elapsed, wait for two ticks.\r
-**/\r
+///\r
+/// This protocol provides access to a known time source in the platform to the\r
+/// core. The core uses this known time source to produce core services that \r
+/// require calibrated delays. \r
+///\r
struct _EFI_METRONOME_ARCH_PROTOCOL {\r
EFI_METRONOME_WAIT_FOR_TICK WaitForTick;\r
\r