doc/guides/platform/dpaa.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 NXP
   3
   4 NXP QorIQ DPAA Board Support Package
   5 ====================================
   6
   7 This doc has information about steps to setup QorIQ dpaa
   8 based layerscape platform and information about common offload
   9 hw block drivers of **NXP QorIQ DPAA** SoC family.
  10
  11 Supported DPAA SoCs
  12 --------------------
  13
  14 * LS1046A/LS1026A
  15 * LS1043A/LS1023A
  16
  17 More information about SoC can be found at `NXP Official Website
  18 <https://www.nxp.com/products/processors-and-microcontrollers/arm-based-
  19 processors-and-mcus/qoriq-layerscape-arm-processors:QORIQ-ARM>`_.
  20
  21
  22 Common Offload HW Block Drivers
  23 -------------------------------
  24
  25 1. **Nics Driver**
  26
  27    See :doc:`../nics/dpaa` for NXP dpaa nic driver information.
  28
  29 2. **Cryptodev Driver**
  30
  31    See :doc:`../cryptodevs/dpaa_sec` for NXP dpaa cryptodev driver information.
  32
  33 3. **Eventdev Driver**
  34
  35    See :doc:`../eventdevs/dpaa` for NXP dpaa eventdev driver information.
  36
  37
  38 Steps To Setup Platform
  39 -----------------------
  40
  41 There are four main pre-requisites for executing DPAA PMD on a DPAA
  42 compatible board:
  43
  44 1. **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 2. **Linux Kernel**
  49
  50    It can be obtained from `NXP's Github hosting <https://source.codeaurora.org/external/qoriq/qoriq-components/linux>`_.
  51
  52 3. **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 4. **FMC Tool**
  60
  61    Before any DPDK application can be executed, the Frame Manager Configuration
  62    Tool (FMC) need to be executed to set the configurations of the queues. This
  63    includes the queue state, RSS and other policies.
  64    This tool can be obtained from `NXP (Freescale) Public Git Repository <https://source.codeaurora.org/external/qoriq/qoriq-components/fmc>`_.
  65
  66    This tool needs configuration files which are available in the
  67    :ref:`DPDK Extra Scripts <extra_scripts>`, described below for DPDK usages.
  68
  69 As an alternative method, DPAA PMD can also be executed using images provided
  70 as part of SDK from NXP. The SDK includes all the above prerequisites necessary
  71 to bring up a DPAA board.
  72
  73 The following dependencies are not part of DPDK and must be installed
  74 separately:
  75
  76 - **NXP Linux SDK**
  77
  78   NXP Linux software development kit (SDK) includes support for family
  79   of QorIQ® ARM-Architecture-based system on chip (SoC) processors
  80   and corresponding boards.
  81
  82   It includes the Linux board support packages (BSPs) for NXP SoCs,
  83   a fully operational tool chain, kernel and board specific modules.
  84
  85   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>`_.
  86
  87
  88 .. _extra_scripts:
  89
  90 - **DPDK Extra Scripts**
  91
  92   DPAA based resources can be configured easily with the help of ready scripts
  93   as provided in the DPDK Extra repository.
  94
  95   `DPDK Extras Scripts <https://source.codeaurora.org/external/qoriq/qoriq-components/dpdk-extras>`_.
  96
  97 Currently supported by DPDK:
  98
  99 - NXP SDK **2.0+** (preferred: LSDK 18.09).
 100 - Supported architectures:  **arm64 LE**.
 101
 102 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>`
 103   to setup the basic DPDK environment.