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