From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from na01-bn1-obe.outbound.protection.outlook.com (mail-bn1bon0076.outbound.protection.outlook.com [157.56.111.76]) by dpdk.org (Postfix) with ESMTP id 2CDD29AD6 for ; Tue, 7 Jun 2016 18:42:39 +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=adcvfvqGpx+XPb2Mmg7bF4vCHmBkIDxDAvApfAsgoa0=; b=YMB5gf5FjZpvcnkCnw3sHjiU3Zy0nmdzyZ5Dv5jxC6IIBL0aov7iwsBO1/0ITZodu791hJihC5bAvTO8MzXq3ULxGNcJwvaKaeEnwilxmJGSxySM+2Zoe7biArN1DO7Pa0HfohifeYRMfTGGz4ZpVs3hlyscY8tshwzzLF/tqWg= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Jerin.Jacob@cavium.com; Received: from localhost.caveonetworks.com (111.93.218.67) by BN3PR0701MB1719.namprd07.prod.outlook.com (10.163.39.18) with Microsoft SMTP Server (TLS) id 15.1.511.8; Tue, 7 Jun 2016 16:42:33 +0000 From: Jerin Jacob To: CC: , , Jerin Jacob , Slawomir Rosek Date: Tue, 7 Jun 2016 22:10:31 +0530 Message-ID: <1465317632-11471-20-git-send-email-jerin.jacob@caviumnetworks.com> X-Mailer: git-send-email 2.5.5 In-Reply-To: <1465317632-11471-1-git-send-email-jerin.jacob@caviumnetworks.com> References: <1464540424-12631-1-git-send-email-jerin.jacob@caviumnetworks.com> <1465317632-11471-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: [111.93.218.67] X-ClientProxiedBy: MAXPR01CA0054.INDPRD01.PROD.OUTLOOK.COM (10.164.146.154) To BN3PR0701MB1719.namprd07.prod.outlook.com (10.163.39.18) X-MS-Office365-Filtering-Correlation-Id: a7d35a94-3758-472d-d85f-08d38ef2ba95 X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 2:1Nzq8nPCYeCVimEqoEwlqAJLJstfIHqIWQOSLygl78Bif45CrZ6qCmyJ8SivcX5z0O4nTva+Hl30pLB4pXlUeZJQ2SRFI0yUVmcaD8QfLETIEuXe0QCSQV1WTjNlvwXC4RI0Dc/Ds7jgClPdv5Ql4vq55xCM6PaXhQ9OBP2SEJDhRX/aSyMby1BuPgkFh6B0; 3:/guZkZcxzi5VbfZgxRn6tQggzdGopLwGL2vDpiY9FPzrz+8QVM/rCKVwauj4xxkDnvvCjcTwp6CSsYrEJBLOVqF3pTH1LqYt6g2+gngYTUx95RWhWKC3nZtGhIRri6WB; 25:U0w197mq6+Yd7VpTUIoYzUBzVDH8Kv5T/wePTc0P9YXvFcIlBdOiQS3zmc7Lu2ijA81APke+11kgbrjYidJwPaJEJ+P5SYcUEC3KRp50zefZyly+4WxPtoACbiKC0lQQlsTKsg7eIGO7wNxbds4VZ54XCLWvhhVhRyikImWJ+33RksoILnlU9JAA3Xl1esSoR4hBT1Myd3QDsf0gxAmla5hAPKEVMyXS47txQ3jkFXQFZtxoD1xUCbGWgOK60le/2XdCVIRMdsIwQk4CjY2NJMdIXel2zjx3MHSGM9siMiCy8Z9IUVMqbRISFhVgt4A+T6wfQf4NtfdahOA3J+3HLGYk419fO8GrCfd44tDtXMnJtdlZe7dcgwjDABsaknjAX/sJz4iJUwYv2g44QMwwDO7AUha/7ri6AzKLV1/OdYU= X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BN3PR0701MB1719; X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 20:tUkOLNa1jLxbvLVxlxBIOLSAjI6GLSM3xMKzWvExxVn9WLOzKFhOwNMHWDy7Qo1/+99mXOE64AGghSPCF8r6IsjR18ezIOdcWHTy4c5v5rGUdYP0gv0nZz2d67gAg50rzwpeqq0IAMxlBd+A6x1OhDL6iWMtr1zxs8hS9Y4ZlupAimSnyHVWV/biKDsJVOcSQ5fTUz1dLFLA2wO7h2lz/QT//9+1E4/K8Ctza7/DGdNGV/f0d3QJewhFcpi2T2CDVlzP2/OxJQDhqTmWjqwXXzp4u4GMWGHcLO3Oef85izeMfHw/4Lvpjg9DXz97l7cx7COhjC+wjoXa+T4UimGE4ygn5zVF2TdpE/RVMM2UqZOf8qHgLJ5FMglweVspZ7eGSG5A/z8fWNqg1r52nI8dswOpHvkar/fSOTXbKhnljx2Uou6C1eDlwNX+KLe5l8kt0ma+7qQkf3gwektGLpJjco67cStgfQrS/OeGflROZVHWzICqLZ83A8fd9RicsrOEDnBIhNfb7enQXfchEQkhNa7OmBFfQ2QQzYj2ax8uSjdNZZvdkd+MnCQ9jv/Wl4wC1D/d4n1hyyQ4Q2Y8s1X7349LpP/ONYek1o9AcicFXIM= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(601004)(2401047)(8121501046)(5005006)(3002001)(10201501046); SRVR:BN3PR0701MB1719; BCL:0; PCL:0; RULEID:; SRVR:BN3PR0701MB1719; X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 4:OLQAPHB0LwgTP8CKKFFa1lpQol7LTMCkiUqheEVGh6X+no/5vKylV5EuBbkKr/ncOxxYqUrJQPxfMvGx8ZBRX+n/Kl26onv0pESkVKZBlxv6jcbIIaofhdK3dlVy/3pNCIxnJR7w8iKO1GaMfEqhpDsq48AJX32uholjRA/Vz3LNVzF7IHF4nb0FR9o/rVaEAttLzOO9v4qnGNZ9VquOQId9Mi/jfJEGSqmZUMW9OCFkoz7D6bogfZcWYQ/rylqE7atWekuuheqGYTks1mZKygXeaCsk79wAlvxW4qAJ1soMFWb02fIapHUcRy2VaR/PQxoc7DuaZabT1UogwSM2165m4se9bXaVW/o5W2w2hZZFHfiI/z6cTpFVUcb+DyDfqqs1IdWtxp7GilHn3YLvNTVVa+BLstDyQjOP/ophoKM= X-Forefront-PRVS: 09669DB681 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(979002)(6069001)(6009001)(199003)(189002)(81166006)(8676002)(81156014)(47776003)(66066001)(36756003)(92566002)(2950100001)(586003)(2351001)(15975445007)(76506005)(5820100001)(42186005)(50466002)(4326007)(77096005)(3846002)(6116002)(53416004)(5004730100002)(2870700001)(105586002)(23676002)(97736004)(2906002)(5008740100001)(10710500007)(106356001)(189998001)(15650500001)(19580395003)(69596002)(101416001)(110136002)(7110500001)(19580405001)(68736007)(33646002)(76176999)(50986999)(229853001)(2420400007)(50226002)(5009440100003)(7099028)(969003)(989001)(999001)(1009001)(1019001); DIR:OUT; SFP:1101; SCL:1; SRVR:BN3PR0701MB1719; H:localhost.caveonetworks.com; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX:1; LANG:es; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtCTjNQUjA3MDFNQjE3MTk7MjM6UGVTSno4ZG52ZGVXc3pRMHBOWWJzR1hU?= =?utf-8?B?N0VDZCtQYksvQkdUU1Q3Um9icVY0YVgrc3d4aG9jSTQ1Sk00WHFORXB2UWFB?= =?utf-8?B?cy9zdmRmeW1pemRTalR2NWZSdGhiQUtlVytkRUFROTk4end5U0ZHRHJXajRK?= =?utf-8?B?YXhjSW9vN3B3YldTN2o4NERndGF3SndOa29EOUZkRXVrei9Rd2o2RjFJY1p6?= =?utf-8?B?ejZ0ZnJ5eEIxb1ZYRURwZkQ3Q3RKNjVEL1NyMklwWWtJSnBaYW9GNyswYXl5?= =?utf-8?B?WFRhSzFQWVEzMmR3WHpnTzIrOCtNQVBxOERZNEYycDhPTzFDTW11U2RMeDZG?= =?utf-8?B?N25RQ1JhYi9LNjFZQXB2WkNxWXVxM1dlTFhzYmlCbUI4cWExV1F1UkV4WEFu?= =?utf-8?B?ZDdIYzFtMjc2Q3ozOFllbE9SOEdyOEg2cElwL3BnMTRWMllQN0tWbzZiOGQ2?= =?utf-8?B?RSs3NmltQytXem03OTZHMk5EeERIbnd6b3lkMUJCL0FTMHRQeXBNQk1KNjZw?= =?utf-8?B?TkdiRlZHT2swcHl2SGV4M1lnU2RSbmpUNkJWMXNSQ244WWVVQjNsU29qbVdD?= =?utf-8?B?UnJVaGs4aUtNM3NBd0pWYkphbnB6cUxDQklVSGl4QUZ1Qng1RVpxaGxvUzY0?= =?utf-8?B?RTI3TS8wTjFMK3Yyb0U2NEpZY3AyQ04xczU2ekJZdDRSa3pNM0FjR2QyRmlB?= =?utf-8?B?UFVJYmRCVlNxTVNZK0xIaVZDUHVlcFA3V203U3pPTmhueXhQUlJ3aTlSVTFM?= =?utf-8?B?SmFyUXBvcE1uVjVkanZZSlg4M1dSSHJ0MXZzcjJycWdKMkFzWllvUFB3eWVP?= =?utf-8?B?UUZEa3U5ZDY1bnloQllJOXRDYzhvaVo2ZlowUmJSWFF6VVFEYVFBMHZPRmlo?= =?utf-8?B?RW1QaFpBZlRNSUc3MUN4QS9LeXZFV0hxSXl1SWduUmk2WmhiSHBJVGxlSHJV?= =?utf-8?B?Q05BUEFzWHVYVlZQalN1bTRTakdUUVBZT1VBc3N0Z0JpUUE1NStsc0ZIVjhF?= =?utf-8?B?TDVqdkdSdnlYcS9OMDYxTVAzd2xpd2hOaTNUQStVV2Jvblg1YmYyYzlhdGk1?= =?utf-8?B?UHBzU0xqdXNXUS94Z3B3UjF6RFQ0dEU3WjB2dm9iaVM1RkN4NTh1WGMwSXN5?= =?utf-8?B?Ulg0WXk1MkRvSmZRWlozSldQL21NOGJaL3pncTdXS0prNlBIOTNkTUtTeVRi?= =?utf-8?B?dEc0Z1RWYlBmMmVlSXd2Uk5aZGlJREhMTGNvQW1YcVkwVWFXK0VrR1dyd3J1?= =?utf-8?B?N3Jua3N1VGV6UHBubDhHUkY4SVdYRjdsQk5vOG9YczN6Z1U4VzRQc3A0dEdi?= =?utf-8?B?WkJFWVBJc0ZrSFdtZFJiSzh5THNHaU5rWEFMK3FPbG5ZcUhWc0hhb3Qwd3A3?= =?utf-8?B?VWlFSys0U3lMRG9veHlrdURHbGt3OUFjQ3N1MEc1WXJYTUUxbmVSTmIzOGkv?= =?utf-8?B?WFBzNmZqZEVnTGVKaEUzRGZhOUNhMlNwSDM1QWNuV0ppcUdkblo3dVVtakNn?= =?utf-8?B?VVdIK21mV3UxQmNBd2NTVHZuSG1xOUJZR2lFWFdnQVZaTEU3dlNsSjNMYXVY?= =?utf-8?B?OHcxcjRoRXZVc3JwWFNXelV0UE0ycnVFQ21rYm9FRUVCOWZrR1JxNGYyTlZD?= =?utf-8?B?YmpKcmdYZTV0cVh2azVmUVpleEFBTFdqVTFEcjIxbzhIaTl4QmExR0hodFVR?= =?utf-8?B?cU5oRjZ4aGZQYUhIZnEwaGhic1diQlM3TmMwd3VaTDFZQzYxcnFwcmN2Q01T?= =?utf-8?B?U3kvWllhK3RhaGdQMTRhWlV2dXZJUlRXV05mRGZOdXV6Y1VKK2c2RTBYL0du?= =?utf-8?B?RXhydGpWZE1YcFdJNmJ4RzF0MUM2QUZld1A5RTdLTCt0eEdFcFduOVZ0QmVh?= =?utf-8?B?SDEyRFNEMU52RzFYeVQwUE05MlQrR0ZzZ3FLMjhZUUxhSEtvZUxWOUFwblQy?= =?utf-8?B?a05ncUdYbHIzd2c9PQ==?= X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 5:svyUIf/fbmAhy2Mr84lTdscrCQbRQ6Mxwaik/z4jTIgTUbd/0FKqR+wR09G52Kuq51Vfm4olE3gfv4G4FuwsBGkwOpT2VyiLqmDrIgfbMiOmxqrhYDANf1aQ8emMmvUu1UPx0fhJMRzkna4HKjkRuw==; 24:jbwLQA1y3mFnHAooIWgtkymM/dDyVvrhfQDyjrwZR0SfBek/i0SmUme9vY6XuZKg+RhUhhmgNGZ+DTaX3o9i5ssWDXRgkLK4vFUZDAtwCSM=; 7:frWDUlgyRqi89dGbb8Z9gH6TZrepxsNuCZbD6+IoPAAk2kpgeripNvt2xCGbk/z24tyUcV7q/F5js/JY+mpJ1NbTrkVtRirUS1YoO+CXtnSFxVixLMTM2fNbFD9xst27TXizuXx76AEJ1yJ9/dIdQAmNYCxFYEBvk2mOHX6Vck+qd36W4LWBR74OItf3l1veaQQFPOXYlmyY+0o0cN7xZLicuQXsSrpGqN9zG8iF0h8= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Jun 2016 16:42:33.4854 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN3PR0701MB1719 Subject: [dpdk-dev] [PATCH v3 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 07 Jun 2016 16:42:39 -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 0b13698..ddf75f4 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -50,6 +50,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 0bd8fae..df28510 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 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 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 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 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 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 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 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 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 - 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 + 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 - 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 + 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 - 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 - Multicast MAC filter 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 + 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 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 + Multicast MAC filter 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 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 - 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 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 + Stats per queue Y Y 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 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 - 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 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 + 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 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 + 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 30e78d4..29b8b52 100644 --- a/doc/guides/rel_notes/release_16_07.rst +++ b/doc/guides/rel_notes/release_16_07.rst @@ -47,6 +47,7 @@ New Features * Dropped specific Xen Dom0 code. * Dropped specific anonymous mempool code in testpmd. +* **Added new poll-mode driver for ThunderX nicvf inbuit NIC device.** Resolved Issues --------------- -- 2.5.5