X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=1ce692eaca343d6a905be93742952783cdcef4d3;hb=ee61f5113b170b3b7742c7060c7e9cef6f5bc6ca;hp=df54674d6006dd0ffa353f86273dc7f54a80175e;hpb=62111861411fae277cb90accd6d8100bdba463c3;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index df54674d60..1ce692eaca 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,13 +8,22 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* eal: both declaring and identifying devices will be streamlined in v18.05. +* eal: DPDK runtime configuration file (located at + ``/var/run/._config``) will be moved. The new path will be as follows: + + - if DPDK is running as root, path will be set to + ``/var/run/dpdk//config`` + - if DPDK is not running as root and $XDG_RUNTIME_DIR is set, path will be set + to ``$XDG_RUNTIME_DIR/dpdk//config`` + - if DPDK is not running as root and $XDG_RUNTIME_DIR is not set, path will be + set to ``/tmp/dpdk//config`` + +* eal: both declaring and identifying devices will be streamlined in v18.08. 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. As such, ``rte_devargs`` device representation will change. - - removal of ``name`` and ``args`` fields. - The enum ``rte_devtype`` was used to identify a bus and will disappear. - Functions previously deprecated will change or disappear: @@ -32,8 +41,8 @@ Deprecation Notices mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by ``rte_mbuf_best_mempool_ops``. - The following function is now redundant and it is target to be deprecated - in 18.05: + The following function is deprecated since 18.05, and will be removed + in 18.08: - ``rte_eal_mbuf_default_mempool_ops`` @@ -42,6 +51,13 @@ Deprecation Notices is defined in librte_sched in a non-generic way. The new generic format will contain: queue ID, traffic class, color. Field size will not change. +* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and + replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As + ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()`` + can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new + experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro + is to fix this semantic inconsistency. + * ethdev: a new Tx and Rx offload API was introduced on 17.11. In the new API, offloads are divided into per-port and per-queue offloads. Offloads are disabled by default and enabled per application request. @@ -51,6 +67,22 @@ Deprecation Notices - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct. - removal of the offloads bit-field from ``rte_eth_rxmode`` struct. +* ethdev: A new offloading flag ``DEV_RX_OFFLOAD_KEEP_CRC`` will be added in v18.08, + This will replace the usage of not setting ``DEV_RX_OFFLOAD_CRC_STRIP`` flag + and will be implemented in PMDs accordingly. + In v18.08 both ``DEV_RX_OFFLOAD_KEEP_CRC`` and ``DEV_RX_OFFLOAD_CRC_STRIP`` flags + will be available, usage will be: + ``CRC_STRIP``: Strip CRC from packet + ``KEEP_CRC``: Keep CRC in packet + Both ``CRC_STRIP`` & ``KEEP_CRC``: Invalid + No flag: Keep CRC in packet + +* 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,