5 * SoftDog 0.05: A Software Watchdog Device
7 * (c) Copyright 2007 Hewlett-Packard Development Company, L.P.
8 * Thomas Mingarelli <thomas.mingarelli@hp.com>
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * version 2 as published by the Free Software Foundation
16 #include <linux/device.h>
18 #include <linux/init.h>
20 #include <linux/bitops.h>
21 #include <linux/kernel.h>
22 #include <linux/miscdevice.h>
23 #include <linux/module.h>
24 #include <linux/moduleparam.h>
25 #include <linux/pci.h>
26 #include <linux/pci_ids.h>
27 #include <linux/types.h>
28 #include <linux/uaccess.h>
29 #include <linux/watchdog.h>
30 #ifdef CONFIG_HPWDT_NMI_DECODING
31 #include <linux/dmi.h>
32 #include <linux/spinlock.h>
33 #include <linux/nmi.h>
34 #include <linux/kdebug.h>
35 #include <linux/notifier.h>
36 #include <asm/cacheflush.h>
37 #endif /* CONFIG_HPWDT_NMI_DECODING */
39 #define HPWDT_VERSION "1.3.0"
40 #define SECS_TO_TICKS(secs) ((secs) * 1000 / 128)
41 #define TICKS_TO_SECS(ticks) ((ticks) * 128 / 1000)
42 #define HPWDT_MAX_TIMER TICKS_TO_SECS(65535)
43 #define DEFAULT_MARGIN 30
45 static unsigned int soft_margin
= DEFAULT_MARGIN
; /* in seconds */
46 static unsigned int reload
; /* the computed soft_margin */
47 static int nowayout
= WATCHDOG_NOWAYOUT
;
48 static char expect_release
;
49 static unsigned long hpwdt_is_open
;
51 static void __iomem
*pci_mem_addr
; /* the PCI-memory address */
52 static unsigned long __iomem
*hpwdt_timer_reg
;
53 static unsigned long __iomem
*hpwdt_timer_con
;
55 static DEFINE_PCI_DEVICE_TABLE(hpwdt_devices
) = {
56 { PCI_DEVICE(PCI_VENDOR_ID_COMPAQ
, 0xB203) }, /* iLO2 */
57 { PCI_DEVICE(PCI_VENDOR_ID_HP
, 0x3306) }, /* iLO3 */
58 {0}, /* terminate list */
60 MODULE_DEVICE_TABLE(pci
, hpwdt_devices
);
62 #ifdef CONFIG_HPWDT_NMI_DECODING
63 #define PCI_BIOS32_SD_VALUE 0x5F32335F /* "_32_" */
64 #define CRU_BIOS_SIGNATURE_VALUE 0x55524324
65 #define PCI_BIOS32_PARAGRAPH_LEN 16
66 #define PCI_ROM_BASE1 0x000F0000
67 #define ROM_SIZE 0x10000
69 struct bios32_service_dir
{
79 struct smbios_cru64_info
{
88 #define SMBIOS_CRU64_INFORMATION 212
91 struct smbios_proliant_info
{
100 #define SMBIOS_ICRU_INFORMATION 219
103 struct cmn_registers
{
143 } __attribute__((packed
));
145 static unsigned int hpwdt_nmi_decoding
;
146 static unsigned int allow_kdump
;
147 static unsigned int priority
; /* hpwdt at end of die_notify list */
148 static unsigned int is_icru
;
149 static DEFINE_SPINLOCK(rom_lock
);
150 static void *cru_rom_addr
;
151 static struct cmn_registers cmn_regs
;
153 extern asmlinkage
void asminline_call(struct cmn_registers
*pi86Regs
,
154 unsigned long *pRomEntry
);
157 /* --32 Bit Bios------------------------------------------------------------ */
159 #define HPWDT_ARCH 32
163 "asminline_call: \n\t"
165 "movl %esp, %ebp \n\t"
171 "movl 8(%ebp),%eax \n\t"
172 "movl 4(%eax),%ebx \n\t"
173 "movl 8(%eax),%ecx \n\t"
174 "movl 12(%eax),%edx \n\t"
175 "movl 16(%eax),%esi \n\t"
176 "movl 20(%eax),%edi \n\t"
177 "movl (%eax),%eax \n\t"
179 "call *12(%ebp) \n\t"
182 "movl 8(%ebp),%eax \n\t"
183 "movl %ebx,4(%eax) \n\t"
184 "movl %ecx,8(%eax) \n\t"
185 "movl %edx,12(%eax) \n\t"
186 "movl %esi,16(%eax) \n\t"
187 "movl %edi,20(%eax) \n\t"
188 "movw %ds,24(%eax) \n\t"
189 "movw %es,26(%eax) \n\t"
191 "movl %ebx,(%eax) \n\t"
193 "movl %ebx,28(%eax) \n\t"
205 * Routine Description:
206 * This function uses the 32-bit BIOS Service Directory record to
207 * search for a $CRU record.
213 static int __devinit
cru_detect(unsigned long map_entry
,
214 unsigned long map_offset
)
217 unsigned long *bios32_entrypoint
;
218 unsigned long cru_physical_address
;
219 unsigned long cru_length
;
220 unsigned long physical_bios_base
= 0;
221 unsigned long physical_bios_offset
= 0;
222 int retval
= -ENODEV
;
224 bios32_map
= ioremap(map_entry
, (2 * PAGE_SIZE
));
226 if (bios32_map
== NULL
)
229 bios32_entrypoint
= bios32_map
+ map_offset
;
231 cmn_regs
.u1
.reax
= CRU_BIOS_SIGNATURE_VALUE
;
233 asminline_call(&cmn_regs
, bios32_entrypoint
);
235 if (cmn_regs
.u1
.ral
!= 0) {
237 "hpwdt: Call succeeded but with an error: 0x%x\n",
240 physical_bios_base
= cmn_regs
.u2
.rebx
;
241 physical_bios_offset
= cmn_regs
.u4
.redx
;
242 cru_length
= cmn_regs
.u3
.recx
;
243 cru_physical_address
=
244 physical_bios_base
+ physical_bios_offset
;
246 /* If the values look OK, then map it in. */
247 if ((physical_bios_base
+ physical_bios_offset
)) {
249 ioremap(cru_physical_address
, cru_length
);
254 printk(KERN_DEBUG
"hpwdt: CRU Base Address: 0x%lx\n",
256 printk(KERN_DEBUG
"hpwdt: CRU Offset Address: 0x%lx\n",
257 physical_bios_offset
);
258 printk(KERN_DEBUG
"hpwdt: CRU Length: 0x%lx\n",
260 printk(KERN_DEBUG
"hpwdt: CRU Mapped Address: %p\n",
270 static int __devinit
bios_checksum(const char __iomem
*ptr
, int len
)
276 * calculate checksum of size bytes. This should add up
277 * to zero if we have a valid header.
279 for (i
= 0; i
< len
; i
++)
282 return ((sum
== 0) && (len
> 0));
288 * Routine Description:
289 * This function finds the 32-bit BIOS Service Directory
295 static int __devinit
bios32_present(const char __iomem
*p
)
297 struct bios32_service_dir
*bios_32_ptr
;
299 unsigned long map_entry
, map_offset
;
301 bios_32_ptr
= (struct bios32_service_dir
*) p
;
304 * Search for signature by checking equal to the swizzled value
305 * instead of calling another routine to perform a strcmp.
307 if (bios_32_ptr
->signature
== PCI_BIOS32_SD_VALUE
) {
308 length
= bios_32_ptr
->length
* PCI_BIOS32_PARAGRAPH_LEN
;
309 if (bios_checksum(p
, length
)) {
311 * According to the spec, we're looking for the
312 * first 4KB-aligned address below the entrypoint
313 * listed in the header. The Service Directory code
314 * is guaranteed to occupy no more than 2 4KB pages.
316 map_entry
= bios_32_ptr
->entry_point
& ~(PAGE_SIZE
- 1);
317 map_offset
= bios_32_ptr
->entry_point
- map_entry
;
319 return cru_detect(map_entry
, map_offset
);
325 static int __devinit
detect_cru_service(void)
331 * Search from 0x0f0000 through 0x0fffff, inclusive.
333 p
= ioremap(PCI_ROM_BASE1
, ROM_SIZE
);
337 for (q
= p
; q
< p
+ ROM_SIZE
; q
+= 16) {
338 rc
= bios32_present(q
);
345 /* ------------------------------------------------------------------------- */
346 #endif /* CONFIG_X86_32 */
348 /* --64 Bit Bios------------------------------------------------------------ */
350 #define HPWDT_ARCH 64
354 "asminline_call: \n\t"
356 "movq %rsp, %rbp \n\t"
362 "movq %rsi, %r12 \n\t"
363 "movq %rdi, %r9 \n\t"
364 "movl 4(%r9),%ebx \n\t"
365 "movl 8(%r9),%ecx \n\t"
366 "movl 12(%r9),%edx \n\t"
367 "movl 16(%r9),%esi \n\t"
368 "movl 20(%r9),%edi \n\t"
369 "movl (%r9),%eax \n\t"
373 "movl %eax, (%r9) \n\t"
374 "movl %ebx, 4(%r9) \n\t"
375 "movl %ecx, 8(%r9) \n\t"
376 "movl %edx, 12(%r9) \n\t"
377 "movl %esi, 16(%r9) \n\t"
378 "movl %edi, 20(%r9) \n\t"
379 "movq %r12, %rax \n\t"
380 "movl %eax, 28(%r9) \n\t"
393 * Routine Description:
394 * This function checks whether or not a SMBIOS/DMI record is
395 * the 64bit CRU info or not
397 static void __devinit
dmi_find_cru(const struct dmi_header
*dm
, void *dummy
)
399 struct smbios_cru64_info
*smbios_cru64_ptr
;
400 unsigned long cru_physical_address
;
402 if (dm
->type
== SMBIOS_CRU64_INFORMATION
) {
403 smbios_cru64_ptr
= (struct smbios_cru64_info
*) dm
;
404 if (smbios_cru64_ptr
->signature
== CRU_BIOS_SIGNATURE_VALUE
) {
405 cru_physical_address
=
406 smbios_cru64_ptr
->physical_address
+
407 smbios_cru64_ptr
->double_offset
;
408 cru_rom_addr
= ioremap(cru_physical_address
,
409 smbios_cru64_ptr
->double_length
);
410 set_memory_x((unsigned long)cru_rom_addr
& PAGE_MASK
,
411 smbios_cru64_ptr
->double_length
>> PAGE_SHIFT
);
416 static int __devinit
detect_cru_service(void)
420 dmi_walk(dmi_find_cru
, NULL
);
422 /* if cru_rom_addr has been set then we found a CRU service */
423 return ((cru_rom_addr
!= NULL
) ? 0 : -ENODEV
);
425 /* ------------------------------------------------------------------------- */
426 #endif /* CONFIG_X86_64 */
427 #endif /* CONFIG_HPWDT_NMI_DECODING */
430 * Watchdog operations
432 static void hpwdt_start(void)
434 reload
= SECS_TO_TICKS(soft_margin
);
435 iowrite16(reload
, hpwdt_timer_reg
);
436 iowrite16(0x85, hpwdt_timer_con
);
439 static void hpwdt_stop(void)
443 data
= ioread16(hpwdt_timer_con
);
445 iowrite16(data
, hpwdt_timer_con
);
448 static void hpwdt_ping(void)
450 iowrite16(reload
, hpwdt_timer_reg
);
453 static int hpwdt_change_timer(int new_margin
)
455 if (new_margin
< 1 || new_margin
> HPWDT_MAX_TIMER
) {
457 "hpwdt: New value passed in is invalid: %d seconds.\n",
462 soft_margin
= new_margin
;
464 "hpwdt: New timer passed in is %d seconds.\n",
466 reload
= SECS_TO_TICKS(soft_margin
);
471 static int hpwdt_time_left(void)
473 return TICKS_TO_SECS(ioread16(hpwdt_timer_reg
));
476 #ifdef CONFIG_HPWDT_NMI_DECODING
480 static int hpwdt_pretimeout(struct notifier_block
*nb
, unsigned long ulReason
,
483 unsigned long rom_pl
;
484 static int die_nmi_called
;
486 if (ulReason
!= DIE_NMIUNKNOWN
)
489 if (!hpwdt_nmi_decoding
)
492 spin_lock_irqsave(&rom_lock
, rom_pl
);
493 if (!die_nmi_called
&& !is_icru
)
494 asminline_call(&cmn_regs
, cru_rom_addr
);
496 spin_unlock_irqrestore(&rom_lock
, rom_pl
);
498 if (cmn_regs
.u1
.ral
== 0) {
499 printk(KERN_WARNING
"hpwdt: An NMI occurred, "
500 "but unable to determine source.\n");
506 panic("An NMI occurred, please see the Integrated "
507 "Management Log for details.\n");
512 #endif /* CONFIG_HPWDT_NMI_DECODING */
515 * /dev/watchdog handling
517 static int hpwdt_open(struct inode
*inode
, struct file
*file
)
519 /* /dev/watchdog can only be opened once */
520 if (test_and_set_bit(0, &hpwdt_is_open
))
523 /* Start the watchdog */
527 return nonseekable_open(inode
, file
);
530 static int hpwdt_release(struct inode
*inode
, struct file
*file
)
532 /* Stop the watchdog */
533 if (expect_release
== 42) {
537 "hpwdt: Unexpected close, not stopping watchdog!\n");
543 /* /dev/watchdog is being closed, make sure it can be re-opened */
544 clear_bit(0, &hpwdt_is_open
);
549 static ssize_t
hpwdt_write(struct file
*file
, const char __user
*data
,
550 size_t len
, loff_t
*ppos
)
552 /* See if we got the magic character 'V' and reload the timer */
557 /* note: just in case someone wrote the magic character
558 * five months ago... */
561 /* scan to see whether or not we got the magic char. */
562 for (i
= 0; i
!= len
; i
++) {
564 if (get_user(c
, data
+ i
))
571 /* someone wrote to us, we should reload the timer */
578 static const struct watchdog_info ident
= {
579 .options
= WDIOF_SETTIMEOUT
|
580 WDIOF_KEEPALIVEPING
|
582 .identity
= "HP iLO2+ HW Watchdog Timer",
585 static long hpwdt_ioctl(struct file
*file
, unsigned int cmd
,
588 void __user
*argp
= (void __user
*)arg
;
589 int __user
*p
= argp
;
594 case WDIOC_GETSUPPORT
:
596 if (copy_to_user(argp
, &ident
, sizeof(ident
)))
600 case WDIOC_GETSTATUS
:
601 case WDIOC_GETBOOTSTATUS
:
602 ret
= put_user(0, p
);
605 case WDIOC_KEEPALIVE
:
610 case WDIOC_SETTIMEOUT
:
611 ret
= get_user(new_margin
, p
);
615 ret
= hpwdt_change_timer(new_margin
);
621 case WDIOC_GETTIMEOUT
:
622 ret
= put_user(soft_margin
, p
);
625 case WDIOC_GETTIMELEFT
:
626 ret
= put_user(hpwdt_time_left(), p
);
635 static const struct file_operations hpwdt_fops
= {
636 .owner
= THIS_MODULE
,
638 .write
= hpwdt_write
,
639 .unlocked_ioctl
= hpwdt_ioctl
,
641 .release
= hpwdt_release
,
644 static struct miscdevice hpwdt_miscdev
= {
645 .minor
= WATCHDOG_MINOR
,
650 #ifdef CONFIG_HPWDT_NMI_DECODING
651 static struct notifier_block die_notifier
= {
652 .notifier_call
= hpwdt_pretimeout
,
655 #endif /* CONFIG_HPWDT_NMI_DECODING */
661 #ifdef CONFIG_HPWDT_NMI_DECODING
662 #ifdef CONFIG_X86_LOCAL_APIC
663 static void __devinit
hpwdt_check_nmi_decoding(struct pci_dev
*dev
)
666 * If nmi_watchdog is turned off then we can turn on
667 * our nmi decoding capability.
669 hpwdt_nmi_decoding
= 1;
672 static void __devinit
hpwdt_check_nmi_decoding(struct pci_dev
*dev
)
674 dev_warn(&dev
->dev
, "NMI decoding is disabled. "
675 "Your kernel does not support a NMI Watchdog.\n");
677 #endif /* CONFIG_X86_LOCAL_APIC */
682 * Routine Description:
683 * This function checks whether or not we are on an iCRU-based server.
684 * This check is independent of architecture and needs to be made for
685 * any ProLiant system.
687 static void __devinit
dmi_find_icru(const struct dmi_header
*dm
, void *dummy
)
689 struct smbios_proliant_info
*smbios_proliant_ptr
;
691 if (dm
->type
== SMBIOS_ICRU_INFORMATION
) {
692 smbios_proliant_ptr
= (struct smbios_proliant_info
*) dm
;
693 if (smbios_proliant_ptr
->misc_features
& 0x01)
698 static int __devinit
hpwdt_init_nmi_decoding(struct pci_dev
*dev
)
703 * On typical CRU-based systems we need to map that service in
704 * the BIOS. For 32 bit Operating Systems we need to go through
705 * the 32 Bit BIOS Service Directory. For 64 bit Operating
706 * Systems we get that service through SMBIOS.
708 * On systems that support the new iCRU service all we need to
709 * do is call dmi_walk to get the supported flag value and skip
710 * the old cru detect code.
712 dmi_walk(dmi_find_icru
, NULL
);
716 * We need to map the ROM to get the CRU service.
717 * For 32 bit Operating Systems we need to go through the 32 Bit
718 * BIOS Service Directory
719 * For 64 bit Operating Systems we get that service through SMBIOS.
721 retval
= detect_cru_service();
724 "Unable to detect the %d Bit CRU Service.\n",
730 * We know this is the only CRU call we need to make so lets keep as
731 * few instructions as possible once the NMI comes in.
733 cmn_regs
.u1
.rah
= 0x0D;
734 cmn_regs
.u1
.ral
= 0x02;
738 * If the priority is set to 1, then we will be put first on the
739 * die notify list to handle a critical NMI. The default is to
740 * be last so other users of the NMI signal can function.
743 die_notifier
.priority
= 0x7FFFFFFF;
745 retval
= register_die_notifier(&die_notifier
);
748 "Unable to register a die notifier (err=%d).\n",
751 iounmap(cru_rom_addr
);
755 "HP Watchdog Timer Driver: NMI decoding initialized"
756 ", allow kernel dump: %s (default = 0/OFF)"
757 ", priority: %s (default = 0/LAST).\n",
758 (allow_kdump
== 0) ? "OFF" : "ON",
759 (priority
== 0) ? "LAST" : "FIRST");
763 static void hpwdt_exit_nmi_decoding(void)
765 unregister_die_notifier(&die_notifier
);
767 iounmap(cru_rom_addr
);
769 #else /* !CONFIG_HPWDT_NMI_DECODING */
770 static void __devinit
hpwdt_check_nmi_decoding(struct pci_dev
*dev
)
774 static int __devinit
hpwdt_init_nmi_decoding(struct pci_dev
*dev
)
779 static void hpwdt_exit_nmi_decoding(void)
782 #endif /* CONFIG_HPWDT_NMI_DECODING */
784 static int __devinit
hpwdt_init_one(struct pci_dev
*dev
,
785 const struct pci_device_id
*ent
)
790 * Check if we can do NMI decoding or not
792 hpwdt_check_nmi_decoding(dev
);
795 * First let's find out if we are on an iLO2+ server. We will
796 * not run on a legacy ASM box.
797 * So we only support the G5 ProLiant servers and higher.
799 if (dev
->subsystem_vendor
!= PCI_VENDOR_ID_HP
) {
801 "This server does not have an iLO2+ ASIC.\n");
805 if (pci_enable_device(dev
)) {
807 "Not possible to enable PCI Device: 0x%x:0x%x.\n",
808 ent
->vendor
, ent
->device
);
812 pci_mem_addr
= pci_iomap(dev
, 1, 0x80);
815 "Unable to detect the iLO2+ server memory.\n");
817 goto error_pci_iomap
;
819 hpwdt_timer_reg
= pci_mem_addr
+ 0x70;
820 hpwdt_timer_con
= pci_mem_addr
+ 0x72;
822 /* Make sure that we have a valid soft_margin */
823 if (hpwdt_change_timer(soft_margin
))
824 hpwdt_change_timer(DEFAULT_MARGIN
);
826 /* Initialize NMI Decoding functionality */
827 retval
= hpwdt_init_nmi_decoding(dev
);
829 goto error_init_nmi_decoding
;
831 retval
= misc_register(&hpwdt_miscdev
);
834 "Unable to register miscdev on minor=%d (err=%d).\n",
835 WATCHDOG_MINOR
, retval
);
836 goto error_misc_register
;
839 dev_info(&dev
->dev
, "HP Watchdog Timer Driver: %s"
840 ", timer margin: %d seconds (nowayout=%d).\n",
841 HPWDT_VERSION
, soft_margin
, nowayout
);
845 hpwdt_exit_nmi_decoding();
846 error_init_nmi_decoding
:
847 pci_iounmap(dev
, pci_mem_addr
);
849 pci_disable_device(dev
);
853 static void __devexit
hpwdt_exit(struct pci_dev
*dev
)
858 misc_deregister(&hpwdt_miscdev
);
859 hpwdt_exit_nmi_decoding();
860 pci_iounmap(dev
, pci_mem_addr
);
861 pci_disable_device(dev
);
864 static struct pci_driver hpwdt_driver
= {
866 .id_table
= hpwdt_devices
,
867 .probe
= hpwdt_init_one
,
868 .remove
= __devexit_p(hpwdt_exit
),
871 static void __exit
hpwdt_cleanup(void)
873 pci_unregister_driver(&hpwdt_driver
);
876 static int __init
hpwdt_init(void)
878 return pci_register_driver(&hpwdt_driver
);
881 MODULE_AUTHOR("Tom Mingarelli");
882 MODULE_DESCRIPTION("hp watchdog driver");
883 MODULE_LICENSE("GPL");
884 MODULE_VERSION(HPWDT_VERSION
);
885 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR
);
887 module_param(soft_margin
, int, 0);
888 MODULE_PARM_DESC(soft_margin
, "Watchdog timeout in seconds");
890 module_param(nowayout
, int, 0);
891 MODULE_PARM_DESC(nowayout
, "Watchdog cannot be stopped once started (default="
892 __MODULE_STRING(WATCHDOG_NOWAYOUT
) ")");
894 #ifdef CONFIG_HPWDT_NMI_DECODING
895 module_param(allow_kdump
, int, 0);
896 MODULE_PARM_DESC(allow_kdump
, "Start a kernel dump after NMI occurs");
898 module_param(priority
, int, 0);
899 MODULE_PARM_DESC(priority
, "The hpwdt driver handles NMIs first or last"
900 " (default = 0/Last)\n");
901 #endif /* !CONFIG_HPWDT_NMI_DECODING */
903 module_init(hpwdt_init
);
904 module_exit(hpwdt_cleanup
);