xref: /dpdk/doc/guides/eventdevs/dpaa.rst (revision 443b949e17953a1094f80532d600a1ee540f2ba4)
1.. SPDX-License-Identifier:        BSD-3-Clause
2   Copyright 2017 NXP
3
4NXP DPAA Eventdev Driver
5=========================
6
7The dpaa eventdev is an implementation of the eventdev API, that provides a
8wide range of the eventdev features. The eventdev relies on a dpaa based
9platform to perform event scheduling.
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 DPAA EVENTDEV implements many features in the eventdev API;
18
19- Hardware based event scheduler
20- 4 event ports
21- 4 event queues
22- Parallel flows
23- Atomic flows
24
25Supported DPAA SoCs
26--------------------
27
28- LS1046A/LS1026A
29- LS1043A/LS1023A
30
31Prerequisites
32-------------
33
34See :doc:`../platform/dpaa` for setup information
35
36Currently supported by DPDK:
37
38- NXP SDK **2.0+** or LSDK **18.09+**
39- Supported architectures:  **arm64 LE**.
40
41- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
42
43
44Initialization
45--------------
46
47The dpaa eventdev is exposed as a vdev device which consists of a set of channels
48and queues. On EAL initialization, dpaa components will be
49probed and then vdev device can be created from the application code by
50
51* Invoking ``rte_vdev_init("event_dpaa1")`` from the application
52
53* Using ``--vdev="event_dpaa1"`` in the EAL options, which will call
54  rte_vdev_init() internally
55
56Example:
57
58.. code-block:: console
59
60    ./your_eventdev_application --vdev="event_dpaa1"
61
62* Use dev arg option ``disable_intr=1`` to disable the interrupt mode
63
64Limitations
65-----------
66
67#. DPAA eventdev can not work with DPAA PUSH mode queues configured for ethdev.
68   Please configure export DPAA_NUM_PUSH_QUEUES=0
69
70Platform Requirement
71~~~~~~~~~~~~~~~~~~~~
72
73DPAA drivers for DPDK can only work on NXP SoCs as listed in the
74``Supported DPAA SoCs``.
75
76Port-core Binding
77~~~~~~~~~~~~~~~~~
78
79DPAA EVENTDEV driver requires event port 'x' to be used on core 'x'.
80