git.droids-corp.org / dpdk.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
doc: update release notes for DCF reset in ice PMD
[dpdk.git] / doc / guides / rel_notes / release_20_02.rst
diff --git a/doc/guides/rel_notes/release_20_02.rst b/doc/guides/rel_notes/release_20_02.rst
index d8abc98..925985b 100644 (file)
--- a/doc/guides/rel_notes/release_20_02.rst
+++ b/doc/guides/rel_notes/release_20_02.rst
@@ -6,56 +6,9 @@
 DPDK Release 20.02
 ==================
 
 DPDK Release 20.02
 ==================
 
-.. **Read this first.**
-
-   The text in the sections below explains how to update the release notes.
-
-   Use proper spelling, capitalization and punctuation in all sections.
-
-   Variable and config names should be quoted as fixed width text:
-   ``LIKE_THIS``.
-
-   Build the docs and view the output file to ensure the changes are correct::
-
-      make doc-guides-html
-
-      xdg-open build/doc/html/guides/rel_notes/release_20_02.html
-
-
 New Features
 ------------
 
 New Features
 ------------
 
-.. This section should contain new features added in this release.
-   Sample format:
-
-   * **Add a title in the past tense with a full stop.**
-
-     Add a short 1-2 sentence description in the past tense.
-     The description should be enough to allow someone scanning
-     the release notes to understand the new feature.
-
-     If the feature adds a lot of sub-features you can use a bullet list
-     like this:
-
-     * Added feature foo to do something.
-     * Enhanced feature bar to do something else.
-
-     Refer to the previous release notes for examples.
-
-     Suggested order in release notes items:
-     * Core libs (EAL, mempool, ring, mbuf, buses)
-     * Device abstraction libs and PMDs
-       - ethdev (lib, PMDs)
-       - cryptodev (lib, PMDs)
-       - eventdev (lib, PMDs)
-       - etc
-     * Other libs
-     * Apps, Examples, Tools (if significant)
-
-     This section is a comment. Do not overwrite or remove it.
-     Also, make sure to start the actual text at the margin.
-     =========================================================
-
 * **Added Wait Until Equal API.**
 
   A new API has been added to wait for a memory location to be updated with a
 * **Added Wait Until Equal API.**
 
   A new API has been added to wait for a memory location to be updated with a
@@ -65,16 +18,25 @@ New Features
 
   New APIs have been added to support rings with custom element size.
 
 
   New APIs have been added to support rings with custom element size.
 
+* **Added mbuf pool with pinned external memory.**
+
+  Added support of mbuf with data buffer allocated in an external device memory.
+
 * **Updated rte_flow api to support L2TPv3 over IP flows.**
 
   Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
 
 * **Updated rte_flow api to support L2TPv3 over IP flows.**
 
   Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
 
+* **Added DSCP rewrite action.**
+
+  New actions ``RTE_FLOW_ACTION_TYPE_SET_IPV[4/6]_DSCP`` have been added
+  to support rewrite the DSCP field in the IP header.
+
 * **Added IONIC net PMD.**
 
   Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
   See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
 
 * **Added IONIC net PMD.**
 
   Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
   See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
 
-* **Updated Broadcom bnxt driver**
+* **Updated Broadcom bnxt driver.**
 
   Updated Broadcom bnxt driver with new features and improvements, including:
 
 
   Updated Broadcom bnxt driver with new features and improvements, including:
 
@@ -91,10 +53,10 @@ New Features
 
   Updated the Intel ice driver with new features and improvements, including:
 
 
   Updated the Intel ice driver with new features and improvements, including:
 
-  * Added support for MAC rules on specific port.
+  * Added support for MAC rules on a specific port.
   * Added support for MAC/VLAN with TCP/UDP in switch rule.
   * Added support for 1/10G device.
   * Added support for MAC/VLAN with TCP/UDP in switch rule.
   * Added support for 1/10G device.
-  * Added support for API rte_eth_tx_done_cleanup.
+  * Added support for API ``rte_eth_tx_done_cleanup``.
 
 * **Updated Intel iavf driver.**
 
 
 * **Updated Intel iavf driver.**
 
@@ -105,7 +67,9 @@ New Features
 
 * **Updated the Intel ixgbe driver.**
 
 
 * **Updated the Intel ixgbe driver.**
 
-  * Added support for API rte_eth_tx_done_cleanup.
+  Updated ixgbe PMD with new features and improvements, including:
+
+  * Added support for API ``rte_eth_tx_done_cleanup()``.
   * Added support setting VF MAC address by PF driver.
   * Added support for setting the link to specific speed.
 
   * Added support setting VF MAC address by PF driver.
   * Added support for setting the link to specific speed.
 
@@ -122,7 +86,7 @@ New Features
   * Extended PHY access AQ cmd.
   * Added support for reading LPI counters.
   * Added support for Energy Efficient Ethernet.
   * Extended PHY access AQ cmd.
   * Added support for reading LPI counters.
   * Added support for Energy Efficient Ethernet.
-  * Added support for API rte_eth_tx_done_cleanup.
+  * Added support for API ``rte_eth_tx_done_cleanup()``.
   * Added support for VF multiple queues interrupt.
   * Added support for setting the link to specific speed.
 
   * Added support for VF multiple queues interrupt.
   * Added support for setting the link to specific speed.
 
@@ -130,11 +94,14 @@ New Features
 
   Updated Mellanox mlx5 driver with new features and improvements, including:
 
 
   Updated Mellanox mlx5 driver with new features and improvements, including:
 
+  * Added support for the mbufs with external pinned buffers.
   * Added support for RSS using L3/L4 source/destination only.
   * Added support for matching on GTP tunnel header item.
   * Removed limitation of matching on tagged/untagged packets (when using DV flow engine).
   * Added support for RSS using L3/L4 source/destination only.
   * Added support for matching on GTP tunnel header item.
   * Removed limitation of matching on tagged/untagged packets (when using DV flow engine).
+  * Added support for IPv4/IPv6 DSCP rewrite action.
+  * Added BlueField-2 integrated ConnectX-6 Dx device support.
 
 
-* **Add new vDPA PMD based on Mellanox devices**
+* **Add new vDPA PMD based on Mellanox devices.**
 
   Added a new Mellanox vDPA  (``mlx5_vdpa``) PMD.
   See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
 
   Added a new Mellanox vDPA  (``mlx5_vdpa``) PMD.
   See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
@@ -154,6 +121,8 @@ New Features
 
 * **Added algorithms to cryptodev API.**
 
 
 * **Added algorithms to cryptodev API.**
 
+  Added new algorithms to the cryptodev API:
+
   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
     asymmetric crypto library specifications.
   * ECPM (Elliptic Curve Point Multiplication) is added to
   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
     asymmetric crypto library specifications.
   * ECPM (Elliptic Curve Point Multiplication) is added to
@@ -161,8 +130,8 @@ New Features
 
 * **Added synchronous Crypto burst API.**
 
 
 * **Added synchronous Crypto burst API.**
 
-  A new API is introduced in crypto library to handle synchronous cryptographic
-  operations allowing to achieve performance gain for cryptodevs which use
+  A new API has been introduced in the crypto library to handle synchronous cryptographic
+  operations allowing it to achieve performance gains for cryptodevs which use
   CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
   cryptodev is provided. The IPsec example application and ipsec library itself
   were changed to allow utilization of this new feature.
   CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
   cryptodev is provided. The IPsec example application and ipsec library itself
   were changed to allow utilization of this new feature.
@@ -173,7 +142,7 @@ New Features
   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
   Such algorithm combinations are not supported on GEN1/GEN2 hardware
   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
   Such algorithm combinations are not supported on GEN1/GEN2 hardware
-  and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
+  and executing the request returns ``RTE_CRYPTO_OP_STATUS_INVALID_SESSION``.
 
 * **Queue-pairs are now thread-safe on Intel QuickAssist Technology (QAT) PMD.**
 
 
 * **Queue-pairs are now thread-safe on Intel QuickAssist Technology (QAT) PMD.**
 
@@ -184,44 +153,45 @@ New Features
 
 * **Updated the ZUC PMD.**
 
 
 * **Updated the ZUC PMD.**
 
-  * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
+  * Transitioned underlying library from libSSO ZUC to intel-ipsec-mb
     library (minimum version required 0.53).
   * Removed dynamic library limitation, so PMD can be built as a shared
     object now.
 
 * **Updated the KASUMI PMD.**
 
     library (minimum version required 0.53).
   * Removed dynamic library limitation, so PMD can be built as a shared
     object now.
 
 * **Updated the KASUMI PMD.**
 
-  * Transistioned underlying library from libSSO KASUMI to intel-ipsec-mb
+  * Transitioned underlying library from libSSO KASUMI to intel-ipsec-mb
     library (minimum version required 0.53).
 
 * **Updated the SNOW3G PMD.**
 
     library (minimum version required 0.53).
 
 * **Updated the SNOW3G PMD.**
 
-  * Transistioned underlying library from libSSO SNOW3G to intel-ipsec-mb
+  * Transitioned underlying library from libSSO SNOW3G to intel-ipsec-mb
     library (minimum version required 0.53).
 
 * **Changed armv8 crypto PMD external dependency.**
 
     library (minimum version required 0.53).
 
 * **Changed armv8 crypto PMD external dependency.**
 
-  armv8 crypto PMD now depends on Arm crypto library, and Marvell's
-  armv8 crypto library is not used anymore. Library name is changed
+  Changed armv8 crypto PMD external dependency. The
+  armv8 crypto PMD now depends on the Arm crypto library, and Marvell's
+  armv8 crypto library is not used anymore. The library name has been changed
   from armv8_crypto to AArch64crypto.
 
 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
 
   from armv8_crypto to AArch64crypto.
 
 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
 
-  Added inline IPsec support to Marvell OCTEON TX2 PMD. With the feature,
-  applications would be able to offload entire IPsec offload to the hardware.
+  Added inline IPsec support to Marvell OCTEON TX2 PMD. With this feature,
+  applications will be able to offload entire IPsec offload to the hardware.
   For the configured sessions, hardware will do the lookup and perform
   For the configured sessions, hardware will do the lookup and perform
-  decryption and IPsec transformation. For the outbound path, application
-  can submit a plain packet to the PMD, and it would be sent out on wire
+  decryption and IPsec transformation. For the outbound path, applications
+  can submit a plain packet to the PMD, and it will be sent out on the wire
   after doing encryption and IPsec transformation of the packet.
 
 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
 
   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
   after doing encryption and IPsec transformation of the packet.
 
 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
 
   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
-  See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
+  See ``rawdevs/octeontx2_ep`` for more details on this new PMD.
 
 * **Added event mode to l3fwd sample application.**
 
 
 * **Added event mode to l3fwd sample application.**
 
-  Add event device support for ``l3fwd`` sample application. It demonstrates
+  Added event device support for the ``l3fwd`` sample application. It demonstrates
   usage of poll and event mode IO mechanism under a single application.
 
 * **Added cycle-count mode to the compression performance tool.**
   usage of poll and event mode IO mechanism under a single application.
 
 * **Added cycle-count mode to the compression performance tool.**
@@ -229,22 +199,18 @@ New Features
   Enhanced the compression performance tool by adding a cycle-count mode
   which can be used to help measure and tune hardware and software PMDs.
 
   Enhanced the compression performance tool by adding a cycle-count mode
   which can be used to help measure and tune hardware and software PMDs.
 
+* **Added OpenWrt howto guide.**
 
 
-Removed Items
--------------
-
-.. This section should contain removed items in this release. Sample format:
+  Added document which describes how to enable DPDK on OpenWrt in both virtual and
+  physical machines.
 
 
-   * Add a short 1-2 sentence description of the removed item
-     in the past tense.
 
 
-   This section is a comment. Do not overwrite or remove it.
-   Also, make sure to start the actual text at the margin.
-   =========================================================
+Removed Items
+-------------
 
 * **Disabled building all the Linux kernel modules by default.**
 
 
 * **Disabled building all the Linux kernel modules by default.**
 
-  In order to remove the build time dependency with Linux kernel,
+  In order to remove the build time dependency on the Linux kernel,
   the Technical Board decided to disable all the kernel modules
   by default from 20.02 version.
 
   the Technical Board decided to disable all the kernel modules
   by default from 20.02 version.
 
@@ -253,79 +219,38 @@ Removed Items
   The internal tail write coalescing feature was removed as not compatible with
   dual-thread feature. It was replaced with a threshold feature. At busy times
   if only a small number of packets can be enqueued, each enqueue causes
   The internal tail write coalescing feature was removed as not compatible with
   dual-thread feature. It was replaced with a threshold feature. At busy times
   if only a small number of packets can be enqueued, each enqueue causes
-  an expensive MMIO write. These MMIO write occurrences can be optimised by using
-  the new threshold parameter on process start. Please see qat documentation for
+  an expensive MMIO write. These MMIO write occurrences can be optimized by using
+  the new threshold parameter on process start. Please see QAT documentation for
   more details.
 
 
 API Changes
 -----------
 
   more details.
 
 
 API Changes
 -----------
 
-.. This section should contain API changes. Sample format:
+* No change in this release.
 
 
-   * sample: Add a short 1-2 sentence description of the API change
-     which was announced in the previous releases and made in this release.
-     Start with a scope label like "ethdev:".
-     Use fixed width quotes for ``function_names`` or ``struct_names``.
-     Use the past tense.
-
-   This section is a comment. Do not overwrite or remove it.
-   Also, make sure to start the actual text at the margin.
-   =========================================================
 
 
+.. _20_02_abi_changes:
 
 ABI Changes
 -----------
 
 
 ABI Changes
 -----------
 
-.. This section should contain ABI changes. Sample format:
-
-   * sample: Add a short 1-2 sentence description of the ABI change
-     which was announced in the previous releases and made in this release.
-     Start with a scope label like "ethdev:".
-     Use fixed width quotes for ``function_names`` or ``struct_names``.
-     Use the past tense.
-
-   This section is a comment. Do not overwrite or remove it.
-   Also, make sure to start the actual text at the margin.
-   =========================================================
-
 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 
 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 
+* The soname for each stable ABI version should be just the ABI version major
+  number without the minor number. Unfortunately both major and minor were used
+  in the v19.11 release, causing version v20.x releases to be incompatible with
+  ABI v20.0.
 
 
-Known Issues
-------------
-
-.. This section should contain new known issues in this release. Sample format:
-
-   * **Add title in present tense with full stop.**
-
-     Add a short 1-2 sentence description of the known issue
-     in the present tense. Add information on any known workarounds.
-
-   This section is a comment. Do not overwrite or remove it.
-   Also, make sure to start the actual text at the margin.
-   =========================================================
+  The `commit f26c2b39b271 <https://git.dpdk.org/dpdk/commit/?id=f26c2b39b271>`_
+  fixed the issue by switching from 2-part to 3-part ABI version numbers so that
+  we can keep v20.0 as soname and using the final digits to identify the DPDK
+  20.x releases which are ABI compatible.
 
 
 Tested Platforms
 ----------------
 
 
 
 Tested Platforms
 ----------------
 
-.. This section should contain a list of platforms that were tested
-   with this release.
-
-   The format is:
-
-   * <vendor> platform with <vendor> <type of devices> combinations
-
-     * List of CPU
-     * List of OS
-     * List of devices
-     * Other relevant details...
-
-   This section is a comment. Do not overwrite or remove it.
-   Also, make sure to start the actual text at the margin.
-   =========================================================
-
 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
 
   * CPU
 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
 
   * CPU
@@ -432,3 +357,139 @@ Tested Platforms
       * Firmware version: 3.25, 0x800006eb
       * Device id (pf): 8086:1533
       * Driver version: 5.4.0-k(igb)
       * Firmware version: 3.25, 0x800006eb
       * Device id (pf): 8086:1533
       * Driver version: 5.4.0-k(igb)
+
+* Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
+
+  * CPU:
+
+    * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
+
+  * OS:
+    * Red Hat Enterprise Linux Server release 7.5 (Maipo)
+    * Red Hat Enterprise Linux Server release 7.4 (Maipo)
+    * Red Hat Enterprise Linux Server release 7.3 (Maipo)
+    * Red Hat Enterprise Linux Server release 7.2 (Maipo)
+    * Ubuntu 18.04
+    * Ubuntu 16.04
+
+  * OFED:
+
+    * MLNX_OFED 4.7-3.2.9.0
+    * MLNX_OFED 5.0-0.4.1.0 and above
+
+  * upstream kernel:
+
+    * Linux 5.5 and above
+
+  * rdma-core:
+
+    * rdma-core-28.0-1 and above
+
+  * NICs:
+
+    * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
+
+      * Host interface: PCI Express 3.0 x8
+      * Device ID: 15b3:1007
+      * Firmware version: 2.42.5000
+
+    * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
+
+      * Host interface: PCI Express 3.0 x8
+      * Device ID: 15b3:1007
+      * Firmware version: 2.42.5000
+
+    * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
+
+      * Host interface: PCI Express 3.0 x8
+      * Device ID: 15b3:1015
+      * Firmware version: 14.27.1000 and above
+
+    * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
+
+      * Host interface: PCI Express 3.0 x8
+      * Device ID: 15b3:1015
+      * Firmware version: 14.27.1000 and above
+
+    * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
+
+      * Host interface: PCI Express 3.0 x16
+      * Device ID: 15b3:1017
+      * Firmware version: 16.27.1000 and above
+
+    * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
+
+      * Host interface: PCI Express 3.0 x16
+      * Device ID: 15b3:1017
+      * Firmware version: 16.27.1000 and above
+
+    * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
+
+      * Host interface: PCI Express 3.0 x16
+      * Device ID: 15b3:1017
+      * Firmware version: 16.27.1000 and above
+
+    * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
+
+      * Host interface: PCI Express 4.0 x16
+      * Device ID: 15b3:1019
+      * Firmware version: 16.27.1000 and above
+
+
+* Mellanox\ |reg| BlueField SmartNIC
+
+  * Mellanox\ |reg| BlueField SmartNIC MT416842 (2x25G)
+
+    * Host interface: PCI Express 3.0 x16
+    * Device ID: 15b3:a2d2
+    * Firmware version: 18.27.1000
+
+  * SoC Arm cores running OS:
+
+    * CentOS Linux release 7.5.1804 (AltArch)
+    * MLNX_OFED 5.0-0.4.0.0
+
+  * DPDK application running on Arm cores inside SmartNIC
+
+* IBM Power 9 platforms with Mellanox\ |reg| NICs combinations
+
+  * CPU:
+
+    * POWER9 2.2 (pvr 004e 1202) 2300MHz
+
+  * OS:
+
+    * Ubuntu 18.04.1 LTS (Bionic Beaver)
+
+  * NICs:
+
+    * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
+
+      * Host interface: PCI Express 3.0 x16
+      * Device ID: 15b3:1017
+      * Firmware version: 16.27.1000
+
+  * OFED:
+
+    * MLNX_OFED 5.0-0.4.1.0
+
+* ARMv8 SoC combinations from Marvell (with integrated NICs)
+
+  * SoC:
+
+    * CN83xx, CN96xx, CN93xx
+
+  * OS (Based on Marvell OCTEON TX SDK-10.3.2.x):
+
+    * Arch Linux
+    * Buildroot 2018.11
+    * Ubuntu 16.04.1 LTS
+    * Ubuntu 16.10
+    * Ubuntu 18.04.1
+    * Ubuntu 19.04
DPDK repo used for reviews