xref: /openbmc/qemu/hw/ppc/spapr_rtas.c (revision 3a3b8502e6f0c8d30865c5f36d2c3ae4114000b5)
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 "cpu.h"
28 #include "sysemu/sysemu.h"
29 #include "sysemu/char.h"
30 #include "hw/qdev.h"
31 #include "sysemu/device_tree.h"
32 
33 #include "hw/ppc/spapr.h"
34 #include "hw/ppc/spapr_vio.h"
35 #include "qapi-event.h"
36 
37 #include <libfdt.h>
38 
39 static void rtas_display_character(PowerPCCPU *cpu, sPAPREnvironment *spapr,
40                                    uint32_t token, uint32_t nargs,
41                                    target_ulong args,
42                                    uint32_t nret, target_ulong rets)
43 {
44     uint8_t c = rtas_ld(args, 0);
45     VIOsPAPRDevice *sdev = vty_lookup(spapr, 0);
46 
47     if (!sdev) {
48         rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
49     } else {
50         vty_putchars(sdev, &c, sizeof(c));
51         rtas_st(rets, 0, RTAS_OUT_SUCCESS);
52     }
53 }
54 
55 static void rtas_get_time_of_day(PowerPCCPU *cpu, sPAPREnvironment *spapr,
56                                  uint32_t token, uint32_t nargs,
57                                  target_ulong args,
58                                  uint32_t nret, target_ulong rets)
59 {
60     struct tm tm;
61 
62     if (nret != 8) {
63         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
64         return;
65     }
66 
67     qemu_get_timedate(&tm, spapr->rtc_offset);
68 
69     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
70     rtas_st(rets, 1, tm.tm_year + 1900);
71     rtas_st(rets, 2, tm.tm_mon + 1);
72     rtas_st(rets, 3, tm.tm_mday);
73     rtas_st(rets, 4, tm.tm_hour);
74     rtas_st(rets, 5, tm.tm_min);
75     rtas_st(rets, 6, tm.tm_sec);
76     rtas_st(rets, 7, 0); /* we don't do nanoseconds */
77 }
78 
79 static void rtas_set_time_of_day(PowerPCCPU *cpu, sPAPREnvironment *spapr,
80                                  uint32_t token, uint32_t nargs,
81                                  target_ulong args,
82                                  uint32_t nret, target_ulong rets)
83 {
84     struct tm tm;
85 
86     tm.tm_year = rtas_ld(args, 0) - 1900;
87     tm.tm_mon = rtas_ld(args, 1) - 1;
88     tm.tm_mday = rtas_ld(args, 2);
89     tm.tm_hour = rtas_ld(args, 3);
90     tm.tm_min = rtas_ld(args, 4);
91     tm.tm_sec = rtas_ld(args, 5);
92 
93     /* Just generate a monitor event for the change */
94     qapi_event_send_rtc_change(qemu_timedate_diff(&tm), &error_abort);
95     spapr->rtc_offset = qemu_timedate_diff(&tm);
96 
97     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
98 }
99 
100 static void rtas_power_off(PowerPCCPU *cpu, sPAPREnvironment *spapr,
101                            uint32_t token, uint32_t nargs, target_ulong args,
102                            uint32_t nret, target_ulong rets)
103 {
104     if (nargs != 2 || nret != 1) {
105         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
106         return;
107     }
108     qemu_system_shutdown_request();
109     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
110 }
111 
112 static void rtas_system_reboot(PowerPCCPU *cpu, sPAPREnvironment *spapr,
113                                uint32_t token, uint32_t nargs,
114                                target_ulong args,
115                                uint32_t nret, target_ulong rets)
116 {
117     if (nargs != 0 || nret != 1) {
118         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
119         return;
120     }
121     qemu_system_reset_request();
122     rtas_st(rets, 0, RTAS_OUT_SUCCESS);
123 }
124 
125 static void rtas_query_cpu_stopped_state(PowerPCCPU *cpu_,
126                                          sPAPREnvironment *spapr,
127                                          uint32_t token, uint32_t nargs,
128                                          target_ulong args,
129                                          uint32_t nret, target_ulong rets)
130 {
131     target_ulong id;
132     PowerPCCPU *cpu;
133 
134     if (nargs != 1 || nret != 2) {
135         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
136         return;
137     }
138 
139     id = rtas_ld(args, 0);
140     cpu = ppc_get_vcpu_by_dt_id(id);
141     if (cpu != NULL) {
142         if (CPU(cpu)->halted) {
143             rtas_st(rets, 1, 0);
144         } else {
145             rtas_st(rets, 1, 2);
146         }
147 
148         rtas_st(rets, 0, RTAS_OUT_SUCCESS);
149         return;
150     }
151 
152     /* Didn't find a matching cpu */
153     rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
154 }
155 
156 static void rtas_start_cpu(PowerPCCPU *cpu_, sPAPREnvironment *spapr,
157                            uint32_t token, uint32_t nargs,
158                            target_ulong args,
159                            uint32_t nret, target_ulong rets)
160 {
161     target_ulong id, start, r3;
162     PowerPCCPU *cpu;
163 
164     if (nargs != 3 || nret != 1) {
165         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
166         return;
167     }
168 
169     id = rtas_ld(args, 0);
170     start = rtas_ld(args, 1);
171     r3 = rtas_ld(args, 2);
172 
173     cpu = ppc_get_vcpu_by_dt_id(id);
174     if (cpu != NULL) {
175         CPUState *cs = CPU(cpu);
176         CPUPPCState *env = &cpu->env;
177 
178         if (!cs->halted) {
179             rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
180             return;
181         }
182 
183         /* This will make sure qemu state is up to date with kvm, and
184          * mark it dirty so our changes get flushed back before the
185          * new cpu enters */
186         kvm_cpu_synchronize_state(cs);
187 
188         env->msr = (1ULL << MSR_SF) | (1ULL << MSR_ME);
189         env->nip = start;
190         env->gpr[3] = r3;
191         cs->halted = 0;
192 
193         qemu_cpu_kick(cs);
194 
195         rtas_st(rets, 0, RTAS_OUT_SUCCESS);
196         return;
197     }
198 
199     /* Didn't find a matching cpu */
200     rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
201 }
202 
203 static void rtas_stop_self(PowerPCCPU *cpu, sPAPREnvironment *spapr,
204                            uint32_t token, uint32_t nargs,
205                            target_ulong args,
206                            uint32_t nret, target_ulong rets)
207 {
208     CPUState *cs = CPU(cpu);
209     CPUPPCState *env = &cpu->env;
210 
211     cs->halted = 1;
212     cpu_exit(cs);
213     /*
214      * While stopping a CPU, the guest calls H_CPPR which
215      * effectively disables interrupts on XICS level.
216      * However decrementer interrupts in TCG can still
217      * wake the CPU up so here we disable interrupts in MSR
218      * as well.
219      * As rtas_start_cpu() resets the whole MSR anyway, there is
220      * no need to bother with specific bits, we just clear it.
221      */
222     env->msr = 0;
223 }
224 
225 #define DIAGNOSTICS_RUN_MODE        42
226 
227 static void rtas_ibm_get_system_parameter(PowerPCCPU *cpu,
228                                           sPAPREnvironment *spapr,
229                                           uint32_t token, uint32_t nargs,
230                                           target_ulong args,
231                                           uint32_t nret, target_ulong rets)
232 {
233     target_ulong parameter = rtas_ld(args, 0);
234     target_ulong buffer = rtas_ld(args, 1);
235     target_ulong length = rtas_ld(args, 2);
236     target_ulong ret = RTAS_OUT_NOT_SUPPORTED;
237 
238     switch (parameter) {
239     case DIAGNOSTICS_RUN_MODE:
240         if (length == 1) {
241             rtas_st(buffer, 0, 0);
242             ret = RTAS_OUT_SUCCESS;
243         }
244         break;
245     }
246 
247     rtas_st(rets, 0, ret);
248 }
249 
250 static void rtas_ibm_set_system_parameter(PowerPCCPU *cpu,
251                                           sPAPREnvironment *spapr,
252                                           uint32_t token, uint32_t nargs,
253                                           target_ulong args,
254                                           uint32_t nret, target_ulong rets)
255 {
256     target_ulong parameter = rtas_ld(args, 0);
257     target_ulong ret = RTAS_OUT_NOT_SUPPORTED;
258 
259     switch (parameter) {
260     case DIAGNOSTICS_RUN_MODE:
261         ret = RTAS_OUT_NOT_AUTHORIZED;
262         break;
263     }
264 
265     rtas_st(rets, 0, ret);
266 }
267 
268 static struct rtas_call {
269     const char *name;
270     spapr_rtas_fn fn;
271 } rtas_table[RTAS_TOKEN_MAX - RTAS_TOKEN_BASE];
272 
273 target_ulong spapr_rtas_call(PowerPCCPU *cpu, sPAPREnvironment *spapr,
274                              uint32_t token, uint32_t nargs, target_ulong args,
275                              uint32_t nret, target_ulong rets)
276 {
277     if ((token >= RTAS_TOKEN_BASE) && (token < RTAS_TOKEN_MAX)) {
278         struct rtas_call *call = rtas_table + (token - RTAS_TOKEN_BASE);
279 
280         if (call->fn) {
281             call->fn(cpu, spapr, token, nargs, args, nret, rets);
282             return H_SUCCESS;
283         }
284     }
285 
286     /* HACK: Some Linux early debug code uses RTAS display-character,
287      * but assumes the token value is 0xa (which it is on some real
288      * machines) without looking it up in the device tree.  This
289      * special case makes this work */
290     if (token == 0xa) {
291         rtas_display_character(cpu, spapr, 0xa, nargs, args, nret, rets);
292         return H_SUCCESS;
293     }
294 
295     hcall_dprintf("Unknown RTAS token 0x%x\n", token);
296     rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
297     return H_PARAMETER;
298 }
299 
300 void spapr_rtas_register(int token, const char *name, spapr_rtas_fn fn)
301 {
302     if (!((token >= RTAS_TOKEN_BASE) && (token < RTAS_TOKEN_MAX))) {
303         fprintf(stderr, "RTAS invalid token 0x%x\n", token);
304         exit(1);
305     }
306 
307     token -= RTAS_TOKEN_BASE;
308     if (rtas_table[token].name) {
309         fprintf(stderr, "RTAS call \"%s\" is registered already as 0x%x\n",
310                 rtas_table[token].name, token);
311         exit(1);
312     }
313 
314     rtas_table[token].name = name;
315     rtas_table[token].fn = fn;
316 }
317 
318 int spapr_rtas_device_tree_setup(void *fdt, hwaddr rtas_addr,
319                                  hwaddr rtas_size)
320 {
321     int ret;
322     int i;
323 
324     ret = fdt_add_mem_rsv(fdt, rtas_addr, rtas_size);
325     if (ret < 0) {
326         fprintf(stderr, "Couldn't add RTAS reserve entry: %s\n",
327                 fdt_strerror(ret));
328         return ret;
329     }
330 
331     ret = qemu_fdt_setprop_cell(fdt, "/rtas", "linux,rtas-base",
332                                 rtas_addr);
333     if (ret < 0) {
334         fprintf(stderr, "Couldn't add linux,rtas-base property: %s\n",
335                 fdt_strerror(ret));
336         return ret;
337     }
338 
339     ret = qemu_fdt_setprop_cell(fdt, "/rtas", "linux,rtas-entry",
340                                 rtas_addr);
341     if (ret < 0) {
342         fprintf(stderr, "Couldn't add linux,rtas-entry property: %s\n",
343                 fdt_strerror(ret));
344         return ret;
345     }
346 
347     ret = qemu_fdt_setprop_cell(fdt, "/rtas", "rtas-size",
348                                 rtas_size);
349     if (ret < 0) {
350         fprintf(stderr, "Couldn't add rtas-size property: %s\n",
351                 fdt_strerror(ret));
352         return ret;
353     }
354 
355     for (i = 0; i < RTAS_TOKEN_MAX - RTAS_TOKEN_BASE; i++) {
356         struct rtas_call *call = &rtas_table[i];
357 
358         if (!call->name) {
359             continue;
360         }
361 
362         ret = qemu_fdt_setprop_cell(fdt, "/rtas", call->name,
363                                     i + RTAS_TOKEN_BASE);
364         if (ret < 0) {
365             fprintf(stderr, "Couldn't add rtas token for %s: %s\n",
366                     call->name, fdt_strerror(ret));
367             return ret;
368         }
369 
370     }
371     return 0;
372 }
373 
374 static void core_rtas_register_types(void)
375 {
376     spapr_rtas_register(RTAS_DISPLAY_CHARACTER, "display-character",
377                         rtas_display_character);
378     spapr_rtas_register(RTAS_GET_TIME_OF_DAY, "get-time-of-day",
379                         rtas_get_time_of_day);
380     spapr_rtas_register(RTAS_SET_TIME_OF_DAY, "set-time-of-day",
381                         rtas_set_time_of_day);
382     spapr_rtas_register(RTAS_POWER_OFF, "power-off", rtas_power_off);
383     spapr_rtas_register(RTAS_SYSTEM_REBOOT, "system-reboot",
384                         rtas_system_reboot);
385     spapr_rtas_register(RTAS_QUERY_CPU_STOPPED_STATE, "query-cpu-stopped-state",
386                         rtas_query_cpu_stopped_state);
387     spapr_rtas_register(RTAS_START_CPU, "start-cpu", rtas_start_cpu);
388     spapr_rtas_register(RTAS_STOP_SELF, "stop-self", rtas_stop_self);
389     spapr_rtas_register(RTAS_IBM_GET_SYSTEM_PARAMETER,
390                         "ibm,get-system-parameter",
391                         rtas_ibm_get_system_parameter);
392     spapr_rtas_register(RTAS_IBM_SET_SYSTEM_PARAMETER,
393                         "ibm,set-system-parameter",
394                         rtas_ibm_set_system_parameter);
395 }
396 
397 type_init(core_rtas_register_types)
398