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