doc/guides/rawdevs/dpaa2_cmdif.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 NXP
   3
   4 NXP DPAA2 CMDIF Driver
   5 ======================
   6
   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.
  10
  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>`_.
  13
  14 Features
  15 --------
  16
  17 The DPAA2 CMDIF implements following features in the rawdev API;
  18
  19 - Getting the object ID of the device (DPCI) using attributes
  20 - I/O to and from the AIOP device using DPCI
  21
  22 Supported DPAA2 SoCs
  23 --------------------
  24
  25 - LS2084A/LS2044A
  26 - LS2088A/LS2048A
  27 - LS1088A/LS1048A
  28
  29 Prerequisites
  30 -------------
  31
  32 See :doc:`../platform/dpaa2` for setup information
  33
  34 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  35
  36 .. note::
  37
  38    Some part of fslmc bus code (mc flib - object library) routines are
  39    dual licensed (BSD & GPLv2).
  40
  41
  42 Enabling logs
  43 -------------
  44
  45 For enabling logs, use the following EAL parameter:
  46
  47 .. code-block:: console
  48
  49    ./your_cmdif_application <EAL args> --log-level=pmd.raw.dpaa2.cmdif,<level>
  50
  51 Using ``pmd.raw.dpaa2.cmdif`` as log matching criteria, all Event PMD logs can be
  52 enabled which are lower than logging ``level``.
  53
  54
  55 Initialization
  56 --------------
  57
  58 The DPAA2 CMDIF is exposed as a vdev device which consists of dpci devices.
  59 On EAL initialization, dpci devices will be probed and then vdev device
  60 can be created from the application code by
  61
  62 * Invoking ``rte_vdev_init("dpaa2_dpci")`` from the application
  63
  64 * Using ``--vdev="dpaa2_dpci"`` in the EAL options, which will call
  65   rte_vdev_init() internally
  66
  67 Example:
  68
  69 .. code-block:: console
  70
  71     ./your_cmdif_application <EAL args> --vdev="dpaa2_dpci"
  72
  73 Platform Requirement
  74 ~~~~~~~~~~~~~~~~~~~~
  75
  76 DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
  77 ``Supported DPAA2 SoCs``.