2 * Blackfin On-Chip Watchdog Driver
3 * Supports BF53[123]/BF53[467]/BF54[2489]/BF561
5 * Originally based on softdog.c
6 * Copyright 2006-2007 Analog Devices Inc.
7 * Copyright 2006-2007 Michele d'Amico
8 * Copyright 1996 Alan Cox <alan@lxorguk.ukuu.org.uk>
10 * Enter bugs at http://blackfin.uclinux.org/
12 * Licensed under the GPL-2 or later.
15 #include <linux/platform_device.h>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/types.h>
19 #include <linux/timer.h>
20 #include <linux/miscdevice.h>
21 #include <linux/watchdog.h>
23 #include <linux/notifier.h>
24 #include <linux/reboot.h>
25 #include <linux/init.h>
26 #include <linux/interrupt.h>
27 #include <linux/uaccess.h>
28 #include <asm/blackfin.h>
30 #define stamp(fmt, args...) \
31 pr_debug("%s:%i: " fmt "\n", __func__, __LINE__, ## args)
32 #define stampit() stamp("here i am")
33 #define pr_devinit(fmt, args...) \
34 ({ static const __devinitconst char __fmt[] = fmt; \
35 printk(__fmt, ## args); })
36 #define pr_init(fmt, args...) \
37 ({ static const __initconst char __fmt[] = fmt; \
38 printk(__fmt, ## args); })
40 #define WATCHDOG_NAME "bfin-wdt"
41 #define PFX WATCHDOG_NAME ": "
43 /* The BF561 has two watchdogs (one per core), but since Linux
44 * only runs on core A, we'll just work with that one.
47 # define bfin_read_WDOG_CTL() bfin_read_WDOGA_CTL()
48 # define bfin_read_WDOG_CNT() bfin_read_WDOGA_CNT()
49 # define bfin_read_WDOG_STAT() bfin_read_WDOGA_STAT()
50 # define bfin_write_WDOG_CTL(x) bfin_write_WDOGA_CTL(x)
51 # define bfin_write_WDOG_CNT(x) bfin_write_WDOGA_CNT(x)
52 # define bfin_write_WDOG_STAT(x) bfin_write_WDOGA_STAT(x)
55 /* Bit in SWRST that indicates boot caused by watchdog */
56 #define SWRST_RESET_WDOG 0x4000
58 /* Bit in WDOG_CTL that indicates watchdog has expired (WDR0) */
59 #define WDOG_EXPIRED 0x8000
61 /* Masks for WDEV field in WDOG_CTL register */
62 #define ICTL_RESET 0x0
68 /* Masks for WDEN field in WDOG_CTL register */
69 #define WDEN_MASK 0x0FF0
70 #define WDEN_ENABLE 0x0000
71 #define WDEN_DISABLE 0x0AD0
74 #define WATCHDOG_TIMEOUT 20
76 static unsigned int timeout = WATCHDOG_TIMEOUT;
77 static int nowayout = WATCHDOG_NOWAYOUT;
78 static struct watchdog_info bfin_wdt_info;
79 static unsigned long open_check;
80 static char expect_close;
81 static DEFINE_SPINLOCK(bfin_wdt_spinlock);
84 * bfin_wdt_keepalive - Keep the Userspace Watchdog Alive
86 * The Userspace watchdog got a KeepAlive: schedule the next timeout.
88 static int bfin_wdt_keepalive(void)
91 bfin_write_WDOG_STAT(0);
96 * bfin_wdt_stop - Stop the Watchdog
98 * Stops the on-chip watchdog.
100 static int bfin_wdt_stop(void)
103 bfin_write_WDOG_CTL(WDEN_DISABLE);
108 * bfin_wdt_start - Start the Watchdog
110 * Starts the on-chip watchdog. Automatically loads WDOG_CNT
111 * into WDOG_STAT for us.
113 static int bfin_wdt_start(void)
116 bfin_write_WDOG_CTL(WDEN_ENABLE | ICTL_RESET);
121 * bfin_wdt_running - Check Watchdog status
123 * See if the watchdog is running.
125 static int bfin_wdt_running(void)
128 return ((bfin_read_WDOG_CTL() & WDEN_MASK) != WDEN_DISABLE);
132 * bfin_wdt_set_timeout - Set the Userspace Watchdog timeout
133 * @t: new timeout value (in seconds)
135 * Translate the specified timeout in seconds into System Clock
136 * terms which is what the on-chip Watchdog requires.
138 static int bfin_wdt_set_timeout(unsigned long t)
145 cnt = t * get_sclk();
146 if (cnt < get_sclk()) {
147 printk(KERN_WARNING PFX "timeout value is too large\n");
151 spin_lock_irqsave(&bfin_wdt_spinlock, flags);
153 int run = bfin_wdt_running();
155 bfin_write_WDOG_CNT(cnt);
159 spin_unlock_irqrestore(&bfin_wdt_spinlock, flags);
167 * bfin_wdt_open - Open the Device
168 * @inode: inode of device
169 * @file: file handle of device
171 * Watchdog device is opened and started.
173 static int bfin_wdt_open(struct inode *inode, struct file *file)
177 if (test_and_set_bit(0, &open_check))
181 __module_get(THIS_MODULE);
183 bfin_wdt_keepalive();
186 return nonseekable_open(inode, file);
190 * bfin_wdt_close - Close the Device
191 * @inode: inode of device
192 * @file: file handle of device
194 * Watchdog device is closed and stopped.
196 static int bfin_wdt_release(struct inode *inode, struct file *file)
200 if (expect_close == 42)
204 "Unexpected close, not stopping watchdog!\n");
205 bfin_wdt_keepalive();
208 clear_bit(0, &open_check);
213 * bfin_wdt_write - Write to Device
214 * @file: file handle of device
215 * @buf: buffer to write
216 * @count: length of buffer
219 * Pings the watchdog on write.
221 static ssize_t bfin_wdt_write(struct file *file, const char __user *data,
222 size_t len, loff_t *ppos)
230 /* In case it was set long ago */
233 for (i = 0; i != len; i++) {
235 if (get_user(c, data + i))
241 bfin_wdt_keepalive();
248 * bfin_wdt_ioctl - Query Device
249 * @file: file handle of device
250 * @cmd: watchdog command
253 * Query basic information from the device or ping it, as outlined by the
256 static long bfin_wdt_ioctl(struct file *file,
257 unsigned int cmd, unsigned long arg)
259 void __user *argp = (void __user *)arg;
260 int __user *p = argp;
265 case WDIOC_GETSUPPORT:
266 if (copy_to_user(argp, &bfin_wdt_info, sizeof(bfin_wdt_info)))
270 case WDIOC_GETSTATUS:
271 case WDIOC_GETBOOTSTATUS:
272 return put_user(!!(_bfin_swrst & SWRST_RESET_WDOG), p);
273 case WDIOC_SETOPTIONS: {
275 int options, ret = -EINVAL;
277 if (get_user(options, p))
280 spin_lock_irqsave(&bfin_wdt_spinlock, flags);
281 if (options & WDIOS_DISABLECARD) {
285 if (options & WDIOS_ENABLECARD) {
289 spin_unlock_irqrestore(&bfin_wdt_spinlock, flags);
292 case WDIOC_KEEPALIVE:
293 bfin_wdt_keepalive();
295 case WDIOC_SETTIMEOUT: {
298 if (get_user(new_timeout, p))
300 if (bfin_wdt_set_timeout(new_timeout))
304 case WDIOC_GETTIMEOUT:
305 return put_user(timeout, p);
312 * bfin_wdt_notify_sys - Notifier Handler
313 * @this: notifier block
314 * @code: notifier event
317 * Handles specific events, such as turning off the watchdog during a
320 static int bfin_wdt_notify_sys(struct notifier_block *this,
321 unsigned long code, void *unused)
325 if (code == SYS_DOWN || code == SYS_HALT)
332 static int state_before_suspend;
335 * bfin_wdt_suspend - suspend the watchdog
336 * @pdev: device being suspended
337 * @state: requested suspend state
339 * Remember if the watchdog was running and stop it.
340 * TODO: is this even right? Doesn't seem to be any
341 * standard in the watchdog world ...
343 static int bfin_wdt_suspend(struct platform_device *pdev, pm_message_t state)
347 state_before_suspend = bfin_wdt_running();
354 * bfin_wdt_resume - resume the watchdog
355 * @pdev: device being resumed
357 * If the watchdog was running, turn it back on.
359 static int bfin_wdt_resume(struct platform_device *pdev)
363 if (state_before_suspend) {
364 bfin_wdt_set_timeout(timeout);
371 # define bfin_wdt_suspend NULL
372 # define bfin_wdt_resume NULL
375 static const struct file_operations bfin_wdt_fops = {
376 .owner = THIS_MODULE,
378 .write = bfin_wdt_write,
379 .unlocked_ioctl = bfin_wdt_ioctl,
380 .open = bfin_wdt_open,
381 .release = bfin_wdt_release,
384 static struct miscdevice bfin_wdt_miscdev = {
385 .minor = WATCHDOG_MINOR,
387 .fops = &bfin_wdt_fops,
390 static struct watchdog_info bfin_wdt_info = {
391 .identity = "Blackfin Watchdog",
392 .options = WDIOF_SETTIMEOUT |
393 WDIOF_KEEPALIVEPING |
397 static struct notifier_block bfin_wdt_notifier = {
398 .notifier_call = bfin_wdt_notify_sys,
402 * bfin_wdt_probe - Initialize module
404 * Registers the misc device and notifier handler. Actual device
405 * initialization is handled by bfin_wdt_open().
407 static int __devinit bfin_wdt_probe(struct platform_device *pdev)
411 ret = register_reboot_notifier(&bfin_wdt_notifier);
413 pr_devinit(KERN_ERR PFX
414 "cannot register reboot notifier (err=%d)\n", ret);
418 ret = misc_register(&bfin_wdt_miscdev);
420 pr_devinit(KERN_ERR PFX
421 "cannot register miscdev on minor=%d (err=%d)\n",
422 WATCHDOG_MINOR, ret);
423 unregister_reboot_notifier(&bfin_wdt_notifier);
427 pr_devinit(KERN_INFO PFX "initialized: timeout=%d sec (nowayout=%d)\n",
434 * bfin_wdt_remove - Initialize module
436 * Unregisters the misc device and notifier handler. Actual device
437 * deinitialization is handled by bfin_wdt_close().
439 static int __devexit bfin_wdt_remove(struct platform_device *pdev)
441 misc_deregister(&bfin_wdt_miscdev);
442 unregister_reboot_notifier(&bfin_wdt_notifier);
446 static struct platform_device *bfin_wdt_device;
448 static struct platform_driver bfin_wdt_driver = {
449 .probe = bfin_wdt_probe,
450 .remove = __devexit_p(bfin_wdt_remove),
451 .suspend = bfin_wdt_suspend,
452 .resume = bfin_wdt_resume,
454 .name = WATCHDOG_NAME,
455 .owner = THIS_MODULE,
460 * bfin_wdt_init - Initialize module
462 * Checks the module params and registers the platform device & driver.
463 * Real work is in the platform probe function.
465 static int __init bfin_wdt_init(void)
471 /* Check that the timeout value is within range */
472 if (bfin_wdt_set_timeout(timeout))
475 /* Since this is an on-chip device and needs no board-specific
476 * resources, we'll handle all the platform device stuff here.
478 ret = platform_driver_register(&bfin_wdt_driver);
480 pr_init(KERN_ERR PFX "unable to register driver\n");
484 bfin_wdt_device = platform_device_register_simple(WATCHDOG_NAME,
486 if (IS_ERR(bfin_wdt_device)) {
487 pr_init(KERN_ERR PFX "unable to register device\n");
488 platform_driver_unregister(&bfin_wdt_driver);
489 return PTR_ERR(bfin_wdt_device);
496 * bfin_wdt_exit - Deinitialize module
498 * Back out the platform device & driver steps. Real work is in the
499 * platform remove function.
501 static void __exit bfin_wdt_exit(void)
503 platform_device_unregister(bfin_wdt_device);
504 platform_driver_unregister(&bfin_wdt_driver);
507 module_init(bfin_wdt_init);
508 module_exit(bfin_wdt_exit);
510 MODULE_AUTHOR("Michele d'Amico, Mike Frysinger <vapier@gentoo.org>");
511 MODULE_DESCRIPTION("Blackfin Watchdog Device Driver");
512 MODULE_LICENSE("GPL");
513 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
515 module_param(timeout, uint, 0);
516 MODULE_PARM_DESC(timeout,
517 "Watchdog timeout in seconds. (1<=timeout<=((2^32)/SCLK), default="
518 __MODULE_STRING(WATCHDOG_TIMEOUT) ")");
520 module_param(nowayout, int, 0);
521 MODULE_PARM_DESC(nowayout,
522 "Watchdog cannot be stopped once started (default="
523 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");