arch/ppc64/kernel/rtas.c

   1 /*
   2  *
   3  * Procedures for interfacing to the RTAS on CHRP machines.
   4  *
   5  * Peter Bergner, IBM   March 2001.
   6  * Copyright (C) 2001 IBM.
   7  *
   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.
  12  */
  13
  14 #include <stdarg.h>
  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
  21 #include <asm/prom.h>
  22 #include <asm/rtas.h>
  23 #include <asm/semaphore.h>
  24 #include <asm/machdep.h>
  25 #include <asm/paca.h>
  26 #include <asm/page.h>
  27 #include <asm/param.h>
  28 #include <asm/system.h>
  29 #include <asm/abs_addr.h>
  30 #include <asm/udbg.h>
  31 #include <asm/delay.h>
  32 #include <asm/uaccess.h>
  33
  34 struct flash_block_list_header rtas_firmware_flash_list = {0, 0};
  35
  36 /*
  37  * prom_init() is called very early on, before the kernel text
  38  * and data have been mapped to KERNELBASE.  At this point the code
  39  * is running at whatever address it has been loaded at, so
  40  * references to extern and static variables must be relocated
  41  * explicitly.  The procedure reloc_offset() returns the address
  42  * we're currently running at minus the address we were linked at.
  43  * (Note that strings count as static variables.)
  44  *
  45  * Because OF may have mapped I/O devices into the area starting at
  46  * KERNELBASE, particularly on CHRP machines, we can't safely call
  47  * OF once the kernel has been mapped to KERNELBASE.  Therefore all
  48  * OF calls should be done within prom_init(), and prom_init()
  49  * and all routines called within it must be careful to relocate
  50  * references as necessary.
  51  *
  52  * Note that the bss is cleared *after* prom_init runs, so we have
  53  * to make sure that any static or extern variables it accesses
  54  * are put in the data segment.
  55  */
  56
  57 struct rtas_t rtas = {
  58         .lock = SPIN_LOCK_UNLOCKED
  59 };
  60
  61 EXPORT_SYMBOL_GPL(rtas);
  62
  63 char rtas_err_buf[RTAS_ERROR_LOG_MAX];
  64
  65 extern unsigned long reloc_offset(void);
  66
  67 spinlock_t rtas_data_buf_lock = SPIN_LOCK_UNLOCKED;
  68 char rtas_data_buf[RTAS_DATA_BUF_SIZE]__page_aligned;
  69
  70 void
  71 call_rtas_display_status(char c)
  72 {
  73         struct rtas_args *args = &(get_paca()->xRtas);
  74         unsigned long s;
  75
  76         spin_lock_irqsave(&rtas.lock, s);
  77
  78         args->token = 10;
  79         args->nargs = 1;
  80         args->nret  = 1;
  81         args->rets  = (rtas_arg_t *)&(args->args[1]);
  82         args->args[0] = (int)c;
  83
  84         enter_rtas(__pa(args));
  85
  86         spin_unlock_irqrestore(&rtas.lock, s);
  87 }
  88
  89 int
  90 rtas_token(const char *service)
  91 {
  92         int *tokp;
  93         if (rtas.dev == NULL) {
  94                 PPCDBG(PPCDBG_RTAS,"\tNo rtas device in device-tree...\n");
  95                 return RTAS_UNKNOWN_SERVICE;
  96         }
  97         tokp = (int *) get_property(rtas.dev, service, NULL);
  98         return tokp ? *tokp : RTAS_UNKNOWN_SERVICE;
  99 }
 100
 101
 102 static int
 103 __log_rtas_error(struct rtas_args *rtas_args)
 104 {
 105         struct rtas_args err_args, temp_args;
 106
 107         err_args.token = rtas_token("rtas-last-error");
 108         err_args.nargs = 2;
 109         err_args.nret = 1;
 110         err_args.rets = (rtas_arg_t *)&(err_args.args[2]);
 111
 112         err_args.args[0] = (rtas_arg_t)__pa(rtas_err_buf);
 113         err_args.args[1] = RTAS_ERROR_LOG_MAX;
 114         err_args.args[2] = 0;
 115
 116         temp_args = *rtas_args;
 117         get_paca()->xRtas = err_args;
 118
 119         PPCDBG(PPCDBG_RTAS, "\tentering rtas with 0x%lx\n",
 120                __pa(&err_args));
 121         enter_rtas(__pa(&get_paca()->xRtas));
 122         PPCDBG(PPCDBG_RTAS, "\treturned from rtas ...\n");
 123
 124         err_args = get_paca()->xRtas;
 125         get_paca()->xRtas = temp_args;
 126
 127         return err_args.rets[0];
 128 }
 129
 130 void
 131 log_rtas_error(struct rtas_args *rtas_args)
 132 {
 133         unsigned long s;
 134         int rc;
 135
 136         spin_lock_irqsave(&rtas.lock, s);
 137         rc = __log_rtas_error(rtas_args);
 138         spin_unlock_irqrestore(&rtas.lock, s);
 139         if (rc == 0)
 140                 log_error(rtas_err_buf, ERR_TYPE_RTAS_LOG, 0);
 141 }
 142
 143 long
 144 rtas_call(int token, int nargs, int nret,
 145           unsigned long *outputs, ...)
 146 {
 147         va_list list;
 148         int i, logit = 0;
 149         unsigned long s;
 150         struct rtas_args *rtas_args = &(get_paca()->xRtas);
 151         long ret;
 152
 153         PPCDBG(PPCDBG_RTAS, "Entering rtas_call\n");
 154         PPCDBG(PPCDBG_RTAS, "\ttoken    = 0x%x\n", token);
 155         PPCDBG(PPCDBG_RTAS, "\tnargs    = %d\n", nargs);
 156         PPCDBG(PPCDBG_RTAS, "\tnret     = %d\n", nret);
 157         PPCDBG(PPCDBG_RTAS, "\t&outputs = 0x%lx\n", outputs);
 158         if (token == RTAS_UNKNOWN_SERVICE)
 159                 return -1;
 160
 161         /* Gotta do something different here, use global lock for now... */
 162         spin_lock_irqsave(&rtas.lock, s);
 163
 164         rtas_args->token = token;
 165         rtas_args->nargs = nargs;
 166         rtas_args->nret  = nret;
 167         rtas_args->rets  = (rtas_arg_t *)&(rtas_args->args[nargs]);
 168         va_start(list, outputs);
 169         for (i = 0; i < nargs; ++i) {
 170                 rtas_args->args[i] = (rtas_arg_t)LONG_LSW(va_arg(list, ulong));
 171                 PPCDBG(PPCDBG_RTAS, "\tnarg[%d] = 0x%lx\n", i, rtas_args->args[i]);
 172         }
 173         va_end(list);
 174
 175         for (i = 0; i < nret; ++i)
 176                 rtas_args->rets[i] = 0;
 177
 178         PPCDBG(PPCDBG_RTAS, "\tentering rtas with 0x%lx\n",
 179                 __pa(rtas_args));
 180         enter_rtas(__pa(rtas_args));
 181         PPCDBG(PPCDBG_RTAS, "\treturned from rtas ...\n");
 182
 183         if (rtas_args->rets[0] == -1)
 184                 logit = (__log_rtas_error(rtas_args) == 0);
 185
 186         ifppcdebug(PPCDBG_RTAS) {
 187                 for(i=0; i < nret ;i++)
 188                         udbg_printf("\tnret[%d] = 0x%lx\n", i, (ulong)rtas_args->rets[i]);
 189         }
 190
 191         if (nret > 1 && outputs != NULL)
 192                 for (i = 0; i < nret-1; ++i)
 193                         outputs[i] = rtas_args->rets[i+1];
 194         ret = (ulong)((nret > 0) ? rtas_args->rets[0] : 0);
 195
 196         /* Gotta do something different here, use global lock for now... */
 197         spin_unlock_irqrestore(&rtas.lock, s);
 198
 199         if (logit)
 200                 log_error(rtas_err_buf, ERR_TYPE_RTAS_LOG, 0);
 201
 202         return ret;
 203 }
 204
 205 /* Given an RTAS status code of 990n compute the hinted delay of 10^n
 206  * (last digit) milliseconds.  For now we bound at n=5 (100 sec).
 207  */
 208 unsigned int
 209 rtas_extended_busy_delay_time(int status)
 210 {
 211         int order = status - 9900;
 212         unsigned long ms;
 213
 214         if (order < 0)
 215                 order = 0;      /* RTC depends on this for -2 clock busy */
 216         else if (order > 5)
 217                 order = 5;      /* bound */
 218
 219         /* Use microseconds for reasonable accuracy */
 220         for (ms=1; order > 0; order--)
 221                 ms *= 10;
 222
 223         return ms;
 224 }
 225
 226 int
 227 rtas_get_power_level(int powerdomain, int *level)
 228 {
 229         int token = rtas_token("get-power-level");
 230         long powerlevel;
 231         int rc;
 232
 233         if (token == RTAS_UNKNOWN_SERVICE)
 234                 return RTAS_UNKNOWN_OP;
 235
 236         while(1) {
 237                 rc = (int) rtas_call(token, 1, 2, &powerlevel, powerdomain);
 238                 if (rc == RTAS_BUSY)
 239                         udelay(1);
 240                 else
 241                         break;
 242         }
 243         *level = (int) powerlevel;
 244         return rc;
 245 }
 246
 247 int
 248 rtas_set_power_level(int powerdomain, int level, int *setlevel)
 249 {
 250         int token = rtas_token("set-power-level");
 251         unsigned int wait_time;
 252         long returned_level;
 253         int rc;
 254
 255         if (token == RTAS_UNKNOWN_SERVICE)
 256                 return RTAS_UNKNOWN_OP;
 257
 258         while (1) {
 259                 rc = (int) rtas_call(token, 2, 2, &returned_level, powerdomain,
 260                                         level);
 261                 if (rc == RTAS_BUSY)
 262                         udelay(1);
 263                 else if (rtas_is_extended_busy(rc)) {
 264                         wait_time = rtas_extended_busy_delay_time(rc);
 265                         udelay(wait_time * 1000);
 266                 }
 267                 else
 268                         break;
 269         }
 270         *setlevel = (int) returned_level;
 271         return rc;
 272 }
 273
 274 int
 275 rtas_get_sensor(int sensor, int index, int *state)
 276 {
 277         int token = rtas_token("get-sensor-state");
 278         unsigned int wait_time;
 279         long returned_state;
 280         int rc;
 281
 282         if (token == RTAS_UNKNOWN_SERVICE)
 283                 return RTAS_UNKNOWN_OP;
 284
 285         while (1) {
 286                 rc = (int) rtas_call(token, 2, 2, &returned_state, sensor,
 287                                         index);
 288                 if (rc == RTAS_BUSY)
 289                         udelay(1);
 290                 else if (rtas_is_extended_busy(rc)) {
 291                         wait_time = rtas_extended_busy_delay_time(rc);
 292                         udelay(wait_time * 1000);
 293                 }
 294                 else
 295                         break;
 296         }
 297         *state = (int) returned_state;
 298         return rc;
 299 }
 300
 301 int
 302 rtas_set_indicator(int indicator, int index, int new_value)
 303 {
 304         int token = rtas_token("set-indicator");
 305         unsigned int wait_time;
 306         int rc;
 307
 308         if (token == RTAS_UNKNOWN_SERVICE)
 309                 return RTAS_UNKNOWN_OP;
 310
 311         while (1) {
 312                 rc = (int) rtas_call(token, 3, 1, NULL, indicator, index,
 313                                         new_value);
 314                 if (rc == RTAS_BUSY)
 315                         udelay(1);
 316                 else if (rtas_is_extended_busy(rc)) {
 317                         wait_time = rtas_extended_busy_delay_time(rc);
 318                         udelay(wait_time * 1000);
 319                 }
 320                 else
 321                         break;
 322         }
 323
 324         return rc;
 325 }
 326
 327 #define FLASH_BLOCK_LIST_VERSION (1UL)
 328 static void
 329 rtas_flash_firmware(void)
 330 {
 331         unsigned long image_size;
 332         struct flash_block_list *f, *next, *flist;
 333         unsigned long rtas_block_list;
 334         int i, status, update_token;
 335
 336         update_token = rtas_token("ibm,update-flash-64-and-reboot");
 337         if (update_token == RTAS_UNKNOWN_SERVICE) {
 338                 printk(KERN_ALERT "FLASH: ibm,update-flash-64-and-reboot is not available -- not a service partition?\n");
 339                 printk(KERN_ALERT "FLASH: firmware will not be flashed\n");
 340                 return;
 341         }
 342
 343         /* NOTE: the "first" block list is a global var with no data
 344          * blocks in the kernel data segment.  We do this because
 345          * we want to ensure this block_list addr is under 4GB.
 346          */
 347         rtas_firmware_flash_list.num_blocks = 0;
 348         flist = (struct flash_block_list *)&rtas_firmware_flash_list;
 349         rtas_block_list = virt_to_abs(flist);
 350         if (rtas_block_list >= 4UL*1024*1024*1024) {
 351                 printk(KERN_ALERT "FLASH: kernel bug...flash list header addr above 4GB\n");
 352                 return;
 353         }
 354
 355         printk(KERN_ALERT "FLASH: preparing saved firmware image for flash\n");
 356         /* Update the block_list in place. */
 357         image_size = 0;
 358         for (f = flist; f; f = next) {
 359                 /* Translate data addrs to absolute */
 360                 for (i = 0; i < f->num_blocks; i++) {
 361                         f->blocks[i].data = (char *)virt_to_abs(f->blocks[i].data);
 362                         image_size += f->blocks[i].length;
 363                 }
 364                 next = f->next;
 365                 /* Don't translate NULL pointer for last entry */
 366                 if (f->next)
 367                         f->next = (struct flash_block_list *)virt_to_abs(f->next);
 368                 else
 369                         f->next = 0LL;
 370                 /* make num_blocks into the version/length field */
 371                 f->num_blocks = (FLASH_BLOCK_LIST_VERSION << 56) | ((f->num_blocks+1)*16);
 372         }
 373
 374         printk(KERN_ALERT "FLASH: flash image is %ld bytes\n", image_size);
 375         printk(KERN_ALERT "FLASH: performing flash and reboot\n");
 376         ppc_md.progress("Flashing        \n", 0x0);
 377         ppc_md.progress("Please Wait...  ", 0x0);
 378         printk(KERN_ALERT "FLASH: this will take several minutes.  Do not power off!\n");
 379         status = rtas_call(update_token, 1, 1, NULL, rtas_block_list);
 380         switch (status) {       /* should only get "bad" status */
 381             case 0:
 382                 printk(KERN_ALERT "FLASH: success\n");
 383                 break;
 384             case -1:
 385                 printk(KERN_ALERT "FLASH: hardware error.  Firmware may not be not flashed\n");
 386                 break;
 387             case -3:
 388                 printk(KERN_ALERT "FLASH: image is corrupt or not correct for this platform.  Firmware not flashed\n");
 389                 break;
 390             case -4:
 391                 printk(KERN_ALERT "FLASH: flash failed when partially complete.  System may not reboot\n");
 392                 break;
 393             default:
 394                 printk(KERN_ALERT "FLASH: unknown flash return code %d\n", status);
 395                 break;
 396         }
 397 }
 398
 399 void rtas_flash_bypass_warning(void)
 400 {
 401         printk(KERN_ALERT "FLASH: firmware flash requires a reboot\n");
 402         printk(KERN_ALERT "FLASH: the firmware image will NOT be flashed\n");
 403 }
 404
 405
 406 void
 407 rtas_restart(char *cmd)
 408 {
 409         if (rtas_firmware_flash_list.next)
 410                 rtas_flash_firmware();
 411
 412         printk("RTAS system-reboot returned %ld\n",
 413                rtas_call(rtas_token("system-reboot"), 0, 1, NULL));
 414         for (;;);
 415 }
 416
 417 void
 418 rtas_power_off(void)
 419 {
 420         if (rtas_firmware_flash_list.next)
 421                 rtas_flash_bypass_warning();
 422         /* allow power on only with power button press */
 423         printk("RTAS power-off returned %ld\n",
 424                rtas_call(rtas_token("power-off"), 2, 1, NULL,0xffffffff,0xffffffff));
 425         for (;;);
 426 }
 427
 428 void
 429 rtas_halt(void)
 430 {
 431         if (rtas_firmware_flash_list.next)
 432                 rtas_flash_bypass_warning();
 433         rtas_power_off();
 434 }
 435
 436 /* Must be in the RMO region, so we place it here */
 437 static char rtas_os_term_buf[2048];
 438
 439 void rtas_os_term(char *str)
 440 {
 441         long status;
 442
 443         snprintf(rtas_os_term_buf, 2048, "OS panic: %s", str);
 444
 445         do {
 446                 status = rtas_call(rtas_token("ibm,os-term"), 1, 1, NULL,
 447                                    __pa(rtas_os_term_buf));
 448
 449                 if (status == RTAS_BUSY)
 450                         udelay(1);
 451                 else if (status != 0)
 452                         printk(KERN_EMERG "ibm,os-term call failed %ld\n",
 453                                status);
 454         } while (status == RTAS_BUSY);
 455 }
 456
 457 unsigned long rtas_rmo_buf = 0;
 458
 459 asmlinkage int ppc_rtas(struct rtas_args __user *uargs)
 460 {
 461         struct rtas_args args;
 462         unsigned long flags;
 463         int nargs;
 464
 465         if (!capable(CAP_SYS_ADMIN))
 466                 return -EPERM;
 467
 468         if (copy_from_user(&args, uargs, 3 * sizeof(u32)) != 0)
 469                 return -EFAULT;
 470
 471         nargs = args.nargs;
 472         if (nargs > ARRAY_SIZE(args.args)
 473             || args.nret > ARRAY_SIZE(args.args)
 474             || nargs + args.nret > ARRAY_SIZE(args.args))
 475                 return -EINVAL;
 476
 477         /* Copy in args. */
 478         if (copy_from_user(args.args, uargs->args,
 479                            nargs * sizeof(rtas_arg_t)) != 0)
 480                 return -EFAULT;
 481
 482         spin_lock_irqsave(&rtas.lock, flags);
 483
 484         get_paca()->xRtas = args;
 485         enter_rtas(__pa(&get_paca()->xRtas));
 486         args = get_paca()->xRtas;
 487
 488         spin_unlock_irqrestore(&rtas.lock, flags);
 489
 490         args.rets  = (rtas_arg_t *)&(args.args[nargs]);
 491         if (args.rets[0] == -1)
 492                 log_rtas_error(&args);
 493
 494         /* Copy out args. */
 495         if (copy_to_user(uargs->args + nargs,
 496                          args.args + nargs,
 497                          args.nret * sizeof(rtas_arg_t)) != 0)
 498                 return -EFAULT;
 499
 500         return 0;
 501 }
 502
 503 #ifdef CONFIG_HOTPLUG_CPU
 504 /* This version can't take the spinlock. */
 505
 506 void rtas_stop_self(void)
 507 {
 508         struct rtas_args *rtas_args = &(get_paca()->xRtas);
 509
 510         local_irq_disable();
 511
 512         rtas_args->token = rtas_token("stop-self");
 513         BUG_ON(rtas_args->token == RTAS_UNKNOWN_SERVICE);
 514         rtas_args->nargs = 0;
 515         rtas_args->nret  = 1;
 516         rtas_args->rets  = &(rtas_args->args[0]);
 517
 518         printk("%u %u Ready to die...\n",
 519                smp_processor_id(), hard_smp_processor_id());
 520         enter_rtas(__pa(rtas_args));
 521
 522         panic("Alas, I survived.\n");
 523 }
 524 #endif /* CONFIG_HOTPLUG_CPU */
 525
 526 EXPORT_SYMBOL(rtas_firmware_flash_list);
 527 EXPORT_SYMBOL(rtas_token);
 528 EXPORT_SYMBOL(rtas_call);
 529 EXPORT_SYMBOL(rtas_data_buf);
 530 EXPORT_SYMBOL(rtas_data_buf_lock);
 531 EXPORT_SYMBOL(rtas_extended_busy_delay_time);
 532 EXPORT_SYMBOL(rtas_get_sensor);
 533 EXPORT_SYMBOL(rtas_get_power_level);
 534 EXPORT_SYMBOL(rtas_set_power_level);
 535 EXPORT_SYMBOL(rtas_set_indicator);