e682cb5d12
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>
87 lines
2.5 KiB
ReStructuredText
87 lines
2.5 KiB
ReStructuredText
.. 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:
|
|
|
|
overview
|
|
build_and_test
|
|
ark
|
|
avp
|
|
bnx2x
|
|
bnxt
|
|
cxgbe
|
|
dpaa2
|
|
e1000em
|
|
ena
|
|
enic
|
|
fm10k
|
|
i40e
|
|
ixgbe
|
|
intel_vf
|
|
kni
|
|
liquidio
|
|
mlx4
|
|
mlx5
|
|
nfp
|
|
qede
|
|
sfc_efx
|
|
szedata2
|
|
tap
|
|
thunderx
|
|
virtio
|
|
vhost
|
|
vmxnet3
|
|
pcap_ring
|
|
|
|
**Figures**
|
|
|
|
:numref:`figure_single_port_nic` :ref:`figure_single_port_nic`
|
|
|
|
:numref:`figure_perf_benchmark` :ref:`figure_perf_benchmark`
|
|
|
|
:numref:`figure_fast_pkt_proc` :ref:`figure_fast_pkt_proc`
|
|
|
|
:numref:`figure_inter_vm_comms` :ref:`figure_inter_vm_comms`
|
|
|
|
:numref:`figure_host_vm_comms` :ref:`figure_host_vm_comms`
|
|
|
|
: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`
|