numam-dpdk/doc/guides/nics/octeon_ep.rst

..  SPDX-License-Identifier: BSD-3-Clause
    Copyright(C) 2021 Marvell.

OCTEON TX EP Poll Mode driver
=============================

The OCTEON TX EP ETHDEV PMD (**librte_pmd_octeon_ep**) provides poll mode
ethdev driver support for the virtual functions (VF) of **Marvell OCTEON 9**
and **Cavium OCTEON** families of adapters in SR-IOV context.

More information can be found at `Marvell Official Website
<https://www.marvell.com/content/dam/marvell/en/public-collateral/embedded-processors/marvell-liquidio-III-solutions-brief.pdf>`_.


Prerequisites
-------------

This driver relies on external kernel PF driver for resources allocations
and initialization. The following dependencies are not part of DPDK and
must be installed separately:

- **Kernel module**
  This module, octeon_drv, drives the physical function, initializes hardware,
  allocates resources such as number of VFs, input/output queues for itself and
  the number of i/o queues each VF can use.

See :doc:`../platform/cnxk` for SDP interface information which provides PCIe endpoint support for a remote host.
net/octeontx_ep: add build and doc infrastructure Adding bare minimum PMD library and doc build infrastructure and claim the maintainership for octeontx end point PMD. Signed-off-by: Nalla Pradeep <pnalla@marvell.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com> 2021-01-29 12:45:00 +00:00			`.. SPDX-License-Identifier: BSD-3-Clause`
			`Copyright(C) 2021 Marvell.`

			`OCTEON TX EP Poll Mode driver`
			`=============================`

net/octeon_ep: rename octeontx_ep This patch renames octeon end point driver from octeontx_ep to octeon_ep to enable single unified driver to support current OcteonTx and future Octeon PCI endpoint NICs to reflect common driver for all Octeon based PCI endpoint NICs. Signed-off-by: Sathesh Edara <sedara@marvell.com> Acked-by: Veerasenareddy Burru <vburru@marvell.com> 2022-08-22 09:10:02 +00:00			`The OCTEON TX EP ETHDEV PMD (librte_pmd_octeon_ep) provides poll mode`
drivers: remove octeontx2 drivers As per the deprecation notice, In the view of enabling unified driver for octeontx2(cn9k)/octeontx3(cn10k), removing drivers/octeontx2 drivers and replace with drivers/cnxk/ which supports both octeontx2(cn9k) and octeontx3(cn10k) SoCs. This patch does the following - Replace drivers/common/octeontx2/ with drivers/common/cnxk/ - Replace drivers/mempool/octeontx2/ with drivers/mempool/cnxk/ - Replace drivers/net/octeontx2/ with drivers/net/cnxk/ - Replace drivers/event/octeontx2/ with drivers/event/cnxk/ - Replace drivers/crypto/octeontx2/ with drivers/crypto/cnxk/ - Rename config/arm/arm64_octeontx2_linux_gcc as config/arm/arm64_cn9k_linux_gcc - Update the documentation and MAINTAINERS to reflect the same. - Change the reference to OCTEONTX2 as OCTEON 9. Old release notes and the kernel related documentation is not accounted for this change. Signed-off-by: Jerin Jacob <jerinj@marvell.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Akhil Goyal <gakhil@marvell.com> Acked-by: Ruifeng Wang <ruifeng.wang@arm.com> 2021-12-11 09:04:35 +00:00			`ethdev driver support for the virtual functions (VF) of Marvell OCTEON 9`
net/octeon_ep: rename octeontx_ep This patch renames octeon end point driver from octeontx_ep to octeon_ep to enable single unified driver to support current OcteonTx and future Octeon PCI endpoint NICs to reflect common driver for all Octeon based PCI endpoint NICs. Signed-off-by: Sathesh Edara <sedara@marvell.com> Acked-by: Veerasenareddy Burru <vburru@marvell.com> 2022-08-22 09:10:02 +00:00			`and Cavium OCTEON families of adapters in SR-IOV context.`
net/octeontx_ep: add build and doc infrastructure Adding bare minimum PMD library and doc build infrastructure and claim the maintainership for octeontx end point PMD. Signed-off-by: Nalla Pradeep <pnalla@marvell.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com> 2021-01-29 12:45:00 +00:00
			More information can be found at `Marvell Official Website
			<https://www.marvell.com/content/dam/marvell/en/public-collateral/embedded-processors/marvell-liquidio-III-solutions-brief.pdf>`_.


			`Prerequisites`
			`-------------`

			`This driver relies on external kernel PF driver for resources allocations`
			`and initialization. The following dependencies are not part of DPDK and`
			`must be installed separately:`

			`- Kernel module`
			`This module, octeon_drv, drives the physical function, initializes hardware,`
			`allocates resources such as number of VFs, input/output queues for itself and`
			`the number of i/o queues each VF can use.`

drivers: remove octeontx2 drivers As per the deprecation notice, In the view of enabling unified driver for octeontx2(cn9k)/octeontx3(cn10k), removing drivers/octeontx2 drivers and replace with drivers/cnxk/ which supports both octeontx2(cn9k) and octeontx3(cn10k) SoCs. This patch does the following - Replace drivers/common/octeontx2/ with drivers/common/cnxk/ - Replace drivers/mempool/octeontx2/ with drivers/mempool/cnxk/ - Replace drivers/net/octeontx2/ with drivers/net/cnxk/ - Replace drivers/event/octeontx2/ with drivers/event/cnxk/ - Replace drivers/crypto/octeontx2/ with drivers/crypto/cnxk/ - Rename config/arm/arm64_octeontx2_linux_gcc as config/arm/arm64_cn9k_linux_gcc - Update the documentation and MAINTAINERS to reflect the same. - Change the reference to OCTEONTX2 as OCTEON 9. Old release notes and the kernel related documentation is not accounted for this change. Signed-off-by: Jerin Jacob <jerinj@marvell.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Akhil Goyal <gakhil@marvell.com> Acked-by: Ruifeng Wang <ruifeng.wang@arm.com> 2021-12-11 09:04:35 +00:00			See :doc:`../platform/cnxk` for SDP interface information which provides PCIe endpoint support for a remote host.