+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright 2018 The DPDK contributors
+
ABI and API Deprecation
=======================
Deprecation Notices
-------------------
-* eal: certain structures will change in EAL on account of upcoming external
- memory support. Aside from internal changes leading to an ABI break, the
- following externally visible changes will also be implemented:
-
- - ``rte_memseg_list`` will change to include a boolean flag indicating
- whether a particular memseg list is externally allocated. This will have
- implications for any users of memseg-walk-related functions, as they will
- now have to skip externally allocated segments in most cases if the intent
- is to only iterate over internal DPDK memory.
- - ``socket_id`` parameter across the entire DPDK will gain additional meaning,
- as some socket ID's will now be representing externally allocated memory. No
- changes will be required for existing code as backwards compatibility will
- be kept, and those who do not use this feature will not see these extra
- socket ID's.
-
-* eal: both declaring and identifying devices will be streamlined in v18.08.
+* kvargs: The function ``rte_kvargs_process`` will get a new parameter
+ for returning key match count. It will ease handling of no-match case.
+
+* eal: function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
+ ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
+ will be added in the next release in ``rte_common.h`` that follows convention
+ set by existing ``rte_bsf32`` function.
+
+* eal: both declaring and identifying devices will be streamlined in v18.11.
New functions will appear to query a specific port from buses, classes of
device and device drivers. Device declaration will be made coherent with the
new scheme of device identification.
- Functions previously deprecated will change or disappear:
+ ``rte_eal_devargs_type_count``
- + ``rte_eal_devargs_parse`` will change its format and use.
* pci: Several exposed functions are misnamed.
The following functions are deprecated starting from v17.11 and are replaced:
- ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
- ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
+* dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
+ by a pa-va search library. This structure was earlier being used for holding
+ memory segments used by dpaa2 driver for faster pa->va translation. This
+ structure would be made internal (or removed if all dependencies are cleared)
+ in future releases.
+
* mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
definition in line with the ethdev TM and MTR APIs. Currently, this field
is defined in librte_sched in a non-generic way. The new generic format
experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
is to fix this semantic inconsistency.
-* ethdev: In v18.11 ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag will be removed, default
- behavior without any flag will be changed to CRC strip.
- To keep CRC ``DEV_RX_OFFLOAD_KEEP_CRC`` flag is required.
- ``KEEP_CRC``: Keep CRC in packet
- No flag: Strip CRC from packet
-
* ethdev: the legacy filter API, including
``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
-* ethdev: In v18.11 ``rte_eth_dev_attach()`` and ``rte_eth_dev_detach()``
- will be removed.
- Hotplug functions ``rte_eal_hotplug_add()`` and ``rte_eal_hotplug_remove()``
- should be used instread.
- Function ``rte_eth_dev_get_port_by_name()`` may be used to find
- identifier of the added port.
-
-* eal: In v18.11 ``rte_eal_dev_attach()`` and ``rte_eal_dev_detach()``
- will be removed.
- Hotplug functions ``rte_eal_hotplug_add()`` and ``rte_eal_hotplug_remove()``
- should be used directly.
+* ethdev: Maximum and minimum MTU values vary between hardware devices. In
+ hardware agnostic DPDK applications access to such information would allow
+ a more accurate way of validating and setting supported MTU values on a per
+ device basis rather than using a defined default for all devices. To
+ resolve this, the following members will be added to ``rte_eth_dev_info``.
+ Note: these can be added to fit a hole in the existing structure for amd64
+ but not for 32-bit, as such ABI change will occur as size of the structure
+ will increase.
+
+ - Member ``uint16_t min_mtu`` the minimum MTU allowed.
+ - Member ``uint16_t max_mtu`` the maximum MTU allowed.
* pdump: As we changed to use generic IPC, some changes in APIs and structure
are expected in subsequent release.
git.droids-corp.org / dpdk.git / blobdiff