diff mbox series

[v3,8/8] watchdog: stpmic1: add stpmic1 watchdog driver

Message ID 1539016176-4072-9-git-send-email-p.paillet@st.com (mailing list archive)
State New, archived
Headers show
Series Introduce STPMIC1 PMIC Driver | expand

Commit Message

Pascal Paillet Oct. 8, 2018, 4:29 p.m. UTC
From: pascal paillet <p.paillet@st.com>

The stpmic1 PMIC embeds a watchdog which is disabled by default. As soon
as the watchdog is started, it must be refreshed periodically otherwise
the PMIC goes off.

Signed-off-by: pascal paillet <p.paillet@st.com>
---
changes in v3:
* Rename struct stpmic1_dev by struct stpmic1.
* Add nowayout module param.
* Fix set timeout. 
* Call watchdog_init_timeout so that the timeout can be set in the devicetree.
* Add email address in MODULE_AUTHOR.

 drivers/watchdog/Kconfig       |  12 ++++
 drivers/watchdog/Makefile      |   1 +
 drivers/watchdog/stpmic1_wdt.c | 138 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 151 insertions(+)
 create mode 100644 drivers/watchdog/stpmic1_wdt.c

Comments

Randy Dunlap Oct. 8, 2018, 4:35 p.m. UTC | #1
On 10/8/18 9:29 AM, Pascal PAILLET-LME wrote:
> From: pascal paillet <p.paillet@st.com>
> 
> The stpmic1 PMIC embeds a watchdog which is disabled by default. As soon
> as the watchdog is started, it must be refreshed periodically otherwise
> the PMIC goes off.
> 
> Signed-off-by: pascal paillet <p.paillet@st.com>
> ---
> changes in v3:
> * Rename struct stpmic1_dev by struct stpmic1.
> * Add nowayout module param.
> * Fix set timeout. 
> * Call watchdog_init_timeout so that the timeout can be set in the devicetree.
> * Add email address in MODULE_AUTHOR.
> 
>  drivers/watchdog/Kconfig       |  12 ++++
>  drivers/watchdog/Makefile      |   1 +
>  drivers/watchdog/stpmic1_wdt.c | 138 +++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 151 insertions(+)
>  create mode 100644 drivers/watchdog/stpmic1_wdt.c

Hi,

> diff --git a/drivers/watchdog/Kconfig b/drivers/watchdog/Kconfig
> index 5ea8909..985781e 100644
> --- a/drivers/watchdog/Kconfig
> +++ b/drivers/watchdog/Kconfig
> @@ -806,6 +806,18 @@ config STM32_WATCHDOG
>  	  To compile this driver as a module, choose M here: the
>  	  module will be called stm32_iwdg.
>  
> +config STPMIC1_WATCHDOG
> +	tristate "STPMIC1 PMIC watchdog support"
> +	depends on MFD_STPMIC1
> +	select WATCHDOG_CORE
> +	help
> +	  Say Y here to include watchdog support embedded into STPMIC1 PMIC.
> +	  If the watchdog timer expires, stpmic1 shut-down all its power

	  If the watchdog timer expires, stpmic1 shuts down all its power
or
	  If the watchdog timer expires, stpmic1 will shut down all its power

> +	  supplies.
> +
> +	  To compile this driver as a module, choose M here: the
> +	  module will be called spmic1_wdt.
> +
>  config UNIPHIER_WATCHDOG
>  	tristate "UniPhier watchdog support"
>  	depends on ARCH_UNIPHIER || COMPILE_TEST

cheers.
kernel test robot Oct. 9, 2018, 12:47 a.m. UTC | #2
Hi pascal,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on ljones-mfd/for-mfd-next]
[also build test WARNING on v4.19-rc7 next-20181008]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url:    https://github.com/0day-ci/linux/commits/Pascal-PAILLET-LME/Introduce-STPMIC1-PMIC-Driver/20181009-042808
base:   https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git for-mfd-next
config: ia64-allyesconfig (attached as .config)
compiler: ia64-linux-gcc (GCC) 8.1.0
reproduce:
        wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
        chmod +x ~/bin/make.cross
        # save the attached .config to linux build tree
        GCC_VERSION=8.1.0 make.cross ARCH=ia64 

All warnings (new ones prefixed by >>):

   In file included from drivers/watchdog/stpmic1_wdt.c:10:
   drivers/watchdog/stpmic1_wdt.c: In function 'pmic_wdt_stop':
>> drivers/watchdog/stpmic1_wdt.c:48:33: warning: conversion from 'long unsigned int' to 'unsigned int' changes value from '18446744073709551614' to '4294967294' [-Woverflow]
          WCHDG_CR, WDT_START_MASK, ~WDT_START);
   include/linux/regmap.h:77:42: note: in definition of macro 'regmap_update_bits'
     regmap_update_bits_base(map, reg, mask, val, NULL, false, false)
                                             ^~~

vim +48 drivers/watchdog/stpmic1_wdt.c

     4	
     5	#include <linux/kernel.h>
     6	#include <linux/mfd/stpmic1.h>
     7	#include <linux/module.h>
     8	#include <linux/platform_device.h>
     9	#include <linux/of.h>
  > 10	#include <linux/regmap.h>
    11	#include <linux/slab.h>
    12	#include <linux/watchdog.h>
    13	
    14	/* WATCHDOG CONTROL REGISTER bit */
    15	#define WDT_START		BIT(0)
    16	#define WDT_PING		BIT(1)
    17	#define WDT_START_MASK		BIT(0)
    18	#define WDT_PING_MASK		BIT(1)
    19	
    20	#define PMIC_WDT_MIN_TIMEOUT 1
    21	#define PMIC_WDT_MAX_TIMEOUT 256
    22	#define PMIC_WDT_DEFAULT_TIMEOUT 30
    23	
    24	static bool nowayout = WATCHDOG_NOWAYOUT;
    25	module_param(nowayout, bool, 0);
    26	MODULE_PARM_DESC(nowayout,
    27			"Watchdog cannot be stopped once started (default="
    28					__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
    29	
    30	struct stpmic1_wdt {
    31		struct stpmic1 *pmic;
    32		struct watchdog_device wdtdev;
    33	};
    34	
    35	static int pmic_wdt_start(struct watchdog_device *wdd)
    36	{
    37		struct stpmic1_wdt *wdt = watchdog_get_drvdata(wdd);
    38	
    39		return regmap_update_bits(wdt->pmic->regmap,
    40					  WCHDG_CR, WDT_START_MASK, WDT_START);
    41	}
    42	
    43	static int pmic_wdt_stop(struct watchdog_device *wdd)
    44	{
    45		struct stpmic1_wdt *wdt = watchdog_get_drvdata(wdd);
    46	
    47		return regmap_update_bits(wdt->pmic->regmap,
  > 48					  WCHDG_CR, WDT_START_MASK, ~WDT_START);
    49	}
    50	

---
0-DAY kernel test infrastructure                Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all                   Intel Corporation
Guenter Roeck Oct. 9, 2018, 9:44 p.m. UTC | #3
On Tue, Oct 09, 2018 at 08:47:26AM +0800, kbuild test robot wrote:
> Hi pascal,
> 
> Thank you for the patch! Perhaps something to improve:
> 

[ ... ]

>     42	
>     43	static int pmic_wdt_stop(struct watchdog_device *wdd)
>     44	{
>     45		struct stpmic1_wdt *wdt = watchdog_get_drvdata(wdd);
>     46	
>     47		return regmap_update_bits(wdt->pmic->regmap,
>   > 48					  WCHDG_CR, WDT_START_MASK, ~WDT_START);

Maybe use

#define WDT_STOP	0

instead, or just write 0. ~WDT_START may be convenient but not really correct.

Guenter
diff mbox series

Patch

diff --git a/drivers/watchdog/Kconfig b/drivers/watchdog/Kconfig
index 5ea8909..985781e 100644
--- a/drivers/watchdog/Kconfig
+++ b/drivers/watchdog/Kconfig
@@ -806,6 +806,18 @@  config STM32_WATCHDOG
 	  To compile this driver as a module, choose M here: the
 	  module will be called stm32_iwdg.
 
+config STPMIC1_WATCHDOG
+	tristate "STPMIC1 PMIC watchdog support"
+	depends on MFD_STPMIC1
+	select WATCHDOG_CORE
+	help
+	  Say Y here to include watchdog support embedded into STPMIC1 PMIC.
+	  If the watchdog timer expires, stpmic1 shut-down all its power
+	  supplies.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called spmic1_wdt.
+
 config UNIPHIER_WATCHDOG
 	tristate "UniPhier watchdog support"
 	depends on ARCH_UNIPHIER || COMPILE_TEST
diff --git a/drivers/watchdog/Makefile b/drivers/watchdog/Makefile
index bf92e7b..2649cf3 100644
--- a/drivers/watchdog/Makefile
+++ b/drivers/watchdog/Makefile
@@ -217,3 +217,4 @@  obj-$(CONFIG_SOFT_WATCHDOG) += softdog.o
 obj-$(CONFIG_MENF21BMC_WATCHDOG) += menf21bmc_wdt.o
 obj-$(CONFIG_MENZ069_WATCHDOG) += menz69_wdt.o
 obj-$(CONFIG_RAVE_SP_WATCHDOG) += rave-sp-wdt.o
+obj-$(CONFIG_STPMIC1_WATCHDOG) += stpmic1_wdt.o
diff --git a/drivers/watchdog/stpmic1_wdt.c b/drivers/watchdog/stpmic1_wdt.c
new file mode 100644
index 0000000..a45693d
--- /dev/null
+++ b/drivers/watchdog/stpmic1_wdt.c
@@ -0,0 +1,138 @@ 
+// SPDX-License-Identifier: GPL-2.0
+// Copyright (C) STMicroelectronics 2018
+// Author: Pascal Paillet <p.paillet@st.com> for STMicroelectronics.
+
+#include <linux/kernel.h>
+#include <linux/mfd/stpmic1.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/of.h>
+#include <linux/regmap.h>
+#include <linux/slab.h>
+#include <linux/watchdog.h>
+
+/* WATCHDOG CONTROL REGISTER bit */
+#define WDT_START		BIT(0)
+#define WDT_PING		BIT(1)
+#define WDT_START_MASK		BIT(0)
+#define WDT_PING_MASK		BIT(1)
+
+#define PMIC_WDT_MIN_TIMEOUT 1
+#define PMIC_WDT_MAX_TIMEOUT 256
+#define PMIC_WDT_DEFAULT_TIMEOUT 30
+
+static bool nowayout = WATCHDOG_NOWAYOUT;
+module_param(nowayout, bool, 0);
+MODULE_PARM_DESC(nowayout,
+		"Watchdog cannot be stopped once started (default="
+				__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
+
+struct stpmic1_wdt {
+	struct stpmic1 *pmic;
+	struct watchdog_device wdtdev;
+};
+
+static int pmic_wdt_start(struct watchdog_device *wdd)
+{
+	struct stpmic1_wdt *wdt = watchdog_get_drvdata(wdd);
+
+	return regmap_update_bits(wdt->pmic->regmap,
+				  WCHDG_CR, WDT_START_MASK, WDT_START);
+}
+
+static int pmic_wdt_stop(struct watchdog_device *wdd)
+{
+	struct stpmic1_wdt *wdt = watchdog_get_drvdata(wdd);
+
+	return regmap_update_bits(wdt->pmic->regmap,
+				  WCHDG_CR, WDT_START_MASK, ~WDT_START);
+}
+
+static int pmic_wdt_ping(struct watchdog_device *wdd)
+{
+	struct stpmic1_wdt *wdt = watchdog_get_drvdata(wdd);
+
+	return regmap_update_bits(wdt->pmic->regmap,
+				  WCHDG_CR, WDT_PING_MASK, WDT_PING);
+}
+
+static int pmic_wdt_set_timeout(struct watchdog_device *wdd,
+				unsigned int timeout)
+{
+	struct stpmic1_wdt *wdt = watchdog_get_drvdata(wdd);
+
+	wdd->timeout = timeout;
+	/* timeout is equal to register value + 1 */
+	return regmap_write(wdt->pmic->regmap, WCHDG_TIMER_CR, timeout - 1);
+}
+
+static const struct watchdog_info pmic_watchdog_info = {
+	.options = WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING | WDIOF_MAGICCLOSE,
+	.identity = "STPMIC1 PMIC Watchdog",
+};
+
+static const struct watchdog_ops pmic_watchdog_ops = {
+	.owner = THIS_MODULE,
+	.start = pmic_wdt_start,
+	.stop = pmic_wdt_stop,
+	.ping = pmic_wdt_ping,
+	.set_timeout = pmic_wdt_set_timeout,
+};
+
+static int pmic_wdt_probe(struct platform_device *pdev)
+{
+	int ret;
+	struct stpmic1 *pmic;
+	struct stpmic1_wdt *wdt;
+
+	if (!pdev->dev.parent)
+		return -EINVAL;
+
+	pmic = dev_get_drvdata(pdev->dev.parent);
+	if (!pmic)
+		return -EINVAL;
+
+	wdt = devm_kzalloc(&pdev->dev, sizeof(struct stpmic1_wdt), GFP_KERNEL);
+	if (!wdt)
+		return -ENOMEM;
+
+	wdt->pmic = pmic;
+
+	wdt->wdtdev.info = &pmic_watchdog_info;
+	wdt->wdtdev.ops = &pmic_watchdog_ops;
+	wdt->wdtdev.min_timeout = PMIC_WDT_MIN_TIMEOUT;
+	wdt->wdtdev.max_timeout = PMIC_WDT_MAX_TIMEOUT;
+
+	wdt->wdtdev.timeout = PMIC_WDT_DEFAULT_TIMEOUT;
+	watchdog_init_timeout(&wdt->wdtdev, 0, &pdev->dev);
+
+	watchdog_set_nowayout(&wdt->wdtdev, nowayout);
+	watchdog_set_drvdata(&wdt->wdtdev, wdt);
+
+	ret = devm_watchdog_register_device(&pdev->dev, &wdt->wdtdev);
+	if (ret)
+		return ret;
+
+	dev_dbg(wdt->pmic->dev, "PMIC Watchdog driver probed\n");
+	return 0;
+}
+
+static const struct of_device_id of_pmic_wdt_match[] = {
+	{ .compatible = "st,stpmic1-wdt" },
+	{ },
+};
+
+MODULE_DEVICE_TABLE(of, of_pmic_wdt_match);
+
+static struct platform_driver stpmic1_wdt_driver = {
+	.probe = pmic_wdt_probe,
+	.driver = {
+		.name = "stpmic1-wdt",
+		.of_match_table = of_pmic_wdt_match,
+	},
+};
+module_platform_driver(stpmic1_wdt_driver);
+
+MODULE_DESCRIPTION("Watchdog driver for STPMIC1 device");
+MODULE_AUTHOR("Pascal Paillet <p.paillet@st.com>");
+MODULE_LICENSE("GPL v2");