xref: /dpdk/doc/guides/nics/octeon_ep.rst (revision 831cf744eeff64b93c96cee2fbeb12fca24c03b4)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright(C) 2021 Marvell.
3
4OCTEON TX EP Poll Mode driver
5=============================
6
7The OCTEON TX EP ETHDEV PMD (**librte_pmd_octeon_ep**) provides poll mode
8ethdev driver support for the virtual functions (VF) of **Marvell OCTEON 9**
9and **Cavium OCTEON** families of adapters in SR-IOV context.
10
11More 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
14Runtime Config Options
15----------------------
16
17- ``Rx & Tx ISM memory accesses enable`` (default ``0``)
18
19   The PMD supports two modes for checking Rx & Tx packet count,
20   PMD may read the packet count directly from hardware registers
21   or it may read from ISM memory,
22   this may be selected at runtime using ``ism_enable`` devargs parameter.
23   Performance is higher for bigger size packets with default value (``ism_enable=0``).
24   Use this runtime option to enable ISM memory accesses
25   to get better performance for lower size packets.
26
27   For example::
28
29      -a 0002:02:00.0,ism_enable=1
30
31Prerequisites
32-------------
33
34This driver relies on external kernel PF driver for resources allocations
35and initialization. The following dependencies are not part of DPDK and
36must be installed separately:
37
38- **Kernel module**
39  This module, octeon_drv, drives the physical function, initializes hardware,
40  allocates resources such as number of VFs, input/output queues for itself and
41  the number of i/o queues each VF can use.
42
43See :doc:`../platform/cnxk` for SDP interface information which provides PCIe endpoint support for a remote host.
44