2 * ALi M7101 PMU Computer Watchdog Timer driver
4 * Based on w83877f_wdt.c by Scott Jennings <linuxdrivers@oro.net>
5 * and the Cobalt kernel WDT timer driver by Tim Hockin
6 * <thockin@cobaltnet.com>
8 * (c)2002 Steve Hill <steve@navaho.co.uk>
10 * This WDT driver is different from most other Linux WDT
11 * drivers in that the driver will ping the watchdog by itself,
12 * because this particular WDT has a very short timeout (1.6
13 * seconds) and it would be insane to count on any userspace
14 * daemon always getting scheduled within that time frame.
17 * Aug 23, 2004 - Added use_gpio module parameter for use on revision a1d PMUs
18 * found on very old cobalt hardware.
19 * -- Mike Waychison <michael.waychison@sun.com>
22 #include <linux/module.h>
23 #include <linux/moduleparam.h>
24 #include <linux/types.h>
25 #include <linux/timer.h>
26 #include <linux/miscdevice.h>
27 #include <linux/watchdog.h>
28 #include <linux/ioport.h>
29 #include <linux/notifier.h>
30 #include <linux/reboot.h>
31 #include <linux/init.h>
33 #include <linux/pci.h>
35 #include <linux/uaccess.h>
37 #include <asm/system.h>
39 #define OUR_NAME "alim7101_wdt"
40 #define PFX OUR_NAME ": "
42 #define WDT_ENABLE 0x9C
43 #define WDT_DISABLE 0x8C
45 #define ALI_7101_WDT 0x92
46 #define ALI_7101_GPIO 0x7D
47 #define ALI_7101_GPIO_O 0x7E
48 #define ALI_WDT_ARM 0x01
51 * We're going to use a 1 second timeout.
52 * If we reset the watchdog every ~250ms we should be safe. */
54 #define WDT_INTERVAL (HZ/4+1)
57 * We must not require too good response from the userspace daemon.
58 * Here we require the userspace daemon to send us a heartbeat
59 * char to /dev/watchdog every 30 seconds.
62 #define WATCHDOG_TIMEOUT 30 /* 30 sec default timeout */
63 /* in seconds, will be multiplied by HZ to get seconds to wait for a ping */
64 static int timeout
= WATCHDOG_TIMEOUT
;
65 module_param(timeout
, int, 0);
66 MODULE_PARM_DESC(timeout
,
67 "Watchdog timeout in seconds. (1<=timeout<=3600, default="
68 __MODULE_STRING(WATCHDOG_TIMEOUT
) ")");
70 static int use_gpio
; /* Use the pic (for a1d revision alim7101) */
71 module_param(use_gpio
, int, 0);
72 MODULE_PARM_DESC(use_gpio
,
73 "Use the gpio watchdog (required by old cobalt boards).");
75 static void wdt_timer_ping(unsigned long);
76 static DEFINE_TIMER(timer
, wdt_timer_ping
, 0, 1);
77 static unsigned long next_heartbeat
;
78 static unsigned long wdt_is_open
;
79 static char wdt_expect_close
;
80 static struct pci_dev
*alim7101_pmu
;
82 static int nowayout
= WATCHDOG_NOWAYOUT
;
83 module_param(nowayout
, int, 0);
84 MODULE_PARM_DESC(nowayout
,
85 "Watchdog cannot be stopped once started (default="
86 __MODULE_STRING(WATCHDOG_NOWAYOUT
) ")");
92 static void wdt_timer_ping(unsigned long data
)
94 /* If we got a heartbeat pulse within the WDT_US_INTERVAL
95 * we agree to ping the WDT
99 if (time_before(jiffies
, next_heartbeat
)) {
100 /* Ping the WDT (this is actually a disarm/arm sequence) */
101 pci_read_config_byte(alim7101_pmu
, 0x92, &tmp
);
102 pci_write_config_byte(alim7101_pmu
,
103 ALI_7101_WDT
, (tmp
& ~ALI_WDT_ARM
));
104 pci_write_config_byte(alim7101_pmu
,
105 ALI_7101_WDT
, (tmp
| ALI_WDT_ARM
));
107 pci_read_config_byte(alim7101_pmu
,
108 ALI_7101_GPIO_O
, &tmp
);
109 pci_write_config_byte(alim7101_pmu
,
110 ALI_7101_GPIO_O
, tmp
| 0x20);
111 pci_write_config_byte(alim7101_pmu
,
112 ALI_7101_GPIO_O
, tmp
& ~0x20);
115 printk(KERN_WARNING PFX
116 "Heartbeat lost! Will not ping the watchdog\n");
118 /* Re-set the timer interval */
119 mod_timer(&timer
, jiffies
+ WDT_INTERVAL
);
126 static void wdt_change(int writeval
)
130 pci_read_config_byte(alim7101_pmu
, ALI_7101_WDT
, &tmp
);
131 if (writeval
== WDT_ENABLE
) {
132 pci_write_config_byte(alim7101_pmu
,
133 ALI_7101_WDT
, (tmp
| ALI_WDT_ARM
));
135 pci_read_config_byte(alim7101_pmu
,
136 ALI_7101_GPIO_O
, &tmp
);
137 pci_write_config_byte(alim7101_pmu
,
138 ALI_7101_GPIO_O
, tmp
& ~0x20);
142 pci_write_config_byte(alim7101_pmu
,
143 ALI_7101_WDT
, (tmp
& ~ALI_WDT_ARM
));
145 pci_read_config_byte(alim7101_pmu
,
146 ALI_7101_GPIO_O
, &tmp
);
147 pci_write_config_byte(alim7101_pmu
,
148 ALI_7101_GPIO_O
, tmp
| 0x20);
153 static void wdt_startup(void)
155 next_heartbeat
= jiffies
+ (timeout
* HZ
);
157 /* We must enable before we kick off the timer in case the timer
158 occurs as we ping it */
160 wdt_change(WDT_ENABLE
);
162 /* Start the timer */
163 mod_timer(&timer
, jiffies
+ WDT_INTERVAL
);
165 printk(KERN_INFO PFX
"Watchdog timer is now enabled.\n");
168 static void wdt_turnoff(void)
171 del_timer_sync(&timer
);
172 wdt_change(WDT_DISABLE
);
173 printk(KERN_INFO PFX
"Watchdog timer is now disabled...\n");
176 static void wdt_keepalive(void)
179 next_heartbeat
= jiffies
+ (timeout
* HZ
);
183 * /dev/watchdog handling
186 static ssize_t
fop_write(struct file
*file
, const char __user
*buf
,
187 size_t count
, loff_t
*ppos
)
189 /* See if we got the magic character 'V' and reload the timer */
194 /* note: just in case someone wrote the magic character
195 * five months ago... */
196 wdt_expect_close
= 0;
199 for (ofs
= 0; ofs
!= count
; ofs
++) {
201 if (get_user(c
, buf
+ ofs
))
204 wdt_expect_close
= 42;
207 /* someone wrote to us, we should restart timer */
213 static int fop_open(struct inode
*inode
, struct file
*file
)
215 /* Just in case we're already talking to someone... */
216 if (test_and_set_bit(0, &wdt_is_open
))
218 /* Good, fire up the show */
220 return nonseekable_open(inode
, file
);
223 static int fop_close(struct inode
*inode
, struct file
*file
)
225 if (wdt_expect_close
== 42)
228 /* wim: shouldn't there be a: del_timer(&timer); */
230 "device file closed unexpectedly. Will not stop the WDT!\n");
232 clear_bit(0, &wdt_is_open
);
233 wdt_expect_close
= 0;
237 static long fop_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
239 void __user
*argp
= (void __user
*)arg
;
240 int __user
*p
= argp
;
241 static struct watchdog_info ident
= {
242 .options
= WDIOF_KEEPALIVEPING
| WDIOF_SETTIMEOUT
244 .firmware_version
= 1,
245 .identity
= "ALiM7101",
249 case WDIOC_GETSUPPORT
:
250 return copy_to_user(argp
, &ident
, sizeof(ident
)) ? -EFAULT
: 0;
251 case WDIOC_GETSTATUS
:
252 case WDIOC_GETBOOTSTATUS
:
253 return put_user(0, p
);
254 case WDIOC_SETOPTIONS
:
256 int new_options
, retval
= -EINVAL
;
258 if (get_user(new_options
, p
))
260 if (new_options
& WDIOS_DISABLECARD
) {
264 if (new_options
& WDIOS_ENABLECARD
) {
270 case WDIOC_KEEPALIVE
:
273 case WDIOC_SETTIMEOUT
:
277 if (get_user(new_timeout
, p
))
279 /* arbitrary upper limit */
280 if (new_timeout
< 1 || new_timeout
> 3600)
282 timeout
= new_timeout
;
286 case WDIOC_GETTIMEOUT
:
287 return put_user(timeout
, p
);
293 static const struct file_operations wdt_fops
= {
294 .owner
= THIS_MODULE
,
298 .release
= fop_close
,
299 .unlocked_ioctl
= fop_ioctl
,
302 static struct miscdevice wdt_miscdev
= {
303 .minor
= WATCHDOG_MINOR
,
309 * Notifier for system down
312 static int wdt_notify_sys(struct notifier_block
*this,
313 unsigned long code
, void *unused
)
315 if (code
== SYS_DOWN
|| code
== SYS_HALT
)
318 if (code
== SYS_RESTART
) {
320 * Cobalt devices have no way of rebooting themselves other
321 * than getting the watchdog to pull reset, so we restart the
322 * watchdog on reboot with no heartbeat
324 wdt_change(WDT_ENABLE
);
325 printk(KERN_INFO PFX
"Watchdog timer is now enabled "
326 "with no heartbeat - should reboot in ~1 second.\n");
332 * The WDT needs to learn about soft shutdowns in order to
333 * turn the timebomb registers off.
336 static struct notifier_block wdt_notifier
= {
337 .notifier_call
= wdt_notify_sys
,
340 static void __exit
alim7101_wdt_unload(void)
344 misc_deregister(&wdt_miscdev
);
345 unregister_reboot_notifier(&wdt_notifier
);
346 pci_dev_put(alim7101_pmu
);
349 static int __init
alim7101_wdt_init(void)
352 struct pci_dev
*ali1543_south
;
355 printk(KERN_INFO PFX
"Steve Hill <steve@navaho.co.uk>.\n");
356 alim7101_pmu
= pci_get_device(PCI_VENDOR_ID_AL
, PCI_DEVICE_ID_AL_M7101
,
360 "ALi M7101 PMU not present - WDT not set\n");
364 /* Set the WDT in the PMU to 1 second */
365 pci_write_config_byte(alim7101_pmu
, ALI_7101_WDT
, 0x02);
367 ali1543_south
= pci_get_device(PCI_VENDOR_ID_AL
, PCI_DEVICE_ID_AL_M1533
,
369 if (!ali1543_south
) {
371 "ALi 1543 South-Bridge not present - WDT not set\n");
374 pci_read_config_byte(ali1543_south
, 0x5e, &tmp
);
375 pci_dev_put(ali1543_south
);
376 if ((tmp
& 0x1e) == 0x00) {
379 "Detected old alim7101 revision 'a1d'. "
380 "If this is a cobalt board, set the 'use_gpio' "
381 "module parameter.\n");
385 } else if ((tmp
& 0x1e) != 0x12 && (tmp
& 0x1e) != 0x00) {
387 "ALi 1543 South-Bridge does not have the correct "
388 "revision number (???1001?) - WDT not set\n");
392 if (timeout
< 1 || timeout
> 3600) {
393 /* arbitrary upper limit */
394 timeout
= WATCHDOG_TIMEOUT
;
396 "timeout value must be 1 <= x <= 3600, using %d\n",
400 rc
= register_reboot_notifier(&wdt_notifier
);
403 "cannot register reboot notifier (err=%d)\n", rc
);
407 rc
= misc_register(&wdt_miscdev
);
410 "cannot register miscdev on minor=%d (err=%d)\n",
411 wdt_miscdev
.minor
, rc
);
416 __module_get(THIS_MODULE
);
418 printk(KERN_INFO PFX
"WDT driver for ALi M7101 initialised. "
419 "timeout=%d sec (nowayout=%d)\n",
424 unregister_reboot_notifier(&wdt_notifier
);
426 pci_dev_put(alim7101_pmu
);
430 module_init(alim7101_wdt_init
);
431 module_exit(alim7101_wdt_unload
);
433 static struct pci_device_id alim7101_pci_tbl
[] __devinitdata
= {
434 { PCI_DEVICE(PCI_VENDOR_ID_AL
, PCI_DEVICE_ID_AL_M1533
) },
435 { PCI_DEVICE(PCI_VENDOR_ID_AL
, PCI_DEVICE_ID_AL_M7101
) },
439 MODULE_DEVICE_TABLE(pci
, alim7101_pci_tbl
);
441 MODULE_AUTHOR("Steve Hill");
442 MODULE_DESCRIPTION("ALi M7101 PMU Computer Watchdog Timer driver");
443 MODULE_LICENSE("GPL");
444 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR
);