[mirror_qemu.git] / include / hw / ppc / spapr.h

#if !defined(__HW_SPAPR_H__)
#define __HW_SPAPR_H__

#include "sysemu/dma.h"
#include "hw/ppc/xics.h"

struct VIOsPAPRBus;
struct sPAPRPHBState;
struct sPAPRNVRAM;

#define HPTE64_V_HPTE_DIRTY     0x0000000000000040ULL

typedef struct sPAPREnvironment {
    struct VIOsPAPRBus *vio_bus;
    QLIST_HEAD(, sPAPRPHBState) phbs;
    hwaddr msi_win_addr;
    MemoryRegion msiwindow;
    struct sPAPRNVRAM *nvram;
    XICSState *icp;

    hwaddr ram_limit;
    void *htab;
    uint32_t htab_shift;
    hwaddr rma_size;
    int vrma_adjust;
    hwaddr fdt_addr, rtas_addr;
    long rtas_size;
    void *fdt_skel;
    target_ulong entry_point;
    uint32_t next_irq;
    uint64_t rtc_offset;
    struct PPCTimebase tb;
    bool has_graphics;

    uint32_t epow_irq;
    Notifier epow_notifier;

    /* Migration state */
    int htab_save_index;
    bool htab_first_pass;
    int htab_fd;
} sPAPREnvironment;

#define H_SUCCESS         0
#define H_BUSY            1        /* Hardware busy -- retry later */
#define H_CLOSED          2        /* Resource closed */
#define H_NOT_AVAILABLE   3
#define H_CONSTRAINED     4        /* Resource request constrained to max allowed */
#define H_PARTIAL         5
#define H_IN_PROGRESS     14       /* Kind of like busy */
#define H_PAGE_REGISTERED 15
#define H_PARTIAL_STORE   16
#define H_PENDING         17       /* returned from H_POLL_PENDING */
#define H_CONTINUE        18       /* Returned from H_Join on success */
#define H_LONG_BUSY_START_RANGE         9900  /* Start of long busy range */
#define H_LONG_BUSY_ORDER_1_MSEC        9900  /* Long busy, hint that 1msec \
                                                 is a good time to retry */
#define H_LONG_BUSY_ORDER_10_MSEC       9901  /* Long busy, hint that 10msec \
                                                 is a good time to retry */
#define H_LONG_BUSY_ORDER_100_MSEC      9902  /* Long busy, hint that 100msec \
                                                 is a good time to retry */
#define H_LONG_BUSY_ORDER_1_SEC         9903  /* Long busy, hint that 1sec \
                                                 is a good time to retry */
#define H_LONG_BUSY_ORDER_10_SEC        9904  /* Long busy, hint that 10sec \
                                                 is a good time to retry */
#define H_LONG_BUSY_ORDER_100_SEC       9905  /* Long busy, hint that 100sec \
                                                 is a good time to retry */
#define H_LONG_BUSY_END_RANGE           9905  /* End of long busy range */
#define H_HARDWARE        -1       /* Hardware error */
#define H_FUNCTION        -2       /* Function not supported */
#define H_PRIVILEGE       -3       /* Caller not privileged */
#define H_PARAMETER       -4       /* Parameter invalid, out-of-range or conflicting */
#define H_BAD_MODE        -5       /* Illegal msr value */
#define H_PTEG_FULL       -6       /* PTEG is full */
#define H_NOT_FOUND       -7       /* PTE was not found" */
#define H_RESERVED_DABR   -8       /* DABR address is reserved by the hypervisor on this processor" */
#define H_NO_MEM          -9
#define H_AUTHORITY       -10
#define H_PERMISSION      -11
#define H_DROPPED         -12
#define H_SOURCE_PARM     -13
#define H_DEST_PARM       -14
#define H_REMOTE_PARM     -15
#define H_RESOURCE        -16
#define H_ADAPTER_PARM    -17
#define H_RH_PARM         -18
#define H_RCQ_PARM        -19
#define H_SCQ_PARM        -20
#define H_EQ_PARM         -21
#define H_RT_PARM         -22
#define H_ST_PARM         -23
#define H_SIGT_PARM       -24
#define H_TOKEN_PARM      -25
#define H_MLENGTH_PARM    -27
#define H_MEM_PARM        -28
#define H_MEM_ACCESS_PARM -29
#define H_ATTR_PARM       -30
#define H_PORT_PARM       -31
#define H_MCG_PARM        -32
#define H_VL_PARM         -33
#define H_TSIZE_PARM      -34
#define H_TRACE_PARM      -35

#define H_MASK_PARM       -37
#define H_MCG_FULL        -38
#define H_ALIAS_EXIST     -39
#define H_P_COUNTER       -40
#define H_TABLE_FULL      -41
#define H_ALT_TABLE       -42
#define H_MR_CONDITION    -43
#define H_NOT_ENOUGH_RESOURCES -44
#define H_R_STATE         -45
#define H_RESCINDEND      -46
#define H_P2              -55
#define H_P3              -56
#define H_P4              -57
#define H_P5              -58
#define H_P6              -59
#define H_P7              -60
#define H_P8              -61
#define H_P9              -62
#define H_UNSUPPORTED_FLAG -256
#define H_MULTI_THREADS_ACTIVE -9005


/* Long Busy is a condition that can be returned by the firmware
 * when a call cannot be completed now, but the identical call
 * should be retried later.  This prevents calls blocking in the
 * firmware for long periods of time.  Annoyingly the firmware can return
 * a range of return codes, hinting at how long we should wait before
 * retrying.  If you don't care for the hint, the macro below is a good
 * way to check for the long_busy return codes
 */
#define H_IS_LONG_BUSY(x)  ((x >= H_LONG_BUSY_START_RANGE) \
                            && (x <= H_LONG_BUSY_END_RANGE))

/* Flags */
#define H_LARGE_PAGE      (1ULL<<(63-16))
#define H_EXACT           (1ULL<<(63-24))       /* Use exact PTE or return H_PTEG_FULL */
#define H_R_XLATE         (1ULL<<(63-25))       /* include a valid logical page num in the pte if the valid bit is set */
#define H_READ_4          (1ULL<<(63-26))       /* Return 4 PTEs */
#define H_PAGE_STATE_CHANGE (1ULL<<(63-28))
#define H_PAGE_UNUSED     ((1ULL<<(63-29)) | (1ULL<<(63-30)))
#define H_PAGE_SET_UNUSED (H_PAGE_STATE_CHANGE | H_PAGE_UNUSED)
#define H_PAGE_SET_LOANED (H_PAGE_SET_UNUSED | (1ULL<<(63-31)))
#define H_PAGE_SET_ACTIVE H_PAGE_STATE_CHANGE
#define H_AVPN            (1ULL<<(63-32))       /* An avpn is provided as a sanity test */
#define H_ANDCOND         (1ULL<<(63-33))
#define H_ICACHE_INVALIDATE (1ULL<<(63-40))     /* icbi, etc.  (ignored for IO pages) */
#define H_ICACHE_SYNCHRONIZE (1ULL<<(63-41))    /* dcbst, icbi, etc (ignored for IO pages */
#define H_ZERO_PAGE       (1ULL<<(63-48))       /* zero the page before mapping (ignored for IO pages) */
#define H_COPY_PAGE       (1ULL<<(63-49))
#define H_N               (1ULL<<(63-61))
#define H_PP1             (1ULL<<(63-62))
#define H_PP2             (1ULL<<(63-63))

/* Values for 2nd argument to H_SET_MODE */
#define H_SET_MODE_RESOURCE_SET_CIABR           1
#define H_SET_MODE_RESOURCE_SET_DAWR            2
#define H_SET_MODE_RESOURCE_ADDR_TRANS_MODE     3
#define H_SET_MODE_RESOURCE_LE                  4

/* Flags for H_SET_MODE_RESOURCE_LE */
#define H_SET_MODE_ENDIAN_BIG    0
#define H_SET_MODE_ENDIAN_LITTLE 1

/* VASI States */
#define H_VASI_INVALID    0
#define H_VASI_ENABLED    1
#define H_VASI_ABORTED    2
#define H_VASI_SUSPENDING 3
#define H_VASI_SUSPENDED  4
#define H_VASI_RESUMED    5
#define H_VASI_COMPLETED  6

/* DABRX flags */
#define H_DABRX_HYPERVISOR (1ULL<<(63-61))
#define H_DABRX_KERNEL     (1ULL<<(63-62))
#define H_DABRX_USER       (1ULL<<(63-63))

/* Each control block has to be on a 4K boundary */
#define H_CB_ALIGNMENT     4096

/* pSeries hypervisor opcodes */
#define H_REMOVE                0x04
#define H_ENTER                 0x08
#define H_READ                  0x0c
#define H_CLEAR_MOD             0x10
#define H_CLEAR_REF             0x14
#define H_PROTECT               0x18
#define H_GET_TCE               0x1c
#define H_PUT_TCE               0x20
#define H_SET_SPRG0             0x24
#define H_SET_DABR              0x28
#define H_PAGE_INIT             0x2c
#define H_SET_ASR               0x30
#define H_ASR_ON                0x34
#define H_ASR_OFF               0x38
#define H_LOGICAL_CI_LOAD       0x3c
#define H_LOGICAL_CI_STORE      0x40
#define H_LOGICAL_CACHE_LOAD    0x44
#define H_LOGICAL_CACHE_STORE   0x48
#define H_LOGICAL_ICBI          0x4c
#define H_LOGICAL_DCBF          0x50
#define H_GET_TERM_CHAR         0x54
#define H_PUT_TERM_CHAR         0x58
#define H_REAL_TO_LOGICAL       0x5c
#define H_HYPERVISOR_DATA       0x60
#define H_EOI                   0x64
#define H_CPPR                  0x68
#define H_IPI                   0x6c
#define H_IPOLL                 0x70
#define H_XIRR                  0x74
#define H_PERFMON               0x7c
#define H_MIGRATE_DMA           0x78
#define H_REGISTER_VPA          0xDC
#define H_CEDE                  0xE0
#define H_CONFER                0xE4
#define H_PROD                  0xE8
#define H_GET_PPP               0xEC
#define H_SET_PPP               0xF0
#define H_PURR                  0xF4
#define H_PIC                   0xF8
#define H_REG_CRQ               0xFC
#define H_FREE_CRQ              0x100
#define H_VIO_SIGNAL            0x104
#define H_SEND_CRQ              0x108
#define H_COPY_RDMA             0x110
#define H_REGISTER_LOGICAL_LAN  0x114
#define H_FREE_LOGICAL_LAN      0x118
#define H_ADD_LOGICAL_LAN_BUFFER 0x11C
#define H_SEND_LOGICAL_LAN      0x120
#define H_BULK_REMOVE           0x124
#define H_MULTICAST_CTRL        0x130
#define H_SET_XDABR             0x134
#define H_STUFF_TCE             0x138
#define H_PUT_TCE_INDIRECT      0x13C
#define H_CHANGE_LOGICAL_LAN_MAC 0x14C
#define H_VTERM_PARTNER_INFO    0x150
#define H_REGISTER_VTERM        0x154
#define H_FREE_VTERM            0x158
#define H_RESET_EVENTS          0x15C
#define H_ALLOC_RESOURCE        0x160
#define H_FREE_RESOURCE         0x164
#define H_MODIFY_QP             0x168
#define H_QUERY_QP              0x16C
#define H_REREGISTER_PMR        0x170
#define H_REGISTER_SMR          0x174
#define H_QUERY_MR              0x178
#define H_QUERY_MW              0x17C
#define H_QUERY_HCA             0x180
#define H_QUERY_PORT            0x184
#define H_MODIFY_PORT           0x188
#define H_DEFINE_AQP1           0x18C
#define H_GET_TRACE_BUFFER      0x190
#define H_DEFINE_AQP0           0x194
#define H_RESIZE_MR             0x198
#define H_ATTACH_MCQP           0x19C
#define H_DETACH_MCQP           0x1A0
#define H_CREATE_RPT            0x1A4
#define H_REMOVE_RPT            0x1A8
#define H_REGISTER_RPAGES       0x1AC
#define H_DISABLE_AND_GETC      0x1B0
#define H_ERROR_DATA            0x1B4
#define H_GET_HCA_INFO          0x1B8
#define H_GET_PERF_COUNT        0x1BC
#define H_MANAGE_TRACE          0x1C0
#define H_FREE_LOGICAL_LAN_BUFFER 0x1D4
#define H_QUERY_INT_STATE       0x1E4
#define H_POLL_PENDING          0x1D8
#define H_ILLAN_ATTRIBUTES      0x244
#define H_MODIFY_HEA_QP         0x250
#define H_QUERY_HEA_QP          0x254
#define H_QUERY_HEA             0x258
#define H_QUERY_HEA_PORT        0x25C
#define H_MODIFY_HEA_PORT       0x260
#define H_REG_BCMC              0x264
#define H_DEREG_BCMC            0x268
#define H_REGISTER_HEA_RPAGES   0x26C
#define H_DISABLE_AND_GET_HEA   0x270
#define H_GET_HEA_INFO          0x274
#define H_ALLOC_HEA_RESOURCE    0x278
#define H_ADD_CONN              0x284
#define H_DEL_CONN              0x288
#define H_JOIN                  0x298
#define H_VASI_STATE            0x2A4
#define H_ENABLE_CRQ            0x2B0
#define H_GET_EM_PARMS          0x2B8
#define H_SET_MPP               0x2D0
#define H_GET_MPP               0x2D4
#define H_XIRR_X                0x2FC
#define H_SET_MODE              0x31C
#define MAX_HCALL_OPCODE        H_SET_MODE

/* The hcalls above are standardized in PAPR and implemented by pHyp
 * as well.
 *
 * We also need some hcalls which are specific to qemu / KVM-on-POWER.
 * So far we just need one for H_RTAS, but in future we'll need more
 * for extensions like virtio.  We put those into the 0xf000-0xfffc
 * range which is reserved by PAPR for "platform-specific" hcalls.
 */
#define KVMPPC_HCALL_BASE       0xf000
#define KVMPPC_H_RTAS           (KVMPPC_HCALL_BASE + 0x0)
#define KVMPPC_H_LOGICAL_MEMOP  (KVMPPC_HCALL_BASE + 0x1)
/* Client Architecture support */
#define KVMPPC_H_CAS            (KVMPPC_HCALL_BASE + 0x2)
#define KVMPPC_HCALL_MAX        KVMPPC_H_CAS

extern sPAPREnvironment *spapr;

typedef struct sPAPRDeviceTreeUpdateHeader {
    uint32_t version_id;
} sPAPRDeviceTreeUpdateHeader;

/*#define DEBUG_SPAPR_HCALLS*/

#ifdef DEBUG_SPAPR_HCALLS
#define hcall_dprintf(fmt, ...) \
    do { fprintf(stderr, "%s: " fmt, __func__, ## __VA_ARGS__); } while (0)
#else
#define hcall_dprintf(fmt, ...) \
    do { } while (0)
#endif

typedef target_ulong (*spapr_hcall_fn)(PowerPCCPU *cpu, sPAPREnvironment *spapr,
                                       target_ulong opcode,
                                       target_ulong *args);

void spapr_register_hypercall(target_ulong opcode, spapr_hcall_fn fn);
target_ulong spapr_hypercall(PowerPCCPU *cpu, target_ulong opcode,
                             target_ulong *args);

int spapr_allocate_irq(int hint, bool lsi);
int spapr_allocate_irq_block(int num, bool lsi, bool msi);

static inline int spapr_allocate_msi(int hint)
{
    return spapr_allocate_irq(hint, false);
}

static inline int spapr_allocate_lsi(int hint)
{
    return spapr_allocate_irq(hint, true);
}

/* RTAS return codes */
#define RTAS_OUT_SUCCESS            0
#define RTAS_OUT_NO_ERRORS_FOUND    1
#define RTAS_OUT_HW_ERROR           -1
#define RTAS_OUT_BUSY               -2
#define RTAS_OUT_PARAM_ERROR        -3
#define RTAS_OUT_NOT_SUPPORTED      -3
#define RTAS_OUT_NOT_AUTHORIZED     -9002

static inline uint64_t ppc64_phys_to_real(uint64_t addr)
{
    return addr & ~0xF000000000000000ULL;
}

static inline uint32_t rtas_ld(target_ulong phys, int n)
{
    return ldl_be_phys(&address_space_memory, ppc64_phys_to_real(phys + 4*n));
}

static inline void rtas_st(target_ulong phys, int n, uint32_t val)
{
    stl_be_phys(&address_space_memory, ppc64_phys_to_real(phys + 4*n), val);
}

typedef void (*spapr_rtas_fn)(PowerPCCPU *cpu, sPAPREnvironment *spapr,
                              uint32_t token,
                              uint32_t nargs, target_ulong args,
                              uint32_t nret, target_ulong rets);
int spapr_rtas_register(const char *name, spapr_rtas_fn fn);
target_ulong spapr_rtas_call(PowerPCCPU *cpu, sPAPREnvironment *spapr,
                             uint32_t token, uint32_t nargs, target_ulong args,
                             uint32_t nret, target_ulong rets);
int spapr_rtas_device_tree_setup(void *fdt, hwaddr rtas_addr,
                                 hwaddr rtas_size);

#define SPAPR_TCE_PAGE_SHIFT   12
#define SPAPR_TCE_PAGE_SIZE    (1ULL << SPAPR_TCE_PAGE_SHIFT)
#define SPAPR_TCE_PAGE_MASK    (SPAPR_TCE_PAGE_SIZE - 1)

#define SPAPR_VIO_BASE_LIOBN    0x00000000
#define SPAPR_PCI_BASE_LIOBN    0x80000000

#define RTAS_ERROR_LOG_MAX      2048

typedef struct sPAPRTCETable sPAPRTCETable;

#define TYPE_SPAPR_TCE_TABLE "spapr-tce-table"
#define SPAPR_TCE_TABLE(obj) \
    OBJECT_CHECK(sPAPRTCETable, (obj), TYPE_SPAPR_TCE_TABLE)

struct sPAPRTCETable {
    DeviceState parent;
    uint32_t liobn;
    uint32_t nb_table;
    uint64_t *table;
    bool bypass;
    int fd;
    MemoryRegion iommu;
    QLIST_ENTRY(sPAPRTCETable) list;
};

void spapr_events_init(sPAPREnvironment *spapr);
void spapr_events_fdt_skel(void *fdt, uint32_t epow_irq);
int spapr_h_cas_compose_response(target_ulong addr, target_ulong size);
sPAPRTCETable *spapr_tce_new_table(DeviceState *owner, uint32_t liobn,
                                   uint32_t nb_table);
MemoryRegion *spapr_tce_get_iommu(sPAPRTCETable *tcet);
void spapr_tce_set_bypass(sPAPRTCETable *tcet, bool bypass);
int spapr_dma_dt(void *fdt, int node_off, const char *propname,
                 uint32_t liobn, uint64_t window, uint32_t size);
int spapr_tcet_dma_dt(void *fdt, int node_off, const char *propname,
                      sPAPRTCETable *tcet);

#endif /* !defined (__HW_SPAPR_H__) */
Commit	Line	Data
9fdf0c29 DG	1	#if !defined(__HW_SPAPR_H__)
	2	#define __HW_SPAPR_H__
	3
9c17d615	4	#include "sysemu/dma.h"
0d09e41a	5	#include "hw/ppc/xics.h"
277f9acf	6
4040ab72	7	struct VIOsPAPRBus;
3384f95c	8	struct sPAPRPHBState;
639e8102	9	struct sPAPRNVRAM;
4040ab72	10
4be21d56 DG	11	#define HPTE64_V_HPTE_DIRTY 0x0000000000000040ULL
4be21d56 DG	12
9fdf0c29	13	typedef struct sPAPREnvironment {
4040ab72	14	struct VIOsPAPRBus *vio_bus;
3384f95c	15	QLIST_HEAD(, sPAPRPHBState) phbs;
f1c2dc7c AK	16	hwaddr msi_win_addr;
f1c2dc7c AK	17	MemoryRegion msiwindow;
639e8102	18	struct sPAPRNVRAM *nvram;
c04d6cfa	19	XICSState *icp;
a3467baa	20
a8170e5e	21	hwaddr ram_limit;
a3467baa	22	void *htab;
4be21d56	23	uint32_t htab_shift;
a8170e5e	24	hwaddr rma_size;
7f763a5d	25	int vrma_adjust;
a8170e5e	26	hwaddr fdt_addr, rtas_addr;
a3467baa DG	27	long rtas_size;
	28	void *fdt_skel;
	29	target_ulong entry_point;
4be21d56 DG	30	uint32_t next_irq;
4be21d56 DG	31	uint64_t rtc_offset;
98a8b524	32	struct PPCTimebase tb;
3fc5acde	33	bool has_graphics;
74d042e5 DG	34
	35	uint32_t epow_irq;
	36	Notifier epow_notifier;
4be21d56 DG	37
	38	/* Migration state */
	39	int htab_save_index;
	40	bool htab_first_pass;
e68cb8b4	41	int htab_fd;
9fdf0c29 DG	42	} sPAPREnvironment;
	43
	44	#define H_SUCCESS 0
	45	#define H_BUSY 1 /* Hardware busy -- retry later */
	46	#define H_CLOSED 2 /* Resource closed */
	47	#define H_NOT_AVAILABLE 3
	48	#define H_CONSTRAINED 4 /* Resource request constrained to max allowed */
	49	#define H_PARTIAL 5
	50	#define H_IN_PROGRESS 14 /* Kind of like busy */
	51	#define H_PAGE_REGISTERED 15
	52	#define H_PARTIAL_STORE 16
	53	#define H_PENDING 17 /* returned from H_POLL_PENDING */
	54	#define H_CONTINUE 18 /* Returned from H_Join on success */
	55	#define H_LONG_BUSY_START_RANGE 9900 /* Start of long busy range */
	56	#define H_LONG_BUSY_ORDER_1_MSEC 9900 /* Long busy, hint that 1msec \
	57	is a good time to retry */
	58	#define H_LONG_BUSY_ORDER_10_MSEC 9901 /* Long busy, hint that 10msec \
	59	is a good time to retry */
	60	#define H_LONG_BUSY_ORDER_100_MSEC 9902 /* Long busy, hint that 100msec \
	61	is a good time to retry */
	62	#define H_LONG_BUSY_ORDER_1_SEC 9903 /* Long busy, hint that 1sec \
	63	is a good time to retry */
	64	#define H_LONG_BUSY_ORDER_10_SEC 9904 /* Long busy, hint that 10sec \
	65	is a good time to retry */
	66	#define H_LONG_BUSY_ORDER_100_SEC 9905 /* Long busy, hint that 100sec \
	67	is a good time to retry */
	68	#define H_LONG_BUSY_END_RANGE 9905 /* End of long busy range */
	69	#define H_HARDWARE -1 /* Hardware error */
	70	#define H_FUNCTION -2 /* Function not supported */
	71	#define H_PRIVILEGE -3 /* Caller not privileged */
	72	#define H_PARAMETER -4 /* Parameter invalid, out-of-range or conflicting */
	73	#define H_BAD_MODE -5 /* Illegal msr value */
	74	#define H_PTEG_FULL -6 /* PTEG is full */
	75	#define H_NOT_FOUND -7 /* PTE was not found" */
	76	#define H_RESERVED_DABR -8 /* DABR address is reserved by the hypervisor on this processor" */
	77	#define H_NO_MEM -9
	78	#define H_AUTHORITY -10
	79	#define H_PERMISSION -11
	80	#define H_DROPPED -12
	81	#define H_SOURCE_PARM -13
	82	#define H_DEST_PARM -14
	83	#define H_REMOTE_PARM -15
	84	#define H_RESOURCE -16
	85	#define H_ADAPTER_PARM -17
	86	#define H_RH_PARM -18
	87	#define H_RCQ_PARM -19
	88	#define H_SCQ_PARM -20
	89	#define H_EQ_PARM -21
	90	#define H_RT_PARM -22
	91	#define H_ST_PARM -23
	92	#define H_SIGT_PARM -24
	93	#define H_TOKEN_PARM -25
	94	#define H_MLENGTH_PARM -27
	95	#define H_MEM_PARM -28
	96	#define H_MEM_ACCESS_PARM -29
	97	#define H_ATTR_PARM -30
	98	#define H_PORT_PARM -31
	99	#define H_MCG_PARM -32
	100	#define H_VL_PARM -33
	101	#define H_TSIZE_PARM -34
	102	#define H_TRACE_PARM -35
	103
	104	#define H_MASK_PARM -37
	105	#define H_MCG_FULL -38
106	#define H_ALIAS_EXIST -39
107	#define H_P_COUNTER -40
108	#define H_TABLE_FULL -41
109	#define H_ALT_TABLE -42
110	#define H_MR_CONDITION -43
111	#define H_NOT_ENOUGH_RESOURCES -44
112	#define H_R_STATE -45
113	#define H_RESCINDEND -46
42561bf2 AB	114	#define H_P2 -55
	115	#define H_P3 -56
	116	#define H_P4 -57
	117	#define H_P5 -58
	118	#define H_P6 -59
	119	#define H_P7 -60
	120	#define H_P8 -61
	121	#define H_P9 -62
	122	#define H_UNSUPPORTED_FLAG -256
9fdf0c29 DG	123	#define H_MULTI_THREADS_ACTIVE -9005
	124
	125
	126	/* Long Busy is a condition that can be returned by the firmware
	127	* when a call cannot be completed now, but the identical call
	128	* should be retried later. This prevents calls blocking in the
	129	* firmware for long periods of time. Annoyingly the firmware can return
	130	* a range of return codes, hinting at how long we should wait before
	131	* retrying. If you don't care for the hint, the macro below is a good
	132	* way to check for the long_busy return codes
	133	*/
	134	#define H_IS_LONG_BUSY(x) ((x >= H_LONG_BUSY_START_RANGE) \
	135	&& (x <= H_LONG_BUSY_END_RANGE))
	136
	137	/* Flags */
	138	#define H_LARGE_PAGE (1ULL<<(63-16))
	139	#define H_EXACT (1ULL<<(63-24)) /* Use exact PTE or return H_PTEG_FULL */
	140	#define H_R_XLATE (1ULL<<(63-25)) /* include a valid logical page num in the pte if the valid bit is set */
	141	#define H_READ_4 (1ULL<<(63-26)) /* Return 4 PTEs */
	142	#define H_PAGE_STATE_CHANGE (1ULL<<(63-28))
	143	#define H_PAGE_UNUSED ((1ULL<<(63-29)) \| (1ULL<<(63-30)))
	144	#define H_PAGE_SET_UNUSED (H_PAGE_STATE_CHANGE \| H_PAGE_UNUSED)
	145	#define H_PAGE_SET_LOANED (H_PAGE_SET_UNUSED \| (1ULL<<(63-31)))
	146	#define H_PAGE_SET_ACTIVE H_PAGE_STATE_CHANGE
	147	#define H_AVPN (1ULL<<(63-32)) /* An avpn is provided as a sanity test */
	148	#define H_ANDCOND (1ULL<<(63-33))
	149	#define H_ICACHE_INVALIDATE (1ULL<<(63-40)) /* icbi, etc. (ignored for IO pages) */
	150	#define H_ICACHE_SYNCHRONIZE (1ULL<<(63-41)) /* dcbst, icbi, etc (ignored for IO pages */
	151	#define H_ZERO_PAGE (1ULL<<(63-48)) /* zero the page before mapping (ignored for IO pages) */
	152	#define H_COPY_PAGE (1ULL<<(63-49))
	153	#define H_N (1ULL<<(63-61))
	154	#define H_PP1 (1ULL<<(63-62))
	155	#define H_PP2 (1ULL<<(63-63))
	156
a46622fd AK	157	/* Values for 2nd argument to H_SET_MODE */
	158	#define H_SET_MODE_RESOURCE_SET_CIABR 1
	159	#define H_SET_MODE_RESOURCE_SET_DAWR 2
	160	#define H_SET_MODE_RESOURCE_ADDR_TRANS_MODE 3
	161	#define H_SET_MODE_RESOURCE_LE 4
	162
	163	/* Flags for H_SET_MODE_RESOURCE_LE */
42561bf2 AB	164	#define H_SET_MODE_ENDIAN_BIG 0
	165	#define H_SET_MODE_ENDIAN_LITTLE 1
	166
9fdf0c29 DG	167	/* VASI States */
	168	#define H_VASI_INVALID 0
	169	#define H_VASI_ENABLED 1
	170	#define H_VASI_ABORTED 2
	171	#define H_VASI_SUSPENDING 3
	172	#define H_VASI_SUSPENDED 4
	173	#define H_VASI_RESUMED 5
	174	#define H_VASI_COMPLETED 6
	175
	176	/* DABRX flags */
	177	#define H_DABRX_HYPERVISOR (1ULL<<(63-61))
	178	#define H_DABRX_KERNEL (1ULL<<(63-62))
	179	#define H_DABRX_USER (1ULL<<(63-63))
	180
66a0a2cb	181	/* Each control block has to be on a 4K boundary */
9fdf0c29 DG	182	#define H_CB_ALIGNMENT 4096
	183
	184	/* pSeries hypervisor opcodes */
	185	#define H_REMOVE 0x04
	186	#define H_ENTER 0x08
	187	#define H_READ 0x0c
	188	#define H_CLEAR_MOD 0x10
	189	#define H_CLEAR_REF 0x14
	190	#define H_PROTECT 0x18
	191	#define H_GET_TCE 0x1c
	192	#define H_PUT_TCE 0x20
	193	#define H_SET_SPRG0 0x24
	194	#define H_SET_DABR 0x28
	195	#define H_PAGE_INIT 0x2c
	196	#define H_SET_ASR 0x30
	197	#define H_ASR_ON 0x34
	198	#define H_ASR_OFF 0x38
	199	#define H_LOGICAL_CI_LOAD 0x3c
	200	#define H_LOGICAL_CI_STORE 0x40
	201	#define H_LOGICAL_CACHE_LOAD 0x44
	202	#define H_LOGICAL_CACHE_STORE 0x48
	203	#define H_LOGICAL_ICBI 0x4c
	204	#define H_LOGICAL_DCBF 0x50
	205	#define H_GET_TERM_CHAR 0x54
	206	#define H_PUT_TERM_CHAR 0x58
	207	#define H_REAL_TO_LOGICAL 0x5c
	208	#define H_HYPERVISOR_DATA 0x60
	209	#define H_EOI 0x64
	210	#define H_CPPR 0x68
	211	#define H_IPI 0x6c
	212	#define H_IPOLL 0x70
	213	#define H_XIRR 0x74
	214	#define H_PERFMON 0x7c
	215	#define H_MIGRATE_DMA 0x78
	216	#define H_REGISTER_VPA 0xDC
	217	#define H_CEDE 0xE0
	218	#define H_CONFER 0xE4
	219	#define H_PROD 0xE8
	220	#define H_GET_PPP 0xEC
	221	#define H_SET_PPP 0xF0
	222	#define H_PURR 0xF4
	223	#define H_PIC 0xF8
	224	#define H_REG_CRQ 0xFC
	225	#define H_FREE_CRQ 0x100
	226	#define H_VIO_SIGNAL 0x104
	227	#define H_SEND_CRQ 0x108
	228	#define H_COPY_RDMA 0x110
	229	#define H_REGISTER_LOGICAL_LAN 0x114
	230	#define H_FREE_LOGICAL_LAN 0x118
	231	#define H_ADD_LOGICAL_LAN_BUFFER 0x11C
	232	#define H_SEND_LOGICAL_LAN 0x120
	233	#define H_BULK_REMOVE 0x124
	234	#define H_MULTICAST_CTRL 0x130
	235	#define H_SET_XDABR 0x134
	236	#define H_STUFF_TCE 0x138
	237	#define H_PUT_TCE_INDIRECT 0x13C
	238	#define H_CHANGE_LOGICAL_LAN_MAC 0x14C
	239	#define H_VTERM_PARTNER_INFO 0x150
	240	#define H_REGISTER_VTERM 0x154
	241	#define H_FREE_VTERM 0x158
	242	#define H_RESET_EVENTS 0x15C
	243	#define H_ALLOC_RESOURCE 0x160
	244	#define H_FREE_RESOURCE 0x164
	245	#define H_MODIFY_QP 0x168
246	#define H_QUERY_QP 0x16C
247	#define H_REREGISTER_PMR 0x170
248	#define H_REGISTER_SMR 0x174
249	#define H_QUERY_MR 0x178
250	#define H_QUERY_MW 0x17C
251	#define H_QUERY_HCA 0x180
252	#define H_QUERY_PORT 0x184
253	#define H_MODIFY_PORT 0x188
254	#define H_DEFINE_AQP1 0x18C
255	#define H_GET_TRACE_BUFFER 0x190
256	#define H_DEFINE_AQP0 0x194
257	#define H_RESIZE_MR 0x198
258	#define H_ATTACH_MCQP 0x19C
259	#define H_DETACH_MCQP 0x1A0
260	#define H_CREATE_RPT 0x1A4
261	#define H_REMOVE_RPT 0x1A8
262	#define H_REGISTER_RPAGES 0x1AC
263	#define H_DISABLE_AND_GETC 0x1B0
264	#define H_ERROR_DATA 0x1B4
265	#define H_GET_HCA_INFO 0x1B8
266	#define H_GET_PERF_COUNT 0x1BC
267	#define H_MANAGE_TRACE 0x1C0
268	#define H_FREE_LOGICAL_LAN_BUFFER 0x1D4
269	#define H_QUERY_INT_STATE 0x1E4
270	#define H_POLL_PENDING 0x1D8
271	#define H_ILLAN_ATTRIBUTES 0x244
272	#define H_MODIFY_HEA_QP 0x250
273	#define H_QUERY_HEA_QP 0x254
274	#define H_QUERY_HEA 0x258
275	#define H_QUERY_HEA_PORT 0x25C
276	#define H_MODIFY_HEA_PORT 0x260
277	#define H_REG_BCMC 0x264
278	#define H_DEREG_BCMC 0x268
279	#define H_REGISTER_HEA_RPAGES 0x26C
280	#define H_DISABLE_AND_GET_HEA 0x270
281	#define H_GET_HEA_INFO 0x274
282	#define H_ALLOC_HEA_RESOURCE 0x278
283	#define H_ADD_CONN 0x284
284	#define H_DEL_CONN 0x288
285	#define H_JOIN 0x298
286	#define H_VASI_STATE 0x2A4
287	#define H_ENABLE_CRQ 0x2B0
288	#define H_GET_EM_PARMS 0x2B8
289	#define H_SET_MPP 0x2D0
290	#define H_GET_MPP 0x2D4
5d87e4b7	291	#define H_XIRR_X 0x2FC
42561bf2 AB	292	#define H_SET_MODE 0x31C
42561bf2 AB	293	#define MAX_HCALL_OPCODE H_SET_MODE
9fdf0c29	294
39ac8455 DG	295	/* The hcalls above are standardized in PAPR and implemented by pHyp
	296	* as well.
	297	*
	298	* We also need some hcalls which are specific to qemu / KVM-on-POWER.
	299	* So far we just need one for H_RTAS, but in future we'll need more
	300	* for extensions like virtio. We put those into the 0xf000-0xfffc
	301	* range which is reserved by PAPR for "platform-specific" hcalls.
	302	*/
	303	#define KVMPPC_HCALL_BASE 0xf000
	304	#define KVMPPC_H_RTAS (KVMPPC_HCALL_BASE + 0x0)
c73e3771	305	#define KVMPPC_H_LOGICAL_MEMOP (KVMPPC_HCALL_BASE + 0x1)
2a6593cb AK	306	/* Client Architecture support */
	307	#define KVMPPC_H_CAS (KVMPPC_HCALL_BASE + 0x2)
	308	#define KVMPPC_HCALL_MAX KVMPPC_H_CAS
39ac8455	309
9fdf0c29 DG	310	extern sPAPREnvironment *spapr;
9fdf0c29 DG	311
2a6593cb AK	312	typedef struct sPAPRDeviceTreeUpdateHeader {
	313	uint32_t version_id;
	314	} sPAPRDeviceTreeUpdateHeader;
	315
9fdf0c29 DG	316	/#define DEBUG_SPAPR_HCALLS/
	317
	318	#ifdef DEBUG_SPAPR_HCALLS
	319	#define hcall_dprintf(fmt, ...) \
d9599c92	320	do { fprintf(stderr, "%s: " fmt, __func__, ## __VA_ARGS__); } while (0)
9fdf0c29 DG	321	#else
	322	#define hcall_dprintf(fmt, ...) \
	323	do { } while (0)
	324	#endif
	325
b13ce26d	326	typedef target_ulong (spapr_hcall_fn)(PowerPCCPU cpu, sPAPREnvironment *spapr,
9fdf0c29 DG	327	target_ulong opcode,
	328	target_ulong *args);
	329
	330	void spapr_register_hypercall(target_ulong opcode, spapr_hcall_fn fn);
aa100fa4	331	target_ulong spapr_hypercall(PowerPCCPU *cpu, target_ulong opcode,
9fdf0c29 DG	332	target_ulong *args);
9fdf0c29 DG	333
ff9d2afa	334	int spapr_allocate_irq(int hint, bool lsi);
f1c2dc7c	335	int spapr_allocate_irq_block(int num, bool lsi, bool msi);
d07fee7e	336
a307d594	337	static inline int spapr_allocate_msi(int hint)
d07fee7e	338	{
ff9d2afa	339	return spapr_allocate_irq(hint, false);
d07fee7e DG	340	}
d07fee7e DG	341
a307d594	342	static inline int spapr_allocate_lsi(int hint)
d07fee7e	343	{
ff9d2afa	344	return spapr_allocate_irq(hint, true);
d07fee7e	345	}
277f9acf	346
a64d325d AK	347	/* RTAS return codes */
	348	#define RTAS_OUT_SUCCESS 0
	349	#define RTAS_OUT_NO_ERRORS_FOUND 1
	350	#define RTAS_OUT_HW_ERROR -1
	351	#define RTAS_OUT_BUSY -2
	352	#define RTAS_OUT_PARAM_ERROR -3
3ada6b11 AK	353	#define RTAS_OUT_NOT_SUPPORTED -3
3ada6b11 AK	354	#define RTAS_OUT_NOT_AUTHORIZED -9002
a64d325d	355
4fe822e0 AK	356	static inline uint64_t ppc64_phys_to_real(uint64_t addr)
	357	{
	358	return addr & ~0xF000000000000000ULL;
	359	}
	360
39ac8455 DG	361	static inline uint32_t rtas_ld(target_ulong phys, int n)
39ac8455 DG	362	{
fdfba1a2	363	return ldl_be_phys(&address_space_memory, ppc64_phys_to_real(phys + 4*n));
39ac8455 DG	364	}
	365
	366	static inline void rtas_st(target_ulong phys, int n, uint32_t val)
	367	{
ab1da857	368	stl_be_phys(&address_space_memory, ppc64_phys_to_real(phys + 4*n), val);
39ac8455 DG	369	}
39ac8455 DG	370
210b580b AL	371	typedef void (spapr_rtas_fn)(PowerPCCPU cpu, sPAPREnvironment *spapr,
210b580b AL	372	uint32_t token,
39ac8455 DG	373	uint32_t nargs, target_ulong args,
39ac8455 DG	374	uint32_t nret, target_ulong rets);
4aac82c3	375	int spapr_rtas_register(const char *name, spapr_rtas_fn fn);
210b580b	376	target_ulong spapr_rtas_call(PowerPCCPU cpu, sPAPREnvironment spapr,
39ac8455 DG	377	uint32_t token, uint32_t nargs, target_ulong args,
39ac8455 DG	378	uint32_t nret, target_ulong rets);
a8170e5e AK	379	int spapr_rtas_device_tree_setup(void *fdt, hwaddr rtas_addr,
a8170e5e AK	380	hwaddr rtas_size);
39ac8455	381
ad0ebb91 DG	382	#define SPAPR_TCE_PAGE_SHIFT 12
	383	#define SPAPR_TCE_PAGE_SIZE (1ULL << SPAPR_TCE_PAGE_SHIFT)
	384	#define SPAPR_TCE_PAGE_MASK (SPAPR_TCE_PAGE_SIZE - 1)
	385
ad0ebb91	386	#define SPAPR_VIO_BASE_LIOBN 0x00000000
edded454	387	#define SPAPR_PCI_BASE_LIOBN 0x80000000
ad0ebb91	388
74d042e5 DG	389	#define RTAS_ERROR_LOG_MAX 2048
74d042e5 DG	390
2b7dc949	391	typedef struct sPAPRTCETable sPAPRTCETable;
74d042e5	392
a83000f5 AL	393	#define TYPE_SPAPR_TCE_TABLE "spapr-tce-table"
	394	#define SPAPR_TCE_TABLE(obj) \
	395	OBJECT_CHECK(sPAPRTCETable, (obj), TYPE_SPAPR_TCE_TABLE)
	396
	397	struct sPAPRTCETable {
	398	DeviceState parent;
	399	uint32_t liobn;
a83000f5 AL	400	uint32_t nb_table;
	401	uint64_t *table;
	402	bool bypass;
	403	int fd;
	404	MemoryRegion iommu;
	405	QLIST_ENTRY(sPAPRTCETable) list;
	406	};
	407
74d042e5 DG	408	void spapr_events_init(sPAPREnvironment *spapr);
74d042e5 DG	409	void spapr_events_fdt_skel(void *fdt, uint32_t epow_irq);
2a6593cb	410	int spapr_h_cas_compose_response(target_ulong addr, target_ulong size);
84af6d9f	411	sPAPRTCETable spapr_tce_new_table(DeviceState owner, uint32_t liobn,
523e7b8a	412	uint32_t nb_table);
a84bb436	413	MemoryRegion spapr_tce_get_iommu(sPAPRTCETable tcet);
2b7dc949	414	void spapr_tce_set_bypass(sPAPRTCETable *tcet, bool bypass);
ad0ebb91	415	int spapr_dma_dt(void fdt, int node_off, const char propname,
5c4cbcf2 AK	416	uint32_t liobn, uint64_t window, uint32_t size);
5c4cbcf2 AK	417	int spapr_tcet_dma_dt(void fdt, int node_off, const char propname,
2b7dc949	418	sPAPRTCETable *tcet);
ad0ebb91	419
9fdf0c29	420	#endif /* !defined (__HW_SPAPR_H__) */