d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

bbdev: promote API as stable

Browse Source 
This promotes the bbdev interface to stable.
Overdue for some time as bbdev interface has been stable.

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
Acked-by: Akhil Goyal <gakhil@marvell.com>
This commit is contained in:
Nicolas Chautru 2021-08-31 09:25:30 -07:00 committed by Akhil Goyal
parent b4a4fb7e5d
commit ba2469cddf
5 changed files with 2 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MAINTAINERS
View File

@ -411,7 +411,7 @@ M: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
T: git://dpdk.org/next/dpdk-next-net
F: lib/ethdev/rte_mtr*
Baseband API - EXPERIMENTAL
Baseband API
M: Nicolas Chautru <nicolas.chautru@intel.com>
T: git://dpdk.org/next/dpdk-next-crypto
F: lib/bbdev/

32
lib/bbdev/rte_bbdev.h
View File

@ -10,10 +10,6 @@
*
* Wireless base band device abstraction APIs.
*
* @warning
* @b EXPERIMENTAL:
* All functions in this file may be changed or removed without prior notice.
*
* This API allows an application to discover, configure and use a device to
* process operations. An asynchronous API (enqueue, followed by later dequeue)
* is used for processing operations.
@ -55,7 +51,6 @@ enum rte_bbdev_state {
* @return
* The total number of usable devices.
*/
__rte_experimental
uint16_t
rte_bbdev_count(void);
@ -68,7 +63,6 @@ rte_bbdev_count(void);
* @return
* true if device ID is valid and device is attached, false otherwise.
*/
__rte_experimental
bool
rte_bbdev_is_valid(uint16_t dev_id);
@ -82,7 +76,6 @@ rte_bbdev_is_valid(uint16_t dev_id);
* - The next device, or
* - RTE_BBDEV_MAX_DEVS if none found
*/
__rte_experimental
uint16_t
rte_bbdev_find_next(uint16_t dev_id);
@ -112,7 +105,6 @@ rte_bbdev_find_next(uint16_t dev_id);
* - -EBUSY if the identified device has already started
* - -ENOMEM if unable to allocate memory
*/
__rte_experimental
int
rte_bbdev_setup_queues(uint16_t dev_id, uint16_t num_queues, int socket_id);
@ -130,7 +122,6 @@ rte_bbdev_setup_queues(uint16_t dev_id, uint16_t num_queues, int socket_id);
* - -EBUSY if the identified device has already started
* - -ENOTSUP if the interrupts are not supported by the device
*/
__rte_experimental
int
rte_bbdev_intr_enable(uint16_t dev_id);
@ -160,7 +151,6 @@ struct rte_bbdev_queue_conf {
* - EINVAL if the identified queue size or priority are invalid
* - EBUSY if the identified queue or its device have already started
*/
__rte_experimental
int
rte_bbdev_queue_configure(uint16_t dev_id, uint16_t queue_id,
const struct rte_bbdev_queue_conf *conf);
@ -176,7 +166,6 @@ rte_bbdev_queue_configure(uint16_t dev_id, uint16_t queue_id,
* - 0 on success
* - negative value on failure - as returned from PMD driver
*/
__rte_experimental
int
rte_bbdev_start(uint16_t dev_id);
@ -190,7 +179,6 @@ rte_bbdev_start(uint16_t dev_id);
* @return
* - 0 on success
*/
__rte_experimental
int
rte_bbdev_stop(uint16_t dev_id);
@ -204,7 +192,6 @@ rte_bbdev_stop(uint16_t dev_id);
* @return
* - 0 on success
*/
__rte_experimental
int
rte_bbdev_close(uint16_t dev_id);
@ -222,7 +209,6 @@ rte_bbdev_close(uint16_t dev_id);
* - 0 on success
* - negative value on failure - as returned from PMD driver
*/
__rte_experimental
int
rte_bbdev_queue_start(uint16_t dev_id, uint16_t queue_id);
@ -238,7 +224,6 @@ rte_bbdev_queue_start(uint16_t dev_id, uint16_t queue_id);
* - 0 on success
* - negative value on failure - as returned from PMD driver
*/
__rte_experimental
int
rte_bbdev_queue_stop(uint16_t dev_id, uint16_t queue_id);
@ -272,7 +257,6 @@ struct rte_bbdev_stats {
* - 0 on success
* - EINVAL if invalid parameter pointer is provided
*/
__rte_experimental
int
rte_bbdev_stats_get(uint16_t dev_id, struct rte_bbdev_stats *stats);
@ -284,7 +268,6 @@ rte_bbdev_stats_get(uint16_t dev_id, struct rte_bbdev_stats *stats);
* @return
* - 0 on success
*/
__rte_experimental
int
rte_bbdev_stats_reset(uint16_t dev_id);
@ -351,7 +334,6 @@ struct rte_bbdev_info {
* - 0 on success
* - EINVAL if invalid parameter pointer is provided
*/
__rte_experimental
int
rte_bbdev_info_get(uint16_t dev_id, struct rte_bbdev_info *dev_info);
@ -378,7 +360,6 @@ struct rte_bbdev_queue_info {
* - 0 on success
* - EINVAL if invalid parameter pointer is provided
*/
__rte_experimental
int
rte_bbdev_queue_info_get(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_queue_info *queue_info);
@ -494,7 +475,6 @@ extern struct rte_bbdev rte_bbdev_devices[];
* The number of operations actually enqueued (this is the number of processed
* entries in the @p ops array).
*/
__rte_experimental
static inline uint16_t
rte_bbdev_enqueue_enc_ops(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_enc_op **ops, uint16_t num_ops)
@ -525,7 +505,6 @@ rte_bbdev_enqueue_enc_ops(uint16_t dev_id, uint16_t queue_id,
* The number of operations actually enqueued (this is the number of processed
* entries in the @p ops array).
*/
__rte_experimental
static inline uint16_t
rte_bbdev_enqueue_dec_ops(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_dec_op **ops, uint16_t num_ops)
@ -556,7 +535,6 @@ rte_bbdev_enqueue_dec_ops(uint16_t dev_id, uint16_t queue_id,
* The number of operations actually enqueued (this is the number of processed
* entries in the @p ops array).
*/
__rte_experimental
static inline uint16_t
rte_bbdev_enqueue_ldpc_enc_ops(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_enc_op **ops, uint16_t num_ops)
@ -587,7 +565,6 @@ rte_bbdev_enqueue_ldpc_enc_ops(uint16_t dev_id, uint16_t queue_id,
* The number of operations actually enqueued (this is the number of processed
* entries in the @p ops array).
*/
__rte_experimental
static inline uint16_t
rte_bbdev_enqueue_ldpc_dec_ops(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_dec_op **ops, uint16_t num_ops)
@ -620,7 +597,6 @@ rte_bbdev_enqueue_ldpc_dec_ops(uint16_t dev_id, uint16_t queue_id,
* The number of operations actually dequeued (this is the number of entries
* copied into the @p ops array).
*/
__rte_experimental
static inline uint16_t
rte_bbdev_dequeue_enc_ops(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_enc_op **ops, uint16_t num_ops)
@ -653,7 +629,6 @@ rte_bbdev_dequeue_enc_ops(uint16_t dev_id, uint16_t queue_id,
* copied into the @p ops array).
*/
__rte_experimental
static inline uint16_t
rte_bbdev_dequeue_dec_ops(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_dec_op **ops, uint16_t num_ops)
@ -685,7 +660,6 @@ rte_bbdev_dequeue_dec_ops(uint16_t dev_id, uint16_t queue_id,
* The number of operations actually dequeued (this is the number of entries
* copied into the @p ops array).
*/
__rte_experimental
static inline uint16_t
rte_bbdev_dequeue_ldpc_enc_ops(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_enc_op **ops, uint16_t num_ops)
@ -716,7 +690,6 @@ rte_bbdev_dequeue_ldpc_enc_ops(uint16_t dev_id, uint16_t queue_id,
* The number of operations actually dequeued (this is the number of entries
* copied into the @p ops array).
*/
__rte_experimental
static inline uint16_t
rte_bbdev_dequeue_ldpc_dec_ops(uint16_t dev_id, uint16_t queue_id,
struct rte_bbdev_dec_op **ops, uint16_t num_ops)
@ -768,7 +741,6 @@ typedef void (*rte_bbdev_cb_fn)(uint16_t dev_id,
* @return
* Zero on success, negative value on failure.
*/
__rte_experimental
int
rte_bbdev_callback_register(uint16_t dev_id, enum rte_bbdev_event_type event,
rte_bbdev_cb_fn cb_fn, void *cb_arg);
@ -792,7 +764,6 @@ rte_bbdev_callback_register(uint16_t dev_id, enum rte_bbdev_event_type event,
* - EINVAL if invalid parameter pointer is provided
* - EAGAIN if the provided callback pointer does not exist
*/
__rte_experimental
int
rte_bbdev_callback_unregister(uint16_t dev_id, enum rte_bbdev_event_type event,
rte_bbdev_cb_fn cb_fn, void *cb_arg);
@ -813,7 +784,6 @@ rte_bbdev_callback_unregister(uint16_t dev_id, enum rte_bbdev_event_type event,
* - 0 on success
* - negative value on failure - as returned from PMD driver
*/
__rte_experimental
int
rte_bbdev_queue_intr_enable(uint16_t dev_id, uint16_t queue_id);
@ -830,7 +800,6 @@ rte_bbdev_queue_intr_enable(uint16_t dev_id, uint16_t queue_id);
* - 0 on success
* - negative value on failure - as returned from PMD driver
*/
__rte_experimental
int
rte_bbdev_queue_intr_disable(uint16_t dev_id, uint16_t queue_id);
@ -858,7 +827,6 @@ rte_bbdev_queue_intr_disable(uint16_t dev_id, uint16_t queue_id);
* - ENOTSUP if interrupts are not supported by the identified device
* - negative value on failure - as returned from PMD driver
*/
__rte_experimental
int
rte_bbdev_queue_intr_ctl(uint16_t dev_id, uint16_t queue_id, int epfd, int op,
void *data);

9
lib/bbdev/rte_bbdev_op.h
View File

@ -9,9 +9,6 @@
* @file rte_bbdev_op.h
*
* Defines wireless base band layer 1 operations and capabilities
*
* @warning
* @b EXPERIMENTAL: this API may change without prior notice
*/
#ifdef __cplusplus
@ -820,7 +817,6 @@ struct rte_bbdev_op_pool_private {
* Operation type as string or NULL if op_type is invalid
*
*/
__rte_experimental
const char*
rte_bbdev_op_type_str(enum rte_bbdev_op_type op_type);
@ -844,7 +840,6 @@ rte_bbdev_op_type_str(enum rte_bbdev_op_type op_type);
* - Pointer to a mempool on success,
* - NULL pointer on failure.
*/
__rte_experimental
struct rte_mempool *
rte_bbdev_op_pool_create(const char *name, enum rte_bbdev_op_type type,
unsigned int num_elements, unsigned int cache_size,
@ -864,7 +859,6 @@ rte_bbdev_op_pool_create(const char *name, enum rte_bbdev_op_type type,
* - 0 on success
* - EINVAL if invalid mempool is provided
*/
__rte_experimental
static inline int
rte_bbdev_enc_op_alloc_bulk(struct rte_mempool *mempool,
struct rte_bbdev_enc_op **ops, uint16_t num_ops)
@ -901,7 +895,6 @@ rte_bbdev_enc_op_alloc_bulk(struct rte_mempool *mempool,
* - 0 on success
* - EINVAL if invalid mempool is provided
*/
__rte_experimental
static inline int
rte_bbdev_dec_op_alloc_bulk(struct rte_mempool *mempool,
struct rte_bbdev_dec_op **ops, uint16_t num_ops)
@ -934,7 +927,6 @@ rte_bbdev_dec_op_alloc_bulk(struct rte_mempool *mempool,
* @param num_ops
* Number of structures
*/
__rte_experimental
static inline void
rte_bbdev_dec_op_free_bulk(struct rte_bbdev_dec_op **ops, unsigned int num_ops)
{
@ -952,7 +944,6 @@ rte_bbdev_dec_op_free_bulk(struct rte_bbdev_dec_op **ops, unsigned int num_ops)
* @param num_ops
* Number of structures
*/
__rte_experimental
static inline void
rte_bbdev_enc_op_free_bulk(struct rte_bbdev_enc_op **ops, unsigned int num_ops)
{

7
lib/bbdev/rte_bbdev_pmd.h
View File

@ -10,9 +10,6 @@
*
* Wireless base band driver-facing APIs.
*
* @warning
* @b EXPERIMENTAL: this API may change without prior notice
*
* This API provides the mechanism for device drivers to register with the
* bbdev interface. User applications should not use this API.
*/
@ -43,7 +40,6 @@ extern "C" {
* @return
* - Slot in the rte_bbdev array for a new device;
*/
__rte_experimental
struct rte_bbdev *
rte_bbdev_allocate(const char *name);
@ -56,7 +52,6 @@ rte_bbdev_allocate(const char *name);
* @return
* - 0 on success, negative on error
*/
__rte_experimental
int
rte_bbdev_release(struct rte_bbdev *bbdev);
@ -71,7 +66,6 @@ rte_bbdev_release(struct rte_bbdev *bbdev);
* - NULL otherwise
*
*/
__rte_experimental
struct rte_bbdev *
rte_bbdev_get_named_dev(const char *name);
@ -190,7 +184,6 @@ struct rte_bbdev_ops {
* @param ret_param
* To pass data back to user application.
*/
__rte_experimental
void
rte_bbdev_pmd_callback_process(struct rte_bbdev *dev,
enum rte_bbdev_event_type event, void *ret_param);

2
lib/bbdev/version.map
View File

@ -1,4 +1,4 @@
EXPERIMENTAL {
DPDK_22 {
global:
rte_bbdev_allocate;