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