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_memcpy.h>
51 #include <rte_memzone.h>
53 #include <rte_string_fns.h>
54 #include <rte_common.h>
55 #include <rte_devargs.h>
57 #include "eal_private.h"
59 extern struct rte_pci_bus rte_pci_bus;
61 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
63 const char *pci_get_sysfs_path(void)
65 const char *path = NULL;
67 path = getenv("SYSFS_PCI_DEVICES");
69 return SYSFS_PCI_DEVICES;
74 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
76 struct rte_devargs *devargs;
77 struct rte_pci_addr addr;
80 pbus = rte_bus_find_by_name("pci");
81 TAILQ_FOREACH(devargs, &devargs_list, next) {
82 if (devargs->bus != pbus)
84 devargs->bus->parse(devargs->name, &addr);
85 if (!rte_eal_compare_pci_addr(&dev->addr, &addr))
91 /* map a particular resource from a file */
93 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
98 /* Map the PCI memory resource of device */
99 mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
100 MAP_SHARED | additional_flags, fd, offset);
101 if (mapaddr == MAP_FAILED) {
102 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
103 __func__, fd, requested_addr,
104 (unsigned long)size, (unsigned long)offset,
105 strerror(errno), mapaddr);
107 RTE_LOG(DEBUG, EAL, " PCI memory mapped at %p\n", mapaddr);
112 /* unmap a particular resource */
114 pci_unmap_resource(void *requested_addr, size_t size)
116 if (requested_addr == NULL)
119 /* Unmap the PCI memory resource of device */
120 if (munmap(requested_addr, size)) {
121 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
122 __func__, requested_addr, (unsigned long)size,
125 RTE_LOG(DEBUG, EAL, " PCI memory unmapped at %p\n",
130 * Match the PCI Driver and Device using the ID Table
133 * PCI driver from which ID table would be extracted
135 * PCI device to match against the driver
137 * 1 for successful match
138 * 0 for unsuccessful match
141 rte_pci_match(const struct rte_pci_driver *pci_drv,
142 const struct rte_pci_device *pci_dev)
144 const struct rte_pci_id *id_table;
146 for (id_table = pci_drv->id_table; id_table->vendor_id != 0;
148 /* check if device's identifiers match the driver's ones */
149 if (id_table->vendor_id != pci_dev->id.vendor_id &&
150 id_table->vendor_id != PCI_ANY_ID)
152 if (id_table->device_id != pci_dev->id.device_id &&
153 id_table->device_id != PCI_ANY_ID)
155 if (id_table->subsystem_vendor_id !=
156 pci_dev->id.subsystem_vendor_id &&
157 id_table->subsystem_vendor_id != PCI_ANY_ID)
159 if (id_table->subsystem_device_id !=
160 pci_dev->id.subsystem_device_id &&
161 id_table->subsystem_device_id != PCI_ANY_ID)
163 if (id_table->class_id != pci_dev->id.class_id &&
164 id_table->class_id != RTE_CLASS_ANY_ID)
174 * If vendor/device ID match, call the probe() function of the
178 rte_pci_probe_one_driver(struct rte_pci_driver *dr,
179 struct rte_pci_device *dev)
182 struct rte_pci_addr *loc;
184 if ((dr == NULL) || (dev == NULL))
189 /* The device is not blacklisted; Check if driver supports it */
190 if (!rte_pci_match(dr, dev))
191 /* Match of device and driver failed */
194 RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
195 loc->domain, loc->bus, loc->devid, loc->function,
196 dev->device.numa_node);
198 /* no initialization when blacklisted, return without error */
199 if (dev->device.devargs != NULL &&
200 dev->device.devargs->type ==
201 RTE_DEVTYPE_BLACKLISTED) {
202 RTE_LOG(INFO, EAL, " Device is blacklisted, not"
207 RTE_LOG(INFO, EAL, " probe driver: %x:%x %s\n", dev->id.vendor_id,
208 dev->id.device_id, dr->driver.name);
210 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
211 /* map resources for devices that use igb_uio */
212 ret = rte_pci_map_device(dev);
217 /* reference driver structure */
219 dev->device.driver = &dr->driver;
221 /* call the driver probe() function */
222 ret = dr->probe(dr, dev);
225 if ((dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) &&
226 /* Don't unmap if device is unsupported and
227 * driver needs mapped resources.
230 (dr->drv_flags & RTE_PCI_DRV_KEEP_MAPPED_RES)))
231 rte_pci_unmap_device(dev);
238 * If vendor/device ID match, call the remove() function of the
242 rte_pci_detach_dev(struct rte_pci_device *dev)
244 struct rte_pci_addr *loc;
245 struct rte_pci_driver *dr;
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->device.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_pci_unmap_device(dev);
274 * If vendor/device ID match, call the probe() function of all
275 * registered driver for the given device. Return -1 if initialization
276 * failed, return 1 if no driver is found for this device.
279 pci_probe_all_drivers(struct rte_pci_device *dev)
281 struct rte_pci_driver *dr = NULL;
287 /* Check if a driver is already loaded */
288 if (dev->driver != NULL)
291 FOREACH_DRIVER_ON_PCIBUS(dr) {
292 rc = rte_pci_probe_one_driver(dr, dev);
294 /* negative value is an error */
297 /* positive value means driver doesn't support it */
305 * Find the pci device specified by pci address, then invoke probe function of
306 * the driver of the device.
309 rte_pci_probe_one(const struct rte_pci_addr *addr)
311 struct rte_pci_device *dev = NULL;
318 /* update current pci device in global list, kernel bindings might have
319 * changed since last time we looked at it.
321 if (pci_update_device(addr) < 0)
324 FOREACH_DEVICE_ON_PCIBUS(dev) {
325 if (rte_eal_compare_pci_addr(&dev->addr, addr))
328 ret = pci_probe_all_drivers(dev);
336 RTE_LOG(WARNING, EAL,
337 "Requested device " PCI_PRI_FMT " cannot be used\n",
338 addr->domain, addr->bus, addr->devid, addr->function);
343 * Detach device specified by its pci address.
346 rte_pci_detach(const struct rte_pci_addr *addr)
348 struct rte_pci_device *dev = NULL;
354 FOREACH_DEVICE_ON_PCIBUS(dev) {
355 if (rte_eal_compare_pci_addr(&dev->addr, addr))
358 ret = rte_pci_detach_dev(dev);
360 /* negative value is an error */
363 /* positive value means driver doesn't support it */
366 rte_pci_remove_device(dev);
373 RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
374 " cannot be used\n", dev->addr.domain, dev->addr.bus,
375 dev->addr.devid, dev->addr.function);
380 * Scan the content of the PCI bus, and call the probe() function for
381 * all registered drivers that have a matching entry in its id_table
382 * for discovered devices.
387 struct rte_pci_device *dev = NULL;
388 size_t probed = 0, failed = 0;
389 struct rte_devargs *devargs;
393 if (rte_pci_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST)
396 FOREACH_DEVICE_ON_PCIBUS(dev) {
399 /* set devargs in PCI structure */
400 devargs = pci_devargs_lookup(dev);
402 dev->device.devargs = devargs;
404 /* probe all or only whitelisted devices */
406 ret = pci_probe_all_drivers(dev);
407 else if (devargs != NULL &&
408 devargs->type == RTE_DEVTYPE_WHITELISTED)
409 ret = pci_probe_all_drivers(dev);
411 RTE_LOG(ERR, EAL, "Requested device " PCI_PRI_FMT
412 " cannot be used\n", dev->addr.domain, dev->addr.bus,
413 dev->addr.devid, dev->addr.function);
420 return (probed && probed == failed) ? -1 : 0;
423 /* dump one device */
425 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
429 fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
430 dev->addr.devid, dev->addr.function);
431 fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
434 for (i = 0; i != sizeof(dev->mem_resource) /
435 sizeof(dev->mem_resource[0]); i++) {
436 fprintf(f, " %16.16"PRIx64" %16.16"PRIx64"\n",
437 dev->mem_resource[i].phys_addr,
438 dev->mem_resource[i].len);
443 /* dump devices on the bus */
445 rte_pci_dump(FILE *f)
447 struct rte_pci_device *dev = NULL;
449 FOREACH_DEVICE_ON_PCIBUS(dev) {
450 pci_dump_one_device(f, dev);
455 pci_parse(const char *name, void *addr)
457 struct rte_pci_addr *out = addr;
458 struct rte_pci_addr pci_addr;
461 parse = (eal_parse_pci_BDF(name, &pci_addr) == 0 ||
462 eal_parse_pci_DomBDF(name, &pci_addr) == 0);
463 if (parse && addr != NULL)
465 return parse == false;
468 /* register a driver */
470 rte_pci_register(struct rte_pci_driver *driver)
472 TAILQ_INSERT_TAIL(&rte_pci_bus.driver_list, driver, next);
473 driver->bus = &rte_pci_bus;
476 /* unregister a driver */
478 rte_pci_unregister(struct rte_pci_driver *driver)
480 TAILQ_REMOVE(&rte_pci_bus.driver_list, driver, next);
484 /* Add a device to PCI bus */
486 rte_pci_add_device(struct rte_pci_device *pci_dev)
488 TAILQ_INSERT_TAIL(&rte_pci_bus.device_list, pci_dev, next);
491 /* Insert a device into a predefined position in PCI bus */
493 rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
494 struct rte_pci_device *new_pci_dev)
496 TAILQ_INSERT_BEFORE(exist_pci_dev, new_pci_dev, next);
499 /* Remove a device from PCI bus */
501 rte_pci_remove_device(struct rte_pci_device *pci_dev)
503 TAILQ_REMOVE(&rte_pci_bus.device_list, pci_dev, next);
506 static struct rte_device *
507 pci_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
510 struct rte_pci_device *dev;
512 FOREACH_DEVICE_ON_PCIBUS(dev) {
513 if (start && &dev->device == start) {
514 start = NULL; /* starting point found */
517 if (cmp(&dev->device, data) == 0)
525 pci_plug(struct rte_device *dev, const char *devargs __rte_unused)
527 struct rte_pci_device *pdev;
528 struct rte_pci_addr *addr;
530 addr = &RTE_DEV_TO_PCI(dev)->addr;
532 /* Find the current device holding this address in the bus. */
533 FOREACH_DEVICE_ON_PCIBUS(pdev) {
534 if (rte_eal_compare_pci_addr(&pdev->addr, addr) == 0)
535 return rte_pci_probe_one(addr);
543 pci_unplug(struct rte_device *dev)
545 struct rte_pci_device *pdev;
547 pdev = RTE_DEV_TO_PCI(dev);
548 if (rte_pci_detach(&pdev->addr) != 0) {
555 struct rte_pci_bus rte_pci_bus = {
557 .scan = rte_pci_scan,
558 .probe = rte_pci_probe,
559 .find_device = pci_find_device,
561 .unplug = pci_unplug,
564 .device_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.device_list),
565 .driver_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.driver_list),
568 RTE_REGISTER_BUS(pci, rte_pci_bus.bus);