DPDK  24.03.0
rte_rawdev_pmd.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2017 NXP
3  */
4 
5 #ifndef _RTE_RAWDEV_PMD_H_
6 #define _RTE_RAWDEV_PMD_H_
7 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 #include <string.h>
21 
22 #include <dev_driver.h>
23 #include <rte_malloc.h>
24 #include <rte_log.h>
25 #include <rte_common.h>
26 
27 #include "rte_rawdev.h"
28 
29 extern int librawdev_logtype;
30 #define RTE_LOGTYPE_RAWDEV librawdev_logtype
31 
32 /* Logging Macros */
33 #define RTE_RDEV_LOG(level, ...) \
34  RTE_LOG_LINE_PREFIX(level, RAWDEV, "%s(): ", __func__, __VA_ARGS__)
35 
36 #define RTE_RDEV_ERR(...) \
37  RTE_RDEV_LOG(ERR, __VA_ARGS__)
38 
39 #define RTE_RDEV_DEBUG(...) \
40  RTE_RDEV_LOG(DEBUG, __VA_ARGS__)
41 
42 #define RTE_RDEV_INFO(...) \
43  RTE_RDEV_LOG(INFO, __VA_ARGS__)
44 
45 /* Macros to check for valid device */
46 #define RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, retval) do { \
47  if (!rte_rawdev_pmd_is_valid_dev((dev_id))) { \
48  RTE_RDEV_ERR("Invalid dev_id=%d", dev_id); \
49  return retval; \
50  } \
51 } while (0)
52 
53 #define RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id) do { \
54  if (!rte_rawdev_pmd_is_valid_dev((dev_id))) { \
55  RTE_RDEV_ERR("Invalid dev_id=%d", dev_id); \
56  return; \
57  } \
58 } while (0)
59 
60 #define RTE_RAWDEV_DETACHED (0)
61 #define RTE_RAWDEV_ATTACHED (1)
62 
63 /* Global structure used for maintaining state of allocated raw devices.
64  *
65  * TODO: Can be expanded to <type of raw device>:<count> in future.
66  * Applications should be able to select from a number of type of raw
67  * devices which were detected or attached to this DPDK instance.
68  */
69 struct rte_rawdev_global {
71  uint16_t nb_devs;
72 };
73 
74 extern struct rte_rawdev *rte_rawdevs;
86 static inline struct rte_rawdev *
88 {
89  struct rte_rawdev *dev;
90  unsigned int i;
91 
92  if (name == NULL)
93  return NULL;
94 
95  for (i = 0; i < RTE_RAWDEV_MAX_DEVS; i++) {
96  dev = &rte_rawdevs[i];
97  if ((dev->attached == RTE_RAWDEV_ATTACHED) &&
98  (strcmp(dev->name, name) == 0))
99  return dev;
100  }
101 
102  return NULL;
103 }
104 
114 static inline unsigned
116 {
117  struct rte_rawdev *dev;
118 
119  if (dev_id >= RTE_RAWDEV_MAX_DEVS)
120  return 0;
121 
122  dev = &rte_rawdevs[dev_id];
123  if (dev->attached != RTE_RAWDEV_ATTACHED)
124  return 0;
125  else
126  return 1;
127 }
128 
148 typedef int (*rawdev_info_get_t)(struct rte_rawdev *dev,
149  rte_rawdev_obj_t dev_info,
150  size_t dev_private_size);
151 
165 typedef int (*rawdev_configure_t)(const struct rte_rawdev *dev,
166  rte_rawdev_obj_t config,
167  size_t config_size);
168 
178 typedef int (*rawdev_start_t)(struct rte_rawdev *dev);
179 
186 typedef void (*rawdev_stop_t)(struct rte_rawdev *dev);
187 
198 typedef int (*rawdev_close_t)(struct rte_rawdev *dev);
199 
209 typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);
210 
226 typedef int (*rawdev_queue_conf_get_t)(struct rte_rawdev *dev,
227  uint16_t queue_id,
228  rte_rawdev_obj_t queue_conf,
229  size_t queue_conf_size);
230 
246 typedef int (*rawdev_queue_setup_t)(struct rte_rawdev *dev,
247  uint16_t queue_id,
248  rte_rawdev_obj_t queue_conf,
249  size_t queue_conf_size);
250 
259 typedef int (*rawdev_queue_release_t)(struct rte_rawdev *dev,
260  uint16_t queue_id);
261 
277 typedef uint16_t (*rawdev_queue_count_t)(struct rte_rawdev *dev);
278 
301 typedef int (*rawdev_enqueue_bufs_t)(struct rte_rawdev *dev,
302  struct rte_rawdev_buf **buffers,
303  unsigned int count,
304  rte_rawdev_obj_t context);
305 
326 typedef int (*rawdev_dequeue_bufs_t)(struct rte_rawdev *dev,
327  struct rte_rawdev_buf **buffers,
328  unsigned int count,
329  rte_rawdev_obj_t context);
330 
342 typedef int (*rawdev_dump_t)(struct rte_rawdev *dev, FILE *f);
343 
359 typedef int (*rawdev_get_attr_t)(struct rte_rawdev *dev,
360  const char *attr_name,
361  uint64_t *attr_value);
362 
377 typedef int (*rawdev_set_attr_t)(struct rte_rawdev *dev,
378  const char *attr_name,
379  const uint64_t attr_value);
380 
397 typedef int (*rawdev_xstats_get_t)(const struct rte_rawdev *dev,
398  const unsigned int ids[], uint64_t values[], unsigned int n);
399 
403 typedef int (*rawdev_xstats_reset_t)(struct rte_rawdev *dev,
404  const uint32_t ids[],
405  uint32_t nb_ids);
406 
422 typedef int (*rawdev_xstats_get_names_t)(const struct rte_rawdev *dev,
423  struct rte_rawdev_xstats_name *xstats_names,
424  unsigned int size);
425 
441 typedef uint64_t (*rawdev_xstats_get_by_name_t)(const struct rte_rawdev *dev,
442  const char *name,
443  unsigned int *id);
444 
457 typedef int (*rawdev_firmware_status_get_t)(struct rte_rawdev *dev,
458  rte_rawdev_obj_t status_info);
459 
471 typedef int (*rawdev_firmware_version_get_t)(struct rte_rawdev *dev,
472  rte_rawdev_obj_t version_info);
473 
488 typedef int (*rawdev_firmware_load_t)(struct rte_rawdev *dev,
489  rte_rawdev_obj_t firmware_buf);
490 
503 typedef int (*rawdev_firmware_unload_t)(struct rte_rawdev *dev);
504 
511 typedef int (*rawdev_selftest_t)(uint16_t dev_id);
512 
527 
536 
542 
543  /* Dump internal information */
545 
550 
559 
568 
570  rawdev_selftest_t dev_selftest;
571 };
572 
588 struct rte_rawdev *
589 rte_rawdev_pmd_allocate(const char *name, size_t dev_private_size,
590  int socket_id);
591 
600 int
601 rte_rawdev_pmd_release(struct rte_rawdev *rawdev);
602 
617 struct rte_rawdev *
618 rte_rawdev_pmd_init(const char *name, size_t dev_private_size,
619  int socket_id);
620 
629 int
630 rte_rawdev_pmd_uninit(const char *name);
631 
632 #ifdef __cplusplus
633 }
634 #endif
635 
636 #endif /* _RTE_RAWDEV_PMD_H_ */
int(* rawdev_xstats_get_t)(const struct rte_rawdev *dev, const unsigned int ids[], uint64_t values[], unsigned int n)
int(* rawdev_info_get_t)(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, size_t dev_private_size)
rawdev_reset_t dev_reset
int(* rawdev_set_attr_t)(struct rte_rawdev *dev, const char *attr_name, const uint64_t attr_value)
rawdev_dequeue_bufs_t dequeue_bufs
rawdev_xstats_get_t xstats_get
int(* rawdev_get_attr_t)(struct rte_rawdev *dev, const char *attr_name, uint64_t *attr_value)
int(* rawdev_start_t)(struct rte_rawdev *dev)
rawdev_info_get_t dev_info_get
static unsigned rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)
int rte_rawdev_pmd_uninit(const char *name)
int(* rawdev_xstats_reset_t)(struct rte_rawdev *dev, const uint32_t ids[], uint32_t nb_ids)
int rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
int(* rawdev_firmware_version_get_t)(struct rte_rawdev *dev, rte_rawdev_obj_t version_info)
struct rte_rawdev * rte_rawdev_pmd_allocate(const char *name, size_t dev_private_size, int socket_id)
rawdev_firmware_version_get_t firmware_version_get
rawdev_xstats_reset_t xstats_reset
int(* rawdev_queue_release_t)(struct rte_rawdev *dev, uint16_t queue_id)
rawdev_queue_conf_get_t queue_def_conf
int(* rawdev_firmware_load_t)(struct rte_rawdev *dev, rte_rawdev_obj_t firmware_buf)
rawdev_configure_t dev_configure
int(* rawdev_dequeue_bufs_t)(struct rte_rawdev *dev, struct rte_rawdev_buf **buffers, unsigned int count, rte_rawdev_obj_t context)
rawdev_start_t dev_start
int(* rawdev_selftest_t)(uint16_t dev_id)
rawdev_queue_count_t queue_count
int(* rawdev_queue_conf_get_t)(struct rte_rawdev *dev, uint16_t queue_id, rte_rawdev_obj_t queue_conf, size_t queue_conf_size)
int(* rawdev_firmware_unload_t)(struct rte_rawdev *dev)
uint16_t(* rawdev_queue_count_t)(struct rte_rawdev *dev)
struct rte_rawdev * rte_rawdev_pmd_init(const char *name, size_t dev_private_size, int socket_id)
int(* rawdev_close_t)(struct rte_rawdev *dev)
rawdev_xstats_get_by_name_t xstats_get_by_name
rawdev_firmware_load_t firmware_load
int(* rawdev_xstats_get_names_t)(const struct rte_rawdev *dev, struct rte_rawdev_xstats_name *xstats_names, unsigned int size)
uint64_t(* rawdev_xstats_get_by_name_t)(const struct rte_rawdev *dev, const char *name, unsigned int *id)
rawdev_set_attr_t attr_set
rawdev_queue_release_t queue_release
void(* rawdev_stop_t)(struct rte_rawdev *dev)
rawdev_queue_setup_t queue_setup
int(* rawdev_configure_t)(const struct rte_rawdev *dev, rte_rawdev_obj_t config, size_t config_size)
rawdev_xstats_get_names_t xstats_get_names
rawdev_get_attr_t attr_get
int(* rawdev_reset_t)(struct rte_rawdev *dev)
rawdev_firmware_status_get_t firmware_status_get
rawdev_enqueue_bufs_t enqueue_bufs
int(* rawdev_firmware_status_get_t)(struct rte_rawdev *dev, rte_rawdev_obj_t status_info)
static struct rte_rawdev * rte_rawdev_pmd_get_named_dev(const char *name)
rawdev_close_t dev_close
rawdev_stop_t dev_stop
int(* rawdev_enqueue_bufs_t)(struct rte_rawdev *dev, struct rte_rawdev_buf **buffers, unsigned int count, rte_rawdev_obj_t context)
int(* rawdev_dump_t)(struct rte_rawdev *dev, FILE *f)
rawdev_dump_t dump
rawdev_firmware_unload_t firmware_unload
int(* rawdev_queue_setup_t)(struct rte_rawdev *dev, uint16_t queue_id, rte_rawdev_obj_t queue_conf, size_t queue_conf_size)