4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright 2013-2014 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/queue.h>
43 #include <rte_errno.h>
44 #include <rte_interrupts.h>
48 #include <rte_per_lcore.h>
49 #include <rte_memory.h>
50 #include <rte_memzone.h>
52 #include <rte_string_fns.h>
53 #include <rte_common.h>
54 #include <rte_devargs.h>
56 #include "eal_private.h"
58 extern struct rte_pci_bus rte_pci_bus;
60 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
62 const char *pci_get_sysfs_path(void)
64 const char *path = NULL;
66 path = getenv("SYSFS_PCI_DEVICES");
68 return SYSFS_PCI_DEVICES;
73 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
75 struct rte_devargs *devargs;
76 struct rte_pci_addr addr;
79 pbus = rte_bus_find_by_name("pci");
80 TAILQ_FOREACH(devargs, &devargs_list, next) {
81 if (devargs->bus != pbus)
83 devargs->bus->parse(devargs->name, &addr);
84 if (!rte_eal_compare_pci_addr(&dev->addr, &addr))
91 pci_name_set(struct rte_pci_device *dev)
93 struct rte_devargs *devargs;
95 /* Each device has its internal, canonical name set. */
96 rte_pci_device_name(&dev->addr,
97 dev->name, sizeof(dev->name));
98 devargs = pci_devargs_lookup(dev);
99 dev->device.devargs = devargs;
100 /* In blacklist mode, if the device is not blacklisted, no
101 * rte_devargs exists for it.
104 /* If an rte_devargs exists, the generic rte_device uses the
105 * given name as its namea
107 dev->device.name = dev->device.devargs->name;
109 /* Otherwise, it uses the internal, canonical form. */
110 dev->device.name = dev->name;
113 /* map a particular resource from a file */
115 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
116 int additional_flags)
120 /* Map the PCI memory resource of device */
121 mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
122 MAP_SHARED | additional_flags, fd, offset);
123 if (mapaddr == MAP_FAILED) {
124 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
125 __func__, fd, requested_addr,
126 (unsigned long)size, (unsigned long)offset,
127 strerror(errno), mapaddr);
129 RTE_LOG(DEBUG, EAL, " PCI memory mapped at %p\n", mapaddr);
134 /* unmap a particular resource */
136 pci_unmap_resource(void *requested_addr, size_t size)
138 if (requested_addr == NULL)
141 /* Unmap the PCI memory resource of device */
142 if (munmap(requested_addr, size)) {
143 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
144 __func__, requested_addr, (unsigned long)size,
147 RTE_LOG(DEBUG, EAL, " PCI memory unmapped at %p\n",
152 * Match the PCI Driver and Device using the ID Table
155 * PCI driver from which ID table would be extracted
157 * PCI device to match against the driver
159 * 1 for successful match
160 * 0 for unsuccessful match
163 rte_pci_match(const struct rte_pci_driver *pci_drv,
164 const struct rte_pci_device *pci_dev)
166 const struct rte_pci_id *id_table;
168 for (id_table = pci_drv->id_table; id_table->vendor_id != 0;
170 /* check if device's identifiers match the driver's ones */
171 if (id_table->vendor_id != pci_dev->id.vendor_id &&
172 id_table->vendor_id != PCI_ANY_ID)
174 if (id_table->device_id != pci_dev->id.device_id &&
175 id_table->device_id != PCI_ANY_ID)
177 if (id_table->subsystem_vendor_id !=
178 pci_dev->id.subsystem_vendor_id &&
179 id_table->subsystem_vendor_id != PCI_ANY_ID)
181 if (id_table->subsystem_device_id !=
182 pci_dev->id.subsystem_device_id &&
183 id_table->subsystem_device_id != PCI_ANY_ID)
185 if (id_table->class_id != pci_dev->id.class_id &&
186 id_table->class_id != RTE_CLASS_ANY_ID)
196 * If vendor/device ID match, call the probe() function of the
200 rte_pci_probe_one_driver(struct rte_pci_driver *dr,
201 struct rte_pci_device *dev)
204 struct rte_pci_addr *loc;
206 if ((dr == NULL) || (dev == NULL))
211 /* The device is not blacklisted; Check if driver supports it */
212 if (!rte_pci_match(dr, dev))
213 /* Match of device and driver failed */
216 RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
217 loc->domain, loc->bus, loc->devid, loc->function,
218 dev->device.numa_node);
220 /* no initialization when blacklisted, return without error */
221 if (dev->device.devargs != NULL &&
222 dev->device.devargs->policy ==
223 RTE_DEV_BLACKLISTED) {
224 RTE_LOG(INFO, EAL, " Device is blacklisted, not"
229 RTE_LOG(INFO, EAL, " probe driver: %x:%x %s\n", dev->id.vendor_id,
230 dev->id.device_id, dr->driver.name);
232 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
233 /* map resources for devices that use igb_uio */
234 ret = rte_pci_map_device(dev);
239 /* reference driver structure */
241 dev->device.driver = &dr->driver;
243 /* call the driver probe() function */
244 ret = dr->probe(dr, dev);
247 dev->device.driver = NULL;
248 if ((dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) &&
249 /* Don't unmap if device is unsupported and
250 * driver needs mapped resources.
253 (dr->drv_flags & RTE_PCI_DRV_KEEP_MAPPED_RES)))
254 rte_pci_unmap_device(dev);
261 * If vendor/device ID match, call the remove() function of the
265 rte_pci_detach_dev(struct rte_pci_device *dev)
267 struct rte_pci_addr *loc;
268 struct rte_pci_driver *dr;
276 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
277 loc->domain, loc->bus, loc->devid,
278 loc->function, dev->device.numa_node);
280 RTE_LOG(DEBUG, EAL, " remove driver: %x:%x %s\n", dev->id.vendor_id,
281 dev->id.device_id, dr->driver.name);
283 if (dr->remove && (dr->remove(dev) < 0))
284 return -1; /* negative value is an error */
286 /* clear driver structure */
289 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
290 /* unmap resources for devices that use igb_uio */
291 rte_pci_unmap_device(dev);
297 * If vendor/device ID match, call the probe() function of all
298 * registered driver for the given device. Return -1 if initialization
299 * failed, return 1 if no driver is found for this device.
302 pci_probe_all_drivers(struct rte_pci_device *dev)
304 struct rte_pci_driver *dr = NULL;
310 /* Check if a driver is already loaded */
311 if (dev->driver != NULL)
314 FOREACH_DRIVER_ON_PCIBUS(dr) {
315 rc = rte_pci_probe_one_driver(dr, dev);
317 /* negative value is an error */
320 /* positive value means driver doesn't support it */
328 * Find the pci device specified by pci address, then invoke probe function of
329 * the driver of the device.
332 rte_pci_probe_one(const struct rte_pci_addr *addr)
334 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 FOREACH_DEVICE_ON_PCIBUS(dev) {
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_pci_detach(const struct rte_pci_addr *addr)
371 struct rte_pci_device *dev = NULL;
377 FOREACH_DEVICE_ON_PCIBUS(dev) {
378 if (rte_eal_compare_pci_addr(&dev->addr, addr))
381 ret = rte_pci_detach_dev(dev);
383 /* negative value is an error */
386 /* positive value means driver doesn't support it */
389 rte_pci_remove_device(dev);
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.
410 struct rte_pci_device *dev = NULL;
411 size_t probed = 0, failed = 0;
412 struct rte_devargs *devargs;
416 if (rte_pci_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST)
419 FOREACH_DEVICE_ON_PCIBUS(dev) {
422 devargs = dev->device.devargs;
423 /* probe all or only whitelisted devices */
425 ret = pci_probe_all_drivers(dev);
426 else if (devargs != NULL &&
427 devargs->policy == RTE_DEV_WHITELISTED)
428 ret = pci_probe_all_drivers(dev);
430 RTE_LOG(ERR, EAL, "Requested device " PCI_PRI_FMT
431 " cannot be used\n", dev->addr.domain, dev->addr.bus,
432 dev->addr.devid, dev->addr.function);
439 return (probed && probed == failed) ? -1 : 0;
442 /* dump one device */
444 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
448 fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
449 dev->addr.devid, dev->addr.function);
450 fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
453 for (i = 0; i != sizeof(dev->mem_resource) /
454 sizeof(dev->mem_resource[0]); i++) {
455 fprintf(f, " %16.16"PRIx64" %16.16"PRIx64"\n",
456 dev->mem_resource[i].phys_addr,
457 dev->mem_resource[i].len);
462 /* dump devices on the bus */
464 rte_pci_dump(FILE *f)
466 struct rte_pci_device *dev = NULL;
468 FOREACH_DEVICE_ON_PCIBUS(dev) {
469 pci_dump_one_device(f, dev);
474 pci_parse(const char *name, void *addr)
476 struct rte_pci_addr *out = addr;
477 struct rte_pci_addr pci_addr;
480 parse = (eal_parse_pci_BDF(name, &pci_addr) == 0 ||
481 eal_parse_pci_DomBDF(name, &pci_addr) == 0);
482 if (parse && addr != NULL)
484 return parse == false;
487 /* register a driver */
489 rte_pci_register(struct rte_pci_driver *driver)
491 TAILQ_INSERT_TAIL(&rte_pci_bus.driver_list, driver, next);
492 driver->bus = &rte_pci_bus;
495 /* unregister a driver */
497 rte_pci_unregister(struct rte_pci_driver *driver)
499 TAILQ_REMOVE(&rte_pci_bus.driver_list, driver, next);
503 /* Add a device to PCI bus */
505 rte_pci_add_device(struct rte_pci_device *pci_dev)
507 TAILQ_INSERT_TAIL(&rte_pci_bus.device_list, pci_dev, next);
510 /* Insert a device into a predefined position in PCI bus */
512 rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
513 struct rte_pci_device *new_pci_dev)
515 TAILQ_INSERT_BEFORE(exist_pci_dev, new_pci_dev, next);
518 /* Remove a device from PCI bus */
520 rte_pci_remove_device(struct rte_pci_device *pci_dev)
522 TAILQ_REMOVE(&rte_pci_bus.device_list, pci_dev, next);
525 static struct rte_device *
526 pci_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
529 struct rte_pci_device *dev;
531 FOREACH_DEVICE_ON_PCIBUS(dev) {
532 if (start && &dev->device == start) {
533 start = NULL; /* starting point found */
536 if (cmp(&dev->device, data) == 0)
544 pci_plug(struct rte_device *dev)
546 return pci_probe_all_drivers(RTE_DEV_TO_PCI(dev));
550 pci_unplug(struct rte_device *dev)
552 struct rte_pci_device *pdev;
555 pdev = RTE_DEV_TO_PCI(dev);
556 ret = rte_pci_detach_dev(pdev);
557 rte_pci_remove_device(pdev);
562 struct rte_pci_bus rte_pci_bus = {
564 .scan = rte_pci_scan,
565 .probe = rte_pci_probe,
566 .find_device = pci_find_device,
568 .unplug = pci_unplug,
571 .device_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.device_list),
572 .driver_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.driver_list),
575 RTE_REGISTER_BUS(pci, rte_pci_bus.bus);