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> /* For CONFIG_WATCHDOG_NOWAYOUT/... */
33 #include <linux/module.h> /* For module specific items */
34 #include <linux/moduleparam.h> /* For new moduleparam's */
35 #include <linux/types.h> /* For standard types (like size_t) */
36 #include <linux/errno.h> /* For the -ENODEV/... values */
37 #include <linux/kernel.h> /* For printk/panic/... */
38 #include <linux/delay.h> /* For mdelay function */
39 #include <linux/miscdevice.h> /* For MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR) */
40 #include <linux/watchdog.h> /* For the watchdog specific items */
41 #include <linux/notifier.h> /* For notifier support */
42 #include <linux/reboot.h> /* For reboot_notifier stuff */
43 #include <linux/init.h> /* For __init/__exit/... */
44 #include <linux/fs.h> /* For file operations */
45 #include <linux/pci.h> /* For pci functions */
46 #include <linux/ioport.h> /* For io-port access */
47 #include <linux/spinlock.h> /* For spin_lock/spin_unlock/... */
49 #include <asm/uaccess.h> /* For copy_to_user/put_user/... */
50 #include <asm/io.h> /* For inb/outb/... */
52 /* Module and version information */
53 #define WATCHDOG_VERSION "1.02"
54 #define WATCHDOG_DATE "03 Sep 2005"
55 #define WATCHDOG_DRIVER_NAME "PCI-PC Watchdog"
56 #define WATCHDOG_NAME "pcwd_pci"
57 #define PFX WATCHDOG_NAME ": "
58 #define DRIVER_VERSION WATCHDOG_DRIVER_NAME " driver, v" WATCHDOG_VERSION " (" WATCHDOG_DATE ")\n"
60 /* Stuff for the PCI ID's */
61 #ifndef PCI_VENDOR_ID_QUICKLOGIC
62 #define PCI_VENDOR_ID_QUICKLOGIC 0x11e3
65 #ifndef PCI_DEVICE_ID_WATCHDOG_PCIPCWD
66 #define PCI_DEVICE_ID_WATCHDOG_PCIPCWD 0x5030
70 * These are the defines that describe the control status bits for the
71 * PCI-PC Watchdog card.
73 /* Port 1 : Control Status #1 */
74 #define WD_PCI_WTRP 0x01 /* Watchdog Trip status */
75 #define WD_PCI_HRBT 0x02 /* Watchdog Heartbeat */
76 #define WD_PCI_TTRP 0x04 /* Temperature Trip status */
77 #define WD_PCI_RL2A 0x08 /* Relay 2 Active */
78 #define WD_PCI_RL1A 0x10 /* Relay 1 Active */
79 #define WD_PCI_R2DS 0x40 /* Relay 2 Disable Temperature-trip/reset */
80 #define WD_PCI_RLY2 0x80 /* Activate Relay 2 on the board */
81 /* Port 2 : Control Status #2 */
82 #define WD_PCI_WDIS 0x10 /* Watchdog Disable */
83 #define WD_PCI_ENTP 0x20 /* Enable Temperature Trip Reset */
84 #define WD_PCI_WRSP 0x40 /* Watchdog wrote response */
85 #define WD_PCI_PCMD 0x80 /* PC has sent command */
87 /* according to documentation max. time to process a command for the pci
88 * watchdog card is 100 ms, so we give it 150 ms to do it's job */
89 #define PCI_COMMAND_TIMEOUT 150
91 /* Watchdog's internal commands */
92 #define CMD_GET_STATUS 0x04
93 #define CMD_GET_FIRMWARE_VERSION 0x08
94 #define CMD_READ_WATCHDOG_TIMEOUT 0x18
95 #define CMD_WRITE_WATCHDOG_TIMEOUT 0x19
96 #define CMD_GET_CLEAR_RESET_COUNT 0x84
98 /* We can only use 1 card due to the /dev/watchdog restriction */
99 static int cards_found;
101 /* internal variables */
102 static int temp_panic;
103 static unsigned long is_active;
104 static char expect_release;
105 static struct { /* this is private data for each PCI-PC watchdog card */
106 int supports_temp; /* Wether or not the card has a temperature device */
107 int boot_status; /* The card's boot status */
108 unsigned long io_addr; /* The cards I/O address */
109 spinlock_t io_lock; /* the lock for io operations */
110 struct pci_dev *pdev; /* the PCI-device */
113 /* module parameters */
114 #define QUIET 0 /* Default */
115 #define VERBOSE 1 /* Verbose */
116 #define DEBUG 2 /* print fancy stuff too */
117 static int debug = QUIET;
118 module_param(debug, int, 0);
119 MODULE_PARM_DESC(debug, "Debug level: 0=Quiet, 1=Verbose, 2=Debug (default=0)");
121 #define WATCHDOG_HEARTBEAT 2 /* 2 sec default heartbeat */
122 static int heartbeat = WATCHDOG_HEARTBEAT;
123 module_param(heartbeat, int, 0);
124 MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. (0<heartbeat<65536, default=" __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
126 static int nowayout = WATCHDOG_NOWAYOUT;
127 module_param(nowayout, int, 0);
128 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
134 static int send_command(int cmd, int *msb, int *lsb)
136 int got_response, count;
139 printk(KERN_DEBUG PFX "sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x\n",
142 spin_lock(&pcipcwd_private.io_lock);
143 /* If a command requires data it should be written first.
144 * Data for commands with 8 bits of data should be written to port 4.
145 * Commands with 16 bits of data, should be written as LSB to port 4
147 * After the required data has been written then write the command to
149 outb_p(*lsb, pcipcwd_private.io_addr + 4);
150 outb_p(*msb, pcipcwd_private.io_addr + 5);
151 outb_p(cmd, pcipcwd_private.io_addr + 6);
153 /* wait till the pci card processed the command, signaled by
154 * the WRSP bit in port 2 and give it a max. timeout of
155 * PCI_COMMAND_TIMEOUT to process */
156 got_response = inb_p(pcipcwd_private.io_addr + 2) & WD_PCI_WRSP;
157 for (count = 0; (count < PCI_COMMAND_TIMEOUT) && (!got_response); count++) {
159 got_response = inb_p(pcipcwd_private.io_addr + 2) & WD_PCI_WRSP;
162 if (debug >= DEBUG) {
164 printk(KERN_DEBUG PFX "time to process command was: %d ms\n",
167 printk(KERN_DEBUG PFX "card did not respond on command!\n");
172 /* read back response */
173 *lsb = inb_p(pcipcwd_private.io_addr + 4);
174 *msb = inb_p(pcipcwd_private.io_addr + 5);
177 inb_p(pcipcwd_private.io_addr + 6);
180 printk(KERN_DEBUG PFX "received following data for cmd=0x%02x: msb=0x%02x lsb=0x%02x\n",
184 spin_unlock(&pcipcwd_private.io_lock);
189 static inline void pcipcwd_check_temperature_support(void)
191 if (inb_p(pcipcwd_private.io_addr) != 0xF0)
192 pcipcwd_private.supports_temp = 1;
195 static int pcipcwd_get_option_switches(void)
199 option_switches = inb_p(pcipcwd_private.io_addr + 3);
200 return option_switches;
203 static void pcipcwd_show_card_info(void)
205 int got_fw_rev, fw_rev_major, fw_rev_minor;
206 char fw_ver_str[20]; /* The cards firmware version */
209 got_fw_rev = send_command(CMD_GET_FIRMWARE_VERSION, &fw_rev_major, &fw_rev_minor);
211 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
213 sprintf(fw_ver_str, "<card no answer>");
216 /* Get switch settings */
217 option_switches = pcipcwd_get_option_switches();
219 printk(KERN_INFO PFX "Found card at port 0x%04x (Firmware: %s) %s temp option\n",
220 (int) pcipcwd_private.io_addr, fw_ver_str,
221 (pcipcwd_private.supports_temp ? "with" : "without"));
223 printk(KERN_INFO PFX "Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
225 ((option_switches & 0x10) ? "ON" : "OFF"),
226 ((option_switches & 0x08) ? "ON" : "OFF"));
228 if (pcipcwd_private.boot_status & WDIOF_CARDRESET)
229 printk(KERN_INFO PFX "Previous reset was caused by the Watchdog card\n");
231 if (pcipcwd_private.boot_status & WDIOF_OVERHEAT)
232 printk(KERN_INFO PFX "Card sensed a CPU Overheat\n");
234 if (pcipcwd_private.boot_status == 0)
235 printk(KERN_INFO PFX "No previous trip detected - Cold boot or reset\n");
238 static int pcipcwd_start(void)
242 spin_lock(&pcipcwd_private.io_lock);
243 outb_p(0x00, pcipcwd_private.io_addr + 3);
246 stat_reg = inb_p(pcipcwd_private.io_addr + 2);
247 spin_unlock(&pcipcwd_private.io_lock);
249 if (stat_reg & WD_PCI_WDIS) {
250 printk(KERN_ERR PFX "Card timer not enabled\n");
254 if (debug >= VERBOSE)
255 printk(KERN_DEBUG PFX "Watchdog started\n");
260 static int pcipcwd_stop(void)
264 spin_lock(&pcipcwd_private.io_lock);
265 outb_p(0xA5, pcipcwd_private.io_addr + 3);
268 outb_p(0xA5, pcipcwd_private.io_addr + 3);
271 stat_reg = inb_p(pcipcwd_private.io_addr + 2);
272 spin_unlock(&pcipcwd_private.io_lock);
274 if (!(stat_reg & WD_PCI_WDIS)) {
275 printk(KERN_ERR PFX "Card did not acknowledge disable attempt\n");
279 if (debug >= VERBOSE)
280 printk(KERN_DEBUG PFX "Watchdog stopped\n");
285 static int pcipcwd_keepalive(void)
287 /* Re-trigger watchdog by writing to port 0 */
288 outb_p(0x42, pcipcwd_private.io_addr); /* send out any data */
291 printk(KERN_DEBUG PFX "Watchdog keepalive signal send\n");
296 static int pcipcwd_set_heartbeat(int t)
301 if ((t < 0x0001) || (t > 0xFFFF))
304 /* Write new heartbeat to watchdog */
305 send_command(CMD_WRITE_WATCHDOG_TIMEOUT, &t_msb, &t_lsb);
308 if (debug >= VERBOSE)
309 printk(KERN_DEBUG PFX "New heartbeat: %d\n",
315 static int pcipcwd_get_status(int *status)
320 control_status = inb_p(pcipcwd_private.io_addr + 1);
321 if (control_status & WD_PCI_WTRP)
322 *status |= WDIOF_CARDRESET;
323 if (control_status & WD_PCI_TTRP) {
324 *status |= WDIOF_OVERHEAT;
326 panic(PFX "Temperature overheat trip!\n");
330 printk(KERN_DEBUG PFX "Control Status #1: 0x%02x\n",
336 static int pcipcwd_clear_status(void)
342 if (debug >= VERBOSE)
343 printk(KERN_INFO PFX "clearing watchdog trip status & LED\n");
345 control_status = inb_p(pcipcwd_private.io_addr + 1);
347 if (debug >= DEBUG) {
348 printk(KERN_DEBUG PFX "status was: 0x%02x\n", control_status);
349 printk(KERN_DEBUG PFX "sending: 0x%02x\n",
350 (control_status & WD_PCI_R2DS) | WD_PCI_WTRP);
353 /* clear trip status & LED and keep mode of relay 2 */
354 outb_p((control_status & WD_PCI_R2DS) | WD_PCI_WTRP, pcipcwd_private.io_addr + 1);
356 /* clear reset counter */
359 send_command(CMD_GET_CLEAR_RESET_COUNT, &msb, &reset_counter);
361 if (debug >= DEBUG) {
362 printk(KERN_DEBUG PFX "reset count was: 0x%02x\n",
369 static int pcipcwd_get_temperature(int *temperature)
372 if (!pcipcwd_private.supports_temp)
375 *temperature = inb_p(pcipcwd_private.io_addr);
378 * Convert celsius to fahrenheit, since this was
379 * the decided 'standard' for this return value.
381 *temperature = (*temperature * 9 / 5) + 32;
383 if (debug >= DEBUG) {
384 printk(KERN_DEBUG PFX "temperature is: %d F\n",
392 * /dev/watchdog handling
395 static ssize_t pcipcwd_write(struct file *file, const char __user *data,
396 size_t len, loff_t *ppos)
398 /* See if we got the magic character 'V' and reload the timer */
403 /* note: just in case someone wrote the magic character
404 * five months ago... */
407 /* scan to see whether or not we got the magic character */
408 for (i = 0; i != len; i++) {
410 if(get_user(c, data+i))
417 /* someone wrote to us, we should reload the timer */
423 static int pcipcwd_ioctl(struct inode *inode, struct file *file,
424 unsigned int cmd, unsigned long arg)
426 void __user *argp = (void __user *)arg;
427 int __user *p = argp;
428 static struct watchdog_info ident = {
429 .options = WDIOF_OVERHEAT |
431 WDIOF_KEEPALIVEPING |
434 .firmware_version = 1,
435 .identity = WATCHDOG_DRIVER_NAME,
439 case WDIOC_GETSUPPORT:
440 return copy_to_user(argp, &ident,
441 sizeof (ident)) ? -EFAULT : 0;
443 case WDIOC_GETSTATUS:
447 pcipcwd_get_status(&status);
449 return put_user(status, p);
452 case WDIOC_GETBOOTSTATUS:
453 return put_user(pcipcwd_private.boot_status, p);
459 if (pcipcwd_get_temperature(&temperature))
462 return put_user(temperature, p);
465 case WDIOC_KEEPALIVE:
469 case WDIOC_SETOPTIONS:
471 int new_options, retval = -EINVAL;
473 if (get_user (new_options, p))
476 if (new_options & WDIOS_DISABLECARD) {
482 if (new_options & WDIOS_ENABLECARD) {
488 if (new_options & WDIOS_TEMPPANIC) {
496 case WDIOC_SETTIMEOUT:
500 if (get_user(new_heartbeat, p))
503 if (pcipcwd_set_heartbeat(new_heartbeat))
510 case WDIOC_GETTIMEOUT:
511 return put_user(heartbeat, p);
518 static int pcipcwd_open(struct inode *inode, struct file *file)
520 /* /dev/watchdog can only be opened once */
521 if (test_and_set_bit(0, &is_active)) {
522 if (debug >= VERBOSE)
523 printk(KERN_ERR PFX "Attempt to open already opened device.\n");
530 return nonseekable_open(inode, file);
533 static int pcipcwd_release(struct inode *inode, struct file *file)
536 * Shut off the timer.
538 if (expect_release == 42) {
541 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
545 clear_bit(0, &is_active);
550 * /dev/temperature handling
553 static ssize_t pcipcwd_temp_read(struct file *file, char __user *data,
554 size_t len, loff_t *ppos)
558 if (pcipcwd_get_temperature(&temperature))
561 if (copy_to_user (data, &temperature, 1))
567 static int pcipcwd_temp_open(struct inode *inode, struct file *file)
569 if (!pcipcwd_private.supports_temp)
572 return nonseekable_open(inode, file);
575 static int pcipcwd_temp_release(struct inode *inode, struct file *file)
584 static int pcipcwd_notify_sys(struct notifier_block *this, unsigned long code, void *unused)
586 if (code==SYS_DOWN || code==SYS_HALT) {
587 /* Turn the WDT off */
598 static struct file_operations pcipcwd_fops = {
599 .owner = THIS_MODULE,
601 .write = pcipcwd_write,
602 .ioctl = pcipcwd_ioctl,
603 .open = pcipcwd_open,
604 .release = pcipcwd_release,
607 static struct miscdevice pcipcwd_miscdev = {
608 .minor = WATCHDOG_MINOR,
610 .fops = &pcipcwd_fops,
613 static struct file_operations pcipcwd_temp_fops = {
614 .owner = THIS_MODULE,
616 .read = pcipcwd_temp_read,
617 .open = pcipcwd_temp_open,
618 .release = pcipcwd_temp_release,
621 static struct miscdevice pcipcwd_temp_miscdev = {
623 .name = "temperature",
624 .fops = &pcipcwd_temp_fops,
627 static struct notifier_block pcipcwd_notifier = {
628 .notifier_call = pcipcwd_notify_sys,
632 * Init & exit routines
635 static int __devinit pcipcwd_card_init(struct pci_dev *pdev,
636 const struct pci_device_id *ent)
641 if (cards_found == 1)
642 printk(KERN_INFO PFX DRIVER_VERSION);
644 if (cards_found > 1) {
645 printk(KERN_ERR PFX "This driver only supports 1 device\n");
649 if (pci_enable_device(pdev)) {
650 printk(KERN_ERR PFX "Not possible to enable PCI Device\n");
654 if (pci_resource_start(pdev, 0) == 0x0000) {
655 printk(KERN_ERR PFX "No I/O-Address for card detected\n");
657 goto err_out_disable_device;
660 pcipcwd_private.pdev = pdev;
661 pcipcwd_private.io_addr = pci_resource_start(pdev, 0);
663 if (pci_request_regions(pdev, WATCHDOG_NAME)) {
664 printk(KERN_ERR PFX "I/O address 0x%04x already in use\n",
665 (int) pcipcwd_private.io_addr);
667 goto err_out_disable_device;
670 /* get the boot_status */
671 pcipcwd_get_status(&pcipcwd_private.boot_status);
673 /* clear the "card caused reboot" flag */
674 pcipcwd_clear_status();
679 /* Check whether or not the card supports the temperature device */
680 pcipcwd_check_temperature_support();
682 /* Show info about the card itself */
683 pcipcwd_show_card_info();
685 /* Check that the heartbeat value is within it's range ; if not reset to the default */
686 if (pcipcwd_set_heartbeat(heartbeat)) {
687 pcipcwd_set_heartbeat(WATCHDOG_HEARTBEAT);
688 printk(KERN_INFO PFX "heartbeat value must be 0<heartbeat<65536, using %d\n",
692 ret = register_reboot_notifier(&pcipcwd_notifier);
694 printk(KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
696 goto err_out_release_region;
699 if (pcipcwd_private.supports_temp) {
700 ret = misc_register(&pcipcwd_temp_miscdev);
702 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
704 goto err_out_unregister_reboot;
708 ret = misc_register(&pcipcwd_miscdev);
710 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
711 WATCHDOG_MINOR, ret);
712 goto err_out_misc_deregister;
715 printk(KERN_INFO PFX "initialized. heartbeat=%d sec (nowayout=%d)\n",
716 heartbeat, nowayout);
720 err_out_misc_deregister:
721 if (pcipcwd_private.supports_temp)
722 misc_deregister(&pcipcwd_temp_miscdev);
723 err_out_unregister_reboot:
724 unregister_reboot_notifier(&pcipcwd_notifier);
725 err_out_release_region:
726 pci_release_regions(pdev);
727 err_out_disable_device:
728 pci_disable_device(pdev);
732 static void __devexit pcipcwd_card_exit(struct pci_dev *pdev)
734 /* Stop the timer before we leave */
739 misc_deregister(&pcipcwd_miscdev);
740 if (pcipcwd_private.supports_temp)
741 misc_deregister(&pcipcwd_temp_miscdev);
742 unregister_reboot_notifier(&pcipcwd_notifier);
743 pci_release_regions(pdev);
744 pci_disable_device(pdev);
748 static struct pci_device_id pcipcwd_pci_tbl[] = {
749 { PCI_VENDOR_ID_QUICKLOGIC, PCI_DEVICE_ID_WATCHDOG_PCIPCWD,
750 PCI_ANY_ID, PCI_ANY_ID, },
751 { 0 }, /* End of list */
753 MODULE_DEVICE_TABLE(pci, pcipcwd_pci_tbl);
755 static struct pci_driver pcipcwd_driver = {
756 .name = WATCHDOG_NAME,
757 .id_table = pcipcwd_pci_tbl,
758 .probe = pcipcwd_card_init,
759 .remove = __devexit_p(pcipcwd_card_exit),
762 static int __init pcipcwd_init_module(void)
764 spin_lock_init(&pcipcwd_private.io_lock);
766 return pci_register_driver(&pcipcwd_driver);
769 static void __exit pcipcwd_cleanup_module(void)
771 pci_unregister_driver(&pcipcwd_driver);
774 module_init(pcipcwd_init_module);
775 module_exit(pcipcwd_cleanup_module);
777 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
778 MODULE_DESCRIPTION("Berkshire PCI-PC Watchdog driver");
779 MODULE_LICENSE("GPL");
780 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
781 MODULE_ALIAS_MISCDEV(TEMP_MINOR);