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 int __rte_experimental
 249 rte_rawdev_start(uint16_t dev_id)
 250 {
 251         struct rte_rawdev *dev;
 252         int diag;
 253
 254         RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
 255
 256         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 257         dev = &rte_rawdevs[dev_id];
 258         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
 259
 260         if (dev->started != 0) {
 261                 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
 262                              dev_id);
 263                 return 0;
 264         }
 265
 266         diag = (*dev->dev_ops->dev_start)(dev);
 267         if (diag == 0)
 268                 dev->started = 1;
 269         else
 270                 return diag;
 271
 272         return 0;
 273 }
 274
 275 void __rte_experimental
 276 rte_rawdev_stop(uint16_t dev_id)
 277 {
 278         struct rte_rawdev *dev;
 279
 280         RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
 281
 282         RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
 283         dev = &rte_rawdevs[dev_id];
 284
 285         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
 286
 287         if (dev->started == 0) {
 288                 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
 289                         dev_id);
 290                 return;
 291         }
 292
 293         (*dev->dev_ops->dev_stop)(dev);
 294         dev->started = 0;
 295 }
 296
 297 int __rte_experimental
 298 rte_rawdev_close(uint16_t dev_id)
 299 {
 300         struct rte_rawdev *dev;
 301
 302         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 303         dev = &rte_rawdevs[dev_id];
 304
 305         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
 306         /* Device must be stopped before it can be closed */
 307         if (dev->started == 1) {
 308                 RTE_RDEV_ERR("Device %u must be stopped before closing",
 309                              dev_id);
 310                 return -EBUSY;
 311         }
 312
 313         return (*dev->dev_ops->dev_close)(dev);
 314 }
 315
 316 int __rte_experimental
 317 rte_rawdev_reset(uint16_t dev_id)
 318 {
 319         struct rte_rawdev *dev;
 320
 321         RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
 322         dev = &rte_rawdevs[dev_id];
 323
 324         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
 325         /* Reset is not dependent on state of the device */
 326         return (*dev->dev_ops->dev_reset)(dev);
 327 }
 328
 329 static inline uint8_t
 330 rte_rawdev_find_free_device_index(void)
 331 {
 332         uint16_t dev_id;
 333
 334         for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
 335                 if (rte_rawdevs[dev_id].attached ==
 336                                 RTE_RAWDEV_DETACHED)
 337                         return dev_id;
 338         }
 339
 340         return RTE_RAWDEV_MAX_DEVS;
 341 }
 342
 343 struct rte_rawdev * __rte_experimental
 344 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
 345 {
 346         struct rte_rawdev *rawdev;
 347         uint16_t dev_id;
 348
 349         if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
 350                 RTE_RDEV_ERR("Event device with name %s already allocated!",
 351                              name);
 352                 return NULL;
 353         }
 354
 355         dev_id = rte_rawdev_find_free_device_index();
 356         if (dev_id == RTE_RAWDEV_MAX_DEVS) {
 357                 RTE_RDEV_ERR("Reached maximum number of raw devices");
 358                 return NULL;
 359         }
 360
 361         rawdev = &rte_rawdevs[dev_id];
 362
 363         rawdev->dev_private = rte_zmalloc_socket("rawdev private",
 364                                      dev_priv_size,
 365                                      RTE_CACHE_LINE_SIZE,
 366                                      socket_id);
 367         if (!rawdev->dev_private) {
 368                 RTE_RDEV_ERR("Unable to allocate memory to Skeleton dev");
 369                 return NULL;
 370         }
 371
 372
 373         rawdev->dev_id = dev_id;
 374         rawdev->socket_id = socket_id;
 375         rawdev->started = 0;
 376         snprintf(rawdev->name, RTE_RAWDEV_NAME_MAX_LEN, "%s", name);
 377
 378         rawdev->attached = RTE_RAWDEV_ATTACHED;
 379         rawdev_globals.nb_devs++;
 380
 381         return rawdev;
 382 }
 383
 384 int __rte_experimental
 385 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
 386 {
 387         int ret;
 388
 389         if (rawdev == NULL)
 390                 return -EINVAL;
 391
 392         ret = rte_rawdev_close(rawdev->dev_id);
 393         if (ret < 0)
 394                 return ret;
 395
 396         rawdev->attached = RTE_RAWDEV_DETACHED;
 397         rawdev_globals.nb_devs--;
 398
 399         rawdev->dev_id = 0;
 400         rawdev->socket_id = 0;
 401         rawdev->dev_ops = NULL;
 402         if (rawdev->dev_private) {
 403                 rte_free(rawdev->dev_private);
 404                 rawdev->dev_private = NULL;
 405         }
 406
 407         return 0;
 408 }
 409
 410 RTE_INIT(librawdev_init_log);
 411
 412 static void
 413 librawdev_init_log(void)
 414 {
 415         librawdev_logtype = rte_log_register("lib.rawdev");
 416         if (librawdev_logtype >= 0)
 417                 rte_log_set_level(librawdev_logtype, RTE_LOG_INFO);
 418 }