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 - LX2160A
  30 - LS2084A/LS2044A
  31 - LS2088A/LS2048A
  32 - LS1088A/LS1048A
  33
  34 Prerequisites
  35 -------------
  36
  37 See :doc:`../platform/dpaa2` for setup information
  38
  39 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  40
  41 .. note::
  42
  43    Some part of fslmc bus code (mc flib - object library) routines are
  44    dual licensed (BSD & GPLv2).
  45
  46
  47 Initialization
  48 --------------
  49
  50 The dpaa2 eventdev is exposed as a vdev device which consists of a set of dpcon
  51 devices and dpci devices. On EAL initialization, dpcon and dpci devices will be
  52 probed and then vdev device can be created from the application code by
  53
  54 * Invoking ``rte_vdev_init("event_dpaa2")`` from the application
  55
  56 * Using ``--vdev="event_dpaa2"`` in the EAL options, which will call
  57   rte_vdev_init() internally
  58
  59 Example:
  60
  61 .. code-block:: console
  62
  63    ./your_eventdev_application --vdev="event_dpaa2"
  64
  65 Enabling logs
  66 -------------
  67
  68 For enabling logs, use the following EAL parameter:
  69
  70 .. code-block:: console
  71
  72    ./your_eventdev_application <EAL args> --log-level=pmd.event.dpaa2,<level>
  73
  74 Using ``eventdev.dpaa2`` as log matching criteria, all Event PMD logs can be
  75 enabled which are lower than logging ``level``.
  76
  77 Limitations
  78 -----------
  79
  80 Platform Requirement
  81 ~~~~~~~~~~~~~~~~~~~~
  82
  83 DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
  84 ``Supported DPAA2 SoCs``.
  85
  86 Port-core binding
  87 ~~~~~~~~~~~~~~~~~
  88
  89 DPAA2 EVENTDEV can support only one eventport per core.