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 case SKELETON_FW_ERROR:
195 SKELETON_PMD_DEBUG("Device already in stopped state");
200 /* Clear all allocated queues */
201 for (i = 0; i < SKELETON_MAX_QUEUES; i++)
207 static int skeleton_rawdev_reset(struct rte_rawdev *dev)
209 struct skeleton_rawdev *skeldev;
211 SKELETON_PMD_FUNC_TRACE();
213 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
215 skeldev = skeleton_rawdev_get_priv(dev);
217 SKELETON_PMD_DEBUG("Resetting device");
218 skeldev->fw.firmware_state = SKELETON_FW_READY;
223 static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,
225 rte_rawdev_obj_t queue_conf)
227 struct skeleton_rawdev *skeldev;
228 struct skeleton_rawdev_queue *skelq;
230 SKELETON_PMD_FUNC_TRACE();
232 if (!dev || !queue_conf)
235 skeldev = skeleton_rawdev_get_priv(dev);
236 skelq = &skeldev->queues[queue_id];
238 if (queue_id < SKELETON_MAX_QUEUES)
239 rte_memcpy(queue_conf, skelq,
240 sizeof(struct skeleton_rawdev_queue));
244 clear_queue_bufs(int queue_id)
248 /* Clear buffers for queue_id */
249 for (i = 0; i < SKELETON_QUEUE_MAX_DEPTH; i++)
250 queue_buf[queue_id].bufs[i] = NULL;
253 static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,
255 rte_rawdev_obj_t queue_conf)
258 struct skeleton_rawdev *skeldev;
259 struct skeleton_rawdev_queue *q;
261 SKELETON_PMD_FUNC_TRACE();
263 if (!dev || !queue_conf)
266 skeldev = skeleton_rawdev_get_priv(dev);
267 q = &skeldev->queues[queue_id];
269 if (skeldev->num_queues > queue_id &&
270 q->depth < SKELETON_QUEUE_MAX_DEPTH) {
271 rte_memcpy(q, queue_conf,
272 sizeof(struct skeleton_rawdev_queue));
273 clear_queue_bufs(queue_id);
275 SKELETON_PMD_ERR("Invalid queue configuration");
282 static int skeleton_rawdev_queue_release(struct rte_rawdev *dev,
286 struct skeleton_rawdev *skeldev;
288 SKELETON_PMD_FUNC_TRACE();
290 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
292 skeldev = skeleton_rawdev_get_priv(dev);
294 if (skeldev->num_queues > queue_id) {
295 skeldev->queues[queue_id].state = SKELETON_QUEUE_DETACH;
296 skeldev->queues[queue_id].depth = SKELETON_QUEUE_DEF_DEPTH;
297 clear_queue_bufs(queue_id);
299 SKELETON_PMD_ERR("Invalid queue configuration");
306 static uint16_t skeleton_rawdev_queue_count(struct rte_rawdev *dev)
308 struct skeleton_rawdev *skeldev;
310 SKELETON_PMD_FUNC_TRACE();
312 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
314 skeldev = skeleton_rawdev_get_priv(dev);
315 return skeldev->num_queues;
318 static int skeleton_rawdev_get_attr(struct rte_rawdev *dev,
319 const char *attr_name,
320 uint64_t *attr_value)
324 struct skeleton_rawdev *skeldev;
326 SKELETON_PMD_FUNC_TRACE();
328 if (!dev || !attr_name || !attr_value) {
329 SKELETON_PMD_ERR("Invalid arguments for getting attributes");
333 skeldev = skeleton_rawdev_get_priv(dev);
335 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
336 if (!skeldev->attr[i].name)
339 if (!strncmp(skeldev->attr[i].name, attr_name,
340 SKELETON_ATTRIBUTE_NAME_MAX)) {
341 *attr_value = skeldev->attr[i].value;
343 SKELETON_PMD_DEBUG("Attribute (%s) Value (%" PRIu64 ")",
344 attr_name, *attr_value);
352 /* Attribute not found */
356 static int skeleton_rawdev_set_attr(struct rte_rawdev *dev,
357 const char *attr_name,
358 const uint64_t attr_value)
362 struct skeleton_rawdev *skeldev;
364 SKELETON_PMD_FUNC_TRACE();
366 if (!dev || !attr_name) {
367 SKELETON_PMD_ERR("Invalid arguments for setting attributes");
371 skeldev = skeleton_rawdev_get_priv(dev);
373 /* Check if attribute already exists */
374 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
375 if (!skeldev->attr[i].name)
378 if (!strncmp(skeldev->attr[i].name, attr_name,
379 SKELETON_ATTRIBUTE_NAME_MAX)) {
381 skeldev->attr[i].value = attr_value;
388 if (i < (SKELETON_MAX_ATTRIBUTES - 1)) {
389 /* There is still space to insert one more */
390 skeldev->attr[i].name = strdup(attr_name);
391 if (!skeldev->attr[i].name)
394 skeldev->attr[i].value = attr_value;
402 static int skeleton_rawdev_enqueue_bufs(struct rte_rawdev *dev,
403 struct rte_rawdev_buf **buffers,
405 rte_rawdev_obj_t context)
411 /* context is essentially the queue_id which is
412 * transferred as opaque object through the library layer. This can
413 * help in complex implementation which require more information than
414 * just an integer - for example, a queue-pair.
416 q_id = *((int *)context);
418 for (i = 0; i < count; i++)
419 queue_buf[q_id].bufs[i] = buffers[i]->buf_addr;
424 static int skeleton_rawdev_dequeue_bufs(struct rte_rawdev *dev,
425 struct rte_rawdev_buf **buffers,
427 rte_rawdev_obj_t context)
433 /* context is essentially the queue_id which is
434 * transferred as opaque object through the library layer. This can
435 * help in complex implementation which require more information than
436 * just an integer - for example, a queue-pair.
438 q_id = *((int *)context);
440 for (i = 0; i < count; i++)
441 buffers[i]->buf_addr = queue_buf[q_id].bufs[i];
446 static int skeleton_rawdev_dump(struct rte_rawdev *dev, FILE *f)
454 static int skeleton_rawdev_firmware_status_get(struct rte_rawdev *dev,
455 rte_rawdev_obj_t status_info)
457 struct skeleton_rawdev *skeldev;
459 SKELETON_PMD_FUNC_TRACE();
461 skeldev = skeleton_rawdev_get_priv(dev);
463 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
466 memcpy(status_info, &skeldev->fw.firmware_state,
467 sizeof(enum skeleton_firmware_state));
473 static int skeleton_rawdev_firmware_version_get(
474 struct rte_rawdev *dev,
475 rte_rawdev_obj_t version_info)
477 struct skeleton_rawdev *skeldev;
478 struct skeleton_firmware_version_info *vi;
480 SKELETON_PMD_FUNC_TRACE();
482 skeldev = skeleton_rawdev_get_priv(dev);
485 vi->major = skeldev->fw.firmware_version.major;
486 vi->minor = skeldev->fw.firmware_version.minor;
487 vi->subrel = skeldev->fw.firmware_version.subrel;
492 static int skeleton_rawdev_firmware_load(struct rte_rawdev *dev,
493 rte_rawdev_obj_t firmware_buf)
495 struct skeleton_rawdev *skeldev;
497 SKELETON_PMD_FUNC_TRACE();
499 skeldev = skeleton_rawdev_get_priv(dev);
501 /* firmware_buf is a mmaped, possibly DMA'able area, buffer. Being
502 * dummy, all this does is check if firmware_buf is not NULL and
503 * sets the state of the firmware.
508 skeldev->fw.firmware_state = SKELETON_FW_LOADED;
513 static int skeleton_rawdev_firmware_unload(struct rte_rawdev *dev)
515 struct skeleton_rawdev *skeldev;
517 SKELETON_PMD_FUNC_TRACE();
519 skeldev = skeleton_rawdev_get_priv(dev);
521 skeldev->fw.firmware_state = SKELETON_FW_READY;
526 static const struct rte_rawdev_ops skeleton_rawdev_ops = {
527 .dev_info_get = skeleton_rawdev_info_get,
528 .dev_configure = skeleton_rawdev_configure,
529 .dev_start = skeleton_rawdev_start,
530 .dev_stop = skeleton_rawdev_stop,
531 .dev_close = skeleton_rawdev_close,
532 .dev_reset = skeleton_rawdev_reset,
534 .queue_def_conf = skeleton_rawdev_queue_def_conf,
535 .queue_setup = skeleton_rawdev_queue_setup,
536 .queue_release = skeleton_rawdev_queue_release,
537 .queue_count = skeleton_rawdev_queue_count,
539 .attr_get = skeleton_rawdev_get_attr,
540 .attr_set = skeleton_rawdev_set_attr,
542 .enqueue_bufs = skeleton_rawdev_enqueue_bufs,
543 .dequeue_bufs = skeleton_rawdev_dequeue_bufs,
545 .dump = skeleton_rawdev_dump,
548 .xstats_get_names = NULL,
549 .xstats_get_by_name = NULL,
550 .xstats_reset = NULL,
552 .firmware_status_get = skeleton_rawdev_firmware_status_get,
553 .firmware_version_get = skeleton_rawdev_firmware_version_get,
554 .firmware_load = skeleton_rawdev_firmware_load,
555 .firmware_unload = skeleton_rawdev_firmware_unload,
557 .dev_selftest = test_rawdev_skeldev,
561 skeleton_rawdev_create(const char *name,
562 struct rte_vdev_device *vdev,
566 struct rte_rawdev *rawdev = NULL;
567 struct skeleton_rawdev *skeldev = NULL;
570 SKELETON_PMD_ERR("Invalid name of the device!");
575 /* Allocate device structure */
576 rawdev = rte_rawdev_pmd_allocate(name, sizeof(struct skeleton_rawdev),
578 if (rawdev == NULL) {
579 SKELETON_PMD_ERR("Unable to allocate rawdevice");
584 ret = rawdev->dev_id; /* return the rawdev id of new device */
586 rawdev->dev_ops = &skeleton_rawdev_ops;
587 rawdev->device = &vdev->device;
589 skeldev = skeleton_rawdev_get_priv(rawdev);
591 skeldev->device_id = SKELETON_DEVICE_ID;
592 skeldev->vendor_id = SKELETON_VENDOR_ID;
593 skeldev->capabilities = SKELETON_DEFAULT_CAPA;
595 memset(&skeldev->fw, 0, sizeof(struct skeleton_firmware));
597 skeldev->fw.firmware_state = SKELETON_FW_READY;
598 skeldev->fw.firmware_version.major = SKELETON_MAJOR_VER;
599 skeldev->fw.firmware_version.minor = SKELETON_MINOR_VER;
600 skeldev->fw.firmware_version.subrel = SKELETON_SUB_VER;
602 skeldev->device_state = SKELETON_DEV_STOPPED;
604 /* Reset/set to default queue configuration for this device */
605 for (i = 0; i < SKELETON_MAX_QUEUES; i++) {
606 skeldev->queues[i].state = SKELETON_QUEUE_DETACH;
607 skeldev->queues[i].depth = SKELETON_QUEUE_DEF_DEPTH;
610 /* Clear all allocated queue buffers */
611 for (i = 0; i < SKELETON_MAX_QUEUES; i++)
618 rte_rawdev_pmd_release(rawdev);
624 skeleton_rawdev_destroy(const char *name)
627 struct rte_rawdev *rdev;
630 SKELETON_PMD_ERR("Invalid device name");
634 rdev = rte_rawdev_pmd_get_named_dev(name);
636 SKELETON_PMD_ERR("Invalid device name (%s)", name);
640 /* rte_rawdev_close is called by pmd_release */
641 ret = rte_rawdev_pmd_release(rdev);
643 SKELETON_PMD_DEBUG("Device cleanup failed");
649 skeldev_get_selftest(const char *key __rte_unused,
659 skeldev_parse_vdev_args(struct rte_vdev_device *vdev)
665 static const char *const args[] = {
666 SKELETON_SELFTEST_ARG,
670 name = rte_vdev_device_name(vdev);
672 params = rte_vdev_device_args(vdev);
673 if (params != NULL && params[0] != '\0') {
674 struct rte_kvargs *kvlist = rte_kvargs_parse(params, args);
678 "Ignoring unsupported params supplied '%s'",
681 int ret = rte_kvargs_process(kvlist,
682 SKELETON_SELFTEST_ARG,
683 skeldev_get_selftest, &selftest);
684 if (ret != 0 || (selftest < 0 || selftest > 1)) {
685 SKELETON_PMD_ERR("%s: Error in parsing args",
687 rte_kvargs_free(kvlist);
688 ret = -1; /* enforce if selftest is invalid */
693 rte_kvargs_free(kvlist);
700 skeleton_rawdev_probe(struct rte_vdev_device *vdev)
703 int selftest = 0, ret = 0;
706 name = rte_vdev_device_name(vdev);
710 /* More than one instance is not supported */
711 if (skeldev_init_once) {
712 SKELETON_PMD_ERR("Multiple instance not supported for %s",
717 SKELETON_PMD_INFO("Init %s on NUMA node %d", name, rte_socket_id());
719 selftest = skeldev_parse_vdev_args(vdev);
720 /* In case of invalid argument, selftest != 1; ignore other values */
722 ret = skeleton_rawdev_create(name, vdev, rte_socket_id());
724 /* In case command line argument for 'selftest' was passed;
725 * if invalid arguments were passed, execution continues but
729 test_rawdev_skeldev(ret);
732 /* Device instance created; Second instance not possible */
733 skeldev_init_once = 1;
735 return ret < 0 ? ret : 0;
739 skeleton_rawdev_remove(struct rte_vdev_device *vdev)
744 name = rte_vdev_device_name(vdev);
748 SKELETON_PMD_INFO("Closing %s on NUMA node %d", name, rte_socket_id());
750 ret = skeleton_rawdev_destroy(name);
752 skeldev_init_once = 0;
757 static struct rte_vdev_driver skeleton_pmd_drv = {
758 .probe = skeleton_rawdev_probe,
759 .remove = skeleton_rawdev_remove
762 RTE_PMD_REGISTER_VDEV(SKELETON_PMD_RAWDEV_NAME, skeleton_pmd_drv);
763 RTE_LOG_REGISTER(skeleton_pmd_logtype, rawdev.skeleton, INFO);