123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394 |
- /** @file
- ACPI Timer implements one instance of Timer Library.
- Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include <Base.h>
- #include <Library/TimerLib.h>
- #include <Library/BaseLib.h>
- #include <Library/PcdLib.h>
- #include <Library/PciLib.h>
- #include <Library/IoLib.h>
- #include <Library/DebugLib.h>
- #include <IndustryStandard/Acpi.h>
- //
- // OVERRIDE: OverrideBegin
- //
- #include <Register/Cpuid.h>
- //
- // OVERRIDE: OverrideEnd
- //
- /**
- Internal function to retrieves the 64-bit frequency in Hz.
- Internal function to retrieves the 64-bit frequency in Hz.
- @return The frequency in Hz.
- **/
- UINT64
- InternalGetPerformanceCounterFrequency (
- VOID
- );
- /**
- The constructor function enables ACPI IO space.
- If ACPI I/O space not enabled, this function will enable it.
- It will always return RETURN_SUCCESS.
- @retval EFI_SUCCESS The constructor always returns RETURN_SUCCESS.
- **/
- RETURN_STATUS
- EFIAPI
- AcpiTimerLibConstructor (
- VOID
- )
- {
- UINTN Bus;
- UINTN Device;
- UINTN Function;
- UINTN EnableRegister;
- UINT8 EnableMask;
- //
- // ASSERT for the invalid PCD values. They must be configured to the real value.
- //
- ASSERT (PcdGet16 (PcdAcpiIoPciBarRegisterOffset) != 0xFFFF);
- ASSERT (PcdGet16 (PcdAcpiIoPortBaseAddress) != 0xFFFF);
- //
- // If the register offset to the BAR for the ACPI I/O Port Base Address is 0x0000, then
- // no PCI register programming is required to enable access to the the ACPI registers
- // specified by PcdAcpiIoPortBaseAddress
- //
- if (PcdGet16 (PcdAcpiIoPciBarRegisterOffset) == 0x0000) {
- return RETURN_SUCCESS;
- }
- //
- // ASSERT for the invalid PCD values. They must be configured to the real value.
- //
- ASSERT (PcdGet8 (PcdAcpiIoPciDeviceNumber) != 0xFF);
- ASSERT (PcdGet8 (PcdAcpiIoPciFunctionNumber) != 0xFF);
- ASSERT (PcdGet16 (PcdAcpiIoPciEnableRegisterOffset) != 0xFFFF);
- //
- // Retrieve the PCD values for the PCI configuration space required to program the ACPI I/O Port Base Address
- //
- Bus = PcdGet8 (PcdAcpiIoPciBusNumber);
- Device = PcdGet8 (PcdAcpiIoPciDeviceNumber);
- Function = PcdGet8 (PcdAcpiIoPciFunctionNumber);
- EnableRegister = PcdGet16 (PcdAcpiIoPciEnableRegisterOffset);
- EnableMask = PcdGet8 (PcdAcpiIoBarEnableMask);
- //
- // If ACPI I/O space is not enabled yet, program ACPI I/O base address and enable it.
- //
- if ((PciRead8 (PCI_LIB_ADDRESS (Bus, Device, Function, EnableRegister)) & EnableMask) != EnableMask) {
- PciWrite16 (
- PCI_LIB_ADDRESS (Bus, Device, Function, PcdGet16 (PcdAcpiIoPciBarRegisterOffset)),
- PcdGet16 (PcdAcpiIoPortBaseAddress)
- );
- PciOr8 (
- PCI_LIB_ADDRESS (Bus, Device, Function, EnableRegister),
- EnableMask
- );
- }
- return RETURN_SUCCESS;
- }
- /**
- Internal function to retrieve the ACPI I/O Port Base Address.
- Internal function to retrieve the ACPI I/O Port Base Address.
- @return The 16-bit ACPI I/O Port Base Address.
- **/
- UINT16
- InternalAcpiGetAcpiTimerIoPort (
- VOID
- )
- {
- UINT16 Port;
- Port = PcdGet16 (PcdAcpiIoPortBaseAddress);
- //
- // If the register offset to the BAR for the ACPI I/O Port Base Address is not 0x0000, then
- // read the PCI register for the ACPI BAR value in case the BAR has been programmed to a
- // value other than PcdAcpiIoPortBaseAddress
- //
- if (PcdGet16 (PcdAcpiIoPciBarRegisterOffset) != 0x0000) {
- Port = PciRead16 (PCI_LIB_ADDRESS (
- PcdGet8 (PcdAcpiIoPciBusNumber),
- PcdGet8 (PcdAcpiIoPciDeviceNumber),
- PcdGet8 (PcdAcpiIoPciFunctionNumber),
- PcdGet16 (PcdAcpiIoPciBarRegisterOffset)
- ));
- }
- return (Port & PcdGet16 (PcdAcpiIoPortBaseAddressMask)) + PcdGet16 (PcdAcpiPm1TmrOffset);
- }
- /**
- 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().
- @param Delay A period of time to delay in ticks.
- **/
- VOID
- InternalAcpiDelay (
- IN UINT32 Delay
- )
- {
- UINT16 Port;
- UINT32 Ticks;
- UINT32 Times;
- Port = InternalAcpiGetAcpiTimerIoPort ();
- Times = Delay >> 22;
- Delay &= BIT22 - 1;
- do {
- //
- // The target timer count is calculated here
- //
- Ticks = IoBitFieldRead32 (Port, 0, 23) + Delay;
- Delay = BIT22;
- //
- // Wait until time out
- // Delay >= 2^23 could not be handled by this function
- // Timer wrap-arounds are handled correctly by this function
- //
- while (((Ticks - IoBitFieldRead32 (Port, 0, 23)) & BIT23) == 0) {
- CpuPause ();
- }
- } while (Times-- > 0);
- }
- /**
- Stalls the CPU for at least the given number of microseconds.
- Stalls the CPU for the number of microseconds specified by MicroSeconds.
- @param MicroSeconds The minimum number of microseconds to delay.
- @return MicroSeconds
- **/
- UINTN
- EFIAPI
- MicroSecondDelay (
- IN UINTN MicroSeconds
- )
- {
- InternalAcpiDelay (
- (UINT32)DivU64x32 (
- MultU64x32 (
- MicroSeconds,
- ACPI_TIMER_FREQUENCY
- ),
- 1000000u
- )
- );
- return MicroSeconds;
- }
- /**
- Stalls the CPU for at least the given number of nanoseconds.
- Stalls the CPU for the number of nanoseconds specified by NanoSeconds.
- @param NanoSeconds The minimum number of nanoseconds to delay.
- @return NanoSeconds
- **/
- UINTN
- EFIAPI
- NanoSecondDelay (
- IN UINTN NanoSeconds
- )
- {
- InternalAcpiDelay (
- (UINT32)DivU64x32 (
- MultU64x32 (
- NanoSeconds,
- ACPI_TIMER_FREQUENCY
- ),
- 1000000000u
- )
- );
- return NanoSeconds;
- }
- /**
- 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().
- @return The current value of the free running performance counter.
- **/
- UINT64
- EFIAPI
- GetPerformanceCounter (
- VOID
- )
- {
- return AsmReadTsc ();
- }
- /**
- 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.
- @param StartValue The value the performance counter starts with when it
- rolls over.
- @param EndValue The value that the performance counter ends with before
- it rolls over.
- @return The frequency in Hz.
- **/
- UINT64
- EFIAPI
- GetPerformanceCounterProperties (
- OUT UINT64 *StartValue, OPTIONAL
- OUT UINT64 *EndValue OPTIONAL
- )
- {
- if (StartValue != NULL) {
- *StartValue = 0;
- }
- if (EndValue != NULL) {
- *EndValue = 0xffffffffffffffffULL;
- }
- return InternalGetPerformanceCounterFrequency ();
- }
- /**
- 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.
- @param Ticks The number of elapsed ticks of running performance counter.
- @return The elapsed time in nanoseconds.
- **/
- UINT64
- EFIAPI
- GetTimeInNanoSecond (
- IN UINT64 Ticks
- )
- {
- UINT64 Frequency;
- UINT64 NanoSeconds;
- UINT64 Remainder;
- INTN Shift;
- Frequency = GetPerformanceCounterProperties (NULL, NULL);
- //
- // Ticks
- // Time = --------- x 1,000,000,000
- // Frequency
- //
- NanoSeconds = MultU64x32 (DivU64x64Remainder (Ticks, Frequency, &Remainder), 1000000000u);
- //
- // Ensure (Remainder * 1,000,000,000) will not overflow 64-bit.
- // Since 2^29 < 1,000,000,000 = 0x3B9ACA00 < 2^30, Remainder should < 2^(64-30) = 2^34,
- // i.e. highest bit set in Remainder should <= 33.
- //
- Shift = MAX (0, HighBitSet64 (Remainder) - 33);
- Remainder = RShiftU64 (Remainder, (UINTN) Shift);
- Frequency = RShiftU64 (Frequency, (UINTN) Shift);
- NanoSeconds += DivU64x64Remainder (MultU64x32 (Remainder, 1000000000u), Frequency, NULL);
- return NanoSeconds;
- }
- //
- // OVERRIDE: OverrideBegin
- //
- /**
- Calculate TSC frequency.
- The TSC counting frequency is determined by using CPUID leaf 0x15 that is the preferred
- method for Skylake and beyond. Frequency in MHz = Core XTAL frequency * EBX/EAX.
- In newer flavors of the CPU, core xtal frequency is returned in ECX (or 0 if not
- supported). If ECX is 0, 24MHz is assumed.
- @return The number of TSC counts per second.
- **/
- UINT64
- InternalCalculateTscFrequency (
- VOID
- )
- {
- UINT64 TscFrequency;
- UINT64 CoreXtalFrequency;
- UINT32 RegEax;
- UINT32 RegEbx;
- UINT32 RegEcx;
- //
- // Use CPUID leaf 0x15.
- // TSC frequency = (Core Xtal Frequency) * EBX/EAX. EBX returns 0 if not
- // supported. ECX, if non zero, provides Core Xtal Frequency in hertz
- // (SDM Dec 2016).
- //
- AsmCpuid (CPUID_TIME_STAMP_COUNTER, &RegEax, &RegEbx, &RegEcx, NULL);
- ASSERT (RegEbx != 0);
- //
- // If core xtal frequency (ECX) returns 0, it is safe to use 24MHz for post
- // Skylake client CPU's.
- //
- if (RegEcx == 0) {
- CoreXtalFrequency = 24000000ul;
- } else {
- CoreXtalFrequency = (UINT64)RegEcx;
- }
- //
- // Calculate frequency. For integer division, round up/down result
- // correctly by adding denominator/2 to the numerator prior to division.
- //
- TscFrequency = DivU64x32 (MultU64x32 (CoreXtalFrequency, RegEbx) + (UINT64)(RegEax >> 1), RegEax);
- return TscFrequency;
- }
- //
- // OVERRIDE: OverrideEnd
- //
|