From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM03-BY2-obe.outbound.protection.outlook.com (mail-by2nam03on0059.outbound.protection.outlook.com [104.47.42.59]) by dpdk.org (Postfix) with ESMTP id 591FFF95D for ; Thu, 2 Mar 2017 12:40:23 +0100 (CET) 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=mABDuOrymcfuV2KE/2AH2gMd4xxZ6FEtyF7wctMD0Ow=; b=c75axTptco8dA1IFYEDH30K16WQgT+8Pf8vw27Xz1kpM9CM88YWZJ1Fbq30v6Ok3SjeAIjd2WqAW2MDIlu8B4VFCFa/2vvzToolbMrB+WaLBzQ2IYpPEeQeYrsN0JLJI+MTIRHVcIml2PfP1+hEGZ6iMwQl0BSXZanWdtUYP6VI= Authentication-Results: intel.com; dkim=none (message not signed) header.d=none;intel.com; dmarc=none action=none header.from=caviumnetworks.com; Received: from lio357.in.caveonetworks.com (14.140.2.178) by CY1PR07MB2277.namprd07.prod.outlook.com (10.164.112.155) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.947.12; Thu, 2 Mar 2017 11:40:19 +0000 From: Shijith Thotton To: ferruh.yigit@intel.com Cc: dev@dpdk.org, john.mcnamara@intel.com, Jerin Jacob , Derek Chickles , Venkat Koppula , Srisivasubramanian S , Mallesham Jatharakonda Date: Thu, 2 Mar 2017 17:02:51 +0530 Message-Id: <1488454371-3342-47-git-send-email-shijith.thotton@caviumnetworks.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1488454371-3342-1-git-send-email-shijith.thotton@caviumnetworks.com> References: <1487669225-30091-1-git-send-email-shijith.thotton@caviumnetworks.com> <1488454371-3342-1-git-send-email-shijith.thotton@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Originating-IP: [14.140.2.178] X-ClientProxiedBy: BM1PR01CA0021.INDPRD01.PROD.OUTLOOK.COM (10.163.198.156) To CY1PR07MB2277.namprd07.prod.outlook.com (10.164.112.155) X-MS-Office365-Filtering-Correlation-Id: fe86cdbc-e24f-4d87-0e53-08d46160e8d4 X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:(22001);SRVR:CY1PR07MB2277; X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2277; 3:H9gO6/DZzf8qgHxKJ7qo9U6dgGCYPz7qIPzPzzQrzEyJxuioFXnnfYvNIs1yd/E4j3D+uT8ZKgTPKV7U68N5ODBnc64DGYRlidEloEiUwQ5jYD3kY4iHfT79cZnAefgM1o12cEIxYPKaVoUGbMCiqNEWTPn12YW93s+rt8yOuKGbQQQch1YQH+FQRtl8NBYWGtRHHIThfYQGaM2flFj2pXMFKm6Rnh90OybX1CjEJmAJBOHUKTtTKJzRT9z40TROD/nifssjeqvIKzMsQJdyEQ==; 25:KY81TdjR1fswEwXQWjpMkiY95spSJtKJRfEG8VG/I30dJGmPfJmjg29odhUT4HENq8QYMWr5JqrR18LEAhewo7cS0kGsNokmWOwaAf7bTXE9L+qaLtwrCh4+AQSvVLwpyWcFl8oZn8mTPTKGjbObD9BGatvRzSn/haWgszsJCYKj8JAp0tuDN8YDKSbz+5zcIGaEvd4cJgw7bQKm6DXOxrTAmxMrEYYzM07JhMDqcjFsI+Bio/eekwiGaygpngUSqO8g/Ka6keWplUMHRok6F8dXgx90VAFnB1iM2nJqHhQUv43E+2mk1MlQcClVl9cKh2PP9A6B6Cl8+q7tHjA0ud/JOYzsDzexWj+pHpV3Z05WKITK4/Z9RKziY1MdnyI98n0iT/igKCKzxhu4cpQ5iTfuScAqmNy1SEV5dPjtunhtFj9D/4gZzxQI3VSGaqpKIuKgWDOXGx5x68oXKwms2Q== X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2277; 31:zLvmwnKzGj8rLrh9Q9yXJekLGL45LfPcDqmV5JjqxQqK0RDaRCzKs9JqPtYRxutt8WhyLCPtuKFi7cNHxWUPmNa9ZQcUbXLL+QbEIFpUh9FuyVYRIE4zTEbHhkdM4UPQKIs9uL/boB2RZ7Gp9tGjluIFtwVEVfAPj2YFdAa3+uLvIRsH7Qde9kIDUjlMaiB6iQOEV90Le9hjhlRz8Vv6bM/rglygNax71poxIKVlcLP+qmnKOVVjDrb+D/pmyIeX; 20:+o4i+n7z9U0JeS/9tUtJjh7PrxdoZ1TuUIF+fI2VFMq9SMAnNLQ2DHqCxAy2oOwC/bkskbMemy30UPIkpTsqTbTuybJmDKxXFZFbAllzIabXWCrZ9Q+9/A1yjlSMxc430SIhV4mRDoxKSwoLn46d5VoAaF7DxhD5LhaLxa9PSbUDqHzPGGqA/7J+OGkugsELidVdhf5xxx3QcVmxOUcYs/4qIGPJ5WOicNuFsx2kzd9+ObHNMJmJy5E4YQZjS0YaHjTpYWA/nfBQKVIeE50TwgG61IXkKBHIVcTUwXhpBZAnoPyiH98+CmOFyC+ndrhSNCF4tWcvY2li5ftpgIS7Mi1kzANsGPrqqd7BArpeCWPgMvNWfRN8ksNQKSr4hFE323VCBG0eljtnizsOJ+d6+UQA1U6pbCOtto3OTduJpQuW6xidARJNY/sWt/yflz7Btkcb/sSRWK4h+Fr3Zlxx+dkjzhM+Pv79GX4CVHl94Py1BYGxUkaGM6StNqfvNBDq98+8vYRZoHhTFYKJq6kvVIj2Y1Xa99TN0OYjpd3Eolvke5qPkQryoEkVlXQQlpdDAcZqAeg8SqeMV4S4ethg2ORCC8VNRLP3dUKW9GHDWD4= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(158342451672863); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040375)(601004)(2401047)(5005006)(8121501046)(10201501046)(3002001)(6041248)(20161123558025)(20161123555025)(20161123560025)(20161123564025)(20161123562025)(6072148); SRVR:CY1PR07MB2277; BCL:0; PCL:0; RULEID:; SRVR:CY1PR07MB2277; X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2277; 4:d8m1ln7+E039OmGTFj3plRSSLNXdu24NOCPInorOI8SWAQEyox87p9SwSp3b6B1+0mPjdP3+jI8Ip2G/XdVo347h1ZFnWCLdtRJukyg2UlFfpaNuxvIBP4fM76IwHr5jSzjfLEAP4Wy8PP7HvuJqoVJC2+waagiL+6k3URbCGi6h0FdnWTZFxhor0WNu7laqftYdi4XSsdh9zXOsKehHI/ZntquYzPb8VxXiVx9PkjCYLUyfkD2yO08h77VYhAEi2NhUe5/y/0dJNdCesvjT8RL5MqEQJ7kUiZeZcf+zhKeIXfgjvOHoOTbGld9fDbzdU7HeRQa4rbgnWfdi3ePWjZJFqUB/43V7dDU50tj4s71YqjDS//kv6u2fAMaUrm9OMY9ZQx9N2FwCvDffYuckQyGr0AWYAqCB7tCuLzXsemNo+mdQEMOlSWVwEXNQdPZBig0g2/ZyvzPZIBJF8Lt278CcI8yAHg/b1omirR6sv4Bfba8CVQpcmV/nx/SxuseDnUP5PXGxPHIPaJe1f2BqZq59TR5LWGt/AHnZNLjeIIPszmFRXypilKd+bBCK5AU4RNgz51w555TH1AmLHkInu69Cto0jUAhX33r3iZbQqZx6QbCXHxJjbGQm344tD6pv/y0ooT0a0XUCsXD3OYNOuQ== X-Forefront-PRVS: 023495660C X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6009001)(7916002)(39450400003)(2950100002)(6916009)(42882006)(575784001)(23676002)(5660300001)(92566002)(4720700003)(33646002)(50226002)(2870700001)(6666003)(2906002)(36756003)(8676002)(50466002)(81166006)(53376002)(110136004)(38730400002)(4326008)(305945005)(2361001)(53936002)(2351001)(6306002)(25786008)(6512007)(189998001)(54906002)(47776003)(6506006)(6486002)(66066001)(6116002)(3846002)(50986999)(76176999)(5009440100003)(42186005)(7736002)(7099028)(110426004); DIR:OUT; SFP:1101; SCL:1; SRVR:CY1PR07MB2277; H:lio357.in.caveonetworks.com; FPR:; SPF:None; MLV:nov; PTR:InfoNoRecords; LANG:en; X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtDWTFQUjA3TUIyMjc3OzIzOllRVzc1SUcwZTFLbHdnRURKT1ljemhMZkll?= =?utf-8?B?WHAwMEtVeXd4b280aFRBemVDSVQ3S3Z5enp5NXBMTDhyWWdlbm9JY0pOWXJ4?= =?utf-8?B?ZUdoSTdjOE9uS3EzbTREcnhmcEFLTjFsWU5ObkpUQlErdWFCTGVyT2h4eDhD?= =?utf-8?B?UjJLblEyL2VDQ0lxTXV0YlMxZGx5N3daQUdVSUVSb2h3dXlmUGE3YWtPbnZx?= =?utf-8?B?ek9zd0QxUWFhRkp4NFJkbERpalVPZE9EWVVSRzViL3ZnTmlmMUxlcjRFQ0RR?= =?utf-8?B?SnZBYVlTaUl0b2kyT0s1TkFGbUhnQjhvQUNvUml5R3dxRVlFeDRveDBkOHBj?= =?utf-8?B?S1JOZjlQVXcxTTdpcHBoR2ZLNmVCT1lsT2x4YVZWQ0Yzb2tCbUFEbjg1cUdi?= =?utf-8?B?TXZWV1JvR0Nvc2lhT2xnRS9TcFNvczYyNUFSRlpYQVBMQ0pCWUk2by9UR2pR?= =?utf-8?B?YzQ4WUpjRk1idTN4Qk5EN05oSVNXcjMzd0EyTkFYRHAxbkN4YzYwL1k4cXo3?= =?utf-8?B?SDYrK3lTQkZZS3JMejNVQUZoMG1ZaHJXOW5xM3pGTkNqcUMxYUN6QzJkV0o0?= =?utf-8?B?YmFQb2pZbTVSaUphSlVzRWg5U1RPUG5NZ2Z2QXROK0tsdnVUQWZETFF1NjRQ?= =?utf-8?B?NTBiRllndlhIOTd0WEg2TGpkczV5SmxzdWMvV08vL3hIUGVkdHV2VWE1eDdL?= =?utf-8?B?RTBpdmhSZGRCU1lWYnhzRk0wQlE4RmhtOFpsMkpsYTFUOUdiWmQwMWE5empS?= =?utf-8?B?dktaZVhOTXlDcVVKMVZSQWlpOXgveXg5MkRLa216NnN5TngzczYyWVhVOXBN?= =?utf-8?B?bnhNWTBpT0NDOVRtVW56eE9nTFNtOEN0VUI1d1hxY2VOTEM2NWVaZVR6OUtD?= =?utf-8?B?RDdjMVBueFRkalNHV1hhMDhtVEd0bWNQMUZuS3NQdEhIUmFrRlVVQjV4MDBF?= =?utf-8?B?V25qQlFUSDVvNlVQVnMyMEpyVWs4S1dQRFpFRzZaaDV4bWxwdlJNRC9xM21G?= =?utf-8?B?VkdtT21NY2xMRTcrMW9VU29YRXlRcFF4VlJMTmZ6OFg4MjNVdXpHaElYYWFO?= =?utf-8?B?em5hSytWQjFVWE1nSmZzYWwwV0psanh0OTdBc2pvWWFwZkJ5T3N0Z2JUb1Zr?= =?utf-8?B?QzhuUUpFdTh1VEk4VHNzT2MvTUJNL3FwRmxvNUJmRENCeFI5ZE94MllzUkJp?= =?utf-8?B?Vk9aMDZvYnlqRmorYUZPV3JHbTNoZXBSQmZUdUlXK3RPWm9hTStSVGp2Ukhu?= =?utf-8?B?cld4ZXpxVllzQlg3eGpBTmt3NEZWdUhNS2Jqc3FPNk1McDdpL2dFYkg5MWM3?= =?utf-8?B?cklOT1JnUlpvNWZ3S3lHTlR1NG1xb1o4emZvUktLd1kvSm0xdGMva0UvM2I1?= =?utf-8?B?cklHU2NQQ0lpclZVSkY1cXNGWlpST0tZYVBQWVdjYlMxY2lBQXNyK2lwY0Zp?= =?utf-8?B?YWxCaER6Q2llb25Oa1h5VW16eVhHd2JYZjM2WFJEcWRWaHROWCtFTTJ1M0xJ?= =?utf-8?B?NVJlSUZYN1M3cHVXVllhL3VlZHBtTTV2WXNwdW5vM1lKTHljZEo3M0J3MmNO?= =?utf-8?B?TGlESGFyUlJHaENtbWhsUjErY0ZiWlE9PQ==?= X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2277; 6:oyip3LuFR6slI6KWt1QW2n/MHxZlgCliSH0csCw56wtx5B7/rqrCTArJ38ICrlNTyD5YvZUJMdR2yx/ikqgiJTDaqNS/tqgXce6nj5W+cfRCjA0n6aPte9J7pKMm777P4ujtp7jXFTqu337Mg7xDmefj7p5dsIRG0CkuabJScnjlGknSfEnt1dcbdC0Leh7BK1TxH4ojpOcuk3Ko7TusNB5Jd1N8xbg5brLnjfTxAPevMdywreQ/7Rwq6VjrJ6xiKoeUlI6NLxO0TAxqP+mdbd9lHQhPNLwq0CkfkSBDrkZh+IqRoaonlEUWWWtc9Dkm0VyRnRUtMa9iimsgIeaXl53D5f4sYn2NPYBFyChbOuqJrtYP/TtTPSGVBGMsd+d6W3VMDTjGb2UTKoh4lywLRA==; 5:JbmWCAyBeO0INKEwxzac2xxB0n2qztSPYfraAotLqBtfzAZHQGWOl98WNSONJ8rS/+mP3QKzqfUGsXUlN+NujWqo1jqn/50LwboJFk9mx5l7nlI2DmEaUj96pDEIafYnwORcAWuWBCQ87h3A6z/IIA==; 24:LZ0ju9jivFlY/6ERiM6Jf7il32o6OIbbx/RoX7ak8XaTSa5Bcd+rTmIZvEpvbtFHNvU6GpRI5VzdDiZVEKC32IUHWmsixjkQvuQuqNu+CCc= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2277; 7:JuSWdrb/DOztN16hzZRVaXajEy7NPR3OBelySR9db6T+p/43uyVKDSsSLSDA8SpPKZtQunoFRld7mjiESlik+sOrBj/bRbsULOEcEL3E+G2xHn29qwgSIRcB+58myDWHikC0M5xohgcDfZC5u7GRt4WCnZYd0S2MF5H/IaO0yAMtRrWiN3/RQ152G/Sl3bQksSwmMNDHWnU09Sf35SItQKl6iju1sx3an++c0CnPi48Xzo4PnfF5eZn6rJYIyYv5MiROiVankBwPfZRLrtVgTPzLJkgs87uyzjbcCoGphdzwOIC6iSpcmJ7ZzNuiNYzWCdEeyMCsObUOrREAoCVK+w== X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 02 Mar 2017 11:40:19.0329 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY1PR07MB2277 Subject: [dpdk-dev] [PATCH v2 46/46] doc: add doc for liquidio X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 02 Mar 2017 11:40:24 -0000 Added doc/guides/nics/liquidio.rst and doc/guides/nics/features/liquidio.ini. Updated release notes. Signed-off-by: Shijith Thotton Signed-off-by: Jerin Jacob Signed-off-by: Derek Chickles Signed-off-by: Venkat Koppula Signed-off-by: Srisivasubramanian S Signed-off-by: Mallesham Jatharakonda --- MAINTAINERS | 2 + doc/guides/nics/features/liquidio.ini | 29 ++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/liquidio.rst | 280 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_17_05.rst | 3 + 5 files changed, 315 insertions(+) create mode 100644 doc/guides/nics/features/liquidio.ini create mode 100644 doc/guides/nics/liquidio.rst diff --git a/MAINTAINERS b/MAINTAINERS index 2e16c5d..3529e0a 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -303,6 +303,8 @@ Cavium LiquidIO M: Shijith Thotton M: Srisivasubramanian Srinivasan F: drivers/net/liquidio/ +F: doc/guides/nics/liquidio.rst +F: doc/guides/nics/features/liquidio.ini Chelsio cxgbe M: Rahul Lakkireddy diff --git a/doc/guides/nics/features/liquidio.ini b/doc/guides/nics/features/liquidio.ini new file mode 100644 index 0000000..eac32ba --- /dev/null +++ b/doc/guides/nics/features/liquidio.ini @@ -0,0 +1,29 @@ +; +; Supported features of the 'LiquidIO' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Link status = Y +Link status event = Y +MTU update = Y +Jumbo frame = Y +Scattered Rx = Y +Allmulticast mode = Y +RSS hash = Y +RSS key update = Y +RSS reta update = Y +SR-IOV = Y +VLAN filter = Y +CRC offload = Y +VLAN offload = P +L3 checksum offload = Y +L4 checksum offload = Y +Inner L3 checksum = Y +Inner L4 checksum = Y +Basic stats = Y +Extended stats = Y +Linux UIO = Y +Linux VFIO = Y +x86-64 = Y +Usage doc = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 5248625..37e6416 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -47,6 +47,7 @@ Network Interface Controller Drivers ixgbe intel_vf kni + liquidio mlx4 mlx5 nfp diff --git a/doc/guides/nics/liquidio.rst b/doc/guides/nics/liquidio.rst new file mode 100644 index 0000000..9ffdc35 --- /dev/null +++ b/doc/guides/nics/liquidio.rst @@ -0,0 +1,280 @@ +.. BSD LICENSE + Copyright(c) 2017 Cavium, Inc.. All rights reserved. + 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, Inc. 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(S) 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. + +LiquidIO VF Poll Mode Driver +============================ + +The LiquidIO VF PMD library (librte_pmd_lio) provides poll mode driver support for +Cavium LiquidIO® II server adapter VFs. PF management and VF creation can be +done using kernel driver. + +More information can be found at `Cavium Official Website +`_. + +Supported LiquidIO Adapters +----------------------------- + +- LiquidIO II CN2350 210SV +- LiquidIO II CN2360 210SV + + +Pre-Installation Configuration +------------------------------ + +The following options can be modified in the ``config`` file. +Please note that enabling debugging options may affect system performance. + +- ``CONFIG_RTE_LIBRTE_LIO_PMD`` (default ``y``) + + Toggle compilation of LiquidIO PMD. + +- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_DRIVER`` (default ``n``) + + Toggle display of generic debugging messages. + +- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_INIT`` (default ``n``) + + Toggle display of initialization related messages. + +- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_RX`` (default ``n``) + + Toggle display of receive fast path run-time messages. + +- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_TX`` (default ``n``) + + Toggle display of transmit fast path run-time messages. + +- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_MBOX`` (default ``n``) + + Toggle display of mailbox messages. + +- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_REGS`` (default ``n``) + + Toggle display of register reads and writes. + + +.. _lio_driver-compilation: + +Driver Compilation +------------------ + +To compile LiquidIO PMD for Linux x86_64 gcc target, run the following "make" +command: + +.. code-block:: console + + cd + make install T=x86_64-native-linuxapp-gcc + + +Sample Application Notes +------------------------ + +This section demonstrates how to launch ``testpmd`` with LiquidIO® CN23XX +device managed by ``librte_pmd_lio`` in Linux operating system. + +#. Mount huge pages: + + .. code-block:: console + + mkdir /mnt/huge + mount -t hugetlbfs nodev /mnt/huge + +#. Request huge pages: + + .. code-block:: console + + echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages + +#. Load ``vfio-pci`` driver: + + .. code-block:: console + + modprobe vfio-pci + +#. Bind the LiquidIO VFs to ``vfio-pci`` loaded in previous step: + + Setup VFIO permissions for regular users and then bind to ``vfio-pci``: + + .. code-block:: console + + sudo chmod a+x /dev/vfio + + sudo chmod 0666 /dev/vfio/* + + ./usertools/dpdk-devbind.py --bind vfio-pci 0000:03:00.3 0000:03:08.3 + +#. Start ``testpmd`` with basic parameters: + + .. code-block:: console + + ./build/app/testpmd -c 0xf -n 4 -- -i + + Example output: + + .. code-block:: console + + [...] + EAL: PCI device 0000:03:00.3 on NUMA socket 0 + EAL: probe driver: 177d:9712 net_liovf + EAL: using IOMMU type 1 (Type 1) + PMD: net_liovf[03:00.3]INFO: DEVICE : CN23XX VF + EAL: PCI device 0000:03:08.3 on NUMA socket 0 + EAL: probe driver: 177d:9712 net_liovf + PMD: net_liovf[03:08.3]INFO: DEVICE : CN23XX VF + Interactive-mode selected + USER1: create a new mbuf pool : n=171456, size=2176, socket=0 + Configuring Port 0 (socket 0) + PMD: net_liovf[03:00.3]INFO: Starting port 0 + Port 0: F2:A8:1B:5E:B4:66 + Configuring Port 1 (socket 0) + PMD: net_liovf[03:08.3]INFO: Starting port 1 + Port 1: 32:76:CC:EE:56:D7 + Checking link statuses... + Port 0 Link Up - speed 10000 Mbps - full-duplex + Port 1 Link Up - speed 10000 Mbps - full-duplex + Done + testpmd> + + +SR-IOV: Prerequisites and Sample Application Notes +-------------------------------------------------- + +This section provides instructions to configure SR-IOV with Linux OS. + +#. Verify SR-IOV and ARI capabilities are enabled on the adapter using ``lspci``: + + .. code-block:: console + + lspci -s -vvv + + Example output: + + .. code-block:: console + + [...] + Capabilities: [148 v1] Alternative Routing-ID Interpretation (ARI) + [...] + Capabilities: [178 v1] Single Root I/O Virtualization (SR-IOV) + [...] + Kernel driver in use: LiquidIO + +#. Load the kernel module: + + .. code-block:: console + + modprobe liquidio + +#. Bring up the PF ports: + + .. code-block:: console + + ifconfig p4p1 up + ifconfig p4p2 up + +#. Change PF MTU if required: + + .. code-block:: console + + ifconfig p4p1 mtu 9000 + ifconfig p4p2 mtu 9000 + +#. Create VF device(s): + + Echo number of VFs to be created into ``"sriov_numvfs"`` sysfs entry + of the parent PF. + + .. code-block:: console + + echo 1 > /sys/bus/pci/devices/0000:03:00.0/sriov_numvfs + echo 1 > /sys/bus/pci/devices/0000:03:00.1/sriov_numvfs + + +#. Assign VF MAC address: + + Assign MAC address to the VF using iproute2 utility. The syntax is:: + + ip link set vf mac + + Example output: + + .. code-block:: console + + ip link set p4p1 vf 0 mac F2:A8:1B:5E:B4:66 + + +#. Assign VF(s) to VM. + + The VF devices may be passed through to the guest VM using qemu or + virt-manager or virsh etc. + + Example qemu guest launch command: + + .. code-block:: console + + ./qemu-system-x86_64 -name lio-vm -machine accel=kvm \ + -cpu host -m 4096 -smp 4 \ + -drive file=,if=none,id=disk1,format= \ + -device virtio-blk-pci,scsi=off,drive=disk1,id=virtio-disk1,bootindex=1 \ + -device vfio-pci,host=03:00.3 -device vfio-pci,host=03:08.3 + + +#. Running testpmd + + Refer :ref:`notes above ` + to compile and run ``testpmd`` application. + Use ``igb_uio`` instead of ``vfio-pci`` in VM. + + +Limitations +----------- + +VF MTU +~~~~~~ + +VF MTU is limited by PF MTU. Raise PF value before configuring VF for larger packet size. + +VLAN offload +~~~~~~~~~~~~ + +Tx VLAN insertion is not supported and consequently VLAN offload feature is +marked partial. + +Ring size +~~~~~~~~~ + +Number of descriptors for Rx/Tx ring should be in the range 128 to 512. + +CRC striping +~~~~~~~~~~~~ + +LiquidIO adapters strip ethernet FCS of every packet coming to 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``. diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst index e25ea9f..7ba6e10 100644 --- a/doc/guides/rel_notes/release_17_05.rst +++ b/doc/guides/rel_notes/release_17_05.rst @@ -41,6 +41,9 @@ New Features Also, make sure to start the actual text at the margin. ========================================================= +* **Added LiquidIO network PMD.** + + Added poll mode driver support for Cavium LiquidIO II server adapter VFs. Resolved Issues --------------- -- 1.8.3.1