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/semaphore.h>
26 #include <asm/machdep.h>
28 #include <asm/param.h>
29 #include <asm/system.h>
30 #include <asm/delay.h>
31 #include <asm/uaccess.h>
35 struct rtas_t rtas
= {
36 .lock
= SPIN_LOCK_UNLOCKED
39 struct rtas_suspend_me_data
{
41 struct rtas_args
*args
;
46 DEFINE_SPINLOCK(rtas_data_buf_lock
);
47 char rtas_data_buf
[RTAS_DATA_BUF_SIZE
] __cacheline_aligned
;
48 unsigned long rtas_rmo_buf
;
51 * If non-NULL, this gets called when the kernel terminates.
52 * This is done like this so rtas_flash can be a module.
54 void (*rtas_flash_term_hook
)(int);
55 EXPORT_SYMBOL(rtas_flash_term_hook
);
58 * call_rtas_display_status and call_rtas_display_status_delay
59 * are designed only for very early low-level debugging, which
60 * is why the token is hard-coded to 10.
62 static void call_rtas_display_status(char c
)
64 struct rtas_args
*args
= &rtas
.args
;
69 spin_lock_irqsave(&rtas
.lock
, s
);
74 args
->rets
= (rtas_arg_t
*)&(args
->args
[1]);
75 args
->args
[0] = (unsigned char)c
;
77 enter_rtas(__pa(args
));
79 spin_unlock_irqrestore(&rtas
.lock
, s
);
82 static void call_rtas_display_status_delay(char c
)
84 static int pending_newline
= 0; /* did last write end with unprinted newline? */
85 static int width
= 16;
89 call_rtas_display_status(' ');
94 if (pending_newline
) {
95 call_rtas_display_status('\r');
96 call_rtas_display_status('\n');
100 call_rtas_display_status(c
);
106 void __init
udbg_init_rtas(void)
108 udbg_putc
= call_rtas_display_status_delay
;
111 void rtas_progress(char *s
, unsigned short hex
)
113 struct device_node
*root
;
116 static int display_character
, set_indicator
;
117 static int display_width
, display_lines
, *row_width
, form_feed
;
118 static DEFINE_SPINLOCK(progress_lock
);
119 static int current_line
;
120 static int pending_newline
= 0; /* did last write end with unprinted newline? */
125 if (display_width
== 0) {
126 display_width
= 0x10;
127 if ((root
= find_path_device("/rtas"))) {
128 if ((p
= (unsigned int *)get_property(root
,
129 "ibm,display-line-length", NULL
)))
131 if ((p
= (unsigned int *)get_property(root
,
132 "ibm,form-feed", NULL
)))
134 if ((p
= (unsigned int *)get_property(root
,
135 "ibm,display-number-of-lines", NULL
)))
137 row_width
= (unsigned int *)get_property(root
,
138 "ibm,display-truncation-length", NULL
);
140 display_character
= rtas_token("display-character");
141 set_indicator
= rtas_token("set-indicator");
144 if (display_character
== RTAS_UNKNOWN_SERVICE
) {
145 /* use hex display if available */
146 if (set_indicator
!= RTAS_UNKNOWN_SERVICE
)
147 rtas_call(set_indicator
, 3, 1, NULL
, 6, 0, hex
);
151 spin_lock(&progress_lock
);
154 * Last write ended with newline, but we didn't print it since
155 * it would just clear the bottom line of output. Print it now
158 * If no newline is pending and form feed is supported, clear the
159 * display with a form feed; otherwise, print a CR to start output
160 * at the beginning of the line.
162 if (pending_newline
) {
163 rtas_call(display_character
, 1, 1, NULL
, '\r');
164 rtas_call(display_character
, 1, 1, NULL
, '\n');
169 rtas_call(display_character
, 1, 1, NULL
,
172 rtas_call(display_character
, 1, 1, NULL
, '\r');
176 width
= row_width
[current_line
];
178 width
= display_width
;
181 if (*os
== '\n' || *os
== '\r') {
182 /* If newline is the last character, save it
183 * until next call to avoid bumping up the
186 if (*os
== '\n' && !os
[1]) {
189 if (current_line
> display_lines
-1)
190 current_line
= display_lines
-1;
191 spin_unlock(&progress_lock
);
195 /* RTAS wants CR-LF, not just LF */
198 rtas_call(display_character
, 1, 1, NULL
, '\r');
199 rtas_call(display_character
, 1, 1, NULL
, '\n');
201 /* CR might be used to re-draw a line, so we'll
202 * leave it alone and not add LF.
204 rtas_call(display_character
, 1, 1, NULL
, *os
);
208 width
= row_width
[current_line
];
210 width
= display_width
;
213 rtas_call(display_character
, 1, 1, NULL
, *os
);
218 /* if we overwrite the screen length */
220 while ((*os
!= 0) && (*os
!= '\n') && (*os
!= '\r'))
224 spin_unlock(&progress_lock
);
226 EXPORT_SYMBOL(rtas_progress
); /* needed by rtas_flash module */
228 int rtas_token(const char *service
)
231 if (rtas
.dev
== NULL
)
232 return RTAS_UNKNOWN_SERVICE
;
233 tokp
= (int *) get_property(rtas
.dev
, service
, NULL
);
234 return tokp
? *tokp
: RTAS_UNKNOWN_SERVICE
;
237 #ifdef CONFIG_RTAS_ERROR_LOGGING
239 * Return the firmware-specified size of the error log buffer
240 * for all rtas calls that require an error buffer argument.
241 * This includes 'check-exception' and 'rtas-last-error'.
243 int rtas_get_error_log_max(void)
245 static int rtas_error_log_max
;
246 if (rtas_error_log_max
)
247 return rtas_error_log_max
;
249 rtas_error_log_max
= rtas_token ("rtas-error-log-max");
250 if ((rtas_error_log_max
== RTAS_UNKNOWN_SERVICE
) ||
251 (rtas_error_log_max
> RTAS_ERROR_LOG_MAX
)) {
252 printk (KERN_WARNING
"RTAS: bad log buffer size %d\n",
254 rtas_error_log_max
= RTAS_ERROR_LOG_MAX
;
256 return rtas_error_log_max
;
258 EXPORT_SYMBOL(rtas_get_error_log_max
);
261 char rtas_err_buf
[RTAS_ERROR_LOG_MAX
];
262 int rtas_last_error_token
;
264 /** Return a copy of the detailed error text associated with the
265 * most recent failed call to rtas. Because the error text
266 * might go stale if there are any other intervening rtas calls,
267 * this routine must be called atomically with whatever produced
268 * the error (i.e. with rtas.lock still held from the previous call).
270 static char *__fetch_rtas_last_error(char *altbuf
)
272 struct rtas_args err_args
, save_args
;
276 if (rtas_last_error_token
== -1)
279 bufsz
= rtas_get_error_log_max();
281 err_args
.token
= rtas_last_error_token
;
284 err_args
.args
[0] = (rtas_arg_t
)__pa(rtas_err_buf
);
285 err_args
.args
[1] = bufsz
;
286 err_args
.args
[2] = 0;
288 save_args
= rtas
.args
;
289 rtas
.args
= err_args
;
291 enter_rtas(__pa(&rtas
.args
));
293 err_args
= rtas
.args
;
294 rtas
.args
= save_args
;
296 /* Log the error in the unlikely case that there was one. */
297 if (unlikely(err_args
.args
[2] == 0)) {
303 buf
= kmalloc(RTAS_ERROR_LOG_MAX
, GFP_ATOMIC
);
306 memcpy(buf
, rtas_err_buf
, RTAS_ERROR_LOG_MAX
);
312 #define get_errorlog_buffer() kmalloc(RTAS_ERROR_LOG_MAX, GFP_KERNEL)
314 #else /* CONFIG_RTAS_ERROR_LOGGING */
315 #define __fetch_rtas_last_error(x) NULL
316 #define get_errorlog_buffer() NULL
319 int rtas_call(int token
, int nargs
, int nret
, int *outputs
, ...)
324 struct rtas_args
*rtas_args
;
325 char *buff_copy
= NULL
;
328 if (token
== RTAS_UNKNOWN_SERVICE
)
331 /* Gotta do something different here, use global lock for now... */
332 spin_lock_irqsave(&rtas
.lock
, s
);
333 rtas_args
= &rtas
.args
;
335 rtas_args
->token
= token
;
336 rtas_args
->nargs
= nargs
;
337 rtas_args
->nret
= nret
;
338 rtas_args
->rets
= (rtas_arg_t
*)&(rtas_args
->args
[nargs
]);
339 va_start(list
, outputs
);
340 for (i
= 0; i
< nargs
; ++i
)
341 rtas_args
->args
[i
] = va_arg(list
, rtas_arg_t
);
344 for (i
= 0; i
< nret
; ++i
)
345 rtas_args
->rets
[i
] = 0;
347 enter_rtas(__pa(rtas_args
));
349 /* A -1 return code indicates that the last command couldn't
350 be completed due to a hardware error. */
351 if (rtas_args
->rets
[0] == -1)
352 buff_copy
= __fetch_rtas_last_error(NULL
);
354 if (nret
> 1 && outputs
!= NULL
)
355 for (i
= 0; i
< nret
-1; ++i
)
356 outputs
[i
] = rtas_args
->rets
[i
+1];
357 ret
= (nret
> 0)? rtas_args
->rets
[0]: 0;
359 /* Gotta do something different here, use global lock for now... */
360 spin_unlock_irqrestore(&rtas
.lock
, s
);
363 log_error(buff_copy
, ERR_TYPE_RTAS_LOG
, 0);
370 /* Given an RTAS status code of 990n compute the hinted delay of 10^n
371 * (last digit) milliseconds. For now we bound at n=5 (100 sec).
373 unsigned int rtas_extended_busy_delay_time(int status
)
375 int order
= status
- 9900;
379 order
= 0; /* RTC depends on this for -2 clock busy */
381 order
= 5; /* bound */
383 /* Use microseconds for reasonable accuracy */
384 for (ms
= 1; order
> 0; order
--)
390 int rtas_error_rc(int rtas_rc
)
395 case -1: /* Hardware Error */
398 case -3: /* Bad indicator/domain/etc */
401 case -9000: /* Isolation error */
404 case -9001: /* Outstanding TCE/PTE */
407 case -9002: /* No usable slot */
411 printk(KERN_ERR
"%s: unexpected RTAS error %d\n",
412 __FUNCTION__
, rtas_rc
);
419 int rtas_get_power_level(int powerdomain
, int *level
)
421 int token
= rtas_token("get-power-level");
424 if (token
== RTAS_UNKNOWN_SERVICE
)
427 while ((rc
= rtas_call(token
, 1, 2, level
, powerdomain
)) == RTAS_BUSY
)
431 return rtas_error_rc(rc
);
435 int rtas_set_power_level(int powerdomain
, int level
, int *setlevel
)
437 int token
= rtas_token("set-power-level");
438 unsigned int wait_time
;
441 if (token
== RTAS_UNKNOWN_SERVICE
)
445 rc
= rtas_call(token
, 2, 2, setlevel
, powerdomain
, level
);
448 else if (rtas_is_extended_busy(rc
)) {
449 wait_time
= rtas_extended_busy_delay_time(rc
);
450 udelay(wait_time
* 1000);
456 return rtas_error_rc(rc
);
460 int rtas_get_sensor(int sensor
, int index
, int *state
)
462 int token
= rtas_token("get-sensor-state");
463 unsigned int wait_time
;
466 if (token
== RTAS_UNKNOWN_SERVICE
)
470 rc
= rtas_call(token
, 2, 2, state
, sensor
, index
);
473 else if (rtas_is_extended_busy(rc
)) {
474 wait_time
= rtas_extended_busy_delay_time(rc
);
475 udelay(wait_time
* 1000);
481 return rtas_error_rc(rc
);
485 int rtas_set_indicator(int indicator
, int index
, int new_value
)
487 int token
= rtas_token("set-indicator");
488 unsigned int wait_time
;
491 if (token
== RTAS_UNKNOWN_SERVICE
)
495 rc
= rtas_call(token
, 3, 1, NULL
, indicator
, index
, new_value
);
498 else if (rtas_is_extended_busy(rc
)) {
499 wait_time
= rtas_extended_busy_delay_time(rc
);
500 udelay(wait_time
* 1000);
507 return rtas_error_rc(rc
);
511 void rtas_restart(char *cmd
)
513 if (rtas_flash_term_hook
)
514 rtas_flash_term_hook(SYS_RESTART
);
515 printk("RTAS system-reboot returned %d\n",
516 rtas_call(rtas_token("system-reboot"), 0, 1, NULL
));
520 void rtas_power_off(void)
522 if (rtas_flash_term_hook
)
523 rtas_flash_term_hook(SYS_POWER_OFF
);
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));
532 if (rtas_flash_term_hook
)
533 rtas_flash_term_hook(SYS_HALT
);
534 /* allow power on only with power button press */
535 printk("RTAS power-off returned %d\n",
536 rtas_call(rtas_token("power-off"), 2, 1, NULL
, -1, -1));
540 /* Must be in the RMO region, so we place it here */
541 static char rtas_os_term_buf
[2048];
543 void rtas_os_term(char *str
)
547 if (RTAS_UNKNOWN_SERVICE
== rtas_token("ibm,os-term"))
550 snprintf(rtas_os_term_buf
, 2048, "OS panic: %s", str
);
553 status
= rtas_call(rtas_token("ibm,os-term"), 1, 1, NULL
,
554 __pa(rtas_os_term_buf
));
556 if (status
== RTAS_BUSY
)
558 else if (status
!= 0)
559 printk(KERN_EMERG
"ibm,os-term call failed %d\n",
561 } while (status
== RTAS_BUSY
);
564 static int ibm_suspend_me_token
= RTAS_UNKNOWN_SERVICE
;
565 #ifdef CONFIG_PPC_PSERIES
566 static void rtas_percpu_suspend_me(void *info
)
570 struct rtas_suspend_me_data
*data
=
571 (struct rtas_suspend_me_data
*)info
;
574 * We use "waiting" to indicate our state. As long
575 * as it is >0, we are still trying to all join up.
576 * If it goes to 0, we have successfully joined up and
577 * one thread got H_Continue. If any error happens,
580 local_irq_save(flags
);
582 rc
= plpar_hcall_norets(H_JOIN
);
584 } while (rc
== H_Success
&& data
->waiting
> 0);
588 if (rc
== H_Continue
) {
590 rtas_call(ibm_suspend_me_token
, 0, 1,
593 data
->waiting
= -EBUSY
;
594 printk(KERN_ERR
"Error on H_Join hypervisor call\n");
598 /* before we restore interrupts, make sure we don't
599 * generate a spurious soft lockup errors
601 touch_softlockup_watchdog();
602 local_irq_restore(flags
);
606 static int rtas_ibm_suspend_me(struct rtas_args
*args
)
610 struct rtas_suspend_me_data data
;
615 /* Call function on all CPUs. One of us will make the
618 if (on_each_cpu(rtas_percpu_suspend_me
, &data
, 1, 0))
619 data
.waiting
= -EINVAL
;
621 if (data
.waiting
!= 0)
622 printk(KERN_ERR
"Error doing global join\n");
624 /* Prod each CPU. This won't hurt, and will wake
625 * anyone we successfully put to sleep with H_Join
628 plpar_hcall_norets(H_PROD
, i
);
632 #else /* CONFIG_PPC_PSERIES */
633 static int rtas_ibm_suspend_me(struct rtas_args
*args
)
639 asmlinkage
int ppc_rtas(struct rtas_args __user
*uargs
)
641 struct rtas_args args
;
643 char *buff_copy
, *errbuf
= NULL
;
647 if (!capable(CAP_SYS_ADMIN
))
650 if (copy_from_user(&args
, uargs
, 3 * sizeof(u32
)) != 0)
654 if (nargs
> ARRAY_SIZE(args
.args
)
655 || args
.nret
> ARRAY_SIZE(args
.args
)
656 || nargs
+ args
.nret
> ARRAY_SIZE(args
.args
))
660 if (copy_from_user(args
.args
, uargs
->args
,
661 nargs
* sizeof(rtas_arg_t
)) != 0)
664 if (args
.token
== RTAS_UNKNOWN_SERVICE
)
667 /* Need to handle ibm,suspend_me call specially */
668 if (args
.token
== ibm_suspend_me_token
) {
669 rc
= rtas_ibm_suspend_me(&args
);
675 buff_copy
= get_errorlog_buffer();
677 spin_lock_irqsave(&rtas
.lock
, flags
);
680 enter_rtas(__pa(&rtas
.args
));
683 args
.rets
= &args
.args
[nargs
];
685 /* A -1 return code indicates that the last command couldn't
686 be completed due to a hardware error. */
687 if (args
.rets
[0] == -1)
688 errbuf
= __fetch_rtas_last_error(buff_copy
);
690 spin_unlock_irqrestore(&rtas
.lock
, flags
);
694 log_error(errbuf
, ERR_TYPE_RTAS_LOG
, 0);
700 if (copy_to_user(uargs
->args
+ nargs
,
702 args
.nret
* sizeof(rtas_arg_t
)) != 0)
708 /* This version can't take the spinlock, because it never returns */
710 struct rtas_args rtas_stop_self_args
= {
711 /* The token is initialized for real in setup_system() */
712 .token
= RTAS_UNKNOWN_SERVICE
,
715 .rets
= &rtas_stop_self_args
.args
[0],
718 void rtas_stop_self(void)
720 struct rtas_args
*rtas_args
= &rtas_stop_self_args
;
724 BUG_ON(rtas_args
->token
== RTAS_UNKNOWN_SERVICE
);
726 printk("cpu %u (hwid %u) Ready to die...\n",
727 smp_processor_id(), hard_smp_processor_id());
728 enter_rtas(__pa(rtas_args
));
730 panic("Alas, I survived.\n");
734 * Call early during boot, before mem init or bootmem, to retrieve the RTAS
735 * informations from the device-tree and allocate the RMO buffer for userland
738 void __init
rtas_initialize(void)
740 unsigned long rtas_region
= RTAS_INSTANTIATE_MAX
;
742 /* Get RTAS dev node and fill up our "rtas" structure with infos
745 rtas
.dev
= of_find_node_by_name(NULL
, "rtas");
750 basep
= (u32
*)get_property(rtas
.dev
, "linux,rtas-base", NULL
);
751 sizep
= (u32
*)get_property(rtas
.dev
, "rtas-size", NULL
);
752 if (basep
!= NULL
&& sizep
!= NULL
) {
755 entryp
= (u32
*)get_property(rtas
.dev
, "linux,rtas-entry", NULL
);
756 if (entryp
== NULL
) /* Ugh */
757 rtas
.entry
= rtas
.base
;
759 rtas
.entry
= *entryp
;
766 /* If RTAS was found, allocate the RMO buffer for it and look for
767 * the stop-self token if any
770 if (_machine
== PLATFORM_PSERIES_LPAR
) {
771 rtas_region
= min(lmb
.rmo_size
, RTAS_INSTANTIATE_MAX
);
772 ibm_suspend_me_token
= rtas_token("ibm,suspend-me");
775 rtas_rmo_buf
= lmb_alloc_base(RTAS_RMOBUF_MAX
, PAGE_SIZE
, rtas_region
);
777 #ifdef CONFIG_HOTPLUG_CPU
778 rtas_stop_self_args
.token
= rtas_token("stop-self");
779 #endif /* CONFIG_HOTPLUG_CPU */
780 #ifdef CONFIG_RTAS_ERROR_LOGGING
781 rtas_last_error_token
= rtas_token("rtas-last-error");
786 EXPORT_SYMBOL(rtas_token
);
787 EXPORT_SYMBOL(rtas_call
);
788 EXPORT_SYMBOL(rtas_data_buf
);
789 EXPORT_SYMBOL(rtas_data_buf_lock
);
790 EXPORT_SYMBOL(rtas_extended_busy_delay_time
);
791 EXPORT_SYMBOL(rtas_get_sensor
);
792 EXPORT_SYMBOL(rtas_get_power_level
);
793 EXPORT_SYMBOL(rtas_set_power_level
);
794 EXPORT_SYMBOL(rtas_set_indicator
);