Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20200924074715.GT9675@piout.net> <20200924105256.18162-1-u.kleine-koenig@pengutronix.de>
 <20200924105256.18162-2-u.kleine-koenig@pengutronix.de>
In-Reply-To: <20200924105256.18162-2-u.kleine-koenig@pengutronix.de>
From:   Bruno Thomsen <bruno.thomsen@gmail.com>
Date:   Sun, 27 Sep 2020 09:50:48 +0200
Message-ID: <CAH+2xPBu3k53XdLzzak7HP_4W16DkfE9NHXCsjaULRbNctzOuQ@mail.gmail.com>
Subject: Re: [PATCH 1/2] rtc: pcf2127: move watchdog initialisation to a
 separate function
To:     =?UTF-8?Q?Uwe_Kleine=2DK=C3=B6nig?= 
        <u.kleine-koenig@pengutronix.de>
Cc:     Alexandre Belloni <alexandre.belloni@bootlin.com>,
        Qiang Zhao <qiang.zhao@nxp.com>, linux-rtc@vger.kernel.org,
        Alessandro Zummo <a.zummo@towertech.it>,
        linux-watchdog@vger.kernel.org,
        "open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS" 
        <devicetree@vger.kernel.org>,
        open list <linux-kernel@vger.kernel.org>,
        Rob Herring <robh+dt@kernel.org>,
        Sascha Hauer <kernel@pengutronix.de>,
        Wim Van Sebroeck <wim@linux-watchdog.org>,
        Guenter Roeck <linux@roeck-us.net>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

Den tor. 24. sep. 2020 kl. 12.53 skrev Uwe Kleine-K=C3=B6nig
<u.kleine-koenig@pengutronix.de>:
>
> The obvious advantages are:
>
>  - The linker can drop the watchdog functions if CONFIG_WATCHDOG is off.
>  - All watchdog stuff grouped together with only a single function call
>    left in generic code.
>  - Watchdog register is only read when it is actually used.
>  - Less #ifdefery
>
> Signed-off-by: Uwe Kleine-K=C3=B6nig <u.kleine-koenig@pengutronix.de>
> ---
>  drivers/rtc/rtc-pcf2127.c | 56 ++++++++++++++++++++++-----------------
>  1 file changed, 31 insertions(+), 25 deletions(-)
>
> diff --git a/drivers/rtc/rtc-pcf2127.c b/drivers/rtc/rtc-pcf2127.c
> index ed6316992cbb..5b1f1949b5e5 100644
> --- a/drivers/rtc/rtc-pcf2127.c
> +++ b/drivers/rtc/rtc-pcf2127.c
> @@ -335,6 +335,36 @@ static const struct watchdog_ops pcf2127_watchdog_op=
s =3D {
>         .set_timeout =3D pcf2127_wdt_set_timeout,
>  };
>
> +static int pcf2127_watchdog_init(struct device *dev, struct pcf2127 *pcf=
2127)
> +{
> +       u32 wdd_timeout;
> +       int ret;
> +
> +       if (!IS_ENABLED(CONFIG_WATCHDOG))
> +               return 0;
> +
> +       pcf2127->wdd.parent =3D dev;
> +       pcf2127->wdd.info =3D &pcf2127_wdt_info;
> +       pcf2127->wdd.ops =3D &pcf2127_watchdog_ops;
> +       pcf2127->wdd.min_timeout =3D PCF2127_WD_VAL_MIN;
> +       pcf2127->wdd.max_timeout =3D PCF2127_WD_VAL_MAX;
> +       pcf2127->wdd.timeout =3D PCF2127_WD_VAL_DEFAULT;
> +       pcf2127->wdd.min_hw_heartbeat_ms =3D 500;
> +       pcf2127->wdd.status =3D WATCHDOG_NOWAYOUT_INIT_STATUS;
> +
> +       watchdog_set_drvdata(&pcf2127->wdd, pcf2127);
> +
> +       /* Test if watchdog timer is started by bootloader */
> +       ret =3D regmap_read(pcf2127->regmap, PCF2127_REG_WD_VAL, &wdd_tim=
eout);
> +       if (ret)
> +               return ret;
> +
> +       if (wdd_timeout)
> +               set_bit(WDOG_HW_RUNNING, &pcf2127->wdd.status);
> +
> +       return devm_watchdog_register_device(dev, &pcf2127->wdd);
> +}
> +
>  /* Alarm */
>  static int pcf2127_rtc_read_alarm(struct device *dev, struct rtc_wkalrm =
*alrm)
>  {
> @@ -536,7 +566,6 @@ static int pcf2127_probe(struct device *dev, struct r=
egmap *regmap,
>                          int alarm_irq, const char *name, bool has_nvmem)
>  {
>         struct pcf2127 *pcf2127;
> -       u32 wdd_timeout;
>         int ret =3D 0;
>
>         dev_dbg(dev, "%s\n", __func__);
> @@ -575,17 +604,6 @@ static int pcf2127_probe(struct device *dev, struct =
regmap *regmap,
>                 pcf2127->rtc->ops =3D &pcf2127_rtc_alrm_ops;
>         }
>
> -       pcf2127->wdd.parent =3D dev;
> -       pcf2127->wdd.info =3D &pcf2127_wdt_info;
> -       pcf2127->wdd.ops =3D &pcf2127_watchdog_ops;
> -       pcf2127->wdd.min_timeout =3D PCF2127_WD_VAL_MIN;
> -       pcf2127->wdd.max_timeout =3D PCF2127_WD_VAL_MAX;
> -       pcf2127->wdd.timeout =3D PCF2127_WD_VAL_DEFAULT;
> -       pcf2127->wdd.min_hw_heartbeat_ms =3D 500;
> -       pcf2127->wdd.status =3D WATCHDOG_NOWAYOUT_INIT_STATUS;
> -
> -       watchdog_set_drvdata(&pcf2127->wdd, pcf2127);
> -
>         if (has_nvmem) {
>                 struct nvmem_config nvmem_cfg =3D {
>                         .priv =3D pcf2127,
> @@ -615,19 +633,7 @@ static int pcf2127_probe(struct device *dev, struct =
regmap *regmap,
>                 return ret;
>         }
>
> -       /* Test if watchdog timer is started by bootloader */
> -       ret =3D regmap_read(pcf2127->regmap, PCF2127_REG_WD_VAL, &wdd_tim=
eout);
> -       if (ret)
> -               return ret;
> -
> -       if (wdd_timeout)
> -               set_bit(WDOG_HW_RUNNING, &pcf2127->wdd.status);
> -
> -#ifdef CONFIG_WATCHDOG
> -       ret =3D devm_watchdog_register_device(dev, &pcf2127->wdd);
> -       if (ret)
> -               return ret;
> -#endif /* CONFIG_WATCHDOG */
> +       pcf2127_watchdog_init(dev, pcf2127);

The code refactoring seems like a good idea Uwe, but the new
pcf2127_watchdog_init() is not a void function. If the return
value is not handled, it will change driver behavior. Correct
handling should look like this:

ret =3D pcf2127_watchdog_init(dev, pcf2127);
if (ret)
        return ret;

/Bruno

>         /*
>          * Disable battery low/switch-over timestamp and interrupts.
> --
> 2.28.0
>