From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from na01-bn1-obe.outbound.protection.outlook.com (mail-bn1on0056.outbound.protection.outlook.com [157.56.110.56]) by dpdk.org (Postfix) with ESMTP id 77912D107 for ; Fri, 17 Jun 2016 15:33:07 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=TOZ1JfyuFUmC2kMpmsohZkK54b3gnL/SVC5uMnrbBns=; b=lumMoRVXLSwM4zwjy4xC2ueIgzSKpkU6gASWI3+ypO9V1q4E9SAxf4pXnXvBw9EqpF/wO+Kk4bnSsIXOa58jj0QTdcIN2Icww7HXV4ROFjaOjHpw20aSuPyb0+cc/bkdloYxg1/ETXGsjfmQAOrW+wYfiaIEmBkOw3aYU+cLQbQ= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Jerin.Jacob@cavium.com; Received: from localhost.localdomain.localdomain (171.48.17.70) by BN3PR0701MB1718.namprd07.prod.outlook.com (10.163.39.17) with Microsoft SMTP Server (TLS) id 15.1.517.8; Fri, 17 Jun 2016 13:33:02 +0000 From: Jerin Jacob To: CC: , , , Jerin Jacob , Slawomir Rosek Date: Fri, 17 Jun 2016 18:59:53 +0530 Message-ID: <1466170194-28393-27-git-send-email-jerin.jacob@caviumnetworks.com> X-Mailer: git-send-email 2.5.5 In-Reply-To: <1466170194-28393-1-git-send-email-jerin.jacob@caviumnetworks.com> References: <1465931200-23912-1-git-send-email-jerin.jacob@caviumnetworks.com> <1466170194-28393-1-git-send-email-jerin.jacob@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit X-Originating-IP: [171.48.17.70] X-ClientProxiedBy: BM1PR01CA0028.INDPRD01.PROD.OUTLOOK.COM (10.163.198.163) To BN3PR0701MB1718.namprd07.prod.outlook.com (10.163.39.17) X-MS-Office365-Filtering-Correlation-Id: 5722e40f-cf49-46e6-ada5-08d396b3e9b3 X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1718; 2:0KmwrR8EmHhICFjYg4iFMA8m21xIN/N6upGMsfe1D6SNxWNJN659V48Ul2lwU96+Br2zgIOJrIqk2ZmRXGF/DG/8K+xTyz0rWMsJfHDxRr/nL4Py4WiN0eLIPllFUgSr/f6ZLIM2Ws5Jgtc26rfpIS/5nVUiKB0O8eFgdknHL9d0Vigg2xrEDhnVyAq6Pvwk; 3:8+mXv1UMaoDQDx4xTweYM1eyUhw0Eea60ZJYutWcnzA1PKTTyA61gcywSC2ERlhtJww3jDdWDcc8t+sNBusPYDCIhX9znOQ3XaLGG1RTStwSK+tu5DMipejvGpk6MpUd; 25:JObP58lnfoLqEgRPzeJUxdFzEKux8dJ7eJ3G9UyudXAHUKts+MGw0w61uQivz3Y8JIX0UIkSm53zyd6hIBEd5DOKC6hvMzfAS5lH0eB6ScyzQ0VNBkc6kgGJaP75G4ZLDEuWlC6CdWqwlNWOOUVGiUkQfzPvW+hA8CE4P3nrvKxZdpx4PpaFPLxRfx0v9oLgYmhbAh6CFyhjetlLKpGtCJeTvRR3ttgkqbsjYXv4lJTwhA//fKOoe36yfsY6+zk3r+pRxCO/AuCcqQkiYCASQ5UIZEe9Yrj8uzU98vV1y0VIiYAXqBnhNGkttC8jaA/q1Vgi6z/FppIuBYe18YTVgWAviIrjBYeF8UPohwRytszWsp4WE7vt8jMsmue78rb2HmBJWx6JXO1kmb2VTSghulzVgebZ4CBg5jqYOcQGuws= X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BN3PR0701MB1718; X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1718; 20:P57D+C2hpmCa36tlACvp+7qyJiiZarzBLb4K7Xf8fcRPpXITQ4GkMfi81czUU6wK/mLTGVOIIQ9mA2P64/ezK0iZs7kNHKyYxRJBuhxi+B85ANqmJd1fe/znql4Fqjffdw7+LjT9zjahMNH1b6VFLDgYOUxZSxHMCIpsT1FvvJbhkNWOw4fuQvfcj+p/oBca9R/1jKyv+eD8h2TdHnZTLRUHwBIopKEfMwUY2WKK9v663muaG4ldOZiqVooldVEJi4JCOuIrl04RgXdFDSU5trtnC7IZmqjgnWkRGgUCKYsbcCW0c0siaveAAxmlnSZoOnD123IlKt+EIV4Nx72JRkNlVUQAv1yPuuFCMfdU1+GcWAeM76LIyyQ1bfazvx1vHtc27cslrsh59kwMGRFblVPDDV+xAM4KvWbpSgghzCMLngKWmG2VVsowiIdyCG1ypaqIhaE4teQ3jwlAN0X835e591vFZi7P1bWrZX3cIkfFvdl5JZbUKN5xoPfs+UKEncVzq1B4p3M03omEP85c07qCHXt6l+zZbt0/8+YgOSMQigMCNlXA4j5w5CQsG/wb4OyIk3oUbkpIjftuvJNk6IkeAk8SBPq8h/wPP1RNPlA= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(601004)(2401047)(5005006)(8121501046)(3002001)(10201501046); SRVR:BN3PR0701MB1718; BCL:0; PCL:0; RULEID:; SRVR:BN3PR0701MB1718; X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1718; 4:QKJwHjTiiUNaBTUh05SqR185H4hokq2JbIo4yyXH1bPjTTxi0NyikNH5thp1RjiF5iRXo5IcFmxUi3gb/O1/rGIkcfNNJ5gQ5wwN5USqsyTGcs8sUihV8Z6+mmwr2WGIKPlZ597c6k74BpVAzK3ju0bAMsRXmlHOKy9qITkSV05hzLakGtY1xGvr9bhirF2rHXH7BaYj+brP3BinHQc/UpfiPpsB3fheRNwd/XRiJU7lVEpZEWAEyuF2ogJZVrJaRxy/1o89yrAm71W6NPF6B+XHFxkJVWDBjbjziD5zIzSGTIY6PaLWYaJ9s6/dO3zK4v7XplT3itJ9wa6qzgAXv+ykgymllZd9+hg8W4GTOWs9UygLRe3bfpFFSBS+0ezTzrL0xomaYfrPfVJ2jB8L8QNqjWPgZOTAREpe9bX+hRE= X-Forefront-PRVS: 09760A0505 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6069001)(6009001)(7916002)(199003)(189002)(2420400007)(19580395003)(23676002)(68736007)(2351001)(47776003)(229853001)(97736004)(19580405001)(586003)(50986999)(110136002)(15650500001)(36756003)(3846002)(66066001)(92566002)(105586002)(189998001)(76176999)(33646002)(42186005)(81156014)(7110500001)(5820100001)(5004730100002)(10710500007)(101416001)(50466002)(2870700001)(2950100001)(15975445007)(4326007)(5008740100001)(50226002)(2906002)(6116002)(77096005)(81166006)(8676002)(106356001); DIR:OUT; SFP:1101; SCL:1; SRVR:BN3PR0701MB1718; H:localhost.localdomain.localdomain; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX:1; CAT:NONE; LANG:es; CAT:NONE; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtCTjNQUjA3MDFNQjE3MTg7MjM6dEJ4OFBUVy94bGxxSWpLYWI5bHZZMk9x?= =?utf-8?B?Q0RZTE5DR1prZ3JDaEtOaHFLK09RYVVlSlZSWGhkNVhsNHNOa3FvaVFIZEVH?= =?utf-8?B?T2JDa2plMEdDeXlSejM2MW9WaHZxdStTTm5LTUdaUkZyeGFuS0M2WktxaitG?= =?utf-8?B?TlJMdzd3Y0RLZTQ2TENCVSswZmJ6THRSWlQ4bHBxRlg5TzAvTXlpRWpBM1py?= =?utf-8?B?OXpqMitXSTZGRzVuT3VNY2diOWpqNlZ5QnFmempId1RzdkdMOEQzMHdYY0Er?= =?utf-8?B?ZzlnZVFBNEdFZFRaSjU2ZEdPdm95RTF2bEpsdkxybmRvdTBIcUJLeit5WDd2?= =?utf-8?B?bGlJZno3ZlYzTzVLVVZkaEpmYnZUQk1XTkJCQU50cjBTblAwdmRqU2ZsOUNp?= =?utf-8?B?OUNzNG9BTld0QmZXc2pMSGxxS1dWbHdodnZ1VThIcjhMWVo2UGFVQWpHZ09N?= =?utf-8?B?ZG5YNTVNK1pTTGFrR0pna3EvclBwWWZ0cXJ1RVQ3NFBTaWJSVExYMFFWRG5Z?= =?utf-8?B?RjAwdmNRV3dwK1hsM1lLdU5yVEdqdVlOczl0ZDFhWThVOE91SFl1MTJWRTMv?= =?utf-8?B?elBNZW5BL3FRV1pnQUhZd3I3T2tNL0hVMW9lU3BtdjZvc3RPS05sckh0MW4y?= =?utf-8?B?QWRFand2eG1aNnlpY2pMZlR3cjFPdEVmY1EzY01leGxCUWFucFhxU241dFFa?= =?utf-8?B?QkJJbHNZSDg0dDdtSkdyTmVaallxWVc1THg2Y3NManJ5Z0dBL3AyREYxN3pL?= =?utf-8?B?U2k5RzUvSjhYNi9DbUVUNHZncWI1NkR0bUVqWFF1VjAwcDRVODdyc3ZydDVV?= =?utf-8?B?S3FkUUhmeEhzbUs4eG5Dd01zUExiaFN3cEdoUnMwamM0blBLeDBmWnZuNFBJ?= =?utf-8?B?aUhvZTF1MlhMYy9BWEpSMDU5UlBnQngzenBBOFNCVW5kUnhpdzdlQWc2SE5T?= =?utf-8?B?eVhyMHNaM0gwQjJ4Wk50SWZOWnlLU0FQY1FvaFR3KzFPekpQSjJqLzN2dG5r?= =?utf-8?B?NmNRYWE0NUtMNlZsK3dEdDdkTXZhWW5jcCtDeGZINHNvSjBCWjFiRVF6MTN2?= =?utf-8?B?TXp3OGxpbkZDSnAxc1NOZTZmTUY3NHF4dWZFMThuYm9KVlRteitYZzJPa3R0?= =?utf-8?B?dHgzODlCcGNETDJQY2QzWHZLKzNqL2xCRFNncGNmcmdBcWlOTHdxSWlUakcy?= =?utf-8?B?RnlHYzFvUnlFclNFZnAvOHg2Mk1DZFg3OFdsYXVzRUIwcnMyZVZLNllBaW9U?= =?utf-8?B?a3F5UURnV2pnNEYvYTkyd2NKTVE5dCs5R01vdkt6TmJubzZYcm45Q253Zlc1?= =?utf-8?B?bXlnY2lMaXpDb1h5TlZJMkQ1SG9lazRTTFRSYVRmak1sTFBUaVRRQ1FzTFBP?= =?utf-8?B?V01Zdnh2M0JTa2VYeFg5OEQvS2tsTENzVGNWbkMwR1FUQlpIODlqbFk3SXBI?= =?utf-8?B?ZWplQUtudXVEbzVFSEo5dyttc25WZldldVA0L0JFV0VodDlOdmp5dnJhTUpQ?= =?utf-8?B?cG1vcHdubzV6Z0p5ejZpSy9QQk9Yd2JJYWNtaThDcEdzanFzbzdzaHB1bmFO?= =?utf-8?B?aWR4dWxOMVFIWlJ2UUpHUXh0WDIxRzlxN3NKU1NybHJ5UVhEVURrTkdoWWw3?= =?utf-8?B?SG81SnFjbkVpeTNLb2Z5QXQyd1k4bWE0MGhaUmk5c2tBeHpYZ3BMbFYyZ3c9?= =?utf-8?Q?=3D?= X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1718; 6:uqhE6mAGmTLFO58LrQzIZh6JjLWiI2NGaZeYb/5i61mqKAW549RL7U+myf2L4AvQTu4W2qEZ2p6waSNrmJUDwqSwXYMH6s4NXFjZyv6zvHJJu9lyAy/V/wq31xpBmgrgfHGdbteyX07cAgC2SfSw7BfRqED013l1WEqIdIoiVmuj1AeDNOfXeWPeDbQBdwSy1HkIEic24eYjG3k3QznbKWIto4v3ivoknIlhKjddmpUuHFYl9vL/a+oLh0pT5MlOsS48mb48U+TRpr+GzhuC/2v5TY1NymYOazMUaiGDbNg=; 5:94fnKPeiGBTwGabkuExwZe9t7K10gnQZP8UfK3+tWw2Wm5Cd9FFndz64Jmc4RSB+yEiBODcL7nTdYihVN8BArsxh5bJ5n6GGqC0O5L2ckVEXhVEIs6IzgQE+0LHQDsj7/QtAq/hQifPlOdlJlFsUeQ==; 24:81LFBjlm/6tZKNGaMWRZUzPA7BQf+HzwQ/3ul9MYK6dZNbI7+lW/6kicre/mZF7Z950/V0gHVHtj0h49j3AplQlxOdkuvPYxjj2xfy3vZwE=; 7:dwqyH1CtB0WlwNhliqkFzEnmPtG0xVCkQKjeCe90yVjNP4qVVjfQEjLXMU/eN/YW3Nn/Y4kwS5SGB0ckFWMJx/9jpuFES7tqhZKVJI0EvlSsJkEMFl5MWv59yB1OwvIWIAqwB7HJ8VuuF6c3ME6hyvOK47DpYy/rzOn34DOwbIcECQX2MRd3rks+53/4RSXow/1f8gzsZHGfYa3ggmPP9g== SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Jun 2016 13:33:02.7925 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN3PR0701MB1718 Subject: [dpdk-dev] [PATCH v6 26/27] net/thunderx: updated driver documentation and release notes X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Jun 2016 13:33:08 -0000 Updated doc/guides/nics/overview.rst, doc/guides/nics/thunderx.rst and release notes Changed "*" to "P" in overview.rst to capture the partially supported feature as "*" creating alignment issues with Sphinx table Signed-off-by: Jerin Jacob Signed-off-by: Slawomir Rosek Acked-by: John McNamara --- doc/guides/nics/index.rst | 1 + doc/guides/nics/overview.rst | 96 ++++----- doc/guides/nics/thunderx.rst | 354 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_16_07.rst | 1 + 4 files changed, 404 insertions(+), 48 deletions(-) create mode 100644 doc/guides/nics/thunderx.rst diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index ffe011e..99ee7f1 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -51,6 +51,7 @@ Network Interface Controller Drivers nfp qede szedata2 + thunderx virtio vhost vmxnet3 diff --git a/doc/guides/nics/overview.rst b/doc/guides/nics/overview.rst index 29a6163..c1ee67b 100644 --- a/doc/guides/nics/overview.rst +++ b/doc/guides/nics/overview.rst @@ -74,40 +74,40 @@ Most of these differences are summarized below. .. table:: Features availability in networking drivers - ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = - Feature a b b b b c e e e i i i i i i i i i i f f f f m m m n n p q q r s v v v v x - f n n n o x 1 n n 4 4 4 4 g g x x x x m m m m l l p f u c e e i z h i i m e - p x x x n g 0 a i 0 0 0 0 b b g g g g 1 1 1 1 x x i p l a d d n e o r r x n - a 2 2 t d b 0 c e e e e v b b b b 0 0 0 0 4 5 p l p e e g d s t t n v - c x x i e 0 . v v f e e e e k k k k e v a t i i e i - k v n . f f . v v . v v f t o o t r - e f g . . . f f . f f a . 3 t - t v v v v v v 2 v - e e e e e e e - c c c c c c c - ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = + ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = + Feature a b b b b c e e e i i i i i i i i i i f f f f m m m n n p q q r s t v v v v x + f n n n o x 1 n n 4 4 4 4 g g x x x x m m m m l l p f u c e e i z h h i i m e + p x x x n g 0 a i 0 0 0 0 b b g g g g 1 1 1 1 x x i p l a d d n e u o r r x n + a 2 2 t d b 0 c e e e e v b b b b 0 0 0 0 4 5 p l p e e g d n s t t n v + c x x i e 0 . v v f e e e e k k k k e v a d t i i e i + k v n . f f . v v . v v f t e o o t r + e f g . . . f f . f f a r . 3 t + t v v v v v v 2 x v + e e e e e e e + c c c c c c c + ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = Speed capabilities - Link status Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Link status event Y Y Y Y Y Y Y Y Y Y Y Y Y - Queue status event Y + Link status Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Link status event Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Queue status event Y Rx interrupt Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Queue start/stop Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - MTU update Y Y Y Y Y Y Y Y Y Y - Jumbo frame Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Scattered Rx Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Queue start/stop Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + MTU update Y Y Y Y Y Y Y Y Y Y Y + Jumbo frame Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Scattered Rx Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y LRO Y Y Y Y TSO Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Promiscuous mode Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Allmulticast mode Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Unicast MAC filter Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Multicast MAC filter Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - RSS hash Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - RSS key update Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - RSS reta update Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Promiscuous mode Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Allmulticast mode Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Unicast MAC filter Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Multicast MAC filter Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + RSS hash Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + RSS key update Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + RSS reta update Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y VMDq Y Y Y Y Y Y Y - SR-IOV Y Y Y Y Y Y Y Y Y Y + SR-IOV Y Y Y Y Y Y Y Y Y Y Y DCB Y Y Y Y Y - VLAN filter Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + VLAN filter Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Ethertype filter Y Y Y Y Y N-tuple filter Y Y Y SYN filter Y Y Y @@ -118,37 +118,37 @@ Most of these differences are summarized below. Flow control Y Y Y Y Y Y Y Y Y Rate limitation Y Y Traffic mirroring Y Y Y Y - CRC offload Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - VLAN offload Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + CRC offload Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + VLAN offload Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y P QinQ offload Y Y Y Y Y Y Y - L3 checksum offload Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - L4 checksum offload Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + L3 checksum offload Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + L4 checksum offload Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Inner L3 checksum Y Y Y Y Y Y Inner L4 checksum Y Y Y Y Y Y - Packet type parsing Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Packet type parsing Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Timesync Y Y Y Y Y - Basic stats Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Extended stats Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Stats per queue Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Basic stats Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Extended stats Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Stats per queue Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y EEPROM dump Y Y Y Y - Registers dump Y Y Y Y Y Y Y - Multiprocess aware Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - BSD nic_uio Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Linux UIO Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Linux VFIO Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Registers dump Y Y Y Y Y Y Y Y + Multiprocess aware Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + BSD nic_uio Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Linux UIO Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Linux VFIO Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Other kdrv Y Y Y - ARMv7 Y Y Y - ARMv8 Y Y Y Y Y Y Y + ARMv7 Y Y Y + ARMv8 Y Y Y Y Y Y Y Y Power8 Y Y Y TILE-Gx Y - x86-32 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - x86-64 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y - Usage doc Y Y Y Y Y Y Y Y Y Y Y + x86-32 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + x86-64 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y + Usage doc Y Y Y Y Y Y Y Y Y Y Y Y Design doc Perf doc - ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = + ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = .. Note:: - Features marked with "*" are partially supported. Refer to the appropriate + Features marked with "P" are partially supported. Refer to the appropriate NIC guide in the following sections for details. diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst new file mode 100644 index 0000000..e38f260 --- /dev/null +++ b/doc/guides/nics/thunderx.rst @@ -0,0 +1,354 @@ +.. BSD LICENSE + Copyright (C) Cavium networks Ltd. 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 Cavium networks 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. + +ThunderX NICVF Poll Mode Driver +=============================== + +The ThunderX NICVF PMD (**librte_pmd_thunderx_nicvf**) provides poll mode driver +support for the inbuilt NIC found in the **Cavium ThunderX** SoC family +as well as their virtual functions (VF) in SR-IOV context. + +More information can be found at `Cavium Networks Official Website +`_. + +Features +-------- + +Features of the ThunderX PMD are: + +- Multiple queues for TX and RX +- Receive Side Scaling (RSS) +- Packet type information +- Checksum offload +- Promiscuous mode +- Multicast mode +- Port hardware statistics +- Jumbo frames +- Link state information +- Scattered and gather for TX and RX +- VLAN stripping +- SR-IOV VF +- NUMA support + +Supported ThunderX SoCs +----------------------- +- CN88xx + +Prerequisites +------------- +- 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_THUNDERX_NICVF_PMD`` (default ``n``) + + By default it is enabled only for defconfig_arm64-thunderx-* config. + Toggle compilation of the ``librte_pmd_thunderx_nicvf`` driver. + +- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_INIT`` (default ``n``) + + Toggle display of initialization related messages. + +- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_RX`` (default ``n``) + + Toggle display of receive fast path run-time message + +- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_TX`` (default ``n``) + + Toggle display of transmit fast path run-time message + +- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_DRIVER`` (default ``n``) + + Toggle display of generic debugging messages + +- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_MBOX`` (default ``n``) + + Toggle display of PF mailbox related run-time check messages + +Driver Compilation +~~~~~~~~~~~~~~~~~~ + +To compile the ThunderX NICVF PMD for Linux arm64 gcc target, run the +following “make” command: + +.. code-block:: console + + cd + make config T=arm64-thunderx-linuxapp-gcc install + +Linux +----- + +.. _thunderx_testpmd_example: + +Running testpmd +~~~~~~~~~~~~~~~ + +This section demonstrates how to launch ``testpmd`` with ThunderX NIC VF device +managed by ``librte_pmd_thunderx_nicvf`` in the Linux operating system. + +#. Load ``vfio-pci`` driver: + + .. code-block:: console + + modprobe vfio-pci + + .. _thunderx_vfio_noiommu: + +#. Enable **VFIO-NOIOMMU** mode (optional): + + .. code-block:: console + + echo 1 > /sys/module/vfio/parameters/enable_unsafe_noiommu_mode + + .. note:: + + **VFIO-NOIOMMU** is required only when running in VM context and should not be enabled otherwise. + See also :ref:`SR-IOV: Prerequisites and sample Application Notes `. + +#. Bind the ThunderX NIC VF device to ``vfio-pci`` loaded in the previous step: + + Setup VFIO permissions for regular users and then bind to ``vfio-pci``: + + .. code-block:: console + + ./tools/dpdk_nic_bind.py --bind vfio-pci 0002:01:00.2 + +#. Start ``testpmd`` with basic parameters: + + .. code-block:: console + + ./arm64-thunderx-linuxapp-gcc/app/testpmd -c 0xf -n 4 -w 0002:01:00.2 \ + -- -i --disable-hw-vlan-filter --crc-strip --no-flush-rx \ + --port-topology=loop + + Example output: + + .. code-block:: console + + ... + + PMD: rte_nicvf_pmd_init(): librte_pmd_thunderx nicvf version 1.0 + + ... + EAL: probe driver: 177d:11 rte_nicvf_pmd + EAL: using IOMMU type 1 (Type 1) + EAL: PCI memory mapped at 0x3ffade50000 + EAL: Trying to map BAR 4 that contains the MSI-X table. + Trying offsets: 0x40000000000:0x0000, 0x10000:0x1f0000 + EAL: PCI memory mapped at 0x3ffadc60000 + PMD: nicvf_eth_dev_init(): nicvf: device (177d:11) 2:1:0:2 + PMD: nicvf_eth_dev_init(): node=0 vf=1 mode=tns-bypass sqs=false + loopback_supported=true + PMD: nicvf_eth_dev_init(): Port 0 (177d:11) mac=a6:c6:d9:17:78:01 + Interactive-mode selected + Configuring Port 0 (socket 0) + ... + + PMD: nicvf_dev_configure(): Configured ethdev port0 hwcap=0x0 + Port 0: A6:C6:D9:17:78:01 + Checking link statuses... + Port 0 Link Up - speed 10000 Mbps - full-duplex + Done + testpmd> + +.. _thunderx_sriov_example: + +SR-IOV: Prerequisites and sample Application Notes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Current ThunderX NIC PF/VF kernel modules maps each physical Ethernet port +automatically to virtual function (VF) and presented them as PCIe-like SR-IOV device. +This section provides instructions to configure SR-IOV with Linux OS. + +#. Verify PF devices capabilities using ``lspci``: + + .. code-block:: console + + lspci -vvv + + Example output: + + .. code-block:: console + + 0002:01:00.0 Ethernet controller: Cavium Networks Device a01e (rev 01) + ... + Capabilities: [100 v1] Alternative Routing-ID Interpretation (ARI) + ... + Capabilities: [180 v1] Single Root I/O Virtualization (SR-IOV) + ... + Kernel driver in use: thunder-nic + ... + + .. note:: + + Unless ``thunder-nic`` driver is in use make sure your kernel config includes ``CONFIG_THUNDER_NIC_PF`` setting. + +#. Verify VF devices capabilities and drivers using ``lspci``: + + .. code-block:: console + + lspci -vvv + + Example output: + + .. code-block:: console + + 0002:01:00.1 Ethernet controller: Cavium Networks Device 0011 (rev 01) + ... + Capabilities: [100 v1] Alternative Routing-ID Interpretation (ARI) + ... + Kernel driver in use: thunder-nicvf + ... + + 0002:01:00.2 Ethernet controller: Cavium Networks Device 0011 (rev 01) + ... + Capabilities: [100 v1] Alternative Routing-ID Interpretation (ARI) + ... + Kernel driver in use: thunder-nicvf + ... + + .. note:: + + Unless ``thunder-nicvf`` driver is in use make sure your kernel config includes ``CONFIG_THUNDER_NIC_VF`` setting. + +#. Verify PF/VF bind using ``dpdk_nic_bind.py``: + + .. code-block:: console + + ./tools/dpdk_nic_bind.py --status + + Example output: + + .. code-block:: console + + ... + 0002:01:00.0 'Device a01e' if= drv=thunder-nic unused=vfio-pci + 0002:01:00.1 'Device 0011' if=eth0 drv=thunder-nicvf unused=vfio-pci + 0002:01:00.2 'Device 0011' if=eth1 drv=thunder-nicvf unused=vfio-pci + ... + +#. Load ``vfio-pci`` driver: + + .. code-block:: console + + modprobe vfio-pci + +#. Bind VF devices to ``vfio-pci`` using ``dpdk_nic_bind.py``: + + .. code-block:: console + + ./tools/dpdk_nic_bind.py --bind vfio-pci 0002:01:00.1 + ./tools/dpdk_nic_bind.py --bind vfio-pci 0002:01:00.2 + +#. Verify VF bind using ``dpdk_nic_bind.py``: + + .. code-block:: console + + ./tools/dpdk_nic_bind.py --status + + Example output: + + .. code-block:: console + + ... + 0002:01:00.1 'Device 0011' drv=vfio-pci unused= + 0002:01:00.2 'Device 0011' drv=vfio-pci unused= + ... + 0002:01:00.0 'Device a01e' if= drv=thunder-nic unused=vfio-pci + ... + +#. Pass VF device to VM context (PCIe Passthrough): + + The VF devices may be passed through to the guest VM using qemu or + virt-manager or virsh etc. + ``librte_pmd_thunderx_nicvf`` or ``thunder-nicvf`` should be used to bind + the VF devices in the guest VM in :ref:`VFIO-NOIOMMU ` mode. + + Example qemu guest launch command: + + .. code-block:: console + + sudo qemu-system-aarch64 -name vm1 \ + -machine virt,gic_version=3,accel=kvm,usb=off \ + -cpu host -m 4096 \ + -smp 4,sockets=1,cores=8,threads=1 \ + -nographic -nodefaults \ + -kernel \ + -append "root=/dev/vda console=ttyAMA0 rw hugepagesz=512M hugepages=3" \ + -device vfio-pci,host=0002:01:00.1 \ + -drive file=,if=none,id=disk1,format=raw \ + -device virtio-blk-device,scsi=off,drive=disk1,id=virtio-disk1,bootindex=1 \ + -netdev tap,id=net0,ifname=tap0,script=/etc/qemu-ifup_thunder \ + -device virtio-net-device,netdev=net0 \ + -serial stdio \ + -mem-path /dev/huge + +#. Refer to section :ref:`Running testpmd ` for instruction + how to launch ``testpmd`` application. + +Limitations +----------- + +CRC striping +~~~~~~~~~~~~ + +The ThunderX SoC family NICs strip the CRC for every packets coming into the +host interface. So, CRC will be stripped even when the +``rxmode.hw_strip_crc`` member is set to 0 in ``struct rte_eth_conf``. + +Maximum packet length +~~~~~~~~~~~~~~~~~~~~~ + +The ThunderX SoC family NICs support a maximum of a 9K 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 9200, frames +up to 9200 bytes can still reach the host interface. + +Maximum packet segments +~~~~~~~~~~~~~~~~~~~~~~~ + +The ThunderX SoC family NICs support up to 12 segments per packet when working +in scatter/gather mode. So, setting MTU will result with ``EINVAL`` when the +frame size does not fit in the maximum number of segments. + +Limited VFs +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ThunderX SoC family NICs has 128VFs and each VF has 8/8 queues +for RX/TX respectively. Current driver implementation has one to one mapping +between physical port and VF hence only limited VFs can be used. diff --git a/doc/guides/rel_notes/release_16_07.rst b/doc/guides/rel_notes/release_16_07.rst index 8765ef8..570333b 100644 --- a/doc/guides/rel_notes/release_16_07.rst +++ b/doc/guides/rel_notes/release_16_07.rst @@ -83,6 +83,7 @@ New Features "Network Interface Controller Drivers" document for more details on this new driver. +* **Added new poll-mode driver for ThunderX nicvf inbuit NIC device.** Resolved Issues --------------- -- 2.5.5