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