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