Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/31230/?format=api
{ "id": 31230, "url": "http://patches.dpdk.org/api/patches/31230/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1510037974-1511-2-git-send-email-santosh.shukla@caviumnetworks.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1510037974-1511-2-git-send-email-santosh.shukla@caviumnetworks.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1510037974-1511-2-git-send-email-santosh.shukla@caviumnetworks.com", "date": "2017-11-07T06:59:32", "name": "[dpdk-dev,v5,1/3] doc: add platform guide", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "330ac7b5468cebde534460409bb7b0f74201deea", "submitter": { "id": 480, "url": "http://patches.dpdk.org/api/people/480/?format=api", "name": "Santosh Shukla", "email": "santosh.shukla@caviumnetworks.com" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1510037974-1511-2-git-send-email-santosh.shukla@caviumnetworks.com/mbox/", "series": [], "comments": "http://patches.dpdk.org/api/patches/31230/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/31230/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 4CBC5255;\n\tTue, 7 Nov 2017 08:00:19 +0100 (CET)", "from NAM02-CY1-obe.outbound.protection.outlook.com\n\t(mail-cys01nam02on0071.outbound.protection.outlook.com\n\t[104.47.37.71]) by dpdk.org (Postfix) with ESMTP id 92AAB1B3CF\n\tfor <dev@dpdk.org>; Tue, 7 Nov 2017 08:00:16 +0100 (CET)", "from santosh-Latitude-5580.caveonetworks.com (50.233.148.156) by\n\tBN6PR07MB3089.namprd07.prod.outlook.com (10.172.105.7) with Microsoft\n\tSMTP Server (version=TLS1_2,\n\tcipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id\n\t15.20.197.13; Tue, 7 Nov 2017 07:00:08 +0000" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com;\n\th=From:Date:Subject:Message-ID:Content-Type:MIME-Version;\n\tbh=TISZrzXyeeQq8HxLz6iduW69S/hL+nQOqVPL68/tzGw=;\n\tb=Agjz/gYC5jGMyRCA22RKWfDfeOO0VFtBlBJYr23RgIMlQxW91Gm5HzYRfWXDojILV+6cvLinqNtb32Tg47X/OPQvS79IzkpM+hpAbkj2ru20MM63x9FFnEVYjTkA6M/JGv4gNg7/zVWMhrNpA4idIsP2M6fxpex4Zez9QQDlBJo=", "Authentication-Results": "spf=none (sender IP is )\n\tsmtp.mailfrom=Santosh.Shukla@cavium.com; ", "From": "Santosh Shukla <santosh.shukla@caviumnetworks.com>", "To": "dev@dpdk.org", "Cc": "john.mcnamara@intel.com, thomas@monjalon.net,\n\tjerin.jacob@caviumnetworks.com,\n\tSantosh Shukla <santosh.shukla@caviumnetworks.com>", "Date": "Tue, 7 Nov 2017 12:29:32 +0530", "Message-Id": "<1510037974-1511-2-git-send-email-santosh.shukla@caviumnetworks.com>", "X-Mailer": "git-send-email 2.7.4", "In-Reply-To": "<1510037974-1511-1-git-send-email-santosh.shukla@caviumnetworks.com>", "References": "<20171020152124.14746-1-santosh.shukla@caviumnetworks.com>\n\t<1510037974-1511-1-git-send-email-santosh.shukla@caviumnetworks.com>", "MIME-Version": "1.0", "Content-Type": "text/plain", "X-Originating-IP": "[50.233.148.156]", "X-ClientProxiedBy": "PN1PR0101CA0066.INDPRD01.PROD.OUTLOOK.COM (10.174.150.156)\n\tTo BN6PR07MB3089.namprd07.prod.outlook.com (10.172.105.7)", "X-MS-PublicTrafficType": "Email", "X-MS-Office365-Filtering-Correlation-Id": "18de5a18-943d-4d47-9af0-08d525ad31b5", "X-Microsoft-Antispam": "UriScan:; BCL:0; PCL:0;\n\tRULEID:(22001)(4534020)(4602075)(4627115)(201703031133081)(201702281549075)(2017052603249);\n\tSRVR:BN6PR07MB3089; ", "X-Microsoft-Exchange-Diagnostics": [ "1; BN6PR07MB3089;\n\t3:2tuHL6HjjwKsz0KdedDZrzkump1CXPZU/ARuL6v7hpbuSC/ni3qrzO60wLNvHnOC3fKR/kf45fgLesnUu/NbNNO2IhVWwy5kRsZhPNQJCDBoahydoCBz06l1Gh5nlmyzKE2YgvQwPkqZHvmPScFY+1HXIKn5VfmVe0bYfBjaoYQnychL1PogdJK8dXtfKkYYSQLO/QJX6ems+WvLgIDqUyse5hrR518XKOInZW9Q3+xwdw+S8n6WHKQLg+irKdYN;\n\t25:Y40+532Lk4E07DIFgLRVRELKeJrbjs8Ue1MwHl+sX5rzV5s9RUIsGZ0nCT/8b55MZzOlCSMYO8QvhNlOajebjIeAULwXrB79PjmTy9Ikf5jPB01CtF2y8CAcjclOsgikKDDxjKDiVGAegu6BQ8YwFSba8joqgzbwFoLajfNRazZKzvnQ+pPZgks8slWYTa0PUEQYfNkrCX7kLKis3Ny3RiRp3Rn3Tgs1B3QWwE19CaFrzuOxHl/FrhTuod24OHZyk0eN0Jjc3YeaR0UOrIT+ZkbO01OMczspKXGHv6sKEz15J4NU32Uxq3cMDSTYCoRSvkgPaW8gqv3xqm5IPt73Yg==;\n\t31:B8UIbssD3tHVwBglAxCDRz3F8fR/8yd4UWMISyG0Q53TlTosDgz9TLosrm9T7cL0W2NRfgTaksq00we9jiCV1vlR3cHh1o/aPOf8d031GWd0jUM8UjFS+OvTHCOa6hU5dxTsAhwXkTrQvbyTey/lochog5S9jMTMuWW4gNN/RpmfQRaltHIlA7KdEvEzXMx2dPd8znuhXsUZ2+VTNVJLSdhfIGNU2mjN6FxHbPZSslM=", "1; BN6PR07MB3089;\n\t20:irvVjgjkIWMyIy1LID1gol4HtzbKLxXVlHWUcAaoCSnz4Tht+4UVcTJNIcciUzR5oJKa09QmDjUKe+9TwIryF7zzF/LqJq6dtuZvchCs5sO0LgmU5zqcv/+kbvsdhEci9yW5AuZd/X0pjbofAauCoalx2BNalPY0T4DJFFodc0Hx6PSk4MxZWTDZRXMX6bIQLQbpJEYJ4Nx9f8Zj2JesiSuyBO1JHXm8Tq8H46hSYMUfPxOpCCHPh1NLv2hO5b/q4nJfnAJc6e0vAH4q0ZKkwF6ic8M8shKnGxIh/tIrXDHGf51NeLS6O1GnDceMoLEkKPazo4I7yWqnCj9+IFoeCh86Vxqv/a3DWKIUo+62VdNV7XouczcdiN5klSb4I9IGQk7UkC0Wp/zXR2uK7E51o1gj1QXIeJHKezlPdSAAiFdRJaqZN0NGmKL77uKAwxuQWZvbq0lt0jrkGckmN9Wh8x+tf7qgYiTKI8u+Ww6Ou1lfelwraBdRas4PygW7hd8bdOTo3aDNlS02kBeiTFWBeNhUSmaWeVBHpCS9kCkQVGAhQshbZYdKvLPpE2zwpCFVUIbVac+g2r1L8EchIW0iuugCBRobP9O3Dybgf+M3JIo=", "1; BN6PR07MB3089;\n\t4:zKT93GWtUGYyqHaqNRt/qMCL3mHSsKRmyFXXmhnnmapFGZMtdVQqlf9rT4ZuaBE/xkgLh5WOmHb/kg3l+mCuyNpTmCSUmIO6RPPg7YAA1z9fGbPtbXdpJ6j0Yu0iaNNNrek68uCesoPu19/oLg81KAzyUpF0qrbZsOszAflSpCeLFT65BgPlEtaY2SRZNAx+hjHlyTsdidP3ZjQaG40epwwrh5+M95GUZ2EjQ+2l91M5zjfx2tPbuCbyy9tpMEe61JozSo/EevHVuLoP5Y1MNfAxnfC1bn5qDAxLZw5G9LSqmSyu25TJ8+39WX7Qq6tLQtgzaB6iBk83DLaaWiKb8TgQun5PSYxYi8OJt+IFgPg=", "=?us-ascii?Q?1; BN6PR07MB3089;\n\t23:cWVYFQCyLLFHAM8mWXq9jwiVLW2UbOWhBaB7+8PBd?=\n\tW2daifBoUAoa6e4MLwVyjop/x2wCWJWEs4hYQM9IdOU9o4GVySYQ4MIJWDd0IQomDd4ZD/aYBSQZXEEhAtv5poqNICLkKCfHd42j1rgi/+NMlbuzDWQ9CBawXTXyXXX3Tb+ly2ptbzD71IbHkqSN/Y5cEHMw9cMVMzKu+ZrmrzUbniUIoy9/8Wtp31HxFwV7mgMCTVxe9DLOr4d3wZBADIT6ZjN+JPFBkDrLuSfEwhglU4rHQHn7qDI8+tHckKk4drDinlkgDpNhgOp/qkwUdvEdWjtpDKdkOuUkysi8PIz46eHs1b6QfkXZqXtMKJngB4aGMHtKwyTXedJoevaXwdKtsWotCcIzjATzkwnEuldriiRaM8/7kRj9y1xW1lcZFmuc2YUN2dhZDKCTTC72NCKel6StEd1+rF0ki3ASK77nM1N1eRR1vN26nXqsEYSW1qEfHGxqHnF8SKoPb31SvpXOps8JQi9G4/j99Tpek542NNgPkkZ6hIH7CFEakB970g97A+XjNEFMjoWR/szUUocy/LDLCIgw2PolRnX7oVZfm0GpQXmlg0nv9iLYKvMC9WtmWmMo/Q/cf/Dl/SQvTjdyzPfniKEh3l0xgP7ZIMgfdQpoy3w58FVXnK3hEeiepVUZXJUfeZ1MX/X+umNtfbk56tFcwa31u/MglhJoSjC2sn9GrDi6vD/aKjOk95FXb+6XuAjSony0xSAbZyVdwstCfwNC6FK9ZemtfIsSofBqJNc1Nmc5iKPDz9PzCa4lGBfhyDSlDZCaPLTHZzTWdCwkfBkDLTz+gtL99yLyP3So/r6lgjDq8OGSLSpbJ0+/sFfGyw55OCBfd4DwZur06rIZEIbp6qEKjUUYdfJ1FhWUd/7A179j/L2GdcVe1/YNLXVNEYpadh7PTHnsCJpseZCjDZglor1b2szJEsr23ACXBdFNcxPVWRhzMKXd/2k4prRvQPVWmPpcopAq6/WZIPKDejiUKaFljoIjkmolJ21zZ8mMO+cnZd8gysXpZYqe4intaAIOwMWlDPdXJvAa0VFxwg95wbzcv2pBLUI/Xe0VEFVHGb8xvI3YDudxcc9/g17GUaFEdOoM7BMTIaoeqAoe2PWfCLFC364oDR9c1XcVGnr92SIlCTHVRDUOu30j5v6nFBdHIGCweaQMU9RE+DM", "1; BN6PR07MB3089;\n\t6:63GoQ0LUC/kR4Xtc+GcVAwrr98ro1Y31HjGXBOQSTbjsGljFbXyOWpQ71znMrTNXhfb0mmx76RschyFMgIcEkmWYTlSr+8tNGaq/1I+4UWSLyaZoZcMgPFXYz/nvMoe3z58+CwkYKyanO6HLe6erhLwMgeoO2CRQDveAdIqqH6bUfUYWh30o59KL7fGQB55U326UNeaZn0CJgXMExoaB9IH7CVI9K/6f8wgHjMIOvfngFQIBm7Y/XCzKE5ivck8G6L8QXwi5SzOHSDxw/S5988L7+gIImRvP0FX/dc37cey+ZEz9YQW7LzZ28z6s8G5901cpKJkhY6CVO/y96QJMpEX87GeHWwVaJufwQKVMXbM=;\n\t5:EsDJMR9k5EhbAVrXafchdTlAFEtcl3LkPG+BsAgpRsPGOF5pqXyC/pxGL9d8gZbGAcG52p2gfDXUq7Dpen7y1WZaV/Xma+0GQYhDoGPiMh8rtIA3669vBuX/vNeSgwf3psDD6iSGO0MBOHiBPFnWCySBQ5yj2qk7umsg/DWqCsw=;\n\t24:oYNVFNDfaGxVFcOcXdlXPzXAixQxFB3AoHncUstUJ7gqfblXYJJJYJwl3o+Y3SVzL614Y1MGAG0tcP/GjsJv1P3bvDVRtufUb3b7ka0QCLs=;\n\t7:xdgMNI8dWPWW+9Sd0vMLuftRFA/7cE/QxCKd/7z8MLX479yzKJ3zGGP7vVauzFqhM1ajUPkFwrlw3IS3TCPwjWjfZeE9T9LC6e7jOQ2Eg68tNGw2ozI0RhdD1I4ChcsONnRrySBAucEeav0hogjvcv+F7RvezD/Ze5wMJO7m1e/w5p292ZESUk3GQBomW5nOjjgFGpwY0ulxiPhIFkbT43VaDcmsKDGNzbnziMVnLPqzqSzdwxE52x/NA6EPLaKw" ], "X-MS-TrafficTypeDiagnostic": "BN6PR07MB3089:", "X-Exchange-Antispam-Report-Test": "UriScan:(166708455590820)(228905959029699); ", "X-Microsoft-Antispam-PRVS": "<BN6PR07MB3089182CF481FFE6D4C5EB7EEA510@BN6PR07MB3089.namprd07.prod.outlook.com>", "X-Exchange-Antispam-Report-CFA-Test": "BCL:0; PCL:0;\n\tRULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6040450)(2401047)(8121501046)(5005006)(3231021)(100000703101)(100105400095)(10201501046)(3002001)(93006095)(6041248)(20161123564025)(20161123562025)(20161123555025)(20161123560025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123558100)(6072148)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095);\n\tSRVR:BN6PR07MB3089; BCL:0; PCL:0;\n\tRULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095);\n\tSRVR:BN6PR07MB3089; ", "X-Forefront-PRVS": "0484063412", "X-Forefront-Antispam-Report": "SFV:NSPM;\n\tSFS:(10009020)(6009001)(376002)(346002)(199003)(189002)(81166006)(7736002)(6506006)(69596002)(16526018)(5003940100001)(81156014)(316002)(6486002)(33646002)(68736007)(3846002)(66066001)(8676002)(305945005)(36756003)(5660300001)(6116002)(6306002)(6512007)(50986999)(76176999)(53936002)(72206003)(2906002)(53416004)(105586002)(6916009)(2950100002)(42882006)(48376002)(6666003)(47776003)(97736004)(50466002)(189998001)(25786009)(107886003)(50226002)(101416001)(478600001)(4326008)(16586007)(106356001)(8936002)(2361001)(2351001);\n\tDIR:OUT; SFP:1101; SCL:1; SRVR:BN6PR07MB3089;\n\tH:santosh-Latitude-5580.caveonetworks.com; FPR:; SPF:None;\n\tPTR:InfoNoRecords; A:1; MX:1; LANG:en; ", "Received-SPF": "None (protection.outlook.com: cavium.com does not designate\n\tpermitted sender hosts)", "SpamDiagnosticOutput": "1:99", "SpamDiagnosticMetadata": "NSPM", "X-OriginatorOrg": "caviumnetworks.com", "X-MS-Exchange-CrossTenant-OriginalArrivalTime": "07 Nov 2017 07:00:08.5880\n\t(UTC)", "X-MS-Exchange-CrossTenant-Network-Message-Id": "18de5a18-943d-4d47-9af0-08d525ad31b5", "X-MS-Exchange-CrossTenant-FromEntityHeader": "Hosted", "X-MS-Exchange-CrossTenant-Id": "711e4ccf-2e9b-4bcf-a551-4094005b6194", "X-MS-Exchange-Transport-CrossTenantHeadersStamped": "BN6PR07MB3089", "Subject": "[dpdk-dev] [PATCH v5 1/3] doc: add platform guide", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "This commit adds a section to the docs listing the platform\nguide for the PMDs.\n\nIt then adds the octeontx platform guide to the listed platform\ndevices.\n\nPatch also removes platform specific duplicate setup information from\neventdev/octeontx.rst, nics/octeontx.rst and update to\nplaform/octeontx.rst.\n\nCc: John McNamara <john.mcnamara@intel.com>\n\nSigned-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>\n---\nv4 --> v5:\n* Replaced `Ref:` with `Sec :doc:` as per John review comment.\n* * Renamed Feature to Features (john).\n* * Replaced Section from `Platform Device Driver` to\n`Platform Specific guide` (john).\n* s/Intel Corporation / Cavium Inc (Jerin)\n\n doc/guides/eventdevs/octeontx.rst | 28 +-------------\n doc/guides/index.rst | 1 +\n doc/guides/nics/octeontx.rst | 29 +--------------\n doc/guides/platform/index.rst | 39 ++++++++++++++++++++\n doc/guides/platform/octeontx.rst | 77 +++++++++++++++++++++++++++++++++++++++\n 5 files changed, 119 insertions(+), 55 deletions(-)\n create mode 100644 doc/guides/platform/index.rst\n create mode 100644 doc/guides/platform/octeontx.rst", "diff": "diff --git a/doc/guides/eventdevs/octeontx.rst b/doc/guides/eventdevs/octeontx.rst\nindex 7e601a0..cef004a 100644\n--- a/doc/guides/eventdevs/octeontx.rst\n+++ b/doc/guides/eventdevs/octeontx.rst\n@@ -63,33 +63,7 @@ Supported OCTEONTX SoCs\n Prerequisites\n -------------\n \n-There are three main pre-perquisites for executing SSOVF PMD on a OCTEONTX\n-compatible board:\n-\n-1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks**\n-\n- The OCTEONTX Linux kernel drivers (including the required PF driver for the\n- SSOVF) are available on Github at `octeontx-kmod <https://github.com/caviumnetworks/octeontx-kmod>`_\n- along with build, install and dpdk usage instructions.\n-\n-2. **ARM64 Tool Chain**\n-\n- For example, the *aarch64* Linaro Toolchain, which can be obtained from\n- `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.\n-\n-3. **Rootfile system**\n-\n- Any *aarch64* supporting filesystem can be used. For example,\n- Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained\n- from `<http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.\n-\n- As an alternative method, SSOVF PMD can also be executed using images provided\n- as part of SDK from Cavium. The SDK includes all the above prerequisites necessary\n- to bring up a OCTEONTX board.\n-\n- SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.\n-\n-- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.\n+See :doc: `../platform/octeontx` for setup information.\n \n Pre-Installation Configuration\n ------------------------------\ndiff --git a/doc/guides/index.rst b/doc/guides/index.rst\nindex 5b6eb7e..91a7ebf 100644\n--- a/doc/guides/index.rst\n+++ b/doc/guides/index.rst\n@@ -44,6 +44,7 @@ DPDK documentation\n nics/index\n cryptodevs/index\n eventdevs/index\n+ platform/index\n contributing/index\n rel_notes/index\n faq/index\ndiff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst\nindex a6631cd..e4f8a4c 100644\n--- a/doc/guides/nics/octeontx.rst\n+++ b/doc/guides/nics/octeontx.rst\n@@ -71,34 +71,7 @@ The features supported by the device and not yet supported by this PMD include:\n Prerequisites\n -------------\n \n-There are three main pre-perquisites for executing OCTEONTX PMD on a OCTEONTX\n-compatible board:\n-\n-1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks**\n-\n- The OCTEONTX Linux kernel drivers (including the required PF driver for the\n- all network acceleration blocks) are available on GitHub at\n- `octeontx-kmod <https://github.com/caviumnetworks/octeontx-kmod>`_\n- along with build, install and dpdk usage instructions.\n-\n-2. **ARM64 Tool Chain**\n-\n- For example, the *aarch64* Linaro Toolchain, which can be obtained from\n- `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.\n-\n-3. **Rootfile system**\n-\n- Any *aarch64* supporting filesystem can be used. For example,\n- Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained\n- from `<http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.\n-\n- As an alternative method, OCTEONTX PMD can also be executed using images provided\n- as part of SDK from Cavium. The SDK includes all the above prerequisites necessary\n- to bring up a OCTEONTX board.\n-\n- SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.\n-\n-Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.\n+See :doc:`../platform/octeontx` for setup information.\n \n Pre-Installation Configuration\n ------------------------------\ndiff --git a/doc/guides/platform/index.rst b/doc/guides/platform/index.rst\nnew file mode 100644\nindex 0000000..69e560c\n--- /dev/null\n+++ b/doc/guides/platform/index.rst\n@@ -0,0 +1,39 @@\n+.. BSD LICENSE\n+ Copyright (C) Cavium, Inc. 2017. All rights reserved.\n+\n+ Redistribution and use in source and binary forms, with or without\n+ modification, are permitted provided that the following conditions\n+ are met:\n+\n+ * Redistributions of source code must retain the above copyright\n+ notice, this list of conditions and the following disclaimer.\n+ * Redistributions in binary form must reproduce the above copyright\n+ notice, this list of conditions and the following disclaimer in\n+ the documentation and/or other materials provided with the\n+ distribution.\n+ * Neither the name of Cavium Inc nor the names of its\n+ contributors may be used to endorse or promote products derived\n+ from this software without specific prior written permission.\n+\n+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+ \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+Platform Specific Guides\n+========================\n+\n+The following are platform specific guides and setup information.\n+\n+.. toctree::\n+ :maxdepth: 2\n+ :numbered:\n+\n+ octeontx\ndiff --git a/doc/guides/platform/octeontx.rst b/doc/guides/platform/octeontx.rst\nnew file mode 100644\nindex 0000000..34c0339\n--- /dev/null\n+++ b/doc/guides/platform/octeontx.rst\n@@ -0,0 +1,77 @@\n+.. BSD LICENSE\n+ Copyright (C) Cavium, Inc. 2017. All rights reserved.\n+\n+ Redistribution and use in source and binary forms, with or without\n+ modification, are permitted provided that the following conditions\n+ are met:\n+\n+ * Redistributions of source code must retain the above copyright\n+ notice, this list of conditions and the following disclaimer.\n+ * Redistributions in binary form must reproduce the above copyright\n+ notice, this list of conditions and the following disclaimer in\n+ the documentation and/or other materials provided with the\n+ distribution.\n+ * Neither the name of Cavium, Inc nor the names of its\n+ contributors may be used to endorse or promote products derived\n+ from this software without specific prior written permission.\n+\n+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+ \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+OCTEONTX Board Support Package\n+==============================\n+\n+This doc has information about steps to setup octeontx platform\n+and information about common offload hw block drivers of\n+**Cavium OCTEONTX** SoC family.\n+\n+\n+More information about SoC can be found at `Cavium, Inc Official Website\n+<http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.\n+\n+Common Offload HW Block Drivers\n+-------------------------------\n+\n+1. **Eventdev Driver**\n+ See :doc: `../eventdevs/octeontx.rst` for octeontx ssovf eventdev driver\n+ information.\n+\n+Steps To Setup Platform\n+-----------------------\n+\n+There are three main pre-prerequisites for setting up Platform drivers on\n+OCTEONTX compatible board:\n+\n+1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks**\n+\n+ The OCTEONTX Linux kernel drivers (includes the required PF driver for the\n+ Platform drivers) are available on Github at `octeontx-kmod <https://github.com/caviumnetworks/octeontx-kmod>`_\n+ along with build, install and dpdk usage instructions.\n+\n+2. **ARM64 Tool Chain**\n+\n+ For example, the *aarch64* Linaro Toolchain, which can be obtained from\n+ `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.\n+\n+3. **Rootfile system**\n+\n+ Any *aarch64* supporting filesystem can be used. For example,\n+ Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained\n+ from `<http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.\n+\n+ As an alternative method, Platform drivers can also be executed using images provided\n+ as part of SDK from Cavium. The SDK includes all the above prerequisites necessary\n+ to bring up a OCTEONTX board.\n+\n+ SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.\n+\n+- Follow the DPDK :doc: `../linux_gsg/index.rst` to setup the basic DPDK environment.\n", "prefixes": [ "dpdk-dev", "v5", "1/3" ] }