doc: announce change in crypto adapter metadata

Message ID 27596654d574825a71b4f422584194ebd8da6116.1628100722.git.sthotton@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce change in crypto adapter metadata |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-testing warning apply patch failure
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Shijith Thotton Aug. 4, 2021, 6:14 p.m. UTC
  In crypto adapter metadata, first 8 bytes of request info is a space
holder for response info. For better clarity, reserved field should be
removed from request info. New space for response info can be made by
changing type of event crypto metadata to structure from union.

Signed-off-by: Shijith Thotton <sthotton@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

Akhil Goyal Aug. 4, 2021, 6:17 p.m. UTC | #1
> Subject: [PATCH] doc: announce change in crypto adapter metadata
> 
> In crypto adapter metadata, first 8 bytes of request info is a space
> holder for response info. For better clarity, reserved field should be
> removed from request info. New space for response info can be made by
> changing type of event crypto metadata to structure from union.
> 
> Signed-off-by: Shijith Thotton <sthotton@marvell.com>
Acked-by: Akhil Goyal <gakhil@marvell.com>
  
Ray Kinsella Aug. 5, 2021, 10:12 a.m. UTC | #2
On 04/08/2021 19:17, Akhil Goyal wrote:
>> Subject: [PATCH] doc: announce change in crypto adapter metadata
>>
>> In crypto adapter metadata, first 8 bytes of request info is a space
>> holder for response info. For better clarity, reserved field should be
>> removed from request info. New space for response info can be made by
>> changing type of event crypto metadata to structure from union.
>>
>> Signed-off-by: Shijith Thotton <sthotton@marvell.com>
> Acked-by: Akhil Goyal <gakhil@marvell.com>
> 
Acked-by: Ray Kinsella <mdr@ashroe.eu>
  
Jerin Jacob Aug. 5, 2021, 10:21 a.m. UTC | #3
On Thu, Aug 5, 2021 at 3:42 PM Kinsella, Ray <mdr@ashroe.eu> wrote:
>
>
>
> On 04/08/2021 19:17, Akhil Goyal wrote:
> >> Subject: [PATCH] doc: announce change in crypto adapter metadata
> >>
> >> In crypto adapter metadata, first 8 bytes of request info is a space
> >> holder for response info. For better clarity, reserved field should be
> >> removed from request info. New space for response info can be made by
> >> changing type of event crypto metadata to structure from union.
> >>
> >> Signed-off-by: Shijith Thotton <sthotton@marvell.com>
> > Acked-by: Akhil Goyal <gakhil@marvell.com>
> >
> Acked-by: Ray Kinsella <mdr@ashroe.eu>

+ @Gujjar, Abhinandan S

Acked-by: Jerin Jacob <jerinj@marvell.com>
  
Thomas Monjalon Aug. 7, 2021, 3:10 p.m. UTC | #4
> > >> In crypto adapter metadata, first 8 bytes of request info is a space
> > >> holder for response info. For better clarity, reserved field should be
> > >> removed from request info. New space for response info can be made by
> > >> changing type of event crypto metadata to structure from union.
> > >>
> > >> Signed-off-by: Shijith Thotton <sthotton@marvell.com>
> > > Acked-by: Akhil Goyal <gakhil@marvell.com>
> > >
> > Acked-by: Ray Kinsella <mdr@ashroe.eu>
> 
> + @Gujjar, Abhinandan S
> 
> 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 9584d6bfd7..c131f1a947 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -147,3 +147,9 @@  Deprecation Notices
 * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific
   content. On Linux and FreeBSD, supported prior to DPDK 20.11,
   original structure will be kept until DPDK 21.11.
+
+* eventdev: Reserved bytes of ``rte_event_crypto_request`` is a space holder
+  for ``response_info``. Both should be decoupled for better clarity. New
+  space for ``response_info`` can be made by changing
+  ``rte_event_crypto_metadata`` type to structure from union. This change is
+  targeted for DPDK 21.11.