1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * SBSA(Server Base System Architecture) Generic Watchdog driver
4 *
5 * Copyright (c) 2015, Linaro Ltd.
6 * Author: Fu Wei <fu.wei@linaro.org>
7 * Suravee Suthikulpanit <Suravee.Suthikulpanit@amd.com>
8 * Al Stone <al.stone@linaro.org>
9 * Timur Tabi <timur@codeaurora.org>
10 *
11 * ARM SBSA Generic Watchdog has two stage timeouts:
12 * the first signal (WS0) is for alerting the system by interrupt,
13 * the second one (WS1) is a real hardware reset.
14 * More details about the hardware specification of this device:
15 * ARM DEN0029B - Server Base System Architecture (SBSA)
16 *
17 * This driver can operate ARM SBSA Generic Watchdog as a single stage watchdog
18 * or a two stages watchdog, it's set up by the module parameter "action".
19 * In the single stage mode, when the timeout is reached, your system
20 * will be reset by WS1. The first signal (WS0) is ignored.
21 * In the two stages mode, when the timeout is reached, the first signal (WS0)
22 * will trigger panic. If the system is getting into trouble and cannot be reset
23 * by panic or restart properly by the kdump kernel(if supported), then the
24 * second stage (as long as the first stage) will be reached, system will be
25 * reset by WS1. This function can help administrator to backup the system
26 * context info by panic console output or kdump.
27 *
28 * SBSA GWDT:
29 * if action is 1 (the two stages mode):
30 * |--------WOR-------WS0--------WOR-------WS1
31 * |----timeout-----(panic)----timeout-----reset
32 *
33 * if action is 0 (the single stage mode):
34 * |------WOR-----WS0(ignored)-----WOR------WS1
35 * |--------------timeout-------------------reset
36 *
37 * Note: Since this watchdog timer has two stages, and each stage is determined
38 * by WOR, in the single stage mode, the timeout is (WOR * 2); in the two
39 * stages mode, the timeout is WOR. The maximum timeout in the two stages mode
40 * is half of that in the single stage mode.
41 */
42
43#include <linux/io.h>
44#include <linux/io-64-nonatomic-lo-hi.h>
45#include <linux/interrupt.h>
46#include <linux/mod_devicetable.h>
47#include <linux/module.h>
48#include <linux/moduleparam.h>
49#include <linux/platform_device.h>
50#include <linux/uaccess.h>
51#include <linux/watchdog.h>
52#include <asm/arch_timer.h>
53
54#define DRV_NAME "sbsa-gwdt"
55#define WATCHDOG_NAME "SBSA Generic Watchdog"
56
57/* SBSA Generic Watchdog register definitions */
58/* refresh frame */
59#define SBSA_GWDT_WRR 0x000
60
61/* control frame */
62#define SBSA_GWDT_WCS 0x000
63#define SBSA_GWDT_WOR 0x008
64#define SBSA_GWDT_WCV 0x010
65
66/* refresh/control frame */
67#define SBSA_GWDT_W_IIDR 0xfcc
68#define SBSA_GWDT_IDR 0xfd0
69
70/* Watchdog Control and Status Register */
71#define SBSA_GWDT_WCS_EN BIT(0)
72#define SBSA_GWDT_WCS_WS0 BIT(1)
73#define SBSA_GWDT_WCS_WS1 BIT(2)
74
75#define SBSA_GWDT_VERSION_MASK 0xF
76#define SBSA_GWDT_VERSION_SHIFT 16
77
78/**
79 * struct sbsa_gwdt - Internal representation of the SBSA GWDT
80 * @wdd: kernel watchdog_device structure
81 * @clk: store the System Counter clock frequency, in Hz.
82 * @version: store the architecture version
83 * @refresh_base: Virtual address of the watchdog refresh frame
84 * @control_base: Virtual address of the watchdog control frame
85 */
86struct sbsa_gwdt {
87 struct watchdog_device wdd;
88 u32 clk;
89 int version;
90 void __iomem *refresh_base;
91 void __iomem *control_base;
92};
93
94#define DEFAULT_TIMEOUT 10 /* seconds */
95
96static unsigned int timeout;
97module_param(timeout, uint, 0);
98MODULE_PARM_DESC(timeout,
99 "Watchdog timeout in seconds. (>=0, default="
100 __MODULE_STRING(DEFAULT_TIMEOUT) ")");
101
102/*
103 * action refers to action taken when watchdog gets WS0
104 * 0 = skip
105 * 1 = panic
106 * defaults to skip (0)
107 */
108static int action;
109module_param(action, int, 0);
110MODULE_PARM_DESC(action, "after watchdog gets WS0 interrupt, do: "
111 "0 = skip(*) 1 = panic");
112
113static bool nowayout = WATCHDOG_NOWAYOUT;
114module_param(nowayout, bool, S_IRUGO);
115MODULE_PARM_DESC(nowayout,
116 "Watchdog cannot be stopped once started (default="
117 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
118
119/*
120 * Arm Base System Architecture 1.0 introduces watchdog v1 which
121 * increases the length watchdog offset register to 48 bits.
122 * - For version 0: WOR is 32 bits;
123 * - For version 1: WOR is 48 bits which comprises the register
124 * offset 0x8 and 0xC, and the bits [63:48] are reserved which are
125 * Read-As-Zero and Writes-Ignored.
126 */
127static u64 sbsa_gwdt_reg_read(struct sbsa_gwdt *gwdt)
128{
129 if (gwdt->version == 0)
130 return readl(addr: gwdt->control_base + SBSA_GWDT_WOR);
131 else
132 return lo_hi_readq(addr: gwdt->control_base + SBSA_GWDT_WOR);
133}
134
135static void sbsa_gwdt_reg_write(u64 val, struct sbsa_gwdt *gwdt)
136{
137 if (gwdt->version == 0)
138 writel(val: (u32)val, addr: gwdt->control_base + SBSA_GWDT_WOR);
139 else
140 lo_hi_writeq(val, addr: gwdt->control_base + SBSA_GWDT_WOR);
141}
142
143/*
144 * watchdog operation functions
145 */
146static int sbsa_gwdt_set_timeout(struct watchdog_device *wdd,
147 unsigned int timeout)
148{
149 struct sbsa_gwdt *gwdt = watchdog_get_drvdata(wdd);
150
151 wdd->timeout = timeout;
152 timeout = clamp_t(unsigned int, timeout, 1, wdd->max_hw_heartbeat_ms / 1000);
153
154 if (action)
155 sbsa_gwdt_reg_write(val: gwdt->clk * timeout, gwdt);
156 else
157 /*
158 * In the single stage mode, The first signal (WS0) is ignored,
159 * the timeout is (WOR * 2), so the WOR should be configured
160 * to half value of timeout.
161 */
162 sbsa_gwdt_reg_write(val: gwdt->clk / 2 * timeout, gwdt);
163
164 return 0;
165}
166
167static unsigned int sbsa_gwdt_get_timeleft(struct watchdog_device *wdd)
168{
169 struct sbsa_gwdt *gwdt = watchdog_get_drvdata(wdd);
170 u64 timeleft = 0;
171
172 /*
173 * In the single stage mode, if WS0 is deasserted
174 * (watchdog is in the first stage),
175 * timeleft = WOR + (WCV - system counter)
176 */
177 if (!action &&
178 !(readl(addr: gwdt->control_base + SBSA_GWDT_WCS) & SBSA_GWDT_WCS_WS0))
179 timeleft += sbsa_gwdt_reg_read(gwdt);
180
181 timeleft += lo_hi_readq(addr: gwdt->control_base + SBSA_GWDT_WCV) -
182 arch_timer_read_counter();
183
184 do_div(timeleft, gwdt->clk);
185
186 return timeleft;
187}
188
189static int sbsa_gwdt_keepalive(struct watchdog_device *wdd)
190{
191 struct sbsa_gwdt *gwdt = watchdog_get_drvdata(wdd);
192
193 /*
194 * Writing WRR for an explicit watchdog refresh.
195 * You can write anyting (like 0).
196 */
197 writel(val: 0, addr: gwdt->refresh_base + SBSA_GWDT_WRR);
198
199 return 0;
200}
201
202static void sbsa_gwdt_get_version(struct watchdog_device *wdd)
203{
204 struct sbsa_gwdt *gwdt = watchdog_get_drvdata(wdd);
205 int ver;
206
207 ver = readl(addr: gwdt->control_base + SBSA_GWDT_W_IIDR);
208 ver = (ver >> SBSA_GWDT_VERSION_SHIFT) & SBSA_GWDT_VERSION_MASK;
209
210 gwdt->version = ver;
211}
212
213static int sbsa_gwdt_start(struct watchdog_device *wdd)
214{
215 struct sbsa_gwdt *gwdt = watchdog_get_drvdata(wdd);
216
217 /* writing WCS will cause an explicit watchdog refresh */
218 writel(SBSA_GWDT_WCS_EN, addr: gwdt->control_base + SBSA_GWDT_WCS);
219
220 return 0;
221}
222
223static int sbsa_gwdt_stop(struct watchdog_device *wdd)
224{
225 struct sbsa_gwdt *gwdt = watchdog_get_drvdata(wdd);
226
227 /* Simply write 0 to WCS to clean WCS_EN bit */
228 writel(val: 0, addr: gwdt->control_base + SBSA_GWDT_WCS);
229
230 return 0;
231}
232
233static irqreturn_t sbsa_gwdt_interrupt(int irq, void *dev_id)
234{
235 panic(WATCHDOG_NAME " timeout");
236
237 return IRQ_HANDLED;
238}
239
240static const struct watchdog_info sbsa_gwdt_info = {
241 .identity = WATCHDOG_NAME,
242 .options = WDIOF_SETTIMEOUT |
243 WDIOF_KEEPALIVEPING |
244 WDIOF_MAGICCLOSE |
245 WDIOF_CARDRESET,
246};
247
248static const struct watchdog_ops sbsa_gwdt_ops = {
249 .owner = THIS_MODULE,
250 .start = sbsa_gwdt_start,
251 .stop = sbsa_gwdt_stop,
252 .ping = sbsa_gwdt_keepalive,
253 .set_timeout = sbsa_gwdt_set_timeout,
254 .get_timeleft = sbsa_gwdt_get_timeleft,
255};
256
257static int sbsa_gwdt_probe(struct platform_device *pdev)
258{
259 void __iomem *rf_base, *cf_base;
260 struct device *dev = &pdev->dev;
261 struct watchdog_device *wdd;
262 struct sbsa_gwdt *gwdt;
263 int ret, irq;
264 u32 status;
265
266 gwdt = devm_kzalloc(dev, size: sizeof(*gwdt), GFP_KERNEL);
267 if (!gwdt)
268 return -ENOMEM;
269 platform_set_drvdata(pdev, data: gwdt);
270
271 cf_base = devm_platform_ioremap_resource(pdev, index: 0);
272 if (IS_ERR(ptr: cf_base))
273 return PTR_ERR(ptr: cf_base);
274
275 rf_base = devm_platform_ioremap_resource(pdev, index: 1);
276 if (IS_ERR(ptr: rf_base))
277 return PTR_ERR(ptr: rf_base);
278
279 /*
280 * Get the frequency of system counter from the cp15 interface of ARM
281 * Generic timer. We don't need to check it, because if it returns "0",
282 * system would panic in very early stage.
283 */
284 gwdt->clk = arch_timer_get_cntfrq();
285 gwdt->refresh_base = rf_base;
286 gwdt->control_base = cf_base;
287
288 wdd = &gwdt->wdd;
289 wdd->parent = dev;
290 wdd->info = &sbsa_gwdt_info;
291 wdd->ops = &sbsa_gwdt_ops;
292 wdd->min_timeout = 1;
293 wdd->timeout = DEFAULT_TIMEOUT;
294 watchdog_set_drvdata(wdd, data: gwdt);
295 watchdog_set_nowayout(wdd, nowayout);
296 sbsa_gwdt_get_version(wdd);
297 if (gwdt->version == 0)
298 wdd->max_hw_heartbeat_ms = U32_MAX / gwdt->clk * 1000;
299 else
300 wdd->max_hw_heartbeat_ms = GENMASK_ULL(47, 0) / gwdt->clk * 1000;
301
302 status = readl(addr: cf_base + SBSA_GWDT_WCS);
303 if (status & SBSA_GWDT_WCS_WS1) {
304 dev_warn(dev, "System reset by WDT.\n");
305 wdd->bootstatus |= WDIOF_CARDRESET;
306 }
307 if (status & SBSA_GWDT_WCS_EN)
308 set_bit(WDOG_HW_RUNNING, addr: &wdd->status);
309
310 if (action) {
311 irq = platform_get_irq(pdev, 0);
312 if (irq < 0) {
313 action = 0;
314 dev_warn(dev, "unable to get ws0 interrupt.\n");
315 } else {
316 /*
317 * In case there is a pending ws0 interrupt, just ping
318 * the watchdog before registering the interrupt routine
319 */
320 writel(val: 0, addr: rf_base + SBSA_GWDT_WRR);
321 if (devm_request_irq(dev, irq, handler: sbsa_gwdt_interrupt, irqflags: 0,
322 devname: pdev->name, dev_id: gwdt)) {
323 action = 0;
324 dev_warn(dev, "unable to request IRQ %d.\n",
325 irq);
326 }
327 }
328 if (!action)
329 dev_warn(dev, "falling back to single stage mode.\n");
330 }
331 /*
332 * In the single stage mode, The first signal (WS0) is ignored,
333 * the timeout is (WOR * 2), so the maximum timeout should be doubled.
334 */
335 if (!action)
336 wdd->max_hw_heartbeat_ms *= 2;
337
338 watchdog_init_timeout(wdd, timeout_parm: timeout, dev);
339 /*
340 * Update timeout to WOR.
341 * Because of the explicit watchdog refresh mechanism,
342 * it's also a ping, if watchdog is enabled.
343 */
344 sbsa_gwdt_set_timeout(wdd, timeout: wdd->timeout);
345
346 watchdog_stop_on_reboot(wdd);
347 ret = devm_watchdog_register_device(dev, wdd);
348 if (ret)
349 return ret;
350
351 dev_info(dev, "Initialized with %ds timeout @ %u Hz, action=%d.%s\n",
352 wdd->timeout, gwdt->clk, action,
353 status & SBSA_GWDT_WCS_EN ? " [enabled]" : "");
354
355 return 0;
356}
357
358/* Disable watchdog if it is active during suspend */
359static int __maybe_unused sbsa_gwdt_suspend(struct device *dev)
360{
361 struct sbsa_gwdt *gwdt = dev_get_drvdata(dev);
362
363 if (watchdog_hw_running(wdd: &gwdt->wdd))
364 sbsa_gwdt_stop(wdd: &gwdt->wdd);
365
366 return 0;
367}
368
369/* Enable watchdog if necessary */
370static int __maybe_unused sbsa_gwdt_resume(struct device *dev)
371{
372 struct sbsa_gwdt *gwdt = dev_get_drvdata(dev);
373
374 if (watchdog_hw_running(wdd: &gwdt->wdd))
375 sbsa_gwdt_start(wdd: &gwdt->wdd);
376
377 return 0;
378}
379
380static const struct dev_pm_ops sbsa_gwdt_pm_ops = {
381 SET_SYSTEM_SLEEP_PM_OPS(sbsa_gwdt_suspend, sbsa_gwdt_resume)
382};
383
384static const struct of_device_id sbsa_gwdt_of_match[] = {
385 { .compatible = "arm,sbsa-gwdt", },
386 {},
387};
388MODULE_DEVICE_TABLE(of, sbsa_gwdt_of_match);
389
390static const struct platform_device_id sbsa_gwdt_pdev_match[] = {
391 { .name = DRV_NAME, },
392 {},
393};
394MODULE_DEVICE_TABLE(platform, sbsa_gwdt_pdev_match);
395
396static struct platform_driver sbsa_gwdt_driver = {
397 .driver = {
398 .name = DRV_NAME,
399 .pm = &sbsa_gwdt_pm_ops,
400 .of_match_table = sbsa_gwdt_of_match,
401 },
402 .probe = sbsa_gwdt_probe,
403 .id_table = sbsa_gwdt_pdev_match,
404};
405
406module_platform_driver(sbsa_gwdt_driver);
407
408MODULE_DESCRIPTION("SBSA Generic Watchdog Driver");
409MODULE_AUTHOR("Fu Wei <fu.wei@linaro.org>");
410MODULE_AUTHOR("Suravee Suthikulpanit <Suravee.Suthikulpanit@amd.com>");
411MODULE_AUTHOR("Al Stone <al.stone@linaro.org>");
412MODULE_AUTHOR("Timur Tabi <timur@codeaurora.org>");
413MODULE_LICENSE("GPL v2");
414

source code of linux/drivers/watchdog/sbsa_gwdt.c