1 /* SPDX-License-Identifier: BSD-3-Clause
13 #include <sys/types.h>
14 #include <sys/queue.h>
16 #include <rte_byteorder.h>
18 #include <rte_debug.h>
20 #include <rte_memory.h>
21 #include <rte_memcpy.h>
22 #include <rte_memzone.h>
24 #include <rte_per_lcore.h>
25 #include <rte_lcore.h>
26 #include <rte_atomic.h>
27 #include <rte_branch_prediction.h>
28 #include <rte_common.h>
29 #include <rte_malloc.h>
30 #include <rte_errno.h>
32 #include "rte_rawdev.h"
33 #include "rte_rawdev_pmd.h"
35 /* dynamic log identifier */
36 int librawdev_logtype;
38 static struct rte_rawdev rte_rawdevices[RTE_RAWDEV_MAX_DEVS];
40 struct rte_rawdev *rte_rawdevs = rte_rawdevices;
42 static struct rte_rawdev_global rawdev_globals = {
46 /* Raw device, northbound API implementation */
48 rte_rawdev_count(void)
50 return rawdev_globals.nb_devs;
54 rte_rawdev_get_dev_id(const char *name)
61 for (i = 0; i < rawdev_globals.nb_devs; i++)
62 if ((strcmp(rte_rawdevices[i].name, name)
64 (rte_rawdevices[i].attached ==
71 rte_rawdev_socket_id(uint16_t dev_id)
73 struct rte_rawdev *dev;
75 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
76 dev = &rte_rawdevs[dev_id];
78 return dev->socket_id;
82 rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)
84 struct rte_rawdev *rawdev;
86 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
87 RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL);
89 rawdev = &rte_rawdevs[dev_id];
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);
96 dev_info->driver_name = rawdev->driver_name;
97 dev_info->device = rawdev->device;
104 rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf)
106 struct rte_rawdev *dev;
109 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
110 RTE_FUNC_PTR_OR_ERR_RET(dev_conf, -EINVAL);
112 dev = &rte_rawdevs[dev_id];
114 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
118 "device %d must be stopped to allow configuration", dev_id);
122 /* Configure the device */
123 diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private);
125 RTE_RDEV_ERR("dev%d dev_configure = %d", dev_id, diag);
133 rte_rawdev_queue_conf_get(uint16_t dev_id,
135 rte_rawdev_obj_t queue_conf)
137 struct rte_rawdev *dev;
139 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
140 dev = &rte_rawdevs[dev_id];
142 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_def_conf, -ENOTSUP);
143 (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf);
148 rte_rawdev_queue_setup(uint16_t dev_id,
150 rte_rawdev_obj_t queue_conf)
152 struct rte_rawdev *dev;
154 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
155 dev = &rte_rawdevs[dev_id];
157 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_setup, -ENOTSUP);
158 return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf);
162 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
164 struct rte_rawdev *dev;
166 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
167 dev = &rte_rawdevs[dev_id];
169 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_release, -ENOTSUP);
170 return (*dev->dev_ops->queue_release)(dev, queue_id);
174 rte_rawdev_queue_count(uint16_t dev_id)
176 struct rte_rawdev *dev;
178 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
179 dev = &rte_rawdevs[dev_id];
181 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_count, -ENOTSUP);
182 return (*dev->dev_ops->queue_count)(dev);
186 rte_rawdev_get_attr(uint16_t dev_id,
187 const char *attr_name,
188 uint64_t *attr_value)
190 struct rte_rawdev *dev;
192 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
193 dev = &rte_rawdevs[dev_id];
195 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_get, -ENOTSUP);
196 return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
200 rte_rawdev_set_attr(uint16_t dev_id,
201 const char *attr_name,
202 const uint64_t attr_value)
204 struct rte_rawdev *dev;
206 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
207 dev = &rte_rawdevs[dev_id];
209 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_set, -ENOTSUP);
210 return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
214 rte_rawdev_enqueue_buffers(uint16_t dev_id,
215 struct rte_rawdev_buf **buffers,
217 rte_rawdev_obj_t context)
219 struct rte_rawdev *dev;
221 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
222 dev = &rte_rawdevs[dev_id];
224 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->enqueue_bufs, -ENOTSUP);
225 return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
229 rte_rawdev_dequeue_buffers(uint16_t dev_id,
230 struct rte_rawdev_buf **buffers,
232 rte_rawdev_obj_t context)
234 struct rte_rawdev *dev;
236 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
237 dev = &rte_rawdevs[dev_id];
239 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dequeue_bufs, -ENOTSUP);
240 return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
244 rte_rawdev_dump(uint16_t dev_id, FILE *f)
246 struct rte_rawdev *dev;
248 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
249 dev = &rte_rawdevs[dev_id];
251 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dump, -ENOTSUP);
252 return (*dev->dev_ops->dump)(dev, f);
256 xstats_get_count(uint16_t dev_id)
258 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
260 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
261 return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
265 rte_rawdev_xstats_names_get(uint16_t dev_id,
266 struct rte_rawdev_xstats_name *xstats_names,
269 const struct rte_rawdev *dev;
270 int cnt_expected_entries;
272 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
274 cnt_expected_entries = xstats_get_count(dev_id);
276 if (xstats_names == NULL || cnt_expected_entries < 0 ||
277 (int)size < cnt_expected_entries || size <= 0)
278 return cnt_expected_entries;
280 dev = &rte_rawdevs[dev_id];
282 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
283 return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
286 /* retrieve rawdev extended statistics */
288 rte_rawdev_xstats_get(uint16_t dev_id,
289 const unsigned int ids[],
293 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
294 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
296 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
297 return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
301 rte_rawdev_xstats_by_name_get(uint16_t dev_id,
305 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
306 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
307 unsigned int temp = -1;
310 *id = (unsigned int)-1;
312 id = &temp; /* driver never gets a NULL value */
314 /* implemented by driver */
315 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
316 return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
320 rte_rawdev_xstats_reset(uint16_t dev_id,
321 const uint32_t ids[], uint32_t nb_ids)
323 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
324 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
326 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_reset, -ENOTSUP);
327 return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
331 rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_info)
333 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
334 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
336 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_status_get, -ENOTSUP);
337 return (*dev->dev_ops->firmware_status_get)(dev, status_info);
341 rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_info)
343 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
344 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
346 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_version_get, -ENOTSUP);
347 return (*dev->dev_ops->firmware_version_get)(dev, version_info);
351 rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
353 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
354 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
359 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
360 return (*dev->dev_ops->firmware_load)(dev, firmware_image);
364 rte_rawdev_firmware_unload(uint16_t dev_id)
366 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
367 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
369 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
370 return (*dev->dev_ops->firmware_unload)(dev);
374 rte_rawdev_selftest(uint16_t dev_id)
376 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
377 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
379 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_selftest, -ENOTSUP);
380 return (*dev->dev_ops->dev_selftest)();
384 rte_rawdev_start(uint16_t dev_id)
386 struct rte_rawdev *dev;
389 RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
391 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
392 dev = &rte_rawdevs[dev_id];
393 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
395 if (dev->started != 0) {
396 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
401 diag = (*dev->dev_ops->dev_start)(dev);
411 rte_rawdev_stop(uint16_t dev_id)
413 struct rte_rawdev *dev;
415 RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
417 RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
418 dev = &rte_rawdevs[dev_id];
420 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
422 if (dev->started == 0) {
423 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
428 (*dev->dev_ops->dev_stop)(dev);
433 rte_rawdev_close(uint16_t dev_id)
435 struct rte_rawdev *dev;
437 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
438 dev = &rte_rawdevs[dev_id];
440 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
441 /* Device must be stopped before it can be closed */
442 if (dev->started == 1) {
443 RTE_RDEV_ERR("Device %u must be stopped before closing",
448 return (*dev->dev_ops->dev_close)(dev);
452 rte_rawdev_reset(uint16_t dev_id)
454 struct rte_rawdev *dev;
456 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
457 dev = &rte_rawdevs[dev_id];
459 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
460 /* Reset is not dependent on state of the device */
461 return (*dev->dev_ops->dev_reset)(dev);
464 static inline uint8_t
465 rte_rawdev_find_free_device_index(void)
469 for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
470 if (rte_rawdevs[dev_id].attached ==
475 return RTE_RAWDEV_MAX_DEVS;
479 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
481 struct rte_rawdev *rawdev;
484 if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
485 RTE_RDEV_ERR("Event device with name %s already allocated!",
490 dev_id = rte_rawdev_find_free_device_index();
491 if (dev_id == RTE_RAWDEV_MAX_DEVS) {
492 RTE_RDEV_ERR("Reached maximum number of raw devices");
496 rawdev = &rte_rawdevs[dev_id];
498 rawdev->dev_private = rte_zmalloc_socket("rawdev private",
502 if (!rawdev->dev_private) {
503 RTE_RDEV_ERR("Unable to allocate memory to Skeleton dev");
508 rawdev->dev_id = dev_id;
509 rawdev->socket_id = socket_id;
511 snprintf(rawdev->name, RTE_RAWDEV_NAME_MAX_LEN, "%s", name);
513 rawdev->attached = RTE_RAWDEV_ATTACHED;
514 rawdev_globals.nb_devs++;
520 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
527 ret = rte_rawdev_close(rawdev->dev_id);
531 rawdev->attached = RTE_RAWDEV_DETACHED;
532 rawdev_globals.nb_devs--;
535 rawdev->socket_id = 0;
536 rawdev->dev_ops = NULL;
537 if (rawdev->dev_private) {
538 rte_free(rawdev->dev_private);
539 rawdev->dev_private = NULL;
545 RTE_INIT(librawdev_init_log)
547 librawdev_logtype = rte_log_register("lib.rawdev");
548 if (librawdev_logtype >= 0)
549 rte_log_set_level(librawdev_logtype, RTE_LOG_INFO);