From patchwork Thu Jan 19 13:23:29 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Hemant Agrawal X-Patchwork-Id: 19783 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 CC273F95F; Thu, 19 Jan 2017 14:25:09 +0100 (CET) Received: from NAM03-DM3-obe.outbound.protection.outlook.com (mail-dm3nam03on0083.outbound.protection.outlook.com [104.47.41.83]) by dpdk.org (Postfix) with ESMTP id 83092D59A for ; Thu, 19 Jan 2017 14:24:25 +0100 (CET) Received: from BN3PR0301CA0007.namprd03.prod.outlook.com (10.160.180.145) by CY1PR0301MB0748.namprd03.prod.outlook.com (10.160.159.154) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.845.12; Thu, 19 Jan 2017 13:24:23 +0000 Received: from BY2FFO11FD028.protection.gbl (2a01:111:f400:7c0c::104) by BN3PR0301CA0007.outlook.office365.com (2a01:111:e400:4000::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.860.13 via Frontend Transport; Thu, 19 Jan 2017 13:24:23 +0000 Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=nxp.com; nxp.com; dkim=none (message not signed) header.d=none; nxp.com; dmarc=fail action=none header.from=nxp.com; nxp.com; dkim=none (message not signed) header.d=none; 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 BY2FFO11FD028.mail.protection.outlook.com (10.1.15.217) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.803.8 via Frontend Transport; Thu, 19 Jan 2017 13:24:22 +0000 Received: from bf-netperf1.idc ([10.232.134.28]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id v0JDO4ee015351; Thu, 19 Jan 2017 06:24:19 -0700 From: Hemant Agrawal To: CC: , , , , , , Hemant Agrawal Date: Thu, 19 Jan 2017 18:53:29 +0530 Message-ID: <1484832240-2048-5-git-send-email-hemant.agrawal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1484832240-2048-1-git-send-email-hemant.agrawal@nxp.com> References: <1484679174-4174-1-git-send-email-hemant.agrawal@nxp.com> <1484832240-2048-1-git-send-email-hemant.agrawal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131293058623096843; (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)(7916002)(336005)(39850400002)(39410400002)(39380400002)(39840400002)(39450400003)(39860400002)(39400400002)(2980300002)(1109001)(1110001)(339900001)(189002)(199003)(105606002)(106466001)(31430400001)(50986999)(85426001)(356003)(110136003)(38730400001)(2351001)(47776003)(92566002)(104016004)(626004)(76176999)(54906002)(33646002)(77096006)(68736007)(50466002)(8656002)(86362001)(36756003)(6916009)(81156014)(305945005)(2950100002)(8936002)(8676002)(4326007)(6666003)(5660300001)(81166006)(97736004)(50226002)(189998001)(5820100001)(2906002)(53936002)(6306002)(2870700001)(23676002); DIR:OUT; SFP:1101; SCL:1; SRVR:CY1PR0301MB0748; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; MX:1; A:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BY2FFO11FD028; 1:yxJ9KQzer6P1wxoTvm+87KlUkemGdc9i9j0tZgmFTCJKFzehBSmkJ3h32F9tvMbhcSNccdh8B1DXTepuZnDbzEOSiQ39g2F5vYManHjTm76CUrVcsggzlkw1jPy6CqUJ21U280n4OseIGmfm+S/IsVzx5t95pYOMrcsJBKSBLyTrvvaxtw7gCJ1qdUrWzJCVjmoic6c8nCAeYPJ+ICeHhIPiqhcoljskY0QrVWzu3KflIGjoScsQ28IynAvNRqp4IPlhp0/1AULphE4sWWMRtyYwl3mBp3nicJBAM6COAEN3S434Jxdj/O5h9CDHL/AioW2Gk5g9YSXKFfI+DQru73UOvKvXXazKr5V7nVkD977X++RA01qaKDdhgDAMgHFtVb9JNEpQOAtWlkeHs2WzJARc7z0H5mnkRmRmB9BH3ZphrUwv9GwzUTY+0V6FDDzdMFKpukbjyPj9RdyUrbPMR0H3TqbqczBDVgmI0saVsuwXy+90BPbAj2s/74liBm62/z4YVVnMzM8tn6WO4Fdn8EIa+MkNBUJ6g6NfoAWyiyoZU1GgPQegy/FEsqIIjo8av7LusS0VcgvNeiFtmHby+R5959rbxIU0xQdl+UgUQsVRhBhKixsunF+71ChN5uYft3n5BsZqXxybTk+q45GoWnH0fC6TI8haHEXN0P0rhKdOGYOM6Ud6HY+vNwwTGZLrQHS4xkxyfA7NvwG5uUglw5kSYVABnEtPVRQo5MFKoLsGbFlDjOEJo5VxS5i3Vh0q X-MS-Office365-Filtering-Correlation-Id: ffd4fa66-6964-4cfd-480b-08d4406e7b2b X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001); SRVR:CY1PR0301MB0748; X-Microsoft-Exchange-Diagnostics: 1; CY1PR0301MB0748; 3:labEzgRZgwrb5bwzpHuTsn+txOoq9ZcLUl2gXySeyzVOYbda9GF6XhALLJwDrxaLe+R2xqNmz7XDP61cjkk/ZHG8wvEmm3fg8FPIssUfnHTlbGFm2w47u4ScFKgVSNbfHOIkhJG4YjAgs1DO6UIwSaFC0yI1U+IKUAJou13Qy3kwdrO8C/FkKhJxFFSMSdoqWuI882oZfwD5wF/P3+2BHPLWg9ga1ER6aOzBlVRlJ27Vq0eX2c0VXAJsSgkC4czGnnSsgcnfOISohtuCQa9FGhpuY4UnhdG/33Ijhf3My5CB9mwnPhW7qcMFwaUwV68Lg7hz6B/eN/MXWZ8T9rP2JJQ/y0sljinUoBIamYs9q272x9z7T9htoldkGlHwPWx/ X-Microsoft-Exchange-Diagnostics: 1; CY1PR0301MB0748; 25:P/RYZef7+lv5T13ExzDgD69WOo7p4OMZGRWfcGtdbuZcA/ZR5nEZaQ5bqhJCR23iZhxC55J6OGmF+8mkFBlqDQSzRjpF6Bv+VqRGoZAOmEWQ5BTCeUgaG7D+IJsYlLqsjW8Q8EJ6Pu1wq4onXgPce4PE+Nw6xF2mVYgYngZeGFBtSifZ9l9l8sM3VWPLhZfjKALSwvuTMa3l2UvcDOYVkkDCR1ahCqT3+ZMY6YAXiArPVZgtz+tBlvWWoYF5tqIpM3+ofzMjaKCleuME7tAeVzDjv7JOuSfn4wDFD0Zc567asrv/z7jN0wtPRxFSGcu2nX0kaDbrlGq8AXWmaBO7/hhCsSNg+xRsQys1ArxZTkANEhNxw9ga+kOSy/GTt3SfVtfy5KCVac1AF5GPSOKmEFZfQ4i+TI96Jy+/MZgVMYAtxj39wjJ3aHwhzfRSPh+QnRZvcJLm0+df+jbdxwmTMqXA26S7PP7N/VpTb7wL1epaHDup8MFXvtj6vGfYlG88JiN2KF0iWYf+KpXTmRSobUW7mXuj+dWp4pb7/zlSWTMWhoJ1tJ2U6wBiuznlNmkeUam5veddwlmcN7K3O9Cv0jTAobeWi0g9p0+D9tXXyR7nmCFfSVuqcjJSr0RxBUAF6eyL2K2+Sm+r8pwGyozf1iNAaDnY3G7SaFn1luRbpA1tx0koOQkwhVRylN95tyE6ncqEAsA2mIuAFDRK70GCof4ZDuG/LpA3cV+GWWVjiopY6J6T/H8C6lZIYrd4E9iYRGM+ji5s7htRf7uh5lZkA4Lb28AzDKYHRLuj0nGeDVTKlmGeHuUYIXEm3UR79u+mv46I8t6Ewaygv+p/dsexzgbON+QMamOT9n6hK21prYGdcBiVtHBXc/4BNlepyKgTH4EkifDjotOocsZZn8RYEw== X-Microsoft-Exchange-Diagnostics: 1; CY1PR0301MB0748; 31:bO+JUkoINAJHxE9bKttFEFnzp2w6kIHGc9l/8jnLcaJ+0X7QPKMRcCQPB4OVr5G7u8vTBkd1JjVpH47nVrj1jksadUf2X3shiFJ0NJ5GPLMpfku3XgcvHsm1Pf1+YPtZacfEdDpldW/04Wsr5sN9h/BVW25XA5vur5Kq+fjCXJNhvbqOR5mU6dSoRpBPsXFot9y1EaduslN+jDBCi6S5BSFnionluJlpyiJzkXXG0MswkKkl+Wi8PSF3GjLy5FODU7XfS4ZG297q5ROmkUw8IA== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(185117386973197)(227817650892897)(275809806118684)(21532816269658)(264314650089876); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6095060)(601004)(2401047)(13015025)(13017025)(13023025)(13018025)(13024025)(5005006)(8121501046)(3002001)(10201501046)(6055026)(6096035)(20161123565025)(20161123563025)(20161123556025)(20161123561025)(20161123559025); SRVR:CY1PR0301MB0748; BCL:0; PCL:0; RULEID:(400006); SRVR:CY1PR0301MB0748; X-Microsoft-Exchange-Diagnostics: 1; CY1PR0301MB0748; 4:u8mba6lG3W2l8CWVvarMA76Onqcg5dAZ8fHrX9iurxU8TtUfNXfKxFLE6HeHilRBi5cfao5JeV8mYOQi5TCjAm0d5UJn0q6dvJE2qKHAY1ddeIFmqQer0Z7YyuZ/FMuDs58R6pgGUbYs2UWG/8IWMvBijL74XogXHh8g/BU4RQJXCr657gDkelpmgc7tpmWHpRwGLQQ2JgEYXA828qFcMO88uNrNMw7WaEqa6Q56VRoWS3aIKpnSANbqRynPzIRYz+zr0iYUXM24II5B69h3Y7Z93Khm8O3CBzTC3JfjgDMl4r1OJqBVfZEC/6ZnLVQsqOaval0hzmO/RPkWspDC9LiCR6XPGGdIias/ZYrEsNnYhOLCuNAlGNoL5VwYzxU4+EEK9XwepBAni8u16dsyNo6klfU6mChXS3qcjDKAXyGINfnC4+ZMd8S96oiX8WpWrQjpjSNUYwrzpbVzsWPHFmEg8drlLMO22UugyXXHa5xIox9Vtt/qP+TxGSciUWKUjlPw3JE5SVMXEOO9au7m3YwtyR/WVdSrJVvKsa09w0Dwl9I4c1/z7j7Npvr3FQIHgbjFKo3GFUOznyZNcNWydPGe4Cl7k07uzIadF+/eYKRzCy9/P0WZX4LTx+Z8aoWSu7F6tLQaKrs5DEpD+LkMPsCw6rcXJUrKVPF7Rnj47k465vOuJCX8mjX8MxOcuoVyVqnBUmZSy9YSXyzpvJoVXiDF6qWEAkgzgCzv8u+ujlCFs+2DU9waaRv7Sd7l0jRWMnVxeLmQgYyzcaxnt3l21V5VVt517OxPE2d4LDlotQQ3Bi1x8aCBasm4Men44ibTkSxMo0wbxJBl37hLazVqed2fFNns4+KKhpNpYMENYJ2QADy1kJnGewnQfQkvCg1KOlir7l6kw3IgIVBwUrLSsdlambtc+fNR6b/ZkM2+i1Y= X-Forefront-PRVS: 0192E812EC X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BCY1PR0301MB0748=3B23=3AGI?= =?utf-8?q?CysRNvAd7xbBFVcQG6U5hSLLb4GhqEYeIeHZPlk0dxcbuPnC5NT6U3Lo?= =?utf-8?q?4EPjZK4aeQw4syYghwHhPGhemU3QpOGO+sx3QvdrJo7gyZAfiM64tWEw?= =?utf-8?q?NtRKYFmWNLZNdXx8WVv5xoDoLB1IxjmrPXK32eWgtprV+OOxQTreBNYQ?= =?utf-8?q?HFHUL1HpXdBU0Aj/KEy+KMsClZulG0HqQX7iRY7Z8I4/XhqvJHBtuqiY?= =?utf-8?q?1gLxa6z8cNHWxedpzOMpl5ltuoGYjSPxJAyD7wtPQ590eTU+1Dgh7OQS?= =?utf-8?q?XnNUpmGLT/1WzPBvig4EA2+7o7kAIZAzJR1vgeW9mxdBZNJRDVpOEWhk?= =?utf-8?q?hXO087BrxGFa3rODPkwNghHpNkxt+n4aWiCBhMmy4ZlaGtWaf74gJnL9?= =?utf-8?q?8fs88/TDr0rBL6gSGvYNUqZBa4BZkjHeuMEZls3+982nQbVaTiHgfu4R?= =?utf-8?q?cx0dd+7t0DS68I9Jdo7I5O9QWgc25UjjKr65rfKpuMj96MFTNxldwpjV?= =?utf-8?q?WQWRyMMGs+RwP71hhfbSstuH+4SyLYsCTecUG19PSfyKmFTLdRjnCIvC?= =?utf-8?q?oW8MEATTq2fRj7GjS/JdY6xQtLA8IEvSyOVSy05bqA9vGifVTMmmZqfl?= =?utf-8?q?DWlLMTjPScyXJk/xrZs2wyXPO8UhCzaCkPqhElUSjFuW3k/09VLUnMnG?= =?utf-8?q?zgtgeoyMOtCjt4u/otJujvOHccg3e+6kvgvL64ISFOHLOGbbokn1p7jV?= =?utf-8?q?a7KfkG56pzhd9haqufcaIHQmCCF7yzWhCyK9d7HFSfy3acaVtVFtJ//U?= =?utf-8?q?BtXqkXUH3LXzlPW3mPTwCRx5BlQ+GylZEz+dRJumhsdPBq3vRpwBR2kd?= =?utf-8?q?pUF6b6wsDyOILqXaS9IPK5D8XMjF+yRr4Zlk2ztSJAiQGU+1A6AmrCHq?= =?utf-8?q?s906foXKuBEiszo0SsEF0KGrlIXVINLWE5GIDVESeoFT+cLhZO4+4C90?= =?utf-8?q?jZXr8zRqgANF1m+rDSrsoM8S/a0VGVK9SA3P7NipQTibU2HioFLdDFRS?= =?utf-8?q?jr/2rFYD8MpTbQU5FjOWSa7d2P3CMBdC74GRPwtcMCfGpiLdoHX40AxO?= =?utf-8?q?l9GxxAHE21xqIv1L5KY6DIUhqmo6Pjxqz4arNgmURU7+O2L5Jg4475tx?= =?utf-8?q?aOx/vkK2MftGt7fVXJy2jIg9a0uIXbU3TiSb4yLWtegFlW+pOu5ytd63?= =?utf-8?q?461sZJDnkwjHWjgMjLwLmFw1SEQMoNArqVCIPP5FHtzwEt1USg6UWahn?= =?utf-8?q?FZM6HaeXSmCbU6tKnJExRvIiqLodpnTLneo26i3hhNpbRIiaVQjlGJTQ?= =?utf-8?q?g9ghBQOMv0H7e1zHVduPYCcm1TSJg9ypXYaalIVyjM0Z/O58Whg7jkyp?= =?utf-8?q?vSsCGsjf5bEJqf/+TraR5kQBnkvoXtqJojL/ABcT4=3D?= X-Microsoft-Exchange-Diagnostics: 1; CY1PR0301MB0748; 6:+HKAFmzNarOjus63ZT4WgqB/JWLTek8Sg0NWJB7LqkNNEcoj+Lx7T1sWD0Czo6qqknubwl6Mg449gFjn5FJiybJMMjjDzNo4eI3Y+Bz2MykdbLtIKU/fy3Zb0XD2zdcN/E42/a+h/7yJ6u6YX2zuGTymF0cNEI388joc+gnBQHOt4MG/42QkMJevub2J0aQfUT5gufwnPY72CiIs9iJcnj9vs2gIxksCYlzbYOKVIVHU8NnbuD7JjlwGYpDgcOcGcgJq9FNOiKtEXBCbF4B9a/sWFcJ555722EuhRHAIJm3Z82Y/0lapoQpHd1jT/QG/sC0/zgSUbkWbBePxUbEfQoYAdmhNKcXh7bAssDZ5+b1X4bgV8hIMI0JYQ9f7p63asuVe4v6s6Gp7SK8l/uHae4eI01xSVYfuu3fbl+eGyaTmOAz+brUsn1T153tbqDAP; 5:vjdLj/SOMUS+IP079kLpxsJb24X08cAKObOFUxvYgVh29Jx0JMHMSZ8L7iMlEOIo380HSrhmu8WHE/fP9ogz9cO7NPMEfweftuIW2MtODsktXdEgHarbbNLAkugVo+rSbk0MaEdYvbW8+e95Sf2FsPlrzefgfSejPYKvHSM4t4rK9iqQIdhMS/6uaq8cZKK6; 24:q5JGracG1/4e1nCOuBXtwnC8gkPwywJRUOY6sDIkb49CmDAwzyZ13yOiEwRdHn3TF0DHLzkyyJi47W8YGkAi0UqvhqFV5xIH4hYBdj+zhQs= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY1PR0301MB0748; 7:S+VKoTXkI83LtorPpKqNmAnhQ4iXhh8S/7Q3IUm0LtK4aYyBusA3MZ8ItnMvpu9aqR36pJM8mlaHpAdHtggPyHCjglMGje6aM7hQ0FRhIIMQ1N7PGmnWrZn93XeNaoBJdG3ndgOlrkmbzy012k5qDNLJzhW0crUaf+pzqOX5T72xbq2SbuHM3rf10mtGLZL1tMMpKOKEhCmiT2x4Dm3vc5zPvMi/KqJqxXgbBa1URMdmIFGhIbB/HJQoawhDN0n0wjdBkT5D37ECxOgDEwwmhkyW2ZIVPXbLgFKRArUvFCy7nYfcSFp5AwKRky2ZNGT5p3vugFbTW5RNRM9C17v9V8mkKT32sGagrqOHmV2k/CuYqohhqlHBSqiYq32DRSNfsY9oHFB+cHfwZSy3sLy6OORxBk1QwiXMdPES1uhjvtGO9/KWf2uJ26uxIctzsS6vN4oeOf7dJVHkN+nmqFQbFg== X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jan 2017 13:24:22.1068 (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: CY1PR0301MB0748 Subject: [dpdk-dev] [PATCHv5 02/33] 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 | 8 + doc/guides/nics/dpaa2.rst | 594 +++++++++++++++++++++++++++++++++ doc/guides/nics/features/dpaa2.ini | 8 + doc/guides/nics/index.rst | 1 + doc/guides/rel_notes/release_17_02.rst | 11 + 5 files changed, 622 insertions(+) create mode 100644 doc/guides/nics/dpaa2.rst create mode 100644 doc/guides/nics/features/dpaa2.ini diff --git a/MAINTAINERS b/MAINTAINERS index f071138..d79e1a5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -354,6 +354,14 @@ M: Alejandro Lucero F: drivers/net/nfp/ F: doc/guides/nics/nfp.rst +NXP DPAA2 PMD +M: Hemant Agrawal +F: drivers/bus/fslmc/ +F: drivers/common/dpaa2/ +F: drivers/net/dpaa2/ +F: drivers/pool/dpaa2/ +F: doc/guides/nics/dpaa2.rst + QLogic bnx2x M: Harish Patil M: Rasesh Mody diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst new file mode 100644 index 0000000..0b30a6f --- /dev/null +++ b/doc/guides/nics/dpaa2.rst @@ -0,0 +1,594 @@ +.. 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 +------------- + +This driver relies on external libraries and kernel drivers for resources +allocations and initialization. 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. + +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_pmd_fslmcbus`` 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_COMMON`` (default ``n``) + + By default it is enabled only for defconfig_arm64-dpaa2-* config. + Toggle compilation of the ``librte_pmd_dpaa2_qbman``, + and ``librte_pmd_dpaa2_dpio`` 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..b2ad6ec --- /dev/null +++ b/doc/guides/nics/features/dpaa2.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'dpaa2' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +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 0ecd720..4d80005 100644 --- a/doc/guides/rel_notes/release_17_02.rst +++ b/doc/guides/rel_notes/release_17_02.rst @@ -15,6 +15,17 @@ DPDK Release 17.02 firefox build/doc/html/guides/rel_notes/release_17_02.html +* **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. New Features ------------