lib/librte_eal/bsdapp/eal/eal_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
  34 #include <ctype.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <string.h>
  38 #include <stdarg.h>
  39 #include <unistd.h>
  40 #include <inttypes.h>
  41 #include <sys/types.h>
  42 #include <sys/stat.h>
  43 #include <fcntl.h>
  44 #include <stdarg.h>
  45 #include <errno.h>
  46 #include <dirent.h>
  47 #include <limits.h>
  48 #include <sys/queue.h>
  49 #include <sys/mman.h>
  50 #include <sys/ioctl.h>
  51 #include <sys/pciio.h>
  52 #include <dev/pci/pcireg.h>
  53
  54 #if defined(RTE_ARCH_X86)
  55 #include <sys/types.h>
  56 #include <machine/cpufunc.h>
  57 #endif
  58
  59 #include <rte_interrupts.h>
  60 #include <rte_log.h>
  61 #include <rte_pci.h>
  62 #include <rte_common.h>
  63 #include <rte_launch.h>
  64 #include <rte_memory.h>
  65 #include <rte_memzone.h>
  66 #include <rte_eal.h>
  67 #include <rte_eal_memconfig.h>
  68 #include <rte_per_lcore.h>
  69 #include <rte_lcore.h>
  70 #include <rte_malloc.h>
  71 #include <rte_string_fns.h>
  72 #include <rte_debug.h>
  73 #include <rte_devargs.h>
  74
  75 #include "eal_filesystem.h"
  76 #include "eal_private.h"
  77
  78 /**
  79  * @file
  80  * PCI probing under linux
  81  *
  82  * This code is used to simulate a PCI probe by parsing information in
  83  * sysfs. Moreover, when a registered driver matches a device, the
  84  * kernel driver currently using it is unloaded and replaced by
  85  * igb_uio module, which is a very minimal userland driver for Intel
  86  * network card, only providing access to PCI BAR to applications, and
  87  * enabling bus master.
  88  */
  89
  90 /* unbind kernel driver for this device */
  91 int
  92 pci_unbind_kernel_driver(struct rte_pci_device *dev __rte_unused)
  93 {
  94         RTE_LOG(ERR, EAL, "RTE_PCI_DRV_FORCE_UNBIND flag is not implemented "
  95                 "for BSD\n");
  96         return -ENOTSUP;
  97 }
  98
  99 /* Map pci device */
 100 int
 101 rte_eal_pci_map_device(struct rte_pci_device *dev)
 102 {
 103         int ret = -1;
 104
 105         /* try mapping the NIC resources */
 106         switch (dev->kdrv) {
 107         case RTE_KDRV_NIC_UIO:
 108                 /* map resources for devices that use uio */
 109                 ret = pci_uio_map_resource(dev);
 110                 break;
 111         default:
 112                 RTE_LOG(DEBUG, EAL,
 113                         "  Not managed by a supported kernel driver, skipped\n");
 114                 ret = 1;
 115                 break;
 116         }
 117
 118         return ret;
 119 }
 120
 121 /* Unmap pci device */
 122 void
 123 rte_eal_pci_unmap_device(struct rte_pci_device *dev)
 124 {
 125         /* try unmapping the NIC resources */
 126         switch (dev->kdrv) {
 127         case RTE_KDRV_NIC_UIO:
 128                 /* unmap resources for devices that use uio */
 129                 pci_uio_unmap_resource(dev);
 130                 break;
 131         default:
 132                 RTE_LOG(DEBUG, EAL,
 133                         "  Not managed by a supported kernel driver, skipped\n");
 134                 break;
 135         }
 136 }
 137
 138 void
 139 pci_uio_free_resource(struct rte_pci_device *dev,
 140                 struct mapped_pci_resource *uio_res)
 141 {
 142         rte_free(uio_res);
 143
 144         if (dev->intr_handle.fd) {
 145                 close(dev->intr_handle.fd);
 146                 dev->intr_handle.fd = -1;
 147                 dev->intr_handle.type = RTE_INTR_HANDLE_UNKNOWN;
 148         }
 149 }
 150
 151 int
 152 pci_uio_alloc_resource(struct rte_pci_device *dev,
 153                 struct mapped_pci_resource **uio_res)
 154 {
 155         char devname[PATH_MAX]; /* contains the /dev/uioX */
 156         struct rte_pci_addr *loc;
 157
 158         loc = &dev->addr;
 159
 160         snprintf(devname, sizeof(devname), "/dev/uio@pci:%u:%u:%u",
 161                         dev->addr.bus, dev->addr.devid, dev->addr.function);
 162
 163         if (access(devname, O_RDWR) < 0) {
 164                 RTE_LOG(WARNING, EAL, "  "PCI_PRI_FMT" not managed by UIO driver, "
 165                                 "skipping\n", loc->domain, loc->bus, loc->devid, loc->function);
 166                 return 1;
 167         }
 168
 169         /* save fd if in primary process */
 170         dev->intr_handle.fd = open(devname, O_RDWR);
 171         if (dev->intr_handle.fd < 0) {
 172                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n",
 173                         devname, strerror(errno));
 174                 goto error;
 175         }
 176         dev->intr_handle.type = RTE_INTR_HANDLE_UIO;
 177
 178         /* allocate the mapping details for secondary processes*/
 179         *uio_res = rte_zmalloc("UIO_RES", sizeof(**uio_res), 0);
 180         if (*uio_res == NULL) {
 181                 RTE_LOG(ERR, EAL,
 182                         "%s(): cannot store uio mmap details\n", __func__);
 183                 goto error;
 184         }
 185
 186         snprintf((*uio_res)->path, sizeof((*uio_res)->path), "%s", devname);
 187         memcpy(&(*uio_res)->pci_addr, &dev->addr, sizeof((*uio_res)->pci_addr));
 188
 189         return 0;
 190
 191 error:
 192         pci_uio_free_resource(dev, *uio_res);
 193         return -1;
 194 }
 195
 196 int
 197 pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
 198                 struct mapped_pci_resource *uio_res, int map_idx)
 199 {
 200         int fd;
 201         char *devname;
 202         void *mapaddr;
 203         uint64_t offset;
 204         uint64_t pagesz;
 205         struct pci_map *maps;
 206
 207         maps = uio_res->maps;
 208         devname = uio_res->path;
 209         pagesz = sysconf(_SC_PAGESIZE);
 210
 211         /* allocate memory to keep path */
 212         maps[map_idx].path = rte_malloc(NULL, strlen(devname) + 1, 0);
 213         if (maps[map_idx].path == NULL) {
 214                 RTE_LOG(ERR, EAL, "Cannot allocate memory for path: %s\n",
 215                                 strerror(errno));
 216                 return -1;
 217         }
 218
 219         /*
 220          * open resource file, to mmap it
 221          */
 222         fd = open(devname, O_RDWR);
 223         if (fd < 0) {
 224                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n",
 225                                 devname, strerror(errno));
 226                 goto error;
 227         }
 228
 229         /* if matching map is found, then use it */
 230         offset = res_idx * pagesz;
 231         mapaddr = pci_map_resource(NULL, fd, (off_t)offset,
 232                         (size_t)dev->mem_resource[res_idx].len, 0);
 233         close(fd);
 234         if (mapaddr == MAP_FAILED)
 235                 goto error;
 236
 237         maps[map_idx].phaddr = dev->mem_resource[res_idx].phys_addr;
 238         maps[map_idx].size = dev->mem_resource[res_idx].len;
 239         maps[map_idx].addr = mapaddr;
 240         maps[map_idx].offset = offset;
 241         strcpy(maps[map_idx].path, devname);
 242         dev->mem_resource[res_idx].addr = mapaddr;
 243
 244         return 0;
 245
 246 error:
 247         rte_free(maps[map_idx].path);
 248         return -1;
 249 }
 250
 251 static int
 252 pci_scan_one(int dev_pci_fd, struct pci_conf *conf)
 253 {
 254         struct rte_pci_device *dev;
 255         struct pci_bar_io bar;
 256         unsigned i, max;
 257
 258         dev = malloc(sizeof(*dev));
 259         if (dev == NULL) {
 260                 return -1;
 261         }
 262
 263         memset(dev, 0, sizeof(*dev));
 264         dev->addr.domain = conf->pc_sel.pc_domain;
 265         dev->addr.bus = conf->pc_sel.pc_bus;
 266         dev->addr.devid = conf->pc_sel.pc_dev;
 267         dev->addr.function = conf->pc_sel.pc_func;
 268
 269         /* get vendor id */
 270         dev->id.vendor_id = conf->pc_vendor;
 271
 272         /* get device id */
 273         dev->id.device_id = conf->pc_device;
 274
 275         /* get subsystem_vendor id */
 276         dev->id.subsystem_vendor_id = conf->pc_subvendor;
 277
 278         /* get subsystem_device id */
 279         dev->id.subsystem_device_id = conf->pc_subdevice;
 280
 281         /* get class id */
 282         dev->id.class_id = (conf->pc_class << 16) |
 283                            (conf->pc_subclass << 8) |
 284                            (conf->pc_progif);
 285
 286         /* TODO: get max_vfs */
 287         dev->max_vfs = 0;
 288
 289         /* FreeBSD has no NUMA support (yet) */
 290         dev->numa_node = 0;
 291
 292         /* FreeBSD has only one pass through driver */
 293         dev->kdrv = RTE_KDRV_NIC_UIO;
 294
 295         /* parse resources */
 296         switch (conf->pc_hdr & PCIM_HDRTYPE) {
 297         case PCIM_HDRTYPE_NORMAL:
 298                 max = PCIR_MAX_BAR_0;
 299                 break;
 300         case PCIM_HDRTYPE_BRIDGE:
 301                 max = PCIR_MAX_BAR_1;
 302                 break;
 303         case PCIM_HDRTYPE_CARDBUS:
 304                 max = PCIR_MAX_BAR_2;
 305                 break;
 306         default:
 307                 goto skipdev;
 308         }
 309
 310         for (i = 0; i <= max; i++) {
 311                 bar.pbi_sel = conf->pc_sel;
 312                 bar.pbi_reg = PCIR_BAR(i);
 313                 if (ioctl(dev_pci_fd, PCIOCGETBAR, &bar) < 0)
 314                         continue;
 315
 316                 dev->mem_resource[i].len = bar.pbi_length;
 317                 if (PCI_BAR_IO(bar.pbi_base)) {
 318                         dev->mem_resource[i].addr = (void *)(bar.pbi_base & ~((uint64_t)0xf));
 319                         continue;
 320                 }
 321                 dev->mem_resource[i].phys_addr = bar.pbi_base & ~((uint64_t)0xf);
 322         }
 323
 324         /* device is valid, add in list (sorted) */
 325         if (TAILQ_EMPTY(&pci_device_list)) {
 326                 TAILQ_INSERT_TAIL(&pci_device_list, dev, next);
 327         }
 328         else {
 329                 struct rte_pci_device *dev2 = NULL;
 330                 int ret;
 331
 332                 TAILQ_FOREACH(dev2, &pci_device_list, next) {
 333                         ret = rte_eal_compare_pci_addr(&dev->addr, &dev2->addr);
 334                         if (ret > 0)
 335                                 continue;
 336                         else if (ret < 0) {
 337                                 TAILQ_INSERT_BEFORE(dev2, dev, next);
 338                                 return 0;
 339                         } else { /* already registered */
 340                                 dev2->kdrv = dev->kdrv;
 341                                 dev2->max_vfs = dev->max_vfs;
 342                                 memmove(dev2->mem_resource,
 343                                         dev->mem_resource,
 344                                         sizeof(dev->mem_resource));
 345                                 free(dev);
 346                                 return 0;
 347                         }
 348                 }
 349                 TAILQ_INSERT_TAIL(&pci_device_list, dev, next);
 350         }
 351
 352         return 0;
 353
 354 skipdev:
 355         free(dev);
 356         return 0;
 357 }
 358
 359 /*
 360  * Scan the content of the PCI bus, and add the devices in the devices
 361  * list. Call pci_scan_one() for each pci entry found.
 362  */
 363 int
 364 rte_eal_pci_scan(void)
 365 {
 366         int fd;
 367         unsigned dev_count = 0;
 368         struct pci_conf matches[16];
 369         struct pci_conf_io conf_io = {
 370                         .pat_buf_len = 0,
 371                         .num_patterns = 0,
 372                         .patterns = NULL,
 373                         .match_buf_len = sizeof(matches),
 374                         .matches = &matches[0],
 375         };
 376
 377         fd = open("/dev/pci", O_RDONLY);
 378         if (fd < 0) {
 379                 RTE_LOG(ERR, EAL, "%s(): error opening /dev/pci\n", __func__);
 380                 goto error;
 381         }
 382
 383         do {
 384                 unsigned i;
 385                 if (ioctl(fd, PCIOCGETCONF, &conf_io) < 0) {
 386                         RTE_LOG(ERR, EAL, "%s(): error with ioctl on /dev/pci: %s\n",
 387                                         __func__, strerror(errno));
 388                         goto error;
 389                 }
 390
 391                 for (i = 0; i < conf_io.num_matches; i++)
 392                         if (pci_scan_one(fd, &matches[i]) < 0)
 393                                 goto error;
 394
 395                 dev_count += conf_io.num_matches;
 396         } while(conf_io.status == PCI_GETCONF_MORE_DEVS);
 397
 398         close(fd);
 399
 400         RTE_LOG(ERR, EAL, "PCI scan found %u devices\n", dev_count);
 401         return 0;
 402
 403 error:
 404         if (fd >= 0)
 405                 close(fd);
 406         return -1;
 407 }
 408
 409 /* Read PCI config space. */
 410 int rte_eal_pci_read_config(const struct rte_pci_device *dev,
 411                             void *buf, size_t len, off_t offset)
 412 {
 413         int fd = -1;
 414         struct pci_io pi = {
 415                 .pi_sel = {
 416                         .pc_domain = dev->addr.domain,
 417                         .pc_bus = dev->addr.bus,
 418                         .pc_dev = dev->addr.devid,
 419                         .pc_func = dev->addr.function,
 420                 },
 421                 .pi_reg = offset,
 422                 .pi_width = len,
 423         };
 424
 425         if (len == 3 || len > sizeof(pi.pi_data)) {
 426                 RTE_LOG(ERR, EAL, "%s(): invalid pci read length\n", __func__);
 427                 goto error;
 428         }
 429
 430         fd = open("/dev/pci", O_RDWR);
 431         if (fd < 0) {
 432                 RTE_LOG(ERR, EAL, "%s(): error opening /dev/pci\n", __func__);
 433                 goto error;
 434         }
 435
 436         if (ioctl(fd, PCIOCREAD, &pi) < 0)
 437                 goto error;
 438         close(fd);
 439
 440         memcpy(buf, &pi.pi_data, len);
 441         return 0;
 442
 443  error:
 444         if (fd >= 0)
 445                 close(fd);
 446         return -1;
 447 }
 448
 449 /* Write PCI config space. */
 450 int rte_eal_pci_write_config(const struct rte_pci_device *dev,
 451                              const void *buf, size_t len, off_t offset)
 452 {
 453         int fd = -1;
 454
 455         struct pci_io pi = {
 456                 .pi_sel = {
 457                         .pc_domain = dev->addr.domain,
 458                         .pc_bus = dev->addr.bus,
 459                         .pc_dev = dev->addr.devid,
 460                         .pc_func = dev->addr.function,
 461                 },
 462                 .pi_reg = offset,
 463                 .pi_data = *(const uint32_t *)buf,
 464                 .pi_width = len,
 465         };
 466
 467         if (len == 3 || len > sizeof(pi.pi_data)) {
 468                 RTE_LOG(ERR, EAL, "%s(): invalid pci read length\n", __func__);
 469                 goto error;
 470         }
 471
 472         memcpy(&pi.pi_data, buf, len);
 473
 474         fd = open("/dev/pci", O_RDWR);
 475         if (fd < 0) {
 476                 RTE_LOG(ERR, EAL, "%s(): error opening /dev/pci\n", __func__);
 477                 goto error;
 478         }
 479
 480         if (ioctl(fd, PCIOCWRITE, &pi) < 0)
 481                 goto error;
 482
 483         close(fd);
 484         return 0;
 485
 486  error:
 487         if (fd >= 0)
 488                 close(fd);
 489         return -1;
 490 }
 491
 492 int
 493 rte_eal_pci_ioport_map(struct rte_pci_device *dev, int bar,
 494                        struct rte_pci_ioport *p)
 495 {
 496         int ret;
 497
 498         switch (dev->kdrv) {
 499 #if defined(RTE_ARCH_X86)
 500         case RTE_KDRV_NIC_UIO:
 501                 if ((uintptr_t) dev->mem_resource[bar].addr <= UINT16_MAX) {
 502                         p->base = (uintptr_t)dev->mem_resource[bar].addr;
 503                         ret = 0;
 504                 } else
 505                         ret = -1;
 506                 break;
 507 #endif
 508         default:
 509                 ret = -1;
 510                 break;
 511         }
 512
 513         if (!ret)
 514                 p->dev = dev;
 515
 516         return ret;
 517 }
 518
 519 static void
 520 pci_uio_ioport_read(struct rte_pci_ioport *p,
 521                     void *data, size_t len, off_t offset)
 522 {
 523 #if defined(RTE_ARCH_X86)
 524         uint8_t *d;
 525         int size;
 526         unsigned short reg = p->base + offset;
 527
 528         for (d = data; len > 0; d += size, reg += size, len -= size) {
 529                 if (len >= 4) {
 530                         size = 4;
 531                         *(uint32_t *)d = inl(reg);
 532                 } else if (len >= 2) {
 533                         size = 2;
 534                         *(uint16_t *)d = inw(reg);
 535                 } else {
 536                         size = 1;
 537                         *d = inb(reg);
 538                 }
 539         }
 540 #else
 541         RTE_SET_USED(p);
 542         RTE_SET_USED(data);
 543         RTE_SET_USED(len);
 544         RTE_SET_USED(offset);
 545 #endif
 546 }
 547
 548 void
 549 rte_eal_pci_ioport_read(struct rte_pci_ioport *p,
 550                         void *data, size_t len, off_t offset)
 551 {
 552         switch (p->dev->kdrv) {
 553         case RTE_KDRV_NIC_UIO:
 554                 pci_uio_ioport_read(p, data, len, offset);
 555                 break;
 556         default:
 557                 break;
 558         }
 559 }
 560
 561 static void
 562 pci_uio_ioport_write(struct rte_pci_ioport *p,
 563                      const void *data, size_t len, off_t offset)
 564 {
 565 #if defined(RTE_ARCH_X86)
 566         const uint8_t *s;
 567         int size;
 568         unsigned short reg = p->base + offset;
 569
 570         for (s = data; len > 0; s += size, reg += size, len -= size) {
 571                 if (len >= 4) {
 572                         size = 4;
 573                         outl(*(const uint32_t *)s, reg);
 574                 } else if (len >= 2) {
 575                         size = 2;
 576                         outw(*(const uint16_t *)s, reg);
 577                 } else {
 578                         size = 1;
 579                         outb(*s, reg);
 580                 }
 581         }
 582 #else
 583         RTE_SET_USED(p);
 584         RTE_SET_USED(data);
 585         RTE_SET_USED(len);
 586         RTE_SET_USED(offset);
 587 #endif
 588 }
 589
 590 void
 591 rte_eal_pci_ioport_write(struct rte_pci_ioport *p,
 592                          const void *data, size_t len, off_t offset)
 593 {
 594         switch (p->dev->kdrv) {
 595         case RTE_KDRV_NIC_UIO:
 596                 pci_uio_ioport_write(p, data, len, offset);
 597                 break;
 598         default:
 599                 break;
 600         }
 601 }
 602
 603 int
 604 rte_eal_pci_ioport_unmap(struct rte_pci_ioport *p)
 605 {
 606         int ret;
 607
 608         switch (p->dev->kdrv) {
 609 #if defined(RTE_ARCH_X86)
 610         case RTE_KDRV_NIC_UIO:
 611                 ret = 0;
 612                 break;
 613 #endif
 614         default:
 615                 ret = -1;
 616                 break;
 617         }
 618
 619         return ret;
 620 }
 621
 622 /* Init the PCI EAL subsystem */
 623 int
 624 rte_eal_pci_init(void)
 625 {
 626         TAILQ_INIT(&pci_driver_list);
 627         TAILQ_INIT(&pci_device_list);
 628
 629         /* for debug purposes, PCI can be disabled */
 630         if (internal_config.no_pci)
 631                 return 0;
 632
 633         if (rte_eal_pci_scan() < 0) {
 634                 RTE_LOG(ERR, EAL, "%s(): Cannot scan PCI bus\n", __func__);
 635                 return -1;
 636         }
 637         return 0;
 638 }