1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright 2018 NXP 3 4NXP QorIQ DPAA Board Support Package 5==================================== 6 7This doc has information about steps to setup QorIQ dpaa 8based layerscape platform and information about common offload 9hw block drivers of **NXP QorIQ DPAA** SoC family. 10 11Supported DPAA SoCs 12-------------------- 13 14* LS1046A/LS1026A 15* LS1043A/LS1023A 16 17More information about SoC can be found at `NXP Official Website 18<https://www.nxp.com/products/processors-and-microcontrollers/arm-based- 19processors-and-mcus/qoriq-layerscape-arm-processors:QORIQ-ARM>`_. 20 21 22Common Offload HW Block Drivers 23------------------------------- 24 25#. **Nics Driver** 26 27 See :doc:`../nics/dpaa` for NXP dpaa nic driver information. 28 29#. **Cryptodev Driver** 30 31 See :doc:`../cryptodevs/dpaa_sec` for NXP dpaa cryptodev driver information. 32 33#. **Eventdev Driver** 34 35 See :doc:`../eventdevs/dpaa` for NXP dpaa eventdev driver information. 36 37 38Steps To Setup Platform 39----------------------- 40 41There are four main pre-requisites for executing DPAA PMD on a DPAA 42compatible board: 43 44#. **ARM 64 Tool Chain** 45 46 For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/7.3-2018.05/aarch64-linux-gnu/gcc-linaro-7.3.1-2018.05-i686_aarch64-linux-gnu.tar.xz>`_. 47 48#. **Linux Kernel** 49 50 It can be obtained from `NXP's Github hosting <https://source.codeaurora.org/external/qoriq/qoriq-components/linux>`_. 51 52#. **Rootfile system** 53 54 Any *aarch64* supporting filesystem can be used. For example, 55 Ubuntu 16.04 LTS (Xenial) or 18.04 (Bionic) userland which can be obtained 56 from `here 57 <http://cdimage.ubuntu.com/ubuntu-base/releases/18.04/release/ubuntu-base-18.04.1-base-arm64.tar.gz>`_. 58 59#. **FMC Tool** 60 61 If one is planning to use more than 1 Recv queue and hardware capability to 62 parse, classify and distribute the packets, the Frame Manager Configuration 63 Tool (FMC) need to be executed to set the configurations of the queues before 64 running the DPAA based DPDK application. This setting is persistent, the 65 configuration will remain in the hardware till it is re-configured. This 66 includes the queue state, RSS and other policies. 67 This tool can be obtained from `NXP (Freescale) Public Git Repository <https://source.codeaurora.org/external/qoriq/qoriq-components/fmc>`_. 68 69 This tool needs configuration files which are available in the 70 :ref:`DPDK Extra Scripts <extra_scripts>`, described below for DPDK usages. 71 72 Note that DPAA PMD can also be executed using images provided 73 as part of SDK from NXP. The SDK includes all the above prerequisites 74 necessary (i.e. fmc tool) to bring up a DPAA board. 75 76 As an alternate method, DPAA PMDs starting from DPDK 20.11 also support the 77 fmlib library integration. The driver will detect about any existing FMC 78 based config (if /tmp/fmc.bin is present). DPAA FMD will be used only if no 79 previous fmc config is existing. 80 81 Note that fmlib based integration rely on underlying fmd driver in kernel, 82 which is available as part of NXP kernel or NXP SDK. 83 84The following dependencies are not part of DPDK and must be installed 85separately: 86 87- **NXP Linux SDK** 88 89 NXP Linux software development kit (SDK) includes support for family 90 of QorIQ® ARM-Architecture-based system on chip (SoC) processors 91 and corresponding boards. 92 93 It includes the Linux board support packages (BSPs) for NXP SoCs, 94 a fully operational tool chain, kernel and board specific modules. 95 96 SDK and related information can be obtained from: `NXP QorIQ SDK <http://www.nxp.com/products/software-and-tools/run-time-software/linux-sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_. 97 98 99.. _extra_scripts: 100 101- **DPDK Extra Scripts** 102 103 DPAA based resources can be configured easily with the help of ready scripts 104 as provided in the DPDK Extra repository. 105 106 `DPDK Extras Scripts <https://source.codeaurora.org/external/qoriq/qoriq-components/dpdk-extras>`_. 107 108Currently supported by DPDK: 109 110- NXP SDK **2.0+** (preferred: LSDK 18.09). 111- Supported architectures: **arm64 LE**. 112 113- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` 114 to setup the basic DPDK environment. 115