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 void 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;
68 static int skeleton_rawdev_configure(const struct rte_rawdev *dev,
69 rte_rawdev_obj_t config)
71 struct skeleton_rawdev *skeldev;
72 struct skeleton_rawdev_conf *skeldev_conf;
74 SKELETON_PMD_FUNC_TRACE();
76 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
79 SKELETON_PMD_ERR("Invalid configuration");
83 skeldev_conf = config;
84 skeldev = skeleton_rawdev_get_priv(dev);
86 if (skeldev_conf->num_queues <= SKELETON_MAX_QUEUES)
87 skeldev->num_queues = skeldev_conf->num_queues;
91 skeldev->capabilities = skeldev_conf->capabilities;
92 skeldev->num_queues = skeldev_conf->num_queues;
97 static int skeleton_rawdev_start(struct rte_rawdev *dev)
100 struct skeleton_rawdev *skeldev;
101 enum skeleton_firmware_state fw_state;
102 enum skeleton_device_state device_state;
104 SKELETON_PMD_FUNC_TRACE();
106 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
108 skeldev = skeleton_rawdev_get_priv(dev);
110 fw_state = skeldev->fw.firmware_state;
111 device_state = skeldev->device_state;
113 if (fw_state == SKELETON_FW_LOADED &&
114 device_state == SKELETON_DEV_STOPPED) {
115 skeldev->device_state = SKELETON_DEV_RUNNING;
117 SKELETON_PMD_ERR("Device not ready for starting");
124 static void skeleton_rawdev_stop(struct rte_rawdev *dev)
126 struct skeleton_rawdev *skeldev;
128 SKELETON_PMD_FUNC_TRACE();
131 skeldev = skeleton_rawdev_get_priv(dev);
132 skeldev->device_state = SKELETON_DEV_STOPPED;
137 reset_queues(struct skeleton_rawdev *skeldev)
141 for (i = 0; i < SKELETON_MAX_QUEUES; i++) {
142 skeldev->queues[i].depth = SKELETON_QUEUE_DEF_DEPTH;
143 skeldev->queues[i].state = SKELETON_QUEUE_DETACH;
148 reset_attribute_table(struct skeleton_rawdev *skeldev)
152 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
153 if (skeldev->attr[i].name) {
154 free(skeldev->attr[i].name);
155 skeldev->attr[i].name = NULL;
160 static int skeleton_rawdev_close(struct rte_rawdev *dev)
163 struct skeleton_rawdev *skeldev;
164 enum skeleton_firmware_state fw_state;
165 enum skeleton_device_state device_state;
167 SKELETON_PMD_FUNC_TRACE();
169 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
171 skeldev = skeleton_rawdev_get_priv(dev);
173 fw_state = skeldev->fw.firmware_state;
174 device_state = skeldev->device_state;
176 reset_queues(skeldev);
177 reset_attribute_table(skeldev);
180 case SKELETON_FW_LOADED:
181 if (device_state == SKELETON_DEV_RUNNING) {
182 SKELETON_PMD_ERR("Cannot close running device");
185 /* Probably call fw reset here */
186 skeldev->fw.firmware_state = SKELETON_FW_READY;
189 case SKELETON_FW_READY:
190 case SKELETON_FW_ERROR:
192 SKELETON_PMD_DEBUG("Device already in stopped state");
197 /* Clear all allocated queues */
198 for (i = 0; i < SKELETON_MAX_QUEUES; i++)
204 static int skeleton_rawdev_reset(struct rte_rawdev *dev)
206 struct skeleton_rawdev *skeldev;
208 SKELETON_PMD_FUNC_TRACE();
210 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
212 skeldev = skeleton_rawdev_get_priv(dev);
214 SKELETON_PMD_DEBUG("Resetting device");
215 skeldev->fw.firmware_state = SKELETON_FW_READY;
220 static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,
222 rte_rawdev_obj_t queue_conf)
224 struct skeleton_rawdev *skeldev;
225 struct skeleton_rawdev_queue *skelq;
227 SKELETON_PMD_FUNC_TRACE();
229 if (!dev || !queue_conf)
232 skeldev = skeleton_rawdev_get_priv(dev);
233 skelq = &skeldev->queues[queue_id];
235 if (queue_id < SKELETON_MAX_QUEUES)
236 rte_memcpy(queue_conf, skelq,
237 sizeof(struct skeleton_rawdev_queue));
241 clear_queue_bufs(int queue_id)
245 /* Clear buffers for queue_id */
246 for (i = 0; i < SKELETON_QUEUE_MAX_DEPTH; i++)
247 queue_buf[queue_id].bufs[i] = NULL;
250 static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,
252 rte_rawdev_obj_t queue_conf)
255 struct skeleton_rawdev *skeldev;
256 struct skeleton_rawdev_queue *q;
258 SKELETON_PMD_FUNC_TRACE();
260 if (!dev || !queue_conf)
263 skeldev = skeleton_rawdev_get_priv(dev);
264 q = &skeldev->queues[queue_id];
266 if (skeldev->num_queues > queue_id &&
267 q->depth < SKELETON_QUEUE_MAX_DEPTH) {
268 rte_memcpy(q, queue_conf,
269 sizeof(struct skeleton_rawdev_queue));
270 clear_queue_bufs(queue_id);
272 SKELETON_PMD_ERR("Invalid queue configuration");
279 static int skeleton_rawdev_queue_release(struct rte_rawdev *dev,
283 struct skeleton_rawdev *skeldev;
285 SKELETON_PMD_FUNC_TRACE();
287 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
289 skeldev = skeleton_rawdev_get_priv(dev);
291 if (skeldev->num_queues > queue_id) {
292 skeldev->queues[queue_id].state = SKELETON_QUEUE_DETACH;
293 skeldev->queues[queue_id].depth = SKELETON_QUEUE_DEF_DEPTH;
294 clear_queue_bufs(queue_id);
296 SKELETON_PMD_ERR("Invalid queue configuration");
303 static uint16_t skeleton_rawdev_queue_count(struct rte_rawdev *dev)
305 struct skeleton_rawdev *skeldev;
307 SKELETON_PMD_FUNC_TRACE();
309 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
311 skeldev = skeleton_rawdev_get_priv(dev);
312 return skeldev->num_queues;
315 static int skeleton_rawdev_get_attr(struct rte_rawdev *dev,
316 const char *attr_name,
317 uint64_t *attr_value)
321 struct skeleton_rawdev *skeldev;
323 SKELETON_PMD_FUNC_TRACE();
325 if (!dev || !attr_name || !attr_value) {
326 SKELETON_PMD_ERR("Invalid arguments for getting attributes");
330 skeldev = skeleton_rawdev_get_priv(dev);
332 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
333 if (!skeldev->attr[i].name)
336 if (!strncmp(skeldev->attr[i].name, attr_name,
337 SKELETON_ATTRIBUTE_NAME_MAX)) {
338 *attr_value = skeldev->attr[i].value;
340 SKELETON_PMD_DEBUG("Attribute (%s) Value (%" PRIu64 ")",
341 attr_name, *attr_value);
349 /* Attribute not found */
353 static int skeleton_rawdev_set_attr(struct rte_rawdev *dev,
354 const char *attr_name,
355 const uint64_t attr_value)
359 struct skeleton_rawdev *skeldev;
361 SKELETON_PMD_FUNC_TRACE();
363 if (!dev || !attr_name) {
364 SKELETON_PMD_ERR("Invalid arguments for setting attributes");
368 skeldev = skeleton_rawdev_get_priv(dev);
370 /* Check if attribute already exists */
371 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
372 if (!skeldev->attr[i].name)
375 if (!strncmp(skeldev->attr[i].name, attr_name,
376 SKELETON_ATTRIBUTE_NAME_MAX)) {
378 skeldev->attr[i].value = attr_value;
385 if (i < (SKELETON_MAX_ATTRIBUTES - 1)) {
386 /* There is still space to insert one more */
387 skeldev->attr[i].name = strdup(attr_name);
388 if (!skeldev->attr[i].name)
391 skeldev->attr[i].value = attr_value;
399 static int skeleton_rawdev_enqueue_bufs(struct rte_rawdev *dev,
400 struct rte_rawdev_buf **buffers,
402 rte_rawdev_obj_t context)
408 /* context is essentially the queue_id which is
409 * transferred as opaque object through the library layer. This can
410 * help in complex implementation which require more information than
411 * just an integer - for example, a queue-pair.
413 q_id = *((int *)context);
415 for (i = 0; i < count; i++)
416 queue_buf[q_id].bufs[i] = buffers[i]->buf_addr;
421 static int skeleton_rawdev_dequeue_bufs(struct rte_rawdev *dev,
422 struct rte_rawdev_buf **buffers,
424 rte_rawdev_obj_t context)
430 /* context is essentially the queue_id which is
431 * transferred as opaque object through the library layer. This can
432 * help in complex implementation which require more information than
433 * just an integer - for example, a queue-pair.
435 q_id = *((int *)context);
437 for (i = 0; i < count; i++)
438 buffers[i]->buf_addr = queue_buf[q_id].bufs[i];
443 static int skeleton_rawdev_dump(struct rte_rawdev *dev, FILE *f)
451 static int skeleton_rawdev_firmware_status_get(struct rte_rawdev *dev,
452 rte_rawdev_obj_t status_info)
454 struct skeleton_rawdev *skeldev;
456 SKELETON_PMD_FUNC_TRACE();
458 skeldev = skeleton_rawdev_get_priv(dev);
460 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
463 memcpy(status_info, &skeldev->fw.firmware_state,
464 sizeof(enum skeleton_firmware_state));
470 static int skeleton_rawdev_firmware_version_get(
471 struct rte_rawdev *dev,
472 rte_rawdev_obj_t version_info)
474 struct skeleton_rawdev *skeldev;
475 struct skeleton_firmware_version_info *vi;
477 SKELETON_PMD_FUNC_TRACE();
479 skeldev = skeleton_rawdev_get_priv(dev);
482 vi->major = skeldev->fw.firmware_version.major;
483 vi->minor = skeldev->fw.firmware_version.minor;
484 vi->subrel = skeldev->fw.firmware_version.subrel;
489 static int skeleton_rawdev_firmware_load(struct rte_rawdev *dev,
490 rte_rawdev_obj_t firmware_buf)
492 struct skeleton_rawdev *skeldev;
494 SKELETON_PMD_FUNC_TRACE();
496 skeldev = skeleton_rawdev_get_priv(dev);
498 /* firmware_buf is a mmaped, possibly DMA'able area, buffer. Being
499 * dummy, all this does is check if firmware_buf is not NULL and
500 * sets the state of the firmware.
505 skeldev->fw.firmware_state = SKELETON_FW_LOADED;
510 static int skeleton_rawdev_firmware_unload(struct rte_rawdev *dev)
512 struct skeleton_rawdev *skeldev;
514 SKELETON_PMD_FUNC_TRACE();
516 skeldev = skeleton_rawdev_get_priv(dev);
518 skeldev->fw.firmware_state = SKELETON_FW_READY;
523 static const struct rte_rawdev_ops skeleton_rawdev_ops = {
524 .dev_info_get = skeleton_rawdev_info_get,
525 .dev_configure = skeleton_rawdev_configure,
526 .dev_start = skeleton_rawdev_start,
527 .dev_stop = skeleton_rawdev_stop,
528 .dev_close = skeleton_rawdev_close,
529 .dev_reset = skeleton_rawdev_reset,
531 .queue_def_conf = skeleton_rawdev_queue_def_conf,
532 .queue_setup = skeleton_rawdev_queue_setup,
533 .queue_release = skeleton_rawdev_queue_release,
534 .queue_count = skeleton_rawdev_queue_count,
536 .attr_get = skeleton_rawdev_get_attr,
537 .attr_set = skeleton_rawdev_set_attr,
539 .enqueue_bufs = skeleton_rawdev_enqueue_bufs,
540 .dequeue_bufs = skeleton_rawdev_dequeue_bufs,
542 .dump = skeleton_rawdev_dump,
545 .xstats_get_names = NULL,
546 .xstats_get_by_name = NULL,
547 .xstats_reset = NULL,
549 .firmware_status_get = skeleton_rawdev_firmware_status_get,
550 .firmware_version_get = skeleton_rawdev_firmware_version_get,
551 .firmware_load = skeleton_rawdev_firmware_load,
552 .firmware_unload = skeleton_rawdev_firmware_unload,
554 .dev_selftest = test_rawdev_skeldev,
558 skeleton_rawdev_create(const char *name,
559 struct rte_vdev_device *vdev,
563 struct rte_rawdev *rawdev = NULL;
564 struct skeleton_rawdev *skeldev = NULL;
567 SKELETON_PMD_ERR("Invalid name of the device!");
572 /* Allocate device structure */
573 rawdev = rte_rawdev_pmd_allocate(name, sizeof(struct skeleton_rawdev),
575 if (rawdev == NULL) {
576 SKELETON_PMD_ERR("Unable to allocate rawdevice");
581 ret = rawdev->dev_id; /* return the rawdev id of new device */
583 rawdev->dev_ops = &skeleton_rawdev_ops;
584 rawdev->device = &vdev->device;
586 skeldev = skeleton_rawdev_get_priv(rawdev);
588 skeldev->device_id = SKELETON_DEVICE_ID;
589 skeldev->vendor_id = SKELETON_VENDOR_ID;
590 skeldev->capabilities = SKELETON_DEFAULT_CAPA;
592 memset(&skeldev->fw, 0, sizeof(struct skeleton_firmware));
594 skeldev->fw.firmware_state = SKELETON_FW_READY;
595 skeldev->fw.firmware_version.major = SKELETON_MAJOR_VER;
596 skeldev->fw.firmware_version.minor = SKELETON_MINOR_VER;
597 skeldev->fw.firmware_version.subrel = SKELETON_SUB_VER;
599 skeldev->device_state = SKELETON_DEV_STOPPED;
601 /* Reset/set to default queue configuration for this device */
602 for (i = 0; i < SKELETON_MAX_QUEUES; i++) {
603 skeldev->queues[i].state = SKELETON_QUEUE_DETACH;
604 skeldev->queues[i].depth = SKELETON_QUEUE_DEF_DEPTH;
607 /* Clear all allocated queue buffers */
608 for (i = 0; i < SKELETON_MAX_QUEUES; i++)
615 rte_rawdev_pmd_release(rawdev);
621 skeleton_rawdev_destroy(const char *name)
624 struct rte_rawdev *rdev;
627 SKELETON_PMD_ERR("Invalid device name");
631 rdev = rte_rawdev_pmd_get_named_dev(name);
633 SKELETON_PMD_ERR("Invalid device name (%s)", name);
637 /* rte_rawdev_close is called by pmd_release */
638 ret = rte_rawdev_pmd_release(rdev);
640 SKELETON_PMD_DEBUG("Device cleanup failed");
646 skeldev_get_selftest(const char *key __rte_unused,
656 skeldev_parse_vdev_args(struct rte_vdev_device *vdev)
662 static const char *const args[] = {
663 SKELETON_SELFTEST_ARG,
667 name = rte_vdev_device_name(vdev);
669 params = rte_vdev_device_args(vdev);
670 if (params != NULL && params[0] != '\0') {
671 struct rte_kvargs *kvlist = rte_kvargs_parse(params, args);
675 "Ignoring unsupported params supplied '%s'",
678 int ret = rte_kvargs_process(kvlist,
679 SKELETON_SELFTEST_ARG,
680 skeldev_get_selftest, &selftest);
681 if (ret != 0 || (selftest < 0 || selftest > 1)) {
682 SKELETON_PMD_ERR("%s: Error in parsing args",
684 rte_kvargs_free(kvlist);
685 ret = -1; /* enforce if selftest is invalid */
690 rte_kvargs_free(kvlist);
697 skeleton_rawdev_probe(struct rte_vdev_device *vdev)
700 int selftest = 0, ret = 0;
703 name = rte_vdev_device_name(vdev);
707 /* More than one instance is not supported */
708 if (skeldev_init_once) {
709 SKELETON_PMD_ERR("Multiple instance not supported for %s",
714 SKELETON_PMD_INFO("Init %s on NUMA node %d", name, rte_socket_id());
716 selftest = skeldev_parse_vdev_args(vdev);
717 /* In case of invalid argument, selftest != 1; ignore other values */
719 ret = skeleton_rawdev_create(name, vdev, rte_socket_id());
721 /* In case command line argument for 'selftest' was passed;
722 * if invalid arguments were passed, execution continues but
726 test_rawdev_skeldev(ret);
729 /* Device instance created; Second instance not possible */
730 skeldev_init_once = 1;
732 return ret < 0 ? ret : 0;
736 skeleton_rawdev_remove(struct rte_vdev_device *vdev)
741 name = rte_vdev_device_name(vdev);
745 SKELETON_PMD_INFO("Closing %s on NUMA node %d", name, rte_socket_id());
747 ret = skeleton_rawdev_destroy(name);
749 skeldev_init_once = 0;
754 static struct rte_vdev_driver skeleton_pmd_drv = {
755 .probe = skeleton_rawdev_probe,
756 .remove = skeleton_rawdev_remove
759 RTE_PMD_REGISTER_VDEV(SKELETON_PMD_RAWDEV_NAME, skeleton_pmd_drv);
760 RTE_LOG_REGISTER(skeleton_pmd_logtype, rawdev.skeleton, INFO);