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