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