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