1 // SPDX-License-Identifier: GPL-2.0
3 * Starfive Watchdog driver
5 * Copyright (C) 2022 StarFive Technology Co., Ltd.
9 #include <linux/iopoll.h>
10 #include <linux/module.h>
11 #include <linux/of_device.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/reset.h>
14 #include <linux/watchdog.h>
16 /* JH7100 Watchdog register define */
17 #define STARFIVE_WDT_JH7100_INTSTAUS 0x000
18 #define STARFIVE_WDT_JH7100_CONTROL 0x104
19 #define STARFIVE_WDT_JH7100_LOAD 0x108
20 #define STARFIVE_WDT_JH7100_EN 0x110
21 #define STARFIVE_WDT_JH7100_RELOAD 0x114 /* Write 0 or 1 to reload preset value */
22 #define STARFIVE_WDT_JH7100_VALUE 0x118
23 #define STARFIVE_WDT_JH7100_INTCLR 0x120 /*
24 * [0]: Write 1 to clear interrupt
25 * [1]: 1 mean clearing and 0 mean complete
28 #define STARFIVE_WDT_JH7100_LOCK 0x13c /* write 0x378f0765 to unlock */
30 /* JH7110 Watchdog register define */
31 #define STARFIVE_WDT_JH7110_LOAD 0x000
32 #define STARFIVE_WDT_JH7110_VALUE 0x004
33 #define STARFIVE_WDT_JH7110_CONTROL 0x008 /*
35 * [1]: interrupt enable && watchdog enable
38 #define STARFIVE_WDT_JH7110_INTCLR 0x00c /* clear intterupt and reload the counter */
39 #define STARFIVE_WDT_JH7110_IMS 0x014
40 #define STARFIVE_WDT_JH7110_LOCK 0xc00 /* write 0x1ACCE551 to unlock */
43 #define STARFIVE_WDT_ENABLE 0x1
44 #define STARFIVE_WDT_EN_SHIFT 0
45 #define STARFIVE_WDT_RESET_EN 0x1
46 #define STARFIVE_WDT_JH7100_RST_EN_SHIFT 0
47 #define STARFIVE_WDT_JH7110_RST_EN_SHIFT 1
50 #define STARFIVE_WDT_JH7100_UNLOCK_KEY 0x378f0765
51 #define STARFIVE_WDT_JH7110_UNLOCK_KEY 0x1acce551
54 #define STARFIVE_WDT_INTCLR 0x1
55 #define STARFIVE_WDT_JH7100_INTCLR_AVA_SHIFT 1 /* Watchdog can clear interrupt when 0 */
57 #define STARFIVE_WDT_MAXCNT 0xffffffff
58 #define STARFIVE_WDT_DEFAULT_TIME (15)
59 #define STARFIVE_WDT_DELAY_US 0
60 #define STARFIVE_WDT_TIMEOUT_US 10000
62 /* module parameter */
63 #define STARFIVE_WDT_EARLY_ENA 0
65 static bool nowayout = WATCHDOG_NOWAYOUT;
67 static bool early_enable = STARFIVE_WDT_EARLY_ENA;
69 module_param(heartbeat, int, 0);
70 module_param(early_enable, bool, 0);
71 module_param(nowayout, bool, 0);
73 MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. (default="
74 __MODULE_STRING(STARFIVE_WDT_DEFAULT_TIME) ")");
75 MODULE_PARM_DESC(early_enable,
76 "Watchdog is started at boot time if set to 1, default="
77 __MODULE_STRING(STARFIVE_WDT_EARLY_ENA));
78 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
79 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
81 struct starfive_wdt_variant {
82 unsigned int control; /* Watchdog Control Resgister for reset enable */
83 unsigned int load; /* Watchdog Load register */
84 unsigned int reload; /* Watchdog Reload Control register */
85 unsigned int enable; /* Watchdog Enable Register */
86 unsigned int value; /* Watchdog Counter Value Register */
87 unsigned int int_clr; /* Watchdog Interrupt Clear Register */
88 unsigned int unlock; /* Watchdog Lock Register */
89 unsigned int int_status; /* Watchdog Interrupt Status Register */
94 bool intclr_check; /* whether need to check it before clearing interrupt */
95 char intclr_ava_shift;
96 bool double_timeout; /* The watchdog need twice timeout to reboot */
100 struct watchdog_device wdd;
101 spinlock_t lock; /* spinlock for register handling */
103 struct clk *core_clk;
105 const struct starfive_wdt_variant *variant;
107 u32 count; /* count of timeout */
108 u32 reload; /* restore the count */
111 /* Register layout and configuration for the JH7100 */
112 static const struct starfive_wdt_variant starfive_wdt_jh7100_variant = {
113 .control = STARFIVE_WDT_JH7100_CONTROL,
114 .load = STARFIVE_WDT_JH7100_LOAD,
115 .reload = STARFIVE_WDT_JH7100_RELOAD,
116 .enable = STARFIVE_WDT_JH7100_EN,
117 .value = STARFIVE_WDT_JH7100_VALUE,
118 .int_clr = STARFIVE_WDT_JH7100_INTCLR,
119 .unlock = STARFIVE_WDT_JH7100_LOCK,
120 .unlock_key = STARFIVE_WDT_JH7100_UNLOCK_KEY,
121 .int_status = STARFIVE_WDT_JH7100_INTSTAUS,
122 .enrst_shift = STARFIVE_WDT_JH7100_RST_EN_SHIFT,
123 .en_shift = STARFIVE_WDT_EN_SHIFT,
124 .intclr_check = true,
125 .intclr_ava_shift = STARFIVE_WDT_JH7100_INTCLR_AVA_SHIFT,
126 .double_timeout = false,
129 /* Register layout and configuration for the JH7110 */
130 static const struct starfive_wdt_variant starfive_wdt_jh7110_variant = {
131 .control = STARFIVE_WDT_JH7110_CONTROL,
132 .load = STARFIVE_WDT_JH7110_LOAD,
133 .enable = STARFIVE_WDT_JH7110_CONTROL,
134 .value = STARFIVE_WDT_JH7110_VALUE,
135 .int_clr = STARFIVE_WDT_JH7110_INTCLR,
136 .unlock = STARFIVE_WDT_JH7110_LOCK,
137 .unlock_key = STARFIVE_WDT_JH7110_UNLOCK_KEY,
138 .int_status = STARFIVE_WDT_JH7110_IMS,
139 .enrst_shift = STARFIVE_WDT_JH7110_RST_EN_SHIFT,
140 .en_shift = STARFIVE_WDT_EN_SHIFT,
141 .intclr_check = false,
142 .double_timeout = true,
145 static int starfive_wdt_enable_clock(struct starfive_wdt *wdt)
149 ret = clk_prepare_enable(wdt->apb_clk);
151 return dev_err_probe(wdt->wdd.parent, ret, "failed to enable apb clock\n");
153 ret = clk_prepare_enable(wdt->core_clk);
155 return dev_err_probe(wdt->wdd.parent, ret, "failed to enable core clock\n");
160 static void starfive_wdt_disable_clock(struct starfive_wdt *wdt)
162 clk_disable_unprepare(wdt->core_clk);
163 clk_disable_unprepare(wdt->apb_clk);
166 static inline int starfive_wdt_get_clock(struct starfive_wdt *wdt)
168 struct device *dev = wdt->wdd.parent;
170 wdt->apb_clk = devm_clk_get(dev, "apb");
171 if (IS_ERR(wdt->apb_clk))
172 return dev_err_probe(dev, PTR_ERR(wdt->apb_clk), "failed to get apb clock\n");
174 wdt->core_clk = devm_clk_get(dev, "core");
175 if (IS_ERR(wdt->core_clk))
176 return dev_err_probe(dev, PTR_ERR(wdt->core_clk), "failed to get core clock\n");
181 static inline int starfive_wdt_reset_init(struct device *dev)
183 struct reset_control *rsts;
186 rsts = devm_reset_control_array_get_exclusive(dev);
188 return dev_err_probe(dev, PTR_ERR(rsts), "failed to get resets\n");
190 ret = reset_control_deassert(rsts);
192 return dev_err_probe(dev, ret, "failed to deassert resets\n");
197 static u32 starfive_wdt_ticks_to_sec(struct starfive_wdt *wdt, u32 ticks)
199 return DIV_ROUND_CLOSEST(ticks, wdt->freq);
202 /* Write unlock-key to unlock. Write other value to lock. */
203 static void starfive_wdt_unlock(struct starfive_wdt *wdt)
205 spin_lock(&wdt->lock);
206 writel(wdt->variant->unlock_key, wdt->base + wdt->variant->unlock);
209 static void starfive_wdt_lock(struct starfive_wdt *wdt)
211 writel(~wdt->variant->unlock_key, wdt->base + wdt->variant->unlock);
212 spin_unlock(&wdt->lock);
215 /* enable watchdog interrupt to reset/reboot */
216 static void starfive_wdt_enable_reset(struct starfive_wdt *wdt)
220 val = readl(wdt->base + wdt->variant->control);
221 val |= STARFIVE_WDT_RESET_EN << wdt->variant->enrst_shift;
222 writel(val, wdt->base + wdt->variant->control);
225 /* interrupt status whether has been raised from the counter */
226 static bool starfive_wdt_raise_irq_status(struct starfive_wdt *wdt)
228 return !!readl(wdt->base + wdt->variant->int_status);
231 /* waiting interrupt can be free to clear */
232 static int starfive_wdt_wait_int_free(struct starfive_wdt *wdt)
236 return readl_poll_timeout_atomic(wdt->base + wdt->variant->int_clr, value,
237 !(value & BIT(wdt->variant->intclr_ava_shift)),
238 STARFIVE_WDT_DELAY_US, STARFIVE_WDT_TIMEOUT_US);
241 /* clear interrupt signal before initialization or reload */
242 static int starfive_wdt_int_clr(struct starfive_wdt *wdt)
246 if (wdt->variant->intclr_check) {
247 ret = starfive_wdt_wait_int_free(wdt);
249 return dev_err_probe(wdt->wdd.parent, ret,
250 "watchdog is not ready to clear interrupt.\n");
252 writel(STARFIVE_WDT_INTCLR, wdt->base + wdt->variant->int_clr);
257 static inline void starfive_wdt_set_count(struct starfive_wdt *wdt, u32 val)
259 writel(val, wdt->base + wdt->variant->load);
262 static inline u32 starfive_wdt_get_count(struct starfive_wdt *wdt)
264 return readl(wdt->base + wdt->variant->value);
267 /* enable watchdog */
268 static inline void starfive_wdt_enable(struct starfive_wdt *wdt)
272 val = readl(wdt->base + wdt->variant->enable);
273 val |= STARFIVE_WDT_ENABLE << wdt->variant->en_shift;
274 writel(val, wdt->base + wdt->variant->enable);
277 /* disable watchdog */
278 static inline void starfive_wdt_disable(struct starfive_wdt *wdt)
282 val = readl(wdt->base + wdt->variant->enable);
283 val &= ~(STARFIVE_WDT_ENABLE << wdt->variant->en_shift);
284 writel(val, wdt->base + wdt->variant->enable);
287 static inline void starfive_wdt_set_reload_count(struct starfive_wdt *wdt, u32 count)
289 starfive_wdt_set_count(wdt, count);
291 /* 7100 need set any value to reload register and could reload value to counter */
292 if (wdt->variant->reload)
293 writel(0x1, wdt->base + wdt->variant->reload);
296 static unsigned int starfive_wdt_max_timeout(struct starfive_wdt *wdt)
298 if (wdt->variant->double_timeout)
299 return DIV_ROUND_UP(STARFIVE_WDT_MAXCNT, (wdt->freq / 2)) - 1;
301 return DIV_ROUND_UP(STARFIVE_WDT_MAXCNT, wdt->freq) - 1;
304 static unsigned int starfive_wdt_get_timeleft(struct watchdog_device *wdd)
306 struct starfive_wdt *wdt = watchdog_get_drvdata(wdd);
310 * If the watchdog takes twice timeout and set half count value,
311 * timeleft value should add the count value before first timeout.
313 count = starfive_wdt_get_count(wdt);
314 if (wdt->variant->double_timeout && !starfive_wdt_raise_irq_status(wdt))
317 return starfive_wdt_ticks_to_sec(wdt, count);
320 static int starfive_wdt_keepalive(struct watchdog_device *wdd)
322 struct starfive_wdt *wdt = watchdog_get_drvdata(wdd);
325 starfive_wdt_unlock(wdt);
326 ret = starfive_wdt_int_clr(wdt);
330 starfive_wdt_set_reload_count(wdt, wdt->count);
333 /* exit with releasing spinlock and locking registers */
334 starfive_wdt_lock(wdt);
338 static int starfive_wdt_start(struct starfive_wdt *wdt)
342 starfive_wdt_unlock(wdt);
343 /* disable watchdog, to be safe */
344 starfive_wdt_disable(wdt);
346 starfive_wdt_enable_reset(wdt);
347 ret = starfive_wdt_int_clr(wdt);
351 starfive_wdt_set_count(wdt, wdt->count);
352 starfive_wdt_enable(wdt);
355 starfive_wdt_lock(wdt);
359 static void starfive_wdt_stop(struct starfive_wdt *wdt)
361 starfive_wdt_unlock(wdt);
362 starfive_wdt_disable(wdt);
363 starfive_wdt_lock(wdt);
366 static int starfive_wdt_pm_start(struct watchdog_device *wdd)
368 struct starfive_wdt *wdt = watchdog_get_drvdata(wdd);
369 int ret = pm_runtime_get_sync(wdd->parent);
374 return starfive_wdt_start(wdt);
377 static int starfive_wdt_pm_stop(struct watchdog_device *wdd)
379 struct starfive_wdt *wdt = watchdog_get_drvdata(wdd);
381 starfive_wdt_stop(wdt);
382 return pm_runtime_put_sync(wdd->parent);
385 static int starfive_wdt_set_timeout(struct watchdog_device *wdd,
386 unsigned int timeout)
388 struct starfive_wdt *wdt = watchdog_get_drvdata(wdd);
389 unsigned long count = timeout * wdt->freq;
391 /* some watchdogs take two timeouts to reset */
392 if (wdt->variant->double_timeout)
396 wdd->timeout = timeout;
398 starfive_wdt_unlock(wdt);
399 starfive_wdt_disable(wdt);
400 starfive_wdt_set_reload_count(wdt, wdt->count);
401 starfive_wdt_enable(wdt);
402 starfive_wdt_lock(wdt);
407 #define STARFIVE_WDT_OPTIONS (WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING | WDIOF_MAGICCLOSE)
409 static const struct watchdog_info starfive_wdt_info = {
410 .options = STARFIVE_WDT_OPTIONS,
411 .identity = "StarFive Watchdog",
414 static const struct watchdog_ops starfive_wdt_ops = {
415 .owner = THIS_MODULE,
416 .start = starfive_wdt_pm_start,
417 .stop = starfive_wdt_pm_stop,
418 .ping = starfive_wdt_keepalive,
419 .set_timeout = starfive_wdt_set_timeout,
420 .get_timeleft = starfive_wdt_get_timeleft,
423 static int starfive_wdt_probe(struct platform_device *pdev)
425 struct starfive_wdt *wdt;
428 wdt = devm_kzalloc(&pdev->dev, sizeof(*wdt), GFP_KERNEL);
432 wdt->base = devm_platform_ioremap_resource(pdev, 0);
433 if (IS_ERR(wdt->base))
434 return dev_err_probe(&pdev->dev, PTR_ERR(wdt->base), "error mapping registers\n");
436 wdt->wdd.parent = &pdev->dev;
437 ret = starfive_wdt_get_clock(wdt);
441 platform_set_drvdata(pdev, wdt);
442 pm_runtime_enable(&pdev->dev);
443 if (pm_runtime_enabled(&pdev->dev)) {
444 ret = pm_runtime_get_sync(&pdev->dev);
448 /* runtime PM is disabled but clocks need to be enabled */
449 ret = starfive_wdt_enable_clock(wdt);
454 ret = starfive_wdt_reset_init(&pdev->dev);
458 watchdog_set_drvdata(&wdt->wdd, wdt);
459 wdt->wdd.info = &starfive_wdt_info;
460 wdt->wdd.ops = &starfive_wdt_ops;
461 wdt->variant = of_device_get_match_data(&pdev->dev);
462 spin_lock_init(&wdt->lock);
464 wdt->freq = clk_get_rate(wdt->core_clk);
466 dev_err(&pdev->dev, "get clock rate failed.\n");
471 wdt->wdd.min_timeout = 1;
472 wdt->wdd.max_timeout = starfive_wdt_max_timeout(wdt);
473 wdt->wdd.timeout = STARFIVE_WDT_DEFAULT_TIME;
474 watchdog_init_timeout(&wdt->wdd, heartbeat, &pdev->dev);
475 starfive_wdt_set_timeout(&wdt->wdd, wdt->wdd.timeout);
477 watchdog_set_nowayout(&wdt->wdd, nowayout);
478 watchdog_stop_on_reboot(&wdt->wdd);
479 watchdog_stop_on_unregister(&wdt->wdd);
482 ret = starfive_wdt_start(wdt);
485 set_bit(WDOG_HW_RUNNING, &wdt->wdd.status);
487 starfive_wdt_stop(wdt);
490 ret = watchdog_register_device(&wdt->wdd);
495 pm_runtime_put_sync(&pdev->dev);
500 starfive_wdt_disable_clock(wdt);
501 pm_runtime_disable(&pdev->dev);
506 static int starfive_wdt_remove(struct platform_device *pdev)
508 struct starfive_wdt *wdt = platform_get_drvdata(pdev);
510 starfive_wdt_stop(wdt);
511 watchdog_unregister_device(&wdt->wdd);
513 if (pm_runtime_enabled(&pdev->dev))
514 pm_runtime_disable(&pdev->dev);
516 /* disable clock without PM */
517 starfive_wdt_disable_clock(wdt);
522 static void starfive_wdt_shutdown(struct platform_device *pdev)
524 struct starfive_wdt *wdt = platform_get_drvdata(pdev);
526 starfive_wdt_pm_stop(&wdt->wdd);
529 #ifdef CONFIG_PM_SLEEP
530 static int starfive_wdt_suspend(struct device *dev)
532 struct starfive_wdt *wdt = dev_get_drvdata(dev);
534 /* Save watchdog state, and turn it off. */
535 wdt->reload = starfive_wdt_get_count(wdt);
537 /* Note that WTCNT doesn't need to be saved. */
538 starfive_wdt_stop(wdt);
540 return pm_runtime_force_suspend(dev);
543 static int starfive_wdt_resume(struct device *dev)
545 struct starfive_wdt *wdt = dev_get_drvdata(dev);
548 ret = pm_runtime_force_resume(dev);
552 starfive_wdt_unlock(wdt);
553 /* Restore watchdog state. */
554 starfive_wdt_set_reload_count(wdt, wdt->reload);
555 starfive_wdt_lock(wdt);
557 return starfive_wdt_start(wdt);
559 #endif /* CONFIG_PM_SLEEP */
562 static int starfive_wdt_runtime_suspend(struct device *dev)
564 struct starfive_wdt *wdt = dev_get_drvdata(dev);
566 starfive_wdt_disable_clock(wdt);
571 static int starfive_wdt_runtime_resume(struct device *dev)
573 struct starfive_wdt *wdt = dev_get_drvdata(dev);
575 return starfive_wdt_enable_clock(wdt);
577 #endif /* CONFIG_PM */
579 static const struct dev_pm_ops starfive_wdt_pm_ops = {
580 SET_RUNTIME_PM_OPS(starfive_wdt_runtime_suspend, starfive_wdt_runtime_resume, NULL)
581 SET_SYSTEM_SLEEP_PM_OPS(starfive_wdt_suspend, starfive_wdt_resume)
584 static const struct of_device_id starfive_wdt_match[] = {
585 { .compatible = "starfive,jh7100-wdt", .data = &starfive_wdt_jh7100_variant },
586 { .compatible = "starfive,jh7110-wdt", .data = &starfive_wdt_jh7110_variant },
589 MODULE_DEVICE_TABLE(of, starfive_wdt_match);
591 static struct platform_driver starfive_wdt_driver = {
592 .probe = starfive_wdt_probe,
593 .remove = starfive_wdt_remove,
594 .shutdown = starfive_wdt_shutdown,
596 .name = "starfive-wdt",
597 .pm = &starfive_wdt_pm_ops,
598 .of_match_table = starfive_wdt_match,
601 module_platform_driver(starfive_wdt_driver);
603 MODULE_AUTHOR("Xingyu Wu <xingyu.wu@starfivetech.com>");
604 MODULE_AUTHOR("Samin Guo <samin.guo@starfivetech.com>");
605 MODULE_DESCRIPTION("StarFive Watchdog Device Driver");
606 MODULE_LICENSE("GPL");