lib/librte_rawdev/rte_rawdev.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2017 NXP
   3  */
   4
   5 #include <ctype.h>
   6 #include <stdio.h>
   7 #include <stdlib.h>
   8 #include <string.h>
   9 #include <stdarg.h>
  10 #include <errno.h>
  11 #include <stdint.h>
  12 #include <inttypes.h>
  13 #include <sys/types.h>
  14 #include <sys/queue.h>
  15
  16 #include <rte_byteorder.h>
  17 #include <rte_log.h>
  18 #include <rte_debug.h>
  19 #include <rte_dev.h>
  20 #include <rte_memory.h>
  21 #include <rte_memcpy.h>
  22 #include <rte_memzone.h>
  23 #include <rte_eal.h>
  24 #include <rte_per_lcore.h>
  25 #include <rte_lcore.h>
  26 #include <rte_atomic.h>
  27 #include <rte_branch_prediction.h>
  28 #include <rte_common.h>
  29 #include <rte_malloc.h>
  30 #include <rte_errno.h>
  31
  32 #include "rte_rawdev.h"
  33 #include "rte_rawdev_pmd.h"
  34
  35 /* dynamic log identifier */
  36 int librawdev_logtype;
  37
  38 struct rte_rawdev rte_rawdevices[RTE_RAWDEV_MAX_DEVS];
  39
  40 struct rte_rawdev *rte_rawdevs = &rte_rawdevices[0];
  41
  42 static struct rte_rawdev_global rawdev_globals = {
  43         .nb_devs                = 0
  44 };
  45
  46 struct rte_rawdev_global *rte_rawdev_globals = &rawdev_globals;
  47
  48 /* Raw device, northbound API implementation */
  49 uint8_t __rte_experimental
  50 rte_rawdev_count(void)
  51 {
  52         return rte_rawdev_globals->nb_devs;
  53 }
  54
  55 uint16_t __rte_experimental
  56 rte_rawdev_get_dev_id(const char *name)
  57 {
  58         uint16_t i;
  59
  60         if (!name)
  61                 return -EINVAL;
  62
  63         for (i = 0; i < rte_rawdev_globals->nb_devs; i++)
  64                 if ((strcmp(rte_rawdevices[i].name, name)
  65                                 == 0) &&
  66                                 (rte_rawdevices[i].attached ==
  67                                                 RTE_RAWDEV_ATTACHED))
  68                         return i;
  69         return -ENODEV;
  70 }
  71
  72 int __rte_experimental
  73 rte_rawdev_socket_id(uint16_t dev_id)
  74 {
  75         struct rte_rawdev *dev;
  76
  77         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
  78         dev = &rte_rawdevs[dev_id];
  79
  80         return dev->socket_id;
  81 }
  82
  83 int __rte_experimental
  84 rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)
  85 {
  86         struct rte_rawdev *rawdev;
  87
  88         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
  89         RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL);
  90
  91         if (dev_info == NULL)
  92                 return -EINVAL;
  93
  94         rawdev = &rte_rawdevs[dev_id];
  95
  96         RTE_FUNC_PTR_OR_ERR_RET(*rawdev->dev_ops->dev_info_get, -ENOTSUP);
  97         (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private);
  98
  99         if (dev_info) {
 100
 101                 dev_info->driver_name = rawdev->driver_name;
 102                 dev_info->device = rawdev->device;
 103         }
 104
 105         return 0;
 106 }
 107
 108 int __rte_experimental
 109 rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf)
 110 {
 111         struct rte_rawdev *dev;
 112         int diag;
 113
 114         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 115         RTE_FUNC_PTR_OR_ERR_RET(dev_conf, -EINVAL);
 116
 117         dev = &rte_rawdevs[dev_id];
 118
 119         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
 120
 121         if (dev->started) {
 122                 RTE_RDEV_ERR(
 123                    "device %d must be stopped to allow configuration", dev_id);
 124                 return -EBUSY;
 125         }
 126
 127         /* Configure the device */
 128         diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private);
 129         if (diag != 0)
 130                 RTE_RDEV_ERR("dev%d dev_configure = %d", dev_id, diag);
 131         else
 132                 dev->attached = 1;
 133
 134         return diag;
 135 }
 136
 137 int __rte_experimental
 138 rte_rawdev_queue_conf_get(uint16_t dev_id,
 139                           uint16_t queue_id,
 140                           rte_rawdev_obj_t queue_conf)
 141 {
 142         struct rte_rawdev *dev;
 143
 144         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 145         dev = &rte_rawdevs[dev_id];
 146
 147         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_def_conf, -ENOTSUP);
 148         (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf);
 149         return 0;
 150 }
 151
 152 int __rte_experimental
 153 rte_rawdev_queue_setup(uint16_t dev_id,
 154                        uint16_t queue_id,
 155                        rte_rawdev_obj_t queue_conf)
 156 {
 157         struct rte_rawdev *dev;
 158
 159         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 160         dev = &rte_rawdevs[dev_id];
 161
 162         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_setup, -ENOTSUP);
 163         return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf);
 164 }
 165
 166 int __rte_experimental
 167 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
 168 {
 169         struct rte_rawdev *dev;
 170
 171         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 172         dev = &rte_rawdevs[dev_id];
 173
 174         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_release, -ENOTSUP);
 175         return (*dev->dev_ops->queue_release)(dev, queue_id);
 176 }
 177
 178 int __rte_experimental
 179 rte_rawdev_get_attr(uint16_t dev_id,
 180                     const char *attr_name,
 181                     uint64_t *attr_value)
 182 {
 183         struct rte_rawdev *dev;
 184
 185         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 186         dev = &rte_rawdevs[dev_id];
 187
 188         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_get, -ENOTSUP);
 189         return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
 190 }
 191
 192 int __rte_experimental
 193 rte_rawdev_set_attr(uint16_t dev_id,
 194                     const char *attr_name,
 195                     const uint64_t attr_value)
 196 {
 197         struct rte_rawdev *dev;
 198
 199         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 200         dev = &rte_rawdevs[dev_id];
 201
 202         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_set, -ENOTSUP);
 203         return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
 204 }
 205
 206 int __rte_experimental
 207 rte_rawdev_enqueue_buffers(uint16_t dev_id,
 208                            struct rte_rawdev_buf **buffers,
 209                            unsigned int count,
 210                            rte_rawdev_obj_t context)
 211 {
 212         struct rte_rawdev *dev;
 213
 214         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 215         dev = &rte_rawdevs[dev_id];
 216
 217         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->enqueue_bufs, -ENOTSUP);
 218         return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
 219 }
 220
 221 int __rte_experimental
 222 rte_rawdev_dequeue_buffers(uint16_t dev_id,
 223                            struct rte_rawdev_buf **buffers,
 224                            unsigned int count,
 225                            rte_rawdev_obj_t context)
 226 {
 227         struct rte_rawdev *dev;
 228
 229         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 230         dev = &rte_rawdevs[dev_id];
 231
 232         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dequeue_bufs, -ENOTSUP);
 233         return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
 234 }
 235
 236 int __rte_experimental
 237 rte_rawdev_dump(uint16_t dev_id, FILE *f)
 238 {
 239         struct rte_rawdev *dev;
 240
 241         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 242         dev = &rte_rawdevs[dev_id];
 243
 244         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dump, -ENOTSUP);
 245         return (*dev->dev_ops->dump)(dev, f);
 246 }
 247
 248 static int
 249 xstats_get_count(uint16_t dev_id)
 250 {
 251         struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 252
 253         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
 254         return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
 255 }
 256
 257 int __rte_experimental
 258 rte_rawdev_xstats_names_get(uint16_t dev_id,
 259                 struct rte_rawdev_xstats_name *xstats_names,
 260                 unsigned int size)
 261 {
 262         const struct rte_rawdev *dev;
 263         int cnt_expected_entries;
 264
 265         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
 266
 267         cnt_expected_entries = xstats_get_count(dev_id);
 268
 269         if (xstats_names == NULL || cnt_expected_entries < 0 ||
 270             (int)size < cnt_expected_entries || size <= 0)
 271                 return cnt_expected_entries;
 272
 273         dev = &rte_rawdevs[dev_id];
 274
 275         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
 276         return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
 277 }
 278
 279 /* retrieve rawdev extended statistics */
 280 int __rte_experimental
 281 rte_rawdev_xstats_get(uint16_t dev_id,
 282                       const unsigned int ids[],
 283                       uint64_t values[],
 284                       unsigned int n)
 285 {
 286         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
 287         const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 288
 289         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
 290         return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
 291 }
 292
 293 uint64_t __rte_experimental
 294 rte_rawdev_xstats_by_name_get(uint16_t dev_id,
 295                               const char *name,
 296                               unsigned int *id)
 297 {
 298         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
 299         const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 300         unsigned int temp = -1;
 301
 302         if (id != NULL)
 303                 *id = (unsigned int)-1;
 304         else
 305                 id = &temp; /* driver never gets a NULL value */
 306
 307         /* implemented by driver */
 308         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
 309         return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
 310 }
 311
 312 int __rte_experimental
 313 rte_rawdev_xstats_reset(uint16_t dev_id,
 314                         const uint32_t ids[], uint32_t nb_ids)
 315 {
 316         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 317         struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 318
 319         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_reset, -ENOTSUP);
 320         return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
 321 }
 322
 323 int __rte_experimental
 324 rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_info)
 325 {
 326         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 327         struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 328
 329         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_status_get, -ENOTSUP);
 330         return (*dev->dev_ops->firmware_status_get)(dev, status_info);
 331 }
 332
 333 int __rte_experimental
 334 rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_info)
 335 {
 336         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 337         struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 338
 339         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_version_get, -ENOTSUP);
 340         return (*dev->dev_ops->firmware_version_get)(dev, version_info);
 341 }
 342
 343 int __rte_experimental
 344 rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
 345 {
 346         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 347         struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 348
 349         if (!firmware_image)
 350                 return -EINVAL;
 351
 352         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
 353         return (*dev->dev_ops->firmware_load)(dev, firmware_image);
 354 }
 355
 356 int __rte_experimental
 357 rte_rawdev_firmware_unload(uint16_t dev_id)
 358 {
 359         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 360         struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 361
 362         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
 363         return (*dev->dev_ops->firmware_unload)(dev);
 364 }
 365
 366 int __rte_experimental
 367 rte_rawdev_selftest(uint16_t dev_id)
 368 {
 369         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 370         struct rte_rawdev *dev = &rte_rawdevs[dev_id];
 371
 372         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_selftest, -ENOTSUP);
 373         return (*dev->dev_ops->dev_selftest)();
 374 }
 375
 376 int __rte_experimental
 377 rte_rawdev_start(uint16_t dev_id)
 378 {
 379         struct rte_rawdev *dev;
 380         int diag;
 381
 382         RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
 383
 384         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 385         dev = &rte_rawdevs[dev_id];
 386         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
 387
 388         if (dev->started != 0) {
 389                 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
 390                              dev_id);
 391                 return 0;
 392         }
 393
 394         diag = (*dev->dev_ops->dev_start)(dev);
 395         if (diag == 0)
 396                 dev->started = 1;
 397         else
 398                 return diag;
 399
 400         return 0;
 401 }
 402
 403 void __rte_experimental
 404 rte_rawdev_stop(uint16_t dev_id)
 405 {
 406         struct rte_rawdev *dev;
 407
 408         RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
 409
 410         RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
 411         dev = &rte_rawdevs[dev_id];
 412
 413         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
 414
 415         if (dev->started == 0) {
 416                 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
 417                         dev_id);
 418                 return;
 419         }
 420
 421         (*dev->dev_ops->dev_stop)(dev);
 422         dev->started = 0;
 423 }
 424
 425 int __rte_experimental
 426 rte_rawdev_close(uint16_t dev_id)
 427 {
 428         struct rte_rawdev *dev;
 429
 430         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 431         dev = &rte_rawdevs[dev_id];
 432
 433         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
 434         /* Device must be stopped before it can be closed */
 435         if (dev->started == 1) {
 436                 RTE_RDEV_ERR("Device %u must be stopped before closing",
 437                              dev_id);
 438                 return -EBUSY;
 439         }
 440
 441         return (*dev->dev_ops->dev_close)(dev);
 442 }
 443
 444 int __rte_experimental
 445 rte_rawdev_reset(uint16_t dev_id)
 446 {
 447         struct rte_rawdev *dev;
 448
 449         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 450         dev = &rte_rawdevs[dev_id];
 451
 452         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
 453         /* Reset is not dependent on state of the device */
 454         return (*dev->dev_ops->dev_reset)(dev);
 455 }
 456
 457 static inline uint8_t
 458 rte_rawdev_find_free_device_index(void)
 459 {
 460         uint16_t dev_id;
 461
 462         for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
 463                 if (rte_rawdevs[dev_id].attached ==
 464                                 RTE_RAWDEV_DETACHED)
 465                         return dev_id;
 466         }
 467
 468         return RTE_RAWDEV_MAX_DEVS;
 469 }
 470
 471 struct rte_rawdev * __rte_experimental
 472 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
 473 {
 474         struct rte_rawdev *rawdev;
 475         uint16_t dev_id;
 476
 477         if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
 478                 RTE_RDEV_ERR("Event device with name %s already allocated!",
 479                              name);
 480                 return NULL;
 481         }
 482
 483         dev_id = rte_rawdev_find_free_device_index();
 484         if (dev_id == RTE_RAWDEV_MAX_DEVS) {
 485                 RTE_RDEV_ERR("Reached maximum number of raw devices");
 486                 return NULL;
 487         }
 488
 489         rawdev = &rte_rawdevs[dev_id];
 490
 491         rawdev->dev_private = rte_zmalloc_socket("rawdev private",
 492                                      dev_priv_size,
 493                                      RTE_CACHE_LINE_SIZE,
 494                                      socket_id);
 495         if (!rawdev->dev_private) {
 496                 RTE_RDEV_ERR("Unable to allocate memory to Skeleton dev");
 497                 return NULL;
 498         }
 499
 500
 501         rawdev->dev_id = dev_id;
 502         rawdev->socket_id = socket_id;
 503         rawdev->started = 0;
 504         snprintf(rawdev->name, RTE_RAWDEV_NAME_MAX_LEN, "%s", name);
 505
 506         rawdev->attached = RTE_RAWDEV_ATTACHED;
 507         rawdev_globals.nb_devs++;
 508
 509         return rawdev;
 510 }
 511
 512 int __rte_experimental
 513 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
 514 {
 515         int ret;
 516
 517         if (rawdev == NULL)
 518                 return -EINVAL;
 519
 520         ret = rte_rawdev_close(rawdev->dev_id);
 521         if (ret < 0)
 522                 return ret;
 523
 524         rawdev->attached = RTE_RAWDEV_DETACHED;
 525         rawdev_globals.nb_devs--;
 526
 527         rawdev->dev_id = 0;
 528         rawdev->socket_id = 0;
 529         rawdev->dev_ops = NULL;
 530         if (rawdev->dev_private) {
 531                 rte_free(rawdev->dev_private);
 532                 rawdev->dev_private = NULL;
 533         }
 534
 535         return 0;
 536 }
 537
 538 RTE_INIT(librawdev_init_log);
 539
 540 static void
 541 librawdev_init_log(void)
 542 {
 543         librawdev_logtype = rte_log_register("lib.rawdev");
 544         if (librawdev_logtype >= 0)
 545                 rte_log_set_level(librawdev_logtype, RTE_LOG_INFO);
 546 }