From patchwork Tue Apr 11 13:49:18 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Hemant Agrawal X-Patchwork-Id: 23484 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 2459DCFA8; Tue, 11 Apr 2017 15:50:01 +0200 (CEST) Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on0066.outbound.protection.outlook.com [104.47.36.66]) by dpdk.org (Postfix) with ESMTP id 7F3A7BD34 for ; Tue, 11 Apr 2017 15:49:59 +0200 (CEST) Received: from CY4PR03CA0018.namprd03.prod.outlook.com (10.168.162.28) by BY1PR0301MB1285.namprd03.prod.outlook.com (10.161.206.143) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1019.17; Tue, 11 Apr 2017 13:49:57 +0000 Received: from BN1BFFO11FD031.protection.gbl (2a01:111:f400:7c10::1:102) by CY4PR03CA0018.outlook.office365.com (2603:10b6:903:33::28) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1019.17 via Frontend Transport; Tue, 11 Apr 2017 13:49:56 +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 BN1BFFO11FD031.mail.protection.outlook.com (10.58.144.94) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.1019.14 via Frontend Transport; Tue, 11 Apr 2017 13:49:56 +0000 Received: from bf-netperf1.ap.freescale.net (bf-netperf1.ap.freescale.net [10.232.134.28]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id v3BDnjFp000706; Tue, 11 Apr 2017 06:49:53 -0700 From: Hemant Agrawal To: CC: , , , , , Date: Tue, 11 Apr 2017 19:19:18 +0530 Message-ID: <1491918578-4902-3-git-send-email-hemant.agrawal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1491918578-4902-1-git-send-email-hemant.agrawal@nxp.com> References: <1491725483-6619-1-git-send-email-hemant.agrawal@nxp.com> <1491918578-4902-1-git-send-email-hemant.agrawal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131363921968498584; (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)(39860400002)(39840400002)(39450400003)(39380400002)(39850400002)(39410400002)(39400400002)(2980300002)(1110001)(1109001)(339900001)(199003)(189002)(9170700003)(38730400002)(5660300001)(86362001)(6666003)(104016004)(47776003)(6916009)(23676002)(97736004)(8936002)(356003)(8676002)(50226002)(85426001)(305945005)(2906002)(2870700001)(189998001)(81166006)(2950100002)(33646002)(6306002)(8656002)(77096006)(54906002)(36756003)(110136004)(105606002)(53936002)(50466002)(5820100001)(2351001)(106466001)(50986999)(76176999)(4326008); DIR:OUT; SFP:1101; SCL:1; SRVR:BY1PR0301MB1285; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; MLV:ovrnspm; A:1; MX:1; PTR:InfoDomainNonexistent; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BN1BFFO11FD031; 1:ahGZmhNzVMhf4jfHbQj4S5d8mVK1BsJqfEGT5ZF1pMHfcOxzNZCU+qyyRg/lZddBXjQP28Mq9rmK05jRyHG/nmHKYbGxdkeYB3sXn7mxp6fYtzSBDCxIGM8HsZtsAJSB6fK9rhXVvp4LOCWtHYf6Nr0vF3g+vn9sV8dLKz4XzMfs8LoML8b4lpv2R0H9h4X7PE95ksvZ2cyTWVAlevl2ae9Fdu5h3UlNRwjau7+oAvhzb8peqS2WzkA+yfS7BhFRupXoOug18ynY3D2yhdG3YcwUzCqFDpKyN0zRij7xZYJpo9g0ao/LRGVABA7ggu3Ns0ImydM1SHyL23zob4A4CDsYeATlJLwykakpzTKFm7z9PHjUY/vI+dW0mga3qSMUXJa8K9lVY6zNvoLXqkOhNBTWqERrhclm5G8OUCF2fI8UWfbAdYw38ZSTX86iz7trmxsFoMmYn/GN23DlkntiOOIzSe5qJ5MW74oMIQYLRyedcOFS9MJ23ZM3xNhqrj/uxOtQt+7vI7AMeZKrSKOM96KavTxhTb56W82lBRytrTKjs5x/AtsyyPC5UY/ty73DL7gsWHjmXjRyzTqZPg+IiGfARF+taRsanRc9lKXH8YsejVsnNe96PQZflIGDY4O7IvS6kiCRr1ZOulO6LfDerQKczrU+I7fWAqe3lpC0Z8Q= X-MS-Office365-Filtering-Correlation-Id: eb66a6fc-4dff-42c1-a637-08d480e1a3b0 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(2017030255120)(201703131430075)(201703131517081); SRVR:BY1PR0301MB1285; X-Microsoft-Exchange-Diagnostics: 1; BY1PR0301MB1285; 3:JxsvShWEwJI+k2Uja8XUFH6FYMHK6kVLOn2iFBPZWeRKt6OLqAAPx0BpBHVPuTKnwHD60FabF98VgNXI7DZAVrSj209n/K9iLXDvJBcKLEVWSM3NLeQaDgohlF40GzKazvIGhT1x7mFRgKWur95/bG1wGCoQv0HecJO0lQL4EqUkn0vSbofYQRiHzXmWc1o3hZn6uIFke0av8goUJd3zDX6MEIsByhjS9YG+iadrs3jV9SCrxcBCmAvi2imaH6idNay3tcv159J1PK5XwuvrtDJgsl6wgR2HWiRsTzRhzA6wQ+hS2iXOaMes1touWicKt1KBkpKeIC4iChmA8a54fZvDdztu+uwzN4/uIG/9MwTwoZ0etV0zd5O8k4mOXDlfd8AuRgYFM/gkKhlbXKysZ4w/epWlP6H4qm1kWUkKqmkehb++YWRCD44xim3RR0FEdU3+KQYVo7gY/YNhuQ208Q== X-Microsoft-Exchange-Diagnostics: 1; BY1PR0301MB1285; 25:ulqazFfD6fY8p3hFW3gcfxINeqYqiJIEM+nz3+YA2SjcrC3QUlQqfoNaTU4EZ5mEgW8TAF8MHnj6UWBRVXznn7/iVUYGhRWO05BYJqvjVAJCYZ9dDVAAyiHgXRIpm2UOPPEgWCukXL9uUgDYdAEq1Juw4YIqOhAupV48DweeUdL9+VWzX0qr2scPqK+4U+Lm8A1QS/AjH7Ley1/DpDNBl8vCeoP2awsd+/Zf9V29s0qdC05ryYZe2KD+l04dr8u/1ARhbjiUlgQaiKhjvsvrfNTbcHdCXIHkvcqeM2DYXCo2L+xwhjRZIVszVYMDZdTr5VTSNpispikxeDf1tK7y3ecbIYfiuDXun59WZuvohRcvhuSpS+oykSDiUdT2YWDUYP4brz/FDWZQxFcV5rlPxrdq3Wlv6uyyoTRnv5fBB5A+oJgK9spqU77uvGLf+lQtxr3Td5XnB2UxSUkeMbe2cw==; 31:/1lLE9AD8YPoGpYuQsqyEJuOn6ULidxAWOWGaoG8+i2F53bAqdpO6Gzz5dzpsvdHe+h82xc1R5UE7zDcshmztVcSz2a7qXbJrMqY77t0DdY0eof8lc58rKdVmUrX8S/5KdZ7I96+ergpeScN09aOd9B2UOjWX0FWfjmbRoEQH9LSvw0+Tzi7Jd1UZelVf9BC6qB4mKh1+pMGR8cy01OEUKzNk9Tu/nbLvjohYdSn2l3oHRBMmRMCOE4hzSZAEiyKuS4OCJz4f9HQpd8UsEsnhw== 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:(6095135)(601004)(2401047)(8121501046)(5005006)(13015025)(13024025)(13017025)(13023025)(13018025)(93006095)(93001095)(10201501046)(3002001)(6055026)(6096035)(20161123563025)(20161123561025)(201703131430075)(201703131441075)(201703131448075)(201703131433075)(201703161259075)(20161123556025)(20161123565025); SRVR:BY1PR0301MB1285; BCL:0; PCL:0; RULEID:(400006); SRVR:BY1PR0301MB1285; X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BBY1PR0301MB1285=3B4=3AwhF?= =?utf-8?q?RnB0rQCaiO7Fds4S/INm7kav3n/oq1xGlkEXIjYQMR6hXg3Jh/BCp/iq?= =?utf-8?q?NVPCm44J9fByLs9lufI86azKhxXZKFxKCAsG5U30CKOa9WyuMN5+yZnx?= =?utf-8?q?mD33tRaCj5wZTEd2mFMemT2/mqu0Sr1MlTSPWsweYPf8j9ES1dolGv+2?= =?utf-8?q?51vXbn7k1zfs1r9ISSCo9+G16Ob7q8XCOJvMEOI7LNSr7DbqHwLWSr1+?= =?utf-8?q?E4apa9NfrANSgYR+WbgAn91VeKTtPjQHLRhT+FGJI0t8rGw8hVNRAdck?= =?utf-8?q?0zVhnzf5lRLf5rlEboKbm3bphwr4ZMjKYHIB8Pp5AE5ITbqeyskxp0w6?= =?utf-8?q?OOe481jr8rBRM3ZtnZ26rnOonaAjDiAecNVp5YFcID+opp+UgVWI1Lb2?= =?utf-8?q?EQ7jgdj2JoBkIjTQhvBef1rYH/0+Oa2KORhKgHNaX/A8mCkScx0h0w4a?= =?utf-8?q?CMqzHOtzV5tttph2TQM88IFtQdfbdghyLKiTMxgDZaj0xCKZk4qtVPxq?= =?utf-8?q?nLI6eUeKsED4Q1iKdBFJQ0YFSlh0PVNibmQ0ZEGJcTJ0RIe19bMtExhn?= =?utf-8?q?26+7cvaa9oFE2VCIY175r2vTOySiOjvE8FExFdtvmvPaoyoUjaxVHM9H?= =?utf-8?q?YMmRY7wRVHbTX0gIJxwW7PLHR8D77SIz7aKDn8cV5MBO/z3EZTUCX2hR?= =?utf-8?q?bmSae8fPMF8+3sLZhayHpmR1kCefQsE615jDikzL3F5Eck3hYVZ2FjGi?= =?utf-8?q?qjMPlbBVqd1Aqm6Ccy3k2ZsJBXwqZndoQMAyRUgEwgTu7TlRlhFLigwN?= =?utf-8?q?VBBl6G+DEC17ykqTBuhis0Scql9F5eXrty78d2Bh49EMmTbrN2BwLejd?= =?utf-8?q?RptxUYnk5RWtVg2/qE/MDrDiPe69TjKTV8IR2YviifYMfo00xDNzA/YM?= =?utf-8?q?51T0dqetWHVm1jfk+AVF7ey+EgHT7+Wt7MlLJP0o+ooYMbk65q8JT7Pc?= =?utf-8?q?w7UQpgcx+xV580v2Ne+KElwACV3Z7YFO8QYQTBqUaAiDL6txhOrssLkA?= =?utf-8?q?Wv8FBHdak5rWQep+xRBLYZl0x30n3SOGNs3PX/L8YXEBr58Mj2w3LDH/?= =?utf-8?q?lM26eZZPmWzMu+RGt1TgS5QU3ZHQiUdGAd8h751aWAwRHO13XHBgMqf7?= =?utf-8?q?GB5OJs7lQW04RIBNEpLK1rhv+IKK1?= X-Forefront-PRVS: 0274272F87 X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BBY1PR0301MB1285=3B23=3AzW?= =?utf-8?q?/cedGi+I96PF4yndJdiii8WdOpqId24mA2Pp483PwQCTqRDDvFLyMs7f?= =?utf-8?q?OnVFDITdB092mWTk7FIlgwzuUo17fz6b+r6E/wGqiiODO0Zs95ZCPukO?= =?utf-8?q?q2sans7BIKjvJKkoYoPvj9OkufZ4Dnhf8wGARpzWIqj1Ccud6yGVxqrf?= =?utf-8?q?Vp7Lj2CIacsHJHkuuTCyWVH8GlMNgFCBLwHk2PgOVsfCoyBqlVZW+xOz?= =?utf-8?q?lG4gbmc2Y8lP1bcdGhhcAfAEYbrmfyqJlohyr6iP6Uvt8o5A6IZUm6W4?= =?utf-8?q?G/s6WrJ72YNuzh/H0xooUsLVqM9f9aBUfYemeG24NubVdMGGmn78LCLq?= =?utf-8?q?zClKmAHoM1zQJ5NATmq1zVcAUsjJaBgWcr8+HKMmILcn99Ly+6D/w1hg?= =?utf-8?q?9Rq7chHTQGM54yPbDrvp+C1AwvfspCWdfWKEBIlJf2lXVT83rZV+85QC?= =?utf-8?q?31jCmvjd08kp9SlZtsWiyFM1c2DacVpwQyVwt+LWXD0f6tRFdN565HV5?= =?utf-8?q?zSkZQSBs2lFhh/OS9QpSCAZiE8x5ftU9VI4GpEdX0ojn1/MAAHRkMVz+?= =?utf-8?q?jAlR4L2V32rVxPtA2Cf2QfUlmeDDScWuExmhRyakgJ55k7nZN8KuZW7v?= =?utf-8?q?ymed9c+tkFi2yu7tTR8fBPE4A1+KdBMRHTekN+MCvXWEK3O1T2DDEdSo?= =?utf-8?q?S0JRVCDcOwb0tv+4hOPPhli4V3drbkQV9SSzwVYc+1oDoROqBKQBjT2H?= =?utf-8?q?SYAlGPD1DVEVdNYi3Mz8kcD7Br36l9HOpTkK4/tOR8hQalIcyr+seQwY?= =?utf-8?q?8S1Q9LP91EpmP0NLs/eYpwL2+JqphSAYTErId3XCQkTB0Nm2kPBBEtYH?= =?utf-8?q?LzOVu6IYjdG5KVIqdxAfiEdI2TCQ/N3DZLQbxtoPlqzL7U/k7UQvQ5au?= =?utf-8?q?Lz5KAdjEIlLntuYmEn5uDqlM2+rgoFXtz3z77aEWL1a+1AZqqjGBymjH?= =?utf-8?q?eL06q27THOaZ8OuHSiGlrkGhihgW4VBfMUkNgQVLAGkG6zQFz70OKRZH?= =?utf-8?q?L/BVEcqbQ3l+I1KYo2sjA+zShcPP1FnD00V+dpCiVpQ9PUjrspiD3R8/?= =?utf-8?q?dM2Taxqc2ZQ0GahaH8NeeEXlwx/Xd30rqTH/ikDRv5siMagkdAtXWvHY?= =?utf-8?q?RP11jsJP45zsQ0IvQzjADWpkxrjyL53SNW9S6EULhxJgD0d7t7hnKzMZ?= =?utf-8?q?9InHbd/1j0LNZPwwu8nWb6I0O+zgHV2ZtQx/fA8uIDMINN0zCBwJr2DA?= =?utf-8?q?60aod/lHsnX3WyGUct/vJrnE+57sil5VsyMBv2/Iv+CGey?= X-Microsoft-Exchange-Diagnostics: 1; BY1PR0301MB1285; 6:uEmorZMm3RjVoNczylmjDut0jez8gl1/JE1Y7/HHGaiMgOEk7W6BaI4E3adQxTqU5ROOD6lAs+yxjmQElf16n7PsQ+iZLvknoKmNBpfH6HM4cBXUIrgTC/2et0bSwX1Ty7DzS5rHYBWeKKHsdquuAJ7LGb1WQNhedhfzEJgUiJT4y8tpIvqIsEAwDrYTpgtzJfVm2/XHmT94il9+dlrZHZ3NpEG6sawu/3zzjLWBrolUY28KuW4JFvnW3vmJyjUs5zMCwhi6bfj1F/pY0Vm/dZLZBsgzFKw+ovSf1luPSYKgbHjijxTITEOyMpOlf+Esf/QLoxUPJdpFQ6BFh74gG9UFtxpMjdY7xOC2M0ZYrV+XH7VUMZ4SwzftBaEQoJNjVV+GtUZEiriVLtHYNWooK/aFLN9wna6KaoEEpIV6ih3nJN422tVYJgx+SrNDXE8Osh5DCQ5nZCnScasq1i+EEw==; 5:1cIFEYCLJv62oWn3+YIZ4DyP8hvWnmmAZeaQexA4Ne3+h7h/arEDQujkCwT7sB6+SYOklmAxtU+1n4ayvZZlVz2JS1N136snTAfaUJNq1p7+fCP2cm+SBKoeWkMkncis2rqC2Mz3feEA4+3tq0j3Xzz07gktQJddKWw4h4qMqvaIAAtdWtP4fWh3C/PKdts6; 24:fE/QK44+FoVmwbaaItbKP3NbTIqVKFLBRwbkZp59/Iv3hRg+0zHQwLoay7T/aH5Hv9m0vY+eo/DyatZS1mY3vq7fHn4d7n70hsoJLjQGDW8= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; BY1PR0301MB1285; 7:hN1LrvrcuFJBhC3LBKmh4MrMuiRzheii7HNoXaBytZ17aIVG8rWvlDZa1/z5kEDRKlvNqwsqvJzqY/UnF3Q1kqTzXEPwGFw3kfKcfiXJ8lXOS7LJ1DQIkah5dPpiFDnzzysMbRfAdWVGKRbB/xM+8t86g08xrRM9EN9QLPZm3M9SDiLPYO/gbZ5OQGif69XQ1hqeikgkhK8IV3uXWsj8W7sfM8fKgadTn6gA5kaumLiq6PNymBFzwLuPe60a6uRi7sdAhDB2Kqw5+5djGpMbrvZKV1l2JerYxnI1YQbly28x8T6LHNIVFvvrFj3cGwmoZ885ULsXJmzWdPPWRlnpYA== X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Apr 2017 13:49:56.6470 (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: BY1PR0301MB1285 Subject: [dpdk-dev] [PATCH v12 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 | 613 +++++++++++++++++++++++++++++++++ doc/guides/nics/features/dpaa2.ini | 9 + doc/guides/nics/index.rst | 1 + doc/guides/rel_notes/release_17_05.rst | 11 + 5 files changed, 635 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 61e8fa2..05f2f5f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -378,6 +378,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..46225b6 --- /dev/null +++ b/doc/guides/nics/dpaa2.rst @@ -0,0 +1,613 @@ +.. 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 `_. + +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 3305e80..03391d0 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -41,6 +41,7 @@ Network Interface Controller Drivers bnx2x bnxt cxgbe + dpaa2 e1000em ena enic diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst index bf4afe0..5f9d807 100644 --- a/doc/guides/rel_notes/release_17_05.rst +++ b/doc/guides/rel_notes/release_17_05.rst @@ -16,6 +16,17 @@ DPDK Release 17.05 xdg-open build/doc/html/guides/rel_notes/release_17_05.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 ------------