xref: /qemu/hw/ppc/spapr_rtas.c (revision cf116ad4703a37b66122d97f139afb2321b9c40e)
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 
37 #include "hw/ppc/spapr.h"
38 #include "hw/ppc/spapr_vio.h"
39 #include "hw/ppc/spapr_rtas.h"
40 #include "hw/ppc/ppc.h"
41 #include "hw/boards.h"
42 
43 #include <libfdt.h>
44 #include "hw/ppc/spapr_drc.h"
45 #include "qemu/cutils.h"
46 #include "trace.h"
47 #include "hw/ppc/fdt.h"
48 #include "target/ppc/mmu-hash64.h"
49 
50 static void rtas_display_character(PowerPCCPU *cpu, sPAPRMachineState *spapr,
51                                    uint32_t token, uint32_t nargs,
52                                    target_ulong args,
53                                    uint32_t nret, target_ulong rets)
54 {
55     uint8_t c = rtas_ld(args, 0);
56     VIOsPAPRDevice *sdev = vty_lookup(spapr, 0);
57 
58     if (!sdev) {
59         rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
60     } else {
61         vty_putchars(sdev, &c, sizeof(c));
62         rtas_st(rets, 0, RTAS_OUT_SUCCESS);
63     }
64 }
65 
66 static void rtas_power_off(PowerPCCPU *cpu, sPAPRMachineState *spapr,
67                            uint32_t token, uint32_t nargs, target_ulong args,
68                            uint32_t nret, target_ulong rets)
69 {
70     if (nargs != 2 || nret != 1) {
71         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
72         return;
73     }
74     qemu_system_shutdown_request(SHUTDOWN_CAUSE_GUEST_SHUTDOWN);
75     cpu_stop_current();
76     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
77 }
78 
79 static void rtas_system_reboot(PowerPCCPU *cpu, sPAPRMachineState *spapr,
80                                uint32_t token, uint32_t nargs,
81                                target_ulong args,
82                                uint32_t nret, target_ulong rets)
83 {
84     if (nargs != 0 || nret != 1) {
85         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
86         return;
87     }
88     qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
89     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
90 }
91 
92 static void rtas_query_cpu_stopped_state(PowerPCCPU *cpu_,
93                                          sPAPRMachineState *spapr,
94                                          uint32_t token, uint32_t nargs,
95                                          target_ulong args,
96                                          uint32_t nret, target_ulong rets)
97 {
98     target_ulong id;
99     PowerPCCPU *cpu;
100 
101     if (nargs != 1 || nret != 2) {
102         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
103         return;
104     }
105 
106     id = rtas_ld(args, 0);
107     cpu = spapr_find_cpu(id);
108     if (cpu != NULL) {
109         if (CPU(cpu)->halted) {
110             rtas_st(rets, 1, 0);
111         } else {
112             rtas_st(rets, 1, 2);
113         }
114 
115         rtas_st(rets, 0, RTAS_OUT_SUCCESS);
116         return;
117     }
118 
119     /* Didn't find a matching cpu */
120     rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
121 }
122 
123 /*
124  * Set the timebase offset of the CPU to that of first CPU.
125  * This helps hotplugged CPU to have the correct timebase offset.
126  */
127 static void spapr_cpu_update_tb_offset(PowerPCCPU *cpu)
128 {
129     PowerPCCPU *fcpu = POWERPC_CPU(first_cpu);
130 
131     cpu->env.tb_env->tb_offset = fcpu->env.tb_env->tb_offset;
132 }
133 
134 static void spapr_cpu_set_endianness(PowerPCCPU *cpu)
135 {
136     PowerPCCPU *fcpu = POWERPC_CPU(first_cpu);
137     PowerPCCPUClass *pcc = POWERPC_CPU_GET_CLASS(fcpu);
138 
139     if (!pcc->interrupts_big_endian(fcpu)) {
140         cpu->env.spr[SPR_LPCR] |= LPCR_ILE;
141     }
142 }
143 
144 static void rtas_start_cpu(PowerPCCPU *callcpu, sPAPRMachineState *spapr,
145                            uint32_t token, uint32_t nargs,
146                            target_ulong args,
147                            uint32_t nret, target_ulong rets)
148 {
149     target_ulong id, start, r3;
150     PowerPCCPU *newcpu;
151     CPUPPCState *env;
152     PowerPCCPUClass *pcc;
153 
154     if (nargs != 3 || nret != 1) {
155         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
156         return;
157     }
158 
159     id = rtas_ld(args, 0);
160     start = rtas_ld(args, 1);
161     r3 = rtas_ld(args, 2);
162 
163     newcpu = spapr_find_cpu(id);
164     if (!newcpu) {
165         /* Didn't find a matching cpu */
166         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
167         return;
168     }
169 
170     env = &newcpu->env;
171     pcc = POWERPC_CPU_GET_CLASS(newcpu);
172 
173     if (!CPU(newcpu)->halted) {
174         rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
175         return;
176     }
177 
178     cpu_synchronize_state(CPU(newcpu));
179 
180     env->msr = (1ULL << MSR_SF) | (1ULL << MSR_ME);
181     spapr_cpu_set_endianness(newcpu);
182     spapr_cpu_update_tb_offset(newcpu);
183     /* Enable Power-saving mode Exit Cause exceptions for the new CPU */
184     ppc_store_lpcr(newcpu, env->spr[SPR_LPCR] | pcc->lpcr_pm);
185 
186     env->nip = start;
187     env->gpr[3] = r3;
188 
189     CPU(newcpu)->halted = 0;
190 
191     qemu_cpu_kick(CPU(newcpu));
192 
193     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
194 }
195 
196 static void rtas_stop_self(PowerPCCPU *cpu, sPAPRMachineState *spapr,
197                            uint32_t token, uint32_t nargs,
198                            target_ulong args,
199                            uint32_t nret, target_ulong rets)
200 {
201     CPUState *cs = CPU(cpu);
202     CPUPPCState *env = &cpu->env;
203     PowerPCCPUClass *pcc = POWERPC_CPU_GET_CLASS(cpu);
204 
205     /* Disable Power-saving mode Exit Cause exceptions for the CPU.
206      * This could deliver an interrupt on a dying CPU and crash the
207      * guest */
208     ppc_store_lpcr(cpu, env->spr[SPR_LPCR] & ~pcc->lpcr_pm);
209     cs->halted = 1;
210     qemu_cpu_kick(cs);
211 }
212 
213 static inline int sysparm_st(target_ulong addr, target_ulong len,
214                              const void *val, uint16_t vallen)
215 {
216     hwaddr phys = ppc64_phys_to_real(addr);
217 
218     if (len < 2) {
219         return RTAS_OUT_SYSPARM_PARAM_ERROR;
220     }
221     stw_be_phys(&address_space_memory, phys, vallen);
222     cpu_physical_memory_write(phys + 2, val, MIN(len - 2, vallen));
223     return RTAS_OUT_SUCCESS;
224 }
225 
226 static void rtas_ibm_get_system_parameter(PowerPCCPU *cpu,
227                                           sPAPRMachineState *spapr,
228                                           uint32_t token, uint32_t nargs,
229                                           target_ulong args,
230                                           uint32_t nret, target_ulong rets)
231 {
232     target_ulong parameter = rtas_ld(args, 0);
233     target_ulong buffer = rtas_ld(args, 1);
234     target_ulong length = rtas_ld(args, 2);
235     target_ulong ret;
236 
237     switch (parameter) {
238     case RTAS_SYSPARM_SPLPAR_CHARACTERISTICS: {
239         char *param_val = g_strdup_printf("MaxEntCap=%d,"
240                                           "DesMem=%llu,"
241                                           "DesProcs=%d,"
242                                           "MaxPlatProcs=%d",
243                                           max_cpus,
244                                           current_machine->ram_size / M_BYTE,
245                                           smp_cpus,
246                                           max_cpus);
247         ret = sysparm_st(buffer, length, param_val, strlen(param_val) + 1);
248         g_free(param_val);
249         break;
250     }
251     case RTAS_SYSPARM_DIAGNOSTICS_RUN_MODE: {
252         uint8_t param_val = DIAGNOSTICS_RUN_MODE_DISABLED;
253 
254         ret = sysparm_st(buffer, length, &param_val, sizeof(param_val));
255         break;
256     }
257     case RTAS_SYSPARM_UUID:
258         ret = sysparm_st(buffer, length, (unsigned char *)&qemu_uuid,
259                          (qemu_uuid_set ? 16 : 0));
260         break;
261     default:
262         ret = RTAS_OUT_NOT_SUPPORTED;
263     }
264 
265     rtas_st(rets, 0, ret);
266 }
267 
268 static void rtas_ibm_set_system_parameter(PowerPCCPU *cpu,
269                                           sPAPRMachineState *spapr,
270                                           uint32_t token, uint32_t nargs,
271                                           target_ulong args,
272                                           uint32_t nret, target_ulong rets)
273 {
274     target_ulong parameter = rtas_ld(args, 0);
275     target_ulong ret = RTAS_OUT_NOT_SUPPORTED;
276 
277     switch (parameter) {
278     case RTAS_SYSPARM_SPLPAR_CHARACTERISTICS:
279     case RTAS_SYSPARM_DIAGNOSTICS_RUN_MODE:
280     case RTAS_SYSPARM_UUID:
281         ret = RTAS_OUT_NOT_AUTHORIZED;
282         break;
283     }
284 
285     rtas_st(rets, 0, ret);
286 }
287 
288 static void rtas_ibm_os_term(PowerPCCPU *cpu,
289                             sPAPRMachineState *spapr,
290                             uint32_t token, uint32_t nargs,
291                             target_ulong args,
292                             uint32_t nret, target_ulong rets)
293 {
294     qemu_system_guest_panicked(NULL);
295 
296     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
297 }
298 
299 static void rtas_set_power_level(PowerPCCPU *cpu, sPAPRMachineState *spapr,
300                                  uint32_t token, uint32_t nargs,
301                                  target_ulong args, uint32_t nret,
302                                  target_ulong rets)
303 {
304     int32_t power_domain;
305 
306     if (nargs != 2 || nret != 2) {
307         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
308         return;
309     }
310 
311     /* we currently only use a single, "live insert" powerdomain for
312      * hotplugged/dlpar'd resources, so the power is always live/full (100)
313      */
314     power_domain = rtas_ld(args, 0);
315     if (power_domain != -1) {
316         rtas_st(rets, 0, RTAS_OUT_NOT_SUPPORTED);
317         return;
318     }
319 
320     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
321     rtas_st(rets, 1, 100);
322 }
323 
324 static void rtas_get_power_level(PowerPCCPU *cpu, sPAPRMachineState *spapr,
325                                   uint32_t token, uint32_t nargs,
326                                   target_ulong args, uint32_t nret,
327                                   target_ulong rets)
328 {
329     int32_t power_domain;
330 
331     if (nargs != 1 || nret != 2) {
332         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
333         return;
334     }
335 
336     /* we currently only use a single, "live insert" powerdomain for
337      * hotplugged/dlpar'd resources, so the power is always live/full (100)
338      */
339     power_domain = rtas_ld(args, 0);
340     if (power_domain != -1) {
341         rtas_st(rets, 0, RTAS_OUT_NOT_SUPPORTED);
342         return;
343     }
344 
345     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
346     rtas_st(rets, 1, 100);
347 }
348 
349 static struct rtas_call {
350     const char *name;
351     spapr_rtas_fn fn;
352 } rtas_table[RTAS_TOKEN_MAX - RTAS_TOKEN_BASE];
353 
354 target_ulong spapr_rtas_call(PowerPCCPU *cpu, sPAPRMachineState *spapr,
355                              uint32_t token, uint32_t nargs, target_ulong args,
356                              uint32_t nret, target_ulong rets)
357 {
358     if ((token >= RTAS_TOKEN_BASE) && (token < RTAS_TOKEN_MAX)) {
359         struct rtas_call *call = rtas_table + (token - RTAS_TOKEN_BASE);
360 
361         if (call->fn) {
362             call->fn(cpu, spapr, token, nargs, args, nret, rets);
363             return H_SUCCESS;
364         }
365     }
366 
367     /* HACK: Some Linux early debug code uses RTAS display-character,
368      * but assumes the token value is 0xa (which it is on some real
369      * machines) without looking it up in the device tree.  This
370      * special case makes this work */
371     if (token == 0xa) {
372         rtas_display_character(cpu, spapr, 0xa, nargs, args, nret, rets);
373         return H_SUCCESS;
374     }
375 
376     hcall_dprintf("Unknown RTAS token 0x%x\n", token);
377     rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
378     return H_PARAMETER;
379 }
380 
381 uint64_t qtest_rtas_call(char *cmd, uint32_t nargs, uint64_t args,
382                          uint32_t nret, uint64_t rets)
383 {
384     int token;
385 
386     for (token = 0; token < RTAS_TOKEN_MAX - RTAS_TOKEN_BASE; token++) {
387         if (strcmp(cmd, rtas_table[token].name) == 0) {
388             sPAPRMachineState *spapr = SPAPR_MACHINE(qdev_get_machine());
389             PowerPCCPU *cpu = POWERPC_CPU(first_cpu);
390 
391             rtas_table[token].fn(cpu, spapr, token + RTAS_TOKEN_BASE,
392                                  nargs, args, nret, rets);
393             return H_SUCCESS;
394         }
395     }
396     return H_PARAMETER;
397 }
398 
399 void spapr_rtas_register(int token, const char *name, spapr_rtas_fn fn)
400 {
401     assert((token >= RTAS_TOKEN_BASE) && (token < RTAS_TOKEN_MAX));
402 
403     token -= RTAS_TOKEN_BASE;
404 
405     assert(!rtas_table[token].name);
406 
407     rtas_table[token].name = name;
408     rtas_table[token].fn = fn;
409 }
410 
411 void spapr_dt_rtas_tokens(void *fdt, int rtas)
412 {
413     int i;
414 
415     for (i = 0; i < RTAS_TOKEN_MAX - RTAS_TOKEN_BASE; i++) {
416         struct rtas_call *call = &rtas_table[i];
417 
418         if (!call->name) {
419             continue;
420         }
421 
422         _FDT(fdt_setprop_cell(fdt, rtas, call->name, i + RTAS_TOKEN_BASE));
423     }
424 }
425 
426 void spapr_load_rtas(sPAPRMachineState *spapr, void *fdt, hwaddr addr)
427 {
428     int rtas_node;
429     int ret;
430 
431     /* Copy RTAS blob into guest RAM */
432     cpu_physical_memory_write(addr, spapr->rtas_blob, spapr->rtas_size);
433 
434     ret = fdt_add_mem_rsv(fdt, addr, spapr->rtas_size);
435     if (ret < 0) {
436         error_report("Couldn't add RTAS reserve entry: %s",
437                      fdt_strerror(ret));
438         exit(1);
439     }
440 
441     /* Update the device tree with the blob's location */
442     rtas_node = fdt_path_offset(fdt, "/rtas");
443     assert(rtas_node >= 0);
444 
445     ret = fdt_setprop_cell(fdt, rtas_node, "linux,rtas-base", addr);
446     if (ret < 0) {
447         error_report("Couldn't add linux,rtas-base property: %s",
448                      fdt_strerror(ret));
449         exit(1);
450     }
451 
452     ret = fdt_setprop_cell(fdt, rtas_node, "linux,rtas-entry", addr);
453     if (ret < 0) {
454         error_report("Couldn't add linux,rtas-entry property: %s",
455                      fdt_strerror(ret));
456         exit(1);
457     }
458 
459     ret = fdt_setprop_cell(fdt, rtas_node, "rtas-size", spapr->rtas_size);
460     if (ret < 0) {
461         error_report("Couldn't add rtas-size property: %s",
462                      fdt_strerror(ret));
463         exit(1);
464     }
465 }
466 
467 static void core_rtas_register_types(void)
468 {
469     spapr_rtas_register(RTAS_DISPLAY_CHARACTER, "display-character",
470                         rtas_display_character);
471     spapr_rtas_register(RTAS_POWER_OFF, "power-off", rtas_power_off);
472     spapr_rtas_register(RTAS_SYSTEM_REBOOT, "system-reboot",
473                         rtas_system_reboot);
474     spapr_rtas_register(RTAS_QUERY_CPU_STOPPED_STATE, "query-cpu-stopped-state",
475                         rtas_query_cpu_stopped_state);
476     spapr_rtas_register(RTAS_START_CPU, "start-cpu", rtas_start_cpu);
477     spapr_rtas_register(RTAS_STOP_SELF, "stop-self", rtas_stop_self);
478     spapr_rtas_register(RTAS_IBM_GET_SYSTEM_PARAMETER,
479                         "ibm,get-system-parameter",
480                         rtas_ibm_get_system_parameter);
481     spapr_rtas_register(RTAS_IBM_SET_SYSTEM_PARAMETER,
482                         "ibm,set-system-parameter",
483                         rtas_ibm_set_system_parameter);
484     spapr_rtas_register(RTAS_IBM_OS_TERM, "ibm,os-term",
485                         rtas_ibm_os_term);
486     spapr_rtas_register(RTAS_SET_POWER_LEVEL, "set-power-level",
487                         rtas_set_power_level);
488     spapr_rtas_register(RTAS_GET_POWER_LEVEL, "get-power-level",
489                         rtas_get_power_level);
490 }
491 
492 type_init(core_rtas_register_types)
493