doc/guides/rel_notes/release_20_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.11
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21       xdg-open build/doc/html/guides/rel_notes/release_20_11.html
  22
  23
  24 New Features
  25 ------------
  26
  27 .. This section should contain new features added in this release.
  28    Sample format:
  29
  30    * **Add a title in the past tense with a full stop.**
  31
  32      Add a short 1-2 sentence description in the past tense.
  33      The description should be enough to allow someone scanning
  34      the release notes to understand the new feature.
  35
  36      If the feature adds a lot of sub-features you can use a bullet list
  37      like this:
  38
  39      * Added feature foo to do something.
  40      * Enhanced feature bar to do something else.
  41
  42      Refer to the previous release notes for examples.
  43
  44      Suggested order in release notes items:
  45      * Core libs (EAL, mempool, ring, mbuf, buses)
  46      * Device abstraction libs and PMDs
  47        - ethdev (lib, PMDs)
  48        - cryptodev (lib, PMDs)
  49        - eventdev (lib, PMDs)
  50        - etc
  51      * Other libs
  52      * Apps, Examples, Tools (if significant)
  53
  54      This section is a comment. Do not overwrite or remove it.
  55      Also, make sure to start the actual text at the margin.
  56      =======================================================
  57
  58 * **Updated Cisco enic driver.**
  59
  60   * Added support for VF representors with single-queue Tx/Rx and flow API
  61   * Added support for egress PORT_ID action
  62   * Added support for non-zero priorities for group 0 flows
  63   * Added support for VXLAN decap combined with VLAN pop
  64
  65 * **Extended flow-perf application.**
  66
  67   * Started supporting user order instead of bit mask:
  68     Now the user can create any structure of rte_flow
  69     using flow performance application with any order,
  70     moreover the app also now starts to support inner
  71     items matching as well.
  72   * Added header modify actions.
  73   * Added flag action.
  74   * Added raw encap/decap actions.
  75   * Added VXLAN encap/decap actions.
  76   * Added ICMP and ICMP6 matching items.
  77   * Added option to set port mask for insertion/deletion:
  78     ``--portmask=N``
  79     where N represents the hexadecimal bitmask of ports used.
  80
  81
  82 Removed Items
  83 -------------
  84
  85 .. This section should contain removed items in this release. Sample format:
  86
  87    * Add a short 1-2 sentence description of the removed item
  88      in the past tense.
  89
  90    This section is a comment. Do not overwrite or remove it.
  91    Also, make sure to start the actual text at the margin.
  92    =======================================================
  93
  94
  95 API Changes
  96 -----------
  97
  98 .. This section should contain API changes. Sample format:
  99
 100    * sample: Add a short 1-2 sentence description of the API change
 101      which was announced in the previous releases and made in this release.
 102      Start with a scope label like "ethdev:".
 103      Use fixed width quotes for ``function_names`` or ``struct_names``.
 104      Use the past tense.
 105
 106    This section is a comment. Do not overwrite or remove it.
 107    Also, make sure to start the actual text at the margin.
 108    =======================================================
 109
 110 * eal: The ``rte_logs`` struct and global symbol was made private
 111   and is no longer part of the API.
 112
 113 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 114   used it.
 115
 116 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
 117   and are removed in this release.
 118
 119 * mem: Removed the unioned field ``phys_addr`` from
 120   the structures ``rte_memseg`` and ``rte_memzone``.
 121   The field ``iova`` is remaining from the old unions.
 122
 123 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 124   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 125   The field ``iova`` is remaining from the old unions.
 126   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 127   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 128
 129 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 130   and the macros ``rte_pktmbuf_mtophys*``.
 131   The same functionality is still available with the functions and macros
 132   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 133
 134 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 135   The field ``buf_iova`` is remaining from the old union.
 136
 137 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 138   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 139   The field ``refcnt`` is remaining from the old unions.
 140
 141 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 142   replaced with a private enum in the PCI subsystem.
 143
 144 * pci: Removed the PCI resources map API from the public API
 145   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 146   PCI bus driver along with the PCI resources lists and associated structures
 147   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 148   ``mapped_pci_res_list``).
 149
 150 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 151   structure as it gave no useful abstracted information to the applications.
 152
 153 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 154
 155 * Renamed internal ethdev APIs:
 156
 157   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 158   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 159
 160 * rawdev: Added a structure size parameter to the functions
 161   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 162   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 163   allowing limited driver type-checking and ABI compatibility.
 164
 165 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 166   and the function ``rte_rawdev_queue_conf_get()``
 167   from ``void`` to ``int`` allowing the return of error codes from drivers.
 168
 169 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 170
 171
 172 ABI Changes
 173 -----------
 174
 175 .. This section should contain ABI changes. Sample format:
 176
 177    * sample: Add a short 1-2 sentence description of the ABI change
 178      which was announced in the previous releases and made in this release.
 179      Start with a scope label like "ethdev:".
 180      Use fixed width quotes for ``function_names`` or ``struct_names``.
 181      Use the past tense.
 182
 183    This section is a comment. Do not overwrite or remove it.
 184    Also, make sure to start the actual text at the margin.
 185    =======================================================
 186
 187 * ``ethdev`` changes
 188
 189   * Following device operation function pointers moved
 190     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 191
 192     * ``eth_rx_queue_count_t       rx_queue_count;``
 193     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 194     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 195     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 196
 197   * ``struct eth_dev_ops`` is no more accessible by applications,
 198     which was already internal data structure.
 199
 200   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 201
 202
 203 Known Issues
 204 ------------
 205
 206 .. This section should contain new known issues in this release. Sample format:
 207
 208    * **Add title in present tense with full stop.**
 209
 210      Add a short 1-2 sentence description of the known issue
 211      in the present tense. Add information on any known workarounds.
 212
 213    This section is a comment. Do not overwrite or remove it.
 214    Also, make sure to start the actual text at the margin.
 215    =======================================================
 216
 217
 218 Tested Platforms
 219 ----------------
 220
 221 .. This section should contain a list of platforms that were tested
 222    with this release.
 223
 224    The format is:
 225
 226    * <vendor> platform with <vendor> <type of devices> combinations
 227
 228      * List of CPU
 229      * List of OS
 230      * List of devices
 231      * Other relevant details...
 232
 233    This section is a comment. Do not overwrite or remove it.
 234    Also, make sure to start the actual text at the margin.
 235    =======================================================