xref: /dpdk/doc/guides/eventdevs/dpaa2.rst (revision f00d0d5fb652504ad6af2ab1a8b146b1cb86fe38)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2017 NXP
3
4
5NXP DPAA2 Eventdev Driver
6=========================
7
8The dpaa2 eventdev is an implementation of the eventdev API, that provides a
9wide range of the eventdev features. The eventdev relies on a dpaa2 hw to
10perform event scheduling.
11
12More information can be found at `NXP Official Website
13<http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
14
15Features
16--------
17
18The DPAA2 EVENTDEV implements many features in the eventdev API;
19
20- Hardware based event scheduler
21- 8 event ports
22- 8 event queues
23- Parallel flows
24- Atomic flows
25
26Supported DPAA2 SoCs
27--------------------
28
29- LX2160A
30- LS2084A/LS2044A
31- LS2088A/LS2048A
32- LS1088A/LS1048A
33
34Prerequisites
35-------------
36
37See :doc:`../platform/dpaa2` for setup information
38
39Currently supported by DPDK:
40
41- NXP SDK **18.09+**.
42- MC Firmware version **10.10.0** and higher.
43- Supported architectures:  **arm64 LE**.
44
45- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
46
47.. note::
48
49   Some part of fslmc bus code (mc flib - object library) routines are
50   dual licensed (BSD & GPLv2).
51
52Pre-Installation Configuration
53------------------------------
54
55Config File Options
56~~~~~~~~~~~~~~~~~~~
57
58The following options can be modified in the ``config`` file.
59Please note that enabling debugging options may affect system performance.
60
61- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV`` (default ``y``)
62
63  Toggle compilation of the ``lrte_pmd_dpaa2_event`` driver.
64
65Driver Compilation
66~~~~~~~~~~~~~~~~~~
67
68To compile the DPAA2 EVENTDEV PMD for Linux arm64 gcc target, run the
69following ``make`` command:
70
71.. code-block:: console
72
73   cd <DPDK-source-directory>
74   make config T=arm64-dpaa2-linuxapp-gcc install
75
76Initialization
77--------------
78
79The dpaa2 eventdev is exposed as a vdev device which consists of a set of dpcon
80devices and dpci devices. On EAL initialization, dpcon and dpci devices will be
81probed and then vdev device can be created from the application code by
82
83* Invoking ``rte_vdev_init("event_dpaa2")`` from the application
84
85* Using ``--vdev="event_dpaa2"`` in the EAL options, which will call
86  rte_vdev_init() internally
87
88Example:
89
90.. code-block:: console
91
92   ./your_eventdev_application --vdev="event_dpaa2"
93
94Enabling logs
95-------------
96
97For enabling logs, use the following EAL parameter:
98
99.. code-block:: console
100
101   ./your_eventdev_application <EAL args> --log-level=pmd.event.dpaa2,<level>
102
103Using ``eventdev.dpaa2`` as log matching criteria, all Event PMD logs can be
104enabled which are lower than logging ``level``.
105
106Limitations
107-----------
108
109Platform Requirement
110~~~~~~~~~~~~~~~~~~~~
111
112DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
113``Supported DPAA2 SoCs``.
114
115Port-core binding
116~~~~~~~~~~~~~~~~~
117
118DPAA2 EVENTDEV can support only one eventport per core.
119