Signed-off-by: Nipun Gupta <nipun.gu...@nxp.com>
MAINTAINERS | 1 +
doc/guides/rawdevs/dpaa2_qdma.rst | 140 ++++++++++++++++++++++++++++++++++++++
2 files changed, 141 insertions(+)
create mode 100644 doc/guides/rawdevs/dpaa2_qdma.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index fccf5bb..6eb6d98 100644
@@ -775,6 +775,7 @@ F: doc/guides/eventdevs/opdl.rst
M: Nipun Gupta <nipun.gu...@nxp.com>
diff --git a/doc/guides/rawdevs/dpaa2_qdma.rst
new file mode 100644
@@ -0,0 +1,140 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright 2018 NXP
+NXP DPAA2 QDMA Driver
+The DPAA2 QDMA is an implementation of the rawdev API, that provide means
+to initiate a DMA transaction from CPU. The initiated DMA is performed
+without CPU being involved in the actual DMA transaction. This is achieved
+via using the DPDMAI device exposed by MC.
+More information can be found at `NXP Official Website
+The DPAA2 QDMA implements following features in the rawdev API;
+- Supports issuing DMA of data within memory without hogging CPU while
+ performing DMA operation.
+- Supports configuring to optionally get status of the DMA translation on
+ per DMA operation basis.
+Supported DPAA2 SoCs
+There are three main pre-requisities for executing DPAA2 QDMA on a DPAA2
+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, DPAA2 QDMA 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 DPAA2 board.
+The following dependencies are not part of DPDK and must be installed
+- **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**
+ DPAA2 based resources can be configured easily with the help of ready scripts
+ as provided in the DPDK Extra repository.
+ `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
+Currently supported by DPDK:
+- NXP SDK **2.0+**.
+- MC Firmware version **10.0.0** and higher.
+- Supported architectures: **arm64 LE**.
+- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
the basic DPDK environment.
+ Some part of fslmc bus code (mc flib - object library) routines are
+ dual licensed (BSD & GPLv2).
+Config File Options
+The following options can be modified in the ``config`` file.
+- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_QDMA`` (default ``y``)
+ Toggle compilation of the ``lrte_pmd_dpaa2_qdma`` driver.
+For enabling logs, use the following EAL parameter:
+.. code-block:: console
+ ./your_qdma_application <EAL args> --log-level=pmd.dpaa2.qdma,<level>
+Using ``dpaa2.qdma`` as log matching criteria, all Event PMD logs can be
+enabled which are lower than logging ``level``.
+To compile the DPAA2 QDMA PMD for Linux arm64 gcc target, run the
+following ``make`` command:
+.. code-block:: console
+ cd <DPDK-source-directory>
+ make config T=arm64-dpaa2-linuxapp-gcc install
+The DPAA2 QDMA is exposed as a vdev device which consists of dpdmai devices.
+On EAL initialization, dpdmai devices will be probed and populated into the
+rawdevices. The rawdev ID of the device can be obtained using
+* Invoking ``rte_rawdev_get_dev_id("dpdmai.x")`` from the application
+ where x is the object ID of the DPDMAI object created by MC. Use can
+ use this index for further rawdev function calls.
+DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
+``Supported DPAA2 SoCs``.