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 struct pci_device_list pci_device_list;
88 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
90 const char *pci_get_sysfs_path(void)
92 const char *path = NULL;
94 path = getenv("SYSFS_PCI_DEVICES");
96 return SYSFS_PCI_DEVICES;
101 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
103 struct rte_devargs *devargs;
105 TAILQ_FOREACH(devargs, &devargs_list, next) {
106 if (devargs->type != RTE_DEVTYPE_BLACKLISTED_PCI &&
107 devargs->type != RTE_DEVTYPE_WHITELISTED_PCI)
109 if (!rte_eal_compare_pci_addr(&dev->addr, &devargs->pci.addr))
115 /* map a particular resource from a file */
117 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
118 int additional_flags)
122 /* Map the PCI memory resource of device */
123 mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
124 MAP_SHARED | additional_flags, fd, offset);
125 if (mapaddr == MAP_FAILED) {
126 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
127 __func__, fd, requested_addr,
128 (unsigned long)size, (unsigned long)offset,
129 strerror(errno), mapaddr);
131 RTE_LOG(DEBUG, EAL, " PCI memory mapped at %p\n", mapaddr);
136 /* unmap a particular resource */
138 pci_unmap_resource(void *requested_addr, size_t size)
140 if (requested_addr == NULL)
143 /* Unmap the PCI memory resource of device */
144 if (munmap(requested_addr, size)) {
145 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
146 __func__, requested_addr, (unsigned long)size,
149 RTE_LOG(DEBUG, EAL, " PCI memory unmapped at %p\n",
154 * If vendor/device ID match, call the devinit() function of the
158 rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr, struct rte_pci_device *dev)
161 const struct rte_pci_id *id_table;
163 for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
165 /* check if device's identifiers match the driver's ones */
166 if (id_table->vendor_id != dev->id.vendor_id &&
167 id_table->vendor_id != PCI_ANY_ID)
169 if (id_table->device_id != dev->id.device_id &&
170 id_table->device_id != PCI_ANY_ID)
172 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
173 id_table->subsystem_vendor_id != PCI_ANY_ID)
175 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
176 id_table->subsystem_device_id != PCI_ANY_ID)
178 if (id_table->class_id != dev->id.class_id &&
179 id_table->class_id != RTE_CLASS_ANY_ID)
182 struct rte_pci_addr *loc = &dev->addr;
184 RTE_LOG(INFO, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
185 loc->domain, loc->bus, loc->devid, loc->function,
188 /* no initialization when blacklisted, return without error */
189 if (dev->devargs != NULL &&
190 dev->devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
191 RTE_LOG(INFO, EAL, " Device is blacklisted, not initializing\n");
195 RTE_LOG(INFO, EAL, " probe driver: %x:%x %s\n", dev->id.vendor_id,
196 dev->id.device_id, dr->name);
198 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
199 /* map resources for devices that use igb_uio */
200 ret = rte_eal_pci_map_device(dev);
203 } else if (dr->drv_flags & RTE_PCI_DRV_FORCE_UNBIND &&
204 rte_eal_process_type() == RTE_PROC_PRIMARY) {
205 /* unbind current driver */
206 if (pci_unbind_kernel_driver(dev) < 0)
210 /* reference driver structure */
213 /* call the driver devinit() function */
214 return dr->devinit(dr, dev);
216 /* return positive value if driver doesn't support this device */
221 * If vendor/device ID match, call the devuninit() function of the
225 rte_eal_pci_detach_dev(struct rte_pci_driver *dr,
226 struct rte_pci_device *dev)
228 const struct rte_pci_id *id_table;
230 if ((dr == NULL) || (dev == NULL))
233 for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
235 /* check if device's identifiers match the driver's ones */
236 if (id_table->vendor_id != dev->id.vendor_id &&
237 id_table->vendor_id != PCI_ANY_ID)
239 if (id_table->device_id != dev->id.device_id &&
240 id_table->device_id != PCI_ANY_ID)
242 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
243 id_table->subsystem_vendor_id != PCI_ANY_ID)
245 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
246 id_table->subsystem_device_id != PCI_ANY_ID)
249 struct rte_pci_addr *loc = &dev->addr;
251 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
252 loc->domain, loc->bus, loc->devid,
253 loc->function, dev->numa_node);
255 RTE_LOG(DEBUG, EAL, " remove driver: %x:%x %s\n", dev->id.vendor_id,
256 dev->id.device_id, dr->name);
258 if (dr->devuninit && (dr->devuninit(dev) < 0))
259 return -1; /* negative value is an error */
261 /* clear driver structure */
264 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
265 /* unmap resources for devices that use igb_uio */
266 rte_eal_pci_unmap_device(dev);
271 /* return positive value if driver doesn't support this device */
276 * If vendor/device ID match, call the devinit() function of all
277 * registered driver for the given device. Return -1 if initialization
278 * failed, return 1 if no driver is found for this device.
281 pci_probe_all_drivers(struct rte_pci_device *dev)
283 struct rte_pci_driver *dr = NULL;
289 TAILQ_FOREACH(dr, &pci_driver_list, next) {
290 rc = rte_eal_pci_probe_one_driver(dr, dev);
292 /* negative value is an error */
295 /* positive value means driver doesn't support it */
303 * If vendor/device ID match, call the devuninit() function of all
304 * registered driver for the given device. Return -1 if initialization
305 * failed, return 1 if no driver is found for this device.
308 pci_detach_all_drivers(struct rte_pci_device *dev)
310 struct rte_pci_driver *dr = NULL;
316 TAILQ_FOREACH(dr, &pci_driver_list, next) {
317 rc = rte_eal_pci_detach_dev(dr, dev);
319 /* negative value is an error */
322 /* positive value means driver doesn't support it */
330 * Find the pci device specified by pci address, then invoke probe function of
331 * the driver of the devive.
334 rte_eal_pci_probe_one(const struct rte_pci_addr *addr)
336 struct rte_pci_device *dev = NULL;
342 TAILQ_FOREACH(dev, &pci_device_list, next) {
343 if (rte_eal_compare_pci_addr(&dev->addr, addr))
346 ret = pci_probe_all_drivers(dev);
354 RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
355 " cannot be used\n", dev->addr.domain, dev->addr.bus,
356 dev->addr.devid, dev->addr.function);
361 * Detach device specified by its pci address.
364 rte_eal_pci_detach(const struct rte_pci_addr *addr)
366 struct rte_pci_device *dev = NULL;
372 TAILQ_FOREACH(dev, &pci_device_list, next) {
373 if (rte_eal_compare_pci_addr(&dev->addr, addr))
376 ret = pci_detach_all_drivers(dev);
380 TAILQ_REMOVE(&pci_device_list, dev, next);
386 RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
387 " cannot be used\n", dev->addr.domain, dev->addr.bus,
388 dev->addr.devid, dev->addr.function);
393 * Scan the content of the PCI bus, and call the devinit() function for
394 * all registered drivers that have a matching entry in its id_table
395 * for discovered devices.
398 rte_eal_pci_probe(void)
400 struct rte_pci_device *dev = NULL;
401 struct rte_devargs *devargs;
405 if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) == 0)
408 TAILQ_FOREACH(dev, &pci_device_list, next) {
410 /* set devargs in PCI structure */
411 devargs = pci_devargs_lookup(dev);
413 dev->devargs = devargs;
415 /* probe all or only whitelisted devices */
417 ret = pci_probe_all_drivers(dev);
418 else if (devargs != NULL &&
419 devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
420 ret = pci_probe_all_drivers(dev);
422 rte_exit(EXIT_FAILURE, "Requested device " PCI_PRI_FMT
423 " cannot be used\n", dev->addr.domain, dev->addr.bus,
424 dev->addr.devid, dev->addr.function);
430 /* dump one device */
432 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
436 fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
437 dev->addr.devid, dev->addr.function);
438 fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
441 for (i = 0; i != sizeof(dev->mem_resource) /
442 sizeof(dev->mem_resource[0]); i++) {
443 fprintf(f, " %16.16"PRIx64" %16.16"PRIx64"\n",
444 dev->mem_resource[i].phys_addr,
445 dev->mem_resource[i].len);
450 /* dump devices on the bus */
452 rte_eal_pci_dump(FILE *f)
454 struct rte_pci_device *dev = NULL;
456 TAILQ_FOREACH(dev, &pci_device_list, next) {
457 pci_dump_one_device(f, dev);
461 /* register a driver */
463 rte_eal_pci_register(struct rte_pci_driver *driver)
465 TAILQ_INSERT_TAIL(&pci_driver_list, driver, next);
468 /* unregister a driver */
470 rte_eal_pci_unregister(struct rte_pci_driver *driver)
472 TAILQ_REMOVE(&pci_driver_list, driver, next);