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 struct rte_rawdev rte_rawdevices[RTE_RAWDEV_MAX_DEVS];
40 struct rte_rawdev *rte_rawdevs = &rte_rawdevices[0];
42 static struct rte_rawdev_global rawdev_globals = {
46 struct rte_rawdev_global *rte_rawdev_globals = &rawdev_globals;
48 /* Raw device, northbound API implementation */
49 uint8_t __rte_experimental
50 rte_rawdev_count(void)
52 return rte_rawdev_globals->nb_devs;
55 uint16_t __rte_experimental
56 rte_rawdev_get_dev_id(const char *name)
63 for (i = 0; i < rte_rawdev_globals->nb_devs; i++)
64 if ((strcmp(rte_rawdevices[i].name, name)
66 (rte_rawdevices[i].attached ==
72 int __rte_experimental
73 rte_rawdev_socket_id(uint16_t dev_id)
75 struct rte_rawdev *dev;
77 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
78 dev = &rte_rawdevs[dev_id];
80 return dev->socket_id;
83 int __rte_experimental
84 rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)
86 struct rte_rawdev *rawdev;
88 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
89 RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL);
94 rawdev = &rte_rawdevs[dev_id];
96 RTE_FUNC_PTR_OR_ERR_RET(*rawdev->dev_ops->dev_info_get, -ENOTSUP);
97 (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private);
101 dev_info->driver_name = rawdev->driver_name;
102 dev_info->device = rawdev->device;
108 int __rte_experimental
109 rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf)
111 struct rte_rawdev *dev;
114 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
115 RTE_FUNC_PTR_OR_ERR_RET(dev_conf, -EINVAL);
117 dev = &rte_rawdevs[dev_id];
119 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
123 "device %d must be stopped to allow configuration", dev_id);
127 /* Configure the device */
128 diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private);
130 RTE_RDEV_ERR("dev%d dev_configure = %d", dev_id, diag);
137 int __rte_experimental
138 rte_rawdev_queue_conf_get(uint16_t dev_id,
140 rte_rawdev_obj_t queue_conf)
142 struct rte_rawdev *dev;
144 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
145 dev = &rte_rawdevs[dev_id];
147 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_def_conf, -ENOTSUP);
148 (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf);
152 int __rte_experimental
153 rte_rawdev_queue_setup(uint16_t dev_id,
155 rte_rawdev_obj_t queue_conf)
157 struct rte_rawdev *dev;
159 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
160 dev = &rte_rawdevs[dev_id];
162 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_setup, -ENOTSUP);
163 return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf);
166 int __rte_experimental
167 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
169 struct rte_rawdev *dev;
171 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
172 dev = &rte_rawdevs[dev_id];
174 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_release, -ENOTSUP);
175 return (*dev->dev_ops->queue_release)(dev, queue_id);
178 int __rte_experimental
179 rte_rawdev_get_attr(uint16_t dev_id,
180 const char *attr_name,
181 uint64_t *attr_value)
183 struct rte_rawdev *dev;
185 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
186 dev = &rte_rawdevs[dev_id];
188 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_get, -ENOTSUP);
189 return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
192 int __rte_experimental
193 rte_rawdev_set_attr(uint16_t dev_id,
194 const char *attr_name,
195 const uint64_t attr_value)
197 struct rte_rawdev *dev;
199 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
200 dev = &rte_rawdevs[dev_id];
202 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->attr_set, -ENOTSUP);
203 return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
206 int __rte_experimental
207 rte_rawdev_enqueue_buffers(uint16_t dev_id,
208 struct rte_rawdev_buf **buffers,
210 rte_rawdev_obj_t context)
212 struct rte_rawdev *dev;
214 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
215 dev = &rte_rawdevs[dev_id];
217 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->enqueue_bufs, -ENOTSUP);
218 return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
221 int __rte_experimental
222 rte_rawdev_dequeue_buffers(uint16_t dev_id,
223 struct rte_rawdev_buf **buffers,
225 rte_rawdev_obj_t context)
227 struct rte_rawdev *dev;
229 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
230 dev = &rte_rawdevs[dev_id];
232 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dequeue_bufs, -ENOTSUP);
233 return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
236 int __rte_experimental
237 rte_rawdev_dump(uint16_t dev_id, FILE *f)
239 struct rte_rawdev *dev;
241 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
242 dev = &rte_rawdevs[dev_id];
244 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dump, -ENOTSUP);
245 return (*dev->dev_ops->dump)(dev, f);
249 xstats_get_count(uint16_t dev_id)
251 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
253 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
254 return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
257 int __rte_experimental
258 rte_rawdev_xstats_names_get(uint16_t dev_id,
259 struct rte_rawdev_xstats_name *xstats_names,
262 const struct rte_rawdev *dev;
263 int cnt_expected_entries;
265 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
267 cnt_expected_entries = xstats_get_count(dev_id);
269 if (xstats_names == NULL || cnt_expected_entries < 0 ||
270 (int)size < cnt_expected_entries || size <= 0)
271 return cnt_expected_entries;
273 dev = &rte_rawdevs[dev_id];
275 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
276 return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
279 /* retrieve rawdev extended statistics */
280 int __rte_experimental
281 rte_rawdev_xstats_get(uint16_t dev_id,
282 const unsigned int ids[],
286 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
287 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
289 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
290 return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
293 uint64_t __rte_experimental
294 rte_rawdev_xstats_by_name_get(uint16_t dev_id,
298 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
299 const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
300 unsigned int temp = -1;
303 *id = (unsigned int)-1;
305 id = &temp; /* driver never gets a NULL value */
307 /* implemented by driver */
308 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
309 return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
312 int __rte_experimental
313 rte_rawdev_xstats_reset(uint16_t dev_id,
314 const uint32_t ids[], uint32_t nb_ids)
316 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
317 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
319 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_reset, -ENOTSUP);
320 return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
323 int __rte_experimental
324 rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_info)
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->firmware_status_get, -ENOTSUP);
330 return (*dev->dev_ops->firmware_status_get)(dev, status_info);
333 int __rte_experimental
334 rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_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_version_get, -ENOTSUP);
340 return (*dev->dev_ops->firmware_version_get)(dev, version_info);
343 int __rte_experimental
344 rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
346 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
347 struct rte_rawdev *dev = &rte_rawdevs[dev_id];
352 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
353 return (*dev->dev_ops->firmware_load)(dev, firmware_image);
356 int __rte_experimental
357 rte_rawdev_firmware_unload(uint16_t dev_id)
359 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
360 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_unload)(dev);
366 int __rte_experimental
367 rte_rawdev_selftest(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->dev_selftest, -ENOTSUP);
373 return (*dev->dev_ops->dev_selftest)();
376 int __rte_experimental
377 rte_rawdev_start(uint16_t dev_id)
379 struct rte_rawdev *dev;
382 RTE_RDEV_DEBUG("Start dev_id=%" PRIu8, dev_id);
384 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
385 dev = &rte_rawdevs[dev_id];
386 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
388 if (dev->started != 0) {
389 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already started",
394 diag = (*dev->dev_ops->dev_start)(dev);
403 void __rte_experimental
404 rte_rawdev_stop(uint16_t dev_id)
406 struct rte_rawdev *dev;
408 RTE_RDEV_DEBUG("Stop dev_id=%" PRIu8, dev_id);
410 RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id);
411 dev = &rte_rawdevs[dev_id];
413 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
415 if (dev->started == 0) {
416 RTE_RDEV_ERR("Device with dev_id=%" PRIu8 "already stopped",
421 (*dev->dev_ops->dev_stop)(dev);
425 int __rte_experimental
426 rte_rawdev_close(uint16_t dev_id)
428 struct rte_rawdev *dev;
430 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
431 dev = &rte_rawdevs[dev_id];
433 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
434 /* Device must be stopped before it can be closed */
435 if (dev->started == 1) {
436 RTE_RDEV_ERR("Device %u must be stopped before closing",
441 return (*dev->dev_ops->dev_close)(dev);
444 int __rte_experimental
445 rte_rawdev_reset(uint16_t dev_id)
447 struct rte_rawdev *dev;
449 RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
450 dev = &rte_rawdevs[dev_id];
452 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_reset, -ENOTSUP);
453 /* Reset is not dependent on state of the device */
454 return (*dev->dev_ops->dev_reset)(dev);
457 static inline uint8_t
458 rte_rawdev_find_free_device_index(void)
462 for (dev_id = 0; dev_id < RTE_RAWDEV_MAX_DEVS; dev_id++) {
463 if (rte_rawdevs[dev_id].attached ==
468 return RTE_RAWDEV_MAX_DEVS;
471 struct rte_rawdev * __rte_experimental
472 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
474 struct rte_rawdev *rawdev;
477 if (rte_rawdev_pmd_get_named_dev(name) != NULL) {
478 RTE_RDEV_ERR("Event device with name %s already allocated!",
483 dev_id = rte_rawdev_find_free_device_index();
484 if (dev_id == RTE_RAWDEV_MAX_DEVS) {
485 RTE_RDEV_ERR("Reached maximum number of raw devices");
489 rawdev = &rte_rawdevs[dev_id];
491 rawdev->dev_private = rte_zmalloc_socket("rawdev private",
495 if (!rawdev->dev_private) {
496 RTE_RDEV_ERR("Unable to allocate memory to Skeleton dev");
501 rawdev->dev_id = dev_id;
502 rawdev->socket_id = socket_id;
504 snprintf(rawdev->name, RTE_RAWDEV_NAME_MAX_LEN, "%s", name);
506 rawdev->attached = RTE_RAWDEV_ATTACHED;
507 rawdev_globals.nb_devs++;
512 int __rte_experimental
513 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
520 ret = rte_rawdev_close(rawdev->dev_id);
524 rawdev->attached = RTE_RAWDEV_DETACHED;
525 rawdev_globals.nb_devs--;
528 rawdev->socket_id = 0;
529 rawdev->dev_ops = NULL;
530 if (rawdev->dev_private) {
531 rte_free(rawdev->dev_private);
532 rawdev->dev_private = NULL;
538 RTE_INIT(librawdev_init_log);
541 librawdev_init_log(void)
543 librawdev_logtype = rte_log_register("lib.rawdev");
544 if (librawdev_logtype >= 0)
545 rte_log_set_level(librawdev_logtype, RTE_LOG_INFO);