X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Frelease_20_08.rst;h=445e40fbacaed53c5b39349ea60cb5ff5aabdb82;hb=5e7596ba7cb3b1f07a605edf6c816d355e84dc26;hp=98dd482c52231a1c8420fb0d85e1cdc93b34a759;hpb=4407009c5d829e4407e278b9b23a95876b6e1c78;p=dpdk.git diff --git a/doc/guides/rel_notes/release_20_08.rst b/doc/guides/rel_notes/release_20_08.rst index 98dd482c52..445e40fbac 100644 --- a/doc/guides/rel_notes/release_20_08.rst +++ b/doc/guides/rel_notes/release_20_08.rst @@ -6,81 +6,34 @@ DPDK Release 20.08 ================== -.. **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_08.html - - 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 non-EAL threads registration API.** Added a new API to register non-EAL threads as lcores. This can be used by - applications to have its threads known of DPDK without suffering from the + applications to have its threads known to DPDK without suffering from the non-EAL previous limitations in terms of performance. -* **rte_*mb APIs are updated to use DMB instruction for ARMv8.** +* **rte_*mb APIs are updated to use the DMB instruction for ARMv8.** ARMv8 memory model has been strengthened to require other-multi-copy - atomicity. This allows for using DMB instruction instead of DSB for IO - barriers. rte_*mb APIs, for ARMv8 platforms, are changed to use DMB + atomicity. This allows for using the DMB instruction instead of DSB for IO + barriers. The rte_*mb APIs, for ARMv8 platforms, have changed to use the DMB instruction to reflect this. * **Added support for RTS and HTS modes into mempool ring driver.** - Added ability to select new ring synchronisation modes: + Added the ability to select new ring synchronisation modes: ``relaxed tail sync (ring_mt_rts)`` and ``head/tail sync (ring_mt_hts)`` - via mempool ops API. + via the mempool ops API. * **Added the support for vfio-pci new VF token interface.** - From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created VFs, - it uses a shared VF token (UUID) to represent the collaboration between PF - and VFs. Update DPDK PCI driver to gain the access to the PF and VFs devices - by appending the VF token parameter. + From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created + VFs, where it uses a shared VF token (UUID) to represent the collaboration + between PF and VFs. The DPDK PCI driver has been updated to gain the access + to the PF and VFs devices by appending the VF token parameter. * **Added the RegEx Library, a generic RegEx service library.** @@ -93,13 +46,13 @@ New Features 4 new APIs have been added to enable vhost async data path, including: - * Async device channel register/unregister APIs - * Async packets enqueue/completion APIs (only split ring was implemented) + * Async device channel register/unregister APIs. + * Async packets enqueue/completion APIs (only split ring was implemented). * **Added vDPA device APIs to query virtio queue statistics.** - A new 3 APIs has been added to query virtio queue statistics, to get their - names and to reset them by a vDPA device. + Added new vDPA APIs to query virtio queue statistics, to get their names and + to reset them. * **Updated Mellanox mlx5 vDPA driver.** @@ -113,11 +66,11 @@ New Features The ``ECPRI`` item has been added to support eCPRI packet offloading for 5G network. -* **Introduced send packet scheduling on the timestamps.** +* **Introduced send packet scheduling based on timestamps.** - Added the new mbuf dynamic field and flag to provide timestamp on what packet - transmitting can be synchronized. The device Tx offload flag is added to - indicate the PMD supports send scheduling. + Added a new mbuf dynamic field and flag to provide a timestamp on which + packet transmitting can be synchronized. A device Tx offload flag has been + added to indicate the PMD supports send scheduling. * **Updated PCAP driver.** @@ -152,7 +105,7 @@ New Features * Added support for LRO. * Added support for setting VF PVID by PF driver. -* **Updated the Intel ice driver.** +* **Updated Intel ice driver.** Updated the Intel ice driver with new features and improvements, including: @@ -162,7 +115,7 @@ New Features * Added RSS support for GTPU, L2TP, ESP, AH, PFCP and PPPoE. * Added support for FDIR filter by GTPU outer IPv4 and IPv6. - * **Updated Intel iavf driver.** +* **Updated Intel iavf driver.** Updated iavf PMD with new features and improvements, including: @@ -174,15 +127,15 @@ New Features Updated i40e PMD with new features and improvements, including: * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only. - * Re-implemented get_fdir_info and get_fdir_stat in private API. - * Re-implemented set_gre_key_len in private API. + * Re-implemented ``get_fdir_info`` and ``get_fdir_stat`` in private API. + * Re-implemented ``set_gre_key_len`` in private API. * Added support for flow query RSS. -* **Updated the Intel ixgbe driver.** +* **Updated Intel ixgbe driver.** Updated the Intel ixgbe driver with new features and improvements, including: - * Re-implemented get_fdir_info and get_fdir_stat in private API. + * Re-implemented ``get_fdir_info`` and ``get_fdir_stat`` in private API. * **Updated Marvell octeontx2 ethdev PMD.** @@ -201,15 +154,15 @@ New Features Updated the NXP dpaa ethdev with new features and improvements, including: - * Added support for link status and interrupt - * Added support to use datapath APIs from non-EAL pthread + * Added support for link status and interrupt. + * Added support to use datapath APIs from non-EAL pthread. * **Updated NXP dpaa2 ethdev PMD.** Updated the NXP dpaa2 ethdev with new features and improvements, including: - * Added support to use datapath APIs from non-EAL pthread - * Added support for dynamic flow management + * Added support to use datapath APIs from non-EAL pthread. + * Added support for dynamic flow management. * **Added DOCSIS protocol to rte_security.** @@ -228,7 +181,7 @@ New Features * Added Chacha20-Poly1305 AEAD algorithm in QAT crypto PMD. * Improved handling of multi process in QAT crypto and compression PMDs. * Added support for Intel GEN2 QuickAssist device 200xx - (PF Did 0x18ee, VF Did 0x18ef). + (PF device id 0x18ee, VF device id 0x18ef). * **Updated the OCTEON TX2 crypto PMD.** @@ -276,33 +229,12 @@ New Features Removed Items ------------- -.. This section should contain removed items in this release. Sample format: - - * 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 ``RTE_KDRV_NONE`` based PCI device driver probing. API Changes ----------- -.. This section should contain API changes. Sample format: - - * 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. - ========================================================= - * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines. * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per @@ -312,35 +244,12 @@ API 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 ABI change that would break compatibility with 19.11. 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. - ========================================================= - * **mlx5 PMD does not work on Power 9 with OFED 5.1-0.6.6.0.** Consider using the newer OFED releases, the previous @@ -350,22 +259,6 @@ Known Issues Tested Platforms ---------------- -.. This section should contain a list of platforms that were tested - with this release. - - The format is: - - * platform with 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