doc: announce support for MACsec in rte_security

Message ID 20220628190802.850690-1-gakhil@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce support for MACsec in rte_security |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Akhil Goyal June 28, 2022, 7:08 p.m. UTC
  MACsec support is planned for DPDK 22.11, which would
result in ABI breakage in some of the rte_security structures.
This patch is to give deprecation notice for the affected structures.

Signed-off-by: Akhil Goyal <gakhil@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)
  

Comments

Hemant Agrawal June 29, 2022, 3:37 a.m. UTC | #1
On 6/29/2022 12:38 AM, Akhil Goyal wrote:
> MACsec support is planned for DPDK 22.11, which would
> result in ABI breakage in some of the rte_security structures.
> This patch is to give deprecation notice for the affected structures.
>
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 5 +++++
>   1 file changed, 5 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 4e5b23c53d..1c3bf54d72 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -116,6 +116,11 @@ Deprecation Notices
>     pointer for the private data to the application which can be attached
>     to the packet while enqueuing.
>   
> +* security: MACsec support is planned to be added in DPDK 22.11 which would
> +  result in updates to structures ``rte_security_macsec_xform``,
> +  ``rte_security_macsec_stats`` and security capability structure
> +  ``rte_security_capability`` to accomodate MACsec capabilities.
> +
>   * metrics: The function ``rte_metrics_init`` will have a non-void return
>     in order to notify errors instead of calling ``rte_exit``.
>   
Acked-by:  Hemant Agrawal <hemant.agrawal@nxp.com>
  
Fan Zhang June 29, 2022, 7:40 a.m. UTC | #2
> -----Original Message-----
> From: Akhil Goyal <gakhil@marvell.com>
> Sent: Tuesday, June 28, 2022 8:08 PM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; david.marchand@redhat.com;
> hemant.agrawal@nxp.com; anoobj@marvell.com;
> konstantin.v.ananyev@yandex.ru; ferruh.yigit@xilinx.com;
> andrew.rybchenko@oktetlabs.ru; ndabilpuram@marvell.com;
> vattunuru@marvell.com; matan@nvidia.com; Zhang, Roy Fan
> <roy.fan.zhang@intel.com>; jerinj@marvell.com; jiawenwu@trustnetic.com;
> Yang, Qiming <qiming.yang@intel.com>; Akhil Goyal <gakhil@marvell.com>
> Subject: [PATCH] doc: announce support for MACsec in rte_security
> 
> MACsec support is planned for DPDK 22.11, which would
> result in ABI breakage in some of the rte_security structures.
> This patch is to give deprecation notice for the affected structures.
> 
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 4e5b23c53d..1c3bf54d72 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -116,6 +116,11 @@ Deprecation Notices
>    pointer for the private data to the application which can be attached
>    to the packet while enqueuing.
> 
> +* security: MACsec support is planned to be added in DPDK 22.11 which
> would
> +  result in updates to structures ``rte_security_macsec_xform``,
> +  ``rte_security_macsec_stats`` and security capability structure
> +  ``rte_security_capability`` to accomodate MACsec capabilities.
> +
>  * metrics: The function ``rte_metrics_init`` will have a non-void return
>    in order to notify errors instead of calling ``rte_exit``.
> 
> --
> 2.25.1
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
  
Jerin Jacob July 11, 2022, 3 p.m. UTC | #3
On Wed, Jun 29, 2022 at 1:10 PM Zhang, Roy Fan <roy.fan.zhang@intel.com> wrote:
>
> > -----Original Message-----
> > From: Akhil Goyal <gakhil@marvell.com>
> > Sent: Tuesday, June 28, 2022 8:08 PM
> > To: dev@dpdk.org
> > Cc: thomas@monjalon.net; david.marchand@redhat.com;
> > hemant.agrawal@nxp.com; anoobj@marvell.com;
> > konstantin.v.ananyev@yandex.ru; ferruh.yigit@xilinx.com;
> > andrew.rybchenko@oktetlabs.ru; ndabilpuram@marvell.com;
> > vattunuru@marvell.com; matan@nvidia.com; Zhang, Roy Fan
> > <roy.fan.zhang@intel.com>; jerinj@marvell.com; jiawenwu@trustnetic.com;
> > Yang, Qiming <qiming.yang@intel.com>; Akhil Goyal <gakhil@marvell.com>
> > Subject: [PATCH] doc: announce support for MACsec in rte_security
> >
> > MACsec support is planned for DPDK 22.11, which would
> > result in ABI breakage in some of the rte_security structures.
> > This patch is to give deprecation notice for the affected structures.
> >
> > Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 5 +++++
> >  1 file changed, 5 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > index 4e5b23c53d..1c3bf54d72 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -116,6 +116,11 @@ Deprecation Notices
> >    pointer for the private data to the application which can be attached
> >    to the packet while enqueuing.
> >
> > +* security: MACsec support is planned to be added in DPDK 22.11 which
> > would
> > +  result in updates to structures ``rte_security_macsec_xform``,
> > +  ``rte_security_macsec_stats`` and security capability structure
> > +  ``rte_security_capability`` to accomodate MACsec capabilities.
> > +
> >  * metrics: The function ``rte_metrics_init`` will have a non-void return
> >    in order to notify errors instead of calling ``rte_exit``.
> >
> > --
> > 2.25.1
> Acked-by: Fan Zhang <roy.fan.zhang@intel.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>
  
Thomas Monjalon July 17, 2022, 9:56 a.m. UTC | #4
28/06/2022 21:08, Akhil Goyal:
> MACsec support is planned for DPDK 22.11, which would
> result in ABI breakage in some of the rte_security structures.
> This patch is to give deprecation notice for the affected structures.
> 
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>

    Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
    Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
    Acked-by: Jerin Jacob <jerinj@marvell.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4e5b23c53d..1c3bf54d72 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -116,6 +116,11 @@  Deprecation Notices
   pointer for the private data to the application which can be attached
   to the packet while enqueuing.
 
+* security: MACsec support is planned to be added in DPDK 22.11 which would
+  result in updates to structures ``rte_security_macsec_xform``,
+  ``rte_security_macsec_stats`` and security capability structure
+  ``rte_security_capability`` to accomodate MACsec capabilities.
+
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.