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