drivers/bus/fslmc/fslmc_bus.c

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