From patchwork Mon Jan 23 11:59:43 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Hemant Agrawal X-Patchwork-Id: 19885 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 4D08BF978; Mon, 23 Jan 2017 13:01:30 +0100 (CET) Received: from NAM03-DM3-obe.outbound.protection.outlook.com (mail-dm3nam03on0042.outbound.protection.outlook.com [104.47.41.42]) by dpdk.org (Postfix) with ESMTP id 172ADBD28 for ; Mon, 23 Jan 2017 13:00:58 +0100 (CET) Received: from CY4PR03CA0004.namprd03.prod.outlook.com (10.168.162.14) by CY4PR03MB2469.namprd03.prod.outlook.com (10.168.163.147) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.860.13; Mon, 23 Jan 2017 12:00:56 +0000 Received: from BL2FFO11FD039.protection.gbl (2a01:111:f400:7c09::191) by CY4PR03CA0004.outlook.office365.com (2603:10b6:903:33::14) 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; Mon, 23 Jan 2017 12:00:56 +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 BL2FFO11FD039.mail.protection.outlook.com (10.173.161.135) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.803.8 via Frontend Transport; Mon, 23 Jan 2017 12:00:56 +0000 Received: from bf-netperf1.idc ([10.232.134.28]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id v0NC07eb019311; Mon, 23 Jan 2017 05:00:53 -0700 From: Hemant Agrawal To: CC: , , , , , , Hemant Agrawal Date: Mon, 23 Jan 2017 17:29:43 +0530 Message-ID: <1485172803-17288-14-git-send-email-hemant.agrawal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1485172803-17288-1-git-send-email-hemant.agrawal@nxp.com> References: <1484832240-2048-1-git-send-email-hemant.agrawal@nxp.com> <1485172803-17288-1-git-send-email-hemant.agrawal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131296464565262835; (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)(39410400002)(39850400002)(39450400003)(39840400002)(39400400002)(39860400002)(39380400002)(2980300002)(1110001)(1109001)(339900001)(199003)(189002)(8676002)(81156014)(81166006)(2950100002)(6916009)(104016004)(356003)(305945005)(8936002)(31430400001)(50226002)(105606002)(2351001)(106466001)(2870700001)(97736004)(6666003)(36756003)(77096006)(110136003)(33646002)(2906002)(4326007)(54906002)(6306002)(38730400001)(5820100001)(189998001)(50466002)(5660300001)(47776003)(53936002)(92566002)(8656002)(626004)(50986999)(76176999)(86362001)(575784001)(68736007)(85426001)(23676002); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR03MB2469; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BL2FFO11FD039; 1:CDik8DGaMuuoQz8N/G4Pv/pAoRbOXBPaj5Fl2Yldh/trU7YuAY2MIpAwocFhDblpkql8xsjdLA4c5AOJiQWxsXZfcQZuYxLeXqrVAy817MuP+HFHoJlr+Zr+9+/0eJPZ2GfNPPZvhM1TpFEf+242cJB5AMvSCRXnWIR1s7+MXrGSj8a1q1Z2CIN8PFWyJm1QawzMLNZqg2biWwSxyioEeyhrk8UJHSB2tDY6m5xDu2HNc+sMv3xUvCJdi9fKb8geFiJwT5+x3ujAF8ZXgswfwtBZs5F2LIeadO/dGd/KB9P2qrfPd6OMbDma4Cv0QEAxl0QOn4MMWWAo016f4FHpt0kMQtArGsfCpgSDdEYIe20BYzS0th4uFIZCvFTTfiG3WUmVd9S+d0hIj8wvWmarFdVNdlnG4xiIUDfz7BcSt0z4PnvlLam3RgABTvbSaKpYKOjMEvs2HTh1hlgpLZK0Dm/+6jPfsUDf3zPfkaVaY/OiGPs/OaPvZ+fgyxVLAEEnSo63dc8nzsTPG2ztyzhr5p1EevJr27elaMtKyqSnAnI13nSU2mbzo9ochaNmLTaGQKHBgNuNP/reMcvU1q4pwcKX2FI2lcv1Kab5tV2d3vB2/rx8DHylpTn5kSREY4eM7y/3sgxPZOBWMbbU7BYR7Lddb1QUo4PaB7NKQ1QvGwYwbeLGojj99HghoiLCzP53K7X4kkXAu2sgd88ekKo9pK0Nlwh5YarGS/frEFrymYZtmEW/Xt66E7Q4WjV78vDH X-MS-Office365-Filtering-Correlation-Id: fa5eda6e-3ddc-4a42-9735-08d443877d1f X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001); SRVR:CY4PR03MB2469; X-Microsoft-Exchange-Diagnostics: 1; CY4PR03MB2469; 3:A7z6sDBCHpnc/6D/4fs5SXjASt7mJ+dfIgQ8YpcWwdZUIAo8vOXNsu73E322WxpLpO/QFk++tuAhNvDT+31qYXDHFdyF4YmlWfyq9mwK4qDLjdg5ciS3uxMCZ8XfjwgLV7NpViK2ORFTBPKDwOo5q7C162X06VcVk1jN0EjYoQf6eKT4cyrZ1yTdBTk9GSSuK1469/AdF0A1JRzEsktvvMwtxM/Na3a5EFFLGTcIfbMKsRUSdi3Db12Pzs4YCZOTW7pCt5b3PA42J3fno+MihfaJjDt36IyXQh2TZrHoqXmMuh05V7wg4lHvXegP6R1kXYZYnfcr1DF6mY+uS8+ZkRikue5n35CcFLHAQEFHWJ1M9G6Nt9UQxq7GoLgrX0k8; 25:3jMhisaJln3P0iU6JZcDx6W9BQRerggihYLFE5pd5TI8WyZD0Xdx+fQn1J6nDlXTubg3rJEMSA2eN3+ENUoGYZxXXwCfIKuPc5U/zt9PhpSvQDlxeQKfwP6JCG80y/SwD4roiVdU2zEixsejKNbyRDi1vYi5u5Xrw0caRgqHcDYW3tENYHVh9/XC7LpyVcO1xyR3Vk29UIsU9pP06POdah7ShgYSHnOfomgF/yHRIMdyd9JVM4dz3AWrfOYM5lgRZpXifScFpQa44Dmt2rGvwcEH6j09J2LryZD8cWmX+NCgZ/W8AYjSptfW+9oxYzJjoV4BrXKRKFjU9SM1ui1pvxHBKuMpZxhOfOTR6wvq41Da45/bi9dNUd/9s8nivFO1muc3nWzfJTqdANg2jxAcMLbjU9ZuQK2Js8p3vjQZkA8C67OMSjXhC3h9gvjnznC91Ko/SLUyS196IxV3O1m+6g== X-Microsoft-Exchange-Diagnostics: 1; CY4PR03MB2469; 31:OiD2oN3EgpKD3kfC+xaGs4vTiuVnBFfbciI9Smrnfa4KvJJhNzvE+zKqPaYKTZM1CeR3oF2CNYi8t3IxaMuIukEfSXko2qVrj+YbEmxdrXKSelRgLWZHzABVHCmwYve47sXBwW0ej1pu+H9W7iXRcDFh+BB6mSnOO777MyXYczCBb0mOFIvdJ80ZLmVBqQs0czM9nzkv9Ln1zMVYnohPUC2GPOKMOIprERNCFktPfmd+aR3vw/RTvjHOZFzsh5mzLMwFeBPSP490Kn6hGjUu0PIOHcent6W2DiutfBBVIwmPRGF11EkTfCulVNs34n2S X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(185117386973197)(227817650892897)(275809806118684)(21532816269658)(264314650089876)(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6095060)(601004)(2401047)(13015025)(13017025)(13023025)(13024025)(13018025)(5005006)(8121501046)(3002001)(10201501046)(6055026)(6096035)(20161123563025)(20161123556025)(20161123559025)(20161123561025)(20161123565025); SRVR:CY4PR03MB2469; BCL:0; PCL:0; RULEID:(400006); SRVR:CY4PR03MB2469; X-Microsoft-Exchange-Diagnostics: 1; CY4PR03MB2469; 4:gW2pWC3ty5GmGaLNppzmgTmoSXQIeKDetD6sJ7kRaz5CZFNi8xH3zBypApWElsD65AUyU8SnRJdRCbPrmLOqU7GVEoT8hjr5ctGW6K7OOrQSh27DTqOXk2jDUMUKo1prB+YAyEd/GAh7v5zMzTvkRGDT2TPOKIqLA8vCybZMRD/FpyzuyRIApLS12a96Ty8vovbwzIJ41X/4yajHz+PK9vX395/JlG0JS2SipJ+SEqvmtHsj4luLzI/x6TUYPjFlhwrF91drCEphP/GR93sGthOkgXNvdZjqAeBQkE/ZFuFL6U19vp5bSXSq28+MbV1bUUv6Qad2ao/TSWy5C8YRDnKBYFq10ahUVNMpfAmak1XPgROppOgIdL7A0g4L/BE6D3ScvSKOlpxBdzeGk2mMvGmPR5GCyJw6WH96Kgx8xAzI7uaDMxc6Vj6/74UAgSNv7jnNT7DJMjzgCk7SeWODAWD4zB+oiYDPUXvhHn87U5wDxYJ3WiefrCLNv+wEyWi1q5ddW48yjP6g44zLsKm6PyBwn7ved+844GwSgvcs+ksfwnSwBwx6akr/wgl0JBeTm66drKWL8+tjdEv6ipSPlF+xP6IRWFQvEWVaCC2o8Es62BwzHQQibdFaYegAjCqntMjNAMANXPAixY1emR01ywI+w42XKW6F5sejBnOvSbVRWyUP5el1rY1hgeMWXb5StjiNTl1lBpBfcCSf4kfU4CQG/y8tu+c+vj4/dVxByh/QcTtsB71At4iCGxFCpNbVrDfsKCu/ctD8hVBFYdQLl0O/10yXh0liRUVtODYbiGxCGKrxArZ3I8ZobAHLSLa85HjhqCEydRNrIvwnKATLIKly1ECy5OBCg1LK/rM8iQWoS3aJwHdBwVjcS7RerKAZTH2ns3Ss4x2L+TGFH9KBkui02euAkFOgn3n7B/eBa4PLmPTRQQ7NDex+NzdTV8lW X-Forefront-PRVS: 0196A226D1 X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BCY4PR03MB2469=3B23=3AHrUt?= =?utf-8?q?8U6ntfGf27g4bLvGJrdW3R+1DiEoQmQNGyO+z0m/LQetWcyies/6chis?= =?utf-8?q?8b7I0DDQ2HZM4YGidhgvBgHkFy+Voi3IPB/2IcNa4HgxO9UbhkzWb+1t?= =?utf-8?q?KKjM2ywumG/i8IKnOng6dg2+EYLhWTQ/7VrDHdf9awBHCaLB7UoUfWAJ?= =?utf-8?q?Dw+l02aALOGyDIAbrcW0DStyDIlMxrG+gUfusV3a6CmdSoTiBhDA5rad?= =?utf-8?q?ac5X5x2fdskT+PxJUxl/IUHua65nMTKvFR3+XvCxkkVxZ5eto4UuhDLS?= =?utf-8?q?MHkZ71eLlj392SiYRK1vjVdGIBu3U+HTRihE3/PcYj6E8N+dzGENZ/eb?= =?utf-8?q?Ytd+KtdiiT4HCBIIPKzgE3GtGZ4oYNCFsevQ3G1RHtiQF8gCfexi9e7V?= =?utf-8?q?o+OO6og9x9vJGUbH7XYluqyM+A8fqUBBdA7+olbDC4RR4Ysoxkbdl7VH?= =?utf-8?q?OYH8uHGd221njktJsL4dpzbEP61HJoxVs6BZWnHr8QBpF3iX7B1Klot2?= =?utf-8?q?BlgdZlgb+gOWQoqzfac1T6AH52V4Tvi6b2Us63IlfWTR6mrV05w+W9wA?= =?utf-8?q?aoZHjF7PHnP77qGtTnP+vFGECiewI/KrfujX0Hwmcd7G8U3JeG9Khq3m?= =?utf-8?q?XD6ZvmBIWthpmgg9MIeFeGFN2yuvV4ZrrDM5B78d3FSZSsOC4vYbzAsx?= =?utf-8?q?25/ofu4CHeg4Bvqd4GLBiw9qa9/Ytk4NcJLhRQu6QQ8wLroKrG6XBm26?= =?utf-8?q?KJmh/Vc2kmsG4Wz32NSNHGKaI9Vy3NIjxPyGNOqc4G1nj6Fit4dFFFcy?= =?utf-8?q?Q8IiQMeaT3Ot0EmvtMmXxlS+BdYyjAvnqf7sSWUMHqLqZboyanTZTTvw?= =?utf-8?q?qYYiK+QnBgL+0uNl3dwwoApgs27PEBmCSy3vIM29e0GimCOn339uy+Gz?= =?utf-8?q?WEbXXkoCEz5xUzbh6y4q1I7EYn1U3g27Kc0g0UTaQctTswi143XaaRno?= =?utf-8?q?E8FOljjatlgvATPLpyk3ofdFMF2Hk3IT6b0vHEpF7dmULpTkMAMImHq+?= =?utf-8?q?ZGSHn4UqqrT7xcbeWVlyiPX55bJMP93mUOcpFwSMc0VJ1LhgqTxUqYv1?= =?utf-8?q?XAZBSIJTud/jK2YNgrTLYvLkAGNI6BstuTKuIR0xHhkyVnPa/u408T+l?= =?utf-8?q?0MtSOipw2u/UxrqFlHZg7Zki0DeYlT/CApyMpB5ytikSHSYpJdwpCVy8?= =?utf-8?q?hCE/Uzzj86TDd3ZKeqz36iNTNh084L2rCUjYcbE8PIJl58JthLvGzYOz?= =?utf-8?q?oAZWHMIbav1+w8p/0aMgVxhFelSqsWNTWvhfRBZFRF8bZiRmAkAfPXJ+?= =?utf-8?q?p7FGOduDTZa4ifa4/8UVw363Araud91T0ADndl/HrKZyQq9+4wtL4a1r?= =?utf-8?q?sBH6NyyzuEZhFf+yxVJoopo5gs4YwyldcmCTLbce1KUAyKs+P9Zb3uhP?= =?utf-8?q?Ia8M?= X-Microsoft-Exchange-Diagnostics: 1; CY4PR03MB2469; 6:4V9KBQeECDJjuUEG7PeLFeK78N8LDwOHy3FPLN6D6nZAWMCySgn/+F9H/DBtLMWpkW/zMN969/MjY9d1iTvBXEVyri9p6cUqnJeeNzGVtmCCrjmgkZrmPw9hJuf+5h2MX6Jp35WmgydzZ049jLmFHYEMuy08N+50i2ZoF5q9W3jga6hBhtda+ajrK5tBJrba4ndPQ24KUQ6OKgmojRZ/8Pf4K6Yiab1TUT91Wxo7NjX4TfWpQmj78ne29Np3X1N1CB8YwBcbHBhrJTd1EWUfaa4nlPvYr0ffEV3Rv8r0VgS4nM3PbAAh3af6ASacAGsYaf4Q1h5h05MpBNThjLkV5NkYfTyJxpwImcMyASPMcYQlAKCLK3V1LL1bPI/o0eKkwncpQKU5ch0a50VBk2Lbvjch8NNNvcNdIATFlGpXXjtCLmu3WT9fJYUi6PewaReq; 5:vAI3NjGymzZ+Q/fae36OB1FHscKK32IAgCXthOZflOWDKMBhX82xFPqHbgcEIp2MoMOPQtpB5R2UHYJuoVYfJemc+k2QKaZXFK62Cflw7U/SApamsTfgJKGPAC7TO6GQYvoUu1PytdEf+7n1tcROW4D96m0RWhY8ycOxR1/kmJbCkUFrbvOw+demLggRboDi; 24:pg72dyV09CCIlr4NuPH59sYjBbMKdNrm0Yj40mZStigPccUKAi0EUlW1fVY3PQUuAPXWg7CC3ItMHHvhaaiLITH5/5zdxUaB5KzS9Mhq81o= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY4PR03MB2469; 7:Itr13HmJCcM2O8uCyMGWWDmb8v0J/CuTp3XvXeaHffSqgFAIbrCQu84nTnIV8dNB4ucSiAh8BlqCUXfvrdEF+RINEeRlqxe9fkR/nwx++agkg0qzMEZ+MOHFxWEQLrJJ/eq4NW0f+SCP8Vb5cxp8zMJaukM6p9BVp5s6I/2p7rNMcMqMSUd8fv7QsvmQzJoT+WzVQ0WNwPG8bDgOoXBm0evqVyJv4UlkaGyrXdDE+HNg4YQ32pzNUMXZyNHrURRCFDSEuWdVs1NiDo26/4f+kLsjZswoc1nMS4c/JWxm8BCED/nhcb9WEqyS+sLrevg9LEzgtwVTFNFkTn2yz+bFuqJVcVEOY4bGUc6Pbg1ZJh1WLd7GGo/njjxWco8wJw/HCtTzkoWzm00cE4FGtospy1tx9qr3vHvVWb+/GEXLGjWPW/OXH3sYwSeg95kfy2mDnjd2txG7bqZ71BKSH3Fbrw== X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Jan 2017 12:00:56.3390 (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: CY4PR03MB2469 Subject: [dpdk-dev] [PATCHv6 13/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 | 1 + doc/guides/nics/dpaa2.rst | 593 +++++++++++++++++++++++++++++++++ doc/guides/nics/features/dpaa2.ini | 9 + doc/guides/nics/index.rst | 1 + doc/guides/rel_notes/release_17_02.rst | 12 +- 5 files changed, 615 insertions(+), 1 deletion(-) create mode 100644 doc/guides/nics/dpaa2.rst create mode 100644 doc/guides/nics/features/dpaa2.ini diff --git a/MAINTAINERS b/MAINTAINERS index 7e274e0..fb85351 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -359,6 +359,7 @@ M: Hemant Agrawal F: drivers/bus/fslmc/ F: drivers/common/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..f0d7a26 --- /dev/null +++ b/doc/guides/nics/dpaa2.rst @@ -0,0 +1,593 @@ +.. 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. + +.. note:: + + Some part of fslmc bus code (mc flib - object library) routines are + dual licensed (BSD & GPLv2). + +Pre-Installation Configuration +------------------------------ + +Config File Options +~~~~~~~~~~~~~~~~~~~ + +The following options can be modified in the ``config`` file. +Please note that enabling debugging options may affect system performance. + +- ``CONFIG_RTE_LIBRTE_FSLMC_BUS`` (default ``n``) + + By default it is enabled only for defconfig_arm64-dpaa2-* config. + Toggle compilation of the ``librte_bus_fslmc`` driver. + +- ``CONFIG_RTE_LIBRTE_DPAA2_PMD`` (default ``n``) + + By default it is enabled only for defconfig_arm64-dpaa2-* config. + Toggle compilation of the ``librte_pmd_dpaa2`` driver. + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_DRIVER`` (default ``n``) + + Toggle display of generic debugging messages + +- ``CONFIG_RTE_LIBRTE_DPAA2_USE_PHYS_IOVA`` (default ``y``) + + Toggle to use physical address vs virtual address for hardware accelerators. + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_INIT`` (default ``n``) + + Toggle display of initialization related messages. + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_RX`` (default ``n``) + + Toggle display of receive fast path run-time message + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_TX`` (default ``n``) + + Toggle display of transmit fast path run-time message + +- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_TX_FREE`` (default ``n``) + + Toggle display of transmit fast path buffer free run-time message + + +Driver Compilation +~~~~~~~~~~~~~~~~~~ + +To compile the DPAA2 PMD for Linux arm64 gcc target, run the +following ``make`` command: + +.. code-block:: console + + cd + make config T=arm64-dpaa2-linuxapp-gcc install + +.. _dpaa2_testpmd_example: + +Running testpmd +~~~~~~~~~~~~~~~ + +This section demonstrates how to launch ``testpmd`` with DPAA2 device +managed by ``librte_pmd_dpaa2`` in the Linux operating system. + +#. Configure the resource container: + + Configure resources in MC and create the DPRC container: + + .. code-block:: console + + export the DPRC container + e.g. export DPRCT=dprc.2 + +#. Start ``testpmd`` with basic parameters: + + .. code-block:: console + + ./arm64-dpaa2-linuxapp-gcc/testpmd -c 0xff -n 1 \ + -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx + + Example output: + + .. code-block:: console + + ..... + EAL: Registered [pci] bus. + EAL: Registered [fslmc] bus. + EAL: Detected 8 lcore(s) + EAL: Probing VFIO support... + EAL: VFIO support initialized + ..... + PMD: DPAA2: Processing Container = dprc.2 + EAL: fslmc: DPRC contains = 51 devices + EAL: fslmc: Bus scan completed + ..... + Configuring Port 0 (socket 0) + Port 0: 00:00:00:00:00:01 + Configuring Port 1 (socket 0) + Port 1: 00:00:00:00:00:02 + ..... + Checking link statuses... + Port 0 Link Up - speed 10000 Mbps - full-duplex + Port 1 Link Up - speed 10000 Mbps - full-duplex + Done + testpmd> + +Limitations +----------- + +Platform Requirement +~~~~~~~~~~~~~~~~~~~~ +DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the +``Supported DPAA2 SoCs``. + +Maximum packet length +~~~~~~~~~~~~~~~~~~~~~ + +The DPAA2 SoC family support a maximum of a 10240 jumbo frame. The value +is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len`` +member of ``struct rte_eth_conf`` is set to a value lower than 10240, frames +up to 10240 bytes can still reach the host interface. diff --git a/doc/guides/nics/features/dpaa2.ini b/doc/guides/nics/features/dpaa2.ini new file mode 100644 index 0000000..b176208 --- /dev/null +++ b/doc/guides/nics/features/dpaa2.ini @@ -0,0 +1,9 @@ +; +; Supported features of the 'dpaa2' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Linux VFIO = Y +ARMv8 = Y +Usage doc = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 87f9334..be21e8a 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -39,6 +39,7 @@ Network Interface Controller Drivers bnx2x bnxt cxgbe + dpaa2 e1000em ena enic diff --git a/doc/guides/rel_notes/release_17_02.rst b/doc/guides/rel_notes/release_17_02.rst index 0ecd720..d755a4d 100644 --- a/doc/guides/rel_notes/release_17_02.rst +++ b/doc/guides/rel_notes/release_17_02.rst @@ -15,7 +15,6 @@ DPDK Release 17.02 firefox build/doc/html/guides/rel_notes/release_17_02.html - New Features ------------ @@ -193,6 +192,17 @@ New Features See the :ref:`Elastic Flow Distributor Library ` documentation in the Programmers Guide document, for more information. +* **Added a new driver for NXP DPAA2 - FSLMC bus.** + + Added the new bus "fslmc" driver for NXP DPAA2 devices. See the + "Network Interface Controller Drivers" document for more details on this new + driver. + +* **Added a new driver for NXP DPAA2 Network PMD.** + + Added the new "dpaa2" net driver for NXP DPAA2 devices. See the + "Network Interface Controller Drivers" document for more details on this new + driver. Resolved Issues ---------------