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>
20 #include <linux/capability.h>
21 #include <linux/delay.h>
25 #include <asm/hvcall.h>
26 #include <asm/semaphore.h>
27 #include <asm/machdep.h>
28 #include <asm/firmware.h>
30 #include <asm/param.h>
31 #include <asm/system.h>
32 #include <asm/delay.h>
33 #include <asm/uaccess.h>
36 #include <asm/syscalls.h>
38 struct rtas_t rtas = {
39 .lock = SPIN_LOCK_UNLOCKED
43 struct rtas_suspend_me_data {
45 struct rtas_args *args;
48 DEFINE_SPINLOCK(rtas_data_buf_lock);
49 EXPORT_SYMBOL(rtas_data_buf_lock);
51 char rtas_data_buf[RTAS_DATA_BUF_SIZE] __cacheline_aligned;
52 EXPORT_SYMBOL(rtas_data_buf);
54 unsigned long rtas_rmo_buf;
57 * If non-NULL, this gets called when the kernel terminates.
58 * This is done like this so rtas_flash can be a module.
60 void (*rtas_flash_term_hook)(int);
61 EXPORT_SYMBOL(rtas_flash_term_hook);
64 * call_rtas_display_status and call_rtas_display_status_delay
65 * are designed only for very early low-level debugging, which
66 * is why the token is hard-coded to 10.
68 static void call_rtas_display_status(char c)
70 struct rtas_args *args = &rtas.args;
75 spin_lock_irqsave(&rtas.lock, s);
80 args->rets = (rtas_arg_t *)&(args->args[1]);
81 args->args[0] = (unsigned char)c;
83 enter_rtas(__pa(args));
85 spin_unlock_irqrestore(&rtas.lock, s);
88 static void call_rtas_display_status_delay(char c)
90 static int pending_newline = 0; /* did last write end with unprinted newline? */
91 static int width = 16;
95 call_rtas_display_status(' ');
100 if (pending_newline) {
101 call_rtas_display_status('\r');
102 call_rtas_display_status('\n');
106 call_rtas_display_status(c);
112 void __init udbg_init_rtas_panel(void)
114 udbg_putc = call_rtas_display_status_delay;
117 #ifdef CONFIG_UDBG_RTAS_CONSOLE
119 /* If you think you're dying before early_init_dt_scan_rtas() does its
120 * work, you can hard code the token values for your firmware here and
121 * hardcode rtas.base/entry etc.
123 static unsigned int rtas_putchar_token = RTAS_UNKNOWN_SERVICE;
124 static unsigned int rtas_getchar_token = RTAS_UNKNOWN_SERVICE;
126 static void udbg_rtascon_putc(char c)
133 /* Add CRs before LFs */
135 udbg_rtascon_putc('\r');
137 /* if there is more than one character to be displayed, wait a bit */
138 for (tries = 0; tries < 16; tries++) {
139 if (rtas_call(rtas_putchar_token, 1, 1, NULL, c) == 0)
145 static int udbg_rtascon_getc_poll(void)
152 if (rtas_call(rtas_getchar_token, 0, 2, &c))
158 static int udbg_rtascon_getc(void)
162 while ((c = udbg_rtascon_getc_poll()) == -1)
169 void __init udbg_init_rtas_console(void)
171 udbg_putc = udbg_rtascon_putc;
172 udbg_getc = udbg_rtascon_getc;
173 udbg_getc_poll = udbg_rtascon_getc_poll;
175 #endif /* CONFIG_UDBG_RTAS_CONSOLE */
177 void rtas_progress(char *s, unsigned short hex)
179 struct device_node *root;
183 static int display_character, set_indicator;
184 static int display_width, display_lines, form_feed;
185 const static int *row_width;
186 static DEFINE_SPINLOCK(progress_lock);
187 static int current_line;
188 static int pending_newline = 0; /* did last write end with unprinted newline? */
193 if (display_width == 0) {
194 display_width = 0x10;
195 if ((root = find_path_device("/rtas"))) {
196 if ((p = get_property(root,
197 "ibm,display-line-length", NULL)))
199 if ((p = get_property(root,
200 "ibm,form-feed", NULL)))
202 if ((p = get_property(root,
203 "ibm,display-number-of-lines", NULL)))
205 row_width = get_property(root,
206 "ibm,display-truncation-length", NULL);
208 display_character = rtas_token("display-character");
209 set_indicator = rtas_token("set-indicator");
212 if (display_character == RTAS_UNKNOWN_SERVICE) {
213 /* use hex display if available */
214 if (set_indicator != RTAS_UNKNOWN_SERVICE)
215 rtas_call(set_indicator, 3, 1, NULL, 6, 0, hex);
219 spin_lock(&progress_lock);
222 * Last write ended with newline, but we didn't print it since
223 * it would just clear the bottom line of output. Print it now
226 * If no newline is pending and form feed is supported, clear the
227 * display with a form feed; otherwise, print a CR to start output
228 * at the beginning of the line.
230 if (pending_newline) {
231 rtas_call(display_character, 1, 1, NULL, '\r');
232 rtas_call(display_character, 1, 1, NULL, '\n');
237 rtas_call(display_character, 1, 1, NULL,
240 rtas_call(display_character, 1, 1, NULL, '\r');
244 width = row_width[current_line];
246 width = display_width;
249 if (*os == '\n' || *os == '\r') {
250 /* If newline is the last character, save it
251 * until next call to avoid bumping up the
254 if (*os == '\n' && !os[1]) {
257 if (current_line > display_lines-1)
258 current_line = display_lines-1;
259 spin_unlock(&progress_lock);
263 /* RTAS wants CR-LF, not just LF */
266 rtas_call(display_character, 1, 1, NULL, '\r');
267 rtas_call(display_character, 1, 1, NULL, '\n');
269 /* CR might be used to re-draw a line, so we'll
270 * leave it alone and not add LF.
272 rtas_call(display_character, 1, 1, NULL, *os);
276 width = row_width[current_line];
278 width = display_width;
281 rtas_call(display_character, 1, 1, NULL, *os);
286 /* if we overwrite the screen length */
288 while ((*os != 0) && (*os != '\n') && (*os != '\r'))
292 spin_unlock(&progress_lock);
294 EXPORT_SYMBOL(rtas_progress); /* needed by rtas_flash module */
296 int rtas_token(const char *service)
299 if (rtas.dev == NULL)
300 return RTAS_UNKNOWN_SERVICE;
301 tokp = get_property(rtas.dev, service, NULL);
302 return tokp ? *tokp : RTAS_UNKNOWN_SERVICE;
304 EXPORT_SYMBOL(rtas_token);
306 #ifdef CONFIG_RTAS_ERROR_LOGGING
308 * Return the firmware-specified size of the error log buffer
309 * for all rtas calls that require an error buffer argument.
310 * This includes 'check-exception' and 'rtas-last-error'.
312 int rtas_get_error_log_max(void)
314 static int rtas_error_log_max;
315 if (rtas_error_log_max)
316 return rtas_error_log_max;
318 rtas_error_log_max = rtas_token ("rtas-error-log-max");
319 if ((rtas_error_log_max == RTAS_UNKNOWN_SERVICE) ||
320 (rtas_error_log_max > RTAS_ERROR_LOG_MAX)) {
321 printk (KERN_WARNING "RTAS: bad log buffer size %d\n",
323 rtas_error_log_max = RTAS_ERROR_LOG_MAX;
325 return rtas_error_log_max;
327 EXPORT_SYMBOL(rtas_get_error_log_max);
330 char rtas_err_buf[RTAS_ERROR_LOG_MAX];
331 int rtas_last_error_token;
333 /** Return a copy of the detailed error text associated with the
334 * most recent failed call to rtas. Because the error text
335 * might go stale if there are any other intervening rtas calls,
336 * this routine must be called atomically with whatever produced
337 * the error (i.e. with rtas.lock still held from the previous call).
339 static char *__fetch_rtas_last_error(char *altbuf)
341 struct rtas_args err_args, save_args;
345 if (rtas_last_error_token == -1)
348 bufsz = rtas_get_error_log_max();
350 err_args.token = rtas_last_error_token;
353 err_args.args[0] = (rtas_arg_t)__pa(rtas_err_buf);
354 err_args.args[1] = bufsz;
355 err_args.args[2] = 0;
357 save_args = rtas.args;
358 rtas.args = err_args;
360 enter_rtas(__pa(&rtas.args));
362 err_args = rtas.args;
363 rtas.args = save_args;
365 /* Log the error in the unlikely case that there was one. */
366 if (unlikely(err_args.args[2] == 0)) {
372 buf = kmalloc(RTAS_ERROR_LOG_MAX, GFP_ATOMIC);
375 memcpy(buf, rtas_err_buf, RTAS_ERROR_LOG_MAX);
381 #define get_errorlog_buffer() kmalloc(RTAS_ERROR_LOG_MAX, GFP_KERNEL)
383 #else /* CONFIG_RTAS_ERROR_LOGGING */
384 #define __fetch_rtas_last_error(x) NULL
385 #define get_errorlog_buffer() NULL
388 int rtas_call(int token, int nargs, int nret, int *outputs, ...)
393 struct rtas_args *rtas_args;
394 char *buff_copy = NULL;
397 if (!rtas.entry || token == RTAS_UNKNOWN_SERVICE)
400 /* Gotta do something different here, use global lock for now... */
401 spin_lock_irqsave(&rtas.lock, s);
402 rtas_args = &rtas.args;
404 rtas_args->token = token;
405 rtas_args->nargs = nargs;
406 rtas_args->nret = nret;
407 rtas_args->rets = (rtas_arg_t *)&(rtas_args->args[nargs]);
408 va_start(list, outputs);
409 for (i = 0; i < nargs; ++i)
410 rtas_args->args[i] = va_arg(list, rtas_arg_t);
413 for (i = 0; i < nret; ++i)
414 rtas_args->rets[i] = 0;
416 enter_rtas(__pa(rtas_args));
418 /* A -1 return code indicates that the last command couldn't
419 be completed due to a hardware error. */
420 if (rtas_args->rets[0] == -1)
421 buff_copy = __fetch_rtas_last_error(NULL);
423 if (nret > 1 && outputs != NULL)
424 for (i = 0; i < nret-1; ++i)
425 outputs[i] = rtas_args->rets[i+1];
426 ret = (nret > 0)? rtas_args->rets[0]: 0;
428 /* Gotta do something different here, use global lock for now... */
429 spin_unlock_irqrestore(&rtas.lock, s);
432 log_error(buff_copy, ERR_TYPE_RTAS_LOG, 0);
438 EXPORT_SYMBOL(rtas_call);
440 /* For RTAS_BUSY (-2), delay for 1 millisecond. For an extended busy status
441 * code of 990n, perform the hinted delay of 10^n (last digit) milliseconds.
443 unsigned int rtas_busy_delay_time(int status)
448 if (status == RTAS_BUSY) {
450 } else if (status >= 9900 && status <= 9905) {
451 order = status - 9900;
452 for (ms = 1; order > 0; order--)
458 EXPORT_SYMBOL(rtas_busy_delay_time);
460 /* For an RTAS busy status code, perform the hinted delay. */
461 unsigned int rtas_busy_delay(int status)
466 ms = rtas_busy_delay_time(status);
472 EXPORT_SYMBOL(rtas_busy_delay);
474 int rtas_error_rc(int rtas_rc)
479 case -1: /* Hardware Error */
482 case -3: /* Bad indicator/domain/etc */
485 case -9000: /* Isolation error */
488 case -9001: /* Outstanding TCE/PTE */
491 case -9002: /* No usable slot */
495 printk(KERN_ERR "%s: unexpected RTAS error %d\n",
496 __FUNCTION__, rtas_rc);
503 int rtas_get_power_level(int powerdomain, int *level)
505 int token = rtas_token("get-power-level");
508 if (token == RTAS_UNKNOWN_SERVICE)
511 while ((rc = rtas_call(token, 1, 2, level, powerdomain)) == RTAS_BUSY)
515 return rtas_error_rc(rc);
518 EXPORT_SYMBOL(rtas_get_power_level);
520 int rtas_set_power_level(int powerdomain, int level, int *setlevel)
522 int token = rtas_token("set-power-level");
525 if (token == RTAS_UNKNOWN_SERVICE)
529 rc = rtas_call(token, 2, 2, setlevel, powerdomain, level);
530 } while (rtas_busy_delay(rc));
533 return rtas_error_rc(rc);
536 EXPORT_SYMBOL(rtas_set_power_level);
538 int rtas_get_sensor(int sensor, int index, int *state)
540 int token = rtas_token("get-sensor-state");
543 if (token == RTAS_UNKNOWN_SERVICE)
547 rc = rtas_call(token, 2, 2, state, sensor, index);
548 } while (rtas_busy_delay(rc));
551 return rtas_error_rc(rc);
554 EXPORT_SYMBOL(rtas_get_sensor);
556 int rtas_set_indicator(int indicator, int index, int new_value)
558 int token = rtas_token("set-indicator");
561 if (token == RTAS_UNKNOWN_SERVICE)
565 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
566 } while (rtas_busy_delay(rc));
569 return rtas_error_rc(rc);
572 EXPORT_SYMBOL(rtas_set_indicator);
575 * Ignoring RTAS extended delay
577 int rtas_set_indicator_fast(int indicator, int index, int new_value)
580 int token = rtas_token("set-indicator");
582 if (token == RTAS_UNKNOWN_SERVICE)
585 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
587 WARN_ON(rc == -2 || (rc >= 9900 && rc <= 9905));
590 return rtas_error_rc(rc);
595 void rtas_restart(char *cmd)
597 if (rtas_flash_term_hook)
598 rtas_flash_term_hook(SYS_RESTART);
599 printk("RTAS system-reboot returned %d\n",
600 rtas_call(rtas_token("system-reboot"), 0, 1, NULL));
604 void rtas_power_off(void)
606 if (rtas_flash_term_hook)
607 rtas_flash_term_hook(SYS_POWER_OFF);
608 /* allow power on only with power button press */
609 printk("RTAS power-off returned %d\n",
610 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
616 if (rtas_flash_term_hook)
617 rtas_flash_term_hook(SYS_HALT);
618 /* allow power on only with power button press */
619 printk("RTAS power-off returned %d\n",
620 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
624 /* Must be in the RMO region, so we place it here */
625 static char rtas_os_term_buf[2048];
627 void rtas_os_term(char *str)
634 if (RTAS_UNKNOWN_SERVICE == rtas_token("ibm,os-term"))
637 snprintf(rtas_os_term_buf, 2048, "OS panic: %s", str);
640 status = rtas_call(rtas_token("ibm,os-term"), 1, 1, NULL,
641 __pa(rtas_os_term_buf));
642 } while (rtas_busy_delay(status));
645 printk(KERN_EMERG "ibm,os-term call failed %d\n",
649 static int ibm_suspend_me_token = RTAS_UNKNOWN_SERVICE;
650 #ifdef CONFIG_PPC_PSERIES
651 static void rtas_percpu_suspend_me(void *info)
656 struct rtas_suspend_me_data *data =
657 (struct rtas_suspend_me_data *)info;
660 * We use "waiting" to indicate our state. As long
661 * as it is >0, we are still trying to all join up.
662 * If it goes to 0, we have successfully joined up and
663 * one thread got H_CONTINUE. If any error happens,
666 local_irq_save(flags);
668 rc = plpar_hcall_norets(H_JOIN);
670 } while (rc == H_SUCCESS && data->waiting > 0);
674 if (rc == H_CONTINUE) {
676 data->args->args[data->args->nargs] =
677 rtas_call(ibm_suspend_me_token, 0, 1, NULL);
678 for_each_possible_cpu(i)
679 plpar_hcall_norets(H_PROD,i);
681 data->waiting = -EBUSY;
682 printk(KERN_ERR "Error on H_JOIN hypervisor call\n");
686 local_irq_restore(flags);
690 static int rtas_ibm_suspend_me(struct rtas_args *args)
695 unsigned long retbuf[PLPAR_HCALL_BUFSIZE];
696 struct rtas_suspend_me_data data;
698 /* Make sure the state is valid */
699 rc = plpar_hcall(H_VASI_STATE, retbuf,
700 ((u64)args->args[0] << 32) | args->args[1]);
705 printk(KERN_ERR "rtas_ibm_suspend_me: vasi_state returned %ld\n",rc);
707 } else if (state == H_VASI_ENABLED) {
708 args->args[args->nargs] = RTAS_NOT_SUSPENDABLE;
710 } else if (state != H_VASI_SUSPENDING) {
711 printk(KERN_ERR "rtas_ibm_suspend_me: vasi_state returned state %ld\n",
713 args->args[args->nargs] = -1;
720 /* Call function on all CPUs. One of us will make the
723 if (on_each_cpu(rtas_percpu_suspend_me, &data, 1, 0))
724 data.waiting = -EINVAL;
726 if (data.waiting != 0)
727 printk(KERN_ERR "Error doing global join\n");
729 /* Prod each CPU. This won't hurt, and will wake
730 * anyone we successfully put to sleep with H_JOIN.
732 for_each_possible_cpu(i)
733 plpar_hcall_norets(H_PROD, i);
737 #else /* CONFIG_PPC_PSERIES */
738 static int rtas_ibm_suspend_me(struct rtas_args *args)
744 asmlinkage int ppc_rtas(struct rtas_args __user *uargs)
746 struct rtas_args args;
748 char *buff_copy, *errbuf = NULL;
752 if (!capable(CAP_SYS_ADMIN))
755 if (copy_from_user(&args, uargs, 3 * sizeof(u32)) != 0)
759 if (nargs > ARRAY_SIZE(args.args)
760 || args.nret > ARRAY_SIZE(args.args)
761 || nargs + args.nret > ARRAY_SIZE(args.args))
765 if (copy_from_user(args.args, uargs->args,
766 nargs * sizeof(rtas_arg_t)) != 0)
769 if (args.token == RTAS_UNKNOWN_SERVICE)
772 /* Need to handle ibm,suspend_me call specially */
773 if (args.token == ibm_suspend_me_token) {
774 rc = rtas_ibm_suspend_me(&args);
780 buff_copy = get_errorlog_buffer();
782 spin_lock_irqsave(&rtas.lock, flags);
785 enter_rtas(__pa(&rtas.args));
788 args.rets = &args.args[nargs];
790 /* A -1 return code indicates that the last command couldn't
791 be completed due to a hardware error. */
792 if (args.rets[0] == -1)
793 errbuf = __fetch_rtas_last_error(buff_copy);
795 spin_unlock_irqrestore(&rtas.lock, flags);
799 log_error(errbuf, ERR_TYPE_RTAS_LOG, 0);
805 if (copy_to_user(uargs->args + nargs,
807 args.nret * sizeof(rtas_arg_t)) != 0)
813 #ifdef CONFIG_HOTPLUG_CPU
814 /* This version can't take the spinlock, because it never returns */
815 static struct rtas_args rtas_stop_self_args = {
816 /* The token is initialized for real in setup_system() */
817 .token = RTAS_UNKNOWN_SERVICE,
820 .rets = &rtas_stop_self_args.args[0],
823 void rtas_stop_self(void)
825 struct rtas_args *rtas_args = &rtas_stop_self_args;
829 BUG_ON(rtas_args->token == RTAS_UNKNOWN_SERVICE);
831 printk("cpu %u (hwid %u) Ready to die...\n",
832 smp_processor_id(), hard_smp_processor_id());
833 enter_rtas(__pa(rtas_args));
835 panic("Alas, I survived.\n");
840 * Call early during boot, before mem init or bootmem, to retrieve the RTAS
841 * informations from the device-tree and allocate the RMO buffer for userland
844 void __init rtas_initialize(void)
846 unsigned long rtas_region = RTAS_INSTANTIATE_MAX;
848 /* Get RTAS dev node and fill up our "rtas" structure with infos
851 rtas.dev = of_find_node_by_name(NULL, "rtas");
853 const u32 *basep, *entryp, *sizep;
855 basep = get_property(rtas.dev, "linux,rtas-base", NULL);
856 sizep = get_property(rtas.dev, "rtas-size", NULL);
857 if (basep != NULL && sizep != NULL) {
860 entryp = get_property(rtas.dev,
861 "linux,rtas-entry", NULL);
862 if (entryp == NULL) /* Ugh */
863 rtas.entry = rtas.base;
865 rtas.entry = *entryp;
872 /* If RTAS was found, allocate the RMO buffer for it and look for
873 * the stop-self token if any
876 if (machine_is(pseries) && firmware_has_feature(FW_FEATURE_LPAR)) {
877 rtas_region = min(lmb.rmo_size, RTAS_INSTANTIATE_MAX);
878 ibm_suspend_me_token = rtas_token("ibm,suspend-me");
881 rtas_rmo_buf = lmb_alloc_base(RTAS_RMOBUF_MAX, PAGE_SIZE, rtas_region);
883 #ifdef CONFIG_HOTPLUG_CPU
884 rtas_stop_self_args.token = rtas_token("stop-self");
885 #endif /* CONFIG_HOTPLUG_CPU */
886 #ifdef CONFIG_RTAS_ERROR_LOGGING
887 rtas_last_error_token = rtas_token("rtas-last-error");
891 int __init early_init_dt_scan_rtas(unsigned long node,
892 const char *uname, int depth, void *data)
894 u32 *basep, *entryp, *sizep;
896 if (depth != 1 || strcmp(uname, "rtas") != 0)
899 basep = of_get_flat_dt_prop(node, "linux,rtas-base", NULL);
900 entryp = of_get_flat_dt_prop(node, "linux,rtas-entry", NULL);
901 sizep = of_get_flat_dt_prop(node, "rtas-size", NULL);
903 if (basep && entryp && sizep) {
905 rtas.entry = *entryp;
909 #ifdef CONFIG_UDBG_RTAS_CONSOLE
910 basep = of_get_flat_dt_prop(node, "put-term-char", NULL);
912 rtas_putchar_token = *basep;
914 basep = of_get_flat_dt_prop(node, "get-term-char", NULL);
916 rtas_getchar_token = *basep;
918 if (rtas_putchar_token != RTAS_UNKNOWN_SERVICE &&
919 rtas_getchar_token != RTAS_UNKNOWN_SERVICE)
920 udbg_init_rtas_console();