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; /**< Associated driver */
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) */
73 * Helper macro for drivers that need to convert to struct rte_pci_device.
75 #define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
77 #define RTE_ETH_DEV_TO_PCI(eth_dev) RTE_DEV_TO_PCI((eth_dev)->device)
79 /** Any PCI device identifier (vendor, device, ...) */
80 #define PCI_ANY_ID (0xffff)
81 #define RTE_CLASS_ANY_ID (0xffffff)
84 /** C++ macro used to help building up tables of device IDs */
85 #define RTE_PCI_DEVICE(vend, dev) \
92 /** Macro used to help building up tables of device IDs */
93 #define RTE_PCI_DEVICE(vend, dev) \
94 .class_id = RTE_CLASS_ANY_ID, \
95 .vendor_id = (vend), \
97 .subsystem_vendor_id = PCI_ANY_ID, \
98 .subsystem_device_id = PCI_ANY_ID
102 * Initialisation function for the driver called during PCI probing.
104 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
107 * Uninitialisation function for the driver called during hotplugging.
109 typedef int (pci_remove_t)(struct rte_pci_device *);
112 * A structure describing a PCI driver.
114 struct rte_pci_driver {
115 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
116 struct rte_driver driver; /**< Inherit core driver. */
117 struct rte_pci_bus *bus; /**< PCI bus reference. */
118 pci_probe_t *probe; /**< Device Probe function. */
119 pci_remove_t *remove; /**< Device Remove function. */
120 const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
121 uint32_t drv_flags; /**< Flags contolling handling of device. */
125 * Structure describing the PCI bus
128 struct rte_bus bus; /**< Inherit the generic class */
129 struct rte_pci_device_list device_list; /**< List of PCI devices */
130 struct rte_pci_driver_list driver_list; /**< List of PCI drivers */
133 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
134 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
135 /** Device driver supports link state interrupt */
136 #define RTE_PCI_DRV_INTR_LSC 0x0008
137 /** Device driver supports device removal interrupt */
138 #define RTE_PCI_DRV_INTR_RMV 0x0010
139 /** Device driver needs to keep mapped resources if unsupported dev detected */
140 #define RTE_PCI_DRV_KEEP_MAPPED_RES 0x0020
141 /** Device driver supports IOVA as VA */
142 #define RTE_PCI_DRV_IOVA_AS_VA 0X0040
145 * Map the PCI device resources in user space virtual memory address
147 * Note that driver should not call this function when flag
148 * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
152 * A pointer to a rte_pci_device structure describing the device
156 * 0 on success, negative on error and positive if no driver
157 * is found for the device.
159 int rte_pci_map_device(struct rte_pci_device *dev);
165 * A pointer to a rte_pci_device structure describing the device
168 void rte_pci_unmap_device(struct rte_pci_device *dev);
171 * Dump the content of the PCI bus.
174 * A pointer to a file for output
176 void rte_pci_dump(FILE *f);
179 * Register a PCI driver.
182 * A pointer to a rte_pci_driver structure describing the driver
185 void rte_pci_register(struct rte_pci_driver *driver);
187 /** Helper for PCI device registration from driver (eth, crypto) instance */
188 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
189 RTE_INIT(pciinitfn_ ##nm); \
190 static void pciinitfn_ ##nm(void) \
192 (pci_drv).driver.name = RTE_STR(nm);\
193 rte_pci_register(&pci_drv); \
195 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
198 * Unregister a PCI driver.
201 * A pointer to a rte_pci_driver structure describing the driver
202 * to be unregistered.
204 void rte_pci_unregister(struct rte_pci_driver *driver);
207 * Read PCI config space.
210 * A pointer to a rte_pci_device structure describing the device
213 * A data buffer where the bytes should be read into
215 * The length of the data buffer.
217 * The offset into PCI config space
219 int rte_pci_read_config(const struct rte_pci_device *device,
220 void *buf, size_t len, off_t offset);
223 * Write PCI config space.
226 * A pointer to a rte_pci_device structure describing the device
229 * A data buffer containing the bytes should be written
231 * The length of the data buffer.
233 * The offset into PCI config space
235 int rte_pci_write_config(const struct rte_pci_device *device,
236 const void *buf, size_t len, off_t offset);
239 * A structure used to access io resources for a pci device.
240 * rte_pci_ioport is arch, os, driver specific, and should not be used outside
243 struct rte_pci_ioport {
244 struct rte_pci_device *dev;
246 uint64_t len; /* only filled for memory mapped ports */
250 * Initialize a rte_pci_ioport object for a pci device io resource.
252 * This object is then used to gain access to those io resources (see below).
255 * A pointer to a rte_pci_device structure describing the device
258 * Index of the io pci resource we want to access.
260 * The rte_pci_ioport object to be initialized.
262 * 0 on success, negative on error.
264 int rte_pci_ioport_map(struct rte_pci_device *dev, int bar,
265 struct rte_pci_ioport *p);
268 * Release any resources used in a rte_pci_ioport object.
271 * The rte_pci_ioport object to be uninitialized.
273 * 0 on success, negative on error.
275 int rte_pci_ioport_unmap(struct rte_pci_ioport *p);
278 * Read from a io pci resource.
281 * The rte_pci_ioport object from which we want to read.
283 * A data buffer where the bytes should be read into
285 * The length of the data buffer.
287 * The offset into the pci io resource.
289 void rte_pci_ioport_read(struct rte_pci_ioport *p,
290 void *data, size_t len, off_t offset);
293 * Write to a io pci resource.
296 * The rte_pci_ioport object to which we want to write.
298 * A data buffer where the bytes should be read into
300 * The length of the data buffer.
302 * The offset into the pci io resource.
304 void rte_pci_ioport_write(struct rte_pci_ioport *p,
305 const void *data, size_t len, off_t offset);
311 #endif /* _RTE_BUS_PCI_H_ */