From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <Jerin.Jacob@cavium.com>
Received: from na01-by2-obe.outbound.protection.outlook.com
(mail-by2on0092.outbound.protection.outlook.com [207.46.100.92])
by dpdk.org (Postfix) with ESMTP id D30C766DB
for <dev@dpdk.org>; Sat, 7 May 2016 17:19:15 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com;
h=From:To:Date:Subject:Message-ID:Content-Type:MIME-Version;
bh=4GbXl+gnIVU5gve7NL6CU4EvwWtmENbdnRTFM28NGek=;
b=kmsyRIJIplPsMErKqaDDNH8TKJEXZbTPw1gdykC58S/xdjGCinRr1p5sk0Ki37llnn3dgWUzhE6+B/JxbY+/Agnv1gZbagHuddfxhl2cJj0DtQkV2Kccl577Dm6fRpGoLdgMryXuZlJ/nDMno0WdyKM3sMvJKZGVO+YdPm1TySo=
Authentication-Results: dpdk.org; dkim=none (message not signed)
header.d=none;dpdk.org; dmarc=none action=none
header.from=caviumnetworks.com;
Received: from localhost.localdomain.localdomain (122.167.10.92) by
BN3PR0701MB1718.namprd07.prod.outlook.com (10.163.39.17) with Microsoft SMTP
Server (TLS) id 15.1.492.11; Sat, 7 May 2016 15:19:11 +0000
From: Jerin Jacob <jerin.jacob@caviumnetworks.com>
To: <dev@dpdk.org>
CC: <thomas.monjalon@6wind.com>, <bruce.richardson@intel.com>, Jerin Jacob
<jerin.jacob@caviumnetworks.com>, Slawomir Rosek
<slawomir.rosek@semihalf.com>
Date: Sat, 7 May 2016 20:46:37 +0530
Message-ID: <1462634198-2289-20-git-send-email-jerin.jacob@caviumnetworks.com>
X-Mailer: git-send-email 2.1.0
In-Reply-To: <1462634198-2289-1-git-send-email-jerin.jacob@caviumnetworks.com>
References: <1462634198-2289-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: [122.167.10.92]
X-ClientProxiedBy: PN1PR01CA0050.INDPRD01.PROD.OUTLOOK.COM (10.164.136.150) To
BN3PR0701MB1718.namprd07.prod.outlook.com (10.163.39.17)
X-MS-Office365-Filtering-Correlation-Id: 6b9e96c8-7543-4592-43a0-08d3768af316
X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1718;
2:V2/eqyGQZ+GbyYzfGEzIWQ1oj31iHAMaQfwTo7vj2OsvvOQ9F4ZL7CGV4p+OnNi6rKaUG02wUGXCMt5x1BXafgN6wxJ9gVj+iVyEB+jeMf0omhJMsrN2CnkM3P7MT6a/5LvzTOD5ERG2TMZky9QBsWQYKuOYSCmuROlwE7gkd3kVCDMk+3uN+Yq3oTJ9ew6Q;
3:HAMwxXMk0KVRCHK14lQqjtujzceDnjPa01TPmAWNdhuAKKiVvBEIWAnZXJOBwfCBkxZImu4Fj85yJDud9BlBYuvTTEuDFsl4TZH9HhdIPbHktP9RbXn9hmbCSzLqgral;
25:rVRldBKoEhgJq48k66IDfgPlKjrFqsX1jSgHpvQsITy5TlW/HQewa5LeWurIQ1eTAb069llC0DxW/nOsJFnha4HVm0RqQbONyTExw39ow15S1RxGlOAW8Gpr7frBUW2cP8iIJoh8SoEMmIEb6uGQPS3srzHjpqBjWOKRiZngcmCurBHPg7lObPb05Wyf0f/iMUQofKUgrb2+kvewXX3V0CBN/4U8I2CGwrJX0sDu7A0ix3YGD4uA51dhwpiS9dyMd43plNWYiNdUeOxJLegnmhAxOvV4UnBD/a68WtIP3Ms/zHkFL0jOHV9brGzw3XQmk16QQG6Mc42Lh05H+eciivdeI4lnahiTII2rf00wI+iecI6Dhp+PMxQ2hDFCplZTnHPHGAblCAZ1vKixuC6FxQ==
X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BN3PR0701MB1718;
X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1718;
20:Hhm4jz/CWFKgwP1/G1v/X+tzclkz3Bma+1OqHjfY4ycvaRaB5AmkRaapnQaf4B64YfHFBdbQ/eqAuQPAhCl/2NYXoRoOqUfqwVwik65n25LaDhJCmiMkwLR7LqbCdLNOqzvwpopdyhEppNtXmvNIZdzZFMkVLdOilHQrKVjQaAFZckQzoaqUYGAjGJkcZkU28o+G6DBf2AEsxQYG+dKGOx5gmUS8WdqQCqkAEGLjVqvVrt5vpVmXg8PekWaRtCxeqRWw6RSyhlzS0k3Go0ZW+O8Ln9Jbc9Zg1WvR2cyohzsxp0hJ6jhGPCkbeJVfP+6jcIh8AEdgFoNyX/bYctMu8yotKUtCQfJk3Ocu/oQXnphd4+kDtKS037Dn7tLg9genH21s2MTqPichteS1tyJRKs+jvMuAuV8Ym1cKoFbCrCCklkzQOp8dG9OJ2VRGxTlhSorEQFYdfsMnCM812wwXf9a9Alf1Mt2Xu7jK1pKTV2vZK8OCRkRRaF5o0g9DPi/T+F7oNDdBTIcGFlnRGoimb0B9bwKjGnBxgIwtQ0cc63+aGgqOpn9nMN+ysMvBE2ULzAS+5+CyshBfHCbJA/u13+bo5H1jT+8nvUiFtBRpR5Y=
X-Microsoft-Antispam-PRVS: <BN3PR0701MB1718D0EE483493156B36BF1D817E0@BN3PR0701MB1718.namprd07.prod.outlook.com>
X-Exchange-Antispam-Report-Test: UriScan:(220618547472400);
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:yUlYj8J2E9HmA6czHaGBIvYQ+jBhB8E3FF6zeR6UjCY1JPQRNMnQ5ppUfr9TNJE33au+zrGeJrEHuTshfORJWyUdc3F9c/9yy58jUBZHbM8f9VCKwzszVCtig9NGPmsKPG+ECqGWtQgV+2o1F5BHXHhWh1/3yKAWS/Smn4ZQeAGRewrl5S+K7mSG8A+UoIKxNL4dlbEOgIk92m/AnIIbcNALGMskreim9mEC3tUciOXG+Wf0eXb0dty+svkh8JmcDP6lE1DJGAcORjFceK2EmRjG8JLnU55cleM641DxStN43BI3t65vvp9N6ywpHVI+UCbW/C0at9D6UajvTfDhlraFvJLJL+TUOnpdyjFtwWuUACioWZT9riZBJI//VZE48LvYQpOD57gUDrcPyGe1dwhd/e28oajiNQBQqKR60zY=
X-Forefront-PRVS: 09352FD734
X-Forefront-Antispam-Report: SFV:NSPM;
SFS:(10009020)(4630300001)(6009001)(6069001)(50226002)(77096005)(2950100001)(15975445007)(81166005)(50466002)(5820100001)(66066001)(47776003)(15650500001)(92566002)(4326007)(2906002)(10710500007)(110136002)(50986999)(2351001)(33646002)(586003)(3846002)(6116002)(229853001)(5004730100002)(76176999)(7110500001)(19580395003)(19580405001)(189998001)(5008740100001)(42186005)(36756003)(23676002)(2870700001)(2420400007)(7099028);
DIR:OUT; SFP:1101; SCL:1; SRVR:BN3PR0701MB1718;
H:localhost.localdomain.localdomain; FPR:; SPF:None; MLV:sfv; LANG:es;
X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtCTjNQUjA3MDFNQjE3MTg7MjM6dTJCSys3bGFYNzdpR29jZFFYNzN5MkR4?=
=?utf-8?B?QitpY1VRcDZWY2preGFIcElaQ3dRZXNwOC9CcWxBZmpad1FwZzNMbUtyUFE2?=
=?utf-8?B?TWxJaldjVDZnUjhLNkRLMy9OZWk0bHlQMExlOTNWOHBtb3FISFFuVVA5eEJu?=
=?utf-8?B?TFZVd2ozOCtEaWkzNyt0d2xURUhSSUVxbEU5K1hOdkErMkFpS0lFU2wvYXV6?=
=?utf-8?B?eU1PakFUMjhvYU0rY2tZVjBZZjM1MGhucmJKNm5vZXdxalVpK2dKQXpVVTc1?=
=?utf-8?B?Y1VMdDcxVGNLRXVZT3owUVBJRXBwaHNTVFpBazZCUVdUVzVLam44c3dJNzBF?=
=?utf-8?B?TjNsYmFSV3BrMGdTYzFGTVA5SWV6aUtjWnU1RGpaQTMrM3FRSnFpSytMdUhM?=
=?utf-8?B?SUlLWkliOEZuQldpNUJnTWYzNEc1Q20wWDZJQWsxeTZJR3JLOUo3Yk5oWSsx?=
=?utf-8?B?aklxaE9pR3JwQjMvTXVkQ0ZnSkY0V0htWWxLcEJob0FiT01ma1c4ZW1UYzd2?=
=?utf-8?B?aHlEK21jRlVVeUxrSEFzWS9OaFpaRXhJY3RFZkROdmE1TEdyUVM4YitNM3Nj?=
=?utf-8?B?MU5HY1BJOUw5SW4wSFZPRGQ3Qy9VNDBnWVVxYlRKVW44L0FESFNOMFNwWHlv?=
=?utf-8?B?TUw0MFhEU0JiTDVJb1NBUUJPT0VkNWNucll3dytOMjFYT243QjJhYURRVXhC?=
=?utf-8?B?R2U0czgrS3FRRlYyL1hOYzB3T3BxMGUxQjIrS2VjZ3BQbUgvOGpGektZdkFR?=
=?utf-8?B?WnJjUWNUU2FmN3BLeVVsSldVeGJvU21wd0czM0dybmVuR2dxMGxHbVVBTis0?=
=?utf-8?B?WUp6MGhhNHcwWkJyckR3VkFsV1JsenJBajV3aDl6M25ZTklPT2tjb3Zic0JC?=
=?utf-8?B?dk1LY05NOHZwUlBlVndIWHRvVGRXSENOelhWWGpxT0NWaDk4bDk1c2JlbUlR?=
=?utf-8?B?MlFXZmp3MjBrbVBWL3UzbEZRUW9mYXB3MEtRSWdqUW80YnRhSmZ0RkowVzdz?=
=?utf-8?B?ZnV4Mm43VXlST2I3eG93cEdNYmYwQm84TitRTDFHdXFZa3pBbXo5MFU1VTRH?=
=?utf-8?B?L0ZmQ1ltUHJTd0pGWmw0aTg0SFA1MkZYdGZTZmlQaThvTld0cmk0SXlQRTJQ?=
=?utf-8?B?RlhQQmRZOXU0WVF6Y0wzY3UzbTB1Njg2U2hHQ2pUMFZBTUIraEpmRXhVTmdt?=
=?utf-8?B?akg4Ky8wQ1l3KzY3ZVhHU0pXbi9BZ2VMd3F3eXBPODRuUUhrYkgyNHFlVVN5?=
=?utf-8?B?bUdtTCtyakgzT2NUUDg5eS9hcnBMV2U5cUJBWkRvaXkxdUJ4RFlPYlMzT2Zr?=
=?utf-8?B?UlRnWmFtL1VhZ2o5bFk0T20vMTlNbUxaRVl4VklXQzlrZ0JoSVN1VEZ2b2ph?=
=?utf-8?B?VENveDJVL2E2L1FIcjAyZ0U2WERwNEl1N3BGaVJOeWc9PQ==?=
X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1718;
5:sgZ31WPw7WFioa3z7aqTKHjrDbVqyOcvW7gyy8+WP0eNv37JW4zY6iq2PKqzH40CYoGSGAKcDQcAVND/BNAMHCgzXwhJTxpPpkSRe2mTMMaUX8F4xDSr0QB1b/Z7pgY0GqcZIUlOOeI57liW7HHkDg==;
24:+Voc0OfM1pxaHLvOVraF+4vj92Fh7hOhfy2prT8qd6gq0AQok3WehkQMgIXomBrjuOcXePq5JSHnpkFoYFQ+t+3zI0T2i+uoCsrXpqslNmA=;
7:cAVtlA4+vHdF5c4SekKKSD8R8RWIohoQ/8KOagMGtoVjqbKwIINAnlburyUbd7zhMqYozBQKRdmpCDbgFaZ2NrjalxgIbUbgzyUUl042D77ihyKql06QNPoTCcl+24ZOWpeD5y/IkXiFdee7Hyeneg9ic5hHkzjGW77yGcyx9Cc+jAViNOMqc/uJBY2uchSz
SpamDiagnosticOutput: 1:23
SpamDiagnosticMetadata: NSPM
X-OriginatorOrg: caviumnetworks.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 May 2016 15:19:11.3851 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN3PR0701MB1718
Subject: [dpdk-dev] [PATCH 19/20] thunderx/nicvf: 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 <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Sat, 07 May 2016 15:19:16 -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 <jerin.jacob@caviumnetworks.com>
Signed-off-by: Slawomir Rosek <slawomir.rosek@semihalf.com>
---
doc/guides/nics/index.rst | 1 +
doc/guides/nics/overview.rst | 94 ++++-----
doc/guides/nics/thunderx.rst | 349 +++++++++++++++++++++++++++++++++
doc/guides/rel_notes/release_16_07.rst | 1 +
4 files changed, 398 insertions(+), 47 deletions(-)
create mode 100644 doc/guides/nics/thunderx.rst
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 769f677..58f4873 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -49,6 +49,7 @@ Network Interface Controller Drivers
mlx5
nfp
szedata2
+ thunderx
virtio
vhost
vmxnet3
diff --git a/doc/guides/nics/overview.rst b/doc/guides/nics/overview.rst
index f08039e..4eaaa71 100644
--- a/doc/guides/nics/overview.rst
+++ b/doc/guides/nics/overview.rst
@@ -74,38 +74,38 @@ Most of these differences are summarized below.
.. table:: Features availability in networking drivers
- ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
- Feature a 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 r s v v v v x
- f 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 i z h i i m e
- p 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 n e o r r x n
- a 2 2 d b 0 c e e e e v b b b b 0 0 0 0 4 5 p l p 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 a t i i e i
- k v n . f f . v v . v v 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 c e e e i i i i i i i i i i f f f f m m m n n p r s t v v v v x
+ f 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 i z h h i i m e
+ p 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 n e u o r r x n
+ a 2 2 d b 0 c e e e e v b b b b 0 0 0 0 4 5 p l p g d d s t t n v
+ c x x i e 0 . v v f e e e e k k k k e a e t i i e i
+ k v n . f f . v v . v v t r o o t r
+ e f g . . . f f . f f a x . 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
+ ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
Speed capabilities
- Link status 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
- 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
+ Link status event 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
- 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
- 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
+ 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
+ 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
- Allmulticast mode 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
- Multicast MAC filter 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
- 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
+ Promiscuous mode 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
+ Unicast MAC filter 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
+ RSS hash 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
VMDq Y Y Y Y Y Y Y
- SR-IOV Y Y Y Y Y Y Y Y Y
+ SR-IOV 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
Ethertype filter Y Y Y Y Y
@@ -118,37 +118,37 @@ Most of these differences are summarized below.
Flow control 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
- VLAN offload 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
+ VLAN offload 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
+ Packet type parsing 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
- Extended stats 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
+ 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
+ Extended stats 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
EEPROM dump Y Y Y
- Registers dump Y Y Y Y Y Y
- Multiprocess aware 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
- 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
+ Multiprocess aware 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
+ 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
+ ARMv7 Y Y Y
+ ARMv8 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
- Usage doc 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
+ Usage doc 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..04257ba
--- /dev/null
+++ b/doc/guides/nics/thunderx.rst
@@ -0,0 +1,349 @@
+.. 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
+<http://www.cavium.com/ThunderX_ARM_Processors.html>`_.
+
+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 <linux_gsg>` 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 <DPDK-source-directory>
+ 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 <thunderx_sriov_example>`.
+
+#. 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 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 <thunderx_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 <kernel image> \
+ -append "root=/dev/vda console=ttyAMA0 rw hugepagesz=512M hugepages=3" \
+ -device vfio-pci,host=0002:01:00.1 \
+ -drive file=<rootfs.ext3>,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 <thunderx_testpmd_example>` 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 83c841b..1a91c15 100644
--- a/doc/guides/rel_notes/release_16_07.rst
+++ b/doc/guides/rel_notes/release_16_07.rst
@@ -54,6 +54,7 @@ EAL
Drivers
~~~~~~~
+* **Added new poll-mode driver for ThunderX nicvf inbuit NIC device.**
Libraries
~~~~~~~~~
--
2.1.0