doc: introduce OpenWrt how-to
[dpdk.git] / doc / guides / rel_notes / release_20_02.rst
index 2c8ee32..dfebc46 100644 (file)
@@ -61,6 +61,10 @@ New Features
   A new API has been added to wait for a memory location to be updated with a
   16-bit, 32-bit, 64-bit value.
 
+* **Added rte_ring_xxx_elem APIs.**
+
+  New APIs have been added to support rings with custom element size.
+
 * **Updated rte_flow api to support L2TPv3 over IP flows.**
 
   Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
@@ -70,6 +74,12 @@ New Features
   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 with new features and improvements, including:
+
+  * Added support for MARK action.
+
 * **Updated Hisilicon hns3 driver.**
 
   Updated Hisilicon hns3 driver with new features and improvements, including:
@@ -84,6 +94,7 @@ New Features
   * Added support for MAC rules on specific port.
   * 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.
 
 * **Updated Intel iavf driver.**
 
@@ -92,6 +103,12 @@ New Features
   * Added more supported device IDs.
   * Updated virtual channel to latest AVF spec.
 
+* **Updated the Intel ixgbe driver.**
+
+  * 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.
+
 * **Updated Intel i40e driver.**
 
   Updated i40e PMD with new features and improvements, including:
@@ -104,7 +121,10 @@ New Features
   * Added LLDP support.
   * Extended PHY access AQ cmd.
   * Added support for reading LPI counters.
-  * Added support for Energy Efficient Ethernet
+  * Added support for Energy Efficient Ethernet.
+  * 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.
 
 * **Updated Mellanox mlx5 driver.**
 
@@ -112,12 +132,22 @@ New Features
 
   * 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 BlueField-2 integrated ConnectX-6 Dx device support.
 
 * **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 support for virtio-PMD notification data.**
+
+  Added support for virtio-PMD notification data so that the driver
+  passes extra data (besides identifying the virtqueue) in its device
+  notifications, expanding the notifications to include the avail index and
+  avail wrap counter (When split ring is used, the avail wrap counter is not
+  included in the notification data).
+
 * **Updated testpmd application.**
 
   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
@@ -130,6 +160,14 @@ New Features
   * ECPM (Elliptic Curve Point Multiplication) is added to
     asymmetric crypto library specifications.
 
+* **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
+  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.
+
 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
 
   Added handling of mixed algorithms in encrypted digest hash-cipher
@@ -138,6 +176,13 @@ New Features
   Such algorithm combinations are not supported on GEN1/GEN2 hardware
   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 thread-safe on Intel CPUs but Queues are not (that is, within
+  a single queue-pair all enqueues to the TX queue must be done from one thread
+  and all dequeues from the RX queue must be done from one thread, but enqueues
+  and dequeues may be done in different threads.).
+
 * **Updated the ZUC PMD.**
 
   * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
@@ -161,6 +206,15 @@ New Features
   armv8 crypto library is not used anymore. Library name is changed
   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.
+  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
+  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.
@@ -171,6 +225,16 @@ New Features
   Add event device support for ``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.**
+
+  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.**
+
+  Added document describes how to enable DPDK on OpenWrt in both virtual and
+  physical machine.
+
 
 Removed Items
 -------------
@@ -190,6 +254,15 @@ Removed Items
   the Technical Board decided to disable all the kernel modules
   by default from 20.02 version.
 
+* **Removed coalescing feature from Intel QuickAssist Technology (QAT) PMD.**
+
+  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
+  more details.
+
 
 API Changes
 -----------
@@ -258,3 +331,110 @@ Tested Platforms
    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| Atom\ |trade| CPU C3758 @ 2.20GHz
+    * Intel\ |reg| Atom\ |trade| CPU C3858 @ 2.00GHz
+    * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
+    * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
+    * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2680 0 @ 2.70GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
+    * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
+    * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
+    * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
+    * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
+    * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
+
+  * OS:
+
+    * CentOS 7.7
+    * CentOS 8.0
+    * Fedora 31
+    * FreeBSD 12.1
+    * Red Hat Enterprise Linux Server release 8.0
+    * Red Hat Enterprise Linux Server release 7.7
+    * Suse15SP1
+    * Ubuntu 14.04
+    * Ubuntu 16.04
+    * Ubuntu 16.10
+    * Ubuntu 18.04
+    * Ubuntu 19.04
+
+  * NICs:
+
+    * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (4x25G)
+
+      * Firmware version: 1.02 0x80002b69
+      * Device id (pf): 8086:1593
+      * Driver version: 0.12.34 (ice)
+
+    * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (2x100G)
+
+      * Firmware version: 1.02 0x80002b68
+      * Device id (pf): 8086:1592
+      * Driver version: 0.12.34 (ice)
+
+    * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
+
+      * Firmware version: 0x61bf0001
+      * Device id (pf/vf): 8086:10fb / 8086:10ed
+      * Driver version: 5.6.1 (ixgbe)
+
+    * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
+
+      * Firmware version: 0x800003e7
+      * Device id (pf/vf): 8086:15ad / 8086:15a8
+      * Driver version: 5.1.0 (ixgbe)
+
+    * Intel\ |reg| Corporation Ethernet Controller 10G X550T
+
+      * Firmware version: 0x80000482
+      * Device id (pf): 8086:1563
+      * Driver version: 5.6.1 (ixgbe)
+
+    * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
+
+      * Firmware version: 7.20 0x800079e8
+      * Device id (pf/vf): 8086:1572 / 8086:154c
+      * Driver version: 2.10.19.30 (i40e)
+
+    * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
+
+      * Firmware version: 4.11 0x80001def
+      * Device id (pf/vf): 8086:37d0 / 8086:37cd
+      * Driver version: 2.10.19.30 (i40e)
+
+    * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
+
+      * Firmware version: 4.10 0x80001a7a
+      * Device id (pf/vf): 8086:37d2 / 8086:37cd
+      * Driver version: 2.10.19.30 (i40e)
+
+    * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
+
+      * Firmware version: 7.20 0x80007947
+      * Device id (pf/vf): 8086:158b / 8086:154c
+      * Driver version: 2.10.19.30 (i40e)
+
+    * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
+
+      * Firmware version: 7.20 0x80007948
+      * Device id (pf/vf): 8086:1583 / 8086:154c
+      * Driver version: 2.10.19.30 (i40e)
+
+    * Intel\ |reg| Corporation I350 Gigabit Network Connection
+
+      * Firmware version: 1.63, 0x80000cbc
+      * Device id (pf/vf): 8086:1521 / 8086:1520
+      * Driver version: 5.4.0-k (igb)
+
+    * Intel\ |reg| Corporation I210 Gigabit Network Connection
+
+      * Firmware version: 3.25, 0x800006eb
+      * Device id (pf): 8086:1533
+      * Driver version: 5.4.0-k(igb)