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