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

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

[Nicolas Chautru]

Realizing when submitting new bbdev operation in this patch
(https://patchwork.dpdk.org/project/dpdk/list/?series=22111) that this is not
workable in practice to extend this API into 22.07 without fundamental ABI breakage
even by using existing versionning framework.
Some existing learnings to be applied here to prevent extension being blocked,
hence accouncing changes in bbdev intended for 22.11 to make this more
future-proof, including dropping max value from enum, as well as deferring extension
of the API for FFT operation into DPDK 22.11.

Let me know if any comments or in case this should be captured differently.
Thanks
Nic

Nicolas Chautru (1):
  doc: announce changes in bbdev related to enum extension

 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

-- 
1.8.3.1

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

[Nicolas Chautru]

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.

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4e5b23c..238920e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -112,6 +112,14 @@ 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: Will fix extending some enum breaking the ABI. Notably
+deprecating ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the ``rte_bbdev_op_type``
+and use fixed array size when required to allow for future enum extension.
+Will also remove some of the inlining when causing ABI future-proof concerns.
+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
+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.
-- 
1.8.3.1