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/LS1026A
  29 - LS1043A/LS1023A
  30
  31 Prerequisites
  32 -------------
  33
  34 See :doc:`../platform/dpaa` for setup information
  35
  36 Currently supported by DPDK:
  37
  38 - NXP SDK **2.0+** or LSDK **18.09+**
  39 - Supported architectures:  **arm64 LE**.
  40
  41 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  42
  43 Pre-Installation Configuration
  44 ------------------------------
  45
  46 Config File Options
  47 ~~~~~~~~~~~~~~~~~~~
  48
  49 The following options can be modified in the ``config`` file.
  50 Please note that enabling debugging options may affect system performance.
  51
  52 - ``CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV`` (default ``y``)
  53
  54   Toggle compilation of the ``librte_pmd_dpaa_event`` driver.
  55
  56 Driver Compilation
  57 ~~~~~~~~~~~~~~~~~~
  58
  59 To compile the DPAA EVENTDEV PMD for Linux arm64 gcc target, run the
  60 following ``make`` command:
  61
  62 .. code-block:: console
  63
  64    cd <DPDK-source-directory>
  65    make config T=arm64-dpaa-linuxapp-gcc install
  66
  67 Initialization
  68 --------------
  69
  70 The dpaa eventdev is exposed as a vdev device which consists of a set of channels
  71 and queues. On EAL initialization, dpaa components will be
  72 probed and then vdev device can be created from the application code by
  73
  74 * Invoking ``rte_vdev_init("event_dpaa1")`` from the application
  75
  76 * Using ``--vdev="event_dpaa1"`` in the EAL options, which will call
  77   rte_vdev_init() internally
  78
  79 Example:
  80
  81 .. code-block:: console
  82
  83     ./your_eventdev_application --vdev="event_dpaa1"
  84
  85 * Use dev arg option ``disable_intr=1`` to disable the interrupt mode
  86
  87 Limitations
  88 -----------
  89
  90 1. DPAA eventdev can not work with DPAA PUSH mode queues configured for ethdev.
  91    Please configure export DPAA_NUM_PUSH_QUEUES=0
  92
  93 Platform Requirement
  94 ~~~~~~~~~~~~~~~~~~~~
  95
  96 DPAA drivers for DPDK can only work on NXP SoCs as listed in the
  97 ``Supported DPAA SoCs``.
  98
  99 Port-core Binding
 100 ~~~~~~~~~~~~~~~~~
 101
 102 DPAA EVENTDEV driver requires event port 'x' to be used on core 'x'.