ArmPlatformPkg/SP805WatchdogDxe: cosmetic cleanup
authorArd Biesheuvel <ard.biesheuvel@linaro.org>
Tue, 18 Dec 2018 13:10:11 +0000 (14:10 +0100)
committerArd Biesheuvel <ard.biesheuvel@linaro.org>
Thu, 20 Dec 2018 11:41:21 +0000 (12:41 +0100)
Before fixing the SP805 driver, let's clean it up a bit. No
functional changes.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805Watchdog.c
ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805WatchdogDxe.inf

index 0a9f640..12c2f0a 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
 *\r
 *  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
+*  Copyright (c) 2018, Linaro Limited. All rights reserved.\r
 *\r
 *  This program and the accompanying materials\r
 *  are licensed and made available under the terms and conditions of the BSD License\r
 #include <Library/BaseMemoryLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/IoLib.h>\r
-#include <Library/PcdLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
-#include <Library/UefiRuntimeServicesTableLib.h>\r
-#include <Library/UefiLib.h>\r
 \r
 #include <Protocol/WatchdogTimer.h>\r
 \r
 #include "SP805Watchdog.h"\r
 \r
-EFI_EVENT                           EfiExitBootServicesEvent = (EFI_EVENT)NULL;\r
+STATIC EFI_EVENT          mEfiExitBootServicesEvent;\r
 \r
 /**\r
   Make sure the SP805 registers are unlocked for writing.\r
@@ -43,8 +41,8 @@ SP805Unlock (
   VOID\r
   )\r
 {\r
-  if( MmioRead32(SP805_WDOG_LOCK_REG) == SP805_WDOG_LOCK_IS_LOCKED ) {\r
-    MmioWrite32(SP805_WDOG_LOCK_REG, SP805_WDOG_SPECIAL_UNLOCK_CODE);\r
+  if (MmioRead32 (SP805_WDOG_LOCK_REG) == SP805_WDOG_LOCK_IS_LOCKED) {\r
+    MmioWrite32 (SP805_WDOG_LOCK_REG, SP805_WDOG_SPECIAL_UNLOCK_CODE);\r
   }\r
 }\r
 \r
@@ -61,9 +59,9 @@ SP805Lock (
   VOID\r
   )\r
 {\r
-  if( MmioRead32(SP805_WDOG_LOCK_REG) == SP805_WDOG_LOCK_IS_UNLOCKED ) {\r
+  if (MmioRead32 (SP805_WDOG_LOCK_REG) == SP805_WDOG_LOCK_IS_UNLOCKED) {\r
     // To lock it, just write in any number (except the special unlock code).\r
-    MmioWrite32(SP805_WDOG_LOCK_REG, SP805_WDOG_LOCK_IS_LOCKED);\r
+    MmioWrite32 (SP805_WDOG_LOCK_REG, SP805_WDOG_LOCK_IS_LOCKED);\r
   }\r
 }\r
 \r
@@ -77,8 +75,8 @@ SP805Stop (
   )\r
 {\r
   // Disable interrupts\r
-  if ( (MmioRead32(SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) != 0 ) {\r
-    MmioAnd32(SP805_WDOG_CONTROL_REG, ~SP805_WDOG_CTRL_INTEN);\r
+  if ((MmioRead32 (SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) != 0) {\r
+    MmioAnd32 (SP805_WDOG_CONTROL_REG, ~SP805_WDOG_CTRL_INTEN);\r
   }\r
 }\r
 \r
@@ -94,8 +92,8 @@ SP805Start (
   )\r
 {\r
   // Enable interrupts\r
-  if ( (MmioRead32(SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) == 0 ) {\r
-    MmioOr32(SP805_WDOG_CONTROL_REG, SP805_WDOG_CTRL_INTEN);\r
+  if ((MmioRead32 (SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) == 0) {\r
+    MmioOr32 (SP805_WDOG_CONTROL_REG, SP805_WDOG_CTRL_INTEN);\r
   }\r
 }\r
 \r
@@ -103,6 +101,7 @@ SP805Start (
     On exiting boot services we must make sure the SP805 Watchdog Timer\r
     is stopped.\r
 **/\r
+STATIC\r
 VOID\r
 EFIAPI\r
 ExitBootServicesEvent (\r
@@ -110,9 +109,9 @@ ExitBootServicesEvent (
   IN VOID       *Context\r
   )\r
 {\r
-  SP805Unlock();\r
-  SP805Stop();\r
-  SP805Lock();\r
+  SP805Unlock ();\r
+  SP805Stop ();\r
+  SP805Lock ();\r
 }\r
 \r
 /**\r
@@ -142,10 +141,11 @@ ExitBootServicesEvent (
                                 previously registered.\r
 \r
 **/\r
+STATIC\r
 EFI_STATUS\r
 EFIAPI\r
 SP805RegisterHandler (\r
-  IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL   *This,\r
+  IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL         *This,\r
   IN EFI_WATCHDOG_TIMER_NOTIFY                NotifyFunction\r
   )\r
 {\r
@@ -182,22 +182,24 @@ SP805RegisterHandler (
   @retval EFI_DEVICE_ERROR      The timer period could not be changed due to a device error.\r
 \r
 **/\r
+STATIC\r
 EFI_STATUS\r
 EFIAPI\r
 SP805SetTimerPeriod (\r
-  IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL   *This,\r
+  IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL         *This,\r
   IN UINT64                                   TimerPeriod   // In 100ns units\r
   )\r
 {\r
-  EFI_STATUS  Status = EFI_SUCCESS;\r
+  EFI_STATUS  Status;\r
   UINT64      Ticks64bit;\r
 \r
-  SP805Unlock();\r
+  SP805Unlock ();\r
 \r
-  if( TimerPeriod == 0 ) {\r
+  Status = EFI_SUCCESS;\r
+\r
+  if (TimerPeriod == 0) {\r
     // This is a watchdog stop request\r
-    SP805Stop();\r
-    goto EXIT;\r
+    SP805Stop ();\r
   } else {\r
     // Calculate the Watchdog ticks required for a delay of (TimerTicks * 100) nanoseconds\r
     // The SP805 will count down to ZERO once, generate an interrupt and\r
@@ -211,10 +213,11 @@ SP805SetTimerPeriod (
     //\r
     // WatchdogTicks = (TimerPeriod * SP805_CLOCK_FREQUENCY) / 20 MHz ;\r
 \r
-    Ticks64bit = DivU64x32(MultU64x32(TimerPeriod, (UINTN)PcdGet32(PcdSP805WatchdogClockFrequencyInHz)), 20000000);\r
+    Ticks64bit = MultU64x32 (TimerPeriod, PcdGet32 (PcdSP805WatchdogClockFrequencyInHz));\r
+    Ticks64bit = DivU64x32 (Ticks64bit, 20000000);\r
 \r
     // The registers in the SP805 are only 32 bits\r
-    if(Ticks64bit > (UINT64)0xFFFFFFFF) {\r
+    if (Ticks64bit > MAX_UINT32) {\r
       // We could load the watchdog with the maximum supported value but\r
       // if a smaller value was requested, this could have the watchdog\r
       // triggering before it was intended.\r
@@ -224,15 +227,15 @@ SP805SetTimerPeriod (
     }\r
 \r
     // Update the watchdog with a 32-bit value.\r
-    MmioWrite32(SP805_WDOG_LOAD_REG, (UINT32)Ticks64bit);\r
+    MmioWrite32 (SP805_WDOG_LOAD_REG, (UINT32)Ticks64bit);\r
 \r
     // Start the watchdog\r
-    SP805Start();\r
+    SP805Start ();\r
   }\r
 \r
-  EXIT:\r
+EXIT:\r
   // Ensure the watchdog is locked before exiting.\r
-  SP805Lock();\r
+  SP805Lock ();\r
   return Status;\r
 }\r
 \r
@@ -251,14 +254,14 @@ SP805SetTimerPeriod (
   @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
 \r
 **/\r
+STATIC\r
 EFI_STATUS\r
 EFIAPI\r
 SP805GetTimerPeriod (\r
-  IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL   *This,\r
+  IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL         *This,\r
   OUT UINT64                                  *TimerPeriod\r
   )\r
 {\r
-  EFI_STATUS  Status = EFI_SUCCESS;\r
   UINT64      ReturnValue;\r
 \r
   if (TimerPeriod == NULL) {\r
@@ -266,19 +269,19 @@ SP805GetTimerPeriod (
   }\r
 \r
   // Check if the watchdog is stopped\r
-  if ( (MmioRead32(SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) == 0 ) {\r
+  if ((MmioRead32 (SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) == 0) {\r
     // It is stopped, so return zero.\r
     ReturnValue = 0;\r
   } else {\r
     // Convert the Watchdog ticks into TimerPeriod\r
     // Ensure 64bit arithmetic throughout because the Watchdog ticks may already\r
     // be at the maximum 32 bit value and we still need to multiply that by 600.\r
-    ReturnValue = MultU64x32( MmioRead32(SP805_WDOG_LOAD_REG), 600 );\r
+    ReturnValue = MultU64x32 (MmioRead32 (SP805_WDOG_LOAD_REG), 600);\r
   }\r
 \r
   *TimerPeriod = ReturnValue;\r
 \r
-  return Status;\r
+  return EFI_SUCCESS;\r
 }\r
 \r
 /**\r
@@ -313,10 +316,10 @@ SP805GetTimerPeriod (
   Retrieves the period of the timer interrupt in 100 nS units.\r
 \r
 **/\r
-EFI_WATCHDOG_TIMER_ARCH_PROTOCOL    gWatchdogTimer = {\r
-  (EFI_WATCHDOG_TIMER_REGISTER_HANDLER) SP805RegisterHandler,\r
-  (EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD) SP805SetTimerPeriod,\r
-  (EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD) SP805GetTimerPeriod\r
+STATIC EFI_WATCHDOG_TIMER_ARCH_PROTOCOL mWatchdogTimer = {\r
+  SP805RegisterHandler,\r
+  SP805SetTimerPeriod,\r
+  SP805GetTimerPeriod\r
 };\r
 \r
 /**\r
@@ -347,12 +350,12 @@ SP805Initialize (
   SP805Stop ();\r
 \r
   // Set the watchdog to reset the board when triggered\r
-  if ((MmioRead32(SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_RESEN) == 0) {\r
+  if ((MmioRead32 (SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_RESEN) == 0) {\r
     MmioOr32 (SP805_WDOG_CONTROL_REG, SP805_WDOG_CTRL_RESEN);\r
   }\r
 \r
   // Prohibit any rogue access to SP805 registers\r
-  SP805Lock();\r
+  SP805Lock ();\r
 \r
   //\r
   // Make sure the Watchdog Timer Architectural Protocol has not been installed in the system yet.\r
@@ -361,28 +364,26 @@ SP805Initialize (
   ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiWatchdogTimerArchProtocolGuid);\r
 \r
   // Register for an ExitBootServicesEvent\r
-  Status = gBS->CreateEvent (EVT_SIGNAL_EXIT_BOOT_SERVICES, TPL_NOTIFY, ExitBootServicesEvent, NULL, &EfiExitBootServicesEvent);\r
-  if (EFI_ERROR(Status)) {\r
+  Status = gBS->CreateEvent (EVT_SIGNAL_EXIT_BOOT_SERVICES, TPL_NOTIFY,\r
+                  ExitBootServicesEvent, NULL, &mEfiExitBootServicesEvent);\r
+  if (EFI_ERROR (Status)) {\r
     Status = EFI_OUT_OF_RESOURCES;\r
     goto EXIT;\r
   }\r
 \r
   // Install the Timer Architectural Protocol onto a new handle\r
   Handle = NULL;\r
-  Status = gBS->InstallMultipleProtocolInterfaces(\r
+  Status = gBS->InstallMultipleProtocolInterfaces (\r
                   &Handle,\r
-                  &gEfiWatchdogTimerArchProtocolGuid, &gWatchdogTimer,\r
+                  &gEfiWatchdogTimerArchProtocolGuid, &mWatchdogTimer,\r
                   NULL\r
                   );\r
-  if (EFI_ERROR(Status)) {\r
+  if (EFI_ERROR (Status)) {\r
     Status = EFI_OUT_OF_RESOURCES;\r
     goto EXIT;\r
   }\r
 \r
 EXIT:\r
-  if(EFI_ERROR(Status)) {\r
-    // The watchdog failed to initialize\r
-    ASSERT(FALSE);\r
-  }\r
+  ASSERT_EFI_ERROR (Status);\r
   return Status;\r
 }\r
index 37924f2..c3971fb 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
 *\r
 *  Copyright (c) 2011-2012, ARM Limited. All rights reserved.\r
+*  Copyright (c) 2018, Linaro Limited. All rights reserved.\r
 *\r
 *  This program and the accompanying materials\r
 *  are licensed and made available under the terms and conditions of the BSD License\r
   FILE_GUID                      = ebd705fb-fa92-46a7-b32b-7f566d944614\r
   MODULE_TYPE                    = DXE_DRIVER\r
   VERSION_STRING                 = 1.0\r
-\r
   ENTRY_POINT                    = SP805Initialize\r
 \r
 [Sources.common]\r
   SP805Watchdog.c\r
 \r
 [Packages]\r
-  MdePkg/MdePkg.dec\r
-  EmbeddedPkg/EmbeddedPkg.dec\r
   ArmPkg/ArmPkg.dec\r
   ArmPlatformPkg/ArmPlatformPkg.dec\r
+  MdePkg/MdePkg.dec\r
 \r
 [LibraryClasses]\r
   BaseLib\r
-  BaseMemoryLib\r
   DebugLib\r
   IoLib\r
-  PcdLib\r
-  UefiLib\r
   UefiBootServicesTableLib\r
   UefiDriverEntryPoint\r
-  UefiRuntimeServicesTableLib\r
 \r
 [Pcd]\r
   gArmPlatformTokenSpaceGuid.PcdSP805WatchdogBase\r
   gArmPlatformTokenSpaceGuid.PcdSP805WatchdogClockFrequencyInHz\r
 \r
 [Protocols]\r
-  gEfiWatchdogTimerArchProtocolGuid\r
+  gEfiWatchdogTimerArchProtocolGuid       ## ALWAYS_PRODUCES\r
 \r
 [Depex]\r
   TRUE\r