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