DxeTimerLib.c File Reference

#include <PiPei.h>
#include <Library/BaseLib.h>
#include <Library/TimerLib.h>
#include <Library/DebugLib.h>
#include <Library/EmuThunkLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Protocol/Timer.h>

Go to the source code of this file.

Functions
VOID EFIAPI	RegisterTimerArchProtocol (IN EFI_EVENT Event, IN VOID *Context)
UINTN EFIAPI	MicroSecondDelay (IN UINTN MicroSeconds)
UINTN EFIAPI	NanoSecondDelay (IN UINTN NanoSeconds)
UINT64 EFIAPI	GetPerformanceCounter (VOID)
UINT64 EFIAPI	GetPerformanceCounterProperties (OUT UINT64 *StartValue OPTIONAL, OUT UINT64 *EndValue OPTIONAL)
EFI_STATUS EFIAPI	DxeTimerLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
UINT64 EFIAPI	GetTimeInNanoSecond (IN UINT64 Ticks)

Variables
STATIC UINT64	gTimerPeriod = 0
STATIC EFI_TIMER_ARCH_PROTOCOL *	gTimerAp = NULL
STATIC EFI_EVENT	gTimerEvent = NULL
STATIC VOID *	gRegistration = NULL

Detailed Description

A non-functional instance of the Timer Library.

Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DxeTimerLib.c.

Function Documentation

DxeTimerLibConstructor()

EFI_STATUS EFIAPI DxeTimerLibConstructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Register for the Timer AP protocol.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS

The constructor always returns EFI_SUCCESS.

Definition at line 180 of file DxeTimerLib.c.

GetPerformanceCounter()

UINT64 EFIAPI GetPerformanceCounter

(

VOID

)

Retrieves the current value of a 64-bit free running performance counter.

The counter can either count up by 1 or count down by 1. If the physical performance counter counts by a larger increment, then the counter values must be translated. The properties of the counter can be retrieved from GetPerformanceCounterProperties().

Returns

The current value of the free running performance counter.

Definition at line 121 of file DxeTimerLib.c.

GetPerformanceCounterProperties()

UINT64 EFIAPI GetPerformanceCounterProperties	(	OUT UINT64 *StartValue	OPTIONAL,
		OUT UINT64 *EndValue	OPTIONAL
	)

Retrieves the 64-bit frequency in Hz and the range of performance counter values.

If StartValue is not NULL, then the value that the performance counter starts with immediately after is it rolls over is returned in StartValue. If EndValue is not NULL, then the value that the performance counter end with immediately before it rolls over is returned in EndValue. The 64-bit frequency of the performance counter in Hz is always returned. If StartValue is less than EndValue, then the performance counter counts up. If StartValue is greater than EndValue, then the performance counter counts down. For example, a 64-bit free running counter that counts up would have a StartValue of 0 and an EndValue of 0xFFFFFFFFFFFFFFFF. A 24-bit free running counter that counts down would have a StartValue of 0xFFFFFF and an EndValue of 0.

Parameters

StartValue	The value the performance counter starts with when it rolls over.
EndValue	The value that the performance counter ends with before it rolls over.

Returns

The frequency in Hz.

Definition at line 153 of file DxeTimerLib.c.

GetTimeInNanoSecond()

UINT64 EFIAPI GetTimeInNanoSecond

(

IN UINT64

Ticks

)

Converts elapsed ticks of performance counter to time in nanoseconds.

This function converts the elapsed ticks of running performance counter to time value in unit of nanoseconds.

Parameters

Ticks

The number of elapsed ticks of running performance counter.

Returns

The elapsed time in nanoseconds.

Definition at line 209 of file DxeTimerLib.c.

MicroSecondDelay()

UINTN EFIAPI MicroSecondDelay

(

IN UINTN

MicroSeconds

)

Stalls the CPU for at least the given number of microseconds.

Stalls the CPU for the number of microseconds specified by MicroSeconds.

Parameters

MicroSeconds

The minimum number of microseconds to delay.

Returns

The value of MicroSeconds inputted.

Definition at line 60 of file DxeTimerLib.c.

NanoSecondDelay()

UINTN EFIAPI NanoSecondDelay

(

IN UINTN

NanoSeconds

)

Stalls the CPU for at least the given number of nanoseconds.

Stalls the CPU for the number of nanoseconds specified by NanoSeconds.

Parameters

NanoSeconds

The minimum number of nanoseconds to delay.

Returns

The value of NanoSeconds inputted.

Definition at line 79 of file DxeTimerLib.c.

RegisterTimerArchProtocol()

VOID EFIAPI RegisterTimerArchProtocol	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Definition at line 26 of file DxeTimerLib.c.

Variable Documentation

gRegistration

STATIC VOID* gRegistration = NULL

Definition at line 22 of file DxeTimerLib.c.

gTimerAp

STATIC EFI_TIMER_ARCH_PROTOCOL* gTimerAp = NULL

Definition at line 20 of file DxeTimerLib.c.

gTimerEvent

STATIC EFI_EVENT gTimerEvent = NULL

Definition at line 21 of file DxeTimerLib.c.

gTimerPeriod

STATIC UINT64 gTimerPeriod = 0

Definition at line 19 of file DxeTimerLib.c.