doc/guides/eventdevs/dpaa2.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2017 NXP
   3
   4
   5 NXP DPAA2 Eventdev Driver
   6 =========================
   7
   8 The dpaa2 eventdev is an implementation of the eventdev API, that provides a
   9 wide range of the eventdev features. The eventdev relies on a dpaa2 hw to
  10 perform event scheduling.
  11
  12 More 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
  15 Features
  16 --------
  17
  18 The 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
  26 Supported DPAA2 SoCs
  27 --------------------
  28
  29 - LS2080A/LS2040A
  30 - LS2084A/LS2044A
  31 - LS2088A/LS2048A
  32 - LS1088A/LS1048A
  33
  34 Prerequisites
  35 -------------
  36
  37 There are three main pre-requisities for executing DPAA2 EVENTDEV on a DPAA2
  38 compatible board:
  39
  40 1. **ARM 64 Tool Chain**
  41
  42    For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
  43
  44 2. **Linux Kernel**
  45
  46    It can be obtained from `NXP's Github hosting <https://github.com/qoriq-open-source/linux>`_.
  47
  48 3. **Rootfile system**
  49
  50    Any *aarch64* supporting filesystem can be used. For example,
  51    Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
  52    from `here <http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
  53
  54 As an alternative method, DPAA2 EVENTDEV can also be executed using images provided
  55 as part of SDK from NXP. The SDK includes all the above prerequisites necessary
  56 to bring up a DPAA2 board.
  57
  58 The following dependencies are not part of DPDK and must be installed
  59 separately:
  60
  61 - **NXP Linux SDK**
  62
  63   NXP Linux software development kit (SDK) includes support for family
  64   of QorIQ® ARM-Architecture-based system on chip (SoC) processors
  65   and corresponding boards.
  66
  67   It includes the Linux board support packages (BSPs) for NXP SoCs,
  68   a fully operational tool chain, kernel and board specific modules.
  69
  70   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>`_.
  71
  72 - **DPDK Extra Scripts**
  73
  74   DPAA2 based resources can be configured easily with the help of ready scripts
  75   as provided in the DPDK Extra repository.
  76
  77   `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
  78
  79 Currently supported by DPDK:
  80
  81 - NXP SDK **2.0+**.
  82 - MC Firmware version **10.0.0** and higher.
  83 - Supported architectures:  **arm64 LE**.
  84
  85 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  86
  87 .. note::
  88
  89    Some part of fslmc bus code (mc flib - object library) routines are
  90    dual licensed (BSD & GPLv2).
  91
  92 Pre-Installation Configuration
  93 ------------------------------
  94
  95 Config File Options
  96 ~~~~~~~~~~~~~~~~~~~
  97
  98 The following options can be modified in the ``config`` file.
  99 Please note that enabling debugging options may affect system performance.
 100
 101 - ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV`` (default ``y``)
 102
 103   Toggle compilation of the ``lrte_pmd_dpaa2_event`` driver.
 104
 105 - ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV_DEBUG`` (default ``n``)
 106
 107   Toggle display of generic debugging messages
 108
 109 Driver Compilation
 110 ~~~~~~~~~~~~~~~~~~
 111
 112 To compile the DPAA2 EVENTDEV PMD for Linux arm64 gcc target, run the
 113 following ``make`` command:
 114
 115 .. code-block:: console
 116
 117    cd <DPDK-source-directory>
 118    make config T=arm64-dpaa2-linuxapp-gcc install
 119
 120 Initialization
 121 --------------
 122
 123 The dpaa2 eventdev is exposed as a vdev device which consists of a set of dpcon
 124 devices and dpci devices. On EAL initialization, dpcon and dpci devices will be
 125 probed and then vdev device can be created from the application code by
 126
 127 * Invoking ``rte_vdev_init("event_dpaa2")`` from the application
 128
 129 * Using ``--vdev="event_dpaa2"`` in the EAL options, which will call
 130   rte_vdev_init() internally
 131
 132 Example:
 133
 134 .. code-block:: console
 135
 136     ./your_eventdev_application --vdev="event_dpaa2"
 137
 138 Limitations
 139 -----------
 140
 141 Platform Requirement
 142 ~~~~~~~~~~~~~~~~~~~~
 143
 144 DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
 145 ``Supported DPAA2 SoCs``.
 146
 147 Port-core binding
 148 ~~~~~~~~~~~~~~~~~
 149
 150 DPAA2 EVENTDEV driver requires event port 'x' to be used on core 'x'.