include/hw/ppc/spapr.h

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