1 /* SPDX-License-Identifier: BSD-3-Clause
13 #include <rte_string_fns.h>
16 #include <rte_common.h>
17 #include <rte_malloc.h>
18 #include <rte_telemetry.h>
20 #include "rte_rawdev.h"
21 #include "rte_rawdev_pmd.h"
23 static struct rte_rawdev rte_rawdevices[RTE_RAWDEV_MAX_DEVS];
25 struct rte_rawdev *rte_rawdevs = rte_rawdevices;
27 static struct rte_rawdev_global rawdev_globals = {
31 /* Raw device, northbound API implementation */
33 rte_rawdev_count(void)
35 return rawdev_globals.nb_devs;
39 rte_rawdev_get_dev_id(const char *name)
46 for (i = 0; i < rawdev_globals.nb_devs; i++)
47 if ((strcmp(rte_rawdevices[i].name, name)
49 (rte_rawdevices[i].attached ==
56 rte_rawdev_socket_id(uint16_t dev_id)
58 struct rte_rawdev *dev;
60 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
61 dev = &rte_rawdevs[dev_id];
63 return dev->socket_id;
67 rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,
68 size_t dev_private_size)
70 struct rte_rawdev *rawdev;
73 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
74 RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL);
76 rawdev = &rte_rawdevs[dev_id];
78 if (dev_info->dev_private != NULL) {
79 RTE_FUNC_PTR_OR_ERR_RET(*rawdev->dev_ops->dev_info_get, -ENOTSUP);
80 ret = (*rawdev->dev_ops->dev_info_get)(rawdev,
81 dev_info->dev_private,
85 dev_info->driver_name = rawdev->driver_name;
86 dev_info->device = rawdev->device;
87 dev_info->socket_id = rawdev->socket_id;
93 rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,
94 size_t dev_private_size)
96 struct rte_rawdev *dev;
99 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
100 RTE_FUNC_PTR_OR_ERR_RET(dev_conf, -EINVAL);
102 dev = &rte_rawdevs[dev_id];
104 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
108 "device %d must be stopped to allow configuration", dev_id);
112 /* Configure the device */
113 diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private,
116 RTE_RDEV_ERR("dev%d dev_configure = %d", dev_id, diag);
124 rte_rawdev_queue_conf_get(uint16_t dev_id,
126 rte_rawdev_obj_t queue_conf,
127 size_t queue_conf_size)
129 struct rte_rawdev *dev;
131 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
132 dev = &rte_rawdevs[dev_id];
134 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_def_conf, -ENOTSUP);
135 return (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf,
140 rte_rawdev_queue_setup(uint16_t dev_id,
142 rte_rawdev_obj_t queue_conf,
143 size_t queue_conf_size)
145 struct rte_rawdev *dev;
147 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
148 dev = &rte_rawdevs[dev_id];
150 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_setup, -ENOTSUP);
151 return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf,
156 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
158 struct rte_rawdev *dev;
160 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
161 dev = &rte_rawdevs[dev_id];
163 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_release, -ENOTSUP);
164 return (*dev->dev_ops->queue_release)(dev, queue_id);
168 rte_rawdev_queue_count(uint16_t dev_id)
170 struct rte_rawdev *dev;
172 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
173 dev = &rte_rawdevs[dev_id];
175 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_count, -ENOTSUP);
176 return (*dev->dev_ops->queue_count)(dev);
180 rte_rawdev_get_attr(uint16_t dev_id,
181 const char *attr_name,
182 uint64_t *attr_value)
184 struct rte_rawdev *dev;
186 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
187 dev = &rte_rawdevs[dev_id];
189 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_get, -ENOTSUP);
190 return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
194 rte_rawdev_set_attr(uint16_t dev_id,
195 const char *attr_name,
196 const uint64_t attr_value)
198 struct rte_rawdev *dev;
200 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
201 dev = &rte_rawdevs[dev_id];
203 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_set, -ENOTSUP);
204 return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
208 rte_rawdev_enqueue_buffers(uint16_t dev_id,
209 struct rte_rawdev_buf **buffers,
211 rte_rawdev_obj_t context)
213 struct rte_rawdev *dev;
215 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
216 dev = &rte_rawdevs[dev_id];
218 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->enqueue_bufs, -ENOTSUP);
219 return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
223 rte_rawdev_dequeue_buffers(uint16_t dev_id,
224 struct rte_rawdev_buf **buffers,
226 rte_rawdev_obj_t context)
228 struct rte_rawdev *dev;
230 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
231 dev = &rte_rawdevs[dev_id];
233 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dequeue_bufs, -ENOTSUP);
234 return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
238 rte_rawdev_dump(uint16_t dev_id, FILE *f)
240 struct rte_rawdev *dev;
242 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
243 dev = &rte_rawdevs[dev_id];
245 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dump, -ENOTSUP);
246 return (*dev->dev_ops->dump)(dev, f);
250 xstats_get_count(uint16_t dev_id)
252 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
254 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
255 return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
259 rte_rawdev_xstats_names_get(uint16_t dev_id,
260 struct rte_rawdev_xstats_name *xstats_names,
263 const struct rte_rawdev *dev;
264 int cnt_expected_entries;
266 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
268 cnt_expected_entries = xstats_get_count(dev_id);
270 if (xstats_names == NULL || cnt_expected_entries < 0 ||
271 (int)size < cnt_expected_entries || size <= 0)
272 return cnt_expected_entries;
274 dev = &rte_rawdevs[dev_id];
276 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
277 return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
280 /* retrieve rawdev extended statistics */
282 rte_rawdev_xstats_get(uint16_t dev_id,
283 const unsigned int ids[],
287 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
288 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
290 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
291 return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
295 rte_rawdev_xstats_by_name_get(uint16_t dev_id,
299 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
300 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
301 unsigned int temp = -1;
304 *id = (unsigned int)-1;
306 id = &temp; /* driver never gets a NULL value */
308 /* implemented by driver */
309 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
310 return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
314 rte_rawdev_xstats_reset(uint16_t dev_id,
315 const uint32_t ids[], uint32_t nb_ids)
317 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
318 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
320 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_reset, -ENOTSUP);
321 return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
325 rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_info)
327 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
328 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
330 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_status_get, -ENOTSUP);
331 return (*dev->dev_ops->firmware_status_get)(dev, status_info);
335 rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_info)
337 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
338 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
340 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_version_get, -ENOTSUP);
341 return (*dev->dev_ops->firmware_version_get)(dev, version_info);
345 rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
347 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
348 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
353 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
354 return (*dev->dev_ops->firmware_load)(dev, firmware_image);
358 rte_rawdev_firmware_unload(uint16_t dev_id)
360 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
361 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
363 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
364 return (*dev->dev_ops->firmware_unload)(dev);
368 rte_rawdev_selftest(uint16_t dev_id)
370 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
371 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
373 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_selftest, -ENOTSUP);
374 return (*dev->dev_ops->dev_selftest)(dev_id);
378 rte_rawdev_start(uint16_t dev_id)
380 struct rte_rawdev *dev;
383 RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
385 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
386 dev = &rte_rawdevs[dev_id];
387 if (dev->started != 0) {
388 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
393 if (dev->dev_ops->dev_start == NULL)
396 diag = (*dev->dev_ops->dev_start)(dev);
406 rte_rawdev_stop(uint16_t dev_id)
408 struct rte_rawdev *dev;
410 RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
412 RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
413 dev = &rte_rawdevs[dev_id];
415 if (dev->started == 0) {
416 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
421 if (dev->dev_ops->dev_stop == NULL)
424 (*dev->dev_ops->dev_stop)(dev);
431 rte_rawdev_close(uint16_t dev_id)
433 struct rte_rawdev *dev;
435 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
436 dev = &rte_rawdevs[dev_id];
438 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
439 /* Device must be stopped before it can be closed */
440 if (dev->started == 1) {
441 RTE_RDEV_ERR("Device %u must be stopped before closing",
446 return (*dev->dev_ops->dev_close)(dev);
450 rte_rawdev_reset(uint16_t dev_id)
452 struct rte_rawdev *dev;
454 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
455 dev = &rte_rawdevs[dev_id];
457 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
458 /* Reset is not dependent on state of the device */
459 return (*dev->dev_ops->dev_reset)(dev);
462 static inline uint8_t
463 rte_rawdev_find_free_device_index(void)
467 for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
468 if (rte_rawdevs[dev_id].attached ==
473 return RTE_RAWDEV_MAX_DEVS;
477 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
479 struct rte_rawdev *rawdev;
482 if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
483 RTE_RDEV_ERR("Event device with name %s already allocated!",
488 dev_id = rte_rawdev_find_free_device_index();
489 if (dev_id == RTE_RAWDEV_MAX_DEVS) {
490 RTE_RDEV_ERR("Reached maximum number of raw devices");
494 rawdev = &rte_rawdevs[dev_id];
496 if (dev_priv_size > 0) {
497 rawdev->dev_private = rte_zmalloc_socket("rawdev private",
501 if (!rawdev->dev_private) {
502 RTE_RDEV_ERR("Unable to allocate memory for rawdev");
507 rawdev->dev_id = dev_id;
508 rawdev->socket_id = socket_id;
510 strlcpy(rawdev->name, name, RTE_RAWDEV_NAME_MAX_LEN);
512 rawdev->attached = RTE_RAWDEV_ATTACHED;
513 rawdev_globals.nb_devs++;
519 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
526 ret = rte_rawdev_close(rawdev->dev_id);
530 rawdev->attached = RTE_RAWDEV_DETACHED;
531 rawdev_globals.nb_devs--;
534 rawdev->socket_id = 0;
535 rawdev->dev_ops = NULL;
536 if (rawdev->dev_private) {
537 rte_free(rawdev->dev_private);
538 rawdev->dev_private = NULL;
545 handle_dev_list(const char *cmd __rte_unused,
546 const char *params __rte_unused,
547 struct rte_tel_data *d)
551 rte_tel_data_start_array(d, RTE_TEL_INT_VAL);
552 for (i = 0; i < rawdev_globals.nb_devs; i++)
553 if (rte_rawdevices[i].attached == RTE_RAWDEV_ATTACHED)
554 rte_tel_data_add_array_int(d, i);
559 handle_dev_xstats(const char *cmd __rte_unused,
561 struct rte_tel_data *d)
563 uint64_t *rawdev_xstats;
564 struct rte_rawdev_xstats_name *xstat_names;
565 int dev_id, num_xstats, i, ret;
569 if (params == NULL || strlen(params) == 0 || !isdigit(*params))
572 dev_id = strtoul(params, &end_param, 0);
573 if (*end_param != '\0')
575 "Extra parameters passed to rawdev telemetry command, ignoring");
576 if (!rte_rawdev_pmd_is_valid_dev(dev_id))
579 num_xstats = xstats_get_count(dev_id);
583 /* use one malloc for names, stats and ids */
584 rawdev_xstats = malloc((sizeof(uint64_t) +
585 sizeof(struct rte_rawdev_xstats_name) +
586 sizeof(unsigned int)) * num_xstats);
587 if (rawdev_xstats == NULL)
589 xstat_names = (void *)&rawdev_xstats[num_xstats];
590 ids = (void *)&xstat_names[num_xstats];
592 ret = rte_rawdev_xstats_names_get(dev_id, xstat_names, num_xstats);
593 if (ret < 0 || ret > num_xstats) {
598 for (i = 0; i < num_xstats; i++)
601 ret = rte_rawdev_xstats_get(dev_id, ids, rawdev_xstats, num_xstats);
602 if (ret < 0 || ret > num_xstats) {
607 rte_tel_data_start_dict(d);
608 for (i = 0; i < num_xstats; i++)
609 rte_tel_data_add_dict_u64(d, xstat_names[i].name,
616 RTE_LOG_REGISTER_DEFAULT(librawdev_logtype, INFO);
618 RTE_INIT(librawdev_init_telemetry)
620 rte_telemetry_register_cmd("/rawdev/list", handle_dev_list,
621 "Returns list of available rawdev ports. Takes no parameters");
622 rte_telemetry_register_cmd("/rawdev/xstats", handle_dev_xstats,
623 "Returns the xstats for a rawdev port. Parameters: int port_id");