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>
44 struct rtas_t rtas = {
45 .lock = __RAW_SPIN_LOCK_UNLOCKED
49 struct rtas_suspend_me_data {
50 atomic_t working; /* number of cpus accessing this struct */
52 int token; /* ibm,suspend-me */
54 struct completion *complete; /* wait on this until working == 0 */
57 DEFINE_SPINLOCK(rtas_data_buf_lock);
58 EXPORT_SYMBOL(rtas_data_buf_lock);
60 char rtas_data_buf[RTAS_DATA_BUF_SIZE] __cacheline_aligned;
61 EXPORT_SYMBOL(rtas_data_buf);
63 unsigned long rtas_rmo_buf;
66 * If non-NULL, this gets called when the kernel terminates.
67 * This is done like this so rtas_flash can be a module.
69 void (*rtas_flash_term_hook)(int);
70 EXPORT_SYMBOL(rtas_flash_term_hook);
72 /* RTAS use home made raw locking instead of spin_lock_irqsave
73 * because those can be called from within really nasty contexts
74 * such as having the timebase stopped which would lockup with
75 * normal locks and spinlock debugging enabled
77 static unsigned long lock_rtas(void)
81 local_irq_save(flags);
83 __raw_spin_lock_flags(&rtas.lock, flags);
87 static void unlock_rtas(unsigned long flags)
89 __raw_spin_unlock(&rtas.lock);
90 local_irq_restore(flags);
95 * call_rtas_display_status and call_rtas_display_status_delay
96 * are designed only for very early low-level debugging, which
97 * is why the token is hard-coded to 10.
99 static void call_rtas_display_status(char c)
101 struct rtas_args *args = &rtas.args;
111 args->rets = (rtas_arg_t *)&(args->args[1]);
112 args->args[0] = (unsigned char)c;
114 enter_rtas(__pa(args));
119 static void call_rtas_display_status_delay(char c)
121 static int pending_newline = 0; /* did last write end with unprinted newline? */
122 static int width = 16;
126 call_rtas_display_status(' ');
131 if (pending_newline) {
132 call_rtas_display_status('\r');
133 call_rtas_display_status('\n');
137 call_rtas_display_status(c);
143 void __init udbg_init_rtas_panel(void)
145 udbg_putc = call_rtas_display_status_delay;
148 #ifdef CONFIG_UDBG_RTAS_CONSOLE
150 /* If you think you're dying before early_init_dt_scan_rtas() does its
151 * work, you can hard code the token values for your firmware here and
152 * hardcode rtas.base/entry etc.
154 static unsigned int rtas_putchar_token = RTAS_UNKNOWN_SERVICE;
155 static unsigned int rtas_getchar_token = RTAS_UNKNOWN_SERVICE;
157 static void udbg_rtascon_putc(char c)
164 /* Add CRs before LFs */
166 udbg_rtascon_putc('\r');
168 /* if there is more than one character to be displayed, wait a bit */
169 for (tries = 0; tries < 16; tries++) {
170 if (rtas_call(rtas_putchar_token, 1, 1, NULL, c) == 0)
176 static int udbg_rtascon_getc_poll(void)
183 if (rtas_call(rtas_getchar_token, 0, 2, &c))
189 static int udbg_rtascon_getc(void)
193 while ((c = udbg_rtascon_getc_poll()) == -1)
200 void __init udbg_init_rtas_console(void)
202 udbg_putc = udbg_rtascon_putc;
203 udbg_getc = udbg_rtascon_getc;
204 udbg_getc_poll = udbg_rtascon_getc_poll;
206 #endif /* CONFIG_UDBG_RTAS_CONSOLE */
208 void rtas_progress(char *s, unsigned short hex)
210 struct device_node *root;
214 static int display_character, set_indicator;
215 static int display_width, display_lines, form_feed;
216 static const int *row_width;
217 static DEFINE_SPINLOCK(progress_lock);
218 static int current_line;
219 static int pending_newline = 0; /* did last write end with unprinted newline? */
224 if (display_width == 0) {
225 display_width = 0x10;
226 if ((root = of_find_node_by_path("/rtas"))) {
227 if ((p = of_get_property(root,
228 "ibm,display-line-length", NULL)))
230 if ((p = of_get_property(root,
231 "ibm,form-feed", NULL)))
233 if ((p = of_get_property(root,
234 "ibm,display-number-of-lines", NULL)))
236 row_width = of_get_property(root,
237 "ibm,display-truncation-length", NULL);
240 display_character = rtas_token("display-character");
241 set_indicator = rtas_token("set-indicator");
244 if (display_character == RTAS_UNKNOWN_SERVICE) {
245 /* use hex display if available */
246 if (set_indicator != RTAS_UNKNOWN_SERVICE)
247 rtas_call(set_indicator, 3, 1, NULL, 6, 0, hex);
251 spin_lock(&progress_lock);
254 * Last write ended with newline, but we didn't print it since
255 * it would just clear the bottom line of output. Print it now
258 * If no newline is pending and form feed is supported, clear the
259 * display with a form feed; otherwise, print a CR to start output
260 * at the beginning of the line.
262 if (pending_newline) {
263 rtas_call(display_character, 1, 1, NULL, '\r');
264 rtas_call(display_character, 1, 1, NULL, '\n');
269 rtas_call(display_character, 1, 1, NULL,
272 rtas_call(display_character, 1, 1, NULL, '\r');
276 width = row_width[current_line];
278 width = display_width;
281 if (*os == '\n' || *os == '\r') {
282 /* If newline is the last character, save it
283 * until next call to avoid bumping up the
286 if (*os == '\n' && !os[1]) {
289 if (current_line > display_lines-1)
290 current_line = display_lines-1;
291 spin_unlock(&progress_lock);
295 /* RTAS wants CR-LF, not just LF */
298 rtas_call(display_character, 1, 1, NULL, '\r');
299 rtas_call(display_character, 1, 1, NULL, '\n');
301 /* CR might be used to re-draw a line, so we'll
302 * leave it alone and not add LF.
304 rtas_call(display_character, 1, 1, NULL, *os);
308 width = row_width[current_line];
310 width = display_width;
313 rtas_call(display_character, 1, 1, NULL, *os);
318 /* if we overwrite the screen length */
320 while ((*os != 0) && (*os != '\n') && (*os != '\r'))
324 spin_unlock(&progress_lock);
326 EXPORT_SYMBOL(rtas_progress); /* needed by rtas_flash module */
328 int rtas_token(const char *service)
331 if (rtas.dev == NULL)
332 return RTAS_UNKNOWN_SERVICE;
333 tokp = of_get_property(rtas.dev, service, NULL);
334 return tokp ? *tokp : RTAS_UNKNOWN_SERVICE;
336 EXPORT_SYMBOL(rtas_token);
338 int rtas_service_present(const char *service)
340 return rtas_token(service) != RTAS_UNKNOWN_SERVICE;
342 EXPORT_SYMBOL(rtas_service_present);
344 #ifdef CONFIG_RTAS_ERROR_LOGGING
346 * Return the firmware-specified size of the error log buffer
347 * for all rtas calls that require an error buffer argument.
348 * This includes 'check-exception' and 'rtas-last-error'.
350 int rtas_get_error_log_max(void)
352 static int rtas_error_log_max;
353 if (rtas_error_log_max)
354 return rtas_error_log_max;
356 rtas_error_log_max = rtas_token ("rtas-error-log-max");
357 if ((rtas_error_log_max == RTAS_UNKNOWN_SERVICE) ||
358 (rtas_error_log_max > RTAS_ERROR_LOG_MAX)) {
359 printk (KERN_WARNING "RTAS: bad log buffer size %d\n",
361 rtas_error_log_max = RTAS_ERROR_LOG_MAX;
363 return rtas_error_log_max;
365 EXPORT_SYMBOL(rtas_get_error_log_max);
368 static char rtas_err_buf[RTAS_ERROR_LOG_MAX];
369 static int rtas_last_error_token;
371 /** Return a copy of the detailed error text associated with the
372 * most recent failed call to rtas. Because the error text
373 * might go stale if there are any other intervening rtas calls,
374 * this routine must be called atomically with whatever produced
375 * the error (i.e. with rtas.lock still held from the previous call).
377 static char *__fetch_rtas_last_error(char *altbuf)
379 struct rtas_args err_args, save_args;
383 if (rtas_last_error_token == -1)
386 bufsz = rtas_get_error_log_max();
388 err_args.token = rtas_last_error_token;
391 err_args.args[0] = (rtas_arg_t)__pa(rtas_err_buf);
392 err_args.args[1] = bufsz;
393 err_args.args[2] = 0;
395 save_args = rtas.args;
396 rtas.args = err_args;
398 enter_rtas(__pa(&rtas.args));
400 err_args = rtas.args;
401 rtas.args = save_args;
403 /* Log the error in the unlikely case that there was one. */
404 if (unlikely(err_args.args[2] == 0)) {
410 buf = kmalloc(RTAS_ERROR_LOG_MAX, GFP_ATOMIC);
413 memcpy(buf, rtas_err_buf, RTAS_ERROR_LOG_MAX);
419 #define get_errorlog_buffer() kmalloc(RTAS_ERROR_LOG_MAX, GFP_KERNEL)
421 #else /* CONFIG_RTAS_ERROR_LOGGING */
422 #define __fetch_rtas_last_error(x) NULL
423 #define get_errorlog_buffer() NULL
426 int rtas_call(int token, int nargs, int nret, int *outputs, ...)
431 struct rtas_args *rtas_args;
432 char *buff_copy = NULL;
435 if (!rtas.entry || token == RTAS_UNKNOWN_SERVICE)
439 rtas_args = &rtas.args;
441 rtas_args->token = token;
442 rtas_args->nargs = nargs;
443 rtas_args->nret = nret;
444 rtas_args->rets = (rtas_arg_t *)&(rtas_args->args[nargs]);
445 va_start(list, outputs);
446 for (i = 0; i < nargs; ++i)
447 rtas_args->args[i] = va_arg(list, rtas_arg_t);
450 for (i = 0; i < nret; ++i)
451 rtas_args->rets[i] = 0;
453 enter_rtas(__pa(rtas_args));
455 /* A -1 return code indicates that the last command couldn't
456 be completed due to a hardware error. */
457 if (rtas_args->rets[0] == -1)
458 buff_copy = __fetch_rtas_last_error(NULL);
460 if (nret > 1 && outputs != NULL)
461 for (i = 0; i < nret-1; ++i)
462 outputs[i] = rtas_args->rets[i+1];
463 ret = (nret > 0)? rtas_args->rets[0]: 0;
468 log_error(buff_copy, ERR_TYPE_RTAS_LOG, 0);
474 EXPORT_SYMBOL(rtas_call);
476 /* For RTAS_BUSY (-2), delay for 1 millisecond. For an extended busy status
477 * code of 990n, perform the hinted delay of 10^n (last digit) milliseconds.
479 unsigned int rtas_busy_delay_time(int status)
484 if (status == RTAS_BUSY) {
486 } else if (status >= 9900 && status <= 9905) {
487 order = status - 9900;
488 for (ms = 1; order > 0; order--)
494 EXPORT_SYMBOL(rtas_busy_delay_time);
496 /* For an RTAS busy status code, perform the hinted delay. */
497 unsigned int rtas_busy_delay(int status)
502 ms = rtas_busy_delay_time(status);
508 EXPORT_SYMBOL(rtas_busy_delay);
510 static int rtas_error_rc(int rtas_rc)
515 case -1: /* Hardware Error */
518 case -3: /* Bad indicator/domain/etc */
521 case -9000: /* Isolation error */
524 case -9001: /* Outstanding TCE/PTE */
527 case -9002: /* No usable slot */
531 printk(KERN_ERR "%s: unexpected RTAS error %d\n",
539 int rtas_get_power_level(int powerdomain, int *level)
541 int token = rtas_token("get-power-level");
544 if (token == RTAS_UNKNOWN_SERVICE)
547 while ((rc = rtas_call(token, 1, 2, level, powerdomain)) == RTAS_BUSY)
551 return rtas_error_rc(rc);
554 EXPORT_SYMBOL(rtas_get_power_level);
556 int rtas_set_power_level(int powerdomain, int level, int *setlevel)
558 int token = rtas_token("set-power-level");
561 if (token == RTAS_UNKNOWN_SERVICE)
565 rc = rtas_call(token, 2, 2, setlevel, powerdomain, level);
566 } while (rtas_busy_delay(rc));
569 return rtas_error_rc(rc);
572 EXPORT_SYMBOL(rtas_set_power_level);
574 int rtas_get_sensor(int sensor, int index, int *state)
576 int token = rtas_token("get-sensor-state");
579 if (token == RTAS_UNKNOWN_SERVICE)
583 rc = rtas_call(token, 2, 2, state, sensor, index);
584 } while (rtas_busy_delay(rc));
587 return rtas_error_rc(rc);
590 EXPORT_SYMBOL(rtas_get_sensor);
592 bool rtas_indicator_present(int token, int *maxindex)
594 int proplen, count, i;
595 const struct indicator_elem {
600 indicators = of_get_property(rtas.dev, "rtas-indicators", &proplen);
604 count = proplen / sizeof(struct indicator_elem);
606 for (i = 0; i < count; i++) {
607 if (indicators[i].token != token)
610 *maxindex = indicators[i].maxindex;
616 EXPORT_SYMBOL(rtas_indicator_present);
618 int rtas_set_indicator(int indicator, int index, int new_value)
620 int token = rtas_token("set-indicator");
623 if (token == RTAS_UNKNOWN_SERVICE)
627 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
628 } while (rtas_busy_delay(rc));
631 return rtas_error_rc(rc);
634 EXPORT_SYMBOL(rtas_set_indicator);
637 * Ignoring RTAS extended delay
639 int rtas_set_indicator_fast(int indicator, int index, int new_value)
642 int token = rtas_token("set-indicator");
644 if (token == RTAS_UNKNOWN_SERVICE)
647 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
649 WARN_ON(rc == -2 || (rc >= 9900 && rc <= 9905));
652 return rtas_error_rc(rc);
657 void rtas_restart(char *cmd)
659 if (rtas_flash_term_hook)
660 rtas_flash_term_hook(SYS_RESTART);
661 printk("RTAS system-reboot returned %d\n",
662 rtas_call(rtas_token("system-reboot"), 0, 1, NULL));
666 void rtas_power_off(void)
668 if (rtas_flash_term_hook)
669 rtas_flash_term_hook(SYS_POWER_OFF);
670 /* allow power on only with power button press */
671 printk("RTAS power-off returned %d\n",
672 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
678 if (rtas_flash_term_hook)
679 rtas_flash_term_hook(SYS_HALT);
680 /* allow power on only with power button press */
681 printk("RTAS power-off returned %d\n",
682 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
686 /* Must be in the RMO region, so we place it here */
687 static char rtas_os_term_buf[2048];
689 void rtas_os_term(char *str)
696 if (RTAS_UNKNOWN_SERVICE == rtas_token("ibm,os-term"))
699 snprintf(rtas_os_term_buf, 2048, "OS panic: %s", str);
702 status = rtas_call(rtas_token("ibm,os-term"), 1, 1, NULL,
703 __pa(rtas_os_term_buf));
704 } while (rtas_busy_delay(status));
707 printk(KERN_EMERG "ibm,os-term call failed %d\n",
711 static int ibm_suspend_me_token = RTAS_UNKNOWN_SERVICE;
712 #ifdef CONFIG_PPC_PSERIES
713 static void rtas_percpu_suspend_me(void *info)
716 unsigned long msr_save;
717 u16 slb_size = mmu_slb_size;
719 struct rtas_suspend_me_data *data =
720 (struct rtas_suspend_me_data *)info;
722 atomic_inc(&data->working);
724 /* really need to ensure MSR.EE is off for H_JOIN */
726 mtmsr(msr_save & ~(MSR_EE));
728 while (rc == H_SUCCESS && !atomic_read(&data->done))
729 rc = plpar_hcall_norets(H_JOIN);
733 if (rc == H_SUCCESS) {
734 /* This cpu was prodded and the suspend is complete. */
736 } else if (rc == H_CONTINUE) {
737 /* All other cpus are in H_JOIN, this cpu does
740 slb_set_size(SLB_MIN_SIZE);
741 printk(KERN_DEBUG "calling ibm,suspend-me on cpu %i\n",
743 data->error = rtas_call(data->token, 0, 1, NULL);
746 printk(KERN_DEBUG "ibm,suspend-me returned %d\n",
748 slb_set_size(slb_size);
751 printk(KERN_ERR "H_JOIN on cpu %i failed with rc = %ld\n",
752 smp_processor_id(), rc);
756 atomic_set(&data->done, 1);
758 /* This cpu did the suspend or got an error; in either case,
759 * we need to prod all other other cpus out of join state.
760 * Extra prods are harmless.
762 for_each_online_cpu(cpu)
763 plpar_hcall_norets(H_PROD, get_hard_smp_processor_id(cpu));
765 if (atomic_dec_return(&data->working) == 0)
766 complete(data->complete);
769 static int rtas_ibm_suspend_me(struct rtas_args *args)
773 unsigned long retbuf[PLPAR_HCALL_BUFSIZE];
774 struct rtas_suspend_me_data data;
775 DECLARE_COMPLETION_ONSTACK(done);
777 if (!rtas_service_present("ibm,suspend-me"))
780 /* Make sure the state is valid */
781 rc = plpar_hcall(H_VASI_STATE, retbuf,
782 ((u64)args->args[0] << 32) | args->args[1]);
787 printk(KERN_ERR "rtas_ibm_suspend_me: vasi_state returned %ld\n",rc);
789 } else if (state == H_VASI_ENABLED) {
790 args->args[args->nargs] = RTAS_NOT_SUSPENDABLE;
792 } else if (state != H_VASI_SUSPENDING) {
793 printk(KERN_ERR "rtas_ibm_suspend_me: vasi_state returned state %ld\n",
795 args->args[args->nargs] = -1;
799 atomic_set(&data.working, 0);
800 atomic_set(&data.done, 0);
801 data.token = rtas_token("ibm,suspend-me");
803 data.complete = &done;
805 /* Call function on all CPUs. One of us will make the
808 if (on_each_cpu(rtas_percpu_suspend_me, &data, 0))
809 data.error = -EINVAL;
811 wait_for_completion(&done);
814 printk(KERN_ERR "Error doing global join\n");
818 #else /* CONFIG_PPC_PSERIES */
819 static int rtas_ibm_suspend_me(struct rtas_args *args)
825 asmlinkage int ppc_rtas(struct rtas_args __user *uargs)
827 struct rtas_args args;
829 char *buff_copy, *errbuf = NULL;
833 if (!capable(CAP_SYS_ADMIN))
836 if (copy_from_user(&args, uargs, 3 * sizeof(u32)) != 0)
840 if (nargs > ARRAY_SIZE(args.args)
841 || args.nret > ARRAY_SIZE(args.args)
842 || nargs + args.nret > ARRAY_SIZE(args.args))
846 if (copy_from_user(args.args, uargs->args,
847 nargs * sizeof(rtas_arg_t)) != 0)
850 if (args.token == RTAS_UNKNOWN_SERVICE)
853 args.rets = &args.args[nargs];
854 memset(args.rets, 0, args.nret * sizeof(rtas_arg_t));
856 /* Need to handle ibm,suspend_me call specially */
857 if (args.token == ibm_suspend_me_token) {
858 rc = rtas_ibm_suspend_me(&args);
864 buff_copy = get_errorlog_buffer();
869 enter_rtas(__pa(&rtas.args));
872 /* A -1 return code indicates that the last command couldn't
873 be completed due to a hardware error. */
874 if (args.rets[0] == -1)
875 errbuf = __fetch_rtas_last_error(buff_copy);
881 log_error(errbuf, ERR_TYPE_RTAS_LOG, 0);
887 if (copy_to_user(uargs->args + nargs,
889 args.nret * sizeof(rtas_arg_t)) != 0)
896 * Call early during boot, before mem init or bootmem, to retrieve the RTAS
897 * informations from the device-tree and allocate the RMO buffer for userland
900 void __init rtas_initialize(void)
902 unsigned long rtas_region = RTAS_INSTANTIATE_MAX;
904 /* Get RTAS dev node and fill up our "rtas" structure with infos
907 rtas.dev = of_find_node_by_name(NULL, "rtas");
909 const u32 *basep, *entryp, *sizep;
911 basep = of_get_property(rtas.dev, "linux,rtas-base", NULL);
912 sizep = of_get_property(rtas.dev, "rtas-size", NULL);
913 if (basep != NULL && sizep != NULL) {
916 entryp = of_get_property(rtas.dev,
917 "linux,rtas-entry", NULL);
918 if (entryp == NULL) /* Ugh */
919 rtas.entry = rtas.base;
921 rtas.entry = *entryp;
928 /* If RTAS was found, allocate the RMO buffer for it and look for
929 * the stop-self token if any
932 if (machine_is(pseries) && firmware_has_feature(FW_FEATURE_LPAR)) {
933 rtas_region = min(lmb.rmo_size, RTAS_INSTANTIATE_MAX);
934 ibm_suspend_me_token = rtas_token("ibm,suspend-me");
937 rtas_rmo_buf = lmb_alloc_base(RTAS_RMOBUF_MAX, PAGE_SIZE, rtas_region);
939 #ifdef CONFIG_RTAS_ERROR_LOGGING
940 rtas_last_error_token = rtas_token("rtas-last-error");
944 int __init early_init_dt_scan_rtas(unsigned long node,
945 const char *uname, int depth, void *data)
947 u32 *basep, *entryp, *sizep;
949 if (depth != 1 || strcmp(uname, "rtas") != 0)
952 basep = of_get_flat_dt_prop(node, "linux,rtas-base", NULL);
953 entryp = of_get_flat_dt_prop(node, "linux,rtas-entry", NULL);
954 sizep = of_get_flat_dt_prop(node, "rtas-size", NULL);
956 if (basep && entryp && sizep) {
958 rtas.entry = *entryp;
962 #ifdef CONFIG_UDBG_RTAS_CONSOLE
963 basep = of_get_flat_dt_prop(node, "put-term-char", NULL);
965 rtas_putchar_token = *basep;
967 basep = of_get_flat_dt_prop(node, "get-term-char", NULL);
969 rtas_getchar_token = *basep;
971 if (rtas_putchar_token != RTAS_UNKNOWN_SERVICE &&
972 rtas_getchar_token != RTAS_UNKNOWN_SERVICE)
973 udbg_init_rtas_console();
981 static raw_spinlock_t timebase_lock;
982 static u64 timebase = 0;
984 void __cpuinit rtas_give_timebase(void)
988 local_irq_save(flags);
990 __raw_spin_lock(&timebase_lock);
991 rtas_call(rtas_token("freeze-time-base"), 0, 1, NULL);
993 __raw_spin_unlock(&timebase_lock);
997 rtas_call(rtas_token("thaw-time-base"), 0, 1, NULL);
998 local_irq_restore(flags);
1001 void __cpuinit rtas_take_timebase(void)
1005 __raw_spin_lock(&timebase_lock);
1006 set_tb(timebase >> 32, timebase & 0xffffffff);
1008 __raw_spin_unlock(&timebase_lock);