[dpdk-dev,4/8] doc: refer PMD compile and test section from cxgbe doc
Checks
Commit Message
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>
---
doc/guides/nics/cxgbe.rst | 109 ++++------------------------------------------
1 file changed, 9 insertions(+), 100 deletions(-)
Comments
> -----Original Message-----
> From: Shijith Thotton [mailto:shijith.thotton@caviumnetworks.com]
> Sent: Thursday, April 6, 2017 8:52 AM
> To: Mcnamara, John <john.mcnamara@intel.com>; Yigit, Ferruh
> <ferruh.yigit@intel.com>; Rahul Lakkireddy <rahul.lakkireddy@chelsio.com>
> Cc: dev@dpdk.org
> Subject: [PATCH 4/8] doc: refer PMD compile and test section from cxgbe
> doc
>
> 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>
I've checked this from a documentation point of view but the PMD
maintainer should also check that the global build instructions
are valid for the PMD.
Acked-by: John McNamara <john.mcnamara@intel.com>
@@ -125,24 +125,11 @@ enabling debugging options may affect system performance.
.. _driver-compilation:
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile CXGBE PMD for Linux x86_64 gcc target, run the following "make"
-command:
-
-.. code-block:: console
-
- cd <DPDK-source-directory>
- make config T=x86_64-native-linuxapp-gcc install
-
-To compile CXGBE PMD for FreeBSD x86_64 clang target, run the following "gmake"
-command:
-
-.. code-block:: console
+Driver compilation and testing
+------------------------------
- cd <DPDK-source-directory>
- gmake config T=x86_64-native-bsdapp-clang install
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.
Linux
-----
@@ -218,13 +205,6 @@ Running testpmd
This section demonstrates how to launch **testpmd** with Chelsio T5
devices managed by librte_pmd_cxgbe in Linux operating system.
-#. Change to DPDK source directory where the target has been compiled in
- section :ref:`driver-compilation`:
-
- .. code-block:: console
-
- cd <DPDK-source-directory>
-
#. Load the kernel module:
.. code-block:: console
@@ -255,89 +235,18 @@ devices managed by librte_pmd_cxgbe in Linux operating system.
modprobe -ar cxgb4 csiostor
-#. Request huge pages:
-
- .. code-block:: console
-
- echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
-
-#. Mount huge pages:
-
- .. code-block:: console
-
- mkdir /mnt/huge
- mount -t hugetlbfs nodev /mnt/huge
-
-#. Load igb_uio or vfio-pci driver:
-
- .. code-block:: console
-
- insmod ./x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
-
- or
-
- .. code-block:: console
-
- modprobe vfio-pci
-
-#. Bind the Chelsio T5 adapters to igb_uio or vfio-pci loaded in the previous
- step:
-
- .. code-block:: console
-
- ./usertools/dpdk-devbind.py --bind igb_uio 0000:02:00.4
-
- or
+#. Running testpmd
- Setup VFIO permissions for regular users and then bind to vfio-pci:
-
- .. code-block:: console
-
- sudo chmod a+x /dev/vfio
-
- sudo chmod 0666 /dev/vfio/*
-
- ./usertools/dpdk-devbind.py --bind vfio-pci 0000:02:00.4
+ Refer to the section :ref:`driver-compilation`.
.. note::
Currently, CXGBE PMD only supports the binding of PF4 for Chelsio T5 NICs.
-#. Start testpmd with basic parameters:
-
- .. code-block:: console
-
- ./x86_64-native-linuxapp-gcc/app/testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i
-
- Example output:
-
- .. code-block:: console
-
- [...]
- EAL: PCI device 0000:02:00.4 on NUMA socket -1
- EAL: probe driver: 1425:5401 rte_cxgbe_pmd
- EAL: PCI memory mapped at 0x7fd7c0200000
- EAL: PCI memory mapped at 0x7fd77cdfd000
- EAL: PCI memory mapped at 0x7fd7c10b7000
- PMD: rte_cxgbe_pmd: fw: 1.13.32.0, TP: 0.1.4.8
- PMD: rte_cxgbe_pmd: Coming up as MASTER: Initializing adapter
- Interactive-mode selected
- Configuring Port 0 (socket 0)
- Port 0: 00:07:43:2D:EA:C0
- Configuring Port 1 (socket 0)
- Port 1: 00:07:43:2D:EA:C8
- Checking link statuses...
- PMD: rte_cxgbe_pmd: Port0: passive DA port module inserted
- PMD: rte_cxgbe_pmd: Port1: passive DA port module inserted
- Port 0 Link Up - speed 10000 Mbps - full-duplex
- Port 1 Link Up - speed 10000 Mbps - full-duplex
- Done
- testpmd>
-
-.. note::
+ .. note::
- Flow control pause TX/RX is disabled by default and can be enabled via
- testpmd. Refer section :ref:`flow-control` for more details.
+ Flow control pause TX/RX is disabled by default and can be enabled via
+ testpmd. Refer section :ref:`flow-control` for more details.
FreeBSD
-------