d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-dpdk/doc/guides/nics/index.rst

84 lines
2.5 KiB
ReStructuredText
Raw Normal View History

doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
.. BSD LICENSE
Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Intel Corporation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Network Interface Controller Drivers
====================================
.. toctree::
:maxdepth: 3
:numbered:
doc: introduce networking driver matrix In order to better compare the drivers and check what is missing for a common baseline, we need to fill a matrix. A CSS trick is used to fit the HTML page. The PDF output needs some LaTeX wizardry. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2016-01-27 21:07:09 +01:00
overview
doc: add AVP Updates the documentation and feature lists for the AVP PMD device. Signed-off-by: Allain Legacy <allain.legacy@windriver.com> Signed-off-by: Matt Peters <matt.peters@windriver.com> Acked-by: John McNamara <john.mcnamara@intel.com> Acked-by: Vincent Jardin <vincent.jardin@6wind.com>
2017-03-28 07:54:09 -04:00
avp
bnx2x: add guide Signed-off-by: Harish Patil <harish.patil@qlogic.com> Signed-off-by: Rasesh Mody <rasesh.mody@qlogic.com>
2015-12-10 22:36:37 -08:00
bnx2x
net/bnxt: add driver for Broadcom NetXtreme-C devices This patch adds the initial skeleton for bnxt driver along with the nic guide, and ties the driver into the build system. At this point, the driver simply fails init. Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com> Signed-off-by: Stephen Hurd <stephen.hurd@broadcom.com> Reviewed-by: David Christensen <david.christensen@broadcom.com> [Release Note Addition] Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2016-06-15 14:23:01 -07:00
bnxt
cxgbe: add documentation Adds cxgbe poll mode driver documentation under the usual doc/guides/nics/ directory with the rest of the drivers. The documentation covers cxgbe implementation details, features and limitations, prerequisites, configuration, and a sample application usage. Signed-off-by: Rahul Lakkireddy <rahul.lakkireddy@chelsio.com> Signed-off-by: Kumar Sanghvi <kumaras@chelsio.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2015-06-30 04:58:42 +05:30
cxgbe
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
e1000em
ena: introduce documentation Signed-off-by: Alexander Matushevsky <matua@amazon.com> Signed-off-by: Jan Medala <jan@semihalf.com> Signed-off-by: Jakub Palider <jpa@semihalf.com>
2016-03-17 15:31:15 +01:00
ena
enic: add guide Signed-off-by: John Daley <johndale@cisco.com>
2015-12-13 15:11:32 -08:00
enic
fm10k: add guide This documentation covers introductions and limitations on Intel FM10000 series products. Signed-off-by: Chen Jing D(Mark) <jing.d.chen@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2015-12-10 15:00:21 +08:00
fm10k
doc: add i40e guide A new doc is added to introduce i40e pmd driver. Signed-off-by: Jingjing Wu <jingjing.wu@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-03-09 15:28:39 +08:00
i40e
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
ixgbe
intel_vf
net/kni: add KNI PMD Add KNI PMD which wraps librte_kni for ease of use. KNI PMD can be used as any regular PMD to send / receive packets to the Linux networking stack. Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Reviewed-by: Yong Wang <yongwang@vmware.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Yong Wang <yongwang@vmware.com>
2017-02-17 13:42:38 +00:00
kni
doc: add liquidio Add liquidio driver documentation and update 17.05 release notes. Signed-off-by: Shijith Thotton <shijith.thotton@caviumnetworks.com> Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Signed-off-by: Derek Chickles <derek.chickles@caviumnetworks.com> Signed-off-by: Venkat Koppula <venkat.koppula@caviumnetworks.com> Signed-off-by: Srisivasubramanian S <ssrinivasan@caviumnetworks.com> Signed-off-by: Mallesham Jatharakonda <mjatharakonda@oneconvergence.com>
2017-03-25 11:54:57 +05:30
liquidio
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
mlx4
mlx5: add documentation Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
2015-10-30 19:52:42 +01:00
mlx5
nfp: add guide Signed-off-by: Alejandro Lucero <alejandro.lucero@netronome.com> Signed-off-by: Rolf Neugebauer <rolf.neugebauer@netronome.com>
2015-11-30 10:25:42 +00:00
nfp
qede: add core driver The Qlogic Everest Driver for Ethernet(QEDE) Poll Mode Driver(PMD) is the DPDK specific module for QLogic FastLinQ QL4xxxx 25G/40G CNA family of adapters as well as their virtual functions (VF) in SR-IOV context. This patch adds QEDE PMD, which interacts with base driver and initialises the HW. This patch content also includes: - eth_dev_ops callbacks - Rx/Tx support for the driver - link default configuration - change link property - link up/down/update notifications - vlan offload and filtering capability - device/function/port statistics - qede nic guide and updated overview.rst Note that the follow on commits contain the code for the features mentioned in documents but not implemented in this patch. Signed-off-by: Harish Patil <harish.patil@qlogic.com> Signed-off-by: Rasesh Mody <rasesh.mody@qlogic.com> Signed-off-by: Sony Chacko <sony.chacko@qlogic.com>
2016-04-27 07:18:37 -07:00
qede
net/sfc: libefx-based driver stub Enable the PMD by default on supported configurations. Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com> Reviewed-by: Andy Moreton <amoreton@solarflare.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
2016-11-29 16:18:33 +00:00
sfc_efx
szedata2: add new poll mode driver Add virtual PMD which communicates with COMBO cards through sze2 layer using libsze2 library. Since link_speed is uint16_t, there can not be used number for 100G speed, therefore link_speed is set to ETH_LINK_SPEED_10G until the type of link_speed is solved. Signed-off-by: Matej Vido <matejvido@gmail.com>
2015-11-10 15:18:13 +01:00
szedata2
net/tap: add TUN/TAP device PMD The PMD allows for DPDK and the host to communicate using a raw device interface on the host and in the DPDK application. The device created is a Tap device with a L2 packet header. Signed-off-by: Keith Wiles <keith.wiles@intel.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com> Tested-by: Aws Ismail <aismail@ciena.com> Tested-by: Vasily Philipov <vasilyf@mellanox.com>
2016-12-12 08:38:38 -06:00
tap
doc: add ThunderX nicvf Updated doc/guides/nics/overview.rst, doc/guides/nics/thunderx.rst and release notes Changed "*" to "P" in overview.rst to capture the partially supported feature as "*" creating alignment issues with Sphinx table Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Signed-off-by: Slawomir Rosek <slawomir.rosek@semihalf.com> Signed-off-by: Maciej Czekaj <maciej.czekaj@caviumnetworks.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-06-17 18:59:53 +05:30
thunderx
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
virtio
vhost: add driver on top of the library The patch introduces a new PMD. This PMD is implemented as thin wrapper of librte_vhost. It means librte_vhost is also needed to compile the PMD. The vhost messages will be handled only when a port is started. So start a port first, then invoke QEMU. The PMD has 2 parameters. - iface: The parameter is used to specify a path to connect to a virtio-net device. - queues: The parameter is used to specify the number of the queues virtio-net device has. (Default: 1) Here is an example. $ ./testpmd -c f -n 4 --vdev 'eth_vhost0,iface=/tmp/sock0,queues=1' -- -i To connect above testpmd, here is qemu command example. $ qemu-system-x86_64 \ <snip> -chardev socket,id=chr0,path=/tmp/sock0 \ -netdev vhost-user,id=net0,chardev=chr0,vhostforce,queues=1 \ -device virtio-net-pci,netdev=net0,mq=on Signed-off-by: Tetsuya Mukawa <mukawa@igel.co.jp> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Yuanhan Liu <yuanhan.liu@linux.intel.com> Acked-by: Rich Lane <rich.lane@bigswitch.com> Tested-by: Rich Lane <rich.lane@bigswitch.com> Update for queue state event name: Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2016-03-21 14:45:08 +09:00
vhost
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
vmxnet3
pcap_ring
**Figures**
doc: refactor figure numbers into references This change adds automatic figure references to the docs. The figure numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. The patch makes the following changes. * Changes image:: tag to figure:: and moves image caption to the figure. * Adds captions to figures that didn't previously have any. * Un-templates the |image-name| substitution definitions into explicit figure:: tags. They weren't used more than once anyway and Sphinx doesn't support them for figure. * Adds a target to each image that didn't previously have one so that they can be cross-referenced. * Renamed existing image target to match the image name for consistency. * Replaces the Figures lists with automatic :numref: :ref: entries to generate automatic numbering and captions. * Replaces "Figure" references with automatic :numref: references. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-05-18 12:34:06 +01:00
:numref:`figure_single_port_nic` :ref:`figure_single_port_nic`
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
doc: refactor figure numbers into references This change adds automatic figure references to the docs. The figure numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. The patch makes the following changes. * Changes image:: tag to figure:: and moves image caption to the figure. * Adds captions to figures that didn't previously have any. * Un-templates the |image-name| substitution definitions into explicit figure:: tags. They weren't used more than once anyway and Sphinx doesn't support them for figure. * Adds a target to each image that didn't previously have one so that they can be cross-referenced. * Renamed existing image target to match the image name for consistency. * Replaces the Figures lists with automatic :numref: :ref: entries to generate automatic numbering and captions. * Replaces "Figure" references with automatic :numref: references. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-05-18 12:34:06 +01:00
:numref:`figure_perf_benchmark` :ref:`figure_perf_benchmark`
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
doc: refactor figure numbers into references This change adds automatic figure references to the docs. The figure numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. The patch makes the following changes. * Changes image:: tag to figure:: and moves image caption to the figure. * Adds captions to figures that didn't previously have any. * Un-templates the |image-name| substitution definitions into explicit figure:: tags. They weren't used more than once anyway and Sphinx doesn't support them for figure. * Adds a target to each image that didn't previously have one so that they can be cross-referenced. * Renamed existing image target to match the image name for consistency. * Replaces the Figures lists with automatic :numref: :ref: entries to generate automatic numbering and captions. * Replaces "Figure" references with automatic :numref: references. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-05-18 12:34:06 +01:00
:numref:`figure_fast_pkt_proc` :ref:`figure_fast_pkt_proc`
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
doc: refactor figure numbers into references This change adds automatic figure references to the docs. The figure numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. The patch makes the following changes. * Changes image:: tag to figure:: and moves image caption to the figure. * Adds captions to figures that didn't previously have any. * Un-templates the |image-name| substitution definitions into explicit figure:: tags. They weren't used more than once anyway and Sphinx doesn't support them for figure. * Adds a target to each image that didn't previously have one so that they can be cross-referenced. * Renamed existing image target to match the image name for consistency. * Replaces the Figures lists with automatic :numref: :ref: entries to generate automatic numbering and captions. * Replaces "Figure" references with automatic :numref: references. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-05-18 12:34:06 +01:00
:numref:`figure_inter_vm_comms` :ref:`figure_inter_vm_comms`
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
doc: refactor figure numbers into references This change adds automatic figure references to the docs. The figure numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. The patch makes the following changes. * Changes image:: tag to figure:: and moves image caption to the figure. * Adds captions to figures that didn't previously have any. * Un-templates the |image-name| substitution definitions into explicit figure:: tags. They weren't used more than once anyway and Sphinx doesn't support them for figure. * Adds a target to each image that didn't previously have one so that they can be cross-referenced. * Renamed existing image target to match the image name for consistency. * Replaces the Figures lists with automatic :numref: :ref: entries to generate automatic numbering and captions. * Replaces "Figure" references with automatic :numref: references. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-05-18 12:34:06 +01:00
:numref:`figure_host_vm_comms` :ref:`figure_host_vm_comms`
doc: nics guide Create nics guide by moving chapters about Intel and Mellanox NICs. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-01-31 23:06:06 +01:00
doc: refactor figure numbers into references This change adds automatic figure references to the docs. The figure numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. The patch makes the following changes. * Changes image:: tag to figure:: and moves image caption to the figure. * Adds captions to figures that didn't previously have any. * Un-templates the |image-name| substitution definitions into explicit figure:: tags. They weren't used more than once anyway and Sphinx doesn't support them for figure. * Adds a target to each image that didn't previously have one so that they can be cross-referenced. * Renamed existing image target to match the image name for consistency. * Replaces the Figures lists with automatic :numref: :ref: entries to generate automatic numbering and captions. * Replaces "Figure" references with automatic :numref: references. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-05-18 12:34:06 +01:00
:numref:`figure_host_vm_comms_qemu` :ref:`figure_host_vm_comms_qemu`
:numref:`figure_vmxnet3_int` :ref:`figure_vmxnet3_int`
:numref:`figure_vswitch_vm` :ref:`figure_vswitch_vm`
:numref:`figure_vm_vm_comms` :ref:`figure_vm_vm_comms`
Reference in New Issue Copy Permalink