doc: announce removal of octeontx2 drivers
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
index edfbe5d..e730d3e 100644 (file)
@@ -17,13 +17,6 @@ Deprecation Notices
 * eal: The function ``rte_eal_remote_launch`` will return new error codes
   after read or write error on the pipe, instead of calling ``rte_panic``.
 
-* eal: The lcore state ``FINISHED`` will be removed from
-  the ``enum rte_lcore_state_t``.
-  The lcore state ``WAIT`` is enough to represent the same state.
-
-* eal: Making ``struct rte_intr_handle`` internal to avoid any ABI breakages
-  in future.
-
 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
   not allow for writing optimized code for all the CPU architectures supported
   in DPDK. DPDK has adopted the atomic operations from
@@ -50,11 +43,6 @@ Deprecation Notices
 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
   will be removed in DPDK 22.11.
 
-* mbuf: The mbuf offload flags ``PKT_*`` will be renamed as ``RTE_MBUF_F_*``.
-  A compatibility layer will be kept until DPDK 22.11, except for the flags
-  that are already deprecated (``PKT_RX_L4_CKSUM_BAD``, ``PKT_RX_IP_CKSUM_BAD``,
-  ``PKT_RX_EIP_CKSUM_BAD``, ``PKT_TX_QINQ_PKT``) which will be removed.
-
 * pci: To reduce unnecessary ABIs exposed by DPDK bus driver, "rte_bus_pci.h"
   will be made internal in 21.11 and macros/data structures/functions defined
   in the header will not be considered as ABI anymore. This change is inspired
@@ -69,22 +57,16 @@ Deprecation Notices
   ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
   type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
   usage in following public struct hierarchy:
-  ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
+  ``rte_eth_fdir_flex_conf -> rte_eth_fdir_conf -> rte_eth_conf (in the middle)``.
   Need to identify this kind of usages and fix in 20.11, otherwise this blocks
   us extending existing enum/define.
   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
 
-* ethdev: Will add ``RTE_ETH_`` prefix to all ethdev macros/enums in v21.11.
-  Macros will be added for backward compatibility.
-  Backward compatibility macros will be removed on v22.11.
-  A few old backward compatibility macros from 2013 that does not have
-  proper prefix will be removed on v21.11.
-
 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
   and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
   will be removed in DPDK 20.11.
 
-* ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
+* ethdev: New offload flags ``RTE_ETH_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
   This will allow application to enable or disable PMDs from updating
   ``rte_mbuf::hash::fdir``.
   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
@@ -105,9 +87,6 @@ Deprecation Notices
   In v21.11 LTS, protocol header fields will be cleaned and only protocol header
   struct will remain.
 
-* ethdev: Add new Rx queue offload flag ``RTE_ETH_RX_OFFLOAD_SHARED_RXQ`` and
-  ``shared_group`` field to ``struct rte_eth_rxconf``.
-
 * ethdev: Queue specific stats fields will be removed from ``struct rte_eth_stats``.
   Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``,
   ``q_errors``.
@@ -122,21 +101,6 @@ Deprecation Notices
   is deprecated as ambiguous with respect to the embedded switch. The use of
   these attributes will become invalid starting from DPDK 22.11.
 
-* vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,
-  ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA
-  driver interface will be marked as internal in DPDK v21.11.
-
-* vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``
-  in DPDK v21.11.
-
-* vhost: The experimental tags of ``rte_vhost_driver_get_protocol_features``,
-  ``rte_vhost_driver_get_queue_num``, ``rte_vhost_crypto_create``,
-  ``rte_vhost_crypto_free``, ``rte_vhost_crypto_fetch_requests``,
-  ``rte_vhost_crypto_finalize_requests``, ``rte_vhost_crypto_set_zero_copy``,
-  ``rte_vhost_va_from_guest_pa``, ``rte_vhost_extern_callback_register``,
-  and ``rte_vhost_driver_set_protocol_features`` functions will be removed
-  and the API functions will be made stable in DPDK 21.11.
-
 * cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
   ``rte_cryptodev_asym_session`` to remove unnecessary indirection between
   session and the private data of session. An opaque pointer can be exposed
@@ -146,42 +110,29 @@ Deprecation Notices
   pointer for the private data to the application which can be attached
   to the packet while enqueuing.
 
-* eventdev: The file ``rte_eventdev_pmd.h`` will be renamed to ``eventdev_driver.h``
-  to make the driver interface as internal and the structures ``rte_eventdev_data``,
-  ``rte_eventdev`` and ``rte_eventdevs`` will be moved to a new file named
-  ``rte_eventdev_core.h`` in DPDK 21.11.
-  The ``rte_`` prefix for internal structures and functions will be removed across the
-  library.
-  The experimental eventdev trace APIs and ``rte_event_vector_pool_create``,
-  ``rte_event_eth_rx_adapter_vector_limits_get`` will be promoted to stable.
-  An 8-byte reserved field will be added to the structure ``rte_event_timer`` to
-  support future extensions.
-
-* eventdev: The structure ``rte_event_eth_rx_adapter_queue_conf`` will be
-  extended to include ``rte_event_eth_rx_adapter_event_vector_config`` elements
-  and the function ``rte_event_eth_rx_adapter_queue_event_vector_config`` will
-  be removed in DPDK 21.11.
-
-  An application can enable event vectorization by passing the desired vector
-  values to the function ``rte_event_eth_rx_adapter_queue_add`` using
-  the structure ``rte_event_eth_rx_adapter_queue_add``.
-
-* eventdev: Reserved bytes of ``rte_event_crypto_request`` is a space holder
-  for ``response_info``. Both should be decoupled for better clarity in
-  DPDK 21.11.
-  New space for ``response_info`` can be made by changing
-  ``rte_event_crypto_metadata`` type to structure from union.
-
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.
 
-* 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.
-
 * raw/ioat: The ``ioat`` rawdev driver has been deprecated, since it's
   functionality is provided through the new ``dmadev`` infrastructure.
   To continue to use hardware previously supported by the ``ioat`` rawdev driver,
   applications should be updated to use the ``dmadev`` library instead,
   with the underlying HW-functionality being provided by the ``ioat`` or
   ``idxd`` dma drivers
+
+* drivers/octeontx2: remove octeontx2 drivers
+
+  In the view of enabling unified driver for ``octeontx2(cn9k)``/``octeontx3(cn10k)``,
+  removing ``drivers/octeontx2`` drivers and replace with ``drivers/cnxk/`` which
+  supports both ``octeontx2(cn9k)`` and ``octeontx3(cn10k)`` SoCs.
+  This deprecation notice is to do following actions in DPDK v22.02 version.
+
+  #. Replace ``drivers/common/octeontx2/`` with ``drivers/common/cnxk/``
+  #. Replace ``drivers/mempool/octeontx2/`` with ``drivers/mempool/cnxk/``
+  #. Replace ``drivers/net/octeontx2/`` with ``drivers/net/cnxk/``
+  #. Replace ``drivers/event/octeontx2/`` with ``drivers/event/cnxk/``
+  #. Replace ``drivers/crypto/octeontx2/`` with ``drivers/crypto/cnxk/``
+  #. Rename ``drivers/regex/octeontx2/`` as ``drivers/regex/cn9k/``
+  #. Rename ``config/arm/arm64_octeontx2_linux_gcc`` as ``config/arm/arm64_cn9k_linux_gcc``
+
+  Last two actions are to align naming convention as cnxk scheme.