ArmPlatformPkg: remove unused SP804 driver and TimerLib implementation

None of the platforms we support use these so remove them.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

2 files changed, 0 insertions, 454 deletions

diff --git a/ArmPlatformPkg/Drivers/SP804TimerDxe/SP804Timer.c b/ArmPlatformPkg/Drivers/SP804TimerDxe/SP804Timer.c
deleted file mode 100644
index 7ae25e9bb9..0000000000
--- a/ArmPlatformPkg/Drivers/SP804TimerDxe/SP804Timer.c
+++ /dev/null
@@ -1,395 +0,0 @@
-/** @file

-  Template for Timer Architecture Protocol driver of the ARM flavor

-

-  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>

-  Copyright (c) 2011 - 2012, ARM Ltd. All rights reserved.<BR>

-

-  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 <Protocol/Timer.h>

-#include <Protocol/HardwareInterrupt.h>

-

-#include <Drivers/SP804Timer.h>

-

-#define SP804_TIMER_PERIODIC_BASE     ((UINTN)PcdGet32 (PcdSP804TimerPeriodicBase))

-#define SP804_TIMER_METRONOME_BASE    ((UINTN)PcdGet32 (PcdSP804TimerMetronomeBase))

-#define SP804_TIMER_PERFORMANCE_BASE  ((UINTN)PcdGet32 (PcdSP804TimerPerformanceBase))

-

-// The notification function to call on every timer interrupt.

-EFI_TIMER_NOTIFY      mTimerNotifyFunction     = (EFI_TIMER_NOTIFY)NULL;

-EFI_EVENT             EfiExitBootServicesEvent = (EFI_EVENT)NULL;

-

-// The current period of the timer interrupt

-UINT64 mTimerPeriod = 0;

-

-// Cached copy of the Hardware Interrupt protocol instance

-EFI_HARDWARE_INTERRUPT_PROTOCOL *gInterrupt = NULL;

-

-// Cached interrupt vector

-UINTN  gVector;

-

-

-/**

-

-  C Interrupt Handler called in the interrupt context when Source interrupt is active.

-

-

-  @param Source         Source of the interrupt. Hardware routing off a specific platform defines

-                        what source means.

-

-  @param SystemContext  Pointer to system register context. Mostly used by debuggers and will

-                        update the system context after the return from the interrupt if

-                        modified. Don't change these values unless you know what you are doing

-

-**/

-VOID

-EFIAPI

-TimerInterruptHandler (

-  IN  HARDWARE_INTERRUPT_SOURCE   Source,

-  IN  EFI_SYSTEM_CONTEXT          SystemContext

-  )

-{

-  EFI_TPL OriginalTPL;

-

-  //

-  // DXE core uses this callback for the EFI timer tick. The DXE core uses locks

-  // that raise to TPL_HIGH and then restore back to current level. Thus we need

-  // to make sure TPL level is set to TPL_HIGH while we are handling the timer tick.

-  //

-  OriginalTPL = gBS->RaiseTPL (TPL_HIGH_LEVEL);

-

-  // If the interrupt is shared then we must check if this interrupt source is the one associated to this Timer

-  if (MmioRead32 (SP804_TIMER_PERIODIC_BASE + SP804_TIMER_MSK_INT_STS_REG) != 0) {

-    // Clear the periodic interrupt

-    MmioWrite32 (SP804_TIMER_PERIODIC_BASE + SP804_TIMER_INT_CLR_REG, 0);

-

-    // Signal end of interrupt early to help avoid losing subsequent ticks from long duration handlers

-    gInterrupt->EndOfInterrupt (gInterrupt, Source);

-

-    if (mTimerNotifyFunction) {

-      mTimerNotifyFunction (mTimerPeriod);

-    }

-  }

-

-  gBS->RestoreTPL (OriginalTPL);

-}

-

-/**

-  This function registers the handler NotifyFunction so it is called every time

-  the timer interrupt fires.  It also passes the amount of time since the last

-  handler call to the NotifyFunction.  If NotifyFunction is NULL, then the

-  handler is unregistered.  If the handler is registered, then EFI_SUCCESS is

-  returned.  If the CPU does not support registering a timer interrupt handler,

-  then EFI_UNSUPPORTED is returned.  If an attempt is made to register a handler

-  when a handler is already registered, then EFI_ALREADY_STARTED is returned.

-  If an attempt is made to unregister a handler when a handler is not registered,

-  then EFI_INVALID_PARAMETER is returned.  If an error occurs attempting to

-  register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR

-  is returned.

-

-  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.

-  @param  NotifyFunction   The function to call when a timer interrupt fires. This

-                           function executes at TPL_HIGH_LEVEL. The DXE Core will

-                           register a handler for the timer interrupt, so it can know

-                           how much time has passed. This information is used to

-                           signal timer based events. NULL will unregister the handler.

-  @retval EFI_SUCCESS           The timer handler was registered.

-  @retval EFI_UNSUPPORTED       The platform does not support timer interrupts.

-  @retval EFI_ALREADY_STARTED   NotifyFunction is not NULL, and a handler is already

-                                registered.

-  @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not

-                                previously registered.

-  @retval EFI_DEVICE_ERROR      The timer handler could not be registered.

-

-**/

-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;

-}

-

-/**

-    Make sure all Dual Timers are disabled

-**/

-VOID

-EFIAPI

-ExitBootServicesEvent (

-  IN EFI_EVENT  Event,

-  IN VOID       *Context

-  )

-{

-  // Disable 'Periodic Operation' timer if enabled

-  if (MmioRead32(SP804_TIMER_PERIODIC_BASE + SP804_TIMER_CONTROL_REG) & SP804_TIMER_CTRL_ENABLE) {

-    MmioAnd32 (SP804_TIMER_PERIODIC_BASE + SP804_TIMER_CONTROL_REG, 0);

-  }

-

-  // Disable 'Metronome/Delay' timer if enabled

-  if (MmioRead32(SP804_TIMER_METRONOME_BASE + SP804_TIMER_CONTROL_REG) & SP804_TIMER_CTRL_ENABLE) {

-    MmioAnd32 (SP804_TIMER_METRONOME_BASE + SP804_TIMER_CONTROL_REG, 0);

-  }

-

-  // Disable 'Performance' timer if enabled

-  if (MmioRead32(SP804_TIMER_PERFORMANCE_BASE + SP804_TIMER_CONTROL_REG) & SP804_TIMER_CTRL_ENABLE) {

-    MmioAnd32 (SP804_TIMER_PERFORMANCE_BASE + SP804_TIMER_CONTROL_REG, 0);

-  }

-}

-

-/**

-

-  This function adjusts the period of timer interrupts to the value specified

-  by TimerPeriod.  If the timer period is updated, then the selected timer

-  period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned.  If

-  the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.

-  If an error occurs while attempting to update the timer period, then the

-  timer hardware will be put back in its state prior to this call, and

-  EFI_DEVICE_ERROR is returned.  If TimerPeriod is 0, then the timer interrupt

-  is disabled.  This is not the same as disabling the CPU's interrupts.

-  Instead, it must either turn off the timer hardware, or it must adjust the

-  interrupt controller so that a CPU interrupt is not generated when the timer

-  interrupt fires.

-

-  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.

-  @param  TimerPeriod      The rate to program the timer interrupt in 100 nS units. If

-                           the timer hardware is not programmable, then EFI_UNSUPPORTED is

-                           returned. If the timer is programmable, then the timer period

-                           will be rounded up to the nearest timer period that is supported

-                           by the timer hardware. If TimerPeriod is set to 0, then the

-                           timer interrupts will be disabled.

-

-

-  @retval EFI_SUCCESS           The timer period was changed.

-  @retval EFI_UNSUPPORTED       The platform cannot change the period of the timer interrupt.

-  @retval EFI_DEVICE_ERROR      The timer period could not be changed due to a device error.

-

-**/

-EFI_STATUS

-EFIAPI

-TimerDriverSetTimerPeriod (

-  IN EFI_TIMER_ARCH_PROTOCOL  *This,

-  IN UINT64                   TimerPeriod

-  )

-{

-  EFI_STATUS  Status;

-  UINT64      TimerTicks;

-

-  // always disable the timer

-  MmioAnd32 (SP804_TIMER_PERIODIC_BASE + SP804_TIMER_CONTROL_REG, ~SP804_TIMER_CTRL_ENABLE);

-

-  if (TimerPeriod == 0) {

-    // Leave timer disabled from above, and...

-

-    // Disable timer 0/1 interrupt for a TimerPeriod of 0

-    Status = gInterrupt->DisableInterruptSource (gInterrupt, gVector);

-  } else {

-    // Convert TimerPeriod into 1MHz clock counts (us units = 100ns units * 10)

-    TimerTicks = DivU64x32 (TimerPeriod, 10);

-    TimerTicks = MultU64x32 (TimerTicks, PcdGet32(PcdSP804TimerFrequencyInMHz));

-

-    // if it's larger than 32-bits, pin to highest value

-    if (TimerTicks > 0xffffffff) {

-      TimerTicks = 0xffffffff;

-    }

-

-    // Program the SP804 timer with the new count value

-    MmioWrite32 (SP804_TIMER_PERIODIC_BASE + SP804_TIMER_LOAD_REG, TimerTicks);

-

-    // enable the timer

-    MmioOr32 (SP804_TIMER_PERIODIC_BASE + SP804_TIMER_CONTROL_REG, SP804_TIMER_CTRL_ENABLE);

-

-    // enable timer 0/1 interrupts

-    Status = gInterrupt->EnableInterruptSource (gInterrupt, gVector);

-  }

-

-  // Save the new timer period

-  mTimerPeriod = TimerPeriod;

-  return Status;

-}

-

-/**

-  This function retrieves the period of timer interrupts in 100 ns units,

-  returns that value in TimerPeriod, and returns EFI_SUCCESS.  If TimerPeriod

-  is NULL, then EFI_INVALID_PARAMETER is returned.  If a TimerPeriod of 0 is

-  returned, then the timer is currently disabled.

-

-  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.

-  @param  TimerPeriod      A pointer to the timer period to retrieve in 100 ns units. If

-                           0 is returned, then the timer is currently disabled.

-

-

-  @retval EFI_SUCCESS           The timer period was returned in TimerPeriod.

-  @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.

-

-**/

-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;

-}

-

-/**

-  This function generates a soft timer interrupt. If the platform does not support soft

-  timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned.

-  If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler()

-  service, then a soft timer interrupt will be generated. If the timer interrupt is

-  enabled when this service is called, then the registered handler will be invoked. The

-  registered handler should not be able to distinguish a hardware-generated timer

-  interrupt from a software-generated timer interrupt.

-

-  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.

-

-  @retval EFI_SUCCESS           The soft timer interrupt was generated.

-  @retval EFI_UNSUPPORTED       The platform does not support the generation of soft timer interrupts.

-

-**/

-EFI_STATUS

-EFIAPI

-TimerDriverGenerateSoftInterrupt (

-  IN EFI_TIMER_ARCH_PROTOCOL  *This

-  )

-{

-  return EFI_UNSUPPORTED;

-}

-

-/**

-  Interface structure for the Timer Architectural Protocol.

-

-  @par Protocol Description:

-  This protocol provides the services to initialize a periodic timer

-  interrupt, and to register a handler that is called each time the timer

-  interrupt fires.  It may also provide a service to adjust the rate of the

-  periodic timer interrupt.  When a timer interrupt occurs, the handler is

-  passed the amount of time that has passed since the previous timer

-  interrupt.

-

-  @param RegisterHandler

-  Registers a handler that will be called each time the

-  timer interrupt fires.  TimerPeriod defines the minimum

-  time between timer interrupts, so TimerPeriod will also

-  be the minimum time between calls to the registered

-  handler.

-

-  @param SetTimerPeriod

-  Sets the period of the timer interrupt in 100 nS units.

-  This function is optional, and may return EFI_UNSUPPORTED.

-  If this function is supported, then the timer period will

-  be rounded up to the nearest supported timer period.

-

-

-  @param GetTimerPeriod

-  Retrieves the period of the timer interrupt in 100 nS units.

-

-  @param GenerateSoftInterrupt

-  Generates a soft timer interrupt that simulates the firing of

-  the timer interrupt. This service can be used to invoke the   registered handler if the timer interrupt has been masked for

-  a period of time.

-

-**/

-EFI_TIMER_ARCH_PROTOCOL   gTimer = {

-  TimerDriverRegisterHandler,

-  TimerDriverSetTimerPeriod,

-  TimerDriverGetTimerPeriod,

-  TimerDriverGenerateSoftInterrupt

-};

-

-

-/**

-  Initialize the state information for the Timer Architectural Protocol and

-  the Timer Debug support protocol that allows the debugger to break into a

-  running program.

-

-  @param  ImageHandle   of the loaded driver

-  @param  SystemTable   Pointer to the System Table

-

-  @retval EFI_SUCCESS           Protocol registered

-  @retval EFI_OUT_OF_RESOURCES  Cannot allocate protocol data structure

-  @retval EFI_DEVICE_ERROR      Hardware problems

-

-**/

-EFI_STATUS

-EFIAPI

-TimerInitialize (

-  IN EFI_HANDLE         ImageHandle,

-  IN EFI_SYSTEM_TABLE   *SystemTable

-  )

-{

-  EFI_HANDLE  Handle = NULL;

-  EFI_STATUS  Status;

-

-  // Set the interrupt timer number

-  gVector = PcdGet32(PcdSP804TimerPeriodicInterruptNum);

-

-  // Find the interrupt controller protocol.  ASSERT if not found.

-  Status = gBS->LocateProtocol (&gHardwareInterruptProtocolGuid, NULL, (VOID **)&gInterrupt);

-  ASSERT_EFI_ERROR (Status);

-

-  // Disable the timer

-  Status = TimerDriverSetTimerPeriod (&gTimer, 0);

-  ASSERT_EFI_ERROR (Status);

-

-  // Install interrupt handler

-  Status = gInterrupt->RegisterInterruptSource (gInterrupt, gVector, TimerInterruptHandler);

-  ASSERT_EFI_ERROR (Status);

-

-  // configure timer 0 for periodic operation, 32 bits, no prescaler, and interrupt enabled

-  MmioWrite32 (SP804_TIMER_PERIODIC_BASE + SP804_TIMER_CONTROL_REG, SP804_TIMER_CTRL_PERIODIC | SP804_TIMER_CTRL_32BIT | SP804_PRESCALE_DIV_1 | SP804_TIMER_CTRL_INT_ENABLE);

-

-  // Set up default timer

-  Status = TimerDriverSetTimerPeriod (&gTimer, FixedPcdGet32(PcdTimerPeriod)); // TIMER_DEFAULT_PERIOD

-  ASSERT_EFI_ERROR (Status);

-

-  // Install the Timer Architectural Protocol onto a new handle

-  Status = gBS->InstallMultipleProtocolInterfaces(

-                  &Handle,

-                  &gEfiTimerArchProtocolGuid,      &gTimer,

-                  NULL

-                  );

-  ASSERT_EFI_ERROR(Status);

-

-  // Register for an ExitBootServicesEvent

-  Status = gBS->CreateEvent (EVT_SIGNAL_EXIT_BOOT_SERVICES, TPL_NOTIFY, ExitBootServicesEvent, NULL, &EfiExitBootServicesEvent);

-  ASSERT_EFI_ERROR (Status);

-

-  return Status;

-}

diff --git a/ArmPlatformPkg/Drivers/SP804TimerDxe/SP804TimerDxe.inf b/ArmPlatformPkg/Drivers/SP804TimerDxe/SP804TimerDxe.inf
deleted file mode 100644
index 386d9649ef..0000000000
--- a/ArmPlatformPkg/Drivers/SP804TimerDxe/SP804TimerDxe.inf
+++ /dev/null
@@ -1,59 +0,0 @@
-#/** @file

-#

-#    Component description file for Timer module

-#

-#  Copyright (c) 2009 - 2010, Apple Inc. All rights reserved.<BR>

-#  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.

-#

-#**/

-

-[Defines]

-  INF_VERSION                    = 0x00010005

-  BASE_NAME                      = ArmVeTimerDxe

-  FILE_GUID                      = a73d663d-a491-4278-9a69-9521be3379f2

-  MODULE_TYPE                    = DXE_DRIVER

-  VERSION_STRING                 = 1.0

-

-  ENTRY_POINT                    = TimerInitialize

-

-[Sources.common]

-  SP804Timer.c

-

-[Packages]

-  MdePkg/MdePkg.dec

-  EmbeddedPkg/EmbeddedPkg.dec

-  ArmPkg/ArmPkg.dec

-  ArmPlatformPkg/ArmPlatformPkg.dec

-

-[LibraryClasses]

-  BaseLib

-  UefiRuntimeServicesTableLib

-  UefiLib

-  UefiBootServicesTableLib

-  BaseMemoryLib

-  DebugLib

-  UefiDriverEntryPoint

-  IoLib

-

-[Guids]

-

-[Protocols]

-  gEfiTimerArchProtocolGuid

-  gHardwareInterruptProtocolGuid

-

-[Pcd.common]

-  gArmPlatformTokenSpaceGuid.PcdSP804TimerFrequencyInMHz

-  gArmPlatformTokenSpaceGuid.PcdSP804TimerPeriodicInterruptNum

-  gArmPlatformTokenSpaceGuid.PcdSP804TimerPeriodicBase

-  gArmPlatformTokenSpaceGuid.PcdSP804TimerPerformanceBase

-  gArmPlatformTokenSpaceGuid.PcdSP804TimerMetronomeBase

-  gEmbeddedTokenSpaceGuid.PcdTimerPeriod

-

-[Depex]

-  gHardwareInterruptProtocolGuid