4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 * Copyright 2013-2014 6WIND S.A.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in
45 * the documentation and/or other materials provided with the
47 * * Neither the name of 6WIND S.A. nor the names of its
48 * contributors may be used to endorse or promote products derived
49 * from this software without specific prior written permission.
51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
80 #include <sys/queue.h>
84 #include <rte_interrupts.h>
86 TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
87 TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
89 extern struct pci_driver_list pci_driver_list; /**< Global list of PCI drivers. */
90 extern struct pci_device_list pci_device_list; /**< Global list of PCI devices. */
92 /** Pathname of PCI devices directory. */
93 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
95 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
96 #define PCI_PRI_FMT "%.4" PRIx16 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
98 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
99 #define PCI_SHORT_PRI_FMT "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
101 /** Nb. of values in PCI device identifier format string. */
102 #define PCI_FMT_NVAL 4
104 /** Nb. of values in PCI resource format. */
105 #define PCI_RESOURCE_FMT_NVAL 3
107 /** IO resource type: memory address space */
108 #define IORESOURCE_MEM 0x00000200
111 * A structure describing a PCI resource.
113 struct rte_pci_resource {
114 uint64_t phys_addr; /**< Physical address, 0 if no resource. */
115 uint64_t len; /**< Length of the resource. */
116 void *addr; /**< Virtual address, NULL when not mapped. */
119 /** Maximum number of PCI resources. */
120 #define PCI_MAX_RESOURCE 6
123 * A structure describing an ID for a PCI driver. Each driver provides a
124 * table of these IDs for each device that it supports.
127 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
128 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
129 uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
130 uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
134 * A structure describing the location of a PCI device.
136 struct rte_pci_addr {
137 uint16_t domain; /**< Device domain */
138 uint8_t bus; /**< Device bus */
139 uint8_t devid; /**< Device ID */
140 uint8_t function; /**< Device function. */
145 enum rte_kernel_driver {
146 RTE_KDRV_UNKNOWN = 0,
149 RTE_KDRV_UIO_GENERIC,
153 * A structure describing a PCI device.
155 struct rte_pci_device {
156 TAILQ_ENTRY(rte_pci_device) next; /**< Next probed PCI device. */
157 struct rte_pci_addr addr; /**< PCI location. */
158 struct rte_pci_id id; /**< PCI ID. */
159 struct rte_pci_resource mem_resource[PCI_MAX_RESOURCE]; /**< PCI Memory Resource */
160 struct rte_intr_handle intr_handle; /**< Interrupt handle */
161 struct rte_pci_driver *driver; /**< Associated driver */
162 uint16_t max_vfs; /**< sriov enable if not zero */
163 int numa_node; /**< NUMA node connection */
164 struct rte_devargs *devargs; /**< Device user arguments */
165 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
168 /** Any PCI device identifier (vendor, device, ...) */
169 #define PCI_ANY_ID (0xffff)
172 /** C++ macro used to help building up tables of device IDs */
173 #define RTE_PCI_DEVICE(vend, dev) \
179 /** Macro used to help building up tables of device IDs */
180 #define RTE_PCI_DEVICE(vend, dev) \
181 .vendor_id = (vend), \
182 .device_id = (dev), \
183 .subsystem_vendor_id = PCI_ANY_ID, \
184 .subsystem_device_id = PCI_ANY_ID
187 struct rte_pci_driver;
190 * Initialisation function for the driver called during PCI probing.
192 typedef int (pci_devinit_t)(struct rte_pci_driver *, struct rte_pci_device *);
195 * Uninitialisation function for the driver called during hotplugging.
197 typedef int (pci_devuninit_t)(struct rte_pci_device *);
200 * A structure describing a PCI driver.
202 struct rte_pci_driver {
203 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
204 const char *name; /**< Driver name. */
205 pci_devinit_t *devinit; /**< Device init. function. */
206 pci_devuninit_t *devuninit; /**< Device uninit function. */
207 const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
208 uint32_t drv_flags; /**< Flags contolling handling of device. */
211 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
212 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
213 /** Device driver must be registered several times until failure - deprecated */
214 #pragma GCC poison RTE_PCI_DRV_MULTIPLE
215 /** Device needs to be unbound even if no module is provided */
216 #define RTE_PCI_DRV_FORCE_UNBIND 0x0004
217 /** Device driver supports link state interrupt */
218 #define RTE_PCI_DRV_INTR_LSC 0x0008
219 /** Device driver supports detaching capability */
220 #define RTE_PCI_DRV_DETACHABLE 0x0010
222 /**< Internal use only - Macro used by pci addr parsing functions **/
223 #define GET_PCIADDR_FIELD(in, fd, lim, dlm) \
228 val = strtoul((in), &end, 16); \
229 if (errno != 0 || end[0] != (dlm) || val > (lim)) \
231 (fd) = (typeof (fd))val; \
236 * Utility function to produce a PCI Bus-Device-Function value
237 * given a string representation. Assumes that the BDF is provided without
238 * a domain prefix (i.e. domain returned is always 0)
241 * The input string to be parsed. Should have the format XX:XX.X
243 * The PCI Bus-Device-Function address to be returned. Domain will always be
246 * 0 on success, negative on error.
249 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
251 dev_addr->domain = 0;
252 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
253 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
254 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
259 * Utility function to produce a PCI Bus-Device-Function value
260 * given a string representation. Assumes that the BDF is provided including
264 * The input string to be parsed. Should have the format XXXX:XX:XX.X
266 * The PCI Bus-Device-Function address to be returned
268 * 0 on success, negative on error.
271 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
273 GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
274 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
275 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
276 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
279 #undef GET_PCIADDR_FIELD
281 /* Compare two PCI device addresses. */
283 * Utility function to compare two PCI device addresses.
286 * The PCI Bus-Device-Function address to compare
288 * The PCI Bus-Device-Function address to compare
290 * 0 on equal PCI address.
291 * Positive on addr is greater than addr2.
292 * Negative on addr is less than addr2, or error.
295 rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
296 const struct rte_pci_addr *addr2)
298 uint64_t dev_addr, dev_addr2;
300 if ((addr == NULL) || (addr2 == NULL))
303 dev_addr = (addr->domain << 24) | (addr->bus << 16) |
304 (addr->devid << 8) | addr->function;
305 dev_addr2 = (addr2->domain << 24) | (addr2->bus << 16) |
306 (addr2->devid << 8) | addr2->function;
308 if (dev_addr > dev_addr2)
310 else if (dev_addr < dev_addr2)
317 * Scan the content of the PCI bus, and the devices in the devices
321 * 0 on success, negative on error
323 int rte_eal_pci_scan(void);
326 * Probe the PCI bus for registered drivers.
328 * Scan the content of the PCI bus, and call the probe() function for
329 * all registered drivers that have a matching entry in its id_table
330 * for discovered devices.
334 * - Negative on error.
336 int rte_eal_pci_probe(void);
338 #ifdef RTE_LIBRTE_EAL_HOTPLUG
340 * Probe the single PCI device.
342 * Scan the content of the PCI bus, and find the pci device specified by pci
343 * address, then call the probe() function for registered driver that has a
344 * matching entry in its id_table for discovered device.
347 * The PCI Bus-Device-Function address to probe.
350 * - Negative on error.
352 int rte_eal_pci_probe_one(const struct rte_pci_addr *addr);
355 * Close the single PCI device.
357 * Scan the content of the PCI bus, and find the pci device specified by pci
358 * address, then call the close() function for registered driver that has a
359 * matching entry in its id_table for discovered device.
362 * The PCI Bus-Device-Function address to close.
365 * - Negative on error.
367 int rte_eal_pci_close_one(const struct rte_pci_addr *addr);
368 #endif /* RTE_LIBRTE_EAL_HOTPLUG */
371 * Dump the content of the PCI bus.
374 * A pointer to a file for output
376 void rte_eal_pci_dump(FILE *f);
379 * Register a PCI driver.
382 * A pointer to a rte_pci_driver structure describing the driver
385 void rte_eal_pci_register(struct rte_pci_driver *driver);
388 * Unregister a PCI driver.
391 * A pointer to a rte_pci_driver structure describing the driver
392 * to be unregistered.
394 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
400 #endif /* _RTE_PCI_H_ */