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
 113 * **Updated Marvell cnxk crypto PMD.**
 114
 115   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
 116   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 117   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 118   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
 119   * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
 120   * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
 121   * Added AES-CMAC support in CN9K & CN10K.
 122
 123 * **Added an API to retrieve event port id of ethdev Rx adapter.**
 124
 125   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
 126
 127 * **Updated testpmd.**
 128
 129   * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode
 130     to support software UDP/TCP checksum over multiple segments.
 131
 132
 133 Removed Items
 134 -------------
 135
 136 .. This section should contain removed items in this release. Sample format:
 137
 138    * Add a short 1-2 sentence description of the removed item
 139      in the past tense.
 140
 141    This section is a comment. Do not overwrite or remove it.
 142    Also, make sure to start the actual text at the margin.
 143    =======================================================
 144
 145 * **Removed experimental performance thread example application.**
 146
 147
 148 API Changes
 149 -----------
 150
 151 .. This section should contain API changes. Sample format:
 152
 153    * sample: Add a short 1-2 sentence description of the API change
 154      which was announced in the previous releases and made in this release.
 155      Start with a scope label like "ethdev:".
 156      Use fixed width quotes for ``function_names`` or ``struct_names``.
 157      Use the past tense.
 158
 159    This section is a comment. Do not overwrite or remove it.
 160    Also, make sure to start the actual text at the margin.
 161    =======================================================
 162
 163 * net: added experimental functions ``rte_ipv4_udptcp_cksum_mbuf()``,
 164   ``rte_ipv4_udptcp_cksum_mbuf_verify()``, ``rte_ipv6_udptcp_cksum_mbuf()``,
 165   ``rte_ipv6_udptcp_cksum_mbuf_verify()``
 166
 167 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
 168   which are kept for backward compatibility, are marked as deprecated.
 169
 170
 171 ABI Changes
 172 -----------
 173
 174 .. This section should contain ABI changes. Sample format:
 175
 176    * sample: Add a short 1-2 sentence description of the ABI change
 177      which was announced in the previous releases and made in this release.
 178      Start with a scope label like "ethdev:".
 179      Use fixed width quotes for ``function_names`` or ``struct_names``.
 180      Use the past tense.
 181
 182    This section is a comment. Do not overwrite or remove it.
 183    Also, make sure to start the actual text at the margin.
 184    =======================================================
 185
 186 * No ABI change that would break compatibility with 21.11.
 187
 188
 189 Known Issues
 190 ------------
 191
 192 .. This section should contain new known issues in this release. Sample format:
 193
 194    * **Add title in present tense with full stop.**
 195
 196      Add a short 1-2 sentence description of the known issue
 197      in the present tense. Add information on any known workarounds.
 198
 199    This section is a comment. Do not overwrite or remove it.
 200    Also, make sure to start the actual text at the margin.
 201    =======================================================
 202
 203
 204 Tested Platforms
 205 ----------------
 206
 207 .. This section should contain a list of platforms that were tested
 208    with this release.
 209
 210    The format is:
 211
 212    * <vendor> platform with <vendor> <type of devices> combinations
 213
 214      * List of CPU
 215      * List of OS
 216      * List of devices
 217      * Other relevant details...
 218
 219    This section is a comment. Do not overwrite or remove it.
 220    Also, make sure to start the actual text at the margin.
 221    =======================================================