X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FMetronome.h;h=bef64a5963d6ac8ece342070fee7c7b0adc565b6;hp=58a9c5ff365234fd8c5716fb55295ad9d600cbe0;hb=630b41877e9a1afe59d4f8a1c22bc691fe933ff8;hpb=cce6f7aa66125df1bddf24c122f02093d47ef204 diff --git a/MdePkg/Include/Protocol/Metronome.h b/MdePkg/Include/Protocol/Metronome.h index 58a9c5ff36..bef64a5963 100644 --- a/MdePkg/Include/Protocol/Metronome.h +++ b/MdePkg/Include/Protocol/Metronome.h @@ -33,7 +33,7 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL EFI_METRONOME_ARCH_PROTOCOL; TickNumber from a known time source in the platform. If TickNumber of ticks are detected, then EFI_SUCCESS is returned. The actual time passed between entry of this function and the first tick is between 0 and - TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod + TickPeriod 100 nS units. To guarantee that at least TickPeriod time has elapsed, wait for two ticks. This function waits for a hardware event to determine when a tick occurs. It is possible for interrupt processing, or exception processing to interrupt the execution of the @@ -57,21 +57,11 @@ EFI_STATUS IN UINT32 TickNumber ); -/** - Interface stucture for the Metronome Architectural Protocol. - - @par Protocol Description: - This protocol provides access to a known time source in the platform to the - core. The core uses this known time source to produce core services that - require calibrated delays. - - @param WaitForTick - Waits for a specified number of ticks from a known time source - in the platform. The actual time passed between entry of this - function and the first tick is between 0 and TickPeriod 100 nS - units. If you want to guarantee that at least TickPeriod time - has elapsed, wait for two ticks. -**/ +/// +/// This protocol provides access to a known time source in the platform to the +/// core. The core uses this known time source to produce core services that +/// require calibrated delays. +/// struct _EFI_METRONOME_ARCH_PROTOCOL { EFI_METRONOME_WAIT_FOR_TICK WaitForTick;