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