v2.4.8 -> v2.4.8.1
[opensuse:kernel.git] / drivers / char / wdt.c
1 /*
2  *      Industrial Computer Source WDT500/501 driver for Linux 2.1.x
3  *
4  *      (c) Copyright 1996-1997 Alan Cox <alan@redhat.com>, All Rights Reserved.
5  *                              http://www.redhat.com
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  *      Neither Alan Cox nor CymruNet Ltd. admit liability nor provide 
13  *      warranty for any of this software. This material is provided 
14  *      "AS-IS" and at no charge.       
15  *
16  *      (c) Copyright 1995    Alan Cox <alan@lxorguk.ukuu.org.uk>
17  *
18  *      Release 0.08.
19  *
20  *      Fixes
21  *              Dave Gregorich  :       Modularisation and minor bugs
22  *              Alan Cox        :       Added the watchdog ioctl() stuff
23  *              Alan Cox        :       Fixed the reboot problem (as noted by
24  *                                      Matt Crocker).
25  *              Alan Cox        :       Added wdt= boot option
26  *              Alan Cox        :       Cleaned up copy/user stuff
27  *              Tim Hockin      :       Added insmod parameters, comment cleanup
28  *                                      Parameterized timeout
29  *              Tigran Aivazian :       Restructured wdt_init() to handle failures
30  */
31
32 #include <linux/config.h>
33 #include <linux/module.h>
34 #include <linux/version.h>
35 #include <linux/types.h>
36 #include <linux/errno.h>
37 #include <linux/kernel.h>
38 #include <linux/sched.h>
39 #include <linux/smp_lock.h>
40 #include <linux/miscdevice.h>
41 #include <linux/watchdog.h>
42 #include "wd501p.h"
43 #include <linux/slab.h>
44 #include <linux/ioport.h>
45 #include <linux/fcntl.h>
46 #include <asm/io.h>
47 #include <asm/uaccess.h>
48 #include <asm/system.h>
49 #include <linux/notifier.h>
50 #include <linux/reboot.h>
51 #include <linux/init.h>
52
53 static int wdt_is_open;
54
55 /*
56  *      You must set these - there is no sane way to probe for this board.
57  *      You can use wdt=x,y to set these now.
58  */
59  
60 static int io=0x240;
61 static int irq=11;
62
63 #define WD_TIMO (100*60)                /* 1 minute */
64
65 #ifndef MODULE
66
67 /**
68  *      wdt_setup:
69  *      @str: command line string
70  *
71  *      Setup options. The board isn't really probe-able so we have to
72  *      get the user to tell us the configuration. Sane people build it 
73  *      modular but the others come here.
74  */
75  
76 static int __init wdt_setup(char *str)
77 {
78         int ints[4];
79
80         str = get_options (str, ARRAY_SIZE(ints), ints);
81
82         if (ints[0] > 0)
83         {
84                 io = ints[1];
85                 if(ints[0] > 1)
86                         irq = ints[2];
87         }
88
89         return 1;
90 }
91
92 __setup("wdt=", wdt_setup);
93
94 #endif /* !MODULE */
95
96 MODULE_PARM(io, "i");
97 MODULE_PARM_DESC(io, "WDT io port (default=0x240)");
98 MODULE_PARM(irq, "i");
99 MODULE_PARM_DESC(irq, "WDT irq (default=11)");
100  
101 /*
102  *      Programming support
103  */
104  
105 static void wdt_ctr_mode(int ctr, int mode)
106 {
107         ctr<<=6;
108         ctr|=0x30;
109         ctr|=(mode<<1);
110         outb_p(ctr, WDT_CR);
111 }
112
113 static void wdt_ctr_load(int ctr, int val)
114 {
115         outb_p(val&0xFF, WDT_COUNT0+ctr);
116         outb_p(val>>8, WDT_COUNT0+ctr);
117 }
118
119 /*
120  *      Kernel methods.
121  */
122  
123  
124 /**
125  *      wdt_status:
126  *      
127  *      Extract the status information from a WDT watchdog device. There are
128  *      several board variants so we have to know which bits are valid. Some
129  *      bits default to one and some to zero in order to be maximally painful.
130  *
131  *      we then map the bits onto the status ioctl flags.
132  */
133  
134 static int wdt_status(void)
135 {
136         /*
137          *      Status register to bit flags
138          */
139          
140         int flag=0;
141         unsigned char status=inb_p(WDT_SR);
142         status|=FEATUREMAP1;
143         status&=~FEATUREMAP2;   
144         
145         if(!(status&WDC_SR_TGOOD))
146                 flag|=WDIOF_OVERHEAT;
147         if(!(status&WDC_SR_PSUOVER))
148                 flag|=WDIOF_POWEROVER;
149         if(!(status&WDC_SR_PSUUNDR))
150                 flag|=WDIOF_POWERUNDER;
151         if(!(status&WDC_SR_FANGOOD))
152                 flag|=WDIOF_FANFAULT;
153         if(status&WDC_SR_ISOI0)
154                 flag|=WDIOF_EXTERN1;
155         if(status&WDC_SR_ISII1)
156                 flag|=WDIOF_EXTERN2;
157         return flag;
158 }
159
160 /**
161  *      wdt_interrupt:
162  *      @irq:           Interrupt number
163  *      @dev_id:        Unused as we don't allow multiple devices.
164  *      @regs:          Unused.
165  *
166  *      Handle an interrupt from the board. These are raised when the status
167  *      map changes in what the board considers an interesting way. That means
168  *      a failure condition occuring.
169  */
170  
171 void wdt_interrupt(int irq, void *dev_id, struct pt_regs *regs)
172 {
173         /*
174          *      Read the status register see what is up and
175          *      then printk it. 
176          */
177          
178         unsigned char status=inb_p(WDT_SR);
179         
180         status|=FEATUREMAP1;
181         status&=~FEATUREMAP2;   
182         
183         printk(KERN_CRIT "WDT status %d\n", status);
184         
185         if(!(status&WDC_SR_TGOOD))
186                 printk(KERN_CRIT "Overheat alarm.(%d)\n",inb_p(WDT_RT));
187         if(!(status&WDC_SR_PSUOVER))
188                 printk(KERN_CRIT "PSU over voltage.\n");
189         if(!(status&WDC_SR_PSUUNDR))
190                 printk(KERN_CRIT "PSU under voltage.\n");
191         if(!(status&WDC_SR_FANGOOD))
192                 printk(KERN_CRIT "Possible fan fault.\n");
193         if(!(status&WDC_SR_WCCR))
194 #ifdef SOFTWARE_REBOOT
195 #ifdef ONLY_TESTING
196                 printk(KERN_CRIT "Would Reboot.\n");
197 #else           
198                 printk(KERN_CRIT "Initiating system reboot.\n");
199                 machine_restart(NULL);
200 #endif          
201 #else
202                 printk(KERN_CRIT "Reset in 5ms.\n");
203 #endif          
204 }
205
206
207 /**
208  *      wdt_ping:
209  *
210  *      Reload counter one with the watchdog timeout. We don't bother reloading
211  *      the cascade counter. 
212  */
213  
214 static void wdt_ping(void)
215 {
216         /* Write a watchdog value */
217         inb_p(WDT_DC);
218         wdt_ctr_mode(1,2);
219         wdt_ctr_load(1,WD_TIMO);                /* Timeout */
220         outb_p(0, WDT_DC);
221 }
222
223 /**
224  *      wdt_write:
225  *      @file: file handle to the watchdog
226  *      @buf: buffer to write (unused as data does not matter here 
227  *      @count: count of bytes
228  *      @ppos: pointer to the position to write. No seeks allowed
229  *
230  *      A write to a watchdog device is defined as a keepalive signal. Any
231  *      write of data will do, as we we don't define content meaning.
232  */
233  
234 static ssize_t wdt_write(struct file *file, const char *buf, size_t count, loff_t *ppos)
235 {
236         /*  Can't seek (pwrite) on this device  */
237         if (ppos != &file->f_pos)
238                 return -ESPIPE;
239
240         if(count)
241         {
242                 wdt_ping();
243                 return 1;
244         }
245         return 0;
246 }
247
248 /**
249  *      wdt_read:
250  *      @file: file handle to the watchdog board
251  *      @buf: buffer to write 1 byte into
252  *      @count: length of buffer
253  *      @ptr: offset (no seek allowed)
254  *
255  *      Read reports the temperature in degrees Fahrenheit. The API is in
256  *      farenheit. It was designed by an imperial measurement luddite.
257  */
258  
259 static ssize_t wdt_read(struct file *file, char *buf, size_t count, loff_t *ptr)
260 {
261         unsigned short c=inb_p(WDT_RT);
262         unsigned char cp;
263         
264         /*  Can't seek (pread) on this device  */
265         if (ptr != &file->f_pos)
266                 return -ESPIPE;
267
268         switch(MINOR(file->f_dentry->d_inode->i_rdev))
269         {
270                 case TEMP_MINOR:
271                         c*=11;
272                         c/=15;
273                         cp=c+7;
274                         if(copy_to_user(buf,&cp,1))
275                                 return -EFAULT;
276                         return 1;
277                 default:
278                         return -EINVAL;
279         }
280 }
281
282 /**
283  *      wdt_ioctl:
284  *      @inode: inode of the device
285  *      @file: file handle to the device
286  *      @cmd: watchdog command
287  *      @arg: argument pointer
288  *
289  *      The watchdog API defines a common set of functions for all watchdogs
290  *      according to their available features. We only actually usefully support
291  *      querying capabilities and current status. 
292  */
293  
294 static int wdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
295         unsigned long arg)
296 {
297         static struct watchdog_info ident=
298         {
299                 WDIOF_OVERHEAT|WDIOF_POWERUNDER|WDIOF_POWEROVER
300                         |WDIOF_EXTERN1|WDIOF_EXTERN2|WDIOF_FANFAULT,
301                 1,
302                 "WDT500/501"
303         };
304         
305         ident.options&=WDT_OPTION_MASK; /* Mask down to the card we have */
306         switch(cmd)
307         {
308                 default:
309                         return -ENOTTY;
310                 case WDIOC_GETSUPPORT:
311                         return copy_to_user((struct watchdog_info *)arg, &ident, sizeof(ident))?-EFAULT:0;
312
313                 case WDIOC_GETSTATUS:
314                         return put_user(wdt_status(),(int *)arg);
315                 case WDIOC_GETBOOTSTATUS:
316                         return put_user(0, (int *)arg);
317                 case WDIOC_KEEPALIVE:
318                         wdt_ping();
319                         return 0;
320         }
321 }
322
323 /**
324  *      wdt_open:
325  *      @inode: inode of device
326  *      @file: file handle to device
327  *
328  *      One of our two misc devices has been opened. The watchdog device is
329  *      single open and on opening we load the counters. Counter zero is a 
330  *      100Hz cascade, into counter 1 which downcounts to reboot. When the
331  *      counter triggers counter 2 downcounts the length of the reset pulse
332  *      which set set to be as long as possible. 
333  */
334  
335 static int wdt_open(struct inode *inode, struct file *file)
336 {
337         switch(MINOR(inode->i_rdev))
338         {
339                 case WATCHDOG_MINOR:
340                         if(wdt_is_open)
341                                 return -EBUSY;
342                         /*
343                          *      Activate 
344                          */
345          
346                         wdt_is_open=1;
347                         inb_p(WDT_DC);          /* Disable */
348                         wdt_ctr_mode(0,3);
349                         wdt_ctr_mode(1,2);
350                         wdt_ctr_mode(2,0);
351                         wdt_ctr_load(0, 8948);          /* count at 100Hz */
352                         wdt_ctr_load(1,WD_TIMO);        /* Timeout 120 seconds */
353                         wdt_ctr_load(2,65535);
354                         outb_p(0, WDT_DC);      /* Enable */
355                         return 0;
356                 case TEMP_MINOR:
357                         return 0;
358                 default:
359                         return -ENODEV;
360         }
361 }
362
363 /**
364  *      wdt_close:
365  *      @inode: inode to board
366  *      @file: file handle to board
367  *
368  *      The watchdog has a configurable API. There is a religious dispute 
369  *      between people who want their watchdog to be able to shut down and 
370  *      those who want to be sure if the watchdog manager dies the machine
371  *      reboots. In the former case we disable the counters, in the latter
372  *      case you have to open it again very soon.
373  */
374  
375 static int wdt_release(struct inode *inode, struct file *file)
376 {
377         lock_kernel();
378         if(MINOR(inode->i_rdev)==WATCHDOG_MINOR)
379         {
380 #ifndef CONFIG_WATCHDOG_NOWAYOUT        
381                 inb_p(WDT_DC);          /* Disable counters */
382                 wdt_ctr_load(2,0);      /* 0 length reset pulses now */
383 #endif          
384                 wdt_is_open=0;
385         }
386         unlock_kernel();
387         return 0;
388 }
389
390 /**
391  *      notify_sys:
392  *      @this: our notifier block
393  *      @code: the event being reported
394  *      @unused: unused
395  *
396  *      Our notifier is called on system shutdowns. We want to turn the card
397  *      off at reboot otherwise the machine will reboot again during memory
398  *      test or worse yet during the following fsck. This would suck, in fact
399  *      trust me - if it happens it does suck.
400  */
401
402 static int wdt_notify_sys(struct notifier_block *this, unsigned long code,
403         void *unused)
404 {
405         if(code==SYS_DOWN || code==SYS_HALT)
406         {
407                 /* Turn the card off */
408                 inb_p(WDT_DC);
409                 wdt_ctr_load(2,0);
410         }
411         return NOTIFY_DONE;
412 }
413  
414 /*
415  *      Kernel Interfaces
416  */
417  
418  
419 static struct file_operations wdt_fops = {
420         owner:          THIS_MODULE,
421         llseek:         no_llseek,
422         read:           wdt_read,
423         write:          wdt_write,
424         ioctl:          wdt_ioctl,
425         open:           wdt_open,
426         release:        wdt_release,
427 };
428
429 static struct miscdevice wdt_miscdev=
430 {
431         WATCHDOG_MINOR,
432         "watchdog",
433         &wdt_fops
434 };
435
436 #ifdef CONFIG_WDT_501
437 static struct miscdevice temp_miscdev=
438 {
439         TEMP_MINOR,
440         "temperature",
441         &wdt_fops
442 };
443 #endif
444
445 /*
446  *      The WDT card needs to learn about soft shutdowns in order to
447  *      turn the timebomb registers off. 
448  */
449  
450 static struct notifier_block wdt_notifier=
451 {
452         wdt_notify_sys,
453         NULL,
454         0
455 };
456
457 /**
458  *      cleanup_module:
459  *
460  *      Unload the watchdog. You cannot do this with any file handles open.
461  *      If your watchdog is set to continue ticking on close and you unload
462  *      it, well it keeps ticking. We won't get the interrupt but the board
463  *      will not touch PC memory so all is fine. You just have to load a new
464  *      module in 60 seconds or reboot.
465  */
466  
467 static void __exit wdt_exit(void)
468 {
469         misc_deregister(&wdt_miscdev);
470 #ifdef CONFIG_WDT_501   
471         misc_deregister(&temp_miscdev);
472 #endif  
473         unregister_reboot_notifier(&wdt_notifier);
474         release_region(io,8);
475         free_irq(irq, NULL);
476 }
477
478 /**
479  *      wdt_init:
480  *
481  *      Set up the WDT watchdog board. All we have to do is grab the
482  *      resources we require and bitch if anyone beat us to them.
483  *      The open() function will actually kick the board off.
484  */
485  
486 static int __init wdt_init(void)
487 {
488         int ret;
489
490         ret = misc_register(&wdt_miscdev);
491         if (ret) {
492                 printk(KERN_ERR "wdt: can't misc_register on minor=%d\n", WATCHDOG_MINOR);
493                 goto out;
494         }
495         ret = request_irq(irq, wdt_interrupt, SA_INTERRUPT, "wdt501p", NULL);
496         if(ret) {
497                 printk(KERN_ERR "wdt: IRQ %d is not free.\n", irq);
498                 goto outmisc;
499         }
500         if (!request_region(io, 8, "wdt501p")) {
501                 printk(KERN_ERR "wdt: IO %X is not free.\n", io);
502                 ret = -EBUSY;
503                 goto outirq;
504         }
505         ret = register_reboot_notifier(&wdt_notifier);
506         if(ret) {
507                 printk(KERN_ERR "wdt: can't register reboot notifier (err=%d)\n", ret);
508                 goto outreg;
509         }
510
511 #ifdef CONFIG_WDT_501
512         ret = misc_register(&temp_miscdev);
513         if (ret) {
514                 printk(KERN_ERR "wdt: can't misc_register (temp) on minor=%d\n", TEMP_MINOR);
515                 goto outrbt;
516         }
517 #endif
518
519         ret = 0;
520         printk(KERN_INFO "WDT500/501-P driver 0.07 at %X (Interrupt %d)\n", io, irq);
521 out:
522         return ret;
523
524 #ifdef CONFIG_WDT_501
525 outrbt:
526         unregister_reboot_notifier(&wdt_notifier);
527 #endif
528
529 outreg:
530         release_region(io,8);
531 outirq:
532         free_irq(irq, NULL);
533 outmisc:
534         misc_deregister(&wdt_miscdev);
535         goto out;
536 }
537
538 module_init(wdt_init);
539 module_exit(wdt_exit);
540