1 .. SPDX-License-Identifier: BSD-3-Clause
4 NXP DPAA Eventdev Driver
5 =========================
7 The dpaa eventdev is an implementation of the eventdev API, that provides a
8 wide range of the eventdev features. The eventdev relies on a dpaa based
9 platform to perform event scheduling.
11 More information can be found at `NXP Official Website
12 <http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
17 The DPAA EVENTDEV implements many features in the eventdev API;
19 - Hardware based event scheduler
34 There are following pre-requisites for executing EVENTDEV on a DPAA compatible
37 1. **ARM 64 Tool Chain**
39 For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/6.4-2017.08/aarch64-linux-gnu/>`_.
43 It can be obtained from `NXP's Github hosting <https://github.com/qoriq-open-source/linux>`_.
45 3. **Rootfile System**
47 Any *aarch64* supporting filesystem can be used. For example,
48 Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
49 from `here <http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
51 As an alternative method, DPAA EVENTDEV can also be executed using images provided
52 as part of SDK from NXP. The SDK includes all the above prerequisites necessary
53 to bring up a DPAA board.
55 The following dependencies are not part of DPDK and must be installed
60 NXP Linux software development kit (SDK) includes support for family
61 of QorIQ® ARM-Architecture-based system on chip (SoC) processors
62 and corresponding boards.
64 It includes the Linux board support packages (BSPs) for NXP SoCs,
65 a fully operational tool chain, kernel and board specific modules.
67 SDK and related information can be obtained from: `NXP QorIQ SDK <http://www.nxp.com/products/software-and-tools/run-time-software/linux-sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_.
69 - **DPDK Extra Scripts**
71 DPAA based resources can be configured easily with the help of ready to use
72 xml files as provided in the DPDK Extra repository.
74 `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
76 Currently supported by DPDK:
78 - NXP SDK **2.0+** or LSDK **17.09+**
79 - Supported architectures: **arm64 LE**.
81 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
83 Pre-Installation Configuration
84 ------------------------------
89 The following options can be modified in the ``config`` file.
90 Please note that enabling debugging options may affect system performance.
92 - ``CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV`` (default ``y``)
94 Toggle compilation of the ``librte_pmd_dpaa_event`` driver.
99 To compile the DPAA EVENTDEV PMD for Linux arm64 gcc target, run the
100 following ``make`` command:
102 .. code-block:: console
104 cd <DPDK-source-directory>
105 make config T=arm64-dpaa-linuxapp-gcc install
110 The dpaa eventdev is exposed as a vdev device which consists of a set of channels
111 and queues. On EAL initialization, dpaa components will be
112 probed and then vdev device can be created from the application code by
114 * Invoking ``rte_vdev_init("event_dpaa1")`` from the application
116 * Using ``--vdev="event_dpaa1"`` in the EAL options, which will call
117 rte_vdev_init() internally
121 .. code-block:: console
123 ./your_eventdev_application --vdev="event_dpaa1"
128 1. DPAA eventdev can not work with DPAA PUSH mode queues configured for ethdev.
129 Please configure export DPAA_NUM_PUSH_QUEUES=0
134 DPAA drivers for DPDK can only work on NXP SoCs as listed in the
135 ``Supported DPAA SoCs``.
140 DPAA EVENTDEV driver requires event port 'x' to be used on core 'x'.