hw/s390x/s390-pci-bus.h

   1 /*
   2  * s390 PCI BUS definitions
   3  *
   4  * Copyright 2014 IBM Corp.
   5  * Author(s): Frank Blaschka <frank.blaschka@de.ibm.com>
   6  *            Hong Bo Li <lihbbj@cn.ibm.com>
   7  *            Yi Min Zhao <zyimin@cn.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2 or (at
  10  * your option) any later version. See the COPYING file in the top-level
  11  * directory.
  12  */
  13
  14 #ifndef HW_S390_PCI_BUS_H
  15 #define HW_S390_PCI_BUS_H
  16
  17 #include "hw/pci/pci.h"
  18 #include "hw/pci/pci_host.h"
  19 #include "hw/s390x/sclp.h"
  20 #include "hw/s390x/s390_flic.h"
  21 #include "hw/s390x/css.h"
  22
  23 #define TYPE_S390_PCI_HOST_BRIDGE "s390-pcihost"
  24 #define TYPE_S390_PCI_BUS "s390-pcibus"
  25 #define TYPE_S390_PCI_DEVICE "zpci"
  26 #define FH_MASK_ENABLE   0x80000000
  27 #define FH_MASK_INSTANCE 0x7f000000
  28 #define FH_MASK_SHM      0x00ff0000
  29 #define FH_MASK_INDEX    0x0000001f
  30 #define FH_SHM_VFIO      0x00010000
  31 #define FH_SHM_EMUL      0x00020000
  32 #define S390_PCIPT_ADAPTER 2
  33 #define ZPCI_MAX_FID 0xffffffff
  34 #define ZPCI_MAX_UID 0xffff
  35 #define UID_UNDEFINED 0
  36 #define UID_CHECKING_ENABLED 0x01
  37 #define HOT_UNPLUG_TIMEOUT (NANOSECONDS_PER_SECOND * 60 * 5)
  38
  39 #define S390_PCI_HOST_BRIDGE(obj) \
  40     OBJECT_CHECK(S390pciState, (obj), TYPE_S390_PCI_HOST_BRIDGE)
  41 #define S390_PCI_BUS(obj) \
  42     OBJECT_CHECK(S390PCIBus, (obj), TYPE_S390_PCI_BUS)
  43 #define S390_PCI_DEVICE(obj) \
  44     OBJECT_CHECK(S390PCIBusDevice, (obj), TYPE_S390_PCI_DEVICE)
  45
  46 #define HP_EVENT_TO_CONFIGURED        0x0301
  47 #define HP_EVENT_RESERVED_TO_STANDBY  0x0302
  48 #define HP_EVENT_DECONFIGURE_REQUEST  0x0303
  49 #define HP_EVENT_CONFIGURED_TO_STBRES 0x0304
  50 #define HP_EVENT_STANDBY_TO_RESERVED  0x0308
  51
  52 #define ERR_EVENT_INVALAS 0x1
  53 #define ERR_EVENT_OORANGE 0x2
  54 #define ERR_EVENT_INVALTF 0x3
  55 #define ERR_EVENT_TPROTE  0x4
  56 #define ERR_EVENT_APROTE  0x5
  57 #define ERR_EVENT_KEYE    0x6
  58 #define ERR_EVENT_INVALTE 0x7
  59 #define ERR_EVENT_INVALTL 0x8
  60 #define ERR_EVENT_TT      0x9
  61 #define ERR_EVENT_INVALMS 0xa
  62 #define ERR_EVENT_SERR    0xb
  63 #define ERR_EVENT_NOMSI   0x10
  64 #define ERR_EVENT_INVALBV 0x11
  65 #define ERR_EVENT_AIBV    0x12
  66 #define ERR_EVENT_AIRERR  0x13
  67 #define ERR_EVENT_FMBA    0x2a
  68 #define ERR_EVENT_FMBUP   0x2b
  69 #define ERR_EVENT_FMBPRO  0x2c
  70 #define ERR_EVENT_CCONF   0x30
  71 #define ERR_EVENT_SERVAC  0x3a
  72 #define ERR_EVENT_PERMERR 0x3b
  73
  74 #define ERR_EVENT_Q_BIT 0x2
  75 #define ERR_EVENT_MVN_OFFSET 16
  76
  77 #define ZPCI_MSI_VEC_BITS 11
  78 #define ZPCI_MSI_VEC_MASK 0x7ff
  79
  80 #define ZPCI_MSI_ADDR  0xfe00000000000000ULL
  81 #define ZPCI_SDMA_ADDR 0x100000000ULL
  82 #define ZPCI_EDMA_ADDR 0x1ffffffffffffffULL
  83
  84 #define PAGE_SHIFT      12
  85 #define PAGE_MASK       (~(PAGE_SIZE-1))
  86 #define PAGE_DEFAULT_ACC        0
  87 #define PAGE_DEFAULT_KEY        (PAGE_DEFAULT_ACC << 4)
  88
  89 /* I/O Translation Anchor (IOTA) */
  90 enum ZpciIoatDtype {
  91     ZPCI_IOTA_STO = 0,
  92     ZPCI_IOTA_RTTO = 1,
  93     ZPCI_IOTA_RSTO = 2,
  94     ZPCI_IOTA_RFTO = 3,
  95     ZPCI_IOTA_PFAA = 4,
  96     ZPCI_IOTA_IOPFAA = 5,
  97     ZPCI_IOTA_IOPTO = 7
  98 };
  99
 100 #define ZPCI_IOTA_IOT_ENABLED           0x800ULL
 101 #define ZPCI_IOTA_DT_ST                 (ZPCI_IOTA_STO  << 2)
 102 #define ZPCI_IOTA_DT_RT                 (ZPCI_IOTA_RTTO << 2)
 103 #define ZPCI_IOTA_DT_RS                 (ZPCI_IOTA_RSTO << 2)
 104 #define ZPCI_IOTA_DT_RF                 (ZPCI_IOTA_RFTO << 2)
 105 #define ZPCI_IOTA_DT_PF                 (ZPCI_IOTA_PFAA << 2)
 106 #define ZPCI_IOTA_FS_4K                 0
 107 #define ZPCI_IOTA_FS_1M                 1
 108 #define ZPCI_IOTA_FS_2G                 2
 109 #define ZPCI_KEY                        (PAGE_DEFAULT_KEY << 5)
 110
 111 #define ZPCI_IOTA_STO_FLAG  (ZPCI_IOTA_IOT_ENABLED | ZPCI_KEY | ZPCI_IOTA_DT_ST)
 112 #define ZPCI_IOTA_RTTO_FLAG (ZPCI_IOTA_IOT_ENABLED | ZPCI_KEY | ZPCI_IOTA_DT_RT)
 113 #define ZPCI_IOTA_RSTO_FLAG (ZPCI_IOTA_IOT_ENABLED | ZPCI_KEY | ZPCI_IOTA_DT_RS)
 114 #define ZPCI_IOTA_RFTO_FLAG (ZPCI_IOTA_IOT_ENABLED | ZPCI_KEY | ZPCI_IOTA_DT_RF)
 115 #define ZPCI_IOTA_RFAA_FLAG (ZPCI_IOTA_IOT_ENABLED | ZPCI_KEY |\
 116                              ZPCI_IOTA_DT_PF | ZPCI_IOTA_FS_2G)
 117
 118 /* I/O Region and segment tables */
 119 #define ZPCI_INDEX_MASK         0x7ffULL
 120
 121 #define ZPCI_TABLE_TYPE_MASK    0xc
 122 #define ZPCI_TABLE_TYPE_RFX     0xc
 123 #define ZPCI_TABLE_TYPE_RSX     0x8
 124 #define ZPCI_TABLE_TYPE_RTX     0x4
 125 #define ZPCI_TABLE_TYPE_SX      0x0
 126
 127 #define ZPCI_TABLE_LEN_RFX      0x3
 128 #define ZPCI_TABLE_LEN_RSX      0x3
 129 #define ZPCI_TABLE_LEN_RTX      0x3
 130
 131 #define ZPCI_TABLE_OFFSET_MASK  0xc0
 132 #define ZPCI_TABLE_SIZE         0x4000
 133 #define ZPCI_TABLE_ALIGN        ZPCI_TABLE_SIZE
 134 #define ZPCI_TABLE_ENTRY_SIZE   (sizeof(unsigned long))
 135 #define ZPCI_TABLE_ENTRIES      (ZPCI_TABLE_SIZE / ZPCI_TABLE_ENTRY_SIZE)
 136
 137 #define ZPCI_TABLE_BITS         11
 138 #define ZPCI_PT_BITS            8
 139 #define ZPCI_ST_SHIFT           (ZPCI_PT_BITS + PAGE_SHIFT)
 140 #define ZPCI_RT_SHIFT           (ZPCI_ST_SHIFT + ZPCI_TABLE_BITS)
 141
 142 #define ZPCI_RTE_FLAG_MASK      0x3fffULL
 143 #define ZPCI_RTE_ADDR_MASK      (~ZPCI_RTE_FLAG_MASK)
 144 #define ZPCI_STE_FLAG_MASK      0x7ffULL
 145 #define ZPCI_STE_ADDR_MASK      (~ZPCI_STE_FLAG_MASK)
 146
 147 /* I/O Page tables */
 148 #define ZPCI_PTE_VALID_MASK             0x400
 149 #define ZPCI_PTE_INVALID                0x400
 150 #define ZPCI_PTE_VALID                  0x000
 151 #define ZPCI_PT_SIZE                    0x800
 152 #define ZPCI_PT_ALIGN                   ZPCI_PT_SIZE
 153 #define ZPCI_PT_ENTRIES                 (ZPCI_PT_SIZE / ZPCI_TABLE_ENTRY_SIZE)
 154 #define ZPCI_PT_MASK                    (ZPCI_PT_ENTRIES - 1)
 155
 156 #define ZPCI_PTE_FLAG_MASK              0xfffULL
 157 #define ZPCI_PTE_ADDR_MASK              (~ZPCI_PTE_FLAG_MASK)
 158
 159 /* Shared bits */
 160 #define ZPCI_TABLE_VALID                0x00
 161 #define ZPCI_TABLE_INVALID              0x20
 162 #define ZPCI_TABLE_PROTECTED            0x200
 163 #define ZPCI_TABLE_UNPROTECTED          0x000
 164
 165 #define ZPCI_TABLE_VALID_MASK           0x20
 166 #define ZPCI_TABLE_PROT_MASK            0x200
 167
 168 /* PCI Function States
 169  *
 170  * reserved: default; device has just been plugged or is in progress of being
 171  *           unplugged
 172  * standby: device is present but not configured; transition from any
 173  *          configured state/to this state via sclp configure/deconfigure
 174  *
 175  * The following states make up the "configured" meta-state:
 176  * disabled: device is configured but not enabled; transition between this
 177  *           state and enabled via clp enable/disable
 178  * enbaled: device is ready for use; transition to disabled via clp disable;
 179  *          may enter an error state
 180  * blocked: ignore all DMA and interrupts; transition back to enabled or from
 181  *          error state via mpcifc
 182  * error: an error occured; transition back to enabled via mpcifc
 183  * permanent error: an unrecoverable error occured; transition to standby via
 184  *                  sclp deconfigure
 185  */
 186 typedef enum {
 187     ZPCI_FS_RESERVED,
 188     ZPCI_FS_STANDBY,
 189     ZPCI_FS_DISABLED,
 190     ZPCI_FS_ENABLED,
 191     ZPCI_FS_BLOCKED,
 192     ZPCI_FS_ERROR,
 193     ZPCI_FS_PERMANENT_ERROR,
 194 } ZpciState;
 195
 196 typedef struct SeiContainer {
 197     QTAILQ_ENTRY(SeiContainer) link;
 198     uint32_t fid;
 199     uint32_t fh;
 200     uint8_t cc;
 201     uint16_t pec;
 202     uint64_t faddr;
 203     uint32_t e;
 204 } SeiContainer;
 205
 206 typedef struct PciCcdfErr {
 207     uint32_t reserved1;
 208     uint32_t fh;
 209     uint32_t fid;
 210     uint32_t e;
 211     uint64_t faddr;
 212     uint32_t reserved3;
 213     uint16_t reserved4;
 214     uint16_t pec;
 215 } QEMU_PACKED PciCcdfErr;
 216
 217 typedef struct PciCcdfAvail {
 218     uint32_t reserved1;
 219     uint32_t fh;
 220     uint32_t fid;
 221     uint32_t reserved2;
 222     uint32_t reserved3;
 223     uint32_t reserved4;
 224     uint32_t reserved5;
 225     uint16_t reserved6;
 226     uint16_t pec;
 227 } QEMU_PACKED PciCcdfAvail;
 228
 229 typedef struct ChscSeiNt2Res {
 230     uint16_t length;
 231     uint16_t code;
 232     uint16_t reserved1;
 233     uint8_t reserved2;
 234     uint8_t nt;
 235     uint8_t flags;
 236     uint8_t reserved3;
 237     uint8_t reserved4;
 238     uint8_t cc;
 239     uint32_t reserved5[13];
 240     uint8_t ccdf[4016];
 241 } QEMU_PACKED ChscSeiNt2Res;
 242
 243 typedef struct PciCfgSccb {
 244     SCCBHeader header;
 245     uint8_t atype;
 246     uint8_t reserved1;
 247     uint16_t reserved2;
 248     uint32_t aid;
 249 } QEMU_PACKED PciCfgSccb;
 250
 251 typedef struct S390MsixInfo {
 252     bool available;
 253     uint8_t table_bar;
 254     uint8_t pba_bar;
 255     uint16_t entries;
 256     uint32_t table_offset;
 257     uint32_t pba_offset;
 258 } S390MsixInfo;
 259
 260 typedef struct S390PCIIOMMU {
 261     AddressSpace as;
 262     MemoryRegion mr;
 263 } S390PCIIOMMU;
 264
 265 typedef struct S390PCIBusDevice {
 266     DeviceState qdev;
 267     PCIDevice *pdev;
 268     ZpciState state;
 269     bool iommu_enabled;
 270     char *target;
 271     uint16_t uid;
 272     uint32_t fh;
 273     uint32_t fid;
 274     bool fid_defined;
 275     uint64_t g_iota;
 276     uint64_t pba;
 277     uint64_t pal;
 278     uint64_t fmb_addr;
 279     uint8_t isc;
 280     uint16_t noi;
 281     uint8_t sum;
 282     S390MsixInfo msix;
 283     AdapterRoutes routes;
 284     S390PCIIOMMU *iommu;
 285     MemoryRegion iommu_mr;
 286     IndAddr *summary_ind;
 287     IndAddr *indicator;
 288     QEMUTimer *release_timer;
 289 } S390PCIBusDevice;
 290
 291 typedef struct S390PCIBus {
 292     BusState qbus;
 293 } S390PCIBus;
 294
 295 typedef struct S390pciState {
 296     PCIHostState parent_obj;
 297     S390PCIBus *bus;
 298     S390PCIBusDevice *pbdev[PCI_SLOT_MAX];
 299     S390PCIIOMMU *iommu[PCI_SLOT_MAX];
 300     AddressSpace msix_notify_as;
 301     MemoryRegion msix_notify_mr;
 302     QTAILQ_HEAD(, SeiContainer) pending_sei;
 303 } S390pciState;
 304
 305 int chsc_sei_nt2_get_event(void *res);
 306 int chsc_sei_nt2_have_event(void);
 307 void s390_pci_sclp_configure(SCCB *sccb);
 308 void s390_pci_sclp_deconfigure(SCCB *sccb);
 309 void s390_pci_iommu_enable(S390PCIBusDevice *pbdev);
 310 void s390_pci_iommu_disable(S390PCIBusDevice *pbdev);
 311 void s390_pci_generate_error_event(uint16_t pec, uint32_t fh, uint32_t fid,
 312                                    uint64_t faddr, uint32_t e);
 313 S390PCIBusDevice *s390_pci_find_dev_by_idx(uint32_t idx);
 314 S390PCIBusDevice *s390_pci_find_dev_by_fh(uint32_t fh);
 315 S390PCIBusDevice *s390_pci_find_dev_by_fid(uint32_t fid);
 316 S390PCIBusDevice *s390_pci_find_next_avail_dev(S390PCIBusDevice *pbdev);
 317
 318 #endif