From patchwork Thu Aug 30 07:39:29 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Hemant Agrawal X-Patchwork-Id: 44001 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4C2D04C9C; Thu, 30 Aug 2018 09:41:43 +0200 (CEST) Received: from EUR02-HE1-obe.outbound.protection.outlook.com (mail-eopbgr10084.outbound.protection.outlook.com [40.107.1.84]) by dpdk.org (Postfix) with ESMTP id 0AAA42BF7 for ; Thu, 30 Aug 2018 09:41:42 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=1rKNqzLnwb4hvGG+g1q4C6xvg2mswLFUPLb0MaCCwhE=; b=XmaQSZ++85AvGEm+lV2L2HPH8YdXp8+nAsL0a4sFBY2e/yKU+Ff472lCffjiF1eWVUzjQjGgYX0B1ffbtTiP+MwGzVf9LtreVks7vizPSHxBmZySB8urghVSSlPIh5YkN5yTDgiSo6FvftpSqeGgWYovU0PfvCK6mWa1tdMzUcc= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=hemant.agrawal@nxp.com; Received: from bf-netperf1.ap.freescale.net (14.143.30.134) by VI1PR0401MB2544.eurprd04.prod.outlook.com (2603:10a6:800:56::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1080.17; Thu, 30 Aug 2018 07:41:38 +0000 From: Hemant Agrawal To: dev@dpdk.org Cc: shreyansh.jain@nxp.com Date: Thu, 30 Aug 2018 13:09:29 +0530 Message-Id: <1535614772-20886-1-git-send-email-hemant.agrawal@nxp.com> X-Mailer: git-send-email 2.7.4 MIME-Version: 1.0 X-Originating-IP: [14.143.30.134] X-ClientProxiedBy: SG2PR04CA0157.apcprd04.prod.outlook.com (2603:1096:4::19) To VI1PR0401MB2544.eurprd04.prod.outlook.com (2603:10a6:800:56::22) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: aef1341c-0644-4844-720c-08d60e4c05bb X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989137)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(5600074)(711020)(4618075)(2017052603328)(7153060)(7193020); SRVR:VI1PR0401MB2544; X-Microsoft-Exchange-Diagnostics: 1; VI1PR0401MB2544; 3:KvGCgvVp7ASkVK2wla1EFu7q8WKoZ8eQoYymduAkAFR27Xf63l4HgU/sLrAMoeufDv6q3Tvtabrz06U7J0G/kZzNTnBW3vC9nBM1u7f/7+PnJ6BNrF85CW3/HhN1YQO1L/Pw+IwIwFD7znVVhIUDqYEp6zNKmVFahEFScSfpE5MFPRUikuiIRI6ChW34KyEQxTnezU0k/nyniyTNo8W/e/Wb1lQOEhQgNtlXHdgdNucgGlILegnLAG/yRDy4Ho+q; 25:BD41rmI9vnG9z7iFA7ANe2mDWXD7hTHhI37V3CLRbcb2xbTI87dMobx3+WLC/BgM4MMZkJQlOtSAHvREqRQZEFPPMhxsxWGEdF7cBlzEpCJeh5TU672rshXBPnySz3WhTDKBhD3GfmqckLvxOHHNtIIV52KrVdNQ44SSjNK0TjqDWP2kVv0deiptMRG+P2dI8YSQR+vUlurUVHEoRZsjB3ttKZlkHmZg6cr6j1BCb/N615PYb7CP8n3CSK3gepeLOaUWnjxANQm9ZS+1DREhlPr91hmkQgfzfQ+8S65UxCKIOLr2IT9mc6fu7UXXppn4ezUrpkGTrWfAaAxW4GzRng==; 31:DKW+Fi/z6ncX5K91fVygTilTWL94zMcvTYfm3f2ZmKmFKUlFiK9hxRDsF2ZjxuOT4LaUBoVclEX2YoESlEZohH9bcrpuUsZo3jRp+X9REL4RpYqYUZFz2uL590w2jgDerIPeCvUNNG+GKZEbK9SeOouePA9p3BVU3qFMyJz7T65vi+KCtHf4xw9efDUaxPL/+mDWwTqX+CcvgG8JvK3bU0miRl2yJKSe1S0GIBiE1lk= X-MS-TrafficTypeDiagnostic: VI1PR0401MB2544: X-Microsoft-Exchange-Diagnostics: 1; VI1PR0401MB2544; 20:1uJccF4jdPEUvKK8ppyALM95CJj9j3Hz8onSjdPohvIVKuupiIu0/+8VwKRQDjEQFYaB6/veRDsjsJVoRYZV70yIsyT4PdunIuK9T4x48el1RO8HRyvFk/iz55Ma8KTbVbB80h/HMoiJFmyHIUwxFjwxebKCEsSoKvCOCih0PnNygW7t2YM0iq1WKTjTOqD1KgRu2L6hCBI6zFFZdmT9qvdhFkvaOV28KRGmeqdZ7JU9xSf4caLvKzND8MPTZAf2/CTM87SWjQz+eW66lsZhBQQw5bVgO9y3QPJjiDw32bs5wSQ2ZmP6ymsWuquulh9MwbQZVujyMN3NMxhsF4da7k0YGe+uJqQ/CfdNPzq9v9RVQxqKDhn3q8aXJkOSd6QRgcc+j7hg0JjZgPgs0VHamfO4F5ru6XcvNqEdKYw1zIhuOqesI3efl12RIrNYznfVPfcs7FkVeRC+3C9hui+ZK+6q7l/GqTN9xinSZBOnOebI28126IsL/LmY1A4p0sAj; 4:zsZqe72PHyOsUVOQm1yjqznyWwj0P9k7inMEjcuzakMr0pdktDWqT004m76Cg8te/BixRlsMtrwPjkbLYhmmqaQ9Ev2nVgllhe06MyL6LAwvK1Gw/uNoSWnjiwK0pZRL2TFk2MZYpWmnEhnrz4ah7flbl7EQhKEYs+hriPBmisFN5HoJeQTxhlwXlE9cJO5qvnwyuI97nJNFFq6rrCbhRNw8S53JemC9RGnpawLZls7nb8m3QWlR/1PwQ42HCOwMo6POSQ3I8jayfxomTfCtBK+/8N8bdbm8IepexSSm+LQ+p8hyOlREaPNHSsNSWwg8f72s7Bg1Q+AFRQCmgGS7uVz/aPdigx7oFYxPr7CIpS4= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197)(264314650089876); X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(823301075)(3231311)(944501410)(52105095)(3002001)(93006095)(93001095)(10201501046)(6055026)(149027)(150027)(6041310)(20161123562045)(20161123558120)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(20161123564045)(201708071742011)(7699016); SRVR:VI1PR0401MB2544; BCL:0; PCL:0; RULEID:; SRVR:VI1PR0401MB2544; X-Forefront-PRVS: 07807C55DC X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(376002)(366004)(39860400002)(346002)(396003)(136003)(199004)(189003)(4326008)(8936002)(5009440100003)(6916009)(186003)(2870700001)(305945005)(3846002)(16526019)(6666003)(478600001)(25786009)(7736002)(105586002)(2361001)(68736007)(47776003)(44832011)(50226002)(2351001)(106356001)(6116002)(66066001)(97736004)(23676004)(81156014)(36756003)(8676002)(6512007)(55236004)(81166006)(6506007)(6306002)(386003)(316002)(956004)(50466002)(26005)(5660300001)(2616005)(2906002)(6486002)(86362001)(53936002)(52116002)(476003)(486006)(217873002)(110426005); DIR:OUT; SFP:1101; SCL:1; SRVR:VI1PR0401MB2544; H:bf-netperf1.ap.freescale.net; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; Received-SPF: None (protection.outlook.com: nxp.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BVI1PR0401MB2544=3B23=3ACp?= =?utf-8?q?Yf4dXLIkXmpvk7BqFJ9kElNwLLM7QJf0z6QkNayrDYlVSL4F5LWHAAAh?= =?utf-8?q?8lPq0WdXiLOycqxPwOQD2Gcj6quZ7m65HXTnQgEBk/U8dAqpU7F3127d?= =?utf-8?q?sU6Lb8bYbDe8ZdCI6UYquer6a3rGp3V0ef7Y6Vs6SLzl6RzkBpnDFO3U?= =?utf-8?q?WaRx11ZO1xc+AEnyVLqkTEFYk90hquBDaoWLr6Kbyo/aOhypwfzGs+xM?= =?utf-8?q?jAnG9UjEaK9KtONH5PrOOYIAly6Cwx6fP9FDkszzOGkPsdwIoWgczFX9?= =?utf-8?q?nSrf0qJMFDxOQmefy1Zo5kcUp1Sum3P1AGrI+8psx7IJBRw6itLTJsJo?= =?utf-8?q?EXNxAIAXq0e7U7a51aeSnkVdKYjrJLo2fZ577W+vzWyDMKeEFi5SsFQB?= =?utf-8?q?+eA5uR0O8cb86rBr2tvjPXw7gJ5O8RYX1pZttQsEnn1c76SxgZWmVEHz?= =?utf-8?q?QhBZaVDR86JCS8A5DKE+NGtd6K99RxuR0In9FDGxtG/23514TmZq6Iah?= =?utf-8?q?cail92X39O+V/QYeE4blDnkq/C3nk5Wv0yT9zgqhWk01GJ22tM9o3lus?= =?utf-8?q?b13f4sMv/Xc9BsE+8mbSemeg2R0KizFvPAlH96PQCbZxqykJylJdLs/7?= =?utf-8?q?uK/TyyVCiYzFd33bZ7lAmv7CU5F/HpBAL4batET5JVtJclkLNCH4sT8m?= =?utf-8?q?5GjI+GbkCpESYEevB84VPhJJnKEL2tzhchbRzNL4WYQpeF4Eq8mdIZQO?= =?utf-8?q?OtLxSuAq28AAmv73H8V+lKBQWjT/O5IcJ+2e0fpqrtfV6EUXnqPBYpoc?= =?utf-8?q?dLx4nh3BvAEYE/8gjjEltyckwrOAMhcs8VDaO6Z66SHqSPDEMXN43CxW?= =?utf-8?q?rWmuledX7yIreQZv/pSSXIaX4BPXFBrGOU7r73x8gMCWuypKZz7GPPLR?= =?utf-8?q?4lxhvs0RhQgCW5PLmDkRyYf/4zxX7Sv6DDsERwrKSDpS+P3Bh9D0+AU4?= =?utf-8?q?WrcJvtasyDOu7KvBVF9jNBi2+vwlpv2gv131S2XgRYXieO69zprt7xuw?= =?utf-8?q?kT8WwkZhp5n1B2CnDTad4Op8NTHSuQSmdKqaH2Q6G4VZNRyWbd4B5fXC?= =?utf-8?q?y3AwuVAJwgTB1z0nwMme2MdmE+fHDTS8gDO9+PjRED4CIeWZHK/foo3P?= =?utf-8?q?dxBZiUy850wY7xS7OYhbybZeIgxe0RZrHLxwI9B5rIE0tq0VvggosBq3?= =?utf-8?q?snp63Aj/Mq+ai5WuxGfb6FUXq14eLGIuH96TH1vktJaR+Do35rPo4jXh?= =?utf-8?q?aEGi98FtiDR30h1y3HvMvIG7WYOQCD8DO2lRPMTL6DMpXx?= X-Microsoft-Antispam-Message-Info: LILc363WSVmmubo86oBFq3QXo0VHsRogfEN0l5VGJke4uflbert6YKm141zZVwMlXlJxnFYKlOFhGvAkA0htD7IdiWXgh+KXB6OayF15y2YFKkGIyQyS4GxtfFZikdkBhlqF6DR5wpeQxrgDQa+J3ZO0NeXAjK8s307fRcD+Yicm+y/oIOkQcsDCB4sjrh+CCdufZjncLLapBa4FFz2F3htC+EuoiomfsTmUXLnZ155cl/s03xCWr/eVMBCL2HkrXfOBrSUqZT8+a+P2F28FmFLGk80BhhVv40g3sIWrGkgbQz5dhtT4l933qmWfClc7manNrIh9SXgIwjn+LK794jSh5RPZUmM0hBlaQb/Xyxk= X-Microsoft-Exchange-Diagnostics: 1; VI1PR0401MB2544; 6:uzFBmN+YNQX0AgupnXOXBZ4xpYaXIFMQZMTfYaktVoEptPjh5KTXYQdP3+dzzjeKoRfa/lxFEQpbP1eGuuoLyzwW/NeE1xk/+9F+frW92tGeAtNN7S+Syl7OdSeVtjJv25YEpaFwyCR76xsUsI5eUkKEI3ON6w934BQNzUKMTP2iXOFhTU/AJUHavbbpED6zQv8c3T7Ze0TaHMshUH6fD+E1crt3v1X5XOsM6CEbBodb3e37Ku5eQjVBr0IVFLMNl8TTTf3xNLj8iZ7Eb9lShP1BgQECjcweBG9kSAJcrA+UeVi2FHvdKj3VLG4bS6MKdKnowna09mchpovMdFOoEr0nL4wEMUoYMCPKs3aFNOE7brPx8owJoI7N8gp9yEuSr/RZbzgNOL5zYyYZ3pcioSHEjODcf8D/O7wifzNrt3msam+IEltQ+2VbezcmMZRm/1WpXko8mVUtDAGS9zPgQg==; 5:/4Y0i8RL+wF7uI/2LiZMMsQ6f0MI0P+O1lBh+aoKGIO/Cm7Vz4SdyD/Gqm2t35JeHjmBky2rnBtSr61EUJCFIzryCPcMFlK0rsLtw0z72wSsO4JZG/u666htB9baBxeFkFfkbgUIP8SeoBeBHVomlRGYMeAgJmRD5kD629N97Ok=; 7:IVCo0vSEnYTpLyd1OEJAQSNVFvcJHQ9j+QJFVzQgGatquCVanQQqucmBP/iaxjBllQL6OXRWaPLOaXQjDp7n0Az8PQUOGEZnkZchSz1wNT3IYCDCnOUshb0WyK70W0Zw0msheEvFRjGGx4BwzhHtcT1DiTb7JuPMquRZZYgrCgIy38KVDnJHaRADQePWLcu+bBFlOG8mFj1xtXG5SLil1HFZtDqtOtr5XodBXqTaFlVg4tm+gS9t9rGZdujXYIET SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Aug 2018 07:41:38.2856 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: aef1341c-0644-4844-720c-08d60e4c05bb X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR0401MB2544 Subject: [dpdk-dev] [PATCH 1/4] doc: create a platorm specific page for NXP DPAA platform 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Signed-off-by: Hemant Agrawal --- doc/guides/platform/dpaa.rst | 102 ++++++++++++++++++++++++++++++++++++++++++ doc/guides/platform/index.rst | 1 + 2 files changed, 103 insertions(+) create mode 100644 doc/guides/platform/dpaa.rst diff --git a/doc/guides/platform/dpaa.rst b/doc/guides/platform/dpaa.rst new file mode 100644 index 0000000..e51379b --- /dev/null +++ b/doc/guides/platform/dpaa.rst @@ -0,0 +1,102 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 NXP + +NXP DPAA Board Support Package +============================== + +This doc has information about steps to setup octeontx platform +and information about common offload hw block drivers of +**NXP QorIQ DPAA** SoC family. + +Supported DPAA SoCs +-------------------- + +* LS1046A/LS1026A +* LS1043A/LS1023A + +More information about SoC can be found at `NXP Official Website +`_. + + +Common Offload HW Block Drivers +------------------------------- + +1. **Nics Driver** + See :doc:`../nics/dpaa` for NXP dpaa nic driver information. + +2. **Cryptodev Driver** + See :doc:`../cryptodevs/dpaa_sec` for NXP dpaa cryptodev driver information. + +3. **Eventdev Driver** + See :doc:`../eventdevs/dpaa` for NXP dpaa eventdev driver information. + + +Steps To Setup Platform +----------------------- + +There are four main pre-requisities for executing DPAA PMD on a DPAA +compatible board: + +1. **ARM 64 Tool Chain** + + For example, the `*aarch64* Linaro Toolchain `_. + +2. **Linux Kernel** + + It can be obtained from `NXP's Github hosting `_. + +3. **Rootfile system** + + Any *aarch64* supporting filesystem can be used. For example, + Ubuntu 16.04 LTS (Xenial) or 18.04 (Bionic) userland which can be obtained + from `here + `_. + +4. **FMC Tool** + + Before any DPDK application can be executed, the Frame Manager Configuration + Tool (FMC) need to be executed to set the configurations of the queues. This + includes the queue state, RSS and other policies. + This tool can be obtained from `NXP (Freescale) Public Git Repository `_. + + This tool needs configuration files which are available in the + :ref:`DPDK Extra Scripts `, described below for DPDK usages. + +As an alternative method, DPAA PMD can also be executed using images provided +as part of SDK from NXP. The SDK includes all the above prerequisites necessary +to bring up a DPAA board. + +The following dependencies are not part of DPDK and must be installed +separately: + +- **NXP Linux SDK** + + NXP Linux software development kit (SDK) includes support for family + of QorIQ® ARM-Architecture-based system on chip (SoC) processors + and corresponding boards. + + It includes the Linux board support packages (BSPs) for NXP SoCs, + a fully operational tool chain, kernel and board specific modules. + + SDK and related information can be obtained from: `NXP QorIQ SDK `_. + + +.. _extra_scripts: + +- **DPDK Extra Scripts** + + DPAA based resources can be configured easily with the help of ready scripts + as provided in the DPDK Extra repository. + + `DPDK Extras Scripts `_. + +Currently supported by DPDK: + +- NXP SDK **2.0+** (preferred: LSDK 18.09). +- Supported architectures: **arm64 LE**. + +- Follow the DPDK :ref:`Getting Started Guide for Linux ` + to setup the basic DPDK environment. + + diff --git a/doc/guides/platform/index.rst b/doc/guides/platform/index.rst index ca6113d..fc7c6d4 100644 --- a/doc/guides/platform/index.rst +++ b/doc/guides/platform/index.rst @@ -10,4 +10,5 @@ The following are platform specific guides and setup information. :maxdepth: 2 :numbered: + dpaa octeontx