From: Bernard Iremonger Date: Thu, 5 Jan 2017 15:25:36 +0000 (+0000) Subject: doc: announce move of ethdev bypass function to ixgbe API X-Git-Tag: spdx-start~4477 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=610b7b78e0686e5776f021be6bbe71458232d08b;p=dpdk.git doc: announce move of ethdev bypass function to ixgbe API In 17.05, nine rte_eth_dev_* functions for bypass control, and implemented only in ixgbe, will be removed from ethdev, renamed and moved to the ixgbe PMD-specific API. Signed-off-by: Bernard Iremonger Acked-by: Thomas Monjalon Acked-by: Jerin Jacob Acked-by: Bernard Iremonger --- diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index d2a6f82ff2..ab2489bee7 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -52,6 +52,29 @@ Deprecation Notices ``_rte_eth_dev_callback_process``. In 17.05 the function will return an ``int`` instead of ``void`` and a fourth parameter ``void *ret_param`` will be added. +* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* + functions and move them into the ixgbe PMD: + + ``rte_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``, + ``rte_eth_dev_bypass_state_show``, ``rte_eth_dev_bypass_event_store``, + ``rte_eth_dev_bypass_event_show``, ``rte_eth_dev_wd_timeout_store``, + ``rte_eth_dev_bypass_wd_timeout_show``, ``rte_eth_dev_bypass_ver_show``, + ``rte_eth_dev_bypass_wd_reset``. + + The following fields will be removed from ``struct eth_dev_ops``: + + ``bypass_init_t``, ``bypass_state_set_t``, ``bypass_state_show_t``, + ``bypass_event_set_t``, ``bypass_event_show_t``, ``bypass_wd_timeout_set_t``, + ``bypass_wd_timeout_show_t``, ``bypass_ver_show_t``, ``bypass_wd_reset_t``. + + The functions will be renamed to the following, and moved to the ``ixgbe`` PMD: + + ``rte_pmd_ixgbe_bypass_init``, ``rte_pmd_ixgbe_bypass_state_set``, + ``rte_pmd_ixgbe_bypass_state_show``, ``rte_pmd_ixgbe_bypass_event_set``, + ``rte_pmd_ixgbe_bypass_event_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_set``, + ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``, + ``rte_pmd_ixgbe_bypass_wd_reset``. + * ABI changes are planned for 17.05 in the ``rte_mbuf`` structure: some fields may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and ``nb_segs`` in one operation, because some platforms have an overhead if the