[PATCH] doc: announce rte_ipsec API changes

[PATCH] doc: announce rte_ipsec API changes

[Aakash Sasidharan]

In case of event mode operations where event device can help in atomic sequence
number increment across cores, sequence number need to be provided by the
application instead of being updated in rte_ipsec or the PMD.
To support this, a new flag ``RTE_IPSEC_SAFLAG_SQN_ASSIGN_DISABLE`` will be added
to disable sequence number update inside IPsec library and the API
rte_ipsec_pkt_crypto_prepare will be extended to include ``sqn`` as an additional
parameter to specify sequence number to be used for IPsec from the application.

Signed-off-by: Aakash Sasidharan <asasidharan@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6948641ff6..bc1d93cca7 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -133,6 +133,13 @@ Deprecation Notices
   Since these functions are not called directly by the application,
   the API remains unaffected.
 
+* ipsec: The rte_ipsec library is updated to support sequence number provided
+  by application. A new flag ``RTE_IPSEC_SAFLAG_SQN_ASSIGN_DISABLE`` is introduced
+  to disable sequence number assignment in lib IPsec.
+  The API rte_ipsec_pkt_crypto_prepare is extended to include ``sqn`` as an
+  additional parameter allowing application to specify the sequence number to be
+  used for the IPsec operation.
+
 * pipeline: The pipeline library legacy API (functions rte_pipeline_*)
   will be deprecated and subsequently removed in DPDK 24.11 release.
   Before this, the new pipeline library API (functions rte_swx_pipeline_*)
-- 
2.25.1

[PATCH] doc: announce rte_ipsec API changes

[Aakash Sasidharan]

In case of event mode operations where event device can help in atomic sequence
number increment across cores, sequence number need to be provided by the
application instead of being updated in rte_ipsec or the PMD.
To support this, a new flag ``RTE_IPSEC_SAFLAG_SQN_ASSIGN_DISABLE`` will be added
to disable sequence number update inside IPsec library and the API
rte_ipsec_pkt_crypto_prepare will be extended to include ``sqn`` as an additional
parameter to specify sequence number to be used for IPsec from the application.

Signed-off-by: Aakash Sasidharan <asasidharan@marvell.com>
Change-Id: I0dd7729d8775106445c8e7cbe1a04c1ac5613b3d
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6948641ff6..bc1d93cca7 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -133,6 +133,13 @@ Deprecation Notices
   Since these functions are not called directly by the application,
   the API remains unaffected.
 
+* ipsec: The rte_ipsec library is updated to support sequence number provided
+  by application. A new flag ``RTE_IPSEC_SAFLAG_SQN_ASSIGN_DISABLE`` is introduced
+  to disable sequence number assignment in lib IPsec.
+  The API rte_ipsec_pkt_crypto_prepare is extended to include ``sqn`` as an
+  additional parameter allowing application to specify the sequence number to be
+  used for the IPsec operation.
+
 * pipeline: The pipeline library legacy API (functions rte_pipeline_*)
   will be deprecated and subsequently removed in DPDK 24.11 release.
   Before this, the new pipeline library API (functions rte_swx_pipeline_*)
-- 
2.25.1