[PATCH v4] doc: announce changes in bbdev related to enum extension

[Chautru, Nicolas]

Hi Thomas, 
Can this one be applied based on your review? 
Thanks
Nic

> -----Original Message-----
> From: Maxime Coquelin <maxime.coquelin at redhat.com>
> Sent: Thursday, June 9, 2022 12:54 AM
> To: Chautru, Nicolas <nicolas.chautru at intel.com>; dev at dpdk.org;
> gakhil at marvell.com; thomas at monjalon.net
> Cc: trix at redhat.com; Kinsella, Ray <ray.kinsella at intel.com>; Richardson, Bruce
> <bruce.richardson at intel.com>; hemant.agrawal at nxp.com;
> david.marchand at redhat.com; stephen at networkplumber.org
> Subject: Re: [PATCH v4] doc: announce changes in bbdev related to enum
> extension
> 
> Hi Nicolas,
> 
> On 6/9/22 02:34, Nicolas Chautru wrote:
> > Intent to resolve in DPDK 22.11 historical usage which prevents
> > graceful extension of enum and API without troublesome ABI breakage as
> > well as extending API RTE_BBDEV_OP_FFT for new operation type in bbdev
> > as well as other new members in existing structures.
> >
> > Signed-off-by: Nicolas Chautru <nicolas.chautru at intel.com>
> > ---
> >   doc/guides/rel_notes/deprecation.rst | 11 +++++++++++
> >   1 file changed, 11 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > index 4e5b23c..c8ab1ec 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -112,6 +112,17 @@ Deprecation Notices
> >     session and the private data of session. An opaque pointer can be exposed
> >     directly to application which can be attached to the ``rte_crypto_op``.
> >
> > +* bbdev: ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the
> > +``rte_bbdev_op_type``
> > +  enum will be deprecated and instead use fixed array size when
> > +required to allow for
> > +  future enum extension.
> > +  Will extend API to support new operation type ``RTE_BBDEV_OP_FFT``
> > +as per this
> > +  RFC https://patchwork.dpdk.org/project/dpdk/list/?series=22111
> > +  New members will be added in ``rte_bbdev_driver_info`` to expose
> > +PMD queue topology inspired
> > +  by this RFC
> > +https://patches.dpdk.org/project/dpdk/list/?series=22076
> > +  New member will be added in ``rte_bbdev_driver_info`` to expose the
> > +device status as per
> > +  this RFC https://patches.dpdk.org/project/dpdk/list/?series=23367
> > +  This should be updated in DPDK 22.11.
> > +
> >   * security: Hide structure ``rte_security_session`` and expose an opaque
> >     pointer for the private data to the application which can be attached
> >     to the packet while enqueuing.
> 
> Thanks for rewording the notice.
> 
> Acked-by: Maxime Coquelin <maxime.coquelin at redhat.com>
> 
> Maxime