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