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