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