lib/librte_eal/common/eal_common_pci.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33 /*   BSD LICENSE
  34  *
  35  *   Copyright 2013-2014 6WIND S.A.
  36  *
  37  *   Redistribution and use in source and binary forms, with or without
  38  *   modification, are permitted provided that the following conditions
  39  *   are met:
  40  *
  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
  46  *       distribution.
  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.
  50  *
  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.
  62  */
  63
  64 #include <string.h>
  65 #include <inttypes.h>
  66 #include <stdint.h>
  67 #include <stdlib.h>
  68 #include <stdio.h>
  69 #include <sys/queue.h>
  70 #include <sys/mman.h>
  71
  72 #include <rte_interrupts.h>
  73 #include <rte_log.h>
  74 #include <rte_pci.h>
  75 #include <rte_per_lcore.h>
  76 #include <rte_memory.h>
  77 #include <rte_memzone.h>
  78 #include <rte_eal.h>
  79 #include <rte_string_fns.h>
  80 #include <rte_common.h>
  81 #include <rte_devargs.h>
  82
  83 #include "eal_private.h"
  84
  85 struct pci_driver_list pci_driver_list;
  86 struct pci_device_list pci_device_list;
  87
  88 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
  89 {
  90         struct rte_devargs *devargs;
  91
  92         TAILQ_FOREACH(devargs, &devargs_list, next) {
  93                 if (devargs->type != RTE_DEVTYPE_BLACKLISTED_PCI &&
  94                         devargs->type != RTE_DEVTYPE_WHITELISTED_PCI)
  95                         continue;
  96                 if (!rte_eal_compare_pci_addr(&dev->addr, &devargs->pci.addr))
  97                         return devargs;
  98         }
  99         return NULL;
 100 }
 101
 102 /* map a particular resource from a file */
 103 void *
 104 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
 105                  int additional_flags)
 106 {
 107         void *mapaddr;
 108
 109         /* Map the PCI memory resource of device */
 110         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
 111                         MAP_SHARED | additional_flags, fd, offset);
 112         if (mapaddr == MAP_FAILED) {
 113                 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
 114                         __func__, fd, requested_addr,
 115                         (unsigned long)size, (unsigned long)offset,
 116                         strerror(errno), mapaddr);
 117         } else
 118                 RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
 119
 120         return mapaddr;
 121 }
 122
 123 /* unmap a particular resource */
 124 void
 125 pci_unmap_resource(void *requested_addr, size_t size)
 126 {
 127         if (requested_addr == NULL)
 128                 return;
 129
 130         /* Unmap the PCI memory resource of device */
 131         if (munmap(requested_addr, size)) {
 132                 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
 133                         __func__, requested_addr, (unsigned long)size,
 134                         strerror(errno));
 135         } else
 136                 RTE_LOG(DEBUG, EAL, "  PCI memory unmapped at %p\n",
 137                                 requested_addr);
 138 }
 139
 140 /*
 141  * If vendor/device ID match, call the devinit() function of all
 142  * registered driver for the given device. Return -1 if initialization
 143  * failed, return 1 if no driver is found for this device.
 144  */
 145 static int
 146 pci_probe_all_drivers(struct rte_pci_device *dev)
 147 {
 148         struct rte_pci_driver *dr = NULL;
 149         int rc = 0;
 150
 151         if (dev == NULL)
 152                 return -1;
 153
 154         TAILQ_FOREACH(dr, &pci_driver_list, next) {
 155                 rc = rte_eal_pci_probe_one_driver(dr, dev);
 156                 if (rc < 0)
 157                         /* negative value is an error */
 158                         return -1;
 159                 if (rc > 0)
 160                         /* positive value means driver not found */
 161                         continue;
 162                 return 0;
 163         }
 164         return 1;
 165 }
 166
 167 #ifdef RTE_LIBRTE_EAL_HOTPLUG
 168 /*
 169  * If vendor/device ID match, call the devuninit() function of all
 170  * registered driver for the given device. Return -1 if initialization
 171  * failed, return 1 if no driver is found for this device.
 172  */
 173 static int
 174 pci_close_all_drivers(struct rte_pci_device *dev)
 175 {
 176         struct rte_pci_driver *dr = NULL;
 177         int rc = 0;
 178
 179         if (dev == NULL)
 180                 return -1;
 181
 182         TAILQ_FOREACH(dr, &pci_driver_list, next) {
 183                 rc = rte_eal_pci_close_one_driver(dr, dev);
 184                 if (rc < 0)
 185                         /* negative value is an error */
 186                         return -1;
 187                 if (rc > 0)
 188                         /* positive value means driver not found */
 189                         continue;
 190                 return 0;
 191         }
 192         return 1;
 193 }
 194
 195 /*
 196  * Find the pci device specified by pci address, then invoke probe function of
 197  * the driver of the devive.
 198  */
 199 int
 200 rte_eal_pci_probe_one(const struct rte_pci_addr *addr)
 201 {
 202         struct rte_pci_device *dev = NULL;
 203         int ret = 0;
 204
 205         if (addr == NULL)
 206                 return -1;
 207
 208         TAILQ_FOREACH(dev, &pci_device_list, next) {
 209                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 210                         continue;
 211
 212                 ret = pci_probe_all_drivers(dev);
 213                 if (ret < 0)
 214                         goto err_return;
 215                 return 0;
 216         }
 217         return -1;
 218
 219 err_return:
 220         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 221                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 222                         dev->addr.devid, dev->addr.function);
 223         return -1;
 224 }
 225
 226 /*
 227  * Find the pci device specified by pci address, then invoke close function of
 228  * the driver of the devive.
 229  */
 230 int
 231 rte_eal_pci_close_one(const struct rte_pci_addr *addr)
 232 {
 233         struct rte_pci_device *dev = NULL;
 234         int ret = 0;
 235
 236         if (addr == NULL)
 237                 return -1;
 238
 239         TAILQ_FOREACH(dev, &pci_device_list, next) {
 240                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
 241                         continue;
 242
 243                 ret = pci_close_all_drivers(dev);
 244                 if (ret < 0)
 245                         goto err_return;
 246
 247                 TAILQ_REMOVE(&pci_device_list, dev, next);
 248                 return 0;
 249         }
 250         return -1;
 251
 252 err_return:
 253         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
 254                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
 255                         dev->addr.devid, dev->addr.function);
 256         return -1;
 257 }
 258 #endif /* RTE_LIBRTE_EAL_HOTPLUG */
 259
 260 /*
 261  * Scan the content of the PCI bus, and call the devinit() function for
 262  * all registered drivers that have a matching entry in its id_table
 263  * for discovered devices.
 264  */
 265 int
 266 rte_eal_pci_probe(void)
 267 {
 268         struct rte_pci_device *dev = NULL;
 269         struct rte_devargs *devargs;
 270         int probe_all = 0;
 271         int ret = 0;
 272
 273         if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) == 0)
 274                 probe_all = 1;
 275
 276         TAILQ_FOREACH(dev, &pci_device_list, next) {
 277
 278                 /* set devargs in PCI structure */
 279                 devargs = pci_devargs_lookup(dev);
 280                 if (devargs != NULL)
 281                         dev->devargs = devargs;
 282
 283                 /* probe all or only whitelisted devices */
 284                 if (probe_all)
 285                         ret = pci_probe_all_drivers(dev);
 286                 else if (devargs != NULL &&
 287                         devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
 288                         ret = pci_probe_all_drivers(dev);
 289                 if (ret < 0)
 290                         rte_exit(EXIT_FAILURE, "Requested device " PCI_PRI_FMT
 291                                  " cannot be used\n", dev->addr.domain, dev->addr.bus,
 292                                  dev->addr.devid, dev->addr.function);
 293         }
 294
 295         return 0;
 296 }
 297
 298 /* dump one device */
 299 static int
 300 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
 301 {
 302         int i;
 303
 304         fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
 305                dev->addr.devid, dev->addr.function);
 306         fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
 307                dev->id.device_id);
 308
 309         for (i = 0; i != sizeof(dev->mem_resource) /
 310                 sizeof(dev->mem_resource[0]); i++) {
 311                 fprintf(f, "   %16.16"PRIx64" %16.16"PRIx64"\n",
 312                         dev->mem_resource[i].phys_addr,
 313                         dev->mem_resource[i].len);
 314         }
 315         return 0;
 316 }
 317
 318 /* dump devices on the bus */
 319 void
 320 rte_eal_pci_dump(FILE *f)
 321 {
 322         struct rte_pci_device *dev = NULL;
 323
 324         TAILQ_FOREACH(dev, &pci_device_list, next) {
 325                 pci_dump_one_device(f, dev);
 326         }
 327 }
 328
 329 /* register a driver */
 330 void
 331 rte_eal_pci_register(struct rte_pci_driver *driver)
 332 {
 333         TAILQ_INSERT_TAIL(&pci_driver_list, driver, next);
 334 }
 335
 336 /* unregister a driver */
 337 void
 338 rte_eal_pci_unregister(struct rte_pci_driver *driver)
 339 {
 340         TAILQ_REMOVE(&pci_driver_list, driver, next);
 341 }