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