4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Include file of Metronome driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Waits for the specified number of ticks.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function implements EFI_METRONOME_ARCH_PROTOCOL.WaitForTick().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The WaitForTick() function waits for the number of ticks specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TickNumber from a known time source in the platform. If TickNumber of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ticks are detected, then EFI_SUCCESS is returned. The actual time passed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync between entry of this function and the first tick is between 0 and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync time has elapsed, wait for two ticks. This function waits for a hardware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync event to determine when a tick occurs. It is possible for interrupt
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync processing, or exception processing to interrupt the execution of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WaitForTick() function. Depending on the hardware source for the ticks, it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is possible for a tick to be missed. This function cannot guarantee that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ticks will not be missed. If a timeout occurs waiting for the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of ticks, then EFI_TIMEOUT is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_METRONOME_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TickNumber Number of ticks to wait.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The wait for the number of ticks specified by TickNumber
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred waiting for the specified number of ticks.