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