9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync Metronome Architectural Protocol as defined in PI SPEC VOLUME 2 DXE
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync This code abstracts the DXE core to provide delay services.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync This program and the accompanying materials
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync are licensed and made available under the terms and conditions of the BSD License
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync which accompanies this distribution. The full text of the license may be found at
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync/// Global ID for the Metronome Architectural Protocol
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync { 0x26baccb2, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync/// Declare forward reference for the Metronome Architectural Protocol
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsynctypedef struct _EFI_METRONOME_ARCH_PROTOCOL EFI_METRONOME_ARCH_PROTOCOL;
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync The WaitForTick() function waits for the number of ticks specified by
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync TickNumber from a known time source in the platform. If TickNumber of
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync ticks are detected, then EFI_SUCCESS is returned. The actual time passed
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync between entry of this function and the first tick is between 0 and
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync time has elapsed, wait for two ticks. This function waits for a hardware
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync event to determine when a tick occurs. It is possible for interrupt
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync processing, or exception processing to interrupt the execution of the
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync WaitForTick() function. Depending on the hardware source for the ticks, it
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync is possible for a tick to be missed. This function cannot guarantee that
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync ticks will not be missed. If a timeout occurs waiting for the specified
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync number of ticks, then EFI_TIMEOUT is returned.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync @param This The EFI_METRONOME_ARCH_PROTOCOL instance.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync @param TickNumber Number of ticks to wait.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync @retval EFI_SUCCESS The wait for the number of ticks specified by TickNumber
bcd15685b4ddca4d91544371d4c0cd79a4bf69fevboxsync @retval EFI_TIMEOUT A timeout occurred waiting for the specified number of ticks.
b9e12f78cf07f58665c0e0b2b0abba1ce7f02a5dvboxsync/// This protocol provides access to a known time source in the platform to the
b9e12f78cf07f58665c0e0b2b0abba1ce7f02a5dvboxsync/// core. The core uses this known time source to produce core services that
b9e12f78cf07f58665c0e0b2b0abba1ce7f02a5dvboxsync/// require calibrated delays.
b9e12f78cf07f58665c0e0b2b0abba1ce7f02a5dvboxsync /// The period of platform's known time source in 100 nS units.
b9e12f78cf07f58665c0e0b2b0abba1ce7f02a5dvboxsync /// This value on any platform must be at least 10 uS, and must not
7de21438395845af0147c375a00fed8f172354f6vboxsync /// exceed 200 uS. The value in this field is a constant that must
7de21438395845af0147c375a00fed8f172354f6vboxsync /// not be modified after the Metronome architectural protocol is
b9e12f78cf07f58665c0e0b2b0abba1ce7f02a5dvboxsync /// installed. All consumers must treat this as a read-only field.