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