218c4e68c1
Rather than using linuxapp and bsdapp everywhere, we can change things to use the, more readable, terms "linux" and "freebsd" in our build configs. Rather than renaming the configs we can just duplicate the existing ones with the new names using symlinks, and use the new names exclusively internally. ["make showconfigs" also only shows the new names to keep the list short] The result is that backward compatibility is kept fully but any new builds or development can be done using the newer names, i.e. both "make config T=x86_64-native-linuxapp-gcc" and "T=x86_64-native-linux-gcc" work. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
105 lines
2.6 KiB
ReStructuredText
105 lines
2.6 KiB
ReStructuredText
.. SPDX-License-Identifier: BSD-3-Clause
|
|
Copyright 2018 NXP
|
|
|
|
NXP DPAA2 CMDIF Driver
|
|
======================
|
|
|
|
The DPAA2 CMDIF is an implementation of the rawdev API, that provides
|
|
communication between the GPP and AIOP (Firmware). This is achieved
|
|
via using the DPCI devices exposed by MC for GPP <--> AIOP interaction.
|
|
|
|
More information can be found at `NXP Official Website
|
|
<http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
|
|
|
|
Features
|
|
--------
|
|
|
|
The DPAA2 CMDIF implements following features in the rawdev API;
|
|
|
|
- Getting the object ID of the device (DPCI) using attributes
|
|
- I/O to and from the AIOP device using DPCI
|
|
|
|
Supported DPAA2 SoCs
|
|
--------------------
|
|
|
|
- LS2084A/LS2044A
|
|
- LS2088A/LS2048A
|
|
- LS1088A/LS1048A
|
|
|
|
Prerequisites
|
|
-------------
|
|
|
|
See :doc:`../platform/dpaa2` for setup information
|
|
|
|
Currently supported by DPDK:
|
|
|
|
- NXP SDK **18.09+**.
|
|
- MC Firmware version **10.10.0** and higher.
|
|
- Supported architectures: **arm64 LE**.
|
|
|
|
- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
|
|
|
|
.. note::
|
|
|
|
Some part of fslmc bus code (mc flib - object library) routines are
|
|
dual licensed (BSD & GPLv2).
|
|
|
|
Pre-Installation Configuration
|
|
------------------------------
|
|
|
|
Config File Options
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
The following options can be modified in the ``config`` file.
|
|
|
|
- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_CMDIF_RAWDEV`` (default ``y``)
|
|
|
|
Toggle compilation of the ``lrte_pmd_dpaa2_cmdif`` driver.
|
|
|
|
Enabling logs
|
|
-------------
|
|
|
|
For enabling logs, use the following EAL parameter:
|
|
|
|
.. code-block:: console
|
|
|
|
./your_cmdif_application <EAL args> --log-level=pmd.raw.dpaa2.cmdif,<level>
|
|
|
|
Using ``pmd.raw.dpaa2.cmdif`` as log matching criteria, all Event PMD logs can be
|
|
enabled which are lower than logging ``level``.
|
|
|
|
Driver Compilation
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
To compile the DPAA2 CMDIF PMD for Linux arm64 gcc target, run the
|
|
following ``make`` command:
|
|
|
|
.. code-block:: console
|
|
|
|
cd <DPDK-source-directory>
|
|
make config T=arm64-dpaa2-linux-gcc install
|
|
|
|
Initialization
|
|
--------------
|
|
|
|
The DPAA2 CMDIF is exposed as a vdev device which consists of dpci devices.
|
|
On EAL initialization, dpci devices will be probed and then vdev device
|
|
can be created from the application code by
|
|
|
|
* Invoking ``rte_vdev_init("dpaa2_dpci")`` from the application
|
|
|
|
* Using ``--vdev="dpaa2_dpci"`` in the EAL options, which will call
|
|
rte_vdev_init() internally
|
|
|
|
Example:
|
|
|
|
.. code-block:: console
|
|
|
|
./your_cmdif_application <EAL args> --vdev="dpaa2_dpci"
|
|
|
|
Platform Requirement
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
|
|
``Supported DPAA2 SoCs``.
|