DPDK  20.05.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 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 #include <stdint.h>
25 #include <rte_log.h>
26 
27 #include "rte_bbdev.h"
28 
30 #define RTE_BBDEV_DEFAULT_MAX_NB_QUEUES RTE_MAX_LCORE
31 
33 #define RTE_BBDEV_QUEUE_SIZE_LIMIT 16384
34 
46 __rte_experimental
47 struct rte_bbdev *
48 rte_bbdev_allocate(const char *name);
49 
59 __rte_experimental
60 int
61 rte_bbdev_release(struct rte_bbdev *bbdev);
62 
74 __rte_experimental
75 struct rte_bbdev *
76 rte_bbdev_get_named_dev(const char *name);
77 
85 typedef int (*rte_bbdev_setup_queues_t)(struct rte_bbdev *dev,
86  uint16_t num_queues, int socket_id);
87 
89 typedef int (*rte_bbdev_intr_enable_t)(struct rte_bbdev *dev);
90 
92 typedef int (*rte_bbdev_queue_setup_t)(struct rte_bbdev *dev,
93  uint16_t queue_id, const struct rte_bbdev_queue_conf *conf);
94 
95 /*
96  * @internal
97  * Function to release memory resources allocated for a device queue.
98  */
99 typedef int (*rte_bbdev_queue_release_t)(struct rte_bbdev *dev,
100  uint16_t queue_id);
101 
103 typedef int (*rte_bbdev_start_t)(struct rte_bbdev *dev);
104 
106 typedef void (*rte_bbdev_stop_t)(struct rte_bbdev *dev);
107 
109 typedef int (*rte_bbdev_close_t)(struct rte_bbdev *dev);
110 
112 typedef int (*rte_bbdev_queue_start_t)(struct rte_bbdev *dev,
113  uint16_t queue_id);
114 
116 typedef int (*rte_bbdev_queue_stop_t)(struct rte_bbdev *dev, uint16_t queue_id);
117 
119 typedef void (*rte_bbdev_stats_get_t)(struct rte_bbdev *dev,
120  struct rte_bbdev_stats *stats);
121 
123 typedef void (*rte_bbdev_stats_reset_t)(struct rte_bbdev *dev);
124 
126 typedef void (*rte_bbdev_info_get_t)(struct rte_bbdev *dev,
127  struct rte_bbdev_driver_info *dev_info);
128 
129 /*
130  * @internal
131  * Function to enable interrupt for next op on a queue of a device.
132  */
133 typedef int (*rte_bbdev_queue_intr_enable_t)(struct rte_bbdev *dev,
134  uint16_t queue_id);
135 
136 /*
137  * @internal
138  * Function to disable interrupt for next op on a queue of a device.
139  */
140 typedef int (*rte_bbdev_queue_intr_disable_t)(struct rte_bbdev *dev,
141  uint16_t queue_id);
142 
152  rte_bbdev_intr_enable_t intr_enable;
154  rte_bbdev_start_t start;
156  rte_bbdev_stop_t stop;
158  rte_bbdev_close_t close;
159 
161  rte_bbdev_info_get_t info_get;
163  rte_bbdev_stats_get_t stats_get;
165  rte_bbdev_stats_reset_t stats_reset;
166 
168  rte_bbdev_queue_setup_t queue_setup;
170  rte_bbdev_queue_release_t queue_release;
172  rte_bbdev_queue_start_t queue_start;
174  rte_bbdev_queue_stop_t queue_stop;
175 
177  rte_bbdev_queue_intr_enable_t queue_intr_enable;
179  rte_bbdev_queue_intr_disable_t queue_intr_disable;
180 };
181 
193 __rte_experimental
194 void
195 rte_bbdev_pmd_callback_process(struct rte_bbdev *dev,
196  enum rte_bbdev_event_type event, void *ret_param);
197 
198 #ifdef __cplusplus
199 }
200 #endif
201 
202 #endif /* _RTE_BBDEV_PMD_H_ */
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:85
rte_bbdev_start_t start
rte_bbdev_queue_stop_t queue_stop
rte_bbdev_stats_get_t stats_get
__rte_experimental void rte_bbdev_pmd_callback_process(struct rte_bbdev *dev, enum rte_bbdev_event_type event, void *ret_param)
rte_bbdev_stop_t stop
__rte_experimental struct rte_bbdev * rte_bbdev_get_named_dev(const char *name)
rte_bbdev_intr_enable_t intr_enable
rte_bbdev_queue_intr_enable_t queue_intr_enable
rte_bbdev_event_type
Definition: rte_bbdev.h:727
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