[dpdk-dev] [PATCH] doc: add inline protocol in feature list

[Anoob Joseph]

Hi Ferruh,

Can you review this patch?

Thanks,
Anoob

> -----Original Message-----
> From: dev <dev-bounces at dpdk.org> On Behalf Of Anoob Joseph
> Sent: Tuesday, December 10, 2019 12:23 PM
> To: John McNamara <john.mcnamara at intel.com>; Marko Kovacevic
> <marko.kovacevic at intel.com>; Ferruh Yigit <ferruh.yigit at intel.com>
> Cc: Anoob Joseph <anoobj at marvell.com>; Jerin Jacob Kollanukkaran
> <jerinj at marvell.com>; Narayana Prasad Raju Athreya
> <pathreya at marvell.com>; dev at dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: add inline protocol in feature list
> 
> Update feature list to include inline protocol offload.
> 
> Signed-off-by: Anoob Joseph <anoobj at marvell.com>
> ---
>  doc/guides/nics/features.rst         | 18 ++++++++++++++++++
>  doc/guides/nics/features/default.ini |  1 +
>  2 files changed, 19 insertions(+)
> 
> diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index
> 8394a65..f4eb2a9 100644
> --- a/doc/guides/nics/features.rst
> +++ b/doc/guides/nics/features.rst
> @@ -433,6 +433,24 @@ Supports inline crypto processing (e.g. inline IPsec). See
> Security library and
>    ``mbuf.ol_flags:PKT_TX_SEC_OFFLOAD``,
> ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD_FAILED``.
> 
> 
> +.. _nic_features_inline_protocol_doc:
> +
> +Inline protocol
> +---------------
> +
> +Supports inline protocol processing (e.g. inline IPsec). See Security library and
> PMD documentation for more details.
> +
> +* **[uses]       rte_eth_rxconf,rte_eth_rxmode**:
> ``offloads:DEV_RX_OFFLOAD_SECURITY``,
> +* **[uses]       rte_eth_txconf,rte_eth_txmode**:
> ``offloads:DEV_TX_OFFLOAD_SECURITY``.
> +* **[implements] rte_security_ops**: ``session_create``,
> +``session_update``,
> +  ``session_stats_get``, ``session_destroy``, ``set_pkt_metadata``,
> +``get_userdata``,
> +  ``capabilities_get``.
> +* **[provides] rte_eth_dev_info**:
> +``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_SECURITY``,
> +  ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_SECURITY``.
> +* **[provides]   mbuf**: ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD``,
> +  ``mbuf.ol_flags:PKT_TX_SEC_OFFLOAD``,
> ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD_FAILED``.
> +
> +
>  .. _nic_features_crc_offload:
> 
>  CRC offload
> diff --git a/doc/guides/nics/features/default.ini
> b/doc/guides/nics/features/default.ini
> index 91ec619..4d0ad32 100644
> --- a/doc/guides/nics/features/default.ini
> +++ b/doc/guides/nics/features/default.ini
> @@ -42,6 +42,7 @@ Flow API             =
>  Rate limitation      =
>  Traffic mirroring    =
>  Inline crypto        =
> +Inline protocol      =
>  CRC offload          =
>  VLAN offload         =
>  QinQ offload         =
> --
> 2.7.4