drivers/bus/fslmc/fslmc_bus.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  *   Copyright 2016,2018-2019 NXP
   4  *
   5  */
   6
   7 #include <string.h>
   8 #include <dirent.h>
   9 #include <stdbool.h>
  10
  11 #include <rte_log.h>
  12 #include <rte_bus.h>
  13 #include <rte_malloc.h>
  14 #include <rte_devargs.h>
  15 #include <rte_memcpy.h>
  16 #include <rte_ethdev_driver.h>
  17
  18 #include <rte_fslmc.h>
  19 #include <fslmc_vfio.h>
  20 #include "fslmc_logs.h"
  21
  22 #include <dpaax_iova_table.h>
  23
  24 int dpaa2_logtype_bus;
  25
  26 #define VFIO_IOMMU_GROUP_PATH "/sys/kernel/iommu_groups"
  27 #define FSLMC_BUS_NAME  fslmc
  28
  29 struct rte_fslmc_bus rte_fslmc_bus;
  30 uint8_t dpaa2_virt_mode;
  31
  32 uint32_t
  33 rte_fslmc_get_device_count(enum rte_dpaa2_dev_type device_type)
  34 {
  35         if (device_type >= DPAA2_DEVTYPE_MAX)
  36                 return 0;
  37         return rte_fslmc_bus.device_count[device_type];
  38 }
  39
  40 RTE_DEFINE_PER_LCORE(struct dpaa2_portal_dqrr, dpaa2_held_bufs);
  41
  42 static void
  43 cleanup_fslmc_device_list(void)
  44 {
  45         struct rte_dpaa2_device *dev;
  46         struct rte_dpaa2_device *t_dev;
  47
  48         TAILQ_FOREACH_SAFE(dev, &rte_fslmc_bus.device_list, next, t_dev) {
  49                 TAILQ_REMOVE(&rte_fslmc_bus.device_list, dev, next);
  50                 free(dev);
  51                 dev = NULL;
  52         }
  53 }
  54
  55 static int
  56 compare_dpaa2_devname(struct rte_dpaa2_device *dev1,
  57                       struct rte_dpaa2_device *dev2)
  58 {
  59         int comp;
  60
  61         if (dev1->dev_type > dev2->dev_type) {
  62                 comp = 1;
  63         } else if (dev1->dev_type < dev2->dev_type) {
  64                 comp = -1;
  65         } else {
  66                 /* Check the ID as types match */
  67                 if (dev1->object_id > dev2->object_id)
  68                         comp = 1;
  69                 else if (dev1->object_id < dev2->object_id)
  70                         comp = -1;
  71                 else
  72                         comp = 0; /* Duplicate device name */
  73         }
  74
  75         return comp;
  76 }
  77
  78 static void
  79 insert_in_device_list(struct rte_dpaa2_device *newdev)
  80 {
  81         int comp, inserted = 0;
  82         struct rte_dpaa2_device *dev = NULL;
  83         struct rte_dpaa2_device *tdev = NULL;
  84
  85         TAILQ_FOREACH_SAFE(dev, &rte_fslmc_bus.device_list, next, tdev) {
  86                 comp = compare_dpaa2_devname(newdev, dev);
  87                 if (comp < 0) {
  88                         TAILQ_INSERT_BEFORE(dev, newdev, next);
  89                         inserted = 1;
  90                         break;
  91                 }
  92         }
  93
  94         if (!inserted)
  95                 TAILQ_INSERT_TAIL(&rte_fslmc_bus.device_list, newdev, next);
  96 }
  97
  98 static struct rte_devargs *
  99 fslmc_devargs_lookup(struct rte_dpaa2_device *dev)
 100 {
 101         struct rte_devargs *devargs;
 102         char dev_name[32];
 103
 104         RTE_EAL_DEVARGS_FOREACH("fslmc", devargs) {
 105                 devargs->bus->parse(devargs->name, &dev_name);
 106                 if (strcmp(dev_name, dev->device.name) == 0) {
 107                         DPAA2_BUS_INFO("**Devargs matched %s", dev_name);
 108                         return devargs;
 109                 }
 110         }
 111         return NULL;
 112 }
 113
 114 static void
 115 dump_device_list(void)
 116 {
 117         struct rte_dpaa2_device *dev;
 118
 119         /* Only if the log level has been set to Debugging, print list */
 120         if (rte_log_can_log(dpaa2_logtype_bus, RTE_LOG_DEBUG)) {
 121                 DPAA2_BUS_LOG(DEBUG, "List of devices scanned on bus:");
 122                 TAILQ_FOREACH(dev, &rte_fslmc_bus.device_list, next) {
 123                         DPAA2_BUS_LOG(DEBUG, "\t\t%s", dev->device.name);
 124                 }
 125         }
 126 }
 127
 128 static int
 129 scan_one_fslmc_device(char *dev_name)
 130 {
 131         char *dup_dev_name, *t_ptr;
 132         struct rte_dpaa2_device *dev = NULL;
 133         int ret = -1;
 134
 135         if (!dev_name)
 136                 return ret;
 137
 138         /* Ignore the Container name itself */
 139         if (!strncmp("dprc", dev_name, 4))
 140                 return 0;
 141
 142         /* Creating a temporary copy to perform cut-parse over string */
 143         dup_dev_name = strdup(dev_name);
 144         if (!dup_dev_name) {
 145                 DPAA2_BUS_ERR("Unable to allocate device name memory");
 146                 return -ENOMEM;
 147         }
 148
 149         /* For all other devices, we allocate rte_dpaa2_device.
 150          * For those devices where there is no driver, probe would release
 151          * the memory associated with the rte_dpaa2_device after necessary
 152          * initialization.
 153          */
 154         dev = calloc(1, sizeof(struct rte_dpaa2_device));
 155         if (!dev) {
 156                 DPAA2_BUS_ERR("Unable to allocate device object");
 157                 free(dup_dev_name);
 158                 return -ENOMEM;
 159         }
 160
 161         dev->device.bus = &rte_fslmc_bus.bus;
 162
 163         /* Parse the device name and ID */
 164         t_ptr = strtok(dup_dev_name, ".");
 165         if (!t_ptr) {
 166                 DPAA2_BUS_ERR("Invalid device found: (%s)", dup_dev_name);
 167                 ret = -EINVAL;
 168                 goto cleanup;
 169         }
 170         if (!strncmp("dpni", t_ptr, 4))
 171                 dev->dev_type = DPAA2_ETH;
 172         else if (!strncmp("dpseci", t_ptr, 6))
 173                 dev->dev_type = DPAA2_CRYPTO;
 174         else if (!strncmp("dpcon", t_ptr, 5))
 175                 dev->dev_type = DPAA2_CON;
 176         else if (!strncmp("dpbp", t_ptr, 4))
 177                 dev->dev_type = DPAA2_BPOOL;
 178         else if (!strncmp("dpio", t_ptr, 4))
 179                 dev->dev_type = DPAA2_IO;
 180         else if (!strncmp("dpci", t_ptr, 4))
 181                 dev->dev_type = DPAA2_CI;
 182         else if (!strncmp("dpmcp", t_ptr, 5))
 183                 dev->dev_type = DPAA2_MPORTAL;
 184         else if (!strncmp("dpdmai", t_ptr, 6))
 185                 dev->dev_type = DPAA2_QDMA;
 186         else if (!strncmp("dpdmux", t_ptr, 6))
 187                 dev->dev_type = DPAA2_MUX;
 188         else if (!strncmp("dprtc", t_ptr, 5))
 189                 dev->dev_type = DPAA2_DPRTC;
 190         else
 191                 dev->dev_type = DPAA2_UNKNOWN;
 192
 193         t_ptr = strtok(NULL, ".");
 194         if (!t_ptr) {
 195                 DPAA2_BUS_ERR("Skipping invalid device (%s)", dup_dev_name);
 196                 ret = 0;
 197                 goto cleanup;
 198         }
 199
 200         sscanf(t_ptr, "%hu", &dev->object_id);
 201         dev->device.name = strdup(dev_name);
 202         if (!dev->device.name) {
 203                 DPAA2_BUS_ERR("Unable to clone device name. Out of memory");
 204                 ret = -ENOMEM;
 205                 goto cleanup;
 206         }
 207         dev->device.devargs = fslmc_devargs_lookup(dev);
 208
 209         /* Update the device found into the device_count table */
 210         rte_fslmc_bus.device_count[dev->dev_type]++;
 211
 212         /* Add device in the fslmc device list */
 213         insert_in_device_list(dev);
 214
 215         /* Don't need the duplicated device filesystem entry anymore */
 216         if (dup_dev_name)
 217                 free(dup_dev_name);
 218
 219         return 0;
 220 cleanup:
 221         if (dup_dev_name)
 222                 free(dup_dev_name);
 223         if (dev)
 224                 free(dev);
 225         return ret;
 226 }
 227
 228 static int
 229 rte_fslmc_parse(const char *name, void *addr)
 230 {
 231         uint16_t dev_id;
 232         char *t_ptr;
 233         const char *sep;
 234         uint8_t sep_exists = 0;
 235         int ret = -1;
 236
 237         DPAA2_BUS_DEBUG("Parsing dev=(%s)", name);
 238
 239         /* There are multiple ways this can be called, with bus:dev, name=dev
 240          * or just dev. In all cases, the 'addr' is actually a string.
 241          */
 242         sep = strchr(name, ':');
 243         if (!sep) {
 244                 /* check for '=' */
 245                 sep = strchr(name, '=');
 246                 if (!sep)
 247                         sep_exists = 0;
 248                 else
 249                         sep_exists = 1;
 250         } else
 251                 sep_exists = 1;
 252
 253         /* Check if starting part if either of 'fslmc:' or 'name=', separator
 254          * exists.
 255          */
 256         if (sep_exists) {
 257                 /* If either of "fslmc" or "name" are starting part */
 258                 if (!strncmp(name, RTE_STR(FSLMC_BUS_NAME),
 259                              strlen(RTE_STR(FSLMC_BUS_NAME))) ||
 260                    (!strncmp(name, "name", strlen("name")))) {
 261                         goto jump_out;
 262                 } else {
 263                         DPAA2_BUS_DEBUG("Invalid device for matching (%s).",
 264                                         name);
 265                         ret = -EINVAL;
 266                         goto err_out;
 267                 }
 268         } else
 269                 sep = name;
 270
 271 jump_out:
 272         /* Validate device name */
 273         if (strncmp("dpni", sep, 4) &&
 274             strncmp("dpseci", sep, 6) &&
 275             strncmp("dpcon", sep, 5) &&
 276             strncmp("dpbp", sep, 4) &&
 277             strncmp("dpio", sep, 4) &&
 278             strncmp("dpci", sep, 4) &&
 279             strncmp("dpmcp", sep, 5) &&
 280             strncmp("dpdmai", sep, 6) &&
 281             strncmp("dpdmux", sep, 6)) {
 282                 DPAA2_BUS_DEBUG("Unknown or unsupported device (%s)", sep);
 283                 ret = -EINVAL;
 284                 goto err_out;
 285         }
 286
 287         t_ptr = strchr(sep, '.');
 288         if (!t_ptr || sscanf(t_ptr + 1, "%hu", &dev_id) != 1) {
 289                 DPAA2_BUS_ERR("Missing device id in device name (%s)", sep);
 290                 ret = -EINVAL;
 291                 goto err_out;
 292         }
 293
 294         if (addr)
 295                 strcpy(addr, sep);
 296
 297         ret = 0;
 298 err_out:
 299         return ret;
 300 }
 301
 302 static int
 303 rte_fslmc_scan(void)
 304 {
 305         int ret;
 306         int device_count = 0;
 307         char fslmc_dirpath[PATH_MAX];
 308         DIR *dir;
 309         struct dirent *entry;
 310         static int process_once;
 311         int groupid;
 312
 313         if (process_once) {
 314                 DPAA2_BUS_DEBUG("Fslmc bus already scanned. Not rescanning");
 315                 return 0;
 316         }
 317         process_once = 1;
 318
 319         ret = fslmc_get_container_group(&groupid);
 320         if (ret != 0)
 321                 goto scan_fail;
 322
 323         /* Scan devices on the group */
 324         sprintf(fslmc_dirpath, "%s/%s", SYSFS_FSL_MC_DEVICES, fslmc_container);
 325         dir = opendir(fslmc_dirpath);
 326         if (!dir) {
 327                 DPAA2_BUS_ERR("Unable to open VFIO group directory");
 328                 goto scan_fail;
 329         }
 330
 331         while ((entry = readdir(dir)) != NULL) {
 332                 if (entry->d_name[0] == '.' || entry->d_type != DT_DIR)
 333                         continue;
 334
 335                 ret = scan_one_fslmc_device(entry->d_name);
 336                 if (ret != 0) {
 337                         /* Error in parsing directory - exit gracefully */
 338                         goto scan_fail_cleanup;
 339                 }
 340                 device_count += 1;
 341         }
 342
 343         closedir(dir);
 344
 345         DPAA2_BUS_INFO("FSLMC Bus scan completed");
 346         /* If debugging is enabled, device list is dumped to log output */
 347         dump_device_list();
 348
 349         return 0;
 350
 351 scan_fail_cleanup:
 352         closedir(dir);
 353
 354         /* Remove all devices in the list */
 355         cleanup_fslmc_device_list();
 356 scan_fail:
 357         DPAA2_BUS_DEBUG("FSLMC Bus Not Available. Skipping (%d)", ret);
 358         /* Irrespective of failure, scan only return success */
 359         return 0;
 360 }
 361
 362 static int
 363 rte_fslmc_match(struct rte_dpaa2_driver *dpaa2_drv,
 364                 struct rte_dpaa2_device *dpaa2_dev)
 365 {
 366         if (dpaa2_drv->drv_type == dpaa2_dev->dev_type)
 367                 return 0;
 368
 369         return 1;
 370 }
 371
 372 static int
 373 rte_fslmc_probe(void)
 374 {
 375         int ret = 0;
 376         int probe_all;
 377
 378         struct rte_dpaa2_device *dev;
 379         struct rte_dpaa2_driver *drv;
 380
 381         if (TAILQ_EMPTY(&rte_fslmc_bus.device_list))
 382                 return 0;
 383
 384         ret = fslmc_vfio_setup_group();
 385         if (ret) {
 386                 DPAA2_BUS_ERR("Unable to setup VFIO %d", ret);
 387                 return 0;
 388         }
 389
 390         /* Map existing segments as well as, in case of hotpluggable memory,
 391          * install callback handler.
 392          */
 393         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 394                 ret = rte_fslmc_vfio_dmamap();
 395                 if (ret) {
 396                         DPAA2_BUS_ERR("Unable to DMA map existing VAs: (%d)",
 397                                       ret);
 398                         /* Not continuing ahead */
 399                         DPAA2_BUS_ERR("FSLMC VFIO Mapping failed");
 400                         return 0;
 401                 }
 402         }
 403
 404         ret = fslmc_vfio_process_group();
 405         if (ret) {
 406                 DPAA2_BUS_ERR("Unable to setup devices %d", ret);
 407                 return 0;
 408         }
 409
 410         probe_all = rte_fslmc_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST;
 411
 412         /* In case of PA, the FD addresses returned by qbman APIs are physical
 413          * addresses, which need conversion into equivalent VA address for
 414          * rte_mbuf. For that, a table (a serial array, in memory) is used to
 415          * increase translation efficiency.
 416          * This has to be done before probe as some device initialization
 417          * (during) probe allocate memory (dpaa2_sec) which needs to be pinned
 418          * to this table.
 419          *
 420          * Error is ignored as relevant logs are handled within dpaax and
 421          * handling for unavailable dpaax table too is transparent to caller.
 422          *
 423          * And, the IOVA table is only applicable in case of PA mode.
 424          */
 425         if (rte_eal_iova_mode() == RTE_IOVA_PA)
 426                 dpaax_iova_table_populate();
 427
 428         TAILQ_FOREACH(dev, &rte_fslmc_bus.device_list, next) {
 429                 TAILQ_FOREACH(drv, &rte_fslmc_bus.driver_list, next) {
 430                         ret = rte_fslmc_match(drv, dev);
 431                         if (ret)
 432                                 continue;
 433
 434                         if (!drv->probe)
 435                                 continue;
 436
 437                         if (rte_dev_is_probed(&dev->device))
 438                                 continue;
 439
 440                         if (dev->device.devargs &&
 441                           dev->device.devargs->policy == RTE_DEV_BLACKLISTED) {
 442                                 DPAA2_BUS_LOG(DEBUG, "%s Blacklisted, skipping",
 443                                               dev->device.name);
 444                                 continue;
 445                         }
 446
 447                         if (probe_all ||
 448                            (dev->device.devargs &&
 449                            dev->device.devargs->policy ==
 450                            RTE_DEV_WHITELISTED)) {
 451                                 ret = drv->probe(drv, dev);
 452                                 if (ret) {
 453                                         DPAA2_BUS_ERR("Unable to probe");
 454                                 } else {
 455                                         dev->driver = drv;
 456                                         dev->device.driver = &drv->driver;
 457                                 }
 458                         }
 459                         break;
 460                 }
 461         }
 462
 463         if (rte_eal_iova_mode() == RTE_IOVA_VA)
 464                 dpaa2_virt_mode = 1;
 465
 466         return 0;
 467 }
 468
 469 static struct rte_device *
 470 rte_fslmc_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
 471                       const void *data)
 472 {
 473         const struct rte_dpaa2_device *dstart;
 474         struct rte_dpaa2_device *dev;
 475
 476         DPAA2_BUS_DEBUG("Finding a device named %s\n", (const char *)data);
 477
 478         /* find_device is always called with an opaque object which should be
 479          * passed along to the 'cmp' function iterating over all device obj
 480          * on the bus.
 481          */
 482
 483         if (start != NULL) {
 484                 dstart = RTE_DEV_TO_FSLMC_CONST(start);
 485                 dev = TAILQ_NEXT(dstart, next);
 486         } else {
 487                 dev = TAILQ_FIRST(&rte_fslmc_bus.device_list);
 488         }
 489         while (dev != NULL) {
 490                 if (cmp(&dev->device, data) == 0) {
 491                         DPAA2_BUS_DEBUG("Found device (%s)\n",
 492                                         dev->device.name);
 493                         return &dev->device;
 494                 }
 495                 dev = TAILQ_NEXT(dev, next);
 496         }
 497
 498         return NULL;
 499 }
 500
 501 /*register a fslmc bus based dpaa2 driver */
 502 void
 503 rte_fslmc_driver_register(struct rte_dpaa2_driver *driver)
 504 {
 505         RTE_VERIFY(driver);
 506
 507         TAILQ_INSERT_TAIL(&rte_fslmc_bus.driver_list, driver, next);
 508         /* Update Bus references */
 509         driver->fslmc_bus = &rte_fslmc_bus;
 510 }
 511
 512 /*un-register a fslmc bus based dpaa2 driver */
 513 void
 514 rte_fslmc_driver_unregister(struct rte_dpaa2_driver *driver)
 515 {
 516         struct rte_fslmc_bus *fslmc_bus;
 517
 518         fslmc_bus = driver->fslmc_bus;
 519
 520         /* Cleanup the PA->VA Translation table; From whereever this function
 521          * is called from.
 522          */
 523         if (rte_eal_iova_mode() == RTE_IOVA_PA)
 524                 dpaax_iova_table_depopulate();
 525
 526         TAILQ_REMOVE(&fslmc_bus->driver_list, driver, next);
 527         /* Update Bus references */
 528         driver->fslmc_bus = NULL;
 529 }
 530
 531 /*
 532  * All device has iova as va
 533  */
 534 static inline int
 535 fslmc_all_device_support_iova(void)
 536 {
 537         int ret = 0;
 538         struct rte_dpaa2_device *dev;
 539         struct rte_dpaa2_driver *drv;
 540
 541         TAILQ_FOREACH(dev, &rte_fslmc_bus.device_list, next) {
 542                 TAILQ_FOREACH(drv, &rte_fslmc_bus.driver_list, next) {
 543                         ret = rte_fslmc_match(drv, dev);
 544                         if (ret)
 545                                 continue;
 546                         /* if the driver is not supporting IOVA */
 547                         if (!(drv->drv_flags & RTE_DPAA2_DRV_IOVA_AS_VA))
 548                                 return 0;
 549                 }
 550         }
 551         return 1;
 552 }
 553
 554 /*
 555  * Get iommu class of DPAA2 devices on the bus.
 556  */
 557 static enum rte_iova_mode
 558 rte_dpaa2_get_iommu_class(void)
 559 {
 560         bool is_vfio_noiommu_enabled = 1;
 561         bool has_iova_va;
 562
 563         if (TAILQ_EMPTY(&rte_fslmc_bus.device_list))
 564                 return RTE_IOVA_DC;
 565
 566 #ifdef RTE_LIBRTE_DPAA2_USE_PHYS_IOVA
 567         return RTE_IOVA_PA;
 568 #endif
 569
 570         /* check if all devices on the bus support Virtual addressing or not */
 571         has_iova_va = fslmc_all_device_support_iova();
 572
 573 #ifdef VFIO_PRESENT
 574         is_vfio_noiommu_enabled = rte_vfio_noiommu_is_enabled() == true ?
 575                                                 true : false;
 576 #endif
 577
 578         if (has_iova_va && !is_vfio_noiommu_enabled)
 579                 return RTE_IOVA_VA;
 580
 581         return RTE_IOVA_PA;
 582 }
 583
 584 static int
 585 fslmc_bus_plug(struct rte_device *dev __rte_unused)
 586 {
 587         /* No operation is performed while plugging the device */
 588         return 0;
 589 }
 590
 591 static int
 592 fslmc_bus_unplug(struct rte_device *dev __rte_unused)
 593 {
 594         /* No operation is performed while unplugging the device */
 595         return 0;
 596 }
 597
 598 static void *
 599 fslmc_bus_dev_iterate(const void *start, const char *str,
 600                       const struct rte_dev_iterator *it __rte_unused)
 601 {
 602         const struct rte_dpaa2_device *dstart;
 603         struct rte_dpaa2_device *dev;
 604         char *dup, *dev_name = NULL;
 605
 606         if (str == NULL) {
 607                 DPAA2_BUS_DEBUG("No device string");
 608                 return NULL;
 609         }
 610
 611         /* Expectation is that device would be name=device_name */
 612         if (strncmp(str, "name=", 5) != 0) {
 613                 DPAA2_BUS_DEBUG("Invalid device string (%s)\n", str);
 614                 return NULL;
 615         }
 616
 617         /* Now that name=device_name format is available, split */
 618         dup = strdup(str);
 619         dev_name = dup + strlen("name=");
 620
 621         if (start != NULL) {
 622                 dstart = RTE_DEV_TO_FSLMC_CONST(start);
 623                 dev = TAILQ_NEXT(dstart, next);
 624         } else {
 625                 dev = TAILQ_FIRST(&rte_fslmc_bus.device_list);
 626         }
 627
 628         while (dev != NULL) {
 629                 if (strcmp(dev->device.name, dev_name) == 0) {
 630                         free(dup);
 631                         return &dev->device;
 632                 }
 633                 dev = TAILQ_NEXT(dev, next);
 634         }
 635
 636         free(dup);
 637         return NULL;
 638 }
 639
 640 struct rte_fslmc_bus rte_fslmc_bus = {
 641         .bus = {
 642                 .scan = rte_fslmc_scan,
 643                 .probe = rte_fslmc_probe,
 644                 .parse = rte_fslmc_parse,
 645                 .find_device = rte_fslmc_find_device,
 646                 .get_iommu_class = rte_dpaa2_get_iommu_class,
 647                 .plug = fslmc_bus_plug,
 648                 .unplug = fslmc_bus_unplug,
 649                 .dev_iterate = fslmc_bus_dev_iterate,
 650         },
 651         .device_list = TAILQ_HEAD_INITIALIZER(rte_fslmc_bus.device_list),
 652         .driver_list = TAILQ_HEAD_INITIALIZER(rte_fslmc_bus.driver_list),
 653         .device_count = {0},
 654 };
 655
 656 RTE_REGISTER_BUS(FSLMC_BUS_NAME, rte_fslmc_bus.bus);
 657
 658 RTE_INIT(fslmc_init_log)
 659 {
 660         /* Bus level logs */
 661         dpaa2_logtype_bus = rte_log_register("bus.fslmc");
 662         if (dpaa2_logtype_bus >= 0)
 663                 rte_log_set_level(dpaa2_logtype_bus, RTE_LOG_NOTICE);
 664 }