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