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