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 new RSS offload types for L2TPv2 in RSS flow.**
  75
  76   Added macro RTE_ETH_RSS_L2TPV2, now L2TPv2 session ID field can be used as
  77   input set for RSS.
  78
  79 * **Added IP reassembly Ethernet offload API, to get and set config.**
  80
  81   Added IP reassembly offload APIs which provide functions to query IP
  82   reassembly capabilities, to set configuration and to get currently set
  83   reassembly configuration.
  84
  85 * **Added an API to enable queue based priority flow ctrl(PFC).**
  86
  87   New APIs, ``rte_eth_dev_priority_flow_ctrl_queue_info_get()`` and
  88   ``rte_eth_dev_priority_flow_ctrl_queue_configure()``, was added.
  89
  90 * **Added a private dump API, to dump private info from device.**
  91
  92   Added the private dump API which provides querying private info from device.
  93   There exists many private properties in different PMD drivers.
  94   The information of these properties is important for debug.
  95   As the information is private, a dump function is introduced.
  96
  97 * **Updated AF_XDP PMD**
  98
  99   * Added support for libxdp >=v1.2.2.
 100
 101 * **Updated Cisco enic driver.**
 102
 103   * Added rte_flow support for matching GENEVE packets.
 104   * Added rte_flow support for matching eCPRI packets.
 105
 106 * **Updated Wangxun ngbe driver.**
 107
 108   * Added support for devices of custom PHY interfaces.
 109     - M88E1512 PHY connects to RJ45
 110     - M88E1512 PHY connects to RGMII combo
 111     - YT8521S PHY connects to SFP
 112   * Added LED OEM support.
 113
 114 * **Updated Marvell cnxk crypto PMD.**
 115
 116   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
 117   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 118   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 119   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
 120   * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
 121   * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
 122   * Added AES-CMAC support in CN9K & CN10K.
 123
 124 * **Added an API to retrieve event port id of ethdev Rx adapter.**
 125
 126   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
 127
 128 * **Updated testpmd.**
 129
 130   * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode
 131     to support software UDP/TCP checksum over multiple segments.
 132
 133
 134 Removed Items
 135 -------------
 136
 137 .. This section should contain removed items in this release. Sample format:
 138
 139    * Add a short 1-2 sentence description of the removed item
 140      in the past tense.
 141
 142    This section is a comment. Do not overwrite or remove it.
 143    Also, make sure to start the actual text at the margin.
 144    =======================================================
 145
 146 * **Removed experimental performance thread example application.**
 147
 148
 149 API Changes
 150 -----------
 151
 152 .. This section should contain API changes. Sample format:
 153
 154    * sample: Add a short 1-2 sentence description of the API change
 155      which was announced in the previous releases and made in this release.
 156      Start with a scope label like "ethdev:".
 157      Use fixed width quotes for ``function_names`` or ``struct_names``.
 158      Use the past tense.
 159
 160    This section is a comment. Do not overwrite or remove it.
 161    Also, make sure to start the actual text at the margin.
 162    =======================================================
 163
 164 * net: added experimental functions ``rte_ipv4_udptcp_cksum_mbuf()``,
 165   ``rte_ipv4_udptcp_cksum_mbuf_verify()``, ``rte_ipv6_udptcp_cksum_mbuf()``,
 166   ``rte_ipv6_udptcp_cksum_mbuf_verify()``
 167
 168 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
 169   which are kept for backward compatibility, are marked as deprecated.
 170
 171
 172 ABI Changes
 173 -----------
 174
 175 .. This section should contain ABI changes. Sample format:
 176
 177    * sample: Add a short 1-2 sentence description of the ABI change
 178      which was announced in the previous releases and made in this release.
 179      Start with a scope label like "ethdev:".
 180      Use fixed width quotes for ``function_names`` or ``struct_names``.
 181      Use the past tense.
 182
 183    This section is a comment. Do not overwrite or remove it.
 184    Also, make sure to start the actual text at the margin.
 185    =======================================================
 186
 187 * No ABI change that would break compatibility with 21.11.
 188
 189
 190 Known Issues
 191 ------------
 192
 193 .. This section should contain new known issues in this release. Sample format:
 194
 195    * **Add title in present tense with full stop.**
 196
 197      Add a short 1-2 sentence description of the known issue
 198      in the present tense. Add information on any known workarounds.
 199
 200    This section is a comment. Do not overwrite or remove it.
 201    Also, make sure to start the actual text at the margin.
 202    =======================================================
 203
 204
 205 Tested Platforms
 206 ----------------
 207
 208 .. This section should contain a list of platforms that were tested
 209    with this release.
 210
 211    The format is:
 212
 213    * <vendor> platform with <vendor> <type of devices> combinations
 214
 215      * List of CPU
 216      * List of OS
 217      * List of devices
 218      * Other relevant details...
 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    =======================================================