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 * mem: Removed the unioned field ``phys_addr`` from
 117   the structures ``rte_memseg`` and ``rte_memzone``.
 118   The field ``iova`` is remaining from the old unions.
 119
 120 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 121   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 122   The field ``iova`` is remaining from the old unions.
 123   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 124   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 125
 126 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 127   and the macros ``rte_pktmbuf_mtophys*``.
 128   The same functionality is still available with the functions and macros
 129   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 130
 131 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 132   The field ``buf_iova`` is remaining from the old union.
 133
 134 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 135   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 136   The field ``refcnt`` is remaining from the old unions.
 137
 138 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 139   replaced with a private enum in the PCI subsystem.
 140
 141 * pci: Removed the PCI resources map API from the public API
 142   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 143   PCI bus driver along with the PCI resources lists and associated structures
 144   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 145   ``mapped_pci_res_list``).
 146
 147 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 148   structure as it gave no useful abstracted information to the applications.
 149
 150 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 151
 152 * Renamed internal ethdev APIs:
 153
 154   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 155   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 156
 157 * rawdev: Added a structure size parameter to the functions
 158   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 159   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 160   allowing limited driver type-checking and ABI compatibility.
 161
 162 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 163   and the function ``rte_rawdev_queue_conf_get()``
 164   from ``void`` to ``int`` allowing the return of error codes from drivers.
 165
 166 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 167
 168
 169 ABI Changes
 170 -----------
 171
 172 .. This section should contain ABI changes. Sample format:
 173
 174    * sample: Add a short 1-2 sentence description of the ABI change
 175      which was announced in the previous releases and made in this release.
 176      Start with a scope label like "ethdev:".
 177      Use fixed width quotes for ``function_names`` or ``struct_names``.
 178      Use the past tense.
 179
 180    This section is a comment. Do not overwrite or remove it.
 181    Also, make sure to start the actual text at the margin.
 182    =======================================================
 183
 184 * ``ethdev`` changes
 185
 186   * Following device operation function pointers moved
 187     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 188
 189     * ``eth_rx_queue_count_t       rx_queue_count;``
 190     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 191     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 192     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 193
 194   * ``struct eth_dev_ops`` is no more accessible by applications,
 195     which was already internal data structure.
 196
 197   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 198
 199
 200 Known Issues
 201 ------------
 202
 203 .. This section should contain new known issues in this release. Sample format:
 204
 205    * **Add title in present tense with full stop.**
 206
 207      Add a short 1-2 sentence description of the known issue
 208      in the present tense. Add information on any known workarounds.
 209
 210    This section is a comment. Do not overwrite or remove it.
 211    Also, make sure to start the actual text at the margin.
 212    =======================================================
 213
 214
 215 Tested Platforms
 216 ----------------
 217
 218 .. This section should contain a list of platforms that were tested
 219    with this release.
 220
 221    The format is:
 222
 223    * <vendor> platform with <vendor> <type of devices> combinations
 224
 225      * List of CPU
 226      * List of OS
 227      * List of devices
 228      * Other relevant details...
 229
 230    This section is a comment. Do not overwrite or remove it.
 231    Also, make sure to start the actual text at the margin.
 232    =======================================================