1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2019 Marvell International Ltd.
4 OCTEON TX2 SSO Eventdev Driver
5 ===============================
7 The OCTEON TX2 SSO PMD (**librte_pmd_octeontx2_event**) provides poll mode
8 eventdev driver support for the inbuilt event device found in the **Marvell OCTEON TX2**
11 More information about OCTEON TX2 SoC can be found at `Marvell Official Website
12 <https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.
17 Features of the OCTEON TX2 SSO PMD are:
20 - 26 (dual) and 52 (single) Event ports
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 limited only by
30 - HW accelerated dequeue timeout support to enable power management
32 Prerequisites and Compilation procedure
33 ---------------------------------------
35 See :doc:`../platform/octeontx2` for setup information.
37 Pre-Installation Configuration
38 ------------------------------
40 Compile time Config Options
41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
43 The following option can be modified in the ``config`` file.
45 - ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_EVENTDEV`` (default ``y``)
47 Toggle compilation of the ``librte_pmd_octeontx2_event`` driver.
49 Runtime Config Options
50 ~~~~~~~~~~~~~~~~~~~~~~
52 - ``Maximum number of in-flight events`` (default ``8192``)
54 In **Marvell OCTEON TX2** the max number of in-flight events are only limited
55 by DRAM size, the ``xae_cnt`` devargs parameter is introduced to provide
56 upper limit for in-flight events.
59 --dev "0002:0e:00.0,xae_cnt=16384"
64 .. _table_octeontx2_event_debug_options:
66 .. table:: OCTEON TX2 event device debug options
68 +---+------------+-------------------------------------------------------+
69 | # | Component | EAL log command |
70 +===+============+=======================================================+
71 | 1 | SSO | --log-level='pmd\.event\.octeontx2,8' |
72 +---+------------+-------------------------------------------------------+