From: Yongseok Koh <yskoh@mellanox.com>
To: yliu@fridaylinux.org
Cc: stable@dpdk.org, shahafs@mellanox.com,
adrien.mazarguil@6wind.com, nelio.laranjeiro@6wind.com
Subject: [dpdk-stable] [PATCH v2 22/67] net/mlx5: add missing function documentation
Date: Mon, 4 Jun 2018 17:37:13 -0700 [thread overview]
Message-ID: <20180605003721.14367-3-yskoh@mellanox.com> (raw)
In-Reply-To: <20180605003721.14367-1-yskoh@mellanox.com>
From: Nélio Laranjeiro <nelio.laranjeiro@6wind.com>
[ upstream commit fb732b0a49c22ee7aeae4a23aab834feb5dfd1d4 ]
Signed-off-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>
Acked-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
---
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 0266a4fe5..764549b63 100644
--- a/drivers/net/mlx5/mlx5_ethdev.c
+++ b/drivers/net/mlx5/mlx5_ethdev.c
@@ -460,6 +460,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)
{
@@ -492,6 +501,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)
@@ -555,6 +567,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)
@@ -758,6 +773,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 ee4848446..75de5a44d 100644
--- a/drivers/net/mlx5/mlx5_mr.c
+++ b/drivers/net/mlx5/mlx5_mr.c
@@ -271,6 +271,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.
*/
@@ -331,6 +332,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.
*/
@@ -381,9 +383,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 003959213..68b03d246 100644
--- a/drivers/net/mlx5/mlx5_rxq.c
+++ b/drivers/net/mlx5/mlx5_rxq.c
@@ -827,9 +827,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)
@@ -1081,9 +1082,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)
@@ -1234,9 +1236,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)
@@ -1403,9 +1406,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 2d9bb86ea..ad15158fe 100644
--- a/drivers/net/mlx5/mlx5_trigger.c
+++ b/drivers/net/mlx5/mlx5_trigger.c
@@ -41,6 +41,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)
{
@@ -50,6 +56,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)
{
@@ -85,6 +100,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)
{
@@ -94,6 +115,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 3741103d7..09d62a95b 100644
--- a/drivers/net/mlx5/mlx5_txq.c
+++ b/drivers/net/mlx5/mlx5_txq.c
@@ -547,9 +547,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)
@@ -794,9 +795,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
next prev parent reply other threads:[~2018-06-05 0:37 UTC|newest]
Thread overview: 69+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-05 0:27 [dpdk-stable] [PATCH v2 00/67] net/mlx5: backport patches for v17.11.3 LTS Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 01/67] net/mlx5: remove get priv internal function Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 02/67] net/mlx4: store RSS hash result in mbufs Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 03/67] net/mlx5: fix synchronization on polling Rx completions Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 04/67] net/mlx5: fix allocation when no memory on device NUMA node Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 05/67] net/mlx5: fix flow director conversion Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 06/67] net/mlx5: fix reception of multiple MAC addresses Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 07/67] net/mlx5: fix secondary process mempool registration Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 08/67] net/mlx5: remove assert un-accessible from secondary process Yongseok Koh
2018-06-05 0:27 ` [dpdk-stable] [PATCH v2 09/67] net/mlx5: warn for unsuccessful memory registration Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 10/67] net/mlx5: map UAR address around huge pages Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 11/67] net/mlx4: fix single port configuration Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 12/67] net/mlx4: fix broadcast Rx Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 13/67] net/mlx4: fix removal detection of stopped port Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 14/67] net/mlx5: fix CRC strip capability query Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 15/67] net/mlx5: fix close after start failure Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 16/67] net/mlx: control netdevices through ioctl only Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 17/67] net/mlx5: fix disabling Tx packet inlining Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 18/67] net/mlx5: fix sriov flag Yongseok Koh
2018-06-05 0:35 ` [dpdk-stable] [PATCH v2 19/67] net/mlx5: name parameters in function prototypes Yongseok Koh
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 20/67] net/mlx5: mark parameters with unused attribute Yongseok Koh
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 21/67] net/mlx5: normalize function prototypes Yongseok Koh
2018-06-05 0:37 ` Yongseok Koh [this message]
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 23/67] net/mlx5: remove useless empty lines Yongseok Koh
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 24/67] net/mlx5: remove control path locks Yongseok Koh
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 25/67] net/mlx5: prefix all functions with mlx5 Yongseok Koh
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 26/67] net/mlx5: change non failing function return values Yongseok Koh
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 27/67] net/mlx5: standardize on negative errno values Yongseok Koh
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 28/67] net/mlx5: use port id in PMD log Yongseok Koh
2018-06-05 0:37 ` [dpdk-stable] [PATCH v2 29/67] net/mlx5: use dynamic logging Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 30/67] net/mlx5: remove kernel version check Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 31/67] net/mlx5: change pkt burst select function prototype Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 32/67] net/mlx5: fix link status behavior Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 33/67] net/mlx5: fix link status to use wait to complete Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 34/67] net/mlx5: change tunnel flow priority Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 35/67] net/mlx5: improve flow error explanation Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 36/67] net/mlx5: refuse empty VLAN flow specification Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 37/67] net/mlx5: fix icc build Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 38/67] net/mlx5: setup RSS regardless of queue count Yongseok Koh
2018-06-05 0:38 ` [dpdk-stable] [PATCH v2 39/67] net/mlx5: enforce RSS key length limitation Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 40/67] net/mlx5: fix RSS key length query Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 41/67] net/mlx4: fix a typo in header file Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 42/67] net/mlx5: remove 32-bit support Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 43/67] net/mlx5: remove excessive data prefetch Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 44/67] net/mlx5: fix link status initialization Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 45/67] net/mlx4: fix RSS resource leak in case of error Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 46/67] net/mlx5: fix RSS flow action bounds check Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 47/67] net/mlx5: fix invalid flow item check Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 48/67] net/mlx5: split L3/L4 in flow director Yongseok Koh
2018-06-05 0:39 ` [dpdk-stable] [PATCH v2 49/67] net/mlx5: fix flow director mask Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 50/67] net/mlx5: fix flow director rule deletion crash Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 51/67] net/mlx4: fix Rx resource leak in case of error Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 52/67] net/mlx5: fix ethtool link setting call order Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 53/67] net/mlx5: fix socket connection return value Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 54/67] net/mlx5: add data-plane debug message macro Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 55/67] net/mlx5: fix probe return value polarity Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 56/67] net/mlx5: fix flow validation Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 57/67] net/mlx4: fix UDP flow rule limitation enforcement Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 58/67] net/mlx5: fix double free on error handling Yongseok Koh
2018-06-05 0:40 ` [dpdk-stable] [PATCH v2 59/67] net/mlx5: fix resource leak in case of error Yongseok Koh
2018-06-05 0:41 ` [dpdk-stable] [PATCH v2 60/67] net/mlx5: fix calculation of Tx TSO inline room size Yongseok Koh
2018-06-05 0:41 ` [dpdk-stable] [PATCH v2 61/67] net/mlx5: change device reference for secondary process Yongseok Koh
2018-06-05 0:41 ` [dpdk-stable] [PATCH v2 62/67] net/mlx4: avoid constant recreations in function Yongseok Koh
2018-06-05 0:41 ` [dpdk-stable] [PATCH v2 63/67] net/mlx5: fix flow director drop rule deletion crash Yongseok Koh
2018-06-05 0:41 ` [dpdk-stable] [PATCH v2 64/67] net/mlx5: fix build with clang on ARM Yongseok Koh
2018-06-05 0:41 ` [dpdk-stable] [PATCH v2 65/67] net/mlx5: fix count in xstats Yongseok Koh
2018-06-05 0:41 ` [dpdk-stable] [PATCH v2 66/67] net: add IPv6 header fields macros Yongseok Koh
2018-06-05 0:41 ` [dpdk-stable] [PATCH v2 67/67] net/mlx5: fix IPv6 header fields Yongseok Koh
2018-06-08 15:25 ` [dpdk-stable] [PATCH v2 00/67] net/mlx5: backport patches for v17.11.3 LTS Yuanhan Liu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180605003721.14367-3-yskoh@mellanox.com \
--to=yskoh@mellanox.com \
--cc=adrien.mazarguil@6wind.com \
--cc=nelio.laranjeiro@6wind.com \
--cc=shahafs@mellanox.com \
--cc=stable@dpdk.org \
--cc=yliu@fridaylinux.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).