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)
83 struct rte_rawdev *rawdev;
85 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
86 RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL);
88 rawdev = &rte_rawdevs[dev_id];
90 if (dev_info->dev_private != NULL) {
91 RTE_FUNC_PTR_OR_ERR_RET(*rawdev->dev_ops->dev_info_get, -ENOTSUP);
92 (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private);
97 dev_info->driver_name = rawdev->driver_name;
98 dev_info->device = rawdev->device;
105 rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf)
107 struct rte_rawdev *dev;
110 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
111 RTE_FUNC_PTR_OR_ERR_RET(dev_conf, -EINVAL);
113 dev = &rte_rawdevs[dev_id];
115 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
119 "device %d must be stopped to allow configuration", dev_id);
123 /* Configure the device */
124 diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private);
126 RTE_RDEV_ERR("dev%d dev_configure = %d", dev_id, diag);
134 rte_rawdev_queue_conf_get(uint16_t dev_id,
136 rte_rawdev_obj_t queue_conf)
138 struct rte_rawdev *dev;
140 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
141 dev = &rte_rawdevs[dev_id];
143 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_def_conf, -ENOTSUP);
144 (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf);
149 rte_rawdev_queue_setup(uint16_t dev_id,
151 rte_rawdev_obj_t queue_conf)
153 struct rte_rawdev *dev;
155 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
156 dev = &rte_rawdevs[dev_id];
158 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_setup, -ENOTSUP);
159 return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf);
163 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
165 struct rte_rawdev *dev;
167 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
168 dev = &rte_rawdevs[dev_id];
170 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_release, -ENOTSUP);
171 return (*dev->dev_ops->queue_release)(dev, queue_id);
175 rte_rawdev_queue_count(uint16_t dev_id)
177 struct rte_rawdev *dev;
179 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
180 dev = &rte_rawdevs[dev_id];
182 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_count, -ENOTSUP);
183 return (*dev->dev_ops->queue_count)(dev);
187 rte_rawdev_get_attr(uint16_t dev_id,
188 const char *attr_name,
189 uint64_t *attr_value)
191 struct rte_rawdev *dev;
193 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
194 dev = &rte_rawdevs[dev_id];
196 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_get, -ENOTSUP);
197 return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
201 rte_rawdev_set_attr(uint16_t dev_id,
202 const char *attr_name,
203 const uint64_t attr_value)
205 struct rte_rawdev *dev;
207 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
208 dev = &rte_rawdevs[dev_id];
210 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_set, -ENOTSUP);
211 return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
215 rte_rawdev_enqueue_buffers(uint16_t dev_id,
216 struct rte_rawdev_buf **buffers,
218 rte_rawdev_obj_t context)
220 struct rte_rawdev *dev;
222 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
223 dev = &rte_rawdevs[dev_id];
225 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->enqueue_bufs, -ENOTSUP);
226 return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
230 rte_rawdev_dequeue_buffers(uint16_t dev_id,
231 struct rte_rawdev_buf **buffers,
233 rte_rawdev_obj_t context)
235 struct rte_rawdev *dev;
237 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
238 dev = &rte_rawdevs[dev_id];
240 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dequeue_bufs, -ENOTSUP);
241 return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
245 rte_rawdev_dump(uint16_t dev_id, FILE *f)
247 struct rte_rawdev *dev;
249 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
250 dev = &rte_rawdevs[dev_id];
252 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dump, -ENOTSUP);
253 return (*dev->dev_ops->dump)(dev, f);
257 xstats_get_count(uint16_t dev_id)
259 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
261 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
262 return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
266 rte_rawdev_xstats_names_get(uint16_t dev_id,
267 struct rte_rawdev_xstats_name *xstats_names,
270 const struct rte_rawdev *dev;
271 int cnt_expected_entries;
273 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
275 cnt_expected_entries = xstats_get_count(dev_id);
277 if (xstats_names == NULL || cnt_expected_entries < 0 ||
278 (int)size < cnt_expected_entries || size <= 0)
279 return cnt_expected_entries;
281 dev = &rte_rawdevs[dev_id];
283 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
284 return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
287 /* retrieve rawdev extended statistics */
289 rte_rawdev_xstats_get(uint16_t dev_id,
290 const unsigned int ids[],
294 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
295 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
297 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
298 return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
302 rte_rawdev_xstats_by_name_get(uint16_t dev_id,
306 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
307 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
308 unsigned int temp = -1;
311 *id = (unsigned int)-1;
313 id = &temp; /* driver never gets a NULL value */
315 /* implemented by driver */
316 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
317 return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
321 rte_rawdev_xstats_reset(uint16_t dev_id,
322 const uint32_t ids[], uint32_t nb_ids)
324 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
325 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
327 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_reset, -ENOTSUP);
328 return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
332 rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_info)
334 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
335 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
337 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_status_get, -ENOTSUP);
338 return (*dev->dev_ops->firmware_status_get)(dev, status_info);
342 rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_info)
344 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
345 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
347 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_version_get, -ENOTSUP);
348 return (*dev->dev_ops->firmware_version_get)(dev, version_info);
352 rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
354 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
355 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
360 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
361 return (*dev->dev_ops->firmware_load)(dev, firmware_image);
365 rte_rawdev_firmware_unload(uint16_t dev_id)
367 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
368 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
370 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
371 return (*dev->dev_ops->firmware_unload)(dev);
375 rte_rawdev_selftest(uint16_t dev_id)
377 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
378 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
380 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_selftest, -ENOTSUP);
381 return (*dev->dev_ops->dev_selftest)(dev_id);
385 rte_rawdev_start(uint16_t dev_id)
387 struct rte_rawdev *dev;
390 RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
392 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
393 dev = &rte_rawdevs[dev_id];
394 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
396 if (dev->started != 0) {
397 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
402 diag = (*dev->dev_ops->dev_start)(dev);
412 rte_rawdev_stop(uint16_t dev_id)
414 struct rte_rawdev *dev;
416 RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
418 RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
419 dev = &rte_rawdevs[dev_id];
421 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
423 if (dev->started == 0) {
424 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
429 (*dev->dev_ops->dev_stop)(dev);
434 rte_rawdev_close(uint16_t dev_id)
436 struct rte_rawdev *dev;
438 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
439 dev = &rte_rawdevs[dev_id];
441 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
442 /* Device must be stopped before it can be closed */
443 if (dev->started == 1) {
444 RTE_RDEV_ERR("Device %u must be stopped before closing",
449 return (*dev->dev_ops->dev_close)(dev);
453 rte_rawdev_reset(uint16_t dev_id)
455 struct rte_rawdev *dev;
457 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
458 dev = &rte_rawdevs[dev_id];
460 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
461 /* Reset is not dependent on state of the device */
462 return (*dev->dev_ops->dev_reset)(dev);
465 static inline uint8_t
466 rte_rawdev_find_free_device_index(void)
470 for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
471 if (rte_rawdevs[dev_id].attached ==
476 return RTE_RAWDEV_MAX_DEVS;
480 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
482 struct rte_rawdev *rawdev;
485 if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
486 RTE_RDEV_ERR("Event device with name %s already allocated!",
491 dev_id = rte_rawdev_find_free_device_index();
492 if (dev_id == RTE_RAWDEV_MAX_DEVS) {
493 RTE_RDEV_ERR("Reached maximum number of raw devices");
497 rawdev = &rte_rawdevs[dev_id];
499 if (dev_priv_size > 0) {
500 rawdev->dev_private = rte_zmalloc_socket("rawdev private",
504 if (!rawdev->dev_private) {
505 RTE_RDEV_ERR("Unable to allocate memory for rawdev");
510 rawdev->dev_id = dev_id;
511 rawdev->socket_id = socket_id;
513 strlcpy(rawdev->name, name, RTE_RAWDEV_NAME_MAX_LEN);
515 rawdev->attached = RTE_RAWDEV_ATTACHED;
516 rawdev_globals.nb_devs++;
522 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
529 ret = rte_rawdev_close(rawdev->dev_id);
533 rawdev->attached = RTE_RAWDEV_DETACHED;
534 rawdev_globals.nb_devs--;
537 rawdev->socket_id = 0;
538 rawdev->dev_ops = NULL;
539 if (rawdev->dev_private) {
540 rte_free(rawdev->dev_private);
541 rawdev->dev_private = NULL;
548 handle_dev_list(const char *cmd __rte_unused,
549 const char *params __rte_unused,
550 struct rte_tel_data *d)
554 rte_tel_data_start_array(d, RTE_TEL_INT_VAL);
555 for (i = 0; i < rawdev_globals.nb_devs; i++)
556 if (rte_rawdevices[i].attached == RTE_RAWDEV_ATTACHED)
557 rte_tel_data_add_array_int(d, i);
562 handle_dev_xstats(const char *cmd __rte_unused,
564 struct rte_tel_data *d)
566 uint64_t *rawdev_xstats;
567 struct rte_rawdev_xstats_name *xstat_names;
568 int dev_id, num_xstats, i, ret;
571 if (params == NULL || strlen(params) == 0 || !isdigit(*params))
574 dev_id = atoi(params);
575 if (!rte_rawdev_pmd_is_valid_dev(dev_id))
578 num_xstats = xstats_get_count(dev_id);
582 /* use one malloc for names, stats and ids */
583 rawdev_xstats = malloc((sizeof(uint64_t) +
584 sizeof(struct rte_rawdev_xstats_name) +
585 sizeof(unsigned int)) * num_xstats);
586 if (rawdev_xstats == NULL)
588 xstat_names = (void *)&rawdev_xstats[num_xstats];
589 ids = (void *)&xstat_names[num_xstats];
591 ret = rte_rawdev_xstats_names_get(dev_id, xstat_names, num_xstats);
592 if (ret < 0 || ret > num_xstats) {
597 for (i = 0; i < num_xstats; i++)
600 ret = rte_rawdev_xstats_get(dev_id, ids, rawdev_xstats, num_xstats);
601 if (ret < 0 || ret > num_xstats) {
606 rte_tel_data_start_dict(d);
607 for (i = 0; i < num_xstats; i++)
608 rte_tel_data_add_dict_u64(d, xstat_names[i].name,
615 RTE_LOG_REGISTER(librawdev_logtype, lib.rawdev, INFO);
617 RTE_INIT(librawdev_init_telemetry)
619 rte_telemetry_register_cmd("/rawdev/list", handle_dev_list,
620 "Returns list of available rawdev ports. Takes no parameters");
621 rte_telemetry_register_cmd("/rawdev/xstats", handle_dev_xstats,
622 "Returns the xstats for a rawdev port. Parameters: int port_id");