beautypg.com

Settimer() – Intel Extensible Firmware Interface User Manual

Page 111

background image

Services — Boot Services

Version 1.10

12/01/02

5-13

SetTimer()

Summary

Sets the type of timer and the trigger time for a timer event.

Prototype

EFI_STATUS
SetTimer (

IN EFI_EVENT

Event,

IN EFI_TIMER_DELAY

Type,

IN UINT64

TriggerTime

);

Parameters

Event

The timer event that is to be signaled at the specified time. Type

EFI_EVENT

is defined in the

CreateEvent()

function

description.

Type

The type of time that is specified in

TriggerTime

. See the

timer delay types in “Related Definitions.”

TriggerTime

The number of 100ns units until the timer expires.

Related Definitions

//*******************************************************
//EFI_TIMER_DELAY
//*******************************************************
typedef enum {

TimerCancel,
TimerPeriodic,
TimerRelative

} EFI_TIMER_DELAY;

TimerCancel

The event’s timer setting is to be cancelled and no timer trigger is
to be set.

TriggerTime

is ignored when canceling a timer.

TimerPeriodic

The event is to be signaled periodically at

TriggerTime

intervals from the current time. This is the only timer trigger

Type

for which the event timer does not need to be reset for each

notification. All other timer trigger types are “one shot.”

TimerRelative

The event is to be signaled in

TriggerTime

100ns units.