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 1A9B5427F9; Wed, 22 Mar 2023 01:00:54 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E3B1642D31; Wed, 22 Mar 2023 01:00:07 +0100 (CET) Received: from NAM12-MW2-obe.outbound.protection.outlook.com (mail-mw2nam12on2059.outbound.protection.outlook.com [40.107.244.59]) by mails.dpdk.org (Postfix) with ESMTP id DE2CA42686 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=A6hbPk4upZOGkUcJu3wA3ZHevGqgRPAx7kUUgp36mPHLTMLGwAefu2qXqCobMTcBMtT5yT4R7RWpdqwhmqfntOsSabGxg43GqWCFp619pJJxrs18lGrswP45h7tzTRTiPwsJxVq5Wv2Uh+I+ru+pUtWxViSUzCAU+O5H1IFCk6Ip21JBj8rhpqVphUiv6+soO+VEwiftjj/c736n2lVFNrvxZHnZLmyM/7F+EHcqrmdE+cRsAlevv4vAO2Egdc4kkuBz4Wj2rGUvPs5sZcxxFCM1xjNs2bsFoDs/gxiSPWwpe56kC9zuPkSaQI19ibffDhk/r/Fm9crG0v1oiH9+rQ== 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=LNjoZTs46KCMQOGABns21t1BOgrba2dL/YE3xIPxFPE=; b=IOE6bPTLfMuY2slrEivoo4e49i2RQXFF2tDbxDvu4kFnJT3HRWN99JsHLYLDhKE58JWnYFwIhC9cUtk+foHJZQeL8cvZSDD6xFa5iN3MVMBiux87TrHl3mor+2QTcZE4iWD9P1xLc74UsxocKwmFQk21/mxOkFtUCpulHuprbaLI9Gpk8LgzfzpW8v+GdFdYyyC7sBQRf2bt53HWyXzXVVvfIN3ltfuQdsDrkRwC8Dzhp/vCvgbbFibb0Abts9N+0lSkYbpQdSZfNSK1wIQhnTRY95xEqiUmLfW1LMgV7WZPCRJzg6eo79lg5BE8YSsBtuyZne45W/x5Dp6Wu8KlZw== 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=LNjoZTs46KCMQOGABns21t1BOgrba2dL/YE3xIPxFPE=; b=o+YhwPf9rWTRpaprTGwCewp3Qu393GZSN+WJ4ZcBK2YIE1IpRtkeE5IML7xrAHqbIf+cSreLjhHCCLWfG5w81fZ1QZHU5lxC10pbBOaVn+mGRaw3fgJMRlEA4tH8F8JoF//x6JpdL6TZcEjklAwzcsIpZYrM0Bomop+P39BK1Uk= Received: from MN2PR14CA0029.namprd14.prod.outlook.com (2603:10b6:208:23e::34) by PH0PR12MB7959.namprd12.prod.outlook.com (2603:10b6:510:282::22) 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:58 +0000 Received: from BL02EPF000100D2.namprd05.prod.outlook.com (2603:10b6:208:23e:cafe::55) by MN2PR14CA0029.outlook.office365.com (2603:10b6:208:23e::34) 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:58 +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:55 -0500 From: Ferruh Yigit To: John McNamara , Gagandeep Singh , Sachin Saxena CC: Thomas Monjalon , Andrew Rybchenko , Subject: [PATCH 06/33] doc: update enetc guide Date: Tue, 21 Mar 2023 23:59:14 +0000 Message-ID: <20230321235941.2169068-7-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_|PH0PR12MB7959:EE_ X-MS-Office365-Filtering-Correlation-Id: 74f8efb4-7d9b-4c31-3e4a-08db2a686055 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: HzXRv3jhwHBbGztGpoDIk/MfKxcj7G4vrKYPqzVBGKrcIi42GYK7cGASeNlVONAZYb+xQ60sXdnGOlQMgEyvaMKQg70abWhrDS1ocyr2F7XCW9IEJ+CXDlx18obrtzhAAbIw5EkhYoMjkRalr+HnHVaRmtUaRAfjktw7ul7KbnoePRWqN+z2vONnwL9OLwt4ZORm0YvfTD0fjDekNtSZ6/nwkFgMZfSb+3Y2ZQIz0PXprVJPTc7s4yrb6lKQTmj6SjZy65h7MMPMjhCAyY3EJYV/TSTDLaCQ4rzGsPNDkA7047aTEfi6Jh1N8hJKePMhAhXQeCybU9kDrDExa676AGbZtQgtA513Bj9TZqOb83/N3SevtVc8oNjOjXvK8aXi3zn/NyEFeVu/2AjX9dF5PDxHqd+7sergBNV5E1zouo+OxBgh/t4eweMQlINMXpLHXaap55saaq+PO47DGNLYNGNfHQwuVrHjoLfrDzURmHYXp7sUyk6V8f2PnaApb7AUmSwx3NNCtTbOH+weVWHcuqHJMNswRrdbgu2zldi3KmUQ8OloQZPg9GwT6MWwnUW7oujlaJQKgXbF7NrqbvEAaH7MTznZNtdIpeKAib2r/WQ8EBTCzkqF7NS9rYRSywb8hcLR0XH2264sZFa+LUqW1Fusv40c7EVCzsDDHXA71D5q4Wpln55pCARdSOIZtQPF/80w9E636unsNQ6xzXj3jThVHLUh+0sz26NW1ttnvAXGa/chBDAVp2EGXlFibHAFJncYz+LPhliBQ8OazvGCzg== 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)(396003)(346002)(376002)(39860400002)(136003)(451199018)(46966006)(40470700004)(36840700001)(4326008)(41300700001)(36860700001)(70206006)(8676002)(70586007)(8936002)(356005)(81166007)(2906002)(40480700001)(86362001)(82310400005)(44832011)(36756003)(5660300002)(40460700003)(82740400003)(7696005)(47076005)(426003)(186003)(1076003)(26005)(336012)(478600001)(6666004)(316002)(110136005)(54906003)(2616005)(16526019)(83380400001)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Mar 2023 23:59:58.3752 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 74f8efb4-7d9b-4c31-3e4a-08db2a686055 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: PH0PR12MB7959 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 - Reduce section indentation, 'ENETC' was single top level section - Move "Supported ENETC SoCs" section up Signed-off-by: Ferruh Yigit --- doc/guides/nics/enetc.rst | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/doc/guides/nics/enetc.rst b/doc/guides/nics/enetc.rst index e2be764bc40b..855bacfd0f6f 100644 --- a/doc/guides/nics/enetc.rst +++ b/doc/guides/nics/enetc.rst @@ -10,24 +10,21 @@ support for the inbuilt NIC found in the **NXP LS1028** SoC. More information can be found at `NXP Official Website `_. -ENETC ------ - This section provides an overview of the NXP ENETC and how it is integrated into the DPDK. Contents summary - ENETC overview +- Supported ENETC SoCs - ENETC features - PCI bus driver - NIC driver -- Supported ENETC SoCs - Prerequisites - Driver compilation and testing ENETC Overview -~~~~~~~~~~~~~~ +-------------- ENETC is a PCI Integrated End Point(IEP). IEP implements peripheral devices in an SoC such that software sees them as PCIe device. @@ -41,8 +38,13 @@ This infrastructure simplifies adding support for IEP and facilitates in followi device register address) - Event reporting +Supported ENETC SoCs +-------------------- + +- LS1028 + ENETC Features -~~~~~~~~~~~~~~ +-------------- - Link Status - Packet type information @@ -55,7 +57,7 @@ ENETC Features - CRC offload NIC Driver (PMD) -~~~~~~~~~~~~~~~~ +---------------- ENETC PMD is traditional DPDK PMD which provides necessary interface between RTE framework and ENETC internal drivers. @@ -68,13 +70,8 @@ RTE framework and ENETC internal drivers. packet processing. - Then Tx is done first followed by Rx. -Supported ENETC SoCs -~~~~~~~~~~~~~~~~~~~~ - -- LS1028 - Prerequisites -~~~~~~~~~~~~~ +------------- There are three main pre-requisites for executing ENETC PMD on a ENETC compatible board: @@ -108,7 +105,7 @@ separately: LSDK and related information can be obtained from: `LSDK `_ Driver compilation and testing -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------ Follow instructions available in the document :ref:`compiling and testing a PMD for a NIC ` -- 2.34.1