watchdog: pc87413_wdt: Cleanup pc87413 watchdog driver to use
[linux-2.6.git] / drivers / watchdog / pc87413_wdt.c
1 /*
2  *      NS pc87413-wdt Watchdog Timer driver for Linux 2.6.x.x
3  *
4  *      This code is based on wdt.c with original copyright.
5  *
6  *      (C) Copyright 2006 Sven Anders, <anders@anduras.de>
7  *                     and Marcus Junker, <junker@anduras.de>
8  *
9  *      This program is free software; you can redistribute it and/or
10  *      modify it under the terms of the GNU General Public License
11  *      as published by the Free Software Foundation; either version
12  *      2 of the License, or (at your option) any later version.
13  *
14  *      Neither Sven Anders, Marcus Junker nor ANDURAS AG
15  *      admit liability nor provide warranty for any of this software.
16  *      This material is provided "AS-IS" and at no charge.
17  *
18  *      Release 1.1
19  */
20
21 #include <linux/module.h>
22 #include <linux/types.h>
23 #include <linux/miscdevice.h>
24 #include <linux/watchdog.h>
25 #include <linux/ioport.h>
26 #include <linux/delay.h>
27 #include <linux/notifier.h>
28 #include <linux/fs.h>
29 #include <linux/reboot.h>
30 #include <linux/init.h>
31 #include <linux/spinlock.h>
32 #include <linux/moduleparam.h>
33 #include <linux/io.h>
34 #include <linux/uaccess.h>
35
36 #include <asm/system.h>
37
38 /* #define DEBUG 1 */
39
40 #define DEFAULT_TIMEOUT     1           /* 1 minute */
41 #define MAX_TIMEOUT         255
42
43 #define VERSION             "1.1"
44 #define MODNAME             "pc87413 WDT"
45 #define PFX                 MODNAME ": "
46 #define DPFX                MODNAME " - DEBUG: "
47
48 #define WDT_INDEX_IO_PORT   (io+0)      /* I/O port base (index register) */
49 #define WDT_DATA_IO_PORT    (WDT_INDEX_IO_PORT+1)
50 #define SWC_LDN             0x04
51 #define SIOCFG2             0x22        /* Serial IO register */
52 #define WDCTL               0x10        /* Watchdog-Timer-Control-Register */
53 #define WDTO                0x11        /* Watchdog timeout register */
54 #define WDCFG               0x12        /* Watchdog config register */
55
56 #define IO_DEFAULT      0x2E            /* Address used on Portwell Boards */
57
58 static int io = IO_DEFAULT;
59 static int swc_base_addr = -1;
60
61 static int timeout = DEFAULT_TIMEOUT;   /* timeout value */
62 static unsigned long timer_enabled;     /* is the timer enabled? */
63
64 static char expect_close;               /* is the close expected? */
65
66 static DEFINE_SPINLOCK(io_lock);        /* to guard us from io races */
67
68 static int nowayout = WATCHDOG_NOWAYOUT;
69
70 /* -- Low level function ----------------------------------------*/
71
72 /* Select pins for Watchdog output */
73
74 static inline void pc87413_select_wdt_out(void)
75 {
76         unsigned int cr_data = 0;
77
78         /* Step 1: Select multiple pin,pin55,as WDT output */
79
80         outb_p(SIOCFG2, WDT_INDEX_IO_PORT);
81
82         cr_data = inb(WDT_DATA_IO_PORT);
83
84         cr_data |= 0x80; /* Set Bit7 to 1*/
85         outb_p(SIOCFG2, WDT_INDEX_IO_PORT);
86
87         outb_p(cr_data, WDT_DATA_IO_PORT);
88
89 #ifdef DEBUG
90         printk(KERN_INFO DPFX
91                 "Select multiple pin,pin55,as WDT output: Bit7 to 1: %d\n",
92                                                                 cr_data);
93 #endif
94 }
95
96 /* Enable SWC functions */
97
98 static inline void pc87413_enable_swc(void)
99 {
100         unsigned int cr_data = 0;
101
102         /* Step 2: Enable SWC functions */
103
104         outb_p(0x07, WDT_INDEX_IO_PORT);        /* Point SWC_LDN (LDN=4) */
105         outb_p(SWC_LDN, WDT_DATA_IO_PORT);
106
107         outb_p(0x30, WDT_INDEX_IO_PORT);        /* Read Index 0x30 First */
108         cr_data = inb(WDT_DATA_IO_PORT);
109         cr_data |= 0x01;                        /* Set Bit0 to 1 */
110         outb_p(0x30, WDT_INDEX_IO_PORT);
111         outb_p(cr_data, WDT_DATA_IO_PORT);      /* Index0x30_bit0P1 */
112
113 #ifdef DEBUG
114         printk(KERN_INFO DPFX "pc87413 - Enable SWC functions\n");
115 #endif
116 }
117
118 /* Read SWC I/O base address */
119
120 static void pc87413_get_swc_base_addr(void)
121 {
122         unsigned char addr_l, addr_h = 0;
123
124         /* Step 3: Read SWC I/O Base Address */
125
126         outb_p(0x60, WDT_INDEX_IO_PORT);        /* Read Index 0x60 */
127         addr_h = inb(WDT_DATA_IO_PORT);
128
129         outb_p(0x61, WDT_INDEX_IO_PORT);        /* Read Index 0x61 */
130
131         addr_l = inb(WDT_DATA_IO_PORT);
132
133         swc_base_addr = (addr_h << 8) + addr_l;
134 #ifdef DEBUG
135         printk(KERN_INFO DPFX
136                 "Read SWC I/O Base Address: low %d, high %d, res %d\n",
137                                                 addr_l, addr_h, swc_base_addr);
138 #endif
139 }
140
141 /* Select Bank 3 of SWC */
142
143 static inline void pc87413_swc_bank3(void)
144 {
145         /* Step 4: Select Bank3 of SWC */
146         outb_p(inb(swc_base_addr + 0x0f) | 0x03, swc_base_addr + 0x0f);
147 #ifdef DEBUG
148         printk(KERN_INFO DPFX "Select Bank3 of SWC\n");
149 #endif
150 }
151
152 /* Set watchdog timeout to x minutes */
153
154 static inline void pc87413_programm_wdto(char pc87413_time)
155 {
156         /* Step 5: Programm WDTO, Twd. */
157         outb_p(pc87413_time, swc_base_addr + WDTO);
158 #ifdef DEBUG
159         printk(KERN_INFO DPFX "Set WDTO to %d minutes\n", pc87413_time);
160 #endif
161 }
162
163 /* Enable WDEN */
164
165 static inline void pc87413_enable_wden(void)
166 {
167         /* Step 6: Enable WDEN */
168         outb_p(inb(swc_base_addr + WDCTL) | 0x01, swc_base_addr + WDCTL);
169 #ifdef DEBUG
170         printk(KERN_INFO DPFX "Enable WDEN\n");
171 #endif
172 }
173
174 /* Enable SW_WD_TREN */
175 static inline void pc87413_enable_sw_wd_tren(void)
176 {
177         /* Enable SW_WD_TREN */
178         outb_p(inb(swc_base_addr + WDCFG) | 0x80, swc_base_addr + WDCFG);
179 #ifdef DEBUG
180         printk(KERN_INFO DPFX "Enable SW_WD_TREN\n");
181 #endif
182 }
183
184 /* Disable SW_WD_TREN */
185
186 static inline void pc87413_disable_sw_wd_tren(void)
187 {
188         /* Disable SW_WD_TREN */
189         outb_p(inb(swc_base_addr + WDCFG) & 0x7f, swc_base_addr + WDCFG);
190 #ifdef DEBUG
191         printk(KERN_INFO DPFX "pc87413 - Disable SW_WD_TREN\n");
192 #endif
193 }
194
195 /* Enable SW_WD_TRG */
196
197 static inline void pc87413_enable_sw_wd_trg(void)
198 {
199         /* Enable SW_WD_TRG */
200         outb_p(inb(swc_base_addr + WDCTL) | 0x80, swc_base_addr + WDCTL);
201 #ifdef DEBUG
202         printk(KERN_INFO DPFX "pc87413 - Enable SW_WD_TRG\n");
203 #endif
204 }
205
206 /* Disable SW_WD_TRG */
207
208 static inline void pc87413_disable_sw_wd_trg(void)
209 {
210         /* Disable SW_WD_TRG */
211         outb_p(inb(swc_base_addr + WDCTL) & 0x7f, swc_base_addr + WDCTL);
212 #ifdef DEBUG
213         printk(KERN_INFO DPFX "Disable SW_WD_TRG\n");
214 #endif
215 }
216
217 /* -- Higher level functions ------------------------------------*/
218
219 /* Enable the watchdog */
220
221 static void pc87413_enable(void)
222 {
223         spin_lock(&io_lock);
224
225         pc87413_swc_bank3();
226         pc87413_programm_wdto(timeout);
227         pc87413_enable_wden();
228         pc87413_enable_sw_wd_tren();
229         pc87413_enable_sw_wd_trg();
230
231         spin_unlock(&io_lock);
232 }
233
234 /* Disable the watchdog */
235
236 static void pc87413_disable(void)
237 {
238         spin_lock(&io_lock);
239
240         pc87413_swc_bank3();
241         pc87413_disable_sw_wd_tren();
242         pc87413_disable_sw_wd_trg();
243         pc87413_programm_wdto(0);
244
245         spin_unlock(&io_lock);
246 }
247
248 /* Refresh the watchdog */
249
250 static void pc87413_refresh(void)
251 {
252         spin_lock(&io_lock);
253
254         pc87413_swc_bank3();
255         pc87413_disable_sw_wd_tren();
256         pc87413_disable_sw_wd_trg();
257         pc87413_programm_wdto(timeout);
258         pc87413_enable_wden();
259         pc87413_enable_sw_wd_tren();
260         pc87413_enable_sw_wd_trg();
261
262         spin_unlock(&io_lock);
263 }
264
265 /* -- File operations -------------------------------------------*/
266
267 /**
268  *      pc87413_open:
269  *      @inode: inode of device
270  *      @file: file handle to device
271  *
272  */
273
274 static int pc87413_open(struct inode *inode, struct file *file)
275 {
276         /* /dev/watchdog can only be opened once */
277
278         if (test_and_set_bit(0, &timer_enabled))
279                 return -EBUSY;
280
281         if (nowayout)
282                 __module_get(THIS_MODULE);
283
284         /* Reload and activate timer */
285         pc87413_refresh();
286
287         printk(KERN_INFO MODNAME
288                 "Watchdog enabled. Timeout set to %d minute(s).\n", timeout);
289
290         return nonseekable_open(inode, file);
291 }
292
293 /**
294  *      pc87413_release:
295  *      @inode: inode to board
296  *      @file: file handle to board
297  *
298  *      The watchdog has a configurable API. There is a religious dispute
299  *      between people who want their watchdog to be able to shut down and
300  *      those who want to be sure if the watchdog manager dies the machine
301  *      reboots. In the former case we disable the counters, in the latter
302  *      case you have to open it again very soon.
303  */
304
305 static int pc87413_release(struct inode *inode, struct file *file)
306 {
307         /* Shut off the timer. */
308
309         if (expect_close == 42) {
310                 pc87413_disable();
311                 printk(KERN_INFO MODNAME
312                                 "Watchdog disabled, sleeping again...\n");
313         } else {
314                 printk(KERN_CRIT MODNAME
315                                 "Unexpected close, not stopping watchdog!\n");
316                 pc87413_refresh();
317         }
318         clear_bit(0, &timer_enabled);
319         expect_close = 0;
320         return 0;
321 }
322
323 /**
324  *      pc87413_status:
325  *
326  *      return, if the watchdog is enabled (timeout is set...)
327  */
328
329
330 static int pc87413_status(void)
331 {
332           return 0; /* currently not supported */
333 }
334
335 /**
336  *      pc87413_write:
337  *      @file: file handle to the watchdog
338  *      @data: data buffer to write
339  *      @len: length in bytes
340  *      @ppos: pointer to the position to write. No seeks allowed
341  *
342  *      A write to a watchdog device is defined as a keepalive signal. Any
343  *      write of data will do, as we we don't define content meaning.
344  */
345
346 static ssize_t pc87413_write(struct file *file, const char __user *data,
347                              size_t len, loff_t *ppos)
348 {
349         /* See if we got the magic character 'V' and reload the timer */
350         if (len) {
351                 if (!nowayout) {
352                         size_t i;
353
354                         /* reset expect flag */
355                         expect_close = 0;
356
357                         /* scan to see whether or not we got the
358                            magic character */
359                         for (i = 0; i != len; i++) {
360                                 char c;
361                                 if (get_user(c, data + i))
362                                         return -EFAULT;
363                                 if (c == 'V')
364                                         expect_close = 42;
365                         }
366                 }
367
368                 /* someone wrote to us, we should reload the timer */
369                 pc87413_refresh();
370         }
371         return len;
372 }
373
374 /**
375  *      pc87413_ioctl:
376  *      @file: file handle to the device
377  *      @cmd: watchdog command
378  *      @arg: argument pointer
379  *
380  *      The watchdog API defines a common set of functions for all watchdogs
381  *      according to their available features. We only actually usefully support
382  *      querying capabilities and current status.
383  */
384
385 static long pc87413_ioctl(struct file *file, unsigned int cmd,
386                                                 unsigned long arg)
387 {
388         int new_timeout;
389
390         union {
391                 struct watchdog_info __user *ident;
392                 int __user *i;
393         } uarg;
394
395         static const struct watchdog_info ident = {
396                 .options          = WDIOF_KEEPALIVEPING |
397                                     WDIOF_SETTIMEOUT |
398                                     WDIOF_MAGICCLOSE,
399                 .firmware_version = 1,
400                 .identity         = "PC87413(HF/F) watchdog",
401         };
402
403         uarg.i = (int __user *)arg;
404
405         switch (cmd) {
406         case WDIOC_GETSUPPORT:
407                 return copy_to_user(uarg.ident, &ident,
408                                         sizeof(ident)) ? -EFAULT : 0;
409         case WDIOC_GETSTATUS:
410                 return put_user(pc87413_status(), uarg.i);
411         case WDIOC_GETBOOTSTATUS:
412                 return put_user(0, uarg.i);
413         case WDIOC_SETOPTIONS:
414         {
415                 int options, retval = -EINVAL;
416                 if (get_user(options, uarg.i))
417                         return -EFAULT;
418                 if (options & WDIOS_DISABLECARD) {
419                         pc87413_disable();
420                         retval = 0;
421                 }
422                 if (options & WDIOS_ENABLECARD) {
423                         pc87413_enable();
424                         retval = 0;
425                 }
426                 return retval;
427         }
428         case WDIOC_KEEPALIVE:
429                 pc87413_refresh();
430 #ifdef DEBUG
431                 printk(KERN_INFO DPFX "keepalive\n");
432 #endif
433                 return 0;
434         case WDIOC_SETTIMEOUT:
435                 if (get_user(new_timeout, uarg.i))
436                         return -EFAULT;
437                 /* the API states this is given in secs */
438                 new_timeout /= 60;
439                 if (new_timeout < 0 || new_timeout > MAX_TIMEOUT)
440                         return -EINVAL;
441                 timeout = new_timeout;
442                 pc87413_refresh();
443                 /* fall through and return the new timeout... */
444         case WDIOC_GETTIMEOUT:
445                 new_timeout = timeout * 60;
446                 return put_user(new_timeout, uarg.i);
447         default:
448                 return -ENOTTY;
449         }
450 }
451
452 /* -- Notifier funtions -----------------------------------------*/
453
454 /**
455  *      notify_sys:
456  *      @this: our notifier block
457  *      @code: the event being reported
458  *      @unused: unused
459  *
460  *      Our notifier is called on system shutdowns. We want to turn the card
461  *      off at reboot otherwise the machine will reboot again during memory
462  *      test or worse yet during the following fsck. This would suck, in fact
463  *      trust me - if it happens it does suck.
464  */
465
466 static int pc87413_notify_sys(struct notifier_block *this,
467                               unsigned long code,
468                               void *unused)
469 {
470         if (code == SYS_DOWN || code == SYS_HALT)
471                 /* Turn the card off */
472                 pc87413_disable();
473         return NOTIFY_DONE;
474 }
475
476 /* -- Module's structures ---------------------------------------*/
477
478 static const struct file_operations pc87413_fops = {
479         .owner          = THIS_MODULE,
480         .llseek         = no_llseek,
481         .write          = pc87413_write,
482         .unlocked_ioctl = pc87413_ioctl,
483         .open           = pc87413_open,
484         .release        = pc87413_release,
485 };
486
487 static struct notifier_block pc87413_notifier = {
488         .notifier_call  = pc87413_notify_sys,
489 };
490
491 static struct miscdevice pc87413_miscdev = {
492         .minor          = WATCHDOG_MINOR,
493         .name           = "watchdog",
494         .fops           = &pc87413_fops,
495 };
496
497 /* -- Module init functions -------------------------------------*/
498
499 /**
500  *      pc87413_init: module's "constructor"
501  *
502  *      Set up the WDT watchdog board. All we have to do is grab the
503  *      resources we require and bitch if anyone beat us to them.
504  *      The open() function will actually kick the board off.
505  */
506
507 static int __init pc87413_init(void)
508 {
509         int ret;
510
511         printk(KERN_INFO PFX "Version " VERSION " at io 0x%X\n",
512                                                         WDT_INDEX_IO_PORT);
513
514         if (!request_muxed_region(io, 2, MODNAME))
515                 return -EBUSY;
516
517         ret = register_reboot_notifier(&pc87413_notifier);
518         if (ret != 0) {
519                 printk(KERN_ERR PFX
520                         "cannot register reboot notifier (err=%d)\n", ret);
521         }
522
523         ret = misc_register(&pc87413_miscdev);
524         if (ret != 0) {
525                 printk(KERN_ERR PFX
526                         "cannot register miscdev on minor=%d (err=%d)\n",
527                         WATCHDOG_MINOR, ret);
528                 goto reboot_unreg;
529         }
530         printk(KERN_INFO PFX "initialized. timeout=%d min \n", timeout);
531
532         pc87413_select_wdt_out();
533         pc87413_enable_swc();
534         pc87413_get_swc_base_addr();
535
536         if (!request_region(swc_base_addr, 0x20, MODNAME)) {
537                 printk(KERN_ERR PFX
538                         "cannot request SWC region at 0x%x\n", swc_base_addr);
539                 ret = -EBUSY;
540                 goto misc_unreg;
541         }
542
543         pc87413_enable();
544
545         release_region(io, 2);
546         return 0;
547
548 misc_unreg:
549         misc_deregister(&pc87413_miscdev);
550 reboot_unreg:
551         unregister_reboot_notifier(&pc87413_notifier);
552         release_region(io, 2);
553         return ret;
554 }
555
556 /**
557  *      pc87413_exit: module's "destructor"
558  *
559  *      Unload the watchdog. You cannot do this with any file handles open.
560  *      If your watchdog is set to continue ticking on close and you unload
561  *      it, well it keeps ticking. We won't get the interrupt but the board
562  *      will not touch PC memory so all is fine. You just have to load a new
563  *      module in 60 seconds or reboot.
564  */
565
566 static void __exit pc87413_exit(void)
567 {
568         /* Stop the timer before we leave */
569         if (!nowayout) {
570                 pc87413_disable();
571                 printk(KERN_INFO MODNAME "Watchdog disabled.\n");
572         }
573
574         misc_deregister(&pc87413_miscdev);
575         unregister_reboot_notifier(&pc87413_notifier);
576         release_region(swc_base_addr, 0x20);
577
578         printk(KERN_INFO MODNAME " watchdog component driver removed.\n");
579 }
580
581 module_init(pc87413_init);
582 module_exit(pc87413_exit);
583
584 MODULE_AUTHOR("Sven Anders <anders@anduras.de>, "
585                 "Marcus Junker <junker@anduras.de>,");
586 MODULE_DESCRIPTION("PC87413 WDT driver");
587 MODULE_LICENSE("GPL");
588
589 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
590
591 module_param(io, int, 0);
592 MODULE_PARM_DESC(io, MODNAME " I/O port (default: "
593                                         __MODULE_STRING(IO_DEFAULT) ").");
594
595 module_param(timeout, int, 0);
596 MODULE_PARM_DESC(timeout,
597                 "Watchdog timeout in minutes (default="
598                                 __MODULE_STRING(DEFAULT_TIMEOUT) ").");
599
600 module_param(nowayout, int, 0);
601 MODULE_PARM_DESC(nowayout,
602                 "Watchdog cannot be stopped once started (default="
603                                 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
604