From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM01-SN1-obe.outbound.protection.outlook.com (mail-sn1nam01on0061.outbound.protection.outlook.com [104.47.32.61]) by dpdk.org (Postfix) with ESMTP id BCCE6FA74 for ; Tue, 21 Feb 2017 10:30:41 +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=dMNlF4+ZG+1yVC+FZ+6Dk8k5g56GiuP+XbIWdgHqYUM=; b=GvKBzqjWObUCGbxpaPHEnI2g+a7jf/wqehlzgNFZWLFHKzKk161fdHFAum3TQWgV/fVqf/XzxgqaeHShfBvglFK0mNqaCLasifpar05fYMvgEmhoilXwb052GCd1abYxaGa2ClYX7vkJ8NkA/zKjeYEi45wqXIKpKEmAR3Fs5VY= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Shijith.Thotton@cavium.com; Received: from lio357.in.caveonetworks.com (14.140.2.178) by SN1PR07MB2285.namprd07.prod.outlook.com (10.164.47.155) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.919.13; Tue, 21 Feb 2017 09:30:38 +0000 From: Shijith Thotton To: dev@dpdk.org Cc: Jerin Jacob , Derek Chickles Date: Tue, 21 Feb 2017 14:57:05 +0530 Message-Id: <1487669225-30091-51-git-send-email-shijith.thotton@caviumnetworks.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1487669225-30091-1-git-send-email-shijith.thotton@caviumnetworks.com> References: <1487669225-30091-1-git-send-email-shijith.thotton@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain; charset=y Content-Transfer-Encoding: 8bit X-Originating-IP: [14.140.2.178] X-ClientProxiedBy: MA1PR01CA0089.INDPRD01.PROD.OUTLOOK.COM (10.174.56.29) To SN1PR07MB2285.namprd07.prod.outlook.com (10.164.47.155) X-MS-Office365-Filtering-Correlation-Id: d4bb034c-f8cb-4aa3-cb2a-08d45a3c4cf1 X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:(22001);SRVR:SN1PR07MB2285; X-Microsoft-Exchange-Diagnostics: 1; SN1PR07MB2285; 3:cCWfI0KXoiLU2E/a/ofAi3e3su9f5jOuhyOpY39svW3VTjF0AazCrj/4sOgWXxOcH0Et8RDqvyhWpk6hcweiJIS4GdigeTURP3T1PhQ1y1uCRIrZOQWXzbMlUpyU8y2FXfd1vjqnUPdXfwPDVqv3hEnm0iPpXeQsAF9mLdA+ALPlNkhDu9M83TkecynXcBqb6CT9mJpj/zWx/5e1PrHfFfgLRPRsd2UzCxBtM6ehhUHP62HBtrDxso/BTHD5WltmbWlC/dHwjOvbZG9zrkUseg==; 25:mzFZMsGDIXjF7jiyPwIxDJkx0ZGs9HyPL3dLx21oe4rJp0DBMzKV0yKvvbLe5P6udBFHYWyB1qyRhBOpI3ztZsvMXC2bDbhxLKXYFG2zN+JKH/F8z4NglWDPUeAmMT5+4I59WbrmuhrthJCVO5NwDbGbXlOl7lJGYRssxbMcvPddZ3URnIT/PLs5f4JqHcEhIkLm+2nGOsBdLp2Kfx3Ol8QCRTmRPRlir+qrpB9VfaAZkQTN6Gcm8scYrI9XtQEM3O14c/R6TwFfkdpiJWcTlV8lrZt3qmG63FuHWe9d60tCjUJCdbKg3OiIdqRMz01uS9t0mTUs7HoTr5eyodTJq/DOZkQJzCv1Fxi7L2s51VYVNC10ietWBoHMK6YH1qm5KRTMmMR6WrP10JxALtRnluUr0jDVAe4k0zqHJ/lvhOCSkY3Gj2RLSen9RxIIW3A1jQd+aH315XXokCxjseedkg== X-Microsoft-Exchange-Diagnostics: 1; SN1PR07MB2285; 31:ANmiBqTprcxK7xdyGuYxPbJ+40nmcVr32SUJlL5EcbCVpkM6tlflKe83G/73F5Md4hmKDTXgS63yYFTYp/lKP020uc8ImbnXhFaae0H9kkdk97fF/zzPdm11X/pZRB2C5u2uKNfcyrbRo3pqdH4EpuyDRj5MhuNInDU71Zv65o9726qVAaA6SVJPGIIQd3C38gQDDWlPKfGszPjd0UbZjuQLdZySPT6FunEvqbmgf/k=; 20:UtHTTsNcieRUcCFOt89jXcJ+68nsWJLGLmcXHdRrs922nBGwhT6svAs+7iFRIyV9t9DyQVuwsEUXeKX26Yry86k4fpvxgwGIp+CJw5MMKK+Tw7CutbllV19lyl+it/B4xLjVhtT9V/OX7LBb/BnJp5RvySQ8/gmbbqX76PS4ud5kJadYrPH5snHpiuX3mQH6izjv0ku7hdV+116rnb18etb3OWrSQsX31cWVEQJWL3MiJAn/kbfZOZ9eZxjAg0cKv8Jt+C5UVvI6Bmt6uSF+FDPlMxoGVzBrbyIqUw0eMCV4kDgGACYl/uDQ8Tn+MSbPuJLR+bEsQJTYifaZX+uDTzvEtXlYfEwvQkdUH8z6vIoQyPXACZhshZuURBQBZO/4IPmfkTDbDdndNDeCZZa9TGZv+zXXytYaXtot6MPltoegXIeKCZn5WRdmnBQmNZcJ1W6ybb1mTj0c3MXLjJsgkIAkYA/Fp1Em3Xx+88E8d6mnNSaRq1g4Erb9xBeZr1kxlKQv5avPUlADjxs6f2/V/xHvvrzTAWK7JEETLGJvGqgDDUz4FHzaMm6f1fMzoeq3OhgKVw8nZOdH9yTr3+mWeKOeljxOL5xLgy1wfAAdhS8= 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)(3002001)(10201501046)(6041248)(20161123555025)(20161123564025)(20161123562025)(20161123560025)(20161123558025)(6072148); SRVR:SN1PR07MB2285; BCL:0; PCL:0; RULEID:; SRVR:SN1PR07MB2285; X-Microsoft-Exchange-Diagnostics: 1; SN1PR07MB2285; 4:HK1J7+7tKiGsMklp4oU3DpAKEp0ueY/qRsvaBdNALi26tuqeJjgwS8f4yx0ZWuefwkWvr25iZAD7StwFzqzEGe+FqDGGstkjW1dWmMkwG0gB1Te2SJ0/8j8ThcNRbJAF8Qyo7kv9v/cL0lTwjvhazaRz0l4ge18jFCU/gCb5qTfSHHedhm7icR/9Q6rrIvUFgZ/xiw0Ctk8W6DBeqnEJonVSK1sJnqWg4yOlz/7elrfWkElfxEQKhTsE0L1UgI//ekb8zgrwekFVvfo7cjJKVzWRyTrsopjEEsVIj3Kxsaj1oBfZr/PMOX92ibHb7Z1XDdw5hfSap2m0gtO6XhVrcOvpyj4xLdYmx8zeXHgsR7idKkvpUtPj4w5NMrkdEh5MSSITVhpKuamox5Sx+4NsqSizYyyfMzL02xtZQ5rVl3aS7vpauRLp7gSWU1Iknv4y3pO/c5cwzs36Gn53y42ewP5sKtHkHqDPtTV9VhxKrAq2DaG/TMyHojoBl3XeCViKvOYdLp9iJhzd3z7zPds00adWAagZZA4b4YHLYyjAiNK/4JDlR6y9+O3jjLOw7Sv5lrOThui49Cd0MuTJP1+nQ5XaFuPZtyVT+x3GwVPbukMb7liApgvRX9d5s/rrrpPP6y2jQSw3B1NyIaajn6qz4Q== X-Forefront-PRVS: 0225B0D5BC X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6009001)(7916002)(39450400003)(39410400002)(39830400002)(189002)(199003)(50226002)(81166006)(42186005)(2361001)(101416001)(81156014)(305945005)(3846002)(6116002)(5009440100003)(8676002)(2870700001)(105586002)(7736002)(53936002)(36756003)(110136004)(106356001)(450100001)(107886003)(6506006)(25786008)(38730400002)(2351001)(92566002)(6486002)(97736004)(50466002)(189998001)(68736007)(2906002)(4326007)(33646002)(76176999)(54906002)(5660300001)(6666003)(6916009)(50986999)(2950100002)(6512007)(4720700003)(42882006)(66066001)(47776003)(7099028)(110426004); DIR:OUT; SFP:1101; SCL:1; SRVR:SN1PR07MB2285; H:lio357.in.caveonetworks.com; FPR:; SPF:None; PTR:InfoNoRecords; MX:1; A:1; LANG:en; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; SN1PR07MB2285; 23:RgMmGa/dAinbIohhoOIMmqOTYViRB6yfCrfiYSh1B?= =?us-ascii?Q?f9jgwRd0boKykdqldJA+1XyjXMbnZxCfU5iSdj6/Lnze5bSkdcXpQwQ21xBT?= =?us-ascii?Q?97JHEtthLtpNoXWHDEcV+IkDkzNIzz5KvoPf2Vc+T3WqnZNu4KC1kzuPOPdr?= =?us-ascii?Q?VPn3VO+LXxktRvyLZpTiB1QosoBd5XXOigohBNEMh0N90J5z1f5GI9ABAcA2?= =?us-ascii?Q?F1OlEilXgBOVqFtJtIsVZy8yFC3gQGrtR0YqJiNedoJF4Jd6Cs5ECuph6IE1?= =?us-ascii?Q?wKeKRjxTmHdhbLY54Sh3gNw+TY476pGyeI+1A2ceQoglI3Q3StO/RlnmJ56B?= =?us-ascii?Q?g/HlBCFJwa567yji8hoKBQTjFNVN/qM44nXO2kJxvR0DGlo28bdbnKpLC6I7?= =?us-ascii?Q?BkMOEuamk7S7eF50o93zg6fDVvckMlGuipm5RD5vBAHxJCc8RI+bLUZfjjtX?= =?us-ascii?Q?+yePuMQ/JzuNcw/7CcA0Imc9ipeovp1VjI5ccIfiqC2QsZpWMt8UjF/z2g4e?= =?us-ascii?Q?8+IO9SqIVQeLZsyZMf0gTX8K0Jk/cePSiWlMvX/sOES1QLAVbfXwTlVWBByQ?= =?us-ascii?Q?ZAsKYi2iDf7McgQvD5dD/ecy8fvdVmXwNY8iNT82j6wBzH95U44pTpLZ7I/E?= =?us-ascii?Q?MMpz8zm3z19d2e540M5RLet8SGc+6U9CC04ktS8GN4TYSaGN14ndwxkk4CfL?= =?us-ascii?Q?HZf2EEAnO0UfgqXLJ5ouoau9EvFZ1znxjlXCyugBXfBrjV28HSlci+rN8oY2?= =?us-ascii?Q?QwgObi2yJfacuwYNELwCGwBZwEqIm9DZCbQ2dvWuzIigUPhC0LzDSW+QtoSc?= =?us-ascii?Q?UJO5tBaNMkjqIW7UHQCXKiT69SqpdyPPQazRlw63Zxliq7OEnAAPxMUoSTNA?= =?us-ascii?Q?hLTjODZpCvGCfN5foHID4UDoA+nSl1paFEV5MMepDWlF6BbBGbb6wmo1OGA9?= =?us-ascii?Q?XKs0eLAPtUJoYUq3oZB1T3wNnLs7gFYLrzMof1wLtigPuscgLhVzACUYgxDu?= =?us-ascii?Q?R5uxrmFFmelj4ZZtqnhwpDLeP/2gI+H0q1GbMIQNB8uCKR8Bx8cdQeWYo7aA?= =?us-ascii?Q?v2BKh6w2gDVytq0NyeUoW32ylF+twwH34hPxwKt4QKK4PRMGdy2Pd9sSjMQ3?= =?us-ascii?Q?tK0I6+ImdN55xjoHPQK4whENEKPEJ5MBREHXOdnkliG8E5juPnd0PUIM4p3N?= =?us-ascii?Q?qpiX4N9RVj/jfb5DIm65PbAzQCpHwllWUaDN2EICdboT6dXgwSUdPcifNZQ4?= =?us-ascii?Q?vEsB8lZcoO6R5wK5u4aM60FVHK8b5ndSht3muJ20IgFAvtuuADZ/Ktgda9mh?= =?us-ascii?Q?+cGI3GjTlOYmQk6/yOoMS0F2vOJcTT4Vf5kG+ea8pFP?= X-Microsoft-Exchange-Diagnostics: 1; SN1PR07MB2285; 6:Xgy0v4DuVjNqjFPQ44/g+zutprEisBPLf9XqJeez2Mb1JRAAAbT+53LODtpawa8t5mz9Unie/H/E9n9bVd5fLQPNLOz+7c67Uaelkb2dRwUMwrX7sZTSRbkQ6bUd3B8D6c61M8MP/VYXSE17FzTH/i9/WLPOquMmbPcosNCrnJqufszCj6frMHVH/w1WPezx3skojJVbcMUHJaRKlVn4YQdIGuRFndsULz1n0S9yvyfrgPVn/i0Sy1qQwcrYFYHjHEkjE4NOL4OMdH/3slbeAjmcbZAy2M27wHFyc5/s5rcDMXfK/yuFm9qZN8Vz7+dYbhJMP+pMklTV0xbktnYX0tvmCCvCD/tKIu/3oK5s1AuCQYZJrIjedgEEZ/Cinn39e9cRsGWPSWrK6CrMA1KsZw==; 5:xnt+SgIvxIXfljG50wEKiCc1D3AEwbLU16ZBIrS6DEgVtGXTMRIp3D9qYQOYbXJBIo4YfZcH/t/YHqSmQ2C5feJxtrWhRuSP8bTvzVFnfh4RgNAqTWVigLCccnacpFyN/8T6eM5kOKrgMjdLInKAxQ==; 24:DqvT/OXcH5hYYjIG6M4fBkmRHCB28wF5DW2OIVhAOUFnGtWlvfrsruVjIwRJrfeU/hsorO4nZpcWSOSauTY/Fw7lZDRpdsUg0gyI3u0pGP4= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; SN1PR07MB2285; 7:pJUSfHsJRwUP3qbdCma4Okb9wXgrn5sciTQqq4Y9lOhrtCU0TYKEgGn4ctEgHcx4aF7vMrnpDum5M5saWZunbQewRU9jub0YQBaYxJZQS7etALvwVZDF4rWFC3FOMw0ZPwGt20J3I82UJPEjuoOYDZKkFfK8CySg19dNixjsK4CC2gkPRI/VwiQL2FPAoqx+0Z4fA+64M7oAMgr2pMxitwGVg3L/945OFYi97SjPUywxYa7CSS/EVj6hAGE4qpdoIS0nztK/Phcxz6BA1Wjyoq5xmN178u4hHPNrITtoMyy4sZrMRNLVQoukAHs/10YbI12lSAG+BO4DkCO2lTNOeQ== X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Feb 2017 09:30:38.0752 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN1PR07MB2285 Subject: [dpdk-dev] [PATCH 50/50] doc: added documents 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: Tue, 21 Feb 2017 09:30:42 -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 --- doc/guides/nics/features/liquidio.ini | 29 ++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/liquidio.rst | 269 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_17_05.rst | 3 + 4 files changed, 302 insertions(+) create mode 100644 doc/guides/nics/features/liquidio.ini create mode 100644 doc/guides/nics/liquidio.rst 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..4bf586b --- /dev/null +++ b/doc/guides/nics/liquidio.rst @@ -0,0 +1,269 @@ +.. 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. + +Supported LiquidIO Adapters +----------------------------- + +- LiquidIO II CN2350 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® CN23X0 +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. diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst index 48fb5bd..23a4bfe 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