xref: /openbmc/qemu/include/hw/pci/pci.h (revision abb3009baf90e5984ff1c230af0bc92a45e64864)
1 #ifndef QEMU_PCI_H
2 #define QEMU_PCI_H
3 
4 #include "exec/memory.h"
5 #include "sysemu/dma.h"
6 
7 /* PCI includes legacy ISA access.  */
8 #include "hw/isa/isa.h"
9 
10 extern bool pci_available;
11 
12 /* PCI bus */
13 
14 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
15 #define PCI_BUS_NUM(x)          (((x) >> 8) & 0xff)
16 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
17 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
18 #define PCI_BUILD_BDF(bus, devfn)     ((bus << 8) | (devfn))
19 #define PCI_BUS_MAX             256
20 #define PCI_DEVFN_MAX           256
21 #define PCI_SLOT_MAX            32
22 #define PCI_FUNC_MAX            8
23 
24 /* Class, Vendor and Device IDs from Linux's pci_ids.h */
25 #include "hw/pci/pci_ids.h"
26 
27 /* QEMU-specific Vendor and Device ID definitions */
28 
29 /* IBM (0x1014) */
30 #define PCI_DEVICE_ID_IBM_440GX          0x027f
31 #define PCI_DEVICE_ID_IBM_OPENPIC2       0xffff
32 
33 /* Hitachi (0x1054) */
34 #define PCI_VENDOR_ID_HITACHI            0x1054
35 #define PCI_DEVICE_ID_HITACHI_SH7751R    0x350e
36 
37 /* Apple (0x106b) */
38 #define PCI_DEVICE_ID_APPLE_343S1201     0x0010
39 #define PCI_DEVICE_ID_APPLE_UNI_N_I_PCI  0x001e
40 #define PCI_DEVICE_ID_APPLE_UNI_N_PCI    0x001f
41 #define PCI_DEVICE_ID_APPLE_UNI_N_KEYL   0x0022
42 #define PCI_DEVICE_ID_APPLE_IPID_USB     0x003f
43 
44 /* Realtek (0x10ec) */
45 #define PCI_DEVICE_ID_REALTEK_8029       0x8029
46 
47 /* Xilinx (0x10ee) */
48 #define PCI_DEVICE_ID_XILINX_XC2VP30     0x0300
49 
50 /* Marvell (0x11ab) */
51 #define PCI_DEVICE_ID_MARVELL_GT6412X    0x4620
52 
53 /* QEMU/Bochs VGA (0x1234) */
54 #define PCI_VENDOR_ID_QEMU               0x1234
55 #define PCI_DEVICE_ID_QEMU_VGA           0x1111
56 #define PCI_DEVICE_ID_QEMU_IPMI          0x1112
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 #define PCI_DEVICE_ID_VIRTIO_PMEM        0x1013
87 #define PCI_DEVICE_ID_VIRTIO_IOMMU       0x1014
88 #define PCI_DEVICE_ID_VIRTIO_MEM         0x1015
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_MDPY        0x000f
106 #define PCI_DEVICE_ID_REDHAT_NVME        0x0010
107 #define PCI_DEVICE_ID_REDHAT_PVPANIC     0x0011
108 #define PCI_DEVICE_ID_REDHAT_ACPI_ERST   0x0012
109 #define PCI_DEVICE_ID_REDHAT_QXL         0x0100
110 
111 #define FMT_PCIBUS                      PRIx64
112 
113 typedef uint64_t pcibus_t;
114 
115 struct PCIHostDeviceAddress {
116     unsigned int domain;
117     unsigned int bus;
118     unsigned int slot;
119     unsigned int function;
120 };
121 
122 typedef void PCIConfigWriteFunc(PCIDevice *pci_dev,
123                                 uint32_t address, uint32_t data, int len);
124 typedef uint32_t PCIConfigReadFunc(PCIDevice *pci_dev,
125                                    uint32_t address, int len);
126 typedef void PCIMapIORegionFunc(PCIDevice *pci_dev, int region_num,
127                                 pcibus_t addr, pcibus_t size, int type);
128 typedef void PCIUnregisterFunc(PCIDevice *pci_dev);
129 
130 typedef struct PCIIORegion {
131     pcibus_t addr; /* current PCI mapping address. -1 means not mapped */
132 #define PCI_BAR_UNMAPPED (~(pcibus_t)0)
133     pcibus_t size;
134     uint8_t type;
135     MemoryRegion *memory;
136     MemoryRegion *address_space;
137 } PCIIORegion;
138 
139 #define PCI_ROM_SLOT 6
140 #define PCI_NUM_REGIONS 7
141 
142 enum {
143     QEMU_PCI_VGA_MEM,
144     QEMU_PCI_VGA_IO_LO,
145     QEMU_PCI_VGA_IO_HI,
146     QEMU_PCI_VGA_NUM_REGIONS,
147 };
148 
149 #define QEMU_PCI_VGA_MEM_BASE 0xa0000
150 #define QEMU_PCI_VGA_MEM_SIZE 0x20000
151 #define QEMU_PCI_VGA_IO_LO_BASE 0x3b0
152 #define QEMU_PCI_VGA_IO_LO_SIZE 0xc
153 #define QEMU_PCI_VGA_IO_HI_BASE 0x3c0
154 #define QEMU_PCI_VGA_IO_HI_SIZE 0x20
155 
156 #include "hw/pci/pci_regs.h"
157 #include "hw/pci/pcie.h"
158 
159 /* PCI HEADER_TYPE */
160 #define  PCI_HEADER_TYPE_MULTI_FUNCTION 0x80
161 
162 /* Size of the standard PCI config header */
163 #define PCI_CONFIG_HEADER_SIZE 0x40
164 /* Size of the standard PCI config space */
165 #define PCI_CONFIG_SPACE_SIZE 0x100
166 /* Size of the standard PCIe config space: 4KB */
167 #define PCIE_CONFIG_SPACE_SIZE  0x1000
168 
169 #define PCI_NUM_PINS 4 /* A-D */
170 
171 /* Bits in cap_present field. */
172 enum {
173     QEMU_PCI_CAP_MSI = 0x1,
174     QEMU_PCI_CAP_MSIX = 0x2,
175     QEMU_PCI_CAP_EXPRESS = 0x4,
176 
177     /* multifunction capable device */
178 #define QEMU_PCI_CAP_MULTIFUNCTION_BITNR        3
179     QEMU_PCI_CAP_MULTIFUNCTION = (1 << QEMU_PCI_CAP_MULTIFUNCTION_BITNR),
180 
181     /* command register SERR bit enabled - unused since QEMU v5.0 */
182 #define QEMU_PCI_CAP_SERR_BITNR 4
183     QEMU_PCI_CAP_SERR = (1 << QEMU_PCI_CAP_SERR_BITNR),
184     /* Standard hot plug controller. */
185 #define QEMU_PCI_SHPC_BITNR 5
186     QEMU_PCI_CAP_SHPC = (1 << QEMU_PCI_SHPC_BITNR),
187 #define QEMU_PCI_SLOTID_BITNR 6
188     QEMU_PCI_CAP_SLOTID = (1 << QEMU_PCI_SLOTID_BITNR),
189     /* PCI Express capability - Power Controller Present */
190 #define QEMU_PCIE_SLTCAP_PCP_BITNR 7
191     QEMU_PCIE_SLTCAP_PCP = (1 << QEMU_PCIE_SLTCAP_PCP_BITNR),
192     /* Link active status in endpoint capability is always set */
193 #define QEMU_PCIE_LNKSTA_DLLLA_BITNR 8
194     QEMU_PCIE_LNKSTA_DLLLA = (1 << QEMU_PCIE_LNKSTA_DLLLA_BITNR),
195 #define QEMU_PCIE_EXTCAP_INIT_BITNR 9
196     QEMU_PCIE_EXTCAP_INIT = (1 << QEMU_PCIE_EXTCAP_INIT_BITNR),
197 #define QEMU_PCIE_CXL_BITNR 10
198     QEMU_PCIE_CAP_CXL = (1 << QEMU_PCIE_CXL_BITNR),
199 };
200 
201 #define TYPE_PCI_DEVICE "pci-device"
202 typedef struct PCIDeviceClass PCIDeviceClass;
203 DECLARE_OBJ_CHECKERS(PCIDevice, PCIDeviceClass,
204                      PCI_DEVICE, TYPE_PCI_DEVICE)
205 
206 /*
207  * Implemented by devices that can be plugged on CXL buses. In the spec, this is
208  * actually a "CXL Component, but we name it device to match the PCI naming.
209  */
210 #define INTERFACE_CXL_DEVICE "cxl-device"
211 
212 /* Implemented by devices that can be plugged on PCI Express buses */
213 #define INTERFACE_PCIE_DEVICE "pci-express-device"
214 
215 /* Implemented by devices that can be plugged on Conventional PCI buses */
216 #define INTERFACE_CONVENTIONAL_PCI_DEVICE "conventional-pci-device"
217 
218 typedef struct PCIINTxRoute {
219     enum {
220         PCI_INTX_ENABLED,
221         PCI_INTX_INVERTED,
222         PCI_INTX_DISABLED,
223     } mode;
224     int irq;
225 } PCIINTxRoute;
226 
227 struct PCIDeviceClass {
228     DeviceClass parent_class;
229 
230     void (*realize)(PCIDevice *dev, Error **errp);
231     PCIUnregisterFunc *exit;
232     PCIConfigReadFunc *config_read;
233     PCIConfigWriteFunc *config_write;
234 
235     uint16_t vendor_id;
236     uint16_t device_id;
237     uint8_t revision;
238     uint16_t class_id;
239     uint16_t subsystem_vendor_id;       /* only for header type = 0 */
240     uint16_t subsystem_id;              /* only for header type = 0 */
241 
242     /*
243      * pci-to-pci bridge or normal device.
244      * This doesn't mean pci host switch.
245      * When card bus bridge is supported, this would be enhanced.
246      */
247     bool is_bridge;
248 
249     /* rom bar */
250     const char *romfile;
251 };
252 
253 typedef void (*PCIINTxRoutingNotifier)(PCIDevice *dev);
254 typedef int (*MSIVectorUseNotifier)(PCIDevice *dev, unsigned int vector,
255                                       MSIMessage msg);
256 typedef void (*MSIVectorReleaseNotifier)(PCIDevice *dev, unsigned int vector);
257 typedef void (*MSIVectorPollNotifier)(PCIDevice *dev,
258                                       unsigned int vector_start,
259                                       unsigned int vector_end);
260 
261 enum PCIReqIDType {
262     PCI_REQ_ID_INVALID = 0,
263     PCI_REQ_ID_BDF,
264     PCI_REQ_ID_SECONDARY_BUS,
265     PCI_REQ_ID_MAX,
266 };
267 typedef enum PCIReqIDType PCIReqIDType;
268 
269 struct PCIReqIDCache {
270     PCIDevice *dev;
271     PCIReqIDType type;
272 };
273 typedef struct PCIReqIDCache PCIReqIDCache;
274 
275 struct PCIDevice {
276     DeviceState qdev;
277     bool partially_hotplugged;
278     bool has_power;
279 
280     /* PCI config space */
281     uint8_t *config;
282 
283     /* Used to enable config checks on load. Note that writable bits are
284      * never checked even if set in cmask. */
285     uint8_t *cmask;
286 
287     /* Used to implement R/W bytes */
288     uint8_t *wmask;
289 
290     /* Used to implement RW1C(Write 1 to Clear) bytes */
291     uint8_t *w1cmask;
292 
293     /* Used to allocate config space for capabilities. */
294     uint8_t *used;
295 
296     /* the following fields are read only */
297     int32_t devfn;
298     /* Cached device to fetch requester ID from, to avoid the PCI
299      * tree walking every time we invoke PCI request (e.g.,
300      * MSI). For conventional PCI root complex, this field is
301      * meaningless. */
302     PCIReqIDCache requester_id_cache;
303     char name[64];
304     PCIIORegion io_regions[PCI_NUM_REGIONS];
305     AddressSpace bus_master_as;
306     MemoryRegion bus_master_container_region;
307     MemoryRegion bus_master_enable_region;
308 
309     /* do not access the following fields */
310     PCIConfigReadFunc *config_read;
311     PCIConfigWriteFunc *config_write;
312 
313     /* Legacy PCI VGA regions */
314     MemoryRegion *vga_regions[QEMU_PCI_VGA_NUM_REGIONS];
315     bool has_vga;
316 
317     /* Current IRQ levels.  Used internally by the generic PCI code.  */
318     uint8_t irq_state;
319 
320     /* Capability bits */
321     uint32_t cap_present;
322 
323     /* Offset of MSI-X capability in config space */
324     uint8_t msix_cap;
325 
326     /* MSI-X entries */
327     int msix_entries_nr;
328 
329     /* Space to store MSIX table & pending bit array */
330     uint8_t *msix_table;
331     uint8_t *msix_pba;
332     /* MemoryRegion container for msix exclusive BAR setup */
333     MemoryRegion msix_exclusive_bar;
334     /* Memory Regions for MSIX table and pending bit entries. */
335     MemoryRegion msix_table_mmio;
336     MemoryRegion msix_pba_mmio;
337     /* Reference-count for entries actually in use by driver. */
338     unsigned *msix_entry_used;
339     /* MSIX function mask set or MSIX disabled */
340     bool msix_function_masked;
341     /* Version id needed for VMState */
342     int32_t version_id;
343 
344     /* Offset of MSI capability in config space */
345     uint8_t msi_cap;
346 
347     /* PCI Express */
348     PCIExpressDevice exp;
349 
350     /* SHPC */
351     SHPCDevice *shpc;
352 
353     /* Location of option rom */
354     char *romfile;
355     uint32_t romsize;
356     bool has_rom;
357     MemoryRegion rom;
358     uint32_t rom_bar;
359 
360     /* INTx routing notifier */
361     PCIINTxRoutingNotifier intx_routing_notifier;
362 
363     /* MSI-X notifiers */
364     MSIVectorUseNotifier msix_vector_use_notifier;
365     MSIVectorReleaseNotifier msix_vector_release_notifier;
366     MSIVectorPollNotifier msix_vector_poll_notifier;
367 
368     /* ID of standby device in net_failover pair */
369     char *failover_pair_id;
370     uint32_t acpi_index;
371 };
372 
373 void pci_register_bar(PCIDevice *pci_dev, int region_num,
374                       uint8_t attr, MemoryRegion *memory);
375 void pci_register_vga(PCIDevice *pci_dev, MemoryRegion *mem,
376                       MemoryRegion *io_lo, MemoryRegion *io_hi);
377 void pci_unregister_vga(PCIDevice *pci_dev);
378 pcibus_t pci_get_bar_addr(PCIDevice *pci_dev, int region_num);
379 
380 int pci_add_capability(PCIDevice *pdev, uint8_t cap_id,
381                        uint8_t offset, uint8_t size,
382                        Error **errp);
383 
384 void pci_del_capability(PCIDevice *pci_dev, uint8_t cap_id, uint8_t cap_size);
385 
386 uint8_t pci_find_capability(PCIDevice *pci_dev, uint8_t cap_id);
387 
388 
389 uint32_t pci_default_read_config(PCIDevice *d,
390                                  uint32_t address, int len);
391 void pci_default_write_config(PCIDevice *d,
392                               uint32_t address, uint32_t val, int len);
393 void pci_device_save(PCIDevice *s, QEMUFile *f);
394 int pci_device_load(PCIDevice *s, QEMUFile *f);
395 MemoryRegion *pci_address_space(PCIDevice *dev);
396 MemoryRegion *pci_address_space_io(PCIDevice *dev);
397 
398 /*
399  * Should not normally be used by devices. For use by sPAPR target
400  * where QEMU emulates firmware.
401  */
402 int pci_bar(PCIDevice *d, int reg);
403 
404 typedef void (*pci_set_irq_fn)(void *opaque, int irq_num, int level);
405 typedef int (*pci_map_irq_fn)(PCIDevice *pci_dev, int irq_num);
406 typedef PCIINTxRoute (*pci_route_irq_fn)(void *opaque, int pin);
407 
408 #define TYPE_PCI_BUS "PCI"
409 OBJECT_DECLARE_TYPE(PCIBus, PCIBusClass, PCI_BUS)
410 #define TYPE_PCIE_BUS "PCIE"
411 
412 typedef void (*pci_bus_dev_fn)(PCIBus *b, PCIDevice *d, void *opaque);
413 typedef void (*pci_bus_fn)(PCIBus *b, void *opaque);
414 typedef void *(*pci_bus_ret_fn)(PCIBus *b, void *opaque);
415 
416 bool pci_bus_is_express(PCIBus *bus);
417 
418 void pci_root_bus_init(PCIBus *bus, size_t bus_size, DeviceState *parent,
419                        const char *name,
420                        MemoryRegion *address_space_mem,
421                        MemoryRegion *address_space_io,
422                        uint8_t devfn_min, const char *typename);
423 PCIBus *pci_root_bus_new(DeviceState *parent, const char *name,
424                          MemoryRegion *address_space_mem,
425                          MemoryRegion *address_space_io,
426                          uint8_t devfn_min, const char *typename);
427 void pci_root_bus_cleanup(PCIBus *bus);
428 void pci_bus_irqs(PCIBus *bus, pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
429                   void *irq_opaque, int nirq);
430 void pci_bus_irqs_cleanup(PCIBus *bus);
431 int pci_bus_get_irq_level(PCIBus *bus, int irq_num);
432 /* 0 <= pin <= 3 0 = INTA, 1 = INTB, 2 = INTC, 3 = INTD */
433 static inline int pci_swizzle(int slot, int pin)
434 {
435     return (slot + pin) % PCI_NUM_PINS;
436 }
437 int pci_swizzle_map_irq_fn(PCIDevice *pci_dev, int pin);
438 PCIBus *pci_register_root_bus(DeviceState *parent, const char *name,
439                               pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
440                               void *irq_opaque,
441                               MemoryRegion *address_space_mem,
442                               MemoryRegion *address_space_io,
443                               uint8_t devfn_min, int nirq,
444                               const char *typename);
445 void pci_unregister_root_bus(PCIBus *bus);
446 void pci_bus_set_route_irq_fn(PCIBus *, pci_route_irq_fn);
447 PCIINTxRoute pci_device_route_intx_to_irq(PCIDevice *dev, int pin);
448 bool pci_intx_route_changed(PCIINTxRoute *old, PCIINTxRoute *new);
449 void pci_bus_fire_intx_routing_notifier(PCIBus *bus);
450 void pci_device_set_intx_routing_notifier(PCIDevice *dev,
451                                           PCIINTxRoutingNotifier notifier);
452 void pci_device_reset(PCIDevice *dev);
453 
454 PCIDevice *pci_nic_init_nofail(NICInfo *nd, PCIBus *rootbus,
455                                const char *default_model,
456                                const char *default_devaddr);
457 
458 PCIDevice *pci_vga_init(PCIBus *bus);
459 
460 static inline PCIBus *pci_get_bus(const PCIDevice *dev)
461 {
462     return PCI_BUS(qdev_get_parent_bus(DEVICE(dev)));
463 }
464 int pci_bus_num(PCIBus *s);
465 void pci_bus_range(PCIBus *bus, int *min_bus, int *max_bus);
466 static inline int pci_dev_bus_num(const PCIDevice *dev)
467 {
468     return pci_bus_num(pci_get_bus(dev));
469 }
470 
471 int pci_bus_numa_node(PCIBus *bus);
472 void pci_for_each_device(PCIBus *bus, int bus_num,
473                          pci_bus_dev_fn fn,
474                          void *opaque);
475 void pci_for_each_device_reverse(PCIBus *bus, int bus_num,
476                                  pci_bus_dev_fn fn,
477                                  void *opaque);
478 void pci_for_each_device_under_bus(PCIBus *bus,
479                                    pci_bus_dev_fn fn, void *opaque);
480 void pci_for_each_device_under_bus_reverse(PCIBus *bus,
481                                            pci_bus_dev_fn fn,
482                                            void *opaque);
483 void pci_for_each_bus_depth_first(PCIBus *bus, pci_bus_ret_fn begin,
484                                   pci_bus_fn end, void *parent_state);
485 PCIDevice *pci_get_function_0(PCIDevice *pci_dev);
486 
487 /* Use this wrapper when specific scan order is not required. */
488 static inline
489 void pci_for_each_bus(PCIBus *bus, pci_bus_fn fn, void *opaque)
490 {
491     pci_for_each_bus_depth_first(bus, NULL, fn, opaque);
492 }
493 
494 PCIBus *pci_device_root_bus(const PCIDevice *d);
495 const char *pci_root_bus_path(PCIDevice *dev);
496 bool pci_bus_bypass_iommu(PCIBus *bus);
497 PCIDevice *pci_find_device(PCIBus *bus, int bus_num, uint8_t devfn);
498 int pci_qdev_find_device(const char *id, PCIDevice **pdev);
499 void pci_bus_get_w64_range(PCIBus *bus, Range *range);
500 
501 void pci_device_deassert_intx(PCIDevice *dev);
502 
503 typedef AddressSpace *(*PCIIOMMUFunc)(PCIBus *, void *, int);
504 
505 AddressSpace *pci_device_iommu_address_space(PCIDevice *dev);
506 void pci_setup_iommu(PCIBus *bus, PCIIOMMUFunc fn, void *opaque);
507 
508 pcibus_t pci_bar_address(PCIDevice *d,
509                          int reg, uint8_t type, pcibus_t size);
510 
511 static inline void
512 pci_set_byte(uint8_t *config, uint8_t val)
513 {
514     *config = val;
515 }
516 
517 static inline uint8_t
518 pci_get_byte(const uint8_t *config)
519 {
520     return *config;
521 }
522 
523 static inline void
524 pci_set_word(uint8_t *config, uint16_t val)
525 {
526     stw_le_p(config, val);
527 }
528 
529 static inline uint16_t
530 pci_get_word(const uint8_t *config)
531 {
532     return lduw_le_p(config);
533 }
534 
535 static inline void
536 pci_set_long(uint8_t *config, uint32_t val)
537 {
538     stl_le_p(config, val);
539 }
540 
541 static inline uint32_t
542 pci_get_long(const uint8_t *config)
543 {
544     return ldl_le_p(config);
545 }
546 
547 /*
548  * PCI capabilities and/or their fields
549  * are generally DWORD aligned only so
550  * mechanism used by pci_set/get_quad()
551  * must be tolerant to unaligned pointers
552  *
553  */
554 static inline void
555 pci_set_quad(uint8_t *config, uint64_t val)
556 {
557     stq_le_p(config, val);
558 }
559 
560 static inline uint64_t
561 pci_get_quad(const uint8_t *config)
562 {
563     return ldq_le_p(config);
564 }
565 
566 static inline void
567 pci_config_set_vendor_id(uint8_t *pci_config, uint16_t val)
568 {
569     pci_set_word(&pci_config[PCI_VENDOR_ID], val);
570 }
571 
572 static inline void
573 pci_config_set_device_id(uint8_t *pci_config, uint16_t val)
574 {
575     pci_set_word(&pci_config[PCI_DEVICE_ID], val);
576 }
577 
578 static inline void
579 pci_config_set_revision(uint8_t *pci_config, uint8_t val)
580 {
581     pci_set_byte(&pci_config[PCI_REVISION_ID], val);
582 }
583 
584 static inline void
585 pci_config_set_class(uint8_t *pci_config, uint16_t val)
586 {
587     pci_set_word(&pci_config[PCI_CLASS_DEVICE], val);
588 }
589 
590 static inline void
591 pci_config_set_prog_interface(uint8_t *pci_config, uint8_t val)
592 {
593     pci_set_byte(&pci_config[PCI_CLASS_PROG], val);
594 }
595 
596 static inline void
597 pci_config_set_interrupt_pin(uint8_t *pci_config, uint8_t val)
598 {
599     pci_set_byte(&pci_config[PCI_INTERRUPT_PIN], val);
600 }
601 
602 /*
603  * helper functions to do bit mask operation on configuration space.
604  * Just to set bit, use test-and-set and discard returned value.
605  * Just to clear bit, use test-and-clear and discard returned value.
606  * NOTE: They aren't atomic.
607  */
608 static inline uint8_t
609 pci_byte_test_and_clear_mask(uint8_t *config, uint8_t mask)
610 {
611     uint8_t val = pci_get_byte(config);
612     pci_set_byte(config, val & ~mask);
613     return val & mask;
614 }
615 
616 static inline uint8_t
617 pci_byte_test_and_set_mask(uint8_t *config, uint8_t mask)
618 {
619     uint8_t val = pci_get_byte(config);
620     pci_set_byte(config, val | mask);
621     return val & mask;
622 }
623 
624 static inline uint16_t
625 pci_word_test_and_clear_mask(uint8_t *config, uint16_t mask)
626 {
627     uint16_t val = pci_get_word(config);
628     pci_set_word(config, val & ~mask);
629     return val & mask;
630 }
631 
632 static inline uint16_t
633 pci_word_test_and_set_mask(uint8_t *config, uint16_t mask)
634 {
635     uint16_t val = pci_get_word(config);
636     pci_set_word(config, val | mask);
637     return val & mask;
638 }
639 
640 static inline uint32_t
641 pci_long_test_and_clear_mask(uint8_t *config, uint32_t mask)
642 {
643     uint32_t val = pci_get_long(config);
644     pci_set_long(config, val & ~mask);
645     return val & mask;
646 }
647 
648 static inline uint32_t
649 pci_long_test_and_set_mask(uint8_t *config, uint32_t mask)
650 {
651     uint32_t val = pci_get_long(config);
652     pci_set_long(config, val | mask);
653     return val & mask;
654 }
655 
656 static inline uint64_t
657 pci_quad_test_and_clear_mask(uint8_t *config, uint64_t mask)
658 {
659     uint64_t val = pci_get_quad(config);
660     pci_set_quad(config, val & ~mask);
661     return val & mask;
662 }
663 
664 static inline uint64_t
665 pci_quad_test_and_set_mask(uint8_t *config, uint64_t mask)
666 {
667     uint64_t val = pci_get_quad(config);
668     pci_set_quad(config, val | mask);
669     return val & mask;
670 }
671 
672 /* Access a register specified by a mask */
673 static inline void
674 pci_set_byte_by_mask(uint8_t *config, uint8_t mask, uint8_t reg)
675 {
676     uint8_t val = pci_get_byte(config);
677     uint8_t rval = reg << ctz32(mask);
678     pci_set_byte(config, (~mask & val) | (mask & rval));
679 }
680 
681 static inline uint8_t
682 pci_get_byte_by_mask(uint8_t *config, uint8_t mask)
683 {
684     uint8_t val = pci_get_byte(config);
685     return (val & mask) >> ctz32(mask);
686 }
687 
688 static inline void
689 pci_set_word_by_mask(uint8_t *config, uint16_t mask, uint16_t reg)
690 {
691     uint16_t val = pci_get_word(config);
692     uint16_t rval = reg << ctz32(mask);
693     pci_set_word(config, (~mask & val) | (mask & rval));
694 }
695 
696 static inline uint16_t
697 pci_get_word_by_mask(uint8_t *config, uint16_t mask)
698 {
699     uint16_t val = pci_get_word(config);
700     return (val & mask) >> ctz32(mask);
701 }
702 
703 static inline void
704 pci_set_long_by_mask(uint8_t *config, uint32_t mask, uint32_t reg)
705 {
706     uint32_t val = pci_get_long(config);
707     uint32_t rval = reg << ctz32(mask);
708     pci_set_long(config, (~mask & val) | (mask & rval));
709 }
710 
711 static inline uint32_t
712 pci_get_long_by_mask(uint8_t *config, uint32_t mask)
713 {
714     uint32_t val = pci_get_long(config);
715     return (val & mask) >> ctz32(mask);
716 }
717 
718 static inline void
719 pci_set_quad_by_mask(uint8_t *config, uint64_t mask, uint64_t reg)
720 {
721     uint64_t val = pci_get_quad(config);
722     uint64_t rval = reg << ctz32(mask);
723     pci_set_quad(config, (~mask & val) | (mask & rval));
724 }
725 
726 static inline uint64_t
727 pci_get_quad_by_mask(uint8_t *config, uint64_t mask)
728 {
729     uint64_t val = pci_get_quad(config);
730     return (val & mask) >> ctz32(mask);
731 }
732 
733 PCIDevice *pci_new_multifunction(int devfn, bool multifunction,
734                                     const char *name);
735 PCIDevice *pci_new(int devfn, const char *name);
736 bool pci_realize_and_unref(PCIDevice *dev, PCIBus *bus, Error **errp);
737 
738 PCIDevice *pci_create_simple_multifunction(PCIBus *bus, int devfn,
739                                            bool multifunction,
740                                            const char *name);
741 PCIDevice *pci_create_simple(PCIBus *bus, int devfn, const char *name);
742 
743 void lsi53c8xx_handle_legacy_cmdline(DeviceState *lsi_dev);
744 
745 qemu_irq pci_allocate_irq(PCIDevice *pci_dev);
746 void pci_set_irq(PCIDevice *pci_dev, int level);
747 
748 static inline int pci_intx(PCIDevice *pci_dev)
749 {
750     return pci_get_byte(pci_dev->config + PCI_INTERRUPT_PIN) - 1;
751 }
752 
753 static inline void pci_irq_assert(PCIDevice *pci_dev)
754 {
755     pci_set_irq(pci_dev, 1);
756 }
757 
758 static inline void pci_irq_deassert(PCIDevice *pci_dev)
759 {
760     pci_set_irq(pci_dev, 0);
761 }
762 
763 /*
764  * FIXME: PCI does not work this way.
765  * All the callers to this method should be fixed.
766  */
767 static inline void pci_irq_pulse(PCIDevice *pci_dev)
768 {
769     pci_irq_assert(pci_dev);
770     pci_irq_deassert(pci_dev);
771 }
772 
773 static inline int pci_is_express(const PCIDevice *d)
774 {
775     return d->cap_present & QEMU_PCI_CAP_EXPRESS;
776 }
777 
778 static inline int pci_is_express_downstream_port(const PCIDevice *d)
779 {
780     uint8_t type;
781 
782     if (!pci_is_express(d) || !d->exp.exp_cap) {
783         return 0;
784     }
785 
786     type = pcie_cap_get_type(d);
787 
788     return type == PCI_EXP_TYPE_DOWNSTREAM || type == PCI_EXP_TYPE_ROOT_PORT;
789 }
790 
791 static inline int pci_is_vf(const PCIDevice *d)
792 {
793     return d->exp.sriov_vf.pf != NULL;
794 }
795 
796 static inline uint32_t pci_config_size(const PCIDevice *d)
797 {
798     return pci_is_express(d) ? PCIE_CONFIG_SPACE_SIZE : PCI_CONFIG_SPACE_SIZE;
799 }
800 
801 static inline uint16_t pci_get_bdf(PCIDevice *dev)
802 {
803     return PCI_BUILD_BDF(pci_bus_num(pci_get_bus(dev)), dev->devfn);
804 }
805 
806 uint16_t pci_requester_id(PCIDevice *dev);
807 
808 /* DMA access functions */
809 static inline AddressSpace *pci_get_address_space(PCIDevice *dev)
810 {
811     return &dev->bus_master_as;
812 }
813 
814 /**
815  * pci_dma_rw: Read from or write to an address space from PCI device.
816  *
817  * Return a MemTxResult indicating whether the operation succeeded
818  * or failed (eg unassigned memory, device rejected the transaction,
819  * IOMMU fault).
820  *
821  * @dev: #PCIDevice doing the memory access
822  * @addr: address within the #PCIDevice address space
823  * @buf: buffer with the data transferred
824  * @len: the number of bytes to read or write
825  * @dir: indicates the transfer direction
826  */
827 static inline MemTxResult pci_dma_rw(PCIDevice *dev, dma_addr_t addr,
828                                      void *buf, dma_addr_t len,
829                                      DMADirection dir, MemTxAttrs attrs)
830 {
831     return dma_memory_rw(pci_get_address_space(dev), addr, buf, len,
832                          dir, attrs);
833 }
834 
835 /**
836  * pci_dma_read: Read from an address space from PCI device.
837  *
838  * Return a MemTxResult indicating whether the operation succeeded
839  * or failed (eg unassigned memory, device rejected the transaction,
840  * IOMMU fault).  Called within RCU critical section.
841  *
842  * @dev: #PCIDevice doing the memory access
843  * @addr: address within the #PCIDevice address space
844  * @buf: buffer with the data transferred
845  * @len: length of the data transferred
846  */
847 static inline MemTxResult pci_dma_read(PCIDevice *dev, dma_addr_t addr,
848                                        void *buf, dma_addr_t len)
849 {
850     return pci_dma_rw(dev, addr, buf, len,
851                       DMA_DIRECTION_TO_DEVICE, MEMTXATTRS_UNSPECIFIED);
852 }
853 
854 /**
855  * pci_dma_write: Write to address space from PCI device.
856  *
857  * Return a MemTxResult indicating whether the operation succeeded
858  * or failed (eg unassigned memory, device rejected the transaction,
859  * IOMMU fault).
860  *
861  * @dev: #PCIDevice doing the memory access
862  * @addr: address within the #PCIDevice address space
863  * @buf: buffer with the data transferred
864  * @len: the number of bytes to write
865  */
866 static inline MemTxResult pci_dma_write(PCIDevice *dev, dma_addr_t addr,
867                                         const void *buf, dma_addr_t len)
868 {
869     return pci_dma_rw(dev, addr, (void *) buf, len,
870                       DMA_DIRECTION_FROM_DEVICE, MEMTXATTRS_UNSPECIFIED);
871 }
872 
873 #define PCI_DMA_DEFINE_LDST(_l, _s, _bits) \
874     static inline MemTxResult ld##_l##_pci_dma(PCIDevice *dev, \
875                                                dma_addr_t addr, \
876                                                uint##_bits##_t *val, \
877                                                MemTxAttrs attrs) \
878     { \
879         return ld##_l##_dma(pci_get_address_space(dev), addr, val, attrs); \
880     } \
881     static inline MemTxResult st##_s##_pci_dma(PCIDevice *dev, \
882                                                dma_addr_t addr, \
883                                                uint##_bits##_t val, \
884                                                MemTxAttrs attrs) \
885     { \
886         return st##_s##_dma(pci_get_address_space(dev), addr, val, attrs); \
887     }
888 
889 PCI_DMA_DEFINE_LDST(ub, b, 8);
890 PCI_DMA_DEFINE_LDST(uw_le, w_le, 16)
891 PCI_DMA_DEFINE_LDST(l_le, l_le, 32);
892 PCI_DMA_DEFINE_LDST(q_le, q_le, 64);
893 PCI_DMA_DEFINE_LDST(uw_be, w_be, 16)
894 PCI_DMA_DEFINE_LDST(l_be, l_be, 32);
895 PCI_DMA_DEFINE_LDST(q_be, q_be, 64);
896 
897 #undef PCI_DMA_DEFINE_LDST
898 
899 /**
900  * pci_dma_map: Map device PCI address space range into host virtual address
901  * @dev: #PCIDevice to be accessed
902  * @addr: address within that device's address space
903  * @plen: pointer to length of buffer; updated on return to indicate
904  *        if only a subset of the requested range has been mapped
905  * @dir: indicates the transfer direction
906  *
907  * Return: A host pointer, or %NULL if the resources needed to
908  *         perform the mapping are exhausted (in that case *@plen
909  *         is set to zero).
910  */
911 static inline void *pci_dma_map(PCIDevice *dev, dma_addr_t addr,
912                                 dma_addr_t *plen, DMADirection dir)
913 {
914     void *buf;
915 
916     buf = dma_memory_map(pci_get_address_space(dev), addr, plen, dir,
917                          MEMTXATTRS_UNSPECIFIED);
918     return buf;
919 }
920 
921 static inline void pci_dma_unmap(PCIDevice *dev, void *buffer, dma_addr_t len,
922                                  DMADirection dir, dma_addr_t access_len)
923 {
924     dma_memory_unmap(pci_get_address_space(dev), buffer, len, dir, access_len);
925 }
926 
927 static inline void pci_dma_sglist_init(QEMUSGList *qsg, PCIDevice *dev,
928                                        int alloc_hint)
929 {
930     qemu_sglist_init(qsg, DEVICE(dev), alloc_hint, pci_get_address_space(dev));
931 }
932 
933 extern const VMStateDescription vmstate_pci_device;
934 
935 #define VMSTATE_PCI_DEVICE(_field, _state) {                         \
936     .name       = (stringify(_field)),                               \
937     .size       = sizeof(PCIDevice),                                 \
938     .vmsd       = &vmstate_pci_device,                               \
939     .flags      = VMS_STRUCT,                                        \
940     .offset     = vmstate_offset_value(_state, _field, PCIDevice),   \
941 }
942 
943 #define VMSTATE_PCI_DEVICE_POINTER(_field, _state) {                 \
944     .name       = (stringify(_field)),                               \
945     .size       = sizeof(PCIDevice),                                 \
946     .vmsd       = &vmstate_pci_device,                               \
947     .flags      = VMS_STRUCT|VMS_POINTER,                            \
948     .offset     = vmstate_offset_pointer(_state, _field, PCIDevice), \
949 }
950 
951 MSIMessage pci_get_msi_message(PCIDevice *dev, int vector);
952 void pci_set_power(PCIDevice *pci_dev, bool state);
953 
954 #endif
955