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 rte_pci_match(const struct rte_pci_driver *pci_drv,
156 const struct rte_pci_device *pci_dev)
158 const struct rte_pci_id *id_table;
160 for (id_table = pci_drv->id_table; id_table->vendor_id != 0;
162 /* check if device's identifiers match the driver's ones */
163 if (id_table->vendor_id != pci_dev->id.vendor_id &&
164 id_table->vendor_id != PCI_ANY_ID)
166 if (id_table->device_id != pci_dev->id.device_id &&
167 id_table->device_id != PCI_ANY_ID)
169 if (id_table->subsystem_vendor_id !=
170 pci_dev->id.subsystem_vendor_id &&
171 id_table->subsystem_vendor_id != PCI_ANY_ID)
173 if (id_table->subsystem_device_id !=
174 pci_dev->id.subsystem_device_id &&
175 id_table->subsystem_device_id != PCI_ANY_ID)
177 if (id_table->class_id != pci_dev->id.class_id &&
178 id_table->class_id != RTE_CLASS_ANY_ID)
188 * If vendor/device ID match, call the probe() function of the
192 rte_pci_probe_one_driver(struct rte_pci_driver *dr,
193 struct rte_pci_device *dev)
196 struct rte_pci_addr *loc;
198 if ((dr == NULL) || (dev == NULL))
203 /* The device is not blacklisted; Check if driver supports it */
204 if (!rte_pci_match(dr, dev))
205 /* Match of device and driver failed */
208 RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
209 loc->domain, loc->bus, loc->devid, loc->function,
210 dev->device.numa_node);
212 /* no initialization when blacklisted, return without error */
213 if (dev->device.devargs != NULL &&
214 dev->device.devargs->policy ==
215 RTE_DEV_BLACKLISTED) {
216 RTE_LOG(INFO, EAL, " Device is blacklisted, not"
221 if (dev->device.numa_node < 0) {
222 RTE_LOG(WARNING, EAL, " Invalid NUMA socket, default to 0\n");
223 dev->device.numa_node = 0;
226 RTE_LOG(INFO, EAL, " probe driver: %x:%x %s\n", dev->id.vendor_id,
227 dev->id.device_id, dr->driver.name);
229 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
230 /* map resources for devices that use igb_uio */
231 ret = rte_pci_map_device(dev);
236 /* reference driver structure */
238 dev->device.driver = &dr->driver;
240 /* call the driver probe() function */
241 ret = dr->probe(dr, dev);
244 dev->device.driver = NULL;
245 if ((dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) &&
246 /* Don't unmap if device is unsupported and
247 * driver needs mapped resources.
250 (dr->drv_flags & RTE_PCI_DRV_KEEP_MAPPED_RES)))
251 rte_pci_unmap_device(dev);
258 * If vendor/device ID match, call the remove() function of the
262 rte_pci_detach_dev(struct rte_pci_device *dev)
264 struct rte_pci_addr *loc;
265 struct rte_pci_driver *dr;
273 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
274 loc->domain, loc->bus, loc->devid,
275 loc->function, dev->device.numa_node);
277 RTE_LOG(DEBUG, EAL, " remove driver: %x:%x %s\n", dev->id.vendor_id,
278 dev->id.device_id, dr->driver.name);
280 if (dr->remove && (dr->remove(dev) < 0))
281 return -1; /* negative value is an error */
283 /* clear driver structure */
286 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
287 /* unmap resources for devices that use igb_uio */
288 rte_pci_unmap_device(dev);
294 * If vendor/device ID match, call the probe() function of all
295 * registered driver for the given device. Return -1 if initialization
296 * failed, return 1 if no driver is found for this device.
299 pci_probe_all_drivers(struct rte_pci_device *dev)
301 struct rte_pci_driver *dr = NULL;
307 /* Check if a driver is already loaded */
308 if (dev->driver != NULL)
311 FOREACH_DRIVER_ON_PCIBUS(dr) {
312 rc = rte_pci_probe_one_driver(dr, dev);
314 /* negative value is an error */
317 /* positive value means driver doesn't support it */
325 * Find the pci device specified by pci address, then invoke probe function of
326 * the driver of the device.
329 rte_pci_probe_one(const struct rte_pci_addr *addr)
331 struct rte_pci_device *dev = NULL;
338 /* update current pci device in global list, kernel bindings might have
339 * changed since last time we looked at it.
341 if (pci_update_device(addr) < 0)
344 FOREACH_DEVICE_ON_PCIBUS(dev) {
345 if (rte_eal_compare_pci_addr(&dev->addr, addr))
348 ret = pci_probe_all_drivers(dev);
356 RTE_LOG(WARNING, EAL,
357 "Requested device " PCI_PRI_FMT " cannot be used\n",
358 addr->domain, addr->bus, addr->devid, addr->function);
363 * Detach device specified by its pci address.
366 rte_pci_detach(const struct rte_pci_addr *addr)
368 struct rte_pci_device *dev = NULL;
374 FOREACH_DEVICE_ON_PCIBUS(dev) {
375 if (rte_eal_compare_pci_addr(&dev->addr, addr))
378 ret = rte_pci_detach_dev(dev);
380 /* negative value is an error */
383 /* positive value means driver doesn't support it */
386 rte_pci_remove_device(dev);
393 RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
394 " cannot be used\n", dev->addr.domain, dev->addr.bus,
395 dev->addr.devid, dev->addr.function);
400 * Scan the content of the PCI bus, and call the probe() function for
401 * all registered drivers that have a matching entry in its id_table
402 * for discovered devices.
407 struct rte_pci_device *dev = NULL;
408 size_t probed = 0, failed = 0;
409 struct rte_devargs *devargs;
413 if (rte_pci_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST)
416 FOREACH_DEVICE_ON_PCIBUS(dev) {
419 devargs = dev->device.devargs;
420 /* probe all or only whitelisted devices */
422 ret = pci_probe_all_drivers(dev);
423 else if (devargs != NULL &&
424 devargs->policy == RTE_DEV_WHITELISTED)
425 ret = pci_probe_all_drivers(dev);
427 RTE_LOG(ERR, EAL, "Requested device " PCI_PRI_FMT
428 " cannot be used\n", dev->addr.domain, dev->addr.bus,
429 dev->addr.devid, dev->addr.function);
436 return (probed && probed == failed) ? -1 : 0;
439 /* dump one device */
441 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
445 fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
446 dev->addr.devid, dev->addr.function);
447 fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
450 for (i = 0; i != sizeof(dev->mem_resource) /
451 sizeof(dev->mem_resource[0]); i++) {
452 fprintf(f, " %16.16"PRIx64" %16.16"PRIx64"\n",
453 dev->mem_resource[i].phys_addr,
454 dev->mem_resource[i].len);
459 /* dump devices on the bus */
461 rte_pci_dump(FILE *f)
463 struct rte_pci_device *dev = NULL;
465 FOREACH_DEVICE_ON_PCIBUS(dev) {
466 pci_dump_one_device(f, dev);
471 pci_parse(const char *name, void *addr)
473 struct rte_pci_addr *out = addr;
474 struct rte_pci_addr pci_addr;
477 parse = (eal_parse_pci_BDF(name, &pci_addr) == 0 ||
478 eal_parse_pci_DomBDF(name, &pci_addr) == 0);
479 if (parse && addr != NULL)
481 return parse == false;
484 /* register a driver */
486 rte_pci_register(struct rte_pci_driver *driver)
488 TAILQ_INSERT_TAIL(&rte_pci_bus.driver_list, driver, next);
489 driver->bus = &rte_pci_bus;
492 /* unregister a driver */
494 rte_pci_unregister(struct rte_pci_driver *driver)
496 TAILQ_REMOVE(&rte_pci_bus.driver_list, driver, next);
500 /* Add a device to PCI bus */
502 rte_pci_add_device(struct rte_pci_device *pci_dev)
504 TAILQ_INSERT_TAIL(&rte_pci_bus.device_list, pci_dev, next);
507 /* Insert a device into a predefined position in PCI bus */
509 rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
510 struct rte_pci_device *new_pci_dev)
512 TAILQ_INSERT_BEFORE(exist_pci_dev, new_pci_dev, next);
515 /* Remove a device from PCI bus */
517 rte_pci_remove_device(struct rte_pci_device *pci_dev)
519 TAILQ_REMOVE(&rte_pci_bus.device_list, pci_dev, next);
522 static struct rte_device *
523 pci_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
526 struct rte_pci_device *dev;
528 FOREACH_DEVICE_ON_PCIBUS(dev) {
529 if (start && &dev->device == start) {
530 start = NULL; /* starting point found */
533 if (cmp(&dev->device, data) == 0)
541 pci_plug(struct rte_device *dev)
543 return pci_probe_all_drivers(RTE_DEV_TO_PCI(dev));
547 pci_unplug(struct rte_device *dev)
549 struct rte_pci_device *pdev;
552 pdev = RTE_DEV_TO_PCI(dev);
553 ret = rte_pci_detach_dev(pdev);
554 rte_pci_remove_device(pdev);
559 struct rte_pci_bus rte_pci_bus = {
561 .scan = rte_pci_scan,
562 .probe = rte_pci_probe,
563 .find_device = pci_find_device,
565 .unplug = pci_unplug,
567 .get_iommu_class = rte_pci_get_iommu_class,
569 .device_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.device_list),
570 .driver_list = TAILQ_HEAD_INITIALIZER(rte_pci_bus.driver_list),
573 RTE_REGISTER_BUS(pci, rte_pci_bus.bus);