doc: announce SA config option struct changes

Message ID 20210630112049.3747-1-marchana@marvell.com (mailing list archive)
State Not Applicable, archived
Delegated to: akhil goyal
Headers
Series doc: announce SA config option struct changes |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Archana Muniganti June 30, 2021, 11:20 a.m. UTC
  Proposing following two new fields for IPsec inner checksum
configuration in the structure ``rte_security_ipsec_sa_options``.
uint32_t ip_csum_enable : 1;
uint32_t l4_csum_enable : 1;

With these config options, per SA, application can specify if
the inner checksum(compute/verify) to be offloaded to the
security device.

https://mails.dpdk.org/archives/dev/2021-June/212977.html

Signed-off-by: Archana Muniganti <marchana@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Akhil Goyal July 31, 2021, 5:53 p.m. UTC | #1
> Proposing following two new fields for IPsec inner checksum
> configuration in the structure ``rte_security_ipsec_sa_options``.
> uint32_t ip_csum_enable : 1;
> uint32_t l4_csum_enable : 1;
> 
> With these config options, per SA, application can specify if
> the inner checksum(compute/verify) to be offloaded to the
> security device.
> 
> https://mails.dpdk.org/archives/dev/2021-June/212977.html
> 
> Signed-off-by: Archana Muniganti <marchana@marvell.com>
> ---
Marking this patch as Not applicable,
As a new patch is submitted for consolidating all notices for same structure.
https://mails.dpdk.org/archives/dev/2021-July/215906.html
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 9584d6bfd7..da65ae68be 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -141,6 +141,10 @@  Deprecation Notices
   in "rte_sched.h". These changes are aligned to improvements suggested in the
   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 
+* security: The IPsec SA config options structure ``struct rte_security_ipsec_sa_options``
+  will be updated with two new fields to support IPsec inner checksum in case
+  of protocol offload.
+
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.