From patchwork Mon Feb 20 08:41:09 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Chaoyong He X-Patchwork-Id: 124170 X-Patchwork-Delegate: ferruh.yigit@amd.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 CC02141CE4; Mon, 20 Feb 2023 09:42:17 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 45E2E42FBE; Mon, 20 Feb 2023 09:42:13 +0100 (CET) Received: from NAM02-DM3-obe.outbound.protection.outlook.com (mail-dm3nam02on2131.outbound.protection.outlook.com [40.107.95.131]) by mails.dpdk.org (Postfix) with ESMTP id C0C5C42FA8 for ; Mon, 20 Feb 2023 09:42:10 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=gGsGiYIeiBqL/1eyU6RwroQ4GC6zFC2uAyGJQuT3eZuBw6moPZABgmFksJdQnJkrkNJJ26uRBJEsKMZhrjW1eRTeRtk7wElxGKU0JR+4DAb0kfxFqgF0/X9/Uq5qep8ZmradQgjwVvhdXMGKr4V68Lj5w/OqDl1L17UwaineUvaq5oB7DywE3exlEm1w/jvYMeWb4fIQwvTtR+bGhAJoWzxJlSrVOZaBEUxVIxvHWcM1ahMb4SJcWMcDXDl1k6uvqEoG/3d3SgkV9BFPo6tTU+IlkDqofs7ZkxK9+pXIeSuAphmDiHzmsH2oca/0vR2zYjNmvwn7VH50IQ0QeZx/vA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=YvdjRJtMUa6TwPL5ytO7FHRsMO9Ds4hCFJFfthglH9I=; b=ccsFs+CAwDOFntsFWTaW4dCMiGH/lCgfXvxOJQkzC8pLpZDYVfSxNgiVjhRzIB649JwQPUfxUBm9ha9JcFKMjPdh+iZfAaiKOv2XaviawKZ0nEJvAQ+DkQtLP5dR2RXyatEoO50n2YF+WaIan7XTwkxCpwmt9bzXGyawo4Wn3vmoT/n9rd0ekG8Uw5Wh9vILcMaMnRuI6GbZjMncPRD/te+PSrkbW8xxzct1/x4EprAPcG+5iXYVEXF04C1yDT0iRcIs/tUrMYAv1QXM/cYL/VxCtZ5KMpSL8UPhRknYsl56H7Rssq0OLlnxIm6BrQ1jmRTE7M8HW/RSslntboBU4w== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=corigine.com; dmarc=pass action=none header.from=corigine.com; dkim=pass header.d=corigine.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=corigine.onmicrosoft.com; s=selector2-corigine-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=YvdjRJtMUa6TwPL5ytO7FHRsMO9Ds4hCFJFfthglH9I=; b=mVqutYc3+8nARgw0JpFqvNhMDK0aiV/rSqU+WBi7OpravHs+0q5q13Ps6l6o9v8+96Js1MyEUFRBUiYbLvDMpplfZuLqq497JexCCGyalqJK1a9WLYH0KloIsFfXJQEb13L0sgyZJLuij4CI01Pa3XPFhdufqjX4weue3LxEERU= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=corigine.com; Received: from SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) by SA0PR13MB3966.namprd13.prod.outlook.com (2603:10b6:806:9e::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6111.20; Mon, 20 Feb 2023 08:42:09 +0000 Received: from SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::7ea4:e421:5dd5:9f4d]) by SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::7ea4:e421:5dd5:9f4d%5]) with mapi id 15.20.6111.018; Mon, 20 Feb 2023 08:42:09 +0000 From: Chaoyong He To: dev@dpdk.org Cc: oss-drivers@corigine.com, niklas.soderlund@corigine.com, Walter Heymans , Chaoyong He Subject: [PATCH v2 1/3] doc: wrap nfp doc to 80 characters and improve grammar Date: Mon, 20 Feb 2023 16:41:09 +0800 Message-Id: <20230220084111.40531-2-chaoyong.he@corigine.com> X-Mailer: git-send-email 2.29.3 In-Reply-To: <20230220084111.40531-1-chaoyong.he@corigine.com> References: <20230203080845.24126-1-chaoyong.he@corigine.com> <20230220084111.40531-1-chaoyong.he@corigine.com> X-ClientProxiedBy: SG2PR04CA0158.apcprd04.prod.outlook.com (2603:1096:4::20) To SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ0PR13MB5545:EE_|SA0PR13MB3966:EE_ X-MS-Office365-Filtering-Correlation-Id: 4e5e5737-9d95-4a03-a153-08db131e5a7b X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: VGqi2+SMtp+rdtDZldL0ZjxR+aiQWDWKtMHaVEGh9fUO+gK9A5FmksumvplS/xzox9QwLoAydKNnX+DI1I1zcx9s8fdLttIXaVmzQ2e8GPecW21Uckf/IJbM47J8rDM2Y5OK5T9HpKDXvEc6AWjYMHbZWQgr3kAahBhg1iUpPFqmiZqDX+HfE0uJy/i+1qie+2ZX6cNfM1HVSOT/9wRDb41g+1G0PnTODm5bdXI56NBpx/1rQ/9R5YIdmzRvg/+3XKFOBthGcfIPp9VziB3b/Gd2vJjPc4IxVc9jwDbkIkuVi+xGs/SRzoXtwdO1az/kjhdHPX3LZAuc4LfJi3frdxZbu6O5IYjnrZvbQqERSbJv68isqiMeSA3FjlEwuWOzXVK5q3oQl6x6KwsGzf78eKEcxRPe9vMII0b/sIrEaXMwSD3Y7oEhxTFWV75EqNfpMKJ7/YkRAdVIoYq9D9Pai+zMMV2LTC5JoDwfXf5Odt9bdKEXzkF7JHcp9nJjHC72Cjy+miGC9ZmnOUZZcFojuZ+jQZgkSNA0xaYRR2kbFLb+Q7SwoNpcUB6yZJn24/BHiYZPsennXFY2s8emuvX7X+8b8XqiiNKlKU8X+f6V/TVhPYg41wPYCMLukqpDvoRDq3ZSF8GOhuKoMWAtmh30cYpj+M2QYnFR4/LPQqfbT9EbwamJmYd2TlxwI+m/wVJf X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ0PR13MB5545.namprd13.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230025)(4636009)(346002)(39840400004)(376002)(396003)(366004)(136003)(451199018)(83380400001)(8936002)(5660300002)(66574015)(41300700001)(86362001)(44832011)(2906002)(52116002)(4326008)(6486002)(966005)(6512007)(186003)(26005)(1076003)(6506007)(107886003)(316002)(8676002)(66946007)(66476007)(6916009)(66556008)(478600001)(2616005)(54906003)(38350700002)(36756003)(38100700002); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?ol9NeCoqUzSJbzsu4lHg4+nhukJj?= =?utf-8?q?FXg7j5yLa0hNOM6344AK/VG62s31BeLu6rpEVPC8+OiDys6msNDxqDR8KShHsH3eJ?= =?utf-8?q?QFipQdQGvzdlioTGWaRp0SoTpfLSKlaC0v+CjliAJn+wpi6HRwK1o7siTolclFWDx?= =?utf-8?q?HeBbMiFJJUQDCqtnWBQBTSYn/IKC89bGqZif5/Kp5wgCe3HBYV5aQ1C8KtpV8cIBI?= =?utf-8?q?i9AbvtHtaVAE/c8OVHDr4SHa1AQSYAJWzs3ZlxiTYqvYl5uSTIWrB4but3CBopMMI?= =?utf-8?q?xwWGCUNUl20AwLyDRZ97x3eRbZg8Q1lcfgepxLhgq5dEp29rok6r+g9d9vjX6WFSJ?= =?utf-8?q?wUTLYr+C5+3ntDYKaSheo/g4Lb9GiiwV6dZYc5V9wVBX3AQvb0YHSzmOLpvk1jKTW?= =?utf-8?q?/RMSrUsj6PKVEWV+ePbQdYJSE7euxvnCMCNQXb6j74WTMdZ6xw0whRhzFf8jLNWlM?= =?utf-8?q?x/52oq1ueF48ZBDIApqC1rjZSnkhDHvCLCR0IXoqRv7EfQQBWKgCCKiQl2hqDoHxJ?= =?utf-8?q?GWLjQdeKwmBbn5Km78VM2CVkpIkE9CgXr+vs+7Rwt7FEYtJJiU4oJxDwxScRlclkE?= =?utf-8?q?y7Myk2H1Y4tYGFnOvCHeKO5eVJk17VZ3YAjzw0TutC19Z6PYk2JM5tmfUYMqqLBno?= =?utf-8?q?IjGgkRJ2km+5YUFbp+iKh9/R0gsHFdn6gDMjLbwRQU9eEwYapmVrn3y+RAalzAf3O?= =?utf-8?q?vo/OowaO+wB7omiXuP8Sh/uLzGtRQEhN5/k/OiAZ6r2X+44dj82zb93+dB2yl1sgH?= =?utf-8?q?aKlTQ7Cqwek8r8kgqpXcR3cYcucYNp5zJU5xdmNMBRvidPgGWX5G3LvOfhcUmK5uQ?= =?utf-8?q?muMAQS8xiZUiX0zsEORMOWljfkQgo7O8gBQ6KXqR0Nu+YnH5uM0MkbnckD2Xpk1Xo?= =?utf-8?q?vkkOsfPtX5iL9m0nwUeXAvde/fLihDZjCbaQW7HCA24nKV3er2BArSH2bOa9WJWeT?= =?utf-8?q?5pNOawU6xLmJMh+ATjg/gzlwpW7atX/NfG9VmkcST640UZKXZGu4dHwkTNrxiXCWY?= =?utf-8?q?yZQt1RTUOnlEdkG/ej6tDpGLOlU/1dYwS/jA3wOBBYObm1VqaO1NDz95iJYMmgXKr?= =?utf-8?q?T8IHA6n+Q2jEtWkp7W8F1quNdWYXIJUHg2qnblh/HwQ3DXrwxJwNSfPcVOk0lGG0T?= =?utf-8?q?Q0BoHCDLDSn7E2KBgGtYGFN7D/2Wm/9KIyAynhibgQ8i2D2+VT3s5ocCGpUx77SbA?= =?utf-8?q?eVfqA/sO/2dKHPf83rRUhCqprb5fPgfNml+nHJ8oLWVV4G9WUCsFA5BXIhTZ0sVTu?= =?utf-8?q?J/jojqdQ+IOX3cDGcOm8LxlGLsmsNDpJrnFZV34ZLhSCVAZdhfNN0JWbLI9KeQPdb?= =?utf-8?q?hdN7uOibU2fNtLjt7GIAjlt3DOUFG3i19G8ePACZWii9mFmWUh7rbDHZCfJQoHa0b?= =?utf-8?q?oKkOdTvJChduX7xXrva5w4oofBclXqXZWFzl1sg2JwaDJJoLCZFatXKUvh1DV7w0P?= =?utf-8?q?GsdC2qw1057TvEtHHKCRJcuyZb16/U5MYFiWkxzLkTWcXN8CWl1uFvNJPTll8lCpf?= =?utf-8?q?fbOrAAOBFzrbYK2hNMysQDMFGCPQr5pEmg=3D=3D?= X-OriginatorOrg: corigine.com X-MS-Exchange-CrossTenant-Network-Message-Id: 4e5e5737-9d95-4a03-a153-08db131e5a7b X-MS-Exchange-CrossTenant-AuthSource: SJ0PR13MB5545.namprd13.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Feb 2023 08:42:09.4023 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: fe128f2c-073b-4c20-818e-7246a585940c X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: S4/moJVTRXnBbN3YlG+oyWyvl9WQq/7LLcYUh+ypsS4dtNamv18g+3nu3gCfBkiis4RVeSt6V11t/z84xh1sUWA10GsdaYyQj99ih73Ha9w= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA0PR13MB3966 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 From: Walter Heymans Wrap the nfp.rst documentation to 80 characters to improve readability in raw format. Also fix some grammatical errors. Signed-off-by: Walter Heymans Reviewed-by: Chaoyong He Reviewed-by: Niklas Söderlund --- doc/guides/nics/nfp.rst | 76 +++++++++++++++++++++-------------------- 1 file changed, 39 insertions(+), 37 deletions(-) diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index a085d7d9ae..36c447a17c 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -15,7 +15,7 @@ Driver (PMD) supporting Netronome's Network Flow Processor 6xxx (NFP-6xxx), Netronome's Network Flow Processor 4xxx (NFP-4xxx) and Netronome's Network Flow Processor 38xx (NFP-38xx). -NFP is a SRIOV capable device and the PMD supports the physical +NFP is a SR-IOV capable device and the PMD supports the physical function (PF) and the virtual functions (VFs). Dependencies @@ -57,8 +57,8 @@ the NFP PMD. Driver compilation and testing ------------------------------ -Refer to the document :ref:`compiling and testing a PMD for a NIC ` -for details. +Refer to the document +:ref:`compiling and testing a PMD for a NIC ` for details. Using the PF ------------ @@ -71,8 +71,8 @@ have a PMD able to work with the PF and VFs at the same time and with the PF implementing VF management along with other PF-only functionalities/offloads. The PMD PF has extra work to do which will delay the DPDK app initialization -like uploading the firmware and configure the Link state properly when starting or -stopping a PF port. Since DPDK 18.05 the firmware upload happens when +like uploading the firmware and configure the Link state properly when starting +or stopping a PF port. Since DPDK 18.05 the firmware upload happens when a PF is initialized, which was not always true with older DPDK versions. Depending on the Netronome product installed in the system, firmware files @@ -92,18 +92,19 @@ PF looks for a firmware file in this order: nic_AMDA0099-0001_2x25.nffw -Netronome's software packages install firmware files under ``/lib/firmware/netronome`` -to support all the Netronome's SmartNICs and different firmware applications. -This is usually done using file names based on SmartNIC type and media and with a -directory per firmware application. Options 1 and 2 for firmware filenames allow -more than one SmartNIC, same type of SmartNIC or different ones, and to upload a -different firmware to each SmartNIC. +Netronome's software packages install firmware files under +``/lib/firmware/netronome`` to support all the Netronome's SmartNICs and +different firmware applications. This is usually done using file names based on +SmartNIC type and media and with a directory per firmware application. Options +1 and 2 for firmware filenames allow more than one SmartNIC, same type of +SmartNIC or different ones, and to upload a different firmware to each +SmartNIC. .. Note:: - Currently the NFP PMD supports using the PF with Agilio Firmware with NFD3 - and Agilio Firmware with NFDk. See https://help.netronome.com/support/solutions - for more information on the various firmwares supported by the Netronome - Agilio CX smartNIC. + Currently the NFP PMD supports using the PF with Agilio Firmware with + NFD3 and Agilio Firmware with NFDk. See + https://help.netronome.com/support/solutions for more information on the + various firmwares supported by the Netronome Agilio CX smartNIC. PF multiport support -------------------- @@ -114,11 +115,11 @@ firmware symbol during initialization to know how many can be used. DPDK apps work with ports, and a port is usually a PF or a VF PCI device. However, with the NFP PF multiport there is just one PF PCI device. Supporting -this particular configuration requires the PMD to create ports in a special way, -although once they are created, DPDK apps should be able to use them as normal -PCI ports. +this particular configuration requires the PMD to create ports in a special +way, although once they are created, DPDK apps should be able to use them as +normal PCI ports. -NFP ports belonging to same PF can be seen inside PMD initialization with a +NFP ports belonging to the same PF can be seen inside PMD initialization with a suffix added to the PCI ID: wwww:xx:yy.z_portn. For example, a PF with PCI ID 0000:03:00.0 and four ports is seen by the PMD code as: @@ -137,24 +138,25 @@ suffix added to the PCI ID: wwww:xx:yy.z_portn. For example, a PF with PCI ID PF multiprocess support ----------------------- -Due to how the driver needs to access the NFP through a CPP interface, which implies -to use specific registers inside the chip, the number of secondary processes with PF -ports is limited to only one. +Due to how the driver needs to access the NFP through a CPP interface, which +implies to use specific registers inside the chip, the number of secondary +processes with PF ports is limited to only one. -This limitation will be solved in future versions but having basic multiprocess support -is important for allowing development and debugging through the PF using a secondary -process which will create a CPP bridge for user space tools accessing the NFP. +This limitation will be solved in future versions, but having basic +multiprocess support is important for allowing development and debugging +through the PF using a secondary process, which will create a CPP bridge +for user space tools accessing the NFP. System configuration -------------------- #. **Enable SR-IOV on the NFP device:** The current NFP PMD supports the PF and - the VFs on a NFP device. However, it is not possible to work with both at the - same time because the VFs require the PF being bound to the NFP PF Linux - netdev driver. Make sure you are working with a kernel with NFP PF support or - get the drivers from the above Github repository and follow the instructions - for building and installing it. + the VFs on a NFP device. However, it is not possible to work with both at + the same time because the VFs require the PF being bound to the NFP PF Linux + netdev driver. Make sure you are working with a kernel with NFP PF support + or get the drivers from the above Github repository and follow the + instructions for building and installing it. VFs need to be enabled before they can be used with the PMD. Before enabling the VFs it is useful to obtain information about the @@ -178,7 +180,7 @@ System configuration lspci -d19ee: -k Two new PCI devices should appear in the output of the above command. The - -k option shows the device driver, if any, that devices are bound to. + -k option shows the device driver, if any, that the devices are bound to. Depending on the modules loaded at this point the new PCI devices may be bound to nfp_netvf driver. @@ -193,13 +195,13 @@ The flower firmware application requires the PMD running two services: * PF vNIC service: handling the feedback traffic. * ctrl vNIC service: communicate between PMD and firmware through - control message. + control messages. To achieve the offload of flow, the representor ports are exposed to OVS. -The flower firmware application support representor port for VF and physical +The flower firmware application supports representor port for VF and physical port. There will always exist a representor port for each physical port, and the number of the representor port for VF is specified by the user through -parameter. +a parameter. In the Rx direction, the flower firmware application will prepend the input port information into metadata for each packet which can't offloaded. The PF @@ -210,9 +212,9 @@ In the Tx direction, the representor port will prepend the output port information into metadata for each packet, and then send it to firmware through PF vNIC. -The ctrl vNIC service handling various control message, like the creation and -configuration of representor port, the pattern and action of flow rules, the -statistics of flow rules, and so on. +The ctrl vNIC service handles various control messages, for example, the +creation and configuration of representor port, the pattern and action of flow +rules, the statistics of flow rules, etc. Metadata Format --------------- From patchwork Mon Feb 20 08:41:10 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Chaoyong He X-Patchwork-Id: 124171 X-Patchwork-Delegate: ferruh.yigit@amd.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 E72D641CE4; Mon, 20 Feb 2023 09:42:25 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BD44542FCC; Mon, 20 Feb 2023 09:42:17 +0100 (CET) Received: from NAM04-BN8-obe.outbound.protection.outlook.com (mail-bn8nam04on2134.outbound.protection.outlook.com [40.107.100.134]) by mails.dpdk.org (Postfix) with ESMTP id 5045042FC0 for ; Mon, 20 Feb 2023 09:42:13 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=ob1jiV7jC6DgcbwjU2Ym+Oq7C8HQcTkrUttpfaBgJx8axdphmhCyQsawWCPeolMppO79+QGS2KAphcCFbidq5R83dsgEIFyZ/h6eq1+ZeXan/ECNuMptHTMgrug+dnNv/tAm+7HI2VhXBLRoz2pc/M5bV5uNoY9xy+aurQpFymK+b8aeGqtjNgrq0NmAiHjTc5OtHCBx+/W46mL2vQ1ZufxyWOfiq+PymufBI6yINJJx2Rl38e65YU1kNRqQU9X180BJ3ZXEIS5T5hb8BcKb5Wo6GkLdPWC5HYltL2lGWgjiDGY07J16WkhpBhdhUujNzHLM+hL33qce9BwkAgS+oQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=K+QVkrs0uYV9JeMvy1JGqI1KeXr0czS0NpcVjSN4gHw=; b=ffqwMUWjQ2YABXaLqlLLh7OSe51PXTq7kqjuN7/KSqxyYS8zlgip2y8J9sRaTjWZ2o4X7EQlBZLxgOKCGz75+6bxIgW15n95drU+ZPe9MmGnkccGlwDdqQsLk98E9Xkx83zni5EkFRQFcCN7q2t+q+7bmEubtXiHdS2AQeXYvG9H/V/B/ZuZBh5uHqbCa5Bb6j7UvHwDgQWPjMJizQMQufjjDD1jR+4TAwJaJDamvSGosY9r7SYbwuez1CAdXO/OoDi8ZiWaBMQBb2LcuuMlPtbbeWVfVhhQEFDmWLa1L8gsc+ONPSxk8n7YfR7Pmx3SWdjIrbRNRawW0b4bImY2JQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=corigine.com; dmarc=pass action=none header.from=corigine.com; dkim=pass header.d=corigine.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=corigine.onmicrosoft.com; s=selector2-corigine-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=K+QVkrs0uYV9JeMvy1JGqI1KeXr0czS0NpcVjSN4gHw=; b=boeGs5Tx9zdjK+lqnIphL3zeeLVcjz2f7uWdya+eeGgKoICiOrqkHBCuq0C3ZH8naBdzVG0MJQWM+UqTBRIx8RM4ylr/I2yI8LQ2cy6A6Fy4cs5YRxYEqeAefASP278vCn0aKMdAezyAnXoVKStyVJe4pD97A6Lx6JYcKCr/vSQ= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=corigine.com; Received: from SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) by SA0PR13MB3966.namprd13.prod.outlook.com (2603:10b6:806:9e::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6111.20; Mon, 20 Feb 2023 08:42:11 +0000 Received: from SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::7ea4:e421:5dd5:9f4d]) by SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::7ea4:e421:5dd5:9f4d%5]) with mapi id 15.20.6111.018; Mon, 20 Feb 2023 08:42:11 +0000 From: Chaoyong He To: dev@dpdk.org Cc: oss-drivers@corigine.com, niklas.soderlund@corigine.com, Walter Heymans , Chaoyong He Subject: [PATCH v2 2/3] doc: update outdated information for the nfp PMD Date: Mon, 20 Feb 2023 16:41:10 +0800 Message-Id: <20230220084111.40531-3-chaoyong.he@corigine.com> X-Mailer: git-send-email 2.29.3 In-Reply-To: <20230220084111.40531-1-chaoyong.he@corigine.com> References: <20230203080845.24126-1-chaoyong.he@corigine.com> <20230220084111.40531-1-chaoyong.he@corigine.com> X-ClientProxiedBy: SG2PR04CA0158.apcprd04.prod.outlook.com (2603:1096:4::20) To SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ0PR13MB5545:EE_|SA0PR13MB3966:EE_ X-MS-Office365-Filtering-Correlation-Id: 6ccac762-53d4-4052-ef3b-08db131e5bd7 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 8NDirVoYl9VE/HYCge3Hxbx1/1LvQgZM5XnFdbLnUq2fgOF3c8ndsvJwan1TrA50SQJvmmurS4BklpD4DLcdhz+U1JXVz5qP+wvsyWrY102A3Cg++WwiX3dpXj+U6QZIyP24xL9kPtwBt+jCQY3oUGqRCO4eatTuVE1bQSAkg3ztJ4EDw3+LHD+YYbY7aNJJhuvbVvFYeFJK1YnwbFFUxRFlnbwpOcviJPi7omnbyh0Wy7VjMxzqDKPy5V3utolp60jbx/fdQL5CRQhS0GGMbgDMndmFnEUG54yL9+lZF20+1YXLFb4yeoOs83j6E8/GqE/3oNe5dJXetXUIovxEW+irxtD496UMdgimdcZiqS4uG11kxBifO1s3OWF/WykHh9gSVMrNkVLMefLbtfMnjKnG0jhTQMrxu1l4+Yt8pxE0aBz/hsPPzCwAbXIanUNXpA5QnBFRGs+bC7T4Av+84xONx8s0hhE9M+0FgA4XywPSR57KkyVuZ4cYVePQzryKh81lgc8XM2obncmLeQIhIIrjuEZyFLFxGF6k/XYU67y1wT1DSm8pqHPZ9SIQEVNA8p8zgjx+VVB0d/Bau4wMiwilfTX5o8giknaoTIE+Qfd/eO7or1zOThVyyvIf8LbnrutRpjhVJFXm+/dJjz/0Qxiu8KWVn7fs6DplX/nF+uTw5ylPwf1zKr01UXU6jCJe0CocWxsSXkPlL2S6OFl8sQ== X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ0PR13MB5545.namprd13.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230025)(4636009)(346002)(39840400004)(376002)(396003)(366004)(136003)(451199018)(83380400001)(8936002)(5660300002)(66574015)(41300700001)(86362001)(15650500001)(44832011)(2906002)(52116002)(4326008)(6486002)(6512007)(186003)(26005)(1076003)(6506007)(107886003)(316002)(8676002)(66946007)(66476007)(6916009)(66556008)(478600001)(2616005)(54906003)(38350700002)(36756003)(38100700002); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?W08rvyQNbukTv5ggm091r+JcbQAn?= =?utf-8?q?YC3QGQy0Q3MqJWIma3uQm55iMU1J9dGXyrMpsCzPQDhgWiWB9WPKTZ89sBUuzPwSY?= =?utf-8?q?18UklFo7uaM63W6ROGg2nxg5ZBlAwIRcts+3SBDO6EuODWnEcg2CP0UcoEoJSyZFt?= =?utf-8?q?mw1DFv93P4RAJ4Fw2nARps316QvlO3yX+sPL1u7YldjciCK/1LiGhaGpx0Q666fYE?= =?utf-8?q?3G2uywtKI6h/EZRL4R+/uII1E51btY04NCZ4GuDNzQH7YvXCKfrJxZ2ptL+hvYe8B?= =?utf-8?q?Sz6QT5U8thZY9DJ0s0ZOjMbCo2y/yeVxN/9Xj6fUpoAYtv37f1XaSQNO19ccVzSlb?= =?utf-8?q?Eo4k9APV9Xz8Ot8csvlIZuxZ6G3+l22Hp9bNFuGqr+kUiE5x2BtSGuMtTvj3Kvr/3?= =?utf-8?q?7Dcr0GKQ195DBmepIuas2OelecQzJbHDwC/NeVI8e1VniPAPeKEc5M7sGfJqd04uX?= =?utf-8?q?ouhChUylTBFJA2nUFsu2D4foxG/N5NignXAI8h4O46FQljWHHwrlutLE62F5rxsgF?= =?utf-8?q?lsMhWUaZYPIyExSBCyyqp1vcJm0pH4ZxUKzpJCG+xwlQ+m9ANam9wmhLd5ay4fKJP?= =?utf-8?q?N/ENWw9GDrDzlnnVpVSjJtcza5Vw2wyyj4U/8E+771HGKJm3NMNraXvPKlwgzQREd?= =?utf-8?q?4vJSppou/1a6LT6NnEY0T/5pjgNqOXjyLMiAogCQ2PaVq2gqwRSi+SKuNgqHf6Y3M?= =?utf-8?q?7Ym8LcsGetfNz2hCQxrElYAUCErHoqWDeTVjBSHWzrtcTo5iGx8ygschgESwT6K75?= =?utf-8?q?AgW65JSraTiDWD9/75LEAq8h+JOM+LJ3Kw1mZ+sH+c/jSewqxfIRp7Ge74pvf3PYQ?= =?utf-8?q?a5eLa61bU/a6MkJ3PpLOdDDaiTwrdn2dFoP7sn+X0/G/i0Ybeq975926F37raGYCD?= =?utf-8?q?YfxEAXAd4wHlijAGeUT9XmixF8vikZAfFnl84Om072ipFUEkeB5P9jFVvpjW/lYrD?= =?utf-8?q?FgNe0xXJ6nvz7M8J5wN4mEOtKWYHklneBI2rYzFH4fCRqNaVuVjGh21K/qhJIktXD?= =?utf-8?q?PQW1mL0IxFFIymgRNbjT507RXhmNab2UKumd/XlVjPNaV/WhMYwXdS1fYUMe1T0Us?= =?utf-8?q?lthD8YZK31BUt5VshjlxUa9neHGtD9oin79w23Vc/qy6aKT8wILk8QC8Wc8V8QMf9?= =?utf-8?q?Uc5B0wGCcUQFsA10WCB+TXk9+CJyOiFrtZXvEQlN6LzQHyBg+Fnd8mxvKUWet0UpF?= =?utf-8?q?qSf69HLIUwIKUVyZIJ+DVlVaWIvYoNcymKDJsmG2OBj+8Oon442DmXaf9yG0lE82x?= =?utf-8?q?WJBkzr44IFE5AHhJ+j2ETvzgl48/cB2DVo/ht4vhNtJePmRER1KURU1s2/B5mPIQF?= =?utf-8?q?yOWPA3x8yYjrjj8tNwtttR99+JB4jxkqFAbtoECw77jMmzKUKj6h998/WUIg277tn?= =?utf-8?q?Xxs1IL7Gm20EbL6KIkYZcKna50uuAfhkp1MIpGPF+gPGztwlHAh0lZgKsVbFGaYy0?= =?utf-8?q?vxrHj9fW7XvxdngXC7ib14gwHS6wF3HH9oWxYTuQVHTpElAM7AOLwfxChcyIcwn4W?= =?utf-8?q?yupwpfTDbVvYQlIbJ43BbaHn6bySs729uQ=3D=3D?= X-OriginatorOrg: corigine.com X-MS-Exchange-CrossTenant-Network-Message-Id: 6ccac762-53d4-4052-ef3b-08db131e5bd7 X-MS-Exchange-CrossTenant-AuthSource: SJ0PR13MB5545.namprd13.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Feb 2023 08:42:11.6732 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: fe128f2c-073b-4c20-818e-7246a585940c X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: 44iHgBVaoDM5GYjGk4neh6RSJSRI6uA5kokVwAa/QzDkd5VJSMqqiwb+xydCLw5zovNvoARh0CitXk041+Wq9SrpmTfhLyqGDNtLuU2YT14= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA0PR13MB3966 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 From: Walter Heymans Update nfp documentation with new information and remove outdated information. The most significant changes that are updated include: - Previously the NFP PMD did not support functionality to control VFs, it now does. - Previously the PF had to be bound to the kernel driver to create VFs, then VFs were created and bound to 'vfio-pci'. Currently it is possible to bind the PF to 'vfio-pci' and create VFs bound to 'vfio-pci'. - The name of the Linux kernel driver changed for VFs. Previously the 'nfp_netvf' module was used, but now both PFs and VFs use the 'nfp' module. Signed-off-by: Walter Heymans Reviewed-by: Chaoyong He Reviewed-by: Niklas Söderlund --- doc/guides/nics/nfp.rst | 40 +++++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index 36c447a17c..d133b6385c 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -63,13 +63,6 @@ Refer to the document Using the PF ------------ -NFP PMD supports using the NFP PF as another DPDK port, but it does not -have any functionality for controlling VFs. In fact, it is not possible to use -the PMD with the VFs if the PF is being used by DPDK, that is, with the NFP PF -bound to ``igb_uio`` or ``vfio-pci`` kernel drivers. Future DPDK versions will -have a PMD able to work with the PF and VFs at the same time and with the PF -implementing VF management along with other PF-only functionalities/offloads. - The PMD PF has extra work to do which will delay the DPDK app initialization like uploading the firmware and configure the Link state properly when starting or stopping a PF port. Since DPDK 18.05 the firmware upload happens when @@ -153,20 +146,25 @@ System configuration #. **Enable SR-IOV on the NFP device:** The current NFP PMD supports the PF and the VFs on a NFP device. However, it is not possible to work with both at - the same time because the VFs require the PF being bound to the NFP PF Linux - netdev driver. Make sure you are working with a kernel with NFP PF support - or get the drivers from the above Github repository and follow the - instructions for building and installing it. + the same time when using the ``nfp`` Linux netdev kernel driver. If the PF + is bound to the ``nfp`` kernel module, and VFs are created, the VFs may be + bound to the ``vfio-pci`` kernel module. It is also possible to bind the PF + to the ``vfio-pci`` kernel module, and create VFs afterwards. This requires + loading the ``vfio-pci`` module with the following parameters: + + .. code-block:: console + + modprobe vfio-pci enable_sriov=1 disable_idle_d3=1 - VFs need to be enabled before they can be used with the PMD. - Before enabling the VFs it is useful to obtain information about the - current NFP PCI device detected by the system: + VFs need to be enabled before they can be used with the PMD. Before enabling + the VFs it is useful to obtain information about the current NFP PCI device + detected by the system. This can be done on Netronome SmartNICs using: .. code-block:: console - lspci -d19ee: + lspci -d 19ee: - Now, for example, configure two virtual functions on a NFP-6xxx device + Now, for example, to configure two virtual functions on a NFP device whose PCI system identity is "0000:03:00.0": .. code-block:: console @@ -177,12 +175,12 @@ System configuration .. code-block:: console - lspci -d19ee: -k + lspci -kd 19ee: Two new PCI devices should appear in the output of the above command. The -k option shows the device driver, if any, that the devices are bound to. - Depending on the modules loaded at this point the new PCI devices may be - bound to nfp_netvf driver. + Depending on the modules loaded, at this point the new PCI devices may be + bound to the ``nfp`` kernel driver or ``vfio-pci``. Flow offload @@ -209,8 +207,8 @@ vNIC service will keep polling packets from the firmware, and multiplex them to the corresponding representor port. In the Tx direction, the representor port will prepend the output port -information into metadata for each packet, and then send it to firmware through -PF vNIC. +information into metadata for each packet, and then send it to the firmware +through the PF vNIC. The ctrl vNIC service handles various control messages, for example, the creation and configuration of representor port, the pattern and action of flow From patchwork Mon Feb 20 08:41:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Chaoyong He X-Patchwork-Id: 124172 X-Patchwork-Delegate: ferruh.yigit@amd.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 C935341CE4; Mon, 20 Feb 2023 09:42:31 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CB22A42FBC; Mon, 20 Feb 2023 09:42:18 +0100 (CET) Received: from NAM02-DM3-obe.outbound.protection.outlook.com (mail-dm3nam02on2108.outbound.protection.outlook.com [40.107.95.108]) by mails.dpdk.org (Postfix) with ESMTP id CCF6442FD6 for ; Mon, 20 Feb 2023 09:42:15 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=kGXBkqOH7ohOvYqs6T0ngUMiA5L6YDkB9Fj8+qThTKGh+b8OZjLmjvjYSGkZ6O0+r1uuUHemDNZIFzV2mAcKXi4T1XnvsBx3PeuyQFIiWVjFgtVdNMZUUS3Vd1QoJL3gQ+o7JrzZtkHo6Y2bwJVp2hETlY44KFo55yF7e+d+ZGjkAGcU8ikj3dfX6u3ibD2/S/z3udVzfKONH80xXEEveA0g1OZ65DmzvfkhBQYtGmH4zmhqsMq82+aQsXrvnSK6FHS0JPb2z7SPGgQkSI0VM7R10EkPFgvXh9Q6pkGitsNU3k9K5SQ2Uog1CuQYjnVMwTr/6Syqp34/IYKXmr/sTg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=WC7xX0IzIQk99LT6iBK6TtI5/tDifF+WACxNNWu/ZDQ=; b=VI3fsjrEvIQ4AlSwsA1LnEnfqs08hFgxHjA+S/gyG0sP7OL055IcmV3lQFZR4uJ5abO/Behnt9MUW+B8bJ5SHI0SSbdfrotf4JaVSarieKdEi2n++Kgc7f+QPlw2yYYO7QBEZvNHJtjRKx/CoZs4Va42E0c/hqy5Gu+DMSVnLIPUNdILigxNj4EqoICPMd9r7sf0J24E0xA5Gn/fpfKFbgfe8aYkvGx1LRT1BU+ITDO0lWwG4n2t/CjUyXZ3Kcl65HyjFu31CFt66VRb4QiA7m06Eya4yY/HLX74EeY28cz4q+KTTH3N34aX5XZ8pYdxIO53qb++sBeN84JWa34mBQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=corigine.com; dmarc=pass action=none header.from=corigine.com; dkim=pass header.d=corigine.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=corigine.onmicrosoft.com; s=selector2-corigine-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=WC7xX0IzIQk99LT6iBK6TtI5/tDifF+WACxNNWu/ZDQ=; b=KRECIG516QruKKuYnEW7ir7fapIm5iMnXRksUBhoUqrBoDtgo46DJKX8w4z0BU56cX708xZZHo/ILDeGsn+6ch03tQYv3udkegqfpU1DE/SAPZ6LBUu/OtuKaKf/4GWSgb8v4+c1+B8R0k2abj1Wn/nH8H3fZe+KDOFPI774Krc= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=corigine.com; Received: from SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) by SA0PR13MB3966.namprd13.prod.outlook.com (2603:10b6:806:9e::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6111.20; Mon, 20 Feb 2023 08:42:14 +0000 Received: from SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::7ea4:e421:5dd5:9f4d]) by SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::7ea4:e421:5dd5:9f4d%5]) with mapi id 15.20.6111.018; Mon, 20 Feb 2023 08:42:14 +0000 From: Chaoyong He To: dev@dpdk.org Cc: oss-drivers@corigine.com, niklas.soderlund@corigine.com, Walter Heymans , Chaoyong He Subject: [PATCH v2 3/3] doc: add Corigine information to nfp documentation Date: Mon, 20 Feb 2023 16:41:11 +0800 Message-Id: <20230220084111.40531-4-chaoyong.he@corigine.com> X-Mailer: git-send-email 2.29.3 In-Reply-To: <20230220084111.40531-1-chaoyong.he@corigine.com> References: <20230203080845.24126-1-chaoyong.he@corigine.com> <20230220084111.40531-1-chaoyong.he@corigine.com> X-ClientProxiedBy: SG2PR04CA0158.apcprd04.prod.outlook.com (2603:1096:4::20) To SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ0PR13MB5545:EE_|SA0PR13MB3966:EE_ X-MS-Office365-Filtering-Correlation-Id: 11223491-8d73-4105-5d79-08db131e5d32 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: QNVBC5jfn7nFb5h1LmYxI2GFjTdG1KwgpqQ4nWssQtW0yA3Mqe9p0ZT9HZZcoywRvee38SVa4hhm3JVQrCPFzMbeAiViuzOW8+RrBsslV8+mWGNmQ1VutWCKtsLK0kApe8JRjZaA++/SNZQZnY6C+oHxbHEkbSh/j91djPioV9CIwW7zUYCb/uxJOmGqRWDw/tjVaKRGX0uka4FAsZcd3aaEwacWuFrxSot5DR9mjn305w44gfdRX/8TOSU3sn4ibZ38KEtzIwruRCEqLYysfq1zMgQHFDezaJBkJBbDGBz8EYevpm8xZ+oLwdroivHZh3e6q8JzJYZtSDmvv5zrFexKYLDKvpcBuU0FaqHQ8G/DJN84hZRiaBX8uNV9MMEaTuBoaa7axdJRmlmYmCom8UeE1/FYVr0vZOywaL9WwlT8BubDY8QoF7h3D3AaP7bkeiHXl4p0SkqWGwaPK9CmiOkM7GyI/Sqz1yOqsPIahSAYHhZdC+DSErfD7V4f/zz/abBk1GFSpbUemAQZe6RmZifZRyDpmcF27gTP0QESdPoTleMjmZ5f2uGoDWiN4ItAgwWBFoDHFiC0XpVv9Pdpon2PGhBGd/bFTjUCdpB83O9hObHZWgLz2/IdxMGpExufoYeDvFA6AYsqLxrpBLDprntPt5eEn30FeeBL0dTwLU67+yZ5hldgOh5nPl9scWfN X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ0PR13MB5545.namprd13.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230025)(4636009)(346002)(39840400004)(376002)(396003)(366004)(136003)(451199018)(83380400001)(8936002)(5660300002)(66574015)(41300700001)(86362001)(44832011)(2906002)(52116002)(4326008)(6486002)(966005)(6666004)(6512007)(186003)(26005)(1076003)(6506007)(107886003)(316002)(8676002)(66946007)(66476007)(6916009)(66556008)(478600001)(2616005)(54906003)(38350700002)(36756003)(38100700002); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?QnAk5slngp/U1w9ZRPfYXcbhjy5r?= =?utf-8?q?C1xSjHOERiEEu0zX53NCfHY7PDGxXsGA68xFBnK4D1OceWgwdXMSQIyClm2YQFiKL?= =?utf-8?q?OyTIDi1VD5gwL1Z8MM5Pmb6cpaShx1oOGm4kr7BK00aEycb2SkKWFx3JyOacsGcuj?= =?utf-8?q?TNTdpZxckAtAkchYhbxSXxaZ1C+n8r9z543gSaGYOBXS/gzMecaBWlXF6/bInU0FM?= =?utf-8?q?uWbEU1hBLW6r6aAuBqTi7rYRVlvb9yZn9bZ0Lf77/W46yPnofCeJ7ODl2YmIXaN/q?= =?utf-8?q?uIPmfiq85D7GeLY06Kj6sj92K6UCOFBsBttbbPwSW71DrO/daApVMR/Mjhh09gWPZ?= =?utf-8?q?UlofVZaZyIuCXMoZyFbKGmg879tyuSDmliOAHOJdGpf/togrKN1u8gsPbZc9hqBYu?= =?utf-8?q?BfGxSQFp+YQ6gqCgPbAH1PvNgg0yqbHZURF6QoPS4HZT8jY6GIEa4X76miGMmz3Z5?= =?utf-8?q?bMt2rJeTsfXp521o241V7QrrUzURc1D/f4dpHmiQS+CYWIyWXUkZgh8jG9jmPDATY?= =?utf-8?q?Xt4DYVSKWQ9g1xx59XGc6q8QAeZwJeI6DF7pZjpNNYAfu7JlV856nY/wXAhJDXFIy?= =?utf-8?q?FU49nixKhGJkZr2x46l/lj6IrE6FL4DXvG1dLObl8XMaksJqxsbgMONOjrWXpltBo?= =?utf-8?q?6zPpwvVUU7th705tEEf7oGhb78gT8mMDDZeCeuvFTdM12KHlVkhJFdapwTnplbRF/?= =?utf-8?q?kdqCPu/TxrLofChhfN3g4JSx/0A/hNwk0+rQRw9FmR/r9mZjd8oVunNzqyXyIn3gC?= =?utf-8?q?gSeVpe2/qVI39kccHG9pzUWTase/lD4UvG1hnFWZodkpJ7CpVUYwHkht23nGzom0h?= =?utf-8?q?L+Yabo2EmqLNsIH3hXWSzW3wbF7fJGydwBxC4cHzQ+xnlVxwRUyyCRNmG+BgMZvVx?= =?utf-8?q?MF/jRVD+XRBeWcsYRHF1qXRxAprYxDHu0wo5HNsE94cDVWA1D6Bz1P8I0SdNXOVHZ?= =?utf-8?q?hAshDgKTMTfJmcfxUNrDqZArd2DWU727oMHjHf3IvledGdizGeXa+z8FWLHkJ8Y3Q?= =?utf-8?q?LXYYYWV9vXL+f6LkbrEMJKqN2D4RijLcUmMt3ZyMR4WIE+8q1FwsYHUy6pi7npPDy?= =?utf-8?q?AS3xpCyGYOoKJbcHoaWcPXC60OB6pAbkMna1BA66wYiIh7oUJiSXn23qNRrlrEdkx?= =?utf-8?q?HxQKCBD0dILnHoXsnB7D4c5RFZZPDNGvzCX61oUynxKkI5rpY9qszKYofIIPnXzna?= =?utf-8?q?51i/jApvGSSiJjcJcSSJWlcWKP3lii6jQgDgeAxgONg0lhMltXbHUYcLy6c3kLr39?= =?utf-8?q?h35u+sAQmJi33/KZehqqmDIl+XLUDtI4UD7o0aSiIgbuFoIRCIfxr8gW3ulARypqK?= =?utf-8?q?rSqwRWlXrha3ajuH5Olpq/wPylnn2XFmVoQsOsXjBLxbQJ5OULdDzA5oRTqnQ2dT8?= =?utf-8?q?gZfRUeNqyaT+MwPqVL+aaQGFLb1UgSNY0VpE+Mnqz8q6tcxKMGX/vQATuZd3HUtMo?= =?utf-8?q?aOuZNBxPbbdo8V865LKLGjDX3kYHegnJootA3HNT0CEmJWUVsiXdoLH1UpSeCcCnq?= =?utf-8?q?q2O8mYhLnN3lgKpW/nn512q/63KIP1La3g=3D=3D?= X-OriginatorOrg: corigine.com X-MS-Exchange-CrossTenant-Network-Message-Id: 11223491-8d73-4105-5d79-08db131e5d32 X-MS-Exchange-CrossTenant-AuthSource: SJ0PR13MB5545.namprd13.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Feb 2023 08:42:13.9085 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: fe128f2c-073b-4c20-818e-7246a585940c X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: QxJEGbz2hE3KAu4dD0Sgd3Jx+2vOOUF24fRRwqPHpVq5m4a6ELFH5kYPy5hTwaq+UeDRwSvmwvHE1JcY73GToUSsLGxLhjrrSlPpqoJTJSE= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA0PR13MB3966 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 From: Walter Heymans Add Corigine information to the nfp documentation. The Network Flow Processor (NFP) PMD is used by products from both Netronome and Corigine. Signed-off-by: Walter Heymans Reviewed-by: Chaoyong He Reviewed-by: Niklas Söderlund --- doc/guides/nics/nfp.rst | 78 +++++++++++++++++++++++++---------------- 1 file changed, 47 insertions(+), 31 deletions(-) diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index d133b6385c..f102238a28 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -1,19 +1,18 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2015-2017 Netronome Systems, Inc. All rights reserved. - All rights reserved. + Copyright(c) 2021 Corigine, Inc. All rights reserved. NFP poll mode driver library ============================ -Netronome's sixth generation of flow processors pack 216 programmable -cores and over 100 hardware accelerators that uniquely combine packet, -flow, security and content processing in a single device that scales +Netronome and Corigine's sixth generation of flow processors pack 216 +programmable cores and over 100 hardware accelerators that uniquely combine +packet, flow, security and content processing in a single device that scales up to 400-Gb/s. -This document explains how to use DPDK with the Netronome Poll Mode -Driver (PMD) supporting Netronome's Network Flow Processor 6xxx -(NFP-6xxx), Netronome's Network Flow Processor 4xxx (NFP-4xxx) and -Netronome's Network Flow Processor 38xx (NFP-38xx). +This document explains how to use DPDK with the Network Flow Processor (NFP) +Poll Mode Driver (PMD) supporting Netronome and Corigine's NFP-6xxx, NFP-4xxx +and NFP-38xx product lines. NFP is a SR-IOV capable device and the PMD supports the physical function (PF) and the virtual functions (VFs). @@ -21,15 +20,16 @@ function (PF) and the virtual functions (VFs). Dependencies ------------ -Before using the Netronome's DPDK PMD some NFP configuration, +Before using the NFP DPDK PMD some NFP configuration, which is not related to DPDK, is required. The system requires -installation of **Netronome's BSP (Board Support Package)** along -with a specific NFP firmware application. Netronome's NSP ABI +installation of the **nfp-bsp (Board Support Package)** along +with a specific NFP firmware application. The NSP ABI version should be 0.20 or higher. -If you have a NFP device you should already have the code and -documentation for this configuration. Contact -**support@netronome.com** to obtain the latest available firmware. +If you have a NFP device you should already have the documentation to perform +this configuration. Contact **support@netronome.com** (for Netronome products) +or **smartnic-support@corigine.com** (for Corigine products) to obtain the +latest available firmware. The NFP Linux netdev kernel driver for VFs has been a part of the vanilla kernel since kernel version 4.5, and support for the PF @@ -44,9 +44,9 @@ Linux kernel driver. Building the software --------------------- -Netronome's PMD code is provided in the **drivers/net/nfp** directory. -Although NFP PMD has Netronome´s BSP dependencies, it is possible to -compile it along with other DPDK PMDs even if no BSP was installed previously. +The NFP PMD code is provided in the **drivers/net/nfp** directory. Although +NFP PMD has BSP dependencies, it is possible to compile it along with other +DPDK PMDs even if no BSP was installed previously. Of course, a DPDK app will require such a BSP installed for using the NFP PMD, along with a specific NFP firmware application. @@ -68,9 +68,9 @@ like uploading the firmware and configure the Link state properly when starting or stopping a PF port. Since DPDK 18.05 the firmware upload happens when a PF is initialized, which was not always true with older DPDK versions. -Depending on the Netronome product installed in the system, firmware files -should be available under ``/lib/firmware/netronome``. DPDK PMD supporting the -PF looks for a firmware file in this order: +Depending on the product installed in the system, firmware files should be +available under ``/lib/firmware/netronome``. DPDK PMD supporting the PF looks +for a firmware file in this order: 1) First try to find a firmware image specific for this device using the NFP serial number: @@ -85,19 +85,22 @@ PF looks for a firmware file in this order: nic_AMDA0099-0001_2x25.nffw -Netronome's software packages install firmware files under -``/lib/firmware/netronome`` to support all the Netronome's SmartNICs and -different firmware applications. This is usually done using file names based on -SmartNIC type and media and with a directory per firmware application. Options -1 and 2 for firmware filenames allow more than one SmartNIC, same type of -SmartNIC or different ones, and to upload a different firmware to each +Netronome and Corigine's software packages install firmware files under +``/lib/firmware/netronome`` to support all the Netronome and Corigine SmartNICs +and different firmware applications. This is usually done using file names +based on SmartNIC type and media and with a directory per firmware application. +Options 1 and 2 for firmware filenames allow more than one SmartNIC, same type +of SmartNIC or different ones, and to upload a different firmware to each SmartNIC. .. Note:: Currently the NFP PMD supports using the PF with Agilio Firmware with NFD3 and Agilio Firmware with NFDk. See - https://help.netronome.com/support/solutions for more information on the - various firmwares supported by the Netronome Agilio CX smartNIC. + `Netronome Support `_. + for more information on the various firmwares supported by the Netronome + Agilio SmartNIC range, or + `Corigine Support `_. + for more information about Corigine's range. PF multiport support -------------------- @@ -164,6 +167,12 @@ System configuration lspci -d 19ee: + and on Corigine SmartNICs using: + + .. code-block:: console + + lspci -d 1da8: + Now, for example, to configure two virtual functions on a NFP device whose PCI system identity is "0000:03:00.0": @@ -171,12 +180,19 @@ System configuration echo 2 > /sys/bus/pci/devices/0000:03:00.0/sriov_numvfs - The result of this command may be shown using lspci again: + The result of this command may be shown using lspci again on Netronome + SmartNICs: .. code-block:: console lspci -kd 19ee: + and on Corigine SmartNICs: + + .. code-block:: console + + lspci -kd 1da8: + Two new PCI devices should appear in the output of the above command. The -k option shows the device driver, if any, that the devices are bound to. Depending on the modules loaded, at this point the new PCI devices may be @@ -186,8 +202,8 @@ System configuration Flow offload ------------ -Use the flower firmware application, some type of Netronome's SmartNICs can -offload the flow into cards. +Using the flower firmware application, some types of Netronome or Corigine +SmartNICs can offload the flows onto the cards. The flower firmware application requires the PMD running two services: