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
  62 * **Extended flow-perf application.**
  63
  64   * Started supporting user order instead of bit mask:
  65     Now the user can create any structure of rte_flow
  66     using flow performance application with any order,
  67     moreover the app also now starts to support inner
  68     items matching as well.
  69   * Added header modify actions.
  70   * Added flag action.
  71   * Added raw encap/decap actions.
  72   * Added VXLAN encap/decap actions.
  73   * Added ICMP and ICMP6 matching items.
  74   * Added option to set port mask for insertion/deletion:
  75     ``--portmask=N``
  76     where N represents the hexadecimal bitmask of ports used.
  77
  78
  79 Removed Items
  80 -------------
  81
  82 .. This section should contain removed items in this release. Sample format:
  83
  84    * Add a short 1-2 sentence description of the removed item
  85      in the past tense.
  86
  87    This section is a comment. Do not overwrite or remove it.
  88    Also, make sure to start the actual text at the margin.
  89    =======================================================
  90
  91
  92 API Changes
  93 -----------
  94
  95 .. This section should contain API changes. Sample format:
  96
  97    * sample: Add a short 1-2 sentence description of the API change
  98      which was announced in the previous releases and made in this release.
  99      Start with a scope label like "ethdev:".
 100      Use fixed width quotes for ``function_names`` or ``struct_names``.
 101      Use the past tense.
 102
 103    This section is a comment. Do not overwrite or remove it.
 104    Also, make sure to start the actual text at the margin.
 105    =======================================================
 106
 107 * eal: The ``rte_logs`` struct and global symbol was made private
 108   and is no longer part of the API.
 109
 110 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 111   used it.
 112
 113 * mem: Removed the unioned field ``phys_addr`` from
 114   the structures ``rte_memseg`` and ``rte_memzone``.
 115   The field ``iova`` is remaining from the old unions.
 116
 117 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 118   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 119   The field ``iova`` is remaining from the old unions.
 120   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 121   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 122
 123 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 124   and the macros ``rte_pktmbuf_mtophys*``.
 125   The same functionality is still available with the functions and macros
 126   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 127
 128 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 129   The field ``buf_iova`` is remaining from the old union.
 130
 131 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 132   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 133   The field ``refcnt`` is remaining from the old unions.
 134
 135 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 136   replaced with a private enum in the PCI subsystem.
 137
 138 * pci: Removed the PCI resources map API from the public API
 139   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 140   PCI bus driver along with the PCI resources lists and associated structures
 141   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 142   ``mapped_pci_res_list``).
 143
 144 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 145   structure as it gave no useful abstracted information to the applications.
 146
 147 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 148
 149 * Renamed internal ethdev APIs:
 150
 151   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 152   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 153
 154 * rawdev: Added a structure size parameter to the functions
 155   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 156   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 157   allowing limited driver type-checking and ABI compatibility.
 158
 159 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 160   and the function ``rte_rawdev_queue_conf_get()``
 161   from ``void`` to ``int`` allowing the return of error codes from drivers.
 162
 163 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 164
 165
 166 ABI Changes
 167 -----------
 168
 169 .. This section should contain ABI changes. Sample format:
 170
 171    * sample: Add a short 1-2 sentence description of the ABI change
 172      which was announced in the previous releases and made in this release.
 173      Start with a scope label like "ethdev:".
 174      Use fixed width quotes for ``function_names`` or ``struct_names``.
 175      Use the past tense.
 176
 177    This section is a comment. Do not overwrite or remove it.
 178    Also, make sure to start the actual text at the margin.
 179    =======================================================
 180
 181 * ``ethdev`` changes
 182
 183   * Following device operation function pointers moved
 184     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 185
 186     * ``eth_rx_queue_count_t       rx_queue_count;``
 187     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 188     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 189     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 190
 191   * ``struct eth_dev_ops`` is no more accessible by applications,
 192     which was already internal data structure.
 193
 194   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 195
 196
 197 Known Issues
 198 ------------
 199
 200 .. This section should contain new known issues in this release. Sample format:
 201
 202    * **Add title in present tense with full stop.**
 203
 204      Add a short 1-2 sentence description of the known issue
 205      in the present tense. Add information on any known workarounds.
 206
 207    This section is a comment. Do not overwrite or remove it.
 208    Also, make sure to start the actual text at the margin.
 209    =======================================================
 210
 211
 212 Tested Platforms
 213 ----------------
 214
 215 .. This section should contain a list of platforms that were tested
 216    with this release.
 217
 218    The format is:
 219
 220    * <vendor> platform with <vendor> <type of devices> combinations
 221
 222      * List of CPU
 223      * List of OS
 224      * List of devices
 225      * Other relevant details...
 226
 227    This section is a comment. Do not overwrite or remove it.
 228    Also, make sure to start the actual text at the margin.
 229    =======================================================