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 C4468427FC; Wed, 22 Mar 2023 01:02:20 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 84EAA42D63; Wed, 22 Mar 2023 01:00:20 +0100 (CET) Received: from NAM11-BN8-obe.outbound.protection.outlook.com (mail-bn8nam11on2040.outbound.protection.outlook.com [40.107.236.40]) by mails.dpdk.org (Postfix) with ESMTP id 5260142D41 for ; Wed, 22 Mar 2023 01:00:11 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=M3B9u3Fnl83RBw+xAw5rLJKOG4vXMpFNftIsVHNgvciBkR9ZRCIF1Big9WwfgQWuHZceahpPipqRxijauS/L9TrV4AGu0//8IglsNY8ekp+6bKu1zySWKRZ/ogqal1LGdK4xSqunqvbrM+Qonz1VpaIcWOn0/CTdd31tj8ntd2RZhJYTGZemxwgy9tOvRk1a2cPLajRhNOMN6i3FpBCzk2r7ZLH2g2fCT6sE+PBwnlkJs3N88brgcyfZh3+xCzS969pW1udO9a1FJefWn/h4lRD9KUsvjckkLz4pWZ3m9J99wPOqxRXGJu+fzLHMxZUWtqLfu1RU/b12acAFjmDG6A== 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=F1sZweTN2nt2mE2zB0lT5lq8UqNYEk2KhvTtPUdKkII=; b=UHzhpqxGGYKgDwqZk9bVuOSjYClpLR6UBw78Jh40uYGUwruUhJptTs8q5sS8QVu689t4BkpNJyFVHkmwnwFFi2r9o+I34OZcg0hKI9cbyGjaG07IGtcMlzWXRVhol8aw7jnmgVN7NFtKiZImCW8lQ/ll+umsypWMCMOhI6WtulUnh1YAx6b4uY0sVFqFt+dD5MjthABf4SB2Guk4N/e/uuqW9c54df65OvurzVM03hpuiy7T71mINJmbz3/ZUfwbsnFjXcP+uj0rVkL5szLgfZq9yvmXAbLTEb8k4ixHaCFBekhZgbk02YKk6v1iKKFjV7r+mBwXUCGUaQJ/pvj1hg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=intel.com smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=F1sZweTN2nt2mE2zB0lT5lq8UqNYEk2KhvTtPUdKkII=; b=aGUbWV3pYIAAy/z66qOqJN332ul4EYRkyclUI0b8vohq/CUKSJbpdbbFx0xOXUS01WC19k5VHY8LlJPJU+sCMtMh1cVpRsyG7nYTHRo286K9GwGSRk7zeIZm5yYcBbeOQRg99amYp0dfEU/SQclNPqUXeDUlio/6QqJ9YcTZ6Ys= Received: from BN9PR03CA0340.namprd03.prod.outlook.com (2603:10b6:408:f6::15) by CY5PR12MB6057.namprd12.prod.outlook.com (2603:10b6:930:2e::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.37; Wed, 22 Mar 2023 00:00:09 +0000 Received: from BL02EPF000100D3.namprd05.prod.outlook.com (2603:10b6:408:f6:cafe::26) by BN9PR03CA0340.outlook.office365.com (2603:10b6:408:f6::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.37 via Frontend Transport; Wed, 22 Mar 2023 00:00:09 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C Received: from SATLEXMB04.amd.com (165.204.84.17) by BL02EPF000100D3.mail.protection.outlook.com (10.167.241.207) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.6178.30 via Frontend Transport; Wed, 22 Mar 2023 00:00:08 +0000 Received: from telcodpdk.amd.com (10.180.168.240) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.34; Tue, 21 Mar 2023 19:00:06 -0500 From: Ferruh Yigit To: John McNamara , Matan Azrad , Viacheslav Ovsiienko CC: Thomas Monjalon , Andrew Rybchenko , Subject: [PATCH 19/33] doc: update mlx5 guide Date: Tue, 21 Mar 2023 23:59:27 +0000 Message-ID: <20230321235941.2169068-20-ferruh.yigit@amd.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230321235941.2169068-1-ferruh.yigit@amd.com> References: <20230321235941.2169068-1-ferruh.yigit@amd.com> MIME-Version: 1.0 Content-Type: text/plain; charset="true" Content-Transfer-Encoding: 8bit X-Originating-IP: [10.180.168.240] X-ClientProxiedBy: SATLEXMB03.amd.com (10.181.40.144) To SATLEXMB04.amd.com (10.181.40.145) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: BL02EPF000100D3:EE_|CY5PR12MB6057:EE_ X-MS-Office365-Filtering-Correlation-Id: 1e57a31b-4dc4-4759-675e-08db2a6866a6 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: Xc0CUO6aMSLeppji5LUMtRO4t/5mP6tYzyPJLOMMd72j9MbM+967KbE4xZ0PvKZdWbLuBih0FcwWRw/TbOEbNkbqprBigJ4rJwVqtesDAXYGWllTbDf+SkvSAL/JatG4tBmmxv1toXu7ZmHGjfk7GvxKa+VnmwTUVOf8RXr7kpH0mKyvQOomeuHebQxuTgMudBOl96E1S3ohQ8hwuN/9JGh0tvB7vRRm9Vr6W6cvecxHAlEUZjWesZMb0Dz3rkyNPFnD4PD6ezwgXOnJ3ziF2HPyoCYamiatdorxcs7ufCtd/6qVr9y3hK4wNYagXg9JcA9+K2fPfNzOowg1xvWn37IEWc/P9A8tsi4p5d72wkHF5CBFxAcXmd92FKMh2mTGIKewmOwb89bZBiHGWiZidXzNfC7q8Nw+eDBvRqgIHlyO/Nd228pSiInpXu0TFT6NR3dO8kkfJYS+REnPemm9P0R8kg6TKzJwE54WYNoabu3rZt1Q6+JhOk0D19G3EdLSGmvUxdjXD5lWxepKVzpPGKcKNyhYvsG5pMxT2zPWqCT1L0oDhOyDdHYWX7dgZpcnMXch7veFa3ui7IMJnUsASNxk7ts7a7V5SaoY9ktE4vZ8MPgT2RI5x8z0Xhzf/a63qPhBx27QfKUEbLsr+FhxR7S+hd8utl8CtzGQWnsaMpkpWPUAxe/uvrbNsDaIUsgbVQl+zRyudh97VZnAr+sxreOwzJ8Y/+yq51Wrpzmm4Z0= X-Forefront-Antispam-Report: CIP:165.204.84.17; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:SATLEXMB04.amd.com; PTR:InfoDomainNonexistent; CAT:NONE; SFS:(13230025)(4636009)(136003)(346002)(39860400002)(396003)(376002)(451199018)(40470700004)(36840700001)(46966006)(86362001)(6666004)(316002)(336012)(356005)(83380400001)(426003)(47076005)(1076003)(16526019)(186003)(2616005)(81166007)(26005)(82740400003)(82310400005)(44832011)(41300700001)(70586007)(4326008)(8676002)(40460700003)(36860700001)(8936002)(5660300002)(54906003)(36756003)(2906002)(7696005)(110136005)(70206006)(478600001)(40480700001)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Mar 2023 00:00:08.9891 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 1e57a31b-4dc4-4759-675e-08db2a6866a6 X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d; Ip=[165.204.84.17]; Helo=[SATLEXMB04.amd.com] X-MS-Exchange-CrossTenant-AuthSource: BL02EPF000100D3.namprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY5PR12MB6057 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 - Move "Supported NICs" section up - Rename "Driver options" section to "Runtime Configuration" - Rename "Testpmd" section to "Testpmd driver specific commands" Signed-off-by: Ferruh Yigit --- doc/guides/nics/mlx5.rst | 116 +++++++++++++++++++-------------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 7960a42e9cfc..ee654392ca0a 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -21,6 +21,60 @@ for **NVIDIA ConnectX-4**, **NVIDIA ConnectX-4 Lx** , **NVIDIA ConnectX-5**, **NVIDIA BlueField-3** families of 10/25/40/50/100/200/400 Gb/s adapters as well as their virtual functions (VF) in SR-IOV context. +Supported NICs +-------------- + +The following NVIDIA device families are supported by the same mlx5 driver: + + - ConnectX-4 + - ConnectX-4 Lx + - ConnectX-5 + - ConnectX-5 Ex + - ConnectX-6 + - ConnectX-6 Dx + - ConnectX-6 Lx + - ConnectX-7 + - BlueField + - BlueField-2 + - BlueField-3 + +Below are detailed device names: + +* NVIDIA\ |reg| ConnectX\ |reg|-4 10G MCX4111A-XCAT (1x10G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 10G MCX412A-XCAT (2x10G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 25G MCX4111A-ACAT (1x25G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 25G MCX412A-ACAT (2x25G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX413A-BCAT (1x40G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX4131A-BCAT (1x40G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX415A-BCAT (1x40G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX413A-GCAT (1x50G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX4131A-GCAT (1x50G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX414A-BCAT (2x50G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX415A-GCAT (1x50G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX416A-BCAT (2x50G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX416A-GCAT (2x50G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX415A-CCAT (1x100G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 100G MCX416A-CCAT (2x100G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4111A-XCAT (1x10G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4121A-XCAT (2x10G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4111A-ACAT (1x25G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G) +* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 40G MCX4131A-BCAT (1x40G) +* NVIDIA\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G) +* NVIDIA\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G) +* NVIDIA\ |reg| ConnectX\ |reg|-6 200G MCX654106A-HCAT (2x200G) +* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G) +* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 200G MCX623105AN-VDAT (1x200G) +* NVIDIA\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G) +* NVIDIA\ |reg| ConnectX\ |reg|-7 200G CX713106AE-HEA_QP1_Ax (2x200G) +* NVIDIA\ |reg| BlueField\ |reg|-2 25G MBF2H332A-AEEOT_A1 (2x25Gg +* NVIDIA\ |reg| BlueField\ |reg|-3 200GbE 900-9D3B6-00CV-AA0 (2x200) +* NVIDIA\ |reg| BlueField\ |reg|-3 200GbE 900-9D3B6-00SV-AA0 (2x200) +* NVIDIA\ |reg| BlueField\ |reg|-3 400GbE 900-9D3B6-00CN-AB0 (2x400) +* NVIDIA\ |reg| BlueField\ |reg|-3 100GbE 900-9D3B4-00CC-EA0 (2x100) +* NVIDIA\ |reg| BlueField\ |reg|-3 100GbE 900-9D3B4-00SC-EA0 (2x100) +* NVIDIA\ |reg| BlueField\ |reg|-3 400GbE 900-9D3B4-00EN-EA0 (1x100) + Design ------ @@ -670,8 +724,8 @@ Firmware configuration See :ref:`mlx5_firmware_config` guide. -Driver options -~~~~~~~~~~~~~~ +Runtime Configuration +~~~~~~~~~~~~~~~~~~~~~ Please refer to :ref:`mlx5 common options ` for an additional list of options shared with other mlx5 drivers. @@ -1249,60 +1303,6 @@ for an additional list of options shared with other mlx5 drivers. By default, the PMD will set this value to 1. -Supported NICs --------------- - -The following NVIDIA device families are supported by the same mlx5 driver: - - - ConnectX-4 - - ConnectX-4 Lx - - ConnectX-5 - - ConnectX-5 Ex - - ConnectX-6 - - ConnectX-6 Dx - - ConnectX-6 Lx - - ConnectX-7 - - BlueField - - BlueField-2 - - BlueField-3 - -Below are detailed device names: - -* NVIDIA\ |reg| ConnectX\ |reg|-4 10G MCX4111A-XCAT (1x10G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 10G MCX412A-XCAT (2x10G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 25G MCX4111A-ACAT (1x25G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 25G MCX412A-ACAT (2x25G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX413A-BCAT (1x40G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX4131A-BCAT (1x40G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX415A-BCAT (1x40G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX413A-GCAT (1x50G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX4131A-GCAT (1x50G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX414A-BCAT (2x50G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX415A-GCAT (1x50G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX416A-BCAT (2x50G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX416A-GCAT (2x50G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX415A-CCAT (1x100G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 100G MCX416A-CCAT (2x100G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4111A-XCAT (1x10G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4121A-XCAT (2x10G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4111A-ACAT (1x25G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G) -* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 40G MCX4131A-BCAT (1x40G) -* NVIDIA\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G) -* NVIDIA\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G) -* NVIDIA\ |reg| ConnectX\ |reg|-6 200G MCX654106A-HCAT (2x200G) -* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G) -* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 200G MCX623105AN-VDAT (1x200G) -* NVIDIA\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G) -* NVIDIA\ |reg| ConnectX\ |reg|-7 200G CX713106AE-HEA_QP1_Ax (2x200G) -* NVIDIA\ |reg| BlueField\ |reg|-2 25G MBF2H332A-AEEOT_A1 (2x25Gg -* NVIDIA\ |reg| BlueField\ |reg|-3 200GbE 900-9D3B6-00CV-AA0 (2x200) -* NVIDIA\ |reg| BlueField\ |reg|-3 200GbE 900-9D3B6-00SV-AA0 (2x200) -* NVIDIA\ |reg| BlueField\ |reg|-3 400GbE 900-9D3B6-00CN-AB0 (2x400) -* NVIDIA\ |reg| BlueField\ |reg|-3 100GbE 900-9D3B4-00CC-EA0 (2x100) -* NVIDIA\ |reg| BlueField\ |reg|-3 100GbE 900-9D3B4-00SC-EA0 (2x100) -* NVIDIA\ |reg| BlueField\ |reg|-3 400GbE 900-9D3B4-00EN-EA0 (1x100) - Sub-Function ------------ @@ -1991,8 +1991,8 @@ and disables ``avail_thresh_triggered``. testpmd> mlx5 set port 1 host_shaper avail_thresh_triggered 0 rate 50 -Testpmd -------- +Testpmd driver specific commands +-------------------------------- port attach with socket path ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- 2.34.1