All of lore.kernel.org
 help / color / mirror / Atom feed
From: Shijith Thotton <shijith.thotton@caviumnetworks.com>
To: John Mcnamara <john.mcnamara@intel.com>,
	Ferruh Yigit <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
Date: Thu,  6 Apr 2017 13:21:53 +0530	[thread overview]
Message-ID: <1491465117-11252-5-git-send-email-shijith.thotton@caviumnetworks.com> (raw)
In-Reply-To: <1491465117-11252-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>
---
 doc/guides/nics/cxgbe.rst | 109 ++++------------------------------------------
 1 file changed, 9 insertions(+), 100 deletions(-)

diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst
index 308a926..d193f66 100644
--- a/doc/guides/nics/cxgbe.rst
+++ b/doc/guides/nics/cxgbe.rst
@@ -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
 -------
-- 
1.8.3.1

  parent reply	other threads:[~2017-04-06  7:54 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-01 15:03 [RFC 0/2] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-01 15:03 ` [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 ` [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 ` [PATCH 0/8] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-06  7:51   ` [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   ` [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   ` [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   ` Shijith Thotton [this message]
2017-04-06 16:45     ` [PATCH 4/8] doc: refer PMD compile and test section from cxgbe doc Mcnamara, John
2017-04-06  7:51   ` [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   ` [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   ` [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   ` [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   ` [PATCH v2 00/10] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 01/10] doc: add doc to explain compiling and testing of PMD Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 02/10] doc: refer PMD compile and test section from ark doc Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 03/10] doc: refer PMD compile and test section from bnx2x doc Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 04/10] doc: refer PMD compile and test section from cxgbe doc Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 05/10] doc: refer PMD compile and test section from ena doc Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 06/10] doc: refer PMD compile and test section from i40e doc Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 07/10] doc: refer PMD compile and test section from liquidio doc Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 08/10] doc: refer PMD compile and test section from nfp doc Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 09/10] doc: refer PMD compile and test section from qede doc Shijith Thotton
2017-04-11 18:56     ` [PATCH v2 10/10] doc: refer PMD compile and test section from thunderx doc Shijith Thotton
2017-04-12 15:23     ` [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=1491465117-11252-5-git-send-email-shijith.thotton@caviumnetworks.com \
    --to=shijith.thotton@caviumnetworks.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=john.mcnamara@intel.com \
    --cc=rahul.lakkireddy@chelsio.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.