From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-bn3nam01on0084.outbound.protection.outlook.com [104.47.33.84]) by dpdk.org (Postfix) with ESMTP id 51151FB5F for ; Fri, 3 Mar 2017 18:31:36 +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=g6ihR9csCwq2bTFmR14GnOjDmoc6e3L87t2O8Ax4SlY=; b=J1xlNOgEvwdsE8v1zVofVyhVNB5gCoIqjdJ2LwanYbvT4O7tn1N6WxFFBu30VqOPpJumJ1O3UML4tpiPUojGy8UAufKEJCfw0aBqAyQgRLWgsYVbj1pe/ywABmXG/FLmS7R+nBaKuEqyA8ohZFjc1FWEBUVJkzlirRjU6MDcuOE= 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 (14.140.2.178) by BN3PR0701MB1719.namprd07.prod.outlook.com (10.163.39.18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.933.12; Fri, 3 Mar 2017 17:31:31 +0000 From: Jerin Jacob To: dev@dpdk.org Cc: thomas.monjalon@6wind.com, bruce.richardson@intel.com, harry.van.haaren@intel.com, hemant.agrawal@nxp.com, gage.eads@intel.com, nipun.gupta@nxp.com, santosh.shukla@caviumnetworks.com, Jerin Jacob Date: Fri, 3 Mar 2017 22:58:21 +0530 Message-Id: <1488562101-6658-40-git-send-email-jerin.jacob@caviumnetworks.com> X-Mailer: git-send-email 2.5.5 In-Reply-To: <1488562101-6658-1-git-send-email-jerin.jacob@caviumnetworks.com> References: <1488562101-6658-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: [14.140.2.178] X-ClientProxiedBy: BMXPR01CA0021.INDPRD01.PROD.OUTLOOK.COM (10.174.214.159) To BN3PR0701MB1719.namprd07.prod.outlook.com (10.163.39.18) X-MS-Office365-Filtering-Correlation-Id: 7417b60a-dcaa-4f9e-6f10-08d4625b23de X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001); SRVR:BN3PR0701MB1719; X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 3:3u0GWb3oBhZul1pYjQM5LpCLAd2C280KN1ank/EIa/eiDq7aKaJUSCPOAynWIZsaz9bBcC2G/q/AAjOxowypMMpv77tR3K+ujql7Z/Ylx+48l1ZsqAjbmQhC3FJhZd3D5fcPuiW37Nofd1UVZ06wLxmtHUQ7Bq1XReLr0xavmC2jL4+4ye29Xyys1NjYT7824Bmzux/ouJ5CnP//a8rxX1/EnjoSOjaMBtiZtF9B8LsCDUizel9CPLKsWVQc2zYeFYUufZVbwPcc1Inv5LXYDQ==; 25:xtcV0ESCjYgSH+rfDz1vrwjhaXg90VazW91HP3rYxVYn6amVL8RMTNxITpcZC9E4SW4f7M2NSY8Dcl7L3IRIgoYelCmuXq5LYqA9+mmiX+H5r4XvjtP2q4Ukd63DH7C11OWdn3BuNxaDCS+9njIZdy7Vnh7KJ3bFgqvdlDxRoH8PUSmpd4gqXlgi+HvUZl1bLckKrrb6tPD2rWsL8sFWrFyXTXTVAUhQQHMCtcKB0xnkybmmiw6hEzZ20Ro31sZraLvVS5A7HmCKoqQaFvuN5O47FQa6uhHVqMntLd8gnsaQ27Bw87yDGeLID+1ubigUjigBte5i/x1xJt9c9cLAj4KM3QLf012YdT8e2ob6k/HVgrsC1N9qO3G8RJElIq5EN+1tdPI8YiJiu7/d7GQ/Df5kwz/Jp1mmG61IUWQzSB6ATvI2hj+lQQuP/KoqNvoFi+J1x0Tx5+WpbOxAm5jYSQ== X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 31:4yXN2E3mffb2X+YDusQvTIJqBkQz4vsurgSyBvlwY/txW1Op1AFaOscRHil1enhNXrExez0oH0qTGF6UodlsK/1/VlukJgirPuTROje0/FLTMvy7kjuwTPYtx3D6oSMgp9CkyZg3T6ECKZaJXal7pE1DfKQ4xfbQf4jvJqCBjnNa0xR8+OkoOgtAwPRSCXVZrY5XTzzdZdUTqKJqTvttDZmiSowOyC9la4iRFFZ3PmSL7AFWm53MCuIB69iUtjTx; 20:46FgDusPPPA3EZtQkHtKCXTcOlg3LddsjAg9pkRC41KBFd8cDmaWFK7FwHA6/2IGjfzR2zDs8lmfnrcwQqf3pFdJ+ka2m+3b+9DmV41R7h9ujZGl0HQUvKllGtWs/k3OC7E+GAuMz1twp8XMn3Co5/YeZkCMHpIXCv2YD4RRQz5lno1fUudG16OMb6Ukw1QUfFlkTpGj9aqVMGnSQn3q9WUVfypq74ipqIqFH2p0/y17jk9ji4tc0jsd8eL5vIrMdKUjJb/EqfB1qHpgMAcX9gielHPLMK2EcNIyHBYldIaFPNXavzv28eqiVFJyC7FOo3Zjup5qVy123qOAmvC9eZQhOKyP4C8O9JZN6zAzFW+LXrIF2RXoYP9VmjqOgjCt15durQvG1PxxRWUeI3PfhoTClLAKQqvOjSlPhHhemjqT9iFnRU6+J5egHSRYX9SZsz1+3kqRNTXlwkKBqwjXK+IVEpxYPWu5WE8+CieDzgljbJXvrwCwZrIjxf4iAxpY/+pn0G1Al0LkXFC56ZFI9b2m/v2KSo9fCpeESrdba0XP66U3zSBpS0eA2AP7GHWr/RwjvvzSO7a5/S2tPtcgFTa/fuIjmkpml0pxgeVWJ8I= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040375)(601004)(2401047)(8121501046)(5005006)(10201501046)(3002001)(6041248)(20161123555025)(20161123560025)(20161123562025)(20161123558025)(20161123564025)(6072148); SRVR:BN3PR0701MB1719; BCL:0; PCL:0; RULEID:; SRVR:BN3PR0701MB1719; X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 4:gZ2NpFP9F6/3KGh79mKso7Uywf4Cx87CbFbbU4voCNLsnjW6JtrA4KKBYPZsqSRTatOprqM9iPT9TD8e0AwRBEHzpLrnOtfb724mWwauHK4/S7T7T1gA0mbar1IBEGjx3A03EAWOXc2AfL6DwSlKzCb21mTPB997qZoWhRVhr+GVYqG9iUW2GHlKhB/6d/gpv9caRUZtYmDkUfe8ozDgH4pgkYlrvozeSZxlmqPYMASjNj/RSSbPR94ha1hII//mrPdC+4DEdiIHt3LpYQDKoBwcmwLZ7ULr36LspLU5DNAWhbwLcMA0f2ANDl/cu1nnASvYkRe9g0yd8C8Ay7DjteVt/T2/NRC2WTh25uhibJsuWJ9za+GyBkJsbbf2IMRKIbT6fIyR8oguDhSP42IMvNuo9hVsETe4rdbsk0u91YhnUxtIQcoDFo0PcHarIsUN0y4VnVryVvF9URd02PVku0DewIYjoxFK3LqaCZ737XSf9KiYqIy5sdvidEVFNN0uWukHCzG1EIoQ3Xk7sKELW8Oge1OiiPLUAokAh8LD2jS6cIQjtyMqQ7Sf3JPQ5vbmtwTB5hjhhuSjxpPEPo+IVBXLfv5Yx3lZ2vX6P8ASgUqi1McKi8OoZ0rKCoLh1hxjERSYdHEAKHy8N9vJwYNzBKCPlfQ8PGG9NsfrL66huVULXKghejoH/bmhLnbxTS+v X-Forefront-PRVS: 0235CBE7D0 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6069001)(6009001)(7916002)(39450400003)(3846002)(50986999)(6116002)(23676002)(2870700001)(36756003)(81166006)(6512007)(97736004)(2361001)(2351001)(6506006)(31430400001)(5660300001)(42186005)(50226002)(8676002)(6666003)(106356001)(8656002)(6306002)(2950100002)(2906002)(25786008)(47776003)(6486002)(76176999)(33646002)(7736002)(107886003)(42882006)(66066001)(110136004)(4326008)(38730400002)(6916009)(305945005)(92566002)(5009440100003)(50466002)(189998001)(53936002)(7099028)(110426004); DIR:OUT; SFP:1101; SCL:1; SRVR:BN3PR0701MB1719; H:localhost.localdomain.localdomain; FPR:; SPF:None; MLV:nov; PTR:InfoNoRecords; LANG:en; X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtCTjNQUjA3MDFNQjE3MTk7MjM6VEM2YVlWS3h3SHRpWldna3JEZFBzOFVF?= =?utf-8?B?MFN4azdRV3BGVVZORDU1eS9MOVFBTGZWdFlsRHVUeS9DOWhtSHdVQU9xZVBl?= =?utf-8?B?T1o2VndzQmhlNjFCd3laRVQ4aHVvblc4ajdFSWI4SEx0bjd5VnZIYWtDaXpr?= =?utf-8?B?MVlXU3hnbVM4ZGtxZ0F3NVZJMElxUG1EazErbnJDMjhMYW9UL0MzdEpqRFBH?= =?utf-8?B?VUZZTEtWeTZoUDJlWGhtMGpnVjB6NDVVZi94ZXByQlNha3lPMWNtZmxJVW5k?= =?utf-8?B?L2VoZ1pNNGVULzJLdTg5cXlnSjFoL1Z4R2UzcGdTN3AyRWxSNGphNGZwUmRx?= =?utf-8?B?bS9LSElmdDBybENTUDRqVllGZCs5U1FWOFpaK00zU3poWG5aTTZBeWVvWjFE?= =?utf-8?B?OXBBSkRwWWZ0d0xLcUFBa0FTZm5EeVRwMnptUDNPbGkxT1NYZmU2VmxiQm5l?= =?utf-8?B?TG1xTFdrK2tsaloyR050QmYwcW9LOHlrcjVkUnVrZ0c1bjdLNUliU0VwUFpt?= =?utf-8?B?SnRZdUhGQVE3RUM2VnVTWkpaQUV2TllJTFVVcDMwSHBKUDg1amhlL0VDMDEw?= =?utf-8?B?NkF4djFsWWlEZ2hJSjJlS1BWT1dyeUkybkdrR1F3R0lOaXNNejNmTjRaNHdF?= =?utf-8?B?Y3kzR2IrVWE2cGg3QWdVS2k5bDU2WlcvNk1Hcjg2UFRjQXNKUjNWWVNWa0x6?= =?utf-8?B?c05Wc21WemlLV1NXRm9sbWViSE5GUk5KbmkxdmZLbWRqQ2VRSGdxa0hOTkJu?= =?utf-8?B?akdJMU1wTE5qMDF6eVJlYWdzb2hrOGthZCtwQUtjTHI5aHZueEdjVDdQT3JJ?= =?utf-8?B?TjFBMUdiMGdEMXMyckFRY1l2Snd3N3RadTB3U1A1SGdtMEtKQ1NUTTF5Wmlq?= =?utf-8?B?UjBjQWk5cTZrVTdveG9RSytHbVQ2NTB4eUV2Z0ttQlgxZEc0dEJDSlp2b1dH?= =?utf-8?B?K04xbzhnWmdGaVJnVEo1alUzSzM1REZFdTZuYktYbEhlTk4xLzNwZTcyOG94?= =?utf-8?B?Z1pMcHlYUHdvd2FzRW5EUEdhTmdmcFBJbWMwUXRoRnFDcGtyalpKTjcxOU5y?= =?utf-8?B?NmUwS1liNmc2aFVyZ25UR0FJdTVZSVovYzI4WWU0THcxOXM1N2Vvc2dyUHBP?= =?utf-8?B?dzI0SFhBazRFR2pqWGJhUmlXbU92dWtMb1BpZTh4TUx6NEtSR08rTHFURGFD?= =?utf-8?B?c212YkE5VVhPS3NvdGMrVEJUU0hqSmsyZTdlZnlRSWJUbkFKSWhPc25FUDFE?= =?utf-8?B?WXdUN3dnZTR3alJVb29yODFmeWJqdkVZcHdGZWZVRjVlQzNZUjI5Q0FQNGsx?= =?utf-8?B?RGt0b2dpNUdlRDF1NkRoRkEveUp1azZSb3VPOWc5dGQ1QzJmVG5YbS94RWZj?= =?utf-8?B?c1pvQTIxWjBhSjNYUU1NVm54UThWWjBSU1RLYUEyWHQ2bFZScW5KdE5GS1JB?= =?utf-8?B?WnpoMTRLSGpXSTBCR2ZhcFFkSm1IWWE0b3M4L08xcE5JdWVmeGpMQU9NRGhv?= =?utf-8?B?cjFVQUpFZklDRHB1bHgzalZiK1M1ME1vNWRqem14c0U4Kzg4SjRwbWR6OUcr?= =?utf-8?B?RVNXdmhUSm52aXNPS09YWW9CL1NmOGUzdU5IZzBhZkEwaEtMMXFvTXA0eG5o?= =?utf-8?Q?s=3D?= X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 6:Tec8gmKC+z0nbUKIptJlG13Xd7LEYpmTQw38T+a82gbhmZT1P4PYhYE7s7O9Z+9uipPaKlrjIExw//9M3f+dKO4kn2J60VxgftgVPnVKE9FO3/Fca0OiYbriD0bxJ/TUvAe+1cGsjnwEnK6YHiwqOCQPPayoO+Mzmkm77IXGwKWFRVpB2DBo3tEKKg1JxUxRKe2XUMvITH0gR+q6yh16vBUuNZhkVSQ4ez3kBMBGiqtSPYtj4fiJDUr03bTCRJKmDHmS7O10lq9jkgCTrRG52svq0JmtRzVeJvXMV8muaDMy/IszoUoepikpiBTKI8QcLec6DvhXp6nk05cw+dNvPglv5QODhuME2gWKXgbcSy3AqZs7KmMOZAqD/W1ifLjvilCve/z6i3HUodMPN/uVAQ==; 5:uwIlV/K4HSfQkDSiUYXnzyuxDNwCbcnGbZUKV2SBBsZjScUyUeZ+hhScG7457Q6tIYwlUJgv7aKmfhi1YcFQn0WFHaN0shc62phPV364obm8bBDeYWsXmqzyLeOQn8d5phSv8zD9CxHUTil/IBucLQ==; 24:ijjjg93NbHREGQlW2WKobvvXLA0zvZLlam5Td1jHh2uPOT+BIz5zjtswxO0bYmvjSKo4Pn6E+7l13IMpKq2y3T6XT2wBT0wZ1F776mSWDVM= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; BN3PR0701MB1719; 7:OdII0/Hj/6LWo87feEtXsTzSQsThS9PFfTeRXKS00UHdTVYDfOENYto3bnRd2WGu/AEQdbjMrQ+sEeQCHVfqqbNxciqeMbt4nUgC6T8WWOozRErUeRfwyLRTN42g97Y47JYEkswlz/BfWtuAQvnJ0JlSv5sYVd7dISRHeSpog4Ukzrk3ffC4/FHFFJhaYna536XYsB1SZmc4hKvpfaWVyfUFWE81hyMpimsz+YmUpr9C5ZbtkvK8SkigPcs/c1wi0p7f1WBCRQZL0AE6nPVrOLn7G5wrHE76ZarRPfPcvjas/uhrS0ry2V0wGgBNP1zSLbrzON3X9uOILbSj3m0zeA== X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Mar 2017 17:31:31.5188 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN3PR0701MB1719 Subject: [dpdk-dev] [PATCH 39/39] doc: add OCTEONTX ssovf details 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: Fri, 03 Mar 2017 17:31:36 -0000 Signed-off-by: Jerin Jacob Signed-off-by: Santosh Shukla --- MAINTAINERS | 9 +++ doc/guides/eventdevs/index.rst | 38 +++++++++++ doc/guides/eventdevs/octeontx.rst | 131 ++++++++++++++++++++++++++++++++++++++ doc/guides/index.rst | 1 + 4 files changed, 179 insertions(+) create mode 100644 doc/guides/eventdevs/index.rst create mode 100644 doc/guides/eventdevs/octeontx.rst diff --git a/MAINTAINERS b/MAINTAINERS index c76d924..cbc5fe4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -484,6 +484,15 @@ M: Fan Zhang F: drivers/crypto/scheduler/ F: doc/guides/cryptodevs/scheduler.rst +Eventdev Drivers +------------------ + +Cavium OCTEONTX ssovf +M: Jerin Jacob +M: Santosh Shukla +F: drivers/event/octeontx/ +F: app/test/test_eventdev_octeontx.c +F: doc/guides/eventdevs/octeontx.rst Packet processing ----------------- diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst new file mode 100644 index 0000000..52be539 --- /dev/null +++ b/doc/guides/eventdevs/index.rst @@ -0,0 +1,38 @@ +.. BSD LICENSE + Copyright(c) 2015 - 2017 Intel Corporation. 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 Intel Corporation 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. + +Event Device Drivers +===================== + + +.. toctree:: + :maxdepth: 2 + :numbered: + + octeontx diff --git a/doc/guides/eventdevs/octeontx.rst b/doc/guides/eventdevs/octeontx.rst new file mode 100644 index 0000000..eec27ab --- /dev/null +++ b/doc/guides/eventdevs/octeontx.rst @@ -0,0 +1,131 @@ +.. BSD LICENSE + Copyright (C) Cavium networks Ltd. 2017. + 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. + +OCTEONTX SSOVF Eventdev Driver +============================== + +The OCTEONTX SSOVF PMD (**librte_pmd_octeontx_ssovf**) provides poll mode +eventdev driver support for the inbuilt event device found in the **Cavium OCTEONTX** +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 OCTEONTX SSOVF PMD are: + +- 64 Event queues +- 32 Event ports +- HW event scheduler +- Supports 1M flows per event queue +- Flow based event pipeling +- Flow pinning support in flow based event pipeling +- Queue based event pipeling +- Supports ATOMIC,ORDERED,PARALLEL schedule types per flow +- Event scheduling QoS based on event queue priority +- Open system with configurable amount of outstanding events +- HW accelerated dequeue timeout support to enable power management +- SR-IOV VF + +Supported OCTEONTX SoCs +----------------------- +- CN83xx + +Prerequisites +------------- + +There are three main pre-perquisites for executing SSOVF PMD on a OCTEONTX +compatible board: + +1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks** + + The OCTEONTX Linux kernel drivers (including the required PF driver for the + SSOVF) are available on Github at `octeontx-kmod `_ + along with build, install and dpdk usage instructions. + +2. **ARM64 Tool Chain** + + For example, the *aarch64* Linaro Toolchain, which can be obtained from + `here `_. + +3. **Rootfile system** + + Any *aarch64* supporting filesystem can be used. For example, + Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained + from ``_. + + As an alternative method, SSOVF PMD can also be executed using images provided + as part of SDK from Cavium. The SDK includes all the above prerequisites necessary + to bring up a OCTEONTX board. + + SDK and related information can be obtained from: `Cavium support site `_. + +- 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_PMD_OCTEONTX_SSOVF`` (default ``n``) + + By default it is enabled only for defconfig_arm64-thunderx-* config. + Toggle compilation of the ``librte_pmd_octeontx_ssovf`` driver. + +- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_SSOVF_DEBUG`` (default ``n``) + + Toggle display of generic debugging messages + +Driver Compilation +~~~~~~~~~~~~~~~~~~ + +To compile the OCTEONTX SSOVF PMD for Linux arm64 gcc target, run the +following “make” command: + +.. code-block:: console + + cd + make config T=arm64-thunderx-linuxapp-gcc install + +Limitations +----------- + +Burst mode support +~~~~~~~~~~~~~~~~~~ + +Burt mode is not supported. Dequeue and Enqueue functions accepts only single +event at a time + diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 82b00e9..63716b0 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -43,6 +43,7 @@ DPDK documentation testpmd_app_ug/index nics/index cryptodevs/index + eventdevs/index xen/index contributing/index rel_notes/index -- 2.5.5