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/memblock.h>
26 #include <linux/slab.h>
30 #include <asm/hvcall.h>
31 #include <asm/machdep.h>
32 #include <asm/firmware.h>
34 #include <asm/param.h>
35 #include <asm/system.h>
36 #include <asm/delay.h>
37 #include <asm/uaccess.h>
39 #include <asm/syscalls.h>
41 #include <asm/atomic.h>
45 struct rtas_t rtas = {
46 .lock = __ARCH_SPIN_LOCK_UNLOCKED
50 struct rtas_suspend_me_data {
51 atomic_t working; /* number of cpus accessing this struct */
53 int token; /* ibm,suspend-me */
55 struct completion *complete; /* wait on this until working == 0 */
58 DEFINE_SPINLOCK(rtas_data_buf_lock);
59 EXPORT_SYMBOL(rtas_data_buf_lock);
61 char rtas_data_buf[RTAS_DATA_BUF_SIZE] __cacheline_aligned;
62 EXPORT_SYMBOL(rtas_data_buf);
64 unsigned long rtas_rmo_buf;
67 * If non-NULL, this gets called when the kernel terminates.
68 * This is done like this so rtas_flash can be a module.
70 void (*rtas_flash_term_hook)(int);
71 EXPORT_SYMBOL(rtas_flash_term_hook);
73 /* RTAS use home made raw locking instead of spin_lock_irqsave
74 * because those can be called from within really nasty contexts
75 * such as having the timebase stopped which would lockup with
76 * normal locks and spinlock debugging enabled
78 static unsigned long lock_rtas(void)
82 local_irq_save(flags);
84 arch_spin_lock_flags(&rtas.lock, flags);
88 static void unlock_rtas(unsigned long flags)
90 arch_spin_unlock(&rtas.lock);
91 local_irq_restore(flags);
96 * call_rtas_display_status and call_rtas_display_status_delay
97 * are designed only for very early low-level debugging, which
98 * is why the token is hard-coded to 10.
100 static void call_rtas_display_status(char c)
102 struct rtas_args *args = &rtas.args;
112 args->rets = (rtas_arg_t *)&(args->args[1]);
113 args->args[0] = (unsigned char)c;
115 enter_rtas(__pa(args));
120 static void call_rtas_display_status_delay(char c)
122 static int pending_newline = 0; /* did last write end with unprinted newline? */
123 static int width = 16;
127 call_rtas_display_status(' ');
132 if (pending_newline) {
133 call_rtas_display_status('\r');
134 call_rtas_display_status('\n');
138 call_rtas_display_status(c);
144 void __init udbg_init_rtas_panel(void)
146 udbg_putc = call_rtas_display_status_delay;
149 #ifdef CONFIG_UDBG_RTAS_CONSOLE
151 /* If you think you're dying before early_init_dt_scan_rtas() does its
152 * work, you can hard code the token values for your firmware here and
153 * hardcode rtas.base/entry etc.
155 static unsigned int rtas_putchar_token = RTAS_UNKNOWN_SERVICE;
156 static unsigned int rtas_getchar_token = RTAS_UNKNOWN_SERVICE;
158 static void udbg_rtascon_putc(char c)
165 /* Add CRs before LFs */
167 udbg_rtascon_putc('\r');
169 /* if there is more than one character to be displayed, wait a bit */
170 for (tries = 0; tries < 16; tries++) {
171 if (rtas_call(rtas_putchar_token, 1, 1, NULL, c) == 0)
177 static int udbg_rtascon_getc_poll(void)
184 if (rtas_call(rtas_getchar_token, 0, 2, &c))
190 static int udbg_rtascon_getc(void)
194 while ((c = udbg_rtascon_getc_poll()) == -1)
201 void __init udbg_init_rtas_console(void)
203 udbg_putc = udbg_rtascon_putc;
204 udbg_getc = udbg_rtascon_getc;
205 udbg_getc_poll = udbg_rtascon_getc_poll;
207 #endif /* CONFIG_UDBG_RTAS_CONSOLE */
209 void rtas_progress(char *s, unsigned short hex)
211 struct device_node *root;
215 static int display_character, set_indicator;
216 static int display_width, display_lines, form_feed;
217 static const int *row_width;
218 static DEFINE_SPINLOCK(progress_lock);
219 static int current_line;
220 static int pending_newline = 0; /* did last write end with unprinted newline? */
225 if (display_width == 0) {
226 display_width = 0x10;
227 if ((root = of_find_node_by_path("/rtas"))) {
228 if ((p = of_get_property(root,
229 "ibm,display-line-length", NULL)))
231 if ((p = of_get_property(root,
232 "ibm,form-feed", NULL)))
234 if ((p = of_get_property(root,
235 "ibm,display-number-of-lines", NULL)))
237 row_width = of_get_property(root,
238 "ibm,display-truncation-length", NULL);
241 display_character = rtas_token("display-character");
242 set_indicator = rtas_token("set-indicator");
245 if (display_character == RTAS_UNKNOWN_SERVICE) {
246 /* use hex display if available */
247 if (set_indicator != RTAS_UNKNOWN_SERVICE)
248 rtas_call(set_indicator, 3, 1, NULL, 6, 0, hex);
252 spin_lock(&progress_lock);
255 * Last write ended with newline, but we didn't print it since
256 * it would just clear the bottom line of output. Print it now
259 * If no newline is pending and form feed is supported, clear the
260 * display with a form feed; otherwise, print a CR to start output
261 * at the beginning of the line.
263 if (pending_newline) {
264 rtas_call(display_character, 1, 1, NULL, '\r');
265 rtas_call(display_character, 1, 1, NULL, '\n');
270 rtas_call(display_character, 1, 1, NULL,
273 rtas_call(display_character, 1, 1, NULL, '\r');
277 width = row_width[current_line];
279 width = display_width;
282 if (*os == '\n' || *os == '\r') {
283 /* If newline is the last character, save it
284 * until next call to avoid bumping up the
287 if (*os == '\n' && !os[1]) {
290 if (current_line > display_lines-1)
291 current_line = display_lines-1;
292 spin_unlock(&progress_lock);
296 /* RTAS wants CR-LF, not just LF */
299 rtas_call(display_character, 1, 1, NULL, '\r');
300 rtas_call(display_character, 1, 1, NULL, '\n');
302 /* CR might be used to re-draw a line, so we'll
303 * leave it alone and not add LF.
305 rtas_call(display_character, 1, 1, NULL, *os);
309 width = row_width[current_line];
311 width = display_width;
314 rtas_call(display_character, 1, 1, NULL, *os);
319 /* if we overwrite the screen length */
321 while ((*os != 0) && (*os != '\n') && (*os != '\r'))
325 spin_unlock(&progress_lock);
327 EXPORT_SYMBOL(rtas_progress); /* needed by rtas_flash module */
329 int rtas_token(const char *service)
332 if (rtas.dev == NULL)
333 return RTAS_UNKNOWN_SERVICE;
334 tokp = of_get_property(rtas.dev, service, NULL);
335 return tokp ? *tokp : RTAS_UNKNOWN_SERVICE;
337 EXPORT_SYMBOL(rtas_token);
339 int rtas_service_present(const char *service)
341 return rtas_token(service) != RTAS_UNKNOWN_SERVICE;
343 EXPORT_SYMBOL(rtas_service_present);
345 #ifdef CONFIG_RTAS_ERROR_LOGGING
347 * Return the firmware-specified size of the error log buffer
348 * for all rtas calls that require an error buffer argument.
349 * This includes 'check-exception' and 'rtas-last-error'.
351 int rtas_get_error_log_max(void)
353 static int rtas_error_log_max;
354 if (rtas_error_log_max)
355 return rtas_error_log_max;
357 rtas_error_log_max = rtas_token ("rtas-error-log-max");
358 if ((rtas_error_log_max == RTAS_UNKNOWN_SERVICE) ||
359 (rtas_error_log_max > RTAS_ERROR_LOG_MAX)) {
360 printk (KERN_WARNING "RTAS: bad log buffer size %d\n",
362 rtas_error_log_max = RTAS_ERROR_LOG_MAX;
364 return rtas_error_log_max;
366 EXPORT_SYMBOL(rtas_get_error_log_max);
369 static char rtas_err_buf[RTAS_ERROR_LOG_MAX];
370 static int rtas_last_error_token;
372 /** Return a copy of the detailed error text associated with the
373 * most recent failed call to rtas. Because the error text
374 * might go stale if there are any other intervening rtas calls,
375 * this routine must be called atomically with whatever produced
376 * the error (i.e. with rtas.lock still held from the previous call).
378 static char *__fetch_rtas_last_error(char *altbuf)
380 struct rtas_args err_args, save_args;
384 if (rtas_last_error_token == -1)
387 bufsz = rtas_get_error_log_max();
389 err_args.token = rtas_last_error_token;
392 err_args.args[0] = (rtas_arg_t)__pa(rtas_err_buf);
393 err_args.args[1] = bufsz;
394 err_args.args[2] = 0;
396 save_args = rtas.args;
397 rtas.args = err_args;
399 enter_rtas(__pa(&rtas.args));
401 err_args = rtas.args;
402 rtas.args = save_args;
404 /* Log the error in the unlikely case that there was one. */
405 if (unlikely(err_args.args[2] == 0)) {
411 buf = kmalloc(RTAS_ERROR_LOG_MAX, GFP_ATOMIC);
414 memcpy(buf, rtas_err_buf, RTAS_ERROR_LOG_MAX);
420 #define get_errorlog_buffer() kmalloc(RTAS_ERROR_LOG_MAX, GFP_KERNEL)
422 #else /* CONFIG_RTAS_ERROR_LOGGING */
423 #define __fetch_rtas_last_error(x) NULL
424 #define get_errorlog_buffer() NULL
427 int rtas_call(int token, int nargs, int nret, int *outputs, ...)
432 struct rtas_args *rtas_args;
433 char *buff_copy = NULL;
436 if (!rtas.entry || token == RTAS_UNKNOWN_SERVICE)
440 rtas_args = &rtas.args;
442 rtas_args->token = token;
443 rtas_args->nargs = nargs;
444 rtas_args->nret = nret;
445 rtas_args->rets = (rtas_arg_t *)&(rtas_args->args[nargs]);
446 va_start(list, outputs);
447 for (i = 0; i < nargs; ++i)
448 rtas_args->args[i] = va_arg(list, rtas_arg_t);
451 for (i = 0; i < nret; ++i)
452 rtas_args->rets[i] = 0;
454 enter_rtas(__pa(rtas_args));
456 /* A -1 return code indicates that the last command couldn't
457 be completed due to a hardware error. */
458 if (rtas_args->rets[0] == -1)
459 buff_copy = __fetch_rtas_last_error(NULL);
461 if (nret > 1 && outputs != NULL)
462 for (i = 0; i < nret-1; ++i)
463 outputs[i] = rtas_args->rets[i+1];
464 ret = (nret > 0)? rtas_args->rets[0]: 0;
469 log_error(buff_copy, ERR_TYPE_RTAS_LOG, 0);
475 EXPORT_SYMBOL(rtas_call);
477 /* For RTAS_BUSY (-2), delay for 1 millisecond. For an extended busy status
478 * code of 990n, perform the hinted delay of 10^n (last digit) milliseconds.
480 unsigned int rtas_busy_delay_time(int status)
485 if (status == RTAS_BUSY) {
487 } else if (status >= 9900 && status <= 9905) {
488 order = status - 9900;
489 for (ms = 1; order > 0; order--)
495 EXPORT_SYMBOL(rtas_busy_delay_time);
497 /* For an RTAS busy status code, perform the hinted delay. */
498 unsigned int rtas_busy_delay(int status)
503 ms = rtas_busy_delay_time(status);
509 EXPORT_SYMBOL(rtas_busy_delay);
511 static int rtas_error_rc(int rtas_rc)
516 case -1: /* Hardware Error */
519 case -3: /* Bad indicator/domain/etc */
522 case -9000: /* Isolation error */
525 case -9001: /* Outstanding TCE/PTE */
528 case -9002: /* No usable slot */
532 printk(KERN_ERR "%s: unexpected RTAS error %d\n",
540 int rtas_get_power_level(int powerdomain, int *level)
542 int token = rtas_token("get-power-level");
545 if (token == RTAS_UNKNOWN_SERVICE)
548 while ((rc = rtas_call(token, 1, 2, level, powerdomain)) == RTAS_BUSY)
552 return rtas_error_rc(rc);
555 EXPORT_SYMBOL(rtas_get_power_level);
557 int rtas_set_power_level(int powerdomain, int level, int *setlevel)
559 int token = rtas_token("set-power-level");
562 if (token == RTAS_UNKNOWN_SERVICE)
566 rc = rtas_call(token, 2, 2, setlevel, powerdomain, level);
567 } while (rtas_busy_delay(rc));
570 return rtas_error_rc(rc);
573 EXPORT_SYMBOL(rtas_set_power_level);
575 int rtas_get_sensor(int sensor, int index, int *state)
577 int token = rtas_token("get-sensor-state");
580 if (token == RTAS_UNKNOWN_SERVICE)
584 rc = rtas_call(token, 2, 2, state, sensor, index);
585 } while (rtas_busy_delay(rc));
588 return rtas_error_rc(rc);
591 EXPORT_SYMBOL(rtas_get_sensor);
593 bool rtas_indicator_present(int token, int *maxindex)
595 int proplen, count, i;
596 const struct indicator_elem {
601 indicators = of_get_property(rtas.dev, "rtas-indicators", &proplen);
605 count = proplen / sizeof(struct indicator_elem);
607 for (i = 0; i < count; i++) {
608 if (indicators[i].token != token)
611 *maxindex = indicators[i].maxindex;
617 EXPORT_SYMBOL(rtas_indicator_present);
619 int rtas_set_indicator(int indicator, int index, int new_value)
621 int token = rtas_token("set-indicator");
624 if (token == RTAS_UNKNOWN_SERVICE)
628 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
629 } while (rtas_busy_delay(rc));
632 return rtas_error_rc(rc);
635 EXPORT_SYMBOL(rtas_set_indicator);
638 * Ignoring RTAS extended delay
640 int rtas_set_indicator_fast(int indicator, int index, int new_value)
643 int token = rtas_token("set-indicator");
645 if (token == RTAS_UNKNOWN_SERVICE)
648 rc = rtas_call(token, 3, 1, NULL, indicator, index, new_value);
650 WARN_ON(rc == -2 || (rc >= 9900 && rc <= 9905));
653 return rtas_error_rc(rc);
658 void rtas_restart(char *cmd)
660 if (rtas_flash_term_hook)
661 rtas_flash_term_hook(SYS_RESTART);
662 printk("RTAS system-reboot returned %d\n",
663 rtas_call(rtas_token("system-reboot"), 0, 1, NULL));
667 void rtas_power_off(void)
669 if (rtas_flash_term_hook)
670 rtas_flash_term_hook(SYS_POWER_OFF);
671 /* allow power on only with power button press */
672 printk("RTAS power-off returned %d\n",
673 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
679 if (rtas_flash_term_hook)
680 rtas_flash_term_hook(SYS_HALT);
681 /* allow power on only with power button press */
682 printk("RTAS power-off returned %d\n",
683 rtas_call(rtas_token("power-off"), 2, 1, NULL, -1, -1));
687 /* Must be in the RMO region, so we place it here */
688 static char rtas_os_term_buf[2048];
690 void rtas_os_term(char *str)
695 * Firmware with the ibm,extended-os-term property is guaranteed
696 * to always return from an ibm,os-term call. Earlier versions without
697 * this property may terminate the partition which we want to avoid
698 * since it interferes with panic_timeout.
700 if (RTAS_UNKNOWN_SERVICE == rtas_token("ibm,os-term") ||
701 RTAS_UNKNOWN_SERVICE == rtas_token("ibm,extended-os-term"))
704 snprintf(rtas_os_term_buf, 2048, "OS panic: %s", str);
707 status = rtas_call(rtas_token("ibm,os-term"), 1, 1, NULL,
708 __pa(rtas_os_term_buf));
709 } while (rtas_busy_delay(status));
712 printk(KERN_EMERG "ibm,os-term call failed %d\n", status);
715 static int ibm_suspend_me_token = RTAS_UNKNOWN_SERVICE;
716 #ifdef CONFIG_PPC_PSERIES
717 static void rtas_percpu_suspend_me(void *info)
720 unsigned long msr_save;
721 u16 slb_size = mmu_slb_size;
723 struct rtas_suspend_me_data *data =
724 (struct rtas_suspend_me_data *)info;
726 atomic_inc(&data->working);
728 /* really need to ensure MSR.EE is off for H_JOIN */
730 mtmsr(msr_save & ~(MSR_EE));
732 while (rc == H_SUCCESS && !atomic_read(&data->done))
733 rc = plpar_hcall_norets(H_JOIN);
737 if (rc == H_SUCCESS) {
738 /* This cpu was prodded and the suspend is complete. */
740 } else if (rc == H_CONTINUE) {
741 /* All other cpus are in H_JOIN, this cpu does
744 slb_set_size(SLB_MIN_SIZE);
745 printk(KERN_DEBUG "calling ibm,suspend-me on cpu %i\n",
747 data->error = rtas_call(data->token, 0, 1, NULL);
750 printk(KERN_DEBUG "ibm,suspend-me returned %d\n",
752 slb_set_size(slb_size);
755 printk(KERN_ERR "H_JOIN on cpu %i failed with rc = %ld\n",
756 smp_processor_id(), rc);
760 atomic_set(&data->done, 1);
762 /* This cpu did the suspend or got an error; in either case,
763 * we need to prod all other other cpus out of join state.
764 * Extra prods are harmless.
766 for_each_online_cpu(cpu)
767 plpar_hcall_norets(H_PROD, get_hard_smp_processor_id(cpu));
769 if (atomic_dec_return(&data->working) == 0)
770 complete(data->complete);
773 static int rtas_ibm_suspend_me(struct rtas_args *args)
777 unsigned long retbuf[PLPAR_HCALL_BUFSIZE];
778 struct rtas_suspend_me_data data;
779 DECLARE_COMPLETION_ONSTACK(done);
781 if (!rtas_service_present("ibm,suspend-me"))
784 /* Make sure the state is valid */
785 rc = plpar_hcall(H_VASI_STATE, retbuf,
786 ((u64)args->args[0] << 32) | args->args[1]);
791 printk(KERN_ERR "rtas_ibm_suspend_me: vasi_state returned %ld\n",rc);
793 } else if (state == H_VASI_ENABLED) {
794 args->args[args->nargs] = RTAS_NOT_SUSPENDABLE;
796 } else if (state != H_VASI_SUSPENDING) {
797 printk(KERN_ERR "rtas_ibm_suspend_me: vasi_state returned state %ld\n",
799 args->args[args->nargs] = -1;
803 atomic_set(&data.working, 0);
804 atomic_set(&data.done, 0);
805 data.token = rtas_token("ibm,suspend-me");
807 data.complete = &done;
809 /* Call function on all CPUs. One of us will make the
812 if (on_each_cpu(rtas_percpu_suspend_me, &data, 0))
813 data.error = -EINVAL;
815 wait_for_completion(&done);
818 printk(KERN_ERR "Error doing global join\n");
822 #else /* CONFIG_PPC_PSERIES */
823 static int rtas_ibm_suspend_me(struct rtas_args *args)
829 asmlinkage int ppc_rtas(struct rtas_args __user *uargs)
831 struct rtas_args args;
833 char *buff_copy, *errbuf = NULL;
837 if (!capable(CAP_SYS_ADMIN))
840 if (copy_from_user(&args, uargs, 3 * sizeof(u32)) != 0)
844 if (nargs > ARRAY_SIZE(args.args)
845 || args.nret > ARRAY_SIZE(args.args)
846 || nargs + args.nret > ARRAY_SIZE(args.args))
850 if (copy_from_user(args.args, uargs->args,
851 nargs * sizeof(rtas_arg_t)) != 0)
854 if (args.token == RTAS_UNKNOWN_SERVICE)
857 args.rets = &args.args[nargs];
858 memset(args.rets, 0, args.nret * sizeof(rtas_arg_t));
860 /* Need to handle ibm,suspend_me call specially */
861 if (args.token == ibm_suspend_me_token) {
862 rc = rtas_ibm_suspend_me(&args);
868 buff_copy = get_errorlog_buffer();
873 enter_rtas(__pa(&rtas.args));
876 /* A -1 return code indicates that the last command couldn't
877 be completed due to a hardware error. */
878 if (args.rets[0] == -1)
879 errbuf = __fetch_rtas_last_error(buff_copy);
885 log_error(errbuf, ERR_TYPE_RTAS_LOG, 0);
891 if (copy_to_user(uargs->args + nargs,
893 args.nret * sizeof(rtas_arg_t)) != 0)
900 * Call early during boot, before mem init or bootmem, to retrieve the RTAS
901 * informations from the device-tree and allocate the RMO buffer for userland
904 void __init rtas_initialize(void)
906 unsigned long rtas_region = RTAS_INSTANTIATE_MAX;
908 /* Get RTAS dev node and fill up our "rtas" structure with infos
911 rtas.dev = of_find_node_by_name(NULL, "rtas");
913 const u32 *basep, *entryp, *sizep;
915 basep = of_get_property(rtas.dev, "linux,rtas-base", NULL);
916 sizep = of_get_property(rtas.dev, "rtas-size", NULL);
917 if (basep != NULL && sizep != NULL) {
920 entryp = of_get_property(rtas.dev,
921 "linux,rtas-entry", NULL);
922 if (entryp == NULL) /* Ugh */
923 rtas.entry = rtas.base;
925 rtas.entry = *entryp;
932 /* If RTAS was found, allocate the RMO buffer for it and look for
933 * the stop-self token if any
936 if (machine_is(pseries) && firmware_has_feature(FW_FEATURE_LPAR)) {
937 rtas_region = min(memblock.rmo_size, RTAS_INSTANTIATE_MAX);
938 ibm_suspend_me_token = rtas_token("ibm,suspend-me");
941 rtas_rmo_buf = memblock_alloc_base(RTAS_RMOBUF_MAX, PAGE_SIZE, rtas_region);
943 #ifdef CONFIG_RTAS_ERROR_LOGGING
944 rtas_last_error_token = rtas_token("rtas-last-error");
948 int __init early_init_dt_scan_rtas(unsigned long node,
949 const char *uname, int depth, void *data)
951 u32 *basep, *entryp, *sizep;
953 if (depth != 1 || strcmp(uname, "rtas") != 0)
956 basep = of_get_flat_dt_prop(node, "linux,rtas-base", NULL);
957 entryp = of_get_flat_dt_prop(node, "linux,rtas-entry", NULL);
958 sizep = of_get_flat_dt_prop(node, "rtas-size", NULL);
960 if (basep && entryp && sizep) {
962 rtas.entry = *entryp;
966 #ifdef CONFIG_UDBG_RTAS_CONSOLE
967 basep = of_get_flat_dt_prop(node, "put-term-char", NULL);
969 rtas_putchar_token = *basep;
971 basep = of_get_flat_dt_prop(node, "get-term-char", NULL);
973 rtas_getchar_token = *basep;
975 if (rtas_putchar_token != RTAS_UNKNOWN_SERVICE &&
976 rtas_getchar_token != RTAS_UNKNOWN_SERVICE)
977 udbg_init_rtas_console();
985 static arch_spinlock_t timebase_lock;
986 static u64 timebase = 0;
988 void __cpuinit rtas_give_timebase(void)
992 local_irq_save(flags);
994 arch_spin_lock(&timebase_lock);
995 rtas_call(rtas_token("freeze-time-base"), 0, 1, NULL);
997 arch_spin_unlock(&timebase_lock);
1001 rtas_call(rtas_token("thaw-time-base"), 0, 1, NULL);
1002 local_irq_restore(flags);
1005 void __cpuinit rtas_take_timebase(void)
1009 arch_spin_lock(&timebase_lock);
1010 set_tb(timebase >> 32, timebase & 0xffffffff);
1012 arch_spin_unlock(&timebase_lock);