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