doc: show how to include code in guides
[dpdk.git] / doc / guides / nics / octeontx_ep.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(C) 2021 Marvell.
3
4 OCTEON TX EP Poll Mode driver
5 =============================
6
7 The OCTEON TX EP ETHDEV PMD (**librte_pmd_octeontx_ep**) provides poll mode
8 ethdev driver support for the virtual functions (VF) of **Marvell OCTEON TX2**
9 and **Cavium OCTEON TX** families of adapters in SR-IOV context.
10
11 More information can be found at `Marvell Official Website
12 <https://www.marvell.com/content/dam/marvell/en/public-collateral/embedded-processors/marvell-liquidio-III-solutions-brief.pdf>`_.
13
14
15 Prerequisites
16 -------------
17
18 This driver relies on external kernel PF driver for resources allocations
19 and initialization. The following dependencies are not part of DPDK and
20 must be installed separately:
21
22 - **Kernel module**
23   This module, octeon_drv, drives the physical function, initializes hardware,
24   allocates resources such as number of VFs, input/output queues for itself and
25   the number of i/o queues each VF can use.
26
27 See :doc:`../platform/octeontx2` for SDP interface information which provides PCIe endpoint support for a remote host.