From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM03-BY2-obe.outbound.protection.outlook.com (mail-by2nam03on0062.outbound.protection.outlook.com [104.47.42.62]) by dpdk.org (Postfix) with ESMTP id 7CA721B2B8 for ; Sat, 21 Oct 2017 11:41:25 +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=G1sFFNgSdC4YdJJQWjMGTxUqDTkbmOStrWYtVmLya0M=; b=ja9n1Nraehyt2grqW0709svZ2F55iatkZncbZaySqDWZnP33jckcKIYd6Q+yuoVKsq9/G2h92RIgwegeRoKFcXLWSwaQrufdam5LvSAeFF2D5lxj6DkKno8ds38qbGVvmfSvgUCu8zTmw7fS62ybHrS9NcGdv5eNobTv9pJLkUY= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Jerin.JacobKollanukkaran@cavium.com; Received: from jerin (171.76.118.225) by BN3PR07MB2513.namprd07.prod.outlook.com (10.167.4.138) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.77.7; Sat, 21 Oct 2017 09:41:20 +0000 Date: Sat, 21 Oct 2017 15:11:02 +0530 From: Jerin Jacob To: Santosh Shukla Cc: dev@dpdk.org, thomas@monjalon.net, john.mcnamara@intel.com Message-ID: <20171021094101.GA14009@jerin> References: <20171008124011.1577-11-santosh.shukla@caviumnetworks.com> <20171020152124.14746-1-santosh.shukla@caviumnetworks.com> <20171020152124.14746-2-santosh.shukla@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20171020152124.14746-2-santosh.shukla@caviumnetworks.com> User-Agent: Mutt/1.9.1 (2017-09-22) X-Originating-IP: [171.76.118.225] X-ClientProxiedBy: PN1PR0101CA0008.INDPRD01.PROD.OUTLOOK.COM (10.174.151.18) To BN3PR07MB2513.namprd07.prod.outlook.com (10.167.4.138) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 543f642a-5227-4b42-74e7-08d51867e3b7 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(4534020)(4602075)(4627075)(201703031133081)(201702281549075)(2017052603199); SRVR:BN3PR07MB2513; X-Microsoft-Exchange-Diagnostics: 1; BN3PR07MB2513; 3:emkZBvLrT9ecQPWVPDeRRszAm3gV024rDOPquTGVuq1n2shFf1rk+HVxzliO5qRcwat/FB5rY3J7V2gVwf8+RE0LKK5Yv73At9GIQct1R0I/vx88vxWj1IjGiMfXl9Uv7Lcsgr5rq7y2z2JYsW8iTJTBqeXvuxGAFiDIDYFEFQedKC6/u87GGemJRI8mvIHTOL58aTFKu+6ywp2LdpOkgafftaj/R+gaqclAh+QAtl8NSzZyakyorCWGYvZdGgBU; 25:cfLfDHxuCa3KquA3reVDe8W9Abqqk36tBjJfbO1ux1jZtr/vnZAUNqn3YzWLOYEAIEHgwOxIMD3ho7Yl3eiZZ4Wrc9KhTAGyMbE6RJDZglj2erF0jNGFGLJCC+uDV94AxVg+r0Ovu7GU9ytAyJqn3Mxm3sSuCVO+dYyuYXK6TFPm4eAEkLS8btWuhmyZt7vY6jL7Uv5uYWvZNwZovQL3xjjsQrajdfSKKdDlXVA81QNvsaq3+gRG5syG9l5++840sJ0Ot0Q/D08t8/Ko7QCXP3MhnFKS3N9Ja9zKNfEsNW8K99Yx5xRyZJLJRo29h9vTYr3o2vqVl0FcbBCfP6r6QA==; 31:G6ZGpRJ92KM+D0jSbXO0rcTSwx83vFZeTvv3UkRA/9eVzDwWadXDZ0hLUnma/xEVTlyUHvs2gdlNiPIa3e9zcra2+QYpZTNtuIy2GSUrjHiLESZNgbJD0wbUj0KS8CF55oNqssRo4tPqlTQOQz+/Ee390V6v4MCpKGhPxYPcPEeG2aF4lEAy/5KNK5gGkSQ+6ITMGUlS0PzTXgRaq0Hi1sRaCYPx8aHEzfjnsTbtEKI= X-MS-TrafficTypeDiagnostic: BN3PR07MB2513: X-Microsoft-Exchange-Diagnostics: 1; BN3PR07MB2513; 20:mSwOl9EaWdELHDsZFvSFedrCLsigJY4onxBO3oRmDgrt1WI6H4aJJJgTtxof29y7zaYpoN7mcEtymmsOiRkebLq3G5zXcF2rHS5o3RscHIev1mVGdRFCK2Udgctn4/oqMz28kvaF9FU9CiJVYx/NCPJ12X6FKXdz2mnmrJdvDotjTTSqD4fOiRWBf/pw8mRGPSO/BoZlE51rVaxI3oXYcqTMElF3+46cX/YEAY8+K3+PskbkcRPvg8DQdTrl/hPTV4DOnF39IqJ+QpdhXfsYHYhUbrnrRkq1zCb9klwqCD9EgLBR9zaTAfssHynUj373H6CP8Rv+cKNo4uVarxWdxcyyaLblQFpR5KCyASrCNrYAonIqs4LxKmEMRgcSTs329YeEEXHq6aPGK7/faeku0ZuIcCvAxYc6cgDG4zVqWSjgh0pNz7ODD0jsnruuooRI6ghWuEAfTXYI9beRMoPhmM+tue0i7PjhZKFwI1BebQyEZ7dyw+lsE8y/3RhGEvL25v4331NCn2K5zOSDCImecgP3OSihaFn0FQoqpHPuGTPcGy8FqQp4Y2wKEdPhvprj/oKDbXyE85sWxKzydpcXlzRRtPsMNeRE6ErbvA8kkrw= X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(228905959029699); X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6040450)(2401047)(8121501046)(5005006)(10201501046)(100000703101)(100105400095)(3002001)(93006095)(3231020)(6041248)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123558100)(20161123560025)(20161123555025)(20161123564025)(20161123562025)(6072148)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:BN3PR07MB2513; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:BN3PR07MB2513; X-Microsoft-Exchange-Diagnostics: 1; BN3PR07MB2513; 4:mPv8dAAnTgdA53zpLxY92LDuL6TOL4kUJuR0mDlSuB8dbbrw4EX4OUmSplfIJaz3TippKLcW/p/WA6yuKUpqrLamLA0tq8GL90jcop13O7pBlCYmsTu+9pKkrCvfT4+enZfbthmwdPEkUYfDYmBqyb7ZOhc8/O/GdiNidTE5XP5J6LyWGCuF4mGryCmc9D9vCI615e7ueZYWDRqghx6panCrRMwbrSTkv9MwVf+T3EYoKYb1bQ9wIHApACLOYlgyIl0/zxiZC39C9k8m1tU6gDGKR3UDPVnVSvV4VamQbA5MsNu+dtTrKDEatTdt5udSBbKHTtHunmW8fkSW4SjPjQ== X-Forefront-PRVS: 046753C63C X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(6009001)(376002)(346002)(199003)(189002)(13464003)(6306002)(54356999)(6496005)(478600001)(189998001)(47776003)(6246003)(58126008)(3846002)(23726003)(6116002)(6636002)(72206003)(16526018)(316002)(6862004)(16586007)(50466002)(76176999)(97736004)(68736007)(33716001)(1076002)(8676002)(50986999)(33656002)(66066001)(2906002)(5660300001)(9686003)(229853002)(55016002)(101416001)(8936002)(53936002)(575784001)(7736002)(106356001)(305945005)(81166006)(6666003)(105586002)(42882006)(25786009)(2950100002)(4326008)(83506002)(81156014)(18370500001); DIR:OUT; SFP:1101; SCL:1; SRVR:BN3PR07MB2513; H:jerin; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX: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; BN3PR07MB2513; 23:ERlpSoDjsE/HzYwDc0VyBAToQVELJdhW496/wWQyH?= =?us-ascii?Q?i+scIYNOrQCN+Z2JVr10GPdBSdc/zMvPHMK7xgqEYBfDVb+4c9yeV/Nf5Vhx?= =?us-ascii?Q?jm15+D4LATwAvZy1AhfR8IQPEYbUXz+HmzUUc++gNcKtW8BlUNtukmqupNF6?= =?us-ascii?Q?uLFglDJMpMClIN+OOW9mBqfV0BUdj/DmSaDlw+MWGB6yt6CWEuYen60kHyig?= =?us-ascii?Q?GWqHnwrqwq5f2sojpmZA8JK7u8mpkIgsDxV9OJvLbJ2tbYhbm8nj78z40/bU?= =?us-ascii?Q?K5vedbYbUWT3KYwxf03O9dIGc/iNOWCcnwbsAI/nh+4aF63Rjn42X8Rv2f7S?= =?us-ascii?Q?sJ0+Iqmh0+j4zKrJ2d7iWQt18hkCKxLrGOXe9fWYNI9V5fpnTzkvvNyjU/hP?= =?us-ascii?Q?yZ9/MBV2gBorVrIcEPZZoW4px4t7O4pLrVvMs46jPgkSttqNSUrF35QheXi0?= =?us-ascii?Q?+o723ZJkijo5mUe6NPwy/aXiOkQOjSEW9Pr56oUqgCK9ewUEx/5S+NbTXT6T?= =?us-ascii?Q?48XZmhh2O4t+s8ocdWqg6CAilalg2ytMUuPv52qgElEcD7JOUVfMvPU+myqe?= =?us-ascii?Q?jMhGH0C+Towoo2DCyxcYM0vrbRHmTQh0G1lDkfHfnfPRGG9aCQ8v8D1VDUzP?= =?us-ascii?Q?W1UdrI+8HEOB2j2a1uSTUguAKZ4QAqa3eGAU+q+akURYbdO8rTFyjK6PgSBJ?= =?us-ascii?Q?Re1WdECz+0InsRYboGGmZCJPySCEFWEBTLWBK1ebCFDq4uuOSt1szsTlG3Mf?= =?us-ascii?Q?q09rCfP4bX8k2gm7RpwYZlRKCkpdHkGvPSTVW4d5mbZf9Lar14S0PH4F5pcT?= =?us-ascii?Q?iZ2VFX8ztya7lgUerwpEU/LjB5LwtBHqFy46j2za2FVO+V9G05iI1W5abWYo?= =?us-ascii?Q?N1RwHIjWgNHe75EkVSfDTbuWB127Rfa6XZ3708W2d5r9u38F43IoN7Ab1M/h?= =?us-ascii?Q?XdBHmLfNfLXDOBKNSxBJzIJ74avq8aVPrnELTsj3fxduPo2tlY2Tu3YAenTz?= =?us-ascii?Q?TZO0x8kXRQ6U7JHHxkTADlQGFCwbsTOruqqyyKjvy2aouWESX6Wve1hAZCrT?= =?us-ascii?Q?6O/oEMYbFYsIpc50UU3zOCfD3bTFPcJ0n9mStEAyF9Gg4UiW2RXYGJCGVCWi?= =?us-ascii?Q?6rGqx0vaxxem/RIA7S1oGPqxBdIhT4kDI/WY8/P0eSDIdwh+RuzdSn8aifim?= =?us-ascii?Q?ISs71j7ZcAcfM0NqRN+Cet+FS7ldpoZ/WtIFKURpYzDC5xLlGrRzi4FLjBE+?= =?us-ascii?Q?krXGv7RDyR8yHMt9dBt/a4AyfPUtktvuTr/C/Rm?= X-Microsoft-Exchange-Diagnostics: 1; BN3PR07MB2513; 6:65DGoE5wGjICATWQNjjbNYxt9lAOFXuRSPidLLOOPMPm7e4el/9Pam1roz/dkE7QAj9wPX+s2cP8wwIB2M2KSRWUxLUiMaO/MDE56uEScxVGj7Mr2KcwettKdX/W/TjlNlpmY86qx4Rxb1e871d455nKAiwFlLFzfQPClUf/t4oJGBQ2dMiZqWmHpqoIp2mr0ziuIpn1kfxEHxN5Xj40KqRUh7urgjOBGW7/4mV83A8u6Ew8B0vgD/06jvpsfK73EhvlI3nafO4Y1TEpo7AA1ysdY/qwRB5d2pRIv7ZGq9JayS2ofU5n6prZwrFhstulrHhlFO8ukIEvEIkW+y68YQ==; 5:hzJ+8NPyod3aq0jyNw+q367pTR3xFSL+XWb5OQjMWd1VP50HNZeAL1LdZ9P/Mt2ueixzcJQLOYV8EYZuFyGanMRwm1y/t5SPuVPpOtcjx7a8YrEGlz1aGXbKcUjOBHJKZlJ0F/k2xgr3JPslXArmjA==; 24:O7CK6pndrx0bwJpasGiGf72vSYYdutuk7q+TgbU/Cipsbu0BOwIv6nbs5O/uPXxmau0Nj/CQqReY0A06woquPdrAyhD6sAQG4ITnLFIFt24=; 7:Vl4vHiA61K/jwwrclRBcg1RVLGM60RA1Kx0S7whvdoX3kn8GfncLbMxvydruIjAK2UdJj2qsrUKSdYzUkDlc5Isef5Y+EyCI1+giXd26WRQhalpCgqpkQ1+TeJf+EkAfYYWmTA7ChZnVYNJu3+rsJBmAs6ESOhxP2n8VODgQPpfSedI1LPqUU2O/7KOHuXDghKkwBuEftXIGpJZ0jZK95EIScU5Zn4zlKE9j4r8nV0w= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Oct 2017 09:41:20.6003 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN3PR07MB2513 Subject: Re: [dpdk-dev] [PATCH v4 1/3] doc: add platform device 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, 21 Oct 2017 09:41:26 -0000 -----Original Message----- > Date: Fri, 20 Oct 2017 20:51:22 +0530 > From: Santosh Shukla > To: dev@dpdk.org > Cc: thomas@monjalon.net, jerin.jacob@caviumnetworks.com, > john.mcnamara@intel.com, Santosh Shukla > > Subject: [PATCH v4 1/3] doc: add platform device > X-Mailer: git-send-email 2.14.1 > > This commit adds a section to the docs listing the platform > device PMDs available. > > It then adds the octeontx platform driver to the listed platform > devices. > > Patch also removes platform specific duplicate setup information from > eventdev/octeontx.rst, nics/octeontx.rst and update to > plaform/octeontx.rst. > > Cc: John McNamara > > Signed-off-by: Santosh Shukla > --- > v3 --> v4: > - Added doc/guide/platform/ as per v3 discussion. > - Moved common content of "Prerequisite" section from eventdev/octeontx.rst > to platform/octeontx.rst. > > doc/guides/eventdevs/octeontx.rst | 28 +-------------- > doc/guides/index.rst | 1 + > doc/guides/nics/octeontx.rst | 29 +-------------- > doc/guides/platform/index.rst | 40 +++++++++++++++++++++ > doc/guides/platform/octeontx.rst | 75 +++++++++++++++++++++++++++++++++++++++ > 5 files changed, 118 insertions(+), 55 deletions(-) > create mode 100644 doc/guides/platform/index.rst > create mode 100644 doc/guides/platform/octeontx.rst > > diff --git a/doc/guides/eventdevs/octeontx.rst b/doc/guides/eventdevs/octeontx.rst > index b43d5155e..e834372af 100644 > --- a/doc/guides/eventdevs/octeontx.rst > +++ b/doc/guides/eventdevs/octeontx.rst > @@ -63,33 +63,7 @@ Supported OCTEONTX SoCs > 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. > +Ref: `OCTEONTX Platform Driver` for setup information of PMD. See last comment > > Pre-Installation Configuration > ------------------------------ > diff --git a/doc/guides/index.rst b/doc/guides/index.rst > index 5b6eb7ec5..9c24dcb46 100644 > --- a/doc/guides/index.rst > +++ b/doc/guides/index.rst > @@ -47,3 +47,4 @@ DPDK documentation > contributing/index > rel_notes/index > faq/index > + platform/index > diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst > index a6631cd0e..2527aa3e3 100644 > --- a/doc/guides/nics/octeontx.rst > +++ b/doc/guides/nics/octeontx.rst > @@ -71,34 +71,7 @@ The features supported by the device and not yet supported by this PMD include: > Prerequisites > ------------- > > -There are three main pre-perquisites for executing OCTEONTX 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 > - all network acceleration blocks) 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, OCTEONTX 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. > +Ref: `OCTEONTX Platform Driver` for setup information of PMD. See last comment > > Pre-Installation Configuration > ------------------------------ > diff --git a/doc/guides/platform/index.rst b/doc/guides/platform/index.rst > new file mode 100644 > index 000000000..27b64e57d > --- /dev/null > +++ b/doc/guides/platform/index.rst > @@ -0,0 +1,40 @@ > +.. BSD LICENSE > + Copyright (C) Cavium, Inc. 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 Intel Corporation nor the names of its s/Intel Corporation/Cavium, Inc/g Similar instance found in patch 2 as well. > + 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. > + > +Platform Device Drivers > +======================= IMO, We should not limit to Platform specific drivers. I think, all platform specific information can go here. For x86 case, may be x86 tuning guide can be moved here from QSG. > + > +The following are a list of platform device PMD, That has information about > +their common hw blocks and steps to setup platform device. > + > +.. toctree:: > + :maxdepth: 2 > + :numbered: > + > + octeontx > diff --git a/doc/guides/platform/octeontx.rst b/doc/guides/platform/octeontx.rst > new file mode 100644 > index 000000000..11cff6a11 > --- /dev/null > +++ b/doc/guides/platform/octeontx.rst > @@ -0,0 +1,75 @@ > +.. BSD LICENSE > + Copyright (C) Cavium, Inc. 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, 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 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 Platform Driver > +======================== I think, it would more appropriate to call "OCTEONTX Board Support Package" or something similar as it has details for PF driver, ARM64 toolchain and Rootfile system etc > + > +OCTEONTX Platform driver has information about common offload hw > +block drivers of **Cavium OCTEONTX** SoC family and has steps to setup platform > +driver. > + > +More information about SoC can be found at `Cavium, Inc Official Website > +`_. > + > +Common Offload HW Block Drivers > +------------------------------- > + > +1. **Eventdev Driver** > + Ref:`OCTEONTX SSOVF Eventdev Driver` > + > +Steps To Setup Platform Driver > +------------------------------ > + > +There are three main pre-prerequisites for setting up Platform drivers on > +OCTEONTX compatible board: > + > +1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks** > + > + The OCTEONTX Linux kernel drivers (includes the required PF driver for the > + Platform drivers) 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, Platform drivers 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. > -- > 2.14.1 >