[PATCH] doc: update release notes for rte_security

[PATCH] doc: update release notes for rte_security

[Akhil Goyal]

Removed the deprication notice for ABI breakage and updated
release notes for rte_security.

Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
---
 doc/guides/prog_guide/rte_security.rst |  2 ++
 doc/guides/rel_notes/deprecation.rst   | 10 ----------
 doc/guides/rel_notes/release_17_11.rst | 33 +++++++++++++++++++++++++++++++++
 3 files changed, 35 insertions(+), 10 deletions(-)

diff --git a/doc/guides/prog_guide/rte_security.rst b/doc/guides/prog_guide/rte_security.rst
index 71be036..ef6ed0f 100644
--- a/doc/guides/prog_guide/rte_security.rst
+++ b/doc/guides/prog_guide/rte_security.rst
@@ -28,6 +28,8 @@
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
+.. _security_library:
+
 Security Library
 ================
 
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index a93c3e1..b8dff0e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -50,16 +50,6 @@ Deprecation Notices
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
 
-* ethdev: new parameters - ``rte_security_capabilities`` and
-  ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
-  ``rte_eth_dev`` respectively  to support security operations like
-  ipsec inline.
-
-* cryptodev: new parameters - ``rte_security_capabilities`` and
-  ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
-  ``rte_cryptodev`` respectively to support security protocol offloaded
-  operations.
-
 * cryptodev: the following function is deprecated starting from 17.08 and will
   be removed in 17.11:
 
diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst
index b96b236..132a916 100644
--- a/doc/guides/rel_notes/release_17_11.rst
+++ b/doc/guides/rel_notes/release_17_11.rst
@@ -208,6 +208,29 @@ New Features
   applications to classify an input packet by matching it against a set of flow
   rules. It uses the librte_table API to manage the flow rules.
 
+* **Added the Security Offload Library.**
+
+  Added an experimental library - rte_security. It provide security APIs for
+  protocols like IPSec using inline ipsec offload to ethernet device or full
+  protocol offload with lookaside crypto device.
+
+  See the :ref:`Security Library <Security_Library>` documentation in
+  the Programmers Guide document, for more information.
+
+* **Updated DPAA2_SEC crypto driver.**
+
+  Updated dpaa2_sec crypto PMD to support rte_security lookaside protocol
+  offload for IPSec.
+
+* **Updated IXGBE ethernet driver.**
+
+  Updated ixgbe ethernet PMD to support rte_security inline IPSec offload.
+
+* **Updated ipsec-secgw application**
+
+  Updated ipsec-secgw sample application to support rte_security actions for
+  ipsec inline and full protocol offload using lookaside crypto offload.
+
 
 Resolved Issues
 ---------------
@@ -422,6 +445,16 @@ ABI Changes
   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
   changed, as described in the `New Features` section.
 
+* **New parameter added to rte_eth_dev.**
+
+  New parameter ``security_ctx``  added to ``rte_eth_dev`` to support security
+  operations like IPSec inline.
+
+* **New parameter added to rte_cryptodev.**
+
+  New parameter ``security_ctx``  added to ``rte_cryptodev`` to support security
+  operations like lookaside crypto.
+
 
 Removed Items
 -------------
-- 
2.9.3

Re: [PATCH] doc: update release notes for rte_security

[Thomas Monjalon]

30/10/2017 13:27, Akhil Goyal:
> Removed the deprication notice for ABI breakage and updated
> release notes for rte_security.
> 
> Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
> ---
> +.. _security_library:
> +
>  Security Library
>  ================
[...]
> +* **Added the Security Offload Library.**
> +
> +  Added an experimental library - rte_security. It provide security APIs for
> +  protocols like IPSec using inline ipsec offload to ethernet device or full
> +  protocol offload with lookaside crypto device.
> +
> +  See the :ref:`Security Library <Security_Library>` documentation in
> +  the Programmers Guide document, for more information.

I think the reference to the programmer's guide is not so useful.
I prefer avoiding it because it won't work in PDF format.

John, any opinion?

Re: [PATCH] doc: update release notes for rte_security

[Akhil Goyal]

Hi Thomas,
On 10/30/2017 7:52 PM, Thomas Monjalon wrote:
> 30/10/2017 13:27, Akhil Goyal:
>> Removed the deprication notice for ABI breakage and updated
>> release notes for rte_security.
>>
>> Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
>> ---
>> +.. _security_library:
>> +
>>   Security Library
>>   ================
> [...]
>> +* **Added the Security Offload Library.**
>> +
>> +  Added an experimental library - rte_security. It provide security APIs for
>> +  protocols like IPSec using inline ipsec offload to ethernet device or full
>> +  protocol offload with lookaside crypto device.
>> +
>> +  See the :ref:`Security Library <Security_Library>` documentation in
>> +  the Programmers Guide document, for more information.
> 
> I think the reference to the programmer's guide is not so useful.
> I prefer avoiding it because it won't work in PDF format.
> 
> John, any opinion?
> 

I added this reference as there was another one in the release notes 
already for membership library.

I will remove reference to security library, if it is not required. 
Please let me know.

Thanks,
Akhil

Re: [PATCH] doc: update release notes for rte_security

[Mcnamara, John]

> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal@nxp.com]
> Sent: Wednesday, November 1, 2017 6:21 AM
> To: Thomas Monjalon <thomas@monjalon.net>; Mcnamara, John
> <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Doherty, Declan <declan.doherty@intel.com>; De Lara
> Guarch, Pablo <pablo.de.lara.guarch@intel.com>; hemant.agrawal@nxp.com;
> Nicolau, Radu <radu.nicolau@intel.com>; borisp@mellanox.com;
> aviadye@mellanox.com; jerin.jacob@caviumnetworks.com; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>
> Subject: Re: [PATCH] doc: update release notes for rte_security
> 
> Hi Thomas,
> On 10/30/2017 7:52 PM, Thomas Monjalon wrote:
> > 30/10/2017 13:27, Akhil Goyal:
> >> Removed the deprication notice for ABI breakage and updated release
> >> notes for rte_security.
> >>
> >> Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
> >> ---
> >> +.. _security_library:
> >> +
> >>   Security Library
> >>   ================
> > [...]
> >> +* **Added the Security Offload Library.**
> >> +
> >> +  Added an experimental library - rte_security. It provide security
> >> + APIs for  protocols like IPSec using inline ipsec offload to
> >> + ethernet device or full  protocol offload with lookaside crypto
> device.
> >> +
> >> +  See the :ref:`Security Library <Security_Library>` documentation
> >> + in  the Programmers Guide document, for more information.
> >
> > I think the reference to the programmer's guide is not so useful.
> > I prefer avoiding it because it won't work in PDF format.
> >
> > John, any opinion?
> >
> 
> I added this reference as there was another one in the release notes
> already for membership library.
> 
> I will remove reference to security library, if it is not required.
> Please let me know.
> 

You could refer to it without a link:

    See the "Security_Library" section of the DPDK Programmers Guide document,
    for more information.

John

[PATCH v2] doc: update release notes for rte_security

[Akhil Goyal]

Removed the deprication notice for ABI breakage and updated
release notes for rte_security.

Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
---
Changes in v2: incorporated comment from John

 doc/guides/rel_notes/deprecation.rst   | 10 ----------
 doc/guides/rel_notes/release_17_11.rst | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+), 10 deletions(-)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index a93c3e1..b8dff0e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -50,16 +50,6 @@ Deprecation Notices
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
 
-* ethdev: new parameters - ``rte_security_capabilities`` and
-  ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
-  ``rte_eth_dev`` respectively  to support security operations like
-  ipsec inline.
-
-* cryptodev: new parameters - ``rte_security_capabilities`` and
-  ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
-  ``rte_cryptodev`` respectively to support security protocol offloaded
-  operations.
-
 * cryptodev: the following function is deprecated starting from 17.08 and will
   be removed in 17.11:
 
diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst
index b96b236..13cc2d9 100644
--- a/doc/guides/rel_notes/release_17_11.rst
+++ b/doc/guides/rel_notes/release_17_11.rst
@@ -208,6 +208,29 @@ New Features
   applications to classify an input packet by matching it against a set of flow
   rules. It uses the librte_table API to manage the flow rules.
 
+* **Added the Security Offload Library.**
+
+  Added an experimental library - rte_security. It provide security APIs for
+  protocols like IPSec using inline ipsec offload to ethernet device or full
+  protocol offload with lookaside crypto device.
+
+  See the "Security_Library" section of the DPDK Programmers Guide document,
+  for more information.
+
+* **Updated DPAA2_SEC crypto driver.**
+
+  Updated dpaa2_sec crypto PMD to support rte_security lookaside protocol
+  offload for IPSec.
+
+* **Updated IXGBE ethernet driver.**
+
+  Updated ixgbe ethernet PMD to support rte_security inline IPSec offload.
+
+* **Updated ipsec-secgw application**
+
+  Updated ipsec-secgw sample application to support rte_security actions for
+  ipsec inline and full protocol offload using lookaside crypto offload.
+
 
 Resolved Issues
 ---------------
@@ -422,6 +445,16 @@ ABI Changes
   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
   changed, as described in the `New Features` section.
 
+* **New parameter added to rte_eth_dev.**
+
+  New parameter ``security_ctx``  added to ``rte_eth_dev`` to support security
+  operations like IPSec inline.
+
+* **New parameter added to rte_cryptodev.**
+
+  New parameter ``security_ctx``  added to ``rte_cryptodev`` to support security
+  operations like lookaside crypto.
+
 
 Removed Items
 -------------
-- 
2.9.3

Re: [PATCH v2] doc: update release notes for rte_security

[Thomas Monjalon]

07/11/2017 07:44, Akhil Goyal:
> Removed the deprication notice for ABI breakage and updated
> release notes for rte_security.
> 
> Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>

Applied, thanks