[PATCH] doc: commands changed in testpmd_funcs for ethertype filter

[PATCH] doc: commands changed in testpmd_funcs for ethertype filter

[Jingjing Wu]

new commands for ethertype filter
  - ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr)
    (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)

Signed-off-by: Jingjing Wu <jingjing.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 51 +++++++----------------------
 1 file changed, 12 insertions(+), 39 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index be935c2..218835a 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -1392,61 +1392,34 @@ Filter Functions
 
 This section details the available filter functions that are available.
 
-add_ethertype_filter
+ethertype_filter
 ~~~~~~~~~~~~~~~~~~~~
 
-Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
+Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
 
-add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx)
+ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
 
 The available information parameters are:
 
 *   port_id:  the port which the Ethertype filter assigned on.
 
-*   eth_value: the EtherType value want to match,
-    for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
-
-*   enable: user priority participates in the match.
-
-*   disable: user priority doesn't participate in the match.
-
-*   pri_value: user priority value that want to match.
-
-*   queue_id : The receive queue associated with this EtherType filter
+*   mac_addr: compare destination mac address.
 
-*   index: the index of this EtherType filter
+*   mac_ignr: ignore destination mac address match.
 
-Example:
-
-.. code-block:: console
+*   mac_address: destination mac address to match.
 
-    testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
-    Assign ARP packet to receive queue 3
-
-remove_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Remove a L2 Ethertype filter
-
-remove_ethertype_filter (port_id) index (idx)
-
-get_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Get and display a L2 Ethertype filter
+*   ether_type: the EtherType value want to match,
+    for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
 
-get_ethertype_filter (port_id) index (idx)
+*   queue_id : The receive queue associated with this EtherType filter. It is meaningless when deleting or dropping.
 
-Example:
+Example, to add/remove an ethertype filter rule:
 
 .. code-block:: console
 
-    testpmd> get_ethertype_filter 0 index 0
-
-    filter[0]:
-        ethertype: 0x0806
-        priority: disable, 0
-        queue: 3
+    testpmd> ethertype_filter 0 add mac_ignr ethertype 0x0806 fwd queue 3
+    testpmd> ethertype_filter 0 del mac_ignr ethertype 0x0806 fwd queue 3
 
 add_2tuple_filter
 ~~~~~~~~~~~~~~~~~
-- 
1.9.3

Re: [PATCH] doc: commands changed in testpmd_funcs for ethertype filter

[Thomas Monjalon]

Hi Jingjing,

Few comments about how to send a v2 patch (as described in http://dpdk.org/dev#send):
--subject-prefix 'PATCH v2' to make it clear that it supersedes a previous version
--annotate to add a changelog below the three dashes
--in-reply-to <Message-ID> to have the versions threaded together
http://dpdk.org/dev/patchwork to set the previous version as superseded

2015-01-22 09:09, Jingjing Wu:
> new commands for ethertype filter
>   - ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr)
>     (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
> 
> Signed-off-by: Jingjing Wu <jingjing.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Applied

Thanks
-- 
Thomas

Re: [PATCH] doc: commands changed in testpmd_funcs for ethertype filter

[Iremonger, Bernard]

> -----Original Message-----
> From: dev [mailto:dev-bounces-VfR2kkLFssw@public.gmane.org] On Behalf Of Jingjing Wu
> Sent: Thursday, January 22, 2015 1:09 AM
> To: dev-VfR2kkLFssw@public.gmane.org
> Subject: [dpdk-dev] [PATCH] doc: commands changed in testpmd_funcs for ethertype filter
> 
> new commands for ethertype filter
>   - ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr)
>     (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
> 
> Signed-off-by: Jingjing Wu <jingjing.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 51 +++++++----------------------
>  1 file changed, 12 insertions(+), 39 deletions(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index be935c2..218835a 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -1392,61 +1392,34 @@ Filter Functions
> 
>  This section details the available filter functions that are available.
> 
> -add_ethertype_filter
> +ethertype_filter
>  ~~~~~~~~~~~~~~~~~~~~
> 
> -Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive
> queue.
> +Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to
> a receive queue.
> 
> -add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue
> (queue_id) index (idx)
> +ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) ethertype (ether_type)
> (drop|fwd) queue (queue_id)
> 
>  The available information parameters are:
> 
>  *   port_id:  the port which the Ethertype filter assigned on.
> 
> -*   eth_value: the EtherType value want to match,
> -    for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
> -
> -*   enable: user priority participates in the match.
> -
> -*   disable: user priority doesn't participate in the match.
> -
> -*   pri_value: user priority value that want to match.
> -
> -*   queue_id : The receive queue associated with this EtherType filter
> +*   mac_addr: compare destination mac address.
> 
> -*   index: the index of this EtherType filter
> +*   mac_ignr: ignore destination mac address match.
> 
> -Example:
> -
> -.. code-block:: console
> +*   mac_address: destination mac address to match.
> 
> -    testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
> -    Assign ARP packet to receive queue 3
> -
> -remove_ethertype_filter
> -~~~~~~~~~~~~~~~~~~~~~~~
> -
> -Remove a L2 Ethertype filter
> -
> -remove_ethertype_filter (port_id) index (idx)
> -
> -get_ethertype_filter
> -~~~~~~~~~~~~~~~~~~~~
> -
> -Get and display a L2 Ethertype filter
> +*   ether_type: the EtherType value want to match,
> +    for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
> 
> -get_ethertype_filter (port_id) index (idx)
> +*   queue_id : The receive queue associated with this EtherType filter. It is meaningless when
> deleting or dropping.
> 
> -Example:
> +Example, to add/remove an ethertype filter rule:
> 
>  .. code-block:: console
> 
> -    testpmd> get_ethertype_filter 0 index 0
> -
> -    filter[0]:
> -        ethertype: 0x0806
> -        priority: disable, 0
> -        queue: 3
> +    testpmd> ethertype_filter 0 add mac_ignr ethertype 0x0806 fwd queue 3
> +    testpmd> ethertype_filter 0 del mac_ignr ethertype 0x0806 fwd queue 3

Hi Jingjing,

There is a duplicate line here.
I have applied the patch and checked the HTML output (applies and builds cleanly).

Regards,

Bernard
> 
>  add_2tuple_filter
>  ~~~~~~~~~~~~~~~~~
> --
> 1.9.3

[PATCH] doc: commands changed in testpmd_funcs for ethertype filter

[Jingjing Wu]

new commands for ethertype filter
      - ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr)
        (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)

Signed-off-by: Jingjing Wu <jingjing.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 46 +++++++----------------------
 1 file changed, 11 insertions(+), 35 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index be935c2..61a7f6d 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -1397,56 +1397,32 @@ add_ethertype_filter
 
 Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
 
-add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx)
+ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
 
 The available information parameters are:
 
 *   port_id:  the port which the Ethertype filter assigned on.
 
-*   eth_value: the EtherType value want to match,
-    for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
-
-*   enable: user priority participates in the match.
-
-*   disable: user priority doesn't participate in the match.
-
-*   pri_value: user priority value that want to match.
-
-*   queue_id : The receive queue associated with this EtherType filter
+*   mac_addr: need compare destination mac address.
 
-*   index: the index of this EtherType filter
-
-Example:
-
-.. code-block:: console
+*   mac_ignr: ignore destination mac address match.
 
-    testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
-    Assign ARP packet to receive queue 3
+*   mac_address: destination mac address need to match.
 
-remove_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Remove a L2 Ethertype filter
-
-remove_ethertype_filter (port_id) index (idx)
-
-get_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Get and display a L2 Ethertype filter
+*   ether_type: the EtherType value want to match,
+    for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
 
-get_ethertype_filter (port_id) index (idx)
+*   queue_id : The receive queue associated with this EtherType filter. It is meaningless when deleting or dropping.
 
 Example:
 
 .. code-block:: console
 
-    testpmd> get_ethertype_filter 0 index 0
+    testpmd> ethertype_filter 0 add mac_ignr ethertype 0x0806 fwd queue 3
+    add a rule to assign ARP packet to receive queue 3
 
-    filter[0]:
-        ethertype: 0x0806
-        priority: disable, 0
-        queue: 3
+	testpmd> ethertype_filter 0 del mac_ignr ethertype 0x0806 fwd queue 3
+    delete the rule to assign ARP packet to receive queue 3
 
 add_2tuple_filter
 ~~~~~~~~~~~~~~~~~
-- 
1.9.3

Re: [PATCH] doc: commands changed in testpmd_funcs for ethertype filter

[Thomas Monjalon]

Hi Jingjing,

Thanks for providing a patch quickly for the missing doc.
I have a few comments.

2015-01-21 16:30, Jingjing Wu:
> new commands for ethertype filter
>       - ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr)
>         (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
> 
> Signed-off-by: Jingjing Wu <jingjing.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 46 +++++++----------------------
>  1 file changed, 11 insertions(+), 35 deletions(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index be935c2..61a7f6d 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -1397,56 +1397,32 @@ add_ethertype_filter
>  
>  Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
>  
> -add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx)
> +ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
>  
>  The available information parameters are:
>  
>  *   port_id:  the port which the Ethertype filter assigned on.
>  
> -*   eth_value: the EtherType value want to match,
> -    for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
> -
> -*   enable: user priority participates in the match.
> -
> -*   disable: user priority doesn't participate in the match.
> -
> -*   pri_value: user priority value that want to match.
> -
> -*   queue_id : The receive queue associated with this EtherType filter
> +*   mac_addr: need compare destination mac address.

is "need" needed? ;)
mac_addr: compare destination mac address.

>  
> -*   index: the index of this EtherType filter
> -
> -Example:
> -
> -.. code-block:: console
> +*   mac_ignr: ignore destination mac address match.
>  
> -    testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
> -    Assign ARP packet to receive queue 3
> +*   mac_address: destination mac address need to match.

again, I would remove "need"
mac_address: destination mac address to match.

>  
> -remove_ethertype_filter
> -~~~~~~~~~~~~~~~~~~~~~~~
> -
> -Remove a L2 Ethertype filter
> -
> -remove_ethertype_filter (port_id) index (idx)
> -
> -get_ethertype_filter
> -~~~~~~~~~~~~~~~~~~~~
> -
> -Get and display a L2 Ethertype filter
> +*   ether_type: the EtherType value want to match,
> +    for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
>  
> -get_ethertype_filter (port_id) index (idx)
> +*   queue_id : The receive queue associated with this EtherType filter. It is meaningless when deleting or dropping.

Do you mean queue_id is optional?

>  
>  Example:
>  
>  .. code-block:: console
>  
> -    testpmd> get_ethertype_filter 0 index 0
> +    testpmd> ethertype_filter 0 add mac_ignr ethertype 0x0806 fwd queue 3
> +    add a rule to assign ARP packet to receive queue 3

You are adding a comment in the code-block. Not sure it is a good idea.

>  
> -    filter[0]:
> -        ethertype: 0x0806
> -        priority: disable, 0
> -        queue: 3
> +	testpmd> ethertype_filter 0 del mac_ignr ethertype 0x0806 fwd queue 3

The indent is strange here.

> +    delete the rule to assign ARP packet to receive queue 3
>  
>  add_2tuple_filter
>  ~~~~~~~~~~~~~~~~~
> 


-- 
Thomas