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
 114 * **Updated Cisco enic driver.**
 115
 116   * Added rte_flow support for matching GENEVE packets.
 117   * Added rte_flow support for matching eCPRI packets.
 118
 119 * **Updated Intel iavf driver.**
 120
 121   * Added L2TPv2 (include PPP over L2TPv2) RSS support based on outer
 122     MAC src/dst address and L2TPv2 session ID.
 123   * Added L2TPv2 (include PPP over L2TPv2) FDIR support based on outer
 124     MAC src/dst address and L2TPv2 session ID.
 125   * Added PPPoL2TPv2oUDP FDIR distribute packets based on inner IP
 126     src/dst address and UDP/TCP src/dst port.
 127
 128 * **Updated Wangxun ngbe driver.**
 129
 130   * Added support for devices of custom PHY interfaces.
 131     - M88E1512 PHY connects to RJ45
 132     - M88E1512 PHY connects to RGMII combo
 133     - YT8521S PHY connects to SFP
 134   * Added LED OEM support.
 135
 136 * **Updated Wangxun txgbe driver.**
 137
 138   * Added LED OEM support.
 139
 140 * **Added an API for private user data in asymmetric crypto session.**
 141
 142   An API was added to get/set an asymmetric crypto session's user data.
 143
 144 * **Updated Marvell cnxk crypto PMD.**
 145
 146   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
 147   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 148   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 149   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
 150   * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
 151   * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
 152   * Added AES-CMAC support in CN9K & CN10K.
 153   * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN10K.
 154
 155 * **Updated Intel QuickAssist Technology crypto PMD.**
 156
 157   * Added support for CPM2.0b (4942) devices.
 158   * Added ECDSA algorithm support.
 159   * Added ECPM algorithm support.
 160
 161 * **Added an API to retrieve event port id of ethdev Rx adapter.**
 162
 163   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
 164
 165 * **Added support for Kunpeng930 DMA devices to HiSilicon DMA PMD.**
 166
 167   * Kunpeng930 DMA devices are now enabled for HiSilicon DMA PMD.
 168
 169 * **Added CNXK GPIO PMD.**
 170
 171   Added a new rawdevice PMD which allows to manage userspace GPIOs and install
 172   custom GPIO interrupt handlers which bypass kernel. This is especially useful
 173   for applications, that besides providing standard dataplane functionality
 174   want to have fast and low latency access to GPIO pin state.
 175
 176   See the :doc:`../rawdevs/cnxk_gpio` rawdev guide for more details on this
 177   driver.
 178
 179 * **Updated testpmd.**
 180
 181   * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode
 182     to support software UDP/TCP checksum over multiple segments.
 183
 184 * **Added crypto producer mode in test-eventdev.**
 185
 186   * Crypto producer mode helps to measure performance of OP_NEW and OP_FORWARD
 187     modes of event crypto adapter.
 188
 189
 190 Removed Items
 191 -------------
 192
 193 .. This section should contain removed items in this release. Sample format:
 194
 195    * Add a short 1-2 sentence description of the removed item
 196      in the past tense.
 197
 198    This section is a comment. Do not overwrite or remove it.
 199    Also, make sure to start the actual text at the margin.
 200    =======================================================
 201
 202 * **Removed experimental performance thread example application.**
 203
 204
 205 API Changes
 206 -----------
 207
 208 .. This section should contain API changes. Sample format:
 209
 210    * sample: Add a short 1-2 sentence description of the API 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 * net: added experimental functions ``rte_ipv4_udptcp_cksum_mbuf()``,
 221   ``rte_ipv4_udptcp_cksum_mbuf_verify()``, ``rte_ipv6_udptcp_cksum_mbuf()``,
 222   ``rte_ipv6_udptcp_cksum_mbuf_verify()``
 223
 224 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
 225   which are kept for backward compatibility, are marked as deprecated.
 226
 227 * cryptodev: The asymmetric session handling was modified to use a single
 228   mempool object. An API ``rte_cryptodev_asym_session_pool_create`` was added
 229   to create a mempool with element size big enough to hold the generic asymmetric
 230   session header, max size for a device private session data, and user data size.
 231   The session structure was moved to ``cryptodev_pmd.h``,
 232   hiding it from applications.
 233   The API ``rte_cryptodev_asym_session_init`` was removed as the initialization
 234   is now moved to ``rte_cryptodev_asym_session_create``, which was updated to
 235   return an integer value to indicate initialisation errors.
 236
 237
 238 ABI Changes
 239 -----------
 240
 241 .. This section should contain ABI changes. Sample format:
 242
 243    * sample: Add a short 1-2 sentence description of the ABI change
 244      which was announced in the previous releases and made in this release.
 245      Start with a scope label like "ethdev:".
 246      Use fixed width quotes for ``function_names`` or ``struct_names``.
 247      Use the past tense.
 248
 249    This section is a comment. Do not overwrite or remove it.
 250    Also, make sure to start the actual text at the margin.
 251    =======================================================
 252
 253 * No ABI change that would break compatibility with 21.11.
 254
 255
 256 Known Issues
 257 ------------
 258
 259 .. This section should contain new known issues in this release. Sample format:
 260
 261    * **Add title in present tense with full stop.**
 262
 263      Add a short 1-2 sentence description of the known issue
 264      in the present tense. Add information on any known workarounds.
 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    =======================================================
 269
 270
 271 Tested Platforms
 272 ----------------
 273
 274 .. This section should contain a list of platforms that were tested
 275    with this release.
 276
 277    The format is:
 278
 279    * <vendor> platform with <vendor> <type of devices> combinations
 280
 281      * List of CPU
 282      * List of OS
 283      * List of devices
 284      * Other relevant details...
 285
 286    This section is a comment. Do not overwrite or remove it.
 287    Also, make sure to start the actual text at the margin.
 288    =======================================================