1 /* SPDX-License-Identifier: BSD-3-Clause
13 #include <sys/types.h>
14 #include <sys/queue.h>
16 #include <rte_string_fns.h>
17 #include <rte_byteorder.h>
19 #include <rte_debug.h>
21 #include <rte_memory.h>
22 #include <rte_memcpy.h>
23 #include <rte_memzone.h>
25 #include <rte_per_lcore.h>
26 #include <rte_lcore.h>
27 #include <rte_atomic.h>
28 #include <rte_branch_prediction.h>
29 #include <rte_common.h>
30 #include <rte_malloc.h>
31 #include <rte_errno.h>
32 #include <rte_telemetry.h>
34 #include "rte_rawdev.h"
35 #include "rte_rawdev_pmd.h"
37 static struct rte_rawdev rte_rawdevices[RTE_RAWDEV_MAX_DEVS];
39 struct rte_rawdev *rte_rawdevs = rte_rawdevices;
41 static struct rte_rawdev_global rawdev_globals = {
45 /* Raw device, northbound API implementation */
47 rte_rawdev_count(void)
49 return rawdev_globals.nb_devs;
53 rte_rawdev_get_dev_id(const char *name)
60 for (i = 0; i < rawdev_globals.nb_devs; i++)
61 if ((strcmp(rte_rawdevices[i].name, name)
63 (rte_rawdevices[i].attached ==
70 rte_rawdev_socket_id(uint16_t dev_id)
72 struct rte_rawdev *dev;
74 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
75 dev = &rte_rawdevs[dev_id];
77 return dev->socket_id;
81 rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,
82 size_t dev_private_size)
84 struct rte_rawdev *rawdev;
87 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
88 RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL);
90 rawdev = &rte_rawdevs[dev_id];
92 if (dev_info->dev_private != NULL) {
93 RTE_FUNC_PTR_OR_ERR_RET(*rawdev->dev_ops->dev_info_get, -ENOTSUP);
94 ret = (*rawdev->dev_ops->dev_info_get)(rawdev,
95 dev_info->dev_private,
99 dev_info->driver_name = rawdev->driver_name;
100 dev_info->device = rawdev->device;
101 dev_info->socket_id = rawdev->socket_id;
107 rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,
108 size_t dev_private_size)
110 struct rte_rawdev *dev;
113 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
114 RTE_FUNC_PTR_OR_ERR_RET(dev_conf, -EINVAL);
116 dev = &rte_rawdevs[dev_id];
118 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
122 "device %d must be stopped to allow configuration", dev_id);
126 /* Configure the device */
127 diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private,
130 RTE_RDEV_ERR("dev%d dev_configure = %d", dev_id, diag);
138 rte_rawdev_queue_conf_get(uint16_t dev_id,
140 rte_rawdev_obj_t queue_conf)
142 struct rte_rawdev *dev;
144 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
145 dev = &rte_rawdevs[dev_id];
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);
153 rte_rawdev_queue_setup(uint16_t dev_id,
155 rte_rawdev_obj_t queue_conf)
157 struct rte_rawdev *dev;
159 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
160 dev = &rte_rawdevs[dev_id];
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);
167 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
169 struct rte_rawdev *dev;
171 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
172 dev = &rte_rawdevs[dev_id];
174 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_release, -ENOTSUP);
175 return (*dev->dev_ops->queue_release)(dev, queue_id);
179 rte_rawdev_queue_count(uint16_t dev_id)
181 struct rte_rawdev *dev;
183 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
184 dev = &rte_rawdevs[dev_id];
186 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_count, -ENOTSUP);
187 return (*dev->dev_ops->queue_count)(dev);
191 rte_rawdev_get_attr(uint16_t dev_id,
192 const char *attr_name,
193 uint64_t *attr_value)
195 struct rte_rawdev *dev;
197 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
198 dev = &rte_rawdevs[dev_id];
200 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_get, -ENOTSUP);
201 return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
205 rte_rawdev_set_attr(uint16_t dev_id,
206 const char *attr_name,
207 const uint64_t attr_value)
209 struct rte_rawdev *dev;
211 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
212 dev = &rte_rawdevs[dev_id];
214 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_set, -ENOTSUP);
215 return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
219 rte_rawdev_enqueue_buffers(uint16_t dev_id,
220 struct rte_rawdev_buf **buffers,
222 rte_rawdev_obj_t context)
224 struct rte_rawdev *dev;
226 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
227 dev = &rte_rawdevs[dev_id];
229 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->enqueue_bufs, -ENOTSUP);
230 return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
234 rte_rawdev_dequeue_buffers(uint16_t dev_id,
235 struct rte_rawdev_buf **buffers,
237 rte_rawdev_obj_t context)
239 struct rte_rawdev *dev;
241 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
242 dev = &rte_rawdevs[dev_id];
244 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dequeue_bufs, -ENOTSUP);
245 return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
249 rte_rawdev_dump(uint16_t dev_id, FILE *f)
251 struct rte_rawdev *dev;
253 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
254 dev = &rte_rawdevs[dev_id];
256 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dump, -ENOTSUP);
257 return (*dev->dev_ops->dump)(dev, f);
261 xstats_get_count(uint16_t dev_id)
263 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
265 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
266 return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
270 rte_rawdev_xstats_names_get(uint16_t dev_id,
271 struct rte_rawdev_xstats_name *xstats_names,
274 const struct rte_rawdev *dev;
275 int cnt_expected_entries;
277 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
279 cnt_expected_entries = xstats_get_count(dev_id);
281 if (xstats_names == NULL || cnt_expected_entries < 0 ||
282 (int)size < cnt_expected_entries || size <= 0)
283 return cnt_expected_entries;
285 dev = &rte_rawdevs[dev_id];
287 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
288 return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
291 /* retrieve rawdev extended statistics */
293 rte_rawdev_xstats_get(uint16_t dev_id,
294 const unsigned int ids[],
298 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
299 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
301 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
302 return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
306 rte_rawdev_xstats_by_name_get(uint16_t dev_id,
310 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
311 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
312 unsigned int temp = -1;
315 *id = (unsigned int)-1;
317 id = &temp; /* driver never gets a NULL value */
319 /* implemented by driver */
320 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
321 return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
325 rte_rawdev_xstats_reset(uint16_t dev_id,
326 const uint32_t ids[], uint32_t nb_ids)
328 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
329 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
331 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_reset, -ENOTSUP);
332 return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
336 rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_info)
338 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
339 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
341 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_status_get, -ENOTSUP);
342 return (*dev->dev_ops->firmware_status_get)(dev, status_info);
346 rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_info)
348 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
349 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
351 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_version_get, -ENOTSUP);
352 return (*dev->dev_ops->firmware_version_get)(dev, version_info);
356 rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
358 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
359 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
364 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
365 return (*dev->dev_ops->firmware_load)(dev, firmware_image);
369 rte_rawdev_firmware_unload(uint16_t dev_id)
371 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
372 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
374 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
375 return (*dev->dev_ops->firmware_unload)(dev);
379 rte_rawdev_selftest(uint16_t dev_id)
381 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
382 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
384 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_selftest, -ENOTSUP);
385 return (*dev->dev_ops->dev_selftest)(dev_id);
389 rte_rawdev_start(uint16_t dev_id)
391 struct rte_rawdev *dev;
394 RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
396 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
397 dev = &rte_rawdevs[dev_id];
398 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
400 if (dev->started != 0) {
401 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
406 diag = (*dev->dev_ops->dev_start)(dev);
416 rte_rawdev_stop(uint16_t dev_id)
418 struct rte_rawdev *dev;
420 RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
422 RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
423 dev = &rte_rawdevs[dev_id];
425 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
427 if (dev->started == 0) {
428 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
433 (*dev->dev_ops->dev_stop)(dev);
438 rte_rawdev_close(uint16_t dev_id)
440 struct rte_rawdev *dev;
442 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
443 dev = &rte_rawdevs[dev_id];
445 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
446 /* Device must be stopped before it can be closed */
447 if (dev->started == 1) {
448 RTE_RDEV_ERR("Device %u must be stopped before closing",
453 return (*dev->dev_ops->dev_close)(dev);
457 rte_rawdev_reset(uint16_t dev_id)
459 struct rte_rawdev *dev;
461 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
462 dev = &rte_rawdevs[dev_id];
464 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
465 /* Reset is not dependent on state of the device */
466 return (*dev->dev_ops->dev_reset)(dev);
469 static inline uint8_t
470 rte_rawdev_find_free_device_index(void)
474 for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
475 if (rte_rawdevs[dev_id].attached ==
480 return RTE_RAWDEV_MAX_DEVS;
484 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
486 struct rte_rawdev *rawdev;
489 if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
490 RTE_RDEV_ERR("Event device with name %s already allocated!",
495 dev_id = rte_rawdev_find_free_device_index();
496 if (dev_id == RTE_RAWDEV_MAX_DEVS) {
497 RTE_RDEV_ERR("Reached maximum number of raw devices");
501 rawdev = &rte_rawdevs[dev_id];
503 if (dev_priv_size > 0) {
504 rawdev->dev_private = rte_zmalloc_socket("rawdev private",
508 if (!rawdev->dev_private) {
509 RTE_RDEV_ERR("Unable to allocate memory for rawdev");
514 rawdev->dev_id = dev_id;
515 rawdev->socket_id = socket_id;
517 strlcpy(rawdev->name, name, RTE_RAWDEV_NAME_MAX_LEN);
519 rawdev->attached = RTE_RAWDEV_ATTACHED;
520 rawdev_globals.nb_devs++;
526 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
533 ret = rte_rawdev_close(rawdev->dev_id);
537 rawdev->attached = RTE_RAWDEV_DETACHED;
538 rawdev_globals.nb_devs--;
541 rawdev->socket_id = 0;
542 rawdev->dev_ops = NULL;
543 if (rawdev->dev_private) {
544 rte_free(rawdev->dev_private);
545 rawdev->dev_private = NULL;
552 handle_dev_list(const char *cmd __rte_unused,
553 const char *params __rte_unused,
554 struct rte_tel_data *d)
558 rte_tel_data_start_array(d, RTE_TEL_INT_VAL);
559 for (i = 0; i < rawdev_globals.nb_devs; i++)
560 if (rte_rawdevices[i].attached == RTE_RAWDEV_ATTACHED)
561 rte_tel_data_add_array_int(d, i);
566 handle_dev_xstats(const char *cmd __rte_unused,
568 struct rte_tel_data *d)
570 uint64_t *rawdev_xstats;
571 struct rte_rawdev_xstats_name *xstat_names;
572 int dev_id, num_xstats, i, ret;
575 if (params == NULL || strlen(params) == 0 || !isdigit(*params))
578 dev_id = atoi(params);
579 if (!rte_rawdev_pmd_is_valid_dev(dev_id))
582 num_xstats = xstats_get_count(dev_id);
586 /* use one malloc for names, stats and ids */
587 rawdev_xstats = malloc((sizeof(uint64_t) +
588 sizeof(struct rte_rawdev_xstats_name) +
589 sizeof(unsigned int)) * num_xstats);
590 if (rawdev_xstats == NULL)
592 xstat_names = (void *)&rawdev_xstats[num_xstats];
593 ids = (void *)&xstat_names[num_xstats];
595 ret = rte_rawdev_xstats_names_get(dev_id, xstat_names, num_xstats);
596 if (ret < 0 || ret > num_xstats) {
601 for (i = 0; i < num_xstats; i++)
604 ret = rte_rawdev_xstats_get(dev_id, ids, rawdev_xstats, num_xstats);
605 if (ret < 0 || ret > num_xstats) {
610 rte_tel_data_start_dict(d);
611 for (i = 0; i < num_xstats; i++)
612 rte_tel_data_add_dict_u64(d, xstat_names[i].name,
619 RTE_LOG_REGISTER(librawdev_logtype, lib.rawdev, INFO);
621 RTE_INIT(librawdev_init_telemetry)
623 rte_telemetry_register_cmd("/rawdev/list", handle_dev_list,
624 "Returns list of available rawdev ports. Takes no parameters");
625 rte_telemetry_register_cmd("/rawdev/xstats", handle_dev_xstats,
626 "Returns the xstats for a rawdev port. Parameters: int port_id");