Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Copyright 2010-2011 Picochip Ltd., Jamie Iles
4 * https://www.picochip.com
5 *
6 * This file implements a driver for the Synopsys DesignWare watchdog device
7 * in the many subsystems. The watchdog has 16 different timeout periods
8 * and these are a function of the input clock frequency.
9 *
10 * The DesignWare watchdog cannot be stopped once it has been started so we
11 * do not implement a stop function. The watchdog core will continue to send
12 * heartbeat requests after the watchdog device has been closed.
13 */
14
15#include <linux/bitops.h>
16#include <linux/clk.h>
17#include <linux/debugfs.h>
18#include <linux/delay.h>
19#include <linux/err.h>
20#include <linux/interrupt.h>
21#include <linux/io.h>
22#include <linux/kernel.h>
23#include <linux/limits.h>
24#include <linux/module.h>
25#include <linux/moduleparam.h>
26#include <linux/of.h>
27#include <linux/platform_device.h>
28#include <linux/pm.h>
29#include <linux/reset.h>
30#include <linux/watchdog.h>
31
32#define WDOG_CONTROL_REG_OFFSET 0x00
33#define WDOG_CONTROL_REG_WDT_EN_MASK 0x01
34#define WDOG_CONTROL_REG_RESP_MODE_MASK 0x02
35#define WDOG_TIMEOUT_RANGE_REG_OFFSET 0x04
36#define WDOG_TIMEOUT_RANGE_TOPINIT_SHIFT 4
37#define WDOG_CURRENT_COUNT_REG_OFFSET 0x08
38#define WDOG_COUNTER_RESTART_REG_OFFSET 0x0c
39#define WDOG_COUNTER_RESTART_KICK_VALUE 0x76
40#define WDOG_INTERRUPT_STATUS_REG_OFFSET 0x10
41#define WDOG_INTERRUPT_CLEAR_REG_OFFSET 0x14
42#define WDOG_COMP_PARAMS_5_REG_OFFSET 0xe4
43#define WDOG_COMP_PARAMS_4_REG_OFFSET 0xe8
44#define WDOG_COMP_PARAMS_3_REG_OFFSET 0xec
45#define WDOG_COMP_PARAMS_2_REG_OFFSET 0xf0
46#define WDOG_COMP_PARAMS_1_REG_OFFSET 0xf4
47#define WDOG_COMP_PARAMS_1_USE_FIX_TOP BIT(6)
48#define WDOG_COMP_VERSION_REG_OFFSET 0xf8
49#define WDOG_COMP_TYPE_REG_OFFSET 0xfc
50
51/* There are sixteen TOPs (timeout periods) that can be set in the watchdog. */
52#define DW_WDT_NUM_TOPS 16
53#define DW_WDT_FIX_TOP(_idx) (1U << (16 + _idx))
54
55#define DW_WDT_DEFAULT_SECONDS 30
56
57static const u32 dw_wdt_fix_tops[DW_WDT_NUM_TOPS] = {
58 DW_WDT_FIX_TOP(0), DW_WDT_FIX_TOP(1), DW_WDT_FIX_TOP(2),
59 DW_WDT_FIX_TOP(3), DW_WDT_FIX_TOP(4), DW_WDT_FIX_TOP(5),
60 DW_WDT_FIX_TOP(6), DW_WDT_FIX_TOP(7), DW_WDT_FIX_TOP(8),
61 DW_WDT_FIX_TOP(9), DW_WDT_FIX_TOP(10), DW_WDT_FIX_TOP(11),
62 DW_WDT_FIX_TOP(12), DW_WDT_FIX_TOP(13), DW_WDT_FIX_TOP(14),
63 DW_WDT_FIX_TOP(15)
64};
65
66static bool nowayout = WATCHDOG_NOWAYOUT;
67module_param(nowayout, bool, 0);
68MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started "
69 "(default=" __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
70
71enum dw_wdt_rmod {
72 DW_WDT_RMOD_RESET = 1,
73 DW_WDT_RMOD_IRQ = 2
74};
75
76struct dw_wdt_timeout {
77 u32 top_val;
78 unsigned int sec;
79 unsigned int msec;
80};
81
82struct dw_wdt {
83 void __iomem *regs;
84 struct clk *clk;
85 struct clk *pclk;
86 unsigned long rate;
87 enum dw_wdt_rmod rmod;
88 struct dw_wdt_timeout timeouts[DW_WDT_NUM_TOPS];
89 struct watchdog_device wdd;
90 struct reset_control *rst;
91 /* Save/restore */
92 u32 control;
93 u32 timeout;
94
95#ifdef CONFIG_DEBUG_FS
96 struct dentry *dbgfs_dir;
97#endif
98};
99
100#define to_dw_wdt(wdd) container_of(wdd, struct dw_wdt, wdd)
101
102static inline int dw_wdt_is_enabled(struct dw_wdt *dw_wdt)
103{
104 return readl(dw_wdt->regs + WDOG_CONTROL_REG_OFFSET) &
105 WDOG_CONTROL_REG_WDT_EN_MASK;
106}
107
108static void dw_wdt_update_mode(struct dw_wdt *dw_wdt, enum dw_wdt_rmod rmod)
109{
110 u32 val;
111
112 val = readl(dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
113 if (rmod == DW_WDT_RMOD_IRQ)
114 val |= WDOG_CONTROL_REG_RESP_MODE_MASK;
115 else
116 val &= ~WDOG_CONTROL_REG_RESP_MODE_MASK;
117 writel(val, dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
118
119 dw_wdt->rmod = rmod;
120}
121
122static unsigned int dw_wdt_find_best_top(struct dw_wdt *dw_wdt,
123 unsigned int timeout, u32 *top_val)
124{
125 int idx;
126
127 /*
128 * Find a TOP with timeout greater or equal to the requested number.
129 * Note we'll select a TOP with maximum timeout if the requested
130 * timeout couldn't be reached.
131 */
132 for (idx = 0; idx < DW_WDT_NUM_TOPS; ++idx) {
133 if (dw_wdt->timeouts[idx].sec >= timeout)
134 break;
135 }
136
137 if (idx == DW_WDT_NUM_TOPS)
138 --idx;
139
140 *top_val = dw_wdt->timeouts[idx].top_val;
141
142 return dw_wdt->timeouts[idx].sec;
143}
144
145static unsigned int dw_wdt_get_min_timeout(struct dw_wdt *dw_wdt)
146{
147 int idx;
148
149 /*
150 * We'll find a timeout greater or equal to one second anyway because
151 * the driver probe would have failed if there was none.
152 */
153 for (idx = 0; idx < DW_WDT_NUM_TOPS; ++idx) {
154 if (dw_wdt->timeouts[idx].sec)
155 break;
156 }
157
158 return dw_wdt->timeouts[idx].sec;
159}
160
161static unsigned int dw_wdt_get_max_timeout_ms(struct dw_wdt *dw_wdt)
162{
163 struct dw_wdt_timeout *timeout = &dw_wdt->timeouts[DW_WDT_NUM_TOPS - 1];
164 u64 msec;
165
166 msec = (u64)timeout->sec * MSEC_PER_SEC + timeout->msec;
167
168 return msec < UINT_MAX ? msec : UINT_MAX;
169}
170
171static unsigned int dw_wdt_get_timeout(struct dw_wdt *dw_wdt)
172{
173 int top_val = readl(dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET) & 0xF;
174 int idx;
175
176 for (idx = 0; idx < DW_WDT_NUM_TOPS; ++idx) {
177 if (dw_wdt->timeouts[idx].top_val == top_val)
178 break;
179 }
180
181 /*
182 * In IRQ mode due to the two stages counter, the actual timeout is
183 * twice greater than the TOP setting.
184 */
185 return dw_wdt->timeouts[idx].sec * dw_wdt->rmod;
186}
187
188static int dw_wdt_ping(struct watchdog_device *wdd)
189{
190 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
191
192 writel(WDOG_COUNTER_RESTART_KICK_VALUE, dw_wdt->regs +
193 WDOG_COUNTER_RESTART_REG_OFFSET);
194
195 return 0;
196}
197
198static int dw_wdt_set_timeout(struct watchdog_device *wdd, unsigned int top_s)
199{
200 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
201 unsigned int timeout;
202 u32 top_val;
203
204 /*
205 * Note IRQ mode being enabled means having a non-zero pre-timeout
206 * setup. In this case we try to find a TOP as close to the half of the
207 * requested timeout as possible since DW Watchdog IRQ mode is designed
208 * in two stages way - first timeout rises the pre-timeout interrupt,
209 * second timeout performs the system reset. So basically the effective
210 * watchdog-caused reset happens after two watchdog TOPs elapsed.
211 */
212 timeout = dw_wdt_find_best_top(dw_wdt, DIV_ROUND_UP(top_s, dw_wdt->rmod),
213 &top_val);
214 if (dw_wdt->rmod == DW_WDT_RMOD_IRQ)
215 wdd->pretimeout = timeout;
216 else
217 wdd->pretimeout = 0;
218
219 /*
220 * Set the new value in the watchdog. Some versions of dw_wdt
221 * have TOPINIT in the TIMEOUT_RANGE register (as per
222 * CP_WDT_DUAL_TOP in WDT_COMP_PARAMS_1). On those we
223 * effectively get a pat of the watchdog right here.
224 */
225 writel(top_val | top_val << WDOG_TIMEOUT_RANGE_TOPINIT_SHIFT,
226 dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET);
227
228 /* Kick new TOP value into the watchdog counter if activated. */
229 if (watchdog_active(wdd))
230 dw_wdt_ping(wdd);
231
232 /*
233 * In case users set bigger timeout value than HW can support,
234 * kernel(watchdog_dev.c) helps to feed watchdog before
235 * wdd->max_hw_heartbeat_ms
236 */
237 if (top_s * 1000 <= wdd->max_hw_heartbeat_ms)
238 wdd->timeout = timeout * dw_wdt->rmod;
239 else
240 wdd->timeout = top_s;
241
242 return 0;
243}
244
245static int dw_wdt_set_pretimeout(struct watchdog_device *wdd, unsigned int req)
246{
247 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
248
249 /*
250 * We ignore actual value of the timeout passed from user-space
251 * using it as a flag whether the pretimeout functionality is intended
252 * to be activated.
253 */
254 dw_wdt_update_mode(dw_wdt, req ? DW_WDT_RMOD_IRQ : DW_WDT_RMOD_RESET);
255 dw_wdt_set_timeout(wdd, wdd->timeout);
256
257 return 0;
258}
259
260static void dw_wdt_arm_system_reset(struct dw_wdt *dw_wdt)
261{
262 u32 val = readl(dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
263
264 /* Disable/enable interrupt mode depending on the RMOD flag. */
265 if (dw_wdt->rmod == DW_WDT_RMOD_IRQ)
266 val |= WDOG_CONTROL_REG_RESP_MODE_MASK;
267 else
268 val &= ~WDOG_CONTROL_REG_RESP_MODE_MASK;
269 /* Enable watchdog. */
270 val |= WDOG_CONTROL_REG_WDT_EN_MASK;
271 writel(val, dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
272}
273
274static int dw_wdt_start(struct watchdog_device *wdd)
275{
276 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
277
278 dw_wdt_set_timeout(wdd, wdd->timeout);
279 dw_wdt_ping(&dw_wdt->wdd);
280 dw_wdt_arm_system_reset(dw_wdt);
281
282 return 0;
283}
284
285static int dw_wdt_stop(struct watchdog_device *wdd)
286{
287 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
288
289 if (!dw_wdt->rst) {
290 set_bit(WDOG_HW_RUNNING, &wdd->status);
291 return 0;
292 }
293
294 reset_control_assert(dw_wdt->rst);
295 reset_control_deassert(dw_wdt->rst);
296
297 return 0;
298}
299
300static int dw_wdt_restart(struct watchdog_device *wdd,
301 unsigned long action, void *data)
302{
303 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
304
305 writel(0, dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET);
306 dw_wdt_update_mode(dw_wdt, DW_WDT_RMOD_RESET);
307 if (dw_wdt_is_enabled(dw_wdt))
308 writel(WDOG_COUNTER_RESTART_KICK_VALUE,
309 dw_wdt->regs + WDOG_COUNTER_RESTART_REG_OFFSET);
310 else
311 dw_wdt_arm_system_reset(dw_wdt);
312
313 /* wait for reset to assert... */
314 mdelay(500);
315
316 return 0;
317}
318
319static unsigned int dw_wdt_get_timeleft(struct watchdog_device *wdd)
320{
321 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
322 unsigned int sec;
323 u32 val;
324
325 val = readl(dw_wdt->regs + WDOG_CURRENT_COUNT_REG_OFFSET);
326 sec = val / dw_wdt->rate;
327
328 if (dw_wdt->rmod == DW_WDT_RMOD_IRQ) {
329 val = readl(dw_wdt->regs + WDOG_INTERRUPT_STATUS_REG_OFFSET);
330 if (!val)
331 sec += wdd->pretimeout;
332 }
333
334 return sec;
335}
336
337static const struct watchdog_info dw_wdt_ident = {
338 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT |
339 WDIOF_MAGICCLOSE,
340 .identity = "Synopsys DesignWare Watchdog",
341};
342
343static const struct watchdog_info dw_wdt_pt_ident = {
344 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT |
345 WDIOF_PRETIMEOUT | WDIOF_MAGICCLOSE,
346 .identity = "Synopsys DesignWare Watchdog",
347};
348
349static const struct watchdog_ops dw_wdt_ops = {
350 .owner = THIS_MODULE,
351 .start = dw_wdt_start,
352 .stop = dw_wdt_stop,
353 .ping = dw_wdt_ping,
354 .set_timeout = dw_wdt_set_timeout,
355 .set_pretimeout = dw_wdt_set_pretimeout,
356 .get_timeleft = dw_wdt_get_timeleft,
357 .restart = dw_wdt_restart,
358};
359
360static irqreturn_t dw_wdt_irq(int irq, void *devid)
361{
362 struct dw_wdt *dw_wdt = devid;
363 u32 val;
364
365 /*
366 * We don't clear the IRQ status. It's supposed to be done by the
367 * following ping operations.
368 */
369 val = readl(dw_wdt->regs + WDOG_INTERRUPT_STATUS_REG_OFFSET);
370 if (!val)
371 return IRQ_NONE;
372
373 watchdog_notify_pretimeout(&dw_wdt->wdd);
374
375 return IRQ_HANDLED;
376}
377
378static int dw_wdt_suspend(struct device *dev)
379{
380 struct dw_wdt *dw_wdt = dev_get_drvdata(dev);
381
382 dw_wdt->control = readl(dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
383 dw_wdt->timeout = readl(dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET);
384
385 clk_disable_unprepare(dw_wdt->pclk);
386 clk_disable_unprepare(dw_wdt->clk);
387
388 return 0;
389}
390
391static int dw_wdt_resume(struct device *dev)
392{
393 struct dw_wdt *dw_wdt = dev_get_drvdata(dev);
394 int err = clk_prepare_enable(dw_wdt->clk);
395
396 if (err)
397 return err;
398
399 err = clk_prepare_enable(dw_wdt->pclk);
400 if (err) {
401 clk_disable_unprepare(dw_wdt->clk);
402 return err;
403 }
404
405 writel(dw_wdt->timeout, dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET);
406 writel(dw_wdt->control, dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
407
408 dw_wdt_ping(&dw_wdt->wdd);
409
410 return 0;
411}
412
413static DEFINE_SIMPLE_DEV_PM_OPS(dw_wdt_pm_ops, dw_wdt_suspend, dw_wdt_resume);
414
415/*
416 * In case if DW WDT IP core is synthesized with fixed TOP feature disabled the
417 * TOPs array can be arbitrary ordered with nearly any sixteen uint numbers
418 * depending on the system engineer imagination. The next method handles the
419 * passed TOPs array to pre-calculate the effective timeouts and to sort the
420 * TOP items out in the ascending order with respect to the timeouts.
421 */
422
423static void dw_wdt_handle_tops(struct dw_wdt *dw_wdt, const u32 *tops)
424{
425 struct dw_wdt_timeout tout, *dst;
426 int val, tidx;
427 u64 msec;
428
429 /*
430 * We walk over the passed TOPs array and calculate corresponding
431 * timeouts in seconds and milliseconds. The milliseconds granularity
432 * is needed to distinguish the TOPs with very close timeouts and to
433 * set the watchdog max heartbeat setting further.
434 */
435 for (val = 0; val < DW_WDT_NUM_TOPS; ++val) {
436 tout.top_val = val;
437 tout.sec = tops[val] / dw_wdt->rate;
438 msec = (u64)tops[val] * MSEC_PER_SEC;
439 do_div(msec, dw_wdt->rate);
440 tout.msec = msec - ((u64)tout.sec * MSEC_PER_SEC);
441
442 /*
443 * Find a suitable place for the current TOP in the timeouts
444 * array so that the list is remained in the ascending order.
445 */
446 for (tidx = 0; tidx < val; ++tidx) {
447 dst = &dw_wdt->timeouts[tidx];
448 if (tout.sec > dst->sec || (tout.sec == dst->sec &&
449 tout.msec >= dst->msec))
450 continue;
451 else
452 swap(*dst, tout);
453 }
454
455 dw_wdt->timeouts[val] = tout;
456 }
457}
458
459static int dw_wdt_init_timeouts(struct dw_wdt *dw_wdt, struct device *dev)
460{
461 u32 data, of_tops[DW_WDT_NUM_TOPS];
462 const u32 *tops;
463 int ret;
464
465 /*
466 * Retrieve custom or fixed counter values depending on the
467 * WDT_USE_FIX_TOP flag found in the component specific parameters
468 * #1 register.
469 */
470 data = readl(dw_wdt->regs + WDOG_COMP_PARAMS_1_REG_OFFSET);
471 if (data & WDOG_COMP_PARAMS_1_USE_FIX_TOP) {
472 tops = dw_wdt_fix_tops;
473 } else {
474 ret = of_property_read_variable_u32_array(dev_of_node(dev),
475 "snps,watchdog-tops", of_tops, DW_WDT_NUM_TOPS,
476 DW_WDT_NUM_TOPS);
477 if (ret < 0) {
478 dev_warn(dev, "No valid TOPs array specified\n");
479 tops = dw_wdt_fix_tops;
480 } else {
481 tops = of_tops;
482 }
483 }
484
485 /* Convert the specified TOPs into an array of watchdog timeouts. */
486 dw_wdt_handle_tops(dw_wdt, tops);
487 if (!dw_wdt->timeouts[DW_WDT_NUM_TOPS - 1].sec) {
488 dev_err(dev, "No any valid TOP detected\n");
489 return -EINVAL;
490 }
491
492 return 0;
493}
494
495#ifdef CONFIG_DEBUG_FS
496
497#define DW_WDT_DBGFS_REG(_name, _off) \
498{ \
499 .name = _name, \
500 .offset = _off \
501}
502
503static const struct debugfs_reg32 dw_wdt_dbgfs_regs[] = {
504 DW_WDT_DBGFS_REG("cr", WDOG_CONTROL_REG_OFFSET),
505 DW_WDT_DBGFS_REG("torr", WDOG_TIMEOUT_RANGE_REG_OFFSET),
506 DW_WDT_DBGFS_REG("ccvr", WDOG_CURRENT_COUNT_REG_OFFSET),
507 DW_WDT_DBGFS_REG("crr", WDOG_COUNTER_RESTART_REG_OFFSET),
508 DW_WDT_DBGFS_REG("stat", WDOG_INTERRUPT_STATUS_REG_OFFSET),
509 DW_WDT_DBGFS_REG("param5", WDOG_COMP_PARAMS_5_REG_OFFSET),
510 DW_WDT_DBGFS_REG("param4", WDOG_COMP_PARAMS_4_REG_OFFSET),
511 DW_WDT_DBGFS_REG("param3", WDOG_COMP_PARAMS_3_REG_OFFSET),
512 DW_WDT_DBGFS_REG("param2", WDOG_COMP_PARAMS_2_REG_OFFSET),
513 DW_WDT_DBGFS_REG("param1", WDOG_COMP_PARAMS_1_REG_OFFSET),
514 DW_WDT_DBGFS_REG("version", WDOG_COMP_VERSION_REG_OFFSET),
515 DW_WDT_DBGFS_REG("type", WDOG_COMP_TYPE_REG_OFFSET)
516};
517
518static void dw_wdt_dbgfs_init(struct dw_wdt *dw_wdt)
519{
520 struct device *dev = dw_wdt->wdd.parent;
521 struct debugfs_regset32 *regset;
522
523 regset = devm_kzalloc(dev, sizeof(*regset), GFP_KERNEL);
524 if (!regset)
525 return;
526
527 regset->regs = dw_wdt_dbgfs_regs;
528 regset->nregs = ARRAY_SIZE(dw_wdt_dbgfs_regs);
529 regset->base = dw_wdt->regs;
530
531 dw_wdt->dbgfs_dir = debugfs_create_dir(dev_name(dev), NULL);
532
533 debugfs_create_regset32("registers", 0444, dw_wdt->dbgfs_dir, regset);
534}
535
536static void dw_wdt_dbgfs_clear(struct dw_wdt *dw_wdt)
537{
538 debugfs_remove_recursive(dw_wdt->dbgfs_dir);
539}
540
541#else /* !CONFIG_DEBUG_FS */
542
543static void dw_wdt_dbgfs_init(struct dw_wdt *dw_wdt) {}
544static void dw_wdt_dbgfs_clear(struct dw_wdt *dw_wdt) {}
545
546#endif /* !CONFIG_DEBUG_FS */
547
548static int dw_wdt_drv_probe(struct platform_device *pdev)
549{
550 struct device *dev = &pdev->dev;
551 struct watchdog_device *wdd;
552 struct dw_wdt *dw_wdt;
553 int ret;
554
555 dw_wdt = devm_kzalloc(dev, sizeof(*dw_wdt), GFP_KERNEL);
556 if (!dw_wdt)
557 return -ENOMEM;
558
559 dw_wdt->regs = devm_platform_ioremap_resource(pdev, 0);
560 if (IS_ERR(dw_wdt->regs))
561 return PTR_ERR(dw_wdt->regs);
562
563 /*
564 * Try to request the watchdog dedicated timer clock source. It must
565 * be supplied if asynchronous mode is enabled. Otherwise fallback
566 * to the common timer/bus clocks configuration, in which the very
567 * first found clock supply both timer and APB signals.
568 */
569 dw_wdt->clk = devm_clk_get_enabled(dev, "tclk");
570 if (IS_ERR(dw_wdt->clk)) {
571 dw_wdt->clk = devm_clk_get_enabled(dev, NULL);
572 if (IS_ERR(dw_wdt->clk))
573 return PTR_ERR(dw_wdt->clk);
574 }
575
576 dw_wdt->rate = clk_get_rate(dw_wdt->clk);
577 if (dw_wdt->rate == 0)
578 return -EINVAL;
579
580 /*
581 * Request APB clock if device is configured with async clocks mode.
582 * In this case both tclk and pclk clocks are supposed to be specified.
583 * Alas we can't know for sure whether async mode was really activated,
584 * so the pclk phandle reference is left optional. If it couldn't be
585 * found we consider the device configured in synchronous clocks mode.
586 */
587 dw_wdt->pclk = devm_clk_get_optional_enabled(dev, "pclk");
588 if (IS_ERR(dw_wdt->pclk))
589 return PTR_ERR(dw_wdt->pclk);
590
591 dw_wdt->rst = devm_reset_control_get_optional_shared(&pdev->dev, NULL);
592 if (IS_ERR(dw_wdt->rst))
593 return PTR_ERR(dw_wdt->rst);
594
595 /* Enable normal reset without pre-timeout by default. */
596 dw_wdt_update_mode(dw_wdt, DW_WDT_RMOD_RESET);
597
598 /*
599 * Pre-timeout IRQ is optional, since some hardware may lack support
600 * of it. Note we must request rising-edge IRQ, since the lane is left
601 * pending either until the next watchdog kick event or up to the
602 * system reset.
603 */
604 ret = platform_get_irq_optional(pdev, 0);
605 if (ret > 0) {
606 ret = devm_request_irq(dev, ret, dw_wdt_irq,
607 IRQF_SHARED | IRQF_TRIGGER_RISING,
608 pdev->name, dw_wdt);
609 if (ret)
610 return ret;
611
612 dw_wdt->wdd.info = &dw_wdt_pt_ident;
613 } else {
614 if (ret == -EPROBE_DEFER)
615 return ret;
616
617 dw_wdt->wdd.info = &dw_wdt_ident;
618 }
619
620 reset_control_deassert(dw_wdt->rst);
621
622 ret = dw_wdt_init_timeouts(dw_wdt, dev);
623 if (ret)
624 goto out_assert_rst;
625
626 wdd = &dw_wdt->wdd;
627 wdd->ops = &dw_wdt_ops;
628 wdd->min_timeout = dw_wdt_get_min_timeout(dw_wdt);
629 wdd->max_hw_heartbeat_ms = dw_wdt_get_max_timeout_ms(dw_wdt);
630 wdd->parent = dev;
631
632 watchdog_set_drvdata(wdd, dw_wdt);
633 watchdog_set_nowayout(wdd, nowayout);
634 watchdog_init_timeout(wdd, 0, dev);
635
636 /*
637 * If the watchdog is already running, use its already configured
638 * timeout. Otherwise use the default or the value provided through
639 * devicetree.
640 */
641 if (dw_wdt_is_enabled(dw_wdt)) {
642 wdd->timeout = dw_wdt_get_timeout(dw_wdt);
643 set_bit(WDOG_HW_RUNNING, &wdd->status);
644 } else {
645 wdd->timeout = DW_WDT_DEFAULT_SECONDS;
646 watchdog_init_timeout(wdd, 0, dev);
647 }
648
649 platform_set_drvdata(pdev, dw_wdt);
650
651 watchdog_set_restart_priority(wdd, 128);
652 watchdog_stop_on_reboot(wdd);
653
654 ret = watchdog_register_device(wdd);
655 if (ret)
656 goto out_assert_rst;
657
658 dw_wdt_dbgfs_init(dw_wdt);
659
660 return 0;
661
662out_assert_rst:
663 reset_control_assert(dw_wdt->rst);
664 return ret;
665}
666
667static void dw_wdt_drv_remove(struct platform_device *pdev)
668{
669 struct dw_wdt *dw_wdt = platform_get_drvdata(pdev);
670
671 dw_wdt_dbgfs_clear(dw_wdt);
672
673 watchdog_unregister_device(&dw_wdt->wdd);
674 reset_control_assert(dw_wdt->rst);
675}
676
677#ifdef CONFIG_OF
678static const struct of_device_id dw_wdt_of_match[] = {
679 { .compatible = "snps,dw-wdt", },
680 { /* sentinel */ }
681};
682MODULE_DEVICE_TABLE(of, dw_wdt_of_match);
683#endif
684
685static struct platform_driver dw_wdt_driver = {
686 .probe = dw_wdt_drv_probe,
687 .remove_new = dw_wdt_drv_remove,
688 .driver = {
689 .name = "dw_wdt",
690 .of_match_table = of_match_ptr(dw_wdt_of_match),
691 .pm = pm_sleep_ptr(&dw_wdt_pm_ops),
692 },
693};
694
695module_platform_driver(dw_wdt_driver);
696
697MODULE_AUTHOR("Jamie Iles");
698MODULE_DESCRIPTION("Synopsys DesignWare Watchdog Driver");
699MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Copyright 2010-2011 Picochip Ltd., Jamie Iles
4 * https://www.picochip.com
5 *
6 * This file implements a driver for the Synopsys DesignWare watchdog device
7 * in the many subsystems. The watchdog has 16 different timeout periods
8 * and these are a function of the input clock frequency.
9 *
10 * The DesignWare watchdog cannot be stopped once it has been started so we
11 * do not implement a stop function. The watchdog core will continue to send
12 * heartbeat requests after the watchdog device has been closed.
13 */
14
15#include <linux/bitops.h>
16#include <linux/limits.h>
17#include <linux/kernel.h>
18#include <linux/clk.h>
19#include <linux/delay.h>
20#include <linux/err.h>
21#include <linux/io.h>
22#include <linux/kernel.h>
23#include <linux/module.h>
24#include <linux/moduleparam.h>
25#include <linux/interrupt.h>
26#include <linux/of.h>
27#include <linux/pm.h>
28#include <linux/platform_device.h>
29#include <linux/reset.h>
30#include <linux/watchdog.h>
31#include <linux/debugfs.h>
32
33#define WDOG_CONTROL_REG_OFFSET 0x00
34#define WDOG_CONTROL_REG_WDT_EN_MASK 0x01
35#define WDOG_CONTROL_REG_RESP_MODE_MASK 0x02
36#define WDOG_TIMEOUT_RANGE_REG_OFFSET 0x04
37#define WDOG_TIMEOUT_RANGE_TOPINIT_SHIFT 4
38#define WDOG_CURRENT_COUNT_REG_OFFSET 0x08
39#define WDOG_COUNTER_RESTART_REG_OFFSET 0x0c
40#define WDOG_COUNTER_RESTART_KICK_VALUE 0x76
41#define WDOG_INTERRUPT_STATUS_REG_OFFSET 0x10
42#define WDOG_INTERRUPT_CLEAR_REG_OFFSET 0x14
43#define WDOG_COMP_PARAMS_5_REG_OFFSET 0xe4
44#define WDOG_COMP_PARAMS_4_REG_OFFSET 0xe8
45#define WDOG_COMP_PARAMS_3_REG_OFFSET 0xec
46#define WDOG_COMP_PARAMS_2_REG_OFFSET 0xf0
47#define WDOG_COMP_PARAMS_1_REG_OFFSET 0xf4
48#define WDOG_COMP_PARAMS_1_USE_FIX_TOP BIT(6)
49#define WDOG_COMP_VERSION_REG_OFFSET 0xf8
50#define WDOG_COMP_TYPE_REG_OFFSET 0xfc
51
52/* There are sixteen TOPs (timeout periods) that can be set in the watchdog. */
53#define DW_WDT_NUM_TOPS 16
54#define DW_WDT_FIX_TOP(_idx) (1U << (16 + _idx))
55
56#define DW_WDT_DEFAULT_SECONDS 30
57
58static const u32 dw_wdt_fix_tops[DW_WDT_NUM_TOPS] = {
59 DW_WDT_FIX_TOP(0), DW_WDT_FIX_TOP(1), DW_WDT_FIX_TOP(2),
60 DW_WDT_FIX_TOP(3), DW_WDT_FIX_TOP(4), DW_WDT_FIX_TOP(5),
61 DW_WDT_FIX_TOP(6), DW_WDT_FIX_TOP(7), DW_WDT_FIX_TOP(8),
62 DW_WDT_FIX_TOP(9), DW_WDT_FIX_TOP(10), DW_WDT_FIX_TOP(11),
63 DW_WDT_FIX_TOP(12), DW_WDT_FIX_TOP(13), DW_WDT_FIX_TOP(14),
64 DW_WDT_FIX_TOP(15)
65};
66
67static bool nowayout = WATCHDOG_NOWAYOUT;
68module_param(nowayout, bool, 0);
69MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started "
70 "(default=" __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
71
72enum dw_wdt_rmod {
73 DW_WDT_RMOD_RESET = 1,
74 DW_WDT_RMOD_IRQ = 2
75};
76
77struct dw_wdt_timeout {
78 u32 top_val;
79 unsigned int sec;
80 unsigned int msec;
81};
82
83struct dw_wdt {
84 void __iomem *regs;
85 struct clk *clk;
86 struct clk *pclk;
87 unsigned long rate;
88 enum dw_wdt_rmod rmod;
89 struct dw_wdt_timeout timeouts[DW_WDT_NUM_TOPS];
90 struct watchdog_device wdd;
91 struct reset_control *rst;
92 /* Save/restore */
93 u32 control;
94 u32 timeout;
95
96#ifdef CONFIG_DEBUG_FS
97 struct dentry *dbgfs_dir;
98#endif
99};
100
101#define to_dw_wdt(wdd) container_of(wdd, struct dw_wdt, wdd)
102
103static inline int dw_wdt_is_enabled(struct dw_wdt *dw_wdt)
104{
105 return readl(dw_wdt->regs + WDOG_CONTROL_REG_OFFSET) &
106 WDOG_CONTROL_REG_WDT_EN_MASK;
107}
108
109static void dw_wdt_update_mode(struct dw_wdt *dw_wdt, enum dw_wdt_rmod rmod)
110{
111 u32 val;
112
113 val = readl(dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
114 if (rmod == DW_WDT_RMOD_IRQ)
115 val |= WDOG_CONTROL_REG_RESP_MODE_MASK;
116 else
117 val &= ~WDOG_CONTROL_REG_RESP_MODE_MASK;
118 writel(val, dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
119
120 dw_wdt->rmod = rmod;
121}
122
123static unsigned int dw_wdt_find_best_top(struct dw_wdt *dw_wdt,
124 unsigned int timeout, u32 *top_val)
125{
126 int idx;
127
128 /*
129 * Find a TOP with timeout greater or equal to the requested number.
130 * Note we'll select a TOP with maximum timeout if the requested
131 * timeout couldn't be reached.
132 */
133 for (idx = 0; idx < DW_WDT_NUM_TOPS; ++idx) {
134 if (dw_wdt->timeouts[idx].sec >= timeout)
135 break;
136 }
137
138 if (idx == DW_WDT_NUM_TOPS)
139 --idx;
140
141 *top_val = dw_wdt->timeouts[idx].top_val;
142
143 return dw_wdt->timeouts[idx].sec;
144}
145
146static unsigned int dw_wdt_get_min_timeout(struct dw_wdt *dw_wdt)
147{
148 int idx;
149
150 /*
151 * We'll find a timeout greater or equal to one second anyway because
152 * the driver probe would have failed if there was none.
153 */
154 for (idx = 0; idx < DW_WDT_NUM_TOPS; ++idx) {
155 if (dw_wdt->timeouts[idx].sec)
156 break;
157 }
158
159 return dw_wdt->timeouts[idx].sec;
160}
161
162static unsigned int dw_wdt_get_max_timeout_ms(struct dw_wdt *dw_wdt)
163{
164 struct dw_wdt_timeout *timeout = &dw_wdt->timeouts[DW_WDT_NUM_TOPS - 1];
165 u64 msec;
166
167 msec = (u64)timeout->sec * MSEC_PER_SEC + timeout->msec;
168
169 return msec < UINT_MAX ? msec : UINT_MAX;
170}
171
172static unsigned int dw_wdt_get_timeout(struct dw_wdt *dw_wdt)
173{
174 int top_val = readl(dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET) & 0xF;
175 int idx;
176
177 for (idx = 0; idx < DW_WDT_NUM_TOPS; ++idx) {
178 if (dw_wdt->timeouts[idx].top_val == top_val)
179 break;
180 }
181
182 /*
183 * In IRQ mode due to the two stages counter, the actual timeout is
184 * twice greater than the TOP setting.
185 */
186 return dw_wdt->timeouts[idx].sec * dw_wdt->rmod;
187}
188
189static int dw_wdt_ping(struct watchdog_device *wdd)
190{
191 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
192
193 writel(WDOG_COUNTER_RESTART_KICK_VALUE, dw_wdt->regs +
194 WDOG_COUNTER_RESTART_REG_OFFSET);
195
196 return 0;
197}
198
199static int dw_wdt_set_timeout(struct watchdog_device *wdd, unsigned int top_s)
200{
201 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
202 unsigned int timeout;
203 u32 top_val;
204
205 /*
206 * Note IRQ mode being enabled means having a non-zero pre-timeout
207 * setup. In this case we try to find a TOP as close to the half of the
208 * requested timeout as possible since DW Watchdog IRQ mode is designed
209 * in two stages way - first timeout rises the pre-timeout interrupt,
210 * second timeout performs the system reset. So basically the effective
211 * watchdog-caused reset happens after two watchdog TOPs elapsed.
212 */
213 timeout = dw_wdt_find_best_top(dw_wdt, DIV_ROUND_UP(top_s, dw_wdt->rmod),
214 &top_val);
215 if (dw_wdt->rmod == DW_WDT_RMOD_IRQ)
216 wdd->pretimeout = timeout;
217 else
218 wdd->pretimeout = 0;
219
220 /*
221 * Set the new value in the watchdog. Some versions of dw_wdt
222 * have have TOPINIT in the TIMEOUT_RANGE register (as per
223 * CP_WDT_DUAL_TOP in WDT_COMP_PARAMS_1). On those we
224 * effectively get a pat of the watchdog right here.
225 */
226 writel(top_val | top_val << WDOG_TIMEOUT_RANGE_TOPINIT_SHIFT,
227 dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET);
228
229 /* Kick new TOP value into the watchdog counter if activated. */
230 if (watchdog_active(wdd))
231 dw_wdt_ping(wdd);
232
233 /*
234 * In case users set bigger timeout value than HW can support,
235 * kernel(watchdog_dev.c) helps to feed watchdog before
236 * wdd->max_hw_heartbeat_ms
237 */
238 if (top_s * 1000 <= wdd->max_hw_heartbeat_ms)
239 wdd->timeout = timeout * dw_wdt->rmod;
240 else
241 wdd->timeout = top_s;
242
243 return 0;
244}
245
246static int dw_wdt_set_pretimeout(struct watchdog_device *wdd, unsigned int req)
247{
248 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
249
250 /*
251 * We ignore actual value of the timeout passed from user-space
252 * using it as a flag whether the pretimeout functionality is intended
253 * to be activated.
254 */
255 dw_wdt_update_mode(dw_wdt, req ? DW_WDT_RMOD_IRQ : DW_WDT_RMOD_RESET);
256 dw_wdt_set_timeout(wdd, wdd->timeout);
257
258 return 0;
259}
260
261static void dw_wdt_arm_system_reset(struct dw_wdt *dw_wdt)
262{
263 u32 val = readl(dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
264
265 /* Disable/enable interrupt mode depending on the RMOD flag. */
266 if (dw_wdt->rmod == DW_WDT_RMOD_IRQ)
267 val |= WDOG_CONTROL_REG_RESP_MODE_MASK;
268 else
269 val &= ~WDOG_CONTROL_REG_RESP_MODE_MASK;
270 /* Enable watchdog. */
271 val |= WDOG_CONTROL_REG_WDT_EN_MASK;
272 writel(val, dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
273}
274
275static int dw_wdt_start(struct watchdog_device *wdd)
276{
277 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
278
279 dw_wdt_set_timeout(wdd, wdd->timeout);
280 dw_wdt_ping(&dw_wdt->wdd);
281 dw_wdt_arm_system_reset(dw_wdt);
282
283 return 0;
284}
285
286static int dw_wdt_stop(struct watchdog_device *wdd)
287{
288 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
289
290 if (!dw_wdt->rst) {
291 set_bit(WDOG_HW_RUNNING, &wdd->status);
292 return 0;
293 }
294
295 reset_control_assert(dw_wdt->rst);
296 reset_control_deassert(dw_wdt->rst);
297
298 return 0;
299}
300
301static int dw_wdt_restart(struct watchdog_device *wdd,
302 unsigned long action, void *data)
303{
304 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
305
306 writel(0, dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET);
307 dw_wdt_update_mode(dw_wdt, DW_WDT_RMOD_RESET);
308 if (dw_wdt_is_enabled(dw_wdt))
309 writel(WDOG_COUNTER_RESTART_KICK_VALUE,
310 dw_wdt->regs + WDOG_COUNTER_RESTART_REG_OFFSET);
311 else
312 dw_wdt_arm_system_reset(dw_wdt);
313
314 /* wait for reset to assert... */
315 mdelay(500);
316
317 return 0;
318}
319
320static unsigned int dw_wdt_get_timeleft(struct watchdog_device *wdd)
321{
322 struct dw_wdt *dw_wdt = to_dw_wdt(wdd);
323 unsigned int sec;
324 u32 val;
325
326 val = readl(dw_wdt->regs + WDOG_CURRENT_COUNT_REG_OFFSET);
327 sec = val / dw_wdt->rate;
328
329 if (dw_wdt->rmod == DW_WDT_RMOD_IRQ) {
330 val = readl(dw_wdt->regs + WDOG_INTERRUPT_STATUS_REG_OFFSET);
331 if (!val)
332 sec += wdd->pretimeout;
333 }
334
335 return sec;
336}
337
338static const struct watchdog_info dw_wdt_ident = {
339 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT |
340 WDIOF_MAGICCLOSE,
341 .identity = "Synopsys DesignWare Watchdog",
342};
343
344static const struct watchdog_info dw_wdt_pt_ident = {
345 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT |
346 WDIOF_PRETIMEOUT | WDIOF_MAGICCLOSE,
347 .identity = "Synopsys DesignWare Watchdog",
348};
349
350static const struct watchdog_ops dw_wdt_ops = {
351 .owner = THIS_MODULE,
352 .start = dw_wdt_start,
353 .stop = dw_wdt_stop,
354 .ping = dw_wdt_ping,
355 .set_timeout = dw_wdt_set_timeout,
356 .set_pretimeout = dw_wdt_set_pretimeout,
357 .get_timeleft = dw_wdt_get_timeleft,
358 .restart = dw_wdt_restart,
359};
360
361static irqreturn_t dw_wdt_irq(int irq, void *devid)
362{
363 struct dw_wdt *dw_wdt = devid;
364 u32 val;
365
366 /*
367 * We don't clear the IRQ status. It's supposed to be done by the
368 * following ping operations.
369 */
370 val = readl(dw_wdt->regs + WDOG_INTERRUPT_STATUS_REG_OFFSET);
371 if (!val)
372 return IRQ_NONE;
373
374 watchdog_notify_pretimeout(&dw_wdt->wdd);
375
376 return IRQ_HANDLED;
377}
378
379#ifdef CONFIG_PM_SLEEP
380static int dw_wdt_suspend(struct device *dev)
381{
382 struct dw_wdt *dw_wdt = dev_get_drvdata(dev);
383
384 dw_wdt->control = readl(dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
385 dw_wdt->timeout = readl(dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET);
386
387 clk_disable_unprepare(dw_wdt->pclk);
388 clk_disable_unprepare(dw_wdt->clk);
389
390 return 0;
391}
392
393static int dw_wdt_resume(struct device *dev)
394{
395 struct dw_wdt *dw_wdt = dev_get_drvdata(dev);
396 int err = clk_prepare_enable(dw_wdt->clk);
397
398 if (err)
399 return err;
400
401 err = clk_prepare_enable(dw_wdt->pclk);
402 if (err) {
403 clk_disable_unprepare(dw_wdt->clk);
404 return err;
405 }
406
407 writel(dw_wdt->timeout, dw_wdt->regs + WDOG_TIMEOUT_RANGE_REG_OFFSET);
408 writel(dw_wdt->control, dw_wdt->regs + WDOG_CONTROL_REG_OFFSET);
409
410 dw_wdt_ping(&dw_wdt->wdd);
411
412 return 0;
413}
414#endif /* CONFIG_PM_SLEEP */
415
416static SIMPLE_DEV_PM_OPS(dw_wdt_pm_ops, dw_wdt_suspend, dw_wdt_resume);
417
418/*
419 * In case if DW WDT IP core is synthesized with fixed TOP feature disabled the
420 * TOPs array can be arbitrary ordered with nearly any sixteen uint numbers
421 * depending on the system engineer imagination. The next method handles the
422 * passed TOPs array to pre-calculate the effective timeouts and to sort the
423 * TOP items out in the ascending order with respect to the timeouts.
424 */
425
426static void dw_wdt_handle_tops(struct dw_wdt *dw_wdt, const u32 *tops)
427{
428 struct dw_wdt_timeout tout, *dst;
429 int val, tidx;
430 u64 msec;
431
432 /*
433 * We walk over the passed TOPs array and calculate corresponding
434 * timeouts in seconds and milliseconds. The milliseconds granularity
435 * is needed to distinguish the TOPs with very close timeouts and to
436 * set the watchdog max heartbeat setting further.
437 */
438 for (val = 0; val < DW_WDT_NUM_TOPS; ++val) {
439 tout.top_val = val;
440 tout.sec = tops[val] / dw_wdt->rate;
441 msec = (u64)tops[val] * MSEC_PER_SEC;
442 do_div(msec, dw_wdt->rate);
443 tout.msec = msec - ((u64)tout.sec * MSEC_PER_SEC);
444
445 /*
446 * Find a suitable place for the current TOP in the timeouts
447 * array so that the list is remained in the ascending order.
448 */
449 for (tidx = 0; tidx < val; ++tidx) {
450 dst = &dw_wdt->timeouts[tidx];
451 if (tout.sec > dst->sec || (tout.sec == dst->sec &&
452 tout.msec >= dst->msec))
453 continue;
454 else
455 swap(*dst, tout);
456 }
457
458 dw_wdt->timeouts[val] = tout;
459 }
460}
461
462static int dw_wdt_init_timeouts(struct dw_wdt *dw_wdt, struct device *dev)
463{
464 u32 data, of_tops[DW_WDT_NUM_TOPS];
465 const u32 *tops;
466 int ret;
467
468 /*
469 * Retrieve custom or fixed counter values depending on the
470 * WDT_USE_FIX_TOP flag found in the component specific parameters
471 * #1 register.
472 */
473 data = readl(dw_wdt->regs + WDOG_COMP_PARAMS_1_REG_OFFSET);
474 if (data & WDOG_COMP_PARAMS_1_USE_FIX_TOP) {
475 tops = dw_wdt_fix_tops;
476 } else {
477 ret = of_property_read_variable_u32_array(dev_of_node(dev),
478 "snps,watchdog-tops", of_tops, DW_WDT_NUM_TOPS,
479 DW_WDT_NUM_TOPS);
480 if (ret < 0) {
481 dev_warn(dev, "No valid TOPs array specified\n");
482 tops = dw_wdt_fix_tops;
483 } else {
484 tops = of_tops;
485 }
486 }
487
488 /* Convert the specified TOPs into an array of watchdog timeouts. */
489 dw_wdt_handle_tops(dw_wdt, tops);
490 if (!dw_wdt->timeouts[DW_WDT_NUM_TOPS - 1].sec) {
491 dev_err(dev, "No any valid TOP detected\n");
492 return -EINVAL;
493 }
494
495 return 0;
496}
497
498#ifdef CONFIG_DEBUG_FS
499
500#define DW_WDT_DBGFS_REG(_name, _off) \
501{ \
502 .name = _name, \
503 .offset = _off \
504}
505
506static const struct debugfs_reg32 dw_wdt_dbgfs_regs[] = {
507 DW_WDT_DBGFS_REG("cr", WDOG_CONTROL_REG_OFFSET),
508 DW_WDT_DBGFS_REG("torr", WDOG_TIMEOUT_RANGE_REG_OFFSET),
509 DW_WDT_DBGFS_REG("ccvr", WDOG_CURRENT_COUNT_REG_OFFSET),
510 DW_WDT_DBGFS_REG("crr", WDOG_COUNTER_RESTART_REG_OFFSET),
511 DW_WDT_DBGFS_REG("stat", WDOG_INTERRUPT_STATUS_REG_OFFSET),
512 DW_WDT_DBGFS_REG("param5", WDOG_COMP_PARAMS_5_REG_OFFSET),
513 DW_WDT_DBGFS_REG("param4", WDOG_COMP_PARAMS_4_REG_OFFSET),
514 DW_WDT_DBGFS_REG("param3", WDOG_COMP_PARAMS_3_REG_OFFSET),
515 DW_WDT_DBGFS_REG("param2", WDOG_COMP_PARAMS_2_REG_OFFSET),
516 DW_WDT_DBGFS_REG("param1", WDOG_COMP_PARAMS_1_REG_OFFSET),
517 DW_WDT_DBGFS_REG("version", WDOG_COMP_VERSION_REG_OFFSET),
518 DW_WDT_DBGFS_REG("type", WDOG_COMP_TYPE_REG_OFFSET)
519};
520
521static void dw_wdt_dbgfs_init(struct dw_wdt *dw_wdt)
522{
523 struct device *dev = dw_wdt->wdd.parent;
524 struct debugfs_regset32 *regset;
525
526 regset = devm_kzalloc(dev, sizeof(*regset), GFP_KERNEL);
527 if (!regset)
528 return;
529
530 regset->regs = dw_wdt_dbgfs_regs;
531 regset->nregs = ARRAY_SIZE(dw_wdt_dbgfs_regs);
532 regset->base = dw_wdt->regs;
533
534 dw_wdt->dbgfs_dir = debugfs_create_dir(dev_name(dev), NULL);
535
536 debugfs_create_regset32("registers", 0444, dw_wdt->dbgfs_dir, regset);
537}
538
539static void dw_wdt_dbgfs_clear(struct dw_wdt *dw_wdt)
540{
541 debugfs_remove_recursive(dw_wdt->dbgfs_dir);
542}
543
544#else /* !CONFIG_DEBUG_FS */
545
546static void dw_wdt_dbgfs_init(struct dw_wdt *dw_wdt) {}
547static void dw_wdt_dbgfs_clear(struct dw_wdt *dw_wdt) {}
548
549#endif /* !CONFIG_DEBUG_FS */
550
551static int dw_wdt_drv_probe(struct platform_device *pdev)
552{
553 struct device *dev = &pdev->dev;
554 struct watchdog_device *wdd;
555 struct dw_wdt *dw_wdt;
556 int ret;
557
558 dw_wdt = devm_kzalloc(dev, sizeof(*dw_wdt), GFP_KERNEL);
559 if (!dw_wdt)
560 return -ENOMEM;
561
562 dw_wdt->regs = devm_platform_ioremap_resource(pdev, 0);
563 if (IS_ERR(dw_wdt->regs))
564 return PTR_ERR(dw_wdt->regs);
565
566 /*
567 * Try to request the watchdog dedicated timer clock source. It must
568 * be supplied if asynchronous mode is enabled. Otherwise fallback
569 * to the common timer/bus clocks configuration, in which the very
570 * first found clock supply both timer and APB signals.
571 */
572 dw_wdt->clk = devm_clk_get(dev, "tclk");
573 if (IS_ERR(dw_wdt->clk)) {
574 dw_wdt->clk = devm_clk_get(dev, NULL);
575 if (IS_ERR(dw_wdt->clk))
576 return PTR_ERR(dw_wdt->clk);
577 }
578
579 ret = clk_prepare_enable(dw_wdt->clk);
580 if (ret)
581 return ret;
582
583 dw_wdt->rate = clk_get_rate(dw_wdt->clk);
584 if (dw_wdt->rate == 0) {
585 ret = -EINVAL;
586 goto out_disable_clk;
587 }
588
589 /*
590 * Request APB clock if device is configured with async clocks mode.
591 * In this case both tclk and pclk clocks are supposed to be specified.
592 * Alas we can't know for sure whether async mode was really activated,
593 * so the pclk phandle reference is left optional. If it couldn't be
594 * found we consider the device configured in synchronous clocks mode.
595 */
596 dw_wdt->pclk = devm_clk_get_optional(dev, "pclk");
597 if (IS_ERR(dw_wdt->pclk)) {
598 ret = PTR_ERR(dw_wdt->pclk);
599 goto out_disable_clk;
600 }
601
602 ret = clk_prepare_enable(dw_wdt->pclk);
603 if (ret)
604 goto out_disable_clk;
605
606 dw_wdt->rst = devm_reset_control_get_optional_shared(&pdev->dev, NULL);
607 if (IS_ERR(dw_wdt->rst)) {
608 ret = PTR_ERR(dw_wdt->rst);
609 goto out_disable_pclk;
610 }
611
612 /* Enable normal reset without pre-timeout by default. */
613 dw_wdt_update_mode(dw_wdt, DW_WDT_RMOD_RESET);
614
615 /*
616 * Pre-timeout IRQ is optional, since some hardware may lack support
617 * of it. Note we must request rising-edge IRQ, since the lane is left
618 * pending either until the next watchdog kick event or up to the
619 * system reset.
620 */
621 ret = platform_get_irq_optional(pdev, 0);
622 if (ret > 0) {
623 ret = devm_request_irq(dev, ret, dw_wdt_irq,
624 IRQF_SHARED | IRQF_TRIGGER_RISING,
625 pdev->name, dw_wdt);
626 if (ret)
627 goto out_disable_pclk;
628
629 dw_wdt->wdd.info = &dw_wdt_pt_ident;
630 } else {
631 if (ret == -EPROBE_DEFER)
632 goto out_disable_pclk;
633
634 dw_wdt->wdd.info = &dw_wdt_ident;
635 }
636
637 reset_control_deassert(dw_wdt->rst);
638
639 ret = dw_wdt_init_timeouts(dw_wdt, dev);
640 if (ret)
641 goto out_disable_clk;
642
643 wdd = &dw_wdt->wdd;
644 wdd->ops = &dw_wdt_ops;
645 wdd->min_timeout = dw_wdt_get_min_timeout(dw_wdt);
646 wdd->max_hw_heartbeat_ms = dw_wdt_get_max_timeout_ms(dw_wdt);
647 wdd->parent = dev;
648
649 watchdog_set_drvdata(wdd, dw_wdt);
650 watchdog_set_nowayout(wdd, nowayout);
651 watchdog_init_timeout(wdd, 0, dev);
652
653 /*
654 * If the watchdog is already running, use its already configured
655 * timeout. Otherwise use the default or the value provided through
656 * devicetree.
657 */
658 if (dw_wdt_is_enabled(dw_wdt)) {
659 wdd->timeout = dw_wdt_get_timeout(dw_wdt);
660 set_bit(WDOG_HW_RUNNING, &wdd->status);
661 } else {
662 wdd->timeout = DW_WDT_DEFAULT_SECONDS;
663 watchdog_init_timeout(wdd, 0, dev);
664 }
665
666 platform_set_drvdata(pdev, dw_wdt);
667
668 watchdog_set_restart_priority(wdd, 128);
669
670 ret = watchdog_register_device(wdd);
671 if (ret)
672 goto out_disable_pclk;
673
674 dw_wdt_dbgfs_init(dw_wdt);
675
676 return 0;
677
678out_disable_pclk:
679 clk_disable_unprepare(dw_wdt->pclk);
680
681out_disable_clk:
682 clk_disable_unprepare(dw_wdt->clk);
683 return ret;
684}
685
686static int dw_wdt_drv_remove(struct platform_device *pdev)
687{
688 struct dw_wdt *dw_wdt = platform_get_drvdata(pdev);
689
690 dw_wdt_dbgfs_clear(dw_wdt);
691
692 watchdog_unregister_device(&dw_wdt->wdd);
693 reset_control_assert(dw_wdt->rst);
694 clk_disable_unprepare(dw_wdt->pclk);
695 clk_disable_unprepare(dw_wdt->clk);
696
697 return 0;
698}
699
700#ifdef CONFIG_OF
701static const struct of_device_id dw_wdt_of_match[] = {
702 { .compatible = "snps,dw-wdt", },
703 { /* sentinel */ }
704};
705MODULE_DEVICE_TABLE(of, dw_wdt_of_match);
706#endif
707
708static struct platform_driver dw_wdt_driver = {
709 .probe = dw_wdt_drv_probe,
710 .remove = dw_wdt_drv_remove,
711 .driver = {
712 .name = "dw_wdt",
713 .of_match_table = of_match_ptr(dw_wdt_of_match),
714 .pm = &dw_wdt_pm_ops,
715 },
716};
717
718module_platform_driver(dw_wdt_driver);
719
720MODULE_AUTHOR("Jamie Iles");
721MODULE_DESCRIPTION("Synopsys DesignWare Watchdog Driver");
722MODULE_LICENSE("GPL");