2 Copyright (C) Cavium networks Ltd. 2017.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Cavium networks nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 OCTEONTX SSOVF Eventdev Driver
32 ==============================
34 The OCTEONTX SSOVF PMD (**librte_pmd_octeontx_ssovf**) provides poll mode
35 eventdev driver support for the inbuilt event device found in the **Cavium OCTEONTX**
36 SoC family as well as their virtual functions (VF) in SR-IOV context.
38 More information can be found at `Cavium Networks Official Website
39 <http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
44 Features of the OCTEONTX SSOVF PMD are:
49 - Supports 1M flows per event queue
50 - Flow based event pipelining
51 - Flow pinning support in flow based event pipelining
52 - Queue based event pipelining
53 - Supports ATOMIC, ORDERED, PARALLEL schedule types per flow
54 - Event scheduling QoS based on event queue priority
55 - Open system with configurable amount of outstanding events
56 - HW accelerated dequeue timeout support to enable power management
59 Supported OCTEONTX SoCs
60 -----------------------
66 There are three main pre-perquisites for executing SSOVF PMD on a OCTEONTX
69 1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks**
71 The OCTEONTX Linux kernel drivers (including the required PF driver for the
72 SSOVF) are available on Github at `octeontx-kmod <https://github.com/caviumnetworks/octeontx-kmod>`_
73 along with build, install and dpdk usage instructions.
75 2. **ARM64 Tool Chain**
77 For example, the *aarch64* Linaro Toolchain, which can be obtained from
78 `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
80 3. **Rootfile system**
82 Any *aarch64* supporting filesystem can be used. For example,
83 Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
84 from `<http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
86 As an alternative method, SSOVF PMD can also be executed using images provided
87 as part of SDK from Cavium. The SDK includes all the above prerequisites necessary
88 to bring up a OCTEONTX board.
90 SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.
92 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
94 Pre-Installation Configuration
95 ------------------------------
100 The following options can be modified in the ``config`` file.
101 Please note that enabling debugging options may affect system performance.
103 - ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_SSOVF`` (default ``y``)
105 Toggle compilation of the ``librte_pmd_octeontx_ssovf`` driver.
107 - ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_SSOVF_DEBUG`` (default ``n``)
109 Toggle display of generic debugging messages
114 To compile the OCTEONTX SSOVF PMD for Linux arm64 gcc target, run the
115 following ``make`` command:
117 .. code-block:: console
119 cd <DPDK-source-directory>
120 make config T=arm64-thunderx-linuxapp-gcc install
126 The octeontx eventdev is exposed as a vdev device which consists of a set
127 of SSO group and work-slot PCIe VF devices. On EAL initialization,
128 SSO PCIe VF devices will be probed and then the vdev device can be created
129 from the application code, or from the EAL command line based on
130 the number of probed/bound SSO PCIe VF device to DPDK by
132 * Invoking ``rte_eal_vdev_init("event_octeontx")`` from the application
134 * Using ``--vdev="event_octeontx"`` in the EAL options, which will call
135 rte_eal_vdev_init() internally
139 .. code-block:: console
141 ./your_eventdev_application --vdev="event_octeontx"
149 Burst mode is not supported. Dequeue and Enqueue functions accepts only single