2 * FIXME: add wdrtas_get_status and wdrtas_get_boot_status as soon as
3 * RTAS calls are available
9 * (C) Copyright IBM Corp. 2005
10 * device driver to exploit watchdog RTAS functions
12 * Authors : Utz Bacher <utz.bacher@de.ibm.com>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30 #include <linux/init.h>
31 #include <linux/kernel.h>
32 #include <linux/miscdevice.h>
33 #include <linux/module.h>
34 #include <linux/notifier.h>
35 #include <linux/reboot.h>
36 #include <linux/types.h>
37 #include <linux/watchdog.h>
38 #include <linux/uaccess.h>
42 #define WDRTAS_MAGIC_CHAR 42
43 #define WDRTAS_SUPPORTED_MASK (WDIOF_SETTIMEOUT | \
46 MODULE_AUTHOR("Utz Bacher <utz.bacher@de.ibm.com>");
47 MODULE_DESCRIPTION("RTAS watchdog driver");
48 MODULE_LICENSE("GPL");
49 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
50 MODULE_ALIAS_MISCDEV(TEMP_MINOR);
52 #ifdef CONFIG_WATCHDOG_NOWAYOUT
53 static int wdrtas_nowayout = 1;
55 static int wdrtas_nowayout = 0;
58 static atomic_t wdrtas_miscdev_open = ATOMIC_INIT(0);
59 static char wdrtas_expect_close;
61 static int wdrtas_interval;
63 #define WDRTAS_THERMAL_SENSOR 3
64 static int wdrtas_token_get_sensor_state;
65 #define WDRTAS_SURVEILLANCE_IND 9000
66 static int wdrtas_token_set_indicator;
67 #define WDRTAS_SP_SPI 28
68 static int wdrtas_token_get_sp;
69 static int wdrtas_token_event_scan;
71 #define WDRTAS_DEFAULT_INTERVAL 300
73 #define WDRTAS_LOGBUFFER_LEN 128
74 static char wdrtas_logbuffer[WDRTAS_LOGBUFFER_LEN];
77 /*** watchdog access functions */
80 * wdrtas_set_interval - sets the watchdog interval
81 * @interval: new interval
83 * returns 0 on success, <0 on failures
85 * wdrtas_set_interval sets the watchdog keepalive interval by calling the
86 * RTAS function set-indicator (surveillance). The unit of interval is
90 static int wdrtas_set_interval(int interval)
93 static int print_msg = 10;
95 /* rtas uses minutes */
96 interval = (interval + 59) / 60;
98 result = rtas_call(wdrtas_token_set_indicator, 3, 1, NULL,
99 WDRTAS_SURVEILLANCE_IND, 0, interval);
100 if (result < 0 && print_msg) {
101 printk(KERN_ERR "wdrtas: setting the watchdog to %i "
102 "timeout failed: %li\n", interval, result);
109 #define WDRTAS_SP_SPI_LEN 4
112 * wdrtas_get_interval - returns the current watchdog interval
113 * @fallback_value: value (in seconds) to use, if the RTAS call fails
115 * returns the interval
117 * wdrtas_get_interval returns the current watchdog keepalive interval
118 * as reported by the RTAS function ibm,get-system-parameter. The unit
119 * of the return value is seconds.
121 static int wdrtas_get_interval(int fallback_value)
124 char value[WDRTAS_SP_SPI_LEN];
126 spin_lock(&rtas_data_buf_lock);
127 memset(rtas_data_buf, 0, WDRTAS_SP_SPI_LEN);
128 result = rtas_call(wdrtas_token_get_sp, 3, 1, NULL,
129 WDRTAS_SP_SPI, __pa(rtas_data_buf),
132 memcpy(value, rtas_data_buf, WDRTAS_SP_SPI_LEN);
133 spin_unlock(&rtas_data_buf_lock);
135 if (value[0] != 0 || value[1] != 2 || value[3] != 0 || result < 0) {
136 printk(KERN_WARNING "wdrtas: could not get sp_spi watchdog "
137 "timeout (%li). Continuing\n", result);
138 return fallback_value;
141 /* rtas uses minutes */
142 return ((int)value[2]) * 60;
146 * wdrtas_timer_start - starts watchdog
148 * wdrtas_timer_start starts the watchdog by calling the RTAS function
149 * set-interval (surveillance)
151 static void wdrtas_timer_start(void)
153 wdrtas_set_interval(wdrtas_interval);
157 * wdrtas_timer_stop - stops watchdog
159 * wdrtas_timer_stop stops the watchdog timer by calling the RTAS function
160 * set-interval (surveillance)
162 static void wdrtas_timer_stop(void)
164 wdrtas_set_interval(0);
168 * wdrtas_log_scanned_event - logs an event we received during keepalive
170 * wdrtas_log_scanned_event prints a message to the log buffer dumping
171 * the results of the last event-scan call
173 static void wdrtas_log_scanned_event(void)
177 for (i = 0; i < WDRTAS_LOGBUFFER_LEN; i += 16)
178 printk(KERN_INFO "wdrtas: dumping event (line %i/%i), data = "
179 "%02x %02x %02x %02x %02x %02x %02x %02x "
180 "%02x %02x %02x %02x %02x %02x %02x %02x\n",
181 (i / 16) + 1, (WDRTAS_LOGBUFFER_LEN / 16),
182 wdrtas_logbuffer[i + 0], wdrtas_logbuffer[i + 1],
183 wdrtas_logbuffer[i + 2], wdrtas_logbuffer[i + 3],
184 wdrtas_logbuffer[i + 4], wdrtas_logbuffer[i + 5],
185 wdrtas_logbuffer[i + 6], wdrtas_logbuffer[i + 7],
186 wdrtas_logbuffer[i + 8], wdrtas_logbuffer[i + 9],
187 wdrtas_logbuffer[i + 10], wdrtas_logbuffer[i + 11],
188 wdrtas_logbuffer[i + 12], wdrtas_logbuffer[i + 13],
189 wdrtas_logbuffer[i + 14], wdrtas_logbuffer[i + 15]);
193 * wdrtas_timer_keepalive - resets watchdog timer to keep system alive
195 * wdrtas_timer_keepalive restarts the watchdog timer by calling the
196 * RTAS function event-scan and repeats these calls as long as there are
197 * events available. All events will be dumped.
199 static void wdrtas_timer_keepalive(void)
204 result = rtas_call(wdrtas_token_event_scan, 4, 1, NULL,
205 RTAS_EVENT_SCAN_ALL_EVENTS, 0,
206 (void *)__pa(wdrtas_logbuffer),
207 WDRTAS_LOGBUFFER_LEN);
209 printk(KERN_ERR "wdrtas: event-scan failed: %li\n",
212 wdrtas_log_scanned_event();
213 } while (result == 0);
217 * wdrtas_get_temperature - returns current temperature
219 * returns temperature or <0 on failures
221 * wdrtas_get_temperature returns the current temperature in Fahrenheit. It
222 * uses the RTAS call get-sensor-state, token 3 to do so
224 static int wdrtas_get_temperature(void)
229 result = rtas_call(wdrtas_token_get_sensor_state, 2, 2,
230 (void *)__pa(&temperature),
231 WDRTAS_THERMAL_SENSOR, 0);
234 printk(KERN_WARNING "wdrtas: reading the thermal sensor "
235 "faild: %li\n", result);
237 temperature = ((temperature * 9) / 5) + 32; /* fahrenheit */
243 * wdrtas_get_status - returns the status of the watchdog
245 * returns a bitmask of defines WDIOF_... as defined in
246 * include/linux/watchdog.h
248 static int wdrtas_get_status(void)
254 * wdrtas_get_boot_status - returns the reason for the last boot
256 * returns a bitmask of defines WDIOF_... as defined in
257 * include/linux/watchdog.h, indicating why the watchdog rebooted the system
259 static int wdrtas_get_boot_status(void)
264 /*** watchdog API and operations stuff */
266 /* wdrtas_write - called when watchdog device is written to
267 * @file: file structure
268 * @buf: user buffer with data
269 * @len: amount to data written
270 * @ppos: position in file
272 * returns the number of successfully processed characters, which is always
273 * the number of bytes passed to this function
275 * wdrtas_write processes all the data given to it and looks for the magic
276 * character 'V'. This character allows the watchdog device to be closed
279 static ssize_t wdrtas_write(struct file *file, const char __user *buf,
280 size_t len, loff_t *ppos)
288 if (!wdrtas_nowayout) {
289 wdrtas_expect_close = 0;
291 for (i = 0; i < len; i++) {
292 if (get_user(c, buf + i))
294 /* allow to close device */
296 wdrtas_expect_close = WDRTAS_MAGIC_CHAR;
300 wdrtas_timer_keepalive();
307 * wdrtas_ioctl - ioctl function for the watchdog device
308 * @file: file structure
309 * @cmd: command for ioctl
310 * @arg: argument pointer
312 * returns 0 on success, <0 on failure
314 * wdrtas_ioctl implements the watchdog API ioctls
317 static long wdrtas_ioctl(struct file *file, unsigned int cmd,
320 int __user *argp = (void __user *)arg;
322 static struct watchdog_info wdinfo = {
323 .options = WDRTAS_SUPPORTED_MASK,
324 .firmware_version = 0,
325 .identity = "wdrtas",
329 case WDIOC_GETSUPPORT:
330 if (copy_to_user(argp, &wdinfo, sizeof(wdinfo)))
334 case WDIOC_GETSTATUS:
335 i = wdrtas_get_status();
336 return put_user(i, argp);
338 case WDIOC_GETBOOTSTATUS:
339 i = wdrtas_get_boot_status();
340 return put_user(i, argp);
343 if (wdrtas_token_get_sensor_state == RTAS_UNKNOWN_SERVICE)
346 i = wdrtas_get_temperature();
347 return put_user(i, argp);
349 case WDIOC_SETOPTIONS:
350 if (get_user(i, argp))
352 if (i & WDIOS_DISABLECARD)
354 if (i & WDIOS_ENABLECARD) {
355 wdrtas_timer_keepalive();
356 wdrtas_timer_start();
358 /* not implemented. Done by H8
359 if (i & WDIOS_TEMPPANIC) {
363 case WDIOC_KEEPALIVE:
364 wdrtas_timer_keepalive();
367 case WDIOC_SETTIMEOUT:
368 if (get_user(i, argp))
371 if (wdrtas_set_interval(i))
374 wdrtas_timer_keepalive();
376 if (wdrtas_token_get_sp == RTAS_UNKNOWN_SERVICE)
379 wdrtas_interval = wdrtas_get_interval(i);
382 case WDIOC_GETTIMEOUT:
383 return put_user(wdrtas_interval, argp);
391 * wdrtas_open - open function of watchdog device
392 * @inode: inode structure
393 * @file: file structure
395 * returns 0 on success, -EBUSY if the file has been opened already, <0 on
398 * function called when watchdog device is opened
400 static int wdrtas_open(struct inode *inode, struct file *file)
403 if (atomic_inc_return(&wdrtas_miscdev_open) > 1) {
404 atomic_dec(&wdrtas_miscdev_open);
408 wdrtas_timer_start();
409 wdrtas_timer_keepalive();
411 return nonseekable_open(inode, file);
415 * wdrtas_close - close function of watchdog device
416 * @inode: inode structure
417 * @file: file structure
419 * returns 0 on success
421 * close function. Always succeeds
423 static int wdrtas_close(struct inode *inode, struct file *file)
425 /* only stop watchdog, if this was announced using 'V' before */
426 if (wdrtas_expect_close == WDRTAS_MAGIC_CHAR)
429 printk(KERN_WARNING "wdrtas: got unexpected close. Watchdog "
431 wdrtas_timer_keepalive();
434 wdrtas_expect_close = 0;
435 atomic_dec(&wdrtas_miscdev_open);
440 * wdrtas_temp_read - gives back the temperature in fahrenheit
441 * @file: file structure
443 * @count: number of bytes to be read
444 * @ppos: position in file
446 * returns always 1 or -EFAULT in case of user space copy failures, <0 on
449 * wdrtas_temp_read gives the temperature to the users by copying this
450 * value as one byte into the user space buffer. The unit is Fahrenheit...
452 static ssize_t wdrtas_temp_read(struct file *file, char __user *buf,
453 size_t count, loff_t *ppos)
457 temperature = wdrtas_get_temperature();
461 if (copy_to_user(buf, &temperature, 1))
468 * wdrtas_temp_open - open function of temperature device
469 * @inode: inode structure
470 * @file: file structure
472 * returns 0 on success, <0 on failure
474 * function called when temperature device is opened
476 static int wdrtas_temp_open(struct inode *inode, struct file *file)
478 return nonseekable_open(inode, file);
482 * wdrtas_temp_close - close function of temperature device
483 * @inode: inode structure
484 * @file: file structure
486 * returns 0 on success
488 * close function. Always succeeds
490 static int wdrtas_temp_close(struct inode *inode, struct file *file)
496 * wdrtas_reboot - reboot notifier function
497 * @nb: notifier block structure
501 * returns NOTIFY_DONE
503 * wdrtas_reboot stops the watchdog in case of a reboot
505 static int wdrtas_reboot(struct notifier_block *this,
506 unsigned long code, void *ptr)
508 if (code == SYS_DOWN || code == SYS_HALT)
514 /*** initialization stuff */
516 static const struct file_operations wdrtas_fops = {
517 .owner = THIS_MODULE,
519 .write = wdrtas_write,
520 .unlocked_ioctl = wdrtas_ioctl,
522 .release = wdrtas_close,
525 static struct miscdevice wdrtas_miscdev = {
526 .minor = WATCHDOG_MINOR,
528 .fops = &wdrtas_fops,
531 static const struct file_operations wdrtas_temp_fops = {
532 .owner = THIS_MODULE,
534 .read = wdrtas_temp_read,
535 .open = wdrtas_temp_open,
536 .release = wdrtas_temp_close,
539 static struct miscdevice wdrtas_tempdev = {
541 .name = "temperature",
542 .fops = &wdrtas_temp_fops,
545 static struct notifier_block wdrtas_notifier = {
546 .notifier_call = wdrtas_reboot,
550 * wdrtas_get_tokens - reads in RTAS tokens
552 * returns 0 on succes, <0 on failure
554 * wdrtas_get_tokens reads in the tokens for the RTAS calls used in
555 * this watchdog driver. It tolerates, if "get-sensor-state" and
556 * "ibm,get-system-parameter" are not available.
558 static int wdrtas_get_tokens(void)
560 wdrtas_token_get_sensor_state = rtas_token("get-sensor-state");
561 if (wdrtas_token_get_sensor_state == RTAS_UNKNOWN_SERVICE) {
562 printk(KERN_WARNING "wdrtas: couldn't get token for "
563 "get-sensor-state. Trying to continue without "
564 "temperature support.\n");
567 wdrtas_token_get_sp = rtas_token("ibm,get-system-parameter");
568 if (wdrtas_token_get_sp == RTAS_UNKNOWN_SERVICE) {
569 printk(KERN_WARNING "wdrtas: couldn't get token for "
570 "ibm,get-system-parameter. Trying to continue with "
571 "a default timeout value of %i seconds.\n",
572 WDRTAS_DEFAULT_INTERVAL);
575 wdrtas_token_set_indicator = rtas_token("set-indicator");
576 if (wdrtas_token_set_indicator == RTAS_UNKNOWN_SERVICE) {
577 printk(KERN_ERR "wdrtas: couldn't get token for "
578 "set-indicator. Terminating watchdog code.\n");
582 wdrtas_token_event_scan = rtas_token("event-scan");
583 if (wdrtas_token_event_scan == RTAS_UNKNOWN_SERVICE) {
584 printk(KERN_ERR "wdrtas: couldn't get token for event-scan. "
585 "Terminating watchdog code.\n");
593 * wdrtas_unregister_devs - unregisters the misc dev handlers
595 * wdrtas_register_devs unregisters the watchdog and temperature watchdog
598 static void wdrtas_unregister_devs(void)
600 misc_deregister(&wdrtas_miscdev);
601 if (wdrtas_token_get_sensor_state != RTAS_UNKNOWN_SERVICE)
602 misc_deregister(&wdrtas_tempdev);
606 * wdrtas_register_devs - registers the misc dev handlers
608 * returns 0 on succes, <0 on failure
610 * wdrtas_register_devs registers the watchdog and temperature watchdog
613 static int wdrtas_register_devs(void)
617 result = misc_register(&wdrtas_miscdev);
619 printk(KERN_ERR "wdrtas: couldn't register watchdog misc "
620 "device. Terminating watchdog code.\n");
624 if (wdrtas_token_get_sensor_state != RTAS_UNKNOWN_SERVICE) {
625 result = misc_register(&wdrtas_tempdev);
627 printk(KERN_WARNING "wdrtas: couldn't register "
628 "watchdog temperature misc device. Continuing "
629 "without temperature support.\n");
630 wdrtas_token_get_sensor_state = RTAS_UNKNOWN_SERVICE;
638 * wdrtas_init - init function of the watchdog driver
640 * returns 0 on succes, <0 on failure
642 * registers the file handlers and the reboot notifier
644 static int __init wdrtas_init(void)
646 if (wdrtas_get_tokens())
649 if (wdrtas_register_devs())
652 if (register_reboot_notifier(&wdrtas_notifier)) {
653 printk(KERN_ERR "wdrtas: could not register reboot notifier. "
654 "Terminating watchdog code.\n");
655 wdrtas_unregister_devs();
659 if (wdrtas_token_get_sp == RTAS_UNKNOWN_SERVICE)
660 wdrtas_interval = WDRTAS_DEFAULT_INTERVAL;
662 wdrtas_interval = wdrtas_get_interval(WDRTAS_DEFAULT_INTERVAL);
668 * wdrtas_exit - exit function of the watchdog driver
670 * unregisters the file handlers and the reboot notifier
672 static void __exit wdrtas_exit(void)
674 if (!wdrtas_nowayout)
677 wdrtas_unregister_devs();
679 unregister_reboot_notifier(&wdrtas_notifier);
682 module_init(wdrtas_init);
683 module_exit(wdrtas_exit);