From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from na01-by2-obe.outbound.protection.outlook.com (mail-by2on0099.outbound.protection.outlook.com [207.46.100.99]) by dpdk.org (Postfix) with ESMTP id 5E93D694A for ; Sun, 29 May 2016 18:58:44 +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=adcvfvqGpx+XPb2Mmg7bF4vCHmBkIDxDAvApfAsgoa0=; b=TiDorga6aCrzftnEYfNdyIbY0VGZWRJKA1u4qhrA2XWcUxGPXfdYwizS1fayn9KINkzkWfzqhCzzzrDa+LfpT2gci5l3LfR1xw+TG27iWEXCUUic3IGqc/iT8LXdwRJBpjmrm1uopb9kYj9vFUrtF6uEhIkMuEkCLFnWfz3NH1I= 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.187.184) by BN3PR0701MB1720.namprd07.prod.outlook.com (10.163.39.19) with Microsoft SMTP Server (TLS) id 15.1.501.7; Sun, 29 May 2016 16:58:39 +0000 From: Jerin Jacob To: CC: , , , Jerin Jacob , Slawomir Rosek Date: Sun, 29 May 2016 22:27:50 +0530 Message-ID: <1464541071-13252-3-git-send-email-jerin.jacob@caviumnetworks.com> X-Mailer: git-send-email 2.5.5 In-Reply-To: <1464541071-13252-1-git-send-email-jerin.jacob@caviumnetworks.com> References: <1462634198-2289-1-git-send-email-jerin.jacob@caviumnetworks.com> <1464541071-13252-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.187.184] X-ClientProxiedBy: PN1PR01CA0033.INDPRD01.PROD.OUTLOOK.COM (10.164.137.40) To BN3PR0701MB1720.namprd07.prod.outlook.com (10.163.39.19) X-MS-Office365-Filtering-Correlation-Id: f51e83c7-0238-445e-6ee5-08d387e27d4f X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1720; 2:wtXc2wLxLkFW/PBKfXxh1VJfcR6lMn5Cnn/q+88xmHZb4mdRadqY/6HP9Z3gC4zY/pe1klX7V3+mly/94jx2PB7e5+iTrezauucjtjrURyH/t+AR+lR1YMK23+UodCEy1NabClX73D8rljTKj5Ht5OUt+EMDKWLK67Zs3mN20Zh1RXxf/Y8XjrIqv3cIemiv; 3:jFV4lgDfGZqvL+oUK+zJ3Y8FdpN9GBc2JD7ENTDToSGwc6jr4Mg+P0dFncFYL6R2v2oW/2dm36ZxXENRcIw95P4HoB5LIoI1n1DXH+rbcRCl68jpRw9+jcj+8me5X104 X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BN3PR0701MB1720; X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1720; 25:mK7Nogl1Nyf/yt6672MuONLeOzWgNw6ngdkW+CkOMTdSHQIi9TMTisJa0FWxzwHXbFxoMTagAbTf6fUhkBIqhNMSnCq7N1jDs6H/ddbvtoWN2Yu0CjLVhhBvI/QPJfQkex8Qx8Bm7bctJchSFYMxNszuqBaFT7nc6ecBKTI0eqj4ZVy/IazzPUb0aZjVEKke4vTRBGIpmo4/P/LiqLrDZbjNvg5ibmUNmg3qDEc5+QKYSZvyv7h1Md0FR4nvX3pGXIe3nlHH/viAYNb23IpglEEQFtRnII2u5CeSH2Fc938TmAubgS8gqa3vj0W1xr8rT5nmF0c1gBBoxnuL8TmtWcAihDqYnXtOlx+B4DUesdDEPJ03329q4NMwr1KuS9IcoxlkWktOHei3IUH+Bhzp2sYzBX3CA6dAvii9EB7QH28uoe70PDj1jKmGVDIw1ha2gykK7dROXVEEn2mn/fUOhGB/JyyepVU2A6govztFdddGTGw5MR1ecoL05hK6wHGn6p8iMJwSP2gq+KwNpbuZ5FFzKGa2+rTh+Mar4MiqbqHZpxAcdtj+WK4QDEUs71sfQyujGzA86BKR3tt+S7bkiyHrmkEB3hb2HvTzGK4GH6XdMfSFmFfeASw7FqcPKVk1DFjgdJLsZtWlwXOUO27s0LGbUNpue2oXuQChABzdlpwvdIvE4MoVizWZsCcut+syuPFXX9WDs7k2sho7xqcjg639UfEsEaBYEtluEMmy1GKXlqyJ2BQXzOw3aa1Q9pXyPB0IiI2UbjT5tzFONnczbriI/WVibqT3xjgNUHNUoczHyCcbV2Gg7qsEwXa+ulrcBeR0G+M2LWU+YVCiBaBxFXzoU8X3+WPt01fODclvpIoJBGWzzaNhU9dsI+YPJoTj X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1720; 20:EEIymo6NfERkPP5Ao5AZ8bbJdI4OVa3Uh9G5dz9UUb88ADLQAT88tEvVvs5x9Evo3fEmwUeTh1Sw3zG9wv4sbMyijB31OziM/SRFjES2IHPZjlPPTp6C9qTPTXT0M62pAYr/ZNfCwJN6CEAx5AWju0Qo49NUTVEzxVJdykxLIGMxIxXRxKlJKYnJjDga3LG9sQC0cZ6dy6WqxK4gVVqUljOyX/rMZf94OOvMZkLl05CpI3H0Z0By83QWA0+UUT8dF8Hisk7zaObqSYMsnqerlqpP816tlP5helCPC7oeBUKohR4xCVyd1N70+gA/9pPJOVsPUj2RitH2TZpv9mVRAvCxLQjtVVskJxZSwFvw44EP1ms8JzL4a7e1t5t9b+xHgaWG0ny2AP4xnbnC9uX40d47GRzIU4TPDp8uVUEH5MM4d591/f6ewQCpnsVcbR6YsDJupfM2822wg26rQa1nVkD482Tk8gKTZeUBNRnPNrFmfPNrY1DkC5YdeJO/wYKYGXlFYVXBKKt94rqgypIvip9+duTLFStO8xx7pTTlv7AsewVz7CTW5LgQlsrD0vBAFAASYs/veYuAFB1OBG60hJM0PRK0T5/Am+YMx5USHvM= 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)(10201501046)(3002001); SRVR:BN3PR0701MB1720; BCL:0; PCL:0; RULEID:; SRVR:BN3PR0701MB1720; X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1720; 4:gXz/MbC8sTXvJleJi8oWVY7m83ubtbUTh/CzJejeUR+foGc3SQwwVhOS43zgmyMo+IJGPoeKA+uP2rF8nXWXXJv5h/tgGtcyZp4uhm5mv6A5NWO5ePiFMUK++3UVU3wyUZW98gxz0jqNF7vu3F9WsNWmR5QIrC4wFUORVk6gfXgWlGQZUXjXhWDlm4j2GEUs6lOTRXN9ttxiP2lyfEU792drcJtvytMWWpw8EVa9DxU0O8gBg2BV68vlYQt4jkuEipAJMFXp2lGR1Ma838u1IIjDTSex8dppqIvG5Z15ux9zXWrG3keriWn1pqDNsaomBLFuZVSnw0fSkEsAyKpWu1bknJpxgSHZhzPwbMPmRP2iJn35dcOSCe+VeUP/sxd9l2101ogHSIcZBnti0ldwjxCINGA/417HLu8Ii+8nhvI= X-Forefront-PRVS: 0957AD37A0 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(6069001)(6009001)(15650500001)(19580395003)(4326007)(47776003)(76176999)(50986999)(19580405001)(77096005)(2351001)(5820100001)(229853001)(2906002)(66066001)(23676002)(10710500007)(36756003)(2420400007)(6116002)(15975445007)(8676002)(7110500001)(81166006)(586003)(5008740100001)(33646002)(2870700001)(110136002)(92566002)(3846002)(2950100001)(42186005)(50226002)(189998001)(5004730100002)(50466002)(7099028); DIR:OUT; SFP:1101; SCL:1; SRVR:BN3PR0701MB1720; H:localhost.localdomain.localdomain; FPR:; SPF:None; MLV:sfv; LANG:es; X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtCTjNQUjA3MDFNQjE3MjA7MjM6SlF6eWwwanFSKzJUVFgrZWNHRkljZldj?= =?utf-8?B?dzU0OGpHMmNQcXF0M2NseGVvOElyY1VCY1JPaEgwaVJKY2tCbkFnb05JVXBS?= =?utf-8?B?eTBYU3lrbUV0V2NvSnJxcUE1bDVQWFp5UENzRy9aOWFwQkdNTks5cW1IMmJC?= =?utf-8?B?TWNxVlFobDZwQ1NZNjJ6c1k5QVdvUU5CZ1l2QWZkcFJ0ZEh2cVRYRGlFbzZP?= =?utf-8?B?RWNNL1g5Siswb0t0NmNaMHBDYmNxRG9uam1ydUE4OUFSZ2s2WEtNb2hZYUN4?= =?utf-8?B?TWRieU95eTJwVERyTWhGa1lNalREaDBRQUlza0VRTjBsbGNqc1h5ZkpnS2hp?= =?utf-8?B?Z25QOE9KOHIrOUdlMjZaeHcwYnF1U0g0dWdYcmpzMncxMGxIemphSnRhV21o?= =?utf-8?B?L0tNQ204RTBPUUJMNm1SajlRVExrY3puc1VwUmlYQk1iU3RpUzNzWklhOXow?= =?utf-8?B?V1FxNlZqWGp3QVRmUFdNNzhGVWJuYmFxT2FSdmNma1hKY3FURFU2MjRqRjhp?= =?utf-8?B?eGM3aTZ6QzhGOHk2dFlMTGV6b2M4T0tpZGV1Ky9jVlFhV0Fnb1puSzg4Zytm?= =?utf-8?B?cjY2RUYza1B5aE15SHgvQ1VZd3RhSG9zam0xOTR4NzBvM1NDdDVxcjhTeFBa?= =?utf-8?B?YTJ0UDlhTFJLQzAzN05LVWdRUElDNGxKNnZpTE9uVDVrOFRTdGJ6Z2w5KytU?= =?utf-8?B?cmhzSHRCbUlsZ0JYN3pRbXFiN3MrSmZIUzAzWHp2Mld6dWkyOXhVUGtwUzNl?= =?utf-8?B?U2dUcGNWa1B2YXBFVjdnVFVXdkRpS1NKRlI2MklmN1JBNkFBM3pYelhDQlh1?= =?utf-8?B?b09mbnpZa1RkY0VsV2JZd01FemNhWnhFOXdnRWdoTlV1WmRscm4weHhpTzVW?= =?utf-8?B?L3Z6dmplbUpaNlVia0M4Z1duT3AzK3Q5S0pJVkRWTGtySVNPLzFScHRyNUhV?= =?utf-8?B?RzVXSk1CTE5WSTBZWXlDTWpQM0QwNHpkMlNRM2poL0hXQ1B4V1IzYWtOM0gz?= =?utf-8?B?YjJTbG92MTc1WEEzYUhtTG9GYXpEWWowaXRnQWw5M3dsUjFIWGFEZVdyN2pK?= =?utf-8?B?Vm82NEhEcW1IU3ozKzBQdk0zT3I0dlpCUlN6a2d5TkwyclNWbkFrWE9lc3hs?= =?utf-8?B?TTk5ampUWXVpYzhOU1dzckgwc3lGQlhjWW9YZVhJM20wNzFMREg2Ry9WdXVT?= =?utf-8?B?MXVlTEVia3o3c3ViZEpvU0JOMDNzRjEyc2owYUFYM1NYenVsOVQ4UWI4VFNS?= =?utf-8?B?a1lvMVFUNVNNVnpCTlN1bTFmSk1WVFFHdnBuWjF2dUpOQ3ZkVmlPbUJ6RmxS?= =?utf-8?B?N2EzM1FJM0xlZU12ZkswRnFCWjFhOG9zMFkzeG51QkhGY2RtY3N5OHJ5Qkhi?= =?utf-8?B?REJ0NEJEOU1hUytwd2p0bHNWMzhDSlpKQVhKUG5XQlE9PQ==?= X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1720; 5:JDHhjCB6MHHJz2KcgUfQC2sXjNqAI2/oHo7Qs7eCxzo9qOw8ZiECSc3DOJeR3DLub1fDdSZBZAR+YvrO5A9HHMiOnLyUzkY80Wj5dwttXIm4noWBORVZ4yoLR+uaad0qbO8VrfTPMrMsvGRC2UWkYQ==; 24:6Uq8rnMX+UusXsP+UEgSwMW16T5kFnWxYQtmSMsArJLz3gjcpuGrNAp1niYy91SApqO51RxQ5lQc4sTtkxZRB/knYhYKJGO284ly392txYc=; 7:CitU/oGn4GhqzYngf6UVck1A/jTuqC6yXstT4D9wIubX0tq3hII9cgXjslkk7AGReQ5GYOYn/hETLkLTZOn3L3PNufIHr4EEAAOkL1OYH5aAICKV00dm245mcm3JRNhhdrztGZbHw1uF9YDlucuVhkr43bpoEuxljuXFsdz9STtYpCNHbkp0x2gCEqpJeVrK SpamDiagnosticOutput: 1:23 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 May 2016 16:58:39.7212 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN3PR0701MB1720 Subject: [dpdk-dev] [PATCH v2 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: Sun, 29 May 2016 16:58:45 -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