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