From patchwork Tue Oct 17 05:45:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chaoyong He X-Patchwork-Id: 132715 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 4621643186; Tue, 17 Oct 2023 07:49:19 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8281242D99; Tue, 17 Oct 2023 07:47:32 +0200 (CEST) Received: from NAM10-MW2-obe.outbound.protection.outlook.com (mail-mw2nam10on2092.outbound.protection.outlook.com [40.107.94.92]) by mails.dpdk.org (Postfix) with ESMTP id 6677C42D99 for ; Tue, 17 Oct 2023 07:47:30 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=oN9PcrmTgiimSgJm3DvsOGNDUxJRN1JXlxlDNX0JrstPuTh0VNPD9Ag2PfXMekKAT5CGMmbuAe3+RPn618L4cS7RQ0NRDXNHQ6WbWGHrHzi1uppm9ZChl4f8qhcRjFWc7/CxXg6jwzC5GJHQpShu6wwAUdNb7Cx9QofZAGl2sLRZsEDeySeKgtNzzdKIQIcpCT5jVV+FwgSAdOXt6CIbC+8AHbHT7Z13k6MM62T1FPMcDBB7gykE7AT8CvcoXhF6ZsJR1NolfB71KqV5mr1H/KzykcmI8UCJLg0aZ6dsKIePrmJoMk8RaxiML9bTh0pQHPQ0BQIYwNQC8FqmVByi+A== 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=2RR/IqsBOP9bQS1WS0plQi53c9S0eDytPV+wezJvEN0=; b=Qa8HgI85F3/zhrpQPa+Lss3Gzc0zJa5r9PfSdgHITSlDeIPdTtT7fwKXkUSo0NbOk2wtj8nmWF3DwUQKIlSNiEGjJXphyY57TEYEQXhBWhOhHyG+8RYFoMT/9ZZ5t3mHA3wbSbTe89cqPa/djHSn0hSXOEmthpz4ZE3E7QIWS7SFosko4NBt3VxC1Wt9o1P8Yp18MTdbUJGeUVigsquhxmbBYtHxlFmjZTArN1MwMIjzm8dZhCkNEQYKpSRCaHTWgtSDapDF1wAr9kjrqOX8bK2HLZknHNZiOEUv44CcOEd7MJ0FGnuPZU1L7hPYaZacphcIYDSjNXK41LzWjMB6eQ== 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=2RR/IqsBOP9bQS1WS0plQi53c9S0eDytPV+wezJvEN0=; b=RoMfIrLa5gG1RQQDoM/KJxmVG/+itJvyhDAR199CFiLkvMHJzP5AhMt0VN+YuzEdDlP8p90R4RsNdFSUneub3x3cYLjC7C2JWZ0fs0rf/M4Pml+yiVStkTwBNdr0WCL6ZK65IbkEYVikyXOjtZrCbK2aDWKfGyFzM7E770+UqK8= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=corigine.com; Received: from PH0PR13MB5568.namprd13.prod.outlook.com (2603:10b6:510:12b::16) by SJ0PR13MB5272.namprd13.prod.outlook.com (2603:10b6:a03:3e3::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6863.46; Tue, 17 Oct 2023 05:47:28 +0000 Received: from PH0PR13MB5568.namprd13.prod.outlook.com ([fe80::b070:92e1:931e:fee7]) by PH0PR13MB5568.namprd13.prod.outlook.com ([fe80::b070:92e1:931e:fee7%4]) with mapi id 15.20.6863.047; Tue, 17 Oct 2023 05:47:28 +0000 From: Chaoyong He To: dev@dpdk.org Cc: oss-drivers@corigine.com, Chaoyong He , Long Wu , Peng Zhang Subject: [PATCH 25/25] doc: add the common and vDPA document Date: Tue, 17 Oct 2023 13:45:45 +0800 Message-Id: <20231017054545.1692509-26-chaoyong.he@corigine.com> X-Mailer: git-send-email 2.39.1 In-Reply-To: <20231017054545.1692509-1-chaoyong.he@corigine.com> References: <20231017054545.1692509-1-chaoyong.he@corigine.com> X-ClientProxiedBy: PH7PR17CA0069.namprd17.prod.outlook.com (2603:10b6:510:325::29) To PH0PR13MB5568.namprd13.prod.outlook.com (2603:10b6:510:12b::16) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: PH0PR13MB5568:EE_|SJ0PR13MB5272:EE_ X-MS-Office365-Filtering-Correlation-Id: 669ef01d-528b-4b3a-ed4d-08dbced48ba7 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: nYoVljWxrejmZfBgSzqJRO2jlkP8pnsdBEkln29yDeCSRWq+Ikr2n0sgodKCgNEQcrB5J1GK3KLWDPg+sP4kP7uXn7mKTFrfYEsBM96RI32xly2eW3i6X9Eox7/JNSZaeo5ZTGiVHmlwLLy2ideg8M+fZL6ubFEHBn8NUMahxxRQFnsWVHCPBz2FhNapQZY+is1OFGucTtyNxM9IyecTxy1m2f/nLvnzaTYZrrcUU3MLsYW3IOxt/HwMVdzY4Gk44ey97K2VQVTqtKv+e0CRFXQBce/7QnfYwzv6APKGudHRLizOQqcuSKZgUC0qeXeCtESHfpJMM4w3dDKFgqvZkCKpYShD9V5yBNR9hrCf6urI7+P92GZb4IvfU/WvXyJELsO0D2nZQYbWBbA/dRPppS0GVnXO91+iScqzGTx/wj9FonNAEGLiTYvGF2Twdf///DIIEXP1Plhnu+yhVJZQ9ac6U2vnH4MXZeCMw+yeax4jAfGyiMgeMHEOBJpRQj2Ai6bfexMumnDj7usaXYiYp8tLSMDpUS/hFOs9PBkIyZHUDcdiSx2YQA+OeAKqetSh25WNwgKaw97aCShsBE3pcBuwnppT/EDqC0NpWXC0bFz8Wd9019m1juuVrMy63Lr/ECSg6OEK4im9ONjlWdy8bC+HECvhHM3Dz2TGT4ubtAE= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PH0PR13MB5568.namprd13.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(366004)(136003)(376002)(346002)(396003)(39830400003)(230922051799003)(451199024)(64100799003)(1800799009)(186009)(38350700005)(6916009)(66476007)(6666004)(66556008)(66946007)(6486002)(86362001)(54906003)(2616005)(83380400001)(478600001)(6512007)(38100700002)(316002)(1076003)(52116002)(26005)(107886003)(5660300002)(6506007)(2906002)(4326008)(8676002)(36756003)(44832011)(41300700001)(8936002); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: m2SQB7LyAU6i/T68SZgFakNYsBEhJd3qxt8KNmy5Jc2Xh7WhiCzTiNyvdzOx+JpDvD5jh5XeZmg/2SX80qxkBtMN60gvI8gvjCtscarvtLaW+d5+93pP6wuNlaUW0IOJzzBHJJD61QeITOhjh7lSacfcQsozO6ZXHSLdvCH4UDwX8NEql/ctXWwO+Jd6N5eozcm8LhsusoVHd4QqVqHLFY2Lo0wd2A2nEJzyOOl5pQFQOprJ4uft8UdK5ccPtGMZS36VpH7ItvDrsFqPKwLdTBicRoBXDrdJVukRNihLirzX2xhQG2W5sN6XKATP4UIsv5erQGBFS9NMD2UPvvtNEalhbC3wD1k1QJGQF3e6yHWnuZ29vC4mn8kSzKvaeSV1qety10p2kxXiMfcC7dBhqPsFU6cUMckhxRgryEGAodxqy88uPa6vcC24PjDIwDHyEFYF1Kwac8Gwz79bBbKxvPOEpdftC5sZcxuVZ2yPoA8JcXszzTbDu+UXfIE5/U7bCMr3/2s79rMpLRAPJfgSzi7ZaDwIF6K+LHIBaNFhNDdQK29E/ZWtnYEXv4Jq7cxMCsyUBLEnF09efO/8VMtfbwiW8ZUpX/UqPMmN58I0p+nEgc3m2kgGhFO5rr+3OHg6rGbTw7gM0lrc7PNJzF1NOpx3crP2167rY8jMsiDuijf+CLjYO6luefpF7Ns/KCODl4Lp2omXUoUTVxA5XUvSiu/8MDXm2jRVO02d0ANjCdow2eCN/YTqeAjMOhPgwJVJJutL4mKXEUC38iURscE6WMrf5RJc9cYk1/rp+DwGoAwVU4maEeeShRIov/4juWo1nQzqFiUWA45a0j/dvyrBWbq97pi1uKBcTUsHZNJ+W9LceQwL1BCSJs4hMOf+5ujtQLAnH50Q1nw2Rx4YngALYyRqwaAJxebWWRqLlMfFSzEPvcqq1HrHoX4Wsz6L8+GWsxK54EL6vMRzpJvpd6dQCWVc3W0e+zx/JH/EW3o+NY5Y9rI+2n1uLW2WNhXEU2DHzpLZy76ndxirtQHe7MbkQCkfHdH0Rzsn/fTuf+GPmP2X8M7UfZBY7K52XumYCYGIxatddal4QtQaC3LutBN5R1q3LsjPlN8hQuDwLmC2WeVy/8o7jAJDt4fYHtlac7cs216X7aiTYTXSXO5ASNyZ3tkzi6Gg+HO8dmcf+FJVXXtZG0OJ+rWNRiATmfvR6pXtG3zWzG7yv6GLBiezfZ6NtQsrH/IrpKR2N2EuFTKnd+yohc88F+8Hs9ACJxlo0K30PNUo/0+X7X1AZMlvbnTdPFEcEnsWi4hHx/dO316tMyyZFOmRjHPVoJfwLatcgc/FzcHpKUUTID9QDWWRF0HqF//s4vTMGfP7NL8kkznD3RozGmd7lFcHzaEuTzgNbs782KUh5u99RtblgTfTpi9HUMixcbPblv0InkhmKpg5C4JlAl9II7MqgfWFcu/TMn167R0+nUR+1QLFFUFvImvrhbPrJ1HOyDyKTOQURK8MGkJPYKU+5m0lmnUjl2QTbLHsxyPWVo6uhtiV5H8Uc10GT3qM8fyptcFCTdU8k09q0jH0ZpqCxVxFevGFWgw4dDkBj2dIL9LSBYLjCw5ozNmNnA== X-OriginatorOrg: corigine.com X-MS-Exchange-CrossTenant-Network-Message-Id: 669ef01d-528b-4b3a-ed4d-08dbced48ba7 X-MS-Exchange-CrossTenant-AuthSource: PH0PR13MB5568.namprd13.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Oct 2023 05:47:28.6547 (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: +wrYw7VfAJegKSpi9wJ9WXRWBXA3QTORXAVrBvtA/IIcdNhpD0wXaboFj9Nzn82M81rNENUpbvQ2o5CB9w3ti790uRiG2ACOe0w7YELn+6Y= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR13MB5272 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 Add the document for nfp common library and vDPA PMD. Signed-off-by: Chaoyong He Reviewed-by: Long Wu Reviewed-by: Peng Zhang --- MAINTAINERS | 8 ++++ doc/guides/platform/index.rst | 1 + doc/guides/platform/nfp.rst | 30 ++++++++++++++ doc/guides/rel_notes/release_23_11.rst | 5 +++ doc/guides/vdpadevs/features/nfp.ini | 8 ++++ doc/guides/vdpadevs/index.rst | 1 + doc/guides/vdpadevs/nfp.rst | 54 ++++++++++++++++++++++++++ 7 files changed, 107 insertions(+) create mode 100644 doc/guides/platform/nfp.rst create mode 100644 doc/guides/vdpadevs/features/nfp.ini create mode 100644 doc/guides/vdpadevs/nfp.rst diff --git a/MAINTAINERS b/MAINTAINERS index 80e071d13e..4891bb6203 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -904,9 +904,11 @@ F: doc/guides/nics/features/nfb.ini Netronome nfp M: Chaoyong He M: Niklas Soderlund +F: drivers/common/nfp/ F: drivers/net/nfp/ F: doc/guides/nics/nfp.rst F: doc/guides/nics/features/nfp*.ini +F: doc/guides/platform/nfp.rst NXP dpaa M: Hemant Agrawal @@ -1310,6 +1312,12 @@ F: drivers/vdpa/ifc/ F: doc/guides/vdpadevs/ifc.rst F: doc/guides/vdpadevs/features/ifcvf.ini +Corigine nfp vDPA +M: Chaoyong He +F: drivers/vdpa/nfp/ +F: doc/guides/vpdadevs/nfp.rst +F: doc/guides/vdpadevs/features/nfp.ini + NVIDIA mlx5 vDPA M: Matan Azrad M: Viacheslav Ovsiienko diff --git a/doc/guides/platform/index.rst b/doc/guides/platform/index.rst index b1ba11df73..07dd273821 100644 --- a/doc/guides/platform/index.rst +++ b/doc/guides/platform/index.rst @@ -15,4 +15,5 @@ The following are platform specific guides and setup information. dpaa dpaa2 mlx5 + nfp octeontx diff --git a/doc/guides/platform/nfp.rst b/doc/guides/platform/nfp.rst new file mode 100644 index 0000000000..f6c7be6fff --- /dev/null +++ b/doc/guides/platform/nfp.rst @@ -0,0 +1,30 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright (c) 2023 Corigine, Inc. + +NFP Common Driver +================= + +The NFP common driver library (**librte_common_nfp**) provides support for +the Netronome and Corigine's NFP-6xxx, NFP-4xxx and NFP-38xx product lines. + +Classes +------- + +One NFP device can be probed by a number of different PMDs. +To select a specific PMD, its name should be specified as a device parameter +(e.g. ``0000:08:00.1,class=eth``). + + +Supported Classes +~~~~~~~~~~~~~~~~~ + +- ``class=eth`` for :doc:`../nics/nfp`. +- ``class=vdpa`` for :doc:`../vdpadevs/nfp`. + +By default, the NFP device will be probed by the ``eth`` PMD. + + +Limitations +~~~~~~~~~~~ + +- ``eth`` and ``vdpa`` PMDs cannot be probed at the same time. diff --git a/doc/guides/rel_notes/release_23_11.rst b/doc/guides/rel_notes/release_23_11.rst index d0c8b8364c..64e1e113a7 100644 --- a/doc/guides/rel_notes/release_23_11.rst +++ b/doc/guides/rel_notes/release_23_11.rst @@ -158,6 +158,11 @@ New Features * Added inline IPsec offload based on the security framework. +* **Add new vDPA PMD based on Corigine NFP devices.** + + Added a new Corigine NFP vDPA (``nfp_vdpa``) PMD. + See the :doc:`../vdpadevs/nfp` guide for more details on this driver. + * **Updated Wangxun ngbe driver.** * Added 100M and auto-neg support in YT PHY fiber mode. diff --git a/doc/guides/vdpadevs/features/nfp.ini b/doc/guides/vdpadevs/features/nfp.ini new file mode 100644 index 0000000000..d830feafe0 --- /dev/null +++ b/doc/guides/vdpadevs/features/nfp.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'nfp' vDPA driver. +; +; Refer to default.ini for the full list of available driver features. +; +[Features] +Linux = Y +x86-64 = Y diff --git a/doc/guides/vdpadevs/index.rst b/doc/guides/vdpadevs/index.rst index cc2f858042..b0191a3a1d 100644 --- a/doc/guides/vdpadevs/index.rst +++ b/doc/guides/vdpadevs/index.rst @@ -14,4 +14,5 @@ which can be used from an application through vhost API. features_overview ifc mlx5 + nfp sfc diff --git a/doc/guides/vdpadevs/nfp.rst b/doc/guides/vdpadevs/nfp.rst new file mode 100644 index 0000000000..63636b2882 --- /dev/null +++ b/doc/guides/vdpadevs/nfp.rst @@ -0,0 +1,54 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright (c) 2023 Corigine, Inc. + +NFP vDPA driver +=============== + +The NFP vDPA (vhost data path acceleration) driver (**librte_nfp_vdpa**) +provides support for the Netronome and Corigine's NFP-6xxx, NFP-4xxx +and NFP-38xx product lines. + +NFP vDPA implementation +----------------------- + +NFP VF device can be configured in the net device or vDPA mode. +Adding "class=vdpa" parameter helps to specify that this device is to +be used in vDPA mode. If this parameter is not specified, device +will be probed by net/nfp driver and will used as a VF net device. + +This PMD uses (common/nfp) code to access the device firmware. + +Per-Device Parameters +~~~~~~~~~~~~~~~~~~~~~ + +The following per-device parameters can be passed via EAL PCI device +allowlist option like "-a 02:00.0,arg1=value1,...". + +- ``class`` [net|vdpa] (default **net**) + + Choose the mode of operation of nfp device. + **net** device will work as network device and will be probed by net/nfp driver. + **vdpa** device will work as vdpa device and will be probed by vdpa/nfp driver. + If this parameter is not specified then nfp device will operate as network device. + +Dynamic Logging Parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +One may leverage EAL option "--log-level" to change default levels +for the log types supported by the driver. The option is used with +an argument typically consisting of two parts separated by a colon. + +Level value is the last part which takes a symbolic name (or integer). +Log type is the former part which may shell match syntax. +Depending on the choice of the expression, the given log level may +be used either for some specific log type or for a subset of types. + +NFP vDPA PMD provides the following log types available for control: + +- ``pmd.vdpa.nfp.vdpa`` (default level is **notice**) + + Affects driver-wide messages unrelated to any particular devices. + +- ``pmd.vdpa.nfp.core`` (default level is **notice**) + + Affects the core logic of this PMD.