From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on0073.outbound.protection.outlook.com [104.47.36.73]) by dpdk.org (Postfix) with ESMTP id 74258FA51 for ; Sat, 25 Mar 2017 07:29:18 +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=GBDXX51BrZSffyQ3pR4jb7wtUGcO8y2k3PI98nrOFHg=; b=SXo7qu+Mq+80qVoXZrN1I3vskZGtHvkoek7b34h+tNthiCkuSbmBlVu72mEL2yQc6kiMWq1sUvuPMAvk7ACclkx5KJxqGo+fcPL8OLxT3Cm3lWn53TKMo3EU29Jh6LGqeLvBQIlPaIeiGltNg9Vm4N5ck4ERbhOfwH6AZuMLdT8= 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 CY1PR07MB2280.namprd07.prod.outlook.com (10.164.112.158) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.977.11; Sat, 25 Mar 2017 06:29:13 +0000 From: Shijith Thotton To: Ferruh Yigit Cc: dev@dpdk.org, Jerin Jacob , Derek Chickles , Venkat Koppula , Srisivasubramanian S , Mallesham Jatharakonda Date: Sat, 25 Mar 2017 11:54:57 +0530 Message-Id: <1490423097-6797-47-git-send-email-shijith.thotton@caviumnetworks.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1490423097-6797-1-git-send-email-shijith.thotton@caviumnetworks.com> References: <1488454371-3342-1-git-send-email-shijith.thotton@caviumnetworks.com> <1490423097-6797-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: BM1PR01CA0117.INDPRD01.PROD.OUTLOOK.COM (10.174.208.33) To CY1PR07MB2280.namprd07.prod.outlook.com (10.164.112.158) X-MS-Office365-Filtering-Correlation-Id: b6fb258b-0e3b-4094-f911-08d47348425d X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:(22001);SRVR:CY1PR07MB2280; X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 3:LnC2eK40M7iiMmeWMcqkM3SOGxAjP7kBO1Nya/9v0U4oIZk5mb83ecE5Ar6lqIoDetfYkGgmbVGYfiiOqdupSny+d2ilGWYR6L7bWru7RCzRJgCsOADa3zJHfhSHlgz+Jsn1Vb9ryU3A46EJg3RnXsxaKVfFN0YvkxhjAIfV6qNgoY1LJFPDZ9dmhwuDkQfSvZuFdtTHCplUkBmSaMq1i++y/M1RB3RN1Eu9AZETAPA8oV3FlWhOMO6XPxhmk5Auk47duuUoz9cASKAkpywURg==; 25:eUjhH+0baNewWva8akCZ5pm276lpayw11Fzb5QQ3MfNhWC1wTxIXmJPvteFUuWL65z63R04AkBuCqot77wuhEhKdNpzf/LG1/Qb3s1G7oQprcoQQCaHtdMSCwr8kkbXanjePNzG7HY2FPguonnmGv0CFAjtDUpitl4L4F4pGA4A0WxxW5GqloLjmDxE+/fWoI8lF8BMBMmDkGKDosB5XcX1F3gogGHZNxib/zbAwIZ5lmQC0rzRJlhvPTMJYy92XV+ARMCGD71t6egk/4dMRJu/83Lhi2hyrguVLjA07vzNEq7VVyKmfJVRhokP6NXKYcV++5PnfRqifIXXqJ/iDzxMoaA9Fhmh27Ieby+xq26Dwq8VuKa+yvqrJwCCNfvI8jjHnz/GDjGgUb1hdgbEp1WnhZfs/N3zoYm38vEJNn9tp9EIzpRKDN2RO8Rrp7oU+Lc0jKH4Ibi8W6bAxk2ymww== X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 31:r8ef5Jbk+lYvE7wqQucRXkhlBYKte++2qTI5rq9Xz+WNR2qX6O90DswmSGdr1vmTNEoo3BWPmR7ZOloB4x26YCYrysl76qBpg40ySNqvzr3XTZo6nhzQLqBjEgbokzbu/+nilQHCS6YT6O2m1g/EumRmZpGPQqHtn0K4zBKyOBW9VlCNBYV5GOdrxNl+imBqPPwYJXjTvN0iTzqYN25J+LUEQ228P5wbrhSOuQrpUEZV6fJYzzWLzpSSsXK4sdex; 20:5jL+fhT4U2g4v5bmUJajw/0QSiXOb/3R932QrGryurKYb2uEly2PaBx6wi0kP+zxc5RnG2hoBEISFLkPZfdlwR1bDDgl3s1YGBORkRLd9Q36n5UEpyR4zsfyIFaM9i8DpOQ+5ZtJLnMNDQEAyYLeDB4EcvSVPSBcTCxPPHhcOiNELaST3eCabRGrb6IYzKdq2+f8PQyozAlGdvmqETpTWYPA10Osbn6W1pxFWJxosVIBRPUDl6JIfl5GibO9oHc/HbjDDWe7M4knepKAlpyLKGvGcnhZIxu/vHBPohXGz3h4cG8NOZFAb7xfo89anZXhHe0Ve7st1X9lHWXwlkOfIgNwNPG+fXz6BiWawmwd1DC33DY1HuL+lqqOYPjlJ6C8hNYIOvQkYfdUJY624+j/NDU8dF+6iazXuIAsL+ymgiQg64rhbYMNwkttGQS60e73vBdODvChVCUhvy3zBahvhKawahIurF2chL0HSAsRI5DIKNowxyO0L3ETgZkQsg5kZyY0XsziwPyvrbtm6vQZraKlBWECo7LnHgiBxQKBmyV0nmH6wEvANbZoEE6inxZC/vI9ZwCE40xUlm2kRb80fQmFKVGQQt69cfTNtwgAGFo= 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)(8121501046)(5005006)(3002001)(10201501046)(6041248)(20161123564025)(20161123560025)(20161123562025)(20161123558025)(20161123555025)(6072148); SRVR:CY1PR07MB2280; BCL:0; PCL:0; RULEID:; SRVR:CY1PR07MB2280; X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 4:CeNbZlF49MU9dRSXqrYhTfSIVPqpLzetpsp6b74FWXjVSPyFmx2LpGgxj5+ox6D75Dchj3vnI9QAypYR7YvZv6lHszGyFzMr8pRWAUAy/QPVQdEBmIDhPVWpu9Ju5PrOXxu+s8LN+BRuU+uWQSMs4vhPn9QdGlaLPU8UiPUSAVi0IAuMPOuW2djzo86rrg9lelggJt5ncNYmb1wUUkx829Orc+f7mkpCzsP7wEZDZYq+OAAHdWawo2g0YmRzIJd9fSECSjkYmTyXEIXHv7DtzZb7rOXdW9lTdHymlXODERNYakP9z2C9RD2vNoOTs6Y4Vyn6bZvzoD5fTq43uhIFX+aemMB2OcbrWCYaSXdHZfpA4X64LXXopjtf72EUr1LU/9O1wbJ1nvdbNrHfIpgTfpxGp+e1Q72Dex0GjbDKCPA/es49aC7fpTWk1x5dU5CqoMrxkLsCQFFHFQj6VWqYzPy2ocd6n7Gs0U0uZNsoHLlsARYJtAKeUWVIHhGVvJRS6U60UkwX1ZD/ScW/GJU8g6CYWgOYiuGrVC3OOQcqSn08n9IYiOGE6SRtiudoYEuDoXZyC1H4VGVKf4r6qH/oG9KeNSHaNOe/2s0IbnbVaYBuuEsC8Y1h6TrDBp+znYQ60WwCiL62fC09Uua5OYRFIQ== X-Forefront-PRVS: 025796F161 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6009001)(39450400003)(39410400002)(39830400002)(2906002)(2950100002)(10710500007)(66066001)(42882006)(6916009)(50466002)(15650500001)(47776003)(42186005)(6306002)(2870700001)(53936002)(6512007)(68736007)(5009440100003)(54906002)(53376002)(50226002)(38730400002)(6486002)(6666003)(25786009)(305945005)(81166006)(7736002)(6116002)(3846002)(4326008)(23676002)(7110500001)(8676002)(6506006)(2420400007)(189998001)(36756003)(50986999)(76176999)(33646002)(4720700003)(5660300001)(110136004)(110426004); DIR:OUT; SFP:1101; SCL:1; SRVR:CY1PR07MB2280; H:lio357.in.caveonetworks.com; FPR:; SPF:None; MLV:nov; PTR:InfoNoRecords; LANG:en; X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtDWTFQUjA3TUIyMjgwOzIzOlZFS3E4eHV2azRQUjluaGJEU0VsMmtkaUd1?= =?utf-8?B?aFo2Kzd0WVB6NzBtMjJhS2E0djROUFg3aksxSktocGcyK01rWTBFYWRUSmc1?= =?utf-8?B?WkdhSXlmeldDWnB0TjQ0cjVLV0d6SXVZZitreDE4KzRjWCszWUZPTlQrQzNK?= =?utf-8?B?SmQ4eVJmcE1vcmdTelRCSlVxa0hPVTBJQkwwSDIzUzMyT3pybm1sSUNGL204?= =?utf-8?B?NEsrWXVWaFVhVzgxVmtDamo4VCtXdnozc0piL3VaUWswdGNGZU81SlpFMFV0?= =?utf-8?B?dlErTlhOMTFtY01vNmxJVWpiUDJMMWhZZCtjMmRqMWdLZXllWjF4a01TRUVQ?= =?utf-8?B?RFpvQVRweHk1RGlVYVZwc2FLRDVQR01yWllXMURiMWdOV2pxYWhXYXViZEd0?= =?utf-8?B?MVF1Y2dZcFRaM3k3NDE5ODNFallGcVhMcER5NWZWV0VPWnNiR20wOUdnWnQ3?= =?utf-8?B?c2YvL1cyYjdEZ2YyQnFBVnNDbjR4eGw0Si9QdXBMNFRCYU5KQUd0d1ZwU2pi?= =?utf-8?B?cXkwMjZZLzNyYi9zQ2QydmVVSURndXovRTVDc0VQMWZ4WW9IdGRMTTdKZENk?= =?utf-8?B?eFg3TjVDV09sbS9FQ3RGWlZtSFp3SHdNeTRSRUs2MlZNcHB2WG5ieVRpeis3?= =?utf-8?B?cHZZWkowNnNkd3oweWdOb2xHRTBoSDZDWi9nVDBxSGRzalRBdUdxZkJIQ0NF?= =?utf-8?B?WVNmcTFvbXRTV1dMMVdySStWWVZxSGUrMVFUTGg0NERYdUFMNW12N01iNkc2?= =?utf-8?B?d2ZJNldhM2xFYUlrQURKTFlXQVA5bVRlMnRmeDdETlNEa2UyVUF1T29heGtV?= =?utf-8?B?QTV3dVYyR2REcTc4Wm9RWTdlRGMzcWkrZEJoZkR3Y3JUWkZSQXpya3BJVmRI?= =?utf-8?B?T2lwL2c2cGZBdEh0MUZ1SUdUZHhubDQ5bG9MMTdiNFpoMTdjMmFtcnJ4cDh5?= =?utf-8?B?SHQ0ZnM1dlJOUlNBRk9RMHlBb045Zkt3L1ZJSlpEUTZWYytGUDQvTDlYTnEx?= =?utf-8?B?Vm5SdzlUbTBQMjJQOVk4d3lhWWZNWENjRVljRHNoVjU4WXVKOEM0ZWVsVktW?= =?utf-8?B?QllOM1RNZWdlYzV3ZnFIblV2QndJY0ZzRzlLN3Frc2Y1T1M2TnJ3Y05BZElE?= =?utf-8?B?ZVdHaUVIbnpQZmJuc2RVaFU3Vm55UlIvOElJRWFjVkFuUzJCZnRsOGhKYWlr?= =?utf-8?B?WTN6bzlESWtURDkwYzdTbDFLK3RwbVhzckg2MURZU1M4b0dmUE1CZnViSFoy?= =?utf-8?B?dXlMSDVrU3BERE9LSm82dWhrbW5tcWlOeXdKV05WQ09kNGtyUllRRU9BZUFw?= =?utf-8?B?bHBzRExoUkRPdmdyam5DQWFJZzMza0wrejBlb3B3WGJqcEg0cWxJcVRZVVIv?= =?utf-8?B?VWdLZHMvNkova2VTNFBVanhpTm9qYTB2Y0JyTDlxTHVsaUhPeFRWcy9XRWtz?= =?utf-8?B?ajhWd3V1SWJSRDNNOFBJRXdXZzMrbC9WNVdzZmliNDRXdzhEcjRRNTFsWk1U?= =?utf-8?B?OFlkNldndnNuT0tobmlkbXh2dit0dUVya25zN29tZ2E4eVVueXFtMjFpUXFk?= =?utf-8?B?STRLK3AwbkQwbURHNjZabDB6QzlOZCtwc2NiZ2dRck10SXJOem94czZCOGFt?= =?utf-8?Q?QPLvHsSuITXmcRrljvym?= X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 6:aGfTESnsjg/USS1RkWFIHALfFYWJit+cIV+cYfet9qF6Y+Wpis7Hsm8mTER5t3iB/2TzNX7euD4wdvMDP+lxzs2ni6xh6SgHgiFjTfvgRSVBg9B1BJqZ6u9oyI5tvjI8pd52d6foLKxcmCwww3m6n2gPqvayyJXETbEiweA1jpq+yYi/X4s0ug1oMpfWLNgT2N4vYWXlCVfebk8UPpC3db9OvG0VuzawSs/MQUAZbX943bT+nB9LKSWh/brBLpTu0cEyPUpfHLuz8SejHwHZycyPM7JgezxAIUOPvEauzfnNHOxB+4lk6vKtUsPpGH+eZpndp8xCqLcv/kQ4pgSHe/lYfhG50BfWImqUPoY+xtrny6IBdNHKraLOwJh4jMyDTjel19HqtCiONH31vt/IgA==; 5:uR9o2O6ezehJf2EkwDItg44s++L+x63tQ/BdxCtWe31Mlg/1RRg+fLVFr3Rz2F69KfplxA6JjQAUbBhfJ/DCbKyzeAbgXvYDeXmvtoNmW5OXSpkA3jY5/W/weM6HjXHZ/0MorBqAxpzJJfX+xuIecw==; 24:yLdaCTZKt2FL16eFLHURy80DvDJMMrJ4J47dQnYPvrElIKAnaNn2PC0r2tBlWhOPggg8EJngmDj7QhpANundhXIzMpvcL8mpW4LC3C2YD6w= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 7:SyONL0EYXy2DgLG+sM1EfyuI7YElTTO9uez0DQQaNb4vjoymqlKXvJ+4m6hKgvYw9sBfs6ljMUdAL9lXmFInwz7YGjTZlPrMKerhNSIQYWO5FCvEyCOTo0qv0CCeOoOnrz9c+y9SS1R7daku9GQENV7+xDsQU0ib38MoVpOVLqpBC4tJbAbNk+03f8XUhQEMPGBdEZF+RGg+35AP5wb56/sI+PieghrL+MufI7mQEJTLdGdRfFf7pZ/S3/mrP7oo7bO09nhv4FB6hqfov9V23CX68EKjrVQq+iwPgTsWN+Jyg8lHOMjB27tEHU0Qdu51IDBIKb8Sg2wDH87i8xwAWg== X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Mar 2017 06:29:13.0607 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY1PR07MB2280 Subject: [dpdk-dev] [PATCH v3 46/46] doc: add doc for liquidio and update release notes 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: Sat, 25 Mar 2017 06:29:19 -0000 Add liquidio driver documentation and update 17.05 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 | 1 + doc/guides/nics/features/liquidio.ini | 1 + doc/guides/nics/index.rst | 1 + doc/guides/nics/liquidio.rst | 280 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_17_05.rst | 4 + 5 files changed, 287 insertions(+) create mode 100644 doc/guides/nics/liquidio.rst diff --git a/MAINTAINERS b/MAINTAINERS index 1421c85..e245d33 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -295,6 +295,7 @@ 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 diff --git a/doc/guides/nics/features/liquidio.ini b/doc/guides/nics/features/liquidio.ini index 6230033..49cc356 100644 --- a/doc/guides/nics/features/liquidio.ini +++ b/doc/guides/nics/features/liquidio.ini @@ -25,3 +25,4 @@ Multiprocess aware = 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 5139ca6..819fd35 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -48,6 +48,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 dee6391..9cee6a3 100644 --- a/doc/guides/rel_notes/release_17_05.rst +++ b/doc/guides/rel_notes/release_17_05.rst @@ -96,6 +96,10 @@ New Features performance enhancements viz. configurable TX data ring, Receive Data Ring, ability to register memory regions. +* **Added LiquidIO network PMD.** + + Added poll mode driver support for Cavium LiquidIO II server adapter VFs. + Resolved Issues --------------- -- 1.8.3.1