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

62 lines
761 B
ReStructuredText
Raw Normal View History

doc: convert Intel license headers to SPDX tags Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-02-01 17:18:17 +00:00
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2010-2014 Intel Corporation.
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
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: document NIC features Document NIC features, add more information about them and add more implementation related support. Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Signed-off-by: John McNamara <john.mcnamara@intel.com> Reviewed-by: Andrew Rybchenko <arybchenko@solarflare.com> Acked-by: Shreyansh Jain <shreyansh.jain@nxp.com>
2017-08-04 14:06:13 +01:00
features
doc: explain compiling and testing of PMD Add a section in NIC drivers documentation to explain compiling and testing of a PMD. It also mentions about host setup, which is required before running testpmd. Add label "testpmd_ug" to refer user guide. Signed-off-by: Shijith Thotton <shijith.thotton@caviumnetworks.com> Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-04-12 00:26:41 +05:30
build_and_test
doc: add af_packet PMD guide As of commit 364e08f2bbc0, DPDK allows an application to send and receive raw packets using an AF_PACKET and PACKET_MMAP, when using Linux Kernel. This complements it by adding a simple guide with the following information: - An introduction, where a brief explanation of this driver is given, pointing out the dependency on PACKET_MMAP; - Which options are supported at configuration time, while setting up an interface, and it's inherent limitations; - What the prerequisites are; - A command line example of how to set up a DPDK port using the af_packet driver. Since there's a dependency in PACKET_MMAP, the guide also points to the original Kernel documentation, so the reader can get more details. Signed-off-by: Tiago Lam <tiago.lam@intel.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-12-17 09:14:22 +00:00
af_packet
net/af_xdp: introduce AF_XDP PMD Add a new PMD driver for AF_XDP which is a proposed faster version of AF_PACKET interface in Linux. More info about AF_XDP, please refer to [1] [2]. This is the vanilla version PMD which just uses a raw buffer registered as the umem. [1] https://fosdem.org/2018/schedule/event/af_xdp/ [2] https://lwn.net/Articles/745934/ Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Luca Boccassi <bluca@debian.org> Reviewed-by: Stephen Hemminger <stephen@networkplumber.org>
2019-04-04 16:51:13 +08:00
af_xdp
net/ark: stub PMD for Atomic Rules Arkville Enable Arkville on supported configurations Add overview documentation Minimum driver support for valid compile Arkville PMD is not supported on ARM or PowerPC at this time Signed-off-by: Ed Czeck <ed.czeck@atomicrules.com> Signed-off-by: John Miller <john.miller@atomicrules.com>
2017-04-04 15:50:23 -04:00
ark
net/atlantic: add PMD driver skeleton Makefile/meson build infrastructure, atl_ethdev minimal skeleton, header with aquantia aQtion NIC device and vendor IDs. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com>
2018-10-12 11:09:03 +00:00
atlantic
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
doc: add guide for AMD axgbe Ethernet PMD Signed-off-by: Ravi Kumar <ravi1.kumar@amd.com>
2018-04-06 08:36:44 -04:00
axgbe
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: add NXP DPAA PMD documentation Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
2017-09-28 17:59:37 +05:30
dpaa
doc: add DPAA2 NIC details This patch adds the NXP dpaa2 architecture and pmd details in the Network interfaces section. Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-04-11 19:19:18 +05:30
dpaa2
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
doc: add guide for ENETC PMD Add enetc usage document to compile and run the DPDK application on enetc supported platform. This document introduces the enetc driver, supported platforms and supported features. Signed-off-by: Gagandeep Singh <g.singh@nxp.com> Acked-by: Shreyansh Jain <shreyansh.jain@nxp.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-10-03 19:06:08 +05:30
enetc
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
net/hinic: add build and doc files Add build and doc files along with hinic_pmd_ethdev.c which just includes PMD register and log initialization for compilation. Signed-off-by: Ziyang Xuan <xuanziyang2@huawei.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
2019-06-27 16:18:20 +08:00
hinic
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
net/ice: support device initialization Update the documents too. Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com> Signed-off-by: Qiming Yang <qiming.yang@intel.com> Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com> Signed-off-by: Jingjing Wu <jingjing.wu@intel.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com> Reviewed-by: Qi Zhang <qi.z.zhang@intel.com>
2018-12-18 16:46:24 +08:00
ice
net/ifc: make driver name consistent Make the compiler switch name and document name consistent as ``ifc`` to avoid confusion. Also rename the map file to standard name for meson build in the process. Signed-off-by: Xiao Wang <xiao.w.wang@intel.com> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2018-06-13 19:32:45 +08:00
ifc
doc: add igb guide This patch adds user guide specifically for igb NIC, like ixgbe, to list all the supported features and known issues. Signed-off-by: Wei Zhao <wei.zhao1@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-02 11:29:32 +08:00
igb
net/ipn3ke: add new driver Add Intel FPGA Acceleration NIC IPN3KE ethdev PMD driver. Signed-off-by: Rosen Xu <rosen.xu@intel.com> Signed-off-by: Andy Pei <andy.pei@intel.com> Signed-off-by: Dan Wei <dan.wei@intel.com>
2019-04-16 11:17:40 +08:00
ipn3ke
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
net/memif: introduce memory interface PMD Shared memory packet interface (memif) PMD allows for DPDK and any other client using memif (DPDK, VPP, libmemif) to communicate using shared memory. The created device transmits packets in a raw format. It can be used with Ethernet mode, IP mode, or Punt/Inject. At this moment, only Ethernet mode is supported in DPDK memif implementation. Memif is Linux only. Signed-off-by: Jakub Grajciar <jgrajcia@cisco.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
2019-06-06 13:38:50 +02:00
memif
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
net/mvneta: add PMD skeleton Add neta pmd driver skeleton providing base for the further development. Signed-off-by: Natalie Samsonov <nsamsono@marvell.com> Signed-off-by: Yelena Krivosheev <yelena@marvell.com> Signed-off-by: Dmitri Epshtein <dima@marvell.com> Signed-off-by: Zyta Szpak <zr@semihalf.com> Signed-off-by: Andrzej Ostruszka <amo@semihalf.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-10-03 09:22:09 +02:00
mvneta
net/mrvl: rename PMD as mvpp2 The name "mrvl" for Marvell PMD driver for PPv2 Marvell PPv2 (Packet Processor v2) 1/10 Gbps adapter is too generic and causes problem for adding new PMD drivers for other Marvell devices. Changed to "mvpp2" for specific Marvell PPv2 PMD. This patch doesn't introduce any change except renaming. Signed-off-by: Natalie Samsonov <nsamsono@marvell.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-03-26 16:38:50 +02:00
mvpp2
net/netvsc: add documentation Matching documentation for new netvsc device. Includes a brief note about the restart issue. Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
2018-07-13 10:06:44 -07:00
netvsc
net/nfb: add new netcope driver Added new net driver for Netcope nfb cards Signed-off-by: Rastislav Cernay <cernay@netcope.com>
2019-04-07 17:03:21 +02:00
nfb
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
doc: add octeontx ethdev driver documentation Adding octeontx ethdev driver documentation and claim octeontx ethdev driver maintainership. Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-10-08 18:14:30 +05:30
octeontx
net/octeontx2: add build and doc infrastructure Adding bare minimum PMD library and doc build infrastructure and claim the maintainership for octeontx2 PMD. Signed-off-by: Jerin Jacob <jerinj@marvell.com> Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Signed-off-by: Kiran Kumar K <kirankumark@marvell.com>
2019-05-28 14:25:22 +05:30
octeontx2
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
doc: add softnic documentation Add softnic documentation to NIC drivers guide. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
2018-07-24 16:50:24 +01:00
softnic
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
net/vdev_netvsc: introduce Hyper-V platform driver This patch lays the groundwork for this driver (draft documentation, copyright notices, code base skeleton and build system hooks). While it can be successfully compiled and invoked, it's an empty shell at this stage. Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com> Signed-off-by: Matan Azrad <matan@mellanox.com>
2018-01-18 13:51:42 +00:00
vdev_netvsc
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
net/failsafe: add fail-safe PMD Introduce the fail-safe poll mode driver initialization and enable its build infrastructure. This PMD allows for applications to benefit from true hot-plugging support without having to implement it. It intercepts and manages Ethernet device removal events issued by slave PMDs and re-initializes them transparently when brought back. It also allows defining a contingency to the removal of a device, by designating a fail-over device that will take on transmitting operations if the preferred device is removed. Applications only see a fail-safe instance, without caring for underlying activity ensuring their continued operations. Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com> Acked-by: Olga Shern <olgas@mellanox.com>
2017-07-18 14:48:14 +02:00
fail_safe
Reference in New Issue Copy Permalink