text: /*
   * QEMU PowerPC pSeries Logical Partition (aka sPAPR) hardware System Emulator
   *
   * Hypercall based emulated RTAS
   *
   * Copyright (c) 2010-2011 David Gibson, IBM Corporation.
   *
   * Permission is hereby granted, free of charge, to any person obtaining a copy
   * of this software and associated documentation files (the "Software"), to deal
   * in the Software without restriction, including without limitation the rights
   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   * copies of the Software, and to permit persons to whom the Software is
   * furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included in
   * all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   * THE SOFTWARE.
   *
   */
  #include "qemu/osdep.h"
  #include "cpu.h"
  #include "qemu/log.h"
  #include "qemu/error-report.h"
  #include "sysemu/sysemu.h"
  #include "hw/qdev.h"
  #include "sysemu/device_tree.h"
  #include "sysemu/cpus.h"
  #include "sysemu/kvm.h"
  
  #include "hw/ppc/spapr.h"
  #include "hw/ppc/spapr_vio.h"
  #include "hw/ppc/spapr_rtas.h"
  #include "hw/ppc/ppc.h"
  #include "qapi-event.h"
  #include "hw/boards.h"
  
  #include <libfdt.h>
  #include "hw/ppc/spapr_drc.h"
  #include "qemu/cutils.h"
  #include "trace.h"
  #include "hw/ppc/fdt.h"
  
  static void rtas_display_character(PowerPCCPU *cpu, sPAPRMachineState *spapr,
                                     uint32_t token, uint32_t nargs,
                                     target_ulong args,
                                     uint32_t nret, target_ulong rets)
  {
      uint8_t c = rtas_ld(args, 0);
      VIOsPAPRDevice *sdev = vty_lookup(spapr, 0);
  
      if (!sdev) {
          rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
      } else {
          vty_putchars(sdev, &c, sizeof(c));
          rtas_st(rets, 0, RTAS_OUT_SUCCESS);
      }
  }
  
  static void rtas_power_off(PowerPCCPU *cpu, sPAPRMachineState *spapr,
                             uint32_t token, uint32_t nargs, target_ulong args,
                             uint32_t nret, target_ulong rets)
  {
      if (nargs != 2 || nret != 1) {
          rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
          return;
      }
      qemu_system_shutdown_request(SHUTDOWN_CAUSE_GUEST_SHUTDOWN);
      cpu_stop_current();
      rtas_st(rets, 0, RTAS_OUT_SUCCESS);
  }
  
  static void rtas_system_reboot(PowerPCCPU *cpu, sPAPRMachineState *spapr,
                                 uint32_t token, uint32_t nargs,
                                 target_ulong args,
                                 uint32_t nret, target_ulong rets)
  {
      if (nargs != 0 || nret != 1) {
          rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
          return;
      }
      qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
      rtas_st(rets, 0, RTAS_OUT_SUCCESS);
  }
  
  static void rtas_query_cpu_stopped_state(PowerPCCPU *cpu_,
                                           sPAPRMachineState *spapr,
                                           uint32_t token, uint32_t nargs,
                                           target_ulong args,
                                           uint32_t nret, target_ulong rets)
  {
      target_ulong id;
      PowerPCCPU *cpu;
  
      if (nargs != 1 || nret != 2) {
          rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
          return;
      }
  
      id = rtas_ld(args, 0);
      cpu = spapr_find_cpu(id);
      if (cpu != NULL) {
          if (CPU(cpu)->halted) {
              rtas_st(rets, 1, 0);
          } else {
              rtas_st(rets, 1, 2);
          }
  
          rtas_st(rets, 0, RTAS_OUT_SUCCESS);
          return;
      }
  
      /* Didn't find a matching cpu */
      rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
  }
  
  /*
   * Set the timebase offset of the CPU to that of first CPU.
   * This helps hotplugged CPU to have the correct timebase offset.
   */
  static void spapr_cpu_update_tb_offset(PowerPCCPU *cpu)
  {
      PowerPCCPU *fcpu = POWERPC_CPU(first_cpu);
  
      cpu->env.tb_env->tb_offset = fcpu->env.tb_env->tb_offset;
  }
  
  static void spapr_cpu_set_endianness(PowerPCCPU *cpu)
  {
      PowerPCCPU *fcpu = POWERPC_CPU(first_cpu);
      PowerPCCPUClass *pcc = POWERPC_CPU_GET_CLASS(fcpu);
  
      if (!pcc->interrupts_big_endian(fcpu)) {
          cpu->env.spr[SPR_LPCR] |= LPCR_ILE;
      }
  }
  
  static void rtas_start_cpu(PowerPCCPU *cpu_, sPAPRMachineState *spapr,
                             uint32_t token, uint32_t nargs,
                             target_ulong args,
                             uint32_t nret, target_ulong rets)
  {
      target_ulong id, start, r3;
      PowerPCCPU *cpu;
  
      if (nargs != 3 || nret != 1) {
          rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
          return;
      }
  
      id = rtas_ld(args, 0);
      start = rtas_ld(args, 1);
      r3 = rtas_ld(args, 2);
  
      cpu = spapr_find_cpu(id);
      if (cpu != NULL) {
          CPUState *cs = CPU(cpu);
          CPUPPCState *env = &cpu->env;
  
          if (!cs->halted) {
              rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
              return;
          }
  
          /* This will make sure qemu state is up to date with kvm, and
           * mark it dirty so our changes get flushed back before the
           * new cpu enters */
          kvm_cpu_synchronize_state(cs);
  
          env->msr = (1ULL << MSR_SF) | (1ULL << MSR_ME);
          env->nip = start;
          env->gpr[3] = r3;
          cs->halted = 0;
          spapr_cpu_set_endianness(cpu);
          spapr_cpu_update_tb_offset(cpu);
  
          qemu_cpu_kick(cs);
  
          rtas_st(rets, 0, RTAS_OUT_SUCCESS);
          return;
      }
  
      /* Didn't find a matching cpu */
      rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
  }
  
  static void rtas_stop_self(PowerPCCPU *cpu, sPAPRMachineState *spapr,
                             uint32_t token, uint32_t nargs,
                             target_ulong args,
                             uint32_t nret, target_ulong rets)
  {
      CPUState *cs = CPU(cpu);
      CPUPPCState *env = &cpu->env;
  
      cs->halted = 1;
      qemu_cpu_kick(cs);
      /*
       * While stopping a CPU, the guest calls H_CPPR which
       * effectively disables interrupts on XICS level.
       * However decrementer interrupts in TCG can still
       * wake the CPU up so here we disable interrupts in MSR
       * as well.
       * As rtas_start_cpu() resets the whole MSR anyway, there is
       * no need to bother with specific bits, we just clear it.
       */
      env->msr = 0;
  }
  
  static inline int sysparm_st(target_ulong addr, target_ulong len,
                               const void *val, uint16_t vallen)
  {
      hwaddr phys = ppc64_phys_to_real(addr);
  
      if (len < 2) {
          return RTAS_OUT_SYSPARM_PARAM_ERROR;
      }
      stw_be_phys(&address_space_memory, phys, vallen);
      cpu_physical_memory_write(phys + 2, val, MIN(len - 2, vallen));
      return RTAS_OUT_SUCCESS;
  }
  
  static void rtas_ibm_get_system_parameter(PowerPCCPU *cpu,
                                            sPAPRMachineState *spapr,
                                            uint32_t token, uint32_t nargs,
                                            target_ulong args,
                                            uint32_t nret, target_ulong rets)
  {
      target_ulong parameter = rtas_ld(args, 0);
      target_ulong buffer = rtas_ld(args, 1);
      target_ulong length = rtas_ld(args, 2);
      target_ulong ret;
  
      switch (parameter) {
      case RTAS_SYSPARM_SPLPAR_CHARACTERISTICS: {
          char *param_val = g_strdup_printf("MaxEntCap=%d,"
                                            "DesMem=%llu,"
                                            "DesProcs=%d,"
                                            "MaxPlatProcs=%d",
                                            max_cpus,
                                            current_machine->ram_size / M_BYTE,
                                            smp_cpus,
                                            max_cpus);
          ret = sysparm_st(buffer, length, param_val, strlen(param_val) + 1);
          g_free(param_val);
          break;
      }
      case RTAS_SYSPARM_DIAGNOSTICS_RUN_MODE: {
          uint8_t param_val = DIAGNOSTICS_RUN_MODE_DISABLED;
  
          ret = sysparm_st(buffer, length, &param_val, sizeof(param_val));
          break;
      }
      case RTAS_SYSPARM_UUID:
          ret = sysparm_st(buffer, length, (unsigned char *)&qemu_uuid,
                           (qemu_uuid_set ? 16 : 0));
          break;
      default:
          ret = RTAS_OUT_NOT_SUPPORTED;
      }
  
      rtas_st(rets, 0, ret);
  }
  
  static void rtas_ibm_set_system_parameter(PowerPCCPU *cpu,
                                            sPAPRMachineState *spapr,
                                            uint32_t token, uint32_t nargs,
                                            target_ulong args,
                                            uint32_t nret, target_ulong rets)
  {
      target_ulong parameter = rtas_ld(args, 0);
      target_ulong ret = RTAS_OUT_NOT_SUPPORTED;
  
      switch (parameter) {
      case RTAS_SYSPARM_SPLPAR_CHARACTERISTICS:
      case RTAS_SYSPARM_DIAGNOSTICS_RUN_MODE:
      case RTAS_SYSPARM_UUID:
          ret = RTAS_OUT_NOT_AUTHORIZED;
          break;
      }
  
      rtas_st(rets, 0, ret);
  }
  
  static void rtas_ibm_os_term(PowerPCCPU *cpu,
                              sPAPRMachineState *spapr,
                              uint32_t token, uint32_t nargs,
                              target_ulong args,
                              uint32_t nret, target_ulong rets)
  {
      qemu_system_guest_panicked(NULL);
  
      rtas_st(rets, 0, RTAS_OUT_SUCCESS);
  }
  
  static void rtas_set_power_level(PowerPCCPU *cpu, sPAPRMachineState *spapr,
                                   uint32_t token, uint32_t nargs,
                                   target_ulong args, uint32_t nret,
                                   target_ulong rets)
  {
      int32_t power_domain;
  
      if (nargs != 2 || nret != 2) {
          rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
          return;
      }
  
      /* we currently only use a single, "live insert" powerdomain for
       * hotplugged/dlpar'd resources, so the power is always live/full (100)
       */
      power_domain = rtas_ld(args, 0);
      if (power_domain != -1) {
          rtas_st(rets, 0, RTAS_OUT_NOT_SUPPORTED);
          return;
      }
  
      rtas_st(rets, 0, RTAS_OUT_SUCCESS);
      rtas_st(rets, 1, 100);
  }
  
  static void rtas_get_power_level(PowerPCCPU *cpu, sPAPRMachineState *spapr,
                                    uint32_t token, uint32_t nargs,
                                    target_ulong args, uint32_t nret,
                                    target_ulong rets)
  {
      int32_t power_domain;
  
      if (nargs != 1 || nret != 2) {
          rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
          return;
      }
  
      /* we currently only use a single, "live insert" powerdomain for
       * hotplugged/dlpar'd resources, so the power is always live/full (100)
       */
      power_domain = rtas_ld(args, 0);
      if (power_domain != -1) {
          rtas_st(rets, 0, RTAS_OUT_NOT_SUPPORTED);
          return;
      }
  
      rtas_st(rets, 0, RTAS_OUT_SUCCESS);
      rtas_st(rets, 1, 100);
  }
  
  static struct rtas_call {
      const char *name;
      spapr_rtas_fn fn;
  } rtas_table[RTAS_TOKEN_MAX - RTAS_TOKEN_BASE];
  
  target_ulong spapr_rtas_call(PowerPCCPU *cpu, sPAPRMachineState *spapr,
                               uint32_t token, uint32_t nargs, target_ulong args,
                               uint32_t nret, target_ulong rets)
  {
      if ((token >= RTAS_TOKEN_BASE) && (token < RTAS_TOKEN_MAX)) {
          struct rtas_call *call = rtas_table + (token - RTAS_TOKEN_BASE);
  
          if (call->fn) {
              call->fn(cpu, spapr, token, nargs, args, nret, rets);
              return H_SUCCESS;
          }
      }
  
      /* HACK: Some Linux early debug code uses RTAS display-character,
       * but assumes the token value is 0xa (which it is on some real
       * machines) without looking it up in the device tree.  This
       * special case makes this work */
      if (token == 0xa) {
          rtas_display_character(cpu, spapr, 0xa, nargs, args, nret, rets);
          return H_SUCCESS;
      }
  
      hcall_dprintf("Unknown RTAS token 0x%x\n", token);
      rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
      return H_PARAMETER;
  }
  
  uint64_t qtest_rtas_call(char *cmd, uint32_t nargs, uint64_t args,
                           uint32_t nret, uint64_t rets)
  {
      int token;
  
      for (token = 0; token < RTAS_TOKEN_MAX - RTAS_TOKEN_BASE; token++) {
          if (strcmp(cmd, rtas_table[token].name) == 0) {
              sPAPRMachineState *spapr = SPAPR_MACHINE(qdev_get_machine());
              PowerPCCPU *cpu = POWERPC_CPU(first_cpu);
  
              rtas_table[token].fn(cpu, spapr, token + RTAS_TOKEN_BASE,
                                   nargs, args, nret, rets);
              return H_SUCCESS;
          }
      }
      return H_PARAMETER;
  }
  
  void spapr_rtas_register(int token, const char *name, spapr_rtas_fn fn)
  {
      assert((token >= RTAS_TOKEN_BASE) && (token < RTAS_TOKEN_MAX));
  
      token -= RTAS_TOKEN_BASE;
  
      assert(!rtas_table[token].name);
  
      rtas_table[token].name = name;
      rtas_table[token].fn = fn;
  }
  
  void spapr_dt_rtas_tokens(void *fdt, int rtas)
  {
      int i;
  
      for (i = 0; i < RTAS_TOKEN_MAX - RTAS_TOKEN_BASE; i++) {
          struct rtas_call *call = &rtas_table[i];
  
          if (!call->name) {
              continue;
          }
  
          _FDT(fdt_setprop_cell(fdt, rtas, call->name, i + RTAS_TOKEN_BASE));
      }
  }
  
  void spapr_load_rtas(sPAPRMachineState *spapr, void *fdt, hwaddr addr)
  {
      int rtas_node;
      int ret;
  
      /* Copy RTAS blob into guest RAM */
      cpu_physical_memory_write(addr, spapr->rtas_blob, spapr->rtas_size);
  
      ret = fdt_add_mem_rsv(fdt, addr, spapr->rtas_size);
      if (ret < 0) {
          error_report("Couldn't add RTAS reserve entry: %s",
                       fdt_strerror(ret));
          exit(1);
      }
  
      /* Update the device tree with the blob's location */
      rtas_node = fdt_path_offset(fdt, "/rtas");
      assert(rtas_node >= 0);
  
      ret = fdt_setprop_cell(fdt, rtas_node, "linux,rtas-base", addr);
      if (ret < 0) {
          error_report("Couldn't add linux,rtas-base property: %s",
                       fdt_strerror(ret));
          exit(1);
      }
  
      ret = fdt_setprop_cell(fdt, rtas_node, "linux,rtas-entry", addr);
      if (ret < 0) {
          error_report("Couldn't add linux,rtas-entry property: %s",
                       fdt_strerror(ret));
          exit(1);
      }
  
      ret = fdt_setprop_cell(fdt, rtas_node, "rtas-size", spapr->rtas_size);
      if (ret < 0) {
          error_report("Couldn't add rtas-size property: %s",
                       fdt_strerror(ret));
          exit(1);
      }
  }
  
  static void core_rtas_register_types(void)
  {
      spapr_rtas_register(RTAS_DISPLAY_CHARACTER, "display-character",
                          rtas_display_character);
      spapr_rtas_register(RTAS_POWER_OFF, "power-off", rtas_power_off);
      spapr_rtas_register(RTAS_SYSTEM_REBOOT, "system-reboot",
                          rtas_system_reboot);
      spapr_rtas_register(RTAS_QUERY_CPU_STOPPED_STATE, "query-cpu-stopped-state",
                          rtas_query_cpu_stopped_state);
      spapr_rtas_register(RTAS_START_CPU, "start-cpu", rtas_start_cpu);
      spapr_rtas_register(RTAS_STOP_SELF, "stop-self", rtas_stop_self);
      spapr_rtas_register(RTAS_IBM_GET_SYSTEM_PARAMETER,
                          "ibm,get-system-parameter",
                          rtas_ibm_get_system_parameter);
      spapr_rtas_register(RTAS_IBM_SET_SYSTEM_PARAMETER,
                          "ibm,set-system-parameter",
                          rtas_ibm_set_system_parameter);
      spapr_rtas_register(RTAS_IBM_OS_TERM, "ibm,os-term",
                          rtas_ibm_os_term);
      spapr_rtas_register(RTAS_SET_POWER_LEVEL, "set-power-level",
                          rtas_set_power_level);
      spapr_rtas_register(RTAS_GET_POWER_LEVEL, "get-power-level",
                          rtas_get_power_level);
  }
  
  type_init(core_rtas_register_types)
  