From patchwork Fri Mar 17 13:08:24 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Hemant Agrawal X-Patchwork-Id: 21862 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 593AACFBA; Fri, 17 Mar 2017 14:10:40 +0100 (CET) Received: from NAM03-DM3-obe.outbound.protection.outlook.com (mail-dm3nam03on0077.outbound.protection.outlook.com [104.47.41.77]) by dpdk.org (Postfix) with ESMTP id 68FEC69EC for ; Fri, 17 Mar 2017 14:09:04 +0100 (CET) Received: from BN6PR03CA0036.namprd03.prod.outlook.com (10.175.124.22) by BLUPR0301MB1953.namprd03.prod.outlook.com (10.164.21.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.977.11; Fri, 17 Mar 2017 13:09:02 +0000 Received: from BY2FFO11FD006.protection.gbl (2a01:111:f400:7c0c::195) by BN6PR03CA0036.outlook.office365.com (2603:10b6:404:10c::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.977.11 via Frontend Transport; Fri, 17 Mar 2017 13:09:02 +0000 Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=nxp.com; caviumnetworks.com; dkim=none (message not signed) header.d=none; caviumnetworks.com; dmarc=fail action=none header.from=nxp.com; Received-SPF: Fail (protection.outlook.com: domain of nxp.com does not designate 192.88.168.50 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.168.50; helo=tx30smr01.am.freescale.net; Received: from tx30smr01.am.freescale.net (192.88.168.50) by BY2FFO11FD006.mail.protection.outlook.com (10.1.14.127) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.977.7 via Frontend Transport; Fri, 17 Mar 2017 13:09:01 +0000 Received: from bf-netperf1.idc ([10.232.134.28]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id v2HD8peO021077; Fri, 17 Mar 2017 06:08:58 -0700 From: Hemant Agrawal To: CC: , , , , , Date: Fri, 17 Mar 2017 18:38:24 +0530 Message-ID: <1489756124-10805-3-git-send-email-hemant.agrawal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1489756124-10805-1-git-send-email-hemant.agrawal@nxp.com> References: <1488545223-25739-1-git-send-email-hemant.agrawal@nxp.com> <1489756124-10805-1-git-send-email-hemant.agrawal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131342297419835589; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.168.50; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(6009001)(336005)(39450400003)(39840400002)(39860400002)(39400400002)(39380400002)(39850400002)(39410400002)(2980300002)(1109001)(1110001)(339900001)(189002)(199003)(9170700003)(6916009)(110136004)(5660300001)(2950100002)(50986999)(76176999)(53936002)(6306002)(6666003)(2351001)(4326008)(54906002)(104016004)(77096006)(189998001)(106466001)(23676002)(105606002)(8656002)(86362001)(38730400002)(47776003)(85426001)(81156014)(356003)(5820100001)(2906002)(2870700001)(81166006)(8936002)(8676002)(33646002)(36756003)(50466002)(305945005)(50226002); DIR:OUT; SFP:1101; SCL:1; SRVR:BLUPR0301MB1953; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; MLV:ovrnspm; MX:1; A:1; PTR:InfoDomainNonexistent; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BY2FFO11FD006; 1:3tbk6ELc8GJEqFrFoxf0Jz0emXaaBUDL9MyvJRMBNR5g3PcMEcmxZNWB9+bLWXXuAnV/US8w6CwUWa5YmyUEjP++MEAgT28Soj4RErXJF1agLEuQxozxZTQ0xzX+4SKtlsXTPc/4a0kzlMAlGMK5EWayJzLYxodjEpHHkbtHqHfkR7qusEf2xiYRB2jB3tvcvswx9U6Ka7cGXB/ZqY7i3cgphgPjsjDH87dRNEd9FnQsZHqPSr5HAdRaa39TP/xb7t833J3Q6YZawU6C67qJ9Ym6WPgGQGtDp9TnrK/9tUnovQV1zqaks7TgKT5aZ/rDq/qQb9lqp/gxMcKt+QTKW6LQjxNg4TiiKxOOLdL8M2kCK7VqTWqJZkGqyRl/tRjXXF69pteuitZ+2aNIUEMdQ8tMTf1DXn2WF7klyYoi20UVxHQeDdXx0tGON6H6YCuAXRcqRVENZVc52B616Jv5aiBLHB/u/9v0ae7TdKb9Eg5IaJZTE+o3bPZ9e3vO4LxQB1B8M4k3bJ0a3hXPL1EbPZieWCFfquyxMG4gXhYabYvq0xkShTGl20Undn7JgOHYmGHuY2IrUiuO3iDvRMp4FCvUt3HU01OB5TlF8zcOcsPyPztU+XrQCV3nffy0Zw8o0Mt20D2kJVlrfDS5GagzGw== X-MS-Office365-Filtering-Correlation-Id: 225fe4d6-b5a2-4ca2-68c5-08d46d36c828 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001); SRVR:BLUPR0301MB1953; X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1953; 3:JVuBlWGLi9LEiHOsnLaYjLqkoJB65u10EnOnE/mun0kwpdH7duEfQDC6NwX0O0js9/tkdaJjGnO4tuzdBDX5OKwsAOWYeE4t4ne/IQ0ekIvORtzspHi+aUqWgZfXF8/HD4c4dzb+bd8H8te7kTm0fTjpi7fA2ww7Z0cFqjGyOnLKyvGQIfKmSE3SlfY7+j5p0YX4l1yvvf1clZkF13YbK+KZt1spRI8lFhEsDozN2PWkZUJJ8sTDEr8Jg/5ZlBKBrGRoNDUbdaTvlRwMCuDDLyIXGY4RIQLQDV97SJK0Mig1yxLs0lGiHvu5Tz4wn8PeIiPKp2tPKrFP/JfCr6wcRYX7IGDdbbHyZ2hgNHqIuD00UtzeJ3hiiEvxv3cBQoPm; 25:zKicCoDymyO5S9+p31ojVTfNWMAQImDtl+i0KDGn1chfiNQlEo4Lal9Lnbs3y2c4JsPpwAJBgL13taUEffKfjToxd3LMq06ld0a5pE+6+1eFqO1bOSewWWGh3Qjg5mvjChwh6er9hAKUDsHqoP0tsj1thpvOYMC3lQBN8E5FqIw38gOppGjXog+yreogHjEPROUZ7ELCbeReuEjZxkrLb5HDmFwRb7XporLnDr2omoL/ypZcbqMWIEdnlg4q9eGmCg6yT+eARTJ2jpeqpDgWdZQU69naf9+EHG8mdl1Vvyvg+F6yFUEGNfx1Y2q0iE/8HRleKjaDIrbQQrNMjmDcFrEv7XiTIyKSEk58HeCmZ33ocSuAuqPasb1BAbFc8mJFa9vqub6rrG1aHiS1S9n4DslaT8QNOAN8cXuuwBvVVXbRebRTlOuYwp2S+mqp+Q0+yMMxp/n+sVd/365vtUaOTA== X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1953; 31:2mScAC8W90Frazf2oCby90pjM/I6A7kb6fTMBrjJiqxuf1UZUkjK1zL/nuY+m4ZgZI55U7sDQEwmL/lwDxvuApPfq8ng/7OBIaHBjXoT147Q6l+Rg8ejLN+7aJfyawDY9uVq2v1dRKu76kj4358+TR0UlB0eVqOHzTw6KQ144d7LPMdl32Jf4sr3AydNAQ7EGdJv9IotWQR4Q/njmzJ+OCJGD1aKh3ojrEug2QpgzH3fhmHwIWdIIKm2CMQLx2Ln8uzYw/14BiB5WF2YaNuMsA== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(185117386973197)(227817650892897)(275809806118684)(21532816269658)(264314650089876)(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6095060)(601004)(2401047)(13023025)(13018025)(13024025)(13017025)(13015025)(5005006)(8121501046)(3002001)(10201501046)(6055026)(6096035)(20161123565025)(20161123556025)(20161123559025)(20161123563025)(20161123561025); SRVR:BLUPR0301MB1953; BCL:0; PCL:0; RULEID:(400006); SRVR:BLUPR0301MB1953; X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1953; 4:7IPesb0fs+rumnCfWIltNR9fTGg+gppe3+8VCzbKZ2dilzkgJI0NUBDOXa6Zx0uitn2KT6yH6+rglVabKfbKEuDBZLcWEPp+hAw+0Y+aXCLNgwfe58SZD5EQZylJgy4CTAGo+TdD2fhYV82ccEtHmqaPlP5bWR/Tbd8kuSAl8gcr1aIyPz6Qosx2AgD91QrMhO1Fto9uUldCnvhe8tdt1jp66CtHtKJPQAW7ui2XAy3yWJBB+hb8osG3baSzX+Ukwa61zxDP+tkcU5g3zD09Uv1SycHUKbEqyorbCetV+VoHXUSDKjI0uSQeBJtmH02KDhQMgYSJPA110Zcs7p6A5NIapSS6MqZQNv4c7UScI/il6oqD/Jx5GZklTUmodQkS1n4Job7JYbEHGYdZePPuTtkFuQ2TN8qwUumMVRq0glDsGECJbRayEDq5lv9kPLDbJAbohAEWJWS5hIMh/QuGSFAhC/tix86IDlaszglWp311fLk/cQSeZjl+dblzR0y2QzJd7whqNzwGAEAKSfB4bScBUU+JY301prYpPTyWaT16NwTu6gcw80GuiuoKV1WzhWuyEqYuRLkP6rZrE8mDOvWPIQeB2QKWsJf4ua5VlXnTt9ajQJnz0l5nkjUI5ks9vVq1RAhtVR57Qp3ODuMuUpsmRqCOZJcWqLl8KiDlmzXtEwCbjc+3IZcaCbz5moXLofkp6gubb2meT0Lcz/Hgtgz90VPn+6meRW+QkANcngI0prv0X/U54hwII0/msE/FueZOo/YMbEowOUljIaZxTZjIW5bF44pmGDvrwbpTWhxSeAOUbzi0MWJxDJrdPYwbNtH17rrLtqlTlrxAwtmeIqyIO9NGYI/ZvGMhZGN/2vLMmSKz/KRo4tNHfPbaKr5VRj3p1i/wsXCYxPMsSTSNO2Pitx8z5ytw9TmBUg4Le+Z/U4ubhGj/jcnlwCJ8nEwc X-Forefront-PRVS: 0249EFCB0B X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BBLUPR0301MB1953=3B23=3A9X?= =?utf-8?q?d0wi+Jw6zjCKhGEnJkpNP00wvxU4bjWP/GNwr4vd7cBQCuxGJLReDlvy?= =?utf-8?q?/nQv3wqzCy4+k0Yhaov8gRAP25TwrmE1nmpEqvangLzl2TXAWy96XgwV?= =?utf-8?q?iHJrqHx4KvE6I2Gsvwy0hFCTR5Vq1s5TQNL4U0qN0pdDheQAusIr+4Cd?= =?utf-8?q?d30tv+twNI5ZSh/d3X/D2gJKvew8IlVWpcu24UyY+Ngk8WCGY8bihJ1X?= =?utf-8?q?iUiXuPsr4zjjIitB8IvIIQi5lOFACYiRvYzzQG5phLCf3tTwTC2Wmke3?= =?utf-8?q?4mpntpSGhL/HoUFNSK04YZf8vdt4V79H4N0UPjEOYEVFeSIUfTe6hYnP?= =?utf-8?q?HhcPF1n1G4wFttaayCiMCwchTTzasAg1hpZHhdd0z6FxFgYpA/Hq0XVC?= =?utf-8?q?f9kHstWO59RsG2MO5FEvkeWYiPn75Xnrs8ma9/GkXwQXhnbnuprXv/+i?= =?utf-8?q?MLxMHioI6PXTe7sUBkhBvP77hFGj8PMa+FZLLoVG6DlHH6VsNnpD37Pg?= =?utf-8?q?AnycOLQaaNMEmNjEWiHytdg4c6VHMvN3t1b5YpuiwmUGnkMVP7EjWfvT?= =?utf-8?q?S7cqeb9ngHhfI/l6fRC1iMnTc8rWGXKt36VEqnA1trLN1y2bSTfF8GcP?= =?utf-8?q?ypPS3CV14Rdds0jiQWrN/P6voecLVTKmLIz5xZEj7cfgs9bR48hFOqz1?= =?utf-8?q?ctkpYLDgaalxczFnmccjovip4Pu28EBDMjjHZH8EwUu99dhyp3Uz9P/9?= =?utf-8?q?eWZ2xc9KCErPBDBz915Z6paDa2ZPcpMGsU07MxvcjLXxJB9rzDSOu4/U?= =?utf-8?q?qDRTDQaoCgNjxLpZGNcndFl/1jXIOmZWXDDWrEoRvDb37zdvpMZcV0iY?= =?utf-8?q?lInUJ08PGyDOMzmVJ3RRHByTpFG/P2Pge5XwjXgBkM4MiDGbBrfaWpOX?= =?utf-8?q?0btb1ldVbd0kufjxLABmgq3J83iDgPKrd/XpP2gYMcyJXRL0dVPFrVQR?= =?utf-8?q?oDoTbM8sGmVjiwtRFR4YH9QleYF2HzoehKc1EDAr7yioDhyq+XswMoso?= =?utf-8?q?2JyVm0hKk4FITYkC7SDM/tC1umB7dM97qn309AZDX/Z/+Gl8QyCNFfo/?= =?utf-8?q?LytO38kRqVzkU9yLvfnItsOgQmNQFbtQ67Kq8nzMY7S0TFx7IJr6Y6bK?= =?utf-8?q?RhKsl8w1oEwihCpb2Zm50EKcpdvWYZN1vKPcmnolNky4XhOPqQll9olO?= =?utf-8?q?SMVylbYoPLUcu76BLRul2GAHiEZsDazy90Pl4EiGZEyM7NvzNrs0h3Rd?= =?utf-8?q?Z8Rb28f6E29eVlfD67lM/vGFySV/OA0d074lJ9ZkhQ4QpW?= X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1953; 6:z+GvuqBmbpZaIpJoJTkOod5SHSDNvKSSsmhI4q03dU57xDLj9ghH6oZSKxmXZ/0oJow3QpBkeczp5Vz7QMFeCTRZ9T32Th1nguoCbZFAUGn9Vx2pMvmXLOwJTTIfPiHsWlHvz3GY8RNlNt+iTS885m/4AYMxdf/7JiUsSnY277rBlCDoVNPctyo9mivrLS2Iz3YoFkHpxf+VMvkAT8kY8xrWivJmct9X0smjzzIBGMg6CoqowzsmHWYauI+asXdzcHqQxMqb7dsKm4VAM9lJWPzV1/M1ojaYwIbU4k7Bp3SYpLQCqol9oKivz6ZiH0AdY59n7fZq62ZwwWguz/bMZO+BS2Vzj3E28IF/eDzIbfrapWnpoxYZ3TebJa8T/IkZ7Ey1TKqQNAwxiZ1Ow/Zr/mbOytx8SdzrxBZbstlSkjc=; 5:q3aC2VfinKeaydb4Aq0cdNwT8fz1RPBTUkfbDtSSsm80j0Nj/yTZw3ffPasCmTEKiUbDxR8daKKoZdkL1QK+atzmLlojcV0X+dCry6Q/6xuwVOlcMNSvihulpZ6izhPiB+cYYqUCOXVj/favpHKjkKCI7RDE/VIKYLe7u44b/ggWBXT8DNOAW2w3CmnEba89; 24:JFfsfPUK6n6xT/+b7bJM35ypSatQYNQ2IHEkkKWbM++Ov0iSHH8g+rY+WURftfi6QY52KAHrYkIuGEC/Nf8y7HfBshp99cc2bJCuvY9Pu7E= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1953; 7:9Kj6cUMmvhGfo3Q0dJA+Uj9FvaKueLWGK92SdkqrsO3zl7chdFSgHg/R4BqqyJHgWLb70ec9CpWOMkPG8SiOThWQMs4upUW+sOhSIBQLhhnQ8LTGrKU107Lm3gkq59FhIblBy+E7WDw3mtW9rggFdU1xKmNwL9xOrPWVUgKDDuDqMiTa4Kl9lBoPIrZVRfG14tfW+kZ51xR3bEMQcB7ph7YIjPkCqiNDL+eSwZ6yCie0+OodjQMp4I5k6J4whEI5+dXowHg6EhnWe9DGdxDz6iNEYO4BO0Qp/HTWdmLGGi9zTN9wJz4h8178jRxr4r0kdyPTTxNQaklKLF0ZpfidNg== X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Mar 2017 13:09:01.7807 (UTC) X-MS-Exchange-CrossTenant-Id: 5afe0b00-7697-4969-b663-5eab37d5f47e X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5afe0b00-7697-4969-b663-5eab37d5f47e; Ip=[192.88.168.50]; Helo=[tx30smr01.am.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BLUPR0301MB1953 Subject: [dpdk-dev] [PATCH v9 02/22] doc: add DPAA2 NIC details X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This patch adds the NXP dpaa2 architecture and pmd details in the Network interfaces section. Signed-off-by: Hemant Agrawal Acked-by: John McNamara --- MAINTAINERS | 1 + doc/guides/nics/dpaa2.rst | 614 +++++++++++++++++++++++++++++++++ doc/guides/nics/features/dpaa2.ini | 9 + doc/guides/nics/index.rst | 1 + doc/guides/rel_notes/release_17_02.rst | 12 +- 5 files changed, 636 insertions(+), 1 deletion(-) create mode 100644 doc/guides/nics/dpaa2.rst create mode 100644 doc/guides/nics/features/dpaa2.ini diff --git a/MAINTAINERS b/MAINTAINERS index 1b1e1d7..4108266 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -355,6 +355,7 @@ M: Shreyansh Jain F: drivers/bus/fslmc/ F: drivers/mempool/dpaa2/ F: drivers/net/dpaa2/ +F: doc/guides/nics/dpaa2.rst QLogic bnx2x M: Harish Patil diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst new file mode 100644 index 0000000..7d7a6c5 --- /dev/null +++ b/doc/guides/nics/dpaa2.rst @@ -0,0 +1,614 @@ +.. BSD LICENSE + Copyright (C) NXP. 2016. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of NXP nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +DPAA2 Poll Mode Driver +====================== + +The DPAA2 NIC PMD (**librte_pmd_dpaa2**) provides poll mode driver +support for the inbuilt NIC found in the **NXP DPAA2** SoC family. + +More information can be found at `NXP Official Website +`_. + +NXP DPAA2 (Data Path Acceleration Architecture Gen2) +---------------------------------------------------- + +This section provides an overview of the NXP DPAA2 architecture +and how it is integrated into the DPDK. + +Contents summary + +- DPAA2 overview +- Overview of DPAA2 objects +- DPAA2 driver architecture overview + +DPAA2 Overview +~~~~~~~~~~~~~~ + +Reference: `FSL MC BUS in Linux Kernel `_. + +DPAA2 is a hardware architecture designed for high-speed network +packet processing. DPAA2 consists of sophisticated mechanisms for +processing Ethernet packets, queue management, buffer management, +autonomous L2 switching, virtual Ethernet bridging, and accelerator +(e.g. crypto) sharing. + +A DPAA2 hardware component called the Management Complex (or MC) manages the +DPAA2 hardware resources. The MC provides an object-based abstraction for +software drivers to use the DPAA2 hardware. + +The MC uses DPAA2 hardware resources such as queues, buffer pools, and +network ports to create functional objects/devices such as network +interfaces, an L2 switch, or accelerator instances. + +The MC provides memory-mapped I/O command interfaces (MC portals) +which DPAA2 software drivers use to operate on DPAA2 objects: + +The diagram below shows an overview of the DPAA2 resource management +architecture: + +.. code-block:: console + + +--------------------------------------+ + | OS | + | DPAA2 drivers | + | | | + +-----------------------------|--------+ + | + | (create,discover,connect + | config,use,destroy) + | + DPAA2 | + +------------------------| mc portal |-+ + | | | + | +- - - - - - - - - - - - -V- - -+ | + | | | | + | | Management Complex (MC) | | + | | | | + | +- - - - - - - - - - - - - - - -+ | + | | + | Hardware Hardware | + | Resources Objects | + | --------- ------- | + | -queues -DPRC | + | -buffer pools -DPMCP | + | -Eth MACs/ports -DPIO | + | -network interface -DPNI | + | profiles -DPMAC | + | -queue portals -DPBP | + | -MC portals ... | + | ... | + | | + +--------------------------------------+ + +The MC mediates operations such as create, discover, +connect, configuration, and destroy. Fast-path operations +on data, such as packet transmit/receive, are not mediated by +the MC and are done directly using memory mapped regions in +DPIO objects. + +Overview of DPAA2 Objects +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The section provides a brief overview of some key DPAA2 objects. +A simple scenario is described illustrating the objects involved +in creating a network interfaces. + +DPRC (Datapath Resource Container) + + A DPRC is a container object that holds all the other + types of DPAA2 objects. In the example diagram below there + are 8 objects of 5 types (DPMCP, DPIO, DPBP, DPNI, and DPMAC) + in the container. + +.. code-block:: console + + +---------------------------------------------------------+ + | DPRC | + | | + | +-------+ +-------+ +-------+ +-------+ +-------+ | + | | DPMCP | | DPIO | | DPBP | | DPNI | | DPMAC | | + | +-------+ +-------+ +-------+ +---+---+ +---+---+ | + | | DPMCP | | DPIO | | + | +-------+ +-------+ | + | | DPMCP | | + | +-------+ | + | | + +---------------------------------------------------------+ + +From the point of view of an OS, a DPRC behaves similar to a plug and +play bus, like PCI. DPRC commands can be used to enumerate the contents +of the DPRC, discover the hardware objects present (including mappable +regions and interrupts). + +.. code-block:: console + + DPRC.1 (bus) + | + +--+--------+-------+-------+-------+ + | | | | | + DPMCP.1 DPIO.1 DPBP.1 DPNI.1 DPMAC.1 + DPMCP.2 DPIO.2 + DPMCP.3 + +Hardware objects can be created and destroyed dynamically, providing +the ability to hot plug/unplug objects in and out of the DPRC. + +A DPRC has a mappable MMIO region (an MC portal) that can be used +to send MC commands. It has an interrupt for status events (like +hotplug). + +All objects in a container share the same hardware "isolation context". +This means that with respect to an IOMMU the isolation granularity +is at the DPRC (container) level, not at the individual object +level. + +DPRCs can be defined statically and populated with objects +via a config file passed to the MC when firmware starts +it. There is also a Linux user space tool called "restool" +that can be used to create/destroy containers and objects +dynamically. + +DPAA2 Objects for an Ethernet Network Interface +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A typical Ethernet NIC is monolithic-- the NIC device contains TX/RX +queuing mechanisms, configuration mechanisms, buffer management, +physical ports, and interrupts. DPAA2 uses a more granular approach +utilizing multiple hardware objects. Each object provides specialized +functions. Groups of these objects are used by software to provide +Ethernet network interface functionality. This approach provides +efficient use of finite hardware resources, flexibility, and +performance advantages. + +The diagram below shows the objects needed for a simple +network interface configuration on a system with 2 CPUs. + +.. code-block:: console + + +---+---+ +---+---+ + CPU0 CPU1 + +---+---+ +---+---+ + | | + +---+---+ +---+---+ + DPIO DPIO + +---+---+ +---+---+ + \ / + \ / + \ / + +---+---+ + DPNI --- DPBP,DPMCP + +---+---+ + | + | + +---+---+ + DPMAC + +---+---+ + | + port/PHY + +Below the objects are described. For each object a brief description +is provided along with a summary of the kinds of operations the object +supports and a summary of key resources of the object (MMIO regions +and IRQs). + +DPMAC (Datapath Ethernet MAC): represents an Ethernet MAC, a +hardware device that connects to an Ethernet PHY and allows +physical transmission and reception of Ethernet frames. + +- MMIO regions: none +- IRQs: DPNI link change +- commands: set link up/down, link config, get stats, IRQ config, enable, reset + +DPNI (Datapath Network Interface): contains TX/RX queues, +network interface configuration, and RX buffer pool configuration +mechanisms. The TX/RX queues are in memory and are identified by +queue number. + +- MMIO regions: none +- IRQs: link state +- commands: port config, offload config, queue config, parse/classify config, IRQ config, enable, reset + +DPIO (Datapath I/O): provides interfaces to enqueue and dequeue +packets and do hardware buffer pool management operations. The DPAA2 +architecture separates the mechanism to access queues (the DPIO object) +from the queues themselves. The DPIO provides an MMIO interface to +enqueue/dequeue packets. To enqueue something a descriptor is written +to the DPIO MMIO region, which includes the target queue number. +There will typically be one DPIO assigned to each CPU. This allows all +CPUs to simultaneously perform enqueue/dequeued operations. DPIOs are +expected to be shared by different DPAA2 drivers. + +- MMIO regions: queue operations, buffer management +- IRQs: data availability, congestion notification, buffer pool depletion +- commands: IRQ config, enable, reset + +DPBP (Datapath Buffer Pool): represents a hardware buffer +pool. + +- MMIO regions: none +- IRQs: none +- commands: enable, reset + +DPMCP (Datapath MC Portal): provides an MC command portal. +Used by drivers to send commands to the MC to manage +objects. + +- MMIO regions: MC command portal +- IRQs: command completion +- commands: IRQ config, enable, reset + +Object Connections +~~~~~~~~~~~~~~~~~~ + +Some objects have explicit relationships that must +be configured: + +- DPNI <--> DPMAC +- DPNI <--> DPNI +- DPNI <--> L2-switch-port + +A DPNI must be connected to something such as a DPMAC, +another DPNI, or L2 switch port. The DPNI connection +is made via a DPRC command. + +.. code-block:: console + + +-------+ +-------+ + | DPNI | | DPMAC | + +---+---+ +---+---+ + | | + +==========+ + +- DPNI <--> DPBP + +A network interface requires a 'buffer pool' (DPBP object) which provides +a list of pointers to memory where received Ethernet data is to be copied. +The Ethernet driver configures the DPBPs associated with the network +interface. + +Interrupts +~~~~~~~~~~ + +All interrupts generated by DPAA2 objects are message +interrupts. At the hardware level message interrupts +generated by devices will normally have 3 components-- +1) a non-spoofable 'device-id' expressed on the hardware +bus, 2) an address, 3) a data value. + +In the case of DPAA2 devices/objects, all objects in the +same container/DPRC share the same 'device-id'. +For ARM-based SoC this is the same as the stream ID. + + +DPAA2 DPDK - Poll Mode Driver Overview +-------------------------------------- + +This section provides an overview of the drivers for +DPAA2-- 1) the bus driver and associated "DPAA2 infrastructure" +drivers and 2) functional object drivers (such as Ethernet). + +As described previously, a DPRC is a container that holds the other +types of DPAA2 objects. It is functionally similar to a plug-and-play +bus controller. + +Each object in the DPRC is a Linux "device" and is bound to a driver. +The diagram below shows the dpaa2 drivers involved in a networking +scenario and the objects bound to each driver. A brief description +of each driver follows. + +.. code-block: console + + + +------------+ + | DPDK DPAA2 | + | PMD | + +------------+ +------------+ + | Ethernet |.......| Mempool | + . . . . . . . . . | (DPNI) | | (DPBP) | + . +---+---+----+ +-----+------+ + . ^ | . + . | | . + . | | . + . +---+---V----+ . + . . . . . . . . . . .| DPIO driver| . + . . | (DPIO) | . + . . +-----+------+ . + . . | QBMAN | . + . . | Driver | . + +----+------+-------+ +-----+----- | . + | dpaa2 bus | | . + | VFIO fslmc-bus |....................|..................... + | | | + | /bus/fslmc | | + +-------------------+ | + | + ========================== HARDWARE =====|======================= + DPIO + | + DPNI---DPBP + | + DPMAC + | + PHY + =========================================|======================== + + +A brief description of each driver is provided below. + +DPAA2 bus driver +~~~~~~~~~~~~~~~~ + +The DPAA2 bus driver is a rte_bus driver which scans the fsl-mc bus. +Key functions include: + +- Reading the container and setting up vfio group +- Scanning and parsing the various MC objects and adding them to + their respective device list. + +Additionally, it also provides the object driver for generic MC objects. + +DPIO driver +~~~~~~~~~~~ + +The DPIO driver is bound to DPIO objects and provides services that allow +other drivers such as the Ethernet driver to enqueue and dequeue data for +their respective objects. +Key services include: + +- Data availability notifications +- Hardware queuing operations (enqueue and dequeue of data) +- Hardware buffer pool management + +To transmit a packet the Ethernet driver puts data on a queue and +invokes a DPIO API. For receive, the Ethernet driver registers +a data availability notification callback. To dequeue a packet +a DPIO API is used. + +There is typically one DPIO object per physical CPU for optimum +performance, allowing different CPUs to simultaneously enqueue +and dequeue data. + +The DPIO driver operates on behalf of all DPAA2 drivers +active -- Ethernet, crypto, compression, etc. + +DPBP based Mempool driver +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The DPBP driver is bound to a DPBP objects and provides sevices to +create a hardware offloaded packet buffer mempool. + +DPAA2 NIC Driver +~~~~~~~~~~~~~~~~ +The Ethernet driver is bound to a DPNI and implements the kernel +interfaces needed to connect the DPAA2 network interface to +the network stack. + +Each DPNI corresponds to a DPDK network interface. + +Features +^^^^^^^^ + +Features of the DPAA2 PMD are: + +- Multiple queues for TX and RX +- Receive Side Scaling (RSS) +- Packet type information +- Checksum offload +- Promiscuous mode + +Supported DPAA2 SoCs +-------------------- + +- LS2080A/LS2040A +- LS2084A/LS2044A +- LS2088A/LS2048A +- LS1088A/LS1048A + +Prerequisites +------------- + +There are three main pre-requisities for executing DPAA2 PMD on a DPAA2 +compatible board: + +1. **ARM 64 Tool Chain** + + For example, the *aarch64* Linaro Toolchain, which can be obtained from + `here `_. + +2. **Linux Kernel** + + It can be obtained from `NXP's Github hosting `_. + +3. **Rootfile system** + + Any *aarch64* supporting filesystem can be used. For example, + Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained + from `here `_. + +As an alternative method, DPAA2 PMD can also be executed using images provided +as part of SDK from NXP. The SDK includes all the above prerequisites necessary +to bring up a DPAA2 board. + +The following dependencies are not part of DPDK and must be installed +separately: + +- **NXP Linux SDK** + + NXP Linux software development kit (SDK) includes support for family + of QorIQ® ARM-Architecture-based system on chip (SoC) processors + and corresponding boards. + + It includes the Linux board support packages (BSPs) for NXP SoCs, + a fully operational tool chain, kernel and board specific modules. + + SDK and related information can be obtained from: `NXP QorIQ SDK `_. + +- **DPDK Helper Scripts** + + DPAA2 based resources can be configured easily with the help of ready scripts + as provided in the DPDK helper repository. + + `DPDK Helper Scripts `_. + +Currently supported by DPDK: + +- NXP SDK **2.0+**. +- MC Firmware version **10.0.0** and higher. +- Supported architectures: **arm64 LE**. + +- Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. + +.. note:: + + Some part of fslmc bus code (mc flib - object library) routines are + dual licensed (BSD & GPLv2). + +Pre-Installation Configuration +------------------------------ + +Config File Options +~~~~~~~~~~~~~~~~~~~ + +The following options can be modified in the ``config`` file. +Please note that enabling debugging options may affect system performance. + +- ``CONFIG_RTE_LIBRTE_FSLMC_BUS`` (default ``n``) + + By default it is enabled only for defconfig_arm64-dpaa2-* config. + Toggle compilation of the ``librte_bus_fslmc`` driver. + +- ``CONFIG_RTE_LIBRTE_DPAA2_PMD`` (default ``n``) + + By default it is enabled only for defconfig_arm64-dpaa2-* config. + Toggle compilation of the ``librte_pmd_dpaa2`` driver. + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_DRIVER`` (default ``n``) + + Toggle display of generic debugging messages + +- ``CONFIG_RTE_LIBRTE_DPAA2_USE_PHYS_IOVA`` (default ``y``) + + Toggle to use physical address vs virtual address for hardware accelerators. + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_INIT`` (default ``n``) + + Toggle display of initialization related messages. + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_RX`` (default ``n``) + + Toggle display of receive fast path run-time message + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_TX`` (default ``n``) + + Toggle display of transmit fast path run-time message + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_TX_FREE`` (default ``n``) + + Toggle display of transmit fast path buffer free run-time message + + +Driver Compilation +~~~~~~~~~~~~~~~~~~ + +To compile the DPAA2 PMD for Linux arm64 gcc target, run the +following ``make`` command: + +.. code-block:: console + + cd + make config T=arm64-dpaa2-linuxapp-gcc install + +.. _dpaa2_testpmd_example: + +Running testpmd +~~~~~~~~~~~~~~~ + +This section demonstrates how to launch ``testpmd`` with DPAA2 device +managed by ``librte_pmd_dpaa2`` in the Linux operating system. + +#. Configure the resource container: + + Configure resources in MC and create the DPRC container: + + .. code-block:: console + + export the DPRC container + e.g. export DPRCT=dprc.2 + +#. Start ``testpmd`` with basic parameters: + + .. code-block:: console + + ./arm64-dpaa2-linuxapp-gcc/testpmd -c 0xff -n 1 \ + -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx + + Example output: + + .. code-block:: console + + ..... + EAL: Registered [pci] bus. + EAL: Registered [fslmc] bus. + EAL: Detected 8 lcore(s) + EAL: Probing VFIO support... + EAL: VFIO support initialized + ..... + PMD: DPAA2: Processing Container = dprc.2 + EAL: fslmc: DPRC contains = 51 devices + EAL: fslmc: Bus scan completed + ..... + Configuring Port 0 (socket 0) + Port 0: 00:00:00:00:00:01 + Configuring Port 1 (socket 0) + Port 1: 00:00:00:00:00:02 + ..... + Checking link statuses... + Port 0 Link Up - speed 10000 Mbps - full-duplex + Port 1 Link Up - speed 10000 Mbps - full-duplex + Done + testpmd> + +Limitations +----------- + +Platform Requirement +~~~~~~~~~~~~~~~~~~~~ +DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the +``Supported DPAA2 SoCs``. + +Maximum packet length +~~~~~~~~~~~~~~~~~~~~~ + +The DPAA2 SoC family support a maximum of a 10240 jumbo frame. The value +is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len`` +member of ``struct rte_eth_conf`` is set to a value lower than 10240, frames +up to 10240 bytes can still reach the host interface. diff --git a/doc/guides/nics/features/dpaa2.ini b/doc/guides/nics/features/dpaa2.ini new file mode 100644 index 0000000..b176208 --- /dev/null +++ b/doc/guides/nics/features/dpaa2.ini @@ -0,0 +1,9 @@ +; +; Supported features of the 'dpaa2' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Linux VFIO = Y +ARMv8 = Y +Usage doc = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 87f9334..be21e8a 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -39,6 +39,7 @@ Network Interface Controller Drivers bnx2x bnxt cxgbe + dpaa2 e1000em ena enic diff --git a/doc/guides/rel_notes/release_17_02.rst b/doc/guides/rel_notes/release_17_02.rst index 357965a..a27f6b7 100644 --- a/doc/guides/rel_notes/release_17_02.rst +++ b/doc/guides/rel_notes/release_17_02.rst @@ -15,7 +15,6 @@ DPDK Release 17.02 firefox build/doc/html/guides/rel_notes/release_17_02.html - New Features ------------ @@ -250,6 +249,17 @@ New Features See the :ref:`Elastic Flow Distributor Library ` documentation in the Programmers Guide document, for more information. +* **Added a new driver for NXP DPAA2 - FSLMC bus.** + + Added the new bus "fslmc" driver for NXP DPAA2 devices. See the + "Network Interface Controller Drivers" document for more details on this new + driver. + +* **Added a new driver for NXP DPAA2 Network PMD.** + + Added the new "dpaa2" net driver for NXP DPAA2 devices. See the + "Network Interface Controller Drivers" document for more details on this new + driver. Resolved Issues ---------------