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,
228 struct skeleton_rawdev *skeldev;
229 struct skeleton_rawdev_queue *skelq;
231 SKELETON_PMD_FUNC_TRACE();
233 if (!dev || !queue_conf ||
234 conf_size != sizeof(struct skeleton_rawdev_queue))
237 skeldev = skeleton_rawdev_get_priv(dev);
238 skelq = &skeldev->queues[queue_id];
240 if (queue_id < SKELETON_MAX_QUEUES)
241 rte_memcpy(queue_conf, skelq,
242 sizeof(struct skeleton_rawdev_queue));
246 clear_queue_bufs(int queue_id)
250 /* Clear buffers for queue_id */
251 for (i = 0; i < SKELETON_QUEUE_MAX_DEPTH; i++)
252 queue_buf[queue_id].bufs[i] = NULL;
255 static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,
257 rte_rawdev_obj_t queue_conf,
261 struct skeleton_rawdev *skeldev;
262 struct skeleton_rawdev_queue *q;
264 SKELETON_PMD_FUNC_TRACE();
266 if (!dev || !queue_conf ||
267 conf_size != sizeof(struct skeleton_rawdev_queue))
270 skeldev = skeleton_rawdev_get_priv(dev);
271 q = &skeldev->queues[queue_id];
273 if (skeldev->num_queues > queue_id &&
274 q->depth < SKELETON_QUEUE_MAX_DEPTH) {
275 rte_memcpy(q, queue_conf,
276 sizeof(struct skeleton_rawdev_queue));
277 clear_queue_bufs(queue_id);
279 SKELETON_PMD_ERR("Invalid queue configuration");
286 static int skeleton_rawdev_queue_release(struct rte_rawdev *dev,
290 struct skeleton_rawdev *skeldev;
292 SKELETON_PMD_FUNC_TRACE();
294 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
296 skeldev = skeleton_rawdev_get_priv(dev);
298 if (skeldev->num_queues > queue_id) {
299 skeldev->queues[queue_id].state = SKELETON_QUEUE_DETACH;
300 skeldev->queues[queue_id].depth = SKELETON_QUEUE_DEF_DEPTH;
301 clear_queue_bufs(queue_id);
303 SKELETON_PMD_ERR("Invalid queue configuration");
310 static uint16_t skeleton_rawdev_queue_count(struct rte_rawdev *dev)
312 struct skeleton_rawdev *skeldev;
314 SKELETON_PMD_FUNC_TRACE();
316 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
318 skeldev = skeleton_rawdev_get_priv(dev);
319 return skeldev->num_queues;
322 static int skeleton_rawdev_get_attr(struct rte_rawdev *dev,
323 const char *attr_name,
324 uint64_t *attr_value)
328 struct skeleton_rawdev *skeldev;
330 SKELETON_PMD_FUNC_TRACE();
332 if (!dev || !attr_name || !attr_value) {
333 SKELETON_PMD_ERR("Invalid arguments for getting attributes");
337 skeldev = skeleton_rawdev_get_priv(dev);
339 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
340 if (!skeldev->attr[i].name)
343 if (!strncmp(skeldev->attr[i].name, attr_name,
344 SKELETON_ATTRIBUTE_NAME_MAX)) {
345 *attr_value = skeldev->attr[i].value;
347 SKELETON_PMD_DEBUG("Attribute (%s) Value (%" PRIu64 ")",
348 attr_name, *attr_value);
356 /* Attribute not found */
360 static int skeleton_rawdev_set_attr(struct rte_rawdev *dev,
361 const char *attr_name,
362 const uint64_t attr_value)
366 struct skeleton_rawdev *skeldev;
368 SKELETON_PMD_FUNC_TRACE();
370 if (!dev || !attr_name) {
371 SKELETON_PMD_ERR("Invalid arguments for setting attributes");
375 skeldev = skeleton_rawdev_get_priv(dev);
377 /* Check if attribute already exists */
378 for (i = 0; i < SKELETON_MAX_ATTRIBUTES; i++) {
379 if (!skeldev->attr[i].name)
382 if (!strncmp(skeldev->attr[i].name, attr_name,
383 SKELETON_ATTRIBUTE_NAME_MAX)) {
385 skeldev->attr[i].value = attr_value;
392 if (i < (SKELETON_MAX_ATTRIBUTES - 1)) {
393 /* There is still space to insert one more */
394 skeldev->attr[i].name = strdup(attr_name);
395 if (!skeldev->attr[i].name)
398 skeldev->attr[i].value = attr_value;
406 static int skeleton_rawdev_enqueue_bufs(struct rte_rawdev *dev,
407 struct rte_rawdev_buf **buffers,
409 rte_rawdev_obj_t context)
415 /* context is essentially the queue_id which is
416 * transferred as opaque object through the library layer. This can
417 * help in complex implementation which require more information than
418 * just an integer - for example, a queue-pair.
420 q_id = *((int *)context);
422 for (i = 0; i < count; i++)
423 queue_buf[q_id].bufs[i] = buffers[i]->buf_addr;
428 static int skeleton_rawdev_dequeue_bufs(struct rte_rawdev *dev,
429 struct rte_rawdev_buf **buffers,
431 rte_rawdev_obj_t context)
437 /* context is essentially the queue_id which is
438 * transferred as opaque object through the library layer. This can
439 * help in complex implementation which require more information than
440 * just an integer - for example, a queue-pair.
442 q_id = *((int *)context);
444 for (i = 0; i < count; i++)
445 buffers[i]->buf_addr = queue_buf[q_id].bufs[i];
450 static int skeleton_rawdev_dump(struct rte_rawdev *dev, FILE *f)
458 static int skeleton_rawdev_firmware_status_get(struct rte_rawdev *dev,
459 rte_rawdev_obj_t status_info)
461 struct skeleton_rawdev *skeldev;
463 SKELETON_PMD_FUNC_TRACE();
465 skeldev = skeleton_rawdev_get_priv(dev);
467 RTE_FUNC_PTR_OR_ERR_RET(dev, -EINVAL);
470 memcpy(status_info, &skeldev->fw.firmware_state,
471 sizeof(enum skeleton_firmware_state));
477 static int skeleton_rawdev_firmware_version_get(
478 struct rte_rawdev *dev,
479 rte_rawdev_obj_t version_info)
481 struct skeleton_rawdev *skeldev;
482 struct skeleton_firmware_version_info *vi;
484 SKELETON_PMD_FUNC_TRACE();
486 skeldev = skeleton_rawdev_get_priv(dev);
489 vi->major = skeldev->fw.firmware_version.major;
490 vi->minor = skeldev->fw.firmware_version.minor;
491 vi->subrel = skeldev->fw.firmware_version.subrel;
496 static int skeleton_rawdev_firmware_load(struct rte_rawdev *dev,
497 rte_rawdev_obj_t firmware_buf)
499 struct skeleton_rawdev *skeldev;
501 SKELETON_PMD_FUNC_TRACE();
503 skeldev = skeleton_rawdev_get_priv(dev);
505 /* firmware_buf is a mmaped, possibly DMA'able area, buffer. Being
506 * dummy, all this does is check if firmware_buf is not NULL and
507 * sets the state of the firmware.
512 skeldev->fw.firmware_state = SKELETON_FW_LOADED;
517 static int skeleton_rawdev_firmware_unload(struct rte_rawdev *dev)
519 struct skeleton_rawdev *skeldev;
521 SKELETON_PMD_FUNC_TRACE();
523 skeldev = skeleton_rawdev_get_priv(dev);
525 skeldev->fw.firmware_state = SKELETON_FW_READY;
530 static const struct rte_rawdev_ops skeleton_rawdev_ops = {
531 .dev_info_get = skeleton_rawdev_info_get,
532 .dev_configure = skeleton_rawdev_configure,
533 .dev_start = skeleton_rawdev_start,
534 .dev_stop = skeleton_rawdev_stop,
535 .dev_close = skeleton_rawdev_close,
536 .dev_reset = skeleton_rawdev_reset,
538 .queue_def_conf = skeleton_rawdev_queue_def_conf,
539 .queue_setup = skeleton_rawdev_queue_setup,
540 .queue_release = skeleton_rawdev_queue_release,
541 .queue_count = skeleton_rawdev_queue_count,
543 .attr_get = skeleton_rawdev_get_attr,
544 .attr_set = skeleton_rawdev_set_attr,
546 .enqueue_bufs = skeleton_rawdev_enqueue_bufs,
547 .dequeue_bufs = skeleton_rawdev_dequeue_bufs,
549 .dump = skeleton_rawdev_dump,
552 .xstats_get_names = NULL,
553 .xstats_get_by_name = NULL,
554 .xstats_reset = NULL,
556 .firmware_status_get = skeleton_rawdev_firmware_status_get,
557 .firmware_version_get = skeleton_rawdev_firmware_version_get,
558 .firmware_load = skeleton_rawdev_firmware_load,
559 .firmware_unload = skeleton_rawdev_firmware_unload,
561 .dev_selftest = test_rawdev_skeldev,
565 skeleton_rawdev_create(const char *name,
566 struct rte_vdev_device *vdev,
570 struct rte_rawdev *rawdev = NULL;
571 struct skeleton_rawdev *skeldev = NULL;
574 SKELETON_PMD_ERR("Invalid name of the device!");
579 /* Allocate device structure */
580 rawdev = rte_rawdev_pmd_allocate(name, sizeof(struct skeleton_rawdev),
582 if (rawdev == NULL) {
583 SKELETON_PMD_ERR("Unable to allocate rawdevice");
588 ret = rawdev->dev_id; /* return the rawdev id of new device */
590 rawdev->dev_ops = &skeleton_rawdev_ops;
591 rawdev->device = &vdev->device;
593 skeldev = skeleton_rawdev_get_priv(rawdev);
595 skeldev->device_id = SKELETON_DEVICE_ID;
596 skeldev->vendor_id = SKELETON_VENDOR_ID;
597 skeldev->capabilities = SKELETON_DEFAULT_CAPA;
599 memset(&skeldev->fw, 0, sizeof(struct skeleton_firmware));
601 skeldev->fw.firmware_state = SKELETON_FW_READY;
602 skeldev->fw.firmware_version.major = SKELETON_MAJOR_VER;
603 skeldev->fw.firmware_version.minor = SKELETON_MINOR_VER;
604 skeldev->fw.firmware_version.subrel = SKELETON_SUB_VER;
606 skeldev->device_state = SKELETON_DEV_STOPPED;
608 /* Reset/set to default queue configuration for this device */
609 for (i = 0; i < SKELETON_MAX_QUEUES; i++) {
610 skeldev->queues[i].state = SKELETON_QUEUE_DETACH;
611 skeldev->queues[i].depth = SKELETON_QUEUE_DEF_DEPTH;
614 /* Clear all allocated queue buffers */
615 for (i = 0; i < SKELETON_MAX_QUEUES; i++)
622 rte_rawdev_pmd_release(rawdev);
628 skeleton_rawdev_destroy(const char *name)
631 struct rte_rawdev *rdev;
634 SKELETON_PMD_ERR("Invalid device name");
638 rdev = rte_rawdev_pmd_get_named_dev(name);
640 SKELETON_PMD_ERR("Invalid device name (%s)", name);
644 /* rte_rawdev_close is called by pmd_release */
645 ret = rte_rawdev_pmd_release(rdev);
647 SKELETON_PMD_DEBUG("Device cleanup failed");
653 skeldev_get_selftest(const char *key __rte_unused,
663 skeldev_parse_vdev_args(struct rte_vdev_device *vdev)
669 static const char *const args[] = {
670 SKELETON_SELFTEST_ARG,
674 name = rte_vdev_device_name(vdev);
676 params = rte_vdev_device_args(vdev);
677 if (params != NULL && params[0] != '\0') {
678 struct rte_kvargs *kvlist = rte_kvargs_parse(params, args);
682 "Ignoring unsupported params supplied '%s'",
685 int ret = rte_kvargs_process(kvlist,
686 SKELETON_SELFTEST_ARG,
687 skeldev_get_selftest, &selftest);
688 if (ret != 0 || (selftest < 0 || selftest > 1)) {
689 SKELETON_PMD_ERR("%s: Error in parsing args",
691 rte_kvargs_free(kvlist);
692 ret = -1; /* enforce if selftest is invalid */
697 rte_kvargs_free(kvlist);
704 skeleton_rawdev_probe(struct rte_vdev_device *vdev)
707 int selftest = 0, ret = 0;
710 name = rte_vdev_device_name(vdev);
714 /* More than one instance is not supported */
715 if (skeldev_init_once) {
716 SKELETON_PMD_ERR("Multiple instance not supported for %s",
721 SKELETON_PMD_INFO("Init %s on NUMA node %d", name, rte_socket_id());
723 selftest = skeldev_parse_vdev_args(vdev);
724 /* In case of invalid argument, selftest != 1; ignore other values */
726 ret = skeleton_rawdev_create(name, vdev, rte_socket_id());
728 /* In case command line argument for 'selftest' was passed;
729 * if invalid arguments were passed, execution continues but
733 test_rawdev_skeldev(ret);
736 /* Device instance created; Second instance not possible */
737 skeldev_init_once = 1;
739 return ret < 0 ? ret : 0;
743 skeleton_rawdev_remove(struct rte_vdev_device *vdev)
748 name = rte_vdev_device_name(vdev);
752 SKELETON_PMD_INFO("Closing %s on NUMA node %d", name, rte_socket_id());
754 ret = skeleton_rawdev_destroy(name);
756 skeldev_init_once = 0;
761 static struct rte_vdev_driver skeleton_pmd_drv = {
762 .probe = skeleton_rawdev_probe,
763 .remove = skeleton_rawdev_remove
766 RTE_PMD_REGISTER_VDEV(SKELETON_PMD_RAWDEV_NAME, skeleton_pmd_drv);
767 RTE_LOG_REGISTER(skeleton_pmd_logtype, rawdev.skeleton, INFO);