xref: /dpdk/doc/guides/eventdevs/dpaa2.rst (revision 29c875cc11ac0d79e35c2b8685b8fe8ecda58731)
1131a75b6SHemant Agrawal..  SPDX-License-Identifier: BSD-3-Clause
2131a75b6SHemant Agrawal    Copyright 2017 NXP
3deda99c7SNipun Gupta
4deda99c7SNipun Gupta
5deda99c7SNipun GuptaNXP DPAA2 Eventdev Driver
6deda99c7SNipun Gupta=========================
7deda99c7SNipun Gupta
8deda99c7SNipun GuptaThe dpaa2 eventdev is an implementation of the eventdev API, that provides a
9deda99c7SNipun Guptawide range of the eventdev features. The eventdev relies on a dpaa2 hw to
10deda99c7SNipun Guptaperform event scheduling.
11deda99c7SNipun Gupta
12deda99c7SNipun GuptaMore information can be found at `NXP Official Website
13deda99c7SNipun Gupta<http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
14deda99c7SNipun Gupta
15deda99c7SNipun GuptaFeatures
16deda99c7SNipun Gupta--------
17deda99c7SNipun Gupta
18deda99c7SNipun GuptaThe DPAA2 EVENTDEV implements many features in the eventdev API;
19deda99c7SNipun Gupta
20deda99c7SNipun Gupta- Hardware based event scheduler
21deda99c7SNipun Gupta- 8 event ports
22deda99c7SNipun Gupta- 8 event queues
23deda99c7SNipun Gupta- Parallel flows
24deda99c7SNipun Gupta- Atomic flows
25deda99c7SNipun Gupta
26deda99c7SNipun GuptaSupported DPAA2 SoCs
27deda99c7SNipun Gupta--------------------
28deda99c7SNipun Gupta
29*b84c1087SHemant Agrawal- LX2160A
30deda99c7SNipun Gupta- LS2084A/LS2044A
31deda99c7SNipun Gupta- LS2088A/LS2048A
32deda99c7SNipun Gupta- LS1088A/LS1048A
33deda99c7SNipun Gupta
34deda99c7SNipun GuptaPrerequisites
35deda99c7SNipun Gupta-------------
36deda99c7SNipun Gupta
37*b84c1087SHemant AgrawalSee :doc:`../platform/dpaa2` for setup information
38deda99c7SNipun Gupta
39deda99c7SNipun Gupta- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
40deda99c7SNipun Gupta
41deda99c7SNipun Gupta.. note::
42deda99c7SNipun Gupta
43deda99c7SNipun Gupta   Some part of fslmc bus code (mc flib - object library) routines are
44deda99c7SNipun Gupta   dual licensed (BSD & GPLv2).
45deda99c7SNipun Gupta
46deda99c7SNipun Gupta
47deda99c7SNipun GuptaInitialization
48deda99c7SNipun Gupta--------------
49deda99c7SNipun Gupta
50deda99c7SNipun GuptaThe dpaa2 eventdev is exposed as a vdev device which consists of a set of dpcon
51deda99c7SNipun Guptadevices and dpci devices. On EAL initialization, dpcon and dpci devices will be
52deda99c7SNipun Guptaprobed and then vdev device can be created from the application code by
53deda99c7SNipun Gupta
54deda99c7SNipun Gupta* Invoking ``rte_vdev_init("event_dpaa2")`` from the application
55deda99c7SNipun Gupta
56deda99c7SNipun Gupta* Using ``--vdev="event_dpaa2"`` in the EAL options, which will call
57deda99c7SNipun Gupta  rte_vdev_init() internally
58deda99c7SNipun Gupta
59deda99c7SNipun GuptaExample:
60deda99c7SNipun Gupta
61deda99c7SNipun Gupta.. code-block:: console
62deda99c7SNipun Gupta
63deda99c7SNipun Gupta   ./your_eventdev_application --vdev="event_dpaa2"
64358309f3SShreyansh Jain
65358309f3SShreyansh JainEnabling logs
66358309f3SShreyansh Jain-------------
67358309f3SShreyansh Jain
68358309f3SShreyansh JainFor enabling logs, use the following EAL parameter:
69358309f3SShreyansh Jain
70358309f3SShreyansh Jain.. code-block:: console
71358309f3SShreyansh Jain
72358309f3SShreyansh Jain   ./your_eventdev_application <EAL args> --log-level=pmd.event.dpaa2,<level>
73358309f3SShreyansh Jain
74358309f3SShreyansh JainUsing ``eventdev.dpaa2`` as log matching criteria, all Event PMD logs can be
75358309f3SShreyansh Jainenabled which are lower than logging ``level``.
76deda99c7SNipun Gupta
77deda99c7SNipun GuptaLimitations
78deda99c7SNipun Gupta-----------
79deda99c7SNipun Gupta
80deda99c7SNipun GuptaPlatform Requirement
81deda99c7SNipun Gupta~~~~~~~~~~~~~~~~~~~~
82deda99c7SNipun Gupta
83deda99c7SNipun GuptaDPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
84deda99c7SNipun Gupta``Supported DPAA2 SoCs``.
85deda99c7SNipun Gupta
86deda99c7SNipun GuptaPort-core binding
87deda99c7SNipun Gupta~~~~~~~~~~~~~~~~~
88deda99c7SNipun Gupta
89*b84c1087SHemant AgrawalDPAA2 EVENTDEV can support only one eventport per core.
90