patch-2_6_7-vs1_9_1_12
[linux-2.6.git] / drivers / char / watchdog / pcwd_pci.c
1 /*
2  *      Berkshire PCI-PC Watchdog Card Driver
3  *
4  *      (c) Copyright 2003 Wim Van Sebroeck <wim@iguana.be>.
5  *
6  *      Based on source code of the following authors:
7  *        Ken Hollis <kenji@bitgate.com>,
8  *        Lindsay Harris <lindsay@bluegum.com>,
9  *        Alan Cox <alan@redhat.com>,
10  *        Matt Domsch <Matt_Domsch@dell.com>,
11  *        Rob Radez <rob@osinvestor.com>
12  *
13  *      This program is free software; you can redistribute it and/or
14  *      modify it under the terms of the GNU General Public License
15  *      as published by the Free Software Foundation; either version
16  *      2 of the License, or (at your option) any later version.
17  *
18  *      Neither Wim Van Sebroeck nor Iguana vzw. admit liability nor
19  *      provide warranty for any of this software. This material is
20  *      provided "AS-IS" and at no charge.
21  */
22
23 /*
24  *      A bells and whistles driver is available from http://www.pcwd.de/
25  *      More info available at http://www.berkprod.com/ or http://www.pcwatchdog.com/
26  */
27
28 /*
29  *      Includes, defines, variables, module parameters, ...
30  */
31
32 #include <linux/config.h>
33 #include <linux/module.h>
34 #include <linux/moduleparam.h>
35 #include <linux/types.h>
36 #include <linux/delay.h>
37 #include <linux/miscdevice.h>
38 #include <linux/watchdog.h>
39 #include <linux/notifier.h>
40 #include <linux/reboot.h>
41 #include <linux/init.h>
42 #include <linux/fs.h>
43 #include <linux/pci.h>
44 #include <linux/ioport.h>
45 #include <linux/spinlock.h>
46
47 #include <asm/uaccess.h>
48 #include <asm/io.h>
49
50 /* Module and version information */
51 #define WATCHDOG_VERSION "1.00"
52 #define WATCHDOG_DATE "12 Jun 2004"
53 #define WATCHDOG_DRIVER_NAME "PCI-PC Watchdog"
54 #define WATCHDOG_NAME "pcwd_pci"
55 #define PFX WATCHDOG_NAME ": "
56 #define DRIVER_VERSION WATCHDOG_DRIVER_NAME " driver, v" WATCHDOG_VERSION " (" WATCHDOG_DATE ")\n"
57
58 /* Stuff for the PCI ID's  */
59 #ifndef PCI_VENDOR_ID_QUICKLOGIC
60 #define PCI_VENDOR_ID_QUICKLOGIC    0x11e3
61 #endif
62
63 #ifndef PCI_DEVICE_ID_WATCHDOG_PCIPCWD
64 #define PCI_DEVICE_ID_WATCHDOG_PCIPCWD 0x5030
65 #endif
66
67 /*
68  * These are the defines that describe the control status bits for the
69  * PCI-PC Watchdog card.
70  */
71 #define WD_PCI_WTRP             0x01    /* Watchdog Trip status */
72 #define WD_PCI_HRBT             0x02    /* Watchdog Heartbeat */
73 #define WD_PCI_TTRP             0x04    /* Temperature Trip status */
74
75 /* according to documentation max. time to process a command for the pci
76  * watchdog card is 100 ms, so we give it 150 ms to do it's job */
77 #define PCI_COMMAND_TIMEOUT     150
78
79 /* Watchdog's internal commands */
80 #define CMD_GET_STATUS                  0x04
81 #define CMD_GET_FIRMWARE_VERSION        0x08
82 #define CMD_READ_WATCHDOG_TIMEOUT       0x18
83 #define CMD_WRITE_WATCHDOG_TIMEOUT      0x19
84
85 /* We can only use 1 card due to the /dev/watchdog restriction */
86 static int cards_found;
87
88 /* internal variables */
89 static int temp_panic;
90 static unsigned long is_active;
91 static char expect_release;
92 static struct {
93         int supports_temp;      /* Wether or not the card has a temperature device */
94         int boot_status;        /* The card's boot status */
95         unsigned long io_addr;  /* The cards I/O address */
96         spinlock_t io_lock;
97         struct pci_dev *pdev;
98 } pcipcwd_private;
99
100 /* module parameters */
101 #define WATCHDOG_HEARTBEAT 2    /* 2 sec default heartbeat */
102 static int heartbeat = WATCHDOG_HEARTBEAT;
103 module_param(heartbeat, int, 0);
104 MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. (0<heartbeat<65536, default=" __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
105
106 #ifdef CONFIG_WATCHDOG_NOWAYOUT
107 static int nowayout = 1;
108 #else
109 static int nowayout = 0;
110 #endif
111
112 module_param(nowayout, int, 0);
113 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
114
115 /*
116  *      Internal functions
117  */
118
119 static int send_command(int cmd, int *msb, int *lsb)
120 {
121         int got_response, count;
122
123         spin_lock(&pcipcwd_private.io_lock);
124         /* If a command requires data it should be written first.
125          * Data for commands with 8 bits of data should be written to port 4.
126          * Commands with 16 bits of data, should be written as LSB to port 4
127          * and MSB to port 5.
128          * After the required data has been written then write the command to
129          * port 6. */
130         outb_p(*lsb, pcipcwd_private.io_addr + 4);
131         outb_p(*msb, pcipcwd_private.io_addr + 5);
132         outb_p(cmd, pcipcwd_private.io_addr + 6);
133
134         /* wait till the pci card processed the command, signaled by
135          * the WRSP bit in port 2 and give it a max. timeout of
136          * PCI_COMMAND_TIMEOUT to process */
137         got_response = inb_p(pcipcwd_private.io_addr + 2) & 0x40;
138         for (count = 0; (count < PCI_COMMAND_TIMEOUT) && (!got_response); count++) {
139                 mdelay(1);
140                 got_response = inb_p(pcipcwd_private.io_addr + 2) & 0x40;
141         }
142
143         if (got_response) {
144                 /* read back response */
145                 *lsb = inb_p(pcipcwd_private.io_addr + 4);
146                 *msb = inb_p(pcipcwd_private.io_addr + 5);
147
148                 /* clear WRSP bit */
149                 inb_p(pcipcwd_private.io_addr + 6);
150         }
151         spin_unlock(&pcipcwd_private.io_lock);
152
153         return got_response;
154 }
155
156 static int pcipcwd_start(void)
157 {
158         int stat_reg;
159
160         spin_lock(&pcipcwd_private.io_lock);
161         outb_p(0x00, pcipcwd_private.io_addr + 3);
162         udelay(1000);
163
164         stat_reg = inb_p(pcipcwd_private.io_addr + 2);
165         spin_unlock(&pcipcwd_private.io_lock);
166
167         if (stat_reg & 0x10) {
168                 printk(KERN_ERR PFX "Card timer not enabled\n");
169                 return -1;
170         }
171
172         return 0;
173 }
174
175 static int pcipcwd_stop(void)
176 {
177         int stat_reg;
178
179         spin_lock(&pcipcwd_private.io_lock);
180         outb_p(0xA5, pcipcwd_private.io_addr + 3);
181         udelay(1000);
182
183         outb_p(0xA5, pcipcwd_private.io_addr + 3);
184         udelay(1000);
185
186         stat_reg = inb_p(pcipcwd_private.io_addr + 2);
187         spin_unlock(&pcipcwd_private.io_lock);
188
189         if (!(stat_reg & 0x10)) {
190                 printk(KERN_ERR PFX "Card did not acknowledge disable attempt\n");
191                 return -1;
192         }
193
194         return 0;
195 }
196
197 static int pcipcwd_keepalive(void)
198 {
199         /* Re-trigger watchdog by writing to port 0 */
200         outb_p(0x42, pcipcwd_private.io_addr);
201         return 0;
202 }
203
204 static int pcipcwd_set_heartbeat(int t)
205 {
206         int t_msb = t / 256;
207         int t_lsb = t % 256;
208
209         if ((t < 0x0001) || (t > 0xFFFF))
210                 return -EINVAL;
211
212         /* Write new heartbeat to watchdog */
213         send_command(CMD_WRITE_WATCHDOG_TIMEOUT, &t_msb, &t_lsb);
214
215         heartbeat = t;
216         return 0;
217 }
218
219 static int pcipcwd_get_status(int *status)
220 {
221         int new_status;
222
223         *status=0;
224         new_status = inb_p(pcipcwd_private.io_addr + 1);
225         if (new_status & WD_PCI_WTRP)
226                 *status |= WDIOF_CARDRESET;
227         if (new_status & WD_PCI_TTRP) {
228                 *status |= WDIOF_OVERHEAT;
229                 if (temp_panic)
230                         panic(PFX "Temperature overheat trip!\n");
231         }
232
233         return 0;
234 }
235
236 static int pcipcwd_clear_status(void)
237 {
238         outb_p(0x01, pcipcwd_private.io_addr + 1);
239         return 0;
240 }
241
242 static int pcipcwd_get_temperature(int *temperature)
243 {
244         *temperature = 0;
245         if (!pcipcwd_private.supports_temp)
246                 return -ENODEV;
247
248         /*
249          * Convert celsius to fahrenheit, since this was
250          * the decided 'standard' for this return value.
251          */
252         *temperature = ((inb_p(pcipcwd_private.io_addr)) * 9 / 5) + 32;
253
254         return 0;
255 }
256
257 /*
258  *      /dev/watchdog handling
259  */
260
261 static ssize_t pcipcwd_write(struct file *file, const char *data,
262                               size_t len, loff_t *ppos)
263 {
264         /* Can't seek (pwrite) on this device  */
265         if (ppos != &file->f_pos)
266                 return -ESPIPE;
267
268         /* See if we got the magic character 'V' and reload the timer */
269         if (len) {
270                 if (!nowayout) {
271                         size_t i;
272
273                         /* note: just in case someone wrote the magic character
274                          * five months ago... */
275                         expect_release = 0;
276
277                         /* scan to see whether or not we got the magic character */
278                         for (i = 0; i != len; i++) {
279                                 char c;
280                                 if(get_user(c, data+i))
281                                         return -EFAULT;
282                                 if (c == 'V')
283                                         expect_release = 42;
284                         }
285                 }
286
287                 /* someone wrote to us, we should reload the timer */
288                 pcipcwd_keepalive();
289         }
290         return len;
291 }
292
293 static int pcipcwd_ioctl(struct inode *inode, struct file *file,
294                           unsigned int cmd, unsigned long arg)
295 {
296         static struct watchdog_info ident = {
297                 .options =              WDIOF_OVERHEAT |
298                                         WDIOF_CARDRESET |
299                                         WDIOF_KEEPALIVEPING |
300                                         WDIOF_SETTIMEOUT |
301                                         WDIOF_MAGICCLOSE,
302                 .firmware_version =     1,
303                 .identity =             WATCHDOG_DRIVER_NAME,
304         };
305
306         switch (cmd) {
307                 case WDIOC_GETSUPPORT:
308                         return copy_to_user((struct watchdog_info *) arg, &ident,
309                                 sizeof (ident)) ? -EFAULT : 0;
310
311                 case WDIOC_GETSTATUS:
312                 {
313                         int status;
314
315                         pcipcwd_get_status(&status);
316
317                         return put_user(status, (int *) arg);
318                 }
319
320                 case WDIOC_GETBOOTSTATUS:
321                         return put_user(pcipcwd_private.boot_status, (int *) arg);
322
323                 case WDIOC_GETTEMP:
324                 {
325                         int temperature;
326
327                         if (pcipcwd_get_temperature(&temperature))
328                                 return -EFAULT;
329
330                         return put_user(temperature, (int *) arg);
331                 }
332
333                 case WDIOC_KEEPALIVE:
334                         pcipcwd_keepalive();
335                         return 0;
336
337                 case WDIOC_SETOPTIONS:
338                 {
339                         int new_options, retval = -EINVAL;
340
341                         if (get_user (new_options, (int *) arg))
342                                 return -EFAULT;
343
344                         if (new_options & WDIOS_DISABLECARD) {
345                                 pcipcwd_stop();
346                                 retval = 0;
347                         }
348
349                         if (new_options & WDIOS_ENABLECARD) {
350                                 pcipcwd_start();
351                                 retval = 0;
352                         }
353
354                         if (new_options & WDIOS_TEMPPANIC) {
355                                 temp_panic = 1;
356                                 retval = 0;
357                         }
358
359                         return retval;
360                 }
361
362                 case WDIOC_SETTIMEOUT:
363                 {
364                         int new_heartbeat;
365
366                         if (get_user(new_heartbeat, (int *) arg))
367                                 return -EFAULT;
368
369                         if (pcipcwd_set_heartbeat(new_heartbeat))
370                             return -EINVAL;
371
372                         pcipcwd_keepalive();
373                         /* Fall */
374                 }
375
376                 case WDIOC_GETTIMEOUT:
377                         return put_user(heartbeat, (int *)arg);
378
379                 default:
380                         return -ENOIOCTLCMD;
381         }
382 }
383
384 static int pcipcwd_open(struct inode *inode, struct file *file)
385 {
386         /* /dev/watchdog can only be opened once */
387         if (test_and_set_bit(0, &is_active))
388                 return -EBUSY;
389
390         /* Activate */
391         pcipcwd_start();
392         pcipcwd_keepalive();
393         return 0;
394 }
395
396 static int pcipcwd_release(struct inode *inode, struct file *file)
397 {
398         /*
399          *      Shut off the timer.
400          */
401         if (expect_release == 42) {
402                 pcipcwd_stop();
403         } else {
404                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
405                 pcipcwd_keepalive();
406         }
407         expect_release = 0;
408         clear_bit(0, &is_active);
409         return 0;
410 }
411
412 /*
413  *      /dev/temperature handling
414  */
415
416 static ssize_t pcipcwd_temp_read(struct file *file, char *data,
417                                 size_t len, loff_t *ppos)
418 {
419         int temperature;
420
421         /* Can't seek (pwrite) on this device  */
422         if (ppos != &file->f_pos)
423                 return -ESPIPE;
424
425         if (pcipcwd_get_temperature(&temperature))
426                 return -EFAULT;
427
428         if (copy_to_user (data, &temperature, 1))
429                 return -EFAULT;
430
431         return 1;
432 }
433
434 static int pcipcwd_temp_open(struct inode *inode, struct file *file)
435 {
436         if (!pcipcwd_private.supports_temp)
437                 return -ENODEV;
438
439         return 0;
440 }
441
442 static int pcipcwd_temp_release(struct inode *inode, struct file *file)
443 {
444         return 0;
445 }
446
447 /*
448  *      Notify system
449  */
450
451 static int pcipcwd_notify_sys(struct notifier_block *this, unsigned long code, void *unused)
452 {
453         if (code==SYS_DOWN || code==SYS_HALT) {
454                 /* Turn the WDT off */
455                 pcipcwd_stop();
456         }
457
458         return NOTIFY_DONE;
459 }
460
461 /*
462  *      Kernel Interfaces
463  */
464
465 static struct file_operations pcipcwd_fops = {
466         .owner =        THIS_MODULE,
467         .llseek =       no_llseek,
468         .write =        pcipcwd_write,
469         .ioctl =        pcipcwd_ioctl,
470         .open =         pcipcwd_open,
471         .release =      pcipcwd_release,
472 };
473
474 static struct miscdevice pcipcwd_miscdev = {
475         .minor =        WATCHDOG_MINOR,
476         .name =         "watchdog",
477         .fops =         &pcipcwd_fops,
478 };
479
480 static struct file_operations pcipcwd_temp_fops = {
481         .owner =        THIS_MODULE,
482         .llseek =       no_llseek,
483         .read =         pcipcwd_temp_read,
484         .open =         pcipcwd_temp_open,
485         .release =      pcipcwd_temp_release,
486 };
487
488 static struct miscdevice pcipcwd_temp_miscdev = {
489         .minor =        TEMP_MINOR,
490         .name =         "temperature",
491         .fops =         &pcipcwd_temp_fops,
492 };
493
494 static struct notifier_block pcipcwd_notifier = {
495         .notifier_call =        pcipcwd_notify_sys,
496 };
497
498 /*
499  *      Init & exit routines
500  */
501
502 static inline void check_temperature_support(void)
503 {
504         if (inb_p(pcipcwd_private.io_addr) != 0xF0)
505                 pcipcwd_private.supports_temp = 1;
506 }
507
508 static int __devinit pcipcwd_card_init(struct pci_dev *pdev,
509                 const struct pci_device_id *ent)
510 {
511         int ret = -EIO;
512         int got_fw_rev, fw_rev_major, fw_rev_minor;
513         char fw_ver_str[20];
514         char option_switches;
515
516         cards_found++;
517         if (cards_found == 1)
518                 printk(KERN_INFO PFX DRIVER_VERSION);
519
520         if (cards_found > 1) {
521                 printk(KERN_ERR PFX "This driver only supports 1 device\n");
522                 return -ENODEV;
523         }
524
525         if (pci_enable_device(pdev)) {
526                 printk(KERN_ERR PFX "Not possible to enable PCI Device\n");
527                 return -ENODEV;
528         }
529
530         if (pci_resource_start(pdev, 0) == 0x0000) {
531                 printk(KERN_ERR PFX "No I/O-Address for card detected\n");
532                 ret = -ENODEV;
533                 goto err_out_disable_device;
534         }
535
536         pcipcwd_private.pdev = pdev;
537         pcipcwd_private.io_addr = pci_resource_start(pdev, 0);
538
539         if (pci_request_regions(pdev, WATCHDOG_NAME)) {
540                 printk(KERN_ERR PFX "I/O address 0x%04x already in use\n",
541                         (int) pcipcwd_private.io_addr);
542                 ret = -EIO;
543                 goto err_out_disable_device;
544         }
545
546         /* get the boot_status */
547         pcipcwd_get_status(&pcipcwd_private.boot_status);
548
549         /* clear the "card caused reboot" flag */
550         pcipcwd_clear_status();
551
552         /* disable card */
553         pcipcwd_stop();
554
555         /* Check whether or not the card supports the temperature device */
556         check_temperature_support();
557
558         /* Get the Firmware Version */
559         got_fw_rev = send_command(CMD_GET_FIRMWARE_VERSION, &fw_rev_major, &fw_rev_minor);
560         if (got_fw_rev) {
561                 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
562         } else {
563                 sprintf(fw_ver_str, "<card no answer>");
564         }
565
566         /* Get switch settings */
567         option_switches = inb_p(pcipcwd_private.io_addr + 3);
568
569         printk(KERN_INFO PFX "Found card at port 0x%04x (Firmware: %s) %s temp option\n",
570                 (int) pcipcwd_private.io_addr, fw_ver_str,
571                 (pcipcwd_private.supports_temp ? "with" : "without"));
572
573         printk(KERN_INFO PFX "Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
574                 option_switches,
575                 ((option_switches & 0x10) ? "ON" : "OFF"),
576                 ((option_switches & 0x08) ? "ON" : "OFF"));
577
578         if (pcipcwd_private.boot_status & WDIOF_CARDRESET)
579                 printk(KERN_INFO PFX "Previous reset was caused by the Watchdog card\n");
580
581         if (pcipcwd_private.boot_status & WDIOF_OVERHEAT)
582                 printk(KERN_INFO PFX "Card sensed a CPU Overheat\n");
583
584         if (pcipcwd_private.boot_status == 0)
585                 printk(KERN_INFO PFX "No previous trip detected - Cold boot or reset\n");
586
587         /* Check that the heartbeat value is within it's range ; if not reset to the default */
588         if (pcipcwd_set_heartbeat(heartbeat)) {
589                 pcipcwd_set_heartbeat(WATCHDOG_HEARTBEAT);
590                 printk(KERN_INFO PFX "heartbeat value must be 0<heartbeat<65536, using %d\n",
591                         WATCHDOG_HEARTBEAT);
592         }
593
594         ret = register_reboot_notifier(&pcipcwd_notifier);
595         if (ret != 0) {
596                 printk(KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
597                         ret);
598                 goto err_out_release_region;
599         }
600
601         if (pcipcwd_private.supports_temp) {
602                 ret = misc_register(&pcipcwd_temp_miscdev);
603                 if (ret != 0) {
604                         printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
605                                 TEMP_MINOR, ret);
606                         goto err_out_unregister_reboot;
607                 }
608         }
609
610         ret = misc_register(&pcipcwd_miscdev);
611         if (ret != 0) {
612                 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
613                         WATCHDOG_MINOR, ret);
614                 goto err_out_misc_deregister;
615         }
616
617         printk(KERN_INFO PFX "initialized. heartbeat=%d sec (nowayout=%d)\n",
618                 heartbeat, nowayout);
619
620         return 0;
621
622 err_out_misc_deregister:
623         if (pcipcwd_private.supports_temp)
624                 misc_deregister(&pcipcwd_temp_miscdev);
625 err_out_unregister_reboot:
626         unregister_reboot_notifier(&pcipcwd_notifier);
627 err_out_release_region:
628         pci_release_regions(pdev);
629 err_out_disable_device:
630         pci_disable_device(pdev);
631         return ret;
632 }
633
634 static void __devexit pcipcwd_card_exit(struct pci_dev *pdev)
635 {
636         /* Stop the timer before we leave */
637         if (!nowayout)
638                 pcipcwd_stop();
639
640         /* Deregister */
641         misc_deregister(&pcipcwd_miscdev);
642         if (pcipcwd_private.supports_temp)
643                 misc_deregister(&pcipcwd_temp_miscdev);
644         unregister_reboot_notifier(&pcipcwd_notifier);
645         pci_release_regions(pdev);
646         pci_disable_device(pdev);
647         cards_found--;
648 }
649
650 static struct pci_device_id pcipcwd_pci_tbl[] = {
651         { PCI_VENDOR_ID_QUICKLOGIC, PCI_DEVICE_ID_WATCHDOG_PCIPCWD,
652                 PCI_ANY_ID, PCI_ANY_ID, },
653         { 0 },                  /* End of list */
654 };
655 MODULE_DEVICE_TABLE(pci, pcipcwd_pci_tbl);
656
657 static struct pci_driver pcipcwd_driver = {
658         .name           = WATCHDOG_NAME,
659         .id_table       = pcipcwd_pci_tbl,
660         .probe          = pcipcwd_card_init,
661         .remove         = __devexit_p(pcipcwd_card_exit),
662 };
663
664 static int __init pcipcwd_init_module(void)
665 {
666         spin_lock_init (&pcipcwd_private.io_lock);
667
668         return pci_module_init(&pcipcwd_driver);
669 }
670
671 static void __exit pcipcwd_cleanup_module(void)
672 {
673         pci_unregister_driver(&pcipcwd_driver);
674 }
675
676 module_init(pcipcwd_init_module);
677 module_exit(pcipcwd_cleanup_module);
678
679 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
680 MODULE_DESCRIPTION("Berkshire PCI-PC Watchdog driver");
681 MODULE_LICENSE("GPL");
682 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
683 MODULE_ALIAS_MISCDEV(TEMP_MINOR);