2 Timer Library functions built upon local APIC on IA32/x64.
4 Copyright (c) 2006 - 2008, Intel Corporation<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include <Library/TimerLib.h>
17 #include <Library/BaseLib.h>
18 #include <Library/IoLib.h>
19 #include <Library/PcdLib.h>
20 #include <Library/DebugLib.h>
22 #define APIC_LVTERR 0x370
23 #define APIC_TMICT 0x380
24 #define APIC_TMCCT 0x390
25 #define APIC_TDCR 0x3e0
28 // The following array is used in calculating the frequency of local APIC
29 // timer. Refer to IA-32 developers' manual for more details.
31 GLOBAL_REMOVE_IF_UNREFERENCED
32 CONST UINT8 mTimerLibLocalApicDivisor
[] = {
33 0x02, 0x04, 0x08, 0x10,
34 0x02, 0x04, 0x08, 0x10,
35 0x20, 0x40, 0x80, 0x01,
36 0x20, 0x40, 0x80, 0x01
40 Internal function to retrieve the base address of local APIC.
42 @return The base address of local APIC
47 InternalX86GetApicBase (
51 return (UINTN
)AsmMsrBitFieldRead64 (27, 12, 35) << 12;
55 Internal function to return the frequency of the local APIC timer.
57 @param ApicBase The base address of memory mapped registers of local APIC.
59 @return The frequency of the timer in Hz.
64 InternalX86GetTimerFrequency (
69 PcdGet32(PcdFSBClock
) /
70 mTimerLibLocalApicDivisor
[MmioBitFieldRead32 (ApicBase
+ APIC_TDCR
, 0, 3)];
74 Internal function to read the current tick counter of local APIC.
76 @param ApicBase The base address of memory mapped registers of local APIC.
78 @return The tick counter read.
83 InternalX86GetTimerTick (
87 return MmioRead32 (ApicBase
+ APIC_TMCCT
);
91 Stalls the CPU for at least the given number of ticks.
93 Stalls the CPU for at least the given number of ticks. It's invoked by
94 MicroSecondDelay() and NanoSecondDelay().
96 @param ApicBase The base address of memory mapped registers of local APIC.
97 @param Delay A period of time to delay in ticks.
108 UINT32 PowerOfTwoCounter
;
111 // The target timer count is calculated here
113 Ticks
= InternalX86GetTimerTick (ApicBase
) - Delay
;
116 // Wait until time out
117 // Delay > 2^31 could not be handled by this function
118 // Timer wrap-arounds are handled correctly by this function
120 PowerOfTwoCounter
= GetPowerOfTwo32 (MmioRead32 (ApicBase
+ APIC_TMICT
));
121 while (((UINT32
)(InternalX86GetTimerTick (ApicBase
) - Ticks
) & PowerOfTwoCounter
) == 0) {
127 Stalls the CPU for at least the given number of microseconds.
129 Stalls the CPU for the number of microseconds specified by MicroSeconds.
131 @param MicroSeconds The minimum number of microseconds to delay.
133 @return The value of MicroSeconds inputted.
139 IN UINTN MicroSeconds
144 ApicBase
= InternalX86GetApicBase ();
149 InternalX86GetTimerFrequency (ApicBase
),
159 Stalls the CPU for at least the given number of nanoseconds.
161 Stalls the CPU for the number of nanoseconds specified by NanoSeconds.
163 @param NanoSeconds The minimum number of nanoseconds to delay.
165 @return The value of NanoSeconds inputted.
176 ApicBase
= InternalX86GetApicBase ();
181 InternalX86GetTimerFrequency (ApicBase
),
191 Retrieves the current value of a 64-bit free running performance counter.
193 The counter can either count up by 1 or count down by 1. If the physical
194 performance counter counts by a larger increment, then the counter values
195 must be translated. The properties of the counter can be retrieved from
196 GetPerformanceCounterProperties().
198 @return The current value of the free running performance counter.
203 GetPerformanceCounter (
207 return (UINT64
)(UINT32
)InternalX86GetTimerTick (InternalX86GetApicBase ());
211 Retrieves the 64-bit frequency in Hz and the range of performance counter
214 If StartValue is not NULL, then the value that the performance counter starts
215 with immediately after is it rolls over is returned in StartValue. If
216 EndValue is not NULL, then the value that the performance counter end with
217 immediately before it rolls over is returned in EndValue. The 64-bit
218 frequency of the performance counter in Hz is always returned. If StartValue
219 is less than EndValue, then the performance counter counts up. If StartValue
220 is greater than EndValue, then the performance counter counts down. For
221 example, a 64-bit free running counter that counts up would have a StartValue
222 of 0 and an EndValue of 0xFFFFFFFFFFFFFFFF. A 24-bit free running counter
223 that counts down would have a StartValue of 0xFFFFFF and an EndValue of 0.
225 @param StartValue The value the performance counter starts with when it
227 @param EndValue The value that the performance counter ends with before
230 @return The frequency in Hz.
235 GetPerformanceCounterProperties (
236 OUT UINT64
*StartValue
, OPTIONAL
237 OUT UINT64
*EndValue OPTIONAL
242 ApicBase
= InternalX86GetApicBase ();
244 if (StartValue
!= NULL
) {
245 *StartValue
= MmioRead32 (ApicBase
+ APIC_TMICT
);
247 // make sure StartValue is all 1s from High Bit
249 ASSERT ((*StartValue
& (*StartValue
+ 1)) == 0);
252 if (EndValue
!= NULL
) {
256 return (UINT64
) InternalX86GetTimerFrequency (ApicBase
);