[dpdk-dev] [PATCH v4 11/11] doc: update mlx5 guide on tunnel offloading

[Nélio Laranjeiro]

On Tue, Apr 17, 2018 at 11:14:36PM +0800, Xueming Li wrote:
> Remove tunnel limitations, add new hardware tunnel offload features.
> 
> Signed-off-by: Xueming Li <xuemingl at mellanox.com>
> ---
>  doc/guides/nics/features/default.ini |  1 +
>  doc/guides/nics/features/mlx5.ini    |  3 +++
>  doc/guides/nics/mlx5.rst             | 22 ++++++++++++++++++++--
>  3 files changed, 24 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini
> index dae2ad776..49be81450 100644
> --- a/doc/guides/nics/features/default.ini
> +++ b/doc/guides/nics/features/default.ini
> @@ -29,6 +29,7 @@ Multicast MAC filter =
>  RSS hash             =
>  RSS key update       =
>  RSS reta update      =
> +Inner RSS            =
>  VMDq                 =
>  SR-IOV               =
>  DCB                  =
> diff --git a/doc/guides/nics/features/mlx5.ini b/doc/guides/nics/features/mlx5.ini
> index f8ce08770..e75b14bdc 100644
> --- a/doc/guides/nics/features/mlx5.ini
> +++ b/doc/guides/nics/features/mlx5.ini
> @@ -21,6 +21,7 @@ Multicast MAC filter = Y
>  RSS hash             = Y
>  RSS key update       = Y
>  RSS reta update      = Y
> +Inner RSS            = Y
>  SR-IOV               = Y
>  VLAN filter          = Y
>  Flow director        = Y
> @@ -30,6 +31,8 @@ VLAN offload         = Y
>  L3 checksum offload  = Y
>  L4 checksum offload  = Y
>  Timestamp offload    = Y
> +Inner L3 checksum    = Y
> +Inner L4 checksum    = Y
>  Packet type parsing  = Y
>  Rx descriptor status = Y
>  Tx descriptor status = Y
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index c28c83278..51590b0a3 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -74,12 +74,12 @@ Features
>  - RX interrupts.
>  - Statistics query including Basic, Extended and per queue.
>  - Rx HW timestamp.
> +- Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLS-in-GRE, MPLS-in-UDP.
> +- Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
>  
>  Limitations
>  -----------
>  
> -- Inner RSS for VXLAN frames is not supported yet.
> -- Hardware checksum RX offloads for VXLAN inner header are not supported yet.
>  - For secondary process:
>  
>    - Forked secondary process not supported.
> @@ -327,6 +327,24 @@ Run-time configuration
>  
>    Enabled by default, valid only on VF devices ignored otherwise.
>  
> +Firmware configuration
> +~~~~~~~~~~~~~~~~~~~~~~
> +
> +- L3 VXLAN and VXLAN-GPE destination UDP port
> +
> +   .. code-block:: console
> +
> +     mlxconfig -d <mst device> set IP_OVER_VXLAN_EN=1
> +     mlxconfig -d <mst device> set IP_OVER_VXLAN_PORT=<udp dport>
> +
> +  Verify configurations are set:
> +
> +   .. code-block:: console
> +
> +     mlxconfig -d <mst device> query | grep IP_OVER_VXLAN
> +     IP_OVER_VXLAN_EN                    True(1)
> +     IP_OVER_VXLAN_PORT                  4790
> +
>  Prerequisites
>  -------------
>  
> -- 
> 2.13.3

The documentation modification related to the L3 VXLAN should be in the
same patch as the code in mlx5.

Thanks,

-- 
Nélio Laranjeiro
6WIND