2 * Berkshire PCI-PC Watchdog Card Driver
4 * (c) Copyright 2003 Wim Van Sebroeck <wim@iguana.be>.
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>
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.
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.
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/
29 * Includes, defines, variables, module parameters, ...
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>
43 #include <linux/pci.h>
44 #include <linux/ioport.h>
45 #include <linux/spinlock.h>
47 #include <asm/uaccess.h>
50 /* Module and version information */
51 #define WATCHDOG_VERSION "1.00"
52 #define WATCHDOG_DATE "13/03/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"
58 /* Stuff for the PCI ID's */
59 #ifndef PCI_VENDOR_ID_QUICKLOGIC
60 #define PCI_VENDOR_ID_QUICKLOGIC 0x11e3
63 #ifndef PCI_DEVICE_ID_WATCHDOG_PCIPCWD
64 #define PCI_DEVICE_ID_WATCHDOG_PCIPCWD 0x5030
68 * These are the defines that describe the control status bits for the
69 * PCI-PC Watchdog card.
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 */
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
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
85 /* We can only use 1 card due to the /dev/watchdog restriction */
86 static int cards_found;
88 /* internal variables */
89 static int temp_panic;
90 static unsigned long is_active;
91 static char expect_release;
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 */
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) ")");
106 #ifdef CONFIG_WATCHDOG_NOWAYOUT
107 static int nowayout = 1;
109 static int nowayout = 0;
112 module_param(nowayout, int, 0);
113 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
119 static int send_command(int cmd, int *msb, int *lsb)
121 int got_response, count;
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
128 * After the required data has been written then write the command to
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);
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++) {
140 got_response = inb_p(pcipcwd_private.io_addr + 2) & 0x40;
144 /* read back response */
145 *lsb = inb_p(pcipcwd_private.io_addr + 4);
146 *msb = inb_p(pcipcwd_private.io_addr + 5);
149 inb_p(pcipcwd_private.io_addr + 6);
151 spin_unlock(&pcipcwd_private.io_lock);
156 static int pcipcwd_start(void)
160 spin_lock(&pcipcwd_private.io_lock);
161 outb_p(0x00, pcipcwd_private.io_addr + 3);
164 stat_reg = inb_p(pcipcwd_private.io_addr + 2);
165 spin_unlock(&pcipcwd_private.io_lock);
167 if (stat_reg & 0x10) {
168 printk(KERN_ERR PFX "Card timer not enabled\n");
175 static int pcipcwd_stop(void)
179 spin_lock(&pcipcwd_private.io_lock);
180 outb_p(0xA5, pcipcwd_private.io_addr + 3);
183 outb_p(0xA5, pcipcwd_private.io_addr + 3);
186 stat_reg = inb_p(pcipcwd_private.io_addr + 2);
187 spin_unlock(&pcipcwd_private.io_lock);
189 if (!(stat_reg & 0x10)) {
190 printk(KERN_ERR PFX "Card did not acknowledge disable attempt\n");
197 static int pcipcwd_keepalive(void)
199 /* Re-trigger watchdog by writing to port 0 */
200 outb_p(0x42, pcipcwd_private.io_addr);
204 static int pcipcwd_set_heartbeat(int t)
209 if ((t < 0x0001) || (t > 0xFFFF))
212 /* Write new heartbeat to watchdog */
213 send_command(CMD_WRITE_WATCHDOG_TIMEOUT, &t_msb, &t_lsb);
219 static int pcipcwd_get_status(int *status)
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;
230 panic(PFX "Temperature overheat trip!\n");
236 static int pcipcwd_clear_status(void)
238 outb_p(0x01, pcipcwd_private.io_addr + 1);
242 static int pcipcwd_get_temperature(int *temperature)
245 if (!pcipcwd_private.supports_temp)
249 * Convert celsius to fahrenheit, since this was
250 * the decided 'standard' for this return value.
252 *temperature = ((inb_p(pcipcwd_private.io_addr)) * 9 / 5) + 32;
258 * /dev/watchdog handling
261 static ssize_t pcipcwd_write(struct file *file, const char *data,
262 size_t len, loff_t *ppos)
264 /* Can't seek (pwrite) on this device */
265 if (ppos != &file->f_pos)
268 /* See if we got the magic character 'V' and reload the timer */
273 /* note: just in case someone wrote the magic character
274 * five months ago... */
277 /* scan to see whether or not we got the magic character */
278 for (i = 0; i != len; i++) {
280 if(get_user(c, data+i))
287 /* someone wrote to us, we should reload the timer */
293 static int pcipcwd_ioctl(struct inode *inode, struct file *file,
294 unsigned int cmd, unsigned long arg)
296 static struct watchdog_info ident = {
297 .options = WDIOF_OVERHEAT |
299 WDIOF_KEEPALIVEPING |
302 .firmware_version = 1,
303 .identity = WATCHDOG_DRIVER_NAME,
307 case WDIOC_GETSUPPORT:
308 return copy_to_user((struct watchdog_info *) arg, &ident,
309 sizeof (ident)) ? -EFAULT : 0;
311 case WDIOC_GETSTATUS:
315 pcipcwd_get_status(&status);
317 return put_user(status, (int *) arg);
320 case WDIOC_GETBOOTSTATUS:
321 return put_user(pcipcwd_private.boot_status, (int *) arg);
327 if (pcipcwd_get_temperature(&temperature))
330 return put_user(temperature, (int *) arg);
333 case WDIOC_KEEPALIVE:
337 case WDIOC_SETOPTIONS:
339 int new_options, retval = -EINVAL;
341 if (get_user (new_options, (int *) arg))
344 if (new_options & WDIOS_DISABLECARD) {
349 if (new_options & WDIOS_ENABLECARD) {
354 if (new_options & WDIOS_TEMPPANIC) {
362 case WDIOC_SETTIMEOUT:
366 if (get_user(new_heartbeat, (int *) arg))
369 if (pcipcwd_set_heartbeat(new_heartbeat))
376 case WDIOC_GETTIMEOUT:
377 return put_user(heartbeat, (int *)arg);
384 static int pcipcwd_open(struct inode *inode, struct file *file)
386 /* /dev/watchdog can only be opened once */
387 if (test_and_set_bit(0, &is_active))
396 static int pcipcwd_release(struct inode *inode, struct file *file)
399 * Shut off the timer.
401 if (expect_release == 42) {
404 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
407 clear_bit(0, &is_active);
413 * /dev/temperature handling
416 static ssize_t pcipcwd_temp_read(struct file *file, char *data,
417 size_t len, loff_t *ppos)
421 /* Can't seek (pwrite) on this device */
422 if (ppos != &file->f_pos)
425 if (pcipcwd_get_temperature(&temperature))
428 if (copy_to_user (data, &temperature, 1))
434 static int pcipcwd_temp_open(struct inode *inode, struct file *file)
436 if (!pcipcwd_private.supports_temp)
442 static int pcipcwd_temp_release(struct inode *inode, struct file *file)
451 static int pcipcwd_notify_sys(struct notifier_block *this, unsigned long code, void *unused)
453 if (code==SYS_DOWN || code==SYS_HALT) {
454 /* Turn the WDT off */
465 static struct file_operations pcipcwd_fops = {
466 .owner = THIS_MODULE,
468 .write = pcipcwd_write,
469 .ioctl = pcipcwd_ioctl,
470 .open = pcipcwd_open,
471 .release = pcipcwd_release,
474 static struct miscdevice pcipcwd_miscdev = {
475 .minor = WATCHDOG_MINOR,
477 .fops = &pcipcwd_fops,
480 static struct file_operations pcipcwd_temp_fops = {
481 .owner = THIS_MODULE,
483 .read = pcipcwd_temp_read,
484 .open = pcipcwd_temp_open,
485 .release = pcipcwd_temp_release,
488 static struct miscdevice pcipcwd_temp_miscdev = {
490 .name = "temperature",
491 .fops = &pcipcwd_temp_fops,
494 static struct notifier_block pcipcwd_notifier = {
495 .notifier_call = pcipcwd_notify_sys,
499 * Init & exit routines
502 static inline void check_temperature_support(void)
504 if (inb_p(pcipcwd_private.io_addr) != 0xF0)
505 pcipcwd_private.supports_temp = 1;
508 static int __devinit pcipcwd_card_init(struct pci_dev *pdev,
509 const struct pci_device_id *ent)
512 int got_fw_rev, fw_rev_major, fw_rev_minor;
514 char option_switches;
517 if (cards_found == 1)
518 printk(KERN_INFO PFX DRIVER_VERSION);
520 if (cards_found > 1) {
521 printk(KERN_ERR PFX "This driver only supports 1 device\n");
525 if (pci_enable_device(pdev)) {
526 printk(KERN_ERR PFX "Not possible to enable PCI Device\n");
530 if (pci_resource_start(pdev, 0) == 0x0000) {
531 printk(KERN_ERR PFX "No I/O-Address for card detected\n");
533 goto err_out_disable_device;
536 pcipcwd_private.pdev = pdev;
537 pcipcwd_private.io_addr = pci_resource_start(pdev, 0);
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);
543 goto err_out_disable_device;
546 /* get the boot_status */
547 pcipcwd_get_status(&pcipcwd_private.boot_status);
549 /* clear the "card caused reboot" flag */
550 pcipcwd_clear_status();
555 /* Check whether or not the card supports the temperature device */
556 check_temperature_support();
558 /* Get the Firmware Version */
559 got_fw_rev = send_command(CMD_GET_FIRMWARE_VERSION, &fw_rev_major, &fw_rev_minor);
561 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
563 sprintf(fw_ver_str, "<card no answer>");
566 /* Get switch settings */
567 option_switches = inb_p(pcipcwd_private.io_addr + 3);
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"));
573 printk(KERN_INFO PFX "Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
575 ((option_switches & 0x10) ? "ON" : "OFF"),
576 ((option_switches & 0x08) ? "ON" : "OFF"));
578 if (pcipcwd_private.boot_status & WDIOF_CARDRESET)
579 printk(KERN_INFO PFX "Previous reset was caused by the Watchdog card\n");
581 if (pcipcwd_private.boot_status & WDIOF_OVERHEAT)
582 printk(KERN_INFO PFX "Card sensed a CPU Overheat\n");
584 if (pcipcwd_private.boot_status == 0)
585 printk(KERN_INFO PFX "No previous trip detected - Cold boot or reset\n");
587 /* Check that the heartbeat value is within it's range ; if not reset to the default */
588 if (heartbeat < 1 || heartbeat > 0xFFFF) {
589 heartbeat = WATCHDOG_HEARTBEAT;
590 printk(KERN_INFO PFX "heartbeat value must be 0<heartbeat<65536, using %d\n",
594 /* Calculate the watchdog's heartbeat */
595 pcipcwd_set_heartbeat(heartbeat);
597 ret = register_reboot_notifier(&pcipcwd_notifier);
599 printk(KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
601 goto err_out_release_region;
604 ret = misc_register(&pcipcwd_miscdev);
606 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
607 WATCHDOG_MINOR, ret);
608 goto err_out_unregister_reboot;
611 if (pcipcwd_private.supports_temp) {
612 ret = misc_register(&pcipcwd_temp_miscdev);
614 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
616 goto err_out_misc_deregister;
620 printk(KERN_INFO PFX "initialized. heartbeat=%d sec (nowayout=%d)\n",
621 heartbeat, nowayout);
625 err_out_misc_deregister:
626 misc_deregister(&pcipcwd_miscdev);
627 err_out_unregister_reboot:
628 unregister_reboot_notifier(&pcipcwd_notifier);
629 err_out_release_region:
630 pci_release_regions(pdev);
631 err_out_disable_device:
632 pci_disable_device(pdev);
636 static void __devexit pcipcwd_card_exit(struct pci_dev *pdev)
638 /* Stop the timer before we leave */
643 if (pcipcwd_private.supports_temp)
644 misc_deregister(&pcipcwd_temp_miscdev);
645 misc_deregister(&pcipcwd_miscdev);
646 unregister_reboot_notifier(&pcipcwd_notifier);
647 pci_release_regions(pdev);
648 pci_disable_device(pdev);
652 static struct pci_device_id pcipcwd_pci_tbl[] = {
653 { PCI_VENDOR_ID_QUICKLOGIC, PCI_DEVICE_ID_WATCHDOG_PCIPCWD,
654 PCI_ANY_ID, PCI_ANY_ID, },
655 { 0 }, /* End of list */
657 MODULE_DEVICE_TABLE(pci, pcipcwd_pci_tbl);
659 static struct pci_driver pcipcwd_driver = {
660 .name = WATCHDOG_NAME,
661 .id_table = pcipcwd_pci_tbl,
662 .probe = pcipcwd_card_init,
663 .remove = __devexit_p(pcipcwd_card_exit),
666 static int __init pcipcwd_init_module(void)
668 spin_lock_init (&pcipcwd_private.io_lock);
670 return pci_module_init(&pcipcwd_driver);
673 static void __exit pcipcwd_cleanup_module(void)
675 pci_unregister_driver(&pcipcwd_driver);
678 module_init(pcipcwd_init_module);
679 module_exit(pcipcwd_cleanup_module);
681 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
682 MODULE_DESCRIPTION("Berkshire PCI-PC Watchdog driver");
683 MODULE_LICENSE("GPL");
684 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
685 MODULE_ALIAS_MISCDEV(TEMP_MINOR);