doc/guides/eventdevs/octeontx.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2017 Cavium, Inc
   3
   4 OCTEON TX SSOVF Eventdev Driver
   5 ===============================
   6
   7 The OCTEON TX SSOVF PMD (**librte_event_octeontx**) provides poll mode
   8 eventdev driver support for the inbuilt event device found in the **Cavium OCTEON TX**
   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 OCTEON TX 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 - HW managed event timers support through TIMVF, with high precision and
  32   time granularity of 1us.
  33 - Up to 64 event timer adapters.
  34
  35 Supported OCTEON TX SoCs
  36 ------------------------
  37 - CN83xx
  38
  39 Prerequisites
  40 -------------
  41
  42 See :doc:`../platform/octeontx` for setup information.
  43
  44
  45 Initialization
  46 --------------
  47
  48 The OCTEON TX eventdev is exposed as a vdev device which consists of a set
  49 of SSO group and work-slot PCIe VF devices. On EAL initialization,
  50 SSO PCIe VF devices will be probed and then the vdev device can be created
  51 from the application code, or from the EAL command line based on
  52 the number of probed/bound SSO PCIe VF device to DPDK by
  53
  54 * Invoking ``rte_vdev_init("event_octeontx")`` from the application
  55
  56 * Using ``--vdev="event_octeontx"`` 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_octeontx"
  64
  65
  66 Selftest
  67 --------
  68
  69 The functionality of OCTEON TX eventdev can be verified using this option,
  70 various unit and functional tests are run to verify the sanity.
  71 The tests are run once the vdev creation is successfully complete.
  72
  73 .. code-block:: console
  74
  75     --vdev="event_octeontx,selftest=1"
  76
  77
  78 Enable TIMvf stats
  79 ------------------
  80 TIMvf stats can be enabled by using this option, by default the stats are
  81 disabled.
  82
  83 .. code-block:: console
  84
  85     --vdev="event_octeontx,timvf_stats=1"
  86
  87
  88 Limitations
  89 -----------
  90
  91 Burst mode support
  92 ~~~~~~~~~~~~~~~~~~
  93
  94 Burst mode is not supported. Dequeue and Enqueue functions accepts only single
  95 event at a time.
  96
  97 Rx adapter support
  98 ~~~~~~~~~~~~~~~~~~
  99
 100 When eth_octeontx is used as Rx adapter event schedule type
 101 ``RTE_SCHED_TYPE_PARALLEL`` is not supported.
 102
 103 Event timer adapter support
 104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 105
 106 When timvf is used as Event timer adapter the clock source mapping is as
 107 follows:
 108
 109 .. code-block:: console
 110
 111         RTE_EVENT_TIMER_ADAPTER_CPU_CLK  = TIM_CLK_SRC_SCLK
 112         RTE_EVENT_TIMER_ADAPTER_EXT_CLK0 = TIM_CLK_SRC_GPIO
 113         RTE_EVENT_TIMER_ADAPTER_EXT_CLK1 = TIM_CLK_SRC_GTI
 114         RTE_EVENT_TIMER_ADAPTER_EXT_CLK2 = TIM_CLK_SRC_PTP
 115
 116 When timvf is used as Event timer adapter event schedule type
 117 ``RTE_SCHED_TYPE_PARALLEL`` is not supported.
 118
 119 Max number of events
 120 ~~~~~~~~~~~~~~~~~~~~
 121
 122 Max number of events in OCTEON TX Eventdev (SSO) are only limited by DRAM size
 123 and they can be configured by passing limits to kernel bootargs as follows:
 124
 125 .. code-block:: console
 126
 127         ssopf.max_events=4194304
 128
 129 The same can be verified by looking at the following sysfs entry:
 130
 131 .. code-block:: console
 132
 133         # cat /sys/module/ssopf/parameters/max_events
 134         4194304
 135
 136 The maximum number of events that can be added to SSO by the event adapters such
 137 as (Rx/Timer) should be limited to the above configured value.