/** @file\r
Include file of Metronome driver.\r
\r
-Copyright (c) 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2008 - 2018, 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
http://opensource.org/licenses/bsd-license.php\r
\r
/**\r
Waits for the specified number of ticks.\r
- \r
+\r
This function implements EFI_METRONOME_ARCH_PROTOCOL.WaitForTick().\r
- The WaitForTick() function waits for the number of ticks specified by \r
- 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
- 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
- WaitForTick() function. Depending on the hardware source for the ticks, it \r
- is possible for a tick to be missed. This function cannot guarantee that \r
- ticks will not be missed. If a timeout occurs waiting for the specified \r
+ The WaitForTick() function waits for the number of ticks specified by\r
+ 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
+ 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
+ WaitForTick() function. Depending on the hardware source for the ticks, it\r
+ is possible for a tick to be missed. This function cannot guarantee that\r
+ ticks will not be missed. If a timeout occurs waiting for the specified\r
number of ticks, then EFI_TIMEOUT is returned.\r
\r
@param This The EFI_METRONOME_ARCH_PROTOCOL instance.\r