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