-/** @file
- Template for Timer Architecture Protocol driver of the ARM flavor
-
- Copyright (c) 2008-2009, Apple Inc. All rights reserved.
-
- 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.
-
-**/
-
-
-#include <PiDxe.h>
-
-#include <Library/BaseLib.h>
-#include <Library/DebugLib.h>
-#include <Library/BaseMemoryLib.h>
-#include <Library/UefiBootServicesTableLib.h>
-#include <Library/UefiLib.h>
-#include <Library/PcdLib.h>
-#include <Library/IoLib.h>
-#include <Library/OmapLib.h>
-
-#include <Protocol/Timer.h>
-#include <Protocol/HardwareInterrupt.h>
-#include <Protocol/TimerDebugSupport.h>
-
-#include <Omap3530/Omap3530.h>
-
-
-// The notification function to call on every timer interrupt.
-volatile EFI_TIMER_NOTIFY mTimerNotifyFunction = (EFI_TIMER_NOTIFY)NULL;
-volatile EFI_PERIODIC_CALLBACK mTimerPeriodicCallback = (EFI_PERIODIC_CALLBACK)NULL;
-
-
-// The current period of the timer interrupt
-volatile UINT64 mTimerPeriod = 0;
-
-// Cached copy of the Hardware Interrupt protocol instance
-EFI_HARDWARE_INTERRUPT_PROTOCOL *gInterrupt = NULL;
-
-// Cached registers
-volatile UINT32 TISR;
-volatile UINT32 TCLR;
-volatile UINT32 TLDR;
-volatile UINT32 TCRR;
-volatile UINT32 TIER;
-
-// Cached interrupt vector
-volatile UINTN gVector;
-
-
+/** @file\r
+ Template for Timer Architecture Protocol driver of the ARM flavor\r
+\r
+ Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
+ \r
+ This program and the accompanying materials \r
+ are licensed and made available under the terms and conditions of the BSD License \r
+ which accompanies this distribution. The full text of the license may be found at \r
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+**/\r
+\r
+\r
+#include <PiDxe.h>\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/UefiLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/IoLib.h>\r
+#include <Library/OmapLib.h>\r
+\r
+#include <Protocol/Timer.h>\r
+#include <Protocol/HardwareInterrupt.h>\r
+\r
+#include <Omap3530/Omap3530.h>\r
+\r
+\r
+// The notification function to call on every timer interrupt.\r
+volatile EFI_TIMER_NOTIFY mTimerNotifyFunction = (EFI_TIMER_NOTIFY)NULL;\r
+\r
+\r
+// The current period of the timer interrupt\r
+volatile UINT64 mTimerPeriod = 0;\r
+\r
+// Cached copy of the Hardware Interrupt protocol instance\r
+EFI_HARDWARE_INTERRUPT_PROTOCOL *gInterrupt = NULL;\r
+\r
+// Cached registers\r
+volatile UINT32 TISR;\r
+volatile UINT32 TCLR;\r
+volatile UINT32 TLDR;\r
+volatile UINT32 TCRR;\r
+volatile UINT32 TIER;\r
+\r
+// Cached interrupt vector\r
+volatile UINTN gVector;\r
+\r
+\r
/**\r
+\r
C Interrupt Handler calledin the interrupt context when Source interrupt is active.\r
\r
+\r
@param Source Source of the interrupt. Hardware routing off a specific platform defines\r
what source means.\r
+\r
@param SystemContext Pointer to system register context. Mostly used by debuggers and will\r
update the system context after the return from the interrupt if \r
modified. Don't change these values unless you know what you are doing\r
\r
-**/
-VOID
-EFIAPI
-TimerInterruptHandler (
- IN HARDWARE_INTERRUPT_SOURCE Source,
- IN EFI_SYSTEM_CONTEXT SystemContext
- )
-{
+**/\r
+VOID\r
+EFIAPI\r
+TimerInterruptHandler (\r
+ IN HARDWARE_INTERRUPT_SOURCE Source,\r
+ IN EFI_SYSTEM_CONTEXT SystemContext \r
+ )\r
+{\r
EFI_TPL OriginalTPL;\r
\r
+\r
+\r
//\r
// DXE core uses this callback for the EFI timer tick. The DXE core uses locks \r
// that raise to TPL_HIGH and then restore back to current level. Thus we need\r
// to make sure TPL level is set to TPL_HIGH while we are handling the timer tick. \r
//\r
OriginalTPL = gBS->RaiseTPL (TPL_HIGH_LEVEL);\r
-
- if (mTimerPeriodicCallback) {
- mTimerPeriodicCallback(SystemContext);
- }
-
- if (mTimerNotifyFunction) {
- mTimerNotifyFunction(mTimerPeriod);
- }
-
- // Clear all timer interrupts
- MmioWrite32(TISR, TISR_CLEAR_ALL);
-
- // Poll interrupt status bits to ensure clearing
- while ((MmioRead32(TISR) & TISR_ALL_INTERRUPT_MASK) != TISR_NO_INTERRUPTS_PENDING);
-
- gBS->RestoreTPL (OriginalTPL);
-}
-
+\r
+ if (mTimerNotifyFunction) {\r
+ mTimerNotifyFunction(mTimerPeriod);\r
+ }\r
+\r
+ // Clear all timer interrupts\r
+ MmioWrite32 (TISR, TISR_CLEAR_ALL); \r
+\r
+ // Poll interrupt status bits to ensure clearing\r
+ while ((MmioRead32 (TISR) & TISR_ALL_INTERRUPT_MASK) != TISR_NO_INTERRUPTS_PENDING);\r
+\r
+ gBS->RestoreTPL (OriginalTPL);\r
+}\r
+\r
/**\r
This function registers the handler NotifyFunction so it is called every time \r
the timer interrupt fires. It also passes the amount of time since the last \r
register a handler for the timer interrupt, so it can know\r
how much time has passed. This information is used to\r
signal timer based events. NULL will unregister the handler.\r
-\r
@retval EFI_SUCCESS The timer handler was registered.\r
@retval EFI_UNSUPPORTED The platform does not support timer interrupts.\r
@retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already\r
@retval EFI_DEVICE_ERROR The timer handler could not be registered.\r
\r
**/\r
-EFI_STATUS
-EFIAPI
-TimerDriverRegisterHandler (
- IN EFI_TIMER_ARCH_PROTOCOL *This,
- IN EFI_TIMER_NOTIFY NotifyFunction
- )
-{
- if ((NotifyFunction == NULL) && (mTimerNotifyFunction == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
-
- if ((NotifyFunction != NULL) && (mTimerNotifyFunction != NULL)) {
- return EFI_ALREADY_STARTED;
- }
-
- mTimerNotifyFunction = NotifyFunction;
-
- return EFI_SUCCESS;
-}
-
+EFI_STATUS\r
+EFIAPI\r
+TimerDriverRegisterHandler (\r
+ IN EFI_TIMER_ARCH_PROTOCOL *This,\r
+ IN EFI_TIMER_NOTIFY NotifyFunction\r
+ )\r
+{\r
+ if ((NotifyFunction == NULL) && (mTimerNotifyFunction == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if ((NotifyFunction != NULL) && (mTimerNotifyFunction != NULL)) {\r
+ return EFI_ALREADY_STARTED;\r
+ }\r
+\r
+ mTimerNotifyFunction = NotifyFunction;\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
/**\r
+\r
This function adjusts the period of timer interrupts to the value specified \r
by TimerPeriod. If the timer period is updated, then the selected timer \r
period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If \r
by the timer hardware. If TimerPeriod is set to 0, then the\r
timer interrupts will be disabled.\r
\r
+\r
@retval EFI_SUCCESS The timer period was changed.\r
@retval EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.\r
@retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error.\r
\r
-**/
-EFI_STATUS
-EFIAPI
-TimerDriverSetTimerPeriod (
- IN EFI_TIMER_ARCH_PROTOCOL *This,
- IN UINT64 TimerPeriod
- )
-{
- EFI_STATUS Status;
- UINT64 TimerCount;
- INT32 LoadValue;
-
- if (TimerPeriod == 0) {
- // Turn off GPTIMER3
- MmioWrite32(TCLR, TCLR_ST_OFF);
-
- Status = gInterrupt->DisableInterruptSource(gInterrupt, gVector);
- } else {
- // Calculate required timer count
- TimerCount = DivU64x32(TimerPeriod * 100, PcdGet32(PcdEmbeddedFdPerformanceCounterPeriodInNanoseconds));
-
- // Set GPTIMER3 Load register
- LoadValue = (INT32) -TimerCount;
- MmioWrite32(TLDR, LoadValue);
- MmioWrite32(TCRR, LoadValue);
-
- // Enable Overflow interrupt
- MmioWrite32(TIER, TIER_TCAR_IT_DISABLE | TIER_OVF_IT_ENABLE | TIER_MAT_IT_DISABLE);
-
- // Turn on GPTIMER3, it will reload at overflow
- MmioWrite32(TCLR, TCLR_AR_AUTORELOAD | TCLR_ST_ON);
-
- Status = gInterrupt->EnableInterruptSource(gInterrupt, gVector);
- }
-
- //
- // Save the new timer period
- //
- mTimerPeriod = TimerPeriod;
- return Status;
-}
-
-
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+TimerDriverSetTimerPeriod (\r
+ IN EFI_TIMER_ARCH_PROTOCOL *This,\r
+ IN UINT64 TimerPeriod\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT64 TimerCount;\r
+ INT32 LoadValue;\r
+ \r
+ if (TimerPeriod == 0) {\r
+ // Turn off GPTIMER3\r
+ MmioWrite32 (TCLR, TCLR_ST_OFF);\r
+ \r
+ Status = gInterrupt->DisableInterruptSource(gInterrupt, gVector); \r
+ } else { \r
+ // Calculate required timer count\r
+ TimerCount = DivU64x32(TimerPeriod * 100, PcdGet32(PcdEmbeddedPerformanceCounterPeriodInNanoseconds));\r
+\r
+ // Set GPTIMER3 Load register\r
+ LoadValue = (INT32) -TimerCount;\r
+ MmioWrite32 (TLDR, LoadValue);\r
+ MmioWrite32 (TCRR, LoadValue);\r
+\r
+ // Enable Overflow interrupt\r
+ MmioWrite32 (TIER, TIER_TCAR_IT_DISABLE | TIER_OVF_IT_ENABLE | TIER_MAT_IT_DISABLE);\r
+\r
+ // Turn on GPTIMER3, it will reload at overflow\r
+ MmioWrite32 (TCLR, TCLR_AR_AUTORELOAD | TCLR_ST_ON);\r
+\r
+ Status = gInterrupt->EnableInterruptSource(gInterrupt, gVector); \r
+ }\r
+\r
+ //\r
+ // Save the new timer period\r
+ //\r
+ mTimerPeriod = TimerPeriod;\r
+ return Status;\r
+}\r
+\r
+\r
/**\r
This function retrieves the period of timer interrupts in 100 ns units, \r
returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod \r
@param TimerPeriod A pointer to the timer period to retrieve in 100 ns units. If\r
0 is returned, then the timer is currently disabled.\r
\r
+\r
@retval EFI_SUCCESS The timer period was returned in TimerPeriod.\r
@retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
\r
-**/
-EFI_STATUS
-EFIAPI
-TimerDriverGetTimerPeriod (
- IN EFI_TIMER_ARCH_PROTOCOL *This,
- OUT UINT64 *TimerPeriod
- )
-{
- if (TimerPeriod == NULL) {
- return EFI_INVALID_PARAMETER;
- }
-
- *TimerPeriod = mTimerPeriod;
- return EFI_SUCCESS;
-}
-
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+TimerDriverGetTimerPeriod (\r
+ IN EFI_TIMER_ARCH_PROTOCOL *This,\r
+ OUT UINT64 *TimerPeriod\r
+ )\r
+{\r
+ if (TimerPeriod == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ *TimerPeriod = mTimerPeriod;\r
+ return EFI_SUCCESS;\r
+}\r
+\r
/**\r
This function generates a soft timer interrupt. If the platform does not support soft \r
timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned. \r
@retval EFI_SUCCESS The soft timer interrupt was generated.\r
@retval EFI_UNSUPPORTED The platform does not support the generation of soft timer interrupts.\r
\r
-**/
-EFI_STATUS
-EFIAPI
-TimerDriverGenerateSoftInterrupt (
- IN EFI_TIMER_ARCH_PROTOCOL *This
- )
-{
- return EFI_UNSUPPORTED;
-}
-
-
-EFI_STATUS
-EFIAPI
-TimerDriverRegisterPeriodicCallback (
- IN TIMER_DEBUG_SUPPORT_PROTOCOL *This,
- IN EFI_PERIODIC_CALLBACK PeriodicCallback
- )
-{
- if ((PeriodicCallback == NULL) && (mTimerPeriodicCallback == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
-
- if ((PeriodicCallback != NULL) && (mTimerPeriodicCallback != NULL)) {
- return EFI_ALREADY_STARTED;
- }
-
- mTimerPeriodicCallback = PeriodicCallback;
-
- return EFI_SUCCESS;
-}
-
-
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+TimerDriverGenerateSoftInterrupt (\r
+ IN EFI_TIMER_ARCH_PROTOCOL *This\r
+ )\r
+{\r
+ return EFI_UNSUPPORTED;\r
+}\r
+\r
+\r
/**\r
Interface stucture for the Timer Architectural Protocol.\r
\r
If this function is supported, then the timer period will \r
be rounded up to the nearest supported timer period.\r
\r
+\r
@param GetTimerPeriod\r
Retrieves the period of the timer interrupt in 100 nS units.\r
\r
@param GenerateSoftInterrupt\r
Generates a soft timer interrupt that simulates the firing of \r
- the timer interrupt. This service can be used to invoke the \r
- registered handler if the timer interrupt has been masked for \r
+ the timer interrupt. This service can be used to invoke the registered handler if the timer interrupt has been masked for \r
a period of time.\r
\r
-**/
-EFI_TIMER_ARCH_PROTOCOL gTimer = {
- TimerDriverRegisterHandler,
- TimerDriverSetTimerPeriod,
- TimerDriverGetTimerPeriod,
- TimerDriverGenerateSoftInterrupt
-};
-
-TIMER_DEBUG_SUPPORT_PROTOCOL gTimerDebugSupport = {
- TimerDriverRegisterPeriodicCallback
-};
-
-
+**/\r
+EFI_TIMER_ARCH_PROTOCOL gTimer = {\r
+ TimerDriverRegisterHandler,\r
+ TimerDriverSetTimerPeriod,\r
+ TimerDriverGetTimerPeriod,\r
+ TimerDriverGenerateSoftInterrupt\r
+};\r
+\r
+\r
/**\r
Initialize the state information for the Timer Architectural Protocol and\r
the Timer Debug support protocol that allows the debugger to break into a\r
@retval EFI_OUT_OF_RESOURCES Cannot allocate protocol data structure\r
@retval EFI_DEVICE_ERROR Hardware problems\r
\r
-**/
-EFI_STATUS
-EFIAPI
-TimerInitialize (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-{
- EFI_HANDLE Handle = NULL;
- EFI_STATUS Status;
- UINT32 TimerBaseAddress;
-
- // Find the interrupt controller protocol. ASSERT if not found.
- Status = gBS->LocateProtocol(&gHardwareInterruptProtocolGuid, NULL, (VOID **)&gInterrupt);
- ASSERT_EFI_ERROR (Status);
-
- // Set up the timer registers
- TimerBaseAddress = TimerBase(FixedPcdGet32(PcdBeagleArchTimer));
- TISR = TimerBaseAddress + GPTIMER_TISR;
- TCLR = TimerBaseAddress + GPTIMER_TCLR;
- TLDR = TimerBaseAddress + GPTIMER_TLDR;
- TCRR = TimerBaseAddress + GPTIMER_TCRR;
- TIER = TimerBaseAddress + GPTIMER_TIER;
-
- // Disable the timer
- Status = TimerDriverSetTimerPeriod(&gTimer, 0);
- ASSERT_EFI_ERROR (Status);
-
- // Install interrupt handler
- gVector = InterruptVectorForTimer(FixedPcdGet32(PcdBeagleArchTimer));
- Status = gInterrupt->RegisterInterruptSource(gInterrupt, gVector, TimerInterruptHandler);
- ASSERT_EFI_ERROR (Status);
-
- // Set up default timer
- Status = TimerDriverSetTimerPeriod(&gTimer, FixedPcdGet32(PcdTimerPeriod));
- ASSERT_EFI_ERROR (Status);
-
- // Install the Timer Architectural Protocol onto a new handle
- Status = gBS->InstallMultipleProtocolInterfaces(&Handle,
- &gEfiTimerArchProtocolGuid, &gTimer,
- &gTimerDebugSupportProtocolGuid, &gTimerDebugSupport,
- NULL);
- ASSERT_EFI_ERROR(Status);
-
- return Status;
-}
-
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+TimerInitialize (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ EFI_HANDLE Handle = NULL;\r
+ EFI_STATUS Status;\r
+ UINT32 TimerBaseAddress;\r
+\r
+ // Find the interrupt controller protocol. ASSERT if not found.\r
+ Status = gBS->LocateProtocol (&gHardwareInterruptProtocolGuid, NULL, (VOID **)&gInterrupt);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ // Set up the timer registers\r
+ TimerBaseAddress = TimerBase (FixedPcdGet32(PcdOmap35xxArchTimer));\r
+ TISR = TimerBaseAddress + GPTIMER_TISR;\r
+ TCLR = TimerBaseAddress + GPTIMER_TCLR;\r
+ TLDR = TimerBaseAddress + GPTIMER_TLDR;\r
+ TCRR = TimerBaseAddress + GPTIMER_TCRR;\r
+ TIER = TimerBaseAddress + GPTIMER_TIER;\r
+\r
+ // Disable the timer\r
+ Status = TimerDriverSetTimerPeriod (&gTimer, 0);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ // Install interrupt handler\r
+ gVector = InterruptVectorForTimer (FixedPcdGet32(PcdOmap35xxArchTimer));\r
+ Status = gInterrupt->RegisterInterruptSource (gInterrupt, gVector, TimerInterruptHandler);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ // Turn on the functional clock for Timer\r
+ MmioOr32 (CM_FCLKEN_PER, CM_FCLKEN_PER_EN_GPT3_ENABLE);\r
+\r
+ // Set up default timer\r
+ Status = TimerDriverSetTimerPeriod (&gTimer, FixedPcdGet32(PcdTimerPeriod));\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ // Install the Timer Architectural Protocol onto a new handle\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &Handle,\r
+ &gEfiTimerArchProtocolGuid, &gTimer,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR(Status);\r
+\r
+ return Status;\r
+}\r
+\r
projects / mirror_edk2.git / blobdiff