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_errno.h>
73 #include <rte_interrupts.h>
76 #include <rte_per_lcore.h>
77 #include <rte_memory.h>
78 #include <rte_memzone.h>
80 #include <rte_string_fns.h>
81 #include <rte_common.h>
82 #include <rte_devargs.h>
84 #include "eal_private.h"
86 struct pci_driver_list pci_driver_list =
87 TAILQ_HEAD_INITIALIZER(pci_driver_list);
88 struct pci_device_list pci_device_list =
89 TAILQ_HEAD_INITIALIZER(pci_device_list);
91 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
93 const char *pci_get_sysfs_path(void)
95 const char *path = NULL;
97 path = getenv("SYSFS_PCI_DEVICES");
99 return SYSFS_PCI_DEVICES;
104 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
106 struct rte_devargs *devargs;
108 TAILQ_FOREACH(devargs, &devargs_list, next) {
109 if (devargs->type != RTE_DEVTYPE_BLACKLISTED_PCI &&
110 devargs->type != RTE_DEVTYPE_WHITELISTED_PCI)
112 if (!rte_eal_compare_pci_addr(&dev->addr, &devargs->pci.addr))
118 /* map a particular resource from a file */
120 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
121 int additional_flags)
125 /* Map the PCI memory resource of device */
126 mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
127 MAP_SHARED | additional_flags, fd, offset);
128 if (mapaddr == MAP_FAILED) {
129 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
130 __func__, fd, requested_addr,
131 (unsigned long)size, (unsigned long)offset,
132 strerror(errno), mapaddr);
134 RTE_LOG(DEBUG, EAL, " PCI memory mapped at %p\n", mapaddr);
139 /* unmap a particular resource */
141 pci_unmap_resource(void *requested_addr, size_t size)
143 if (requested_addr == NULL)
146 /* Unmap the PCI memory resource of device */
147 if (munmap(requested_addr, size)) {
148 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
149 __func__, requested_addr, (unsigned long)size,
152 RTE_LOG(DEBUG, EAL, " PCI memory unmapped at %p\n",
157 * Match the PCI Driver and Device using the ID Table
160 * PCI driver from which ID table would be extracted
162 * PCI device to match against the driver
164 * 1 for successful match
165 * 0 for unsuccessful match
168 rte_pci_match(const struct rte_pci_driver *pci_drv,
169 const struct rte_pci_device *pci_dev)
171 const struct rte_pci_id *id_table;
173 for (id_table = pci_drv->id_table; id_table->vendor_id != 0;
175 /* check if device's identifiers match the driver's ones */
176 if (id_table->vendor_id != pci_dev->id.vendor_id &&
177 id_table->vendor_id != PCI_ANY_ID)
179 if (id_table->device_id != pci_dev->id.device_id &&
180 id_table->device_id != PCI_ANY_ID)
182 if (id_table->subsystem_vendor_id !=
183 pci_dev->id.subsystem_vendor_id &&
184 id_table->subsystem_vendor_id != PCI_ANY_ID)
186 if (id_table->subsystem_device_id !=
187 pci_dev->id.subsystem_device_id &&
188 id_table->subsystem_device_id != PCI_ANY_ID)
190 if (id_table->class_id != pci_dev->id.class_id &&
191 id_table->class_id != RTE_CLASS_ANY_ID)
201 * If vendor/device ID match, call the probe() function of the
205 rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr,
206 struct rte_pci_device *dev)
209 struct rte_pci_addr *loc;
211 if ((dr == NULL) || (dev == NULL))
216 /* The device is not blacklisted; Check if driver supports it */
217 if (!rte_pci_match(dr, dev)) {
218 /* Match of device and driver failed */
219 RTE_LOG(DEBUG, EAL, "Driver (%s) doesn't match the device\n",
224 RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
225 loc->domain, loc->bus, loc->devid, loc->function,
226 dev->device.numa_node);
228 /* no initialization when blacklisted, return without error */
229 if (dev->device.devargs != NULL &&
230 dev->device.devargs->type ==
231 RTE_DEVTYPE_BLACKLISTED_PCI) {
232 RTE_LOG(INFO, EAL, " Device is blacklisted, not"
237 RTE_LOG(INFO, EAL, " probe driver: %x:%x %s\n", dev->id.vendor_id,
238 dev->id.device_id, dr->driver.name);
240 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
241 /* map resources for devices that use igb_uio */
242 ret = rte_eal_pci_map_device(dev);
247 /* reference driver structure */
250 /* call the driver probe() function */
251 ret = dr->probe(dr, dev);
254 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
255 rte_eal_pci_unmap_device(dev);
262 * If vendor/device ID match, call the remove() function of the
266 rte_eal_pci_detach_dev(struct rte_pci_device *dev)
268 struct rte_pci_addr *loc;
269 struct rte_pci_driver *dr;
277 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
278 loc->domain, loc->bus, loc->devid,
279 loc->function, dev->device.numa_node);
281 RTE_LOG(DEBUG, EAL, " remove driver: %x:%x %s\n", dev->id.vendor_id,
282 dev->id.device_id, dr->driver.name);
284 if (dr->remove && (dr->remove(dev) < 0))
285 return -1; /* negative value is an error */
287 /* clear driver structure */
290 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
291 /* unmap resources for devices that use igb_uio */
292 rte_eal_pci_unmap_device(dev);
298 * If vendor/device ID match, call the probe() function of all
299 * registered driver for the given device. Return -1 if initialization
300 * failed, return 1 if no driver is found for this device.
303 pci_probe_all_drivers(struct rte_pci_device *dev)
305 struct rte_pci_driver *dr = NULL;
311 /* Check if a driver is already loaded */
312 if (dev->driver != NULL)
315 TAILQ_FOREACH(dr, &pci_driver_list, next) {
316 rc = rte_eal_pci_probe_one_driver(dr, dev);
318 /* negative value is an error */
321 /* positive value means driver doesn't support it */
329 * Find the pci device specified by pci address, then invoke probe function of
330 * the driver of the devive.
333 rte_eal_pci_probe_one(const struct rte_pci_addr *addr)
335 struct rte_pci_device *dev = NULL;
341 /* update current pci device in global list, kernel bindings might have
342 * changed since last time we looked at it.
344 if (pci_update_device(addr) < 0)
347 TAILQ_FOREACH(dev, &pci_device_list, next) {
348 if (rte_eal_compare_pci_addr(&dev->addr, addr))
351 ret = pci_probe_all_drivers(dev);
359 RTE_LOG(WARNING, EAL,
360 "Requested device " PCI_PRI_FMT " cannot be used\n",
361 addr->domain, addr->bus, addr->devid, addr->function);
366 * Detach device specified by its pci address.
369 rte_eal_pci_detach(const struct rte_pci_addr *addr)
371 struct rte_pci_device *dev = NULL;
377 TAILQ_FOREACH(dev, &pci_device_list, next) {
378 if (rte_eal_compare_pci_addr(&dev->addr, addr))
381 ret = rte_eal_pci_detach_dev(dev);
383 /* negative value is an error */
386 /* positive value means driver doesn't support it */
389 TAILQ_REMOVE(&pci_device_list, dev, next);
396 RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
397 " cannot be used\n", dev->addr.domain, dev->addr.bus,
398 dev->addr.devid, dev->addr.function);
403 * Scan the content of the PCI bus, and call the probe() function for
404 * all registered drivers that have a matching entry in its id_table
405 * for discovered devices.
408 rte_eal_pci_probe(void)
410 struct rte_pci_device *dev = NULL;
411 size_t probed = 0, failed = 0;
412 struct rte_devargs *devargs;
416 if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) == 0)
419 TAILQ_FOREACH(dev, &pci_device_list, next) {
422 /* set devargs in PCI structure */
423 devargs = pci_devargs_lookup(dev);
425 dev->device.devargs = devargs;
427 /* probe all or only whitelisted devices */
429 ret = pci_probe_all_drivers(dev);
430 else if (devargs != NULL &&
431 devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
432 ret = pci_probe_all_drivers(dev);
434 RTE_LOG(ERR, EAL, "Requested device " PCI_PRI_FMT
435 " cannot be used\n", dev->addr.domain, dev->addr.bus,
436 dev->addr.devid, dev->addr.function);
443 return (probed && probed == failed) ? -1 : 0;
446 /* dump one device */
448 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
452 fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
453 dev->addr.devid, dev->addr.function);
454 fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
457 for (i = 0; i != sizeof(dev->mem_resource) /
458 sizeof(dev->mem_resource[0]); i++) {
459 fprintf(f, " %16.16"PRIx64" %16.16"PRIx64"\n",
460 dev->mem_resource[i].phys_addr,
461 dev->mem_resource[i].len);
466 /* dump devices on the bus */
468 rte_eal_pci_dump(FILE *f)
470 struct rte_pci_device *dev = NULL;
472 TAILQ_FOREACH(dev, &pci_device_list, next) {
473 pci_dump_one_device(f, dev);
477 /* register a driver */
479 rte_eal_pci_register(struct rte_pci_driver *driver)
481 TAILQ_INSERT_TAIL(&pci_driver_list, driver, next);
482 rte_eal_driver_register(&driver->driver);
485 /* unregister a driver */
487 rte_eal_pci_unregister(struct rte_pci_driver *driver)
489 rte_eal_driver_unregister(&driver->driver);
490 TAILQ_REMOVE(&pci_driver_list, driver, next);