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