From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2a00:1450:4864:20::344; helo=mail-wm1-x344.google.com; envelope-from=leif.lindholm@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-wm1-x344.google.com (mail-wm1-x344.google.com [IPv6:2a00:1450:4864:20::344]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 4F0C7211982C8 for ; Tue, 18 Dec 2018 05:35:29 -0800 (PST) Received: by mail-wm1-x344.google.com with SMTP id y185so7187297wmd.1 for ; Tue, 18 Dec 2018 05:35:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=BaQjhv/8iAgG4hcs9u5PaqNKmPHWVskw7wC9whGFXBA=; b=Q8MeiWBPZuo3ZgksedWgwi5/7uHm1aUDiO3mY1/UIC5GhNq8ffPKLTLRHoeolgQ8Pv jXjUKDpQrYrL0g1M1s6U0RepDVmv1C5Su3w8dHsPC2LVUoWSQVw9PZZ8StntSROUeOP+ J+ZtLjjThmt77Oa3w2YoE2bof9WfvSz0abFh4= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=BaQjhv/8iAgG4hcs9u5PaqNKmPHWVskw7wC9whGFXBA=; b=O1GnMz++4c+NBnetii8GNMgdg5Qw9urUCCB5HrC2cFvlyT62K4eJCY1NomHnbU23/T PXRJvu5UWLwRx1Bhv0VcaUXnoequ2AmIMjqo2mjzPjasspI4xPuiegDBI0OHUZ/0piGf GBB9tahO7tRXHFRmArExaDEfZv326ZGpyHsOjWWk7soD6rHK2/LYhWf2AQC05BYQS4he McGwyRp6rLQ/NpjUEjM3TajlvR+WEbxiC/uJvJM3xhWmSwBWok5pulcAFd59So4Wb8c+ 1jJEb41cijmQlbuMP7MSub4W8OfP3madCNpNQ8Aj3jTgTJ5CtkvtcHeHKS1w5Nf3Wn8E Refw== X-Gm-Message-State: AA+aEWYVdf8Hi9y121emoLHkJ/Hh11FQ35BBT2Lm2Y/86hAa+NligCc+ efRtt/LWGIbcQyAHqsOOvMOCnA== X-Google-Smtp-Source: AFSGD/Up0qYlQWQRCOBtwvDOVGEdfd4W6MQ+thxX9DBU2gOe8BYwEaLlCn2YbCa4QqYsvBDocrXDIA== X-Received: by 2002:a7b:cb96:: with SMTP id m22mr3338932wmi.39.1545140127915; Tue, 18 Dec 2018 05:35:27 -0800 (PST) Received: from bivouac.eciton.net (bivouac.eciton.net. [2a00:1098:0:86:1000:23:0:2]) by smtp.gmail.com with ESMTPSA id 126sm1686938wmd.1.2018.12.18.05.35.26 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 18 Dec 2018 05:35:26 -0800 (PST) Date: Tue, 18 Dec 2018 13:35:25 +0000 From: Leif Lindholm To: Ard Biesheuvel Cc: edk2-devel@lists.01.org, Sami Mujawar , Thomas Panakamattam Abraham , Meenakshi Aggarwal , Udit Kumar , Matteo Carlini , Nariman Poushin Message-ID: <20181218133525.tkrjzbutgmfjn427@bivouac.eciton.net> References: <20181218131015.20062-1-ard.biesheuvel@linaro.org> <20181218131015.20062-2-ard.biesheuvel@linaro.org> MIME-Version: 1.0 In-Reply-To: <20181218131015.20062-2-ard.biesheuvel@linaro.org> User-Agent: NeoMutt/20170113 (1.7.2) Subject: Re: [PATCH 1/4] ArmPlatformPkg/SP805WatchdogDxe: cosmetic cleanup X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 18 Dec 2018 13:35:30 -0000 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Tue, Dec 18, 2018 at 02:10:11PM +0100, Ard Biesheuvel wrote: > 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 > --- > ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805Watchdog.c | 97 ++++++++++---------- > ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805WatchdogDxe.inf | 13 +-- > 2 files changed, 53 insertions(+), 57 deletions(-) > > diff --git a/ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805Watchdog.c b/ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805Watchdog.c > index 0a9f64095bf8..12c2f0a1fe49 100644 > --- a/ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805Watchdog.c > +++ b/ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805Watchdog.c > @@ -1,6 +1,7 @@ > /** @file > * > * Copyright (c) 2011-2013, ARM Limited. All rights reserved. > +* Copyright (c) 2018, Linaro Limited. All rights reserved. > * > * This program and the accompanying materials > * are licensed and made available under the terms and conditions of the BSD License > @@ -19,16 +20,13 @@ > #include > #include > #include > -#include > #include > -#include > -#include > > #include > > #include "SP805Watchdog.h" > > -EFI_EVENT EfiExitBootServicesEvent = (EFI_EVENT)NULL; > +STATIC EFI_EVENT mEfiExitBootServicesEvent; > > /** > Make sure the SP805 registers are unlocked for writing. > @@ -43,8 +41,8 @@ SP805Unlock ( > VOID > ) > { > - if( MmioRead32(SP805_WDOG_LOCK_REG) == SP805_WDOG_LOCK_IS_LOCKED ) { > - MmioWrite32(SP805_WDOG_LOCK_REG, SP805_WDOG_SPECIAL_UNLOCK_CODE); > + if (MmioRead32 (SP805_WDOG_LOCK_REG) == SP805_WDOG_LOCK_IS_LOCKED) { > + MmioWrite32 (SP805_WDOG_LOCK_REG, SP805_WDOG_SPECIAL_UNLOCK_CODE); > } > } > > @@ -61,9 +59,9 @@ SP805Lock ( > VOID > ) > { > - if( MmioRead32(SP805_WDOG_LOCK_REG) == SP805_WDOG_LOCK_IS_UNLOCKED ) { > + if (MmioRead32 (SP805_WDOG_LOCK_REG) == SP805_WDOG_LOCK_IS_UNLOCKED) { > // To lock it, just write in any number (except the special unlock code). > - MmioWrite32(SP805_WDOG_LOCK_REG, SP805_WDOG_LOCK_IS_LOCKED); > + MmioWrite32 (SP805_WDOG_LOCK_REG, SP805_WDOG_LOCK_IS_LOCKED); > } > } > > @@ -77,8 +75,8 @@ SP805Stop ( > ) > { > // Disable interrupts > - if ( (MmioRead32(SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) != 0 ) { > - MmioAnd32(SP805_WDOG_CONTROL_REG, ~SP805_WDOG_CTRL_INTEN); > + if ((MmioRead32 (SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) != 0) { > + MmioAnd32 (SP805_WDOG_CONTROL_REG, ~SP805_WDOG_CTRL_INTEN); > } > } > > @@ -94,8 +92,8 @@ SP805Start ( > ) > { > // Enable interrupts > - if ( (MmioRead32(SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) == 0 ) { > - MmioOr32(SP805_WDOG_CONTROL_REG, SP805_WDOG_CTRL_INTEN); > + if ((MmioRead32 (SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) == 0) { > + MmioOr32 (SP805_WDOG_CONTROL_REG, SP805_WDOG_CTRL_INTEN); > } > } > > @@ -103,6 +101,7 @@ SP805Start ( > On exiting boot services we must make sure the SP805 Watchdog Timer > is stopped. > **/ > +STATIC > VOID > EFIAPI > ExitBootServicesEvent ( > @@ -110,9 +109,9 @@ ExitBootServicesEvent ( > IN VOID *Context > ) > { > - SP805Unlock(); > - SP805Stop(); > - SP805Lock(); > + SP805Unlock (); > + SP805Stop (); > + SP805Lock (); > } > > /** > @@ -142,10 +141,11 @@ ExitBootServicesEvent ( > previously registered. > > **/ > +STATIC > EFI_STATUS > EFIAPI > SP805RegisterHandler ( > - IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, > + IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, > IN EFI_WATCHDOG_TIMER_NOTIFY NotifyFunction > ) > { > @@ -182,22 +182,24 @@ SP805RegisterHandler ( > @retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error. > > **/ > +STATIC > EFI_STATUS > EFIAPI > SP805SetTimerPeriod ( > - IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, > + IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, > IN UINT64 TimerPeriod // In 100ns units > ) > { > - EFI_STATUS Status = EFI_SUCCESS; > + EFI_STATUS Status; > UINT64 Ticks64bit; > > - SP805Unlock(); > + SP805Unlock (); > > - if( TimerPeriod == 0 ) { > + Status = EFI_SUCCESS; > + > + if (TimerPeriod == 0) { > // This is a watchdog stop request > - SP805Stop(); > - goto EXIT; > + SP805Stop (); > } else { > // Calculate the Watchdog ticks required for a delay of (TimerTicks * 100) nanoseconds > // The SP805 will count down to ZERO once, generate an interrupt and > @@ -211,10 +213,11 @@ SP805SetTimerPeriod ( > // > // WatchdogTicks = (TimerPeriod * SP805_CLOCK_FREQUENCY) / 20 MHz ; > > - Ticks64bit = DivU64x32(MultU64x32(TimerPeriod, (UINTN)PcdGet32(PcdSP805WatchdogClockFrequencyInHz)), 20000000); > + Ticks64bit = MultU64x32 (TimerPeriod, PcdGet32 (PcdSP805WatchdogClockFrequencyInHz)); > + Ticks64bit = DivU64x32 (Ticks64bit, 20000000); > > // The registers in the SP805 are only 32 bits > - if(Ticks64bit > (UINT64)0xFFFFFFFF) { > + if (Ticks64bit > MAX_UINT32) { > // We could load the watchdog with the maximum supported value but > // if a smaller value was requested, this could have the watchdog > // triggering before it was intended. > @@ -224,15 +227,15 @@ SP805SetTimerPeriod ( > } > > // Update the watchdog with a 32-bit value. > - MmioWrite32(SP805_WDOG_LOAD_REG, (UINT32)Ticks64bit); > + MmioWrite32 (SP805_WDOG_LOAD_REG, (UINT32)Ticks64bit); > > // Start the watchdog > - SP805Start(); > + SP805Start (); > } > > - EXIT: > +EXIT: > // Ensure the watchdog is locked before exiting. > - SP805Lock(); > + SP805Lock (); > return Status; > } > > @@ -251,14 +254,14 @@ SP805SetTimerPeriod ( > @retval EFI_INVALID_PARAMETER TimerPeriod is NULL. > > **/ > +STATIC > EFI_STATUS > EFIAPI > SP805GetTimerPeriod ( > - IN CONST EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, > + IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, > OUT UINT64 *TimerPeriod > ) > { > - EFI_STATUS Status = EFI_SUCCESS; > UINT64 ReturnValue; > > if (TimerPeriod == NULL) { > @@ -266,19 +269,19 @@ SP805GetTimerPeriod ( > } > > // Check if the watchdog is stopped > - if ( (MmioRead32(SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) == 0 ) { > + if ((MmioRead32 (SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_INTEN) == 0) { > // It is stopped, so return zero. > ReturnValue = 0; > } else { > // Convert the Watchdog ticks into TimerPeriod > // Ensure 64bit arithmetic throughout because the Watchdog ticks may already > // be at the maximum 32 bit value and we still need to multiply that by 600. > - ReturnValue = MultU64x32( MmioRead32(SP805_WDOG_LOAD_REG), 600 ); > + ReturnValue = MultU64x32 (MmioRead32 (SP805_WDOG_LOAD_REG), 600); > } > > *TimerPeriod = ReturnValue; > > - return Status; > + return EFI_SUCCESS; > } > > /** > @@ -313,10 +316,10 @@ SP805GetTimerPeriod ( > Retrieves the period of the timer interrupt in 100 nS units. > > **/ > -EFI_WATCHDOG_TIMER_ARCH_PROTOCOL gWatchdogTimer = { > - (EFI_WATCHDOG_TIMER_REGISTER_HANDLER) SP805RegisterHandler, > - (EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD) SP805SetTimerPeriod, > - (EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD) SP805GetTimerPeriod > +STATIC EFI_WATCHDOG_TIMER_ARCH_PROTOCOL mWatchdogTimer = { > + SP805RegisterHandler, > + SP805SetTimerPeriod, > + SP805GetTimerPeriod > }; > > /** > @@ -347,12 +350,12 @@ SP805Initialize ( > SP805Stop (); > > // Set the watchdog to reset the board when triggered > - if ((MmioRead32(SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_RESEN) == 0) { > + if ((MmioRead32 (SP805_WDOG_CONTROL_REG) & SP805_WDOG_CTRL_RESEN) == 0) { > MmioOr32 (SP805_WDOG_CONTROL_REG, SP805_WDOG_CTRL_RESEN); > } > > // Prohibit any rogue access to SP805 registers > - SP805Lock(); > + SP805Lock (); > > // > // Make sure the Watchdog Timer Architectural Protocol has not been installed in the system yet. > @@ -361,28 +364,26 @@ SP805Initialize ( > 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 = gBS->CreateEvent (EVT_SIGNAL_EXIT_BOOT_SERVICES, TPL_NOTIFY, > + ExitBootServicesEvent, NULL, &mEfiExitBootServicesEvent); > + 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( > + Status = gBS->InstallMultipleProtocolInterfaces ( > &Handle, > - &gEfiWatchdogTimerArchProtocolGuid, &gWatchdogTimer, > + &gEfiWatchdogTimerArchProtocolGuid, &mWatchdogTimer, > NULL > ); > - if (EFI_ERROR(Status)) { > + if (EFI_ERROR (Status)) { > Status = EFI_OUT_OF_RESOURCES; > goto EXIT; > } > > EXIT: > - if(EFI_ERROR(Status)) { > - // The watchdog failed to initialize > - ASSERT(FALSE); > - } > + ASSERT_EFI_ERROR (Status); > return Status; > } > diff --git a/ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805WatchdogDxe.inf b/ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805WatchdogDxe.inf > index 37924f2e3cd2..99ecab477567 100644 > --- a/ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805WatchdogDxe.inf > +++ b/ArmPlatformPkg/Drivers/SP805WatchdogDxe/SP805WatchdogDxe.inf > @@ -1,6 +1,7 @@ > /** @file > * > * Copyright (c) 2011-2012, ARM Limited. All rights reserved. > +* Copyright (c) 2018, Linaro Limited. All rights reserved. > * > * This program and the accompanying materials > * are licensed and made available under the terms and conditions of the BSD License > @@ -18,35 +19,29 @@ > FILE_GUID = ebd705fb-fa92-46a7-b32b-7f566d944614 > MODULE_TYPE = DXE_DRIVER > VERSION_STRING = 1.0 > - > ENTRY_POINT = SP805Initialize > > [Sources.common] > SP805Watchdog.c > > [Packages] > - MdePkg/MdePkg.dec > - EmbeddedPkg/EmbeddedPkg.dec > - ArmPkg/ArmPkg.dec > ArmPlatformPkg/ArmPlatformPkg.dec > + ArmPkg/ArmPkg.dec Umm, move up one line? With that, beautiful enough to bring tears to my eyes: Reviewed-by: Leif Lindholm > + MdePkg/MdePkg.dec > > [LibraryClasses] > BaseLib > - BaseMemoryLib > DebugLib > IoLib > - PcdLib > - UefiLib > UefiBootServicesTableLib > UefiDriverEntryPoint > - UefiRuntimeServicesTableLib > > [Pcd] > gArmPlatformTokenSpaceGuid.PcdSP805WatchdogBase > gArmPlatformTokenSpaceGuid.PcdSP805WatchdogClockFrequencyInHz > > [Protocols] > - gEfiWatchdogTimerArchProtocolGuid > + gEfiWatchdogTimerArchProtocolGuid ## ALWAYS_PRODUCES > > [Depex] > TRUE > -- > 2.17.1 >