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