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 2DF84427F9; Wed, 22 Mar 2023 01:00:45 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C4D8D42D29; Wed, 22 Mar 2023 01:00:06 +0100 (CET) Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on2084.outbound.protection.outlook.com [40.107.96.84]) by mails.dpdk.org (Postfix) with ESMTP id A598B410F9 for ; Wed, 22 Mar 2023 01:00:01 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=RSiPlfHEPnzR+IzM/5KlrvYaUqE5pOVEBgyXz6bCXk8S87dbeI8fgxjELEcAg/1bbixiHDG3qV43+VsiT8LKrDCkNUmjJI9nmrag6LBlGHEQvwqYBIklYF7UyeGY5QTwXH+PrVL7n4/iI5uLAd8/OaId21m+CbtR368DqhvGkHacFLIrdSCwAprSLqZLK+c2XP98vsm4q5X8Di9TOp0OEzRHy/PQoVPhpswqP09mtFa6pg4KCmW5m81HFaZcDGq6sg7txLqTmsA71HF5NfDSpZeGydgqSSQ6PWJKAHn+TSxeC4kATo8ZC4a+JdL5B4nuEgP+DqotflT3i3OjxcbnvQ== 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=1a6SWacp/RJDyEpK3JQ5T0ECgMgEwQAfhfuRJWOJZsA=; b=A1aVj3UJo+elh7gY6mDe67G+OILv9C6naPESIv2Ou1fvG5/+BIgbD+iO8R9tYV8Qq/tpqVWAr+hVFXTMZ5v4H4c3bpUHO4v3ZS9PK49RN+Nr7TI/hF0GJj4uX8X/dj5fTON5Eeu9uT3qNkTrhDAghcHlrPOQx8eQiZoo/lQWLeuwGjCKcEn1QkChpovVbWU52Uhl9pWRWQD7tW2FLZROOteJwPKFYGyUvCZXB7lSSCVak9YcknKw0fQjYoA9k2rUPQfcJ8OgXaRTYL5OzkUqk1Qr7QGpG5+/8OljXDo3iumEYGVNL0vPS3MTLkAUDWJgENrK7RwZZCDbuWHvipk6Cg== 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=1a6SWacp/RJDyEpK3JQ5T0ECgMgEwQAfhfuRJWOJZsA=; b=2+Y1A36zYrBkEUSu6FC5ShuthgfKKt00qCUIpz3M40MIfrjZdlECWV/l8Yc8X9pfuPNgkowWDbCOS80vFVTFyK4ydAMqzwY4+06N9G7/4cF71ICJ7RqxgIPHGaDJBCNBZhXg6wHLl1dsxkMMBHqPemZGEo66OWEV5MiJrE37/IY= Received: from MN2PR14CA0010.namprd14.prod.outlook.com (2603:10b6:208:23e::15) by DM4PR12MB5165.namprd12.prod.outlook.com (2603:10b6:5:394::9) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.37; Tue, 21 Mar 2023 23:59:59 +0000 Received: from BL02EPF000100D2.namprd05.prod.outlook.com (2603:10b6:208:23e:cafe::2e) by MN2PR14CA0010.outlook.office365.com (2603:10b6:208:23e::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; Tue, 21 Mar 2023 23:59:59 +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 BL02EPF000100D2.mail.protection.outlook.com (10.167.241.206) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.6178.30 via Frontend Transport; Tue, 21 Mar 2023 23:59:59 +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 18:59:58 -0500 From: Ferruh Yigit To: John McNamara , Dongdong Liu , Yisen Zhuang CC: Thomas Monjalon , Andrew Rybchenko , Subject: [PATCH 09/33] doc: update hns3 guide Date: Tue, 21 Mar 2023 23:59:17 +0000 Message-ID: <20230321235941.2169068-10-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-Transfer-Encoding: 8bit Content-Type: text/plain 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: BL02EPF000100D2:EE_|DM4PR12MB5165:EE_ X-MS-Office365-Filtering-Correlation-Id: 2b7646ca-9ac9-40f5-4b8b-08db2a6860e4 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: DTiTGQ+HHe4F3tOOpKpKUM0Um0PbinzvGKyDmEcF4AgEIk8idi+l+7ksYHwLqOqhRDB5sy+93PkFUV6ZeXZxZ3eTfIjr4lz+1wrDJOx0P7yy4TxZ2GOCWffAVHkFRFG5y4h8/86TkpRQFxIwjj4AMl6QlRfr+KQTsAJfBHWlXXGV/KFDuf4IJCCWwwu+6Wa1JGGRrBxSSi7CTIsE2l6fWx0EMELY0CzZJm+eboI6u1ZUdPBXln7s4TAE/GibcSuoBMrCEea8aGcVOc9Np/WIiVjEB4DKmuN9ooHu1ZEGxIpjuCPaqqhjUn5GIkYeUU8IPeeEmo7PXH806CFxUKAbXhZX8iBKKeuwI3+MJvA2RkBdIAcKKrzaOpWuUygSi3uWII/jwlG52VfzmVmkmev8fKq6iz6l3VkMX8pEuqLtmL4WkAGLDqaQrvNAQFetxtEoh0GU2JJaunuThim/22Tv4GmBSjeVLvKaTx8SGQ9jAVfvlZGfcPjWqS3TMO/DRWjlH3p0knR1Yi7LuF0EToj/KCdJTodfD8/540vs7xAZvnFuQcm5WSXTS2kSB9MN0dNOSI42lKop8QdeRYfdyP+l/oWHhS4tcErdMuDMkHDlKZBdtQFKb8ghyRfD1nfUr4FnhifWYxM+qRx4p9vznSkV75Z/xAssWnouj7PpDEO/tWCvz0AaMHWHOo3ubeURf0pR5lTnhBi7nxsai3By5AkSwoYHz2yJny52q/Id+5yG7TM= 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)(376002)(346002)(396003)(136003)(39860400002)(451199018)(36840700001)(46966006)(40470700004)(47076005)(186003)(1076003)(426003)(86362001)(16526019)(26005)(336012)(2616005)(8936002)(2906002)(40460700003)(41300700001)(82740400003)(478600001)(316002)(36860700001)(7696005)(36756003)(83380400001)(54906003)(6666004)(4326008)(44832011)(5660300002)(81166007)(82310400005)(356005)(70586007)(110136005)(70206006)(8676002)(40480700001)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Mar 2023 23:59:59.3127 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 2b7646ca-9ac9-40f5-4b8b-08db2a6860e4 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: BL02EPF000100D2.namprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR12MB5165 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 "Link status event Pre-conditions" subsection under "Prerequisites" section - Rename "Pre-Installation Configuration" section to "Configuration" - Rename "Config File Options" section to "Compilation Options" - Rename "Runtime Config Options" section to "Runtime Configuration" Signed-off-by: Ferruh Yigit --- doc/guides/nics/hns3.rst | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst index 791c9cc2ed49..5373ec5a8faf 100644 --- a/doc/guides/nics/hns3.rst +++ b/doc/guides/nics/hns3.rst @@ -47,11 +47,21 @@ Prerequisites - Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. +Link status event Pre-conditions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Pre-Installation Configuration ------------------------------- +Firmware 1.8.0.0 and later versions support reporting link changes to the PF. +Therefore, to use the LSC for the PF driver, ensure that the firmware version +also supports reporting link changes. +If the VF driver needs to support LSC, special patch must be added: +``_. +Note: The patch has been uploaded to 5.13 of the Linux kernel mainline. + + +Configuration +------------- -Config File Options +Compilation Options ~~~~~~~~~~~~~~~~~~~ The following options can be modified in the ``config/rte_config.h`` file. @@ -60,8 +70,8 @@ The following options can be modified in the ``config/rte_config.h`` file. Number of MAX queues reserved for PF. -Runtime Config Options -~~~~~~~~~~~~~~~~~~~~~~ +Runtime Configuration +~~~~~~~~~~~~~~~~~~~~~ - ``rx_func_hint`` (default ``none``) @@ -130,16 +140,6 @@ Runtime Config Options For example:: -a 0000:7d:00.0,mbx_time_limit_ms=600 -Link status event Pre-conditions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Firmware 1.8.0.0 and later versions support reporting link changes to the PF. -Therefore, to use the LSC for the PF driver, ensure that the firmware version -also supports reporting link changes. -If the VF driver needs to support LSC, special patch must be added: -``_. -Note: The patch has been uploaded to 5.13 of the Linux kernel mainline. - Driver compilation and testing ------------------------------ -- 2.34.1