ArmArchTimerLib.c File Reference

#include <Base.h>
#include <Library/ArmLib.h>
#include <Library/BaseLib.h>
#include <Library/TimerLib.h>
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>
#include <Library/ArmGenericTimerCounterLib.h>

Go to the source code of this file.

Macros
#define	TICKS_PER_MICRO_SEC   (ArmGenericTimerGetTimerFreq ()/1000000U)
#define	MULT_U64_X_N   MultU64x64

Functions
STATIC UINTN EFIAPI	GetPlatformTimerFreq ()
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)
UINT64 EFIAPI	GetTimeInNanoSecond (IN UINT64 Ticks)

Detailed Description

Generic ARM implementation of TimerLib.h

Copyright (c) 2011 - 2021, Arm Limited. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ArmArchTimerLib.c.

Macro Definition Documentation

MULT_U64_X_N

#define MULT_U64_X_N   MultU64x64

Definition at line 24 of file ArmArchTimerLib.c.

TICKS_PER_MICRO_SEC

#define TICKS_PER_MICRO_SEC   (ArmGenericTimerGetTimerFreq ()/1000000U)

Definition at line 18 of file ArmArchTimerLib.c.

Function Documentation

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 139 of file ArmArchTimerLib.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 172 of file ArmArchTimerLib.c.

GetPlatformTimerFreq()

STATIC UINTN EFIAPI GetPlatformTimerFreq

(

)

A local utility function that returns the PCD value, if specified. Otherwise it defaults to ArmGenericTimerGetTimerFreq.

Returns

The timer frequency.

Definition at line 37 of file ArmArchTimerLib.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 203 of file ArmArchTimerLib.c.

MicroSecondDelay()

UINTN EFIAPI MicroSecondDelay

(

IN UINTN

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 input.

Definition at line 59 of file ArmArchTimerLib.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.

When the timer frequency is 1MHz, each tick corresponds to 1 microsecond. Therefore, the nanosecond delay will be rounded up to the nearest 1 microsecond.

Parameters

NanoSeconds

The minimum number of nanoseconds to delay.

Returns

The value of NanoSeconds inputted.

Definition at line 111 of file ArmArchTimerLib.c.