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 0F4C3431EB; Tue, 24 Oct 2023 04:33:11 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 71E5942E20; Tue, 24 Oct 2023 04:30:31 +0200 (CEST) Received: from NAM11-DM6-obe.outbound.protection.outlook.com (mail-dm6nam11on2105.outbound.protection.outlook.com [40.107.223.105]) by mails.dpdk.org (Postfix) with ESMTP id 9FB2142E0E for ; Tue, 24 Oct 2023 04:30:26 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=dhl2w4XcwpTt1ELfgopXyXnc1VyTudvTtpYFrbN2f0TLk2h3PEjvVQHwB+ayCFf/iF7+ZCw4j+ZIFCcoS8XllvuAKQETt3oaJ3DJnOkCxQOsjo4GvQXpVGtEnJA4n8TOBi/DYY9H5B8ecnZq1clPXMl4m3ADQd0fBazp0fgvWHN4CVgHUieVQ3Z1VH5uBiMhSV+6NFDL6fcsRtu69MKgUhWWhFmIS/L3yCW4AWTlXa+QudYcqmjFQW1ZJIzJVszAyi6kaflwHn5uWtC3vcDm073L1lDBhY7CxgHoOEvhxSc/5hk4XtUAUzdNPIWHMrdduO2xMhLaAiYnbU+yhhz8IQ== 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=wMR5ZTLjtpZwansAMbNMFQkD6Ynr32QT/2YjSibo8TA=; b=kv9hCnnP6F5iXA1CMbr9QZLumzvvIa3Ebjc45wYcoQbvCVbEmkGDGX9cGaKHYmskq42yU5qZZbYbL/kERQTATyBF2xtFb3hOKp/34of6tVzv+StjMbzfT1sQUJPk8EvC4q/GsRHJwNHmK/RGo/ogknf6LmN6joiw/5JYDpvHtEKQ4Oo8utzxvRbnz3iX1SM8izB9BLQOzSf37pShym/c2dis0vBi2IeKxUJQhqIavpgPYdATmNdxN5VBc7N7b2NYul3u8As+CVY8yt+oQHRjw/1PedOh3s67qpvYLxkl9uAbDsXBG/RORJ0LxRl/IUOrtzX6ZHT26nOQ5j+5Dp/jGA== 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=wMR5ZTLjtpZwansAMbNMFQkD6Ynr32QT/2YjSibo8TA=; b=caLZGLhPsbzKxyqAZyQqJz7yghsWoy+WeA9UVbydonGak+LIzH2ORF+yua9YTwGDyvwF6CTXi0fT+jCkukKPwRAA9hZH8EMACEf/6YRRIp71Rbs1OMypKoi9ctN/8e6gUzXnM9xouCyVj3mbH/Wh8UMDlgboarzpMa1JcIItAdc= 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 PH8PR13MB6182.namprd13.prod.outlook.com (2603:10b6:510:259::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6907.21; Tue, 24 Oct 2023 02:30:25 +0000 Received: from SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::142e:d47c:7320:8a9d]) by SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::142e:d47c:7320:8a9d%4]) with mapi id 15.20.6907.021; Tue, 24 Oct 2023 02:30:25 +0000 From: Chaoyong He To: dev@dpdk.org Cc: oss-drivers@corigine.com, Chaoyong He , Long Wu , Peng Zhang Subject: [PATCH v2 25/25] doc: add the common and vDPA document Date: Tue, 24 Oct 2023 10:28:49 +0800 Message-Id: <20231024022849.3092506-26-chaoyong.he@corigine.com> X-Mailer: git-send-email 2.39.1 In-Reply-To: <20231024022849.3092506-1-chaoyong.he@corigine.com> References: <20231017054545.1692509-1-chaoyong.he@corigine.com> <20231024022849.3092506-1-chaoyong.he@corigine.com> Content-Transfer-Encoding: 8bit Content-Type: text/plain X-ClientProxiedBy: BYAPR04CA0015.namprd04.prod.outlook.com (2603:10b6:a03:40::28) To SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ0PR13MB5545:EE_|PH8PR13MB6182:EE_ X-MS-Office365-Filtering-Correlation-Id: fb22f913-540a-48ce-1d2c-08dbd4392dab X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: PstLGlvbifzQId7IeRZXxvsISnmBal1zfjUr17bhmURAfXEjDEQ6eFMRgrpsF3HmnITa7WXUo3ac09/rtYPCCO2j8V+3YaSncVVgP8SKTpEmpZUw7ewpgZE3v53RRqxwbSlkjbBm7hcivpjQ4MfKZgx8rKNx3Fm9164xtninGnYC9uDSl2e0vZiyk1bu7inzAnnTX19rFrm0Ya0rLIJwXC8wO04777snQbgJQp3Y1Hvms/tzOFKuVCcRWwGahKt7susjaAgBriyRjFsQ+oP3TQNN93/fXAZrYDMBGQytIr4mlhGoyMc4jGF8/ZPYgzYEBWj0lthzGSfVQHQMwuKymmjkg9E77rriSoMhlaWLJb9gidXw/2KeOS+1hQbnwu7zy9rWfocRhrqR1NFWN+ftx+L6kJkaQkTmM2r9FO6wLtaBNEJWueUumMxBlsTpwPTIc046oYSfaatIayo7CMo3krmkj7IK/vMfv/oZfm473a631aUT/GLvTPxfmNQWtyOfE0popYA7uOqrtSeh2G2lleQ4hIJThDpJwLamtDCih8Cb5iWTTLIDVJ0/hEQ3dx2m1j1uNoMou0CcXdttJpknpV14fUZTnKl8KviJUFe7zABUzVmfKsVnsx7YxjKS0HgxQ90q4sdmpp3fpLk5K7qQ4FFp2W32xXp1YOPKCPWhCE4= 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:(13230031)(366004)(396003)(376002)(39830400003)(346002)(136003)(230922051799003)(1800799009)(64100799003)(186009)(451199024)(86362001)(66946007)(316002)(2906002)(54906003)(66476007)(6916009)(66556008)(5660300002)(8936002)(44832011)(8676002)(4326008)(36756003)(41300700001)(2616005)(38100700002)(478600001)(1076003)(52116002)(6506007)(107886003)(6666004)(38350700005)(6512007)(26005)(83380400001)(6486002); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?W7HCiXlSuIqas0CtC3Xp9xaUfdy8z3CTSjmlhMhJBYASvO1hWgU6GotAukZI?= =?us-ascii?Q?t39ojHWY48DEg65BwHsSMXI+vPbai5GOE4fnSgLF0qiEfcCnS8hmOIOECzGa?= =?us-ascii?Q?59tqeP+KpfMJkSrIsxrneUr8sckyaZOhB8zq6Qxcv9FMJqtd0IiIE1DbnGei?= =?us-ascii?Q?DTeObp/jSmx+g5DTlnub2s/YqEuneuOQxmv01mheRRUKa449oRzaB2UxBxNf?= =?us-ascii?Q?mAYh36lLWIpHojb88h3y+coMAR26tSd8n0PMTcfUkdKe3Ae5aysArsd1JnPl?= =?us-ascii?Q?CXkQP9xQ/ap1P6zHY57l2QjZIOu/FZp5Xil+aeumxnf8Q5AAHO+ZU3tXcyNf?= =?us-ascii?Q?ikXHVH59DfBY/FR/pKXfF31eCqIdA9hjgPkKpr7xlxSgMLlGIjy+V5NV6koG?= =?us-ascii?Q?5vXbPUwCej7GtPdUGiFYdsWbAqZTitrzP3JFEAyi42NnNoO4shNH5ODGFIpA?= =?us-ascii?Q?1assTMOO58Qbh5LSEMTACC599QKVj6JYsRVq6iqJ/x+mZZ37ki60tvhMxwSY?= =?us-ascii?Q?B1s6PKHLTlZXUo2Mmy5RtBYCCK7+GjdYJ1Cees2xYURw6dqn16xe6ISA5E1E?= =?us-ascii?Q?HGxy5vD7i/b0E1yBceQ8LdOcgvHGpY2Yl7xdJgnarTjLGMAwkD+UiW3peeLV?= =?us-ascii?Q?Pp322KpwsbjiwFB5BSzTbm4zNkjzUGY1/4sdPRfJy29YrUIZ2BRSDMRGwYtI?= =?us-ascii?Q?nezWLdzEtACESTFyzkKTG6/Zr4Eq7kce+AKCVz08CxQyMhoOgQbqOhheiyj5?= =?us-ascii?Q?AerIo1+vPcl+yBhFBt9M9mtY4KSHurKVw4lTPAIRKS24lijI807+E8lXugrY?= =?us-ascii?Q?57YlZFgNP/7A3vc1bHXmZ7DyOmGZWwbeskO1qUhhtC7j9qBN0yAs7Tu7VUYc?= =?us-ascii?Q?7yH1+Zci9aG/R11RgCRilVvLQxwJt+zQ0L72u8yoedRPTfTbWZofHzCJQYyl?= =?us-ascii?Q?vR90N1/b9zF7DqhKw/BtQFoTZh74jSie2FJbNzoCL/zIGzlsfeMhszUOuNZW?= =?us-ascii?Q?py5eZysSG+YeAVcR9uzx8mZzbLgZXFcqCVfArVln07wYwHomU5y60sLdJnAy?= =?us-ascii?Q?3FAToFsk4QNcvXAL8rgtatkbxkQ035uNow5z/iVfPAj2WcX/GafkMu2Z0JxH?= =?us-ascii?Q?MOH84YQfcBf1GRn56uMf7VnTfsOBQKenGxcATtSCQroAKV3Cf/YsbJo4zKJM?= =?us-ascii?Q?UZ3wG6qjjR5jKKxFdDcgUMMTE1vUSeIcbUi1ksTUkbC2AFYnGv7LDAXeEleL?= =?us-ascii?Q?BjG0hOeGZPQufAGSqN4RihA/duWue/UuKfFJzFQBsLJNqWckRkUgNJMbQYFe?= =?us-ascii?Q?n6BykIREPdWy1TEZhvYkgURVGTSDFxQZW4vqYKozj3kxQVFOu8k92XE+17BA?= =?us-ascii?Q?+YVNY1R7tQh+GiAO6FOrQrguRTiVGOHuMNGH5Phnn2nrvLakK+3gV4GmoJTK?= =?us-ascii?Q?AKpjDQUpUk3qluaNMfeFMjn78a0t+D+lTbHevHueXWKsTEgAVH27GtlsrEYn?= =?us-ascii?Q?h0BCdupV5rXln9GpslqWNZXtwMYuSuLFTvgLjLJwC/io1raBPun54FLVpLmg?= =?us-ascii?Q?yDs3ZWimhTlnWfj1F2EA4lVT6UVvgXEd9ok4IqlGkTaHJ4X4lEMbjHB+OIgh?= =?us-ascii?Q?xw=3D=3D?= X-OriginatorOrg: corigine.com X-MS-Exchange-CrossTenant-Network-Message-Id: fb22f913-540a-48ce-1d2c-08dbd4392dab X-MS-Exchange-CrossTenant-AuthSource: SJ0PR13MB5545.namprd13.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Oct 2023 02:30:25.0479 (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: McVuuqkPpIBr6LGy6SOoDJj0ufdtlAQCxNTFStntmWDC7lY9pwIIhxSqv9HVixXP+1TUlv4U1T3LXXKcn0B2CVP/0bMkaAh/Nxk0wPF+O68= X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH8PR13MB6182 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 4083658697..b28cdab54c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -900,9 +900,11 @@ F: doc/guides/nics/features/nfb.ini Netronome nfp M: Chaoyong He +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 @@ -1306,6 +1308,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 0a6fc76a9d..f6dde6fb9d 100644 --- a/doc/guides/rel_notes/release_23_11.rst +++ b/doc/guides/rel_notes/release_23_11.rst @@ -153,6 +153,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. -- 2.39.1