MdePkg/Include/Protocol/Metronome.h File Reference


Data Structures

struct  _EFI_METRONOME_ARCH_PROTOCOL

Defines

#define EFI_METRONOME_ARCH_PROTOCOL_GUID   { 0x26baccb2, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }

Typedefs

typedef struct
_EFI_METRONOME_ARCH_PROTOCOL 
EFI_METRONOME_ARCH_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_METRONOME_WAIT_FOR_TICK )(IN EFI_METRONOME_ARCH_PROTOCOL *This, IN UINT32 TickNumber)

Variables

EFI_GUID gEfiMetronomeArchProtocolGuid

Detailed Description

Metronome Architectural Protocol as defined in PI SPEC VOLUME 2 DXE

This code abstracts the DXE core to provide delay services.

Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define EFI_METRONOME_ARCH_PROTOCOL_GUID   { 0x26baccb2, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }

Global ID for the Metronome Architectural Protocol


Typedef Documentation

Declare forward reference for the Metronome Architectural Protocol

typedef EFI_STATUS(EFIAPI * EFI_METRONOME_WAIT_FOR_TICK)(IN EFI_METRONOME_ARCH_PROTOCOL *This, IN UINT32 TickNumber)

The WaitForTick() function waits for the number of ticks specified by 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 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 WaitForTick() function. Depending on the hardware source for the ticks, it is possible for a tick to be missed. This function cannot guarantee that ticks will not be missed. If a timeout occurs waiting for the specified number of ticks, then EFI_TIMEOUT is returned.

Parameters:
This The EFI_METRONOME_ARCH_PROTOCOL instance.
TickNumber Number of ticks to wait.
Return values:
EFI_SUCCESS The wait for the number of ticks specified by TickNumber succeeded.
EFI_TIMEOUT A timeout occurred waiting for the specified number of ticks.


Variable Documentation


Generated on Wed Sep 23 16:24:23 2015 for MdePkg[ALL] by  doxygen 1.5.7.1