hw/pci.h

   1 #ifndef QEMU_PCI_H
   2 #define QEMU_PCI_H
   3
   4 #include "qemu-common.h"
   5
   6 #include "qdev.h"
   7
   8 /* PCI includes legacy ISA access.  */
   9 #include "isa.h"
  10
  11 /* PCI bus */
  12
  13 extern target_phys_addr_t pci_mem_base;
  14
  15 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
  16 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
  17 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
  18
  19 /* Class, Vendor and Device IDs from Linux's pci_ids.h */
  20 #include "pci_ids.h"
  21
  22 /* QEMU-specific Vendor and Device ID definitions */
  23
  24 /* IBM (0x1014) */
  25 #define PCI_DEVICE_ID_IBM_440GX          0x027f
  26 #define PCI_DEVICE_ID_IBM_OPENPIC2       0xffff
  27
  28 /* Hitachi (0x1054) */
  29 #define PCI_VENDOR_ID_HITACHI            0x1054
  30 #define PCI_DEVICE_ID_HITACHI_SH7751R    0x350e
  31
  32 /* Apple (0x106b) */
  33 #define PCI_DEVICE_ID_APPLE_343S1201     0x0010
  34 #define PCI_DEVICE_ID_APPLE_UNI_N_I_PCI  0x001e
  35 #define PCI_DEVICE_ID_APPLE_UNI_N_PCI    0x001f
  36 #define PCI_DEVICE_ID_APPLE_UNI_N_KEYL   0x0022
  37 #define PCI_DEVICE_ID_APPLE_IPID_USB     0x003f
  38
  39 /* Realtek (0x10ec) */
  40 #define PCI_DEVICE_ID_REALTEK_8029       0x8029
  41
  42 /* Xilinx (0x10ee) */
  43 #define PCI_DEVICE_ID_XILINX_XC2VP30     0x0300
  44
  45 /* Marvell (0x11ab) */
  46 #define PCI_DEVICE_ID_MARVELL_GT6412X    0x4620
  47
  48 /* QEMU/Bochs VGA (0x1234) */
  49 #define PCI_VENDOR_ID_QEMU               0x1234
  50 #define PCI_DEVICE_ID_QEMU_VGA           0x1111
  51
  52 /* VMWare (0x15ad) */
  53 #define PCI_VENDOR_ID_VMWARE             0x15ad
  54 #define PCI_DEVICE_ID_VMWARE_SVGA2       0x0405
  55 #define PCI_DEVICE_ID_VMWARE_SVGA        0x0710
  56 #define PCI_DEVICE_ID_VMWARE_NET         0x0720
  57 #define PCI_DEVICE_ID_VMWARE_SCSI        0x0730
  58 #define PCI_DEVICE_ID_VMWARE_IDE         0x1729
  59
  60 /* Intel (0x8086) */
  61 #define PCI_DEVICE_ID_INTEL_82551IT      0x1209
  62 #define PCI_DEVICE_ID_INTEL_82557        0x1229
  63
  64 /* Red Hat / Qumranet (for QEMU) -- see pci-ids.txt */
  65 #define PCI_VENDOR_ID_REDHAT_QUMRANET    0x1af4
  66 #define PCI_SUBVENDOR_ID_REDHAT_QUMRANET 0x1af4
  67 #define PCI_SUBDEVICE_ID_QEMU            0x1100
  68
  69 #define PCI_DEVICE_ID_VIRTIO_NET         0x1000
  70 #define PCI_DEVICE_ID_VIRTIO_BLOCK       0x1001
  71 #define PCI_DEVICE_ID_VIRTIO_BALLOON     0x1002
  72 #define PCI_DEVICE_ID_VIRTIO_CONSOLE     0x1003
  73
  74 typedef uint64_t pcibus_t;
  75 #define FMT_PCIBUS                      PRIx64
  76
  77 typedef void PCIConfigWriteFunc(PCIDevice *pci_dev,
  78                                 uint32_t address, uint32_t data, int len);
  79 typedef uint32_t PCIConfigReadFunc(PCIDevice *pci_dev,
  80                                    uint32_t address, int len);
  81 typedef void PCIMapIORegionFunc(PCIDevice *pci_dev, int region_num,
  82                                 pcibus_t addr, pcibus_t size, int type);
  83 typedef int PCIUnregisterFunc(PCIDevice *pci_dev);
  84
  85 typedef struct PCIIORegion {
  86     pcibus_t addr; /* current PCI mapping address. -1 means not mapped */
  87 #define PCI_BAR_UNMAPPED (~(pcibus_t)0)
  88     pcibus_t size;
  89     pcibus_t filtered_size;
  90     uint8_t type;
  91     PCIMapIORegionFunc *map_func;
  92 } PCIIORegion;
  93
  94 #define PCI_ROM_SLOT 6
  95 #define PCI_NUM_REGIONS 7
  96
  97 /* Declarations from linux/pci_regs.h */
  98 #define PCI_VENDOR_ID           0x00    /* 16 bits */
  99 #define PCI_DEVICE_ID           0x02    /* 16 bits */
 100 #define PCI_COMMAND             0x04    /* 16 bits */
 101 #define  PCI_COMMAND_IO         0x1     /* Enable response in I/O space */
 102 #define  PCI_COMMAND_MEMORY     0x2     /* Enable response in Memory space */
 103 #define  PCI_COMMAND_MASTER     0x4     /* Enable bus master */
 104 #define  PCI_COMMAND_SPECIAL    0x8     /* Enable response to special cycles */
 105 #define  PCI_COMMAND_INVALIDATE 0x10    /* Use memory write and invalidate */
 106 #define  PCI_COMMAND_VGA_PALETTE 0x20   /* Enable palette snooping */
 107 #define  PCI_COMMAND_PARITY     0x40    /* Enable parity checking */
 108 #define  PCI_COMMAND_WAIT       0x80    /* Enable address/data stepping */
 109 #define  PCI_COMMAND_SERR       0x100   /* Enable SERR */
 110 #define  PCI_COMMAND_FAST_BACK  0x200   /* Enable back-to-back writes */
 111 #define  PCI_COMMAND_INTX_DISABLE 0x400 /* INTx Emulation Disable */
 112 #define PCI_STATUS              0x06    /* 16 bits */
 113 #define PCI_REVISION_ID         0x08    /* 8 bits  */
 114 #define PCI_CLASS_PROG          0x09    /* Reg. Level Programming Interface */
 115 #define PCI_CLASS_DEVICE        0x0a    /* Device class */
 116 #define PCI_CACHE_LINE_SIZE     0x0c    /* 8 bits */
 117 #define PCI_LATENCY_TIMER       0x0d    /* 8 bits */
 118 #define PCI_HEADER_TYPE         0x0e    /* 8 bits */
 119 #define  PCI_HEADER_TYPE_NORMAL         0
 120 #define  PCI_HEADER_TYPE_BRIDGE         1
 121 #define  PCI_HEADER_TYPE_CARDBUS        2
 122 #define  PCI_HEADER_TYPE_MULTI_FUNCTION 0x80
 123 #define PCI_BASE_ADDRESS_0      0x10    /* 32 bits */
 124 #define  PCI_BASE_ADDRESS_SPACE_IO      0x01
 125 #define  PCI_BASE_ADDRESS_SPACE_MEMORY  0x00
 126 #define  PCI_BASE_ADDRESS_MEM_TYPE_64   0x04    /* 64 bit address */
 127 #define  PCI_BASE_ADDRESS_MEM_PREFETCH  0x08    /* prefetchable? */
 128 #define PCI_PRIMARY_BUS         0x18    /* Primary bus number */
 129 #define PCI_SECONDARY_BUS       0x19    /* Secondary bus number */
 130 #define PCI_SUBORDINATE_BUS     0x1a    /* Highest bus number behind the bridge */
 131 #define PCI_SEC_LATENCY_TIMER   0x1b    /* Latency timer for secondary interface */
 132 #define PCI_IO_BASE             0x1c    /* I/O range behind the bridge */
 133 #define PCI_IO_LIMIT            0x1d
 134 #define  PCI_IO_RANGE_TYPE_32   0x01
 135 #define  PCI_IO_RANGE_MASK      (~0x0fUL)
 136 #define PCI_SEC_STATUS          0x1e    /* Secondary status register, only bit 14 used */
 137 #define PCI_MEMORY_BASE         0x20    /* Memory range behind */
 138 #define PCI_MEMORY_LIMIT        0x22
 139 #define  PCI_MEMORY_RANGE_MASK  (~0x0fUL)
 140 #define PCI_PREF_MEMORY_BASE    0x24    /* Prefetchable memory range behind */
 141 #define PCI_PREF_MEMORY_LIMIT   0x26
 142 #define  PCI_PREF_RANGE_MASK    (~0x0fUL)
 143 #define PCI_PREF_BASE_UPPER32   0x28    /* Upper half of prefetchable memory range */
 144 #define PCI_PREF_LIMIT_UPPER32  0x2c
 145 #define PCI_SUBSYSTEM_VENDOR_ID 0x2c    /* 16 bits */
 146 #define PCI_SUBSYSTEM_ID        0x2e    /* 16 bits */
 147 #define PCI_ROM_ADDRESS         0x30    /* Bits 31..11 are address, 10..1 reserved */
 148 #define  PCI_ROM_ADDRESS_ENABLE 0x01
 149 #define PCI_IO_BASE_UPPER16     0x30    /* Upper half of I/O addresses */
 150 #define PCI_IO_LIMIT_UPPER16    0x32
 151 #define PCI_CAPABILITY_LIST     0x34    /* Offset of first capability list entry */
 152 #define PCI_ROM_ADDRESS1        0x38    /* Same as PCI_ROM_ADDRESS, but for htype 1 */
 153 #define PCI_INTERRUPT_LINE      0x3c    /* 8 bits */
 154 #define PCI_INTERRUPT_PIN       0x3d    /* 8 bits */
 155 #define PCI_MIN_GNT             0x3e    /* 8 bits */
 156 #define PCI_BRIDGE_CONTROL      0x3e
 157 #define PCI_MAX_LAT             0x3f    /* 8 bits */
 158
 159 /* Capability lists */
 160 #define PCI_CAP_LIST_ID         0       /* Capability ID */
 161 #define PCI_CAP_LIST_NEXT       1       /* Next capability in the list */
 162
 163 #define PCI_REVISION            0x08    /* obsolete, use PCI_REVISION_ID */
 164 #define PCI_SUBVENDOR_ID        0x2c    /* obsolete, use PCI_SUBSYSTEM_VENDOR_ID */
 165 #define PCI_SUBDEVICE_ID        0x2e    /* obsolete, use PCI_SUBSYSTEM_ID */
 166
 167 /* Bits in the PCI Status Register (PCI 2.3 spec) */
 168 #define PCI_STATUS_RESERVED1    0x007
 169 #define PCI_STATUS_INT_STATUS   0x008
 170 #define PCI_STATUS_CAP_LIST     0x010
 171 #define PCI_STATUS_66MHZ        0x020
 172 #define PCI_STATUS_RESERVED2    0x040
 173 #define PCI_STATUS_FAST_BACK    0x080
 174 #define PCI_STATUS_DEVSEL       0x600
 175
 176 #define PCI_STATUS_RESERVED_MASK_LO (PCI_STATUS_RESERVED1 | \
 177                 PCI_STATUS_INT_STATUS | PCI_STATUS_CAPABILITIES | \
 178                 PCI_STATUS_66MHZ | PCI_STATUS_RESERVED2 | PCI_STATUS_FAST_BACK)
 179
 180 #define PCI_STATUS_RESERVED_MASK_HI (PCI_STATUS_DEVSEL >> 8)
 181
 182 /* Bits in the PCI Command Register (PCI 2.3 spec) */
 183 #define PCI_COMMAND_RESERVED    0xf800
 184
 185 #define PCI_COMMAND_RESERVED_MASK_HI (PCI_COMMAND_RESERVED >> 8)
 186
 187 /* Size of the standard PCI config header */
 188 #define PCI_CONFIG_HEADER_SIZE 0x40
 189 /* Size of the standard PCI config space */
 190 #define PCI_CONFIG_SPACE_SIZE 0x100
 191 /* Size of the standart PCIe config space: 4KB */
 192 #define PCIE_CONFIG_SPACE_SIZE  0x1000
 193
 194 #define PCI_NUM_PINS 4 /* A-D */
 195
 196 /* Bits in cap_present field. */
 197 enum {
 198     QEMU_PCI_CAP_MSIX = 0x1,
 199     QEMU_PCI_CAP_EXPRESS = 0x2,
 200 };
 201
 202 struct PCIDevice {
 203     DeviceState qdev;
 204     /* PCI config space */
 205     uint8_t *config;
 206
 207     /* Used to enable config checks on load. Note that writeable bits are
 208      * never checked even if set in cmask. */
 209     uint8_t *cmask;
 210
 211     /* Used to implement R/W bytes */
 212     uint8_t *wmask;
 213
 214     /* Used to allocate config space for capabilities. */
 215     uint8_t *used;
 216
 217     /* the following fields are read only */
 218     PCIBus *bus;
 219     uint32_t devfn;
 220     char name[64];
 221     PCIIORegion io_regions[PCI_NUM_REGIONS];
 222
 223     /* do not access the following fields */
 224     PCIConfigReadFunc *config_read;
 225     PCIConfigWriteFunc *config_write;
 226
 227     /* IRQ objects for the INTA-INTD pins.  */
 228     qemu_irq *irq;
 229
 230     /* Current IRQ levels.  Used internally by the generic PCI code.  */
 231     int irq_state[PCI_NUM_PINS];
 232
 233     /* Capability bits */
 234     uint32_t cap_present;
 235
 236     /* Offset of MSI-X capability in config space */
 237     uint8_t msix_cap;
 238
 239     /* MSI-X entries */
 240     int msix_entries_nr;
 241
 242     /* Space to store MSIX table */
 243     uint8_t *msix_table_page;
 244     /* MMIO index used to map MSIX table and pending bit entries. */
 245     int msix_mmio_index;
 246     /* Reference-count for entries actually in use by driver. */
 247     unsigned *msix_entry_used;
 248     /* Region including the MSI-X table */
 249     uint32_t msix_bar_size;
 250     /* Version id needed for VMState */
 251     int32_t version_id;
 252 };
 253
 254 PCIDevice *pci_register_device(PCIBus *bus, const char *name,
 255                                int instance_size, int devfn,
 256                                PCIConfigReadFunc *config_read,
 257                                PCIConfigWriteFunc *config_write);
 258
 259 void pci_register_bar(PCIDevice *pci_dev, int region_num,
 260                             pcibus_t size, int type,
 261                             PCIMapIORegionFunc *map_func);
 262
 263 int pci_add_capability(PCIDevice *pci_dev, uint8_t cap_id, uint8_t cap_size);
 264
 265 void pci_del_capability(PCIDevice *pci_dev, uint8_t cap_id, uint8_t cap_size);
 266
 267 void pci_reserve_capability(PCIDevice *pci_dev, uint8_t offset, uint8_t size);
 268
 269 uint8_t pci_find_capability(PCIDevice *pci_dev, uint8_t cap_id);
 270
 271
 272 uint32_t pci_default_read_config(PCIDevice *d,
 273                                  uint32_t address, int len);
 274 void pci_default_write_config(PCIDevice *d,
 275                               uint32_t address, uint32_t val, int len);
 276 void pci_device_save(PCIDevice *s, QEMUFile *f);
 277 int pci_device_load(PCIDevice *s, QEMUFile *f);
 278
 279 typedef void (*pci_set_irq_fn)(void *opaque, int irq_num, int level);
 280 typedef int (*pci_map_irq_fn)(PCIDevice *pci_dev, int irq_num);
 281 typedef int (*pci_hotplug_fn)(PCIDevice *pci_dev, int state);
 282 void pci_bus_new_inplace(PCIBus *bus, DeviceState *parent,
 283                          const char *name, int devfn_min);
 284 PCIBus *pci_bus_new(DeviceState *parent, const char *name, int devfn_min);
 285 void pci_bus_irqs(PCIBus *bus, pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
 286                   void *irq_opaque, int nirq);
 287 void pci_bus_hotplug(PCIBus *bus, pci_hotplug_fn hotplug);
 288 PCIBus *pci_register_bus(DeviceState *parent, const char *name,
 289                          pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
 290                          void *irq_opaque, int devfn_min, int nirq);
 291
 292 PCIDevice *pci_nic_init(NICInfo *nd, const char *default_model,
 293                         const char *default_devaddr);
 294 PCIDevice *pci_nic_init_nofail(NICInfo *nd, const char *default_model,
 295                                const char *default_devaddr);
 296 int pci_bus_num(PCIBus *s);
 297 void pci_for_each_device(PCIBus *bus, int bus_num, void (*fn)(PCIBus *bus, PCIDevice *d));
 298 PCIBus *pci_find_root_bus(int domain);
 299 PCIBus *pci_find_bus(PCIBus *bus, int bus_num);
 300 PCIDevice *pci_find_device(PCIBus *bus, int bus_num, int slot, int function);
 301 PCIBus *pci_get_bus_devfn(int *devfnp, const char *devaddr);
 302
 303 int pci_read_devaddr(Monitor *mon, const char *addr, int *domp, int *busp,
 304                      unsigned *slotp);
 305
 306 void pci_info(Monitor *mon);
 307 PCIBus *pci_bridge_init(PCIBus *bus, int devfn, uint16_t vid, uint16_t did,
 308                         pci_map_irq_fn map_irq, const char *name);
 309
 310 static inline void
 311 pci_set_byte(uint8_t *config, uint8_t val)
 312 {
 313     *config = val;
 314 }
 315
 316 static inline uint8_t
 317 pci_get_byte(uint8_t *config)
 318 {
 319     return *config;
 320 }
 321
 322 static inline void
 323 pci_set_word(uint8_t *config, uint16_t val)
 324 {
 325     cpu_to_le16wu((uint16_t *)config, val);
 326 }
 327
 328 static inline uint16_t
 329 pci_get_word(uint8_t *config)
 330 {
 331     return le16_to_cpupu((uint16_t *)config);
 332 }
 333
 334 static inline void
 335 pci_set_long(uint8_t *config, uint32_t val)
 336 {
 337     cpu_to_le32wu((uint32_t *)config, val);
 338 }
 339
 340 static inline uint32_t
 341 pci_get_long(uint8_t *config)
 342 {
 343     return le32_to_cpupu((uint32_t *)config);
 344 }
 345
 346 static inline void
 347 pci_set_quad(uint8_t *config, uint64_t val)
 348 {
 349     cpu_to_le64w((uint64_t *)config, val);
 350 }
 351
 352 static inline uint64_t
 353 pci_get_quad(uint8_t *config)
 354 {
 355     return le64_to_cpup((uint64_t *)config);
 356 }
 357
 358 static inline void
 359 pci_config_set_vendor_id(uint8_t *pci_config, uint16_t val)
 360 {
 361     pci_set_word(&pci_config[PCI_VENDOR_ID], val);
 362 }
 363
 364 static inline void
 365 pci_config_set_device_id(uint8_t *pci_config, uint16_t val)
 366 {
 367     pci_set_word(&pci_config[PCI_DEVICE_ID], val);
 368 }
 369
 370 static inline void
 371 pci_config_set_class(uint8_t *pci_config, uint16_t val)
 372 {
 373     pci_set_word(&pci_config[PCI_CLASS_DEVICE], val);
 374 }
 375
 376 typedef int (*pci_qdev_initfn)(PCIDevice *dev);
 377 typedef struct {
 378     DeviceInfo qdev;
 379     pci_qdev_initfn init;
 380     PCIUnregisterFunc *exit;
 381     PCIConfigReadFunc *config_read;
 382     PCIConfigWriteFunc *config_write;
 383
 384     /* pci config header type */
 385     uint8_t header_type;
 386
 387     /* pcie stuff */
 388     int is_express;   /* is this device pci express? */
 389 } PCIDeviceInfo;
 390
 391 void pci_qdev_register(PCIDeviceInfo *info);
 392 void pci_qdev_register_many(PCIDeviceInfo *info);
 393
 394 PCIDevice *pci_create(PCIBus *bus, int devfn, const char *name);
 395 PCIDevice *pci_create_simple(PCIBus *bus, int devfn, const char *name);
 396
 397 static inline int pci_is_express(PCIDevice *d)
 398 {
 399     return d->cap_present & QEMU_PCI_CAP_EXPRESS;
 400 }
 401
 402 static inline uint32_t pci_config_size(PCIDevice *d)
 403 {
 404     return pci_is_express(d) ? PCIE_CONFIG_SPACE_SIZE : PCI_CONFIG_SPACE_SIZE;
 405 }
 406
 407 /* These are not pci specific. Should move into a separate header.
 408  * Only pci.c uses them, so keep them here for now.
 409  */
 410
 411 /* Get last byte of a range from offset + length.
 412  * Undefined for ranges that wrap around 0. */
 413 static inline uint64_t range_get_last(uint64_t offset, uint64_t len)
 414 {
 415     return offset + len - 1;
 416 }
 417
 418 /* Check whether a given range covers a given byte. */
 419 static inline int range_covers_byte(uint64_t offset, uint64_t len,
 420                                     uint64_t byte)
 421 {
 422     return offset <= byte && byte <= range_get_last(offset, len);
 423 }
 424
 425 /* Check whether 2 given ranges overlap.
 426  * Undefined if ranges that wrap around 0. */
 427 static inline int ranges_overlap(uint64_t first1, uint64_t len1,
 428                                  uint64_t first2, uint64_t len2)
 429 {
 430     uint64_t last1 = range_get_last(first1, len1);
 431     uint64_t last2 = range_get_last(first2, len2);
 432
 433     return !(last2 < first1 || last1 < first2);
 434 }
 435
 436 #endif