From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr0-f195.google.com (mail-wr0-f195.google.com [209.85.128.195]) by dpdk.org (Postfix) with ESMTP id DFFD04CB9 for ; Wed, 28 Feb 2018 16:13:38 +0100 (CET) Received: by mail-wr0-f195.google.com with SMTP id n7so2794577wrn.5 for ; Wed, 28 Feb 2018 07:13:38 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :in-reply-to:references; bh=ulZ6DyEvp5ZkHDpQAie/7q0jusq/2c7tZEBb3+GJ7pw=; b=XJFO+jYnmbFYVw3ECx8IkhLjzaDJQdodLEgmiXTA+mOz66S6MSPskaZRrPOi7aexXu u8Xzw2A86a/QocL6OEXsG/TPcBqFPnQg9MVqhsshUQHJYx4WpprA6PkP0+9RlcWB2GGn 30gwgyFokCXFfTkUPCvcE63Tf+vDkC9MtMmjxQQHKAZAtwD4VF9zS+fQM5btarg4azFu kfiY8E3aR8dKpyt5HxMTFEq6B3+Db1RdTjJ8v8kGDd9rxj5B/nywDIJDmu8mvZNtOFXl yyzFuO8tlHXzooGtzvPvHdFIJmM6TXOkuI+vzCdhIIpVOY5QzwWKEpR4RKAnCtbc2ci9 f4DQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:in-reply-to:references; bh=ulZ6DyEvp5ZkHDpQAie/7q0jusq/2c7tZEBb3+GJ7pw=; b=aWNIUHgw4bl8bf+isLpQQz7pIW15MBebJR6qosMACRWoqbaaA8OYT/EhvaerdAZB9P xspKegPVb9VSFVNtEQw9jpurWugtTB4gEXJswuztjTC1ON8VLnfhGutvOZzBpUOhbSWh fneLSIqhiLFnzxg5dA4GRNXx6AsuUfe/paOcpCDw6HvhhUtn0Dp9JhV5SPGQ1IRETlUG rfYoXsmrXpVig+g1CLX9voGA0ZcOOn0q2LVADOC/zj4yTpNY/gyBvALrak/NEctxZdkR M/ouMF6zIkeXkhugGxwEZ0ZlueYoKsRJ7RMPvmWiXvZK180aTwLvCLzi1j+8aqgDz2RA JviA== X-Gm-Message-State: APf1xPBqQA5/bplGX/mYTD4kxckFs79IP9GE3TrGuGBHSzt+YwNS1iI1 6DeU0W1Zs5+0wU7oJ+8lXPu9Sl/x2A== X-Google-Smtp-Source: AG47ELs0OrX8JDC2PDLYFzpEx3WO3ZoxrfK4gqQJMyhxgnHB4bPdxIOsJ3Q0wB0qo3LnrpxgWet99g== X-Received: by 10.223.190.15 with SMTP id n15mr1203224wrh.82.1519830818270; Wed, 28 Feb 2018 07:13:38 -0800 (PST) Received: from laranjeiro-vm.dev.6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id e18sm4281944wmc.21.2018.02.28.07.13.37 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 28 Feb 2018 07:13:37 -0800 (PST) From: Nelio Laranjeiro To: dev@dpdk.org Cc: Adrien Mazarguil , Yongseok Koh Date: Wed, 28 Feb 2018 16:12:45 +0100 Message-Id: <7d52c62426ecc6151650890feb7b2b66ff5a628d.1519829860.git.nelio.laranjeiro@6wind.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: References: In-Reply-To: References: Subject: [dpdk-dev] [PATCH v2 05/10] net/mlx5: add missing function documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 28 Feb 2018 15:13:39 -0000 Signed-off-by: Nelio Laranjeiro Acked-by: Adrien Mazarguil --- drivers/net/mlx5/mlx5_ethdev.c | 18 ++++++++++++++++++ drivers/net/mlx5/mlx5_mr.c | 7 +++++-- drivers/net/mlx5/mlx5_rxq.c | 20 ++++++++++++-------- drivers/net/mlx5/mlx5_trigger.c | 30 ++++++++++++++++++++++++++++++ drivers/net/mlx5/mlx5_txq.c | 10 ++++++---- 5 files changed, 71 insertions(+), 14 deletions(-) diff --git a/drivers/net/mlx5/mlx5_ethdev.c b/drivers/net/mlx5/mlx5_ethdev.c index 0c383deba..9bbf1eb7d 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 4e1495800..8748ddcf5 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 2fc6e08aa..6924202cc 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 72e8ff644..b147fb4f8 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 @@ priv_txq_start(struct priv *priv) 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 1a508a488..9be707840 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) -- 2.11.0