watchdog: Use pr_<fmt> and pr_<level>
[sfrench/cifs-2.6.git] / drivers / watchdog / machzwd.c
1 /*
2  *  MachZ ZF-Logic Watchdog Timer driver for Linux
3  *
4  *
5  *  This program is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU General Public License
7  *  as published by the Free Software Foundation; either version
8  *  2 of the License, or (at your option) any later version.
9  *
10  *  The author does NOT admit liability nor provide warranty for
11  *  any of this software. This material is provided "AS-IS" in
12  *  the hope that it may be useful for others.
13  *
14  *  Author: Fernando Fuganti <fuganti@conectiva.com.br>
15  *
16  *  Based on sbc60xxwdt.c by Jakob Oestergaard
17  *
18  *
19  *  We have two timers (wd#1, wd#2) driven by a 32 KHz clock with the
20  *  following periods:
21  *      wd#1 - 2 seconds;
22  *      wd#2 - 7.2 ms;
23  *  After the expiration of wd#1, it can generate a NMI, SCI, SMI, or
24  *  a system RESET and it starts wd#2 that unconditionally will RESET
25  *  the system when the counter reaches zero.
26  *
27  *  14-Dec-2001 Matt Domsch <Matt_Domsch@dell.com>
28  *      Added nowayout module option to override CONFIG_WATCHDOG_NOWAYOUT
29  */
30
31 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32
33 #include <linux/module.h>
34 #include <linux/moduleparam.h>
35 #include <linux/types.h>
36 #include <linux/timer.h>
37 #include <linux/jiffies.h>
38 #include <linux/miscdevice.h>
39 #include <linux/watchdog.h>
40 #include <linux/fs.h>
41 #include <linux/ioport.h>
42 #include <linux/notifier.h>
43 #include <linux/reboot.h>
44 #include <linux/init.h>
45 #include <linux/io.h>
46 #include <linux/uaccess.h>
47
48 #include <asm/system.h>
49
50 /* ports */
51 #define ZF_IOBASE       0x218
52 #define INDEX           0x218
53 #define DATA_B          0x219
54 #define DATA_W          0x21A
55 #define DATA_D          0x21A
56
57 /* indexes */                   /* size */
58 #define ZFL_VERSION     0x02    /* 16   */
59 #define CONTROL         0x10    /* 16   */
60 #define STATUS          0x12    /* 8    */
61 #define COUNTER_1       0x0C    /* 16   */
62 #define COUNTER_2       0x0E    /* 8    */
63 #define PULSE_LEN       0x0F    /* 8    */
64
65 /* controls */
66 #define ENABLE_WD1      0x0001
67 #define ENABLE_WD2      0x0002
68 #define RESET_WD1       0x0010
69 #define RESET_WD2       0x0020
70 #define GEN_SCI         0x0100
71 #define GEN_NMI         0x0200
72 #define GEN_SMI         0x0400
73 #define GEN_RESET       0x0800
74
75
76 /* utilities */
77
78 #define WD1     0
79 #define WD2     1
80
81 #define zf_writew(port, data)  { outb(port, INDEX); outw(data, DATA_W); }
82 #define zf_writeb(port, data)  { outb(port, INDEX); outb(data, DATA_B); }
83 #define zf_get_ZFL_version()   zf_readw(ZFL_VERSION)
84
85
86 static unsigned short zf_readw(unsigned char port)
87 {
88         outb(port, INDEX);
89         return inw(DATA_W);
90 }
91
92
93 MODULE_AUTHOR("Fernando Fuganti <fuganti@conectiva.com.br>");
94 MODULE_DESCRIPTION("MachZ ZF-Logic Watchdog driver");
95 MODULE_LICENSE("GPL");
96 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
97
98 static int nowayout = WATCHDOG_NOWAYOUT;
99 module_param(nowayout, int, 0);
100 MODULE_PARM_DESC(nowayout,
101                 "Watchdog cannot be stopped once started (default="
102                                 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
103
104 #define PFX "machzwd"
105
106 static const struct watchdog_info zf_info = {
107         .options                = WDIOF_KEEPALIVEPING | WDIOF_MAGICCLOSE,
108         .firmware_version       = 1,
109         .identity               = "ZF-Logic watchdog",
110 };
111
112
113 /*
114  * action refers to action taken when watchdog resets
115  * 0 = GEN_RESET
116  * 1 = GEN_SMI
117  * 2 = GEN_NMI
118  * 3 = GEN_SCI
119  * defaults to GEN_RESET (0)
120  */
121 static int action;
122 module_param(action, int, 0);
123 MODULE_PARM_DESC(action, "after watchdog resets, generate: "
124                                 "0 = RESET(*)  1 = SMI  2 = NMI  3 = SCI");
125
126 static void zf_ping(unsigned long data);
127
128 static int zf_action = GEN_RESET;
129 static unsigned long zf_is_open;
130 static char zf_expect_close;
131 static DEFINE_SPINLOCK(zf_port_lock);
132 static DEFINE_TIMER(zf_timer, zf_ping, 0, 0);
133 static unsigned long next_heartbeat;
134
135
136 /* timeout for user land heart beat (10 seconds) */
137 #define ZF_USER_TIMEO (HZ*10)
138
139 /* timeout for hardware watchdog (~500ms) */
140 #define ZF_HW_TIMEO (HZ/2)
141
142 /* number of ticks on WD#1 (driven by a 32KHz clock, 2s) */
143 #define ZF_CTIMEOUT 0xffff
144
145 #ifndef ZF_DEBUG
146 #define dprintk(format, args...)
147 #else
148 #define dprintk(format, args...)                                        \
149         pr_debug(":%s:%d: " format, __func__, __LINE__ , ## args)
150 #endif
151
152
153 static inline void zf_set_status(unsigned char new)
154 {
155         zf_writeb(STATUS, new);
156 }
157
158
159 /* CONTROL register functions */
160
161 static inline unsigned short zf_get_control(void)
162 {
163         return zf_readw(CONTROL);
164 }
165
166 static inline void zf_set_control(unsigned short new)
167 {
168         zf_writew(CONTROL, new);
169 }
170
171
172 /* WD#? counter functions */
173 /*
174  *      Just set counter value
175  */
176
177 static inline void zf_set_timer(unsigned short new, unsigned char n)
178 {
179         switch (n) {
180         case WD1:
181                 zf_writew(COUNTER_1, new);
182         case WD2:
183                 zf_writeb(COUNTER_2, new > 0xff ? 0xff : new);
184         default:
185                 return;
186         }
187 }
188
189 /*
190  * stop hardware timer
191  */
192 static void zf_timer_off(void)
193 {
194         unsigned int ctrl_reg = 0;
195         unsigned long flags;
196
197         /* stop internal ping */
198         del_timer_sync(&zf_timer);
199
200         spin_lock_irqsave(&zf_port_lock, flags);
201         /* stop watchdog timer */
202         ctrl_reg = zf_get_control();
203         ctrl_reg |= (ENABLE_WD1|ENABLE_WD2);    /* disable wd1 and wd2 */
204         ctrl_reg &= ~(ENABLE_WD1|ENABLE_WD2);
205         zf_set_control(ctrl_reg);
206         spin_unlock_irqrestore(&zf_port_lock, flags);
207
208         pr_info("Watchdog timer is now disabled\n");
209 }
210
211
212 /*
213  * start hardware timer
214  */
215 static void zf_timer_on(void)
216 {
217         unsigned int ctrl_reg = 0;
218         unsigned long flags;
219
220         spin_lock_irqsave(&zf_port_lock, flags);
221
222         zf_writeb(PULSE_LEN, 0xff);
223
224         zf_set_timer(ZF_CTIMEOUT, WD1);
225
226         /* user land ping */
227         next_heartbeat = jiffies + ZF_USER_TIMEO;
228
229         /* start the timer for internal ping */
230         mod_timer(&zf_timer, jiffies + ZF_HW_TIMEO);
231
232         /* start watchdog timer */
233         ctrl_reg = zf_get_control();
234         ctrl_reg |= (ENABLE_WD1|zf_action);
235         zf_set_control(ctrl_reg);
236         spin_unlock_irqrestore(&zf_port_lock, flags);
237
238         pr_info("Watchdog timer is now enabled\n");
239 }
240
241
242 static void zf_ping(unsigned long data)
243 {
244         unsigned int ctrl_reg = 0;
245         unsigned long flags;
246
247         zf_writeb(COUNTER_2, 0xff);
248
249         if (time_before(jiffies, next_heartbeat)) {
250                 dprintk("time_before: %ld\n", next_heartbeat - jiffies);
251                 /*
252                  * reset event is activated by transition from 0 to 1 on
253                  * RESET_WD1 bit and we assume that it is already zero...
254                  */
255
256                 spin_lock_irqsave(&zf_port_lock, flags);
257                 ctrl_reg = zf_get_control();
258                 ctrl_reg |= RESET_WD1;
259                 zf_set_control(ctrl_reg);
260
261                 /* ...and nothing changes until here */
262                 ctrl_reg &= ~(RESET_WD1);
263                 zf_set_control(ctrl_reg);
264                 spin_unlock_irqrestore(&zf_port_lock, flags);
265
266                 mod_timer(&zf_timer, jiffies + ZF_HW_TIMEO);
267         } else
268                 pr_crit("I will reset your machine\n");
269 }
270
271 static ssize_t zf_write(struct file *file, const char __user *buf, size_t count,
272                                                                 loff_t *ppos)
273 {
274         /* See if we got the magic character */
275         if (count) {
276                 /*
277                  * no need to check for close confirmation
278                  * no way to disable watchdog ;)
279                  */
280                 if (!nowayout) {
281                         size_t ofs;
282                         /*
283                          * note: just in case someone wrote the magic character
284                          * five months ago...
285                          */
286                         zf_expect_close = 0;
287
288                         /* now scan */
289                         for (ofs = 0; ofs != count; ofs++) {
290                                 char c;
291                                 if (get_user(c, buf + ofs))
292                                         return -EFAULT;
293                                 if (c == 'V') {
294                                         zf_expect_close = 42;
295                                         dprintk("zf_expect_close = 42\n");
296                                 }
297                         }
298                 }
299
300                 /*
301                  * Well, anyhow someone wrote to us,
302                  * we should return that favour
303                  */
304                 next_heartbeat = jiffies + ZF_USER_TIMEO;
305                 dprintk("user ping at %ld\n", jiffies);
306         }
307         return count;
308 }
309
310 static long zf_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
311 {
312         void __user *argp = (void __user *)arg;
313         int __user *p = argp;
314         switch (cmd) {
315         case WDIOC_GETSUPPORT:
316                 if (copy_to_user(argp, &zf_info, sizeof(zf_info)))
317                         return -EFAULT;
318                 break;
319         case WDIOC_GETSTATUS:
320         case WDIOC_GETBOOTSTATUS:
321                 return put_user(0, p);
322         case WDIOC_KEEPALIVE:
323                 zf_ping(0);
324                 break;
325         default:
326                 return -ENOTTY;
327         }
328         return 0;
329 }
330
331 static int zf_open(struct inode *inode, struct file *file)
332 {
333         if (test_and_set_bit(0, &zf_is_open))
334                 return -EBUSY;
335         if (nowayout)
336                 __module_get(THIS_MODULE);
337         zf_timer_on();
338         return nonseekable_open(inode, file);
339 }
340
341 static int zf_close(struct inode *inode, struct file *file)
342 {
343         if (zf_expect_close == 42)
344                 zf_timer_off();
345         else {
346                 del_timer(&zf_timer);
347                 pr_err("device file closed unexpectedly. Will not stop the WDT!\n");
348         }
349         clear_bit(0, &zf_is_open);
350         zf_expect_close = 0;
351         return 0;
352 }
353
354 /*
355  * Notifier for system down
356  */
357
358 static int zf_notify_sys(struct notifier_block *this, unsigned long code,
359                                                                 void *unused)
360 {
361         if (code == SYS_DOWN || code == SYS_HALT)
362                 zf_timer_off();
363         return NOTIFY_DONE;
364 }
365
366 static const struct file_operations zf_fops = {
367         .owner          = THIS_MODULE,
368         .llseek         = no_llseek,
369         .write          = zf_write,
370         .unlocked_ioctl = zf_ioctl,
371         .open           = zf_open,
372         .release        = zf_close,
373 };
374
375 static struct miscdevice zf_miscdev = {
376         .minor = WATCHDOG_MINOR,
377         .name = "watchdog",
378         .fops = &zf_fops,
379 };
380
381
382 /*
383  * The device needs to learn about soft shutdowns in order to
384  * turn the timebomb registers off.
385  */
386 static struct notifier_block zf_notifier = {
387         .notifier_call = zf_notify_sys,
388 };
389
390 static void __init zf_show_action(int act)
391 {
392         static const char * const str[] = { "RESET", "SMI", "NMI", "SCI" };
393
394         pr_info("Watchdog using action = %s\n", str[act]);
395 }
396
397 static int __init zf_init(void)
398 {
399         int ret;
400
401         pr_info("MachZ ZF-Logic Watchdog driver initializing\n");
402
403         ret = zf_get_ZFL_version();
404         if (!ret || ret == 0xffff) {
405                 pr_warn("no ZF-Logic found\n");
406                 return -ENODEV;
407         }
408
409         if (action <= 3 && action >= 0)
410                 zf_action = zf_action >> action;
411         else
412                 action = 0;
413
414         zf_show_action(action);
415
416         if (!request_region(ZF_IOBASE, 3, "MachZ ZFL WDT")) {
417                 pr_err("cannot reserve I/O ports at %d\n", ZF_IOBASE);
418                 ret = -EBUSY;
419                 goto no_region;
420         }
421
422         ret = register_reboot_notifier(&zf_notifier);
423         if (ret) {
424                 pr_err("can't register reboot notifier (err=%d)\n", ret);
425                 goto no_reboot;
426         }
427
428         ret = misc_register(&zf_miscdev);
429         if (ret) {
430                 pr_err("can't misc_register on minor=%d\n", WATCHDOG_MINOR);
431                 goto no_misc;
432         }
433
434         zf_set_status(0);
435         zf_set_control(0);
436
437         return 0;
438
439 no_misc:
440         unregister_reboot_notifier(&zf_notifier);
441 no_reboot:
442         release_region(ZF_IOBASE, 3);
443 no_region:
444         return ret;
445 }
446
447
448 static void __exit zf_exit(void)
449 {
450         zf_timer_off();
451
452         misc_deregister(&zf_miscdev);
453         unregister_reboot_notifier(&zf_notifier);
454         release_region(ZF_IOBASE, 3);
455 }
456
457 module_init(zf_init);
458 module_exit(zf_exit);