3 * Procedures for interfacing to the RTAS on CHRP machines.
5 * Peter Bergner, IBM March 2001.
6 * Copyright (C) 2001 IBM.
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version
11 * 2 of the License, or (at your option) any later version.
15 #include <linux/kernel.h>
16 #include <linux/types.h>
17 #include <linux/spinlock.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
23 #include <asm/semaphore.h>
24 #include <asm/machdep.h>
26 #include <asm/param.h>
27 #include <asm/system.h>
28 #include <asm/delay.h>
29 #include <asm/uaccess.h>
32 #include <asm/systemcfg.h>
35 struct rtas_t rtas = {
36 .lock = SPIN_LOCK_UNLOCKED
41 DEFINE_SPINLOCK(rtas_data_buf_lock);
42 char rtas_data_buf[RTAS_DATA_BUF_SIZE] __cacheline_aligned;
43 unsigned long rtas_rmo_buf;
46 * If non-NULL, this gets called when the kernel terminates.
47 * This is done like this so rtas_flash can be a module.
49 void (*rtas_flash_term_hook)(int);
50 EXPORT_SYMBOL(rtas_flash_term_hook);
53 * call_rtas_display_status and call_rtas_display_status_delay
54 * are designed only for very early low-level debugging, which
55 * is why the token is hard-coded to 10.
57 void call_rtas_display_status(unsigned char c)
59 struct rtas_args *args = &rtas.args;
64 spin_lock_irqsave(&rtas.lock, s);
69 args->rets = (rtas_arg_t *)&(args->args[1]);
70 args->args[0] = (int)c;
72 enter_rtas(__pa(args));
74 spin_unlock_irqrestore(&rtas.lock, s);
77 void call_rtas_display_status_delay(unsigned char c)
79 static int pending_newline = 0; /* did last write end with unprinted newline? */
80 static int width = 16;
84 call_rtas_display_status(' ');
89 if (pending_newline) {
90 call_rtas_display_status('\r');
91 call_rtas_display_status('\n');
95 call_rtas_display_status(c);
101 void rtas_progress(char *s, unsigned short hex)
103 struct device_node *root;
106 static int display_character, set_indicator;
107 static int display_width, display_lines, *row_width, form_feed;
108 static DEFINE_SPINLOCK(progress_lock);
109 static int current_line;
110 static int pending_newline = 0; /* did last write end with unprinted newline? */
115 if (display_width == 0) {
116 display_width = 0x10;
117 if ((root = find_path_device("/rtas"))) {
118 if ((p = (unsigned int *)get_property(root,
119 "ibm,display-line-length", NULL)))
121 if ((p = (unsigned int *)get_property(root,
122 "ibm,form-feed", NULL)))
124 if ((p = (unsigned int *)get_property(root,
125 "ibm,display-number-of-lines", NULL)))
127 row_width = (unsigned int *)get_property(root,
128 "ibm,display-truncation-length", NULL);
130 display_character = rtas_token("display-character");
131 set_indicator = rtas_token("set-indicator");
134 if (display_character == RTAS_UNKNOWN_SERVICE) {
135 /* use hex display if available */
136 if (set_indicator != RTAS_UNKNOWN_SERVICE)
137 rtas_call(set_indicator, 3, 1, NULL, 6, 0, hex);
141 spin_lock(&progress_lock);
144 * Last write ended with newline, but we didn't print it since
145 * it would just clear the bottom line of output. Print it now
148 * If no newline is pending and form feed is supported, clear the
149 * display with a form feed; otherwise, print a CR to start output
150 * at the beginning of the line.
152 if (pending_newline) {
153 rtas_call(display_character, 1, 1, NULL, '\r');
154 rtas_call(display_character, 1, 1, NULL, '\n');
159 rtas_call(display_character, 1, 1, NULL,
162 rtas_call(display_character, 1, 1, NULL, '\r');
166 width = row_width[current_line];
168 width = display_width;
171 if (*os == '\n' || *os == '\r') {
172 /* If newline is the last character, save it
173 * until next call to avoid bumping up the
176 if (*os == '\n' && !os[1]) {
179 if (current_line > display_lines-1)
180 current_line = display_lines-1;
181 spin_unlock(&progress_lock);
185 /* RTAS wants CR-LF, not just LF */
188 rtas_call(display_character, 1, 1, NULL, '\r');
189 rtas_call(display_character, 1, 1, NULL, '\n');
191 /* CR might be used to re-draw a line, so we'll
192 * leave it alone and not add LF.
194 rtas_call(display_character, 1, 1, NULL, *os);
198 width = row_width[current_line];
200 width = display_width;
203 rtas_call(display_character, 1, 1, NULL, *os);
208 /* if we overwrite the screen length */
210 while ((*os != 0) && (*os != '\n') && (*os != '\r'))
214 spin_unlock(&progress_lock);
216 EXPORT_SYMBOL(rtas_progress); /* needed by rtas_flash module */
218 int rtas_token(const char *service)
221 if (rtas.dev == NULL)
222 return RTAS_UNKNOWN_SERVICE;
223 tokp = (int *) get_property(rtas.dev, service, NULL);
224 return tokp ? *tokp : RTAS_UNKNOWN_SERVICE;
227 #ifdef CONFIG_RTAS_ERROR_LOGGING
229 * Return the firmware-specified size of the error log buffer
230 * for all rtas calls that require an error buffer argument.
231 * This includes 'check-exception' and 'rtas-last-error'.
233 int rtas_get_error_log_max(void)
235 static int rtas_error_log_max;
236 if (rtas_error_log_max)
237 return rtas_error_log_max;
239 rtas_error_log_max = rtas_token ("rtas-error-log-max");
240 if ((rtas_error_log_max == RTAS_UNKNOWN_SERVICE) ||
241 (rtas_error_log_max > RTAS_ERROR_LOG_MAX)) {
242 printk (KERN_WARNING "RTAS: bad log buffer size %d\n",
244 rtas_error_log_max = RTAS_ERROR_LOG_MAX;
246 return rtas_error_log_max;
248 EXPORT_SYMBOL(rtas_get_error_log_max);
251 char rtas_err_buf[RTAS_ERROR_LOG_MAX];
252 int rtas_last_error_token;
254 /** Return a copy of the detailed error text associated with the
255 * most recent failed call to rtas. Because the error text
256 * might go stale if there are any other intervening rtas calls,
257 * this routine must be called atomically with whatever produced
258 * the error (i.e. with rtas.lock still held from the previous call).
260 static char *__fetch_rtas_last_error(char *altbuf)
262 struct rtas_args err_args, save_args;
266 if (rtas_last_error_token == -1)
269 bufsz = rtas_get_error_log_max();
271 err_args.token = rtas_last_error_token;
274 err_args.args[0] = (rtas_arg_t)__pa(rtas_err_buf);
275 err_args.args[1] = bufsz;
276 err_args.args[2] = 0;
278 save_args = rtas.args;
279 rtas.args = err_args;
281 enter_rtas(__pa(&rtas.args));
283 err_args = rtas.args;
284 rtas.args = save_args;
286 /* Log the error in the unlikely case that there was one. */
287 if (unlikely(err_args.args[2] == 0)) {
293 buf = kmalloc(RTAS_ERROR_LOG_MAX, GFP_ATOMIC);
296 memcpy(buf, rtas_err_buf, RTAS_ERROR_LOG_MAX);
302 #define get_errorlog_buffer() kmalloc(RTAS_ERROR_LOG_MAX, GFP_KERNEL)
304 #else /* CONFIG_RTAS_ERROR_LOGGING */
305 #define __fetch_rtas_last_error(x) NULL
306 #define get_errorlog_buffer() NULL
309 int rtas_call(int token, int nargs, int nret, int *outputs, ...)
314 struct rtas_args *rtas_args;
315 char *buff_copy = NULL;
318 if (token == RTAS_UNKNOWN_SERVICE)
321 /* Gotta do something different here, use global lock for now... */
322 spin_lock_irqsave(&rtas.lock, s);
323 rtas_args = &rtas.args;
325 rtas_args->token = token;
326 rtas_args->nargs = nargs;
327 rtas_args->nret = nret;
328 rtas_args->rets = (rtas_arg_t *)&(rtas_args->args[nargs]);
329 va_start(list, outputs);
330 for (i = 0; i < nargs; ++i)
331 rtas_args->args[i] = va_arg(list, rtas_arg_t);
334 for (i = 0; i < nret; ++i)
335 rtas_args->rets[i] = 0;
337 enter_rtas(__pa(rtas_args));
339 /* A -1 return code indicates that the last command couldn't
340 be completed due to a hardware error. */
341 if (rtas_args->rets[0] == -1)
342 buff_copy = __fetch_rtas_last_error(NULL);
344 if (nret > 1 && outputs != NULL)
345 for (i = 0; i < nret-1; ++i)
346 outputs[i] = rtas_args->rets[i+1];
347 ret = (nret > 0)? rtas_args->rets[0]: 0;
349 /* Gotta do something different here, use global lock for now... */
350 spin_unlock_irqrestore(&rtas.lock, s);
353 log_error(buff_copy, ERR_TYPE_RTAS_LOG, 0);
360 /* Given an RTAS status code of 990n compute the hinted delay of 10^n
361 * (last digit) milliseconds. For now we bound at n=5 (100 sec).
363 unsigned int rtas_extended_busy_delay_time(int status)
365 int order = status - 9900;
369 order = 0; /* RTC depends on this for -2 clock busy */
371 order = 5; /* bound */
373 /* Use microseconds for reasonable accuracy */
374 for (ms = 1; order > 0; order--)
380 int rtas_error_rc(int rtas_rc)
385 case -1: /* Hardware Error */
388 case -3: /* Bad indicator/domain/etc */
391 case -9000: /* Isolation error */
394 case -9001: /* Outstanding TCE/PTE */
397 case -9002: /* No usable slot */
401 printk(KERN_ERR "%s: unexpected RTAS error %d\n",
402 __FUNCTION__, rtas_rc);
409 int rtas_get_power_level(int powerdomain, int *level)
411 int token = rtas_token("get-power-level");
414 if (token == RTAS_UNKNOWN_SERVICE)
417 while ((rc = rtas_call(token, 1, 2, level, powerdomain)) == RTAS_BUSY)
421 return rtas_error_rc(rc);
425 int rtas_set_power_level(int powerdomain, int level, int *setlevel)
427 int token = rtas_token("set-power-level");
428 unsigned int wait_time;
431 if (token == RTAS_UNKNOWN_SERVICE)
435 rc = rtas_call(token, 2, 2, setlevel, powerdomain, level);
438 else if (rtas_is_extended_busy(rc)) {
439 wait_time = rtas_extended_busy_delay_time(rc);
440 udelay(wait_time * 1000);
446 return rtas_error_rc(rc);
450 int rtas_get_sensor(int sensor, int index, int *state)
452 int token = rtas_token("get-sensor-state");
453 unsigned int wait_time;
456 if (token == RTAS_UNKNOWN_SERVICE)
460 rc = rtas_call(token, 2, 2, state, sensor, index);
463 else if (rtas_is_extended_busy(rc)) {
464 wait_time = rtas_extended_busy_delay_time(rc);
465 udelay(wait_time * 1000);
471 return rtas_error_rc(rc);
475 int rtas_set_indicator(int indicator, int index, int new_value)
477 int token = rtas_token("set-indicator");
478 unsigned int wait_time;
481 if (token == RTAS_UNKNOWN_SERVICE)
485 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
488 else if (rtas_is_extended_busy(rc)) {
489 wait_time = rtas_extended_busy_delay_time(rc);
490 udelay(wait_time * 1000);
497 return rtas_error_rc(rc);
501 void rtas_restart(char *cmd)
503 if (rtas_flash_term_hook)
504 rtas_flash_term_hook(SYS_RESTART);
505 printk("RTAS system-reboot returned %d\n",
506 rtas_call(rtas_token("system-reboot"), 0, 1, NULL));
510 void rtas_power_off(void)
512 if (rtas_flash_term_hook)
513 rtas_flash_term_hook(SYS_POWER_OFF);
514 /* allow power on only with power button press */
515 printk("RTAS power-off returned %d\n",
516 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
522 if (rtas_flash_term_hook)
523 rtas_flash_term_hook(SYS_HALT);
524 /* allow power on only with power button press */
525 printk("RTAS power-off returned %d\n",
526 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
530 /* Must be in the RMO region, so we place it here */
531 static char rtas_os_term_buf[2048];
533 void rtas_os_term(char *str)
537 if (RTAS_UNKNOWN_SERVICE == rtas_token("ibm,os-term"))
540 snprintf(rtas_os_term_buf, 2048, "OS panic: %s", str);
543 status = rtas_call(rtas_token("ibm,os-term"), 1, 1, NULL,
544 __pa(rtas_os_term_buf));
546 if (status == RTAS_BUSY)
548 else if (status != 0)
549 printk(KERN_EMERG "ibm,os-term call failed %d\n",
551 } while (status == RTAS_BUSY);
555 asmlinkage int ppc_rtas(struct rtas_args __user *uargs)
557 struct rtas_args args;
559 char *buff_copy, *errbuf = NULL;
562 if (!capable(CAP_SYS_ADMIN))
565 if (copy_from_user(&args, uargs, 3 * sizeof(u32)) != 0)
569 if (nargs > ARRAY_SIZE(args.args)
570 || args.nret > ARRAY_SIZE(args.args)
571 || nargs + args.nret > ARRAY_SIZE(args.args))
575 if (copy_from_user(args.args, uargs->args,
576 nargs * sizeof(rtas_arg_t)) != 0)
579 buff_copy = get_errorlog_buffer();
581 spin_lock_irqsave(&rtas.lock, flags);
584 enter_rtas(__pa(&rtas.args));
587 args.rets = &args.args[nargs];
589 /* A -1 return code indicates that the last command couldn't
590 be completed due to a hardware error. */
591 if (args.rets[0] == -1)
592 errbuf = __fetch_rtas_last_error(buff_copy);
594 spin_unlock_irqrestore(&rtas.lock, flags);
598 log_error(errbuf, ERR_TYPE_RTAS_LOG, 0);
603 if (copy_to_user(uargs->args + nargs,
605 args.nret * sizeof(rtas_arg_t)) != 0)
612 /* This version can't take the spinlock, because it never returns */
614 struct rtas_args rtas_stop_self_args = {
615 /* The token is initialized for real in setup_system() */
616 .token = RTAS_UNKNOWN_SERVICE,
619 .rets = &rtas_stop_self_args.args[0],
622 void rtas_stop_self(void)
624 struct rtas_args *rtas_args = &rtas_stop_self_args;
628 BUG_ON(rtas_args->token == RTAS_UNKNOWN_SERVICE);
630 printk("cpu %u (hwid %u) Ready to die...\n",
631 smp_processor_id(), hard_smp_processor_id());
632 enter_rtas(__pa(rtas_args));
634 panic("Alas, I survived.\n");
639 * Call early during boot, before mem init or bootmem, to retreive the RTAS
640 * informations from the device-tree and allocate the RMO buffer for userland
643 void __init rtas_initialize(void)
645 unsigned long rtas_region = RTAS_INSTANTIATE_MAX;
647 /* Get RTAS dev node and fill up our "rtas" structure with infos
650 rtas.dev = of_find_node_by_name(NULL, "rtas");
655 basep = (u32 *)get_property(rtas.dev, "linux,rtas-base", NULL);
656 sizep = (u32 *)get_property(rtas.dev, "rtas-size", NULL);
657 if (basep != NULL && sizep != NULL) {
660 entryp = (u32 *)get_property(rtas.dev, "linux,rtas-entry", NULL);
661 if (entryp == NULL) /* Ugh */
662 rtas.entry = rtas.base;
664 rtas.entry = *entryp;
671 /* If RTAS was found, allocate the RMO buffer for it and look for
672 * the stop-self token if any
675 if (systemcfg->platform == PLATFORM_PSERIES_LPAR)
676 rtas_region = min(lmb.rmo_size, RTAS_INSTANTIATE_MAX);
678 rtas_rmo_buf = lmb_alloc_base(RTAS_RMOBUF_MAX, PAGE_SIZE, rtas_region);
680 #ifdef CONFIG_HOTPLUG_CPU
681 rtas_stop_self_args.token = rtas_token("stop-self");
682 #endif /* CONFIG_HOTPLUG_CPU */
683 #ifdef CONFIG_RTAS_ERROR_LOGGING
684 rtas_last_error_token = rtas_token("rtas-last-error");
689 EXPORT_SYMBOL(rtas_token);
690 EXPORT_SYMBOL(rtas_call);
691 EXPORT_SYMBOL(rtas_data_buf);
692 EXPORT_SYMBOL(rtas_data_buf_lock);
693 EXPORT_SYMBOL(rtas_extended_busy_delay_time);
694 EXPORT_SYMBOL(rtas_get_sensor);
695 EXPORT_SYMBOL(rtas_get_power_level);
696 EXPORT_SYMBOL(rtas_set_power_level);
697 EXPORT_SYMBOL(rtas_set_indicator);