hw/pci.h

   1 #ifndef QEMU_PCI_H
   2 #define QEMU_PCI_H
   3
   4 #include "qemu-common.h"
   5 #include "qobject.h"
   6
   7 #include "qdev.h"
   8
   9 /* PCI includes legacy ISA access.  */
  10 #include "isa.h"
  11
  12 /* PCI bus */
  13
  14 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
  15 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
  16 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
  17
  18 /* Class, Vendor and Device IDs from Linux's pci_ids.h */
  19 #include "pci_ids.h"
  20
  21 /* QEMU-specific Vendor and Device ID definitions */
  22
  23 /* IBM (0x1014) */
  24 #define PCI_DEVICE_ID_IBM_440GX          0x027f
  25 #define PCI_DEVICE_ID_IBM_OPENPIC2       0xffff
  26
  27 /* Hitachi (0x1054) */
  28 #define PCI_VENDOR_ID_HITACHI            0x1054
  29 #define PCI_DEVICE_ID_HITACHI_SH7751R    0x350e
  30
  31 /* Apple (0x106b) */
  32 #define PCI_DEVICE_ID_APPLE_343S1201     0x0010
  33 #define PCI_DEVICE_ID_APPLE_UNI_N_I_PCI  0x001e
  34 #define PCI_DEVICE_ID_APPLE_UNI_N_PCI    0x001f
  35 #define PCI_DEVICE_ID_APPLE_UNI_N_KEYL   0x0022
  36 #define PCI_DEVICE_ID_APPLE_IPID_USB     0x003f
  37
  38 /* Realtek (0x10ec) */
  39 #define PCI_DEVICE_ID_REALTEK_8029       0x8029
  40
  41 /* Xilinx (0x10ee) */
  42 #define PCI_DEVICE_ID_XILINX_XC2VP30     0x0300
  43
  44 /* Marvell (0x11ab) */
  45 #define PCI_DEVICE_ID_MARVELL_GT6412X    0x4620
  46
  47 /* QEMU/Bochs VGA (0x1234) */
  48 #define PCI_VENDOR_ID_QEMU               0x1234
  49 #define PCI_DEVICE_ID_QEMU_VGA           0x1111
  50
  51 /* VMWare (0x15ad) */
  52 #define PCI_VENDOR_ID_VMWARE             0x15ad
  53 #define PCI_DEVICE_ID_VMWARE_SVGA2       0x0405
  54 #define PCI_DEVICE_ID_VMWARE_SVGA        0x0710
  55 #define PCI_DEVICE_ID_VMWARE_NET         0x0720
  56 #define PCI_DEVICE_ID_VMWARE_SCSI        0x0730
  57 #define PCI_DEVICE_ID_VMWARE_IDE         0x1729
  58
  59 /* Intel (0x8086) */
  60 #define PCI_DEVICE_ID_INTEL_82551IT      0x1209
  61 #define PCI_DEVICE_ID_INTEL_82557        0x1229
  62
  63 /* Red Hat / Qumranet (for QEMU) -- see pci-ids.txt */
  64 #define PCI_VENDOR_ID_REDHAT_QUMRANET    0x1af4
  65 #define PCI_SUBVENDOR_ID_REDHAT_QUMRANET 0x1af4
  66 #define PCI_SUBDEVICE_ID_QEMU            0x1100
  67
  68 #define PCI_DEVICE_ID_VIRTIO_NET         0x1000
  69 #define PCI_DEVICE_ID_VIRTIO_BLOCK       0x1001
  70 #define PCI_DEVICE_ID_VIRTIO_BALLOON     0x1002
  71 #define PCI_DEVICE_ID_VIRTIO_CONSOLE     0x1003
  72
  73 #define FMT_PCIBUS                      PRIx64
  74
  75 typedef void PCIConfigWriteFunc(PCIDevice *pci_dev,
  76                                 uint32_t address, uint32_t data, int len);
  77 typedef uint32_t PCIConfigReadFunc(PCIDevice *pci_dev,
  78                                    uint32_t address, int len);
  79 typedef void PCIMapIORegionFunc(PCIDevice *pci_dev, int region_num,
  80                                 pcibus_t addr, pcibus_t size, int type);
  81 typedef int PCIUnregisterFunc(PCIDevice *pci_dev);
  82
  83 typedef struct PCIIORegion {
  84     pcibus_t addr; /* current PCI mapping address. -1 means not mapped */
  85 #define PCI_BAR_UNMAPPED (~(pcibus_t)0)
  86     pcibus_t size;
  87     pcibus_t filtered_size;
  88     uint8_t type;
  89     PCIMapIORegionFunc *map_func;
  90 } PCIIORegion;
  91
  92 #define PCI_ROM_SLOT 6
  93 #define PCI_NUM_REGIONS 7
  94
  95 #include "pci_regs.h"
  96
  97 /* PCI HEADER_TYPE */
  98 #define  PCI_HEADER_TYPE_MULTI_FUNCTION 0x80
  99
 100 #define PCI_STATUS_RESERVED_MASK_LO (PCI_STATUS_RESERVED1 | \
 101                 PCI_STATUS_INT_STATUS | PCI_STATUS_CAPABILITIES | \
 102                 PCI_STATUS_66MHZ | PCI_STATUS_RESERVED2 | PCI_STATUS_FAST_BACK)
 103
 104 #define PCI_STATUS_RESERVED_MASK_HI (PCI_STATUS_DEVSEL >> 8)
 105
 106 /* Bits in the PCI Command Register (PCI 2.3 spec) */
 107 #define PCI_COMMAND_RESERVED    0xf800
 108
 109 #define PCI_COMMAND_RESERVED_MASK_HI (PCI_COMMAND_RESERVED >> 8)
 110
 111 /* Size of the standard PCI config header */
 112 #define PCI_CONFIG_HEADER_SIZE 0x40
 113 /* Size of the standard PCI config space */
 114 #define PCI_CONFIG_SPACE_SIZE 0x100
 115 /* Size of the standart PCIe config space: 4KB */
 116 #define PCIE_CONFIG_SPACE_SIZE  0x1000
 117
 118 #define PCI_NUM_PINS 4 /* A-D */
 119
 120 /* Bits in cap_present field. */
 121 enum {
 122     QEMU_PCI_CAP_MSIX = 0x1,
 123     QEMU_PCI_CAP_EXPRESS = 0x2,
 124 };
 125
 126 struct PCIDevice {
 127     DeviceState qdev;
 128     /* PCI config space */
 129     uint8_t *config;
 130
 131     /* Used to enable config checks on load. Note that writeable bits are
 132      * never checked even if set in cmask. */
 133     uint8_t *cmask;
 134
 135     /* Used to implement R/W bytes */
 136     uint8_t *wmask;
 137
 138     /* Used to allocate config space for capabilities. */
 139     uint8_t *used;
 140
 141     /* the following fields are read only */
 142     PCIBus *bus;
 143     uint32_t devfn;
 144     char name[64];
 145     PCIIORegion io_regions[PCI_NUM_REGIONS];
 146
 147     /* do not access the following fields */
 148     PCIConfigReadFunc *config_read;
 149     PCIConfigWriteFunc *config_write;
 150
 151     /* IRQ objects for the INTA-INTD pins.  */
 152     qemu_irq *irq;
 153
 154     /* Current IRQ levels.  Used internally by the generic PCI code.  */
 155     uint8_t irq_state;
 156
 157     /* Capability bits */
 158     uint32_t cap_present;
 159
 160     /* Offset of MSI-X capability in config space */
 161     uint8_t msix_cap;
 162
 163     /* MSI-X entries */
 164     int msix_entries_nr;
 165
 166     /* Space to store MSIX table */
 167     uint8_t *msix_table_page;
 168     /* MMIO index used to map MSIX table and pending bit entries. */
 169     int msix_mmio_index;
 170     /* Reference-count for entries actually in use by driver. */
 171     unsigned *msix_entry_used;
 172     /* Region including the MSI-X table */
 173     uint32_t msix_bar_size;
 174     /* Version id needed for VMState */
 175     int32_t version_id;
 176
 177     /* Location of option rom */
 178     char *romfile;
 179     ram_addr_t rom_offset;
 180     uint32_t rom_bar;
 181 };
 182
 183 PCIDevice *pci_register_device(PCIBus *bus, const char *name,
 184                                int instance_size, int devfn,
 185                                PCIConfigReadFunc *config_read,
 186                                PCIConfigWriteFunc *config_write);
 187
 188 void pci_register_bar(PCIDevice *pci_dev, int region_num,
 189                             pcibus_t size, int type,
 190                             PCIMapIORegionFunc *map_func);
 191
 192 int pci_add_capability(PCIDevice *pci_dev, uint8_t cap_id, uint8_t cap_size);
 193
 194 void pci_del_capability(PCIDevice *pci_dev, uint8_t cap_id, uint8_t cap_size);
 195
 196 void pci_reserve_capability(PCIDevice *pci_dev, uint8_t offset, uint8_t size);
 197
 198 uint8_t pci_find_capability(PCIDevice *pci_dev, uint8_t cap_id);
 199
 200
 201 uint32_t pci_default_read_config(PCIDevice *d,
 202                                  uint32_t address, int len);
 203 void pci_default_write_config(PCIDevice *d,
 204                               uint32_t address, uint32_t val, int len);
 205 void pci_device_save(PCIDevice *s, QEMUFile *f);
 206 int pci_device_load(PCIDevice *s, QEMUFile *f);
 207
 208 typedef void (*pci_set_irq_fn)(void *opaque, int irq_num, int level);
 209 typedef int (*pci_map_irq_fn)(PCIDevice *pci_dev, int irq_num);
 210 typedef int (*pci_hotplug_fn)(PCIDevice *pci_dev, int state);
 211 void pci_bus_new_inplace(PCIBus *bus, DeviceState *parent,
 212                          const char *name, int devfn_min);
 213 PCIBus *pci_bus_new(DeviceState *parent, const char *name, int devfn_min);
 214 void pci_bus_irqs(PCIBus *bus, pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
 215                   void *irq_opaque, int nirq);
 216 void pci_bus_hotplug(PCIBus *bus, pci_hotplug_fn hotplug);
 217 PCIBus *pci_register_bus(DeviceState *parent, const char *name,
 218                          pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
 219                          void *irq_opaque, int devfn_min, int nirq);
 220
 221 void pci_bus_set_mem_base(PCIBus *bus, target_phys_addr_t base);
 222
 223 PCIDevice *pci_nic_init(NICInfo *nd, const char *default_model,
 224                         const char *default_devaddr);
 225 PCIDevice *pci_nic_init_nofail(NICInfo *nd, const char *default_model,
 226                                const char *default_devaddr);
 227 int pci_bus_num(PCIBus *s);
 228 void pci_for_each_device(PCIBus *bus, int bus_num, void (*fn)(PCIBus *bus, PCIDevice *d));
 229 PCIBus *pci_find_root_bus(int domain);
 230 PCIBus *pci_find_bus(PCIBus *bus, int bus_num);
 231 PCIDevice *pci_find_device(PCIBus *bus, int bus_num, int slot, int function);
 232 PCIBus *pci_get_bus_devfn(int *devfnp, const char *devaddr);
 233
 234 int pci_read_devaddr(Monitor *mon, const char *addr, int *domp, int *busp,
 235                      unsigned *slotp);
 236
 237 void do_pci_info_print(Monitor *mon, const QObject *data);
 238 void do_pci_info(Monitor *mon, QObject **ret_data);
 239 PCIBus *pci_bridge_init(PCIBus *bus, int devfn, uint16_t vid, uint16_t did,
 240                         pci_map_irq_fn map_irq, const char *name);
 241 PCIDevice *pci_bridge_get_device(PCIBus *bus);
 242
 243 static inline void
 244 pci_set_byte(uint8_t *config, uint8_t val)
 245 {
 246     *config = val;
 247 }
 248
 249 static inline uint8_t
 250 pci_get_byte(const uint8_t *config)
 251 {
 252     return *config;
 253 }
 254
 255 static inline void
 256 pci_set_word(uint8_t *config, uint16_t val)
 257 {
 258     cpu_to_le16wu((uint16_t *)config, val);
 259 }
 260
 261 static inline uint16_t
 262 pci_get_word(const uint8_t *config)
 263 {
 264     return le16_to_cpupu((const uint16_t *)config);
 265 }
 266
 267 static inline void
 268 pci_set_long(uint8_t *config, uint32_t val)
 269 {
 270     cpu_to_le32wu((uint32_t *)config, val);
 271 }
 272
 273 static inline uint32_t
 274 pci_get_long(const uint8_t *config)
 275 {
 276     return le32_to_cpupu((const uint32_t *)config);
 277 }
 278
 279 static inline void
 280 pci_set_quad(uint8_t *config, uint64_t val)
 281 {
 282     cpu_to_le64w((uint64_t *)config, val);
 283 }
 284
 285 static inline uint64_t
 286 pci_get_quad(const uint8_t *config)
 287 {
 288     return le64_to_cpup((const uint64_t *)config);
 289 }
 290
 291 static inline void
 292 pci_config_set_vendor_id(uint8_t *pci_config, uint16_t val)
 293 {
 294     pci_set_word(&pci_config[PCI_VENDOR_ID], val);
 295 }
 296
 297 static inline void
 298 pci_config_set_device_id(uint8_t *pci_config, uint16_t val)
 299 {
 300     pci_set_word(&pci_config[PCI_DEVICE_ID], val);
 301 }
 302
 303 static inline void
 304 pci_config_set_revision(uint8_t *pci_config, uint8_t val)
 305 {
 306     pci_set_byte(&pci_config[PCI_REVISION_ID], val);
 307 }
 308
 309 static inline void
 310 pci_config_set_class(uint8_t *pci_config, uint16_t val)
 311 {
 312     pci_set_word(&pci_config[PCI_CLASS_DEVICE], val);
 313 }
 314
 315 static inline void
 316 pci_config_set_prog_interface(uint8_t *pci_config, uint8_t val)
 317 {
 318     pci_set_byte(&pci_config[PCI_CLASS_PROG], val);
 319 }
 320
 321 static inline void
 322 pci_config_set_interrupt_pin(uint8_t *pci_config, uint8_t val)
 323 {
 324     pci_set_byte(&pci_config[PCI_INTERRUPT_PIN], val);
 325 }
 326
 327 typedef int (*pci_qdev_initfn)(PCIDevice *dev);
 328 typedef struct {
 329     DeviceInfo qdev;
 330     pci_qdev_initfn init;
 331     PCIUnregisterFunc *exit;
 332     PCIConfigReadFunc *config_read;
 333     PCIConfigWriteFunc *config_write;
 334
 335     /* pci config header type */
 336     uint8_t header_type;
 337
 338     /* pcie stuff */
 339     int is_express;   /* is this device pci express? */
 340
 341     /* rom bar */
 342     const char *romfile;
 343 } PCIDeviceInfo;
 344
 345 void pci_qdev_register(PCIDeviceInfo *info);
 346 void pci_qdev_register_many(PCIDeviceInfo *info);
 347
 348 PCIDevice *pci_create(PCIBus *bus, int devfn, const char *name);
 349 PCIDevice *pci_create_simple(PCIBus *bus, int devfn, const char *name);
 350
 351 static inline int pci_is_express(PCIDevice *d)
 352 {
 353     return d->cap_present & QEMU_PCI_CAP_EXPRESS;
 354 }
 355
 356 static inline uint32_t pci_config_size(PCIDevice *d)
 357 {
 358     return pci_is_express(d) ? PCIE_CONFIG_SPACE_SIZE : PCI_CONFIG_SPACE_SIZE;
 359 }
 360
 361 /* These are not pci specific. Should move into a separate header.
 362  * Only pci.c uses them, so keep them here for now.
 363  */
 364
 365 /* Get last byte of a range from offset + length.
 366  * Undefined for ranges that wrap around 0. */
 367 static inline uint64_t range_get_last(uint64_t offset, uint64_t len)
 368 {
 369     return offset + len - 1;
 370 }
 371
 372 /* Check whether a given range covers a given byte. */
 373 static inline int range_covers_byte(uint64_t offset, uint64_t len,
 374                                     uint64_t byte)
 375 {
 376     return offset <= byte && byte <= range_get_last(offset, len);
 377 }
 378
 379 /* Check whether 2 given ranges overlap.
 380  * Undefined if ranges that wrap around 0. */
 381 static inline int ranges_overlap(uint64_t first1, uint64_t len1,
 382                                  uint64_t first2, uint64_t len2)
 383 {
 384     uint64_t last1 = range_get_last(first1, len1);
 385     uint64_t last2 = range_get_last(first2, len2);
 386
 387     return !(last2 < first1 || last1 < first2);
 388 }
 389
 390 #endif