doc/guides/dmadevs/dpaa2.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018-2022 NXP
   3
   4 NXP DPAA2 QDMA Driver
   5 =====================
   6
   7 The DPAA2 QDMA is an implementation of the dmadev API, that provide means
   8 to initiate a DMA transaction from CPU. The initiated DMA is performed
   9 without CPU being involved in the actual DMA transaction. This is achieved
  10 via using the DPDMAI device exposed by MC.
  11
  12 More information can be found at `NXP Official Website
  13 <http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
  14
  15 Supported DPAA2 SoCs
  16 --------------------
  17
  18 - LX2160A
  19 - LS2084A/LS2044A
  20 - LS2088A/LS2048A
  21 - LS1088A/LS1048A
  22
  23 Prerequisites
  24 -------------
  25
  26 See :doc:`../platform/dpaa2` for setup information
  27
  28 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  29
  30 .. note::
  31
  32    Some part of fslmc bus code (mc flib - object library) routines are
  33    dual licensed (BSD & GPLv2).
  34
  35
  36 Enabling logs
  37 -------------
  38
  39 For enabling logs, use the following EAL parameter:
  40
  41 .. code-block:: console
  42
  43    ./your_qdma_application <EAL args> --log-level=pmd.dma.dpaa2.qdma,<level>
  44
  45 Using ``pmd.dma.dpaa2.qdma`` as log matching criteria, all Event PMD logs can be
  46 enabled which are lower than logging ``level``.
  47
  48
  49 Initialization
  50 --------------
  51
  52 The DPAA2 QDMA is exposed as a dma device which consists of dpdmai devices.
  53 On EAL initialization, dpdmai devices will be probed and populated into the
  54 dmadevices. The dmadev ID of the device can be obtained using
  55
  56 * Invoking ``rte_dma_get_dev_id_by_name("dpdmai.x")`` from the application
  57   where x is the object ID of the DPDMAI object created by MC. Use can
  58   use this index for further rawdev function calls.
  59
  60 Platform Requirement
  61 ~~~~~~~~~~~~~~~~~~~~
  62
  63 DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
  64 ``Supported DPAA2 SoCs``.