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