1 /* SPDX-License-Identifier: BSD-3-Clause
13 #include <rte_byteorder.h>
14 #include <rte_common.h>
15 #include <rte_debug.h>
18 #include <rte_kvargs.h>
20 #include <rte_malloc.h>
21 #include <rte_memory.h>
22 #include <rte_memcpy.h>
23 #include <rte_lcore.h>
24 #include <rte_bus_vdev.h>
26 #include <rte_rawdev.h>
27 #include <rte_rawdev_pmd.h>
29 #include "skeleton_rawdev.h"
31 /* Count of instances */
32 static uint16_t skeldev_init_once;
34 /**< Rawdev Skeleton dummy driver name */
35 #define SKELETON_PMD_RAWDEV_NAME rawdev_skeleton
37 struct queue_buffers {
38 void *bufs[SKELETON_QUEUE_MAX_DEPTH];
41 static struct queue_buffers queue_buf[SKELETON_MAX_QUEUES] = {};
42 static void clear_queue_bufs(int queue_id);
44 static int skeleton_rawdev_info_get(struct rte_rawdev *dev,
45 rte_rawdev_obj_t dev_info,
48 struct skeleton_rawdev *skeldev;
49 struct skeleton_rawdev_conf *skeldev_conf;
51 SKELETON_PMD_FUNC_TRACE();
53 if (!dev_info || dev_info_size != sizeof(*skeldev_conf)) {
54 SKELETON_PMD_ERR("Invalid request");
58 skeldev = skeleton_rawdev_get_priv(dev);
60 skeldev_conf = dev_info;
62 skeldev_conf->num_queues = skeldev->num_queues;
63 skeldev_conf->capabilities = skeldev->capabilities;
64 skeldev_conf->device_state = skeldev->device_state;
65 skeldev_conf->firmware_state = skeldev->fw.firmware_state;
70 static int skeleton_rawdev_configure(const struct rte_rawdev *dev,
71 rte_rawdev_obj_t config,
74 struct skeleton_rawdev *skeldev;
75 struct skeleton_rawdev_conf *skeldev_conf;
77 SKELETON_PMD_FUNC_TRACE();
79 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
81 if (config == NULL || config_size != sizeof(*skeldev_conf)) {
82 SKELETON_PMD_ERR("Invalid configuration");
86 skeldev_conf = config;
87 skeldev = skeleton_rawdev_get_priv(dev);
89 if (skeldev_conf->num_queues <= SKELETON_MAX_QUEUES)
90 skeldev->num_queues = skeldev_conf->num_queues;
94 skeldev->capabilities = skeldev_conf->capabilities;
95 skeldev->num_queues = skeldev_conf->num_queues;
100 static int skeleton_rawdev_start(struct rte_rawdev *dev)
103 struct skeleton_rawdev *skeldev;
104 enum skeleton_firmware_state fw_state;
105 enum skeleton_device_state device_state;
107 SKELETON_PMD_FUNC_TRACE();
109 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
111 skeldev = skeleton_rawdev_get_priv(dev);
113 fw_state = skeldev->fw.firmware_state;
114 device_state = skeldev->device_state;
116 if (fw_state == SKELETON_FW_LOADED &&
117 device_state == SKELETON_DEV_STOPPED) {
118 skeldev->device_state = SKELETON_DEV_RUNNING;
120 SKELETON_PMD_ERR("Device not ready for starting");
127 static void skeleton_rawdev_stop(struct rte_rawdev *dev)
129 struct skeleton_rawdev *skeldev;
131 SKELETON_PMD_FUNC_TRACE();
134 skeldev = skeleton_rawdev_get_priv(dev);
135 skeldev->device_state = SKELETON_DEV_STOPPED;
140 reset_queues(struct skeleton_rawdev *skeldev)
144 for (i = 0; i < SKELETON_MAX_QUEUES; i++) {
145 skeldev->queues[i].depth = SKELETON_QUEUE_DEF_DEPTH;
146 skeldev->queues[i].state = SKELETON_QUEUE_DETACH;
151 reset_attribute_table(struct skeleton_rawdev *skeldev)
155 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
156 if (skeldev->attr[i].name) {
157 free(skeldev->attr[i].name);
158 skeldev->attr[i].name = NULL;
163 static int skeleton_rawdev_close(struct rte_rawdev *dev)
166 struct skeleton_rawdev *skeldev;
167 enum skeleton_firmware_state fw_state;
168 enum skeleton_device_state device_state;
170 SKELETON_PMD_FUNC_TRACE();
172 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
174 skeldev = skeleton_rawdev_get_priv(dev);
176 fw_state = skeldev->fw.firmware_state;
177 device_state = skeldev->device_state;
179 reset_queues(skeldev);
180 reset_attribute_table(skeldev);
183 case SKELETON_FW_LOADED:
184 if (device_state == SKELETON_DEV_RUNNING) {
185 SKELETON_PMD_ERR("Cannot close running device");
188 /* Probably call fw reset here */
189 skeldev->fw.firmware_state = SKELETON_FW_READY;
192 case SKELETON_FW_READY:
193 SKELETON_PMD_DEBUG("Device already in stopped state");
195 case SKELETON_FW_ERROR:
197 SKELETON_PMD_DEBUG("Device in impossible state");
202 /* Clear all allocated queues */
203 for (i = 0; i < SKELETON_MAX_QUEUES; i++)
209 static int skeleton_rawdev_reset(struct rte_rawdev *dev)
211 struct skeleton_rawdev *skeldev;
213 SKELETON_PMD_FUNC_TRACE();
215 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
217 skeldev = skeleton_rawdev_get_priv(dev);
219 SKELETON_PMD_DEBUG("Resetting device");
220 skeldev->fw.firmware_state = SKELETON_FW_READY;
225 static int skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,
227 rte_rawdev_obj_t queue_conf,
230 struct skeleton_rawdev *skeldev;
231 struct skeleton_rawdev_queue *skelq;
233 SKELETON_PMD_FUNC_TRACE();
235 if (!dev || !queue_conf ||
236 conf_size != sizeof(struct skeleton_rawdev_queue))
239 skeldev = skeleton_rawdev_get_priv(dev);
240 skelq = &skeldev->queues[queue_id];
242 if (queue_id < SKELETON_MAX_QUEUES)
243 rte_memcpy(queue_conf, skelq,
244 sizeof(struct skeleton_rawdev_queue));
250 clear_queue_bufs(int queue_id)
254 /* Clear buffers for queue_id */
255 for (i = 0; i < SKELETON_QUEUE_MAX_DEPTH; i++)
256 queue_buf[queue_id].bufs[i] = NULL;
259 static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,
261 rte_rawdev_obj_t queue_conf,
265 struct skeleton_rawdev *skeldev;
266 struct skeleton_rawdev_queue *q;
268 SKELETON_PMD_FUNC_TRACE();
270 if (!dev || !queue_conf ||
271 conf_size != sizeof(struct skeleton_rawdev_queue))
274 skeldev = skeleton_rawdev_get_priv(dev);
275 q = &skeldev->queues[queue_id];
277 if (skeldev->num_queues > queue_id &&
278 q->depth < SKELETON_QUEUE_MAX_DEPTH) {
279 rte_memcpy(q, queue_conf,
280 sizeof(struct skeleton_rawdev_queue));
281 clear_queue_bufs(queue_id);
283 SKELETON_PMD_ERR("Invalid queue configuration");
290 static int skeleton_rawdev_queue_release(struct rte_rawdev *dev,
294 struct skeleton_rawdev *skeldev;
296 SKELETON_PMD_FUNC_TRACE();
298 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
300 skeldev = skeleton_rawdev_get_priv(dev);
302 if (skeldev->num_queues > queue_id) {
303 skeldev->queues[queue_id].state = SKELETON_QUEUE_DETACH;
304 skeldev->queues[queue_id].depth = SKELETON_QUEUE_DEF_DEPTH;
305 clear_queue_bufs(queue_id);
307 SKELETON_PMD_ERR("Invalid queue configuration");
314 static uint16_t skeleton_rawdev_queue_count(struct rte_rawdev *dev)
316 struct skeleton_rawdev *skeldev;
318 SKELETON_PMD_FUNC_TRACE();
320 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
322 skeldev = skeleton_rawdev_get_priv(dev);
323 return skeldev->num_queues;
326 static int skeleton_rawdev_get_attr(struct rte_rawdev *dev,
327 const char *attr_name,
328 uint64_t *attr_value)
332 struct skeleton_rawdev *skeldev;
334 SKELETON_PMD_FUNC_TRACE();
336 if (!dev || !attr_name || !attr_value) {
337 SKELETON_PMD_ERR("Invalid arguments for getting attributes");
341 skeldev = skeleton_rawdev_get_priv(dev);
343 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
344 if (!skeldev->attr[i].name)
347 if (!strncmp(skeldev->attr[i].name, attr_name,
348 SKELETON_ATTRIBUTE_NAME_MAX)) {
349 *attr_value = skeldev->attr[i].value;
351 SKELETON_PMD_DEBUG("Attribute (%s) Value (%" PRIu64 ")",
352 attr_name, *attr_value);
360 /* Attribute not found */
364 static int skeleton_rawdev_set_attr(struct rte_rawdev *dev,
365 const char *attr_name,
366 const uint64_t attr_value)
370 struct skeleton_rawdev *skeldev;
372 SKELETON_PMD_FUNC_TRACE();
374 if (!dev || !attr_name) {
375 SKELETON_PMD_ERR("Invalid arguments for setting attributes");
379 skeldev = skeleton_rawdev_get_priv(dev);
381 /* Check if attribute already exists */
382 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
383 if (!skeldev->attr[i].name)
386 if (!strncmp(skeldev->attr[i].name, attr_name,
387 SKELETON_ATTRIBUTE_NAME_MAX)) {
389 skeldev->attr[i].value = attr_value;
396 if (i < (SKELETON_MAX_ATTRIBUTES - 1)) {
397 /* There is still space to insert one more */
398 skeldev->attr[i].name = strdup(attr_name);
399 if (!skeldev->attr[i].name)
402 skeldev->attr[i].value = attr_value;
410 static int skeleton_rawdev_enqueue_bufs(struct rte_rawdev *dev,
411 struct rte_rawdev_buf **buffers,
413 rte_rawdev_obj_t context)
419 /* context is essentially the queue_id which is
420 * transferred as opaque object through the library layer. This can
421 * help in complex implementation which require more information than
422 * just an integer - for example, a queue-pair.
424 q_id = *((int *)context);
426 for (i = 0; i < count; i++)
427 queue_buf[q_id].bufs[i] = buffers[i]->buf_addr;
432 static int skeleton_rawdev_dequeue_bufs(struct rte_rawdev *dev,
433 struct rte_rawdev_buf **buffers,
435 rte_rawdev_obj_t context)
441 /* context is essentially the queue_id which is
442 * transferred as opaque object through the library layer. This can
443 * help in complex implementation which require more information than
444 * just an integer - for example, a queue-pair.
446 q_id = *((int *)context);
448 for (i = 0; i < count; i++)
449 buffers[i]->buf_addr = queue_buf[q_id].bufs[i];
454 static int skeleton_rawdev_dump(struct rte_rawdev *dev, FILE *f)
462 static int skeleton_rawdev_firmware_status_get(struct rte_rawdev *dev,
463 rte_rawdev_obj_t status_info)
465 struct skeleton_rawdev *skeldev;
467 SKELETON_PMD_FUNC_TRACE();
469 skeldev = skeleton_rawdev_get_priv(dev);
471 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
474 memcpy(status_info, &skeldev->fw.firmware_state,
475 sizeof(enum skeleton_firmware_state));
481 static int skeleton_rawdev_firmware_version_get(
482 struct rte_rawdev *dev,
483 rte_rawdev_obj_t version_info)
485 struct skeleton_rawdev *skeldev;
486 struct skeleton_firmware_version_info *vi;
488 SKELETON_PMD_FUNC_TRACE();
490 skeldev = skeleton_rawdev_get_priv(dev);
493 vi->major = skeldev->fw.firmware_version.major;
494 vi->minor = skeldev->fw.firmware_version.minor;
495 vi->subrel = skeldev->fw.firmware_version.subrel;
500 static int skeleton_rawdev_firmware_load(struct rte_rawdev *dev,
501 rte_rawdev_obj_t firmware_buf)
503 struct skeleton_rawdev *skeldev;
505 SKELETON_PMD_FUNC_TRACE();
507 skeldev = skeleton_rawdev_get_priv(dev);
509 /* firmware_buf is a mmaped, possibly DMA'able area, buffer. Being
510 * dummy, all this does is check if firmware_buf is not NULL and
511 * sets the state of the firmware.
516 skeldev->fw.firmware_state = SKELETON_FW_LOADED;
521 static int skeleton_rawdev_firmware_unload(struct rte_rawdev *dev)
523 struct skeleton_rawdev *skeldev;
525 SKELETON_PMD_FUNC_TRACE();
527 skeldev = skeleton_rawdev_get_priv(dev);
529 skeldev->fw.firmware_state = SKELETON_FW_READY;
534 static const struct rte_rawdev_ops skeleton_rawdev_ops = {
535 .dev_info_get = skeleton_rawdev_info_get,
536 .dev_configure = skeleton_rawdev_configure,
537 .dev_start = skeleton_rawdev_start,
538 .dev_stop = skeleton_rawdev_stop,
539 .dev_close = skeleton_rawdev_close,
540 .dev_reset = skeleton_rawdev_reset,
542 .queue_def_conf = skeleton_rawdev_queue_def_conf,
543 .queue_setup = skeleton_rawdev_queue_setup,
544 .queue_release = skeleton_rawdev_queue_release,
545 .queue_count = skeleton_rawdev_queue_count,
547 .attr_get = skeleton_rawdev_get_attr,
548 .attr_set = skeleton_rawdev_set_attr,
550 .enqueue_bufs = skeleton_rawdev_enqueue_bufs,
551 .dequeue_bufs = skeleton_rawdev_dequeue_bufs,
553 .dump = skeleton_rawdev_dump,
556 .xstats_get_names = NULL,
557 .xstats_get_by_name = NULL,
558 .xstats_reset = NULL,
560 .firmware_status_get = skeleton_rawdev_firmware_status_get,
561 .firmware_version_get = skeleton_rawdev_firmware_version_get,
562 .firmware_load = skeleton_rawdev_firmware_load,
563 .firmware_unload = skeleton_rawdev_firmware_unload,
565 .dev_selftest = test_rawdev_skeldev,
569 skeleton_rawdev_create(const char *name,
570 struct rte_vdev_device *vdev,
574 struct rte_rawdev *rawdev = NULL;
575 struct skeleton_rawdev *skeldev = NULL;
578 SKELETON_PMD_ERR("Invalid name of the device!");
583 /* Allocate device structure */
584 rawdev = rte_rawdev_pmd_allocate(name, sizeof(struct skeleton_rawdev),
586 if (rawdev == NULL) {
587 SKELETON_PMD_ERR("Unable to allocate rawdevice");
592 ret = rawdev->dev_id; /* return the rawdev id of new device */
594 rawdev->dev_ops = &skeleton_rawdev_ops;
595 rawdev->device = &vdev->device;
597 skeldev = skeleton_rawdev_get_priv(rawdev);
599 skeldev->device_id = SKELETON_DEVICE_ID;
600 skeldev->vendor_id = SKELETON_VENDOR_ID;
601 skeldev->capabilities = SKELETON_DEFAULT_CAPA;
603 memset(&skeldev->fw, 0, sizeof(struct skeleton_firmware));
605 skeldev->fw.firmware_state = SKELETON_FW_READY;
606 skeldev->fw.firmware_version.major = SKELETON_MAJOR_VER;
607 skeldev->fw.firmware_version.minor = SKELETON_MINOR_VER;
608 skeldev->fw.firmware_version.subrel = SKELETON_SUB_VER;
610 skeldev->device_state = SKELETON_DEV_STOPPED;
612 /* Reset/set to default queue configuration for this device */
613 for (i = 0; i < SKELETON_MAX_QUEUES; i++) {
614 skeldev->queues[i].state = SKELETON_QUEUE_DETACH;
615 skeldev->queues[i].depth = SKELETON_QUEUE_DEF_DEPTH;
618 /* Clear all allocated queue buffers */
619 for (i = 0; i < SKELETON_MAX_QUEUES; i++)
626 rte_rawdev_pmd_release(rawdev);
632 skeleton_rawdev_destroy(const char *name)
635 struct rte_rawdev *rdev;
638 SKELETON_PMD_ERR("Invalid device name");
642 rdev = rte_rawdev_pmd_get_named_dev(name);
644 SKELETON_PMD_ERR("Invalid device name (%s)", name);
648 /* rte_rawdev_close is called by pmd_release */
649 ret = rte_rawdev_pmd_release(rdev);
651 SKELETON_PMD_DEBUG("Device cleanup failed");
657 skeldev_get_selftest(const char *key __rte_unused,
667 skeldev_parse_vdev_args(struct rte_vdev_device *vdev)
673 static const char *const args[] = {
674 SKELETON_SELFTEST_ARG,
678 name = rte_vdev_device_name(vdev);
680 params = rte_vdev_device_args(vdev);
681 if (params != NULL && params[0] != '\0') {
682 struct rte_kvargs *kvlist = rte_kvargs_parse(params, args);
686 "Ignoring unsupported params supplied '%s'",
689 int ret = rte_kvargs_process(kvlist,
690 SKELETON_SELFTEST_ARG,
691 skeldev_get_selftest, &selftest);
692 if (ret != 0 || (selftest < 0 || selftest > 1)) {
693 SKELETON_PMD_ERR("%s: Error in parsing args",
695 rte_kvargs_free(kvlist);
696 ret = -1; /* enforce if selftest is invalid */
701 rte_kvargs_free(kvlist);
708 skeleton_rawdev_probe(struct rte_vdev_device *vdev)
711 int selftest = 0, ret = 0;
714 name = rte_vdev_device_name(vdev);
718 /* More than one instance is not supported */
719 if (skeldev_init_once) {
720 SKELETON_PMD_ERR("Multiple instance not supported for %s",
725 SKELETON_PMD_INFO("Init %s on NUMA node %d", name, rte_socket_id());
727 selftest = skeldev_parse_vdev_args(vdev);
728 /* In case of invalid argument, selftest != 1; ignore other values */
730 ret = skeleton_rawdev_create(name, vdev, rte_socket_id());
732 /* In case command line argument for 'selftest' was passed;
733 * if invalid arguments were passed, execution continues but
737 test_rawdev_skeldev(ret);
740 /* Device instance created; Second instance not possible */
741 skeldev_init_once = 1;
743 return ret < 0 ? ret : 0;
747 skeleton_rawdev_remove(struct rte_vdev_device *vdev)
752 name = rte_vdev_device_name(vdev);
756 SKELETON_PMD_INFO("Closing %s on NUMA node %d", name, rte_socket_id());
758 ret = skeleton_rawdev_destroy(name);
760 skeldev_init_once = 0;
765 static struct rte_vdev_driver skeleton_pmd_drv = {
766 .probe = skeleton_rawdev_probe,
767 .remove = skeleton_rawdev_remove
770 RTE_PMD_REGISTER_VDEV(SKELETON_PMD_RAWDEV_NAME, skeleton_pmd_drv);
771 RTE_LOG_REGISTER(skeleton_pmd_logtype, rawdev.skeleton, INFO);