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