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
31 - HW managed event timers support through TIM, with high precision and
32 time granularity of 2.5us.
33 - Up to 256 TIM rings aka event timer adapters.
34 - Up to 8 rings traversed in parallel.
36 Prerequisites and Compilation procedure
37 ---------------------------------------
39 See :doc:`../platform/octeontx2` for setup information.
41 Pre-Installation Configuration
42 ------------------------------
44 Compile time Config Options
45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
47 The following option can be modified in the ``config`` file.
49 - ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_EVENTDEV`` (default ``y``)
51 Toggle compilation of the ``librte_pmd_octeontx2_event`` driver.
53 Runtime Config Options
54 ~~~~~~~~~~~~~~~~~~~~~~
56 - ``Maximum number of in-flight events`` (default ``8192``)
58 In **Marvell OCTEON TX2** the max number of in-flight events are only limited
59 by DRAM size, the ``xae_cnt`` devargs parameter is introduced to provide
60 upper limit for in-flight events.
63 --dev "0002:0e:00.0,xae_cnt=16384"
65 - ``Force legacy mode``
67 The ``single_ws`` devargs parameter is introduced to force legacy mode i.e
68 single workslot mode in SSO and disable the default dual workslot mode.
71 --dev "0002:0e:00.0,single_ws=1"
73 - ``Event Group QoS support``
75 SSO GGRPs i.e. queue uses DRAM & SRAM buffers to hold in-flight
76 events. By default the buffers are assigned to the SSO GGRPs to
77 satisfy minimum HW requirements. SSO is free to assign the remaining
78 buffers to GGRPs based on a preconfigured threshold.
79 We can control the QoS of SSO GGRP by modifying the above mentioned
80 thresholds. GGRPs that have higher importance can be assigned higher
81 thresholds than the rest. The dictionary format is as follows
82 [Qx-XAQ-TAQ-IAQ][Qz-XAQ-TAQ-IAQ] expressed in percentages, 0 represents
86 --dev "0002:0e:00.0,qos=[1-50-50-50]"
90 The functionality of OCTEON TX2 eventdev can be verified using this option,
91 various unit and functional tests are run to verify the sanity.
92 The tests are run once the vdev creation is successfully complete.
95 --dev "0002:0e:00.0,selftest=1"
100 .. _table_octeontx2_event_debug_options:
102 .. table:: OCTEON TX2 event device debug options
104 +---+------------+-------------------------------------------------------+
105 | # | Component | EAL log command |
106 +===+============+=======================================================+
107 | 1 | SSO | --log-level='pmd\.event\.octeontx2,8' |
108 +---+------------+-------------------------------------------------------+
109 | 2 | TIM | --log-level='pmd\.event\.octeontx2\.timer,8' |
110 +---+------------+-------------------------------------------------------+