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