From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from EUR02-HE1-obe.outbound.protection.outlook.com (mail-eopbgr10066.outbound.protection.outlook.com [40.107.1.66]) by dpdk.org (Postfix) with ESMTP id 6B6734CA5 for ; Thu, 30 Aug 2018 09:41:45 +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=RKVNd6peY00+DlHO8KoKWQ3Yujx8mIgQsIRPpPk5ueE=; b=Xnz9cqjZC0TrBg7oY3UfWkh/zMlAUnGbWwj4NQpBFgMuQnllxcH7IPxBuuid5QHu8HOwkj+PGCo+Suhi4w008OPLiVt/oBPaIls/PXJwTTB/sRfmmZy4KUQXw/tC0rpBtT51lfQ3RbHJTCIvQ+s4tpubA6ujT63dJDEcrY1ZyPg= 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:42 +0000 From: Hemant Agrawal To: dev@dpdk.org Cc: shreyansh.jain@nxp.com Date: Thu, 30 Aug 2018 13:09:31 +0530 Message-Id: <1535614772-20886-3-git-send-email-hemant.agrawal@nxp.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1535614772-20886-1-git-send-email-hemant.agrawal@nxp.com> References: <1535614772-20886-1-git-send-email-hemant.agrawal@nxp.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: 39eca2d3-caaf-4395-8e94-08d60e4c0826 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:bwkEklaA+PjPhwBut/e2FLnRp5ZCuD0+Q0Jltk1UclS6sKoSrq/hBYDZoZ0o9TETqgEnbHt/iTefLEMAI7YLoHj7ydiysxVQ+tWzw3iUYZxcigx2eqEk5OfdNVpGRcvxQpFBcI5+z3lFwrt1BXI/FlB+PBBTOn43fYiw04R35n0MYVewgaTiw1QldaLlNWA50ePcVpJxiJCocSkoCSYp37uhOokm/s3WIWgWWHvkyKwtoPMtOTP3ZBb6f0JEIYHp; 25:yj+72zkjgJC/tkjcTS9VfMXHY+9P+mL8eZYSpLefbNxYcffXD7PDSeEPJNVRJ79WsshIJZ8BL/WgZ0fjRN3n6+LgbpC4ic3mR1DirPyokbj8ZDhX/mW7XrhUGpgRAq5Wb4lcM0eIi1SjPKFf2x02Vsb+vt7ysvFcgzsGWp053cRGE6hr9gSMP9j6IoukhjCXpdkWUCk1Zsc9sb1J1iPiCa7StIEDwcYt+q0VWdNpJA3K5bb9AjJUXoP+yN3irGZ1Ovwt5RF8WZfU+VDd0FU8Zycu7pECAFv+Xkp6f0aa/S/3iJQvnCA35DrP3RZzU78WJId6VxTROcmCdqvDEgoBCQ==; 31:wNP/lQS5un5T55R9D+ysgaQjLe3iOIMl9L2oHFWOynddLu7kn3x8I8tz3A3/N4AEv9RPIuYXHyHa1bn4vU1aqNk2RorvbSy6F6eD/kn7rtGpl3L4WHdshfbHkIZA1YSm3Zc08nfGYlb+EIuyMO0xOiAK9q1f8T5NZvtWN8nKpz7H7nVFnUxevqUaUVhyljrGX/PoqsiWlnZ5fyXBeZuYHcvc7pBBWnaBn+iiGa9xBOk= X-MS-TrafficTypeDiagnostic: VI1PR0401MB2544: X-Microsoft-Exchange-Diagnostics: 1; VI1PR0401MB2544; 20:lxFNYPcCd3kcKg3zkuLyiRGsHBtHmIPFQ9d6y5Jo4B7JVPmbihuuWvferF2i5n7dTTD8jEnLCnE7qgxtuWPeCbQCi7csSMOdjXiH1z8rUaoULfPAfeG07IIx0xauxa6fu6e5WgjYF3GOBruaQhgHi3/UftMpAMX1kitT4CS9mAqPFjFgoanVJ4JXw+gV3eojNV6Lv+KDzGMbYxq6AsOYD+RzqOgPPz7mjM2btJZcUhw6r2GFWD3fMK9vw/Zw7XfePnS16eRqAuPjFAKF2qMOSq48NqkUuZNbfpUsWM/bjEnHJNXLwTMYR11SrVwmVIKg8+Bzyx7/EYo4VaNgXQgyi/yoHGCDuW6fo+Q2p162ulCautqOZUCtm3msA8V5btQ5BXVWbSMbFnuBCjvgwOK+cLmQ2+30y0hOgRcBtXlJic0lupv6PSoBpckMoBM1lv/gHJBo+dmlMepCzopCU3/kfq/ypu7j0eUzOl3CGTWziAWOeu2ngRh58EBeVsul1SSm; 4:7uwNi7Qgdw0ewiMXxhZajXuHWIIjjJg+TtD4veVRNHBIV9DSwJPGRxCe2guFz7ji27aaff/7wtiSmsqoWoWi08HT81Etb1ySZ+7f9LRsD67VZrDAQmDrk+6wX2XCEJ3I9y+rU08tMqY9c35CjONZHZ00p2xun4z7F7dkl+bMz8GEQVYZoXHVTu7iO3rretZiGLx88Q9/pd7nC4UEDhvdHejij0e3Jm4DyfviIwHU3Zo29d+U/M/7moGFX1BwKk8+6kGvZQySxD+1HUohSzmeWS/WNQB5Wq2CsC9MAyy7MG2XVTb6MXF1zKnDaYTEmbBCObm3DDrIw/5A+1YW7dUN712bgKX9TNJa3iwo9mT3L0U= 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)(979002)(376002)(366004)(39860400002)(346002)(396003)(136003)(199004)(189003)(4326008)(8936002)(5009440100003)(76176011)(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)(11346002)(476003)(446003)(486006)(110426005)(969003)(989001)(999001)(1009001)(1019001); 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?B?MTtWSTFQUjA0MDFNQjI1NDQ7MjM6L3NyTmxhZ0VUKzVmR2IvSjRtZnlCc0Qz?= =?utf-8?B?SFlxVnJvejZOaTRzamFiNldTcnpLNUFLaXJuOUhrNTJkeDZsdERXTzdIMnlH?= =?utf-8?B?VHZybzdqTC9xN3AvRzBjMWJROEgwdlJKWS94R2dYaEZIRkFXYm9uRXJHdTAw?= =?utf-8?B?YXBlNXNSRktYV2tGbDUwT25kblVybk5mRVlYcmtrT3dYWXRJRUhFVjV5OWN0?= =?utf-8?B?UzdnZ2xkUitxckQ5ZEFWWEVjeC9WOUVUYit5Zi9Rb3lzRDFEUDBCMzNIYWl1?= =?utf-8?B?QlZCZVFXNWFkQXhqUnBxSVZiZm43SFBlUSt1VEpKRnRQWlBwcG9UdHVTK0p5?= =?utf-8?B?UkxFUldlcjE1akZkbnNic1JSNGFSMzZKakJxMzNraktQaks1YkQ1OEsxbFBT?= =?utf-8?B?cTNOenltZVloQ1Bra2dBY3RSQ2RURWtBN3pHVC9MWERScTNWeEY4aDFHb0dM?= =?utf-8?B?TmdxOFRFNXNsTUg1dVprTXpCeGprR1VkZUw5dFErOHFLcDdnSkUyb3pPYjkw?= =?utf-8?B?eE00aTB1eG8yZ0w4V2RLMHdSVHp0ZGhQckgya0FIWmJXS3NhcjVPUEs5cTVN?= =?utf-8?B?RXExelFreGIrRzFuVmRGbzk0U0lGR1ZXSU04amRwRGFEUlVTbUp5UEF6SWFN?= =?utf-8?B?cHN6c3h4NTBjeUZlcENXS2ZvVUZXYjlzSXdMblJac0ZSeXhNUlUrUEUveVJC?= =?utf-8?B?V2VRNXh6MUdYSXprWDM5Y0MyZU9ZWklxZkdscDNscmk3V0J3Vy93WUF5S3do?= =?utf-8?B?eGl1elVPOVRtL0MvcUFIQUs4czJaYk5HTDdIeVZPZEZ4OVppWUZ2V2VHeW9o?= =?utf-8?B?aHpjZlVRLzRwcllPd2dWdmVuRTVqOUtYNFg0cUJKQ1hzU0ZmZ3IyOGIwUWNo?= =?utf-8?B?aWNTTmJyY3lxTTBoeDNjSVk1ei9XNm05WUdKTjBsbTN6VmxBejNTbjhsVDdo?= =?utf-8?B?bGJaMm9HeVJBL2V3QlZSVWhUaTBTWU1xY0RSRGJuSmMraDRSTkdQa04zampO?= =?utf-8?B?eE9lOUVZR0dZSHRNejNKcHQxd1JSWXI2NnBPa0xDaXdxUXZZOVg3Wnh5c0dn?= =?utf-8?B?c084SlFHVkdJRW1WRGJOVm9pVDhWMUNTc0llZllCMFFPcUZIR1JpTnZSTklH?= =?utf-8?B?YmhCK3Z1ck13NEJLMVVhdGpIWnNvL0pvSzJlZ05lTUVDQWJva04yTGMvV0FZ?= =?utf-8?B?Ykx4SThjdkRBYVB3dGZaR25ieWxlS2RGem1mb3JIWWZaSlBhTndUTHZFY0lD?= =?utf-8?B?VVQxWCtjZkUrTS9BVDltVmFYUEF5WG1DLzhXcktpOW1CM0l4bE0xd1pwNGRi?= =?utf-8?B?Umh5dlFxRDhXdlREZGVNSnlMS2pJWHE3eVhDdjYwUnQxNTZjMHJEdS9wOEVI?= =?utf-8?B?cnpYYi9VaGl3MEhOR0V4ZjlJeHJCcXNkbFM1MWdkZUxMZ29CS1doMUxXTzhO?= =?utf-8?B?T2hxZ3kzdGNGL2pxK0VKWkFSa0lzVFVlek1RZVVIdFAyTkU3Y3FpLzJOaCth?= =?utf-8?B?U0pEZjhiYXdqUGJuOEJ1UDJza2JDL2VqTkxrZzRWZmcybW9VM0ljeW1lQlpo?= =?utf-8?B?dVR3N0dUS3pJYVZvRjkxd0cra3k1ZmhzeHFIalVmS3hDcVJNNzhjWk5qbE9N?= =?utf-8?B?cnhKdk1vMDd3VmdmOGFZK2J6ZGFKamQycENzNVNFbVVFczBRanR6QmlWcTVm?= =?utf-8?B?YWR0NHdjYytmeGpra3JVNWgrNzgyUEhDN3l0VjJybGI1QS9ZaFcrV2ZvR20w?= =?utf-8?B?SE1Yb3JCTW9QTnd3YWZobmtzZUNEeGhwY28rSGVueW9ySjM3WVRONVF5UUFo?= =?utf-8?B?NVJZbW43YmpuOXgyU2dBL0prTW9sL2xqM3AzdUdBNmNxdzRhalNGbDhmUEZM?= =?utf-8?Q?1dMYMR9m77bxtAJlKRNLJDf+oVC+J4NJYn?= X-Microsoft-Antispam-Message-Info: Hw+YZ74ljdIQBmL3ZnAqqYrOgzBz0K/JqoTVG9OxHUZkTeITPCZfzL5mUkynz6r8Q/P4i95W7GlUPF6DpKeE2azoWXGUUL0hPeFL5+RSPHXDHcLAgKG/XxOfRoyQED2Ap1ETogAA0QnoJliVD4qAyewOLeJ+VemSP3qSIl+yJ+kmiqzLgxfgW/m1IHoVwPgJi0onSsAjl7puEVQDw5787sgJ9lPoz5h7DBgnsdnK7IoEprvvuPtqfhkgFAumDj/cB7H5+97O5qJJsTU7Q7e0k47iyizMhXR83qwV3zvKKzrY1HUNpMi3aiQT5rcQg2hiC1t6ZDtEMunsdDCs+Rye9rAaM9dHKNO7KOJfJCKu8Dg= X-Microsoft-Exchange-Diagnostics: 1; VI1PR0401MB2544; 6:YpbmP2TiiJZk6zl0VTXs8+s31ERlyyUNW813zcadIu2yw5JCOqpGyPRtD7JN6iFsHNEM09MfB4oKaVViJfPVHckZIHU6zsqcabtq0ynDzoarlWMOwGHhTW3grylR2AlZYFldrxN8Exugrf1EDNKSWtR2Ihai6IFjWP67/a/NgZuUKkC4+UU/uIF/XeWYHLqs8kNMbbOZdAy9lGNb0vQkAT3j1vGxn7ac6wHzLQP8cKaVXYDfvAK56W7YiwIA/6Vwf2e4/2GL1w4i6nM0mI9nNZdhFigj0LO+S9E8SbtspzTKvmi+IxIadqzWAiHu80tKHE0JdeNE8q4BX2ibQZIKrdm4EhkVumhruqQJhjdRXTRugoGGOylCYz/UDy3O6Npk5tLdGFSi3UggUIGaht+W+QdbA7dejxRSmM7yUv13Ug8iTEoZslQCAxIkWPpaitepfPm+TV4njx6+X5RwmNs4gg==; 5:uHLZupaCqbntwTIMCB41ECVXKC12Ctp4MZ03dUxFHwoCBbimz4xP13Lcus8GMQ7MMyHwqLezm2JCbv1C+YTX0j6hLLC2gaWyg/uOGjD7VeefQl9Cgb8JdU2dx0xgY/RxjOOJPKWbec951ZCmJmT6H5MP5hoUoS57abkNqn5ood0=; 7:l+xR7pNOsux/ppUrVDOdVVHGUV260CXplN7nZaKaNXDQWIuUeF+Nkws2ztkFkU5mvSM5i6oN9D1rFxvDIDworJhN8t35mPDAfXJfpeHZVD2PpILaJce+buceTbmB+IuWGjMT2MnRNCffJ9wJn0Ki4kYWhDAdnFu8gmKh1K2I91KQPLpka90tyODtNjfcQ+E4VsVK1XAHQ4987cI0S9OMAimLtek3Cz80c3dPVhbdkpLfpVCJcfT1S+HHQQON6aKH SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Aug 2018 07:41:42.3440 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 39eca2d3-caaf-4395-8e94-08d60e4c0826 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 3/4] doc: create a platorm specific page for NXP DPAA2 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: , X-List-Received-Date: Thu, 30 Aug 2018 07:41:45 -0000 Signed-off-by: Hemant Agrawal --- doc/guides/platform/dpaa2.rst | 100 ++++++++++++++++++++++++++++++++++++++++++ doc/guides/platform/index.rst | 1 + 2 files changed, 101 insertions(+) create mode 100644 doc/guides/platform/dpaa2.rst diff --git a/doc/guides/platform/dpaa2.rst b/doc/guides/platform/dpaa2.rst new file mode 100644 index 0000000..bd9abcf --- /dev/null +++ b/doc/guides/platform/dpaa2.rst @@ -0,0 +1,100 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 NXP + +NXP DPAA2 Board Support Package +=============================== + +This doc has information about steps to setup octeontx platform +and information about common offload hw block drivers of +**NXP QorIQ DPAA2** SoC family. + +Supported DPAA2 SoCs +-------------------- + +- LX2160A +- LS2084A/LS2044A +- LS2088A/LS2048A +- LS1088A/LS1048A + +More information about SoC can be found at `NXP Official Website +`_. + + +Common Offload HW Block Drivers +------------------------------- + +1. **Nics Driver** + See :doc:`../nics/dpaa2` for NXP dpaa2 nic driver information. + +2. **Cryptodev Driver** + See :doc:`../cryptodevs/dpaa2_sec` for NXP dpaa2 cryptodev driver information. + +3. **Eventdev Driver** + See :doc:`../eventdevs/dpaa2` for NXP dpaa2 eventdev driver information. + + +Steps To Setup Platform +----------------------- + +There are four main pre-requisities for executing DPAA2 PMD on a DPAA2 +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. **Resource Scripts** + + DPAA2 based resources can be configured easily with the help of ready scripts + as provided in the DPDK Extra repository. + +As an alternative method, DPAA2 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 DPAA2 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** + + DPAA2 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). +- MC Firmware version **10.9.0** and higher. +- 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 fc7c6d4..98c6638 100644 --- a/doc/guides/platform/index.rst +++ b/doc/guides/platform/index.rst @@ -11,4 +11,5 @@ The following are platform specific guides and setup information. :numbered: dpaa + dpaa2 octeontx -- 2.7.4