From patchwork Mon Dec 19 20:53:42 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Hemant Agrawal X-Patchwork-Id: 18163 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 2A48EF97B; Mon, 19 Dec 2016 16:21:08 +0100 (CET) Received: from NAM02-BL2-obe.outbound.protection.outlook.com (mail-bl2nam02on0054.outbound.protection.outlook.com [104.47.38.54]) by dpdk.org (Postfix) with ESMTP id 7F17FF969 for ; Mon, 19 Dec 2016 16:20:41 +0100 (CET) Received: from BN3PR0301CA0024.namprd03.prod.outlook.com (10.160.180.162) by BN1PR0301MB0737.namprd03.prod.outlook.com (10.160.78.144) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.789.14; Mon, 19 Dec 2016 15:20:39 +0000 Received: from BL2FFO11FD010.protection.gbl (2a01:111:f400:7c09::193) by BN3PR0301CA0024.outlook.office365.com (2a01:111:e400:4000::34) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.789.14 via Frontend Transport; Mon, 19 Dec 2016 15:20:39 +0000 Authentication-Results: spf=fail (sender IP is 192.88.158.2) 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.158.2 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.158.2; helo=az84smr01.freescale.net; Received: from az84smr01.freescale.net (192.88.158.2) by BL2FFO11FD010.mail.protection.outlook.com (10.173.161.16) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.789.10 via Frontend Transport; Mon, 19 Dec 2016 15:20:39 +0000 Received: from bf-netperf1.idc ([10.232.134.28]) by az84smr01.freescale.net (8.14.3/8.14.0) with ESMTP id uBJFKMhS029110; Mon, 19 Dec 2016 08:20:35 -0700 From: Hemant Agrawal To: CC: , , , , , , Hemant Agrawal Date: Tue, 20 Dec 2016 02:23:42 +0530 Message-ID: <1482180853-18823-4-git-send-email-hemant.agrawal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1482180853-18823-1-git-send-email-hemant.agrawal@nxp.com> References: <1480875447-23680-1-git-send-email-hemant.agrawal@nxp.com> <1482180853-18823-1-git-send-email-hemant.agrawal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131266344398038596; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.158.2; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(6009001)(336005)(7916002)(39410400002)(39860400002)(39380400002)(39840400002)(39850400002)(39400400002)(39450400003)(2980300002)(1109001)(1110001)(339900001)(199003)(189002)(33646002)(36756003)(2906002)(77096006)(2870700001)(104016004)(68736007)(31430400001)(4326007)(85426001)(38730400001)(47776003)(356003)(23676002)(8666005)(189998001)(81166006)(5820100001)(50466002)(8676002)(97736004)(6666003)(2950100002)(81156014)(76176999)(50986999)(305945005)(110136003)(50226002)(86362001)(5660300001)(2351001)(626004)(6916009)(92566002)(69596002)(105606002)(8936002)(106466001)(7059030); DIR:OUT; SFP:1101; SCL:1; SRVR:BN1PR0301MB0737; H:az84smr01.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BL2FFO11FD010; 1:8iwerZZxY7ktc4SEfXEYKp4uLaY3MIgdqcYaY0d+76DBK5rUBMNPvtA8KUOVkUaLIwSOfcz3W5ztOiMgynVYQ6m3u+7Nr58W26qgrIqaupIPuN42KWpx5oUrAxvumrQepYOYNAmhVcxV0xlg7sEPY99qd/PXyyO5JIL1u58b/Vh4uN5xIdbEAQTJ5NcgtapyepWkxDEHCn0ro9v3ppiw7H8hJ+TCNHPRiJ09Cocg5IsdlRj280Sf/BrFkGAEc5Jb5Q/J5t2UCMVHHSzFgxAAXk/peNEL+sPLR0DzlGCg2pb5AquSeBn+i5BoZtkBvw2p2OBH1yGejUq/6WBKvoor2osjnM2KnbUeAr7dAfiSANe4Wn2FqSZ6SR3LKLS4QNm2VNHXuset6Ra4wcQw0wi/gQFfHxVn69J4r/JsdR7QScuAObKMw6jHAjh2ppFfqzWG+0tD3HOO2QJE+nLAKSbLtUGHuNxxyvT05qFG3i9GVhJhKUu3NbelATzUJ+39YjsjSCNaIUcXsCTs0h+0K7ytRAw/NJcd5juAtawNP/I9DRHE3dTDdmSmXfNu2UmeTmOkweM49d1BOObCfbEyd9rCVsF5M3Pw6pG6qhdIXwOeV7/Hkwoc4Pxi/EnXqS/22kJcL87k8G5jzzeKxPiXbckS/Wk1X3R1xWMq4dPaQDc3s04uQzHrn7Y8JQwKZZVcm9gS0J5au2DskQqXaZTldLDhcW4hz1eFd1htZqen9/TEmQH79XTW3r3MQpttuPt9sRF73ke77H55drtSjUzNaTEs0Q== X-MS-Office365-Filtering-Correlation-Id: 9615a7aa-1833-466e-1b4c-08d428229733 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001); SRVR:BN1PR0301MB0737; X-Microsoft-Exchange-Diagnostics: 1; BN1PR0301MB0737; 3:D2X9MleSC5nWK5QcJyYIieVzmvSurfqjuIszUq5lVIqjbkA/Qzsqd7TqeL4YLu9ucXcwUoLigFRjBTyC1EXZkc10q9PxAIe5yi7QuPA81idBp3ezJGz+A8Ut9Qu4ucE7J4RQR8hENqt8D6uQkI3Pi3zEDpJ5MHj851Nj3s0YxdoHfxB98vso275KcDNQFRpjm3fj7AdOqVkNNSiABNCHoBjBcxu5Q8CCM5wEPmPWcv1Fo224sMxrmKiRjO5XD+z7OnmiekXaCablem11mCz9D0g7WX9l+/prfhnhwcOd07JUjTUkZpAvZ/LPuCaSkIJJEkG4QmnNhmgrkVp6Ph7KfuHFYVS31IueBaH/wVG5aK1HnFHiOKge2aXXcnVQq6ZK X-Microsoft-Exchange-Diagnostics: 1; BN1PR0301MB0737; 25:yYDPum/cPB58EstfY/y6WQvj+KwPCUkc3iZp2s5/h5FcOWZfnUX+4WcaXMAm/gsC5BbdD9fXgKSlQBClSwySV9vVvXbS0ZY2tezDD6DwyDQE7hZN8Jdwu4DLHC0+Xh4OU6r45UAmenHjgsi6lel4+OBhFKlhHiO5J8ZmVnSwGl3uh/19uObD9PuvQwpGCTWfGBLLZJ4lU8/GdjSmFyNE/BGnwK+0HPJ5ABw9mtkGo8Ixc3sUSRNVfuoVZi4JQj3mVLfuaFDHQ+9LpGxZuTEeKD8LlxN0ZhHl8NiylzHCrkzL8OMM0c/4IFVZiibTfqD4LMk2zfN7FvgDjRKlftbRI/4t9/kNS0lKMTISNroO0agaVmnjSQxdarGt+cW1BO0K2Rete7uYc8Nmmsi7ZeT3XIpQ4uCpUWWY59BGuWZS3g7LCAEbnergG5oe59O63eQXAD5fKGEpOIg+8m6sowpsILKoi7P7HtbHYEAb4V77muHe7kfla0C2NK+c2sntGv+cCPZlu3PCte/yQYI0nBVD7UFqUX9xDv2Y4vp1U96ECp1ElT015aDmWOgZSn2Pj0zQSHuxZd7RbJmos5+LmbNpR5CuFxX/CtotOTom/u1aP/AxjXJG9BM4mkp5x/izqTmBw3hXyfAvSzTzV33XFVKorkj6mZW59pgbFVBSeMas6WG62NEg36MtLdfc9Io5fT0Iy5ni0Quhs1bC0gpGlevVbtM6n4bctN1ibKdpEb8xsrjRKkEgEYZXWaRr+h0UYlFUF1Pob4YImYYiBB/HmQM8FARroUEkcoAE57i+/hliv3HmQfbIHWCAJ5lxWTCiRxzLCY/ra5H09ruQNkEDPjQVMxSZoIwdD+C4EciYjrLg/eieauk+KxGcc21mk0EP0eleLuyj41LzPKH0NNuRfK6VpA== X-Microsoft-Exchange-Diagnostics: 1; BN1PR0301MB0737; 31:A0XNZDJ2EY3zLsw3mm7dSy+Zl1lXKOPFto2agXHjuw5qSNnk4BJLPO/pMT55D3zapVeNAg8Fe62OiDic68Io+S1nettsnrI9jZNu0k7n37Uep5ePxaRxcWncuo0v4kVXVYUCeisOO3DO7MdBEhHbeiiipIQknFfazIC8+Z3MKgwH3+a+1VxZX8l+vUIahkZcxdGKaji11TOIUoqIU6hDBeqv2TVccX2ZjzryQAj0Nt7Hosfj8sqbuz0Nr71S40MJiZCV7MhaLu1S2DbkQ9zjhovVhha/y6B4bSoMksSUsH9Kx8l6NFP+FX3RCjbXEHC3 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)(8121501046)(13018025)(13015025)(5005006)(13024025)(13023025)(13017025)(3002001)(10201501046)(6055026)(6096035)(20161123561025)(20161123559025)(20161123565025)(20161123556025)(20161123563025); SRVR:BN1PR0301MB0737; BCL:0; PCL:0; RULEID:(400006); SRVR:BN1PR0301MB0737; X-Microsoft-Exchange-Diagnostics: 1; BN1PR0301MB0737; 4:YRRBmeNBBYg+3QKTb2Z0D5d4ZZ50a1O1kFrZ5eGYpV9l6AyccH9tH8YcCqzEeJ2n1b2JkFDw+5g00T2piCOz+bRECIcimqXgetksJfmolJS0LNwPssJtqYNW690QUWfQDSQcpV1svuRSrUyKsx8BXxezOa+AecHtFOu/hd+UhccLs99zMlBcd0SPsETQ/S8iL7MtKSGAuDMTiNduhExRjDh6FXPSM+b+1Np3k6dgigEGgu9Q1p7c8BPhJDlKt9D1/oe0c5EQmW0bgZL/CBNymG/e5yEn6N3kaEECxv6qfgpGjDQfo3VDwGoySup7NQREjrP0KJvXsSTpn8TcTlxPrE/jXj3x1i72x1X4DoOX64lumH51mFuOzjegriq6FUxt8XohPJ920QBxbUTiOEJ2gx0kHwzajG2pA9SfQXodSboQjI48Z9k+mxuyP9QC9bpi2q96IXU5zcLBShqcDBOlixAzkiU7dc44X/vBguvN6YJhGXbwDUxLDKX5A7/PutmMQbzGbNl6gmGNVpnjL9Vx0cILCS7zmeh/T2k8h+qmPy3khpaEvIH7p3GZMmwBIIQmXxSrd3eycghcXyFhW7oG1ALqX0Kw7ZVjSXSCQntwjJt1B9UVahRdnWN3EQtcRfUc5nbSLTOzHneSfwdSBef+f9Q/VDLBoQOWesHV6aOrr17Hm5RMsLg/8i5qWknIKHka/Q82VupXLJdbSfhW4fLfdKdycZ8VIiLvsCxFMGdRB72K15XAnubomZzmA9/HH5nsoIQAYm5gkW+ISLFpzQJFiGSdDSY5HryTWCTIJZi05wHFMqycnH3DROKWc5DdRHgGc33hFzCN0RuEFIun1qluAIyyKmEcheIWl7UT6PLuqsd3Znizwi9fwtwCY/qRAIn4eCRH0+02K/4ctCOfcAcgtBEBBPc0eR+9TayLPjwRR1I= X-Forefront-PRVS: 01613DFDC8 X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BBN1PR0301MB0737=3B23=3A9r?= =?utf-8?q?h2h6LP7p0JYu2qaPDgbU/nEvKivtBq4VUJfizyDgbu1981p/W9360ClH?= =?utf-8?q?ycbp+3ooVUaqZoef7HWqpN5cvpE8Ot51xGHKRg1QzjHU9U0jkpelm/c2?= =?utf-8?q?w2CLX5vWiGWZtCwNq+N+EcR6yDDo/5GcashXyIP+ulcshULbvllevyX7?= =?utf-8?q?OcNjxfq1hlXc9opeDTABYQfOHI2JLNr018sQuf4MNHod9vMZKLnzAvDI?= =?utf-8?q?1EJgpzYtVKJFKqIzFwB5k/zRbGQZS1qoH2yF1BeMQI9viaXMTQRX7XtP?= =?utf-8?q?JucNPp4q98VI0yfTyAfQU1lG58D1fGZeTpbCTSjslfUfpvYjnX3NkxEM?= =?utf-8?q?OjEdC7vtx3IuR9RWa2h9BL5SrgJwi67HNJAyfVCMjrqh/CIJihxHgf2w?= =?utf-8?q?PD+d09kdssxK3/TKnFMGRjgW3/uEVz6aCEicgbhqdLofw6pGQfHYdeOH?= =?utf-8?q?BJy3FSTtspkWo2yc1i0+HiA7ARhtyYMwP6yvtU8K+ANLltvEZ8edUUw1?= =?utf-8?q?rjp6K05QzjSxazFIZMTrJTp78D6yE462BcJMykXMSAAowjhi6SKn6+b8?= =?utf-8?q?sdqz4eJHEwbJUY+igpo7rFJBdrIlIzhLpSKBi/6jDN4D2MXpFPEb4p1L?= =?utf-8?q?tklPPTsrKi+mDlgdZLlou95WO3h4ZtRK2kmvMgvszE3o8SuhVcb0wkbd?= =?utf-8?q?myFlnDiNvPEcHTP0rZGhAkn6UKbAd4Acjf9+o2R/1USdp3e1cCuUUCb5?= =?utf-8?q?6FOR8Y7MSDvoDQiJCJTmvQxYBH5vjcZSq9qOptZ6AN4A1XQAUSnCcwrS?= =?utf-8?q?9El67QEulvVmGAtum3pJweB2R0XGMYU+Vlcle/YMtBGm5FankDyuqdiu?= =?utf-8?q?5ivw7QXGFE9narQl6H3bmcBecCVK+QH+KkDZtLrYUGygbpztEIMaSjQD?= =?utf-8?q?XaNaEHZkpJrCSODGnu7OU24pUdz2fm6Qj2MMhPcJV/4I0L07vAuunnjm?= =?utf-8?q?AeXyHCzrbWAs2ABrJTHfzQxvhvITMTKrwuzASo9OQRwaV+5XvwGfT16D?= =?utf-8?q?sKw2Asjw4qOc7RsqXTnyWPNFYCriccYOHUX2is4+o0Q+pLUAarRhd1uB?= =?utf-8?q?3AciEt4xW2uGQmydYwaOVFowca042CzAwyUus5y7qX/Bgkbk2bk3Rvfn?= =?utf-8?q?DowEHBl3v4l10274O7RHE3RBYhFacTNkD1Gm8cmVW06Mt+27A+RoNSEG?= =?utf-8?q?UHkJK1e4hZrd6Q1UA3v+UldtMd5yvGfvrjAJ9qMrk4RqHKJwBwLiYTl3?= =?utf-8?q?dZT8lILUkC+xs10ezK/EiBS5Xto+hjg0Ob+xpL9VxkW5lWyaDrwTovMl?= =?utf-8?q?HjDPbDmkei9iitB0sxs+wlhgKGGmeougWhyffmt58VWElJQKFVUi9V2i?= =?utf-8?q?Bx10dgmpK1N5OKqdR2YA=3D=3D?= X-Microsoft-Exchange-Diagnostics: 1; BN1PR0301MB0737; 6:3FbdtK+7cjWJ0siqBmNl/q2TCtWmFH1qknlsbaCNhapYkWGv01YdbLWAtazxNouZxo/JvSYLCP6IlYkGkvuP08ndB27ClpIKdL0pE46XkgSf1bGlvmYJUEQjun3sZAGQ5zrjeKV+gdxtieW4DnmFATxyvNCeqwRmMRM+fhtBM9DHVN6hnk4sLFP6v3X7KAHc/UwjtSg00PyLrAF+zb3zUDRi/7RPt3dxZxMwUJKhYE2ZdAPlADPhMMMRSgVUG9D5R2h/jTz9PbiOxR+8D7cesk+ufLBQw/MTzfo32CXveBNlVEY36pK3nZSbRPzggt9iNDUaPWeoni7i/5c/cbTRSabfBqZmeYGaTEtjThbwm5aLbYjai/zu7X01iwUAkZGX1h99fyLOya+G3vjeBrn9laX5L0FMRwA0pukQDKHzBenhkoSte/tHA1J2Rk09/MvJ; 5:VoCyAi9xOfGJlfeVvBOTDceWfNOGsP/suztc4PBkt1TLU6lGWDsXMW/IAmmMpHw7M3O0W4LpJVbs42Cm6F1Ylszx1N+un8G5klmDSdCKSBAuh2qMIK6Lh6WudDTMo3Bs/5C74ZRP5RKkdyBVC5QwZ6XFw2McHFWjItnypvzkrBshUrr99Ddrkna1GMnP2aGV; 24:pbw6GPasPf6AUr7Yf0a70dhaFtzO/cHI2dTvC3+fB+M4xnL9Cx2bsBLaJJ/ENjYWOscDKC1msWQG+JCHZPjavIXjO4J3Vvy6X4snoOV6uMc= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; BN1PR0301MB0737; 7:1nIBw0esAoxMcd3JDXZ+OvYb4mgwR08gVfWfq5SEeIlLY++tGiOoHrK7Mh8XWijOnR8/2ZHio3EkJr6scS+RBLFuLXIsXCuIOr5hE95/36SI0IqgmwEv47kcj6TRUioR5bzQIY1sFOp20S4JG6OMygJUtwZdEO0IccSI7tlALblrHrgPYZeiEVuXRPPTwesxIATnrKKYeattzOwchCmfWDtuIzvWMvjax4u/cMVtW+VUXz5wKTELnkTYpRQBm8xtt9VlUlFyOFdtbd7UQc/jAnljvJE65cTNu2Jdv0E8tycKw4lgwZhtrbpyTlnJCvXvu+Znk6S59028pIKs3Alp2S/1hlaMbQMCojmLufgbZFIYKXM23NvUABPrgdYkiU9ZQbKR8w4jRtP0ehkx9qg7JkHVBuWzjDSpqpdVrEdjKNTct+NwlzSiQLurev8WOF63Zm3bjrddN8BprZMOCRGbjg== X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Dec 2016 15:20:39.4294 (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.158.2]; Helo=[az84smr01.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN1PR0301MB0737 Subject: [dpdk-dev] [PATCHv2 03/34] 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 --- MAINTAINERS | 7 + doc/guides/nics/dpaa2.rst | 596 +++++++++++++++++++++++++++++++++ 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, 623 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 26d9590..2f072b5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -350,6 +350,13 @@ 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: doc/guides/nics/dpaa2.rst + QLogic bnx2x M: Sony Chacko M: Harish Patil diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst new file mode 100644 index 0000000..88c671b --- /dev/null +++ b/doc/guides/nics/dpaa2.rst @@ -0,0 +1,596 @@ +.. 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 92d56a5..fa01662 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 3b65038..3e742b3 100644 --- a/doc/guides/rel_notes/release_17_02.rst +++ b/doc/guides/rel_notes/release_17_02.rst @@ -38,6 +38,17 @@ New Features Also, make sure to start the actual text at the margin. ========================================================= +* **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 ---------------