numam-dpdk/doc/guides/eventdevs/dpaa.rst
Ciara Power 08b1d50543 doc: remove references to make from eventdevs guide
Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Signed-off-by: Ciara Power <ciara.power@intel.com>
Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
2020-10-22 22:54:05 +02:00

80 lines
2.0 KiB
ReStructuredText

.. SPDX-License-Identifier: BSD-3-Clause
Copyright 2017 NXP
NXP DPAA Eventdev Driver
=========================
The dpaa eventdev is an implementation of the eventdev API, that provides a
wide range of the eventdev features. The eventdev relies on a dpaa based
platform to perform event scheduling.
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 DPAA EVENTDEV implements many features in the eventdev API;
- Hardware based event scheduler
- 4 event ports
- 4 event queues
- Parallel flows
- Atomic flows
Supported DPAA SoCs
--------------------
- LS1046A/LS1026A
- LS1043A/LS1023A
Prerequisites
-------------
See :doc:`../platform/dpaa` for setup information
Currently supported by DPDK:
- NXP SDK **2.0+** or LSDK **18.09+**
- Supported architectures: **arm64 LE**.
- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
Initialization
--------------
The dpaa eventdev is exposed as a vdev device which consists of a set of channels
and queues. On EAL initialization, dpaa components will be
probed and then vdev device can be created from the application code by
* Invoking ``rte_vdev_init("event_dpaa1")`` from the application
* Using ``--vdev="event_dpaa1"`` in the EAL options, which will call
rte_vdev_init() internally
Example:
.. code-block:: console
./your_eventdev_application --vdev="event_dpaa1"
* Use dev arg option ``disable_intr=1`` to disable the interrupt mode
Limitations
-----------
1. DPAA eventdev can not work with DPAA PUSH mode queues configured for ethdev.
Please configure export DPAA_NUM_PUSH_QUEUES=0
Platform Requirement
~~~~~~~~~~~~~~~~~~~~
DPAA drivers for DPDK can only work on NXP SoCs as listed in the
``Supported DPAA SoCs``.
Port-core Binding
~~~~~~~~~~~~~~~~~
DPAA EVENTDEV driver requires event port 'x' to be used on core 'x'.