From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM02-BL2-obe.outbound.protection.outlook.com (mail-bl2nam02on0079.outbound.protection.outlook.com [104.47.38.79]) by dpdk.org (Postfix) with ESMTP id 844CE5424 for ; Fri, 31 Mar 2017 21:38:04 +0200 (CEST) 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=OJtm91uYTY/6wJRh6GoLvsQ4NA2j+lfP7jLjYqQtXjQ=; b=XPlhD45u7o7YiYNY8Pn7UAPLBOphRhWrHkji9anEjXP57XHD8yzOGO3G3lEsN96WlqRoPlz0U6w1Gb9NGZyAZxf2MntBbo2z3EYRf1GYQDkfWUmwHlOFvpCEgKqXQ+ulIuloXV5xKfvqdMXjdxLCmMS35VKVLgEjVYSDpad0rc0= 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 (14.140.2.178) by BY1PR0701MB1723.namprd07.prod.outlook.com (10.162.111.142) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.991.14; Fri, 31 Mar 2017 19:37:59 +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: Sat, 1 Apr 2017 01:05:03 +0530 Message-Id: <1490988905-12584-37-git-send-email-jerin.jacob@caviumnetworks.com> X-Mailer: git-send-email 2.5.5 In-Reply-To: <1490988905-12584-1-git-send-email-jerin.jacob@caviumnetworks.com> References: <1488562101-6658-1-git-send-email-jerin.jacob@caviumnetworks.com> <1490988905-12584-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: MAXPR01CA0058.INDPRD01.PROD.OUTLOOK.COM (10.164.146.158) To BY1PR0701MB1723.namprd07.prod.outlook.com (10.162.111.142) X-MS-Office365-Filtering-Correlation-Id: c497992e-8920-4b29-e2f3-08d4786d722e X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(201703131423075)(201703031133081); SRVR:BY1PR0701MB1723; X-Microsoft-Exchange-Diagnostics: 1; BY1PR0701MB1723; 3:/vPM9PfcSSNd5yldO9eDLONLOf2vRmB905wsnSI11C02XUIgcZmVG3AtPkGNSwwV2DuXACN07oZ59hqUhtuprwn47Tt74nX5Y8sic8uh7YZ2NWcRL96gHX64EjHhxPI/L0xWaLd2e2rdDFfG46xouJFTjpoSlCu61eaeDWso4gEefwberPfwyERO4Mi4jlHTJZsoliKVZMR6iHm3qq3eXG2KB3gCfXQVxmiUGXErT8jttg1x3UxGdJe8rvz98pQBZ6iPeElgPmBzHgp5fcpd+ZPZJWOcme+707w3Nu7KtH8T7t+kDmLk9SWYrTALBrwl9/ItR28+GDZMiuDoqAVu8Q==; 25:ajJel8dK1myJQE936HtLZEPbiiNslyFw98fjRc2OC9nPRp44bHRus8Ln7a3BbYUniMMJ8x6A8/rx3cRNI3e+IPzjNWLOsxZzpRAvGMvAfJe3pHyCRFUpDXpfr5/AgYaQg26Fd+NTVI0MP/mSDNefYVS8Dj+ZFkVGfbShPr5qPRGoolsw+fWJTF5MsZ1x6/oDnIFD0YNSN/L0ce/EoOH87+jjeXf2bnBfy4JxWH+BoAXZmuKxbY3nu2D9vyqighn8BWFJXevqFmA+3b7MlGqbKzfXXMMDdMXTVHaERCPYZUp7xVqel2YmI9Zq9b+URYKzsTbpPYxtsn8DCnE0WnMw8gBt5OyFXbUdcH8P5B6PDS5Q19v9MPNVBNHlFzTmG0v0YBMmP6X9QIOkhh8cff2DZAXuiYhOV35rSsOTIo452TTOykGW710o16QtYdKKXITBbXkWoVrhj8Dv9yvcgiow+A== X-Microsoft-Exchange-Diagnostics: 1; BY1PR0701MB1723; 31:NLmouFrZMHmOCskBNePsPtSHtfdga4K+toSHDUhwhWshnwLejgbA27oXJClwQvsMjTa5jR6ui7AI3IJzdZ+ALZZDIJGMQaKf4I3YHmiOAIDwF7QiGyDcBgFMWrIYiq7SHYbozi9PTrkJuEbKDtSAGiM9O5mXyAHNlJPO5sqD8VJjgoaAWqcIqf/UHpI0pKV3p9HD5mSQyUkcvYzvqHwKwUiABxSgQ6jbb8sReXvy6kZL4U/2cZ0Nbv/Y7I2YQ/Y+; 20:7HG61y988uqgtq+En3gfWTMXZprfJZYeuT/uf6VxSN8TkrEJ/I2uvw2DE4zhAjGmxgQXzeqZISx4ZVxA9GPFyZUuQ+mtizHOUzCOyGgmMSzzRFxr6K28eTGOIHMvi2x4z3ALznpS8PoGepCtXY5O9W/OGAPWW2GGHB/B7tWsV4EteWrwAhi3KaqJvuvlnVgCYptzJwoVPWKs7YWca12cxu6Z/Ot30R6UVJWC9ILpnmtAC+Uqo17YYQYoJIr1ifioq51YNi4xKAVfIR8NKQ+VVmLfjWo8yS0+5UCsikl+bqz9jhwTDb8zPQ2lImvpwzczNAuf0AoygC6GxBesfXdwFCS9JgtrT5xWOOcyturHy0CN4VK3AWLpDh0cC5nE/SmCHM2G/2+VkwmO29it97yqz5GJV/BgDSLDqSLnnHXt+NFTUerKh9e7wJSJFWGMrgAdEutaKrtBao1UH0X0FPkIHdj4oPedptt/Cd7oqwwmfJ8p6ZdBApua4VVKXnPzM3iFfM7DGpJCnpJSWIy3DHbeYjdMAy5eK6T+PSnzJrzIMzQ+wxeprieI0KvcMNOsme64TC4qOT0Ycr0CgulW+TxQ7ZskHxVcdyT8Gccpk+NqStU= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040450)(601004)(2401047)(8121501046)(5005006)(10201501046)(93006095)(3002001)(6041248)(20161123555025)(20161123562025)(201703131423075)(201702281528075)(201703061421075)(20161123560025)(20161123564025)(6072148); SRVR:BY1PR0701MB1723; BCL:0; PCL:0; RULEID:; SRVR:BY1PR0701MB1723; X-Microsoft-Exchange-Diagnostics: 1; BY1PR0701MB1723; 4:Q9DUQZ5ikmr+052FyXnEzD7NRVH6ktlhz0bi3KF9mQ03SM6BWyN44np2Tu7SDw0+Qkkt6J5rM10dFJmaLK17is8645vfPDf72T6JMzRm9mVZ+HjxTtEAyxcsnukA/lUT6TMCqaerS92KM0xbCJEkkRzL/+1HwvMh3Ltml/ixVJLedWt6a0E/cEQ0imWFZAJdpUBLr78QO49dtGMLhlf2YaYd35paHcU4jGxrDYmbr0s3W1ANSiE27LbLe8fONpsARMnCkrkYHGVudyk5gnD0t/n6oGNv/Rd/32Ja0iVIfNxh1cMTG0WEoYWBFQbfne2wvMlfGjkvzGwrcWCm2vUe8W6wWUsCmCQON6nzE9wt9iryHuxroJMRZtP6eH5Ho48BgxmyFjV4CmrvrwFevcdkC0pY+9KXiE/Ctg7MSrS3hyxZP/NHKtugTjBo4DEcTU7q3Cav3uFhS3I3vxkxyd5RdVlib8UWumC3pwDF2R+bxX/T+ycADsNri7dgZ8Rh45IaOfGVf4MGUrcSeS5WS6z+wF9bOle3Fm1kOpLpicrlYdsg8FbuCVYRZClqZ/ffvY0JDx7hE/qFQd1EzGNC7w+Vt75dZd7HGSd7Aw/v0/zYhRy778UdCP9dsRQhO0J/5CusIt23fwkertMgrrHZSbYEJUSG5faxCoMzpXCbZo9SeHTir+ZJbzxkmCyqt0liQtwnDYGsnu3hdBs0G1rok3hymB5ftU3h8FxOOX3yWP6SL01oLrMUXmHToci7lw3GXe6Ny4RJagzaRAQlqxcXhxz1MA== X-Forefront-PRVS: 02638D901B X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6069001)(6009001)(39450400003)(39410400002)(39400400002)(39850400002)(39840400002)(38730400002)(8676002)(107886003)(110136004)(50466002)(189998001)(305945005)(6506006)(36756003)(50226002)(25786009)(6666003)(575784001)(8656002)(6486002)(7736002)(2950100002)(5660300001)(53936002)(81156014)(81166006)(3846002)(42882006)(6916009)(6306002)(6116002)(6512007)(23676002)(42186005)(33646002)(2361001)(2351001)(76176999)(50986999)(47776003)(2906002)(2870700001)(5009440100003)(4326008)(66066001)(110426004); DIR:OUT; SFP:1101; SCL:1; SRVR:BY1PR0701MB1723; H:localhost.localdomain; FPR:; SPF:None; MLV:nov; PTR:InfoNoRecords; LANG:en; X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtCWTFQUjA3MDFNQjE3MjM7MjM6VlQzbkVtR0F1ZVBTeUNNWHh1V1IrVTEx?= =?utf-8?B?alM5OGpkdHlFNXdhTXJDOVVrbStQZGNBWHo4ZzNGdVNOQWlhcEhCNmFnandJ?= =?utf-8?B?YnRqZHhHR3AwNVhUa0V5RENsR3JiU3BJbDA4WXRFeWZieGJaYnlTU3Q3NHZU?= =?utf-8?B?d2Z6bmx3Wmo3RHhoY2JOQVF4L3piaFNWVWtjNHVGeW9ITURDMkhRWHpSMFVo?= =?utf-8?B?b3pOM1g1ZXNRUzJyRjJ6MFhRNy9ncnpTMzJOYlJqRjB2RURjVVBzRUNZclZt?= =?utf-8?B?Q3ByYnZJSnk2Ym1sZEdWbTk1L3BiS21wS1YyWkV5dVE0cUlDNnFXSEVnZU9F?= =?utf-8?B?Yk1zYUhkSG9sU1JjbUpEWGJnWjdiUUpQNXFHR28vZnZVMkhZb1h0cnhuOGtX?= =?utf-8?B?elgvaVhSTFM4WkhpRlVTNlM3Q1JINHBjazZhZUpnRTFUTEg4OVgvV0Q2T2x0?= =?utf-8?B?anoyU3FSeVppNUExa2lsNURTKzRBN2VEc2RYTkNJQ3k1cDJ4TEtBYW5WQXo0?= =?utf-8?B?eHJrbFJBUzU4TGtzeWorQW83VUhGRVp1bkhqNFFiL1JpRDM3T3R1UWdJNVF4?= =?utf-8?B?UmFIQ3hxS2hFY0xWekFwd252bVM4SHZSVEZ1NldVZ2Y1TDFwREdCOU5ubUJN?= =?utf-8?B?TWUrRWdmaERVQkhYZ0dmdlBlZTUyTDNXcDNZQTNEazRpa0NRcCtid25IZDI5?= =?utf-8?B?dDNtb29TcWhLcGMvT3EzYjhYbU9mSER1cy9FTzNCM2ZVY09tdFNrMUs3ZHls?= =?utf-8?B?b2pCdE1yVGgrVlhzWVJmUm9ZMGVzNmZLaGJRQm9JVkZKYS9xKzBmaGZaYVIw?= =?utf-8?B?TkJ6RkVCWG5CdWdvQmFCMHVuR1FvRjdDL0x1SlRIZm52VGRkS3JwcVRVMTVO?= =?utf-8?B?Vk1yRWhZNDhlcXhNODZsSjN2VWViRVpaT2FNdDMyOXlBU0RRUWxtSU9NaW9I?= =?utf-8?B?eDJZTE9wY0ZWbG94OFo3TkZMNC83VWtoKzZOYzdzcDJHQ2JEeERvZ2VQazJM?= =?utf-8?B?V0pIVkVmcmptL3BjelVXa3ZYK3BpTHJZcldxUUtrdVZWYUQ5UFRQV1IzSURJ?= =?utf-8?B?QjNnSE1jUWcrYlZYVVRVNlFaNmI5UDZnUUMvOGhISjVOUGdOU2NNd21xTVZy?= =?utf-8?B?NGJKaFJoc082UnJKZDRqSzArNzMwa1E5MEJSMWZvSnQ0RCs4b0M3aE1vbG9z?= =?utf-8?B?aVlhaGpqZEFyMzZxTTFySmQyZUdhOTAyUzE0N09yQlpPQmI1VW5EUjM1ay96?= =?utf-8?B?cVBiRDZ1SFBQSVA3anF5d29PVGo5bEZKbGVVdVdUaXdRZ1dtbndLVHFWT2x4?= =?utf-8?B?Qmw0eFZzak13ZzFSelI2dFJqY3lTTW1TQ1VpNTdBb2pHTDZEa043emxoOFVa?= =?utf-8?B?R0tBSHFEUXl0ZWJvczRyZEUyZ2k0YkJOY3lxc2tiRzlWWHFKLy9BZkN0aWJE?= =?utf-8?B?TzI5T01iRUc1a2JPR3I1OWdiZFdCQjRqaEZ0TjQrbSs3WEkzMk5YQSsvMi8w?= =?utf-8?B?NkhoVnY5Q1N2Y2ttR1kzMEpyclBIUEQreVd2ZUJ4YzM4OEQ5TG5tUi83Nm5W?= =?utf-8?B?MGZxOFhaVTVGbm9tc2NxbVNQdnA0bSsxc290NUtPclZScnl0Z0NEUzZjWDFj?= =?utf-8?Q?dsfubrRr08tSydBcaCC+aL?= X-Microsoft-Exchange-Diagnostics: 1; BY1PR0701MB1723; 6:+1xO1WoQVKQl65AH5CLzRAsYY1xDVcp16qQzWjfLnMerwykn0Jmypd4XXj5OLRxMXIRgumLv5sTbR81ocCj1COTfjJ9i1n8zpDjqCTeoum6HBxi14o0rVrnUaKeW6nQHPaZof6NkZwZY7kshcA3PeoX4vJdopILxPqxkMDMrI5VhqLVJhIzlm2pPX1wufQlJEF7g9h1TeqaNLCC/ptU8Npz3ZejEvb4Je9G+F90OzVjeGySoNkToxogomKvlqNJPHzZMhCvC69Ii9LOInvNTynijHYQhANBYWSgXRlihy1KVsxFja1if5jgbjx9r7LHYPa02UN0sK6ASOWtxrRmT/jk89TvEzjdvuwU7Aiw5t1fxaTHkzkZtLu9BrdmSaj0uFl0sequXI+GxEYAjnUNfDg==; 5:R80YMolmUKW4oOSggDhWfj1OSXkDBMYRYrGqb6Mgl+fWIG518jEI9ZCyP2PSHDvAdAg4Ptr7GTKFt9mPW1KyAJHQiNx2kvTcdRw4dHBZQDU2fpoLeXBQlDyAJ9/tESrzPy9Z38HiUVcwpViuGBy6WUUviShJRlyQB+cRMMu65xM=; 24:CsELTZ3I4p9ln6G8cdP3RYM3r5AbhSHzBFD53BkkTVJc4AcAJrKfWq+fGNzVwyZEL8FdpP74Nc2wrmoWxtH+TyfHEf3fS6nej/2ACuG3dUQ= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; BY1PR0701MB1723; 7:G8qjFTEhWqrNB6IpR7FjN5f4Ta3c4wX/Rep1RCVaN6f+WARWB/VID5XB6z2z6gwuPZqITiFgF58KGYGJkjz6G8aDs+GYlEWtf4+R9H2xktkAHj9/TNaTz5TNwWGZ7xjygqywuvyev6rZT7dbGOUl7FdpTMchyyivsriHgt7476d03XNsDCsl5621xDadth4cyFACdxwuI04qof0Y/G840BOGTIrKRQ5mnrQyu3l83uZWP/3ibdE0dZX1/c6nDJEo1fBlaSj5AARTOmVjtAw5Khphwx/jWCwcpD87I0eRCPd8Zs4o/TeLtRZgSy6pvF5ex1pwlqM79ilnkvxIeyKpnw== X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 Mar 2017 19:37:59.4795 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY1PR0701MB1723 Subject: [dpdk-dev] [PATCH v2 36/38] 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, 31 Mar 2017 19:38:05 -0000 Signed-off-by: Jerin Jacob Signed-off-by: Santosh Shukla Acked-by: Harry van Haaren --- doc/guides/eventdevs/index.rst | 38 ++++++++++ doc/guides/eventdevs/octeontx.rst | 151 ++++++++++++++++++++++++++++++++++++++ doc/guides/index.rst | 1 + 3 files changed, 190 insertions(+) create mode 100644 doc/guides/eventdevs/index.rst create mode 100644 doc/guides/eventdevs/octeontx.rst diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst new file mode 100644 index 0000000..433ee0b --- /dev/null +++ b/doc/guides/eventdevs/index.rst @@ -0,0 +1,38 @@ +.. BSD LICENSE + Copyright(c) 2017 Cavium networks. 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. + +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..6d88192 --- /dev/null +++ b/doc/guides/eventdevs/octeontx.rst @@ -0,0 +1,151 @@ +.. 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 pipelining +- Flow pinning support in flow based event pipelining +- Queue based event pipelining +- 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 ``y``) + + 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 + + +Initialization +-------------- + +The octeontx eventdev is exposed as a vdev device which consists of a set +of SSO group and work-slot PCIe VF devices. On EAL initialization, +SSO PCIe VF devices will be probed and then the vdev device can be created +from the application code, or from the EAL command line based on +the number of probed/bound SSO PCIe VF device to DPDK by + +* Invoking ``rte_eal_vdev_init("event_octeontx")`` from the application + +* Using ``--vdev="event_octeontx"`` in the EAL options, which will call + rte_eal_vdev_init() internally + +Example: + +.. code-block:: console + + ./your_eventdev_application --vdev="event_octeontx" + +Limitations +----------- + +Burst mode support +~~~~~~~~~~~~~~~~~~ + +Burst 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