xref: /openbmc/qemu/hw/ppc/spapr_rtas.c (revision dd8d6a2d)
1 /*
2  * QEMU PowerPC pSeries Logical Partition (aka sPAPR) hardware System Emulator
3  *
4  * Hypercall based emulated RTAS
5  *
6  * Copyright (c) 2010-2011 David Gibson, IBM Corporation.
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  *
26  */
27 #include "qemu/osdep.h"
28 #include "cpu.h"
29 #include "qemu/log.h"
30 #include "qemu/error-report.h"
31 #include "sysemu/sysemu.h"
32 #include "hw/qdev.h"
33 #include "sysemu/device_tree.h"
34 #include "sysemu/cpus.h"
35 #include "sysemu/hw_accel.h"
36 #include "kvm_ppc.h"
37 
38 #include "hw/ppc/spapr.h"
39 #include "hw/ppc/spapr_vio.h"
40 #include "hw/ppc/spapr_rtas.h"
41 #include "hw/ppc/spapr_cpu_core.h"
42 #include "hw/ppc/ppc.h"
43 #include "hw/boards.h"
44 
45 #include <libfdt.h>
46 #include "hw/ppc/spapr_drc.h"
47 #include "qemu/cutils.h"
48 #include "trace.h"
49 #include "hw/ppc/fdt.h"
50 #include "target/ppc/mmu-hash64.h"
51 #include "target/ppc/mmu-book3s-v3.h"
52 
53 static void rtas_display_character(PowerPCCPU *cpu, sPAPRMachineState *spapr,
54                                    uint32_t token, uint32_t nargs,
55                                    target_ulong args,
56                                    uint32_t nret, target_ulong rets)
57 {
58     uint8_t c = rtas_ld(args, 0);
59     VIOsPAPRDevice *sdev = vty_lookup(spapr, 0);
60 
61     if (!sdev) {
62         rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
63     } else {
64         vty_putchars(sdev, &c, sizeof(c));
65         rtas_st(rets, 0, RTAS_OUT_SUCCESS);
66     }
67 }
68 
69 static void rtas_power_off(PowerPCCPU *cpu, sPAPRMachineState *spapr,
70                            uint32_t token, uint32_t nargs, target_ulong args,
71                            uint32_t nret, target_ulong rets)
72 {
73     if (nargs != 2 || nret != 1) {
74         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
75         return;
76     }
77     qemu_system_shutdown_request(SHUTDOWN_CAUSE_GUEST_SHUTDOWN);
78     cpu_stop_current();
79     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
80 }
81 
82 static void rtas_system_reboot(PowerPCCPU *cpu, sPAPRMachineState *spapr,
83                                uint32_t token, uint32_t nargs,
84                                target_ulong args,
85                                uint32_t nret, target_ulong rets)
86 {
87     if (nargs != 0 || nret != 1) {
88         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
89         return;
90     }
91     qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
92     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
93 }
94 
95 static void rtas_query_cpu_stopped_state(PowerPCCPU *cpu_,
96                                          sPAPRMachineState *spapr,
97                                          uint32_t token, uint32_t nargs,
98                                          target_ulong args,
99                                          uint32_t nret, target_ulong rets)
100 {
101     target_ulong id;
102     PowerPCCPU *cpu;
103 
104     if (nargs != 1 || nret != 2) {
105         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
106         return;
107     }
108 
109     id = rtas_ld(args, 0);
110     cpu = spapr_find_cpu(id);
111     if (cpu != NULL) {
112         if (CPU(cpu)->halted) {
113             rtas_st(rets, 1, 0);
114         } else {
115             rtas_st(rets, 1, 2);
116         }
117 
118         rtas_st(rets, 0, RTAS_OUT_SUCCESS);
119         return;
120     }
121 
122     /* Didn't find a matching cpu */
123     rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
124 }
125 
126 static void rtas_start_cpu(PowerPCCPU *callcpu, sPAPRMachineState *spapr,
127                            uint32_t token, uint32_t nargs,
128                            target_ulong args,
129                            uint32_t nret, target_ulong rets)
130 {
131     target_ulong id, start, r3;
132     PowerPCCPU *newcpu;
133     CPUPPCState *env;
134     PowerPCCPUClass *pcc;
135     target_ulong lpcr;
136 
137     if (nargs != 3 || nret != 1) {
138         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
139         return;
140     }
141 
142     id = rtas_ld(args, 0);
143     start = rtas_ld(args, 1);
144     r3 = rtas_ld(args, 2);
145 
146     newcpu = spapr_find_cpu(id);
147     if (!newcpu) {
148         /* Didn't find a matching cpu */
149         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
150         return;
151     }
152 
153     env = &newcpu->env;
154     pcc = POWERPC_CPU_GET_CLASS(newcpu);
155 
156     if (!CPU(newcpu)->halted) {
157         rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
158         return;
159     }
160 
161     cpu_synchronize_state(CPU(newcpu));
162 
163     env->msr = (1ULL << MSR_SF) | (1ULL << MSR_ME);
164 
165     /* Enable Power-saving mode Exit Cause exceptions for the new CPU */
166     lpcr = env->spr[SPR_LPCR];
167     if (!pcc->interrupts_big_endian(callcpu)) {
168         lpcr |= LPCR_ILE;
169     }
170     if (env->mmu_model == POWERPC_MMU_3_00) {
171         /*
172          * New cpus are expected to start in the same radix/hash mode
173          * as the existing CPUs
174          */
175         if (ppc64_v3_radix(callcpu)) {
176             lpcr |= LPCR_UPRT | LPCR_GTSE | LPCR_HR;
177         } else {
178             lpcr &= ~(LPCR_UPRT | LPCR_GTSE | LPCR_HR);
179         }
180     }
181     ppc_store_lpcr(newcpu, lpcr);
182 
183     /*
184      * Set the timebase offset of the new CPU to that of the invoking
185      * CPU.  This helps hotplugged CPU to have the correct timebase
186      * offset.
187      */
188     newcpu->env.tb_env->tb_offset = callcpu->env.tb_env->tb_offset;
189 
190     spapr_cpu_set_entry_state(newcpu, start, r3);
191 
192     qemu_cpu_kick(CPU(newcpu));
193 
194     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
195 }
196 
197 static void rtas_stop_self(PowerPCCPU *cpu, sPAPRMachineState *spapr,
198                            uint32_t token, uint32_t nargs,
199                            target_ulong args,
200                            uint32_t nret, target_ulong rets)
201 {
202     CPUState *cs = CPU(cpu);
203     CPUPPCState *env = &cpu->env;
204     PowerPCCPUClass *pcc = POWERPC_CPU_GET_CLASS(cpu);
205 
206     /* Disable Power-saving mode Exit Cause exceptions for the CPU.
207      * This could deliver an interrupt on a dying CPU and crash the
208      * guest */
209     ppc_store_lpcr(cpu, env->spr[SPR_LPCR] & ~pcc->lpcr_pm);
210     cs->halted = 1;
211     kvmppc_set_reg_ppc_online(cpu, 0);
212     qemu_cpu_kick(cs);
213 }
214 
215 static inline int sysparm_st(target_ulong addr, target_ulong len,
216                              const void *val, uint16_t vallen)
217 {
218     hwaddr phys = ppc64_phys_to_real(addr);
219 
220     if (len < 2) {
221         return RTAS_OUT_SYSPARM_PARAM_ERROR;
222     }
223     stw_be_phys(&address_space_memory, phys, vallen);
224     cpu_physical_memory_write(phys + 2, val, MIN(len - 2, vallen));
225     return RTAS_OUT_SUCCESS;
226 }
227 
228 static void rtas_ibm_get_system_parameter(PowerPCCPU *cpu,
229                                           sPAPRMachineState *spapr,
230                                           uint32_t token, uint32_t nargs,
231                                           target_ulong args,
232                                           uint32_t nret, target_ulong rets)
233 {
234     target_ulong parameter = rtas_ld(args, 0);
235     target_ulong buffer = rtas_ld(args, 1);
236     target_ulong length = rtas_ld(args, 2);
237     target_ulong ret;
238 
239     switch (parameter) {
240     case RTAS_SYSPARM_SPLPAR_CHARACTERISTICS: {
241         char *param_val = g_strdup_printf("MaxEntCap=%d,"
242                                           "DesMem=%" PRIu64 ","
243                                           "DesProcs=%d,"
244                                           "MaxPlatProcs=%d",
245                                           max_cpus,
246                                           current_machine->ram_size / MiB,
247                                           smp_cpus,
248                                           max_cpus);
249         ret = sysparm_st(buffer, length, param_val, strlen(param_val) + 1);
250         g_free(param_val);
251         break;
252     }
253     case RTAS_SYSPARM_DIAGNOSTICS_RUN_MODE: {
254         uint8_t param_val = DIAGNOSTICS_RUN_MODE_DISABLED;
255 
256         ret = sysparm_st(buffer, length, &param_val, sizeof(param_val));
257         break;
258     }
259     case RTAS_SYSPARM_UUID:
260         ret = sysparm_st(buffer, length, (unsigned char *)&qemu_uuid,
261                          (qemu_uuid_set ? 16 : 0));
262         break;
263     default:
264         ret = RTAS_OUT_NOT_SUPPORTED;
265     }
266 
267     rtas_st(rets, 0, ret);
268 }
269 
270 static void rtas_ibm_set_system_parameter(PowerPCCPU *cpu,
271                                           sPAPRMachineState *spapr,
272                                           uint32_t token, uint32_t nargs,
273                                           target_ulong args,
274                                           uint32_t nret, target_ulong rets)
275 {
276     target_ulong parameter = rtas_ld(args, 0);
277     target_ulong ret = RTAS_OUT_NOT_SUPPORTED;
278 
279     switch (parameter) {
280     case RTAS_SYSPARM_SPLPAR_CHARACTERISTICS:
281     case RTAS_SYSPARM_DIAGNOSTICS_RUN_MODE:
282     case RTAS_SYSPARM_UUID:
283         ret = RTAS_OUT_NOT_AUTHORIZED;
284         break;
285     }
286 
287     rtas_st(rets, 0, ret);
288 }
289 
290 static void rtas_ibm_os_term(PowerPCCPU *cpu,
291                             sPAPRMachineState *spapr,
292                             uint32_t token, uint32_t nargs,
293                             target_ulong args,
294                             uint32_t nret, target_ulong rets)
295 {
296     qemu_system_guest_panicked(NULL);
297 
298     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
299 }
300 
301 static void rtas_set_power_level(PowerPCCPU *cpu, sPAPRMachineState *spapr,
302                                  uint32_t token, uint32_t nargs,
303                                  target_ulong args, uint32_t nret,
304                                  target_ulong rets)
305 {
306     int32_t power_domain;
307 
308     if (nargs != 2 || nret != 2) {
309         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
310         return;
311     }
312 
313     /* we currently only use a single, "live insert" powerdomain for
314      * hotplugged/dlpar'd resources, so the power is always live/full (100)
315      */
316     power_domain = rtas_ld(args, 0);
317     if (power_domain != -1) {
318         rtas_st(rets, 0, RTAS_OUT_NOT_SUPPORTED);
319         return;
320     }
321 
322     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
323     rtas_st(rets, 1, 100);
324 }
325 
326 static void rtas_get_power_level(PowerPCCPU *cpu, sPAPRMachineState *spapr,
327                                   uint32_t token, uint32_t nargs,
328                                   target_ulong args, uint32_t nret,
329                                   target_ulong rets)
330 {
331     int32_t power_domain;
332 
333     if (nargs != 1 || nret != 2) {
334         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
335         return;
336     }
337 
338     /* we currently only use a single, "live insert" powerdomain for
339      * hotplugged/dlpar'd resources, so the power is always live/full (100)
340      */
341     power_domain = rtas_ld(args, 0);
342     if (power_domain != -1) {
343         rtas_st(rets, 0, RTAS_OUT_NOT_SUPPORTED);
344         return;
345     }
346 
347     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
348     rtas_st(rets, 1, 100);
349 }
350 
351 static struct rtas_call {
352     const char *name;
353     spapr_rtas_fn fn;
354 } rtas_table[RTAS_TOKEN_MAX - RTAS_TOKEN_BASE];
355 
356 target_ulong spapr_rtas_call(PowerPCCPU *cpu, sPAPRMachineState *spapr,
357                              uint32_t token, uint32_t nargs, target_ulong args,
358                              uint32_t nret, target_ulong rets)
359 {
360     if ((token >= RTAS_TOKEN_BASE) && (token < RTAS_TOKEN_MAX)) {
361         struct rtas_call *call = rtas_table + (token - RTAS_TOKEN_BASE);
362 
363         if (call->fn) {
364             call->fn(cpu, spapr, token, nargs, args, nret, rets);
365             return H_SUCCESS;
366         }
367     }
368 
369     /* HACK: Some Linux early debug code uses RTAS display-character,
370      * but assumes the token value is 0xa (which it is on some real
371      * machines) without looking it up in the device tree.  This
372      * special case makes this work */
373     if (token == 0xa) {
374         rtas_display_character(cpu, spapr, 0xa, nargs, args, nret, rets);
375         return H_SUCCESS;
376     }
377 
378     hcall_dprintf("Unknown RTAS token 0x%x\n", token);
379     rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
380     return H_PARAMETER;
381 }
382 
383 uint64_t qtest_rtas_call(char *cmd, uint32_t nargs, uint64_t args,
384                          uint32_t nret, uint64_t rets)
385 {
386     int token;
387 
388     for (token = 0; token < RTAS_TOKEN_MAX - RTAS_TOKEN_BASE; token++) {
389         if (strcmp(cmd, rtas_table[token].name) == 0) {
390             sPAPRMachineState *spapr = SPAPR_MACHINE(qdev_get_machine());
391             PowerPCCPU *cpu = POWERPC_CPU(first_cpu);
392 
393             rtas_table[token].fn(cpu, spapr, token + RTAS_TOKEN_BASE,
394                                  nargs, args, nret, rets);
395             return H_SUCCESS;
396         }
397     }
398     return H_PARAMETER;
399 }
400 
401 void spapr_rtas_register(int token, const char *name, spapr_rtas_fn fn)
402 {
403     assert((token >= RTAS_TOKEN_BASE) && (token < RTAS_TOKEN_MAX));
404 
405     token -= RTAS_TOKEN_BASE;
406 
407     assert(!rtas_table[token].name);
408 
409     rtas_table[token].name = name;
410     rtas_table[token].fn = fn;
411 }
412 
413 void spapr_dt_rtas_tokens(void *fdt, int rtas)
414 {
415     int i;
416 
417     for (i = 0; i < RTAS_TOKEN_MAX - RTAS_TOKEN_BASE; i++) {
418         struct rtas_call *call = &rtas_table[i];
419 
420         if (!call->name) {
421             continue;
422         }
423 
424         _FDT(fdt_setprop_cell(fdt, rtas, call->name, i + RTAS_TOKEN_BASE));
425     }
426 }
427 
428 void spapr_load_rtas(sPAPRMachineState *spapr, void *fdt, hwaddr addr)
429 {
430     int rtas_node;
431     int ret;
432 
433     /* Copy RTAS blob into guest RAM */
434     cpu_physical_memory_write(addr, spapr->rtas_blob, spapr->rtas_size);
435 
436     ret = fdt_add_mem_rsv(fdt, addr, spapr->rtas_size);
437     if (ret < 0) {
438         error_report("Couldn't add RTAS reserve entry: %s",
439                      fdt_strerror(ret));
440         exit(1);
441     }
442 
443     /* Update the device tree with the blob's location */
444     rtas_node = fdt_path_offset(fdt, "/rtas");
445     assert(rtas_node >= 0);
446 
447     ret = fdt_setprop_cell(fdt, rtas_node, "linux,rtas-base", addr);
448     if (ret < 0) {
449         error_report("Couldn't add linux,rtas-base property: %s",
450                      fdt_strerror(ret));
451         exit(1);
452     }
453 
454     ret = fdt_setprop_cell(fdt, rtas_node, "linux,rtas-entry", addr);
455     if (ret < 0) {
456         error_report("Couldn't add linux,rtas-entry property: %s",
457                      fdt_strerror(ret));
458         exit(1);
459     }
460 
461     ret = fdt_setprop_cell(fdt, rtas_node, "rtas-size", spapr->rtas_size);
462     if (ret < 0) {
463         error_report("Couldn't add rtas-size property: %s",
464                      fdt_strerror(ret));
465         exit(1);
466     }
467 }
468 
469 static void core_rtas_register_types(void)
470 {
471     spapr_rtas_register(RTAS_DISPLAY_CHARACTER, "display-character",
472                         rtas_display_character);
473     spapr_rtas_register(RTAS_POWER_OFF, "power-off", rtas_power_off);
474     spapr_rtas_register(RTAS_SYSTEM_REBOOT, "system-reboot",
475                         rtas_system_reboot);
476     spapr_rtas_register(RTAS_QUERY_CPU_STOPPED_STATE, "query-cpu-stopped-state",
477                         rtas_query_cpu_stopped_state);
478     spapr_rtas_register(RTAS_START_CPU, "start-cpu", rtas_start_cpu);
479     spapr_rtas_register(RTAS_STOP_SELF, "stop-self", rtas_stop_self);
480     spapr_rtas_register(RTAS_IBM_GET_SYSTEM_PARAMETER,
481                         "ibm,get-system-parameter",
482                         rtas_ibm_get_system_parameter);
483     spapr_rtas_register(RTAS_IBM_SET_SYSTEM_PARAMETER,
484                         "ibm,set-system-parameter",
485                         rtas_ibm_set_system_parameter);
486     spapr_rtas_register(RTAS_IBM_OS_TERM, "ibm,os-term",
487                         rtas_ibm_os_term);
488     spapr_rtas_register(RTAS_SET_POWER_LEVEL, "set-power-level",
489                         rtas_set_power_level);
490     spapr_rtas_register(RTAS_GET_POWER_LEVEL, "get-power-level",
491                         rtas_get_power_level);
492 }
493 
494 type_init(core_rtas_register_types)
495