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