Hi Leif,
From: Leif Lindholm [mailto:leif.lindholm@linaro.org] Sent: Saturday, November 05, 2016 5:14 AM
On Tue, Oct 18, 2016 at 01:34:12AM +0530, Bhupesh Sharma wrote:
From: Sakar Arora sakar.arora@nxp.com
This patch adds support for the Watchdog timer present on the LS1043A SoC.
The patch installs Watchdog timer arch protocol and implements APIs necessary for the same.
Signed-off-by: Sakar Arora sakar.arora@nxp.com
.../LS1043aRdb/LS1043aWatchDog/LS1043aWatchDog.c | 355
+++++++++++++++++++++
.../LS1043aWatchDog/LS1043aWatchDogDxe.inf | 54 ++++ 2 files changed, 409 insertions(+) create mode 100644 Platforms/Nxp/LS1043aRdb/LS1043aWatchDog/LS1043aWatchDog.c create mode 100644 Platforms/Nxp/LS1043aRdb/LS1043aWatchDog/LS1043aWatchDogDxe.inf
diff --git a/Platforms/Nxp/LS1043aRdb/LS1043aWatchDog/LS1043aWatchDog.c b/Platforms/Nxp/LS1043aRdb/LS1043aWatchDog/LS1043aWatchDog.c new file mode 100644 index 0000000..ea298f9 --- /dev/null +++ b/Platforms/Nxp/LS1043aRdb/LS1043aWatchDog/LS1043aWatchDog.c @@ -0,0 +1,355 @@ +/** LS1043aWatchDog.c +* +* Based on Watchdog driver implemenation available in +* ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805Watchdog.c +* +* Copyright (c) 2011-2013, ARM Limited. All rights reserved. +* Copyright (c) 2016, Freescale Semiconductor, Inc. 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/BaseMemoryLib.h> +#include <Library/DebugLib.h> +#include <Library/IoLib.h> +#include <Library/PcdLib.h> +#include <Library/UefiBootServicesTableLib.h> +#include <Library/UefiRuntimeServicesTableLib.h> +#include <Library/UefiLib.h>
+#include <Protocol/WatchdogTimer.h> +#include <Library/PlatformLib.h>
Sort, please.
Ok.
+#define LS1043A_WT_MAX_TIME 128 +#define LS1043A_WD_COUNT(sec) (((sec) * 2 - 1) << 8) +#define LS1043A_WD_SEC(cnt) (((cnt) + 1) / 2)
+EFI_EVENT EfiExitBootServicesEvent =
(EFI_EVENT)NULL;
STATIC and prefix m?
Ok.
+inline
No inline please. I would expect the compiler to inline these anyway if they're marked STATIC (as they should be if not used externally). Please apply throughout.
Ok.
+VOID +LS1043aWdogPing (
- VOID
- )
+{
- MmioWriteBe16(WDOG1_BASE_ADDR + WDOG_WSR_OFFSET,
+WDOG_SERVICE_SEQ1);
- MmioWriteBe16(WDOG1_BASE_ADDR + WDOG_WSR_OFFSET,
+WDOG_SERVICE_SEQ2); }
+/**
- Stop the LS1043aWdog watchdog timer from counting down by
disabling interrupts.
+**/ +inline +VOID +LS1043aWdogStop (
- VOID
- )
+{
- // LS1043a Watchdog cannot be disabled by software once started.
- // At best, we can keep pinging the watchdog
- LS1043aWdogPing();
+}
+/**
- Starts the LS1043aWdog counting down by enabling interrupts.
- The count down will start from the value stored in the Load
+register,
- not from the value where it was previously stopped.
+**/ +inline +VOID +LS1043aWdogStart (
- VOID
- )
+{
- /* Watchdog is enabled already in LS1043aWdogInitialize - time to
+reload the timeout value */
- LS1043aWdogPing();
+}
+/**
- On exiting boot services we must make sure the LS1043aWdog
Watchdog Timer
- is stopped.
+**/ +VOID +EFIAPI +ExitBootServicesEvent (
- IN EFI_EVENT Event,
- IN VOID *Context
- )
+{
- LS1043aWdogStop();
+}
+/**
- This function registers the handler NotifyFunction so it is called
+every time
- the watchdog timer expires. It also passes the amount of time
+since the last
- handler call to the NotifyFunction.
- If NotifyFunction is not NULL and a handler is not already
+registered,
- then the new handler is registered and EFI_SUCCESS is returned.
- If NotifyFunction is NULL, and a handler is already registered,
- then that handler is unregistered.
- 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.
- @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. TheDXE Core will
register a handler for the timerinterrupt, so it can know
how much time has passed. Thisinformation is used to
signal timer based events. NULL willunregister the handler.
- @retval EFI_SUCCESS The watchdog timer handler was
registered.
- @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.+**/ +EFI_STATUS +EFIAPI +LS1043aWdogRegisterHandler (
- IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,
- IN EFI_WATCHDOG_TIMER_NOTIFY NotifyFunction
- )
+{
- // ERROR: This function is not supported.
- // The hardware watchdog will reset the board
- return EFI_INVALID_PARAMETER;
+}
+/**
- 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 timerperiod that is supported
by the timer hardware. If TimerPeriod isset 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 +LS1043aWdogSetTimerPeriod (
- IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,
- IN UINT64 TimerPeriod // In
100ns units
- )
+{
- EFI_STATUS Status = EFI_SUCCESS;
- UINT64 TimerPeriodInSec;
- UINT16 Val;
- if( TimerPeriod == 0 ) {
- // This is a watchdog stop request
- LS1043aWdogStop();
- goto EXIT;
There is no cleanup to be done, so no need for the goto. Drop this goto.
Ok.
- } else {
- // Convert the TimerPeriod (in 100 ns unit) to an equivalent
- second value
- TimerPeriodInSec = DivU64x32(TimerPeriod, 10000000);
- // The registers in the LS1043aWdog are only 32 bits
- if(TimerPeriodInSec > LS1043A_WT_MAX_TIME) {
// We could load the watchdog with the maximum supported valuebut
// if a smaller value was requested, this could have thewatchdog
// triggering before it was intended.// Better generate an error to let the caller know.Status = EFI_DEVICE_ERROR;goto EXIT;Replace above two lines with return EFI_DEVICE_ERROR;
Sure.
- }
- // set the new timeout value in the WCR
- Val = MmioReadBe16(WDOG1_BASE_ADDR + WDOG_WCR_OFFSET);
- Val &= ~WDOG_WCR_WT;
- // Convert the timeout value from Seconds to timer count
- Val |= ((LS1043A_WD_COUNT(TimerPeriodInSec) & 0xff00) << 8);
- MmioWriteBe16(WDOG1_BASE_ADDR + WDOG_WCR_OFFSET, Val);
- // Start the watchdog
- LS1043aWdogStart();
- }
- EXIT:
- return Status;
And these two with return EFI_SUCCESS;
Ok.
+}
+/**
- 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 iscurrently disabled.
- @retval EFI_SUCCESS The timer period was returned in
TimerPeriod.
- @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
+**/ +EFI_STATUS +EFIAPI +LS1043aWdogGetTimerPeriod (
- IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,
- OUT UINT64 *TimerPeriod
- )
+{
- EFI_STATUS Status = EFI_SUCCESS;
- UINT64 ReturnValue;
- UINT16 Val;
- if (TimerPeriod == NULL) {
- return EFI_INVALID_PARAMETER;
- }
- // Check if the watchdog is stopped if (
- (MmioReadBe16(WDOG1_BASE_ADDR + WDOG_WCR_OFFSET) & WDOG_WCR_WDE) ==
- 0 ) {
No space padding at start/end.
Ok.
- // It is stopped, so return zero.
- ReturnValue = 0;
- } else {
- // Convert the Watchdog ticks into equivalent TimerPeriod second
- // value.
- Val = (MmioReadBe16(WDOG1_BASE_ADDR + WDOG_WCR_OFFSET) &
- WDOG_WCR_WT ) >> 8;
Drop space before ).
Ok.
- ReturnValue = LS1043A_WD_SEC(Val); }
- *TimerPeriod = ReturnValue;
- return Status;
+}
+/**
- Interface structure for the Watchdog Architectural Protocol.
- @par Protocol Description:
- This protocol provides a service to set the amount of time to wait
- before firing the watchdog timer, and it also provides a service to
- register a handler that is invoked when the watchdog timer fires.
- @par When the watchdog timer fires, control will be passed to a
- handler if one has been registered. If no handler has been
- registered, or the registered handler returns, then the system
will
- be reset by calling the Runtime Service ResetSystem().
- @param RegisterHandler
- Registers a handler that will be called each time the
- watchdogtimer interrupt fires. TimerPeriod defines the minimum
- time between timer interrupts, so TimerPeriod will also be the
- minimum time between calls to the registered handler.
- NOTE: If the watchdog resets the system in hardware, then
this function will not have any chance of executing.- @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.
+**/ +EFI_WATCHDOG_TIMER_ARCH_PROTOCOL gWatchdogTimer = {
- (EFI_WATCHDOG_TIMER_REGISTER_HANDLER) LS1043aWdogRegisterHandler,
- (EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD) LS1043aWdogSetTimerPeriod,
- (EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD) LS1043aWdogGetTimerPeriod };
+/**
- Initialize the state information for the Watchdog Timer
Architectural Protocol.
- @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 +LS1043aWdogInitialize (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
+{
- EFI_STATUS Status;
- EFI_HANDLE Handle;
- UINT16 Val;
- Val = MmioReadBe16(WDOG1_BASE_ADDR + WDOG_WCR_OFFSET);
- Val &= ~WDOG_WCR_WT;
- Val &= ~WDOG_WCR_WDE;
- Val |= LS1043A_WD_COUNT(LS1043A_WT_MAX_TIME) & 0xff00;
- MmioWriteBe16(WDOG1_BASE_ADDR + WDOG_WCR_OFFSET, Val);
- Val |= WDOG_WCR_WDE;
- //
- // Make sure the Watchdog Timer Architectural Protocol has not
been installed in the system yet.
- // This will avoid conflicts with the universal watchdog //
- ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL,
- &gEfiWatchdogTimerArchProtocolGuid);
- // Register for an ExitBootServicesEvent Status = gBS-
CreateEvent
- (EVT_SIGNAL_EXIT_BOOT_SERVICES, TPL_NOTIFY, ExitBootServicesEvent,
- NULL, &EfiExitBootServicesEvent); if (EFI_ERROR(Status)) {
- Status = EFI_OUT_OF_RESOURCES;
- goto EXIT;
- }
- // Install the Timer Architectural Protocol onto a new handle
- Handle = NULL; Status = gBS->InstallMultipleProtocolInterfaces(
&Handle,&gEfiWatchdogTimerArchProtocolGuid,&gWatchdogTimer,
NULL);- if (EFI_ERROR(Status)) {
- Status = EFI_OUT_OF_RESOURCES;
- goto EXIT;
- }
+EXIT:
- if(EFI_ERROR(Status)) {
- // The watchdog failed to initialize
- ASSERT(FALSE);
- }
- LS1043aWdogPing();
- return Status;
+} diff --git a/Platforms/Nxp/LS1043aRdb/LS1043aWatchDog/LS1043aWatchDogDxe.inf b/Platforms/Nxp/LS1043aRdb/LS1043aWatchDog/LS1043aWatchDogDxe.inf new file mode 100644 index 0000000..e1dbbcf --- /dev/null +++ b/Platforms/Nxp/LS1043aRdb/LS1043aWatchDog/LS1043aWatchDogDxe.inf @@ -0,0 +1,54 @@ +#/** LS1043aWatchDog.inf +# +# Component description file for LS1043a WatchDog module # # +Copyright (c) 2016, Freescale Semiconductor, Inc. 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.
+# +#**/
+[Defines]
- INF_VERSION = 0x00010005
- BASE_NAME = LS1043aWatchDogDxe
- FILE_GUID = ebd705fb-fa92-46a7-b32b-
7f566d944614
- MODULE_TYPE = DXE_DRIVER
- VERSION_STRING = 1.0
- ENTRY_POINT = LS1043aWdogInitialize
+[Sources.common]
- LS1043aWatchDog.c
+[Packages]
- MdePkg/MdePkg.dec
- EmbeddedPkg/EmbeddedPkg.dec
- ArmPkg/ArmPkg.dec
- ArmPlatformPkg/ArmPlatformPkg.dec
- OpenPlatformPkg/Platforms/Nxp/LS1043aRdb/LS1043aRdbPkg.dec
+[LibraryClasses]
- BaseLib
- BaseMemoryLib
- DebugLib
- IoLib
- PcdLib
- UefiLib
- UefiBootServicesTableLib
- UefiDriverEntryPoint
- UefiRuntimeServicesTableLib
Please sort above.
Sure.
+[Pcd]
- gArmPlatformTokenSpaceGuid.PcdLS1043aWatchDogBase
+[Protocols]
- gEfiWatchdogTimerArchProtocolGuid
+[Depex]
- TRUE
-- 1.9.1