Merge tag 'riscv-for-linus-5.9-mw1' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-block.git] / drivers / watchdog / sp805_wdt.c
CommitLineData
4a370278
VK
1/*
2 * drivers/char/watchdog/sp805-wdt.c
3 *
4 * Watchdog driver for ARM SP805 watchdog module
5 *
6 * Copyright (C) 2010 ST Microelectronics
da89947b 7 * Viresh Kumar <vireshk@kernel.org>
4a370278
VK
8 *
9 * This file is licensed under the terms of the GNU General Public
10 * License version 2 or later. This program is licensed "as is" without any
11 * warranty of any kind, whether express or implied.
12 */
13
dc0e4a3b 14#include <linux/acpi.h>
4a370278
VK
15#include <linux/device.h>
16#include <linux/resource.h>
17#include <linux/amba/bus.h>
18#include <linux/bitops.h>
19#include <linux/clk.h>
4a370278
VK
20#include <linux/io.h>
21#include <linux/ioport.h>
22#include <linux/kernel.h>
23#include <linux/math64.h>
4a370278
VK
24#include <linux/module.h>
25#include <linux/moduleparam.h>
dc0e4a3b 26#include <linux/of.h>
16ac4abe 27#include <linux/pm.h>
4a370278
VK
28#include <linux/slab.h>
29#include <linux/spinlock.h>
30#include <linux/types.h>
4a370278
VK
31#include <linux/watchdog.h>
32
33/* default timeout in seconds */
34#define DEFAULT_TIMEOUT 60
35
36#define MODULE_NAME "sp805-wdt"
37
38/* watchdog register offsets and masks */
39#define WDTLOAD 0x000
40 #define LOAD_MIN 0x00000001
41 #define LOAD_MAX 0xFFFFFFFF
42#define WDTVALUE 0x004
43#define WDTCONTROL 0x008
44 /* control register masks */
45 #define INT_ENABLE (1 << 0)
46 #define RESET_ENABLE (1 << 1)
fa5072ed 47 #define ENABLE_MASK (INT_ENABLE | RESET_ENABLE)
4a370278
VK
48#define WDTINTCLR 0x00C
49#define WDTRIS 0x010
50#define WDTMIS 0x014
51 #define INT_MASK (1 << 0)
52#define WDTLOCK 0xC00
53 #define UNLOCK 0x1ACCE551
54 #define LOCK 0x00000001
55
56/**
57 * struct sp805_wdt: sp805 wdt device structure
4a516539 58 * @wdd: instance of struct watchdog_device
bfae14b6
VK
59 * @lock: spin lock protecting dev structure and io access
60 * @base: base address of wdt
61 * @clk: clock structure of wdt
62 * @adev: amba device structure of wdt
63 * @status: current status of wdt
64 * @load_val: load value to be set for current timeout
4a370278
VK
65 */
66struct sp805_wdt {
4a516539 67 struct watchdog_device wdd;
4a370278
VK
68 spinlock_t lock;
69 void __iomem *base;
70 struct clk *clk;
dc0e4a3b 71 u64 rate;
4a370278 72 struct amba_device *adev;
4a370278 73 unsigned int load_val;
4a370278
VK
74};
75
86a1e189 76static bool nowayout = WATCHDOG_NOWAYOUT;
4a516539
VK
77module_param(nowayout, bool, 0);
78MODULE_PARM_DESC(nowayout,
79 "Set to 1 to keep watchdog running after device release");
4a370278 80
fa5072ed
RJ
81/* returns true if wdt is running; otherwise returns false */
82static bool wdt_is_running(struct watchdog_device *wdd)
83{
84 struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
85 u32 wdtcontrol = readl_relaxed(wdt->base + WDTCONTROL);
86
87 return (wdtcontrol & ENABLE_MASK) == ENABLE_MASK;
88}
89
4a370278 90/* This routine finds load value that will reset system in required timout */
4a516539 91static int wdt_setload(struct watchdog_device *wdd, unsigned int timeout)
4a370278 92{
4a516539 93 struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
4a370278
VK
94 u64 load, rate;
95
dc0e4a3b 96 rate = wdt->rate;
4a370278
VK
97
98 /*
99 * sp805 runs counter with given value twice, after the end of first
100 * counter it gives an interrupt and then starts counter again. If
25985edc 101 * interrupt already occurred then it resets the system. This is why
4a370278
VK
102 * load is half of what should be required.
103 */
104 load = div_u64(rate, 2) * timeout - 1;
105
106 load = (load > LOAD_MAX) ? LOAD_MAX : load;
107 load = (load < LOAD_MIN) ? LOAD_MIN : load;
108
109 spin_lock(&wdt->lock);
110 wdt->load_val = load;
111 /* roundup timeout to closest positive integer value */
938626d9 112 wdd->timeout = div_u64((load + 1) * 2 + (rate / 2), rate);
4a370278 113 spin_unlock(&wdt->lock);
4a516539
VK
114
115 return 0;
4a370278
VK
116}
117
118/* returns number of seconds left for reset to occur */
4a516539 119static unsigned int wdt_timeleft(struct watchdog_device *wdd)
4a370278 120{
4a516539 121 struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
dc0e4a3b 122 u64 load;
4a370278
VK
123
124 spin_lock(&wdt->lock);
d2e8919b 125 load = readl_relaxed(wdt->base + WDTVALUE);
4a370278
VK
126
127 /*If the interrupt is inactive then time left is WDTValue + WDTLoad. */
d2e8919b 128 if (!(readl_relaxed(wdt->base + WDTRIS) & INT_MASK))
4a370278
VK
129 load += wdt->load_val + 1;
130 spin_unlock(&wdt->lock);
131
dc0e4a3b 132 return div_u64(load, wdt->rate);
4a370278
VK
133}
134
6c5c0d48
JK
135static int
136wdt_restart(struct watchdog_device *wdd, unsigned long mode, void *cmd)
137{
138 struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
139
ea104a9e 140 writel_relaxed(UNLOCK, wdt->base + WDTLOCK);
6c5c0d48
JK
141 writel_relaxed(0, wdt->base + WDTCONTROL);
142 writel_relaxed(0, wdt->base + WDTLOAD);
143 writel_relaxed(INT_ENABLE | RESET_ENABLE, wdt->base + WDTCONTROL);
144
ea104a9e
MW
145 /* Flush posted writes. */
146 readl_relaxed(wdt->base + WDTLOCK);
147
6c5c0d48
JK
148 return 0;
149}
150
4a516539 151static int wdt_config(struct watchdog_device *wdd, bool ping)
4a370278 152{
4a516539
VK
153 struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
154 int ret;
155
156 if (!ping) {
d9df0ef1 157
63fbbc16 158 ret = clk_prepare_enable(wdt->clk);
4a516539
VK
159 if (ret) {
160 dev_err(&wdt->adev->dev, "clock enable fail");
161 return ret;
162 }
163 }
164
4a370278
VK
165 spin_lock(&wdt->lock);
166
d2e8919b
VK
167 writel_relaxed(UNLOCK, wdt->base + WDTLOCK);
168 writel_relaxed(wdt->load_val, wdt->base + WDTLOAD);
55e07177 169 writel_relaxed(INT_MASK, wdt->base + WDTINTCLR);
4a370278 170
55e07177 171 if (!ping)
4a516539
VK
172 writel_relaxed(INT_ENABLE | RESET_ENABLE, wdt->base +
173 WDTCONTROL);
4a370278 174
d2e8919b 175 writel_relaxed(LOCK, wdt->base + WDTLOCK);
4a370278 176
081d83a3 177 /* Flush posted writes. */
d2e8919b 178 readl_relaxed(wdt->base + WDTLOCK);
4a370278 179 spin_unlock(&wdt->lock);
4a516539
VK
180
181 return 0;
4a370278
VK
182}
183
4a516539 184static int wdt_ping(struct watchdog_device *wdd)
4a370278 185{
4a516539 186 return wdt_config(wdd, true);
4a370278
VK
187}
188
4a516539
VK
189/* enables watchdog timers reset */
190static int wdt_enable(struct watchdog_device *wdd)
4a370278 191{
4a516539 192 return wdt_config(wdd, false);
4a370278
VK
193}
194
4a516539
VK
195/* disables watchdog timers reset */
196static int wdt_disable(struct watchdog_device *wdd)
4a370278 197{
4a516539 198 struct sp805_wdt *wdt = watchdog_get_drvdata(wdd);
4a370278 199
4a516539 200 spin_lock(&wdt->lock);
4a370278 201
4a516539
VK
202 writel_relaxed(UNLOCK, wdt->base + WDTLOCK);
203 writel_relaxed(0, wdt->base + WDTCONTROL);
204 writel_relaxed(LOCK, wdt->base + WDTLOCK);
4a370278 205
4a516539
VK
206 /* Flush posted writes. */
207 readl_relaxed(wdt->base + WDTLOCK);
208 spin_unlock(&wdt->lock);
4a370278 209
63fbbc16 210 clk_disable_unprepare(wdt->clk);
4a370278
VK
211
212 return 0;
213}
214
4a516539
VK
215static const struct watchdog_info wdt_info = {
216 .options = WDIOF_MAGICCLOSE | WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING,
217 .identity = MODULE_NAME,
4a370278
VK
218};
219
4a516539
VK
220static const struct watchdog_ops wdt_ops = {
221 .owner = THIS_MODULE,
222 .start = wdt_enable,
223 .stop = wdt_disable,
224 .ping = wdt_ping,
225 .set_timeout = wdt_setload,
226 .get_timeleft = wdt_timeleft,
6c5c0d48 227 .restart = wdt_restart,
4a370278
VK
228};
229
2d991a16 230static int
aa25afad 231sp805_wdt_probe(struct amba_device *adev, const struct amba_id *id)
4a370278 232{
4a516539 233 struct sp805_wdt *wdt;
4a370278
VK
234 int ret = 0;
235
fb35a5ad 236 wdt = devm_kzalloc(&adev->dev, sizeof(*wdt), GFP_KERNEL);
4a370278 237 if (!wdt) {
4a370278 238 ret = -ENOMEM;
fb35a5ad
VK
239 goto err;
240 }
241
9d11e4f8
JH
242 wdt->base = devm_ioremap_resource(&adev->dev, &adev->res);
243 if (IS_ERR(wdt->base))
244 return PTR_ERR(wdt->base);
4a370278 245
dc0e4a3b
SM
246 if (adev->dev.of_node) {
247 wdt->clk = devm_clk_get(&adev->dev, NULL);
248 if (IS_ERR(wdt->clk)) {
249 dev_err(&adev->dev, "Clock not found\n");
250 return PTR_ERR(wdt->clk);
251 }
252 wdt->rate = clk_get_rate(wdt->clk);
253 } else if (has_acpi_companion(&adev->dev)) {
254 /*
255 * When Driver probe with ACPI device, clock devices
256 * are not available, so watchdog rate get from
257 * clock-frequency property given in _DSD object.
258 */
259 device_property_read_u64(&adev->dev, "clock-frequency",
260 &wdt->rate);
261 if (!wdt->rate) {
262 dev_err(&adev->dev, "no clock-frequency property\n");
263 return -ENODEV;
264 }
4a370278
VK
265 }
266
267 wdt->adev = adev;
4a516539
VK
268 wdt->wdd.info = &wdt_info;
269 wdt->wdd.ops = &wdt_ops;
6551881c 270 wdt->wdd.parent = &adev->dev;
4a516539 271
4a370278 272 spin_lock_init(&wdt->lock);
4a516539
VK
273 watchdog_set_nowayout(&wdt->wdd, nowayout);
274 watchdog_set_drvdata(&wdt->wdd, wdt);
6c5c0d48 275 watchdog_set_restart_priority(&wdt->wdd, 128);
b8008858
RJ
276
277 /*
278 * If 'timeout-sec' devicetree property is specified, use that.
279 * Otherwise, use DEFAULT_TIMEOUT
280 */
281 wdt->wdd.timeout = DEFAULT_TIMEOUT;
282 watchdog_init_timeout(&wdt->wdd, 0, &adev->dev);
283 wdt_setload(&wdt->wdd, wdt->wdd.timeout);
4a370278 284
fa5072ed
RJ
285 /*
286 * If HW is already running, enable/reset the wdt and set the running
287 * bit to tell the wdt subsystem
288 */
289 if (wdt_is_running(&wdt->wdd)) {
290 wdt_enable(&wdt->wdd);
291 set_bit(WDOG_HW_RUNNING, &wdt->wdd.status);
292 }
293
4a516539 294 ret = watchdog_register_device(&wdt->wdd);
199801cd 295 if (ret)
07bf971a 296 goto err;
4a516539 297 amba_set_drvdata(adev, wdt);
4a370278
VK
298
299 dev_info(&adev->dev, "registration successful\n");
300 return 0;
301
4a370278
VK
302err:
303 dev_err(&adev->dev, "Probe Failed!!!\n");
304 return ret;
305}
306
4b12b896 307static int sp805_wdt_remove(struct amba_device *adev)
4a370278 308{
4a516539
VK
309 struct sp805_wdt *wdt = amba_get_drvdata(adev);
310
311 watchdog_unregister_device(&wdt->wdd);
4a516539 312 watchdog_set_drvdata(&wdt->wdd, NULL);
4a370278
VK
313
314 return 0;
315}
316
60d6dd53 317static int __maybe_unused sp805_wdt_suspend(struct device *dev)
16ac4abe 318{
4a516539
VK
319 struct sp805_wdt *wdt = dev_get_drvdata(dev);
320
321 if (watchdog_active(&wdt->wdd))
322 return wdt_disable(&wdt->wdd);
16ac4abe
VK
323
324 return 0;
325}
326
60d6dd53 327static int __maybe_unused sp805_wdt_resume(struct device *dev)
16ac4abe 328{
4a516539 329 struct sp805_wdt *wdt = dev_get_drvdata(dev);
16ac4abe 330
4a516539
VK
331 if (watchdog_active(&wdt->wdd))
332 return wdt_enable(&wdt->wdd);
16ac4abe 333
4a516539 334 return 0;
16ac4abe 335}
16ac4abe
VK
336
337static SIMPLE_DEV_PM_OPS(sp805_wdt_dev_pm_ops, sp805_wdt_suspend,
338 sp805_wdt_resume);
339
05ce42ff 340static const struct amba_id sp805_wdt_ids[] = {
4a370278
VK
341 {
342 .id = 0x00141805,
343 .mask = 0x00ffffff,
344 },
345 { 0, 0 },
346};
347
17885b05
DM
348MODULE_DEVICE_TABLE(amba, sp805_wdt_ids);
349
4a370278
VK
350static struct amba_driver sp805_wdt_driver = {
351 .drv = {
352 .name = MODULE_NAME,
16ac4abe 353 .pm = &sp805_wdt_dev_pm_ops,
4a370278
VK
354 },
355 .id_table = sp805_wdt_ids,
356 .probe = sp805_wdt_probe,
82268714 357 .remove = sp805_wdt_remove,
4a370278
VK
358};
359
9e5ed094 360module_amba_driver(sp805_wdt_driver);
4a370278 361
da89947b 362MODULE_AUTHOR("Viresh Kumar <vireshk@kernel.org>");
4a370278
VK
363MODULE_DESCRIPTION("ARM SP805 Watchdog Driver");
364MODULE_LICENSE("GPL");