event/cnxk: add build infra and device setup
[dpdk.git] / doc / guides / eventdevs / cnxk.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright(c) 2021 Marvell.
3
4 Marvell cnxk SSO Eventdev Driver
5 ================================
6
7 The SSO PMD (**librte_event_cnxk**) and provides poll mode
8 eventdev driver support for the inbuilt event device found in the
9 **Marvell OCTEON cnxk** SoC family.
10
11 More information about OCTEON cnxk SoC can be found at `Marvell Official Website
12 <https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.
13
14 Supported OCTEON cnxk SoCs
15 --------------------------
16
17 - CN9XX
18 - CN10XX
19
20 Features
21 --------
22
23 Features of the OCTEON cnxk SSO PMD are:
24
25 - 256 Event queues
26 - 26 (dual) and 52 (single) Event ports on CN9XX
27 - 52 Event ports on CN10XX
28 - HW event scheduler
29 - Supports 1M flows per event queue
30 - Flow based event pipelining
31 - Flow pinning support in flow based event pipelining
32 - Queue based event pipelining
33 - Supports ATOMIC, ORDERED, PARALLEL schedule types per flow
34 - Event scheduling QoS based on event queue priority
35 - Open system with configurable amount of outstanding events limited only by
36   DRAM
37 - HW accelerated dequeue timeout support to enable power management
38
39 Prerequisites and Compilation procedure
40 ---------------------------------------
41
42    See :doc:`../platform/cnxk` for setup information.
43
44 Debugging Options
45 -----------------
46
47 .. _table_octeon_cnxk_event_debug_options:
48
49 .. table:: OCTEON cnxk event device debug options
50
51    +---+------------+-------------------------------------------------------+
52    | # | Component  | EAL log command                                       |
53    +===+============+=======================================================+
54    | 1 | SSO        | --log-level='pmd\.event\.cnxk,8'                      |
55    +---+------------+-------------------------------------------------------+