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

[Hemant Agrawal <hemant.agrawal@nxp.com>]

> -----Original Message-----
> From: Nicolas Chautru <nicolas.chautru@intel.com>
> Sent: Thursday, June 9, 2022 6:05 AM
> To: dev@dpdk.org; gakhil@marvell.com; thomas@monjalon.net;
> maxime.coquelin@redhat.com
> Cc: trix@redhat.com; ray.kinsella@intel.com; bruce.richardson@intel.com;
> Hemant Agrawal <hemant.agrawal@nxp.com>;
> david.marchand@redhat.com; stephen@networkplumber.org; Nicolas
> Chautru <nicolas.chautru@intel.com>
> Subject: [PATCH v4] doc: announce changes in bbdev related to enum
> extension
> Importance: High
> 
> 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@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://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpatc
> h
> +work.dpdk.org%2Fproject%2Fdpdk%2Flist%2F%3Fseries%3D22111&amp;da
> ta=05%7
> +C01%7Chemant.agrawal%40nxp.com%7Ce8c1b946f9ba4152d02d08da49b1
> 5297%7C686
> +ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637903323196944926%7C
> Unknown%7C
> +TWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwi
> LCJXVCI
> +6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=zDwsoIF4tF0eP2py43nwUHUz
> pS3XlDTQDiRMd
> +JxBqwg%3D&amp;reserved=0
> +  New members will be added in ``rte_bbdev_driver_info`` to expose PMD
> +queue topology inspired
> +  by this RFC
> +https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpatc
> h
> +es.dpdk.org%2Fproject%2Fdpdk%2Flist%2F%3Fseries%3D22076&amp;data=
> 05%7C0
> +1%7Chemant.agrawal%40nxp.com%7Ce8c1b946f9ba4152d02d08da49b152
> 97%7C686ea
> +1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637903323196944926%7CUn
> known%7CTW
> +FpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJ
> XVCI6M
> +n0%3D%7C3000%7C%7C%7C&amp;sdata=tx8iueWoLEbbCyFQFQHKsvs9nkib
> c0ANem5dyai
> +mspQ%3D&amp;reserved=0
> +  New member will be added in ``rte_bbdev_driver_info`` to expose the
> +device status as per
> +  this RFC
> +https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpatc
> h
> +es.dpdk.org%2Fproject%2Fdpdk%2Flist%2F%3Fseries%3D23367&amp;data=
> 05%7C0
> +1%7Chemant.agrawal%40nxp.com%7Ce8c1b946f9ba4152d02d08da49b152
> 97%7C686ea
> +1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637903323196944926%7CUn
> known%7CTW
> +FpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJ
> XVCI6M
> +n0%3D%7C3000%7C%7C%7C&amp;sdata=rHnuL7B63SoFIIo1M4kdRnnDm0
> xqmCwML8CEo%2
> +BsxDBA%3D&amp;reserved=0
> +  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.
> 
Acked-by:  Hemant Agrawal <hemant.agrawal@nxp.com>