doc/guides/eventdevs/dpaa2.rst

   1 ..  BSD LICENSE
   2     Copyright 2017 NXP.
   3
   4     Redistribution and use in source and binary forms, with or without
   5     modification, are permitted provided that the following conditions
   6     are met:
   7
   8     * Redistributions of source code must retain the above copyright
   9     notice, this list of conditions and the following disclaimer.
  10     * Redistributions in binary form must reproduce the above copyright
  11     notice, this list of conditions and the following disclaimer in
  12     the documentation and/or other materials provided with the
  13     distribution.
  14     * Neither the name of NXP nor the names of its
  15     contributors may be used to endorse or promote products derived
  16     from this software without specific prior written permission.
  17
  18     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 NXP DPAA2 Eventdev Driver
  31 =========================
  32
  33 The dpaa2 eventdev is an implementation of the eventdev API, that provides a
  34 wide range of the eventdev features. The eventdev relies on a dpaa2 hw to
  35 perform event scheduling.
  36
  37 More information can be found at `NXP Official Website
  38 <http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
  39
  40 Features
  41 --------
  42
  43 The DPAA2 EVENTDEV implements many features in the eventdev API;
  44
  45 - Hardware based event scheduler
  46 - 8 event ports
  47 - 8 event queues
  48 - Parallel flows
  49 - Atomic flows
  50
  51 Supported DPAA2 SoCs
  52 --------------------
  53
  54 - LS2080A/LS2040A
  55 - LS2084A/LS2044A
  56 - LS2088A/LS2048A
  57 - LS1088A/LS1048A
  58
  59 Prerequisites
  60 -------------
  61
  62 There are three main pre-requisities for executing DPAA2 EVENTDEV on a DPAA2
  63 compatible board:
  64
  65 1. **ARM 64 Tool Chain**
  66
  67    For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
  68
  69 2. **Linux Kernel**
  70
  71    It can be obtained from `NXP's Github hosting <https://github.com/qoriq-open-source/linux>`_.
  72
  73 3. **Rootfile system**
  74
  75    Any *aarch64* supporting filesystem can be used. For example,
  76    Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
  77    from `here <http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
  78
  79 As an alternative method, DPAA2 EVENTDEV can also be executed using images provided
  80 as part of SDK from NXP. The SDK includes all the above prerequisites necessary
  81 to bring up a DPAA2 board.
  82
  83 The following dependencies are not part of DPDK and must be installed
  84 separately:
  85
  86 - **NXP Linux SDK**
  87
  88   NXP Linux software development kit (SDK) includes support for family
  89   of QorIQ® ARM-Architecture-based system on chip (SoC) processors
  90   and corresponding boards.
  91
  92   It includes the Linux board support packages (BSPs) for NXP SoCs,
  93   a fully operational tool chain, kernel and board specific modules.
  94
  95   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>`_.
  96
  97 - **DPDK Extra Scripts**
  98
  99   DPAA2 based resources can be configured easily with the help of ready scripts
 100   as provided in the DPDK Extra repository.
 101
 102   `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
 103
 104 Currently supported by DPDK:
 105
 106 - NXP SDK **2.0+**.
 107 - MC Firmware version **10.0.0** and higher.
 108 - Supported architectures:  **arm64 LE**.
 109
 110 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 111
 112 .. note::
 113
 114    Some part of fslmc bus code (mc flib - object library) routines are
 115    dual licensed (BSD & GPLv2).
 116
 117 Pre-Installation Configuration
 118 ------------------------------
 119
 120 Config File Options
 121 ~~~~~~~~~~~~~~~~~~~
 122
 123 The following options can be modified in the ``config`` file.
 124 Please note that enabling debugging options may affect system performance.
 125
 126 - ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV`` (default ``y``)
 127
 128   Toggle compilation of the ``lrte_pmd_dpaa2_event`` driver.
 129
 130 - ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV_DEBUG`` (default ``n``)
 131
 132   Toggle display of generic debugging messages
 133
 134 Driver Compilation
 135 ~~~~~~~~~~~~~~~~~~
 136
 137 To compile the DPAA2 EVENTDEV PMD for Linux arm64 gcc target, run the
 138 following ``make`` command:
 139
 140 .. code-block:: console
 141
 142    cd <DPDK-source-directory>
 143    make config T=arm64-dpaa2-linuxapp-gcc install
 144
 145 Initialization
 146 --------------
 147
 148 The dpaa2 eventdev is exposed as a vdev device which consists of a set of dpcon
 149 devices and dpci devices. On EAL initialization, dpcon and dpci devices will be
 150 probed and then vdev device can be created from the application code by
 151
 152 * Invoking ``rte_vdev_init("event_dpaa2")`` from the application
 153
 154 * Using ``--vdev="event_dpaa2"`` in the EAL options, which will call
 155   rte_vdev_init() internally
 156
 157 Example:
 158
 159 .. code-block:: console
 160
 161     ./your_eventdev_application --vdev="event_dpaa2"
 162
 163 Limitations
 164 -----------
 165
 166 Platform Requirement
 167 ~~~~~~~~~~~~~~~~~~~~
 168
 169 DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
 170 ``Supported DPAA2 SoCs``.
 171
 172 Port-core binding
 173 ~~~~~~~~~~~~~~~~~
 174
 175 DPAA2 EVENTDEV driver requires event port 'x' to be used on core 'x'.