doc/guides/eventdevs/octeontx2.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2019 Marvell International Ltd.
   3
   4 OCTEON TX2 SSO Eventdev Driver
   5 ===============================
   6
   7 The OCTEON TX2 SSO PMD (**librte_pmd_octeontx2_event**) provides poll mode
   8 eventdev driver support for the inbuilt event device found in the **Marvell OCTEON TX2**
   9 SoC family.
  10
  11 More information about OCTEON TX2 SoC can be found at `Marvell Official Website
  12 <https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.
  13
  14 Features
  15 --------
  16
  17 Features of the OCTEON TX2 SSO PMD are:
  18
  19 - 256 Event queues
  20 - 26 (dual) and 52 (single) Event ports
  21 - HW event scheduler
  22 - Supports 1M flows per event queue
  23 - Flow based event pipelining
  24 - Flow pinning support in flow based event pipelining
  25 - Queue based event pipelining
  26 - Supports ATOMIC, ORDERED, PARALLEL schedule types per flow
  27 - Event scheduling QoS based on event queue priority
  28 - Open system with configurable amount of outstanding events limited only by
  29   DRAM
  30 - HW accelerated dequeue timeout support to enable power management
  31
  32 Prerequisites and Compilation procedure
  33 ---------------------------------------
  34
  35    See :doc:`../platform/octeontx2` for setup information.
  36
  37 Pre-Installation Configuration
  38 ------------------------------
  39
  40 Compile time Config Options
  41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42
  43 The following option can be modified in the ``config`` file.
  44
  45 - ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_EVENTDEV`` (default ``y``)
  46
  47   Toggle compilation of the ``librte_pmd_octeontx2_event`` driver.
  48
  49 Debugging Options
  50 ~~~~~~~~~~~~~~~~~
  51
  52 .. _table_octeontx2_event_debug_options:
  53
  54 .. table:: OCTEON TX2 event device debug options
  55
  56    +---+------------+-------------------------------------------------------+
  57    | # | Component  | EAL log command                                       |
  58    +===+============+=======================================================+
  59    | 1 | SSO        | --log-level='pmd\.event\.octeontx2,8'                 |
  60    +---+------------+-------------------------------------------------------+