[PATCH] consolidate CONFIG_WATCHDOG_NOWAYOUT handling
[linux-2.6] / drivers / char / watchdog / sc520_wdt.c
1 /*
2  *      AMD Elan SC520 processor Watchdog Timer driver
3  *
4  *      Based on acquirewdt.c by Alan Cox,
5  *           and sbc60xxwdt.c by Jakob Oestergaard <jakob@unthought.net>
6  *
7  *      This program is free software; you can redistribute it and/or
8  *      modify it under the terms of the GNU General Public License
9  *      as published by the Free Software Foundation; either version
10  *      2 of the License, or (at your option) any later version.
11  *
12  *      The authors do NOT admit liability nor provide warranty for
13  *      any of this software. This material is provided "AS-IS" in
14  *      the hope that it may be useful for others.
15  *
16  *      (c) Copyright 2001    Scott Jennings <linuxdrivers@oro.net>
17  *           9/27 - 2001      [Initial release]
18  *
19  *      Additional fixes Alan Cox
20  *      -       Fixed formatting
21  *      -       Removed debug printks
22  *      -       Fixed SMP built kernel deadlock
23  *      -       Switched to private locks not lock_kernel
24  *      -       Used ioremap/writew/readw
25  *      -       Added NOWAYOUT support
26  *      4/12 - 2002 Changes by Rob Radez <rob@osinvestor.com>
27  *      -       Change comments
28  *      -       Eliminate fop_llseek
29  *      -       Change CONFIG_WATCHDOG_NOWAYOUT semantics
30  *      -       Add KERN_* tags to printks
31  *      -       fix possible wdt_is_open race
32  *      -       Report proper capabilities in watchdog_info
33  *      -       Add WDIOC_{GETSTATUS, GETBOOTSTATUS, SETTIMEOUT,
34  *              GETTIMEOUT, SETOPTIONS} ioctls
35  *      09/8 - 2003 Changes by Wim Van Sebroeck <wim@iguana.be>
36  *      -       cleanup of trailing spaces
37  *      -       added extra printk's for startup problems
38  *      -       use module_param
39  *      -       made timeout (the emulated heartbeat) a module_param
40  *      -       made the keepalive ping an internal subroutine
41  *      3/27 - 2004 Changes by Sean Young <sean@mess.org>
42  *      -       set MMCR_BASE to 0xfffef000
43  *      -       CBAR does not need to be read
44  *      -       removed debugging printks
45  *
46  *  This WDT driver is different from most other Linux WDT
47  *  drivers in that the driver will ping the watchdog by itself,
48  *  because this particular WDT has a very short timeout (1.6
49  *  seconds) and it would be insane to count on any userspace
50  *  daemon always getting scheduled within that time frame.
51  *
52  *  This driver uses memory mapped IO, and spinlock.
53  */
54
55 #include <linux/module.h>
56 #include <linux/moduleparam.h>
57 #include <linux/types.h>
58 #include <linux/timer.h>
59 #include <linux/miscdevice.h>
60 #include <linux/watchdog.h>
61 #include <linux/fs.h>
62 #include <linux/ioport.h>
63 #include <linux/notifier.h>
64 #include <linux/reboot.h>
65 #include <linux/init.h>
66
67 #include <asm/io.h>
68 #include <asm/uaccess.h>
69 #include <asm/system.h>
70
71 #define OUR_NAME "sc520_wdt"
72 #define PFX OUR_NAME ": "
73
74 /*
75  * The AMD Elan SC520 timeout value is 492us times a power of 2 (0-7)
76  *
77  *   0: 492us    2: 1.01s    4: 4.03s   6: 16.22s
78  *   1: 503ms    3: 2.01s    5: 8.05s   7: 32.21s
79  *
80  * We will program the SC520 watchdog for a timeout of 2.01s.
81  * If we reset the watchdog every ~250ms we should be safe.
82  */
83
84 #define WDT_INTERVAL (HZ/4+1)
85
86 /*
87  * We must not require too good response from the userspace daemon.
88  * Here we require the userspace daemon to send us a heartbeat
89  * char to /dev/watchdog every 30 seconds.
90  */
91
92 #define WATCHDOG_TIMEOUT 30             /* 30 sec default timeout */
93 static int timeout = WATCHDOG_TIMEOUT;  /* in seconds, will be multiplied by HZ to get seconds to wait for a ping */
94 module_param(timeout, int, 0);
95 MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds. (1<=timeout<=3600, default=" __MODULE_STRING(WATCHDOG_TIMEOUT) ")");
96
97 static int nowayout = WATCHDOG_NOWAYOUT;
98 module_param(nowayout, int, 0);
99 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
100
101 /*
102  * AMD Elan SC520 - Watchdog Timer Registers
103  */
104 #define MMCR_BASE       0xfffef000      /* The default base address */
105 #define OFFS_WDTMRCTL   0xCB0   /* Watchdog Timer Control Register */
106
107 /* WDT Control Register bit definitions */
108 #define WDT_EXP_SEL_01  0x0001  /* [01] Time-out = 496 us (with 33 Mhz clk). */
109 #define WDT_EXP_SEL_02  0x0002  /* [02] Time-out = 508 ms (with 33 Mhz clk). */
110 #define WDT_EXP_SEL_03  0x0004  /* [03] Time-out = 1.02 s (with 33 Mhz clk). */
111 #define WDT_EXP_SEL_04  0x0008  /* [04] Time-out = 2.03 s (with 33 Mhz clk). */
112 #define WDT_EXP_SEL_05  0x0010  /* [05] Time-out = 4.07 s (with 33 Mhz clk). */
113 #define WDT_EXP_SEL_06  0x0020  /* [06] Time-out = 8.13 s (with 33 Mhz clk). */
114 #define WDT_EXP_SEL_07  0x0040  /* [07] Time-out = 16.27s (with 33 Mhz clk). */
115 #define WDT_EXP_SEL_08  0x0080  /* [08] Time-out = 32.54s (with 33 Mhz clk). */
116 #define WDT_IRQ_FLG     0x1000  /* [12] Interrupt Request Flag */
117 #define WDT_WRST_ENB    0x4000  /* [14] Watchdog Timer Reset Enable */
118 #define WDT_ENB         0x8000  /* [15] Watchdog Timer Enable */
119
120 static __u16 __iomem *wdtmrctl;
121
122 static void wdt_timer_ping(unsigned long);
123 static struct timer_list timer;
124 static unsigned long next_heartbeat;
125 static unsigned long wdt_is_open;
126 static char wdt_expect_close;
127 static spinlock_t wdt_spinlock;
128
129 /*
130  *      Whack the dog
131  */
132
133 static void wdt_timer_ping(unsigned long data)
134 {
135         /* If we got a heartbeat pulse within the WDT_US_INTERVAL
136          * we agree to ping the WDT
137          */
138         if(time_before(jiffies, next_heartbeat))
139         {
140                 /* Ping the WDT */
141                 spin_lock(&wdt_spinlock);
142                 writew(0xAAAA, wdtmrctl);
143                 writew(0x5555, wdtmrctl);
144                 spin_unlock(&wdt_spinlock);
145
146                 /* Re-set the timer interval */
147                 timer.expires = jiffies + WDT_INTERVAL;
148                 add_timer(&timer);
149         } else {
150                 printk(KERN_WARNING PFX "Heartbeat lost! Will not ping the watchdog\n");
151         }
152 }
153
154 /*
155  *      Utility routines
156  */
157
158 static void wdt_config(int writeval)
159 {
160         __u16 dummy;
161         unsigned long flags;
162
163         /* buy some time (ping) */
164         spin_lock_irqsave(&wdt_spinlock, flags);
165         dummy=readw(wdtmrctl);  /* ensure write synchronization */
166         writew(0xAAAA, wdtmrctl);
167         writew(0x5555, wdtmrctl);
168         /* unlock WDT = make WDT configuration register writable one time */
169         writew(0x3333, wdtmrctl);
170         writew(0xCCCC, wdtmrctl);
171         /* write WDT configuration register */
172         writew(writeval, wdtmrctl);
173         spin_unlock_irqrestore(&wdt_spinlock, flags);
174 }
175
176 static int wdt_startup(void)
177 {
178         next_heartbeat = jiffies + (timeout * HZ);
179
180         /* Start the timer */
181         timer.expires = jiffies + WDT_INTERVAL;
182         add_timer(&timer);
183
184         /* Start the watchdog */
185         wdt_config(WDT_ENB | WDT_WRST_ENB | WDT_EXP_SEL_04);
186
187         printk(KERN_INFO PFX "Watchdog timer is now enabled.\n");
188         return 0;
189 }
190
191 static int wdt_turnoff(void)
192 {
193         /* Stop the timer */
194         del_timer(&timer);
195
196         /* Stop the watchdog */
197         wdt_config(0);
198
199         printk(KERN_INFO PFX "Watchdog timer is now disabled...\n");
200         return 0;
201 }
202
203 static int wdt_keepalive(void)
204 {
205         /* user land ping */
206         next_heartbeat = jiffies + (timeout * HZ);
207         return 0;
208 }
209
210 static int wdt_set_heartbeat(int t)
211 {
212         if ((t < 1) || (t > 3600))      /* arbitrary upper limit */
213                 return -EINVAL;
214
215         timeout = t;
216         return 0;
217 }
218
219 /*
220  *      /dev/watchdog handling
221  */
222
223 static ssize_t fop_write(struct file * file, const char __user * buf, size_t count, loff_t * ppos)
224 {
225         /* See if we got the magic character 'V' and reload the timer */
226         if(count) {
227                 if (!nowayout) {
228                         size_t ofs;
229
230                         /* note: just in case someone wrote the magic character
231                          * five months ago... */
232                         wdt_expect_close = 0;
233
234                         /* now scan */
235                         for(ofs = 0; ofs != count; ofs++) {
236                                 char c;
237                                 if (get_user(c, buf + ofs))
238                                         return -EFAULT;
239                                 if(c == 'V')
240                                         wdt_expect_close = 42;
241                         }
242                 }
243
244                 /* Well, anyhow someone wrote to us, we should return that favour */
245                 wdt_keepalive();
246         }
247         return count;
248 }
249
250 static int fop_open(struct inode * inode, struct file * file)
251 {
252         nonseekable_open(inode, file);
253
254         /* Just in case we're already talking to someone... */
255         if(test_and_set_bit(0, &wdt_is_open))
256                 return -EBUSY;
257         if (nowayout)
258                 __module_get(THIS_MODULE);
259
260         /* Good, fire up the show */
261         wdt_startup();
262         return 0;
263 }
264
265 static int fop_close(struct inode * inode, struct file * file)
266 {
267         if(wdt_expect_close == 42) {
268                 wdt_turnoff();
269         } else {
270                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
271                 wdt_keepalive();
272         }
273         clear_bit(0, &wdt_is_open);
274         wdt_expect_close = 0;
275         return 0;
276 }
277
278 static int fop_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
279         unsigned long arg)
280 {
281         void __user *argp = (void __user *)arg;
282         int __user *p = argp;
283         static struct watchdog_info ident = {
284                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
285                 .firmware_version = 1,
286                 .identity = "SC520",
287         };
288
289         switch(cmd)
290         {
291                 default:
292                         return -ENOIOCTLCMD;
293                 case WDIOC_GETSUPPORT:
294                         return copy_to_user(argp, &ident, sizeof(ident))?-EFAULT:0;
295                 case WDIOC_GETSTATUS:
296                 case WDIOC_GETBOOTSTATUS:
297                         return put_user(0, p);
298                 case WDIOC_KEEPALIVE:
299                         wdt_keepalive();
300                         return 0;
301                 case WDIOC_SETOPTIONS:
302                 {
303                         int new_options, retval = -EINVAL;
304
305                         if(get_user(new_options, p))
306                                 return -EFAULT;
307
308                         if(new_options & WDIOS_DISABLECARD) {
309                                 wdt_turnoff();
310                                 retval = 0;
311                         }
312
313                         if(new_options & WDIOS_ENABLECARD) {
314                                 wdt_startup();
315                                 retval = 0;
316                         }
317
318                         return retval;
319                 }
320                 case WDIOC_SETTIMEOUT:
321                 {
322                         int new_timeout;
323
324                         if(get_user(new_timeout, p))
325                                 return -EFAULT;
326
327                         if(wdt_set_heartbeat(new_timeout))
328                                 return -EINVAL;
329
330                         wdt_keepalive();
331                         /* Fall through */
332                 }
333                 case WDIOC_GETTIMEOUT:
334                         return put_user(timeout, p);
335         }
336 }
337
338 static struct file_operations wdt_fops = {
339         .owner          = THIS_MODULE,
340         .llseek         = no_llseek,
341         .write          = fop_write,
342         .open           = fop_open,
343         .release        = fop_close,
344         .ioctl          = fop_ioctl,
345 };
346
347 static struct miscdevice wdt_miscdev = {
348         .minor  = WATCHDOG_MINOR,
349         .name   = "watchdog",
350         .fops   = &wdt_fops,
351 };
352
353 /*
354  *      Notifier for system down
355  */
356
357 static int wdt_notify_sys(struct notifier_block *this, unsigned long code,
358         void *unused)
359 {
360         if(code==SYS_DOWN || code==SYS_HALT)
361                 wdt_turnoff();
362         return NOTIFY_DONE;
363 }
364
365 /*
366  *      The WDT needs to learn about soft shutdowns in order to
367  *      turn the timebomb registers off.
368  */
369
370 static struct notifier_block wdt_notifier = {
371         .notifier_call = wdt_notify_sys,
372 };
373
374 static void __exit sc520_wdt_unload(void)
375 {
376         if (!nowayout)
377                 wdt_turnoff();
378
379         /* Deregister */
380         misc_deregister(&wdt_miscdev);
381         unregister_reboot_notifier(&wdt_notifier);
382         iounmap(wdtmrctl);
383 }
384
385 static int __init sc520_wdt_init(void)
386 {
387         int rc = -EBUSY;
388
389         spin_lock_init(&wdt_spinlock);
390
391         init_timer(&timer);
392         timer.function = wdt_timer_ping;
393         timer.data = 0;
394
395         /* Check that the timeout value is within it's range ; if not reset to the default */
396         if (wdt_set_heartbeat(timeout)) {
397                 wdt_set_heartbeat(WATCHDOG_TIMEOUT);
398                 printk(KERN_INFO PFX "timeout value must be 1<=timeout<=3600, using %d\n",
399                         WATCHDOG_TIMEOUT);
400         }
401
402         wdtmrctl = ioremap((unsigned long)(MMCR_BASE + OFFS_WDTMRCTL), 2);
403         if (!wdtmrctl) {
404                 printk(KERN_ERR PFX "Unable to remap memory\n");
405                 rc = -ENOMEM;
406                 goto err_out_region2;
407         }
408
409         rc = register_reboot_notifier(&wdt_notifier);
410         if (rc) {
411                 printk(KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
412                         rc);
413                 goto err_out_ioremap;
414         }
415
416         rc = misc_register(&wdt_miscdev);
417         if (rc) {
418                 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
419                         WATCHDOG_MINOR, rc);
420                 goto err_out_notifier;
421         }
422
423         printk(KERN_INFO PFX "WDT driver for SC520 initialised. timeout=%d sec (nowayout=%d)\n",
424                 timeout,nowayout);
425
426         return 0;
427
428 err_out_notifier:
429         unregister_reboot_notifier(&wdt_notifier);
430 err_out_ioremap:
431         iounmap(wdtmrctl);
432 err_out_region2:
433         return rc;
434 }
435
436 module_init(sc520_wdt_init);
437 module_exit(sc520_wdt_unload);
438
439 MODULE_AUTHOR("Scott and Bill Jennings");
440 MODULE_DESCRIPTION("Driver for watchdog timer in AMD \"Elan\" SC520 uProcessor");
441 MODULE_LICENSE("GPL");
442 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);