From: Dekel Peled <dekelp@mellanox.com>
To: matan@mellanox.com, viacheslavo@mellanox.com
Cc: rasland@mellanox.com, orika@mellanox.com, dev@dpdk.org
Subject: [dpdk-dev] [PATCH 10/11] net/mlx5: update description of validation funcs
Date: Wed, 22 Jan 2020 16:27:22 +0200 [thread overview]
Message-ID: <6d40b36e3eb4dea2d044299bbc4de87dcc613bdb.1579703134.git.dekelp@mellanox.com> (raw)
In-Reply-To: <cover.1579703134.git.dekelp@mellanox.com>
Description of several functions is not accurate.
This patch updates the description, parameter names etc.
Signed-off-by: Dekel Peled <dekelp@mellanox.com>
Acked-by: Ori Kam <orika@mellanox.com>
---
drivers/net/mlx5/mlx5_flow_dv.c | 28 ++++++++++++----------------
1 file changed, 12 insertions(+), 16 deletions(-)
diff --git a/drivers/net/mlx5/mlx5_flow_dv.c b/drivers/net/mlx5/mlx5_flow_dv.c
index 4b6a92c..059d03f 100644
--- a/drivers/net/mlx5/mlx5_flow_dv.c
+++ b/drivers/net/mlx5/mlx5_flow_dv.c
@@ -1662,14 +1662,10 @@ struct field_modify_info modify_tcp[] = {
/**
* Get VLAN default info from vlan match info.
*
- * @param[in] dev
- * Pointer to the rte_eth_dev structure.
- * @param[in] item
+ * @param[in] items
* the list of item specifications.
* @param[out] vlan
* pointer VLAN info to fill to.
- * @param[out] error
- * Pointer to error structure.
*
* @return
* 0 on success, a negative errno value otherwise and rte_errno is set.
@@ -1721,8 +1717,10 @@ struct field_modify_info modify_tcp[] = {
*
* @param[in] action_flags
* Holds the actions detected until now.
+ * @param[in] item_flags
+ * The items found in this flow rule.
* @param[in] action
- * Pointer to the encap action.
+ * Pointer to the action structure.
* @param[in] attr
* Pointer to flow attributes
* @param[out] error
@@ -1772,8 +1770,6 @@ struct field_modify_info modify_tcp[] = {
* Holds the actions detected until now.
* @param[in] actions
* Pointer to the list of actions remaining in the flow rule.
- * @param[in] attr
- * Pointer to flow attributes
* @param[out] error
* Pointer to error structure.
*
@@ -1988,7 +1984,7 @@ struct field_modify_info modify_tcp[] = {
* @param[in] dev
* Pointer to the rte_eth_dev structure.
* @param[in] action
- * Pointer to the encap action.
+ * Pointer to the action structure.
* @param[in] action_flags
* Holds the actions detected until now.
* @param[in] attr
@@ -2049,7 +2045,7 @@ struct field_modify_info modify_tcp[] = {
* @param[in] dev
* Pointer to the rte_eth_dev structure.
* @param[in] action
- * Pointer to the encap action.
+ * Pointer to the action structure.
* @param[in] action_flags
* Holds the actions detected until now.
* @param[in] attr
@@ -2103,7 +2099,7 @@ struct field_modify_info modify_tcp[] = {
* Validate count action.
*
* @param[in] dev
- * device otr.
+ * Pointer to rte_eth_dev structure.
* @param[out] error
* Pointer to error structure.
*
@@ -2135,7 +2131,7 @@ struct field_modify_info modify_tcp[] = {
* @param[in] action_flags
* Holds the actions detected until now.
* @param[in] action
- * Pointer to the encap action.
+ * Pointer to the action structure.
* @param[in] attr
* Pointer to flow attributes
* @param[out] error
@@ -2995,12 +2991,12 @@ struct field_modify_info modify_tcp[] = {
*
* @param[in] dev
* Pointer to rte_eth_dev structure.
- * @param[in] vlan_tag
- * the vlan tag to push to the Ethernet header.
- * @param[in, out] dev_flow
- * Pointer to the mlx5_flow.
* @param[in] attr
* Pointer to the flow attributes.
+ * @param[in] vlan
+ * Pointer to the vlan to push to the Ethernet header.
+ * @param[in, out] dev_flow
+ * Pointer to the mlx5_flow.
* @param[out] error
* Pointer to the error structure.
*
--
1.8.3.1
next prev parent reply other threads:[~2020-01-22 14:31 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-22 14:27 [dpdk-dev] [PATCH 00/11] net/mlx5: vlan actions validation fixes Dekel Peled
2020-01-22 14:27 ` [dpdk-dev] [PATCH 01/11] net/mlx5: fix masks of encap and decap actions Dekel Peled
2020-01-23 7:56 ` Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 02/11] net/mlx5: fix invalid check for VLAN actions Dekel Peled
2020-01-23 7:56 ` Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 03/11] net/mlx5: fix bit mask used for push VLAN validate Dekel Peled
2020-01-23 7:56 ` Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 04/11] net/mlx5: fix allow push VLAN without VID value Dekel Peled
2020-01-23 7:57 ` Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 05/11] net/mlx5: unify validation of drop action Dekel Peled
2020-01-23 7:57 ` Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 06/11] net/mlx5: fix block push VLAN action on Rx Dekel Peled
2020-01-23 7:57 ` Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 07/11] net/mlx5: fix block pop VLAN action on Tx Dekel Peled
2020-01-23 7:57 ` Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 08/11] net/mlx5: fix pop VLAN action validation function Dekel Peled
2020-01-23 7:57 ` Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 09/11] net/mlx5: fix the set VLAN VID action validation Dekel Peled
2020-01-23 7:58 ` Slava Ovsiienko
2020-01-22 14:27 ` Dekel Peled [this message]
2020-01-23 7:58 ` [dpdk-dev] [PATCH 10/11] net/mlx5: update description of validation funcs Slava Ovsiienko
2020-01-22 14:27 ` [dpdk-dev] [PATCH 11/11] doc: update MLX5 supported hardware offloads table Dekel Peled
2020-01-23 7:58 ` Slava Ovsiienko
2020-01-26 15:48 ` [dpdk-dev] [PATCH 00/11] net/mlx5: vlan actions validation fixes Raslan Darawsheh
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=6d40b36e3eb4dea2d044299bbc4de87dcc613bdb.1579703134.git.dekelp@mellanox.com \
--to=dekelp@mellanox.com \
--cc=dev@dpdk.org \
--cc=matan@mellanox.com \
--cc=orika@mellanox.com \
--cc=rasland@mellanox.com \
--cc=viacheslavo@mellanox.com \
/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).