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@redhat.com>
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 <asm/blackfin.h>
28 #include <asm/uaccess.h>
30 #define stamp(fmt, args...) pr_debug("%s:%i: " fmt "\n", __func__, __LINE__, ## args)
31 #define stampit() stamp("here i am")
33 #define WATCHDOG_NAME "bfin-wdt"
34 #define PFX WATCHDOG_NAME ": "
36 /* The BF561 has two watchdogs (one per core), but since Linux
37 * only runs on core A, we'll just work with that one.
40 # define bfin_read_WDOG_CTL() bfin_read_WDOGA_CTL()
41 # define bfin_read_WDOG_CNT() bfin_read_WDOGA_CNT()
42 # define bfin_read_WDOG_STAT() bfin_read_WDOGA_STAT()
43 # define bfin_write_WDOG_CTL(x) bfin_write_WDOGA_CTL(x)
44 # define bfin_write_WDOG_CNT(x) bfin_write_WDOGA_CNT(x)
45 # define bfin_write_WDOG_STAT(x) bfin_write_WDOGA_STAT(x)
48 /* Bit in SWRST that indicates boot caused by watchdog */
49 #define SWRST_RESET_WDOG 0x4000
51 /* Bit in WDOG_CTL that indicates watchdog has expired (WDR0) */
52 #define WDOG_EXPIRED 0x8000
54 /* Masks for WDEV field in WDOG_CTL register */
55 #define ICTL_RESET 0x0
61 /* Masks for WDEN field in WDOG_CTL register */
62 #define WDEN_MASK 0x0FF0
63 #define WDEN_ENABLE 0x0000
64 #define WDEN_DISABLE 0x0AD0
67 #define WATCHDOG_TIMEOUT 20
69 static unsigned int timeout
= WATCHDOG_TIMEOUT
;
70 static int nowayout
= WATCHDOG_NOWAYOUT
;
71 static struct watchdog_info bfin_wdt_info
;
72 static unsigned long open_check
;
73 static char expect_close
;
74 static DEFINE_SPINLOCK(bfin_wdt_spinlock
);
77 * bfin_wdt_keepalive - Keep the Userspace Watchdog Alive
79 * The Userspace watchdog got a KeepAlive: schedule the next timeout.
81 static int bfin_wdt_keepalive(void)
84 bfin_write_WDOG_STAT(0);
89 * bfin_wdt_stop - Stop the Watchdog
91 * Stops the on-chip watchdog.
93 static int bfin_wdt_stop(void)
96 bfin_write_WDOG_CTL(WDEN_DISABLE
);
101 * bfin_wdt_start - Start the Watchdog
103 * Starts the on-chip watchdog. Automatically loads WDOG_CNT
104 * into WDOG_STAT for us.
106 static int bfin_wdt_start(void)
109 bfin_write_WDOG_CTL(WDEN_ENABLE
| ICTL_RESET
);
114 * bfin_wdt_running - Check Watchdog status
116 * See if the watchdog is running.
118 static int bfin_wdt_running(void)
121 return ((bfin_read_WDOG_CTL() & WDEN_MASK
) != WDEN_DISABLE
);
125 * bfin_wdt_set_timeout - Set the Userspace Watchdog timeout
126 * @t: new timeout value (in seconds)
128 * Translate the specified timeout in seconds into System Clock
129 * terms which is what the on-chip Watchdog requires.
131 static int bfin_wdt_set_timeout(unsigned long t
)
138 cnt
= t
* get_sclk();
139 if (cnt
< get_sclk()) {
140 printk(KERN_WARNING PFX
"timeout value is too large\n");
144 spin_lock_irqsave(&bfin_wdt_spinlock
, flags
);
146 int run
= bfin_wdt_running();
148 bfin_write_WDOG_CNT(cnt
);
149 if (run
) bfin_wdt_start();
151 spin_unlock_irqrestore(&bfin_wdt_spinlock
, flags
);
159 * bfin_wdt_open - Open the Device
160 * @inode: inode of device
161 * @file: file handle of device
163 * Watchdog device is opened and started.
165 static int bfin_wdt_open(struct inode
*inode
, struct file
*file
)
169 if (test_and_set_bit(0, &open_check
))
173 __module_get(THIS_MODULE
);
175 bfin_wdt_keepalive();
178 return nonseekable_open(inode
, file
);
182 * bfin_wdt_close - Close the Device
183 * @inode: inode of device
184 * @file: file handle of device
186 * Watchdog device is closed and stopped.
188 static int bfin_wdt_release(struct inode
*inode
, struct file
*file
)
192 if (expect_close
== 42) {
195 printk(KERN_CRIT PFX
"Unexpected close, not stopping watchdog!\n");
196 bfin_wdt_keepalive();
200 clear_bit(0, &open_check
);
206 * bfin_wdt_write - Write to Device
207 * @file: file handle of device
208 * @buf: buffer to write
209 * @count: length of buffer
212 * Pings the watchdog on write.
214 static ssize_t
bfin_wdt_write(struct file
*file
, const char __user
*data
,
215 size_t len
, loff_t
*ppos
)
223 /* In case it was set long ago */
226 for (i
= 0; i
!= len
; i
++) {
228 if (get_user(c
, data
+ i
))
234 bfin_wdt_keepalive();
241 * bfin_wdt_ioctl - Query Device
242 * @inode: inode of device
243 * @file: file handle of device
244 * @cmd: watchdog command
247 * Query basic information from the device or ping it, as outlined by the
250 static int bfin_wdt_ioctl(struct inode
*inode
, struct file
*file
,
251 unsigned int cmd
, unsigned long arg
)
253 void __user
*argp
= (void __user
*)arg
;
254 int __user
*p
= argp
;
262 case WDIOC_GETSUPPORT
:
263 if (copy_to_user(argp
, &bfin_wdt_info
, sizeof(bfin_wdt_info
)))
268 case WDIOC_GETSTATUS
:
269 case WDIOC_GETBOOTSTATUS
:
270 return put_user(!!(_bfin_swrst
& SWRST_RESET_WDOG
), p
);
272 case WDIOC_KEEPALIVE
:
273 bfin_wdt_keepalive();
276 case WDIOC_SETTIMEOUT
: {
279 if (get_user(new_timeout
, p
))
282 if (bfin_wdt_set_timeout(new_timeout
))
286 case WDIOC_GETTIMEOUT
:
287 return put_user(timeout
, p
);
289 case WDIOC_SETOPTIONS
: {
291 int options
, ret
= -EINVAL
;
293 if (get_user(options
, p
))
296 spin_lock_irqsave(&bfin_wdt_spinlock
, flags
);
298 if (options
& WDIOS_DISABLECARD
) {
303 if (options
& WDIOS_ENABLECARD
) {
308 spin_unlock_irqrestore(&bfin_wdt_spinlock
, flags
);
316 * bfin_wdt_notify_sys - Notifier Handler
317 * @this: notifier block
318 * @code: notifier event
321 * Handles specific events, such as turning off the watchdog during a
324 static int bfin_wdt_notify_sys(struct notifier_block
*this, unsigned long code
,
329 if (code
== SYS_DOWN
|| code
== SYS_HALT
)
336 static int state_before_suspend
;
339 * bfin_wdt_suspend - suspend the watchdog
340 * @pdev: device being suspended
341 * @state: requested suspend state
343 * Remember if the watchdog was running and stop it.
344 * TODO: is this even right? Doesn't seem to be any
345 * standard in the watchdog world ...
347 static int bfin_wdt_suspend(struct platform_device
*pdev
, pm_message_t state
)
351 state_before_suspend
= bfin_wdt_running();
358 * bfin_wdt_resume - resume the watchdog
359 * @pdev: device being resumed
361 * If the watchdog was running, turn it back on.
363 static int bfin_wdt_resume(struct platform_device
*pdev
)
367 if (state_before_suspend
) {
368 bfin_wdt_set_timeout(timeout
);
375 # define bfin_wdt_suspend NULL
376 # define bfin_wdt_resume NULL
379 static struct platform_device bfin_wdt_device
= {
380 .name
= WATCHDOG_NAME
,
384 static struct platform_driver bfin_wdt_driver
= {
386 .name
= WATCHDOG_NAME
,
387 .owner
= THIS_MODULE
,
389 .suspend
= bfin_wdt_suspend
,
390 .resume
= bfin_wdt_resume
,
393 static struct file_operations bfin_wdt_fops
= {
394 .owner
= THIS_MODULE
,
396 .write
= bfin_wdt_write
,
397 .ioctl
= bfin_wdt_ioctl
,
398 .open
= bfin_wdt_open
,
399 .release
= bfin_wdt_release
,
402 static struct miscdevice bfin_wdt_miscdev
= {
403 .minor
= WATCHDOG_MINOR
,
405 .fops
= &bfin_wdt_fops
,
408 static struct watchdog_info bfin_wdt_info
= {
409 .identity
= "Blackfin Watchdog",
410 .options
= WDIOF_SETTIMEOUT
|
411 WDIOF_KEEPALIVEPING
|
415 static struct notifier_block bfin_wdt_notifier
= {
416 .notifier_call
= bfin_wdt_notify_sys
,
420 * bfin_wdt_init - Initialize module
422 * Registers the device and notifier handler. Actual device
423 * initialization is handled by bfin_wdt_open().
425 static int __init
bfin_wdt_init(void)
431 /* Check that the timeout value is within range */
432 if (bfin_wdt_set_timeout(timeout
))
435 /* Since this is an on-chip device and needs no board-specific
436 * resources, we'll handle all the platform device stuff here.
438 ret
= platform_device_register(&bfin_wdt_device
);
442 ret
= platform_driver_probe(&bfin_wdt_driver
, NULL
);
446 ret
= register_reboot_notifier(&bfin_wdt_notifier
);
448 printk(KERN_ERR PFX
"cannot register reboot notifier (err=%d)\n", ret
);
452 ret
= misc_register(&bfin_wdt_miscdev
);
454 printk(KERN_ERR PFX
"cannot register miscdev on minor=%d (err=%d)\n",
455 WATCHDOG_MINOR
, ret
);
456 unregister_reboot_notifier(&bfin_wdt_notifier
);
460 printk(KERN_INFO PFX
"initialized: timeout=%d sec (nowayout=%d)\n",
467 * bfin_wdt_exit - Deinitialize module
469 * Unregisters the device and notifier handler. Actual device
470 * deinitialization is handled by bfin_wdt_close().
472 static void __exit
bfin_wdt_exit(void)
474 misc_deregister(&bfin_wdt_miscdev
);
475 unregister_reboot_notifier(&bfin_wdt_notifier
);
478 module_init(bfin_wdt_init
);
479 module_exit(bfin_wdt_exit
);
481 MODULE_AUTHOR("Michele d'Amico, Mike Frysinger <vapier@gentoo.org>");
482 MODULE_DESCRIPTION("Blackfin Watchdog Device Driver");
483 MODULE_LICENSE("GPL");
484 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR
);
486 module_param(timeout
, uint
, 0);
487 MODULE_PARM_DESC(timeout
, "Watchdog timeout in seconds. (1<=timeout<=((2^32)/SCLK), default=" __MODULE_STRING(WATCHDOG_TIMEOUT
) ")");
489 module_param(nowayout
, int, 0);
490 MODULE_PARM_DESC(nowayout
, "Watchdog cannot be stopped once started (default=" __MODULE_STRING(WATCHDOG_NOWAYOUT
) ")");