From: Shijith Thotton <shijith.thotton@caviumnetworks.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
John McNamara <john.mcnamara@intel.com>,
Rasesh Mody <rasesh.mody@cavium.com>,
Harish Patil <harish.patil@cavium.com>
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v2 09/10] doc: refer PMD compile and test section from qede doc
Date: Wed, 12 Apr 2017 00:26:49 +0530 [thread overview]
Message-ID: <1491937010-16553-10-git-send-email-shijith.thotton@caviumnetworks.com> (raw)
In-Reply-To: <1491937010-16553-1-git-send-email-shijith.thotton@caviumnetworks.com>
Refer the section which explains driver compilation and running of
testpmd in Linux, instead of describing it in driver documentation.
Signed-off-by: Shijith Thotton <shijith.thotton@caviumnetworks.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
---
doc/guides/nics/qede.rst | 176 ++++++++++++++++++-----------------------------
1 file changed, 66 insertions(+), 110 deletions(-)
diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst
index eacb3da..afe2df8 100644
--- a/doc/guides/nics/qede.rst
+++ b/doc/guides/nics/qede.rst
@@ -124,64 +124,96 @@ enabling debugging options may affect system performance.
Empty string indicates driver will pick up the firmware file
from the default location.
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
+Driver compilation and testing
+------------------------------
-To compile QEDE PMD for Linux x86_64 gcc target, run the following ``make``
-command::
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.
- cd <DPDK-source-directory>
- make config T=x86_64-native-linuxapp-gcc install
+SR-IOV: Prerequisites and Sample Application Notes
+--------------------------------------------------
-To compile QEDE PMD for Linux x86_64 clang target, run the following ``make``
-command::
+This section provides instructions to configure SR-IOV with Linux OS.
- cd <DPDK-source-directory>
- make config T=x86_64-native-linuxapp-clang install
+**Note**: librte_pmd_qede will be used to bind to SR-IOV VF device and Linux native kernel driver (QEDE) will function as SR-IOV PF driver. Requires PF driver to be 8.10.x.x or higher.
-To compile QEDE PMD for FreeBSD x86_64 clang target, run the following ``gmake``
-command::
+#. Verify SR-IOV and ARI capability is enabled on the adapter using ``lspci``:
- cd <DPDK-source-directory>
- gmake config T=x86_64-native-bsdapp-clang install
+ .. code-block:: console
-To compile QEDE PMD for FreeBSD x86_64 gcc target, run the following ``gmake``
-command::
+ lspci -s <slot> -vvv
- cd <DPDK-source-directory>
- gmake config T=x86_64-native-bsdapp-gcc install -Wl,-rpath=\
- /usr/local/lib/gcc49 CC=gcc49
+ Example output:
+ .. code-block:: console
-Sample Application Notes
-~~~~~~~~~~~~~~~~~~~~~~~~
+ [...]
+ Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
+ [...]
+ Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
+ [...]
+ Kernel driver in use: igb_uio
-This section demonstrates how to launch ``testpmd`` with QLogic 4xxxx
-devices managed by ``librte_pmd_qede`` in Linux operating system.
+#. Load the kernel module:
-#. Request huge pages:
+ .. code-block:: console
+
+ modprobe qede
+
+ Example output:
.. code-block:: console
- echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/ \
- nr_hugepages
+ systemd-udevd[4848]: renamed network interface eth0 to ens5f0
+ systemd-udevd[4848]: renamed network interface eth1 to ens5f1
-#. Load ``igb_uio`` driver:
+#. Bring up the PF ports:
.. code-block:: console
- insmod ./x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
+ ifconfig ens5f0 up
+ ifconfig ens5f1 up
+
+#. Create VF device(s):
+
+ Echo the number of VFs to be created into ``"sriov_numvfs"`` sysfs entry
+ of the parent PF.
-#. Bind the QLogic 4xxxx adapters to ``igb_uio`` loaded in the
- previous step:
+ Example output:
.. code-block:: console
- ./usertools/dpdk-devbind.py --bind igb_uio 0000:84:00.0 0000:84:00.1 \
- 0000:84:00.2 0000:84:00.3
+ echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
-#. Start ``testpmd`` with basic parameters:
- (Enable QEDE_DEBUG_INFO=y to view informational messages)
+
+#. Assign VF MAC address:
+
+ Assign MAC address to the VF using iproute2 utility. The syntax is::
+
+ ip link set <PF iface> vf <VF id> mac <macaddr>
+
+ Example output:
+
+ .. code-block:: console
+
+ ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
+
+
+#. PCI Passthrough:
+
+ The VF devices may be passed through to the guest VM using ``virt-manager`` or
+ ``virsh``. QEDE PMD should be used to bind the VF devices in the guest VM
+ using the instructions from Driver compilation and testing section above.
+
+
+#. Running testpmd
+ (Enable QEDE_DEBUG_INFO=y to view informational messages):
+
+ Refer to the document
+ :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` to run
+ ``testpmd`` application.
+
+ Example output:
.. code-block:: console
@@ -236,79 +268,3 @@ devices managed by ``librte_pmd_qede`` in Linux operating system.
Port 3 Link Up - speed 25000 Mbps - full-duplex
Done
testpmd>
-
-
-SR-IOV: Prerequisites and Sample Application Notes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This section provides instructions to configure SR-IOV with Linux OS.
-
-**Note**: librte_pmd_qede will be used to bind to SR-IOV VF device and Linux native kernel driver (QEDE) will function as SR-IOV PF driver. Requires PF driver to be 8.10.x.x or higher.
-
-#. Verify SR-IOV and ARI capability is enabled on the adapter using ``lspci``:
-
- .. code-block:: console
-
- lspci -s <slot> -vvv
-
- Example output:
-
- .. code-block:: console
-
- [...]
- Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
- [...]
- Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
- [...]
- Kernel driver in use: igb_uio
-
-#. Load the kernel module:
-
- .. code-block:: console
-
- modprobe qede
-
- Example output:
-
- .. code-block:: console
-
- systemd-udevd[4848]: renamed network interface eth0 to ens5f0
- systemd-udevd[4848]: renamed network interface eth1 to ens5f1
-
-#. Bring up the PF ports:
-
- .. code-block:: console
-
- ifconfig ens5f0 up
- ifconfig ens5f1 up
-
-#. Create VF device(s):
-
- Echo the number of VFs to be created into ``"sriov_numvfs"`` sysfs entry
- of the parent PF.
-
- Example output:
-
- .. code-block:: console
-
- echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
-
-
-#. Assign VF MAC address:
-
- Assign MAC address to the VF using iproute2 utility. The syntax is::
-
- ip link set <PF iface> vf <VF id> mac <macaddr>
-
- Example output:
-
- .. code-block:: console
-
- ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
-
-
-#. PCI Passthrough:
-
- The VF devices may be passed through to the guest VM using ``virt-manager`` or
- ``virsh``. QEDE PMD should be used to bind the VF devices in the guest VM
- using the instructions outlined in the Application notes above.
--
1.8.3.1
next prev parent reply other threads:[~2017-04-11 19:00 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-04-01 15:03 [dpdk-dev] [RFC 0/2] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-01 15:03 ` [dpdk-dev] [RFC 1/2] doc: add doc with steps to build PMD and run testpmd Shijith Thotton
2017-04-02 12:11 ` Mcnamara, John
2017-04-02 12:13 ` Mcnamara, John
2017-04-03 8:05 ` Shijith Thotton
2017-04-01 15:04 ` [dpdk-dev] [RFC 2/2] doc: include PMD build and run file in liquidio doc Shijith Thotton
2017-04-02 12:15 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 0/8] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-06 7:51 ` [dpdk-dev] [PATCH 1/8] doc: add doc to explain compiling and testing of PMD Shijith Thotton
2017-04-06 16:43 ` Mcnamara, John
2017-04-06 18:30 ` Thomas Monjalon
2017-04-07 7:07 ` Shijith Thotton
2017-04-07 9:23 ` Mcnamara, John
2017-04-07 9:34 ` Thomas Monjalon
2017-04-07 9:42 ` Jerin Jacob
2017-04-07 10:10 ` Shijith Thotton
2017-04-06 7:51 ` [dpdk-dev] [PATCH 2/8] doc: refer PMD compile and test section from liquidio doc Shijith Thotton
2017-04-06 16:43 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 3/8] doc: refer PMD compile and test section from bnx2x doc Shijith Thotton
2017-04-06 16:45 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 4/8] doc: refer PMD compile and test section from cxgbe doc Shijith Thotton
2017-04-06 16:45 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 5/8] doc: refer PMD compile and test section from ena doc Shijith Thotton
2017-04-06 16:45 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 6/8] doc: refer PMD compile and test section from i40e doc Shijith Thotton
2017-04-06 16:46 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 7/8] doc: refer PMD compile and test section from nfp doc Shijith Thotton
2017-04-06 16:46 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 8/8] doc: refer PMD compile and test section from qede doc Shijith Thotton
2017-04-06 16:46 ` Mcnamara, John
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 00/10] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 01/10] doc: add doc to explain compiling and testing of PMD Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 02/10] doc: refer PMD compile and test section from ark doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 03/10] doc: refer PMD compile and test section from bnx2x doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 04/10] doc: refer PMD compile and test section from cxgbe doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 05/10] doc: refer PMD compile and test section from ena doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 06/10] doc: refer PMD compile and test section from i40e doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 07/10] doc: refer PMD compile and test section from liquidio doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 08/10] doc: refer PMD compile and test section from nfp doc Shijith Thotton
2017-04-11 18:56 ` Shijith Thotton [this message]
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 10/10] doc: refer PMD compile and test section from thunderx doc Shijith Thotton
2017-04-12 15:23 ` [dpdk-dev] [PATCH v2 00/10] doc: consolidate common part among PMD docs Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1491937010-16553-10-git-send-email-shijith.thotton@caviumnetworks.com \
--to=shijith.thotton@caviumnetworks.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=harish.patil@cavium.com \
--cc=john.mcnamara@intel.com \
--cc=rasesh.mody@cavium.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).