X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=9584d6bfd723135bfbb3afdef9581b44a7592065;hb=dbba7c9efbb9ed5cfc88c192213f54b1f9942c00;hp=49011262efd1ac6bad6b7ea85205065ff3d286b2;hpb=f79e7b094d14f591e1d86bdf46adbde3102ce40c;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 49011262ef..9584d6bfd7 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -11,20 +11,6 @@ here. Deprecation Notices ------------------- -* build: The macros defined to indicate which DPDK libraries and drivers - are included in the meson build are changing to a standardized format of - ``RTE_LIB_`` and ``RTE__``, where ``NAME`` is the - upper-case component name, e.g. EAL, ETHDEV, IXGBE, and ``CLASS`` is the - upper-case name of the device class to which a driver belongs e.g. - ``NET``, ``CRYPTO``, ``VDPA``. The old macros are deprecated and will be - removed in a future release. - -* meson: The minimum supported version of meson for configuring and building - DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For - those users with a version earlier than 0.47.1, an updated copy of meson - can be got using the ``pip3`` tool (or ``python3 -m pip``) for downloading - python packages. - * kvargs: The function ``rte_kvargs_process`` will get a new parameter for returning key match count. It will ease handling of no-match case. @@ -70,6 +56,31 @@ Deprecation Notices In 19.11 PMDs will still update the field even when the offload is not enabled. +* ethdev: ``uint32_t max_rx_pkt_len`` field of ``struct rte_eth_rxmode``, will be + replaced by a new ``uint32_t mtu`` field of ``struct rte_eth_conf`` in v21.11. + The new ``mtu`` field will be used to configure the initial device MTU via + ``rte_eth_dev_configure()`` API. + Later MTU can be changed by ``rte_eth_dev_set_mtu()`` API as done now. + The existing ``(struct rte_eth_dev)->data->mtu`` variable will be used to store + the configured ``mtu`` value, + and this new ``(struct rte_eth_dev)->data->dev_conf.mtu`` variable will + be used to store the user configuration request. + Unlike ``max_rx_pkt_len``, which was valid only when ``JUMBO_FRAME`` enabled, + ``mtu`` field will be always valid. + When ``mtu`` config is not provided by the application, default ``RTE_ETHER_MTU`` + value will be used. + ``(struct rte_eth_dev)->data->mtu`` should be updated after MTU set successfully, + either by ``rte_eth_dev_configure()`` or ``rte_eth_dev_set_mtu()``. + + An application may need to configure device for a specific Rx packet size, like for + cases ``DEV_RX_OFFLOAD_SCATTER`` is not supported and device received packet size + can't be bigger than Rx buffer size. + To cover these cases an application needs to know the device packet overhead to be + able to calculate the ``mtu`` corresponding to a Rx buffer size, for this + ``(struct rte_eth_dev_info).max_rx_pktlen`` will be kept, + the device packet overhead can be calculated as: + ``(struct rte_eth_dev_info).max_rx_pktlen - (struct rte_eth_dev_info).max_mtu`` + * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done`` will be removed in 21.11. Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status`` @@ -81,6 +92,20 @@ Deprecation Notices as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``. This API will be fully removed in DPDK 21.11. +* ethdev: Attribute ``shared`` of the ``struct rte_flow_action_count`` + is deprecated and will be removed in DPDK 21.11. Shared counters should + be managed using shared actions API (``rte_flow_shared_action_create`` etc). + +* ethdev: The flow API matching pattern structures, ``struct rte_flow_item_*``, + should start with relevant protocol header. + Some matching pattern structures implements this by duplicating protocol header + fields in the struct. To clarify the intention and to be sure protocol header + is intact, will replace those fields with relevant protocol header struct. + In v21.02 both individual protocol header fields and the protocol header struct + will be added as union, target is switch usage to the protocol header by time. + In v21.11 LTS, protocol header fields will be cleaned and only protocol header + struct will remain. + * 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``. @@ -88,11 +113,27 @@ Deprecation Notices will be limited to maximum 256 queues. Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed. -* Broadcom bnxt PMD: NetXtreme devices belonging to the ``BCM573xx and - BCM5740x`` families will no longer be supported as of DPDK 21.02. - Specifically the support for the following Broadcom PCI IDs will be removed - from the release: ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df,`` - ``0x16d0, 0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9``. +* ethdev: The offload flag ``PKT_RX_EIP_CKSUM_BAD`` will be removed and + replaced by the new flag ``PKT_RX_OUTER_IP_CKSUM_BAD``. The new name is more + consistent with existing outer header checksum status flag naming, which + should help in reducing confusion about its usage. + +* i40e: As there are both i40evf and iavf pmd, the functions of them are + duplicated. And now more and more advanced features are developed on iavf. + To keep consistent with kernel driver's name + (https://patchwork.ozlabs.org/patch/970154/), i40evf is no need to maintain. + Starting from 21.05, the default VF driver of i40e will be iavf, but i40evf + can still be used if users specify the devarg "driver=i40evf". I40evf will + be deleted in DPDK 21.11. + +* 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``. * sched: To allow more traffic classes, flexible mapping of pipe queues to traffic classes, and subport level configuration of pipes and queues @@ -106,8 +147,3 @@ Deprecation Notices * 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. - -* dpdk-setup.sh: This old script relies on deprecated stuff, and especially - ``make``. Given environments are too much variables for such a simple script, - it will be removed in DPDK 20.11. - Some useful parts may be converted into specific scripts.