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 WATCHDOG_HEARTBEAT 2 /* 2 sec default heartbeat */
115 static int heartbeat = WATCHDOG_HEARTBEAT;
116 module_param(heartbeat, int, 0);
117 MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. (0<heartbeat<65536, default=" __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
119 static int nowayout = WATCHDOG_NOWAYOUT;
120 module_param(nowayout, int, 0);
121 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
127 static int send_command(int cmd, int *msb, int *lsb)
129 int got_response, count;
131 spin_lock(&pcipcwd_private.io_lock);
132 /* If a command requires data it should be written first.
133 * Data for commands with 8 bits of data should be written to port 4.
134 * Commands with 16 bits of data, should be written as LSB to port 4
136 * After the required data has been written then write the command to
138 outb_p(*lsb, pcipcwd_private.io_addr + 4);
139 outb_p(*msb, pcipcwd_private.io_addr + 5);
140 outb_p(cmd, pcipcwd_private.io_addr + 6);
142 /* wait till the pci card processed the command, signaled by
143 * the WRSP bit in port 2 and give it a max. timeout of
144 * PCI_COMMAND_TIMEOUT to process */
145 got_response = inb_p(pcipcwd_private.io_addr + 2) & WD_PCI_WRSP;
146 for (count = 0; (count < PCI_COMMAND_TIMEOUT) && (!got_response); count++) {
148 got_response = inb_p(pcipcwd_private.io_addr + 2) & WD_PCI_WRSP;
152 /* read back response */
153 *lsb = inb_p(pcipcwd_private.io_addr + 4);
154 *msb = inb_p(pcipcwd_private.io_addr + 5);
157 inb_p(pcipcwd_private.io_addr + 6);
159 spin_unlock(&pcipcwd_private.io_lock);
164 static inline void pcipcwd_check_temperature_support(void)
166 if (inb_p(pcipcwd_private.io_addr) != 0xF0)
167 pcipcwd_private.supports_temp = 1;
170 static int pcipcwd_get_option_switches(void)
174 option_switches = inb_p(pcipcwd_private.io_addr + 3);
175 return option_switches;
178 static void pcipcwd_show_card_info(void)
180 int got_fw_rev, fw_rev_major, fw_rev_minor;
181 char fw_ver_str[20]; /* The cards firmware version */
184 got_fw_rev = send_command(CMD_GET_FIRMWARE_VERSION, &fw_rev_major, &fw_rev_minor);
186 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
188 sprintf(fw_ver_str, "<card no answer>");
191 /* Get switch settings */
192 option_switches = pcipcwd_get_option_switches();
194 printk(KERN_INFO PFX "Found card at port 0x%04x (Firmware: %s) %s temp option\n",
195 (int) pcipcwd_private.io_addr, fw_ver_str,
196 (pcipcwd_private.supports_temp ? "with" : "without"));
198 printk(KERN_INFO PFX "Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
200 ((option_switches & 0x10) ? "ON" : "OFF"),
201 ((option_switches & 0x08) ? "ON" : "OFF"));
203 if (pcipcwd_private.boot_status & WDIOF_CARDRESET)
204 printk(KERN_INFO PFX "Previous reset was caused by the Watchdog card\n");
206 if (pcipcwd_private.boot_status & WDIOF_OVERHEAT)
207 printk(KERN_INFO PFX "Card sensed a CPU Overheat\n");
209 if (pcipcwd_private.boot_status == 0)
210 printk(KERN_INFO PFX "No previous trip detected - Cold boot or reset\n");
213 static int pcipcwd_start(void)
217 spin_lock(&pcipcwd_private.io_lock);
218 outb_p(0x00, pcipcwd_private.io_addr + 3);
221 stat_reg = inb_p(pcipcwd_private.io_addr + 2);
222 spin_unlock(&pcipcwd_private.io_lock);
224 if (stat_reg & WD_PCI_WDIS) {
225 printk(KERN_ERR PFX "Card timer not enabled\n");
232 static int pcipcwd_stop(void)
236 spin_lock(&pcipcwd_private.io_lock);
237 outb_p(0xA5, pcipcwd_private.io_addr + 3);
240 outb_p(0xA5, pcipcwd_private.io_addr + 3);
243 stat_reg = inb_p(pcipcwd_private.io_addr + 2);
244 spin_unlock(&pcipcwd_private.io_lock);
246 if (!(stat_reg & WD_PCI_WDIS)) {
247 printk(KERN_ERR PFX "Card did not acknowledge disable attempt\n");
254 static int pcipcwd_keepalive(void)
256 /* Re-trigger watchdog by writing to port 0 */
257 outb_p(0x42, pcipcwd_private.io_addr); /* send out any data */
261 static int pcipcwd_set_heartbeat(int t)
266 if ((t < 0x0001) || (t > 0xFFFF))
269 /* Write new heartbeat to watchdog */
270 send_command(CMD_WRITE_WATCHDOG_TIMEOUT, &t_msb, &t_lsb);
276 static int pcipcwd_get_status(int *status)
281 control_status = inb_p(pcipcwd_private.io_addr + 1);
282 if (control_status & WD_PCI_WTRP)
283 *status |= WDIOF_CARDRESET;
284 if (control_status & WD_PCI_TTRP) {
285 *status |= WDIOF_OVERHEAT;
287 panic(PFX "Temperature overheat trip!\n");
293 static int pcipcwd_clear_status(void)
299 control_status = inb_p(pcipcwd_private.io_addr + 1);
301 /* clear trip status & LED and keep mode of relay 2 */
302 outb_p((control_status & WD_PCI_R2DS) | WD_PCI_WTRP, pcipcwd_private.io_addr + 1);
304 /* clear reset counter */
307 send_command(CMD_GET_CLEAR_RESET_COUNT, &msb, &reset_counter);
312 static int pcipcwd_get_temperature(int *temperature)
315 if (!pcipcwd_private.supports_temp)
318 *temperature = inb_p(pcipcwd_private.io_addr);
321 * Convert celsius to fahrenheit, since this was
322 * the decided 'standard' for this return value.
324 *temperature = (*temperature * 9 / 5) + 32;
330 * /dev/watchdog handling
333 static ssize_t pcipcwd_write(struct file *file, const char __user *data,
334 size_t len, loff_t *ppos)
336 /* See if we got the magic character 'V' and reload the timer */
341 /* note: just in case someone wrote the magic character
342 * five months ago... */
345 /* scan to see whether or not we got the magic character */
346 for (i = 0; i != len; i++) {
348 if(get_user(c, data+i))
355 /* someone wrote to us, we should reload the timer */
361 static int pcipcwd_ioctl(struct inode *inode, struct file *file,
362 unsigned int cmd, unsigned long arg)
364 void __user *argp = (void __user *)arg;
365 int __user *p = argp;
366 static struct watchdog_info ident = {
367 .options = WDIOF_OVERHEAT |
369 WDIOF_KEEPALIVEPING |
372 .firmware_version = 1,
373 .identity = WATCHDOG_DRIVER_NAME,
377 case WDIOC_GETSUPPORT:
378 return copy_to_user(argp, &ident,
379 sizeof (ident)) ? -EFAULT : 0;
381 case WDIOC_GETSTATUS:
385 pcipcwd_get_status(&status);
387 return put_user(status, p);
390 case WDIOC_GETBOOTSTATUS:
391 return put_user(pcipcwd_private.boot_status, p);
397 if (pcipcwd_get_temperature(&temperature))
400 return put_user(temperature, p);
403 case WDIOC_KEEPALIVE:
407 case WDIOC_SETOPTIONS:
409 int new_options, retval = -EINVAL;
411 if (get_user (new_options, p))
414 if (new_options & WDIOS_DISABLECARD) {
420 if (new_options & WDIOS_ENABLECARD) {
426 if (new_options & WDIOS_TEMPPANIC) {
434 case WDIOC_SETTIMEOUT:
438 if (get_user(new_heartbeat, p))
441 if (pcipcwd_set_heartbeat(new_heartbeat))
448 case WDIOC_GETTIMEOUT:
449 return put_user(heartbeat, p);
456 static int pcipcwd_open(struct inode *inode, struct file *file)
458 /* /dev/watchdog can only be opened once */
459 if (test_and_set_bit(0, &is_active)) {
466 return nonseekable_open(inode, file);
469 static int pcipcwd_release(struct inode *inode, struct file *file)
472 * Shut off the timer.
474 if (expect_release == 42) {
477 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
481 clear_bit(0, &is_active);
486 * /dev/temperature handling
489 static ssize_t pcipcwd_temp_read(struct file *file, char __user *data,
490 size_t len, loff_t *ppos)
494 if (pcipcwd_get_temperature(&temperature))
497 if (copy_to_user (data, &temperature, 1))
503 static int pcipcwd_temp_open(struct inode *inode, struct file *file)
505 if (!pcipcwd_private.supports_temp)
508 return nonseekable_open(inode, file);
511 static int pcipcwd_temp_release(struct inode *inode, struct file *file)
520 static int pcipcwd_notify_sys(struct notifier_block *this, unsigned long code, void *unused)
522 if (code==SYS_DOWN || code==SYS_HALT) {
523 /* Turn the WDT off */
534 static struct file_operations pcipcwd_fops = {
535 .owner = THIS_MODULE,
537 .write = pcipcwd_write,
538 .ioctl = pcipcwd_ioctl,
539 .open = pcipcwd_open,
540 .release = pcipcwd_release,
543 static struct miscdevice pcipcwd_miscdev = {
544 .minor = WATCHDOG_MINOR,
546 .fops = &pcipcwd_fops,
549 static struct file_operations pcipcwd_temp_fops = {
550 .owner = THIS_MODULE,
552 .read = pcipcwd_temp_read,
553 .open = pcipcwd_temp_open,
554 .release = pcipcwd_temp_release,
557 static struct miscdevice pcipcwd_temp_miscdev = {
559 .name = "temperature",
560 .fops = &pcipcwd_temp_fops,
563 static struct notifier_block pcipcwd_notifier = {
564 .notifier_call = pcipcwd_notify_sys,
568 * Init & exit routines
571 static int __devinit pcipcwd_card_init(struct pci_dev *pdev,
572 const struct pci_device_id *ent)
577 if (cards_found == 1)
578 printk(KERN_INFO PFX DRIVER_VERSION);
580 if (cards_found > 1) {
581 printk(KERN_ERR PFX "This driver only supports 1 device\n");
585 if (pci_enable_device(pdev)) {
586 printk(KERN_ERR PFX "Not possible to enable PCI Device\n");
590 if (pci_resource_start(pdev, 0) == 0x0000) {
591 printk(KERN_ERR PFX "No I/O-Address for card detected\n");
593 goto err_out_disable_device;
596 pcipcwd_private.pdev = pdev;
597 pcipcwd_private.io_addr = pci_resource_start(pdev, 0);
599 if (pci_request_regions(pdev, WATCHDOG_NAME)) {
600 printk(KERN_ERR PFX "I/O address 0x%04x already in use\n",
601 (int) pcipcwd_private.io_addr);
603 goto err_out_disable_device;
606 /* get the boot_status */
607 pcipcwd_get_status(&pcipcwd_private.boot_status);
609 /* clear the "card caused reboot" flag */
610 pcipcwd_clear_status();
615 /* Check whether or not the card supports the temperature device */
616 pcipcwd_check_temperature_support();
618 /* Show info about the card itself */
619 pcipcwd_show_card_info();
621 /* Check that the heartbeat value is within it's range ; if not reset to the default */
622 if (pcipcwd_set_heartbeat(heartbeat)) {
623 pcipcwd_set_heartbeat(WATCHDOG_HEARTBEAT);
624 printk(KERN_INFO PFX "heartbeat value must be 0<heartbeat<65536, using %d\n",
628 ret = register_reboot_notifier(&pcipcwd_notifier);
630 printk(KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
632 goto err_out_release_region;
635 if (pcipcwd_private.supports_temp) {
636 ret = misc_register(&pcipcwd_temp_miscdev);
638 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
640 goto err_out_unregister_reboot;
644 ret = misc_register(&pcipcwd_miscdev);
646 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
647 WATCHDOG_MINOR, ret);
648 goto err_out_misc_deregister;
651 printk(KERN_INFO PFX "initialized. heartbeat=%d sec (nowayout=%d)\n",
652 heartbeat, nowayout);
656 err_out_misc_deregister:
657 if (pcipcwd_private.supports_temp)
658 misc_deregister(&pcipcwd_temp_miscdev);
659 err_out_unregister_reboot:
660 unregister_reboot_notifier(&pcipcwd_notifier);
661 err_out_release_region:
662 pci_release_regions(pdev);
663 err_out_disable_device:
664 pci_disable_device(pdev);
668 static void __devexit pcipcwd_card_exit(struct pci_dev *pdev)
670 /* Stop the timer before we leave */
675 misc_deregister(&pcipcwd_miscdev);
676 if (pcipcwd_private.supports_temp)
677 misc_deregister(&pcipcwd_temp_miscdev);
678 unregister_reboot_notifier(&pcipcwd_notifier);
679 pci_release_regions(pdev);
680 pci_disable_device(pdev);
684 static struct pci_device_id pcipcwd_pci_tbl[] = {
685 { PCI_VENDOR_ID_QUICKLOGIC, PCI_DEVICE_ID_WATCHDOG_PCIPCWD,
686 PCI_ANY_ID, PCI_ANY_ID, },
687 { 0 }, /* End of list */
689 MODULE_DEVICE_TABLE(pci, pcipcwd_pci_tbl);
691 static struct pci_driver pcipcwd_driver = {
692 .name = WATCHDOG_NAME,
693 .id_table = pcipcwd_pci_tbl,
694 .probe = pcipcwd_card_init,
695 .remove = __devexit_p(pcipcwd_card_exit),
698 static int __init pcipcwd_init_module(void)
700 spin_lock_init(&pcipcwd_private.io_lock);
702 return pci_register_driver(&pcipcwd_driver);
705 static void __exit pcipcwd_cleanup_module(void)
707 pci_unregister_driver(&pcipcwd_driver);
710 module_init(pcipcwd_init_module);
711 module_exit(pcipcwd_cleanup_module);
713 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
714 MODULE_DESCRIPTION("Berkshire PCI-PC Watchdog driver");
715 MODULE_LICENSE("GPL");
716 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
717 MODULE_ALIAS_MISCDEV(TEMP_MINOR);