This source file includes following definitions.
- send_command
- pcipcwd_check_temperature_support
- pcipcwd_get_option_switches
- pcipcwd_show_card_info
- pcipcwd_start
- pcipcwd_stop
- pcipcwd_keepalive
- pcipcwd_set_heartbeat
- pcipcwd_get_status
- pcipcwd_clear_status
- pcipcwd_get_temperature
- pcipcwd_get_timeleft
- pcipcwd_write
- pcipcwd_ioctl
- pcipcwd_open
- pcipcwd_release
- pcipcwd_temp_read
- pcipcwd_temp_open
- pcipcwd_temp_release
- pcipcwd_notify_sys
- pcipcwd_card_init
- pcipcwd_card_exit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32
33 #include <linux/module.h>
34 #include <linux/moduleparam.h>
35 #include <linux/types.h>
36 #include <linux/errno.h>
37 #include <linux/kernel.h>
38 #include <linux/delay.h>
39 #include <linux/miscdevice.h>
40 #include <linux/watchdog.h>
41 #include <linux/notifier.h>
42 #include <linux/reboot.h>
43 #include <linux/init.h>
44 #include <linux/fs.h>
45 #include <linux/pci.h>
46 #include <linux/ioport.h>
47 #include <linux/spinlock.h>
48 #include <linux/uaccess.h>
49 #include <linux/io.h>
50
51
52 #define WATCHDOG_VERSION "1.03"
53 #define WATCHDOG_DRIVER_NAME "PCI-PC Watchdog"
54 #define WATCHDOG_NAME "pcwd_pci"
55 #define DRIVER_VERSION WATCHDOG_DRIVER_NAME " driver, v" WATCHDOG_VERSION
56
57
58 #ifndef PCI_VENDOR_ID_QUICKLOGIC
59 #define PCI_VENDOR_ID_QUICKLOGIC 0x11e3
60 #endif
61
62 #ifndef PCI_DEVICE_ID_WATCHDOG_PCIPCWD
63 #define PCI_DEVICE_ID_WATCHDOG_PCIPCWD 0x5030
64 #endif
65
66
67
68
69
70
71 #define WD_PCI_WTRP 0x01
72 #define WD_PCI_HRBT 0x02
73 #define WD_PCI_TTRP 0x04
74 #define WD_PCI_RL2A 0x08
75 #define WD_PCI_RL1A 0x10
76 #define WD_PCI_R2DS 0x40
77
78 #define WD_PCI_RLY2 0x80
79
80 #define WD_PCI_WDIS 0x10
81 #define WD_PCI_ENTP 0x20
82 #define WD_PCI_WRSP 0x40
83 #define WD_PCI_PCMD 0x80
84
85
86
87 #define PCI_COMMAND_TIMEOUT 150
88
89
90 #define CMD_GET_STATUS 0x04
91 #define CMD_GET_FIRMWARE_VERSION 0x08
92 #define CMD_READ_WATCHDOG_TIMEOUT 0x18
93 #define CMD_WRITE_WATCHDOG_TIMEOUT 0x19
94 #define CMD_GET_CLEAR_RESET_COUNT 0x84
95
96
97 static const int heartbeat_tbl[] = {
98 5,
99 10,
100 30,
101 60,
102 300,
103 600,
104 1800,
105 3600,
106 };
107
108
109 static int cards_found;
110
111
112 static int temp_panic;
113 static unsigned long is_active;
114 static char expect_release;
115
116 static struct {
117
118 int supports_temp;
119
120 int boot_status;
121
122 unsigned long io_addr;
123
124 spinlock_t io_lock;
125
126 struct pci_dev *pdev;
127 } pcipcwd_private;
128
129
130 #define QUIET 0
131 #define VERBOSE 1
132 #define DEBUG 2
133 static int debug = QUIET;
134 module_param(debug, int, 0);
135 MODULE_PARM_DESC(debug, "Debug level: 0=Quiet, 1=Verbose, 2=Debug (default=0)");
136
137 #define WATCHDOG_HEARTBEAT 0
138
139 static int heartbeat = WATCHDOG_HEARTBEAT;
140 module_param(heartbeat, int, 0);
141 MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. "
142 "(0<heartbeat<65536 or 0=delay-time from dip-switches, default="
143 __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
144
145 static bool nowayout = WATCHDOG_NOWAYOUT;
146 module_param(nowayout, bool, 0);
147 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
148 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
149
150
151
152
153
154 static int send_command(int cmd, int *msb, int *lsb)
155 {
156 int got_response, count;
157
158 if (debug >= DEBUG)
159 pr_debug("sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x\n",
160 cmd, *msb, *lsb);
161
162 spin_lock(&pcipcwd_private.io_lock);
163
164
165
166
167
168
169 outb_p(*lsb, pcipcwd_private.io_addr + 4);
170 outb_p(*msb, pcipcwd_private.io_addr + 5);
171 outb_p(cmd, pcipcwd_private.io_addr + 6);
172
173
174
175
176 got_response = inb_p(pcipcwd_private.io_addr + 2) & WD_PCI_WRSP;
177 for (count = 0; (count < PCI_COMMAND_TIMEOUT) && (!got_response);
178 count++) {
179 mdelay(1);
180 got_response = inb_p(pcipcwd_private.io_addr + 2) & WD_PCI_WRSP;
181 }
182
183 if (debug >= DEBUG) {
184 if (got_response) {
185 pr_debug("time to process command was: %d ms\n",
186 count);
187 } else {
188 pr_debug("card did not respond on command!\n");
189 }
190 }
191
192 if (got_response) {
193
194 *lsb = inb_p(pcipcwd_private.io_addr + 4);
195 *msb = inb_p(pcipcwd_private.io_addr + 5);
196
197
198 inb_p(pcipcwd_private.io_addr + 6);
199
200 if (debug >= DEBUG)
201 pr_debug("received following data for cmd=0x%02x: msb=0x%02x lsb=0x%02x\n",
202 cmd, *msb, *lsb);
203 }
204
205 spin_unlock(&pcipcwd_private.io_lock);
206
207 return got_response;
208 }
209
210 static inline void pcipcwd_check_temperature_support(void)
211 {
212 if (inb_p(pcipcwd_private.io_addr) != 0xF0)
213 pcipcwd_private.supports_temp = 1;
214 }
215
216 static int pcipcwd_get_option_switches(void)
217 {
218 int option_switches;
219
220 option_switches = inb_p(pcipcwd_private.io_addr + 3);
221 return option_switches;
222 }
223
224 static void pcipcwd_show_card_info(void)
225 {
226 int got_fw_rev, fw_rev_major, fw_rev_minor;
227 char fw_ver_str[20];
228 int option_switches;
229
230 got_fw_rev = send_command(CMD_GET_FIRMWARE_VERSION, &fw_rev_major,
231 &fw_rev_minor);
232 if (got_fw_rev)
233 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
234 else
235 sprintf(fw_ver_str, "<card no answer>");
236
237
238 option_switches = pcipcwd_get_option_switches();
239
240 pr_info("Found card at port 0x%04x (Firmware: %s) %s temp option\n",
241 (int) pcipcwd_private.io_addr, fw_ver_str,
242 (pcipcwd_private.supports_temp ? "with" : "without"));
243
244 pr_info("Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
245 option_switches,
246 ((option_switches & 0x10) ? "ON" : "OFF"),
247 ((option_switches & 0x08) ? "ON" : "OFF"));
248
249 if (pcipcwd_private.boot_status & WDIOF_CARDRESET)
250 pr_info("Previous reset was caused by the Watchdog card\n");
251
252 if (pcipcwd_private.boot_status & WDIOF_OVERHEAT)
253 pr_info("Card sensed a CPU Overheat\n");
254
255 if (pcipcwd_private.boot_status == 0)
256 pr_info("No previous trip detected - Cold boot or reset\n");
257 }
258
259 static int pcipcwd_start(void)
260 {
261 int stat_reg;
262
263 spin_lock(&pcipcwd_private.io_lock);
264 outb_p(0x00, pcipcwd_private.io_addr + 3);
265 udelay(1000);
266
267 stat_reg = inb_p(pcipcwd_private.io_addr + 2);
268 spin_unlock(&pcipcwd_private.io_lock);
269
270 if (stat_reg & WD_PCI_WDIS) {
271 pr_err("Card timer not enabled\n");
272 return -1;
273 }
274
275 if (debug >= VERBOSE)
276 pr_debug("Watchdog started\n");
277
278 return 0;
279 }
280
281 static int pcipcwd_stop(void)
282 {
283 int stat_reg;
284
285 spin_lock(&pcipcwd_private.io_lock);
286 outb_p(0xA5, pcipcwd_private.io_addr + 3);
287 udelay(1000);
288
289 outb_p(0xA5, pcipcwd_private.io_addr + 3);
290 udelay(1000);
291
292 stat_reg = inb_p(pcipcwd_private.io_addr + 2);
293 spin_unlock(&pcipcwd_private.io_lock);
294
295 if (!(stat_reg & WD_PCI_WDIS)) {
296 pr_err("Card did not acknowledge disable attempt\n");
297 return -1;
298 }
299
300 if (debug >= VERBOSE)
301 pr_debug("Watchdog stopped\n");
302
303 return 0;
304 }
305
306 static int pcipcwd_keepalive(void)
307 {
308
309 spin_lock(&pcipcwd_private.io_lock);
310 outb_p(0x42, pcipcwd_private.io_addr);
311 spin_unlock(&pcipcwd_private.io_lock);
312
313 if (debug >= DEBUG)
314 pr_debug("Watchdog keepalive signal send\n");
315
316 return 0;
317 }
318
319 static int pcipcwd_set_heartbeat(int t)
320 {
321 int t_msb = t / 256;
322 int t_lsb = t % 256;
323
324 if ((t < 0x0001) || (t > 0xFFFF))
325 return -EINVAL;
326
327
328 send_command(CMD_WRITE_WATCHDOG_TIMEOUT, &t_msb, &t_lsb);
329
330 heartbeat = t;
331 if (debug >= VERBOSE)
332 pr_debug("New heartbeat: %d\n", heartbeat);
333
334 return 0;
335 }
336
337 static int pcipcwd_get_status(int *status)
338 {
339 int control_status;
340
341 *status = 0;
342 control_status = inb_p(pcipcwd_private.io_addr + 1);
343 if (control_status & WD_PCI_WTRP)
344 *status |= WDIOF_CARDRESET;
345 if (control_status & WD_PCI_TTRP) {
346 *status |= WDIOF_OVERHEAT;
347 if (temp_panic)
348 panic(KBUILD_MODNAME ": Temperature overheat trip!\n");
349 }
350
351 if (debug >= DEBUG)
352 pr_debug("Control Status #1: 0x%02x\n", control_status);
353
354 return 0;
355 }
356
357 static int pcipcwd_clear_status(void)
358 {
359 int control_status;
360 int msb;
361 int reset_counter;
362
363 if (debug >= VERBOSE)
364 pr_info("clearing watchdog trip status & LED\n");
365
366 control_status = inb_p(pcipcwd_private.io_addr + 1);
367
368 if (debug >= DEBUG) {
369 pr_debug("status was: 0x%02x\n", control_status);
370 pr_debug("sending: 0x%02x\n",
371 (control_status & WD_PCI_R2DS) | WD_PCI_WTRP);
372 }
373
374
375 outb_p((control_status & WD_PCI_R2DS) | WD_PCI_WTRP,
376 pcipcwd_private.io_addr + 1);
377
378
379 msb = 0;
380 reset_counter = 0xff;
381 send_command(CMD_GET_CLEAR_RESET_COUNT, &msb, &reset_counter);
382
383 if (debug >= DEBUG) {
384 pr_debug("reset count was: 0x%02x\n", reset_counter);
385 }
386
387 return 0;
388 }
389
390 static int pcipcwd_get_temperature(int *temperature)
391 {
392 *temperature = 0;
393 if (!pcipcwd_private.supports_temp)
394 return -ENODEV;
395
396 spin_lock(&pcipcwd_private.io_lock);
397 *temperature = inb_p(pcipcwd_private.io_addr);
398 spin_unlock(&pcipcwd_private.io_lock);
399
400
401
402
403
404 *temperature = (*temperature * 9 / 5) + 32;
405
406 if (debug >= DEBUG) {
407 pr_debug("temperature is: %d F\n", *temperature);
408 }
409
410 return 0;
411 }
412
413 static int pcipcwd_get_timeleft(int *time_left)
414 {
415 int msb;
416 int lsb;
417
418
419
420 send_command(CMD_READ_WATCHDOG_TIMEOUT, &msb, &lsb);
421
422 *time_left = (msb << 8) + lsb;
423
424 if (debug >= VERBOSE)
425 pr_debug("Time left before next reboot: %d\n", *time_left);
426
427 return 0;
428 }
429
430
431
432
433
434 static ssize_t pcipcwd_write(struct file *file, const char __user *data,
435 size_t len, loff_t *ppos)
436 {
437
438 if (len) {
439 if (!nowayout) {
440 size_t i;
441
442
443
444 expect_release = 0;
445
446
447
448 for (i = 0; i != len; i++) {
449 char c;
450 if (get_user(c, data + i))
451 return -EFAULT;
452 if (c == 'V')
453 expect_release = 42;
454 }
455 }
456
457
458 pcipcwd_keepalive();
459 }
460 return len;
461 }
462
463 static long pcipcwd_ioctl(struct file *file, unsigned int cmd,
464 unsigned long arg)
465 {
466 void __user *argp = (void __user *)arg;
467 int __user *p = argp;
468 static const struct watchdog_info ident = {
469 .options = WDIOF_OVERHEAT |
470 WDIOF_CARDRESET |
471 WDIOF_KEEPALIVEPING |
472 WDIOF_SETTIMEOUT |
473 WDIOF_MAGICCLOSE,
474 .firmware_version = 1,
475 .identity = WATCHDOG_DRIVER_NAME,
476 };
477
478 switch (cmd) {
479 case WDIOC_GETSUPPORT:
480 return copy_to_user(argp, &ident, sizeof(ident)) ? -EFAULT : 0;
481
482 case WDIOC_GETSTATUS:
483 {
484 int status;
485 pcipcwd_get_status(&status);
486 return put_user(status, p);
487 }
488
489 case WDIOC_GETBOOTSTATUS:
490 return put_user(pcipcwd_private.boot_status, p);
491
492 case WDIOC_GETTEMP:
493 {
494 int temperature;
495
496 if (pcipcwd_get_temperature(&temperature))
497 return -EFAULT;
498
499 return put_user(temperature, p);
500 }
501
502 case WDIOC_SETOPTIONS:
503 {
504 int new_options, retval = -EINVAL;
505
506 if (get_user(new_options, p))
507 return -EFAULT;
508
509 if (new_options & WDIOS_DISABLECARD) {
510 if (pcipcwd_stop())
511 return -EIO;
512 retval = 0;
513 }
514
515 if (new_options & WDIOS_ENABLECARD) {
516 if (pcipcwd_start())
517 return -EIO;
518 retval = 0;
519 }
520
521 if (new_options & WDIOS_TEMPPANIC) {
522 temp_panic = 1;
523 retval = 0;
524 }
525
526 return retval;
527 }
528
529 case WDIOC_KEEPALIVE:
530 pcipcwd_keepalive();
531 return 0;
532
533 case WDIOC_SETTIMEOUT:
534 {
535 int new_heartbeat;
536
537 if (get_user(new_heartbeat, p))
538 return -EFAULT;
539
540 if (pcipcwd_set_heartbeat(new_heartbeat))
541 return -EINVAL;
542
543 pcipcwd_keepalive();
544 }
545
546
547 case WDIOC_GETTIMEOUT:
548 return put_user(heartbeat, p);
549
550 case WDIOC_GETTIMELEFT:
551 {
552 int time_left;
553
554 if (pcipcwd_get_timeleft(&time_left))
555 return -EFAULT;
556
557 return put_user(time_left, p);
558 }
559
560 default:
561 return -ENOTTY;
562 }
563 }
564
565 static int pcipcwd_open(struct inode *inode, struct file *file)
566 {
567
568 if (test_and_set_bit(0, &is_active)) {
569 if (debug >= VERBOSE)
570 pr_err("Attempt to open already opened device\n");
571 return -EBUSY;
572 }
573
574
575 pcipcwd_start();
576 pcipcwd_keepalive();
577 return stream_open(inode, file);
578 }
579
580 static int pcipcwd_release(struct inode *inode, struct file *file)
581 {
582
583
584
585 if (expect_release == 42) {
586 pcipcwd_stop();
587 } else {
588 pr_crit("Unexpected close, not stopping watchdog!\n");
589 pcipcwd_keepalive();
590 }
591 expect_release = 0;
592 clear_bit(0, &is_active);
593 return 0;
594 }
595
596
597
598
599
600 static ssize_t pcipcwd_temp_read(struct file *file, char __user *data,
601 size_t len, loff_t *ppos)
602 {
603 int temperature;
604
605 if (pcipcwd_get_temperature(&temperature))
606 return -EFAULT;
607
608 if (copy_to_user(data, &temperature, 1))
609 return -EFAULT;
610
611 return 1;
612 }
613
614 static int pcipcwd_temp_open(struct inode *inode, struct file *file)
615 {
616 if (!pcipcwd_private.supports_temp)
617 return -ENODEV;
618
619 return stream_open(inode, file);
620 }
621
622 static int pcipcwd_temp_release(struct inode *inode, struct file *file)
623 {
624 return 0;
625 }
626
627
628
629
630
631 static int pcipcwd_notify_sys(struct notifier_block *this, unsigned long code,
632 void *unused)
633 {
634 if (code == SYS_DOWN || code == SYS_HALT)
635 pcipcwd_stop();
636
637 return NOTIFY_DONE;
638 }
639
640
641
642
643
644 static const struct file_operations pcipcwd_fops = {
645 .owner = THIS_MODULE,
646 .llseek = no_llseek,
647 .write = pcipcwd_write,
648 .unlocked_ioctl = pcipcwd_ioctl,
649 .open = pcipcwd_open,
650 .release = pcipcwd_release,
651 };
652
653 static struct miscdevice pcipcwd_miscdev = {
654 .minor = WATCHDOG_MINOR,
655 .name = "watchdog",
656 .fops = &pcipcwd_fops,
657 };
658
659 static const struct file_operations pcipcwd_temp_fops = {
660 .owner = THIS_MODULE,
661 .llseek = no_llseek,
662 .read = pcipcwd_temp_read,
663 .open = pcipcwd_temp_open,
664 .release = pcipcwd_temp_release,
665 };
666
667 static struct miscdevice pcipcwd_temp_miscdev = {
668 .minor = TEMP_MINOR,
669 .name = "temperature",
670 .fops = &pcipcwd_temp_fops,
671 };
672
673 static struct notifier_block pcipcwd_notifier = {
674 .notifier_call = pcipcwd_notify_sys,
675 };
676
677
678
679
680
681 static int pcipcwd_card_init(struct pci_dev *pdev,
682 const struct pci_device_id *ent)
683 {
684 int ret = -EIO;
685
686 cards_found++;
687 if (cards_found == 1)
688 pr_info("%s\n", DRIVER_VERSION);
689
690 if (cards_found > 1) {
691 pr_err("This driver only supports 1 device\n");
692 return -ENODEV;
693 }
694
695 if (pci_enable_device(pdev)) {
696 pr_err("Not possible to enable PCI Device\n");
697 return -ENODEV;
698 }
699
700 if (pci_resource_start(pdev, 0) == 0x0000) {
701 pr_err("No I/O-Address for card detected\n");
702 ret = -ENODEV;
703 goto err_out_disable_device;
704 }
705
706 spin_lock_init(&pcipcwd_private.io_lock);
707 pcipcwd_private.pdev = pdev;
708 pcipcwd_private.io_addr = pci_resource_start(pdev, 0);
709
710 if (pci_request_regions(pdev, WATCHDOG_NAME)) {
711 pr_err("I/O address 0x%04x already in use\n",
712 (int) pcipcwd_private.io_addr);
713 ret = -EIO;
714 goto err_out_disable_device;
715 }
716
717
718 pcipcwd_get_status(&pcipcwd_private.boot_status);
719
720
721 pcipcwd_clear_status();
722
723
724 pcipcwd_stop();
725
726
727 pcipcwd_check_temperature_support();
728
729
730 pcipcwd_show_card_info();
731
732
733 if (heartbeat == 0)
734 heartbeat =
735 heartbeat_tbl[(pcipcwd_get_option_switches() & 0x07)];
736
737
738
739 if (pcipcwd_set_heartbeat(heartbeat)) {
740 pcipcwd_set_heartbeat(WATCHDOG_HEARTBEAT);
741 pr_info("heartbeat value must be 0<heartbeat<65536, using %d\n",
742 WATCHDOG_HEARTBEAT);
743 }
744
745 ret = register_reboot_notifier(&pcipcwd_notifier);
746 if (ret != 0) {
747 pr_err("cannot register reboot notifier (err=%d)\n", ret);
748 goto err_out_release_region;
749 }
750
751 if (pcipcwd_private.supports_temp) {
752 ret = misc_register(&pcipcwd_temp_miscdev);
753 if (ret != 0) {
754 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
755 TEMP_MINOR, ret);
756 goto err_out_unregister_reboot;
757 }
758 }
759
760 ret = misc_register(&pcipcwd_miscdev);
761 if (ret != 0) {
762 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
763 WATCHDOG_MINOR, ret);
764 goto err_out_misc_deregister;
765 }
766
767 pr_info("initialized. heartbeat=%d sec (nowayout=%d)\n",
768 heartbeat, nowayout);
769
770 return 0;
771
772 err_out_misc_deregister:
773 if (pcipcwd_private.supports_temp)
774 misc_deregister(&pcipcwd_temp_miscdev);
775 err_out_unregister_reboot:
776 unregister_reboot_notifier(&pcipcwd_notifier);
777 err_out_release_region:
778 pci_release_regions(pdev);
779 err_out_disable_device:
780 pci_disable_device(pdev);
781 return ret;
782 }
783
784 static void pcipcwd_card_exit(struct pci_dev *pdev)
785 {
786
787 if (!nowayout)
788 pcipcwd_stop();
789
790
791 misc_deregister(&pcipcwd_miscdev);
792 if (pcipcwd_private.supports_temp)
793 misc_deregister(&pcipcwd_temp_miscdev);
794 unregister_reboot_notifier(&pcipcwd_notifier);
795 pci_release_regions(pdev);
796 pci_disable_device(pdev);
797 cards_found--;
798 }
799
800 static const struct pci_device_id pcipcwd_pci_tbl[] = {
801 { PCI_VENDOR_ID_QUICKLOGIC, PCI_DEVICE_ID_WATCHDOG_PCIPCWD,
802 PCI_ANY_ID, PCI_ANY_ID, },
803 { 0 },
804 };
805 MODULE_DEVICE_TABLE(pci, pcipcwd_pci_tbl);
806
807 static struct pci_driver pcipcwd_driver = {
808 .name = WATCHDOG_NAME,
809 .id_table = pcipcwd_pci_tbl,
810 .probe = pcipcwd_card_init,
811 .remove = pcipcwd_card_exit,
812 };
813
814 module_pci_driver(pcipcwd_driver);
815
816 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
817 MODULE_DESCRIPTION("Berkshire PCI-PC Watchdog driver");
818 MODULE_LICENSE("GPL");