1 .. SPDX-License-Identifier: BSD-3-Clause
7 The DPAA2 CMDIF is an implementation of the rawdev API, that provides
8 communication between the GPP and AIOP (Firmware). This is achieved
9 via using the DPCI devices exposed by MC for GPP <--> AIOP interaction.
11 More information can be found at `NXP Official Website
12 <http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
17 The DPAA2 CMDIF implements following features in the rawdev API;
19 - Getting the object ID of the device (DPCI) using attributes
20 - I/O to and from the AIOP device using DPCI
32 There are three main pre-requisities for executing DPAA2 CMDIF on a DPAA2
35 1. **ARM 64 Tool Chain**
37 For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/6.3-2017.02/aarch64-linux-gnu>`_.
41 It can be obtained from `NXP's Github hosting <https://github.com/qoriq-open-source/linux>`_.
43 3. **Rootfile system**
45 Any *aarch64* supporting filesystem can be used. For example,
46 Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
47 from `here <http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
49 As an alternative method, DPAA2 CMDIF can also be executed using images provided
50 as part of SDK from NXP. The SDK includes all the above prerequisites necessary
51 to bring up a DPAA2 board.
53 The following dependencies are not part of DPDK and must be installed
58 NXP Linux software development kit (SDK) includes support for family
59 of QorIQ® ARM-Architecture-based system on chip (SoC) processors
60 and corresponding boards.
62 It includes the Linux board support packages (BSPs) for NXP SoCs,
63 a fully operational tool chain, kernel and board specific modules.
65 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>`_.
67 - **DPDK Extra Scripts**
69 DPAA2 based resources can be configured easily with the help of ready scripts
70 as provided in the DPDK Extra repository.
72 `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
74 Currently supported by DPDK:
77 - MC Firmware version **10.0.0** and higher.
78 - Supported architectures: **arm64 LE**.
80 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
84 Some part of fslmc bus code (mc flib - object library) routines are
85 dual licensed (BSD & GPLv2).
87 Pre-Installation Configuration
88 ------------------------------
93 The following options can be modified in the ``config`` file.
95 - ``CONFIG_RTE_LIBRTE_PMD_DPAA2_CMDIF_RAWDEV`` (default ``y``)
97 Toggle compilation of the ``lrte_pmd_dpaa2_cmdif`` driver.
102 For enabling logs, use the following EAL parameter:
104 .. code-block:: console
106 ./your_cmdif_application <EAL args> --log-level=pmd.raw.dpaa2.cmdif,<level>
108 Using ``pmd.raw.dpaa2.cmdif`` as log matching criteria, all Event PMD logs can be
109 enabled which are lower than logging ``level``.
114 To compile the DPAA2 CMDIF PMD for Linux arm64 gcc target, run the
115 following ``make`` command:
117 .. code-block:: console
119 cd <DPDK-source-directory>
120 make config T=arm64-dpaa2-linuxapp-gcc install
125 The DPAA2 CMDIF is exposed as a vdev device which consists of dpci devices.
126 On EAL initialization, dpci devices will be probed and then vdev device
127 can be created from the application code by
129 * Invoking ``rte_vdev_init("dpaa2_dpci")`` from the application
131 * Using ``--vdev="dpaa2_dpci"`` in the EAL options, which will call
132 rte_vdev_init() internally
136 .. code-block:: console
138 ./your_cmdif_application <EAL args> --vdev="dpaa2_dpci"
143 DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
144 ``Supported DPAA2 SoCs``.