xref: /openbmc/qemu/include/hw/ppc/spapr.h (revision e4082063)
1 #ifndef HW_SPAPR_H
2 #define HW_SPAPR_H
3 
4 #include "qemu/units.h"
5 #include "sysemu/dma.h"
6 #include "hw/boards.h"
7 #include "hw/ppc/spapr_drc.h"
8 #include "hw/mem/pc-dimm.h"
9 #include "hw/ppc/spapr_ovec.h"
10 #include "hw/ppc/spapr_irq.h"
11 #include "qom/object.h"
12 #include "hw/ppc/spapr_xive.h"  /* For SpaprXive */
13 #include "hw/ppc/xics.h"        /* For ICSState */
14 #include "hw/ppc/spapr_tpm_proxy.h"
15 #include "hw/ppc/vof.h"
16 
17 struct SpaprVioBus;
18 struct SpaprPhbState;
19 struct SpaprNvram;
20 
21 typedef struct SpaprEventLogEntry SpaprEventLogEntry;
22 typedef struct SpaprEventSource SpaprEventSource;
23 typedef struct SpaprPendingHpt SpaprPendingHpt;
24 
25 #define HPTE64_V_HPTE_DIRTY     0x0000000000000040ULL
26 #define SPAPR_ENTRY_POINT       0x100
27 
28 #define SPAPR_TIMEBASE_FREQ     512000000ULL
29 
30 #define TYPE_SPAPR_RTC "spapr-rtc"
31 
32 OBJECT_DECLARE_SIMPLE_TYPE(SpaprRtcState, SPAPR_RTC)
33 
34 struct SpaprRtcState {
35     /*< private >*/
36     DeviceState parent_obj;
37     int64_t ns_offset;
38 };
39 
40 typedef struct SpaprDimmState SpaprDimmState;
41 
42 #define TYPE_SPAPR_MACHINE      "spapr-machine"
43 OBJECT_DECLARE_TYPE(SpaprMachineState, SpaprMachineClass, 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  * Capabilities
54  */
55 
56 /* Hardware Transactional Memory */
57 #define SPAPR_CAP_HTM                   0x00
58 /* Vector Scalar Extensions */
59 #define SPAPR_CAP_VSX                   0x01
60 /* Decimal Floating Point */
61 #define SPAPR_CAP_DFP                   0x02
62 /* Cache Flush on Privilege Change */
63 #define SPAPR_CAP_CFPC                  0x03
64 /* Speculation Barrier Bounds Checking */
65 #define SPAPR_CAP_SBBC                  0x04
66 /* Indirect Branch Serialisation */
67 #define SPAPR_CAP_IBS                   0x05
68 /* HPT Maximum Page Size (encoded as a shift) */
69 #define SPAPR_CAP_HPT_MAXPAGESIZE       0x06
70 /* Nested KVM-HV */
71 #define SPAPR_CAP_NESTED_KVM_HV         0x07
72 /* Large Decrementer */
73 #define SPAPR_CAP_LARGE_DECREMENTER     0x08
74 /* Count Cache Flush Assist HW Instruction */
75 #define SPAPR_CAP_CCF_ASSIST            0x09
76 /* Implements PAPR FWNMI option */
77 #define SPAPR_CAP_FWNMI                 0x0A
78 /* Support H_RPT_INVALIDATE */
79 #define SPAPR_CAP_RPT_INVALIDATE        0x0B
80 /* Num Caps */
81 #define SPAPR_CAP_NUM                   (SPAPR_CAP_RPT_INVALIDATE + 1)
82 
83 /*
84  * Capability Values
85  */
86 /* Bool Caps */
87 #define SPAPR_CAP_OFF                   0x00
88 #define SPAPR_CAP_ON                    0x01
89 
90 /* Custom Caps */
91 
92 /* Generic */
93 #define SPAPR_CAP_BROKEN                0x00
94 #define SPAPR_CAP_WORKAROUND            0x01
95 #define SPAPR_CAP_FIXED                 0x02
96 /* SPAPR_CAP_IBS (cap-ibs) */
97 #define SPAPR_CAP_FIXED_IBS             0x02
98 #define SPAPR_CAP_FIXED_CCD             0x03
99 #define SPAPR_CAP_FIXED_NA              0x10 /* Lets leave a bit of a gap... */
100 
101 #define FDT_MAX_SIZE                    0x200000
102 
103 /* Max number of GPUs per system */
104 #define NVGPU_MAX_NUM              6
105 
106 /* Max number of NUMA nodes */
107 #define NUMA_NODES_MAX_NUM         (MAX_NODES + NVGPU_MAX_NUM)
108 
109 /*
110  * NUMA FORM1 macros. FORM1_DIST_REF_POINTS was taken from
111  * MAX_DISTANCE_REF_POINTS in arch/powerpc/mm/numa.h from Linux
112  * kernel source. It represents the amount of associativity domains
113  * for non-CPU resources.
114  *
115  * FORM1_NUMA_ASSOC_SIZE is the base array size of an ibm,associativity
116  * array for any non-CPU resource.
117  */
118 #define FORM1_DIST_REF_POINTS            4
119 #define FORM1_NUMA_ASSOC_SIZE            (FORM1_DIST_REF_POINTS + 1)
120 
121 /*
122  * FORM2 NUMA affinity has a single associativity domain, giving
123  * us a assoc size of 2.
124  */
125 #define FORM2_DIST_REF_POINTS            1
126 #define FORM2_NUMA_ASSOC_SIZE            (FORM2_DIST_REF_POINTS + 1)
127 
128 typedef struct SpaprCapabilities SpaprCapabilities;
129 struct SpaprCapabilities {
130     uint8_t caps[SPAPR_CAP_NUM];
131 };
132 
133 /**
134  * SpaprMachineClass:
135  */
136 struct SpaprMachineClass {
137     /*< private >*/
138     MachineClass parent_class;
139 
140     /*< public >*/
141     bool dr_lmb_enabled;       /* enable dynamic-reconfig/hotplug of LMBs */
142     bool dr_phb_enabled;       /* enable dynamic-reconfig/hotplug of PHBs */
143     bool update_dt_enabled;    /* enable KVMPPC_H_UPDATE_DT */
144     bool use_ohci_by_default;  /* use USB-OHCI instead of XHCI */
145     bool pre_2_10_has_unused_icps;
146     bool legacy_irq_allocation;
147     uint32_t nr_xirqs;
148     bool broken_host_serial_model; /* present real host info to the guest */
149     bool pre_4_1_migration; /* don't migrate hpt-max-page-size */
150     bool linux_pci_probe;
151     bool smp_threads_vsmt; /* set VSMT to smp_threads by default */
152     hwaddr rma_limit;          /* clamp the RMA to this size */
153     bool pre_5_1_assoc_refpoints;
154     bool pre_5_2_numa_associativity;
155     bool pre_6_2_numa_affinity;
156 
157     bool (*phb_placement)(SpaprMachineState *spapr, uint32_t index,
158                           uint64_t *buid, hwaddr *pio,
159                           hwaddr *mmio32, hwaddr *mmio64,
160                           unsigned n_dma, uint32_t *liobns, hwaddr *nv2gpa,
161                           hwaddr *nv2atsd, Error **errp);
162     SpaprResizeHpt resize_hpt_default;
163     SpaprCapabilities default_caps;
164     SpaprIrq *irq;
165 };
166 
167 /**
168  * SpaprMachineState:
169  */
170 struct SpaprMachineState {
171     /*< private >*/
172     MachineState parent_obj;
173 
174     struct SpaprVioBus *vio_bus;
175     QLIST_HEAD(, SpaprPhbState) phbs;
176     struct SpaprNvram *nvram;
177     SpaprRtcState rtc;
178 
179     SpaprResizeHpt resize_hpt;
180     void *htab;
181     uint32_t htab_shift;
182     uint64_t patb_entry; /* Process tbl registed in H_REGISTER_PROC_TBL */
183     SpaprPendingHpt *pending_hpt; /* in-progress resize */
184 
185     hwaddr rma_size;
186     uint32_t fdt_size;
187     uint32_t fdt_initial_size;
188     void *fdt_blob;
189     long kernel_size;
190     bool kernel_le;
191     uint64_t kernel_addr;
192     uint32_t initrd_base;
193     long initrd_size;
194     Vof *vof;
195     uint64_t rtc_offset; /* Now used only during incoming migration */
196     struct PPCTimebase tb;
197     bool has_graphics;
198     uint32_t vsmt;       /* Virtual SMT mode (KVM's "core stride") */
199 
200     /* Nested HV support (TCG only) */
201     uint64_t nested_ptcr;
202 
203     Notifier epow_notifier;
204     QTAILQ_HEAD(, SpaprEventLogEntry) pending_events;
205     bool use_hotplug_event_source;
206     SpaprEventSource *event_sources;
207 
208     /* ibm,client-architecture-support option negotiation */
209     bool cas_pre_isa3_guest;
210     SpaprOptionVector *ov5;         /* QEMU-supported option vectors */
211     SpaprOptionVector *ov5_cas;     /* negotiated (via CAS) option vectors */
212     uint32_t max_compat_pvr;
213 
214     /* Migration state */
215     int htab_save_index;
216     bool htab_first_pass;
217     int htab_fd;
218 
219     /* Pending DIMM unplug cache. It is populated when a LMB
220      * unplug starts. It can be regenerated if a migration
221      * occurs during the unplug process. */
222     QTAILQ_HEAD(, SpaprDimmState) pending_dimm_unplugs;
223 
224     /* State related to FWNMI option */
225 
226     /* System Reset and Machine Check Notification Routine addresses
227      * registered by "ibm,nmi-register" RTAS call.
228      */
229     target_ulong fwnmi_system_reset_addr;
230     target_ulong fwnmi_machine_check_addr;
231 
232     /* Machine Check FWNMI synchronization, fwnmi_machine_check_interlock is
233      * set to -1 if a FWNMI machine check is not in progress, else is set to
234      * the CPU that was delivered the machine check, and is set back to -1
235      * when that CPU makes an "ibm,nmi-interlock" RTAS call. The cond is used
236      * to synchronize other CPUs.
237      */
238     int fwnmi_machine_check_interlock;
239     QemuCond fwnmi_machine_check_interlock_cond;
240 
241     /* Set by -boot */
242     char *boot_device;
243 
244     /*< public >*/
245     char *kvm_type;
246     char *host_model;
247     char *host_serial;
248 
249     int32_t irq_map_nr;
250     unsigned long *irq_map;
251     SpaprIrq *irq;
252     qemu_irq *qirqs;
253     SpaprInterruptController *active_intc;
254     ICSState *ics;
255     SpaprXive *xive;
256 
257     bool cmd_line_caps[SPAPR_CAP_NUM];
258     SpaprCapabilities def, eff, mig;
259 
260     unsigned gpu_numa_id;
261     SpaprTpmProxy *tpm_proxy;
262 
263     uint32_t FORM1_assoc_array[NUMA_NODES_MAX_NUM][FORM1_NUMA_ASSOC_SIZE];
264     uint32_t FORM2_assoc_array[NUMA_NODES_MAX_NUM][FORM2_NUMA_ASSOC_SIZE];
265 
266     Error *fwnmi_migration_blocker;
267 };
268 
269 #define H_SUCCESS         0
270 #define H_BUSY            1        /* Hardware busy -- retry later */
271 #define H_CLOSED          2        /* Resource closed */
272 #define H_NOT_AVAILABLE   3
273 #define H_CONSTRAINED     4        /* Resource request constrained to max allowed */
274 #define H_PARTIAL         5
275 #define H_IN_PROGRESS     14       /* Kind of like busy */
276 #define H_PAGE_REGISTERED 15
277 #define H_PARTIAL_STORE   16
278 #define H_PENDING         17       /* returned from H_POLL_PENDING */
279 #define H_CONTINUE        18       /* Returned from H_Join on success */
280 #define H_LONG_BUSY_START_RANGE         9900  /* Start of long busy range */
281 #define H_LONG_BUSY_ORDER_1_MSEC        9900  /* Long busy, hint that 1msec \
282                                                  is a good time to retry */
283 #define H_LONG_BUSY_ORDER_10_MSEC       9901  /* Long busy, hint that 10msec \
284                                                  is a good time to retry */
285 #define H_LONG_BUSY_ORDER_100_MSEC      9902  /* Long busy, hint that 100msec \
286                                                  is a good time to retry */
287 #define H_LONG_BUSY_ORDER_1_SEC         9903  /* Long busy, hint that 1sec \
288                                                  is a good time to retry */
289 #define H_LONG_BUSY_ORDER_10_SEC        9904  /* Long busy, hint that 10sec \
290                                                  is a good time to retry */
291 #define H_LONG_BUSY_ORDER_100_SEC       9905  /* Long busy, hint that 100sec \
292                                                  is a good time to retry */
293 #define H_LONG_BUSY_END_RANGE           9905  /* End of long busy range */
294 #define H_HARDWARE        -1       /* Hardware error */
295 #define H_FUNCTION        -2       /* Function not supported */
296 #define H_PRIVILEGE       -3       /* Caller not privileged */
297 #define H_PARAMETER       -4       /* Parameter invalid, out-of-range or conflicting */
298 #define H_BAD_MODE        -5       /* Illegal msr value */
299 #define H_PTEG_FULL       -6       /* PTEG is full */
300 #define H_NOT_FOUND       -7       /* PTE was not found" */
301 #define H_RESERVED_DABR   -8       /* DABR address is reserved by the hypervisor on this processor" */
302 #define H_NO_MEM          -9
303 #define H_AUTHORITY       -10
304 #define H_PERMISSION      -11
305 #define H_DROPPED         -12
306 #define H_SOURCE_PARM     -13
307 #define H_DEST_PARM       -14
308 #define H_REMOTE_PARM     -15
309 #define H_RESOURCE        -16
310 #define H_ADAPTER_PARM    -17
311 #define H_RH_PARM         -18
312 #define H_RCQ_PARM        -19
313 #define H_SCQ_PARM        -20
314 #define H_EQ_PARM         -21
315 #define H_RT_PARM         -22
316 #define H_ST_PARM         -23
317 #define H_SIGT_PARM       -24
318 #define H_TOKEN_PARM      -25
319 #define H_MLENGTH_PARM    -27
320 #define H_MEM_PARM        -28
321 #define H_MEM_ACCESS_PARM -29
322 #define H_ATTR_PARM       -30
323 #define H_PORT_PARM       -31
324 #define H_MCG_PARM        -32
325 #define H_VL_PARM         -33
326 #define H_TSIZE_PARM      -34
327 #define H_TRACE_PARM      -35
328 
329 #define H_MASK_PARM       -37
330 #define H_MCG_FULL        -38
331 #define H_ALIAS_EXIST     -39
332 #define H_P_COUNTER       -40
333 #define H_TABLE_FULL      -41
334 #define H_ALT_TABLE       -42
335 #define H_MR_CONDITION    -43
336 #define H_NOT_ENOUGH_RESOURCES -44
337 #define H_R_STATE         -45
338 #define H_RESCINDEND      -46
339 #define H_P2              -55
340 #define H_P3              -56
341 #define H_P4              -57
342 #define H_P5              -58
343 #define H_P6              -59
344 #define H_P7              -60
345 #define H_P8              -61
346 #define H_P9              -62
347 #define H_UNSUPPORTED     -67
348 #define H_OVERLAP         -68
349 #define H_UNSUPPORTED_FLAG -256
350 #define H_MULTI_THREADS_ACTIVE -9005
351 
352 
353 /* Long Busy is a condition that can be returned by the firmware
354  * when a call cannot be completed now, but the identical call
355  * should be retried later.  This prevents calls blocking in the
356  * firmware for long periods of time.  Annoyingly the firmware can return
357  * a range of return codes, hinting at how long we should wait before
358  * retrying.  If you don't care for the hint, the macro below is a good
359  * way to check for the long_busy return codes
360  */
361 #define H_IS_LONG_BUSY(x)  ((x >= H_LONG_BUSY_START_RANGE) \
362                             && (x <= H_LONG_BUSY_END_RANGE))
363 
364 /* Flags */
365 #define H_LARGE_PAGE      (1ULL<<(63-16))
366 #define H_EXACT           (1ULL<<(63-24))       /* Use exact PTE or return H_PTEG_FULL */
367 #define H_R_XLATE         (1ULL<<(63-25))       /* include a valid logical page num in the pte if the valid bit is set */
368 #define H_READ_4          (1ULL<<(63-26))       /* Return 4 PTEs */
369 #define H_PAGE_STATE_CHANGE (1ULL<<(63-28))
370 #define H_PAGE_UNUSED     ((1ULL<<(63-29)) | (1ULL<<(63-30)))
371 #define H_PAGE_SET_UNUSED (H_PAGE_STATE_CHANGE | H_PAGE_UNUSED)
372 #define H_PAGE_SET_LOANED (H_PAGE_SET_UNUSED | (1ULL<<(63-31)))
373 #define H_PAGE_SET_ACTIVE H_PAGE_STATE_CHANGE
374 #define H_AVPN            (1ULL<<(63-32))       /* An avpn is provided as a sanity test */
375 #define H_ANDCOND         (1ULL<<(63-33))
376 #define H_ICACHE_INVALIDATE (1ULL<<(63-40))     /* icbi, etc.  (ignored for IO pages) */
377 #define H_ICACHE_SYNCHRONIZE (1ULL<<(63-41))    /* dcbst, icbi, etc (ignored for IO pages */
378 #define H_ZERO_PAGE       (1ULL<<(63-48))       /* zero the page before mapping (ignored for IO pages) */
379 #define H_COPY_PAGE       (1ULL<<(63-49))
380 #define H_N               (1ULL<<(63-61))
381 #define H_PP1             (1ULL<<(63-62))
382 #define H_PP2             (1ULL<<(63-63))
383 
384 /* Values for 2nd argument to H_SET_MODE */
385 #define H_SET_MODE_RESOURCE_SET_CIABR           1
386 #define H_SET_MODE_RESOURCE_SET_DAWR0           2
387 #define H_SET_MODE_RESOURCE_ADDR_TRANS_MODE     3
388 #define H_SET_MODE_RESOURCE_LE                  4
389 
390 /* Flags for H_SET_MODE_RESOURCE_LE */
391 #define H_SET_MODE_ENDIAN_BIG    0
392 #define H_SET_MODE_ENDIAN_LITTLE 1
393 
394 /* VASI States */
395 #define H_VASI_INVALID    0
396 #define H_VASI_ENABLED    1
397 #define H_VASI_ABORTED    2
398 #define H_VASI_SUSPENDING 3
399 #define H_VASI_SUSPENDED  4
400 #define H_VASI_RESUMED    5
401 #define H_VASI_COMPLETED  6
402 
403 /* DABRX flags */
404 #define H_DABRX_HYPERVISOR (1ULL<<(63-61))
405 #define H_DABRX_KERNEL     (1ULL<<(63-62))
406 #define H_DABRX_USER       (1ULL<<(63-63))
407 
408 /* Values for KVM_PPC_GET_CPU_CHAR & H_GET_CPU_CHARACTERISTICS */
409 #define H_CPU_CHAR_SPEC_BAR_ORI31               PPC_BIT(0)
410 #define H_CPU_CHAR_BCCTRL_SERIALISED            PPC_BIT(1)
411 #define H_CPU_CHAR_L1D_FLUSH_ORI30              PPC_BIT(2)
412 #define H_CPU_CHAR_L1D_FLUSH_TRIG2              PPC_BIT(3)
413 #define H_CPU_CHAR_L1D_THREAD_PRIV              PPC_BIT(4)
414 #define H_CPU_CHAR_HON_BRANCH_HINTS             PPC_BIT(5)
415 #define H_CPU_CHAR_THR_RECONF_TRIG              PPC_BIT(6)
416 #define H_CPU_CHAR_CACHE_COUNT_DIS              PPC_BIT(7)
417 #define H_CPU_CHAR_BCCTR_FLUSH_ASSIST           PPC_BIT(9)
418 
419 #define H_CPU_BEHAV_FAVOUR_SECURITY             PPC_BIT(0)
420 #define H_CPU_BEHAV_L1D_FLUSH_PR                PPC_BIT(1)
421 #define H_CPU_BEHAV_BNDS_CHK_SPEC_BAR           PPC_BIT(2)
422 #define H_CPU_BEHAV_FLUSH_COUNT_CACHE           PPC_BIT(5)
423 #define H_CPU_BEHAV_NO_L1D_FLUSH_ENTRY          PPC_BIT(7)
424 #define H_CPU_BEHAV_NO_L1D_FLUSH_UACCESS        PPC_BIT(8)
425 
426 /* Each control block has to be on a 4K boundary */
427 #define H_CB_ALIGNMENT     4096
428 
429 /* pSeries hypervisor opcodes */
430 #define H_REMOVE                0x04
431 #define H_ENTER                 0x08
432 #define H_READ                  0x0c
433 #define H_CLEAR_MOD             0x10
434 #define H_CLEAR_REF             0x14
435 #define H_PROTECT               0x18
436 #define H_GET_TCE               0x1c
437 #define H_PUT_TCE               0x20
438 #define H_SET_SPRG0             0x24
439 #define H_SET_DABR              0x28
440 #define H_PAGE_INIT             0x2c
441 #define H_SET_ASR               0x30
442 #define H_ASR_ON                0x34
443 #define H_ASR_OFF               0x38
444 #define H_LOGICAL_CI_LOAD       0x3c
445 #define H_LOGICAL_CI_STORE      0x40
446 #define H_LOGICAL_CACHE_LOAD    0x44
447 #define H_LOGICAL_CACHE_STORE   0x48
448 #define H_LOGICAL_ICBI          0x4c
449 #define H_LOGICAL_DCBF          0x50
450 #define H_GET_TERM_CHAR         0x54
451 #define H_PUT_TERM_CHAR         0x58
452 #define H_REAL_TO_LOGICAL       0x5c
453 #define H_HYPERVISOR_DATA       0x60
454 #define H_EOI                   0x64
455 #define H_CPPR                  0x68
456 #define H_IPI                   0x6c
457 #define H_IPOLL                 0x70
458 #define H_XIRR                  0x74
459 #define H_PERFMON               0x7c
460 #define H_MIGRATE_DMA           0x78
461 #define H_REGISTER_VPA          0xDC
462 #define H_CEDE                  0xE0
463 #define H_CONFER                0xE4
464 #define H_PROD                  0xE8
465 #define H_GET_PPP               0xEC
466 #define H_SET_PPP               0xF0
467 #define H_PURR                  0xF4
468 #define H_PIC                   0xF8
469 #define H_REG_CRQ               0xFC
470 #define H_FREE_CRQ              0x100
471 #define H_VIO_SIGNAL            0x104
472 #define H_SEND_CRQ              0x108
473 #define H_COPY_RDMA             0x110
474 #define H_REGISTER_LOGICAL_LAN  0x114
475 #define H_FREE_LOGICAL_LAN      0x118
476 #define H_ADD_LOGICAL_LAN_BUFFER 0x11C
477 #define H_SEND_LOGICAL_LAN      0x120
478 #define H_BULK_REMOVE           0x124
479 #define H_MULTICAST_CTRL        0x130
480 #define H_SET_XDABR             0x134
481 #define H_STUFF_TCE             0x138
482 #define H_PUT_TCE_INDIRECT      0x13C
483 #define H_CHANGE_LOGICAL_LAN_MAC 0x14C
484 #define H_VTERM_PARTNER_INFO    0x150
485 #define H_REGISTER_VTERM        0x154
486 #define H_FREE_VTERM            0x158
487 #define H_RESET_EVENTS          0x15C
488 #define H_ALLOC_RESOURCE        0x160
489 #define H_FREE_RESOURCE         0x164
490 #define H_MODIFY_QP             0x168
491 #define H_QUERY_QP              0x16C
492 #define H_REREGISTER_PMR        0x170
493 #define H_REGISTER_SMR          0x174
494 #define H_QUERY_MR              0x178
495 #define H_QUERY_MW              0x17C
496 #define H_QUERY_HCA             0x180
497 #define H_QUERY_PORT            0x184
498 #define H_MODIFY_PORT           0x188
499 #define H_DEFINE_AQP1           0x18C
500 #define H_GET_TRACE_BUFFER      0x190
501 #define H_DEFINE_AQP0           0x194
502 #define H_RESIZE_MR             0x198
503 #define H_ATTACH_MCQP           0x19C
504 #define H_DETACH_MCQP           0x1A0
505 #define H_CREATE_RPT            0x1A4
506 #define H_REMOVE_RPT            0x1A8
507 #define H_REGISTER_RPAGES       0x1AC
508 #define H_DISABLE_AND_GETC      0x1B0
509 #define H_ERROR_DATA            0x1B4
510 #define H_GET_HCA_INFO          0x1B8
511 #define H_GET_PERF_COUNT        0x1BC
512 #define H_MANAGE_TRACE          0x1C0
513 #define H_GET_CPU_CHARACTERISTICS 0x1C8
514 #define H_FREE_LOGICAL_LAN_BUFFER 0x1D4
515 #define H_QUERY_INT_STATE       0x1E4
516 #define H_POLL_PENDING          0x1D8
517 #define H_ILLAN_ATTRIBUTES      0x244
518 #define H_MODIFY_HEA_QP         0x250
519 #define H_QUERY_HEA_QP          0x254
520 #define H_QUERY_HEA             0x258
521 #define H_QUERY_HEA_PORT        0x25C
522 #define H_MODIFY_HEA_PORT       0x260
523 #define H_REG_BCMC              0x264
524 #define H_DEREG_BCMC            0x268
525 #define H_REGISTER_HEA_RPAGES   0x26C
526 #define H_DISABLE_AND_GET_HEA   0x270
527 #define H_GET_HEA_INFO          0x274
528 #define H_ALLOC_HEA_RESOURCE    0x278
529 #define H_ADD_CONN              0x284
530 #define H_DEL_CONN              0x288
531 #define H_JOIN                  0x298
532 #define H_VASI_STATE            0x2A4
533 #define H_ENABLE_CRQ            0x2B0
534 #define H_GET_EM_PARMS          0x2B8
535 #define H_SET_MPP               0x2D0
536 #define H_GET_MPP               0x2D4
537 #define H_HOME_NODE_ASSOCIATIVITY 0x2EC
538 #define H_XIRR_X                0x2FC
539 #define H_RANDOM                0x300
540 #define H_SET_MODE              0x31C
541 #define H_RESIZE_HPT_PREPARE    0x36C
542 #define H_RESIZE_HPT_COMMIT     0x370
543 #define H_CLEAN_SLB             0x374
544 #define H_INVALIDATE_PID        0x378
545 #define H_REGISTER_PROC_TBL     0x37C
546 #define H_SIGNAL_SYS_RESET      0x380
547 
548 #define H_INT_GET_SOURCE_INFO   0x3A8
549 #define H_INT_SET_SOURCE_CONFIG 0x3AC
550 #define H_INT_GET_SOURCE_CONFIG 0x3B0
551 #define H_INT_GET_QUEUE_INFO    0x3B4
552 #define H_INT_SET_QUEUE_CONFIG  0x3B8
553 #define H_INT_GET_QUEUE_CONFIG  0x3BC
554 #define H_INT_SET_OS_REPORTING_LINE 0x3C0
555 #define H_INT_GET_OS_REPORTING_LINE 0x3C4
556 #define H_INT_ESB               0x3C8
557 #define H_INT_SYNC              0x3CC
558 #define H_INT_RESET             0x3D0
559 #define H_SCM_READ_METADATA     0x3E4
560 #define H_SCM_WRITE_METADATA    0x3E8
561 #define H_SCM_BIND_MEM          0x3EC
562 #define H_SCM_UNBIND_MEM        0x3F0
563 #define H_SCM_UNBIND_ALL        0x3FC
564 #define H_SCM_HEALTH            0x400
565 #define H_RPT_INVALIDATE        0x448
566 #define H_SCM_FLUSH             0x44C
567 
568 #define MAX_HCALL_OPCODE        H_SCM_FLUSH
569 
570 /* The hcalls above are standardized in PAPR and implemented by pHyp
571  * as well.
572  *
573  * We also need some hcalls which are specific to qemu / KVM-on-POWER.
574  * We put those into the 0xf000-0xfffc range which is reserved by PAPR
575  * for "platform-specific" hcalls.
576  */
577 #define KVMPPC_HCALL_BASE       0xf000
578 #define KVMPPC_H_RTAS           (KVMPPC_HCALL_BASE + 0x0)
579 #define KVMPPC_H_LOGICAL_MEMOP  (KVMPPC_HCALL_BASE + 0x1)
580 /* Client Architecture support */
581 #define KVMPPC_H_CAS            (KVMPPC_HCALL_BASE + 0x2)
582 #define KVMPPC_H_UPDATE_DT      (KVMPPC_HCALL_BASE + 0x3)
583 /* 0x4 was used for KVMPPC_H_UPDATE_PHANDLE in SLOF */
584 #define KVMPPC_H_VOF_CLIENT     (KVMPPC_HCALL_BASE + 0x5)
585 
586 /* Platform-specific hcalls used for nested HV KVM */
587 #define KVMPPC_H_SET_PARTITION_TABLE   (KVMPPC_HCALL_BASE + 0x800)
588 #define KVMPPC_H_ENTER_NESTED          (KVMPPC_HCALL_BASE + 0x804)
589 #define KVMPPC_H_TLB_INVALIDATE        (KVMPPC_HCALL_BASE + 0x808)
590 #define KVMPPC_H_COPY_TOFROM_GUEST     (KVMPPC_HCALL_BASE + 0x80C)
591 
592 #define KVMPPC_HCALL_MAX        KVMPPC_H_COPY_TOFROM_GUEST
593 
594 /*
595  * The hcall range 0xEF00 to 0xEF80 is reserved for use in facilitating
596  * Secure VM mode via an Ultravisor / Protected Execution Facility
597  */
598 #define SVM_HCALL_BASE              0xEF00
599 #define SVM_H_TPM_COMM              0xEF10
600 #define SVM_HCALL_MAX               SVM_H_TPM_COMM
601 
602 /*
603  * Register state for entering a nested guest with H_ENTER_NESTED.
604  * New member must be added at the end.
605  */
606 struct kvmppc_hv_guest_state {
607     uint64_t version;      /* version of this structure layout, must be first */
608     uint32_t lpid;
609     uint32_t vcpu_token;
610     /* These registers are hypervisor privileged (at least for writing) */
611     uint64_t lpcr;
612     uint64_t pcr;
613     uint64_t amor;
614     uint64_t dpdes;
615     uint64_t hfscr;
616     int64_t tb_offset;
617     uint64_t dawr0;
618     uint64_t dawrx0;
619     uint64_t ciabr;
620     uint64_t hdec_expiry;
621     uint64_t purr;
622     uint64_t spurr;
623     uint64_t ic;
624     uint64_t vtb;
625     uint64_t hdar;
626     uint64_t hdsisr;
627     uint64_t heir;
628     uint64_t asdr;
629     /* These are OS privileged but need to be set late in guest entry */
630     uint64_t srr0;
631     uint64_t srr1;
632     uint64_t sprg[4];
633     uint64_t pidr;
634     uint64_t cfar;
635     uint64_t ppr;
636     /* Version 1 ends here */
637     uint64_t dawr1;
638     uint64_t dawrx1;
639     /* Version 2 ends here */
640 };
641 
642 /* Latest version of hv_guest_state structure */
643 #define HV_GUEST_STATE_VERSION  2
644 
645 /* Linux 64-bit powerpc pt_regs struct, used by nested HV */
646 struct kvmppc_pt_regs {
647     uint64_t gpr[32];
648     uint64_t nip;
649     uint64_t msr;
650     uint64_t orig_gpr3;    /* Used for restarting system calls */
651     uint64_t ctr;
652     uint64_t link;
653     uint64_t xer;
654     uint64_t ccr;
655     uint64_t softe;        /* Soft enabled/disabled */
656     uint64_t trap;         /* Reason for being here */
657     uint64_t dar;          /* Fault registers */
658     uint64_t dsisr;        /* on 4xx/Book-E used for ESR */
659     uint64_t result;       /* Result of a system call */
660 };
661 
662 typedef struct SpaprDeviceTreeUpdateHeader {
663     uint32_t version_id;
664 } SpaprDeviceTreeUpdateHeader;
665 
666 #define hcall_dprintf(fmt, ...) \
667     do { \
668         qemu_log_mask(LOG_GUEST_ERROR, "%s: " fmt, __func__, ## __VA_ARGS__); \
669     } while (0)
670 
671 typedef target_ulong (*spapr_hcall_fn)(PowerPCCPU *cpu, SpaprMachineState *sm,
672                                        target_ulong opcode,
673                                        target_ulong *args);
674 
675 void spapr_register_hypercall(target_ulong opcode, spapr_hcall_fn fn);
676 target_ulong spapr_hypercall(PowerPCCPU *cpu, target_ulong opcode,
677                              target_ulong *args);
678 
679 void spapr_exit_nested(PowerPCCPU *cpu, int excp);
680 
681 target_ulong softmmu_resize_hpt_prepare(PowerPCCPU *cpu, SpaprMachineState *spapr,
682                                          target_ulong shift);
683 target_ulong softmmu_resize_hpt_commit(PowerPCCPU *cpu, SpaprMachineState *spapr,
684                                         target_ulong flags, target_ulong shift);
685 bool is_ram_address(SpaprMachineState *spapr, hwaddr addr);
686 void push_sregs_to_kvm_pr(SpaprMachineState *spapr);
687 
688 /* Virtual Processor Area structure constants */
689 #define VPA_MIN_SIZE           640
690 #define VPA_SIZE_OFFSET        0x4
691 #define VPA_SHARED_PROC_OFFSET 0x9
692 #define VPA_SHARED_PROC_VAL    0x2
693 #define VPA_DISPATCH_COUNTER   0x100
694 
695 /* ibm,set-eeh-option */
696 #define RTAS_EEH_DISABLE                 0
697 #define RTAS_EEH_ENABLE                  1
698 #define RTAS_EEH_THAW_IO                 2
699 #define RTAS_EEH_THAW_DMA                3
700 
701 /* ibm,get-config-addr-info2 */
702 #define RTAS_GET_PE_ADDR                 0
703 #define RTAS_GET_PE_MODE                 1
704 #define RTAS_PE_MODE_NONE                0
705 #define RTAS_PE_MODE_NOT_SHARED          1
706 #define RTAS_PE_MODE_SHARED              2
707 
708 /* ibm,read-slot-reset-state2 */
709 #define RTAS_EEH_PE_STATE_NORMAL         0
710 #define RTAS_EEH_PE_STATE_RESET          1
711 #define RTAS_EEH_PE_STATE_STOPPED_IO_DMA 2
712 #define RTAS_EEH_PE_STATE_STOPPED_DMA    4
713 #define RTAS_EEH_PE_STATE_UNAVAIL        5
714 #define RTAS_EEH_NOT_SUPPORT             0
715 #define RTAS_EEH_SUPPORT                 1
716 #define RTAS_EEH_PE_UNAVAIL_INFO         1000
717 #define RTAS_EEH_PE_RECOVER_INFO         0
718 
719 /* ibm,set-slot-reset */
720 #define RTAS_SLOT_RESET_DEACTIVATE       0
721 #define RTAS_SLOT_RESET_HOT              1
722 #define RTAS_SLOT_RESET_FUNDAMENTAL      3
723 
724 /* ibm,slot-error-detail */
725 #define RTAS_SLOT_TEMP_ERR_LOG           1
726 #define RTAS_SLOT_PERM_ERR_LOG           2
727 
728 /* RTAS return codes */
729 #define RTAS_OUT_SUCCESS                        0
730 #define RTAS_OUT_NO_ERRORS_FOUND                1
731 #define RTAS_OUT_HW_ERROR                       -1
732 #define RTAS_OUT_BUSY                           -2
733 #define RTAS_OUT_PARAM_ERROR                    -3
734 #define RTAS_OUT_NOT_SUPPORTED                  -3
735 #define RTAS_OUT_NO_SUCH_INDICATOR              -3
736 #define RTAS_OUT_NOT_AUTHORIZED                 -9002
737 #define RTAS_OUT_SYSPARM_PARAM_ERROR            -9999
738 
739 /* DDW pagesize mask values from ibm,query-pe-dma-window */
740 #define RTAS_DDW_PGSIZE_4K       0x01
741 #define RTAS_DDW_PGSIZE_64K      0x02
742 #define RTAS_DDW_PGSIZE_16M      0x04
743 #define RTAS_DDW_PGSIZE_32M      0x08
744 #define RTAS_DDW_PGSIZE_64M      0x10
745 #define RTAS_DDW_PGSIZE_128M     0x20
746 #define RTAS_DDW_PGSIZE_256M     0x40
747 #define RTAS_DDW_PGSIZE_16G      0x80
748 #define RTAS_DDW_PGSIZE_2M       0x100
749 
750 /* RTAS tokens */
751 #define RTAS_TOKEN_BASE      0x2000
752 
753 #define RTAS_DISPLAY_CHARACTER                  (RTAS_TOKEN_BASE + 0x00)
754 #define RTAS_GET_TIME_OF_DAY                    (RTAS_TOKEN_BASE + 0x01)
755 #define RTAS_SET_TIME_OF_DAY                    (RTAS_TOKEN_BASE + 0x02)
756 #define RTAS_POWER_OFF                          (RTAS_TOKEN_BASE + 0x03)
757 #define RTAS_SYSTEM_REBOOT                      (RTAS_TOKEN_BASE + 0x04)
758 #define RTAS_QUERY_CPU_STOPPED_STATE            (RTAS_TOKEN_BASE + 0x05)
759 #define RTAS_START_CPU                          (RTAS_TOKEN_BASE + 0x06)
760 #define RTAS_STOP_SELF                          (RTAS_TOKEN_BASE + 0x07)
761 #define RTAS_IBM_GET_SYSTEM_PARAMETER           (RTAS_TOKEN_BASE + 0x08)
762 #define RTAS_IBM_SET_SYSTEM_PARAMETER           (RTAS_TOKEN_BASE + 0x09)
763 #define RTAS_IBM_SET_XIVE                       (RTAS_TOKEN_BASE + 0x0A)
764 #define RTAS_IBM_GET_XIVE                       (RTAS_TOKEN_BASE + 0x0B)
765 #define RTAS_IBM_INT_OFF                        (RTAS_TOKEN_BASE + 0x0C)
766 #define RTAS_IBM_INT_ON                         (RTAS_TOKEN_BASE + 0x0D)
767 #define RTAS_CHECK_EXCEPTION                    (RTAS_TOKEN_BASE + 0x0E)
768 #define RTAS_EVENT_SCAN                         (RTAS_TOKEN_BASE + 0x0F)
769 #define RTAS_IBM_SET_TCE_BYPASS                 (RTAS_TOKEN_BASE + 0x10)
770 #define RTAS_QUIESCE                            (RTAS_TOKEN_BASE + 0x11)
771 #define RTAS_NVRAM_FETCH                        (RTAS_TOKEN_BASE + 0x12)
772 #define RTAS_NVRAM_STORE                        (RTAS_TOKEN_BASE + 0x13)
773 #define RTAS_READ_PCI_CONFIG                    (RTAS_TOKEN_BASE + 0x14)
774 #define RTAS_WRITE_PCI_CONFIG                   (RTAS_TOKEN_BASE + 0x15)
775 #define RTAS_IBM_READ_PCI_CONFIG                (RTAS_TOKEN_BASE + 0x16)
776 #define RTAS_IBM_WRITE_PCI_CONFIG               (RTAS_TOKEN_BASE + 0x17)
777 #define RTAS_IBM_QUERY_INTERRUPT_SOURCE_NUMBER  (RTAS_TOKEN_BASE + 0x18)
778 #define RTAS_IBM_CHANGE_MSI                     (RTAS_TOKEN_BASE + 0x19)
779 #define RTAS_SET_INDICATOR                      (RTAS_TOKEN_BASE + 0x1A)
780 #define RTAS_SET_POWER_LEVEL                    (RTAS_TOKEN_BASE + 0x1B)
781 #define RTAS_GET_POWER_LEVEL                    (RTAS_TOKEN_BASE + 0x1C)
782 #define RTAS_GET_SENSOR_STATE                   (RTAS_TOKEN_BASE + 0x1D)
783 #define RTAS_IBM_CONFIGURE_CONNECTOR            (RTAS_TOKEN_BASE + 0x1E)
784 #define RTAS_IBM_OS_TERM                        (RTAS_TOKEN_BASE + 0x1F)
785 #define RTAS_IBM_SET_EEH_OPTION                 (RTAS_TOKEN_BASE + 0x20)
786 #define RTAS_IBM_GET_CONFIG_ADDR_INFO2          (RTAS_TOKEN_BASE + 0x21)
787 #define RTAS_IBM_READ_SLOT_RESET_STATE2         (RTAS_TOKEN_BASE + 0x22)
788 #define RTAS_IBM_SET_SLOT_RESET                 (RTAS_TOKEN_BASE + 0x23)
789 #define RTAS_IBM_CONFIGURE_PE                   (RTAS_TOKEN_BASE + 0x24)
790 #define RTAS_IBM_SLOT_ERROR_DETAIL              (RTAS_TOKEN_BASE + 0x25)
791 #define RTAS_IBM_QUERY_PE_DMA_WINDOW            (RTAS_TOKEN_BASE + 0x26)
792 #define RTAS_IBM_CREATE_PE_DMA_WINDOW           (RTAS_TOKEN_BASE + 0x27)
793 #define RTAS_IBM_REMOVE_PE_DMA_WINDOW           (RTAS_TOKEN_BASE + 0x28)
794 #define RTAS_IBM_RESET_PE_DMA_WINDOW            (RTAS_TOKEN_BASE + 0x29)
795 #define RTAS_IBM_SUSPEND_ME                     (RTAS_TOKEN_BASE + 0x2A)
796 #define RTAS_IBM_NMI_REGISTER                   (RTAS_TOKEN_BASE + 0x2B)
797 #define RTAS_IBM_NMI_INTERLOCK                  (RTAS_TOKEN_BASE + 0x2C)
798 
799 #define RTAS_TOKEN_MAX                          (RTAS_TOKEN_BASE + 0x2D)
800 
801 /* RTAS ibm,get-system-parameter token values */
802 #define RTAS_SYSPARM_SPLPAR_CHARACTERISTICS      20
803 #define RTAS_SYSPARM_DIAGNOSTICS_RUN_MODE        42
804 #define RTAS_SYSPARM_UUID                        48
805 
806 /* RTAS indicator/sensor types
807  *
808  * as defined by PAPR+ 2.7 7.3.5.4, Table 41
809  *
810  * NOTE: currently only DR-related sensors are implemented here
811  */
812 #define RTAS_SENSOR_TYPE_ISOLATION_STATE        9001
813 #define RTAS_SENSOR_TYPE_DR                     9002
814 #define RTAS_SENSOR_TYPE_ALLOCATION_STATE       9003
815 #define RTAS_SENSOR_TYPE_ENTITY_SENSE RTAS_SENSOR_TYPE_ALLOCATION_STATE
816 
817 /* Possible values for the platform-processor-diagnostics-run-mode parameter
818  * of the RTAS ibm,get-system-parameter call.
819  */
820 #define DIAGNOSTICS_RUN_MODE_DISABLED  0
821 #define DIAGNOSTICS_RUN_MODE_STAGGERED 1
822 #define DIAGNOSTICS_RUN_MODE_IMMEDIATE 2
823 #define DIAGNOSTICS_RUN_MODE_PERIODIC  3
824 
825 static inline uint64_t ppc64_phys_to_real(uint64_t addr)
826 {
827     return addr & ~0xF000000000000000ULL;
828 }
829 
830 static inline uint32_t rtas_ld(target_ulong phys, int n)
831 {
832     return ldl_be_phys(&address_space_memory, ppc64_phys_to_real(phys + 4*n));
833 }
834 
835 static inline uint64_t rtas_ldq(target_ulong phys, int n)
836 {
837     return (uint64_t)rtas_ld(phys, n) << 32 | rtas_ld(phys, n + 1);
838 }
839 
840 static inline void rtas_st(target_ulong phys, int n, uint32_t val)
841 {
842     stl_be_phys(&address_space_memory, ppc64_phys_to_real(phys + 4*n), val);
843 }
844 
845 typedef void (*spapr_rtas_fn)(PowerPCCPU *cpu, SpaprMachineState *sm,
846                               uint32_t token,
847                               uint32_t nargs, target_ulong args,
848                               uint32_t nret, target_ulong rets);
849 void spapr_rtas_register(int token, const char *name, spapr_rtas_fn fn);
850 target_ulong spapr_rtas_call(PowerPCCPU *cpu, SpaprMachineState *sm,
851                              uint32_t token, uint32_t nargs, target_ulong args,
852                              uint32_t nret, target_ulong rets);
853 void spapr_dt_rtas_tokens(void *fdt, int rtas);
854 void spapr_load_rtas(SpaprMachineState *spapr, void *fdt, hwaddr addr);
855 
856 #define SPAPR_TCE_PAGE_SHIFT   12
857 #define SPAPR_TCE_PAGE_SIZE    (1ULL << SPAPR_TCE_PAGE_SHIFT)
858 #define SPAPR_TCE_PAGE_MASK    (SPAPR_TCE_PAGE_SIZE - 1)
859 
860 #define SPAPR_VIO_BASE_LIOBN    0x00000000
861 #define SPAPR_VIO_LIOBN(reg)    (0x00000000 | (reg))
862 #define SPAPR_PCI_LIOBN(phb_index, window_num) \
863     (0x80000000 | ((phb_index) << 8) | (window_num))
864 #define SPAPR_IS_PCI_LIOBN(liobn)   (!!((liobn) & 0x80000000))
865 #define SPAPR_PCI_DMA_WINDOW_NUM(liobn) ((liobn) & 0xff)
866 
867 #define RTAS_MIN_SIZE           20 /* hv_rtas_size in SLOF */
868 #define RTAS_ERROR_LOG_MAX      2048
869 
870 /* Offset from rtas-base where error log is placed */
871 #define RTAS_ERROR_LOG_OFFSET       0x30
872 
873 #define RTAS_EVENT_SCAN_RATE    1
874 
875 /* This helper should be used to encode interrupt specifiers when the related
876  * "interrupt-controller" node has its "#interrupt-cells" property set to 2 (ie,
877  * VIO devices, RTAS event sources and PHBs).
878  */
879 static inline void spapr_dt_irq(uint32_t *intspec, int irq, bool is_lsi)
880 {
881     intspec[0] = cpu_to_be32(irq);
882     intspec[1] = is_lsi ? cpu_to_be32(1) : 0;
883 }
884 
885 
886 #define TYPE_SPAPR_TCE_TABLE "spapr-tce-table"
887 OBJECT_DECLARE_SIMPLE_TYPE(SpaprTceTable, SPAPR_TCE_TABLE)
888 
889 #define TYPE_SPAPR_IOMMU_MEMORY_REGION "spapr-iommu-memory-region"
890 DECLARE_INSTANCE_CHECKER(IOMMUMemoryRegion, SPAPR_IOMMU_MEMORY_REGION,
891                          TYPE_SPAPR_IOMMU_MEMORY_REGION)
892 
893 struct SpaprTceTable {
894     DeviceState parent;
895     uint32_t liobn;
896     uint32_t nb_table;
897     uint64_t bus_offset;
898     uint32_t page_shift;
899     uint64_t *table;
900     uint32_t mig_nb_table;
901     uint64_t *mig_table;
902     bool bypass;
903     bool need_vfio;
904     bool skipping_replay;
905     int fd;
906     MemoryRegion root;
907     IOMMUMemoryRegion iommu;
908     struct SpaprVioDevice *vdev; /* for @bypass migration compatibility only */
909     QLIST_ENTRY(SpaprTceTable) list;
910 };
911 
912 SpaprTceTable *spapr_tce_find_by_liobn(target_ulong liobn);
913 
914 struct SpaprEventLogEntry {
915     uint32_t summary;
916     uint32_t extended_length;
917     void *extended_log;
918     QTAILQ_ENTRY(SpaprEventLogEntry) next;
919 };
920 
921 void *spapr_build_fdt(SpaprMachineState *spapr, bool reset, size_t space);
922 void spapr_events_init(SpaprMachineState *sm);
923 void spapr_dt_events(SpaprMachineState *sm, void *fdt);
924 void close_htab_fd(SpaprMachineState *spapr);
925 void spapr_setup_hpt(SpaprMachineState *spapr);
926 void spapr_free_hpt(SpaprMachineState *spapr);
927 void spapr_check_mmu_mode(bool guest_radix);
928 SpaprTceTable *spapr_tce_new_table(DeviceState *owner, uint32_t liobn);
929 void spapr_tce_table_enable(SpaprTceTable *tcet,
930                             uint32_t page_shift, uint64_t bus_offset,
931                             uint32_t nb_table);
932 void spapr_tce_table_disable(SpaprTceTable *tcet);
933 void spapr_tce_set_need_vfio(SpaprTceTable *tcet, bool need_vfio);
934 
935 MemoryRegion *spapr_tce_get_iommu(SpaprTceTable *tcet);
936 int spapr_dma_dt(void *fdt, int node_off, const char *propname,
937                  uint32_t liobn, uint64_t window, uint32_t size);
938 int spapr_tcet_dma_dt(void *fdt, int node_off, const char *propname,
939                       SpaprTceTable *tcet);
940 void spapr_pci_switch_vga(SpaprMachineState *spapr, bool big_endian);
941 void spapr_hotplug_req_add_by_index(SpaprDrc *drc);
942 void spapr_hotplug_req_remove_by_index(SpaprDrc *drc);
943 void spapr_hotplug_req_add_by_count(SpaprDrcType drc_type,
944                                        uint32_t count);
945 void spapr_hotplug_req_remove_by_count(SpaprDrcType drc_type,
946                                           uint32_t count);
947 void spapr_hotplug_req_add_by_count_indexed(SpaprDrcType drc_type,
948                                             uint32_t count, uint32_t index);
949 void spapr_hotplug_req_remove_by_count_indexed(SpaprDrcType drc_type,
950                                                uint32_t count, uint32_t index);
951 int spapr_hpt_shift_for_ramsize(uint64_t ramsize);
952 int spapr_reallocate_hpt(SpaprMachineState *spapr, int shift, Error **errp);
953 void spapr_clear_pending_events(SpaprMachineState *spapr);
954 void spapr_clear_pending_hotplug_events(SpaprMachineState *spapr);
955 void spapr_memory_unplug_rollback(SpaprMachineState *spapr, DeviceState *dev);
956 int spapr_max_server_number(SpaprMachineState *spapr);
957 void spapr_store_hpte(PowerPCCPU *cpu, hwaddr ptex,
958                       uint64_t pte0, uint64_t pte1);
959 void spapr_mce_req_event(PowerPCCPU *cpu, bool recovered);
960 
961 /* DRC callbacks. */
962 void spapr_core_release(DeviceState *dev);
963 int spapr_core_dt_populate(SpaprDrc *drc, SpaprMachineState *spapr,
964                            void *fdt, int *fdt_start_offset, Error **errp);
965 void spapr_lmb_release(DeviceState *dev);
966 int spapr_lmb_dt_populate(SpaprDrc *drc, SpaprMachineState *spapr,
967                           void *fdt, int *fdt_start_offset, Error **errp);
968 void spapr_phb_release(DeviceState *dev);
969 int spapr_phb_dt_populate(SpaprDrc *drc, SpaprMachineState *spapr,
970                           void *fdt, int *fdt_start_offset, Error **errp);
971 
972 void spapr_rtc_read(SpaprRtcState *rtc, struct tm *tm, uint32_t *ns);
973 int spapr_rtc_import_offset(SpaprRtcState *rtc, int64_t legacy_offset);
974 
975 #define TYPE_SPAPR_RNG "spapr-rng"
976 
977 #define SPAPR_MEMORY_BLOCK_SIZE ((hwaddr)1 << 28) /* 256MB */
978 
979 /*
980  * This defines the maximum number of DIMM slots we can have for sPAPR
981  * guest. This is not defined by sPAPR but we are defining it to 32 slots
982  * based on default number of slots provided by PowerPC kernel.
983  */
984 #define SPAPR_MAX_RAM_SLOTS     32
985 
986 /* 1GB alignment for hotplug memory region */
987 #define SPAPR_DEVICE_MEM_ALIGN (1 * GiB)
988 
989 /*
990  * Number of 32 bit words in each LMB list entry in ibm,dynamic-memory
991  * property under ibm,dynamic-reconfiguration-memory node.
992  */
993 #define SPAPR_DR_LMB_LIST_ENTRY_SIZE 6
994 
995 /*
996  * Defines for flag value in ibm,dynamic-memory property under
997  * ibm,dynamic-reconfiguration-memory node.
998  */
999 #define SPAPR_LMB_FLAGS_ASSIGNED 0x00000008
1000 #define SPAPR_LMB_FLAGS_DRC_INVALID 0x00000020
1001 #define SPAPR_LMB_FLAGS_RESERVED 0x00000080
1002 #define SPAPR_LMB_FLAGS_HOTREMOVABLE 0x00000100
1003 
1004 void spapr_do_system_reset_on_cpu(CPUState *cs, run_on_cpu_data arg);
1005 
1006 #define HTAB_SIZE(spapr)        (1ULL << ((spapr)->htab_shift))
1007 
1008 int spapr_get_vcpu_id(PowerPCCPU *cpu);
1009 bool spapr_set_vcpu_id(PowerPCCPU *cpu, int cpu_index, Error **errp);
1010 PowerPCCPU *spapr_find_cpu(int vcpu_id);
1011 
1012 int spapr_caps_pre_load(void *opaque);
1013 int spapr_caps_pre_save(void *opaque);
1014 
1015 /*
1016  * Handling of optional capabilities
1017  */
1018 extern const VMStateDescription vmstate_spapr_cap_htm;
1019 extern const VMStateDescription vmstate_spapr_cap_vsx;
1020 extern const VMStateDescription vmstate_spapr_cap_dfp;
1021 extern const VMStateDescription vmstate_spapr_cap_cfpc;
1022 extern const VMStateDescription vmstate_spapr_cap_sbbc;
1023 extern const VMStateDescription vmstate_spapr_cap_ibs;
1024 extern const VMStateDescription vmstate_spapr_cap_hpt_maxpagesize;
1025 extern const VMStateDescription vmstate_spapr_cap_nested_kvm_hv;
1026 extern const VMStateDescription vmstate_spapr_cap_large_decr;
1027 extern const VMStateDescription vmstate_spapr_cap_ccf_assist;
1028 extern const VMStateDescription vmstate_spapr_cap_fwnmi;
1029 extern const VMStateDescription vmstate_spapr_cap_rpt_invalidate;
1030 
1031 static inline uint8_t spapr_get_cap(SpaprMachineState *spapr, int cap)
1032 {
1033     return spapr->eff.caps[cap];
1034 }
1035 
1036 void spapr_caps_init(SpaprMachineState *spapr);
1037 void spapr_caps_apply(SpaprMachineState *spapr);
1038 void spapr_caps_cpu_apply(SpaprMachineState *spapr, PowerPCCPU *cpu);
1039 void spapr_caps_add_properties(SpaprMachineClass *smc);
1040 int spapr_caps_post_migration(SpaprMachineState *spapr);
1041 
1042 bool spapr_check_pagesize(SpaprMachineState *spapr, hwaddr pagesize,
1043                           Error **errp);
1044 /*
1045  * XIVE definitions
1046  */
1047 #define SPAPR_OV5_XIVE_LEGACY   0x0
1048 #define SPAPR_OV5_XIVE_EXPLOIT  0x40
1049 #define SPAPR_OV5_XIVE_BOTH     0x80 /* Only to advertise on the platform */
1050 
1051 void spapr_set_all_lpcrs(target_ulong value, target_ulong mask);
1052 hwaddr spapr_get_rtas_addr(void);
1053 bool spapr_memory_hot_unplug_supported(SpaprMachineState *spapr);
1054 
1055 void spapr_vof_reset(SpaprMachineState *spapr, void *fdt, Error **errp);
1056 void spapr_vof_quiesce(MachineState *ms);
1057 bool spapr_vof_setprop(MachineState *ms, const char *path, const char *propname,
1058                        void *val, int vallen);
1059 target_ulong spapr_h_vof_client(PowerPCCPU *cpu, SpaprMachineState *spapr,
1060                                 target_ulong opcode, target_ulong *args);
1061 target_ulong spapr_vof_client_architecture_support(MachineState *ms,
1062                                                    CPUState *cs,
1063                                                    target_ulong ovec_addr);
1064 void spapr_vof_client_dt_finalize(SpaprMachineState *spapr, void *fdt);
1065 
1066 #endif /* HW_SPAPR_H */
1067