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>
22 #include <linux/smp.h>
23 #include <linux/completion.h>
24 #include <linux/cpumask.h>
25 #include <linux/lmb.h>
29 #include <asm/hvcall.h>
30 #include <asm/machdep.h>
31 #include <asm/firmware.h>
33 #include <asm/param.h>
34 #include <asm/system.h>
35 #include <asm/delay.h>
36 #include <asm/uaccess.h>
38 #include <asm/syscalls.h>
40 #include <asm/atomic.h>
42 struct rtas_t rtas = {
43 .lock = SPIN_LOCK_UNLOCKED
47 struct rtas_suspend_me_data {
48 atomic_t working; /* number of cpus accessing this struct */
50 int token; /* ibm,suspend-me */
52 struct completion *complete; /* wait on this until working == 0 */
55 DEFINE_SPINLOCK(rtas_data_buf_lock);
56 EXPORT_SYMBOL(rtas_data_buf_lock);
58 char rtas_data_buf[RTAS_DATA_BUF_SIZE] __cacheline_aligned;
59 EXPORT_SYMBOL(rtas_data_buf);
61 unsigned long rtas_rmo_buf;
64 * If non-NULL, this gets called when the kernel terminates.
65 * This is done like this so rtas_flash can be a module.
67 void (*rtas_flash_term_hook)(int);
68 EXPORT_SYMBOL(rtas_flash_term_hook);
71 * call_rtas_display_status and call_rtas_display_status_delay
72 * are designed only for very early low-level debugging, which
73 * is why the token is hard-coded to 10.
75 static void call_rtas_display_status(char c)
77 struct rtas_args *args = &rtas.args;
82 spin_lock_irqsave(&rtas.lock, s);
87 args->rets = (rtas_arg_t *)&(args->args[1]);
88 args->args[0] = (unsigned char)c;
90 enter_rtas(__pa(args));
92 spin_unlock_irqrestore(&rtas.lock, s);
95 static void call_rtas_display_status_delay(char c)
97 static int pending_newline = 0; /* did last write end with unprinted newline? */
98 static int width = 16;
102 call_rtas_display_status(' ');
107 if (pending_newline) {
108 call_rtas_display_status('\r');
109 call_rtas_display_status('\n');
113 call_rtas_display_status(c);
119 void __init udbg_init_rtas_panel(void)
121 udbg_putc = call_rtas_display_status_delay;
124 #ifdef CONFIG_UDBG_RTAS_CONSOLE
126 /* If you think you're dying before early_init_dt_scan_rtas() does its
127 * work, you can hard code the token values for your firmware here and
128 * hardcode rtas.base/entry etc.
130 static unsigned int rtas_putchar_token = RTAS_UNKNOWN_SERVICE;
131 static unsigned int rtas_getchar_token = RTAS_UNKNOWN_SERVICE;
133 static void udbg_rtascon_putc(char c)
140 /* Add CRs before LFs */
142 udbg_rtascon_putc('\r');
144 /* if there is more than one character to be displayed, wait a bit */
145 for (tries = 0; tries < 16; tries++) {
146 if (rtas_call(rtas_putchar_token, 1, 1, NULL, c) == 0)
152 static int udbg_rtascon_getc_poll(void)
159 if (rtas_call(rtas_getchar_token, 0, 2, &c))
165 static int udbg_rtascon_getc(void)
169 while ((c = udbg_rtascon_getc_poll()) == -1)
176 void __init udbg_init_rtas_console(void)
178 udbg_putc = udbg_rtascon_putc;
179 udbg_getc = udbg_rtascon_getc;
180 udbg_getc_poll = udbg_rtascon_getc_poll;
182 #endif /* CONFIG_UDBG_RTAS_CONSOLE */
184 void rtas_progress(char *s, unsigned short hex)
186 struct device_node *root;
190 static int display_character, set_indicator;
191 static int display_width, display_lines, form_feed;
192 static const int *row_width;
193 static DEFINE_SPINLOCK(progress_lock);
194 static int current_line;
195 static int pending_newline = 0; /* did last write end with unprinted newline? */
200 if (display_width == 0) {
201 display_width = 0x10;
202 if ((root = of_find_node_by_path("/rtas"))) {
203 if ((p = of_get_property(root,
204 "ibm,display-line-length", NULL)))
206 if ((p = of_get_property(root,
207 "ibm,form-feed", NULL)))
209 if ((p = of_get_property(root,
210 "ibm,display-number-of-lines", NULL)))
212 row_width = of_get_property(root,
213 "ibm,display-truncation-length", NULL);
216 display_character = rtas_token("display-character");
217 set_indicator = rtas_token("set-indicator");
220 if (display_character == RTAS_UNKNOWN_SERVICE) {
221 /* use hex display if available */
222 if (set_indicator != RTAS_UNKNOWN_SERVICE)
223 rtas_call(set_indicator, 3, 1, NULL, 6, 0, hex);
227 spin_lock(&progress_lock);
230 * Last write ended with newline, but we didn't print it since
231 * it would just clear the bottom line of output. Print it now
234 * If no newline is pending and form feed is supported, clear the
235 * display with a form feed; otherwise, print a CR to start output
236 * at the beginning of the line.
238 if (pending_newline) {
239 rtas_call(display_character, 1, 1, NULL, '\r');
240 rtas_call(display_character, 1, 1, NULL, '\n');
245 rtas_call(display_character, 1, 1, NULL,
248 rtas_call(display_character, 1, 1, NULL, '\r');
252 width = row_width[current_line];
254 width = display_width;
257 if (*os == '\n' || *os == '\r') {
258 /* If newline is the last character, save it
259 * until next call to avoid bumping up the
262 if (*os == '\n' && !os[1]) {
265 if (current_line > display_lines-1)
266 current_line = display_lines-1;
267 spin_unlock(&progress_lock);
271 /* RTAS wants CR-LF, not just LF */
274 rtas_call(display_character, 1, 1, NULL, '\r');
275 rtas_call(display_character, 1, 1, NULL, '\n');
277 /* CR might be used to re-draw a line, so we'll
278 * leave it alone and not add LF.
280 rtas_call(display_character, 1, 1, NULL, *os);
284 width = row_width[current_line];
286 width = display_width;
289 rtas_call(display_character, 1, 1, NULL, *os);
294 /* if we overwrite the screen length */
296 while ((*os != 0) && (*os != '\n') && (*os != '\r'))
300 spin_unlock(&progress_lock);
302 EXPORT_SYMBOL(rtas_progress); /* needed by rtas_flash module */
304 int rtas_token(const char *service)
307 if (rtas.dev == NULL)
308 return RTAS_UNKNOWN_SERVICE;
309 tokp = of_get_property(rtas.dev, service, NULL);
310 return tokp ? *tokp : RTAS_UNKNOWN_SERVICE;
312 EXPORT_SYMBOL(rtas_token);
314 int rtas_service_present(const char *service)
316 return rtas_token(service) != RTAS_UNKNOWN_SERVICE;
318 EXPORT_SYMBOL(rtas_service_present);
320 #ifdef CONFIG_RTAS_ERROR_LOGGING
322 * Return the firmware-specified size of the error log buffer
323 * for all rtas calls that require an error buffer argument.
324 * This includes 'check-exception' and 'rtas-last-error'.
326 int rtas_get_error_log_max(void)
328 static int rtas_error_log_max;
329 if (rtas_error_log_max)
330 return rtas_error_log_max;
332 rtas_error_log_max = rtas_token ("rtas-error-log-max");
333 if ((rtas_error_log_max == RTAS_UNKNOWN_SERVICE) ||
334 (rtas_error_log_max > RTAS_ERROR_LOG_MAX)) {
335 printk (KERN_WARNING "RTAS: bad log buffer size %d\n",
337 rtas_error_log_max = RTAS_ERROR_LOG_MAX;
339 return rtas_error_log_max;
341 EXPORT_SYMBOL(rtas_get_error_log_max);
344 static char rtas_err_buf[RTAS_ERROR_LOG_MAX];
345 static int rtas_last_error_token;
347 /** Return a copy of the detailed error text associated with the
348 * most recent failed call to rtas. Because the error text
349 * might go stale if there are any other intervening rtas calls,
350 * this routine must be called atomically with whatever produced
351 * the error (i.e. with rtas.lock still held from the previous call).
353 static char *__fetch_rtas_last_error(char *altbuf)
355 struct rtas_args err_args, save_args;
359 if (rtas_last_error_token == -1)
362 bufsz = rtas_get_error_log_max();
364 err_args.token = rtas_last_error_token;
367 err_args.args[0] = (rtas_arg_t)__pa(rtas_err_buf);
368 err_args.args[1] = bufsz;
369 err_args.args[2] = 0;
371 save_args = rtas.args;
372 rtas.args = err_args;
374 enter_rtas(__pa(&rtas.args));
376 err_args = rtas.args;
377 rtas.args = save_args;
379 /* Log the error in the unlikely case that there was one. */
380 if (unlikely(err_args.args[2] == 0)) {
386 buf = kmalloc(RTAS_ERROR_LOG_MAX, GFP_ATOMIC);
389 memcpy(buf, rtas_err_buf, RTAS_ERROR_LOG_MAX);
395 #define get_errorlog_buffer() kmalloc(RTAS_ERROR_LOG_MAX, GFP_KERNEL)
397 #else /* CONFIG_RTAS_ERROR_LOGGING */
398 #define __fetch_rtas_last_error(x) NULL
399 #define get_errorlog_buffer() NULL
402 int rtas_call(int token, int nargs, int nret, int *outputs, ...)
407 struct rtas_args *rtas_args;
408 char *buff_copy = NULL;
411 if (!rtas.entry || token == RTAS_UNKNOWN_SERVICE)
414 /* Gotta do something different here, use global lock for now... */
415 spin_lock_irqsave(&rtas.lock, s);
416 rtas_args = &rtas.args;
418 rtas_args->token = token;
419 rtas_args->nargs = nargs;
420 rtas_args->nret = nret;
421 rtas_args->rets = (rtas_arg_t *)&(rtas_args->args[nargs]);
422 va_start(list, outputs);
423 for (i = 0; i < nargs; ++i)
424 rtas_args->args[i] = va_arg(list, rtas_arg_t);
427 for (i = 0; i < nret; ++i)
428 rtas_args->rets[i] = 0;
430 enter_rtas(__pa(rtas_args));
432 /* A -1 return code indicates that the last command couldn't
433 be completed due to a hardware error. */
434 if (rtas_args->rets[0] == -1)
435 buff_copy = __fetch_rtas_last_error(NULL);
437 if (nret > 1 && outputs != NULL)
438 for (i = 0; i < nret-1; ++i)
439 outputs[i] = rtas_args->rets[i+1];
440 ret = (nret > 0)? rtas_args->rets[0]: 0;
442 /* Gotta do something different here, use global lock for now... */
443 spin_unlock_irqrestore(&rtas.lock, s);
446 log_error(buff_copy, ERR_TYPE_RTAS_LOG, 0);
452 EXPORT_SYMBOL(rtas_call);
454 /* For RTAS_BUSY (-2), delay for 1 millisecond. For an extended busy status
455 * code of 990n, perform the hinted delay of 10^n (last digit) milliseconds.
457 unsigned int rtas_busy_delay_time(int status)
462 if (status == RTAS_BUSY) {
464 } else if (status >= 9900 && status <= 9905) {
465 order = status - 9900;
466 for (ms = 1; order > 0; order--)
472 EXPORT_SYMBOL(rtas_busy_delay_time);
474 /* For an RTAS busy status code, perform the hinted delay. */
475 unsigned int rtas_busy_delay(int status)
480 ms = rtas_busy_delay_time(status);
486 EXPORT_SYMBOL(rtas_busy_delay);
488 static int rtas_error_rc(int rtas_rc)
493 case -1: /* Hardware Error */
496 case -3: /* Bad indicator/domain/etc */
499 case -9000: /* Isolation error */
502 case -9001: /* Outstanding TCE/PTE */
505 case -9002: /* No usable slot */
509 printk(KERN_ERR "%s: unexpected RTAS error %d\n",
517 int rtas_get_power_level(int powerdomain, int *level)
519 int token = rtas_token("get-power-level");
522 if (token == RTAS_UNKNOWN_SERVICE)
525 while ((rc = rtas_call(token, 1, 2, level, powerdomain)) == RTAS_BUSY)
529 return rtas_error_rc(rc);
532 EXPORT_SYMBOL(rtas_get_power_level);
534 int rtas_set_power_level(int powerdomain, int level, int *setlevel)
536 int token = rtas_token("set-power-level");
539 if (token == RTAS_UNKNOWN_SERVICE)
543 rc = rtas_call(token, 2, 2, setlevel, powerdomain, level);
544 } while (rtas_busy_delay(rc));
547 return rtas_error_rc(rc);
550 EXPORT_SYMBOL(rtas_set_power_level);
552 int rtas_get_sensor(int sensor, int index, int *state)
554 int token = rtas_token("get-sensor-state");
557 if (token == RTAS_UNKNOWN_SERVICE)
561 rc = rtas_call(token, 2, 2, state, sensor, index);
562 } while (rtas_busy_delay(rc));
565 return rtas_error_rc(rc);
568 EXPORT_SYMBOL(rtas_get_sensor);
570 bool rtas_indicator_present(int token, int *maxindex)
572 int proplen, count, i;
573 const struct indicator_elem {
578 indicators = of_get_property(rtas.dev, "rtas-indicators", &proplen);
582 count = proplen / sizeof(struct indicator_elem);
584 for (i = 0; i < count; i++) {
585 if (indicators[i].token != token)
588 *maxindex = indicators[i].maxindex;
594 EXPORT_SYMBOL(rtas_indicator_present);
596 int rtas_set_indicator(int indicator, int index, int new_value)
598 int token = rtas_token("set-indicator");
601 if (token == RTAS_UNKNOWN_SERVICE)
605 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
606 } while (rtas_busy_delay(rc));
609 return rtas_error_rc(rc);
612 EXPORT_SYMBOL(rtas_set_indicator);
615 * Ignoring RTAS extended delay
617 int rtas_set_indicator_fast(int indicator, int index, int new_value)
620 int token = rtas_token("set-indicator");
622 if (token == RTAS_UNKNOWN_SERVICE)
625 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
627 WARN_ON(rc == -2 || (rc >= 9900 && rc <= 9905));
630 return rtas_error_rc(rc);
635 void rtas_restart(char *cmd)
637 if (rtas_flash_term_hook)
638 rtas_flash_term_hook(SYS_RESTART);
639 printk("RTAS system-reboot returned %d\n",
640 rtas_call(rtas_token("system-reboot"), 0, 1, NULL));
644 void rtas_power_off(void)
646 if (rtas_flash_term_hook)
647 rtas_flash_term_hook(SYS_POWER_OFF);
648 /* allow power on only with power button press */
649 printk("RTAS power-off returned %d\n",
650 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
656 if (rtas_flash_term_hook)
657 rtas_flash_term_hook(SYS_HALT);
658 /* allow power on only with power button press */
659 printk("RTAS power-off returned %d\n",
660 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
664 /* Must be in the RMO region, so we place it here */
665 static char rtas_os_term_buf[2048];
667 void rtas_os_term(char *str)
674 if (RTAS_UNKNOWN_SERVICE == rtas_token("ibm,os-term"))
677 snprintf(rtas_os_term_buf, 2048, "OS panic: %s", str);
680 status = rtas_call(rtas_token("ibm,os-term"), 1, 1, NULL,
681 __pa(rtas_os_term_buf));
682 } while (rtas_busy_delay(status));
685 printk(KERN_EMERG "ibm,os-term call failed %d\n",
689 static int ibm_suspend_me_token = RTAS_UNKNOWN_SERVICE;
690 #ifdef CONFIG_PPC_PSERIES
691 static void rtas_percpu_suspend_me(void *info)
694 unsigned long msr_save;
696 struct rtas_suspend_me_data *data =
697 (struct rtas_suspend_me_data *)info;
699 atomic_inc(&data->working);
701 /* really need to ensure MSR.EE is off for H_JOIN */
703 mtmsr(msr_save & ~(MSR_EE));
705 while (rc == H_SUCCESS && !atomic_read(&data->done))
706 rc = plpar_hcall_norets(H_JOIN);
710 if (rc == H_SUCCESS) {
711 /* This cpu was prodded and the suspend is complete. */
713 } else if (rc == H_CONTINUE) {
714 /* All other cpus are in H_JOIN, this cpu does
717 printk(KERN_DEBUG "calling ibm,suspend-me on cpu %i\n",
719 data->error = rtas_call(data->token, 0, 1, NULL);
722 printk(KERN_DEBUG "ibm,suspend-me returned %d\n",
725 printk(KERN_ERR "H_JOIN on cpu %i failed with rc = %ld\n",
726 smp_processor_id(), rc);
730 atomic_set(&data->done, 1);
732 /* This cpu did the suspend or got an error; in either case,
733 * we need to prod all other other cpus out of join state.
734 * Extra prods are harmless.
736 for_each_online_cpu(cpu)
737 plpar_hcall_norets(H_PROD, get_hard_smp_processor_id(cpu));
739 if (atomic_dec_return(&data->working) == 0)
740 complete(data->complete);
743 static int rtas_ibm_suspend_me(struct rtas_args *args)
747 unsigned long retbuf[PLPAR_HCALL_BUFSIZE];
748 struct rtas_suspend_me_data data;
749 DECLARE_COMPLETION_ONSTACK(done);
751 if (!rtas_service_present("ibm,suspend-me"))
754 /* Make sure the state is valid */
755 rc = plpar_hcall(H_VASI_STATE, retbuf,
756 ((u64)args->args[0] << 32) | args->args[1]);
761 printk(KERN_ERR "rtas_ibm_suspend_me: vasi_state returned %ld\n",rc);
763 } else if (state == H_VASI_ENABLED) {
764 args->args[args->nargs] = RTAS_NOT_SUSPENDABLE;
766 } else if (state != H_VASI_SUSPENDING) {
767 printk(KERN_ERR "rtas_ibm_suspend_me: vasi_state returned state %ld\n",
769 args->args[args->nargs] = -1;
773 atomic_set(&data.working, 0);
774 atomic_set(&data.done, 0);
775 data.token = rtas_token("ibm,suspend-me");
777 data.complete = &done;
779 /* Call function on all CPUs. One of us will make the
782 if (on_each_cpu(rtas_percpu_suspend_me, &data, 0))
783 data.error = -EINVAL;
785 wait_for_completion(&done);
788 printk(KERN_ERR "Error doing global join\n");
792 #else /* CONFIG_PPC_PSERIES */
793 static int rtas_ibm_suspend_me(struct rtas_args *args)
799 asmlinkage int ppc_rtas(struct rtas_args __user *uargs)
801 struct rtas_args args;
803 char *buff_copy, *errbuf = NULL;
807 if (!capable(CAP_SYS_ADMIN))
810 if (copy_from_user(&args, uargs, 3 * sizeof(u32)) != 0)
814 if (nargs > ARRAY_SIZE(args.args)
815 || args.nret > ARRAY_SIZE(args.args)
816 || nargs + args.nret > ARRAY_SIZE(args.args))
820 if (copy_from_user(args.args, uargs->args,
821 nargs * sizeof(rtas_arg_t)) != 0)
824 if (args.token == RTAS_UNKNOWN_SERVICE)
827 args.rets = &args.args[nargs];
828 memset(args.rets, 0, args.nret * sizeof(rtas_arg_t));
830 /* Need to handle ibm,suspend_me call specially */
831 if (args.token == ibm_suspend_me_token) {
832 rc = rtas_ibm_suspend_me(&args);
838 buff_copy = get_errorlog_buffer();
840 spin_lock_irqsave(&rtas.lock, flags);
843 enter_rtas(__pa(&rtas.args));
846 /* A -1 return code indicates that the last command couldn't
847 be completed due to a hardware error. */
848 if (args.rets[0] == -1)
849 errbuf = __fetch_rtas_last_error(buff_copy);
851 spin_unlock_irqrestore(&rtas.lock, flags);
855 log_error(errbuf, ERR_TYPE_RTAS_LOG, 0);
861 if (copy_to_user(uargs->args + nargs,
863 args.nret * sizeof(rtas_arg_t)) != 0)
870 * Call early during boot, before mem init or bootmem, to retrieve the RTAS
871 * informations from the device-tree and allocate the RMO buffer for userland
874 void __init rtas_initialize(void)
876 unsigned long rtas_region = RTAS_INSTANTIATE_MAX;
878 /* Get RTAS dev node and fill up our "rtas" structure with infos
881 rtas.dev = of_find_node_by_name(NULL, "rtas");
883 const u32 *basep, *entryp, *sizep;
885 basep = of_get_property(rtas.dev, "linux,rtas-base", NULL);
886 sizep = of_get_property(rtas.dev, "rtas-size", NULL);
887 if (basep != NULL && sizep != NULL) {
890 entryp = of_get_property(rtas.dev,
891 "linux,rtas-entry", NULL);
892 if (entryp == NULL) /* Ugh */
893 rtas.entry = rtas.base;
895 rtas.entry = *entryp;
902 /* If RTAS was found, allocate the RMO buffer for it and look for
903 * the stop-self token if any
906 if (machine_is(pseries) && firmware_has_feature(FW_FEATURE_LPAR)) {
907 rtas_region = min(lmb.rmo_size, RTAS_INSTANTIATE_MAX);
908 ibm_suspend_me_token = rtas_token("ibm,suspend-me");
911 rtas_rmo_buf = lmb_alloc_base(RTAS_RMOBUF_MAX, PAGE_SIZE, rtas_region);
913 #ifdef CONFIG_RTAS_ERROR_LOGGING
914 rtas_last_error_token = rtas_token("rtas-last-error");
918 int __init early_init_dt_scan_rtas(unsigned long node,
919 const char *uname, int depth, void *data)
921 u32 *basep, *entryp, *sizep;
923 if (depth != 1 || strcmp(uname, "rtas") != 0)
926 basep = of_get_flat_dt_prop(node, "linux,rtas-base", NULL);
927 entryp = of_get_flat_dt_prop(node, "linux,rtas-entry", NULL);
928 sizep = of_get_flat_dt_prop(node, "rtas-size", NULL);
930 if (basep && entryp && sizep) {
932 rtas.entry = *entryp;
936 #ifdef CONFIG_UDBG_RTAS_CONSOLE
937 basep = of_get_flat_dt_prop(node, "put-term-char", NULL);
939 rtas_putchar_token = *basep;
941 basep = of_get_flat_dt_prop(node, "get-term-char", NULL);
943 rtas_getchar_token = *basep;
945 if (rtas_putchar_token != RTAS_UNKNOWN_SERVICE &&
946 rtas_getchar_token != RTAS_UNKNOWN_SERVICE)
947 udbg_init_rtas_console();