xref: /qemu/include/hw/ppc/spapr.h (revision 30f4b05bd090564181554d0890605eb2c143e4ea)
1 #ifndef HW_SPAPR_H
2 #define HW_SPAPR_H
3 
4 #include "sysemu/dma.h"
5 #include "hw/boards.h"
6 #include "hw/ppc/xics.h"
7 #include "hw/ppc/spapr_drc.h"
8 #include "hw/mem/pc-dimm.h"
9 #include "hw/ppc/spapr_ovec.h"
10 
11 struct VIOsPAPRBus;
12 struct sPAPRPHBState;
13 struct sPAPRNVRAM;
14 typedef struct sPAPREventLogEntry sPAPREventLogEntry;
15 typedef struct sPAPREventSource sPAPREventSource;
16 
17 #define HPTE64_V_HPTE_DIRTY     0x0000000000000040ULL
18 #define SPAPR_ENTRY_POINT       0x100
19 
20 #define SPAPR_TIMEBASE_FREQ     512000000ULL
21 
22 #define TYPE_SPAPR_RTC "spapr-rtc"
23 
24 #define SPAPR_RTC(obj)                                  \
25     OBJECT_CHECK(sPAPRRTCState, (obj), TYPE_SPAPR_RTC)
26 
27 typedef struct sPAPRRTCState sPAPRRTCState;
28 struct sPAPRRTCState {
29     /*< private >*/
30     DeviceState parent_obj;
31     int64_t ns_offset;
32 };
33 
34 typedef struct sPAPRDIMMState sPAPRDIMMState;
35 typedef struct sPAPRMachineClass sPAPRMachineClass;
36 
37 #define TYPE_SPAPR_MACHINE      "spapr-machine"
38 #define SPAPR_MACHINE(obj) \
39     OBJECT_CHECK(sPAPRMachineState, (obj), TYPE_SPAPR_MACHINE)
40 #define SPAPR_MACHINE_GET_CLASS(obj) \
41     OBJECT_GET_CLASS(sPAPRMachineClass, obj, TYPE_SPAPR_MACHINE)
42 #define SPAPR_MACHINE_CLASS(klass) \
43     OBJECT_CLASS_CHECK(sPAPRMachineClass, klass, TYPE_SPAPR_MACHINE)
44 
45 typedef enum {
46     SPAPR_RESIZE_HPT_DEFAULT = 0,
47     SPAPR_RESIZE_HPT_DISABLED,
48     SPAPR_RESIZE_HPT_ENABLED,
49     SPAPR_RESIZE_HPT_REQUIRED,
50 } sPAPRResizeHPT;
51 
52 /**
53  * sPAPRMachineClass:
54  */
55 struct sPAPRMachineClass {
56     /*< private >*/
57     MachineClass parent_class;
58 
59     /*< public >*/
60     bool dr_lmb_enabled;       /* enable dynamic-reconfig/hotplug of LMBs */
61     bool use_ohci_by_default;  /* use USB-OHCI instead of XHCI */
62     const char *tcg_default_cpu; /* which (TCG) CPU to simulate by default */
63     bool pre_2_10_has_unused_icps;
64     void (*phb_placement)(sPAPRMachineState *spapr, uint32_t index,
65                           uint64_t *buid, hwaddr *pio,
66                           hwaddr *mmio32, hwaddr *mmio64,
67                           unsigned n_dma, uint32_t *liobns, Error **errp);
68     sPAPRResizeHPT resize_hpt_default;
69 };
70 
71 /**
72  * sPAPRMachineState:
73  */
74 struct sPAPRMachineState {
75     /*< private >*/
76     MachineState parent_obj;
77 
78     struct VIOsPAPRBus *vio_bus;
79     QLIST_HEAD(, sPAPRPHBState) phbs;
80     struct sPAPRNVRAM *nvram;
81     ICSState *ics;
82     sPAPRRTCState rtc;
83 
84     sPAPRResizeHPT resize_hpt;
85     void *htab;
86     uint32_t htab_shift;
87     uint64_t patb_entry; /* Process tbl registed in H_REGISTER_PROCESS_TABLE */
88     hwaddr rma_size;
89     int vrma_adjust;
90     ssize_t rtas_size;
91     void *rtas_blob;
92     long kernel_size;
93     bool kernel_le;
94     uint32_t initrd_base;
95     long initrd_size;
96     uint64_t rtc_offset; /* Now used only during incoming migration */
97     struct PPCTimebase tb;
98     bool has_graphics;
99 
100     Notifier epow_notifier;
101     QTAILQ_HEAD(, sPAPREventLogEntry) pending_events;
102     bool use_hotplug_event_source;
103     sPAPREventSource *event_sources;
104 
105     /* ibm,client-architecture-support option negotiation */
106     bool cas_reboot;
107     bool cas_legacy_guest_workaround;
108     sPAPROptionVector *ov5;         /* QEMU-supported option vectors */
109     sPAPROptionVector *ov5_cas;     /* negotiated (via CAS) option vectors */
110     uint32_t max_compat_pvr;
111 
112     /* Migration state */
113     int htab_save_index;
114     bool htab_first_pass;
115     int htab_fd;
116 
117     /* Pending DIMM unplug cache. It is populated when a LMB
118      * unplug starts. It can be regenerated if a migration
119      * occurs during the unplug process. */
120     QTAILQ_HEAD(, sPAPRDIMMState) pending_dimm_unplugs;
121 
122     /*< public >*/
123     char *kvm_type;
124     MemoryHotplugState hotplug_memory;
125 
126     const char *icp_type;
127 };
128 
129 #define H_SUCCESS         0
130 #define H_BUSY            1        /* Hardware busy -- retry later */
131 #define H_CLOSED          2        /* Resource closed */
132 #define H_NOT_AVAILABLE   3
133 #define H_CONSTRAINED     4        /* Resource request constrained to max allowed */
134 #define H_PARTIAL         5
135 #define H_IN_PROGRESS     14       /* Kind of like busy */
136 #define H_PAGE_REGISTERED 15
137 #define H_PARTIAL_STORE   16
138 #define H_PENDING         17       /* returned from H_POLL_PENDING */
139 #define H_CONTINUE        18       /* Returned from H_Join on success */
140 #define H_LONG_BUSY_START_RANGE         9900  /* Start of long busy range */
141 #define H_LONG_BUSY_ORDER_1_MSEC        9900  /* Long busy, hint that 1msec \
142                                                  is a good time to retry */
143 #define H_LONG_BUSY_ORDER_10_MSEC       9901  /* Long busy, hint that 10msec \
144                                                  is a good time to retry */
145 #define H_LONG_BUSY_ORDER_100_MSEC      9902  /* Long busy, hint that 100msec \
146                                                  is a good time to retry */
147 #define H_LONG_BUSY_ORDER_1_SEC         9903  /* Long busy, hint that 1sec \
148                                                  is a good time to retry */
149 #define H_LONG_BUSY_ORDER_10_SEC        9904  /* Long busy, hint that 10sec \
150                                                  is a good time to retry */
151 #define H_LONG_BUSY_ORDER_100_SEC       9905  /* Long busy, hint that 100sec \
152                                                  is a good time to retry */
153 #define H_LONG_BUSY_END_RANGE           9905  /* End of long busy range */
154 #define H_HARDWARE        -1       /* Hardware error */
155 #define H_FUNCTION        -2       /* Function not supported */
156 #define H_PRIVILEGE       -3       /* Caller not privileged */
157 #define H_PARAMETER       -4       /* Parameter invalid, out-of-range or conflicting */
158 #define H_BAD_MODE        -5       /* Illegal msr value */
159 #define H_PTEG_FULL       -6       /* PTEG is full */
160 #define H_NOT_FOUND       -7       /* PTE was not found" */
161 #define H_RESERVED_DABR   -8       /* DABR address is reserved by the hypervisor on this processor" */
162 #define H_NO_MEM          -9
163 #define H_AUTHORITY       -10
164 #define H_PERMISSION      -11
165 #define H_DROPPED         -12
166 #define H_SOURCE_PARM     -13
167 #define H_DEST_PARM       -14
168 #define H_REMOTE_PARM     -15
169 #define H_RESOURCE        -16
170 #define H_ADAPTER_PARM    -17
171 #define H_RH_PARM         -18
172 #define H_RCQ_PARM        -19
173 #define H_SCQ_PARM        -20
174 #define H_EQ_PARM         -21
175 #define H_RT_PARM         -22
176 #define H_ST_PARM         -23
177 #define H_SIGT_PARM       -24
178 #define H_TOKEN_PARM      -25
179 #define H_MLENGTH_PARM    -27
180 #define H_MEM_PARM        -28
181 #define H_MEM_ACCESS_PARM -29
182 #define H_ATTR_PARM       -30
183 #define H_PORT_PARM       -31
184 #define H_MCG_PARM        -32
185 #define H_VL_PARM         -33
186 #define H_TSIZE_PARM      -34
187 #define H_TRACE_PARM      -35
188 
189 #define H_MASK_PARM       -37
190 #define H_MCG_FULL        -38
191 #define H_ALIAS_EXIST     -39
192 #define H_P_COUNTER       -40
193 #define H_TABLE_FULL      -41
194 #define H_ALT_TABLE       -42
195 #define H_MR_CONDITION    -43
196 #define H_NOT_ENOUGH_RESOURCES -44
197 #define H_R_STATE         -45
198 #define H_RESCINDEND      -46
199 #define H_P2              -55
200 #define H_P3              -56
201 #define H_P4              -57
202 #define H_P5              -58
203 #define H_P6              -59
204 #define H_P7              -60
205 #define H_P8              -61
206 #define H_P9              -62
207 #define H_UNSUPPORTED_FLAG -256
208 #define H_MULTI_THREADS_ACTIVE -9005
209 
210 
211 /* Long Busy is a condition that can be returned by the firmware
212  * when a call cannot be completed now, but the identical call
213  * should be retried later.  This prevents calls blocking in the
214  * firmware for long periods of time.  Annoyingly the firmware can return
215  * a range of return codes, hinting at how long we should wait before
216  * retrying.  If you don't care for the hint, the macro below is a good
217  * way to check for the long_busy return codes
218  */
219 #define H_IS_LONG_BUSY(x)  ((x >= H_LONG_BUSY_START_RANGE) \
220                             && (x <= H_LONG_BUSY_END_RANGE))
221 
222 /* Flags */
223 #define H_LARGE_PAGE      (1ULL<<(63-16))
224 #define H_EXACT           (1ULL<<(63-24))       /* Use exact PTE or return H_PTEG_FULL */
225 #define H_R_XLATE         (1ULL<<(63-25))       /* include a valid logical page num in the pte if the valid bit is set */
226 #define H_READ_4          (1ULL<<(63-26))       /* Return 4 PTEs */
227 #define H_PAGE_STATE_CHANGE (1ULL<<(63-28))
228 #define H_PAGE_UNUSED     ((1ULL<<(63-29)) | (1ULL<<(63-30)))
229 #define H_PAGE_SET_UNUSED (H_PAGE_STATE_CHANGE | H_PAGE_UNUSED)
230 #define H_PAGE_SET_LOANED (H_PAGE_SET_UNUSED | (1ULL<<(63-31)))
231 #define H_PAGE_SET_ACTIVE H_PAGE_STATE_CHANGE
232 #define H_AVPN            (1ULL<<(63-32))       /* An avpn is provided as a sanity test */
233 #define H_ANDCOND         (1ULL<<(63-33))
234 #define H_ICACHE_INVALIDATE (1ULL<<(63-40))     /* icbi, etc.  (ignored for IO pages) */
235 #define H_ICACHE_SYNCHRONIZE (1ULL<<(63-41))    /* dcbst, icbi, etc (ignored for IO pages */
236 #define H_ZERO_PAGE       (1ULL<<(63-48))       /* zero the page before mapping (ignored for IO pages) */
237 #define H_COPY_PAGE       (1ULL<<(63-49))
238 #define H_N               (1ULL<<(63-61))
239 #define H_PP1             (1ULL<<(63-62))
240 #define H_PP2             (1ULL<<(63-63))
241 
242 /* Values for 2nd argument to H_SET_MODE */
243 #define H_SET_MODE_RESOURCE_SET_CIABR           1
244 #define H_SET_MODE_RESOURCE_SET_DAWR            2
245 #define H_SET_MODE_RESOURCE_ADDR_TRANS_MODE     3
246 #define H_SET_MODE_RESOURCE_LE                  4
247 
248 /* Flags for H_SET_MODE_RESOURCE_LE */
249 #define H_SET_MODE_ENDIAN_BIG    0
250 #define H_SET_MODE_ENDIAN_LITTLE 1
251 
252 /* VASI States */
253 #define H_VASI_INVALID    0
254 #define H_VASI_ENABLED    1
255 #define H_VASI_ABORTED    2
256 #define H_VASI_SUSPENDING 3
257 #define H_VASI_SUSPENDED  4
258 #define H_VASI_RESUMED    5
259 #define H_VASI_COMPLETED  6
260 
261 /* DABRX flags */
262 #define H_DABRX_HYPERVISOR (1ULL<<(63-61))
263 #define H_DABRX_KERNEL     (1ULL<<(63-62))
264 #define H_DABRX_USER       (1ULL<<(63-63))
265 
266 /* Each control block has to be on a 4K boundary */
267 #define H_CB_ALIGNMENT     4096
268 
269 /* pSeries hypervisor opcodes */
270 #define H_REMOVE                0x04
271 #define H_ENTER                 0x08
272 #define H_READ                  0x0c
273 #define H_CLEAR_MOD             0x10
274 #define H_CLEAR_REF             0x14
275 #define H_PROTECT               0x18
276 #define H_GET_TCE               0x1c
277 #define H_PUT_TCE               0x20
278 #define H_SET_SPRG0             0x24
279 #define H_SET_DABR              0x28
280 #define H_PAGE_INIT             0x2c
281 #define H_SET_ASR               0x30
282 #define H_ASR_ON                0x34
283 #define H_ASR_OFF               0x38
284 #define H_LOGICAL_CI_LOAD       0x3c
285 #define H_LOGICAL_CI_STORE      0x40
286 #define H_LOGICAL_CACHE_LOAD    0x44
287 #define H_LOGICAL_CACHE_STORE   0x48
288 #define H_LOGICAL_ICBI          0x4c
289 #define H_LOGICAL_DCBF          0x50
290 #define H_GET_TERM_CHAR         0x54
291 #define H_PUT_TERM_CHAR         0x58
292 #define H_REAL_TO_LOGICAL       0x5c
293 #define H_HYPERVISOR_DATA       0x60
294 #define H_EOI                   0x64
295 #define H_CPPR                  0x68
296 #define H_IPI                   0x6c
297 #define H_IPOLL                 0x70
298 #define H_XIRR                  0x74
299 #define H_PERFMON               0x7c
300 #define H_MIGRATE_DMA           0x78
301 #define H_REGISTER_VPA          0xDC
302 #define H_CEDE                  0xE0
303 #define H_CONFER                0xE4
304 #define H_PROD                  0xE8
305 #define H_GET_PPP               0xEC
306 #define H_SET_PPP               0xF0
307 #define H_PURR                  0xF4
308 #define H_PIC                   0xF8
309 #define H_REG_CRQ               0xFC
310 #define H_FREE_CRQ              0x100
311 #define H_VIO_SIGNAL            0x104
312 #define H_SEND_CRQ              0x108
313 #define H_COPY_RDMA             0x110
314 #define H_REGISTER_LOGICAL_LAN  0x114
315 #define H_FREE_LOGICAL_LAN      0x118
316 #define H_ADD_LOGICAL_LAN_BUFFER 0x11C
317 #define H_SEND_LOGICAL_LAN      0x120
318 #define H_BULK_REMOVE           0x124
319 #define H_MULTICAST_CTRL        0x130
320 #define H_SET_XDABR             0x134
321 #define H_STUFF_TCE             0x138
322 #define H_PUT_TCE_INDIRECT      0x13C
323 #define H_CHANGE_LOGICAL_LAN_MAC 0x14C
324 #define H_VTERM_PARTNER_INFO    0x150
325 #define H_REGISTER_VTERM        0x154
326 #define H_FREE_VTERM            0x158
327 #define H_RESET_EVENTS          0x15C
328 #define H_ALLOC_RESOURCE        0x160
329 #define H_FREE_RESOURCE         0x164
330 #define H_MODIFY_QP             0x168
331 #define H_QUERY_QP              0x16C
332 #define H_REREGISTER_PMR        0x170
333 #define H_REGISTER_SMR          0x174
334 #define H_QUERY_MR              0x178
335 #define H_QUERY_MW              0x17C
336 #define H_QUERY_HCA             0x180
337 #define H_QUERY_PORT            0x184
338 #define H_MODIFY_PORT           0x188
339 #define H_DEFINE_AQP1           0x18C
340 #define H_GET_TRACE_BUFFER      0x190
341 #define H_DEFINE_AQP0           0x194
342 #define H_RESIZE_MR             0x198
343 #define H_ATTACH_MCQP           0x19C
344 #define H_DETACH_MCQP           0x1A0
345 #define H_CREATE_RPT            0x1A4
346 #define H_REMOVE_RPT            0x1A8
347 #define H_REGISTER_RPAGES       0x1AC
348 #define H_DISABLE_AND_GETC      0x1B0
349 #define H_ERROR_DATA            0x1B4
350 #define H_GET_HCA_INFO          0x1B8
351 #define H_GET_PERF_COUNT        0x1BC
352 #define H_MANAGE_TRACE          0x1C0
353 #define H_FREE_LOGICAL_LAN_BUFFER 0x1D4
354 #define H_QUERY_INT_STATE       0x1E4
355 #define H_POLL_PENDING          0x1D8
356 #define H_ILLAN_ATTRIBUTES      0x244
357 #define H_MODIFY_HEA_QP         0x250
358 #define H_QUERY_HEA_QP          0x254
359 #define H_QUERY_HEA             0x258
360 #define H_QUERY_HEA_PORT        0x25C
361 #define H_MODIFY_HEA_PORT       0x260
362 #define H_REG_BCMC              0x264
363 #define H_DEREG_BCMC            0x268
364 #define H_REGISTER_HEA_RPAGES   0x26C
365 #define H_DISABLE_AND_GET_HEA   0x270
366 #define H_GET_HEA_INFO          0x274
367 #define H_ALLOC_HEA_RESOURCE    0x278
368 #define H_ADD_CONN              0x284
369 #define H_DEL_CONN              0x288
370 #define H_JOIN                  0x298
371 #define H_VASI_STATE            0x2A4
372 #define H_ENABLE_CRQ            0x2B0
373 #define H_GET_EM_PARMS          0x2B8
374 #define H_SET_MPP               0x2D0
375 #define H_GET_MPP               0x2D4
376 #define H_XIRR_X                0x2FC
377 #define H_RANDOM                0x300
378 #define H_SET_MODE              0x31C
379 #define H_RESIZE_HPT_PREPARE    0x36C
380 #define H_RESIZE_HPT_COMMIT     0x370
381 #define H_CLEAN_SLB             0x374
382 #define H_INVALIDATE_PID        0x378
383 #define H_REGISTER_PROC_TBL     0x37C
384 #define H_SIGNAL_SYS_RESET      0x380
385 #define MAX_HCALL_OPCODE        H_SIGNAL_SYS_RESET
386 
387 /* The hcalls above are standardized in PAPR and implemented by pHyp
388  * as well.
389  *
390  * We also need some hcalls which are specific to qemu / KVM-on-POWER.
391  * We put those into the 0xf000-0xfffc range which is reserved by PAPR
392  * for "platform-specific" hcalls.
393  */
394 #define KVMPPC_HCALL_BASE       0xf000
395 #define KVMPPC_H_RTAS           (KVMPPC_HCALL_BASE + 0x0)
396 #define KVMPPC_H_LOGICAL_MEMOP  (KVMPPC_HCALL_BASE + 0x1)
397 /* Client Architecture support */
398 #define KVMPPC_H_CAS            (KVMPPC_HCALL_BASE + 0x2)
399 #define KVMPPC_HCALL_MAX        KVMPPC_H_CAS
400 
401 typedef struct sPAPRDeviceTreeUpdateHeader {
402     uint32_t version_id;
403 } sPAPRDeviceTreeUpdateHeader;
404 
405 #define hcall_dprintf(fmt, ...) \
406     do { \
407         qemu_log_mask(LOG_GUEST_ERROR, "%s: " fmt, __func__, ## __VA_ARGS__); \
408     } while (0)
409 
410 typedef target_ulong (*spapr_hcall_fn)(PowerPCCPU *cpu, sPAPRMachineState *sm,
411                                        target_ulong opcode,
412                                        target_ulong *args);
413 
414 void spapr_register_hypercall(target_ulong opcode, spapr_hcall_fn fn);
415 target_ulong spapr_hypercall(PowerPCCPU *cpu, target_ulong opcode,
416                              target_ulong *args);
417 
418 /* ibm,set-eeh-option */
419 #define RTAS_EEH_DISABLE                 0
420 #define RTAS_EEH_ENABLE                  1
421 #define RTAS_EEH_THAW_IO                 2
422 #define RTAS_EEH_THAW_DMA                3
423 
424 /* ibm,get-config-addr-info2 */
425 #define RTAS_GET_PE_ADDR                 0
426 #define RTAS_GET_PE_MODE                 1
427 #define RTAS_PE_MODE_NONE                0
428 #define RTAS_PE_MODE_NOT_SHARED          1
429 #define RTAS_PE_MODE_SHARED              2
430 
431 /* ibm,read-slot-reset-state2 */
432 #define RTAS_EEH_PE_STATE_NORMAL         0
433 #define RTAS_EEH_PE_STATE_RESET          1
434 #define RTAS_EEH_PE_STATE_STOPPED_IO_DMA 2
435 #define RTAS_EEH_PE_STATE_STOPPED_DMA    4
436 #define RTAS_EEH_PE_STATE_UNAVAIL        5
437 #define RTAS_EEH_NOT_SUPPORT             0
438 #define RTAS_EEH_SUPPORT                 1
439 #define RTAS_EEH_PE_UNAVAIL_INFO         1000
440 #define RTAS_EEH_PE_RECOVER_INFO         0
441 
442 /* ibm,set-slot-reset */
443 #define RTAS_SLOT_RESET_DEACTIVATE       0
444 #define RTAS_SLOT_RESET_HOT              1
445 #define RTAS_SLOT_RESET_FUNDAMENTAL      3
446 
447 /* ibm,slot-error-detail */
448 #define RTAS_SLOT_TEMP_ERR_LOG           1
449 #define RTAS_SLOT_PERM_ERR_LOG           2
450 
451 /* RTAS return codes */
452 #define RTAS_OUT_SUCCESS                        0
453 #define RTAS_OUT_NO_ERRORS_FOUND                1
454 #define RTAS_OUT_HW_ERROR                       -1
455 #define RTAS_OUT_BUSY                           -2
456 #define RTAS_OUT_PARAM_ERROR                    -3
457 #define RTAS_OUT_NOT_SUPPORTED                  -3
458 #define RTAS_OUT_NO_SUCH_INDICATOR              -3
459 #define RTAS_OUT_NOT_AUTHORIZED                 -9002
460 #define RTAS_OUT_SYSPARM_PARAM_ERROR            -9999
461 
462 /* DDW pagesize mask values from ibm,query-pe-dma-window */
463 #define RTAS_DDW_PGSIZE_4K       0x01
464 #define RTAS_DDW_PGSIZE_64K      0x02
465 #define RTAS_DDW_PGSIZE_16M      0x04
466 #define RTAS_DDW_PGSIZE_32M      0x08
467 #define RTAS_DDW_PGSIZE_64M      0x10
468 #define RTAS_DDW_PGSIZE_128M     0x20
469 #define RTAS_DDW_PGSIZE_256M     0x40
470 #define RTAS_DDW_PGSIZE_16G      0x80
471 
472 /* RTAS tokens */
473 #define RTAS_TOKEN_BASE      0x2000
474 
475 #define RTAS_DISPLAY_CHARACTER                  (RTAS_TOKEN_BASE + 0x00)
476 #define RTAS_GET_TIME_OF_DAY                    (RTAS_TOKEN_BASE + 0x01)
477 #define RTAS_SET_TIME_OF_DAY                    (RTAS_TOKEN_BASE + 0x02)
478 #define RTAS_POWER_OFF                          (RTAS_TOKEN_BASE + 0x03)
479 #define RTAS_SYSTEM_REBOOT                      (RTAS_TOKEN_BASE + 0x04)
480 #define RTAS_QUERY_CPU_STOPPED_STATE            (RTAS_TOKEN_BASE + 0x05)
481 #define RTAS_START_CPU                          (RTAS_TOKEN_BASE + 0x06)
482 #define RTAS_STOP_SELF                          (RTAS_TOKEN_BASE + 0x07)
483 #define RTAS_IBM_GET_SYSTEM_PARAMETER           (RTAS_TOKEN_BASE + 0x08)
484 #define RTAS_IBM_SET_SYSTEM_PARAMETER           (RTAS_TOKEN_BASE + 0x09)
485 #define RTAS_IBM_SET_XIVE                       (RTAS_TOKEN_BASE + 0x0A)
486 #define RTAS_IBM_GET_XIVE                       (RTAS_TOKEN_BASE + 0x0B)
487 #define RTAS_IBM_INT_OFF                        (RTAS_TOKEN_BASE + 0x0C)
488 #define RTAS_IBM_INT_ON                         (RTAS_TOKEN_BASE + 0x0D)
489 #define RTAS_CHECK_EXCEPTION                    (RTAS_TOKEN_BASE + 0x0E)
490 #define RTAS_EVENT_SCAN                         (RTAS_TOKEN_BASE + 0x0F)
491 #define RTAS_IBM_SET_TCE_BYPASS                 (RTAS_TOKEN_BASE + 0x10)
492 #define RTAS_QUIESCE                            (RTAS_TOKEN_BASE + 0x11)
493 #define RTAS_NVRAM_FETCH                        (RTAS_TOKEN_BASE + 0x12)
494 #define RTAS_NVRAM_STORE                        (RTAS_TOKEN_BASE + 0x13)
495 #define RTAS_READ_PCI_CONFIG                    (RTAS_TOKEN_BASE + 0x14)
496 #define RTAS_WRITE_PCI_CONFIG                   (RTAS_TOKEN_BASE + 0x15)
497 #define RTAS_IBM_READ_PCI_CONFIG                (RTAS_TOKEN_BASE + 0x16)
498 #define RTAS_IBM_WRITE_PCI_CONFIG               (RTAS_TOKEN_BASE + 0x17)
499 #define RTAS_IBM_QUERY_INTERRUPT_SOURCE_NUMBER  (RTAS_TOKEN_BASE + 0x18)
500 #define RTAS_IBM_CHANGE_MSI                     (RTAS_TOKEN_BASE + 0x19)
501 #define RTAS_SET_INDICATOR                      (RTAS_TOKEN_BASE + 0x1A)
502 #define RTAS_SET_POWER_LEVEL                    (RTAS_TOKEN_BASE + 0x1B)
503 #define RTAS_GET_POWER_LEVEL                    (RTAS_TOKEN_BASE + 0x1C)
504 #define RTAS_GET_SENSOR_STATE                   (RTAS_TOKEN_BASE + 0x1D)
505 #define RTAS_IBM_CONFIGURE_CONNECTOR            (RTAS_TOKEN_BASE + 0x1E)
506 #define RTAS_IBM_OS_TERM                        (RTAS_TOKEN_BASE + 0x1F)
507 #define RTAS_IBM_SET_EEH_OPTION                 (RTAS_TOKEN_BASE + 0x20)
508 #define RTAS_IBM_GET_CONFIG_ADDR_INFO2          (RTAS_TOKEN_BASE + 0x21)
509 #define RTAS_IBM_READ_SLOT_RESET_STATE2         (RTAS_TOKEN_BASE + 0x22)
510 #define RTAS_IBM_SET_SLOT_RESET                 (RTAS_TOKEN_BASE + 0x23)
511 #define RTAS_IBM_CONFIGURE_PE                   (RTAS_TOKEN_BASE + 0x24)
512 #define RTAS_IBM_SLOT_ERROR_DETAIL              (RTAS_TOKEN_BASE + 0x25)
513 #define RTAS_IBM_QUERY_PE_DMA_WINDOW            (RTAS_TOKEN_BASE + 0x26)
514 #define RTAS_IBM_CREATE_PE_DMA_WINDOW           (RTAS_TOKEN_BASE + 0x27)
515 #define RTAS_IBM_REMOVE_PE_DMA_WINDOW           (RTAS_TOKEN_BASE + 0x28)
516 #define RTAS_IBM_RESET_PE_DMA_WINDOW            (RTAS_TOKEN_BASE + 0x29)
517 
518 #define RTAS_TOKEN_MAX                          (RTAS_TOKEN_BASE + 0x2A)
519 
520 /* RTAS ibm,get-system-parameter token values */
521 #define RTAS_SYSPARM_SPLPAR_CHARACTERISTICS      20
522 #define RTAS_SYSPARM_DIAGNOSTICS_RUN_MODE        42
523 #define RTAS_SYSPARM_UUID                        48
524 
525 /* RTAS indicator/sensor types
526  *
527  * as defined by PAPR+ 2.7 7.3.5.4, Table 41
528  *
529  * NOTE: currently only DR-related sensors are implemented here
530  */
531 #define RTAS_SENSOR_TYPE_ISOLATION_STATE        9001
532 #define RTAS_SENSOR_TYPE_DR                     9002
533 #define RTAS_SENSOR_TYPE_ALLOCATION_STATE       9003
534 #define RTAS_SENSOR_TYPE_ENTITY_SENSE RTAS_SENSOR_TYPE_ALLOCATION_STATE
535 
536 /* Possible values for the platform-processor-diagnostics-run-mode parameter
537  * of the RTAS ibm,get-system-parameter call.
538  */
539 #define DIAGNOSTICS_RUN_MODE_DISABLED  0
540 #define DIAGNOSTICS_RUN_MODE_STAGGERED 1
541 #define DIAGNOSTICS_RUN_MODE_IMMEDIATE 2
542 #define DIAGNOSTICS_RUN_MODE_PERIODIC  3
543 
544 static inline uint64_t ppc64_phys_to_real(uint64_t addr)
545 {
546     return addr & ~0xF000000000000000ULL;
547 }
548 
549 static inline uint32_t rtas_ld(target_ulong phys, int n)
550 {
551     return ldl_be_phys(&address_space_memory, ppc64_phys_to_real(phys + 4*n));
552 }
553 
554 static inline uint64_t rtas_ldq(target_ulong phys, int n)
555 {
556     return (uint64_t)rtas_ld(phys, n) << 32 | rtas_ld(phys, n + 1);
557 }
558 
559 static inline void rtas_st(target_ulong phys, int n, uint32_t val)
560 {
561     stl_be_phys(&address_space_memory, ppc64_phys_to_real(phys + 4*n), val);
562 }
563 
564 typedef void (*spapr_rtas_fn)(PowerPCCPU *cpu, sPAPRMachineState *sm,
565                               uint32_t token,
566                               uint32_t nargs, target_ulong args,
567                               uint32_t nret, target_ulong rets);
568 void spapr_rtas_register(int token, const char *name, spapr_rtas_fn fn);
569 target_ulong spapr_rtas_call(PowerPCCPU *cpu, sPAPRMachineState *sm,
570                              uint32_t token, uint32_t nargs, target_ulong args,
571                              uint32_t nret, target_ulong rets);
572 void spapr_dt_rtas_tokens(void *fdt, int rtas);
573 void spapr_load_rtas(sPAPRMachineState *spapr, void *fdt, hwaddr addr);
574 
575 #define SPAPR_TCE_PAGE_SHIFT   12
576 #define SPAPR_TCE_PAGE_SIZE    (1ULL << SPAPR_TCE_PAGE_SHIFT)
577 #define SPAPR_TCE_PAGE_MASK    (SPAPR_TCE_PAGE_SIZE - 1)
578 
579 #define SPAPR_VIO_BASE_LIOBN    0x00000000
580 #define SPAPR_VIO_LIOBN(reg)    (0x00000000 | (reg))
581 #define SPAPR_PCI_LIOBN(phb_index, window_num) \
582     (0x80000000 | ((phb_index) << 8) | (window_num))
583 #define SPAPR_IS_PCI_LIOBN(liobn)   (!!((liobn) & 0x80000000))
584 #define SPAPR_PCI_DMA_WINDOW_NUM(liobn) ((liobn) & 0xff)
585 
586 #define RTAS_ERROR_LOG_MAX      2048
587 
588 #define RTAS_EVENT_SCAN_RATE    1
589 
590 typedef struct sPAPRTCETable sPAPRTCETable;
591 
592 #define TYPE_SPAPR_TCE_TABLE "spapr-tce-table"
593 #define SPAPR_TCE_TABLE(obj) \
594     OBJECT_CHECK(sPAPRTCETable, (obj), TYPE_SPAPR_TCE_TABLE)
595 
596 #define TYPE_SPAPR_IOMMU_MEMORY_REGION "spapr-iommu-memory-region"
597 #define SPAPR_IOMMU_MEMORY_REGION(obj) \
598         OBJECT_CHECK(IOMMUMemoryRegion, (obj), TYPE_SPAPR_IOMMU_MEMORY_REGION)
599 
600 struct sPAPRTCETable {
601     DeviceState parent;
602     uint32_t liobn;
603     uint32_t nb_table;
604     uint64_t bus_offset;
605     uint32_t page_shift;
606     uint64_t *table;
607     uint32_t mig_nb_table;
608     uint64_t *mig_table;
609     bool bypass;
610     bool need_vfio;
611     int fd;
612     MemoryRegion root;
613     IOMMUMemoryRegion iommu;
614     struct VIOsPAPRDevice *vdev; /* for @bypass migration compatibility only */
615     QLIST_ENTRY(sPAPRTCETable) list;
616 };
617 
618 sPAPRTCETable *spapr_tce_find_by_liobn(target_ulong liobn);
619 
620 struct sPAPREventLogEntry {
621     uint32_t summary;
622     uint32_t extended_length;
623     void *extended_log;
624     QTAILQ_ENTRY(sPAPREventLogEntry) next;
625 };
626 
627 void spapr_events_init(sPAPRMachineState *sm);
628 void spapr_dt_events(sPAPRMachineState *sm, void *fdt);
629 int spapr_h_cas_compose_response(sPAPRMachineState *sm,
630                                  target_ulong addr, target_ulong size,
631                                  sPAPROptionVector *ov5_updates);
632 void close_htab_fd(sPAPRMachineState *spapr);
633 void spapr_setup_hpt_and_vrma(sPAPRMachineState *spapr);
634 void spapr_free_hpt(sPAPRMachineState *spapr);
635 sPAPRTCETable *spapr_tce_new_table(DeviceState *owner, uint32_t liobn);
636 void spapr_tce_table_enable(sPAPRTCETable *tcet,
637                             uint32_t page_shift, uint64_t bus_offset,
638                             uint32_t nb_table);
639 void spapr_tce_table_disable(sPAPRTCETable *tcet);
640 void spapr_tce_set_need_vfio(sPAPRTCETable *tcet, bool need_vfio);
641 
642 MemoryRegion *spapr_tce_get_iommu(sPAPRTCETable *tcet);
643 int spapr_dma_dt(void *fdt, int node_off, const char *propname,
644                  uint32_t liobn, uint64_t window, uint32_t size);
645 int spapr_tcet_dma_dt(void *fdt, int node_off, const char *propname,
646                       sPAPRTCETable *tcet);
647 void spapr_pci_switch_vga(bool big_endian);
648 void spapr_hotplug_req_add_by_index(sPAPRDRConnector *drc);
649 void spapr_hotplug_req_remove_by_index(sPAPRDRConnector *drc);
650 void spapr_hotplug_req_add_by_count(sPAPRDRConnectorType drc_type,
651                                        uint32_t count);
652 void spapr_hotplug_req_remove_by_count(sPAPRDRConnectorType drc_type,
653                                           uint32_t count);
654 void spapr_hotplug_req_add_by_count_indexed(sPAPRDRConnectorType drc_type,
655                                             uint32_t count, uint32_t index);
656 void spapr_hotplug_req_remove_by_count_indexed(sPAPRDRConnectorType drc_type,
657                                                uint32_t count, uint32_t index);
658 void spapr_cpu_parse_features(sPAPRMachineState *spapr);
659 
660 /* CPU and LMB DRC release callbacks. */
661 void spapr_core_release(DeviceState *dev);
662 void spapr_lmb_release(DeviceState *dev);
663 
664 void spapr_rtc_read(sPAPRRTCState *rtc, struct tm *tm, uint32_t *ns);
665 int spapr_rtc_import_offset(sPAPRRTCState *rtc, int64_t legacy_offset);
666 
667 #define TYPE_SPAPR_RNG "spapr-rng"
668 
669 int spapr_rng_populate_dt(void *fdt);
670 
671 #define SPAPR_MEMORY_BLOCK_SIZE (1 << 28) /* 256MB */
672 
673 /*
674  * This defines the maximum number of DIMM slots we can have for sPAPR
675  * guest. This is not defined by sPAPR but we are defining it to 32 slots
676  * based on default number of slots provided by PowerPC kernel.
677  */
678 #define SPAPR_MAX_RAM_SLOTS     32
679 
680 /* 1GB alignment for hotplug memory region */
681 #define SPAPR_HOTPLUG_MEM_ALIGN (1ULL << 30)
682 
683 /*
684  * Number of 32 bit words in each LMB list entry in ibm,dynamic-memory
685  * property under ibm,dynamic-reconfiguration-memory node.
686  */
687 #define SPAPR_DR_LMB_LIST_ENTRY_SIZE 6
688 
689 /*
690  * Defines for flag value in ibm,dynamic-memory property under
691  * ibm,dynamic-reconfiguration-memory node.
692  */
693 #define SPAPR_LMB_FLAGS_ASSIGNED 0x00000008
694 #define SPAPR_LMB_FLAGS_DRC_INVALID 0x00000020
695 #define SPAPR_LMB_FLAGS_RESERVED 0x00000080
696 
697 void spapr_do_system_reset_on_cpu(CPUState *cs, run_on_cpu_data arg);
698 
699 #endif /* HW_SPAPR_H */
700