OpenCore  1.0.4
OpenCore Bootloader
Loading...
Searching...
No Matches
Functions | Variables
X86TimerLib.c File Reference
#include <Base.h>
#include <Library/TimerLib.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Guid/AcpiDescription.h>
#include <Library/IoLib.h>
#include <Library/PciLib.h>

Go to the source code of this file.

Functions

EFI_ACPI_DESCRIPTION * InternalGetApciDescrptionTable (VOID)
 
STATIC UINT32 InternalAcpiGetTimerTick (VOID)
 
STATIC VOID InternalAcpiDelay (IN UINT32 Delay)
 
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)
 

Variables

EFI_ACPI_DESCRIPTION * gAcpiDesc = NULL
 

Detailed Description

Timer Library functions built upon ACPI on IA32/x64.

ACPI power management timer is a 24-bit or 32-bit fixed rate free running count-up timer that runs off a 3.579545 MHz clock. When startup, Duet will check the FADT to determine whether the PM timer is a 32-bit or 24-bit timer.

Copyright (c) 2006 - 2011, 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.

Definition in file X86TimerLib.c.

Function Documentation

◆ GetPerformanceCounter()

UINT64 EFIAPI GetPerformanceCounter ( VOID )

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

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 190 of file X86TimerLib.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
StartValueThe value the performance counter starts with when it rolls over.
EndValueThe value that the performance counter ends with before it rolls over.
Returns
The frequency in Hz.

Definition at line 226 of file X86TimerLib.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
TicksThe number of elapsed ticks of running performance counter.
Returns
The elapsed time in nanoseconds.

Definition at line 259 of file X86TimerLib.c.

◆ InternalAcpiDelay()

STATIC VOID InternalAcpiDelay ( IN UINT32 Delay)

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

Stalls the CPU for at least the given number of ticks. It's invoked by MicroSecondDelay() and NanoSecondDelay().

Parameters
DelayA period of time to delay in ticks.

Definition at line 85 of file X86TimerLib.c.

◆ InternalAcpiGetTimerTick()

STATIC UINT32 InternalAcpiGetTimerTick ( VOID )

Internal function to read the current tick counter of ACPI.

Returns
The tick counter read.

Definition at line 67 of file X86TimerLib.c.

◆ InternalGetApciDescrptionTable()

EFI_ACPI_DESCRIPTION * InternalGetApciDescrptionTable ( VOID )

Internal function to get Acpi information from HOB.

Returns
Pointer to ACPI description structure.

Definition at line 37 of file X86TimerLib.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
MicroSecondsThe minimum number of microseconds to delay.
Returns
MicroSeconds

Definition at line 124 of file X86TimerLib.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
NanoSecondsThe minimum number of nanoseconds to delay.
Returns
NanoSeconds

Definition at line 156 of file X86TimerLib.c.

Variable Documentation

◆ gAcpiDesc

EFI_ACPI_DESCRIPTION* gAcpiDesc = NULL

Definition at line 29 of file X86TimerLib.c.