doc/guides/rel_notes/release_22_03.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 22.03
   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       ninja -C build doc
  21       xdg-open build/doc/guides/html/rel_notes/release_22_03.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 (ordered alphabetically by vendor name)
  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 * **Added ability to reuse hugepages in Linux.**
  59
  60   It is possible to reuse files in hugetlbfs to speed up hugepage mapping,
  61   which may be useful for fast restart and large allocations.
  62   The new mode is activated with ``--huge-unlink=never``
  63   and has security implications, refer to the user and programmer guides.
  64
  65 * **Added functions to calculate UDP/TCP checksum in mbuf.**
  66
  67   * Added the following functions to calculate UDP/TCP checksum of packets
  68     which can be over multi-segments:
  69     - ``rte_ipv4_udptcp_cksum_mbuf()``
  70     - ``rte_ipv4_udptcp_cksum_mbuf_verify()``
  71     - ``rte_ipv6_udptcp_cksum_mbuf()``
  72     - ``rte_ipv6_udptcp_cksum_mbuf_verify()``
  73
  74 * **Added rte_flow support for matching GRE optional fields.**
  75
  76   Added ``gre_option`` item in rte_flow to support checksum/key/sequence
  77   matching in GRE packets.
  78
  79 * **Added new RSS offload types for L2TPv2 in RSS flow.**
  80
  81   Added macro RTE_ETH_RSS_L2TPV2, now L2TPv2 session ID field can be used as
  82   input set for RSS.
  83
  84 * **Added IP reassembly Ethernet offload API, to get and set config.**
  85
  86   Added IP reassembly offload APIs which provide functions to query IP
  87   reassembly capabilities, to set configuration and to get currently set
  88   reassembly configuration.
  89
  90 * **Added an API to enable queue based priority flow ctrl(PFC).**
  91
  92   New APIs, ``rte_eth_dev_priority_flow_ctrl_queue_info_get()`` and
  93   ``rte_eth_dev_priority_flow_ctrl_queue_configure()``, was added.
  94
  95 * **Added a private dump API, to dump private info from device.**
  96
  97   Added the private dump API which provides querying private info from device.
  98   There exists many private properties in different PMD drivers.
  99   The information of these properties is important for debug.
 100   As the information is private, a dump function is introduced.
 101
 102 * **Updated AF_XDP PMD**
 103
 104   * Added support for libxdp >=v1.2.2.
 105   * Re-enabled secondary process support. RX/TX is not supported.
 106
 107 * **Updated Amazon ENA PMD.**
 108
 109   The new driver version (v2.6.0) introduced bug fixes and improvements, including:
 110
 111   * Added new checksum related xstats: ``l3_csum_bad``, ``l4_csum_bad`` and
 112     ``l4_csum_good``.
 113   * Added support for the link status configuration.
 114   * Added optimized memcpy support for the ARM platforms.
 115   * Added ENA admin queue support for the MP applications.
 116   * Added free Tx mbuf on demand feature support.
 117
 118 * **Updated Cisco enic driver.**
 119
 120   * Added rte_flow support for matching GENEVE packets.
 121   * Added rte_flow support for matching eCPRI packets.
 122
 123 * **Updated Intel iavf driver.**
 124
 125   * Added L2TPv2 (include PPP over L2TPv2) RSS support based on outer
 126     MAC src/dst address and L2TPv2 session ID.
 127   * Added L2TPv2 (include PPP over L2TPv2) FDIR support based on outer
 128     MAC src/dst address and L2TPv2 session ID.
 129   * Added PPPoL2TPv2oUDP FDIR distribute packets based on inner IP
 130     src/dst address and UDP/TCP src/dst port.
 131
 132 * **Updated Wangxun ngbe driver.**
 133
 134   * Added support for devices of custom PHY interfaces.
 135     - M88E1512 PHY connects to RJ45
 136     - M88E1512 PHY connects to RGMII combo
 137     - YT8521S PHY connects to SFP
 138   * Added LED OEM support.
 139
 140 * **Updated Wangxun txgbe driver.**
 141
 142   * Added LED OEM support.
 143
 144 * **Added an API for private user data in asymmetric crypto session.**
 145
 146   An API was added to get/set an asymmetric crypto session's user data.
 147
 148 * **Updated Marvell cnxk crypto PMD.**
 149
 150   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
 151   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 152   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 153   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
 154   * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
 155   * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
 156   * Added AES-CMAC support in CN9K & CN10K.
 157   * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN10K.
 158
 159 * **Updated Intel QuickAssist Technology crypto PMD.**
 160
 161   * Added support for CPM2.0b (4942) devices.
 162   * Added ECDSA algorithm support.
 163   * Added ECPM algorithm support.
 164
 165 * **Added an API to retrieve event port id of ethdev Rx adapter.**
 166
 167   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
 168
 169 * **Added support for Kunpeng930 DMA devices to HiSilicon DMA PMD.**
 170
 171   * Kunpeng930 DMA devices are now enabled for HiSilicon DMA PMD.
 172
 173 * **Added CNXK GPIO PMD.**
 174
 175   Added a new rawdevice PMD which allows to manage userspace GPIOs and install
 176   custom GPIO interrupt handlers which bypass kernel. This is especially useful
 177   for applications, that besides providing standard dataplane functionality
 178   want to have fast and low latency access to GPIO pin state.
 179
 180   See the :doc:`../rawdevs/cnxk_gpio` rawdev guide for more details on this
 181   driver.
 182
 183 * **Updated testpmd.**
 184
 185   * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode
 186     to support software UDP/TCP checksum over multiple segments.
 187
 188 * **Added crypto producer mode in test-eventdev.**
 189
 190   * Crypto producer mode helps to measure performance of OP_NEW and OP_FORWARD
 191     modes of event crypto adapter.
 192
 193
 194 Removed Items
 195 -------------
 196
 197 .. This section should contain removed items in this release. Sample format:
 198
 199    * Add a short 1-2 sentence description of the removed item
 200      in the past tense.
 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 * **Removed experimental performance thread example application.**
 207
 208
 209 API Changes
 210 -----------
 211
 212 .. This section should contain API changes. Sample format:
 213
 214    * sample: Add a short 1-2 sentence description of the API change
 215      which was announced in the previous releases and made in this release.
 216      Start with a scope label like "ethdev:".
 217      Use fixed width quotes for ``function_names`` or ``struct_names``.
 218      Use the past tense.
 219
 220    This section is a comment. Do not overwrite or remove it.
 221    Also, make sure to start the actual text at the margin.
 222    =======================================================
 223
 224 * net: added experimental functions ``rte_ipv4_udptcp_cksum_mbuf()``,
 225   ``rte_ipv4_udptcp_cksum_mbuf_verify()``, ``rte_ipv6_udptcp_cksum_mbuf()``,
 226   ``rte_ipv6_udptcp_cksum_mbuf_verify()``
 227
 228 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
 229   which are kept for backward compatibility, are marked as deprecated.
 230
 231 * cryptodev: The asymmetric session handling was modified to use a single
 232   mempool object. An API ``rte_cryptodev_asym_session_pool_create`` was added
 233   to create a mempool with element size big enough to hold the generic asymmetric
 234   session header, max size for a device private session data, and user data size.
 235   The session structure was moved to ``cryptodev_pmd.h``,
 236   hiding it from applications.
 237   The API ``rte_cryptodev_asym_session_init`` was removed as the initialization
 238   is now moved to ``rte_cryptodev_asym_session_create``, which was updated to
 239   return an integer value to indicate initialisation errors.
 240
 241
 242 ABI Changes
 243 -----------
 244
 245 .. This section should contain ABI changes. Sample format:
 246
 247    * sample: Add a short 1-2 sentence description of the ABI change
 248      which was announced in the previous releases and made in this release.
 249      Start with a scope label like "ethdev:".
 250      Use fixed width quotes for ``function_names`` or ``struct_names``.
 251      Use the past tense.
 252
 253    This section is a comment. Do not overwrite or remove it.
 254    Also, make sure to start the actual text at the margin.
 255    =======================================================
 256
 257 * No ABI change that would break compatibility with 21.11.
 258
 259
 260 Known Issues
 261 ------------
 262
 263 .. This section should contain new known issues in this release. Sample format:
 264
 265    * **Add title in present tense with full stop.**
 266
 267      Add a short 1-2 sentence description of the known issue
 268      in the present tense. Add information on any known workarounds.
 269
 270    This section is a comment. Do not overwrite or remove it.
 271    Also, make sure to start the actual text at the margin.
 272    =======================================================
 273
 274
 275 Tested Platforms
 276 ----------------
 277
 278 .. This section should contain a list of platforms that were tested
 279    with this release.
 280
 281    The format is:
 282
 283    * <vendor> platform with <vendor> <type of devices> combinations
 284
 285      * List of CPU
 286      * List of OS
 287      * List of devices
 288      * Other relevant details...
 289
 290    This section is a comment. Do not overwrite or remove it.
 291    Also, make sure to start the actual text at the margin.
 292    =======================================================