DPDK  24.03.0
rte_bbdev_pmd.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017 Intel Corporation
3  */
4 
5 #ifndef _RTE_BBDEV_PMD_H_
6 #define _RTE_BBDEV_PMD_H_
7 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 #include <stdint.h>
22 #include <rte_log.h>
23 
24 #include "rte_bbdev.h"
25 
27 #define RTE_BBDEV_DEFAULT_MAX_NB_QUEUES RTE_MAX_LCORE
28 
30 #define RTE_BBDEV_QUEUE_SIZE_LIMIT 16384
31 
43 struct rte_bbdev *
44 rte_bbdev_allocate(const char *name);
45 
55 int
56 rte_bbdev_release(struct rte_bbdev *bbdev);
57 
68 struct rte_bbdev *
69 rte_bbdev_get_named_dev(const char *name);
70 
78 typedef int (*rte_bbdev_setup_queues_t)(struct rte_bbdev *dev,
79  uint16_t num_queues, int socket_id);
80 
82 typedef int (*rte_bbdev_intr_enable_t)(struct rte_bbdev *dev);
83 
85 typedef int (*rte_bbdev_queue_setup_t)(struct rte_bbdev *dev,
86  uint16_t queue_id, const struct rte_bbdev_queue_conf *conf);
87 
88 /*
89  * @internal
90  * Function to release memory resources allocated for a device queue.
91  */
92 typedef int (*rte_bbdev_queue_release_t)(struct rte_bbdev *dev,
93  uint16_t queue_id);
94 
96 typedef int (*rte_bbdev_start_t)(struct rte_bbdev *dev);
97 
99 typedef void (*rte_bbdev_stop_t)(struct rte_bbdev *dev);
100 
102 typedef int (*rte_bbdev_close_t)(struct rte_bbdev *dev);
103 
105 typedef int (*rte_bbdev_queue_start_t)(struct rte_bbdev *dev,
106  uint16_t queue_id);
107 
109 typedef int (*rte_bbdev_queue_stop_t)(struct rte_bbdev *dev, uint16_t queue_id);
110 
112 typedef void (*rte_bbdev_stats_get_t)(struct rte_bbdev *dev,
113  struct rte_bbdev_stats *stats);
114 
116 typedef void (*rte_bbdev_stats_reset_t)(struct rte_bbdev *dev);
117 
119 typedef void (*rte_bbdev_info_get_t)(struct rte_bbdev *dev,
120  struct rte_bbdev_driver_info *dev_info);
121 
122 /*
123  * @internal
124  * Function to enable interrupt for next op on a queue of a device.
125  */
126 typedef int (*rte_bbdev_queue_intr_enable_t)(struct rte_bbdev *dev,
127  uint16_t queue_id);
128 
129 /*
130  * @internal
131  * Function to disable interrupt for next op on a queue of a device.
132  */
133 typedef int (*rte_bbdev_queue_intr_disable_t)(struct rte_bbdev *dev,
134  uint16_t queue_id);
135 
145  rte_bbdev_intr_enable_t intr_enable;
147  rte_bbdev_start_t start;
149  rte_bbdev_stop_t stop;
151  rte_bbdev_close_t close;
152 
154  rte_bbdev_info_get_t info_get;
156  rte_bbdev_stats_get_t stats_get;
158  rte_bbdev_stats_reset_t stats_reset;
159 
161  rte_bbdev_queue_setup_t queue_setup;
163  rte_bbdev_queue_release_t queue_release;
165  rte_bbdev_queue_start_t queue_start;
167  rte_bbdev_queue_stop_t queue_stop;
168 
170  rte_bbdev_queue_intr_enable_t queue_intr_enable;
172  rte_bbdev_queue_intr_disable_t queue_intr_disable;
173 };
174 
186 void
187 rte_bbdev_pmd_callback_process(struct rte_bbdev *dev,
188  enum rte_bbdev_event_type event, void *ret_param);
189 
190 #ifdef __cplusplus
191 }
192 #endif
193 
194 #endif /* _RTE_BBDEV_PMD_H_ */
struct rte_bbdev * rte_bbdev_get_named_dev(const char *name)
rte_bbdev_setup_queues_t setup_queues
int(* rte_bbdev_setup_queues_t)(struct rte_bbdev *dev, uint16_t num_queues, int socket_id)
Definition: rte_bbdev_pmd.h:78
rte_bbdev_start_t start
rte_bbdev_queue_stop_t queue_stop
void rte_bbdev_pmd_callback_process(struct rte_bbdev *dev, enum rte_bbdev_event_type event, void *ret_param)
rte_bbdev_stats_get_t stats_get
rte_bbdev_stop_t stop
rte_bbdev_intr_enable_t intr_enable
rte_bbdev_queue_intr_enable_t queue_intr_enable
rte_bbdev_event_type
Definition: rte_bbdev.h:909
rte_bbdev_close_t close
rte_bbdev_queue_start_t queue_start
rte_bbdev_queue_intr_disable_t queue_intr_disable
rte_bbdev_info_get_t info_get
rte_bbdev_queue_setup_t queue_setup
rte_bbdev_stats_reset_t stats_reset
rte_bbdev_queue_release_t queue_release