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