From patchwork Thu Nov 23 11:44:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Marchand X-Patchwork-Id: 134559 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 514AA433A8; Thu, 23 Nov 2023 12:44:47 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D50A742F51; Thu, 23 Nov 2023 12:44:41 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id AA43E42F29 for ; Thu, 23 Nov 2023 12:44:40 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1700739880; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=I+oUGNwSkaxXexhJflKvAXzeXjq5AnFn9JE3GMETABI=; b=UE6cZVo2+HdyvDSSwQ3hL7tYhzzsnIj/5lwn7mQHJCxmEuzus7lUBhhpqo/8oZZQnTcA6W pJrYGjpg2vR1vAW6QZAc9N9XQ318eyaKuCU0mitHKeu2WAvxAsH8OIOzRajMHZpWhT9Msz YU7XGbzwDzzCxvDRcrxQ8Isb1VJhFqc= Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-374-B6fsTAsHOfewd9bdDHwa5Q-1; Thu, 23 Nov 2023 06:44:36 -0500 X-MC-Unique: B6fsTAsHOfewd9bdDHwa5Q-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id C4D4B2818766; Thu, 23 Nov 2023 11:44:34 +0000 (UTC) Received: from dmarchan.redhat.com (unknown [10.45.226.112]) by smtp.corp.redhat.com (Postfix) with ESMTP id C519F1C060B0; Thu, 23 Nov 2023 11:44:30 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: thomas@monjalon.net, stable@dpdk.org, Dariusz Sosnowski , Viacheslav Ovsiienko , Ori Kam , Suanming Mou , Matan Azrad , Maxime Coquelin , Chenbo Xia , Nithin Dabilpuram , Kiran Kumar K , Sunil Kumar Kori , Satha Rao , Jiayu Hu , Michael Baum , Jianfeng Tan , Yuanhan Liu , Tiwei Bie , Yinan Wang , Jerin Jacob , Mark Kavanagh , Konstantin Ananyev , John McNamara Subject: [PATCH 3/5] doc: fix some ordered lists Date: Thu, 23 Nov 2023 12:44:03 +0100 Message-ID: <20231123114405.2611371-4-david.marchand@redhat.com> In-Reply-To: <20231123114405.2611371-1-david.marchand@redhat.com> References: <20231123114405.2611371-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.7 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com 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 Ordered lists must start preceded by an empty line. Entries must be separated by an empty line (as per our coding style). Incorrectly indented lines are seen as a separator and result in starting a new list in the rendered doc. Fix issues in some guides. Fixes: 85d9252e55f2 ("net/mlx5: add test for remote PD and CTX") Fixes: 26b683b4f7d0 ("net/virtio: setup Rx queue interrupts") Fixes: 9dcf5d15569b ("doc: clarify path selection in virtio guide") Fixes: 68a03efeed65 ("doc: add Marvell cnxk platform guide") Fixes: f6010c7655cc ("doc: add GSO programmer's guide") Cc: stable@dpdk.org Signed-off-by: David Marchand Acked-by: Bruce Richardson --- doc/guides/nics/mlx5.rst | 21 +++++++++---------- doc/guides/nics/virtio.rst | 12 +++++++++++ doc/guides/platform/cnxk.rst | 3 +++ .../generic_segmentation_offload_lib.rst | 2 +- 4 files changed, 26 insertions(+), 12 deletions(-) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 45379960f0..39a8c5d7b4 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -2326,19 +2326,18 @@ This command performs: #. Call the regular ``port attach`` function with updated identifier. -For example, to attach a port whose PCI address is ``0000:0a:00.0`` -and its socket path is ``/var/run/import_ipc_socket``: + For example, to attach a port whose PCI address is ``0000:0a:00.0`` + and its socket path is ``/var/run/import_ipc_socket``: -.. code-block:: console - - testpmd> mlx5 port attach 0000:0a:00.0 socket=/var/run/import_ipc_socket - testpmd: MLX5 socket path is /var/run/import_ipc_socket - testpmd: Attach port with extra devargs 0000:0a:00.0,cmd_fd=40,pd_handle=1 - Attaching a new port... - EAL: Probe PCI driver: mlx5_pci (15b3:101d) device: 0000:0a:00.0 (socket 0) - Port 0 is attached. Now total ports is 1 - Done + .. code-block:: console + testpmd> mlx5 port attach 0000:0a:00.0 socket=/var/run/import_ipc_socket + testpmd: MLX5 socket path is /var/run/import_ipc_socket + testpmd: Attach port with extra devargs 0000:0a:00.0,cmd_fd=40,pd_handle=1 + Attaching a new port... + EAL: Probe PCI driver: mlx5_pci (15b3:101d) device: 0000:0a:00.0 (socket 0) + Port 0 is attached. Now total ports is 1 + Done port map external Rx queue ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst index ba6247170d..c22ce56a02 100644 --- a/doc/guides/nics/virtio.rst +++ b/doc/guides/nics/virtio.rst @@ -217,6 +217,7 @@ Prerequisites for Rx interrupts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To support Rx interrupts, + #. Check if guest kernel supports VFIO-NOIOMMU: Linux started to support VFIO-NOIOMMU since 4.8.0. Make sure the guest @@ -379,12 +380,16 @@ according to below configuration: #. Split virtqueue mergeable path: If Rx mergeable is negotiated, in-order feature is not negotiated, this path will be selected. + #. Split virtqueue non-mergeable path: If Rx mergeable and in-order feature are not negotiated, also Rx offload(s) are requested, this path will be selected. + #. Split virtqueue in-order mergeable path: If Rx mergeable and in-order feature are both negotiated, this path will be selected. + #. Split virtqueue in-order non-mergeable path: If in-order feature is negotiated and Rx mergeable is not negotiated, this path will be selected. + #. Split virtqueue vectorized Rx path: If Rx mergeable is disabled and no Rx offload requested, this path will be selected. @@ -393,16 +398,21 @@ according to below configuration: #. Packed virtqueue mergeable path: If Rx mergeable is negotiated, in-order feature is not negotiated, this path will be selected. + #. Packed virtqueue non-mergeable path: If Rx mergeable and in-order feature are not negotiated, this path will be selected. + #. Packed virtqueue in-order mergeable path: If in-order and Rx mergeable feature are both negotiated, this path will be selected. + #. Packed virtqueue in-order non-mergeable path: If in-order feature is negotiated and Rx mergeable is not negotiated, this path will be selected. + #. Packed virtqueue vectorized Rx path: If building and running environment support (AVX512 || NEON) && in-order feature is negotiated && Rx mergeable is not negotiated && TCP_LRO Rx offloading is disabled && vectorized option enabled, this path will be selected. + #. Packed virtqueue vectorized Tx path: If building and running environment support (AVX512 || NEON) && in-order feature is negotiated && vectorized option enabled, this path will be selected. @@ -480,5 +490,7 @@ or configuration, below steps can help you identify which path you selected and root cause faster. #. Run vhost/virtio test case; + #. Run "perf top" and check virtio Rx/Tx callback names; + #. Identify which virtio path is selected refer to above table. diff --git a/doc/guides/platform/cnxk.rst b/doc/guides/platform/cnxk.rst index b3aa4de09d..b901062c93 100644 --- a/doc/guides/platform/cnxk.rst +++ b/doc/guides/platform/cnxk.rst @@ -113,7 +113,9 @@ where even VF bound to the first domain and odd VF bound to the second domain. Typical application usage models are, #. Communication between the Linux kernel and DPDK application. + #. Exception path to Linux kernel from DPDK application as SW ``KNI`` replacement. + #. Communication between two different DPDK applications. SDP interface @@ -132,6 +134,7 @@ can bind PF or VF to use SDP interface and it will be enumerated as ethdev ports The primary use case for SDP is to enable the smart NIC use case. Typical usage models are, #. Communication channel between remote host and cnxk SoC over PCIe. + #. Transfer packets received from network interface to remote host over PCIe and vice-versa. diff --git a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst index e605b86376..30d13bcc61 100644 --- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst +++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst @@ -204,7 +204,7 @@ To segment an outgoing packet, an application must: - a flag, that indicates whether the IPv4 headers of output segments should contain fixed or incremental ID values. -2. Set the appropriate ol_flags in the mbuf. +#. Set the appropriate ol_flags in the mbuf. - The GSO library use the value of an mbuf's ``ol_flags`` attribute to determine how a packet should be segmented. It is the application's