doc/guides/eventdevs/dpaa.rst

   1 .. SPDX-License-Identifier:        BSD-3-Clause
   2    Copyright 2017 NXP
   3
   4 NXP DPAA Eventdev Driver
   5 =========================
   6
   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.
  10
  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>`_.
  13
  14 Features
  15 --------
  16
  17 The DPAA EVENTDEV implements many features in the eventdev API;
  18
  19 - Hardware based event scheduler
  20 - 4 event ports
  21 - 4 event queues
  22 - Parallel flows
  23 - Atomic flows
  24
  25 Supported DPAA SoCs
  26 --------------------
  27
  28 - LS1046A
  29 - LS1043A
  30
  31 Prerequisites
  32 -------------
  33
  34 There are following pre-requisites for executing EVENTDEV on a DPAA compatible
  35 platform:
  36
  37 1. **ARM 64 Tool Chain**
  38
  39   For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/6.4-2017.08/aarch64-linux-gnu/>`_.
  40
  41 2. **Linux Kernel**
  42
  43    It can be obtained from `NXP's Github hosting <https://github.com/qoriq-open-source/linux>`_.
  44
  45 3. **Rootfile System**
  46
  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>`_.
  50
  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.
  54
  55 The following dependencies are not part of DPDK and must be installed
  56 separately:
  57
  58 - **NXP Linux SDK**
  59
  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.
  63
  64   It includes the Linux board support packages (BSPs) for NXP SoCs,
  65   a fully operational tool chain, kernel and board specific modules.
  66
  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>`_.
  68
  69 - **DPDK Extra Scripts**
  70
  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.
  73
  74   `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
  75
  76 Currently supported by DPDK:
  77
  78 - NXP SDK **2.0+** or LSDK **17.09+**
  79 - Supported architectures:  **arm64 LE**.
  80
  81 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  82
  83 Pre-Installation Configuration
  84 ------------------------------
  85
  86 Config File Options
  87 ~~~~~~~~~~~~~~~~~~~
  88
  89 The following options can be modified in the ``config`` file.
  90 Please note that enabling debugging options may affect system performance.
  91
  92 - ``CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV`` (default ``y``)
  93
  94   Toggle compilation of the ``librte_pmd_dpaa_event`` driver.
  95
  96 Driver Compilation
  97 ~~~~~~~~~~~~~~~~~~
  98
  99 To compile the DPAA EVENTDEV PMD for Linux arm64 gcc target, run the
 100 following ``make`` command:
 101
 102 .. code-block:: console
 103
 104    cd <DPDK-source-directory>
 105    make config T=arm64-dpaa-linuxapp-gcc install
 106
 107 Initialization
 108 --------------
 109
 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
 113
 114 * Invoking ``rte_vdev_init("event_dpaa1")`` from the application
 115
 116 * Using ``--vdev="event_dpaa1"`` in the EAL options, which will call
 117   rte_vdev_init() internally
 118
 119 Example:
 120
 121 .. code-block:: console
 122
 123     ./your_eventdev_application --vdev="event_dpaa1"
 124
 125 * Use dev arg option ``disable_intr=1`` to disable the interrupt mode
 126
 127 Limitations
 128 -----------
 129
 130 1. DPAA eventdev can not work with DPAA PUSH mode queues configured for ethdev.
 131    Please configure export DPAA_NUM_PUSH_QUEUES=0
 132
 133 Platform Requirement
 134 ~~~~~~~~~~~~~~~~~~~~
 135
 136 DPAA drivers for DPDK can only work on NXP SoCs as listed in the
 137 ``Supported DPAA SoCs``.
 138
 139 Port-core Binding
 140 ~~~~~~~~~~~~~~~~~
 141
 142 DPAA EVENTDEV driver requires event port 'x' to be used on core 'x'.