drivers/bus/ifpga/ifpga_bus.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2018 Intel Corporation
   3  */
   4
   5 #include <string.h>
   6 #include <inttypes.h>
   7 #include <stdint.h>
   8 #include <stdlib.h>
   9 #include <stdio.h>
  10 #include <sys/queue.h>
  11 #include <sys/mman.h>
  12 #include <sys/types.h>
  13 #include <unistd.h>
  14 #include <fcntl.h>
  15
  16 #include <rte_errno.h>
  17 #include <rte_bus.h>
  18 #include <rte_per_lcore.h>
  19 #include <rte_memory.h>
  20 #include <rte_memzone.h>
  21 #include <rte_eal.h>
  22 #include <rte_common.h>
  23 #include <rte_devargs.h>
  24 #include <rte_kvargs.h>
  25 #include <rte_alarm.h>
  26 #include <rte_string_fns.h>
  27
  28 #include "rte_rawdev.h"
  29 #include "rte_rawdev_pmd.h"
  30 #include "rte_bus_ifpga.h"
  31 #include "ifpga_logs.h"
  32 #include "ifpga_common.h"
  33
  34 int ifpga_bus_logtype;
  35
  36 /* Forward declaration to access Intel FPGA bus
  37  * on which iFPGA devices are connected
  38  */
  39 static struct rte_bus rte_ifpga_bus;
  40
  41 static struct ifpga_afu_dev_list ifpga_afu_dev_list =
  42         TAILQ_HEAD_INITIALIZER(ifpga_afu_dev_list);
  43 static struct ifpga_afu_drv_list ifpga_afu_drv_list =
  44         TAILQ_HEAD_INITIALIZER(ifpga_afu_drv_list);
  45
  46
  47 /* register a ifpga bus based driver */
  48 void rte_ifpga_driver_register(struct rte_afu_driver *driver)
  49 {
  50         RTE_VERIFY(driver);
  51
  52         TAILQ_INSERT_TAIL(&ifpga_afu_drv_list, driver, next);
  53 }
  54
  55 /* un-register a fpga bus based driver */
  56 void rte_ifpga_driver_unregister(struct rte_afu_driver *driver)
  57 {
  58         TAILQ_REMOVE(&ifpga_afu_drv_list, driver, next);
  59 }
  60
  61 static struct rte_afu_device *
  62 ifpga_find_afu_dev(const struct rte_rawdev *rdev,
  63         const struct rte_afu_id *afu_id)
  64 {
  65         struct rte_afu_device *afu_dev = NULL;
  66
  67         TAILQ_FOREACH(afu_dev, &ifpga_afu_dev_list, next) {
  68                 if (afu_dev &&
  69                         afu_dev->rawdev == rdev &&
  70                         !ifpga_afu_id_cmp(&afu_dev->id, afu_id))
  71                         return afu_dev;
  72         }
  73         return NULL;
  74 }
  75
  76 static const char * const valid_args[] = {
  77 #define IFPGA_ARG_NAME         "ifpga"
  78         IFPGA_ARG_NAME,
  79 #define IFPGA_ARG_PORT         "port"
  80         IFPGA_ARG_PORT,
  81 #define IFPGA_AFU_BTS          "afu_bts"
  82         IFPGA_AFU_BTS,
  83         NULL
  84 };
  85
  86 /*
  87  * Scan the content of the FPGA bus, and the devices in the devices
  88  * list
  89  */
  90 static struct rte_afu_device *
  91 ifpga_scan_one(struct rte_rawdev *rawdev,
  92                 struct rte_devargs *devargs)
  93 {
  94         struct rte_kvargs *kvlist = NULL;
  95         struct rte_afu_device *afu_dev = NULL;
  96         struct rte_afu_pr_conf afu_pr_conf;
  97         int ret = 0;
  98         char *path = NULL;
  99
 100         memset(&afu_pr_conf, 0, sizeof(struct rte_afu_pr_conf));
 101
 102         kvlist = rte_kvargs_parse(devargs->args, valid_args);
 103         if (!kvlist) {
 104                 IFPGA_BUS_ERR("error when parsing param");
 105                 goto end;
 106         }
 107
 108         if (rte_kvargs_count(kvlist, IFPGA_ARG_PORT) == 1) {
 109                 if (rte_kvargs_process(kvlist, IFPGA_ARG_PORT,
 110                 &rte_ifpga_get_integer32_arg, &afu_pr_conf.afu_id.port) < 0) {
 111                         IFPGA_BUS_ERR("error to parse %s",
 112                                      IFPGA_ARG_PORT);
 113                         goto end;
 114                 }
 115         } else {
 116                 IFPGA_BUS_ERR("arg %s is mandatory for ifpga bus",
 117                           IFPGA_ARG_PORT);
 118                 goto end;
 119         }
 120
 121         if (rte_kvargs_count(kvlist, IFPGA_AFU_BTS) == 1) {
 122                 if (rte_kvargs_process(kvlist, IFPGA_AFU_BTS,
 123                                        &rte_ifpga_get_string_arg, &path) < 0) {
 124                         IFPGA_BUS_ERR("Failed to parse %s",
 125                                      IFPGA_AFU_BTS);
 126                         goto end;
 127                 }
 128         } else {
 129                 IFPGA_BUS_ERR("arg %s is mandatory for ifpga bus",
 130                           IFPGA_AFU_BTS);
 131                 goto end;
 132         }
 133
 134         afu_pr_conf.afu_id.uuid.uuid_low = 0;
 135         afu_pr_conf.afu_id.uuid.uuid_high = 0;
 136         afu_pr_conf.pr_enable = path?1:0;
 137
 138         if (ifpga_find_afu_dev(rawdev, &afu_pr_conf.afu_id))
 139                 goto end;
 140
 141         afu_dev = calloc(1, sizeof(*afu_dev));
 142         if (!afu_dev)
 143                 goto end;
 144
 145         afu_dev->device.devargs = devargs;
 146         afu_dev->device.numa_node = SOCKET_ID_ANY;
 147         afu_dev->device.name = devargs->name;
 148         afu_dev->rawdev = rawdev;
 149         afu_dev->id.uuid.uuid_low  = 0;
 150         afu_dev->id.uuid.uuid_high = 0;
 151         afu_dev->id.port      = afu_pr_conf.afu_id.port;
 152
 153         if (rawdev->dev_ops && rawdev->dev_ops->dev_info_get)
 154                 rawdev->dev_ops->dev_info_get(rawdev, afu_dev);
 155
 156         if (rawdev->dev_ops &&
 157                 rawdev->dev_ops->dev_start &&
 158                 rawdev->dev_ops->dev_start(rawdev))
 159                 goto end;
 160
 161         strlcpy(afu_pr_conf.bs_path, path, sizeof(afu_pr_conf.bs_path));
 162         if (rawdev->dev_ops->firmware_load &&
 163                 rawdev->dev_ops->firmware_load(rawdev,
 164                                 &afu_pr_conf)){
 165                 IFPGA_BUS_ERR("firmware load error %d\n", ret);
 166                 goto end;
 167         }
 168         afu_dev->id.uuid.uuid_low  = afu_pr_conf.afu_id.uuid.uuid_low;
 169         afu_dev->id.uuid.uuid_high = afu_pr_conf.afu_id.uuid.uuid_high;
 170
 171         rte_kvargs_free(kvlist);
 172         free(path);
 173         return afu_dev;
 174
 175 end:
 176         if (kvlist)
 177                 rte_kvargs_free(kvlist);
 178         if (path)
 179                 free(path);
 180         if (afu_dev)
 181                 free(afu_dev);
 182
 183         return NULL;
 184 }
 185
 186 /*
 187  * Scan the content of the FPGA bus, and the devices in the devices
 188  * list
 189  */
 190 static int
 191 ifpga_scan(void)
 192 {
 193         struct rte_devargs *devargs;
 194         struct rte_kvargs *kvlist = NULL;
 195         struct rte_rawdev *rawdev = NULL;
 196         char *name = NULL;
 197         char name1[RTE_RAWDEV_NAME_MAX_LEN];
 198         struct rte_afu_device *afu_dev = NULL;
 199
 200         /* for FPGA devices we scan the devargs_list populated via cmdline */
 201         RTE_EAL_DEVARGS_FOREACH(IFPGA_ARG_NAME, devargs) {
 202                 if (devargs->bus != &rte_ifpga_bus)
 203                         continue;
 204
 205                 kvlist = rte_kvargs_parse(devargs->args, valid_args);
 206                 if (!kvlist) {
 207                         IFPGA_BUS_ERR("error when parsing param");
 208                         goto end;
 209                 }
 210
 211                 if (rte_kvargs_count(kvlist, IFPGA_ARG_NAME) == 1) {
 212                         if (rte_kvargs_process(kvlist, IFPGA_ARG_NAME,
 213                                        &rte_ifpga_get_string_arg, &name) < 0) {
 214                                 IFPGA_BUS_ERR("error to parse %s",
 215                                      IFPGA_ARG_NAME);
 216                                 goto end;
 217                         }
 218                 } else {
 219                         IFPGA_BUS_ERR("arg %s is mandatory for ifpga bus",
 220                           IFPGA_ARG_NAME);
 221                         goto end;
 222                 }
 223
 224                 memset(name1, 0, sizeof(name1));
 225                 snprintf(name1, RTE_RAWDEV_NAME_MAX_LEN, "IFPGA:%s", name);
 226
 227                 rawdev = rte_rawdev_pmd_get_named_dev(name1);
 228                 if (!rawdev)
 229                         goto end;
 230
 231                 afu_dev = ifpga_scan_one(rawdev, devargs);
 232                 if (afu_dev != NULL)
 233                         TAILQ_INSERT_TAIL(&ifpga_afu_dev_list, afu_dev, next);
 234         }
 235
 236 end:
 237         if (kvlist)
 238                 rte_kvargs_free(kvlist);
 239         if (name)
 240                 free(name);
 241
 242         return 0;
 243 }
 244
 245 /*
 246  * Match the AFU Driver and AFU Device using the ID Table
 247  */
 248 static int
 249 rte_afu_match(const struct rte_afu_driver *afu_drv,
 250               const struct rte_afu_device *afu_dev)
 251 {
 252         const struct rte_afu_uuid *id_table;
 253
 254         for (id_table = afu_drv->id_table;
 255                 ((id_table->uuid_low != 0) && (id_table->uuid_high != 0));
 256              id_table++) {
 257                 /* check if device's identifiers match the driver's ones */
 258                 if ((id_table->uuid_low != afu_dev->id.uuid.uuid_low) ||
 259                                 id_table->uuid_high !=
 260                                  afu_dev->id.uuid.uuid_high)
 261                         continue;
 262
 263                 return 1;
 264         }
 265
 266         return 0;
 267 }
 268
 269 static int
 270 ifpga_probe_one_driver(struct rte_afu_driver *drv,
 271                         struct rte_afu_device *afu_dev)
 272 {
 273         int ret;
 274
 275         if (!rte_afu_match(drv, afu_dev))
 276                 /* Match of device and driver failed */
 277                 return 1;
 278
 279         /* reference driver structure */
 280         afu_dev->driver = drv;
 281         afu_dev->device.driver = &drv->driver;
 282
 283         /* call the driver probe() function */
 284         ret = drv->probe(afu_dev);
 285         if (ret) {
 286                 afu_dev->driver = NULL;
 287                 afu_dev->device.driver = NULL;
 288         }
 289
 290         return ret;
 291 }
 292
 293 static int
 294 ifpga_probe_all_drivers(struct rte_afu_device *afu_dev)
 295 {
 296         struct rte_afu_driver *drv = NULL;
 297         int ret = 0;
 298
 299         if (afu_dev == NULL)
 300                 return -1;
 301
 302         /* Check if a driver is already loaded */
 303         if (afu_dev->driver != NULL)
 304                 return 0;
 305
 306         TAILQ_FOREACH(drv, &ifpga_afu_drv_list, next) {
 307                 if (ifpga_probe_one_driver(drv, afu_dev)) {
 308                         ret = -1;
 309                         break;
 310                 }
 311         }
 312         return ret;
 313 }
 314
 315 /*
 316  * Scan the content of the Intel FPGA bus, and call the probe() function for
 317  * all registered drivers that have a matching entry in its id_table
 318  * for discovered devices.
 319  */
 320 static int
 321 ifpga_probe(void)
 322 {
 323         struct rte_afu_device *afu_dev = NULL;
 324         int ret = 0;
 325
 326         TAILQ_FOREACH(afu_dev, &ifpga_afu_dev_list, next) {
 327                 if (afu_dev->device.driver)
 328                         continue;
 329
 330                 ret = ifpga_probe_all_drivers(afu_dev);
 331                 if (ret < 0)
 332                         IFPGA_BUS_ERR("failed to initialize %s device\n",
 333                                 rte_ifpga_device_name(afu_dev));
 334                 }
 335
 336         return ret;
 337 }
 338
 339 static int
 340 ifpga_plug(struct rte_device *dev)
 341 {
 342         return ifpga_probe_all_drivers(RTE_DEV_TO_AFU(dev));
 343 }
 344
 345 static int
 346 ifpga_remove_driver(struct rte_afu_device *afu_dev)
 347 {
 348         const char *name;
 349         const struct rte_afu_driver *driver;
 350
 351         name = rte_ifpga_device_name(afu_dev);
 352         if (!afu_dev->device.driver) {
 353                 IFPGA_BUS_DEBUG("no driver attach to device %s\n", name);
 354                 return 1;
 355         }
 356
 357         driver = RTE_DRV_TO_AFU_CONST(afu_dev->device.driver);
 358         return driver->remove(afu_dev);
 359 }
 360
 361 static int
 362 ifpga_unplug(struct rte_device *dev)
 363 {
 364         struct rte_afu_device *afu_dev = NULL;
 365         struct rte_devargs *devargs = NULL;
 366         int ret;
 367
 368         if (dev == NULL)
 369                 return -EINVAL;
 370
 371         afu_dev = RTE_DEV_TO_AFU(dev);
 372         if (!afu_dev)
 373                 return -ENOENT;
 374
 375         devargs = dev->devargs;
 376
 377         ret = ifpga_remove_driver(afu_dev);
 378         if (ret)
 379                 return ret;
 380
 381         TAILQ_REMOVE(&ifpga_afu_dev_list, afu_dev, next);
 382
 383         rte_devargs_remove(devargs->bus->name, devargs->name);
 384         free(afu_dev);
 385         return 0;
 386
 387 }
 388
 389 static struct rte_device *
 390 ifpga_find_device(const struct rte_device *start,
 391         rte_dev_cmp_t cmp, const void *data)
 392 {
 393         struct rte_afu_device *afu_dev;
 394
 395         TAILQ_FOREACH(afu_dev, &ifpga_afu_dev_list, next) {
 396                 if (start && &afu_dev->device == start) {
 397                         start = NULL;
 398                         continue;
 399                 }
 400                 if (cmp(&afu_dev->device, data) == 0)
 401                         return &afu_dev->device;
 402         }
 403
 404         return NULL;
 405 }
 406 static int
 407 ifpga_parse(const char *name, void *addr)
 408 {
 409         int *out = addr;
 410         struct rte_rawdev *rawdev = NULL;
 411         char rawdev_name[RTE_RAWDEV_NAME_MAX_LEN];
 412         char *c1 = NULL;
 413         char *c2 = NULL;
 414         int port = IFPGA_BUS_DEV_PORT_MAX;
 415         char str_port[8];
 416         int str_port_len = 0;
 417         int ret;
 418
 419         memset(str_port, 0, 8);
 420         c1 = strchr(name, '|');
 421         if (c1 != NULL) {
 422                 str_port_len = c1 - name;
 423                 c2 = c1 + 1;
 424         }
 425
 426         if (str_port_len < 8 &&
 427                 str_port_len > 0) {
 428                 memcpy(str_port, name, str_port_len);
 429                 ret = sscanf(str_port, "%d", &port);
 430                 if (ret == -1)
 431                         return 0;
 432         }
 433
 434         memset(rawdev_name, 0, sizeof(rawdev_name));
 435         snprintf(rawdev_name, RTE_RAWDEV_NAME_MAX_LEN, "IFPGA:%s", c2);
 436         rawdev = rte_rawdev_pmd_get_named_dev(rawdev_name);
 437
 438         if ((port < IFPGA_BUS_DEV_PORT_MAX) &&
 439                 rawdev &&
 440                 (addr != NULL))
 441                 *out = port;
 442
 443         if ((port < IFPGA_BUS_DEV_PORT_MAX) &&
 444                 rawdev)
 445                 return 0;
 446         else
 447                 return 1;
 448 }
 449
 450 static struct rte_bus rte_ifpga_bus = {
 451         .scan        = ifpga_scan,
 452         .probe       = ifpga_probe,
 453         .find_device = ifpga_find_device,
 454         .plug        = ifpga_plug,
 455         .unplug      = ifpga_unplug,
 456         .parse       = ifpga_parse,
 457 };
 458
 459 RTE_REGISTER_BUS(IFPGA_BUS_NAME, rte_ifpga_bus);
 460
 461 RTE_INIT(ifpga_init_log)
 462 {
 463         ifpga_bus_logtype = rte_log_register("bus.ifpga");
 464         if (ifpga_bus_logtype >= 0)
 465                 rte_log_set_level(ifpga_bus_logtype, RTE_LOG_NOTICE);
 466 }