ArmPlatformPkg/Include/Drivers/SP805Watchdog.h

   1 /** @file
   2 *
   3 *  Copyright (c) 2011, ARM Limited. All rights reserved.
   4 *
   5 *  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
   9 *
  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.
  12 *
  13 **/
  14
  15
  16 #ifndef __SP805_WATCHDOG_H__
  17 #define __SP805_WATCHDOG_H__
  18
  19 // SP805 Watchdog Registers
  20 #define SP805_WDOG_LOAD_REG             ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0x000)
  21 #define SP805_WDOG_CURRENT_REG          ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0x004)
  22 #define SP805_WDOG_CONTROL_REG          ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0x008)
  23 #define SP805_WDOG_INT_CLR_REG          ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0x00C)
  24 #define SP805_WDOG_RAW_INT_STS_REG      ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0x010)
  25 #define SP805_WDOG_MSK_INT_STS_REG      ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0x014)
  26 #define SP805_WDOG_LOCK_REG             ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xC00)
  27
  28 #define SP805_WDOG_PERIPH_ID0           ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xFE0)
  29 #define SP805_WDOG_PERIPH_ID1           ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xFE4)
  30 #define SP805_WDOG_PERIPH_ID2           ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xFE8)
  31 #define SP805_WDOG_PERIPH_ID3           ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xFEC)
  32
  33 #define SP805_WDOG_PCELL_ID0            ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xFF0)
  34 #define SP805_WDOG_PCELL_ID1            ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xFF4)
  35 #define SP805_WDOG_PCELL_ID2            ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xFF8)
  36 #define SP805_WDOG_PCELL_ID3            ((UINT32)PcdGet32 (PcdSP805WatchdogBase) + 0xFFC)
  37
  38 // Timer control register bit definitions
  39 #define SP805_WDOG_CTRL_INTEN           BIT0
  40 #define SP805_WDOG_CTRL_RESEN           BIT1
  41 #define SP805_WDOG_RAW_INT_STS_WDOGRIS  BIT0
  42 #define SP805_WDOG_MSK_INT_STS_WDOGMIS  BIT0
  43
  44 #define SP805_WDOG_LOCK_IS_UNLOCKED     0x00000000
  45 #define SP805_WDOG_LOCK_IS_LOCKED       0x00000001
  46 #define SP805_WDOG_SPECIAL_UNLOCK_CODE  0x1ACCE551
  47
  48 VOID
  49 EFIAPI
  50 ExitBootServicesEvent (
  51   IN EFI_EVENT  Event,
  52   IN VOID       *Context
  53 );
  54
  55 EFI_STATUS
  56 EFIAPI
  57 SP805SetTimerPeriod (
  58   IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL   *This,
  59   IN UINT64                                   TimerPeriod   // In 100ns units
  60 );
  61
  62 EFI_STATUS
  63 EFIAPI
  64 SP805GetTimerPeriod (
  65   IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL   *This,
  66   OUT UINT64                                  *TimerPeriod
  67 );
  68
  69 EFI_STATUS
  70 EFIAPI
  71 SP805RegisterHandler (
  72   IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL   *This,
  73   IN EFI_WATCHDOG_TIMER_NOTIFY                NotifyFunction
  74 );
  75
  76 EFI_STATUS
  77 SP805Initialize (
  78   VOID
  79 );
  80
  81 EFI_STATUS
  82 EFIAPI
  83 SP805InstallProtocol (
  84   IN EFI_HANDLE         ImageHandle,
  85   IN EFI_SYSTEM_TABLE   *SystemTable
  86 );
  87
  88
  89 #endif  // __SP805_WATCHDOG_H__