xref: /dpdk/doc/guides/platform/dpaa2.rst (revision f00d0d5fb652504ad6af2ab1a8b146b1cb86fe38)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2018 NXP
3
4NXP QorIQ DPAA2 Board Support Package
5=====================================
6
7This doc has information about steps to setup NXP QoriQ DPAA2 platform
8and information about common offload hw block drivers of
9**NXP QorIQ DPAA2** SoC family.
10
11Supported DPAA2 SoCs
12--------------------
13
14- LX2160A
15- LS2084A/LS2044A
16- LS2088A/LS2048A
17- LS1088A/LS1048A
18
19More information about SoC can be found at `NXP Official Website
20<https://www.nxp.com/products/processors-and-microcontrollers/arm-based-
21processors-and-mcus/qoriq-layerscape-arm-processors:QORIQ-ARM>`_.
22
23
24Common Offload HW Block Drivers
25-------------------------------
26
271. **Nics Driver**
28
29   See :doc:`../nics/dpaa2` for NXP dpaa2 nic driver information.
30
312. **Cryptodev Driver**
32
33   See :doc:`../cryptodevs/dpaa2_sec` for NXP dpaa2 cryptodev driver information.
34
353. **Eventdev Driver**
36
37   See :doc:`../eventdevs/dpaa2` for NXP dpaa2 eventdev driver information.
38
394. **Rawdev AIOP CMDIF Driver**
40
41   See :doc:`../rawdevs/dpaa2_cmdif` for NXP dpaa2 AIOP command interface driver information.
42
435. **Rawdev QDMA Driver**
44
45   See :doc:`../rawdevs/dpaa2_qdma` for NXP dpaa2 QDMA driver information.
46
47
48Steps To Setup Platform
49-----------------------
50
51There are four main pre-requisities for executing DPAA2 PMD on a DPAA2
52compatible board:
53
541. **ARM 64 Tool Chain**
55
56   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>`_.
57
582. **Linux Kernel**
59
60   It can be obtained from `NXP's Github hosting <https://source.codeaurora.org/external/qoriq/qoriq-components/linux>`_.
61
623. **Rootfile system**
63
64   Any *aarch64* supporting filesystem can be used. For example,
65   Ubuntu 16.04 LTS (Xenial) or 18.04 (Bionic) userland which can be obtained
66   from `here
67   <http://cdimage.ubuntu.com/ubuntu-base/releases/18.04/release/ubuntu-base-18.04.1-base-arm64.tar.gz>`_.
68
694. **Resource Scripts**
70
71   DPAA2 based resources can be configured easily with the help of ready scripts
72   as provided in the DPDK Extra repository.
73
74As an alternative method, DPAA2 PMD can also be executed using images provided
75as part of SDK from NXP. The SDK includes all the above prerequisites necessary
76to bring up a DPAA2 board.
77
78The following dependencies are not part of DPDK and must be installed
79separately:
80
81- **NXP Linux SDK**
82
83  NXP Linux software development kit (SDK) includes support for family
84  of QorIQ® ARM-Architecture-based system on chip (SoC) processors
85  and corresponding boards.
86
87  It includes the Linux board support packages (BSPs) for NXP SoCs,
88  a fully operational tool chain, kernel and board specific modules.
89
90  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>`_.
91
92
93.. _extra_scripts:
94
95- **DPDK Extra Scripts**
96
97  DPAA2 based resources can be configured easily with the help of ready scripts
98  as provided in the DPDK Extra repository.
99
100  `DPDK Extras Scripts <https://source.codeaurora.org/external/qoriq/qoriq-components/dpdk-extras>`_.
101
102Currently supported by DPDK:
103
104- NXP SDK **2.0+** (preferred: LSDK 18.09).
105- MC Firmware version **10.10.0** and higher.
106- Supported architectures:  **arm64 LE**.
107
108- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>`
109  to setup the basic DPDK environment.
110