2 Template for Timer Architecture Protocol driver of the ARM flavor
4 Copyright (c) 2008-2009, Apple Inc. All rights reserved.
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Library/BaseLib.h>
20 #include <Library/DebugLib.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/UefiBootServicesTableLib.h>
23 #include <Library/UefiLib.h>
24 #include <Library/PcdLib.h>
25 #include <Library/IoLib.h>
26 #include <Library/OmapLib.h>
28 #include <Protocol/Timer.h>
29 #include <Protocol/HardwareInterrupt.h>
30 #include <Protocol/TimerDebugSupport.h>
32 #include <Omap3530/Omap3530.h>
35 // The notification function to call on every timer interrupt.
36 volatile EFI_TIMER_NOTIFY mTimerNotifyFunction
= (EFI_TIMER_NOTIFY
)NULL
;
37 volatile EFI_PERIODIC_CALLBACK mTimerPeriodicCallback
= (EFI_PERIODIC_CALLBACK
)NULL
;
40 // The current period of the timer interrupt
41 volatile UINT64 mTimerPeriod
= 0;
43 // Cached copy of the Hardware Interrupt protocol instance
44 EFI_HARDWARE_INTERRUPT_PROTOCOL
*gInterrupt
= NULL
;
53 // Cached interrupt vector
54 volatile UINTN gVector
;
59 C Interrupt Handler calledin the interrupt context when Source interrupt is active.
63 @param Source Source of the interrupt. Hardware routing off a specific platform defines
67 @param SystemContext Pointer to system register context. Mostly used by debuggers and will
69 update the system context after the return from the interrupt if
71 modified. Don't change these values unless you know what you are doing
78 TimerInterruptHandler (
79 IN HARDWARE_INTERRUPT_SOURCE Source
,
80 IN EFI_SYSTEM_CONTEXT SystemContext
89 // DXE core uses this callback for the EFI timer tick. The DXE core uses locks
91 // that raise to TPL_HIGH and then restore back to current level. Thus we need
93 // to make sure TPL level is set to TPL_HIGH while we are handling the timer tick.
97 OriginalTPL
= gBS
->RaiseTPL (TPL_HIGH_LEVEL
);
100 if (mTimerPeriodicCallback
) {
101 mTimerPeriodicCallback(SystemContext
);
104 if (mTimerNotifyFunction
) {
105 mTimerNotifyFunction(mTimerPeriod
);
108 // Clear all timer interrupts
109 MmioWrite32 (TISR
, TISR_CLEAR_ALL
);
111 // Poll interrupt status bits to ensure clearing
112 while ((MmioRead32(TISR
) & TISR_ALL_INTERRUPT_MASK
) != TISR_NO_INTERRUPTS_PENDING
);
114 gBS
->RestoreTPL (OriginalTPL
);
119 This function registers the handler NotifyFunction so it is called every time
121 the timer interrupt fires. It also passes the amount of time since the last
123 handler call to the NotifyFunction. If NotifyFunction is NULL, then the
125 handler is unregistered. If the handler is registered, then EFI_SUCCESS is
127 returned. If the CPU does not support registering a timer interrupt handler,
129 then EFI_UNSUPPORTED is returned. If an attempt is made to register a handler
131 when a handler is already registered, then EFI_ALREADY_STARTED is returned.
133 If an attempt is made to unregister a handler when a handler is not registered,
135 then EFI_INVALID_PARAMETER is returned. If an error occurs attempting to
137 register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR
143 @param This The EFI_TIMER_ARCH_PROTOCOL instance.
145 @param NotifyFunction The function to call when a timer interrupt fires. This
147 function executes at TPL_HIGH_LEVEL. The DXE Core will
149 register a handler for the timer interrupt, so it can know
151 how much time has passed. This information is used to
153 signal timer based events. NULL will unregister the handler.
157 @retval EFI_SUCCESS The timer handler was registered.
159 @retval EFI_UNSUPPORTED The platform does not support timer interrupts.
161 @retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already
165 @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not
167 previously registered.
169 @retval EFI_DEVICE_ERROR The timer handler could not be registered.
177 TimerDriverRegisterHandler (
178 IN EFI_TIMER_ARCH_PROTOCOL
*This
,
179 IN EFI_TIMER_NOTIFY NotifyFunction
182 if ((NotifyFunction
== NULL
) && (mTimerNotifyFunction
== NULL
)) {
183 return EFI_INVALID_PARAMETER
;
186 if ((NotifyFunction
!= NULL
) && (mTimerNotifyFunction
!= NULL
)) {
187 return EFI_ALREADY_STARTED
;
190 mTimerNotifyFunction
= NotifyFunction
;
197 This function adjusts the period of timer interrupts to the value specified
199 by TimerPeriod. If the timer period is updated, then the selected timer
201 period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If
203 the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.
205 If an error occurs while attempting to update the timer period, then the
207 timer hardware will be put back in its state prior to this call, and
209 EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt
211 is disabled. This is not the same as disabling the CPU's interrupts.
213 Instead, it must either turn off the timer hardware, or it must adjust the
215 interrupt controller so that a CPU interrupt is not generated when the timer
221 @param This The EFI_TIMER_ARCH_PROTOCOL instance.
223 @param TimerPeriod The rate to program the timer interrupt in 100 nS units. If
225 the timer hardware is not programmable, then EFI_UNSUPPORTED is
227 returned. If the timer is programmable, then the timer period
229 will be rounded up to the nearest timer period that is supported
231 by the timer hardware. If TimerPeriod is set to 0, then the
233 timer interrupts will be disabled.
237 @retval EFI_SUCCESS The timer period was changed.
239 @retval EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.
241 @retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error.
248 TimerDriverSetTimerPeriod (
249 IN EFI_TIMER_ARCH_PROTOCOL
*This
,
250 IN UINT64 TimerPeriod
257 if (TimerPeriod
== 0) {
259 MmioWrite32 (TCLR
, TCLR_ST_OFF
);
261 Status
= gInterrupt
->DisableInterruptSource(gInterrupt
, gVector
);
263 // Calculate required timer count
264 TimerCount
= DivU64x32(TimerPeriod
* 100, PcdGet32(PcdEmbeddedFdPerformanceCounterPeriodInNanoseconds
));
266 // Set GPTIMER3 Load register
267 LoadValue
= (INT32
) -TimerCount
;
268 MmioWrite32 (TLDR
, LoadValue
);
269 MmioWrite32 (TCRR
, LoadValue
);
271 // Enable Overflow interrupt
272 MmioWrite32 (TIER
, TIER_TCAR_IT_DISABLE
| TIER_OVF_IT_ENABLE
| TIER_MAT_IT_DISABLE
);
274 // Turn on GPTIMER3, it will reload at overflow
275 MmioWrite32 (TCLR
, TCLR_AR_AUTORELOAD
| TCLR_ST_ON
);
277 Status
= gInterrupt
->EnableInterruptSource(gInterrupt
, gVector
);
281 // Save the new timer period
283 mTimerPeriod
= TimerPeriod
;
290 This function retrieves the period of timer interrupts in 100 ns units,
292 returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod
294 is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is
296 returned, then the timer is currently disabled.
300 @param This The EFI_TIMER_ARCH_PROTOCOL instance.
302 @param TimerPeriod A pointer to the timer period to retrieve in 100 ns units. If
304 0 is returned, then the timer is currently disabled.
308 @retval EFI_SUCCESS The timer period was returned in TimerPeriod.
310 @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
317 TimerDriverGetTimerPeriod (
318 IN EFI_TIMER_ARCH_PROTOCOL
*This
,
319 OUT UINT64
*TimerPeriod
322 if (TimerPeriod
== NULL
) {
323 return EFI_INVALID_PARAMETER
;
326 *TimerPeriod
= mTimerPeriod
;
332 This function generates a soft timer interrupt. If the platform does not support soft
334 timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned.
336 If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler()
338 service, then a soft timer interrupt will be generated. If the timer interrupt is
340 enabled when this service is called, then the registered handler will be invoked. The
342 registered handler should not be able to distinguish a hardware-generated timer
344 interrupt from a software-generated timer interrupt.
348 @param This The EFI_TIMER_ARCH_PROTOCOL instance.
352 @retval EFI_SUCCESS The soft timer interrupt was generated.
354 @retval EFI_UNSUPPORTED The platform does not support the generation of soft timer interrupts.
361 TimerDriverGenerateSoftInterrupt (
362 IN EFI_TIMER_ARCH_PROTOCOL
*This
365 return EFI_UNSUPPORTED
;
371 TimerDriverRegisterPeriodicCallback (
372 IN TIMER_DEBUG_SUPPORT_PROTOCOL
*This
,
373 IN EFI_PERIODIC_CALLBACK PeriodicCallback
376 if ((PeriodicCallback
== NULL
) && (mTimerPeriodicCallback
== NULL
)) {
377 return EFI_INVALID_PARAMETER
;
380 if ((PeriodicCallback
!= NULL
) && (mTimerPeriodicCallback
!= NULL
)) {
381 return EFI_ALREADY_STARTED
;
384 mTimerPeriodicCallback
= PeriodicCallback
;
392 Interface stucture for the Timer Architectural Protocol.
396 @par Protocol Description:
398 This protocol provides the services to initialize a periodic timer
400 interrupt, and to register a handler that is called each time the timer
402 interrupt fires. It may also provide a service to adjust the rate of the
404 periodic timer interrupt. When a timer interrupt occurs, the handler is
406 passed the amount of time that has passed since the previous timer
412 @param RegisterHandler
414 Registers a handler that will be called each time the
416 timer interrupt fires. TimerPeriod defines the minimum
418 time between timer interrupts, so TimerPeriod will also
420 be the minimum time between calls to the registered
426 @param SetTimerPeriod
428 Sets the period of the timer interrupt in 100 nS units.
430 This function is optional, and may return EFI_UNSUPPORTED.
432 If this function is supported, then the timer period will
434 be rounded up to the nearest supported timer period.
438 @param GetTimerPeriod
440 Retrieves the period of the timer interrupt in 100 nS units.
444 @param GenerateSoftInterrupt
446 Generates a soft timer interrupt that simulates the firing of
448 the timer interrupt. This service can be used to invoke the
450 registered handler if the timer interrupt has been masked for
457 EFI_TIMER_ARCH_PROTOCOL gTimer
= {
458 TimerDriverRegisterHandler
,
459 TimerDriverSetTimerPeriod
,
460 TimerDriverGetTimerPeriod
,
461 TimerDriverGenerateSoftInterrupt
464 TIMER_DEBUG_SUPPORT_PROTOCOL gTimerDebugSupport
= {
465 TimerDriverRegisterPeriodicCallback
471 Initialize the state information for the Timer Architectural Protocol and
473 the Timer Debug support protocol that allows the debugger to break into a
479 @param ImageHandle of the loaded driver
481 @param SystemTable Pointer to the System Table
485 @retval EFI_SUCCESS Protocol registered
487 @retval EFI_OUT_OF_RESOURCES Cannot allocate protocol data structure
489 @retval EFI_DEVICE_ERROR Hardware problems
497 IN EFI_HANDLE ImageHandle
,
498 IN EFI_SYSTEM_TABLE
*SystemTable
501 EFI_HANDLE Handle
= NULL
;
503 UINT32 TimerBaseAddress
;
505 // Find the interrupt controller protocol. ASSERT if not found.
506 Status
= gBS
->LocateProtocol(&gHardwareInterruptProtocolGuid
, NULL
, (VOID
**)&gInterrupt
);
507 ASSERT_EFI_ERROR (Status
);
509 // Set up the timer registers
510 TimerBaseAddress
= TimerBase(FixedPcdGet32(PcdBeagleArchTimer
));
511 TISR
= TimerBaseAddress
+ GPTIMER_TISR
;
512 TCLR
= TimerBaseAddress
+ GPTIMER_TCLR
;
513 TLDR
= TimerBaseAddress
+ GPTIMER_TLDR
;
514 TCRR
= TimerBaseAddress
+ GPTIMER_TCRR
;
515 TIER
= TimerBaseAddress
+ GPTIMER_TIER
;
518 Status
= TimerDriverSetTimerPeriod(&gTimer
, 0);
519 ASSERT_EFI_ERROR (Status
);
521 // Install interrupt handler
522 gVector
= InterruptVectorForTimer(FixedPcdGet32(PcdBeagleArchTimer
));
523 Status
= gInterrupt
->RegisterInterruptSource(gInterrupt
, gVector
, TimerInterruptHandler
);
524 ASSERT_EFI_ERROR (Status
);
526 // Set up default timer
527 Status
= TimerDriverSetTimerPeriod(&gTimer
, FixedPcdGet32(PcdTimerPeriod
));
528 ASSERT_EFI_ERROR (Status
);
530 // Install the Timer Architectural Protocol onto a new handle
531 Status
= gBS
->InstallMultipleProtocolInterfaces(&Handle
,
532 &gEfiTimerArchProtocolGuid
, &gTimer
,
533 &gTimerDebugSupportProtocolGuid
, &gTimerDebugSupport
,
535 ASSERT_EFI_ERROR(Status
);