doc/guides/eventdevs/octeontx.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2017 Cavium, Inc
   3
   4 OCTEONTX SSOVF Eventdev Driver
   5 ==============================
   6
   7 The OCTEONTX SSOVF PMD (**librte_pmd_octeontx_ssovf**) provides poll mode
   8 eventdev driver support for the inbuilt event device found in the **Cavium OCTEONTX**
   9 SoC family as well as their virtual functions (VF) in SR-IOV context.
  10
  11 More information can be found at `Cavium, Inc Official Website
  12 <http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
  13
  14 Features
  15 --------
  16
  17 Features of the OCTEONTX SSOVF PMD are:
  18
  19 - 64 Event queues
  20 - 32 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
  29 - HW accelerated dequeue timeout support to enable power management
  30 - SR-IOV VF
  31
  32 Supported OCTEONTX SoCs
  33 -----------------------
  34 - CN83xx
  35
  36 Prerequisites
  37 -------------
  38
  39 See :doc: `../platform/octeontx` for setup information.
  40
  41 Pre-Installation Configuration
  42 ------------------------------
  43
  44 Config File Options
  45 ~~~~~~~~~~~~~~~~~~~
  46
  47 The following options can be modified in the ``config`` file.
  48 Please note that enabling debugging options may affect system performance.
  49
  50 - ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_SSOVF`` (default ``y``)
  51
  52   Toggle compilation of the ``librte_pmd_octeontx_ssovf`` driver.
  53
  54 - ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_SSOVF_DEBUG`` (default ``n``)
  55
  56   Toggle display of generic debugging messages
  57
  58 Driver Compilation
  59 ~~~~~~~~~~~~~~~~~~
  60
  61 To compile the OCTEONTX SSOVF PMD for Linux arm64 gcc target, run the
  62 following ``make`` command:
  63
  64 .. code-block:: console
  65
  66    cd <DPDK-source-directory>
  67    make config T=arm64-thunderx-linuxapp-gcc install
  68
  69
  70 Initialization
  71 --------------
  72
  73 The octeontx eventdev is exposed as a vdev device which consists of a set
  74 of SSO group and work-slot PCIe VF devices. On EAL initialization,
  75 SSO PCIe VF devices will be probed and then the vdev device can be created
  76 from the application code, or from the EAL command line based on
  77 the number of probed/bound SSO PCIe VF device to DPDK by
  78
  79 * Invoking ``rte_vdev_init("event_octeontx")`` from the application
  80
  81 * Using ``--vdev="event_octeontx"`` in the EAL options, which will call
  82   rte_vdev_init() internally
  83
  84 Example:
  85
  86 .. code-block:: console
  87
  88     ./your_eventdev_application --vdev="event_octeontx"
  89
  90 Limitations
  91 -----------
  92
  93 Burst mode support
  94 ~~~~~~~~~~~~~~~~~~
  95
  96 Burst mode is not supported. Dequeue and Enqueue functions accepts only single
  97 event at a time.
  98
  99 Rx adapter support
 100 ~~~~~~~~~~~~~~~~~~
 101
 102 When eth_octeontx is used as Rx adapter event schedule type
 103 ``RTE_SCHED_TYPE_PARALLEL`` is not supported.