[PATCH] doc: add limitations for i40e PMD

[PATCH] doc: add limitations for i40e PMD

[Jingjing Wu]

This patch adds "Limitations or Known issues" section for
i40e PMD, including two items:
1. MPLS packet classification on X710/XL710
2. 16 Byte Descriptor cannot be used on DPDK VF

Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
---
 doc/guides/nics/i40e.rst | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 4d12b10..6df0f7a 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -411,3 +411,36 @@ configuration passed on the EAL command line.
 
 The floating VEB functionality requires a NIC firmware version of 5.0
 or greater.
+
+
+Limitations or Known issues
+---------------------------
+
+MPLS packet classification on X710/XL710
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Before NIC firmware version of 5.0, MPLS packet cannot be recognized by NIC.
+The L2 Payload flow type in flow director can be used to classify MPLS packet
+by the command in testpmd like:
+
+   testpmd> flow_director_filter 0 mode IP add flow l2_payload ether \
+            0x8847 flexbytes () fwd pf queue <N> fd_id <M>
+
+In the NIC firmware whose version is 5.0 or greater, very limited MPLS support
+is added: Native MPLS skip is implemented, that is, packet type can be
+recognized like MPLS header is skipped, while no new packet type and no more
+meta data is extracted from MPLS header. With this change, L2 Payload flow
+type in flow director cannot be used to classify MPLS packet as previous.
+Meanwhile, Ethertype filter can be used to classify MPLS packet by the command
+in testpmd like:
+
+   testpmd> ethertype_filter 0 add mac_ignr 00:00:00:00:00:00 ethertype \
+            0x8847 fwd queue <M>
+
+16 Byte Descriptor cannot be used on DPDK VF
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If Linux i40e kerel driver is used as host driver, while DPDK i40e PMD is used
+as VF driver, DPDK cannot choose 16 byte descriptor receive descriptor. That
+is to say, user should keep "CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC=n" in config
+file.
-- 
2.4.11

Re: [PATCH] doc: add limitations for i40e PMD

[Xing, Beilei]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Jingjing Wu
> Sent: Tuesday, September 6, 2016 10:17 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Wu, Jingjing <jingjing.wu@intel.com>; Zhang, Helin
> <helin.zhang@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: add limitations for i40e PMD
> 
> This patch adds "Limitations or Known issues" section for i40e PMD, including
> two items:
> 1. MPLS packet classification on X710/XL710 2. 16 Byte Descriptor cannot be
> used on DPDK VF
> 
> Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
> ---
>  doc/guides/nics/i40e.rst | 33 +++++++++++++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
> 
> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index
> 4d12b10..6df0f7a 100644
> --- a/doc/guides/nics/i40e.rst
> +++ b/doc/guides/nics/i40e.rst
> @@ -411,3 +411,36 @@ configuration passed on the EAL command line.
> 
>  The floating VEB functionality requires a NIC firmware version of 5.0  or
> greater.
> +
> +
> +Limitations or Known issues
> +---------------------------
> +
> +MPLS packet classification on X710/XL710
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Before NIC firmware version of 5.0, MPLS packet cannot be recognized by
> NIC.
> +The L2 Payload flow type in flow director can be used to classify MPLS
> +packet by the command in testpmd like:
> +
> +   testpmd> flow_director_filter 0 mode IP add flow l2_payload ether \
> +            0x8847 flexbytes () fwd pf queue <N> fd_id <M>
> +
> +In the NIC firmware whose version is 5.0 or greater, very limited MPLS
> +support is added: Native MPLS skip is implemented, that is, packet type
> +can be recognized like MPLS header is skipped, while no new packet type
> +and no more meta data is extracted from MPLS header. With this change,
> +L2 Payload flow type in flow director cannot be used to classify MPLS packet
> as previous.
> +Meanwhile, Ethertype filter can be used to classify MPLS packet by the
> +command in testpmd like:
> +
> +   testpmd> ethertype_filter 0 add mac_ignr 00:00:00:00:00:00 ethertype \
> +            0x8847 fwd queue <M>
> +
> +16 Byte Descriptor cannot be used on DPDK VF
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +If Linux i40e kerel driver is used as host driver, while DPDK i40e PMD

one typo:  kerel -> kernel

> +is used as VF driver, DPDK cannot choose 16 byte descriptor receive
> +descriptor. That is to say, user should keep
> +"CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC=n" in config file.
> --
> 2.4.11

[PATCH v2] doc: add limitations for i40e PMD

[Jingjing Wu]

This patch adds "Limitations or Known issues" section for
i40e PMD, including two items:
1. MPLS packet classification on X710/XL710
2. 16 Byte Descriptor cannot be used on DPDK VF

Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
---
v2 changes:
 fix typo.

 doc/guides/nics/i40e.rst | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 4d12b10..1891551 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -411,3 +411,36 @@ configuration passed on the EAL command line.
 
 The floating VEB functionality requires a NIC firmware version of 5.0
 or greater.
+
+
+Limitations or Known issues
+---------------------------
+
+MPLS packet classification on X710/XL710
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Before NIC firmware version of 5.0, MPLS packet cannot be recognized by NIC.
+The L2 Payload flow type in flow director can be used to classify MPLS packet
+by the command in testpmd like:
+
+   testpmd> flow_director_filter 0 mode IP add flow l2_payload ether \
+            0x8847 flexbytes () fwd pf queue <N> fd_id <M>
+
+In the NIC firmware whose version is 5.0 or greater, very limited MPLS support
+is added: Native MPLS skip is implemented, that is, packet type can be
+recognized like MPLS header is skipped, while no new packet type and no more
+meta data is extracted from MPLS header. With this change, L2 Payload flow
+type in flow director cannot be used to classify MPLS packet as previous.
+Meanwhile, Ethertype filter can be used to classify MPLS packet by the command
+in testpmd like:
+
+   testpmd> ethertype_filter 0 add mac_ignr 00:00:00:00:00:00 ethertype \
+            0x8847 fwd queue <M>
+
+16 Byte Descriptor cannot be used on DPDK VF
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If Linux i40e kernel driver is used as host driver, while DPDK i40e PMD is used
+as VF driver, DPDK cannot choose 16 byte descriptor receive descriptor. That
+is to say, user should keep "CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC=n" in config
+file.
-- 
2.4.11

Re: [PATCH v2] doc: add limitations for i40e PMD

[Mcnamara, John]

> -----Original Message-----
> From: Wu, Jingjing
> Sent: Friday, September 16, 2016 6:06 PM
> To: dev@dpdk.org
> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Xing, Beilei
> <beilei.xing@intel.com>; Mcnamara, John <john.mcnamara@intel.com>
> Subject: [PATCH v2] doc: add limitations for i40e PMD
> 
> This patch adds "Limitations or Known issues" section for i40e PMD,
> including two items:
> 1. MPLS packet classification on X710/XL710 2. 16 Byte Descriptor cannot
> be used on DPDK VF
> 
> Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
>
> ...
>
> +Before NIC firmware version of 5.0, MPLS packet cannot be recognized by
> NIC.
> +The L2 Payload flow type in flow director can be used to classify MPLS
> +packet by the command in testpmd like:
> +
> +   testpmd> flow_director_filter 0 mode IP add flow l2_payload ether \
> +            0x8847 flexbytes () fwd pf queue <N> fd_id <M>
> +
> +In the NIC firmware whose version is 5.0 or greater, very limited MPLS
> +support is added: Native MPLS skip is implemented, that is, packet type
> +can be recognized like MPLS header is skipped, while no new packet type
> +and no more meta data is extracted from MPLS header.

This paragraph is a little confusing. Perhaps you could simplify/clarify it.

[PATCH v3] doc: add limitations for i40e PMD

[Jingjing Wu]

This patch adds "Limitations or Known issues" section for
i40e PMD, including two items:
1. MPLS packet classification on X710/XL710
2. 16 Byte Descriptor cannot be used on DPDK VF
3. Link down with i40e kernel driver after DPDK application exist

Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
---
v2 changes:
 fix typo.

v3 changes:
 add one more limitation.
 rewording.

 doc/guides/nics/i40e.rst | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 4d12b10..c0163fc 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -411,3 +411,45 @@ configuration passed on the EAL command line.
 
 The floating VEB functionality requires a NIC firmware version of 5.0
 or greater.
+
+
+Limitations or Known issues
+---------------------------
+
+MPLS packet classification on X710/XL710
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For firmware versions prior to 5.0, MPLS packets are not recognized by the NIC.
+The L2 Payload flow type in flow director can be used to classify MPLS packet
+by using a command in testpmd like:
+
+   testpmd> flow_director_filter 0 mode IP add flow l2_payload ether \
+            0x8847 flexbytes () fwd pf queue <N> fd_id <M>
+
+With the NIC firmware version 5.0 or greater, some limited MPLS support
+is added: Native MPLS (MPLS in Ethernet) skip is implemented, while no
+new packet type, no classification or offload are possible. With this change,
+L2 Payload flow type in flow director cannot be used to classify MPLS packet
+as with previous firmware versions. Meanwhile, the Ethertype filter can be
+used to classify MPLS packet by using a command in testpmd like:
+
+   testpmd> ethertype_filter 0 add mac_ignr 00:00:00:00:00:00 ethertype \
+            0x8847 fwd queue <M>
+
+16 Byte Descriptor cannot be used on DPDK VF
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If the Linux i40e kernel driver is used as host driver, while DPDK i40e PMD
+is used as the VF driver, DPDK cannot choose 16 byte receive descriptor. That
+is to say, user should keep ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC=n`` in
+config file.
+
+Link down with i40e kernel driver after DPDK application exist
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+After DPDK application quit, and the device is bound back to Linux i40e
+kernel driver, the link cannot be up after ``ifconfig <dev> up``.
+To work around this issue, ``ethtool -s <dev> autoneg on`` should be
+set first and then the link can be brought up through ``ifconfig <dev> up``.
+
+NOTE: requires Linux kernel i40e driver version >= 1.4.X
-- 
2.4.11

Re: [PATCH v3] doc: add limitations for i40e PMD

[Mcnamara, John]

> -----Original Message-----
> From: Wu, Jingjing
> Sent: Friday, September 30, 2016 7:46 AM
> To: dev@dpdk.org
> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Xing, Beilei
> <beilei.xing@intel.com>; Mcnamara, John <john.mcnamara@intel.com>
> Subject: [PATCH v3] doc: add limitations for i40e PMD
> 
> This patch adds "Limitations or Known issues" section for i40e PMD,
> including two items:
> 1. MPLS packet classification on X710/XL710 2. 16 Byte Descriptor cannot
> be used on DPDK VF 3. Link down with i40e kernel driver after DPDK
> application exist
> 
> Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>


Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [PATCH v3] doc: add limitations for i40e PMD

[Bruce Richardson]

On Fri, Sep 30, 2016 at 03:09:53PM +0000, Mcnamara, John wrote:
> 
> 
> > -----Original Message-----
> > From: Wu, Jingjing
> > Sent: Friday, September 30, 2016 7:46 AM
> > To: dev@dpdk.org
> > Cc: Wu, Jingjing <jingjing.wu@intel.com>; Xing, Beilei
> > <beilei.xing@intel.com>; Mcnamara, John <john.mcnamara@intel.com>
> > Subject: [PATCH v3] doc: add limitations for i40e PMD
> > 
> > This patch adds "Limitations or Known issues" section for i40e PMD,
> > including two items:
> > 1. MPLS packet classification on X710/XL710 2. 16 Byte Descriptor cannot
> > be used on DPDK VF 3. Link down with i40e kernel driver after DPDK
> > application exist
> > 
> > Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
> 
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>
> 
Applied to dpdk-next-net/rel_16_11

/Bruce