net/octeontx2: add build and doc infrastructure
[dpdk.git] / doc / guides / nics / octeontx2.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(C) 2019 Marvell International Ltd.
3
4 OCTEON TX2 Poll Mode driver
5 ===========================
6
7 The OCTEON TX2 ETHDEV PMD (**librte_pmd_octeontx2**) provides poll mode ethdev
8 driver support for the inbuilt network device found in **Marvell OCTEON TX2**
9 SoC family as well as for their virtual functions (VF) in SR-IOV context.
10
11 More information can be found at `Marvell Official Website
12 <https://www.marvell.com/embedded-processors/infrastructure-processors>`_.
13
14 Features
15 --------
16
17 Features of the OCTEON TX2 Ethdev PMD are:
18
19
20 Prerequisites
21 -------------
22
23 See :doc:`../platform/octeontx2` for setup information.
24
25 Compile time Config Options
26 ---------------------------
27
28 The following options may be modified in the ``config`` file.
29
30 - ``CONFIG_RTE_LIBRTE_OCTEONTX2_PMD`` (default ``y``)
31
32   Toggle compilation of the ``librte_pmd_octeontx2`` driver.