From: Hemant Agrawal Date: Wed, 26 Sep 2018 07:42:29 +0000 (+0530) Subject: doc: create NXP DPAA platform guide X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=ceccf8dc7c3d7797e380f12b45cd3ea1d7396b58;p=dpdk.git doc: create NXP DPAA platform guide Signed-off-by: Hemant Agrawal Acked-by: Marko Kovacevic --- diff --git a/doc/guides/cryptodevs/dpaa_sec.rst b/doc/guides/cryptodevs/dpaa_sec.rst index dd683894f8..897a4fe809 100644 --- a/doc/guides/cryptodevs/dpaa_sec.rst +++ b/doc/guides/cryptodevs/dpaa_sec.rst @@ -101,32 +101,11 @@ Prerequisites ------------- DPAA_SEC driver has similar pre-requisites as described in :ref:`dpaa_overview`. -The following dependencies are not part of DPDK and must be installed separately: -* **NXP Linux SDK** +See :doc:`../platform/dpaa` for setup information - NXP Linux software development kit (SDK) includes support for the 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 `_. - -* **DPDK Extras Scripts** - - DPAA based resources can be configured easily with the help of ready scripts - as provided in the DPDK Extras repository. - - `DPDK Extras Scripts `_. - -Currently supported by DPDK: - -* NXP SDK **2.0+**. -* Supported architectures: **arm64 LE**. - -* Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. +- Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. Pre-Installation Configuration ------------------------------ diff --git a/doc/guides/eventdevs/dpaa.rst b/doc/guides/eventdevs/dpaa.rst index 2f356d3cef..cfc40347a5 100644 --- a/doc/guides/eventdevs/dpaa.rst +++ b/doc/guides/eventdevs/dpaa.rst @@ -25,57 +25,17 @@ The DPAA EVENTDEV implements many features in the eventdev API; Supported DPAA SoCs -------------------- -- LS1046A -- LS1043A +- LS1046A/LS1026A +- LS1043A/LS1023A Prerequisites ------------- -There are following pre-requisites for executing EVENTDEV on a DPAA compatible -platform: - -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 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained - from `here `_. - -As an alternative method, DPAA EVENTDEV 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 `_. - -- **DPDK Extra Scripts** - - DPAA based resources can be configured easily with the help of ready to use - xml files as provided in the DPDK Extra repository. - - `DPDK Extras Scripts `_. +See :doc:`../platform/dpaa` for setup information Currently supported by DPDK: -- NXP SDK **2.0+** or LSDK **17.09+** +- NXP SDK **2.0+** or 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/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index 620c045df7..2173673b95 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -181,65 +181,8 @@ Supported DPAA SoCs Prerequisites ------------- -There are three main pre-requisities for executing DPAA PMD on a DPAA -compatible board: +See :doc:`../platform/dpaa` for setup information -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 15.10 (Wily) or 16.04 LTS (Xenial) 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+**. -- 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/dpaa.rst b/doc/guides/platform/dpaa.rst new file mode 100644 index 0000000000..3904871522 --- /dev/null +++ b/doc/guides/platform/dpaa.rst @@ -0,0 +1,103 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 NXP + +NXP QorIQ DPAA Board Support Package +==================================== + +This doc has information about steps to setup QorIq dpaa +based layerscape 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 ca6113d63d..fc7c6d4ca8 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