1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2017 Cavium, Inc
4 OCTEONTX SSOVF Eventdev Driver
5 ==============================
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.
11 More information can be found at `Cavium, Inc Official Website
12 <http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
17 Features of the OCTEONTX SSOVF PMD are:
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
32 Supported OCTEONTX SoCs
33 -----------------------
39 See :doc: `../platform/octeontx` for setup information.
41 Pre-Installation Configuration
42 ------------------------------
47 The following options can be modified in the ``config`` file.
48 Please note that enabling debugging options may affect system performance.
50 - ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_SSOVF`` (default ``y``)
52 Toggle compilation of the ``librte_pmd_octeontx_ssovf`` driver.
57 To compile the OCTEONTX SSOVF PMD for Linux arm64 gcc target, run the
58 following ``make`` command:
60 .. code-block:: console
62 cd <DPDK-source-directory>
63 make config T=arm64-thunderx-linuxapp-gcc install
69 The octeontx eventdev is exposed as a vdev device which consists of a set
70 of SSO group and work-slot PCIe VF devices. On EAL initialization,
71 SSO PCIe VF devices will be probed and then the vdev device can be created
72 from the application code, or from the EAL command line based on
73 the number of probed/bound SSO PCIe VF device to DPDK by
75 * Invoking ``rte_vdev_init("event_octeontx")`` from the application
77 * Using ``--vdev="event_octeontx"`` in the EAL options, which will call
78 rte_vdev_init() internally
82 .. code-block:: console
84 ./your_eventdev_application --vdev="event_octeontx"
92 Burst mode is not supported. Dequeue and Enqueue functions accepts only single
98 When eth_octeontx is used as Rx adapter event schedule type
99 ``RTE_SCHED_TYPE_PARALLEL`` is not supported.