From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 89D49A0032; Wed, 16 Mar 2022 18:33:45 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1FB8D410EC; Wed, 16 Mar 2022 18:33:45 +0100 (CET) Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by mails.dpdk.org (Postfix) with ESMTP id B3C6B40395 for ; Wed, 16 Mar 2022 18:33:42 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1647452022; x=1678988022; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=/5TaD1DGiQm9YJcibIXY3/eRPLbriLNAWfJfs3neQec=; b=NaUULd70fzHVr4+4EjISJf1WY1HhvwMYHV10U3BtPPRzZzfry4co4gJL yLqePPEaEMdtG9rhmJomHQqc+SZ4M8aNKaVJJ6Cb5j3E9SGpoYTfWZwNE OORIgFCDqjFGusWnXvD9L0BgXk06Fwtn2lymcjhrOMh7xvVFjf/JSCLCg H+PAOwEmJTMTK4LGpTAce11EneUAiyPoOQKsZDUxdF3j1Z3o5R0F7uS1V PlHuTPzl0tQ35bw49Kpb4lTKDd4YJ+PpGJbyB4h/7OucA5bdHG90hIJH6 CBIzD1frsbUTAZqwnrX0caddIVFDI1MaO35cjOrMprCzU0t1hcCqPtsMo Q==; X-IronPort-AV: E=McAfee;i="6200,9189,10288"; a="236618324" X-IronPort-AV: E=Sophos;i="5.90,187,1643702400"; d="scan'208";a="236618324" Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 Mar 2022 10:33:41 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,187,1643702400"; d="scan'208";a="635075396" Received: from silpixa00389815.ir.intel.com (HELO silpixa00389815.ger.corp.intel.com) ([10.237.223.46]) by FMSMGA003.fm.intel.com with ESMTP; 16 Mar 2022 10:33:40 -0700 From: John McNamara To: dev@dpdk.org Cc: thomas@monjalon.net, John McNamara Subject: [PATCH v1] doc: update release notes for 22.03 Date: Wed, 16 Mar 2022 17:33:37 +0000 Message-Id: <20220316173337.1944038-1-john.mcnamara@intel.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Fix grammar, spelling and formatting of DPDK 22.03 release notes. Signed-off-by: John McNamara --- Note: I haven't removed the boilerplate RST comments from this file/patch in order to make it easier to merge apply. If you want me to do that I can submit a v2. doc/guides/rel_notes/release_22_03.rst | 108 +++++++++++++------------ 1 file changed, 56 insertions(+), 52 deletions(-) diff --git a/doc/guides/rel_notes/release_22_03.rst b/doc/guides/rel_notes/release_22_03.rst index d231e3e8a4..27067dd5c0 100644 --- a/doc/guides/rel_notes/release_22_03.rst +++ b/doc/guides/rel_notes/release_22_03.rst @@ -57,45 +57,47 @@ New Features * **Added ability to reuse hugepages in Linux.** - It is possible to reuse files in hugetlbfs to speed up hugepage mapping, + It is now possible to reuse files in hugetlbfs to speed up hugepage mapping, which may be useful for fast restart and large allocations. The new mode is activated with ``--huge-unlink=never`` and has security implications, refer to the user and programmer guides. * **Added functions to calculate UDP/TCP checksum in mbuf.** - * Added the following functions to calculate UDP/TCP checksum of packets - which can be over multi-segments: - - ``rte_ipv4_udptcp_cksum_mbuf()`` - - ``rte_ipv4_udptcp_cksum_mbuf_verify()`` - - ``rte_ipv6_udptcp_cksum_mbuf()`` - - ``rte_ipv6_udptcp_cksum_mbuf_verify()`` + Added the following functions to calculate UDP/TCP checksum of packets + which can be over multi-segments: -* **Added functions to configure flow engine.** + - ``rte_ipv4_udptcp_cksum_mbuf()`` + - ``rte_ipv4_udptcp_cksum_mbuf_verify()`` + - ``rte_ipv6_udptcp_cksum_mbuf()`` + - ``rte_ipv6_udptcp_cksum_mbuf_verify()`` - * Added ``rte_flow_configure`` API to configure flow management - engine, allowing to pre-allocate some resources for better performance. - Added ``rte_flow_info_get`` API to retrieve available resources. +* **Added functions to configure the flow engine.** - * Added ``rte_flow_template_table_create`` API to group flow rules - with the same flow attributes and common matching patterns and actions - defined by ``rte_flow_pattern_template_create`` and - ``rte_flow_actions_template_create`` respectively. - Corresponding functions to destroy these entities are: - ``rte_flow_template_table_destroy``, ``rte_flow_pattern_template_destroy`` - and ``rte_flow_actions_template_destroy``. + Added the ``rte_flow_configure`` API to configure the flow management + engine, allowing preallocation of some resources for better performance. + Added ``rte_flow_info_get`` API to retrieve available resources. -* **Added functions for asynchronous flow rules creation/destruction.** + Added ``rte_flow_template_table_create`` API to group flow rules + with the same flow attributes and common matching patterns and actions + defined by ``rte_flow_pattern_template_create`` and + ``rte_flow_actions_template_create`` respectively. + The corresponding functions to destroy these entities are: + ``rte_flow_template_table_destroy``, ``rte_flow_pattern_template_destroy`` + and ``rte_flow_actions_template_destroy``. - * Added ``rte_flow_async_create`` and ``rte_flow_async_destroy`` API - to enqueue flow creaion/destruction operations asynchronously as well as - ``rte_flow_pull`` to poll and retrieve results of these operations and - ``rte_flow_push`` to push all the in-flight operations to the NIC. +* **Added functions for asynchronous flow rules creation and destruction.** - * Added asynchronous API for indirect actions management: - ``rte_flow_async_action_handle_create``, - ``rte_flow_async_action_handle_destroy`` and - ``rte_flow_async_action_handle_update``. + Added the ``rte_flow_async_create`` and ``rte_flow_async_destroy`` APIs + to enqueue flow creation/destruction operations asynchronously as well as + ``rte_flow_pull`` to poll and retrieve results of these operations and + ``rte_flow_push`` to push all the in-flight operations to the NIC. + + Added asynchronous APIs for indirect actions management: + + - ``rte_flow_async_action_handle_create`` + - ``rte_flow_async_action_handle_destroy`` + - ``rte_flow_async_action_handle_update`` * **Added rte_flow support for matching GRE optional fields.** @@ -104,35 +106,35 @@ New Features * **Added new RSS offload types for L2TPv2 in RSS flow.** - Added macro RTE_ETH_RSS_L2TPV2, now L2TPv2 session ID field can be used as + Added ``RTE_ETH_RSS_L2TPV2`` macro so that he L2TPv2 session ID field can be used as input set for RSS. -* **Added IP reassembly Ethernet offload API, to get and set config.** +* **Added IP reassembly Ethernet offload APIs to get and set config.** Added IP reassembly offload APIs which provide functions to query IP reassembly capabilities, to set configuration and to get currently set reassembly configuration. -* **Added an API to enable queue based priority flow ctrl(PFC).** +* **Added an API to enable queue based priority flow ctrl (PFC).** - New APIs, ``rte_eth_dev_priority_flow_ctrl_queue_info_get()`` and - ``rte_eth_dev_priority_flow_ctrl_queue_configure()``, was added. + Added new APIs, ``rte_eth_dev_priority_flow_ctrl_queue_info_get()`` and + ``rte_eth_dev_priority_flow_ctrl_queue_configure()`` for queue based + priority flow ctrl (PFC). * **Added a private dump API, to dump private info from device.** - Added the private dump API which provides querying private info from device. - There exists many private properties in different PMD drivers. - The information of these properties is important for debug. - As the information is private, a dump function is introduced. + Added the private dump API which provides a facility for querying private info from a device. + There exists many private properties in different PMD drivers and + the information in these properties is useful for debugging. -* **Updated AF_XDP PMD** +* **Updated AF_XDP PMD.** - * Added support for libxdp >=v1.2.2. + * Added support for libxdp >= v1.2.2. * Re-enabled secondary process support. RX/TX is not supported. * **Updated Amazon ENA PMD.** - The new driver version (v2.6.0) introduced bug fixes and improvements, including: + The new driver version (v2.6.0) introduces bug fixes and improvements, including: * Added new checksum related xstats: ``l3_csum_bad``, ``l4_csum_bad`` and ``l4_csum_good``. @@ -159,14 +161,14 @@ New Features * **Updated Marvell cnxk ethdev PMD.** - * Added queue based priority flow control support for CN9K & CN10K. + * Added queue based priority flow control support for CN9K and CN10K. * Added support for IP reassembly for inline inbound IPsec packets. * Added support for packet marking in traffic manager. * Added support for CNF95xx B0 variant SoC. * **Updated Mellanox mlx5 driver.** - * Supported ConnectX-7 capability to schedule traffic sending on timestamp. + * Added support for ConnectX-7 capability to schedule traffic sending on timestamp. * Added WQE based hardware steering support with ``rte_flow_async`` API. * Added steering for external Rx queue created outside the PMD. * Added GRE optional fields matching. @@ -174,14 +176,16 @@ New Features * **Updated Wangxun ngbe driver.** * Added support for devices of custom PHY interfaces. + - M88E1512 PHY connects to RJ45 - M88E1512 PHY connects to RGMII combo - YT8521S PHY connects to SFP + * Added LED OEM support. * **Updated Wangxun txgbe driver.** - * Added LED OEM support. + Added LED OEM support. * **Added an API for private user data in asymmetric crypto session.** @@ -210,27 +214,27 @@ New Features * **Added support for Kunpeng930 DMA devices to HiSilicon DMA PMD.** - * Kunpeng930 DMA devices are now enabled for HiSilicon DMA PMD. + Kunpeng930 DMA devices are now enabled for HiSilicon DMA PMD. * **Added CNXK GPIO PMD.** - Added a new rawdevice PMD which allows to manage userspace GPIOs and install - custom GPIO interrupt handlers which bypass kernel. This is especially useful - for applications, that besides providing standard dataplane functionality - want to have fast and low latency access to GPIO pin state. + Added a new rawdevice PMD which allows managing userspace GPIOs and installing + custom GPIO interrupt handlers which bypass the kernel. This is especially useful + for applications that as well as providing standard dataplane functionality + also want to have fast and low latency access to GPIO pin state. See the :doc:`../rawdevs/cnxk_gpio` rawdev guide for more details on this driver. -* **Updated testpmd.** +* **Updated testpmd to support software UDP/TCP checksum over multiple segments.** - * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode - to support software UDP/TCP checksum over multiple segments. + Updated ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode + to support software UDP/TCP checksum over multiple segments. * **Added crypto producer mode in test-eventdev.** - * Crypto producer mode helps to measure performance of OP_NEW and OP_FORWARD - modes of event crypto adapter. + Crypto producer mode helps to measure performance of OP_NEW and OP_FORWARD + modes of event crypto adapter. Removed Items -- 2.25.1