[v3] doc: add inline protocol in feature list
Checks
Commit Message
Update feature list to include inline protocol offload.
Signed-off-by: Anoob Joseph <anoobj@marvell.com>
---
v3
* Added inline protocol in octeontx2_vf.ini
v2
* Reworded doc following suggestions from Akhil
doc/guides/nics/features.rst | 27 ++++++++++++++++++++++++++-
doc/guides/nics/features/default.ini | 1 +
doc/guides/nics/features/octeontx2.ini | 1 +
doc/guides/nics/features/octeontx2_vf.ini | 1 +
4 files changed, 29 insertions(+), 1 deletion(-)
Comments
>
> Update feature list to include inline protocol offload.
>
> Signed-off-by: Anoob Joseph <anoobj@marvell.com>
> ---
> v3
> * Added inline protocol in octeontx2_vf.ini
>
> v2
> * Reworded doc following suggestions from Akhil
>
> doc/guides/nics/features.rst | 27 ++++++++++++++++++++++++++-
> doc/guides/nics/features/default.ini | 1 +
> doc/guides/nics/features/octeontx2.ini | 1 +
> doc/guides/nics/features/octeontx2_vf.ini | 1 +
> 4 files changed, 29 insertions(+), 1 deletion(-)
>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Ferruh,
Do you want me to take this patch on crypto tree or you would be taking it.
Regards,
Akhil
On 2/18/2020 7:40 AM, Akhil Goyal wrote:
>
>>
>> Update feature list to include inline protocol offload.
>>
>> Signed-off-by: Anoob Joseph <anoobj@marvell.com>
>> ---
>> v3
>> * Added inline protocol in octeontx2_vf.ini
>>
>> v2
>> * Reworded doc following suggestions from Akhil
>>
>> doc/guides/nics/features.rst | 27 ++++++++++++++++++++++++++-
>> doc/guides/nics/features/default.ini | 1 +
>> doc/guides/nics/features/octeontx2.ini | 1 +
>> doc/guides/nics/features/octeontx2_vf.ini | 1 +
>> 4 files changed, 29 insertions(+), 1 deletion(-)
>>
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
>
> Ferruh,
> Do you want me to take this patch on crypto tree or you would be taking it.
>
Thanks Akhil, both are OK for me, but there are already a few patches merged in
next-net so let me get this one too to simply merging to main repo.
On 2/18/2020 9:28 AM, Ferruh Yigit wrote:
> On 2/18/2020 7:40 AM, Akhil Goyal wrote:
>>
>>>
>>> Update feature list to include inline protocol offload.
>>>
>>> Signed-off-by: Anoob Joseph <anoobj@marvell.com>
>>> ---
>>> v3
>>> * Added inline protocol in octeontx2_vf.ini
>>>
>>> v2
>>> * Reworded doc following suggestions from Akhil
>>>
>>> doc/guides/nics/features.rst | 27 ++++++++++++++++++++++++++-
>>> doc/guides/nics/features/default.ini | 1 +
>>> doc/guides/nics/features/octeontx2.ini | 1 +
>>> doc/guides/nics/features/octeontx2_vf.ini | 1 +
>>> 4 files changed, 29 insertions(+), 1 deletion(-)
>>>
>> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
>>
>> Ferruh,
>> Do you want me to take this patch on crypto tree or you would be taking it.
>>
>
> Thanks Akhil, both are OK for me, but there are already a few patches merged in
> next-net so let me get this one too to simply merging to main repo.
>
Applied to dpdk-next-net/master, thanks.
@@ -421,7 +421,9 @@ Supports adding traffic mirroring rules.
Inline crypto
-------------
-Supports inline crypto processing (e.g. inline IPsec). See Security library and PMD documentation for more details.
+Supports inline crypto processing defined by rte_security library to perform crypto
+operations of security protocol while packet is received in NIC. NIC is not aware
+of protocol operations. 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``.
@@ -431,6 +433,29 @@ Supports inline crypto processing (e.g. inline IPsec). See Security library and
``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``.
+* **[provides] rte_security_ops, capabilities_get**: ``action: RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO``
+
+
+.. _nic_features_inline_protocol_doc:
+
+Inline protocol
+---------------
+
+Supports inline protocol processing defined by rte_security library to perform
+protocol processing for the security protocol (e.g. IPsec, MACSEC) while the
+packet is received at NIC. The NIC is capable of understanding the security
+protocol operations. 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``.
+* **[provides] rte_security_ops, capabilities_get**: ``action: RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL``
.. _nic_features_crc_offload:
@@ -42,6 +42,7 @@ Flow API =
Rate limitation =
Traffic mirroring =
Inline crypto =
+Inline protocol =
CRC offload =
VLAN offload =
QinQ offload =
@@ -27,6 +27,7 @@ RSS hash = Y
RSS key update = Y
RSS reta update = Y
Inner RSS = Y
+Inline protocol = Y
VLAN filter = Y
Flow control = Y
Flow API = Y
@@ -21,6 +21,7 @@ RSS hash = Y
RSS key update = Y
RSS reta update = Y
Inner RSS = Y
+Inline protocol = Y
VLAN filter = Y
Flow API = Y
Jumbo frame = Y