1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2015 Intel Corporation.
3 * Copyright 2013-2014 6WIND S.A.
6 #ifndef _RTE_BUS_PCI_H_
7 #define _RTE_BUS_PCI_H_
12 * RTE PCI Bus Interface
23 #include <sys/queue.h>
27 #include <rte_debug.h>
28 #include <rte_interrupts.h>
33 /** Pathname of PCI devices directory. */
34 const char *rte_pci_get_sysfs_path(void);
36 /* Forward declarations */
37 struct rte_pci_device;
38 struct rte_pci_driver;
40 /** List of PCI devices */
41 TAILQ_HEAD(rte_pci_device_list, rte_pci_device);
42 /** List of PCI drivers */
43 TAILQ_HEAD(rte_pci_driver_list, rte_pci_driver);
45 /* PCI Bus iterators */
46 #define FOREACH_DEVICE_ON_PCIBUS(p) \
47 TAILQ_FOREACH(p, &(rte_pci_bus.device_list), next)
49 #define FOREACH_DRIVER_ON_PCIBUS(p) \
50 TAILQ_FOREACH(p, &(rte_pci_bus.driver_list), next)
55 * A structure describing a PCI device.
57 struct rte_pci_device {
58 TAILQ_ENTRY(rte_pci_device) next; /**< Next probed PCI device. */
59 struct rte_device device; /**< Inherit core device */
60 struct rte_pci_addr addr; /**< PCI location. */
61 struct rte_pci_id id; /**< PCI ID. */
62 struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
63 /**< PCI Memory Resource */
64 struct rte_intr_handle intr_handle; /**< Interrupt handle */
65 struct rte_pci_driver *driver; /**< PCI driver used in probing */
66 uint16_t max_vfs; /**< sriov enable if not zero */
67 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
68 char name[PCI_PRI_STR_SIZE+1]; /**< PCI location (ASCII) */
69 struct rte_intr_handle vfio_req_intr_handle;
70 /**< Handler of VFIO request interrupt */
75 * Helper macro for drivers that need to convert to struct rte_pci_device.
77 #define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
79 #define RTE_DEV_TO_PCI_CONST(ptr) \
80 container_of(ptr, const struct rte_pci_device, device)
82 #define RTE_ETH_DEV_TO_PCI(eth_dev) RTE_DEV_TO_PCI((eth_dev)->device)
84 /** Any PCI device identifier (vendor, device, ...) */
85 #define PCI_ANY_ID (0xffff)
86 #define RTE_CLASS_ANY_ID (0xffffff)
89 /** C++ macro used to help building up tables of device IDs */
90 #define RTE_PCI_DEVICE(vend, dev) \
97 /** Macro used to help building up tables of device IDs */
98 #define RTE_PCI_DEVICE(vend, dev) \
99 .class_id = RTE_CLASS_ANY_ID, \
100 .vendor_id = (vend), \
101 .device_id = (dev), \
102 .subsystem_vendor_id = PCI_ANY_ID, \
103 .subsystem_device_id = PCI_ANY_ID
107 * Initialisation function for the driver called during PCI probing.
109 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
112 * Uninitialisation function for the driver called during hotplugging.
114 typedef int (pci_remove_t)(struct rte_pci_device *);
117 * A structure describing a PCI driver.
119 struct rte_pci_driver {
120 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
121 struct rte_driver driver; /**< Inherit core driver. */
122 struct rte_pci_bus *bus; /**< PCI bus reference. */
123 pci_probe_t *probe; /**< Device Probe function. */
124 pci_remove_t *remove; /**< Device Remove function. */
125 const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
126 uint32_t drv_flags; /**< Flags RTE_PCI_DRV_*. */
130 * Structure describing the PCI bus
133 struct rte_bus bus; /**< Inherit the generic class */
134 struct rte_pci_device_list device_list; /**< List of PCI devices */
135 struct rte_pci_driver_list driver_list; /**< List of PCI drivers */
138 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
139 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
140 /** Device needs PCI BAR mapping with enabled write combining (wc) */
141 #define RTE_PCI_DRV_WC_ACTIVATE 0x0002
142 /** Device already probed can be probed again to check for new ports. */
143 #define RTE_PCI_DRV_PROBE_AGAIN 0x0004
144 /** Device driver supports link state interrupt */
145 #define RTE_PCI_DRV_INTR_LSC 0x0008
146 /** Device driver supports device removal interrupt */
147 #define RTE_PCI_DRV_INTR_RMV 0x0010
148 /** Device driver needs to keep mapped resources if unsupported dev detected */
149 #define RTE_PCI_DRV_KEEP_MAPPED_RES 0x0020
150 /** Device driver supports IOVA as VA */
151 #define RTE_PCI_DRV_IOVA_AS_VA 0X0040
154 * Map the PCI device resources in user space virtual memory address
156 * Note that driver should not call this function when flag
157 * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
161 * A pointer to a rte_pci_device structure describing the device
165 * 0 on success, negative on error and positive if no driver
166 * is found for the device.
168 int rte_pci_map_device(struct rte_pci_device *dev);
174 * A pointer to a rte_pci_device structure describing the device
177 void rte_pci_unmap_device(struct rte_pci_device *dev);
180 * Dump the content of the PCI bus.
183 * A pointer to a file for output
185 void rte_pci_dump(FILE *f);
188 * Register a PCI driver.
191 * A pointer to a rte_pci_driver structure describing the driver
194 void rte_pci_register(struct rte_pci_driver *driver);
196 /** Helper for PCI device registration from driver (eth, crypto) instance */
197 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
198 RTE_INIT(pciinitfn_ ##nm) \
200 (pci_drv).driver.name = RTE_STR(nm);\
201 rte_pci_register(&pci_drv); \
203 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
206 * Unregister a PCI driver.
209 * A pointer to a rte_pci_driver structure describing the driver
210 * to be unregistered.
212 void rte_pci_unregister(struct rte_pci_driver *driver);
215 * Read PCI config space.
218 * A pointer to a rte_pci_device structure describing the device
221 * A data buffer where the bytes should be read into
223 * The length of the data buffer.
225 * The offset into PCI config space
227 * Number of bytes read on success, negative on error.
229 int rte_pci_read_config(const struct rte_pci_device *device,
230 void *buf, size_t len, off_t offset);
233 * Write PCI config space.
236 * A pointer to a rte_pci_device structure describing the device
239 * A data buffer containing the bytes should be written
241 * The length of the data buffer.
243 * The offset into PCI config space
245 int rte_pci_write_config(const struct rte_pci_device *device,
246 const void *buf, size_t len, off_t offset);
249 * A structure used to access io resources for a pci device.
250 * rte_pci_ioport is arch, os, driver specific, and should not be used outside
253 struct rte_pci_ioport {
254 struct rte_pci_device *dev;
256 uint64_t len; /* only filled for memory mapped ports */
260 * Initialize a rte_pci_ioport object for a pci device io resource.
262 * This object is then used to gain access to those io resources (see below).
265 * A pointer to a rte_pci_device structure describing the device
268 * Index of the io pci resource we want to access.
270 * The rte_pci_ioport object to be initialized.
272 * 0 on success, negative on error.
274 int rte_pci_ioport_map(struct rte_pci_device *dev, int bar,
275 struct rte_pci_ioport *p);
278 * Release any resources used in a rte_pci_ioport object.
281 * The rte_pci_ioport object to be uninitialized.
283 * 0 on success, negative on error.
285 int rte_pci_ioport_unmap(struct rte_pci_ioport *p);
288 * Read from a io pci resource.
291 * The rte_pci_ioport object from which we want to read.
293 * A data buffer where the bytes should be read into
295 * The length of the data buffer.
297 * The offset into the pci io resource.
299 void rte_pci_ioport_read(struct rte_pci_ioport *p,
300 void *data, size_t len, off_t offset);
303 * Write to a io pci resource.
306 * The rte_pci_ioport object to which we want to write.
308 * A data buffer where the bytes should be read into
310 * The length of the data buffer.
312 * The offset into the pci io resource.
314 void rte_pci_ioport_write(struct rte_pci_ioport *p,
315 const void *data, size_t len, off_t offset);
321 #endif /* _RTE_BUS_PCI_H_ */