]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/watchdog/imx2_wdt.c
watchdog: machzwd : fix warning Using plain integer as NULL pointer
[mirror_ubuntu-hirsute-kernel.git] / drivers / watchdog / imx2_wdt.c
CommitLineData
cd6100fc 1// SPDX-License-Identifier: GPL-2.0
bb2fd8a8
WS
2/*
3 * Watchdog driver for IMX2 and later processors
4 *
5 * Copyright (C) 2010 Wolfram Sang, Pengutronix e.K. <w.sang@pengutronix.de>
1a9c5efa 6 * Copyright (C) 2014 Freescale Semiconductor, Inc.
bb2fd8a8
WS
7 *
8 * some parts adapted by similar drivers from Darius Augulis and Vladimir
9 * Zapolskiy, additional improvements by Wim Van Sebroeck.
10 *
bb2fd8a8
WS
11 * NOTE: MX1 has a slightly different Watchdog than MX2 and later:
12 *
13 * MX1: MX2+:
14 * ---- -----
15 * Registers: 32-bit 16-bit
16 * Stopable timer: Yes No
17 * Need to enable clk: No Yes
18 * Halt on suspend: Manual Can be automatic
19 */
20
30cb042a 21#include <linux/clk.h>
334a9d81 22#include <linux/delay.h>
bb2fd8a8 23#include <linux/init.h>
39487f66 24#include <linux/interrupt.h>
30cb042a 25#include <linux/io.h>
bb2fd8a8 26#include <linux/kernel.h>
bb2fd8a8
WS
27#include <linux/module.h>
28#include <linux/moduleparam.h>
f728f4bf 29#include <linux/of_address.h>
bb2fd8a8 30#include <linux/platform_device.h>
a7977003 31#include <linux/regmap.h>
30cb042a 32#include <linux/watchdog.h>
bb2fd8a8
WS
33
34#define DRIVER_NAME "imx2-wdt"
35
36#define IMX2_WDT_WCR 0x00 /* Control Register */
37#define IMX2_WDT_WCR_WT (0xFF << 8) /* -> Watchdog Timeout Field */
68d4cb80
VZ
38#define IMX2_WDT_WCR_WDA BIT(5) /* -> External Reset WDOG_B */
39#define IMX2_WDT_WCR_SRS BIT(4) /* -> Software Reset Signal */
40#define IMX2_WDT_WCR_WRE BIT(3) /* -> WDOG Reset Enable */
41#define IMX2_WDT_WCR_WDE BIT(2) /* -> Watchdog Enable */
42#define IMX2_WDT_WCR_WDZST BIT(0) /* -> Watchdog timer Suspend */
bb2fd8a8
WS
43
44#define IMX2_WDT_WSR 0x02 /* Service Register */
45#define IMX2_WDT_SEQ1 0x5555 /* -> service sequence 1 */
46#define IMX2_WDT_SEQ2 0xAAAA /* -> service sequence 2 */
47
474ef121 48#define IMX2_WDT_WRSR 0x04 /* Reset Status Register */
68d4cb80 49#define IMX2_WDT_WRSR_TOUT BIT(1) /* -> Reset due to Timeout */
474ef121 50
39487f66
VZ
51#define IMX2_WDT_WICR 0x06 /* Interrupt Control Register */
52#define IMX2_WDT_WICR_WIE BIT(15) /* -> Interrupt Enable */
53#define IMX2_WDT_WICR_WTIS BIT(14) /* -> Interrupt Status */
54#define IMX2_WDT_WICR_WICT 0xFF /* -> Interrupt Count Timeout */
55
5fe65ce7
MP
56#define IMX2_WDT_WMCR 0x08 /* Misc Register */
57
bb2fd8a8
WS
58#define IMX2_WDT_MAX_TIME 128
59#define IMX2_WDT_DEFAULT_TIME 60 /* in seconds */
60
61#define WDOG_SEC_TO_COUNT(s) ((s * 2 - 1) << 8)
62
faad5de0 63struct imx2_wdt_device {
bb2fd8a8 64 struct clk *clk;
a7977003 65 struct regmap *regmap;
faad5de0 66 struct watchdog_device wdog;
bc677ff4 67 bool ext_reset;
faad5de0 68};
bb2fd8a8 69
86a1e189
WVS
70static bool nowayout = WATCHDOG_NOWAYOUT;
71module_param(nowayout, bool, 0);
bb2fd8a8
WS
72MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
73 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
74
75
2b77f008 76static unsigned timeout;
bb2fd8a8
WS
77module_param(timeout, uint, 0);
78MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds (default="
79 __MODULE_STRING(IMX2_WDT_DEFAULT_TIME) ")");
80
81static const struct watchdog_info imx2_wdt_info = {
82 .identity = "imx2+ watchdog",
83 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
84};
85
39487f66
VZ
86static const struct watchdog_info imx2_wdt_pretimeout_info = {
87 .identity = "imx2+ watchdog",
88 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE |
89 WDIOF_PRETIMEOUT,
90};
91
4d8b229d
GR
92static int imx2_wdt_restart(struct watchdog_device *wdog, unsigned long action,
93 void *data)
334a9d81 94{
2d9d2475 95 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
334a9d81 96 unsigned int wcr_enable = IMX2_WDT_WCR_WDE;
2d9d2475 97
bc677ff4
TH
98 /* Use internal reset or external - not both */
99 if (wdev->ext_reset)
100 wcr_enable |= IMX2_WDT_WCR_SRS; /* do not assert int reset */
101 else
102 wcr_enable |= IMX2_WDT_WCR_WDA; /* do not assert ext-reset */
103
334a9d81 104 /* Assert SRS signal */
9493c0d8 105 regmap_write(wdev->regmap, IMX2_WDT_WCR, wcr_enable);
334a9d81
JL
106 /*
107 * Due to imx6q errata ERR004346 (WDOG: WDOG SRS bit requires to be
108 * written twice), we add another two writes to ensure there must be at
109 * least two writes happen in the same one 32kHz clock period. We save
110 * the target check here, since the writes shouldn't be a huge burden
111 * for other platforms.
112 */
9493c0d8
FE
113 regmap_write(wdev->regmap, IMX2_WDT_WCR, wcr_enable);
114 regmap_write(wdev->regmap, IMX2_WDT_WCR, wcr_enable);
334a9d81
JL
115
116 /* wait for reset to assert... */
117 mdelay(500);
118
2d9d2475 119 return 0;
334a9d81
JL
120}
121
faad5de0 122static inline void imx2_wdt_setup(struct watchdog_device *wdog)
bb2fd8a8 123{
faad5de0 124 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
a7977003
XL
125 u32 val;
126
faad5de0 127 regmap_read(wdev->regmap, IMX2_WDT_WCR, &val);
bb2fd8a8 128
1a9c5efa
AH
129 /* Suspend timer in low power mode, write once-only */
130 val |= IMX2_WDT_WCR_WDZST;
bb2fd8a8
WS
131 /* Strip the old watchdog Time-Out value */
132 val &= ~IMX2_WDT_WCR_WT;
bc677ff4
TH
133 /* Generate internal chip-level reset if WDOG times out */
134 if (!wdev->ext_reset)
135 val &= ~IMX2_WDT_WCR_WRE;
136 /* Or if external-reset assert WDOG_B reset only on time-out */
137 else
138 val |= IMX2_WDT_WCR_WRE;
bb2fd8a8
WS
139 /* Keep Watchdog Disabled */
140 val &= ~IMX2_WDT_WCR_WDE;
141 /* Set the watchdog's Time-Out value */
faad5de0 142 val |= WDOG_SEC_TO_COUNT(wdog->timeout);
bb2fd8a8 143
faad5de0 144 regmap_write(wdev->regmap, IMX2_WDT_WCR, val);
bb2fd8a8
WS
145
146 /* enable the watchdog */
147 val |= IMX2_WDT_WCR_WDE;
faad5de0 148 regmap_write(wdev->regmap, IMX2_WDT_WCR, val);
bb2fd8a8
WS
149}
150
faad5de0 151static inline bool imx2_wdt_is_running(struct imx2_wdt_device *wdev)
bb2fd8a8 152{
faad5de0 153 u32 val;
bb2fd8a8 154
faad5de0
AG
155 regmap_read(wdev->regmap, IMX2_WDT_WCR, &val);
156
157 return val & IMX2_WDT_WCR_WDE;
bb2fd8a8
WS
158}
159
faad5de0 160static int imx2_wdt_ping(struct watchdog_device *wdog)
bb2fd8a8 161{
faad5de0 162 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
bb2fd8a8 163
faad5de0
AG
164 regmap_write(wdev->regmap, IMX2_WDT_WSR, IMX2_WDT_SEQ1);
165 regmap_write(wdev->regmap, IMX2_WDT_WSR, IMX2_WDT_SEQ2);
166 return 0;
bb2fd8a8
WS
167}
168
0be26725
MK
169static void __imx2_wdt_set_timeout(struct watchdog_device *wdog,
170 unsigned int new_timeout)
bb2fd8a8 171{
faad5de0
AG
172 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
173
174 regmap_update_bits(wdev->regmap, IMX2_WDT_WCR, IMX2_WDT_WCR_WT,
a7977003 175 WDOG_SEC_TO_COUNT(new_timeout));
0be26725
MK
176}
177
178static int imx2_wdt_set_timeout(struct watchdog_device *wdog,
179 unsigned int new_timeout)
180{
181 __imx2_wdt_set_timeout(wdog, new_timeout);
182
183 wdog->timeout = new_timeout;
faad5de0 184 return 0;
bb2fd8a8
WS
185}
186
39487f66
VZ
187static int imx2_wdt_set_pretimeout(struct watchdog_device *wdog,
188 unsigned int new_pretimeout)
189{
190 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
191
192 if (new_pretimeout >= IMX2_WDT_MAX_TIME)
193 return -EINVAL;
194
195 wdog->pretimeout = new_pretimeout;
196
197 regmap_update_bits(wdev->regmap, IMX2_WDT_WICR,
198 IMX2_WDT_WICR_WIE | IMX2_WDT_WICR_WICT,
199 IMX2_WDT_WICR_WIE | (new_pretimeout << 1));
200 return 0;
201}
202
203static irqreturn_t imx2_wdt_isr(int irq, void *wdog_arg)
204{
205 struct watchdog_device *wdog = wdog_arg;
206 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
207
208 regmap_write_bits(wdev->regmap, IMX2_WDT_WICR,
209 IMX2_WDT_WICR_WTIS, IMX2_WDT_WICR_WTIS);
210
211 watchdog_notify_pretimeout(wdog);
212
213 return IRQ_HANDLED;
214}
215
faad5de0 216static int imx2_wdt_start(struct watchdog_device *wdog)
bb2fd8a8 217{
faad5de0 218 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
bb2fd8a8 219
11d7aba9 220 if (imx2_wdt_is_running(wdev))
faad5de0 221 imx2_wdt_set_timeout(wdog, wdog->timeout);
11d7aba9 222 else
faad5de0
AG
223 imx2_wdt_setup(wdog);
224
11d7aba9 225 set_bit(WDOG_HW_RUNNING, &wdog->status);
bb2fd8a8 226
11d7aba9 227 return imx2_wdt_ping(wdog);
bb2fd8a8
WS
228}
229
4bd8ce33 230static const struct watchdog_ops imx2_wdt_ops = {
bb2fd8a8 231 .owner = THIS_MODULE,
faad5de0 232 .start = imx2_wdt_start,
faad5de0
AG
233 .ping = imx2_wdt_ping,
234 .set_timeout = imx2_wdt_set_timeout,
39487f66 235 .set_pretimeout = imx2_wdt_set_pretimeout,
2d9d2475 236 .restart = imx2_wdt_restart,
bb2fd8a8
WS
237};
238
4bd8ce33 239static const struct regmap_config imx2_wdt_regmap_config = {
a7977003
XL
240 .reg_bits = 16,
241 .reg_stride = 2,
242 .val_bits = 16,
243 .max_register = 0x8,
244};
245
bb2fd8a8
WS
246static int __init imx2_wdt_probe(struct platform_device *pdev)
247{
faad5de0
AG
248 struct imx2_wdt_device *wdev;
249 struct watchdog_device *wdog;
a7977003
XL
250 void __iomem *base;
251 int ret;
faad5de0
AG
252 u32 val;
253
254 wdev = devm_kzalloc(&pdev->dev, sizeof(*wdev), GFP_KERNEL);
255 if (!wdev)
256 return -ENOMEM;
bb2fd8a8 257
24b82256 258 base = devm_platform_ioremap_resource(pdev, 0);
a7977003
XL
259 if (IS_ERR(base))
260 return PTR_ERR(base);
261
faad5de0
AG
262 wdev->regmap = devm_regmap_init_mmio_clk(&pdev->dev, NULL, base,
263 &imx2_wdt_regmap_config);
264 if (IS_ERR(wdev->regmap)) {
a7977003 265 dev_err(&pdev->dev, "regmap init failed\n");
faad5de0 266 return PTR_ERR(wdev->regmap);
a7977003 267 }
bb2fd8a8 268
faad5de0
AG
269 wdev->clk = devm_clk_get(&pdev->dev, NULL);
270 if (IS_ERR(wdev->clk)) {
bb2fd8a8 271 dev_err(&pdev->dev, "can't get Watchdog clock\n");
faad5de0 272 return PTR_ERR(wdev->clk);
bb2fd8a8
WS
273 }
274
faad5de0
AG
275 wdog = &wdev->wdog;
276 wdog->info = &imx2_wdt_info;
277 wdog->ops = &imx2_wdt_ops;
278 wdog->min_timeout = 1;
2b77f008 279 wdog->timeout = IMX2_WDT_DEFAULT_TIME;
11d7aba9 280 wdog->max_hw_heartbeat_ms = IMX2_WDT_MAX_TIME * 1000;
8135193c 281 wdog->parent = &pdev->dev;
bb2fd8a8 282
39487f66
VZ
283 ret = platform_get_irq(pdev, 0);
284 if (ret > 0)
285 if (!devm_request_irq(&pdev->dev, ret, imx2_wdt_isr, 0,
286 dev_name(&pdev->dev), wdog))
287 wdog->info = &imx2_wdt_pretimeout_info;
288
aefb163c
FE
289 ret = clk_prepare_enable(wdev->clk);
290 if (ret)
291 return ret;
bb2fd8a8 292
faad5de0
AG
293 regmap_read(wdev->regmap, IMX2_WDT_WRSR, &val);
294 wdog->bootstatus = val & IMX2_WDT_WRSR_TOUT ? WDIOF_CARDRESET : 0;
bb2fd8a8 295
bc677ff4
TH
296 wdev->ext_reset = of_property_read_bool(pdev->dev.of_node,
297 "fsl,ext-reset-output");
faad5de0
AG
298 platform_set_drvdata(pdev, wdog);
299 watchdog_set_drvdata(wdog, wdev);
300 watchdog_set_nowayout(wdog, nowayout);
2d9d2475 301 watchdog_set_restart_priority(wdog, 128);
faad5de0
AG
302 watchdog_init_timeout(wdog, timeout, &pdev->dev);
303
11d7aba9
GR
304 if (imx2_wdt_is_running(wdev)) {
305 imx2_wdt_set_timeout(wdog, wdog->timeout);
306 set_bit(WDOG_HW_RUNNING, &wdog->status);
307 }
faad5de0 308
5fe65ce7
MP
309 /*
310 * Disable the watchdog power down counter at boot. Otherwise the power
311 * down counter will pull down the #WDOG interrupt line for one clock
312 * cycle.
313 */
314 regmap_write(wdev->regmap, IMX2_WDT_WMCR, 0);
315
faad5de0
AG
316 ret = watchdog_register_device(wdog);
317 if (ret) {
318 dev_err(&pdev->dev, "cannot register watchdog device\n");
db11cba2 319 goto disable_clk;
faad5de0
AG
320 }
321
322 dev_info(&pdev->dev, "timeout %d sec (nowayout=%d)\n",
323 wdog->timeout, nowayout);
324
325 return 0;
db11cba2
FE
326
327disable_clk:
328 clk_disable_unprepare(wdev->clk);
329 return ret;
bb2fd8a8
WS
330}
331
332static int __exit imx2_wdt_remove(struct platform_device *pdev)
333{
faad5de0
AG
334 struct watchdog_device *wdog = platform_get_drvdata(pdev);
335 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
bb2fd8a8 336
faad5de0 337 watchdog_unregister_device(wdog);
bb2fd8a8 338
faad5de0 339 if (imx2_wdt_is_running(wdev)) {
faad5de0
AG
340 imx2_wdt_ping(wdog);
341 dev_crit(&pdev->dev, "Device removed: Expect reboot!\n");
bdf49574 342 }
bb2fd8a8
WS
343 return 0;
344}
345
346static void imx2_wdt_shutdown(struct platform_device *pdev)
347{
faad5de0
AG
348 struct watchdog_device *wdog = platform_get_drvdata(pdev);
349 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
350
351 if (imx2_wdt_is_running(wdev)) {
352 /*
11d7aba9
GR
353 * We are running, configure max timeout before reboot
354 * will take place.
faad5de0 355 */
faad5de0
AG
356 imx2_wdt_set_timeout(wdog, IMX2_WDT_MAX_TIME);
357 imx2_wdt_ping(wdog);
358 dev_crit(&pdev->dev, "Device shutdown: Expect reboot!\n");
bb2fd8a8
WS
359 }
360}
361
aefbaf3a 362#ifdef CONFIG_PM_SLEEP
bbd59009 363/* Disable watchdog if it is active or non-active but still running */
aefbaf3a
XL
364static int imx2_wdt_suspend(struct device *dev)
365{
366 struct watchdog_device *wdog = dev_get_drvdata(dev);
367 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
368
bbd59009
XL
369 /* The watchdog IP block is running */
370 if (imx2_wdt_is_running(wdev)) {
0be26725
MK
371 /*
372 * Don't update wdog->timeout, we'll restore the current value
373 * during resume.
374 */
375 __imx2_wdt_set_timeout(wdog, IMX2_WDT_MAX_TIME);
bbd59009 376 imx2_wdt_ping(wdog);
bbd59009 377 }
aefbaf3a
XL
378
379 clk_disable_unprepare(wdev->clk);
380
381 return 0;
382}
383
384/* Enable watchdog and configure it if necessary */
385static int imx2_wdt_resume(struct device *dev)
386{
387 struct watchdog_device *wdog = dev_get_drvdata(dev);
388 struct imx2_wdt_device *wdev = watchdog_get_drvdata(wdog);
aefb163c 389 int ret;
aefbaf3a 390
aefb163c
FE
391 ret = clk_prepare_enable(wdev->clk);
392 if (ret)
393 return ret;
aefbaf3a
XL
394
395 if (watchdog_active(wdog) && !imx2_wdt_is_running(wdev)) {
bbd59009
XL
396 /*
397 * If the watchdog is still active and resumes
398 * from deep sleep state, need to restart the
399 * watchdog again.
aefbaf3a
XL
400 */
401 imx2_wdt_setup(wdog);
11d7aba9
GR
402 }
403 if (imx2_wdt_is_running(wdev)) {
aefbaf3a
XL
404 imx2_wdt_set_timeout(wdog, wdog->timeout);
405 imx2_wdt_ping(wdog);
aefbaf3a
XL
406 }
407
408 return 0;
409}
410#endif
411
412static SIMPLE_DEV_PM_OPS(imx2_wdt_pm_ops, imx2_wdt_suspend,
413 imx2_wdt_resume);
414
f5a427ee
SG
415static const struct of_device_id imx2_wdt_dt_ids[] = {
416 { .compatible = "fsl,imx21-wdt", },
417 { /* sentinel */ }
418};
813296a1 419MODULE_DEVICE_TABLE(of, imx2_wdt_dt_ids);
f5a427ee 420
bb2fd8a8 421static struct platform_driver imx2_wdt_driver = {
bb2fd8a8
WS
422 .remove = __exit_p(imx2_wdt_remove),
423 .shutdown = imx2_wdt_shutdown,
424 .driver = {
425 .name = DRIVER_NAME,
aefbaf3a 426 .pm = &imx2_wdt_pm_ops,
f5a427ee 427 .of_match_table = imx2_wdt_dt_ids,
bb2fd8a8
WS
428 },
429};
430
1cb9204c 431module_platform_driver_probe(imx2_wdt_driver, imx2_wdt_probe);
bb2fd8a8
WS
432
433MODULE_AUTHOR("Wolfram Sang");
434MODULE_DESCRIPTION("Watchdog driver for IMX2 and later");
435MODULE_LICENSE("GPL v2");
bb2fd8a8 436MODULE_ALIAS("platform:" DRIVER_NAME);