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)
109 struct rte_rawdev *dev;
112 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
113 RTE_FUNC_PTR_OR_ERR_RET(dev_conf, -EINVAL);
115 dev = &rte_rawdevs[dev_id];
117 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
121 "device %d must be stopped to allow configuration", dev_id);
125 /* Configure the device */
126 diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private);
128 RTE_RDEV_ERR("dev%d dev_configure = %d", dev_id, diag);
136 rte_rawdev_queue_conf_get(uint16_t dev_id,
138 rte_rawdev_obj_t queue_conf)
140 struct rte_rawdev *dev;
142 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
143 dev = &rte_rawdevs[dev_id];
145 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_def_conf, -ENOTSUP);
146 (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf);
151 rte_rawdev_queue_setup(uint16_t dev_id,
153 rte_rawdev_obj_t queue_conf)
155 struct rte_rawdev *dev;
157 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
158 dev = &rte_rawdevs[dev_id];
160 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_setup, -ENOTSUP);
161 return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf);
165 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
167 struct rte_rawdev *dev;
169 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
170 dev = &rte_rawdevs[dev_id];
172 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_release, -ENOTSUP);
173 return (*dev->dev_ops->queue_release)(dev, queue_id);
177 rte_rawdev_queue_count(uint16_t dev_id)
179 struct rte_rawdev *dev;
181 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
182 dev = &rte_rawdevs[dev_id];
184 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_count, -ENOTSUP);
185 return (*dev->dev_ops->queue_count)(dev);
189 rte_rawdev_get_attr(uint16_t dev_id,
190 const char *attr_name,
191 uint64_t *attr_value)
193 struct rte_rawdev *dev;
195 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
196 dev = &rte_rawdevs[dev_id];
198 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_get, -ENOTSUP);
199 return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
203 rte_rawdev_set_attr(uint16_t dev_id,
204 const char *attr_name,
205 const uint64_t attr_value)
207 struct rte_rawdev *dev;
209 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
210 dev = &rte_rawdevs[dev_id];
212 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_set, -ENOTSUP);
213 return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
217 rte_rawdev_enqueue_buffers(uint16_t dev_id,
218 struct rte_rawdev_buf **buffers,
220 rte_rawdev_obj_t context)
222 struct rte_rawdev *dev;
224 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
225 dev = &rte_rawdevs[dev_id];
227 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->enqueue_bufs, -ENOTSUP);
228 return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
232 rte_rawdev_dequeue_buffers(uint16_t dev_id,
233 struct rte_rawdev_buf **buffers,
235 rte_rawdev_obj_t context)
237 struct rte_rawdev *dev;
239 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
240 dev = &rte_rawdevs[dev_id];
242 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dequeue_bufs, -ENOTSUP);
243 return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
247 rte_rawdev_dump(uint16_t dev_id, FILE *f)
249 struct rte_rawdev *dev;
251 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
252 dev = &rte_rawdevs[dev_id];
254 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dump, -ENOTSUP);
255 return (*dev->dev_ops->dump)(dev, f);
259 xstats_get_count(uint16_t dev_id)
261 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
263 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
264 return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
268 rte_rawdev_xstats_names_get(uint16_t dev_id,
269 struct rte_rawdev_xstats_name *xstats_names,
272 const struct rte_rawdev *dev;
273 int cnt_expected_entries;
275 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
277 cnt_expected_entries = xstats_get_count(dev_id);
279 if (xstats_names == NULL || cnt_expected_entries < 0 ||
280 (int)size < cnt_expected_entries || size <= 0)
281 return cnt_expected_entries;
283 dev = &rte_rawdevs[dev_id];
285 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
286 return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
289 /* retrieve rawdev extended statistics */
291 rte_rawdev_xstats_get(uint16_t dev_id,
292 const unsigned int ids[],
296 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
297 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
299 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
300 return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
304 rte_rawdev_xstats_by_name_get(uint16_t dev_id,
308 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
309 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
310 unsigned int temp = -1;
313 *id = (unsigned int)-1;
315 id = &temp; /* driver never gets a NULL value */
317 /* implemented by driver */
318 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
319 return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
323 rte_rawdev_xstats_reset(uint16_t dev_id,
324 const uint32_t ids[], uint32_t nb_ids)
326 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
327 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
329 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_reset, -ENOTSUP);
330 return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
334 rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_info)
336 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
337 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
339 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_status_get, -ENOTSUP);
340 return (*dev->dev_ops->firmware_status_get)(dev, status_info);
344 rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_info)
346 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
347 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
349 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_version_get, -ENOTSUP);
350 return (*dev->dev_ops->firmware_version_get)(dev, version_info);
354 rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
356 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
357 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
362 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
363 return (*dev->dev_ops->firmware_load)(dev, firmware_image);
367 rte_rawdev_firmware_unload(uint16_t dev_id)
369 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
370 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
372 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
373 return (*dev->dev_ops->firmware_unload)(dev);
377 rte_rawdev_selftest(uint16_t dev_id)
379 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
380 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
382 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_selftest, -ENOTSUP);
383 return (*dev->dev_ops->dev_selftest)(dev_id);
387 rte_rawdev_start(uint16_t dev_id)
389 struct rte_rawdev *dev;
392 RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
394 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
395 dev = &rte_rawdevs[dev_id];
396 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
398 if (dev->started != 0) {
399 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
404 diag = (*dev->dev_ops->dev_start)(dev);
414 rte_rawdev_stop(uint16_t dev_id)
416 struct rte_rawdev *dev;
418 RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
420 RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
421 dev = &rte_rawdevs[dev_id];
423 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
425 if (dev->started == 0) {
426 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
431 (*dev->dev_ops->dev_stop)(dev);
436 rte_rawdev_close(uint16_t dev_id)
438 struct rte_rawdev *dev;
440 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
441 dev = &rte_rawdevs[dev_id];
443 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
444 /* Device must be stopped before it can be closed */
445 if (dev->started == 1) {
446 RTE_RDEV_ERR("Device %u must be stopped before closing",
451 return (*dev->dev_ops->dev_close)(dev);
455 rte_rawdev_reset(uint16_t dev_id)
457 struct rte_rawdev *dev;
459 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
460 dev = &rte_rawdevs[dev_id];
462 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
463 /* Reset is not dependent on state of the device */
464 return (*dev->dev_ops->dev_reset)(dev);
467 static inline uint8_t
468 rte_rawdev_find_free_device_index(void)
472 for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
473 if (rte_rawdevs[dev_id].attached ==
478 return RTE_RAWDEV_MAX_DEVS;
482 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
484 struct rte_rawdev *rawdev;
487 if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
488 RTE_RDEV_ERR("Event device with name %s already allocated!",
493 dev_id = rte_rawdev_find_free_device_index();
494 if (dev_id == RTE_RAWDEV_MAX_DEVS) {
495 RTE_RDEV_ERR("Reached maximum number of raw devices");
499 rawdev = &rte_rawdevs[dev_id];
501 if (dev_priv_size > 0) {
502 rawdev->dev_private = rte_zmalloc_socket("rawdev private",
506 if (!rawdev->dev_private) {
507 RTE_RDEV_ERR("Unable to allocate memory for rawdev");
512 rawdev->dev_id = dev_id;
513 rawdev->socket_id = socket_id;
515 strlcpy(rawdev->name, name, RTE_RAWDEV_NAME_MAX_LEN);
517 rawdev->attached = RTE_RAWDEV_ATTACHED;
518 rawdev_globals.nb_devs++;
524 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
531 ret = rte_rawdev_close(rawdev->dev_id);
535 rawdev->attached = RTE_RAWDEV_DETACHED;
536 rawdev_globals.nb_devs--;
539 rawdev->socket_id = 0;
540 rawdev->dev_ops = NULL;
541 if (rawdev->dev_private) {
542 rte_free(rawdev->dev_private);
543 rawdev->dev_private = NULL;
550 handle_dev_list(const char *cmd __rte_unused,
551 const char *params __rte_unused,
552 struct rte_tel_data *d)
556 rte_tel_data_start_array(d, RTE_TEL_INT_VAL);
557 for (i = 0; i < rawdev_globals.nb_devs; i++)
558 if (rte_rawdevices[i].attached == RTE_RAWDEV_ATTACHED)
559 rte_tel_data_add_array_int(d, i);
564 handle_dev_xstats(const char *cmd __rte_unused,
566 struct rte_tel_data *d)
568 uint64_t *rawdev_xstats;
569 struct rte_rawdev_xstats_name *xstat_names;
570 int dev_id, num_xstats, i, ret;
573 if (params == NULL || strlen(params) == 0 || !isdigit(*params))
576 dev_id = atoi(params);
577 if (!rte_rawdev_pmd_is_valid_dev(dev_id))
580 num_xstats = xstats_get_count(dev_id);
584 /* use one malloc for names, stats and ids */
585 rawdev_xstats = malloc((sizeof(uint64_t) +
586 sizeof(struct rte_rawdev_xstats_name) +
587 sizeof(unsigned int)) * num_xstats);
588 if (rawdev_xstats == NULL)
590 xstat_names = (void *)&rawdev_xstats[num_xstats];
591 ids = (void *)&xstat_names[num_xstats];
593 ret = rte_rawdev_xstats_names_get(dev_id, xstat_names, num_xstats);
594 if (ret < 0 || ret > num_xstats) {
599 for (i = 0; i < num_xstats; i++)
602 ret = rte_rawdev_xstats_get(dev_id, ids, rawdev_xstats, num_xstats);
603 if (ret < 0 || ret > num_xstats) {
608 rte_tel_data_start_dict(d);
609 for (i = 0; i < num_xstats; i++)
610 rte_tel_data_add_dict_u64(d, xstat_names[i].name,
617 RTE_LOG_REGISTER(librawdev_logtype, lib.rawdev, INFO);
619 RTE_INIT(librawdev_init_telemetry)
621 rte_telemetry_register_cmd("/rawdev/list", handle_dev_list,
622 "Returns list of available rawdev ports. Takes no parameters");
623 rte_telemetry_register_cmd("/rawdev/xstats", handle_dev_xstats,
624 "Returns the xstats for a rawdev port. Parameters: int port_id");