blob: 7e12f88bb4a688748d52bc0d423182c2434d34a1 [file] [log] [blame]
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +02001/*
2 * Watchdog driver for IMX2 and later processors
3 *
4 * Copyright (C) 2010 Wolfram Sang, Pengutronix e.K. <w.sang@pengutronix.de>
Anson Huang1a9c5ef2014-01-13 19:58:34 +08005 * Copyright (C) 2014 Freescale Semiconductor, Inc.
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +02006 *
7 * some parts adapted by similar drivers from Darius Augulis and Vladimir
8 * Zapolskiy, additional improvements by Wim Van Sebroeck.
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License version 2 as published by
12 * the Free Software Foundation.
13 *
14 * NOTE: MX1 has a slightly different Watchdog than MX2 and later:
15 *
16 * MX1: MX2+:
17 * ---- -----
18 * Registers: 32-bit 16-bit
19 * Stopable timer: Yes No
20 * Need to enable clk: No Yes
21 * Halt on suspend: Manual Can be automatic
22 */
23
Xiubo Li30cb0422014-04-04 09:33:24 +080024#include <linux/clk.h>
Jingchang Lu334a9d82014-09-12 15:24:36 +080025#include <linux/delay.h>
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020026#include <linux/init.h>
Xiubo Li30cb0422014-04-04 09:33:24 +080027#include <linux/io.h>
28#include <linux/jiffies.h>
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020029#include <linux/kernel.h>
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020030#include <linux/module.h>
31#include <linux/moduleparam.h>
Jingchang Lu334a9d82014-09-12 15:24:36 +080032#include <linux/notifier.h>
Xiubo Lif728f4b2014-06-03 10:45:14 +080033#include <linux/of_address.h>
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020034#include <linux/platform_device.h>
Jingchang Lu334a9d82014-09-12 15:24:36 +080035#include <linux/reboot.h>
Xiubo Lia7977002014-04-04 09:33:25 +080036#include <linux/regmap.h>
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020037#include <linux/timer.h>
Xiubo Li30cb0422014-04-04 09:33:24 +080038#include <linux/watchdog.h>
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020039
40#define DRIVER_NAME "imx2-wdt"
41
42#define IMX2_WDT_WCR 0x00 /* Control Register */
43#define IMX2_WDT_WCR_WT (0xFF << 8) /* -> Watchdog Timeout Field */
44#define IMX2_WDT_WCR_WRE (1 << 3) /* -> WDOG Reset Enable */
45#define IMX2_WDT_WCR_WDE (1 << 2) /* -> Watchdog Enable */
Anson Huang1a9c5ef2014-01-13 19:58:34 +080046#define IMX2_WDT_WCR_WDZST (1 << 0) /* -> Watchdog timer Suspend */
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020047
48#define IMX2_WDT_WSR 0x02 /* Service Register */
49#define IMX2_WDT_SEQ1 0x5555 /* -> service sequence 1 */
50#define IMX2_WDT_SEQ2 0xAAAA /* -> service sequence 2 */
51
Oskar Schirmer474ef122012-02-16 12:17:45 +000052#define IMX2_WDT_WRSR 0x04 /* Reset Status Register */
53#define IMX2_WDT_WRSR_TOUT (1 << 1) /* -> Reset due to Timeout */
54
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020055#define IMX2_WDT_MAX_TIME 128
56#define IMX2_WDT_DEFAULT_TIME 60 /* in seconds */
57
58#define WDOG_SEC_TO_COUNT(s) ((s * 2 - 1) << 8)
59
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +020060struct imx2_wdt_device {
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020061 struct clk *clk;
Xiubo Lia7977002014-04-04 09:33:25 +080062 struct regmap *regmap;
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020063 struct timer_list timer; /* Pings the watchdog when closed */
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +020064 struct watchdog_device wdog;
Jingchang Lu334a9d82014-09-12 15:24:36 +080065 struct notifier_block restart_handler;
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +020066};
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020067
Wim Van Sebroeck86a1e182012-03-05 16:51:11 +010068static bool nowayout = WATCHDOG_NOWAYOUT;
69module_param(nowayout, bool, 0);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +020070MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
71 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
72
73
74static unsigned timeout = IMX2_WDT_DEFAULT_TIME;
75module_param(timeout, uint, 0);
76MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds (default="
77 __MODULE_STRING(IMX2_WDT_DEFAULT_TIME) ")");
78
79static const struct watchdog_info imx2_wdt_info = {
80 .identity = "imx2+ watchdog",
81 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
82};
83
Jingchang Lu334a9d82014-09-12 15:24:36 +080084static int imx2_restart_handler(struct notifier_block *this, unsigned long mode,
85 void *cmd)
86{
87 unsigned int wcr_enable = IMX2_WDT_WCR_WDE;
88 struct imx2_wdt_device *wdev = container_of(this,
89 struct imx2_wdt_device,
90 restart_handler);
91 /* Assert SRS signal */
92 regmap_write(wdev->regmap, 0, wcr_enable);
93 /*
94 * Due to imx6q errata ERR004346 (WDOG: WDOG SRS bit requires to be
95 * written twice), we add another two writes to ensure there must be at
96 * least two writes happen in the same one 32kHz clock period. We save
97 * the target check here, since the writes shouldn't be a huge burden
98 * for other platforms.
99 */
100 regmap_write(wdev->regmap, 0, wcr_enable);
101 regmap_write(wdev->regmap, 0, wcr_enable);
102
103 /* wait for reset to assert... */
104 mdelay(500);
105
106 return NOTIFY_DONE;
107}
108
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200109static inline void imx2_wdt_setup(struct watchdog_device *wdog)
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200110{
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200111 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
Xiubo Lia7977002014-04-04 09:33:25 +0800112 u32 val;
113
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200114 regmap_read(wdev->regmap, IMX2_WDT_WCR, &val);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200115
Anson Huang1a9c5ef2014-01-13 19:58:34 +0800116 /* Suspend timer in low power mode, write once-only */
117 val |= IMX2_WDT_WCR_WDZST;
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200118 /* Strip the old watchdog Time-Out value */
119 val &= ~IMX2_WDT_WCR_WT;
120 /* Generate reset if WDOG times out */
121 val &= ~IMX2_WDT_WCR_WRE;
122 /* Keep Watchdog Disabled */
123 val &= ~IMX2_WDT_WCR_WDE;
124 /* Set the watchdog's Time-Out value */
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200125 val |= WDOG_SEC_TO_COUNT(wdog->timeout);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200126
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200127 regmap_write(wdev->regmap, IMX2_WDT_WCR, val);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200128
129 /* enable the watchdog */
130 val |= IMX2_WDT_WCR_WDE;
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200131 regmap_write(wdev->regmap, IMX2_WDT_WCR, val);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200132}
133
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200134static inline bool imx2_wdt_is_running(struct imx2_wdt_device *wdev)
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200135{
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200136 u32 val;
137
138 regmap_read(wdev->regmap, IMX2_WDT_WCR, &val);
139
140 return val & IMX2_WDT_WCR_WDE;
141}
142
143static int imx2_wdt_ping(struct watchdog_device *wdog)
144{
145 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
146
147 regmap_write(wdev->regmap, IMX2_WDT_WSR, IMX2_WDT_SEQ1);
148 regmap_write(wdev->regmap, IMX2_WDT_WSR, IMX2_WDT_SEQ2);
149 return 0;
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200150}
151
152static void imx2_wdt_timer_ping(unsigned long arg)
153{
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200154 struct watchdog_device *wdog = (struct watchdog_device *)arg;
155 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
156
157 /* ping it every wdog->timeout / 2 seconds to prevent reboot */
158 imx2_wdt_ping(wdog);
159 mod_timer(&wdev->timer, jiffies + wdog->timeout * HZ / 2);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200160}
161
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200162static int imx2_wdt_set_timeout(struct watchdog_device *wdog,
163 unsigned int new_timeout)
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200164{
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200165 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200166
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200167 regmap_update_bits(wdev->regmap, IMX2_WDT_WCR, IMX2_WDT_WCR_WT,
Xiubo Lia7977002014-04-04 09:33:25 +0800168 WDOG_SEC_TO_COUNT(new_timeout));
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200169 return 0;
170}
171
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200172static int imx2_wdt_start(struct watchdog_device *wdog)
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200173{
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200174 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200175
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200176 if (imx2_wdt_is_running(wdev)) {
177 /* delete the timer that pings the watchdog after close */
178 del_timer_sync(&wdev->timer);
179 imx2_wdt_set_timeout(wdog, wdog->timeout);
180 } else
181 imx2_wdt_setup(wdog);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200182
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200183 return imx2_wdt_ping(wdog);
184}
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200185
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200186static int imx2_wdt_stop(struct watchdog_device *wdog)
187{
188 /*
189 * We don't need a clk_disable, it cannot be disabled once started.
190 * We use a timer to ping the watchdog while /dev/watchdog is closed
191 */
192 imx2_wdt_timer_ping((unsigned long)wdog);
193 return 0;
194}
Oskar Schirmer474ef122012-02-16 12:17:45 +0000195
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200196static inline void imx2_wdt_ping_if_active(struct watchdog_device *wdog)
197{
198 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200199
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200200 if (imx2_wdt_is_running(wdev)) {
201 imx2_wdt_set_timeout(wdog, wdog->timeout);
202 imx2_wdt_timer_ping((unsigned long)wdog);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200203 }
204}
205
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200206static struct watchdog_ops imx2_wdt_ops = {
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200207 .owner = THIS_MODULE,
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200208 .start = imx2_wdt_start,
209 .stop = imx2_wdt_stop,
210 .ping = imx2_wdt_ping,
211 .set_timeout = imx2_wdt_set_timeout,
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200212};
213
Xiubo Lia7977002014-04-04 09:33:25 +0800214static struct regmap_config imx2_wdt_regmap_config = {
215 .reg_bits = 16,
216 .reg_stride = 2,
217 .val_bits = 16,
218 .max_register = 0x8,
219};
220
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200221static int __init imx2_wdt_probe(struct platform_device *pdev)
222{
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200223 struct imx2_wdt_device *wdev;
224 struct watchdog_device *wdog;
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200225 struct resource *res;
Xiubo Lia7977002014-04-04 09:33:25 +0800226 void __iomem *base;
227 int ret;
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200228 u32 val;
229
230 wdev = devm_kzalloc(&pdev->dev, sizeof(*wdev), GFP_KERNEL);
231 if (!wdev)
232 return -ENOMEM;
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200233
234 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Xiubo Lia7977002014-04-04 09:33:25 +0800235 base = devm_ioremap_resource(&pdev->dev, res);
236 if (IS_ERR(base))
237 return PTR_ERR(base);
238
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200239 wdev->regmap = devm_regmap_init_mmio_clk(&pdev->dev, NULL, base,
240 &imx2_wdt_regmap_config);
241 if (IS_ERR(wdev->regmap)) {
Xiubo Lia7977002014-04-04 09:33:25 +0800242 dev_err(&pdev->dev, "regmap init failed\n");
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200243 return PTR_ERR(wdev->regmap);
Xiubo Lia7977002014-04-04 09:33:25 +0800244 }
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200245
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200246 wdev->clk = devm_clk_get(&pdev->dev, NULL);
247 if (IS_ERR(wdev->clk)) {
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200248 dev_err(&pdev->dev, "can't get Watchdog clock\n");
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200249 return PTR_ERR(wdev->clk);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200250 }
251
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200252 wdog = &wdev->wdog;
253 wdog->info = &imx2_wdt_info;
254 wdog->ops = &imx2_wdt_ops;
255 wdog->min_timeout = 1;
256 wdog->max_timeout = IMX2_WDT_MAX_TIME;
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200257
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200258 clk_prepare_enable(wdev->clk);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200259
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200260 regmap_read(wdev->regmap, IMX2_WDT_WRSR, &val);
261 wdog->bootstatus = val & IMX2_WDT_WRSR_TOUT ? WDIOF_CARDRESET : 0;
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200262
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200263 wdog->timeout = clamp_t(unsigned, timeout, 1, IMX2_WDT_MAX_TIME);
264 if (wdog->timeout != timeout)
265 dev_warn(&pdev->dev, "Initial timeout out of range! Clamped from %u to %u\n",
266 timeout, wdog->timeout);
267
268 platform_set_drvdata(pdev, wdog);
269 watchdog_set_drvdata(wdog, wdev);
270 watchdog_set_nowayout(wdog, nowayout);
271 watchdog_init_timeout(wdog, timeout, &pdev->dev);
272
273 setup_timer(&wdev->timer, imx2_wdt_timer_ping, (unsigned long)wdog);
274
275 imx2_wdt_ping_if_active(wdog);
276
277 ret = watchdog_register_device(wdog);
278 if (ret) {
279 dev_err(&pdev->dev, "cannot register watchdog device\n");
280 return ret;
281 }
282
Jingchang Lu334a9d82014-09-12 15:24:36 +0800283 wdev->restart_handler.notifier_call = imx2_restart_handler;
284 wdev->restart_handler.priority = 128;
285 ret = register_restart_handler(&wdev->restart_handler);
286 if (ret)
287 dev_err(&pdev->dev, "cannot register restart handler\n");
288
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200289 dev_info(&pdev->dev, "timeout %d sec (nowayout=%d)\n",
290 wdog->timeout, nowayout);
291
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200292 return 0;
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200293}
294
295static int __exit imx2_wdt_remove(struct platform_device *pdev)
296{
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200297 struct watchdog_device *wdog = platform_get_drvdata(pdev);
298 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200299
Jingchang Lu334a9d82014-09-12 15:24:36 +0800300 unregister_restart_handler(&wdev->restart_handler);
301
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200302 watchdog_unregister_device(wdog);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200303
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200304 if (imx2_wdt_is_running(wdev)) {
305 del_timer_sync(&wdev->timer);
306 imx2_wdt_ping(wdog);
307 dev_crit(&pdev->dev, "Device removed: Expect reboot!\n");
Jingoo Hanbdf49572013-04-29 18:15:53 +0900308 }
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200309 return 0;
310}
311
312static void imx2_wdt_shutdown(struct platform_device *pdev)
313{
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200314 struct watchdog_device *wdog = platform_get_drvdata(pdev);
315 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200316
Anatolij Gustschinfaad5de2014-04-11 08:57:14 +0200317 if (imx2_wdt_is_running(wdev)) {
318 /*
319 * We are running, we need to delete the timer but will
320 * give max timeout before reboot will take place
321 */
322 del_timer_sync(&wdev->timer);
323 imx2_wdt_set_timeout(wdog, IMX2_WDT_MAX_TIME);
324 imx2_wdt_ping(wdog);
325 dev_crit(&pdev->dev, "Device shutdown: Expect reboot!\n");
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200326 }
327}
328
Shawn Guof5a427e2011-07-18 11:15:21 +0800329static const struct of_device_id imx2_wdt_dt_ids[] = {
330 { .compatible = "fsl,imx21-wdt", },
331 { /* sentinel */ }
332};
Niels de Vos813296a2013-07-29 09:38:18 +0200333MODULE_DEVICE_TABLE(of, imx2_wdt_dt_ids);
Shawn Guof5a427e2011-07-18 11:15:21 +0800334
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200335static struct platform_driver imx2_wdt_driver = {
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200336 .remove = __exit_p(imx2_wdt_remove),
337 .shutdown = imx2_wdt_shutdown,
338 .driver = {
339 .name = DRIVER_NAME,
340 .owner = THIS_MODULE,
Shawn Guof5a427e2011-07-18 11:15:21 +0800341 .of_match_table = imx2_wdt_dt_ids,
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200342 },
343};
344
Fabio Porcedda1cb92042013-01-09 12:15:27 +0100345module_platform_driver_probe(imx2_wdt_driver, imx2_wdt_probe);
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200346
347MODULE_AUTHOR("Wolfram Sang");
348MODULE_DESCRIPTION("Watchdog driver for IMX2 and later");
349MODULE_LICENSE("GPL v2");
Wolfram Sangbb2fd8a2010-04-29 10:03:17 +0200350MODULE_ALIAS("platform:" DRIVER_NAME);