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