diff mbox

[dpdk-dev] doc: add VLAN flow limitation on mlx5 PMD

Message ID 20170606142016.140162-1-shahafs@mellanox.com (mailing list archive)
State Superseded, archived
Headers

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK

Commit Message

Shahaf Shuler June 6, 2017, 2:20 p.m. UTC 
  On mlx5 PMD Flow pattern without any specific vlan will match for vlan
packets as well.

Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
Acked-by: Nelio Laranjeiro nelio.laranjeiro@6wind.com
---
 doc/guides/rel_notes/release_17_08.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

Comments

Adrien Mazarguil June 12, 2017, 2:27 p.m. UTC | #1 
Hi Shahaf,

On Tue, Jun 06, 2017 at 05:20:16PM +0300, Shahaf Shuler wrote:
> On mlx5 PMD Flow pattern without any specific vlan will match for vlan
> packets as well.
> 
> Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> Acked-by: Nelio Laranjeiro nelio.laranjeiro@6wind.com
> ---
>  doc/guides/rel_notes/release_17_08.rst | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_17_08.rst b/doc/guides/rel_notes/release_17_08.rst
> index 7f1212094..bd219640c 100644
> --- a/doc/guides/rel_notes/release_17_08.rst
> +++ b/doc/guides/rel_notes/release_17_08.rst
> @@ -111,6 +111,22 @@ Known Issues
>     Also, make sure to start the actual text at the margin.
>     =========================================================
>  
> +* **On mlx5 PMD, Flow pattern without any specific vlan will match for vlan packets as well.**
> +
> +  When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
> +  Meaning, the flow rule::
> +
> +        flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
> +
> +  Will only match vlan packets with vid=3. and the flow rules::
> +
> +        flow create 0 ingress pattern eth / ipv4 / end ...
> +
> +  Or::
> +
> +        flow create 0 ingress pattern eth / vlan / ipv4 / end ...
> +
> +  Will match any ipv4 packet (VLAN included).
>  
>  API Changes
>  -----------

I do not think this should be part of the release notes as it is not a new
behavior introduced by a commit for 17.08. It has been the case since VLAN
support was added to the mlx5 rte_flow implementation back in 17.02.

Please move this info to guide/nics/mlx5.rst, the resulting documentation
commit should likely be CC'ed to stable@dpdk.org against "net/mlx5: support
VLAN flow item".
diff mbox

Patch

diff --git a/doc/guides/rel_notes/release_17_08.rst b/doc/guides/rel_notes/release_17_08.rst
index 7f1212094..bd219640c 100644
--- a/doc/guides/rel_notes/release_17_08.rst
+++ b/doc/guides/rel_notes/release_17_08.rst
@@ -111,6 +111,22 @@  Known Issues
    Also, make sure to start the actual text at the margin.
    =========================================================
 
+* **On mlx5 PMD, Flow pattern without any specific vlan will match for vlan packets as well.**
+
+  When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
+  Meaning, the flow rule::
+
+        flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
+
+  Will only match vlan packets with vid=3. and the flow rules::
+
+        flow create 0 ingress pattern eth / ipv4 / end ...
+
+  Or::
+
+        flow create 0 ingress pattern eth / vlan / ipv4 / end ...
+
+  Will match any ipv4 packet (VLAN included).
 
 API Changes
 -----------