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.
69 #include <sys/queue.h>
72 #include <rte_interrupts.h>
75 #include <rte_per_lcore.h>
76 #include <rte_memory.h>
77 #include <rte_memzone.h>
79 #include <rte_string_fns.h>
80 #include <rte_common.h>
81 #include <rte_devargs.h>
83 #include "eal_private.h"
85 struct pci_driver_list pci_driver_list =
86 TAILQ_HEAD_INITIALIZER(pci_driver_list);
87 struct pci_device_list pci_device_list =
88 TAILQ_HEAD_INITIALIZER(pci_device_list);
90 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
92 const char *pci_get_sysfs_path(void)
94 const char *path = NULL;
96 path = getenv("SYSFS_PCI_DEVICES");
98 return SYSFS_PCI_DEVICES;
103 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
105 struct rte_devargs *devargs;
107 TAILQ_FOREACH(devargs, &devargs_list, next) {
108 if (devargs->type != RTE_DEVTYPE_BLACKLISTED_PCI &&
109 devargs->type != RTE_DEVTYPE_WHITELISTED_PCI)
111 if (!rte_eal_compare_pci_addr(&dev->addr, &devargs->pci.addr))
117 /* map a particular resource from a file */
119 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
120 int additional_flags)
124 /* Map the PCI memory resource of device */
125 mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
126 MAP_SHARED | additional_flags, fd, offset);
127 if (mapaddr == MAP_FAILED) {
128 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
129 __func__, fd, requested_addr,
130 (unsigned long)size, (unsigned long)offset,
131 strerror(errno), mapaddr);
133 RTE_LOG(DEBUG, EAL, " PCI memory mapped at %p\n", mapaddr);
138 /* unmap a particular resource */
140 pci_unmap_resource(void *requested_addr, size_t size)
142 if (requested_addr == NULL)
145 /* Unmap the PCI memory resource of device */
146 if (munmap(requested_addr, size)) {
147 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
148 __func__, requested_addr, (unsigned long)size,
151 RTE_LOG(DEBUG, EAL, " PCI memory unmapped at %p\n",
156 * If vendor/device ID match, call the probe() function of the
160 rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr, struct rte_pci_device *dev)
163 const struct rte_pci_id *id_table;
165 for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
167 /* check if device's identifiers match the driver's ones */
168 if (id_table->vendor_id != dev->id.vendor_id &&
169 id_table->vendor_id != PCI_ANY_ID)
171 if (id_table->device_id != dev->id.device_id &&
172 id_table->device_id != PCI_ANY_ID)
174 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
175 id_table->subsystem_vendor_id != PCI_ANY_ID)
177 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
178 id_table->subsystem_device_id != PCI_ANY_ID)
180 if (id_table->class_id != dev->id.class_id &&
181 id_table->class_id != RTE_CLASS_ANY_ID)
184 struct rte_pci_addr *loc = &dev->addr;
186 RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
187 loc->domain, loc->bus, loc->devid, loc->function,
190 /* no initialization when blacklisted, return without error */
191 if (dev->devargs != NULL &&
192 dev->devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
193 RTE_LOG(INFO, EAL, " Device is blacklisted, not initializing\n");
197 RTE_LOG(INFO, EAL, " probe driver: %x:%x %s\n", dev->id.vendor_id,
198 dev->id.device_id, dr->driver.name);
200 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
201 /* map resources for devices that use igb_uio */
202 ret = rte_eal_pci_map_device(dev);
205 } else if (dr->drv_flags & RTE_PCI_DRV_FORCE_UNBIND &&
206 rte_eal_process_type() == RTE_PROC_PRIMARY) {
207 /* unbind current driver */
208 if (pci_unbind_kernel_driver(dev) < 0)
212 /* reference driver structure */
215 /* call the driver probe() function */
216 return dr->probe(dr, dev);
218 /* return positive value if driver doesn't support this device */
223 * If vendor/device ID match, call the remove() function of the
227 rte_eal_pci_detach_dev(struct rte_pci_driver *dr,
228 struct rte_pci_device *dev)
230 const struct rte_pci_id *id_table;
232 if ((dr == NULL) || (dev == NULL))
235 for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
237 /* check if device's identifiers match the driver's ones */
238 if (id_table->vendor_id != dev->id.vendor_id &&
239 id_table->vendor_id != PCI_ANY_ID)
241 if (id_table->device_id != dev->id.device_id &&
242 id_table->device_id != PCI_ANY_ID)
244 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
245 id_table->subsystem_vendor_id != PCI_ANY_ID)
247 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
248 id_table->subsystem_device_id != PCI_ANY_ID)
251 struct rte_pci_addr *loc = &dev->addr;
253 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
254 loc->domain, loc->bus, loc->devid,
255 loc->function, dev->numa_node);
257 RTE_LOG(DEBUG, EAL, " remove driver: %x:%x %s\n", dev->id.vendor_id,
258 dev->id.device_id, dr->driver.name);
260 if (dr->remove && (dr->remove(dev) < 0))
261 return -1; /* negative value is an error */
263 /* clear driver structure */
266 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
267 /* unmap resources for devices that use igb_uio */
268 rte_eal_pci_unmap_device(dev);
273 /* return positive value if driver doesn't support this device */
278 * If vendor/device ID match, call the probe() function of all
279 * registered driver for the given device. Return -1 if initialization
280 * failed, return 1 if no driver is found for this device.
283 pci_probe_all_drivers(struct rte_pci_device *dev)
285 struct rte_pci_driver *dr = NULL;
291 TAILQ_FOREACH(dr, &pci_driver_list, next) {
292 rc = rte_eal_pci_probe_one_driver(dr, dev);
294 /* negative value is an error */
297 /* positive value means driver doesn't support it */
305 * If vendor/device ID match, call the remove() function of all
306 * registered driver for the given device. Return -1 if initialization
307 * failed, return 1 if no driver is found for this device.
310 pci_detach_all_drivers(struct rte_pci_device *dev)
312 struct rte_pci_driver *dr = NULL;
318 TAILQ_FOREACH(dr, &pci_driver_list, next) {
319 rc = rte_eal_pci_detach_dev(dr, dev);
321 /* negative value is an error */
324 /* positive value means driver doesn't support it */
332 * Find the pci device specified by pci address, then invoke probe function of
333 * the driver of the devive.
336 rte_eal_pci_probe_one(const struct rte_pci_addr *addr)
338 struct rte_pci_device *dev = NULL;
344 /* update current pci device in global list, kernel bindings might have
345 * changed since last time we looked at it.
347 if (pci_update_device(addr) < 0)
350 TAILQ_FOREACH(dev, &pci_device_list, next) {
351 if (rte_eal_compare_pci_addr(&dev->addr, addr))
354 ret = pci_probe_all_drivers(dev);
362 RTE_LOG(WARNING, EAL,
363 "Requested device " PCI_PRI_FMT " cannot be used\n",
364 addr->domain, addr->bus, addr->devid, addr->function);
369 * Detach device specified by its pci address.
372 rte_eal_pci_detach(const struct rte_pci_addr *addr)
374 struct rte_pci_device *dev = NULL;
380 TAILQ_FOREACH(dev, &pci_device_list, next) {
381 if (rte_eal_compare_pci_addr(&dev->addr, addr))
384 ret = pci_detach_all_drivers(dev);
388 TAILQ_REMOVE(&pci_device_list, dev, next);
394 RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
395 " cannot be used\n", dev->addr.domain, dev->addr.bus,
396 dev->addr.devid, dev->addr.function);
401 * Scan the content of the PCI bus, and call the probe() function for
402 * all registered drivers that have a matching entry in its id_table
403 * for discovered devices.
406 rte_eal_pci_probe(void)
408 struct rte_pci_device *dev = NULL;
409 struct rte_devargs *devargs;
413 if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) == 0)
416 TAILQ_FOREACH(dev, &pci_device_list, next) {
418 /* set devargs in PCI structure */
419 devargs = pci_devargs_lookup(dev);
421 dev->devargs = devargs;
423 /* probe all or only whitelisted devices */
425 ret = pci_probe_all_drivers(dev);
426 else if (devargs != NULL &&
427 devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
428 ret = pci_probe_all_drivers(dev);
430 rte_exit(EXIT_FAILURE, "Requested device " PCI_PRI_FMT
431 " cannot be used\n", dev->addr.domain, dev->addr.bus,
432 dev->addr.devid, dev->addr.function);
438 /* dump one device */
440 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
444 fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
445 dev->addr.devid, dev->addr.function);
446 fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
449 for (i = 0; i != sizeof(dev->mem_resource) /
450 sizeof(dev->mem_resource[0]); i++) {
451 fprintf(f, " %16.16"PRIx64" %16.16"PRIx64"\n",
452 dev->mem_resource[i].phys_addr,
453 dev->mem_resource[i].len);
458 /* dump devices on the bus */
460 rte_eal_pci_dump(FILE *f)
462 struct rte_pci_device *dev = NULL;
464 TAILQ_FOREACH(dev, &pci_device_list, next) {
465 pci_dump_one_device(f, dev);
469 /* register a driver */
471 rte_eal_pci_register(struct rte_pci_driver *driver)
473 TAILQ_INSERT_TAIL(&pci_driver_list, driver, next);
474 rte_eal_driver_register(&driver->driver);
477 /* unregister a driver */
479 rte_eal_pci_unregister(struct rte_pci_driver *driver)
481 rte_eal_driver_unregister(&driver->driver);
482 TAILQ_REMOVE(&pci_driver_list, driver, next);