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 1FF0E427F9; Wed, 22 Mar 2023 01:00:33 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6ED6B42C4D; Wed, 22 Mar 2023 01:00:05 +0100 (CET) Received: from NAM02-BN1-obe.outbound.protection.outlook.com (mail-bn1nam02on2043.outbound.protection.outlook.com [40.107.212.43]) by mails.dpdk.org (Postfix) with ESMTP id 67B48410DD for ; Wed, 22 Mar 2023 01:00:00 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=N4XLyYKX5DjzjUDEm95ziRSGbPBVD2959uLebK0wi6254pBlWOV4rf8vGWkhG6GbdkvGE5lsvDkpK+lEd9SwKZ+/jAYx5yqHYNuL8dEAFxvYxWTAmN+AHlIptesb4rmsb1c4jhGpIB8ElrT6m7gHqkQdNzmo6ZVZwBn30Cek0GNollUB31w5sy3P2HqM3m7QoC+PWQ1yD0n8cW4FxeNt+ARpYKngmFPj4tDGHG7sp2SKvvq56Xypbt2NrllE17bDYJ+sx+qwPoBU7hVclNQEKgjhnNC1HRY3ybwUjo/dBJu58WXQjuwb1kzuV+VKg7IAwLEYS+LAMuZv5TI1gqM14g== 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=BlCygJRbxtvC+W1KoflMHhsoQ/IIuMQ89gDhKpypDoU=; b=KUcH1xOp0VubBkwAmfWvgpBwqpZM1g5zgZQkUnSj4aZgU6mlS0eHjmKXiUtPi+/klm1LfC7xe8KRoh7zUu+SpZs4DWncn6JkU4d9cCkK3/bYtuhOThWbT3d56iXe96COmZdFQ8zVTd6yWKAeQSeGESWVbMvIRZfQQWeugVgvgT4uUCjg1Hodn07NfOipcfkl3hEZLJr5Trpszhv0GYD3izPI6oij4cYit6w0iYoQXIfiK//9xBelnZrm/b9gXgM/TTFfHuXRUwnQ54PQzR+j/ioI8fUGegbonZeUJ1nD1acLjM/otTIg/QYpKMFN2LTYb4qTsBd0UkZb9JLjYSyhWg== 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=BlCygJRbxtvC+W1KoflMHhsoQ/IIuMQ89gDhKpypDoU=; b=Nx4tU/jezmI1Ew/4oLapA/k9EvLWJUTo8desTg/9WnnGRD9G4Px7Aarz2NWprfk271wy2K9MEf6AU3CHbAgS/2kAjkTX4isWCiRmv2hKthRU8RxffByOwRCYMDaRGyZBDZdrk2tamIu0ZXn3J8dbGJk39NEqC/C8P0E42Ow2C70= Received: from MN2PR14CA0022.namprd14.prod.outlook.com (2603:10b6:208:23e::27) by DM4PR12MB8452.namprd12.prod.outlook.com (2603:10b6:8:184::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.36; Tue, 21 Mar 2023 23:59:58 +0000 Received: from BL02EPF000100D2.namprd05.prod.outlook.com (2603:10b6:208:23e:cafe::60) by MN2PR14CA0022.outlook.office365.com (2603:10b6:208:23e::27) 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:58 +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:57 +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:54 -0500 From: Ferruh Yigit To: John McNamara , Marcin Wojtas , Michal Krawczyk , Shai Brandes , Evgeny Schemeilin , Igor Chauskin CC: Thomas Monjalon , Andrew Rybchenko , Subject: [PATCH 05/33] doc: update ena guide Date: Tue, 21 Mar 2023 23:59:13 +0000 Message-ID: <20230321235941.2169068-6-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_|DM4PR12MB8452:EE_ X-MS-Office365-Filtering-Correlation-Id: 711cdb74-97d8-4082-40e0-08db2a686017 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: Edq728C5NVAgxtpYzVB/IKq08bLKxdjzo4giIGiTYvbGtg3OimJjIFw/gP/mYHptO8MBQXKBsD0BQvi38gPVCLiKQ0c3LvmKu1pMRCHllCfzW5GRVb23OTrn8bxUOrgtd8xy8FYMO27YNVea16Uiw6oipWv6YdGkV/xCLmmoksvY7Ay1LH7STK9LVvXbf/uLTEXjRjc4Um2T9TJS7EIcPdyFRSTJJBZnwznAwEscMgZVx+x/o/I5Fkfp675yG9Ac2S4a1lVHfHn39GZDneDwmG159Lu4m/sJAAZEvjdDWZsVvtfq7mgwhI0v6YyyzSoiOyCTFtzPPGZ235W2P/IfZ9OtZvTi3Ce82in49ZsoQlEFEHqImV9tRekN/dX6I/nMQIEXJ0qB6yTR5TlSknAe1uk2ynOOwKHNjFOYfrKl7c0IMPyuvASLoQnLEU8oY28ex+2AlXl+EOMdvfXndAbLFJoiinGNti/9aIta0Edty6mmq/PJ3MI04LK5Q+ysUy7HDguoqtdTU1tESiUilAO4wCzev+xPxkVo2NJmklpiVpKSc5VbR+Ro4rreVj+Izj8eT6rfWAqWa8hJ5FHq6e8bPbK4asYFddfgzh8CjcJKWZoP7CbpUM7yO090GAJtHO1fPDDH2qIBgjgqq+vP8FddQZndD6xxEMlLrGiyDTSqvukUG7kIhbuiT8DLt0N1nym08IvylPTzHMncYBjeaOzL/xrn1abmZURRT1xS2BZ7mkE= 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)(39860400002)(396003)(136003)(346002)(451199018)(46966006)(40470700004)(36840700001)(86362001)(36756003)(356005)(40460700003)(5660300002)(7696005)(4326008)(41300700001)(54906003)(336012)(8676002)(44832011)(8936002)(110136005)(316002)(70206006)(478600001)(15650500001)(2906002)(82740400003)(83380400001)(36860700001)(82310400005)(40480700001)(1076003)(6666004)(426003)(81166007)(47076005)(186003)(2616005)(16526019)(26005)(70586007)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Mar 2023 23:59:57.9690 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 711cdb74-97d8-4082-40e0-08db2a686017 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: DM4PR12MB8452 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 ENA adapters" section to top - Move "Supported features" section up - Rename "Configuration information" section to "Configuration" - Convert paragraphs to subsections under "Configuration" - Rename "Runtime Configuration Parameters" to "Runtime Configuration" section. Signed-off-by: Ferruh Yigit --- doc/guides/nics/ena.rst | 60 +++++++++++++++++++++-------------------- 1 file changed, 31 insertions(+), 29 deletions(-) diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst index df5343e4aedb..b039e75ead26 100644 --- a/doc/guides/nics/ena.rst +++ b/doc/guides/nics/ena.rst @@ -8,6 +8,31 @@ ENA Poll Mode Driver The ENA PMD is a DPDK poll-mode driver for the Amazon Elastic Network Adapter (ENA) family. +Supported ENA adapters +---------------------- + +Current ENA PMD supports the following ENA adapters including: + +* ``1d0f:ec20`` - ENA VF +* ``1d0f:ec21`` - ENA VF RSERV0 + +Supported features +------------------ + +* MTU configuration +* Jumbo frames up to 9K +* IPv4/TCP/UDP checksum offload +* TSO offload +* Multiple receive and transmit queues +* RSS hash +* RSS indirection table configuration +* Low Latency Queue for Tx +* Basic and extended statistics +* LSC event notification +* Watchdog (requires handling of timers in the application) +* Device reset upon failure +* Rx interrupts + Overview -------- @@ -76,10 +101,11 @@ Refer to ``ena_eth_io_defs.h`` for the detailed structure of the descriptor The driver supports multi-queue for both Tx and Rx. -Configuration information -------------------------- +Configuration +------------- -**Runtime Configuration Parameters** +Runtime Configuration +^^^^^^^^^^^^^^^^^^^^^ * **large_llq_hdr** (default 0) @@ -105,7 +131,8 @@ Configuration information huge performance degradation. In general disabling LLQ is highly not recommended!** -**ENA Configuration Parameters** +ENA Configuration Parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * **Number of Queues** @@ -130,37 +157,12 @@ By default the ENA PMD library will be built into the DPDK library. For configuring and using UIO and VFIO frameworks, please also refer :ref:`the documentation that comes with DPDK suite `. -Supported ENA adapters ----------------------- - -Current ENA PMD supports the following ENA adapters including: - -* ``1d0f:ec20`` - ENA VF -* ``1d0f:ec21`` - ENA VF RSERV0 - Supported Operating Systems --------------------------- Any Linux distribution fulfilling the conditions described in ``System Requirements`` section of :ref:`the DPDK documentation ` or refer to *DPDK Release Notes*. -Supported features ------------------- - -* MTU configuration -* Jumbo frames up to 9K -* IPv4/TCP/UDP checksum offload -* TSO offload -* Multiple receive and transmit queues -* RSS hash -* RSS indirection table configuration -* Low Latency Queue for Tx -* Basic and extended statistics -* LSC event notification -* Watchdog (requires handling of timers in the application) -* Device reset upon failure -* Rx interrupts - Prerequisites ------------- -- 2.34.1