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 #ifdef RTE_LIBRTE_TELEMETRY
33 #include <rte_telemetry.h>
36 #include "rte_rawdev.h"
37 #include "rte_rawdev_pmd.h"
39 /* dynamic log identifier */
40 int librawdev_logtype;
42 static struct rte_rawdev rte_rawdevices[RTE_RAWDEV_MAX_DEVS];
44 struct rte_rawdev *rte_rawdevs = rte_rawdevices;
46 static struct rte_rawdev_global rawdev_globals = {
50 /* Raw device, northbound API implementation */
52 rte_rawdev_count(void)
54 return rawdev_globals.nb_devs;
58 rte_rawdev_get_dev_id(const char *name)
65 for (i = 0; i < rawdev_globals.nb_devs; i++)
66 if ((strcmp(rte_rawdevices[i].name, name)
68 (rte_rawdevices[i].attached ==
75 rte_rawdev_socket_id(uint16_t dev_id)
77 struct rte_rawdev *dev;
79 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
80 dev = &rte_rawdevs[dev_id];
82 return dev->socket_id;
86 rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)
88 struct rte_rawdev *rawdev;
90 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
91 RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL);
93 rawdev = &rte_rawdevs[dev_id];
95 RTE_FUNC_PTR_OR_ERR_RET(*rawdev->dev_ops->dev_info_get, -ENOTSUP);
96 (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private);
100 dev_info->driver_name = rawdev->driver_name;
101 dev_info->device = rawdev->device;
108 rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf)
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);
129 RTE_RDEV_ERR("dev%d dev_configure = %d", dev_id, diag);
137 rte_rawdev_queue_conf_get(uint16_t dev_id,
139 rte_rawdev_obj_t queue_conf)
141 struct rte_rawdev *dev;
143 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
144 dev = &rte_rawdevs[dev_id];
146 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_def_conf, -ENOTSUP);
147 (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf);
152 rte_rawdev_queue_setup(uint16_t dev_id,
154 rte_rawdev_obj_t queue_conf)
156 struct rte_rawdev *dev;
158 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
159 dev = &rte_rawdevs[dev_id];
161 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_setup, -ENOTSUP);
162 return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf);
166 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
168 struct rte_rawdev *dev;
170 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
171 dev = &rte_rawdevs[dev_id];
173 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_release, -ENOTSUP);
174 return (*dev->dev_ops->queue_release)(dev, queue_id);
178 rte_rawdev_queue_count(uint16_t dev_id)
180 struct rte_rawdev *dev;
182 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
183 dev = &rte_rawdevs[dev_id];
185 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_count, -ENOTSUP);
186 return (*dev->dev_ops->queue_count)(dev);
190 rte_rawdev_get_attr(uint16_t dev_id,
191 const char *attr_name,
192 uint64_t *attr_value)
194 struct rte_rawdev *dev;
196 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
197 dev = &rte_rawdevs[dev_id];
199 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_get, -ENOTSUP);
200 return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
204 rte_rawdev_set_attr(uint16_t dev_id,
205 const char *attr_name,
206 const uint64_t attr_value)
208 struct rte_rawdev *dev;
210 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
211 dev = &rte_rawdevs[dev_id];
213 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_set, -ENOTSUP);
214 return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
218 rte_rawdev_enqueue_buffers(uint16_t dev_id,
219 struct rte_rawdev_buf **buffers,
221 rte_rawdev_obj_t context)
223 struct rte_rawdev *dev;
225 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
226 dev = &rte_rawdevs[dev_id];
228 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->enqueue_bufs, -ENOTSUP);
229 return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
233 rte_rawdev_dequeue_buffers(uint16_t dev_id,
234 struct rte_rawdev_buf **buffers,
236 rte_rawdev_obj_t context)
238 struct rte_rawdev *dev;
240 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
241 dev = &rte_rawdevs[dev_id];
243 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dequeue_bufs, -ENOTSUP);
244 return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
248 rte_rawdev_dump(uint16_t dev_id, FILE *f)
250 struct rte_rawdev *dev;
252 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
253 dev = &rte_rawdevs[dev_id];
255 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dump, -ENOTSUP);
256 return (*dev->dev_ops->dump)(dev, f);
260 xstats_get_count(uint16_t dev_id)
262 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
264 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
265 return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
269 rte_rawdev_xstats_names_get(uint16_t dev_id,
270 struct rte_rawdev_xstats_name *xstats_names,
273 const struct rte_rawdev *dev;
274 int cnt_expected_entries;
276 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
278 cnt_expected_entries = xstats_get_count(dev_id);
280 if (xstats_names == NULL || cnt_expected_entries < 0 ||
281 (int)size < cnt_expected_entries || size <= 0)
282 return cnt_expected_entries;
284 dev = &rte_rawdevs[dev_id];
286 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
287 return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
290 /* retrieve rawdev extended statistics */
292 rte_rawdev_xstats_get(uint16_t dev_id,
293 const unsigned int ids[],
297 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
298 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
300 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
301 return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
305 rte_rawdev_xstats_by_name_get(uint16_t dev_id,
309 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
310 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
311 unsigned int temp = -1;
314 *id = (unsigned int)-1;
316 id = &temp; /* driver never gets a NULL value */
318 /* implemented by driver */
319 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
320 return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
324 rte_rawdev_xstats_reset(uint16_t dev_id,
325 const uint32_t ids[], uint32_t nb_ids)
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->xstats_reset, -ENOTSUP);
331 return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
335 rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_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_status_get, -ENOTSUP);
341 return (*dev->dev_ops->firmware_status_get)(dev, status_info);
345 rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_info)
347 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
348 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
350 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_version_get, -ENOTSUP);
351 return (*dev->dev_ops->firmware_version_get)(dev, version_info);
355 rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
357 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
358 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_load)(dev, firmware_image);
368 rte_rawdev_firmware_unload(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->firmware_load, -ENOTSUP);
374 return (*dev->dev_ops->firmware_unload)(dev);
378 rte_rawdev_selftest(uint16_t dev_id)
380 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
381 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
383 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_selftest, -ENOTSUP);
384 return (*dev->dev_ops->dev_selftest)(dev_id);
388 rte_rawdev_start(uint16_t dev_id)
390 struct rte_rawdev *dev;
393 RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
395 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
396 dev = &rte_rawdevs[dev_id];
397 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
399 if (dev->started != 0) {
400 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
405 diag = (*dev->dev_ops->dev_start)(dev);
415 rte_rawdev_stop(uint16_t dev_id)
417 struct rte_rawdev *dev;
419 RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
421 RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
422 dev = &rte_rawdevs[dev_id];
424 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
426 if (dev->started == 0) {
427 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
432 (*dev->dev_ops->dev_stop)(dev);
437 rte_rawdev_close(uint16_t dev_id)
439 struct rte_rawdev *dev;
441 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
442 dev = &rte_rawdevs[dev_id];
444 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
445 /* Device must be stopped before it can be closed */
446 if (dev->started == 1) {
447 RTE_RDEV_ERR("Device %u must be stopped before closing",
452 return (*dev->dev_ops->dev_close)(dev);
456 rte_rawdev_reset(uint16_t dev_id)
458 struct rte_rawdev *dev;
460 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
461 dev = &rte_rawdevs[dev_id];
463 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
464 /* Reset is not dependent on state of the device */
465 return (*dev->dev_ops->dev_reset)(dev);
468 static inline uint8_t
469 rte_rawdev_find_free_device_index(void)
473 for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
474 if (rte_rawdevs[dev_id].attached ==
479 return RTE_RAWDEV_MAX_DEVS;
483 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
485 struct rte_rawdev *rawdev;
488 if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
489 RTE_RDEV_ERR("Event device with name %s already allocated!",
494 dev_id = rte_rawdev_find_free_device_index();
495 if (dev_id == RTE_RAWDEV_MAX_DEVS) {
496 RTE_RDEV_ERR("Reached maximum number of raw devices");
500 rawdev = &rte_rawdevs[dev_id];
502 if (dev_priv_size > 0) {
503 rawdev->dev_private = rte_zmalloc_socket("rawdev private",
507 if (!rawdev->dev_private) {
508 RTE_RDEV_ERR("Unable to allocate memory for rawdev");
513 rawdev->dev_id = dev_id;
514 rawdev->socket_id = socket_id;
516 strlcpy(rawdev->name, name, RTE_RAWDEV_NAME_MAX_LEN);
518 rawdev->attached = RTE_RAWDEV_ATTACHED;
519 rawdev_globals.nb_devs++;
525 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
532 ret = rte_rawdev_close(rawdev->dev_id);
536 rawdev->attached = RTE_RAWDEV_DETACHED;
537 rawdev_globals.nb_devs--;
540 rawdev->socket_id = 0;
541 rawdev->dev_ops = NULL;
542 if (rawdev->dev_private) {
543 rte_free(rawdev->dev_private);
544 rawdev->dev_private = NULL;
550 #ifdef RTE_LIBRTE_TELEMETRY
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,
620 RTE_INIT(librawdev_init_log)
622 librawdev_logtype = rte_log_register("lib.rawdev");
623 if (librawdev_logtype >= 0)
624 rte_log_set_level(librawdev_logtype, RTE_LOG_INFO);
625 #ifdef RTE_LIBRTE_TELEMETRY
626 rte_telemetry_register_cmd("/rawdev/list", handle_dev_list,
627 "Returns list of available rawdev ports. Takes no parameters");
628 rte_telemetry_register_cmd("/rawdev/xstats", handle_dev_xstats,
629 "Returns the xstats for a rawdev port. Parameters: int port_id");