From: Nélio Laranjeiro Date: Mon, 5 Mar 2018 12:21:01 +0000 (+0100) Subject: net/mlx5: add missing function documentation X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=fb732b0a49c22ee7aeae4a23aab834feb5dfd1d4;p=dpdk.git net/mlx5: add missing function documentation Signed-off-by: Nelio Laranjeiro Acked-by: Adrien Mazarguil --- diff --git a/drivers/net/mlx5/mlx5_ethdev.c b/drivers/net/mlx5/mlx5_ethdev.c index 0c383deba7..9bbf1eb7d0 100644 --- a/drivers/net/mlx5/mlx5_ethdev.c +++ b/drivers/net/mlx5/mlx5_ethdev.c @@ -435,6 +435,15 @@ mlx5_dev_infos_get(struct rte_eth_dev *dev, struct rte_eth_dev_info *info) priv_unlock(priv); } +/** + * Get supported packet types. + * + * @param dev + * Pointer to Ethernet device structure. + * + * @return + * A pointer to the supported Packet types array. + */ const uint32_t * mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev) { @@ -467,6 +476,9 @@ mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev) * * @param dev * Pointer to Ethernet device structure. + * + * @return + * 0 on success, -1 on error. */ static int mlx5_link_update_unlocked_gset(struct rte_eth_dev *dev) @@ -530,6 +542,9 @@ mlx5_link_update_unlocked_gset(struct rte_eth_dev *dev) * * @param dev * Pointer to Ethernet device structure. + * + * @return + * 0 on success, -1 on error. */ static int mlx5_link_update_unlocked_gs(struct rte_eth_dev *dev) @@ -733,6 +748,9 @@ priv_force_link_status_change(struct priv *priv, int status) * Pointer to Ethernet device structure. * @param wait_to_complete * Wait for request completion (ignored). + * + * @return + * 0 on success, -1 on error. */ int mlx5_link_update(struct rte_eth_dev *dev, int wait_to_complete __rte_unused) diff --git a/drivers/net/mlx5/mlx5_mr.c b/drivers/net/mlx5/mlx5_mr.c index 4e1495800f..8748ddcf5c 100644 --- a/drivers/net/mlx5/mlx5_mr.c +++ b/drivers/net/mlx5/mlx5_mr.c @@ -242,6 +242,7 @@ mlx5_mp2mr_iter(struct rte_mempool *mp, void *arg) * Pointer to private structure. * @param mp * Pointer to the memory pool to register. + * * @return * The memory region on success. */ @@ -302,6 +303,7 @@ priv_mr_new(struct priv *priv, struct rte_mempool *mp) * Pointer to private structure. * @param mp * Pointer to the memory pool to register. + * * @return * The memory region on success. */ @@ -352,9 +354,10 @@ priv_mr_release(struct priv *priv __rte_unused, struct mlx5_mr *mr) * Verify the flow list is empty * * @param priv - * Pointer to private structure. + * Pointer to private structure. * - * @return the number of object not released. + * @return + * The number of object not released. */ int priv_mr_verify(struct priv *priv) diff --git a/drivers/net/mlx5/mlx5_rxq.c b/drivers/net/mlx5/mlx5_rxq.c index 2fc6e08aa7..6924202cc8 100644 --- a/drivers/net/mlx5/mlx5_rxq.c +++ b/drivers/net/mlx5/mlx5_rxq.c @@ -883,9 +883,10 @@ mlx5_priv_rxq_ibv_release(struct priv *priv, struct mlx5_rxq_ibv *rxq_ibv) * Verify the Verbs Rx queue list is empty * * @param priv - * Pointer to private structure. + * Pointer to private structure. * - * @return the number of object not released. + * @return + * The number of object not released. */ int mlx5_priv_rxq_ibv_verify(struct priv *priv) @@ -1139,9 +1140,10 @@ mlx5_priv_rxq_releasable(struct priv *priv, uint16_t idx) * Verify the Rx Queue list is empty * * @param priv - * Pointer to private structure. + * Pointer to private structure. * - * @return the number of object not released. + * @return + * The number of object not released. */ int mlx5_priv_rxq_verify(struct priv *priv) @@ -1293,9 +1295,10 @@ mlx5_priv_ind_table_ibv_release(struct priv *priv, * Verify the Rx Queue list is empty * * @param priv - * Pointer to private structure. + * Pointer to private structure. * - * @return the number of object not released. + * @return + * The number of object not released. */ int mlx5_priv_ind_table_ibv_verify(struct priv *priv) @@ -1462,9 +1465,10 @@ mlx5_priv_hrxq_release(struct priv *priv, struct mlx5_hrxq *hrxq) * Verify the Rx Queue list is empty * * @param priv - * Pointer to private structure. + * Pointer to private structure. * - * @return the number of object not released. + * @return + * The number of object not released. */ int mlx5_priv_hrxq_ibv_verify(struct priv *priv) diff --git a/drivers/net/mlx5/mlx5_trigger.c b/drivers/net/mlx5/mlx5_trigger.c index 72e8ff6440..b147fb4f8b 100644 --- a/drivers/net/mlx5/mlx5_trigger.c +++ b/drivers/net/mlx5/mlx5_trigger.c @@ -14,6 +14,12 @@ #include "mlx5_rxtx.h" #include "mlx5_utils.h" +/** + * Stop traffic on Tx queues. + * + * @param dev + * Pointer to Ethernet device structure. + */ static void priv_txq_stop(struct priv *priv) { @@ -23,6 +29,15 @@ priv_txq_stop(struct priv *priv) mlx5_priv_txq_release(priv, i); } +/** + * Start traffic on Tx queues. + * + * @param dev + * Pointer to Ethernet device structure. + * + * @return + * 0 on success, errno on error. + */ static int priv_txq_start(struct priv *priv) { @@ -58,6 +73,12 @@ error: return ret; } +/** + * Stop traffic on Rx queues. + * + * @param dev + * Pointer to Ethernet device structure. + */ static void priv_rxq_stop(struct priv *priv) { @@ -67,6 +88,15 @@ priv_rxq_stop(struct priv *priv) mlx5_priv_rxq_release(priv, i); } +/** + * Start traffic on Rx queues. + * + * @param dev + * Pointer to Ethernet device structure. + * + * @return + * 0 on success, errno on error. + */ static int priv_rxq_start(struct priv *priv) { diff --git a/drivers/net/mlx5/mlx5_txq.c b/drivers/net/mlx5/mlx5_txq.c index 1a508a4880..9be7078405 100644 --- a/drivers/net/mlx5/mlx5_txq.c +++ b/drivers/net/mlx5/mlx5_txq.c @@ -614,9 +614,10 @@ mlx5_priv_txq_ibv_releasable(struct priv *priv __rte_unused, * Verify the Verbs Tx queue list is empty * * @param priv - * Pointer to private structure. + * Pointer to private structure. * - * @return the number of object not released. + * @return + * The number of object not released. */ int mlx5_priv_txq_ibv_verify(struct priv *priv) @@ -893,9 +894,10 @@ mlx5_priv_txq_releasable(struct priv *priv, uint16_t idx) * Verify the Tx Queue list is empty * * @param priv - * Pointer to private structure. + * Pointer to private structure. * - * @return the number of object not released. + * @return + * The number of object not released. */ int mlx5_priv_txq_verify(struct priv *priv)