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