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

bbdev: fix doxygen comments

Browse Source 
Several doxygen markup were incorrect in header files.

Fixes: 4935e1e9f76e ("bbdev: introduce wireless base band device lib")
Cc: stable@dpdk.org

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
This commit is contained in:
Nicolas Chautru 2020-04-19 16:39:48 -07:00 committed by Akhil Goyal
parent 8978ab3b03
commit cc29fea1ca
3 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
lib/librte_bbdev/rte_bbdev.h
View File

@ -442,21 +442,21 @@ TAILQ_HEAD(rte_bbdev_cb_list, rte_bbdev_callback);
* these fields, but should only write to the *_ops fields.
*/
struct __rte_cache_aligned rte_bbdev {
/**< Enqueue encode function */
/** Enqueue encode function */
rte_bbdev_enqueue_enc_ops_t enqueue_enc_ops;
/**< Enqueue decode function */
/** Enqueue decode function */
rte_bbdev_enqueue_dec_ops_t enqueue_dec_ops;
/**< Dequeue encode function */
/** Dequeue encode function */
rte_bbdev_dequeue_enc_ops_t dequeue_enc_ops;
/**< Dequeue decode function */
/** Dequeue decode function */
rte_bbdev_dequeue_dec_ops_t dequeue_dec_ops;
/**< Enqueue encode function */
/** Enqueue encode function */
rte_bbdev_enqueue_enc_ops_t enqueue_ldpc_enc_ops;
/**< Enqueue decode function */
/** Enqueue decode function */
rte_bbdev_enqueue_dec_ops_t enqueue_ldpc_dec_ops;
/**< Dequeue encode function */
/** Dequeue encode function */
rte_bbdev_dequeue_enc_ops_t dequeue_ldpc_enc_ops;
/**< Dequeue decode function */
/** Dequeue decode function */
rte_bbdev_dequeue_dec_ops_t dequeue_ldpc_dec_ops;
const struct rte_bbdev_ops *dev_ops; /**< Functions exported by PMD */
struct rte_bbdev_data *data; /**< Pointer to device data */

16
lib/librte_bbdev/rte_bbdev_op.h
View File

@ -398,12 +398,12 @@ struct rte_bbdev_op_turbo_dec {
*/
uint8_t num_maps;
/**< [0 - TB : 1 - CB] */
/** [0 - TB : 1 - CB] */
uint8_t code_block_mode;
union {
/**< Struct which stores Code Block specific parameters */
/** Struct which stores Code Block specific parameters */
struct rte_bbdev_op_dec_turbo_cb_params cb_params;
/**< Struct which stores Transport Block specific parameters */
/** Struct which stores Transport Block specific parameters */
struct rte_bbdev_op_dec_turbo_tb_params tb_params;
};
};
@ -554,7 +554,7 @@ struct rte_bbdev_op_enc_turbo_tb_params {
* the Turbo operation when r >= C-, [K:3*Kpi]
*/
uint16_t ncb_pos;
/**< The index of the first CB in the inbound mbuf data, default is 0 */
/** The index of the first CB in the inbound mbuf data, default is 0 */
uint8_t r;
};
@ -751,11 +751,11 @@ enum {
/** Structure specifying a single encode operation */
struct rte_bbdev_enc_op {
/**< Status of operation that was performed */
/** Status of operation that was performed */
int status;
/**< Mempool which op instance is in */
/** Mempool which op instance is in */
struct rte_mempool *mempool;
/**< Opaque pointer for user data */
/** Opaque pointer for user data */
void *opaque_data;
union {
/** Contains turbo decoder specific parameters */
@ -792,7 +792,7 @@ struct rte_bbdev_op_cap {
} cap; /**< Operation-type specific capabilities */
};
/**< @internal Private data structure stored with operation pool. */
/** @internal Private data structure stored with operation pool. */
struct rte_bbdev_op_pool_private {
enum rte_bbdev_op_type type; /**< Type of operations in a pool */
};

14
lib/librte_bbdev/rte_bbdev_pmd.h
View File

@ -146,18 +146,18 @@ typedef int (*rte_bbdev_queue_intr_disable_t)(struct rte_bbdev *dev,
* fields are for non-vital operations
*/
struct rte_bbdev_ops {
/**< Allocate and configure device memory. Optional. */
/** Allocate and configure device memory. Optional. */
rte_bbdev_setup_queues_t setup_queues;
/**< Configure interrupts. Optional. */
/** Configure interrupts. Optional. */
rte_bbdev_intr_enable_t intr_enable;
/**< Start device. Optional. */
/** Start device. Optional. */
rte_bbdev_start_t start;
/**< Stop device. Optional. */
/** Stop device. Optional. */
rte_bbdev_stop_t stop;
/**< Close device. Optional. */
/** Close device. Optional. */
rte_bbdev_close_t close;
/**< Get device info. Required. */
/** Get device info. Required. */
rte_bbdev_info_get_t info_get;
/** Get device statistics. Optional. */
rte_bbdev_stats_get_t stats_get;
@ -170,7 +170,7 @@ struct rte_bbdev_ops {
rte_bbdev_queue_release_t queue_release;
/** Start a queue. Optional. */
rte_bbdev_queue_start_t queue_start;
/**< Stop a queue pair. Optional. */
/** Stop a queue pair. Optional. */
rte_bbdev_queue_stop_t queue_stop;
/** Enable queue interrupt. Optional */