include/hw/pci/pci.h

   1 #ifndef QEMU_PCI_H
   2 #define QEMU_PCI_H
   3
   4 #include "hw/qdev.h"
   5 #include "exec/memory.h"
   6 #include "sysemu/dma.h"
   7
   8 /* PCI includes legacy ISA access.  */
   9 #include "hw/isa/isa.h"
  10
  11 #include "hw/pci/pcie.h"
  12
  13 extern bool pci_available;
  14
  15 /* PCI bus */
  16
  17 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
  18 #define PCI_BUS_NUM(x)          (((x) >> 8) & 0xff)
  19 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
  20 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
  21 #define PCI_BUILD_BDF(bus, devfn)     ((bus << 8) | (devfn))
  22 #define PCI_BUS_MAX             256
  23 #define PCI_DEVFN_MAX           256
  24 #define PCI_SLOT_MAX            32
  25 #define PCI_FUNC_MAX            8
  26
  27 /* Class, Vendor and Device IDs from Linux's pci_ids.h */
  28 #include "hw/pci/pci_ids.h"
  29
  30 /* QEMU-specific Vendor and Device ID definitions */
  31
  32 /* IBM (0x1014) */
  33 #define PCI_DEVICE_ID_IBM_440GX          0x027f
  34 #define PCI_DEVICE_ID_IBM_OPENPIC2       0xffff
  35
  36 /* Hitachi (0x1054) */
  37 #define PCI_VENDOR_ID_HITACHI            0x1054
  38 #define PCI_DEVICE_ID_HITACHI_SH7751R    0x350e
  39
  40 /* Apple (0x106b) */
  41 #define PCI_DEVICE_ID_APPLE_343S1201     0x0010
  42 #define PCI_DEVICE_ID_APPLE_UNI_N_I_PCI  0x001e
  43 #define PCI_DEVICE_ID_APPLE_UNI_N_PCI    0x001f
  44 #define PCI_DEVICE_ID_APPLE_UNI_N_KEYL   0x0022
  45 #define PCI_DEVICE_ID_APPLE_IPID_USB     0x003f
  46
  47 /* Realtek (0x10ec) */
  48 #define PCI_DEVICE_ID_REALTEK_8029       0x8029
  49
  50 /* Xilinx (0x10ee) */
  51 #define PCI_DEVICE_ID_XILINX_XC2VP30     0x0300
  52
  53 /* Marvell (0x11ab) */
  54 #define PCI_DEVICE_ID_MARVELL_GT6412X    0x4620
  55
  56 /* QEMU/Bochs VGA (0x1234) */
  57 #define PCI_VENDOR_ID_QEMU               0x1234
  58 #define PCI_DEVICE_ID_QEMU_VGA           0x1111
  59
  60 /* VMWare (0x15ad) */
  61 #define PCI_VENDOR_ID_VMWARE             0x15ad
  62 #define PCI_DEVICE_ID_VMWARE_SVGA2       0x0405
  63 #define PCI_DEVICE_ID_VMWARE_SVGA        0x0710
  64 #define PCI_DEVICE_ID_VMWARE_NET         0x0720
  65 #define PCI_DEVICE_ID_VMWARE_SCSI        0x0730
  66 #define PCI_DEVICE_ID_VMWARE_PVSCSI      0x07C0
  67 #define PCI_DEVICE_ID_VMWARE_IDE         0x1729
  68 #define PCI_DEVICE_ID_VMWARE_VMXNET3     0x07B0
  69
  70 /* Intel (0x8086) */
  71 #define PCI_DEVICE_ID_INTEL_82551IT      0x1209
  72 #define PCI_DEVICE_ID_INTEL_82557        0x1229
  73 #define PCI_DEVICE_ID_INTEL_82801IR      0x2922
  74
  75 /* Red Hat / Qumranet (for QEMU) -- see pci-ids.txt */
  76 #define PCI_VENDOR_ID_REDHAT_QUMRANET    0x1af4
  77 #define PCI_SUBVENDOR_ID_REDHAT_QUMRANET 0x1af4
  78 #define PCI_SUBDEVICE_ID_QEMU            0x1100
  79
  80 #define PCI_DEVICE_ID_VIRTIO_NET         0x1000
  81 #define PCI_DEVICE_ID_VIRTIO_BLOCK       0x1001
  82 #define PCI_DEVICE_ID_VIRTIO_BALLOON     0x1002
  83 #define PCI_DEVICE_ID_VIRTIO_CONSOLE     0x1003
  84 #define PCI_DEVICE_ID_VIRTIO_SCSI        0x1004
  85 #define PCI_DEVICE_ID_VIRTIO_RNG         0x1005
  86 #define PCI_DEVICE_ID_VIRTIO_9P          0x1009
  87 #define PCI_DEVICE_ID_VIRTIO_VSOCK       0x1012
  88
  89 #define PCI_VENDOR_ID_REDHAT             0x1b36
  90 #define PCI_DEVICE_ID_REDHAT_BRIDGE      0x0001
  91 #define PCI_DEVICE_ID_REDHAT_SERIAL      0x0002
  92 #define PCI_DEVICE_ID_REDHAT_SERIAL2     0x0003
  93 #define PCI_DEVICE_ID_REDHAT_SERIAL4     0x0004
  94 #define PCI_DEVICE_ID_REDHAT_TEST        0x0005
  95 #define PCI_DEVICE_ID_REDHAT_ROCKER      0x0006
  96 #define PCI_DEVICE_ID_REDHAT_SDHCI       0x0007
  97 #define PCI_DEVICE_ID_REDHAT_PCIE_HOST   0x0008
  98 #define PCI_DEVICE_ID_REDHAT_PXB         0x0009
  99 #define PCI_DEVICE_ID_REDHAT_BRIDGE_SEAT 0x000a
 100 #define PCI_DEVICE_ID_REDHAT_PXB_PCIE    0x000b
 101 #define PCI_DEVICE_ID_REDHAT_PCIE_RP     0x000c
 102 #define PCI_DEVICE_ID_REDHAT_XHCI        0x000d
 103 #define PCI_DEVICE_ID_REDHAT_PCIE_BRIDGE 0x000e
 104 #define PCI_DEVICE_ID_REDHAT_QXL         0x0100
 105
 106 #define FMT_PCIBUS                      PRIx64
 107
 108 typedef uint64_t pcibus_t;
 109
 110 struct PCIHostDeviceAddress {
 111     unsigned int domain;
 112     unsigned int bus;
 113     unsigned int slot;
 114     unsigned int function;
 115 };
 116
 117 typedef void PCIConfigWriteFunc(PCIDevice *pci_dev,
 118                                 uint32_t address, uint32_t data, int len);
 119 typedef uint32_t PCIConfigReadFunc(PCIDevice *pci_dev,
 120                                    uint32_t address, int len);
 121 typedef void PCIMapIORegionFunc(PCIDevice *pci_dev, int region_num,
 122                                 pcibus_t addr, pcibus_t size, int type);
 123 typedef void PCIUnregisterFunc(PCIDevice *pci_dev);
 124
 125 typedef struct PCIIORegion {
 126     pcibus_t addr; /* current PCI mapping address. -1 means not mapped */
 127 #define PCI_BAR_UNMAPPED (~(pcibus_t)0)
 128     pcibus_t size;
 129     uint8_t type;
 130     MemoryRegion *memory;
 131     MemoryRegion *address_space;
 132 } PCIIORegion;
 133
 134 #define PCI_ROM_SLOT 6
 135 #define PCI_NUM_REGIONS 7
 136
 137 enum {
 138     QEMU_PCI_VGA_MEM,
 139     QEMU_PCI_VGA_IO_LO,
 140     QEMU_PCI_VGA_IO_HI,
 141     QEMU_PCI_VGA_NUM_REGIONS,
 142 };
 143
 144 #define QEMU_PCI_VGA_MEM_BASE 0xa0000
 145 #define QEMU_PCI_VGA_MEM_SIZE 0x20000
 146 #define QEMU_PCI_VGA_IO_LO_BASE 0x3b0
 147 #define QEMU_PCI_VGA_IO_LO_SIZE 0xc
 148 #define QEMU_PCI_VGA_IO_HI_BASE 0x3c0
 149 #define QEMU_PCI_VGA_IO_HI_SIZE 0x20
 150
 151 #include "hw/pci/pci_regs.h"
 152
 153 /* PCI HEADER_TYPE */
 154 #define  PCI_HEADER_TYPE_MULTI_FUNCTION 0x80
 155
 156 /* Size of the standard PCI config header */
 157 #define PCI_CONFIG_HEADER_SIZE 0x40
 158 /* Size of the standard PCI config space */
 159 #define PCI_CONFIG_SPACE_SIZE 0x100
 160 /* Size of the standard PCIe config space: 4KB */
 161 #define PCIE_CONFIG_SPACE_SIZE  0x1000
 162
 163 #define PCI_NUM_PINS 4 /* A-D */
 164
 165 /* Bits in cap_present field. */
 166 enum {
 167     QEMU_PCI_CAP_MSI = 0x1,
 168     QEMU_PCI_CAP_MSIX = 0x2,
 169     QEMU_PCI_CAP_EXPRESS = 0x4,
 170
 171     /* multifunction capable device */
 172 #define QEMU_PCI_CAP_MULTIFUNCTION_BITNR        3
 173     QEMU_PCI_CAP_MULTIFUNCTION = (1 << QEMU_PCI_CAP_MULTIFUNCTION_BITNR),
 174
 175     /* command register SERR bit enabled */
 176 #define QEMU_PCI_CAP_SERR_BITNR 4
 177     QEMU_PCI_CAP_SERR = (1 << QEMU_PCI_CAP_SERR_BITNR),
 178     /* Standard hot plug controller. */
 179 #define QEMU_PCI_SHPC_BITNR 5
 180     QEMU_PCI_CAP_SHPC = (1 << QEMU_PCI_SHPC_BITNR),
 181 #define QEMU_PCI_SLOTID_BITNR 6
 182     QEMU_PCI_CAP_SLOTID = (1 << QEMU_PCI_SLOTID_BITNR),
 183     /* PCI Express capability - Power Controller Present */
 184 #define QEMU_PCIE_SLTCAP_PCP_BITNR 7
 185     QEMU_PCIE_SLTCAP_PCP = (1 << QEMU_PCIE_SLTCAP_PCP_BITNR),
 186     /* Link active status in endpoint capability is always set */
 187 #define QEMU_PCIE_LNKSTA_DLLLA_BITNR 8
 188     QEMU_PCIE_LNKSTA_DLLLA = (1 << QEMU_PCIE_LNKSTA_DLLLA_BITNR),
 189 #define QEMU_PCIE_EXTCAP_INIT_BITNR 9
 190     QEMU_PCIE_EXTCAP_INIT = (1 << QEMU_PCIE_EXTCAP_INIT_BITNR),
 191 };
 192
 193 #define TYPE_PCI_DEVICE "pci-device"
 194 #define PCI_DEVICE(obj) \
 195      OBJECT_CHECK(PCIDevice, (obj), TYPE_PCI_DEVICE)
 196 #define PCI_DEVICE_CLASS(klass) \
 197      OBJECT_CLASS_CHECK(PCIDeviceClass, (klass), TYPE_PCI_DEVICE)
 198 #define PCI_DEVICE_GET_CLASS(obj) \
 199      OBJECT_GET_CLASS(PCIDeviceClass, (obj), TYPE_PCI_DEVICE)
 200
 201 /* Implemented by devices that can be plugged on PCI Express buses */
 202 #define INTERFACE_PCIE_DEVICE "pci-express-device"
 203
 204 /* Implemented by devices that can be plugged on Conventional PCI buses */
 205 #define INTERFACE_CONVENTIONAL_PCI_DEVICE "conventional-pci-device"
 206
 207 typedef struct PCIINTxRoute {
 208     enum {
 209         PCI_INTX_ENABLED,
 210         PCI_INTX_INVERTED,
 211         PCI_INTX_DISABLED,
 212     } mode;
 213     int irq;
 214 } PCIINTxRoute;
 215
 216 typedef struct PCIDeviceClass {
 217     DeviceClass parent_class;
 218
 219     void (*realize)(PCIDevice *dev, Error **errp);
 220     int (*init)(PCIDevice *dev);/* TODO convert to realize() and remove */
 221     PCIUnregisterFunc *exit;
 222     PCIConfigReadFunc *config_read;
 223     PCIConfigWriteFunc *config_write;
 224
 225     uint16_t vendor_id;
 226     uint16_t device_id;
 227     uint8_t revision;
 228     uint16_t class_id;
 229     uint16_t subsystem_vendor_id;       /* only for header type = 0 */
 230     uint16_t subsystem_id;              /* only for header type = 0 */
 231
 232     /*
 233      * pci-to-pci bridge or normal device.
 234      * This doesn't mean pci host switch.
 235      * When card bus bridge is supported, this would be enhanced.
 236      */
 237     int is_bridge;
 238
 239     /* pcie stuff */
 240     int is_express;   /* is this device pci express? */
 241
 242     /* rom bar */
 243     const char *romfile;
 244 } PCIDeviceClass;
 245
 246 typedef void (*PCIINTxRoutingNotifier)(PCIDevice *dev);
 247 typedef int (*MSIVectorUseNotifier)(PCIDevice *dev, unsigned int vector,
 248                                       MSIMessage msg);
 249 typedef void (*MSIVectorReleaseNotifier)(PCIDevice *dev, unsigned int vector);
 250 typedef void (*MSIVectorPollNotifier)(PCIDevice *dev,
 251                                       unsigned int vector_start,
 252                                       unsigned int vector_end);
 253
 254 enum PCIReqIDType {
 255     PCI_REQ_ID_INVALID = 0,
 256     PCI_REQ_ID_BDF,
 257     PCI_REQ_ID_SECONDARY_BUS,
 258     PCI_REQ_ID_MAX,
 259 };
 260 typedef enum PCIReqIDType PCIReqIDType;
 261
 262 struct PCIReqIDCache {
 263     PCIDevice *dev;
 264     PCIReqIDType type;
 265 };
 266 typedef struct PCIReqIDCache PCIReqIDCache;
 267
 268 struct PCIDevice {
 269     DeviceState qdev;
 270
 271     /* PCI config space */
 272     uint8_t *config;
 273
 274     /* Used to enable config checks on load. Note that writable bits are
 275      * never checked even if set in cmask. */
 276     uint8_t *cmask;
 277
 278     /* Used to implement R/W bytes */
 279     uint8_t *wmask;
 280
 281     /* Used to implement RW1C(Write 1 to Clear) bytes */
 282     uint8_t *w1cmask;
 283
 284     /* Used to allocate config space for capabilities. */
 285     uint8_t *used;
 286
 287     /* the following fields are read only */
 288     int32_t devfn;
 289     /* Cached device to fetch requester ID from, to avoid the PCI
 290      * tree walking every time we invoke PCI request (e.g.,
 291      * MSI). For conventional PCI root complex, this field is
 292      * meaningless. */
 293     PCIReqIDCache requester_id_cache;
 294     char name[64];
 295     PCIIORegion io_regions[PCI_NUM_REGIONS];
 296     AddressSpace bus_master_as;
 297     MemoryRegion bus_master_container_region;
 298     MemoryRegion bus_master_enable_region;
 299
 300     /* do not access the following fields */
 301     PCIConfigReadFunc *config_read;
 302     PCIConfigWriteFunc *config_write;
 303
 304     /* Legacy PCI VGA regions */
 305     MemoryRegion *vga_regions[QEMU_PCI_VGA_NUM_REGIONS];
 306     bool has_vga;
 307
 308     /* Current IRQ levels.  Used internally by the generic PCI code.  */
 309     uint8_t irq_state;
 310
 311     /* Capability bits */
 312     uint32_t cap_present;
 313
 314     /* Offset of MSI-X capability in config space */
 315     uint8_t msix_cap;
 316
 317     /* MSI-X entries */
 318     int msix_entries_nr;
 319
 320     /* Space to store MSIX table & pending bit array */
 321     uint8_t *msix_table;
 322     uint8_t *msix_pba;
 323     /* MemoryRegion container for msix exclusive BAR setup */
 324     MemoryRegion msix_exclusive_bar;
 325     /* Memory Regions for MSIX table and pending bit entries. */
 326     MemoryRegion msix_table_mmio;
 327     MemoryRegion msix_pba_mmio;
 328     /* Reference-count for entries actually in use by driver. */
 329     unsigned *msix_entry_used;
 330     /* MSIX function mask set or MSIX disabled */
 331     bool msix_function_masked;
 332     /* Version id needed for VMState */
 333     int32_t version_id;
 334
 335     /* Offset of MSI capability in config space */
 336     uint8_t msi_cap;
 337
 338     /* PCI Express */
 339     PCIExpressDevice exp;
 340
 341     /* SHPC */
 342     SHPCDevice *shpc;
 343
 344     /* Location of option rom */
 345     char *romfile;
 346     bool has_rom;
 347     MemoryRegion rom;
 348     uint32_t rom_bar;
 349
 350     /* INTx routing notifier */
 351     PCIINTxRoutingNotifier intx_routing_notifier;
 352
 353     /* MSI-X notifiers */
 354     MSIVectorUseNotifier msix_vector_use_notifier;
 355     MSIVectorReleaseNotifier msix_vector_release_notifier;
 356     MSIVectorPollNotifier msix_vector_poll_notifier;
 357 };
 358
 359 void pci_register_bar(PCIDevice *pci_dev, int region_num,
 360                       uint8_t attr, MemoryRegion *memory);
 361 void pci_register_vga(PCIDevice *pci_dev, MemoryRegion *mem,
 362                       MemoryRegion *io_lo, MemoryRegion *io_hi);
 363 void pci_unregister_vga(PCIDevice *pci_dev);
 364 pcibus_t pci_get_bar_addr(PCIDevice *pci_dev, int region_num);
 365
 366 int pci_add_capability(PCIDevice *pdev, uint8_t cap_id,
 367                        uint8_t offset, uint8_t size,
 368                        Error **errp);
 369
 370 void pci_del_capability(PCIDevice *pci_dev, uint8_t cap_id, uint8_t cap_size);
 371
 372 uint8_t pci_find_capability(PCIDevice *pci_dev, uint8_t cap_id);
 373
 374
 375 uint32_t pci_default_read_config(PCIDevice *d,
 376                                  uint32_t address, int len);
 377 void pci_default_write_config(PCIDevice *d,
 378                               uint32_t address, uint32_t val, int len);
 379 void pci_device_save(PCIDevice *s, QEMUFile *f);
 380 int pci_device_load(PCIDevice *s, QEMUFile *f);
 381 MemoryRegion *pci_address_space(PCIDevice *dev);
 382 MemoryRegion *pci_address_space_io(PCIDevice *dev);
 383
 384 /*
 385  * Should not normally be used by devices. For use by sPAPR target
 386  * where QEMU emulates firmware.
 387  */
 388 int pci_bar(PCIDevice *d, int reg);
 389
 390 typedef void (*pci_set_irq_fn)(void *opaque, int irq_num, int level);
 391 typedef int (*pci_map_irq_fn)(PCIDevice *pci_dev, int irq_num);
 392 typedef PCIINTxRoute (*pci_route_irq_fn)(void *opaque, int pin);
 393
 394 #define TYPE_PCI_BUS "PCI"
 395 #define PCI_BUS(obj) OBJECT_CHECK(PCIBus, (obj), TYPE_PCI_BUS)
 396 #define PCI_BUS_CLASS(klass) OBJECT_CLASS_CHECK(PCIBusClass, (klass), TYPE_PCI_BUS)
 397 #define PCI_BUS_GET_CLASS(obj) OBJECT_GET_CLASS(PCIBusClass, (obj), TYPE_PCI_BUS)
 398 #define TYPE_PCIE_BUS "PCIE"
 399
 400 bool pci_bus_is_express(PCIBus *bus);
 401 bool pci_bus_is_root(PCIBus *bus);
 402 void pci_root_bus_new_inplace(PCIBus *bus, size_t bus_size, DeviceState *parent,
 403                               const char *name,
 404                               MemoryRegion *address_space_mem,
 405                               MemoryRegion *address_space_io,
 406                               uint8_t devfn_min, const char *typename);
 407 PCIBus *pci_root_bus_new(DeviceState *parent, const char *name,
 408                          MemoryRegion *address_space_mem,
 409                          MemoryRegion *address_space_io,
 410                          uint8_t devfn_min, const char *typename);
 411 void pci_bus_irqs(PCIBus *bus, pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
 412                   void *irq_opaque, int nirq);
 413 int pci_bus_get_irq_level(PCIBus *bus, int irq_num);
 414 /* 0 <= pin <= 3 0 = INTA, 1 = INTB, 2 = INTC, 3 = INTD */
 415 int pci_swizzle_map_irq_fn(PCIDevice *pci_dev, int pin);
 416 PCIBus *pci_register_root_bus(DeviceState *parent, const char *name,
 417                               pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
 418                               void *irq_opaque,
 419                               MemoryRegion *address_space_mem,
 420                               MemoryRegion *address_space_io,
 421                               uint8_t devfn_min, int nirq,
 422                               const char *typename);
 423 void pci_bus_set_route_irq_fn(PCIBus *, pci_route_irq_fn);
 424 PCIINTxRoute pci_device_route_intx_to_irq(PCIDevice *dev, int pin);
 425 bool pci_intx_route_changed(PCIINTxRoute *old, PCIINTxRoute *new);
 426 void pci_bus_fire_intx_routing_notifier(PCIBus *bus);
 427 void pci_device_set_intx_routing_notifier(PCIDevice *dev,
 428                                           PCIINTxRoutingNotifier notifier);
 429 void pci_device_reset(PCIDevice *dev);
 430
 431 PCIDevice *pci_nic_init_nofail(NICInfo *nd, PCIBus *rootbus,
 432                                const char *default_model,
 433                                const char *default_devaddr);
 434
 435 PCIDevice *pci_vga_init(PCIBus *bus);
 436
 437 static inline PCIBus *pci_get_bus(const PCIDevice *dev)
 438 {
 439     return PCI_BUS(qdev_get_parent_bus(DEVICE(dev)));
 440 }
 441 int pci_bus_num(PCIBus *s);
 442 static inline int pci_dev_bus_num(const PCIDevice *dev)
 443 {
 444     return pci_bus_num(pci_get_bus(dev));
 445 }
 446
 447 int pci_bus_numa_node(PCIBus *bus);
 448 void pci_for_each_device(PCIBus *bus, int bus_num,
 449                          void (*fn)(PCIBus *bus, PCIDevice *d, void *opaque),
 450                          void *opaque);
 451 void pci_for_each_device_reverse(PCIBus *bus, int bus_num,
 452                                  void (*fn)(PCIBus *bus, PCIDevice *d,
 453                                             void *opaque),
 454                                  void *opaque);
 455 void pci_for_each_bus_depth_first(PCIBus *bus,
 456                                   void *(*begin)(PCIBus *bus, void *parent_state),
 457                                   void (*end)(PCIBus *bus, void *state),
 458                                   void *parent_state);
 459 PCIDevice *pci_get_function_0(PCIDevice *pci_dev);
 460
 461 /* Use this wrapper when specific scan order is not required. */
 462 static inline
 463 void pci_for_each_bus(PCIBus *bus,
 464                       void (*fn)(PCIBus *bus, void *opaque),
 465                       void *opaque)
 466 {
 467     pci_for_each_bus_depth_first(bus, NULL, fn, opaque);
 468 }
 469
 470 PCIBus *pci_device_root_bus(const PCIDevice *d);
 471 const char *pci_root_bus_path(PCIDevice *dev);
 472 PCIDevice *pci_find_device(PCIBus *bus, int bus_num, uint8_t devfn);
 473 int pci_qdev_find_device(const char *id, PCIDevice **pdev);
 474 void pci_bus_get_w64_range(PCIBus *bus, Range *range);
 475
 476 void pci_device_deassert_intx(PCIDevice *dev);
 477
 478 typedef AddressSpace *(*PCIIOMMUFunc)(PCIBus *, void *, int);
 479
 480 AddressSpace *pci_device_iommu_address_space(PCIDevice *dev);
 481 void pci_setup_iommu(PCIBus *bus, PCIIOMMUFunc fn, void *opaque);
 482
 483 static inline void
 484 pci_set_byte(uint8_t *config, uint8_t val)
 485 {
 486     *config = val;
 487 }
 488
 489 static inline uint8_t
 490 pci_get_byte(const uint8_t *config)
 491 {
 492     return *config;
 493 }
 494
 495 static inline void
 496 pci_set_word(uint8_t *config, uint16_t val)
 497 {
 498     stw_le_p(config, val);
 499 }
 500
 501 static inline uint16_t
 502 pci_get_word(const uint8_t *config)
 503 {
 504     return lduw_le_p(config);
 505 }
 506
 507 static inline void
 508 pci_set_long(uint8_t *config, uint32_t val)
 509 {
 510     stl_le_p(config, val);
 511 }
 512
 513 static inline uint32_t
 514 pci_get_long(const uint8_t *config)
 515 {
 516     return ldl_le_p(config);
 517 }
 518
 519 /*
 520  * PCI capabilities and/or their fields
 521  * are generally DWORD aligned only so
 522  * mechanism used by pci_set/get_quad()
 523  * must be tolerant to unaligned pointers
 524  *
 525  */
 526 static inline void
 527 pci_set_quad(uint8_t *config, uint64_t val)
 528 {
 529     stq_le_p(config, val);
 530 }
 531
 532 static inline uint64_t
 533 pci_get_quad(const uint8_t *config)
 534 {
 535     return ldq_le_p(config);
 536 }
 537
 538 static inline void
 539 pci_config_set_vendor_id(uint8_t *pci_config, uint16_t val)
 540 {
 541     pci_set_word(&pci_config[PCI_VENDOR_ID], val);
 542 }
 543
 544 static inline void
 545 pci_config_set_device_id(uint8_t *pci_config, uint16_t val)
 546 {
 547     pci_set_word(&pci_config[PCI_DEVICE_ID], val);
 548 }
 549
 550 static inline void
 551 pci_config_set_revision(uint8_t *pci_config, uint8_t val)
 552 {
 553     pci_set_byte(&pci_config[PCI_REVISION_ID], val);
 554 }
 555
 556 static inline void
 557 pci_config_set_class(uint8_t *pci_config, uint16_t val)
 558 {
 559     pci_set_word(&pci_config[PCI_CLASS_DEVICE], val);
 560 }
 561
 562 static inline void
 563 pci_config_set_prog_interface(uint8_t *pci_config, uint8_t val)
 564 {
 565     pci_set_byte(&pci_config[PCI_CLASS_PROG], val);
 566 }
 567
 568 static inline void
 569 pci_config_set_interrupt_pin(uint8_t *pci_config, uint8_t val)
 570 {
 571     pci_set_byte(&pci_config[PCI_INTERRUPT_PIN], val);
 572 }
 573
 574 /*
 575  * helper functions to do bit mask operation on configuration space.
 576  * Just to set bit, use test-and-set and discard returned value.
 577  * Just to clear bit, use test-and-clear and discard returned value.
 578  * NOTE: They aren't atomic.
 579  */
 580 static inline uint8_t
 581 pci_byte_test_and_clear_mask(uint8_t *config, uint8_t mask)
 582 {
 583     uint8_t val = pci_get_byte(config);
 584     pci_set_byte(config, val & ~mask);
 585     return val & mask;
 586 }
 587
 588 static inline uint8_t
 589 pci_byte_test_and_set_mask(uint8_t *config, uint8_t mask)
 590 {
 591     uint8_t val = pci_get_byte(config);
 592     pci_set_byte(config, val | mask);
 593     return val & mask;
 594 }
 595
 596 static inline uint16_t
 597 pci_word_test_and_clear_mask(uint8_t *config, uint16_t mask)
 598 {
 599     uint16_t val = pci_get_word(config);
 600     pci_set_word(config, val & ~mask);
 601     return val & mask;
 602 }
 603
 604 static inline uint16_t
 605 pci_word_test_and_set_mask(uint8_t *config, uint16_t mask)
 606 {
 607     uint16_t val = pci_get_word(config);
 608     pci_set_word(config, val | mask);
 609     return val & mask;
 610 }
 611
 612 static inline uint32_t
 613 pci_long_test_and_clear_mask(uint8_t *config, uint32_t mask)
 614 {
 615     uint32_t val = pci_get_long(config);
 616     pci_set_long(config, val & ~mask);
 617     return val & mask;
 618 }
 619
 620 static inline uint32_t
 621 pci_long_test_and_set_mask(uint8_t *config, uint32_t mask)
 622 {
 623     uint32_t val = pci_get_long(config);
 624     pci_set_long(config, val | mask);
 625     return val & mask;
 626 }
 627
 628 static inline uint64_t
 629 pci_quad_test_and_clear_mask(uint8_t *config, uint64_t mask)
 630 {
 631     uint64_t val = pci_get_quad(config);
 632     pci_set_quad(config, val & ~mask);
 633     return val & mask;
 634 }
 635
 636 static inline uint64_t
 637 pci_quad_test_and_set_mask(uint8_t *config, uint64_t mask)
 638 {
 639     uint64_t val = pci_get_quad(config);
 640     pci_set_quad(config, val | mask);
 641     return val & mask;
 642 }
 643
 644 /* Access a register specified by a mask */
 645 static inline void
 646 pci_set_byte_by_mask(uint8_t *config, uint8_t mask, uint8_t reg)
 647 {
 648     uint8_t val = pci_get_byte(config);
 649     uint8_t rval = reg << ctz32(mask);
 650     pci_set_byte(config, (~mask & val) | (mask & rval));
 651 }
 652
 653 static inline uint8_t
 654 pci_get_byte_by_mask(uint8_t *config, uint8_t mask)
 655 {
 656     uint8_t val = pci_get_byte(config);
 657     return (val & mask) >> ctz32(mask);
 658 }
 659
 660 static inline void
 661 pci_set_word_by_mask(uint8_t *config, uint16_t mask, uint16_t reg)
 662 {
 663     uint16_t val = pci_get_word(config);
 664     uint16_t rval = reg << ctz32(mask);
 665     pci_set_word(config, (~mask & val) | (mask & rval));
 666 }
 667
 668 static inline uint16_t
 669 pci_get_word_by_mask(uint8_t *config, uint16_t mask)
 670 {
 671     uint16_t val = pci_get_word(config);
 672     return (val & mask) >> ctz32(mask);
 673 }
 674
 675 static inline void
 676 pci_set_long_by_mask(uint8_t *config, uint32_t mask, uint32_t reg)
 677 {
 678     uint32_t val = pci_get_long(config);
 679     uint32_t rval = reg << ctz32(mask);
 680     pci_set_long(config, (~mask & val) | (mask & rval));
 681 }
 682
 683 static inline uint32_t
 684 pci_get_long_by_mask(uint8_t *config, uint32_t mask)
 685 {
 686     uint32_t val = pci_get_long(config);
 687     return (val & mask) >> ctz32(mask);
 688 }
 689
 690 static inline void
 691 pci_set_quad_by_mask(uint8_t *config, uint64_t mask, uint64_t reg)
 692 {
 693     uint64_t val = pci_get_quad(config);
 694     uint64_t rval = reg << ctz32(mask);
 695     pci_set_quad(config, (~mask & val) | (mask & rval));
 696 }
 697
 698 static inline uint64_t
 699 pci_get_quad_by_mask(uint8_t *config, uint64_t mask)
 700 {
 701     uint64_t val = pci_get_quad(config);
 702     return (val & mask) >> ctz32(mask);
 703 }
 704
 705 PCIDevice *pci_create_multifunction(PCIBus *bus, int devfn, bool multifunction,
 706                                     const char *name);
 707 PCIDevice *pci_create_simple_multifunction(PCIBus *bus, int devfn,
 708                                            bool multifunction,
 709                                            const char *name);
 710 PCIDevice *pci_create(PCIBus *bus, int devfn, const char *name);
 711 PCIDevice *pci_create_simple(PCIBus *bus, int devfn, const char *name);
 712
 713 void lsi53c895a_create(PCIBus *bus);
 714
 715 qemu_irq pci_allocate_irq(PCIDevice *pci_dev);
 716 void pci_set_irq(PCIDevice *pci_dev, int level);
 717
 718 static inline void pci_irq_assert(PCIDevice *pci_dev)
 719 {
 720     pci_set_irq(pci_dev, 1);
 721 }
 722
 723 static inline void pci_irq_deassert(PCIDevice *pci_dev)
 724 {
 725     pci_set_irq(pci_dev, 0);
 726 }
 727
 728 /*
 729  * FIXME: PCI does not work this way.
 730  * All the callers to this method should be fixed.
 731  */
 732 static inline void pci_irq_pulse(PCIDevice *pci_dev)
 733 {
 734     pci_irq_assert(pci_dev);
 735     pci_irq_deassert(pci_dev);
 736 }
 737
 738 static inline int pci_is_express(const PCIDevice *d)
 739 {
 740     return d->cap_present & QEMU_PCI_CAP_EXPRESS;
 741 }
 742
 743 static inline uint32_t pci_config_size(const PCIDevice *d)
 744 {
 745     return pci_is_express(d) ? PCIE_CONFIG_SPACE_SIZE : PCI_CONFIG_SPACE_SIZE;
 746 }
 747
 748 static inline uint16_t pci_get_bdf(PCIDevice *dev)
 749 {
 750     return PCI_BUILD_BDF(pci_bus_num(pci_get_bus(dev)), dev->devfn);
 751 }
 752
 753 uint16_t pci_requester_id(PCIDevice *dev);
 754
 755 /* DMA access functions */
 756 static inline AddressSpace *pci_get_address_space(PCIDevice *dev)
 757 {
 758     return &dev->bus_master_as;
 759 }
 760
 761 static inline int pci_dma_rw(PCIDevice *dev, dma_addr_t addr,
 762                              void *buf, dma_addr_t len, DMADirection dir)
 763 {
 764     dma_memory_rw(pci_get_address_space(dev), addr, buf, len, dir);
 765     return 0;
 766 }
 767
 768 static inline int pci_dma_read(PCIDevice *dev, dma_addr_t addr,
 769                                void *buf, dma_addr_t len)
 770 {
 771     return pci_dma_rw(dev, addr, buf, len, DMA_DIRECTION_TO_DEVICE);
 772 }
 773
 774 static inline int pci_dma_write(PCIDevice *dev, dma_addr_t addr,
 775                                 const void *buf, dma_addr_t len)
 776 {
 777     return pci_dma_rw(dev, addr, (void *) buf, len, DMA_DIRECTION_FROM_DEVICE);
 778 }
 779
 780 #define PCI_DMA_DEFINE_LDST(_l, _s, _bits)                              \
 781     static inline uint##_bits##_t ld##_l##_pci_dma(PCIDevice *dev,      \
 782                                                    dma_addr_t addr)     \
 783     {                                                                   \
 784         return ld##_l##_dma(pci_get_address_space(dev), addr);          \
 785     }                                                                   \
 786     static inline void st##_s##_pci_dma(PCIDevice *dev,                 \
 787                                         dma_addr_t addr, uint##_bits##_t val) \
 788     {                                                                   \
 789         st##_s##_dma(pci_get_address_space(dev), addr, val);            \
 790     }
 791
 792 PCI_DMA_DEFINE_LDST(ub, b, 8);
 793 PCI_DMA_DEFINE_LDST(uw_le, w_le, 16)
 794 PCI_DMA_DEFINE_LDST(l_le, l_le, 32);
 795 PCI_DMA_DEFINE_LDST(q_le, q_le, 64);
 796 PCI_DMA_DEFINE_LDST(uw_be, w_be, 16)
 797 PCI_DMA_DEFINE_LDST(l_be, l_be, 32);
 798 PCI_DMA_DEFINE_LDST(q_be, q_be, 64);
 799
 800 #undef PCI_DMA_DEFINE_LDST
 801
 802 static inline void *pci_dma_map(PCIDevice *dev, dma_addr_t addr,
 803                                 dma_addr_t *plen, DMADirection dir)
 804 {
 805     void *buf;
 806
 807     buf = dma_memory_map(pci_get_address_space(dev), addr, plen, dir);
 808     return buf;
 809 }
 810
 811 static inline void pci_dma_unmap(PCIDevice *dev, void *buffer, dma_addr_t len,
 812                                  DMADirection dir, dma_addr_t access_len)
 813 {
 814     dma_memory_unmap(pci_get_address_space(dev), buffer, len, dir, access_len);
 815 }
 816
 817 static inline void pci_dma_sglist_init(QEMUSGList *qsg, PCIDevice *dev,
 818                                        int alloc_hint)
 819 {
 820     qemu_sglist_init(qsg, DEVICE(dev), alloc_hint, pci_get_address_space(dev));
 821 }
 822
 823 extern const VMStateDescription vmstate_pci_device;
 824
 825 #define VMSTATE_PCI_DEVICE(_field, _state) {                         \
 826     .name       = (stringify(_field)),                               \
 827     .size       = sizeof(PCIDevice),                                 \
 828     .vmsd       = &vmstate_pci_device,                               \
 829     .flags      = VMS_STRUCT,                                        \
 830     .offset     = vmstate_offset_value(_state, _field, PCIDevice),   \
 831 }
 832
 833 #define VMSTATE_PCI_DEVICE_POINTER(_field, _state) {                 \
 834     .name       = (stringify(_field)),                               \
 835     .size       = sizeof(PCIDevice),                                 \
 836     .vmsd       = &vmstate_pci_device,                               \
 837     .flags      = VMS_STRUCT|VMS_POINTER,                            \
 838     .offset     = vmstate_offset_pointer(_state, _field, PCIDevice), \
 839 }
 840
 841 MSIMessage pci_get_msi_message(PCIDevice *dev, int vector);
 842
 843 #endif