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