arch/powerpc/platforms/powernv/opal.c

   1 /*
   2  * PowerNV OPAL high level interfaces
   3  *
   4  * Copyright 2011 IBM Corp.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #define pr_fmt(fmt)     "opal: " fmt
  13
  14 #include <linux/printk.h>
  15 #include <linux/types.h>
  16 #include <linux/of.h>
  17 #include <linux/of_fdt.h>
  18 #include <linux/of_platform.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/notifier.h>
  21 #include <linux/slab.h>
  22 #include <linux/sched.h>
  23 #include <linux/kobject.h>
  24 #include <linux/delay.h>
  25 #include <linux/memblock.h>
  26 #include <linux/kthread.h>
  27 #include <linux/freezer.h>
  28
  29 #include <asm/machdep.h>
  30 #include <asm/opal.h>
  31 #include <asm/firmware.h>
  32 #include <asm/mce.h>
  33
  34 #include "powernv.h"
  35
  36 /* /sys/firmware/opal */
  37 struct kobject *opal_kobj;
  38
  39 struct opal {
  40         u64 base;
  41         u64 entry;
  42         u64 size;
  43 } opal;
  44
  45 struct mcheck_recoverable_range {
  46         u64 start_addr;
  47         u64 end_addr;
  48         u64 recover_addr;
  49 };
  50
  51 static struct mcheck_recoverable_range *mc_recoverable_range;
  52 static int mc_recoverable_range_len;
  53
  54 struct device_node *opal_node;
  55 static DEFINE_SPINLOCK(opal_write_lock);
  56 static struct atomic_notifier_head opal_msg_notifier_head[OPAL_MSG_TYPE_MAX];
  57 static uint32_t opal_heartbeat;
  58
  59 static void opal_reinit_cores(void)
  60 {
  61         /* Do the actual re-init, This will clobber all FPRs, VRs, etc...
  62          *
  63          * It will preserve non volatile GPRs and HSPRG0/1. It will
  64          * also restore HIDs and other SPRs to their original value
  65          * but it might clobber a bunch.
  66          */
  67 #ifdef __BIG_ENDIAN__
  68         opal_reinit_cpus(OPAL_REINIT_CPUS_HILE_BE);
  69 #else
  70         opal_reinit_cpus(OPAL_REINIT_CPUS_HILE_LE);
  71 #endif
  72 }
  73
  74 int __init early_init_dt_scan_opal(unsigned long node,
  75                                    const char *uname, int depth, void *data)
  76 {
  77         const void *basep, *entryp, *sizep;
  78         int basesz, entrysz, runtimesz;
  79
  80         if (depth != 1 || strcmp(uname, "ibm,opal") != 0)
  81                 return 0;
  82
  83         basep  = of_get_flat_dt_prop(node, "opal-base-address", &basesz);
  84         entryp = of_get_flat_dt_prop(node, "opal-entry-address", &entrysz);
  85         sizep = of_get_flat_dt_prop(node, "opal-runtime-size", &runtimesz);
  86
  87         if (!basep || !entryp || !sizep)
  88                 return 1;
  89
  90         opal.base = of_read_number(basep, basesz/4);
  91         opal.entry = of_read_number(entryp, entrysz/4);
  92         opal.size = of_read_number(sizep, runtimesz/4);
  93
  94         pr_debug("OPAL Base  = 0x%llx (basep=%p basesz=%d)\n",
  95                  opal.base, basep, basesz);
  96         pr_debug("OPAL Entry = 0x%llx (entryp=%p basesz=%d)\n",
  97                  opal.entry, entryp, entrysz);
  98         pr_debug("OPAL Entry = 0x%llx (sizep=%p runtimesz=%d)\n",
  99                  opal.size, sizep, runtimesz);
 100
 101         powerpc_firmware_features |= FW_FEATURE_OPAL;
 102         if (of_flat_dt_is_compatible(node, "ibm,opal-v3")) {
 103                 powerpc_firmware_features |= FW_FEATURE_OPALv2;
 104                 powerpc_firmware_features |= FW_FEATURE_OPALv3;
 105                 pr_info("OPAL V3 detected !\n");
 106         } else if (of_flat_dt_is_compatible(node, "ibm,opal-v2")) {
 107                 powerpc_firmware_features |= FW_FEATURE_OPALv2;
 108                 pr_info("OPAL V2 detected !\n");
 109         } else {
 110                 pr_info("OPAL V1 detected !\n");
 111         }
 112
 113         /* Reinit all cores with the right endian */
 114         opal_reinit_cores();
 115
 116         /* Restore some bits */
 117         if (cur_cpu_spec->cpu_restore)
 118                 cur_cpu_spec->cpu_restore();
 119
 120         return 1;
 121 }
 122
 123 int __init early_init_dt_scan_recoverable_ranges(unsigned long node,
 124                                    const char *uname, int depth, void *data)
 125 {
 126         int i, psize, size;
 127         const __be32 *prop;
 128
 129         if (depth != 1 || strcmp(uname, "ibm,opal") != 0)
 130                 return 0;
 131
 132         prop = of_get_flat_dt_prop(node, "mcheck-recoverable-ranges", &psize);
 133
 134         if (!prop)
 135                 return 1;
 136
 137         pr_debug("Found machine check recoverable ranges.\n");
 138
 139         /*
 140          * Calculate number of available entries.
 141          *
 142          * Each recoverable address range entry is (start address, len,
 143          * recovery address), 2 cells each for start and recovery address,
 144          * 1 cell for len, totalling 5 cells per entry.
 145          */
 146         mc_recoverable_range_len = psize / (sizeof(*prop) * 5);
 147
 148         /* Sanity check */
 149         if (!mc_recoverable_range_len)
 150                 return 1;
 151
 152         /* Size required to hold all the entries. */
 153         size = mc_recoverable_range_len *
 154                         sizeof(struct mcheck_recoverable_range);
 155
 156         /*
 157          * Allocate a buffer to hold the MC recoverable ranges. We would be
 158          * accessing them in real mode, hence it needs to be within
 159          * RMO region.
 160          */
 161         mc_recoverable_range =__va(memblock_alloc_base(size, __alignof__(u64),
 162                                                         ppc64_rma_size));
 163         memset(mc_recoverable_range, 0, size);
 164
 165         for (i = 0; i < mc_recoverable_range_len; i++) {
 166                 mc_recoverable_range[i].start_addr =
 167                                         of_read_number(prop + (i * 5) + 0, 2);
 168                 mc_recoverable_range[i].end_addr =
 169                                         mc_recoverable_range[i].start_addr +
 170                                         of_read_number(prop + (i * 5) + 2, 1);
 171                 mc_recoverable_range[i].recover_addr =
 172                                         of_read_number(prop + (i * 5) + 3, 2);
 173
 174                 pr_debug("Machine check recoverable range: %llx..%llx: %llx\n",
 175                                 mc_recoverable_range[i].start_addr,
 176                                 mc_recoverable_range[i].end_addr,
 177                                 mc_recoverable_range[i].recover_addr);
 178         }
 179         return 1;
 180 }
 181
 182 static int __init opal_register_exception_handlers(void)
 183 {
 184 #ifdef __BIG_ENDIAN__
 185         u64 glue;
 186
 187         if (!(powerpc_firmware_features & FW_FEATURE_OPAL))
 188                 return -ENODEV;
 189
 190         /* Hookup some exception handlers except machine check. We use the
 191          * fwnmi area at 0x7000 to provide the glue space to OPAL
 192          */
 193         glue = 0x7000;
 194
 195         /*
 196          * Check if we are running on newer firmware that exports
 197          * OPAL_HANDLE_HMI token. If yes, then don't ask OPAL to patch
 198          * the HMI interrupt and we catch it directly in Linux.
 199          *
 200          * For older firmware (i.e currently released POWER8 System Firmware
 201          * as of today <= SV810_087), we fallback to old behavior and let OPAL
 202          * patch the HMI vector and handle it inside OPAL firmware.
 203          *
 204          * For newer firmware (in development/yet to be released) we will
 205          * start catching/handling HMI directly in Linux.
 206          */
 207         if (!opal_check_token(OPAL_HANDLE_HMI)) {
 208                 pr_info("Old firmware detected, OPAL handles HMIs.\n");
 209                 opal_register_exception_handler(
 210                                 OPAL_HYPERVISOR_MAINTENANCE_HANDLER,
 211                                 0, glue);
 212                 glue += 128;
 213         }
 214
 215         opal_register_exception_handler(OPAL_SOFTPATCH_HANDLER, 0, glue);
 216 #endif
 217
 218         return 0;
 219 }
 220 machine_early_initcall(powernv, opal_register_exception_handlers);
 221
 222 /*
 223  * Opal message notifier based on message type. Allow subscribers to get
 224  * notified for specific messgae type.
 225  */
 226 int opal_message_notifier_register(enum opal_msg_type msg_type,
 227                                         struct notifier_block *nb)
 228 {
 229         if (!nb || msg_type >= OPAL_MSG_TYPE_MAX) {
 230                 pr_warning("%s: Invalid arguments, msg_type:%d\n",
 231                            __func__, msg_type);
 232                 return -EINVAL;
 233         }
 234
 235         return atomic_notifier_chain_register(
 236                                 &opal_msg_notifier_head[msg_type], nb);
 237 }
 238 EXPORT_SYMBOL_GPL(opal_message_notifier_register);
 239
 240 int opal_message_notifier_unregister(enum opal_msg_type msg_type,
 241                                      struct notifier_block *nb)
 242 {
 243         return atomic_notifier_chain_unregister(
 244                         &opal_msg_notifier_head[msg_type], nb);
 245 }
 246 EXPORT_SYMBOL_GPL(opal_message_notifier_unregister);
 247
 248 static void opal_message_do_notify(uint32_t msg_type, void *msg)
 249 {
 250         /* notify subscribers */
 251         atomic_notifier_call_chain(&opal_msg_notifier_head[msg_type],
 252                                         msg_type, msg);
 253 }
 254
 255 static void opal_handle_message(void)
 256 {
 257         s64 ret;
 258         /*
 259          * TODO: pre-allocate a message buffer depending on opal-msg-size
 260          * value in /proc/device-tree.
 261          */
 262         static struct opal_msg msg;
 263         u32 type;
 264
 265         ret = opal_get_msg(__pa(&msg), sizeof(msg));
 266         /* No opal message pending. */
 267         if (ret == OPAL_RESOURCE)
 268                 return;
 269
 270         /* check for errors. */
 271         if (ret) {
 272                 pr_warning("%s: Failed to retrieve opal message, err=%lld\n",
 273                                 __func__, ret);
 274                 return;
 275         }
 276
 277         type = be32_to_cpu(msg.msg_type);
 278
 279         /* Sanity check */
 280         if (type >= OPAL_MSG_TYPE_MAX) {
 281                 pr_warning("%s: Unknown message type: %u\n", __func__, type);
 282                 return;
 283         }
 284         opal_message_do_notify(type, (void *)&msg);
 285 }
 286
 287 static irqreturn_t opal_message_notify(int irq, void *data)
 288 {
 289         opal_handle_message();
 290         return IRQ_HANDLED;
 291 }
 292
 293 static int __init opal_message_init(void)
 294 {
 295         int ret, i, irq;
 296
 297         for (i = 0; i < OPAL_MSG_TYPE_MAX; i++)
 298                 ATOMIC_INIT_NOTIFIER_HEAD(&opal_msg_notifier_head[i]);
 299
 300         irq = opal_event_request(ilog2(OPAL_EVENT_MSG_PENDING));
 301         if (!irq) {
 302                 pr_err("%s: Can't register OPAL event irq (%d)\n",
 303                        __func__, irq);
 304                 return irq;
 305         }
 306
 307         ret = request_irq(irq, opal_message_notify,
 308                         IRQ_TYPE_LEVEL_HIGH, "opal-msg", NULL);
 309         if (ret) {
 310                 pr_err("%s: Can't request OPAL event irq (%d)\n",
 311                        __func__, ret);
 312                 return ret;
 313         }
 314
 315         return 0;
 316 }
 317
 318 int opal_get_chars(uint32_t vtermno, char *buf, int count)
 319 {
 320         s64 rc;
 321         __be64 evt, len;
 322
 323         if (!opal.entry)
 324                 return -ENODEV;
 325         opal_poll_events(&evt);
 326         if ((be64_to_cpu(evt) & OPAL_EVENT_CONSOLE_INPUT) == 0)
 327                 return 0;
 328         len = cpu_to_be64(count);
 329         rc = opal_console_read(vtermno, &len, buf);
 330         if (rc == OPAL_SUCCESS)
 331                 return be64_to_cpu(len);
 332         return 0;
 333 }
 334
 335 int opal_put_chars(uint32_t vtermno, const char *data, int total_len)
 336 {
 337         int written = 0;
 338         __be64 olen;
 339         s64 len, rc;
 340         unsigned long flags;
 341         __be64 evt;
 342
 343         if (!opal.entry)
 344                 return -ENODEV;
 345
 346         /* We want put_chars to be atomic to avoid mangling of hvsi
 347          * packets. To do that, we first test for room and return
 348          * -EAGAIN if there isn't enough.
 349          *
 350          * Unfortunately, opal_console_write_buffer_space() doesn't
 351          * appear to work on opal v1, so we just assume there is
 352          * enough room and be done with it
 353          */
 354         spin_lock_irqsave(&opal_write_lock, flags);
 355         if (firmware_has_feature(FW_FEATURE_OPALv2)) {
 356                 rc = opal_console_write_buffer_space(vtermno, &olen);
 357                 len = be64_to_cpu(olen);
 358                 if (rc || len < total_len) {
 359                         spin_unlock_irqrestore(&opal_write_lock, flags);
 360                         /* Closed -> drop characters */
 361                         if (rc)
 362                                 return total_len;
 363                         opal_poll_events(NULL);
 364                         return -EAGAIN;
 365                 }
 366         }
 367
 368         /* We still try to handle partial completions, though they
 369          * should no longer happen.
 370          */
 371         rc = OPAL_BUSY;
 372         while(total_len > 0 && (rc == OPAL_BUSY ||
 373                                 rc == OPAL_BUSY_EVENT || rc == OPAL_SUCCESS)) {
 374                 olen = cpu_to_be64(total_len);
 375                 rc = opal_console_write(vtermno, &olen, data);
 376                 len = be64_to_cpu(olen);
 377
 378                 /* Closed or other error drop */
 379                 if (rc != OPAL_SUCCESS && rc != OPAL_BUSY &&
 380                     rc != OPAL_BUSY_EVENT) {
 381                         written = total_len;
 382                         break;
 383                 }
 384                 if (rc == OPAL_SUCCESS) {
 385                         total_len -= len;
 386                         data += len;
 387                         written += len;
 388                 }
 389                 /* This is a bit nasty but we need that for the console to
 390                  * flush when there aren't any interrupts. We will clean
 391                  * things a bit later to limit that to synchronous path
 392                  * such as the kernel console and xmon/udbg
 393                  */
 394                 do
 395                         opal_poll_events(&evt);
 396                 while(rc == OPAL_SUCCESS &&
 397                         (be64_to_cpu(evt) & OPAL_EVENT_CONSOLE_OUTPUT));
 398         }
 399         spin_unlock_irqrestore(&opal_write_lock, flags);
 400         return written;
 401 }
 402
 403 static int opal_recover_mce(struct pt_regs *regs,
 404                                         struct machine_check_event *evt)
 405 {
 406         int recovered = 0;
 407         uint64_t ea = get_mce_fault_addr(evt);
 408
 409         if (!(regs->msr & MSR_RI)) {
 410                 /* If MSR_RI isn't set, we cannot recover */
 411                 recovered = 0;
 412         } else if (evt->disposition == MCE_DISPOSITION_RECOVERED) {
 413                 /* Platform corrected itself */
 414                 recovered = 1;
 415         } else if (ea && !is_kernel_addr(ea)) {
 416                 /*
 417                  * Faulting address is not in kernel text. We should be fine.
 418                  * We need to find which process uses this address.
 419                  * For now, kill the task if we have received exception when
 420                  * in userspace.
 421                  *
 422                  * TODO: Queue up this address for hwpoisioning later.
 423                  */
 424                 if (user_mode(regs) && !is_global_init(current)) {
 425                         _exception(SIGBUS, regs, BUS_MCEERR_AR, regs->nip);
 426                         recovered = 1;
 427                 } else
 428                         recovered = 0;
 429         } else if (user_mode(regs) && !is_global_init(current) &&
 430                 evt->severity == MCE_SEV_ERROR_SYNC) {
 431                 /*
 432                  * If we have received a synchronous error when in userspace
 433                  * kill the task.
 434                  */
 435                 _exception(SIGBUS, regs, BUS_MCEERR_AR, regs->nip);
 436                 recovered = 1;
 437         }
 438         return recovered;
 439 }
 440
 441 int opal_machine_check(struct pt_regs *regs)
 442 {
 443         struct machine_check_event evt;
 444         int ret;
 445
 446         if (!get_mce_event(&evt, MCE_EVENT_RELEASE))
 447                 return 0;
 448
 449         /* Print things out */
 450         if (evt.version != MCE_V1) {
 451                 pr_err("Machine Check Exception, Unknown event version %d !\n",
 452                        evt.version);
 453                 return 0;
 454         }
 455         machine_check_print_event_info(&evt);
 456
 457         if (opal_recover_mce(regs, &evt))
 458                 return 1;
 459
 460         /*
 461          * Unrecovered machine check, we are heading to panic path.
 462          *
 463          * We may have hit this MCE in very early stage of kernel
 464          * initialization even before opal-prd has started running. If
 465          * this is the case then this MCE error may go un-noticed or
 466          * un-analyzed if we go down panic path. We need to inform
 467          * BMC/OCC about this error so that they can collect relevant
 468          * data for error analysis before rebooting.
 469          * Use opal_cec_reboot2(OPAL_REBOOT_PLATFORM_ERROR) to do so.
 470          * This function may not return on BMC based system.
 471          */
 472         ret = opal_cec_reboot2(OPAL_REBOOT_PLATFORM_ERROR,
 473                         "Unrecoverable Machine Check exception");
 474         if (ret == OPAL_UNSUPPORTED) {
 475                 pr_emerg("Reboot type %d not supported\n",
 476                                         OPAL_REBOOT_PLATFORM_ERROR);
 477         }
 478
 479         /*
 480          * We reached here. There can be three possibilities:
 481          * 1. We are running on a firmware level that do not support
 482          *    opal_cec_reboot2()
 483          * 2. We are running on a firmware level that do not support
 484          *    OPAL_REBOOT_PLATFORM_ERROR reboot type.
 485          * 3. We are running on FSP based system that does not need opal
 486          *    to trigger checkstop explicitly for error analysis. The FSP
 487          *    PRD component would have already got notified about this
 488          *    error through other channels.
 489          *
 490          * In any case, let us just fall through. We anyway heading
 491          * down to panic path.
 492          */
 493         return 0;
 494 }
 495
 496 /* Early hmi handler called in real mode. */
 497 int opal_hmi_exception_early(struct pt_regs *regs)
 498 {
 499         s64 rc;
 500
 501         /*
 502          * call opal hmi handler. Pass paca address as token.
 503          * The return value OPAL_SUCCESS is an indication that there is
 504          * an HMI event generated waiting to pull by Linux.
 505          */
 506         rc = opal_handle_hmi();
 507         if (rc == OPAL_SUCCESS) {
 508                 local_paca->hmi_event_available = 1;
 509                 return 1;
 510         }
 511         return 0;
 512 }
 513
 514 /* HMI exception handler called in virtual mode during check_irq_replay. */
 515 int opal_handle_hmi_exception(struct pt_regs *regs)
 516 {
 517         s64 rc;
 518         __be64 evt = 0;
 519
 520         /*
 521          * Check if HMI event is available.
 522          * if Yes, then call opal_poll_events to pull opal messages and
 523          * process them.
 524          */
 525         if (!local_paca->hmi_event_available)
 526                 return 0;
 527
 528         local_paca->hmi_event_available = 0;
 529         rc = opal_poll_events(&evt);
 530         if (rc == OPAL_SUCCESS && evt)
 531                 opal_handle_events(be64_to_cpu(evt));
 532
 533         return 1;
 534 }
 535
 536 static uint64_t find_recovery_address(uint64_t nip)
 537 {
 538         int i;
 539
 540         for (i = 0; i < mc_recoverable_range_len; i++)
 541                 if ((nip >= mc_recoverable_range[i].start_addr) &&
 542                     (nip < mc_recoverable_range[i].end_addr))
 543                     return mc_recoverable_range[i].recover_addr;
 544         return 0;
 545 }
 546
 547 bool opal_mce_check_early_recovery(struct pt_regs *regs)
 548 {
 549         uint64_t recover_addr = 0;
 550
 551         if (!opal.base || !opal.size)
 552                 goto out;
 553
 554         if ((regs->nip >= opal.base) &&
 555                         (regs->nip <= (opal.base + opal.size)))
 556                 recover_addr = find_recovery_address(regs->nip);
 557
 558         /*
 559          * Setup regs->nip to rfi into fixup address.
 560          */
 561         if (recover_addr)
 562                 regs->nip = recover_addr;
 563
 564 out:
 565         return !!recover_addr;
 566 }
 567
 568 static int opal_sysfs_init(void)
 569 {
 570         opal_kobj = kobject_create_and_add("opal", firmware_kobj);
 571         if (!opal_kobj) {
 572                 pr_warn("kobject_create_and_add opal failed\n");
 573                 return -ENOMEM;
 574         }
 575
 576         return 0;
 577 }
 578
 579 static ssize_t symbol_map_read(struct file *fp, struct kobject *kobj,
 580                                struct bin_attribute *bin_attr,
 581                                char *buf, loff_t off, size_t count)
 582 {
 583         return memory_read_from_buffer(buf, count, &off, bin_attr->private,
 584                                        bin_attr->size);
 585 }
 586
 587 static BIN_ATTR_RO(symbol_map, 0);
 588
 589 static void opal_export_symmap(void)
 590 {
 591         const __be64 *syms;
 592         unsigned int size;
 593         struct device_node *fw;
 594         int rc;
 595
 596         fw = of_find_node_by_path("/ibm,opal/firmware");
 597         if (!fw)
 598                 return;
 599         syms = of_get_property(fw, "symbol-map", &size);
 600         if (!syms || size != 2 * sizeof(__be64))
 601                 return;
 602
 603         /* Setup attributes */
 604         bin_attr_symbol_map.private = __va(be64_to_cpu(syms[0]));
 605         bin_attr_symbol_map.size = be64_to_cpu(syms[1]);
 606
 607         rc = sysfs_create_bin_file(opal_kobj, &bin_attr_symbol_map);
 608         if (rc)
 609                 pr_warn("Error %d creating OPAL symbols file\n", rc);
 610 }
 611
 612 static void __init opal_dump_region_init(void)
 613 {
 614         void *addr;
 615         uint64_t size;
 616         int rc;
 617
 618         if (!opal_check_token(OPAL_REGISTER_DUMP_REGION))
 619                 return;
 620
 621         /* Register kernel log buffer */
 622         addr = log_buf_addr_get();
 623         if (addr == NULL)
 624                 return;
 625
 626         size = log_buf_len_get();
 627         if (size == 0)
 628                 return;
 629
 630         rc = opal_register_dump_region(OPAL_DUMP_REGION_LOG_BUF,
 631                                        __pa(addr), size);
 632         /* Don't warn if this is just an older OPAL that doesn't
 633          * know about that call
 634          */
 635         if (rc && rc != OPAL_UNSUPPORTED)
 636                 pr_warn("DUMP: Failed to register kernel log buffer. "
 637                         "rc = %d\n", rc);
 638 }
 639
 640 static void opal_pdev_init(struct device_node *opal_node,
 641                 const char *compatible)
 642 {
 643         struct device_node *np;
 644
 645         for_each_child_of_node(opal_node, np)
 646                 if (of_device_is_compatible(np, compatible))
 647                         of_platform_device_create(np, NULL, NULL);
 648 }
 649
 650 static void opal_i2c_create_devs(void)
 651 {
 652         struct device_node *np;
 653
 654         for_each_compatible_node(np, NULL, "ibm,opal-i2c")
 655                 of_platform_device_create(np, NULL, NULL);
 656 }
 657
 658 static int kopald(void *unused)
 659 {
 660         __be64 events;
 661
 662         set_freezable();
 663         do {
 664                 try_to_freeze();
 665                 opal_poll_events(&events);
 666                 opal_handle_events(be64_to_cpu(events));
 667                 msleep_interruptible(opal_heartbeat);
 668         } while (!kthread_should_stop());
 669
 670         return 0;
 671 }
 672
 673 static void opal_init_heartbeat(void)
 674 {
 675         /* Old firwmware, we assume the HVC heartbeat is sufficient */
 676         if (of_property_read_u32(opal_node, "ibm,heartbeat-ms",
 677                                  &opal_heartbeat) != 0)
 678                 opal_heartbeat = 0;
 679
 680         if (opal_heartbeat)
 681                 kthread_run(kopald, NULL, "kopald");
 682 }
 683
 684 static int __init opal_init(void)
 685 {
 686         struct device_node *np, *consoles, *leds;
 687         int rc;
 688
 689         opal_node = of_find_node_by_path("/ibm,opal");
 690         if (!opal_node) {
 691                 pr_warn("Device node not found\n");
 692                 return -ENODEV;
 693         }
 694
 695         /* Register OPAL consoles if any ports */
 696         if (firmware_has_feature(FW_FEATURE_OPALv2))
 697                 consoles = of_find_node_by_path("/ibm,opal/consoles");
 698         else
 699                 consoles = of_node_get(opal_node);
 700         if (consoles) {
 701                 for_each_child_of_node(consoles, np) {
 702                         if (strcmp(np->name, "serial"))
 703                                 continue;
 704                         of_platform_device_create(np, NULL, NULL);
 705                 }
 706                 of_node_put(consoles);
 707         }
 708
 709         /* Initialise OPAL messaging system */
 710         opal_message_init();
 711
 712         /* Initialise OPAL asynchronous completion interface */
 713         opal_async_comp_init();
 714
 715         /* Initialise OPAL sensor interface */
 716         opal_sensor_init();
 717
 718         /* Initialise OPAL hypervisor maintainence interrupt handling */
 719         opal_hmi_handler_init();
 720
 721         /* Create i2c platform devices */
 722         opal_i2c_create_devs();
 723
 724         /* Setup a heatbeat thread if requested by OPAL */
 725         opal_init_heartbeat();
 726
 727         /* Create leds platform devices */
 728         leds = of_find_node_by_path("/ibm,opal/leds");
 729         if (leds) {
 730                 of_platform_device_create(leds, "opal_leds", NULL);
 731                 of_node_put(leds);
 732         }
 733
 734         /* Create "opal" kobject under /sys/firmware */
 735         rc = opal_sysfs_init();
 736         if (rc == 0) {
 737                 /* Export symbol map to userspace */
 738                 opal_export_symmap();
 739                 /* Setup dump region interface */
 740                 opal_dump_region_init();
 741                 /* Setup error log interface */
 742                 rc = opal_elog_init();
 743                 /* Setup code update interface */
 744                 opal_flash_update_init();
 745                 /* Setup platform dump extract interface */
 746                 opal_platform_dump_init();
 747                 /* Setup system parameters interface */
 748                 opal_sys_param_init();
 749                 /* Setup message log interface. */
 750                 opal_msglog_init();
 751         }
 752
 753         /* Initialize platform devices: IPMI backend, PRD & flash interface */
 754         opal_pdev_init(opal_node, "ibm,opal-ipmi");
 755         opal_pdev_init(opal_node, "ibm,opal-flash");
 756         opal_pdev_init(opal_node, "ibm,opal-prd");
 757
 758         return 0;
 759 }
 760 machine_subsys_initcall(powernv, opal_init);
 761
 762 void opal_shutdown(void)
 763 {
 764         long rc = OPAL_BUSY;
 765
 766         opal_event_shutdown();
 767
 768         /*
 769          * Then sync with OPAL which ensure anything that can
 770          * potentially write to our memory has completed such
 771          * as an ongoing dump retrieval
 772          */
 773         while (rc == OPAL_BUSY || rc == OPAL_BUSY_EVENT) {
 774                 rc = opal_sync_host_reboot();
 775                 if (rc == OPAL_BUSY)
 776                         opal_poll_events(NULL);
 777                 else
 778                         mdelay(10);
 779         }
 780
 781         /* Unregister memory dump region */
 782         if (opal_check_token(OPAL_UNREGISTER_DUMP_REGION))
 783                 opal_unregister_dump_region(OPAL_DUMP_REGION_LOG_BUF);
 784 }
 785
 786 /* Export this so that test modules can use it */
 787 EXPORT_SYMBOL_GPL(opal_invalid_call);
 788 EXPORT_SYMBOL_GPL(opal_xscom_read);
 789 EXPORT_SYMBOL_GPL(opal_xscom_write);
 790 EXPORT_SYMBOL_GPL(opal_ipmi_send);
 791 EXPORT_SYMBOL_GPL(opal_ipmi_recv);
 792 EXPORT_SYMBOL_GPL(opal_flash_read);
 793 EXPORT_SYMBOL_GPL(opal_flash_write);
 794 EXPORT_SYMBOL_GPL(opal_flash_erase);
 795 EXPORT_SYMBOL_GPL(opal_prd_msg);
 796
 797 /* Convert a region of vmalloc memory to an opal sg list */
 798 struct opal_sg_list *opal_vmalloc_to_sg_list(void *vmalloc_addr,
 799                                              unsigned long vmalloc_size)
 800 {
 801         struct opal_sg_list *sg, *first = NULL;
 802         unsigned long i = 0;
 803
 804         sg = kzalloc(PAGE_SIZE, GFP_KERNEL);
 805         if (!sg)
 806                 goto nomem;
 807
 808         first = sg;
 809
 810         while (vmalloc_size > 0) {
 811                 uint64_t data = vmalloc_to_pfn(vmalloc_addr) << PAGE_SHIFT;
 812                 uint64_t length = min(vmalloc_size, PAGE_SIZE);
 813
 814                 sg->entry[i].data = cpu_to_be64(data);
 815                 sg->entry[i].length = cpu_to_be64(length);
 816                 i++;
 817
 818                 if (i >= SG_ENTRIES_PER_NODE) {
 819                         struct opal_sg_list *next;
 820
 821                         next = kzalloc(PAGE_SIZE, GFP_KERNEL);
 822                         if (!next)
 823                                 goto nomem;
 824
 825                         sg->length = cpu_to_be64(
 826                                         i * sizeof(struct opal_sg_entry) + 16);
 827                         i = 0;
 828                         sg->next = cpu_to_be64(__pa(next));
 829                         sg = next;
 830                 }
 831
 832                 vmalloc_addr += length;
 833                 vmalloc_size -= length;
 834         }
 835
 836         sg->length = cpu_to_be64(i * sizeof(struct opal_sg_entry) + 16);
 837
 838         return first;
 839
 840 nomem:
 841         pr_err("%s : Failed to allocate memory\n", __func__);
 842         opal_free_sg_list(first);
 843         return NULL;
 844 }
 845
 846 void opal_free_sg_list(struct opal_sg_list *sg)
 847 {
 848         while (sg) {
 849                 uint64_t next = be64_to_cpu(sg->next);
 850
 851                 kfree(sg);
 852
 853                 if (next)
 854                         sg = __va(next);
 855                 else
 856                         sg = NULL;
 857         }
 858 }
 859
 860 int opal_error_code(int rc)
 861 {
 862         switch (rc) {
 863         case OPAL_SUCCESS:              return 0;
 864
 865         case OPAL_PARAMETER:            return -EINVAL;
 866         case OPAL_ASYNC_COMPLETION:     return -EINPROGRESS;
 867         case OPAL_BUSY_EVENT:           return -EBUSY;
 868         case OPAL_NO_MEM:               return -ENOMEM;
 869         case OPAL_PERMISSION:           return -EPERM;
 870
 871         case OPAL_UNSUPPORTED:          return -EIO;
 872         case OPAL_HARDWARE:             return -EIO;
 873         case OPAL_INTERNAL_ERROR:       return -EIO;
 874         default:
 875                 pr_err("%s: unexpected OPAL error %d\n", __func__, rc);
 876                 return -EIO;
 877         }
 878 }
 879
 880 EXPORT_SYMBOL_GPL(opal_poll_events);
 881 EXPORT_SYMBOL_GPL(opal_rtc_read);
 882 EXPORT_SYMBOL_GPL(opal_rtc_write);
 883 EXPORT_SYMBOL_GPL(opal_tpo_read);
 884 EXPORT_SYMBOL_GPL(opal_tpo_write);
 885 EXPORT_SYMBOL_GPL(opal_i2c_request);
 886 /* Export these symbols for PowerNV LED class driver */
 887 EXPORT_SYMBOL_GPL(opal_leds_get_ind);
 888 EXPORT_SYMBOL_GPL(opal_leds_set_ind);