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