2 * Copyright (C) 2001 Anton Blanchard <anton@au.ibm.com>, IBM
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Communication to userspace based on kernel/printk.c
12 #include <linux/types.h>
13 #include <linux/errno.h>
14 #include <linux/sched.h>
15 #include <linux/kernel.h>
16 #include <linux/poll.h>
17 #include <linux/proc_fs.h>
18 #include <linux/init.h>
19 #include <linux/vmalloc.h>
20 #include <linux/spinlock.h>
21 #include <linux/cpu.h>
22 #include <linux/delay.h>
24 #include <asm/uaccess.h>
28 #include <asm/nvram.h>
29 #include <asm/atomic.h>
30 #include <asm/machdep.h>
33 #define DEBUG(A...) printk(KERN_ERR A)
38 static DEFINE_SPINLOCK(rtasd_log_lock);
40 DECLARE_WAIT_QUEUE_HEAD(rtas_log_wait);
42 static char *rtas_log_buf;
43 static unsigned long rtas_log_start;
44 static unsigned long rtas_log_size;
46 static int surveillance_timeout = -1;
47 static unsigned int rtas_error_log_max;
48 static unsigned int rtas_error_log_buffer_max;
50 /* RTAS service tokens */
51 static unsigned int event_scan;
52 static unsigned int rtas_event_scan_rate;
54 static int full_rtas_msgs = 0;
56 /* Stop logging to nvram after first fatal error */
57 static int no_more_logging;
59 static int error_log_cnt;
62 * Since we use 32 bit RTAS, the physical address of this must be below
63 * 4G or else bad things happen. Allocate this in the kernel data and
66 static unsigned char logdata[RTAS_ERROR_LOG_MAX];
68 static char *rtas_type[] = {
69 "Unknown", "Retry", "TCE Error", "Internal Device Failure",
70 "Timeout", "Data Parity", "Address Parity", "Cache Parity",
71 "Address Invalid", "ECC Uncorrected", "ECC Corrupted",
74 static char *rtas_event_type(int type)
76 if ((type > 0) && (type < 11))
77 return rtas_type[type];
82 case RTAS_TYPE_PLATFORM:
83 return "Platform Error";
87 return "Platform Information Event";
88 case RTAS_TYPE_DEALLOC:
89 return "Resource Deallocation Event";
91 return "Dump Notification Event";
97 /* To see this info, grep RTAS /var/log/messages and each entry
98 * will be collected together with obvious begin/end.
99 * There will be a unique identifier on the begin and end lines.
100 * This will persist across reboots.
102 * format of error logs returned from RTAS:
103 * bytes (size) : contents
104 * --------------------------------------------------------
105 * 0-7 (8) : rtas_error_log
106 * 8-47 (40) : extended info
107 * 48-51 (4) : vendor id
108 * 52-1023 (vendor specific) : location code and debug data
110 static void printk_log_rtas(char *buf, int len)
116 char * str = "RTAS event";
118 if (full_rtas_msgs) {
119 printk(RTAS_DEBUG "%d -------- %s begin --------\n",
123 * Print perline bytes on each line, each line will start
124 * with RTAS and a changing number, so syslogd will
125 * print lines that are otherwise the same. Separate every
126 * 4 bytes with a space.
128 for (i = 0; i < len; i++) {
131 memset(buffer, 0, sizeof(buffer));
132 n = sprintf(buffer, "RTAS %d:", i/perline);
136 n += sprintf(buffer+n, " ");
138 n += sprintf(buffer+n, "%02x", (unsigned char)buf[i]);
140 if (j == (perline-1))
141 printk(KERN_DEBUG "%s\n", buffer);
143 if ((i % perline) != 0)
144 printk(KERN_DEBUG "%s\n", buffer);
146 printk(RTAS_DEBUG "%d -------- %s end ----------\n",
149 struct rtas_error_log *errlog = (struct rtas_error_log *)buf;
151 printk(RTAS_DEBUG "event: %d, Type: %s, Severity: %d\n",
152 error_log_cnt, rtas_event_type(errlog->type),
157 static int log_rtas_len(char * buf)
160 struct rtas_error_log *err;
162 /* rtas fixed header */
164 err = (struct rtas_error_log *)buf;
165 if (err->extended_log_length) {
167 /* extended header */
168 len += err->extended_log_length;
171 if (rtas_error_log_max == 0)
172 rtas_error_log_max = rtas_get_error_log_max();
174 if (len > rtas_error_log_max)
175 len = rtas_error_log_max;
181 * First write to nvram, if fatal error, that is the only
182 * place we log the info. The error will be picked up
183 * on the next reboot by rtasd. If not fatal, run the
184 * method for the type of error. Currently, only RTAS
185 * errors have methods implemented, but in the future
186 * there might be a need to store data in nvram before a
189 * XXX We write to nvram periodically, to indicate error has
190 * been written and sync'd, but there is a possibility
191 * that if we don't shutdown correctly, a duplicate error
192 * record will be created on next reboot.
194 void pSeries_log_error(char *buf, unsigned int err_type, int fatal)
196 unsigned long offset;
200 DEBUG("logging event\n");
204 spin_lock_irqsave(&rtasd_log_lock, s);
206 /* get length and increase count */
207 switch (err_type & ERR_TYPE_MASK) {
208 case ERR_TYPE_RTAS_LOG:
209 len = log_rtas_len(buf);
210 if (!(err_type & ERR_FLAG_BOOT))
213 case ERR_TYPE_KERNEL_PANIC:
215 spin_unlock_irqrestore(&rtasd_log_lock, s);
219 /* Write error to NVRAM */
220 if (!no_more_logging && !(err_type & ERR_FLAG_BOOT))
221 nvram_write_error_log(buf, len, err_type, error_log_cnt);
224 * rtas errors can occur during boot, and we do want to capture
225 * those somewhere, even if nvram isn't ready (why not?), and even
226 * if rtasd isn't ready. Put them into the boot log, at least.
228 if ((err_type & ERR_TYPE_MASK) == ERR_TYPE_RTAS_LOG)
229 printk_log_rtas(buf, len);
231 /* Check to see if we need to or have stopped logging */
232 if (fatal || no_more_logging) {
234 spin_unlock_irqrestore(&rtasd_log_lock, s);
238 /* call type specific method for error */
239 switch (err_type & ERR_TYPE_MASK) {
240 case ERR_TYPE_RTAS_LOG:
241 offset = rtas_error_log_buffer_max *
242 ((rtas_log_start+rtas_log_size) & LOG_NUMBER_MASK);
244 /* First copy over sequence number */
245 memcpy(&rtas_log_buf[offset], (void *) &error_log_cnt, sizeof(int));
247 /* Second copy over error log data */
248 offset += sizeof(int);
249 memcpy(&rtas_log_buf[offset], buf, len);
251 if (rtas_log_size < LOG_NUMBER)
256 spin_unlock_irqrestore(&rtasd_log_lock, s);
257 wake_up_interruptible(&rtas_log_wait);
259 case ERR_TYPE_KERNEL_PANIC:
261 spin_unlock_irqrestore(&rtasd_log_lock, s);
268 static int rtas_log_open(struct inode * inode, struct file * file)
273 static int rtas_log_release(struct inode * inode, struct file * file)
278 /* This will check if all events are logged, if they are then, we
279 * know that we can safely clear the events in NVRAM.
280 * Next we'll sit and wait for something else to log.
282 static ssize_t rtas_log_read(struct file * file, char __user * buf,
283 size_t count, loff_t *ppos)
288 unsigned long offset;
290 if (!buf || count < rtas_error_log_buffer_max)
293 count = rtas_error_log_buffer_max;
295 if (!access_ok(VERIFY_WRITE, buf, count))
298 tmp = kmalloc(count, GFP_KERNEL);
303 spin_lock_irqsave(&rtasd_log_lock, s);
304 /* if it's 0, then we know we got the last one (the one in NVRAM) */
305 if (rtas_log_size == 0 && !no_more_logging)
306 nvram_clear_error_log();
307 spin_unlock_irqrestore(&rtasd_log_lock, s);
310 error = wait_event_interruptible(rtas_log_wait, rtas_log_size);
314 spin_lock_irqsave(&rtasd_log_lock, s);
315 offset = rtas_error_log_buffer_max * (rtas_log_start & LOG_NUMBER_MASK);
316 memcpy(tmp, &rtas_log_buf[offset], count);
320 spin_unlock_irqrestore(&rtasd_log_lock, s);
322 error = copy_to_user(buf, tmp, count) ? -EFAULT : count;
328 static unsigned int rtas_log_poll(struct file *file, poll_table * wait)
330 poll_wait(file, &rtas_log_wait, wait);
332 return POLLIN | POLLRDNORM;
336 const struct file_operations proc_rtas_log_operations = {
337 .read = rtas_log_read,
338 .poll = rtas_log_poll,
339 .open = rtas_log_open,
340 .release = rtas_log_release,
343 static int enable_surveillance(int timeout)
347 error = rtas_set_indicator(SURVEILLANCE_TOKEN, 0, timeout);
352 if (error == -EINVAL) {
353 printk(KERN_DEBUG "rtasd: surveillance not supported\n");
357 printk(KERN_ERR "rtasd: could not update surveillance\n");
361 static void do_event_scan(void)
365 memset(logdata, 0, rtas_error_log_max);
366 error = rtas_call(event_scan, 4, 1, NULL,
367 RTAS_EVENT_SCAN_ALL_EVENTS, 0,
368 __pa(logdata), rtas_error_log_max);
370 printk(KERN_ERR "event-scan failed\n");
375 pSeries_log_error(logdata, ERR_TYPE_RTAS_LOG, 0);
380 static void do_event_scan_all_cpus(long delay)
385 cpu = first_cpu(cpu_online_map);
387 set_cpus_allowed(current, cpumask_of_cpu(cpu));
389 set_cpus_allowed(current, CPU_MASK_ALL);
391 /* Drop hotplug lock, and sleep for the specified delay */
392 unlock_cpu_hotplug();
393 msleep_interruptible(delay);
396 cpu = next_cpu(cpu, cpu_online_map);
400 unlock_cpu_hotplug();
403 static int rtasd(void *unused)
405 unsigned int err_type;
410 printk(KERN_DEBUG "RTAS daemon started\n");
411 DEBUG("will sleep for %d milliseconds\n", (30000/rtas_event_scan_rate));
413 /* See if we have any error stored in NVRAM */
414 memset(logdata, 0, rtas_error_log_max);
415 rc = nvram_read_error_log(logdata, rtas_error_log_max,
416 &err_type, &error_log_cnt);
419 if (err_type != ERR_FLAG_ALREADY_LOGGED) {
420 pSeries_log_error(logdata, err_type | ERR_FLAG_BOOT, 0);
425 do_event_scan_all_cpus(1000);
427 if (surveillance_timeout != -1) {
428 DEBUG("enabling surveillance\n");
429 enable_surveillance(surveillance_timeout);
430 DEBUG("surveillance enabled\n");
433 /* Delay should be at least one second since some
434 * machines have problems if we call event-scan too
437 do_event_scan_all_cpus(30000/rtas_event_scan_rate);
442 static int __init rtas_init(void)
444 struct proc_dir_entry *entry;
446 if (!machine_is(pseries))
450 event_scan = rtas_token("event-scan");
451 if (event_scan == RTAS_UNKNOWN_SERVICE) {
452 printk(KERN_DEBUG "rtasd: no event-scan on system\n");
456 rtas_event_scan_rate = rtas_token("rtas-event-scan-rate");
457 if (rtas_event_scan_rate == RTAS_UNKNOWN_SERVICE) {
458 printk(KERN_ERR "rtasd: no rtas-event-scan-rate on system\n");
462 /* Make room for the sequence number */
463 rtas_error_log_max = rtas_get_error_log_max();
464 rtas_error_log_buffer_max = rtas_error_log_max + sizeof(int);
466 rtas_log_buf = vmalloc(rtas_error_log_buffer_max*LOG_NUMBER);
468 printk(KERN_ERR "rtasd: no memory\n");
472 entry = create_proc_entry("ppc64/rtas/error_log", S_IRUSR, NULL);
474 entry->proc_fops = &proc_rtas_log_operations;
476 printk(KERN_ERR "Failed to create error_log proc entry\n");
478 if (kernel_thread(rtasd, NULL, CLONE_FS) < 0)
479 printk(KERN_ERR "Failed to start RTAS daemon\n");
484 static int __init surveillance_setup(char *str)
488 if (get_option(&str,&i)) {
489 if (i >= 0 && i <= 255)
490 surveillance_timeout = i;
496 static int __init rtasmsgs_setup(char *str)
498 if (strcmp(str, "on") == 0)
500 else if (strcmp(str, "off") == 0)
505 __initcall(rtas_init);
506 __setup("surveillance=", surveillance_setup);
507 __setup("rtasmsgs=", rtasmsgs_setup);