doc/guides/rel_notes/release_21_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.11
   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_21_11.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 * **Enabled new devargs parser.**
  59
  60   * Enabled devargs syntax
  61     ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
  62   * Added bus-level parsing of the devargs syntax.
  63   * Kept compatibility with the legacy syntax as parsing fallback.
  64
  65 * **Updated EAL hugetlbfs mount handling for Linux.**
  66
  67   * Modified to allow ``--huge-dir`` option to specify a sub-directory
  68     within a hugetlbfs mountpoint.
  69
  70 * **Added dmadev library.**
  71
  72   * Added a DMA device framework for management and provision of
  73     hardware and software DMA devices.
  74   * Added generic API which support a number of different DMA
  75     operations.
  76   * Added multi-process support.
  77
  78 * **Added HiSilicon DMA driver.**
  79
  80   The HiSilicon DMA driver provides device drivers for the Kunpeng's DMA devices.
  81   This device driver can be used through the generic dmadev API.
  82
  83 * **Added IDXD dmadev driver implementation.**
  84
  85   The IDXD dmadev driver provide device drivers for the Intel DSA devices.
  86   This device driver can be used through the generic dmadev API.
  87
  88 * **Added IOAT dmadev driver implementation.**
  89
  90   The Intel I/O Acceleration Technology (IOAT) dmadev driver provides a device
  91   driver for Intel IOAT devices such as Crystal Beach DMA (CBDMA) on Ice Lake,
  92   Skylake and Broadwell. This device driver can be used through the generic dmadev API.
  93
  94 * **Added Marvell CNXK DMA driver.**
  95
  96   Added dmadev driver for the DPI DMA hardware accelerator
  97   of Marvell OCTEONTX2 and OCTEONTX3 family of SoCs.
  98
  99 * **Added NXP DPAA DMA driver.**
 100
 101   Added a new dmadev driver for NXP DPAA platform.
 102
 103 * **Added support to get all MAC addresses of a device.**
 104
 105   Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet
 106   addresses assigned to given ethernet port.
 107
 108 * **Introduced GPU device class with first features:**
 109
 110   * Device information
 111   * Memory management
 112   * Communication flag & list
 113
 114 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
 115
 116   Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
 117   TCP/UDP/SCTP header checksum field can be used as input set for RSS.
 118
 119 * **Added L2TPv2 and PPP protocol support in flow API.**
 120
 121   Added flow pattern items and header formats of L2TPv2 and PPP protocol.
 122
 123 * **Added flow flex item.**
 124
 125   The configurable flow flex item provides the capability to introduce
 126   an arbitrary user-specified network protocol header,
 127   configure the hardware accordingly, and perform match on this header
 128   with desired patterns and masks.
 129
 130 * **Added ethdev support to control delivery of Rx metadata from the HW to the PMD.**
 131
 132   A new API, ``rte_eth_rx_metadata_negotiate()``, was added.
 133   The following parts of Rx metadata were defined:
 134
 135   * ``RTE_ETH_RX_METADATA_USER_FLAG``
 136   * ``RTE_ETH_RX_METADATA_USER_MARK``
 137   * ``RTE_ETH_RX_METADATA_TUNNEL_ID``
 138
 139 * **Added an API to get a proxy port to manage "transfer" flows.**
 140
 141   A new API, ``rte_flow_pick_transfer_proxy()``, was added.
 142
 143 * **Added ethdev shared Rx queue support.**
 144
 145   * Added new device capability flag and Rx domain field to switch info.
 146   * Added share group and share queue ID to Rx queue configuration.
 147   * Added testpmd support and dedicate forwarding engine.
 148
 149 * **Updated af_packet ethdev driver.**
 150
 151   * Default VLAN strip behavior was changed. VLAN tag won't be stripped
 152     unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
 153
 154 * **Added API to get device configuration in ethdev.**
 155
 156   Added an ethdev API which can help users get device configuration.
 157
 158 * **Updated AF_XDP PMD.**
 159
 160   * Disabled secondary process support.
 161
 162 * **Updated Amazon ENA PMD.**
 163
 164   Updated the Amazon ENA PMD. The new driver version (v2.5.0) introduced
 165   bug fixes and improvements, including:
 166
 167   * Support for the tx_free_thresh and rx_free_thresh configuration parameters.
 168   * NUMA aware allocations for the queue helper structures.
 169   * Watchdog's feature which is checking for missing Tx completions.
 170
 171 * **Updated Broadcom bnxt PMD.**
 172
 173   * Added flow offload support for Thor.
 174   * Added TruFlow and AFM SRAM partitioning support.
 175   * Implement support for tunnel offload.
 176   * Updated HWRM API to version 1.10.2.68.
 177   * Added NAT support for dest IP and port combination.
 178   * Added support for socket redirection.
 179   * Added wildcard match support for ingress flows.
 180   * Added support for inner IP header for GRE tunnel flows.
 181   * Removed devargs option for stats accumulation.
 182
 183 * **Updated Cisco enic driver.**
 184
 185   * Added rte_flow support for matching GTP, GTP-C and GTP-U headers.
 186
 187 * **Updated Intel e1000 emulated driver.**
 188
 189   * Added Intel e1000 support on Windows.
 190
 191 * **Updated Intel iavf driver.**
 192
 193   * Added Intel iavf support on Windows.
 194   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
 195   * Added PPPoL2TPv2oUDP RSS hash based on inner IP address and TCP/UDP port.
 196   * Added Intel iavf inline crypto support.
 197
 198 * **Updated Intel ice driver.**
 199
 200   * Added protocol agnostic flow offloading support in Flow Director.
 201   * Added protocol agnostic flow offloading support in RSS hash.
 202   * Added 1PPS out support by a devargs.
 203   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
 204   * Added DEV_RX_OFFLOAD_TIMESTAMP support.
 205   * Added timesync API support under scalar path.
 206
 207 * **Updated Intel ixgbe driver.**
 208
 209   * Added Intel ixgbe support on Windows.
 210
 211 * **Updated Marvell cnxk ethdev driver.**
 212
 213   * Added rte_flow support for dual VLAN insert and strip actions.
 214   * Added rte_tm support.
 215   * Added support for Inline IPsec for CN9K event mode and CN10K
 216     poll mode and event mode.
 217   * Added support for ingress meter for CN10K platform.
 218
 219 * **Updated Mellanox mlx5 driver.**
 220
 221   Updated the Mellanox mlx5 driver with new features and improvements, including:
 222
 223   * Added implicit mempool registration to avoid data path hiccups (opt-out).
 224   * Added delay drop support for Rx queue.
 225   * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).
 226   * Added socket direct mode bonding support.
 227
 228 * **Updated Solarflare network PMD.**
 229
 230   Updated the Solarflare ``sfc_efx`` driver with changes including:
 231
 232   * Added port representors support on SN1000 SmartNICs
 233   * Added flow API transfer proxy support
 234   * Added SN1000 virtual functions (VF) support
 235   * Added support for flow counters without service cores
 236
 237 * **Added power monitor API in vhost library.**
 238
 239   Added an API to support power monitor in vhost library.
 240
 241 * **Updated vhost PMD.**
 242
 243   Add power monitor support in vhost PMD.
 244
 245 * **Updated virtio PMD.**
 246
 247   * Initial support for RSS receive mode has been added to the Virtio PMD,
 248     with the capability for the application to configure the hash key,
 249     the RETA and the hash types.
 250     Virtio hash reporting is yet to be added.
 251   * Added power monitor support in virtio PMD.
 252
 253 * **Updated Wangxun ngbe driver.**
 254
 255   * Added offloads and packet type on RxTx.
 256   * Added VLAN and MAC filters.
 257   * Added device basic statistics and extended stats.
 258   * Added multi-queue and RSS.
 259   * Added SRIOV.
 260   * Added flow control.
 261   * Added IEEE 1588.
 262
 263 * **Added new vDPA PMD based on Xilinx devices.**
 264
 265   Added a new Xilinx vDPA  (``sfc_vdpa``) PMD.
 266   See the :doc:`../vdpadevs/sfc` guide for more details on this driver.
 267
 268 * **Added telemetry callbacks to cryptodev library.**
 269
 270   Added telemetry callback functions which allow a list of crypto devices,
 271   stats for a crypto device, and other device information to be queried.
 272   Also added callback to get cryptodev capabilities.
 273
 274 * **Added telemetry to security library.**
 275
 276   Added telemetry callback functions to query security capabilities of
 277   crypto device.
 278
 279 * **Updated Marvell cnxk crypto PMD.**
 280
 281   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
 282   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
 283   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
 284   * Added support for lookaside protocol (IPsec) offload for CN9K.
 285   * Added support for ZUC algorithm with 256-bit key length for CN10K.
 286   * Added support for CN98xx dual block.
 287   * Added inner checksum support in lookaside protocol (IPsec) for CN10K.
 288   * Added AES-CBC NULL auth support in lookaside protocol (IPsec) for CN10K.
 289   * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN9K.
 290
 291 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
 292
 293   * Added event crypto adapter OP_FORWARD mode support.
 294
 295 * **Updated Mellanox mlx5 crypto driver.**
 296
 297   * Added Windows support.
 298
 299 * **Updated NXP dpaa_sec crypto PMD.**
 300
 301   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
 302   * Added PDCP short MAC-I support.
 303   * Added raw vector datapath API support.
 304
 305 * **Updated NXP dpaa2_sec crypto PMD.**
 306
 307   * Added PDCP short MAC-I support.
 308   * Added raw vector datapath API support.
 309
 310 * **Added framework for consolidation of IPsec_MB dependent SW Crypto PMDs.**
 311
 312   * The IPsec_MB framework was added to share common code between Intel
 313     SW Crypto PMDs that depend on the intel-ipsec-mb library.
 314   * Multiprocess support was added for the consolidated PMDs,
 315     which requires v1.1 of the intel-ipsec-mb library.
 316   * The following PMDs were moved into a single source folder,
 317     however their usage and EAL options remain unchanged.
 318     * AESNI_MB PMD.
 319     * AESNI_GCM PMD.
 320     * KASUMI PMD.
 321     * SNOW3G PMD.
 322     * ZUC PMD.
 323     * CHACHA20_POLY1305 - A new PMD added.
 324
 325 * **Updated the aesni_mb crypto PMD.**
 326
 327   * Added support for ZUC-EEA3-256 and ZUC-EIA3-256.
 328
 329 * **Added digest appended ops support for Snow3G PMD.**
 330
 331   * Added support for out-of-place auth-cipher operations that encrypt
 332     the digest along with the rest of the raw data.
 333   * Added support for partially encrypted digest when using auth-cipher
 334     operations.
 335
 336 * **Updated the ACC100 bbdev PMD.**
 337
 338   Added support for more comprehensive CRC options.
 339
 340 * **Updated the turbo_sw bbdev PMD.**
 341
 342   Added support for more comprehensive CRC options.
 343
 344 * **Added NXP LA12xx baseband PMD.**
 345
 346   * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
 347   * See the :doc:`../bbdevs/la12xx` for more details.
 348
 349 * **Updated Mellanox compress driver.**
 350
 351   * Added devargs option to allow manual setting of Huffman block size.
 352
 353 * **Updated Mellanox regex driver.**
 354
 355   * Added support for new ROF file format.
 356
 357 * **Updated IPsec library.**
 358
 359   * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
 360     and AES_GMAC.
 361   * Added support for NAT-T / UDP encapsulated ESP.
 362   * Added support for SA telemetry.
 363   * Added support for setting a non default starting ESN value.
 364   * Added support for TSO in inline crypto mode.
 365
 366 * **Added optimized Toeplitz hash implementation.**
 367
 368   Added optimized Toeplitz hash implementation using Galois Fields New Instructions.
 369
 370 * **Added multi-process support for testpmd.**
 371
 372   Added command-line options to specify total number of processes and
 373   current process ID. Each process owns subset of Rx and Tx queues.
 374
 375 * **Updated test-crypto-perf application with new cases.**
 376
 377   * Added support for asymmetric crypto throughput performance measurement.
 378     Only modex is supported for now.
 379   * Added support for lookaside IPsec protocol offload throughput measurement.
 380
 381 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
 382
 383   * Added known vector tests (AES-GCM 128, 192, 256).
 384   * Added tests to verify error reporting with ICV corruption.
 385   * Added tests to verify IV generation.
 386   * Added tests to verify UDP encapsulation.
 387   * Added tests to verify UDP encapsulation ports.
 388   * Added tests to validate packets soft expiry.
 389   * Added tests to validate packets hard expiry.
 390   * Added tests to verify tunnel header verification in IPsec inbound.
 391   * Added tests to verify inner checksum.
 392   * Added tests for CHACHA20_POLY1305 PMD, including a new testcase for SGL OOP.
 393
 394 * **Updated IPsec Security Gateway sample application with new features.**
 395
 396   * Added support for TSO (only for inline crypto TCP packets).
 397   * Added support for telemetry.
 398   * Added support for more AEAD algorithms: AES-GMAC, AES_CTR, AES_XCBC_MAC,
 399     AES_CCM, CHACHA20_POLY1305
 400   * Added support for event vectors for inline protocol offload mode.
 401
 402 * **Revised packet capture framework.**
 403
 404   * New dpdk-dumpcap program that has most of the features
 405     of the wireshark dumpcap utility including:
 406     capture of multiple interfaces, filtering,
 407     and stopping after number of bytes, packets.
 408   * New library for writing pcapng packet capture files.
 409   * Enhancements to the pdump library to support:
 410     * Packet filter with BPF.
 411     * Pcapng format with timestamps and meta-data.
 412     * Fixes packet capture with stripped VLAN tags.
 413
 414 * **Added ASan support.**
 415
 416   `AddressSanitizer
 417   <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (ASan)
 418   is a widely-used debugging tool to detect memory access errors.
 419   It helps to detect issues like use-after-free, various kinds of buffer
 420   overruns in C/C++ programs, and other similar errors, as well as
 421   printing out detailed debug information whenever an error is detected.
 422
 423
 424 Removed Items
 425 -------------
 426
 427 .. This section should contain removed items in this release. Sample format:
 428
 429    * Add a short 1-2 sentence description of the removed item
 430      in the past tense.
 431
 432    This section is a comment. Do not overwrite or remove it.
 433    Also, make sure to start the actual text at the margin.
 434    =======================================================
 435
 436 * eal: Removed the deprecated function ``rte_get_master_lcore()``
 437   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
 438
 439 * eal: The old api arguments that were deprecated for
 440   blacklist/whitelist are removed. Users must use the new
 441   block/allow list arguments.
 442
 443 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
 444   ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
 445
 446 * ethdev: Removed the port mirroring API. A more fine-grain flow API
 447   action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
 448   The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
 449   the functions ``rte_eth_mirror_rule_set`` and
 450   ``rte_eth_mirror_rule_reset`` along with the associated macros
 451   ``ETH_MIRROR_*`` are removed.
 452
 453 * ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its
 454   driver callback. It is replaced by the more complete function
 455   ``rte_eth_rx_descriptor_status``.
 456
 457 * ethdev: Removed deprecated ``shared`` attribute of the
 458   ``struct rte_flow_action_count``. Shared counters should be managed
 459   using indirect actions API (``rte_flow_action_handle_create`` etc).
 460
 461 * i40e: Removed i40evf driver.
 462   iavf already became the default VF driver for i40e devices,
 463   so there is no need to maintain i40evf.
 464
 465
 466 API Changes
 467 -----------
 468
 469 .. This section should contain API changes. Sample format:
 470
 471    * sample: Add a short 1-2 sentence description of the API change
 472      which was announced in the previous releases and made in this release.
 473      Start with a scope label like "ethdev:".
 474      Use fixed width quotes for ``function_names`` or ``struct_names``.
 475      Use the past tense.
 476
 477    This section is a comment. Do not overwrite or remove it.
 478    Also, make sure to start the actual text at the margin.
 479    =======================================================
 480
 481 * eal: The lcore state ``FINISHED`` is removed from
 482   the ``enum rte_lcore_state_t``.
 483   The lcore state ``WAIT`` is enough to represent the same state.
 484
 485 * eal: Made ``rte_intr_handle`` structure definition hidden.
 486
 487 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
 488   removed. Its usages have been replaced by a new function
 489   ``rte_kvargs_get_with_value()``.
 490
 491 * cmdline: ``cmdline_stdin_exit()`` now frees the ``cmdline`` structure.
 492   Calls to ``cmdline_free()`` after it need to be deleted from applications.
 493
 494 * cmdline: Made ``cmdline`` structure definition hidden on Linux and FreeBSD.
 495
 496 * cmdline: Made ``rdline`` structure definition hidden. Functions are added
 497   to dynamically allocate and free it, and to access user data in callbacks.
 498
 499 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
 500   that objects from this pool will not be used for device IO (e.g. DMA).
 501
 502 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
 503   Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
 504
 505 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
 506   The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
 507
 508 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
 509   deprecated.  Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
 510
 511 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
 512   will be removed in DPDK 22.11.
 513
 514 * mbuf: The mbuf offload flags ``PKT_*`` are renamed as ``RTE_MBUF_F_*``. A
 515   compatibility layer will be kept until DPDK 22.11.
 516 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
 517   to ``src_addr`` and ``dst_addr``, respectively.
 518
 519 * net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
 520   Existing ``version_ihl`` field is kept for backward compatibility.
 521
 522 * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
 523   flow API.
 524
 525 * ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
 526   Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
 527
 528 * ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
 529   with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
 530
 531 * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
 532   array is extended, data pointer field is explicitly added to union, the
 533   action behavior is defined in more strict fashion and documentation updated.
 534   The immediate value behavior has been changed, the entire immediate field
 535   should be provided, and offset for immediate source bitfield is assigned
 536   from destination one.
 537
 538 * vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,
 539   ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA
 540   driver interface are marked as internal.
 541
 542 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 543   rte_cryptodev_is_valid_dev as it can be used by the application as
 544   well as PMD to check whether the device is valid or not.
 545
 546 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 547   as it is for drivers only and should be private to DPDK, and not
 548   installed for app use.
 549
 550 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
 551   renamed to ``aux_flags`` to indicate warnings and other information from
 552   the crypto/security operation. This field will be used to communicate
 553   events such as soft expiry with IPsec in lookaside mode.
 554
 555 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
 556   moved to the end of the structure and extended to ``uint32_t``.
 557
 558 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
 559   field to support total buffer length to facilitate protocol offload case.
 560
 561 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
 562   ``dest_sgl`` to support out of place processing.
 563
 564 * bbdev: Added device info related to data byte endianness processing.
 565
 566 * eventdev: Moved memory used by timer adapters to hugepage. This will prevent
 567   TLB misses if any and aligns to memory structure of other subsystems.
 568
 569 * fib: Added the ``rib_ext_sz`` field to ``rte_fib_conf`` and ``rte_fib6_conf``
 570   so that user can specify the size of the RIB extension inside the FIB.
 571
 572
 573 ABI Changes
 574 -----------
 575
 576 .. This section should contain ABI changes. Sample format:
 577
 578    * sample: Add a short 1-2 sentence description of the ABI change
 579      which was announced in the previous releases and made in this release.
 580      Start with a scope label like "ethdev:".
 581      Use fixed width quotes for ``function_names`` or ``struct_names``.
 582      Use the past tense.
 583
 584    This section is a comment. Do not overwrite or remove it.
 585    Also, make sure to start the actual text at the margin.
 586    =======================================================
 587
 588 * ethdev: All enums & macros updated to have ``RTE_ETH`` prefix and structures
 589   updated to have ``rte_eth`` prefix. DPDK components updated to use new names.
 590
 591 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
 592   Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
 593   to internal queue data as input parameter. While this change is transparent
 594   to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``
 595   is used by  public inline function ``rte_eth_rx_queue_count``.
 596
 597 * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``
 598   private data structures. ``rte_eth_devices[]`` can't be accessed directly
 599   by user any more. While it is an ABI breakage, this change is intended
 600   to be transparent for both users (no changes in user app is required) and
 601   PMD developers (no changes in PMD is required).
 602
 603 * vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``.
 604
 605 * cryptodev: Made ``rte_cryptodev``, ``rte_cryptodev_data`` private
 606   structures internal to DPDK. ``rte_cryptodevs`` can't be accessed directly
 607   by user any more. While it is an ABI breakage, this change is intended
 608   to be transparent for both users (no changes in user app is required) and
 609   PMD developers (no changes in PMD is required).
 610
 611 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
 612   routines used by inline outbound and inline inbound security processing were
 613   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 614   have much processing in PMD specific callbacks but just 64-bit set/get.
 615   This avoids a per packet function pointer jump overhead for such PMDs.
 616
 617 * security: A new option ``iv_gen_disable`` was added in structure
 618   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
 619   so that application can provide its own IV and test known test vectors.
 620
 621 * security: A new option ``tunnel_hdr_verify`` was added in structure
 622   ``rte_security_ipsec_sa_options`` to indicate whether outer header
 623   verification need to be done as part of inbound IPsec processing.
 624
 625 * security: A new option ``udp_ports_verify`` was added in structure
 626   ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
 627   verification need to be done as part of inbound IPsec processing.
 628
 629 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
 630   replace ``esn_soft_limit`` in IPsec configuration structure
 631   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
 632   and hard expiry limits. Limits can be either in number of packets or bytes.
 633
 634 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
 635   in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
 636   packet IPv4 header checksum and L4 checksum need to be offloaded to
 637   security device.
 638
 639 * security: A new structure ``esn`` was added in structure
 640   ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
 641   application to start from an arbitrary ESN value for debug and SA lifetime
 642   enforcement purposes.
 643
 644 * security: A new structure ``udp`` was added in structure
 645   ``rte_security_ipsec_xform`` to allow setting the source and destination ports
 646   for UDP encapsulated IPsec traffic.
 647
 648 * bbdev: Added capability related to more comprehensive CRC options,
 649   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
 650
 651 * eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
 652   were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
 653   status.
 654
 655 * eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
 656   by the fastpath inline functions. The structures ``rte_eventdev``,
 657   ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
 658   accessed directly by user any more. This change is transparent to both
 659   applications and PMDs.
 660
 661 * eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
 662
 663 * ip_frag: Increased default value for config parameter
 664   ``RTE_LIBRTE_IP_FRAG_MAX_FRAG`` from ``4`` to ``8``.
 665   This parameter controls maximum number of fragments per packet
 666   in IP reassembly table. Increasing this value from ``4`` to ``8``
 667   will allow to cover common case with jumbo packet size of ``9KB``
 668   and fragments with default frame size ``(1500B)``.
 669
 670
 671 Known Issues
 672 ------------
 673
 674 .. This section should contain new known issues in this release. Sample format:
 675
 676    * **Add title in present tense with full stop.**
 677
 678      Add a short 1-2 sentence description of the known issue
 679      in the present tense. Add information on any known workarounds.
 680
 681    This section is a comment. Do not overwrite or remove it.
 682    Also, make sure to start the actual text at the margin.
 683    =======================================================
 684
 685
 686 Tested Platforms
 687 ----------------
 688
 689 .. This section should contain a list of platforms that were tested
 690    with this release.
 691
 692    The format is:
 693
 694    * <vendor> platform with <vendor> <type of devices> combinations
 695
 696      * List of CPU
 697      * List of OS
 698      * List of devices
 699      * Other relevant details...
 700
 701    This section is a comment. Do not overwrite or remove it.
 702    Also, make sure to start the actual text at the margin.
 703    =======================================================