All of lore.kernel.org
 help / color / mirror / Atom feed
From: Shijith Thotton <shijith.thotton@caviumnetworks.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
	John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org
Subject: [PATCH v2 07/10] doc: refer PMD compile and test section from liquidio doc
Date: Wed, 12 Apr 2017 00:26:47 +0530	[thread overview]
Message-ID: <1491937010-16553-8-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/liquidio.rst | 123 ++++++++++++-------------------------------
 1 file changed, 33 insertions(+), 90 deletions(-)

diff --git a/doc/guides/nics/liquidio.rst b/doc/guides/nics/liquidio.rst
index 9ffdc35..b7c80c5 100644
--- a/doc/guides/nics/liquidio.rst
+++ b/doc/guides/nics/liquidio.rst
@@ -80,90 +80,6 @@ Please note that enabling debugging options may affect system performance.
   Toggle display of register reads and writes.
 
 
-.. _lio_driver-compilation:
-
-Driver Compilation
-------------------
-
-To compile LiquidIO PMD for Linux x86_64 gcc target, run the following "make"
-command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make install T=x86_64-native-linuxapp-gcc
-
-
-Sample Application Notes
-------------------------
-
-This section demonstrates how to launch ``testpmd`` with LiquidIO® CN23XX
-device managed by ``librte_pmd_lio`` in Linux operating system.
-
-#. Mount huge pages:
-
-   .. code-block:: console
-
-      mkdir /mnt/huge
-      mount -t hugetlbfs nodev /mnt/huge
-
-#. Request huge pages:
-
-   .. code-block:: console
-
-      echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
-
-#. Load ``vfio-pci`` driver:
-
-   .. code-block:: console
-
-      modprobe vfio-pci
-
-#. Bind the LiquidIO VFs to ``vfio-pci`` loaded in previous step:
-
-   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:03:00.3 0000:03:08.3
-
-#. Start ``testpmd`` with basic parameters:
-
-   .. code-block:: console
-
-      ./build/app/testpmd -c 0xf -n 4 -- -i
-
-   Example output:
-
-   .. code-block:: console
-
-      [...]
-      EAL: PCI device 0000:03:00.3 on NUMA socket 0
-      EAL:   probe driver: 177d:9712 net_liovf
-      EAL:   using IOMMU type 1 (Type 1)
-      PMD: net_liovf[03:00.3]INFO: DEVICE : CN23XX VF
-      EAL: PCI device 0000:03:08.3 on NUMA socket 0
-      EAL:   probe driver: 177d:9712 net_liovf
-      PMD: net_liovf[03:08.3]INFO: DEVICE : CN23XX VF
-      Interactive-mode selected
-      USER1: create a new mbuf pool <mbuf_pool_socket_0>: n=171456, size=2176, socket=0
-      Configuring Port 0 (socket 0)
-      PMD: net_liovf[03:00.3]INFO: Starting port 0
-      Port 0: F2:A8:1B:5E:B4:66
-      Configuring Port 1 (socket 0)
-      PMD: net_liovf[03:08.3]INFO: Starting port 1
-      Port 1: 32:76:CC:EE:56:D7
-      Checking link statuses...
-      Port 0 Link Up - speed 10000 Mbps - full-duplex
-      Port 1 Link Up - speed 10000 Mbps - full-duplex
-      Done
-      testpmd>
-
-
 SR-IOV: Prerequisites and Sample Application Notes
 --------------------------------------------------
 
@@ -216,7 +132,6 @@ This section provides instructions to configure SR-IOV with Linux OS.
       echo 1 > /sys/bus/pci/devices/0000:03:00.0/sriov_numvfs
       echo 1 > /sys/bus/pci/devices/0000:03:00.1/sriov_numvfs
 
-
 #. Assign VF MAC address:
 
    Assign MAC address to the VF using iproute2 utility. The syntax is::
@@ -229,7 +144,6 @@ This section provides instructions to configure SR-IOV with Linux OS.
 
       ip link set p4p1 vf 0 mac F2:A8:1B:5E:B4:66
 
-
 #. Assign VF(s) to VM.
 
    The VF devices may be passed through to the guest VM using qemu or
@@ -245,12 +159,41 @@ This section provides instructions to configure SR-IOV with Linux OS.
       -device virtio-blk-pci,scsi=off,drive=disk1,id=virtio-disk1,bootindex=1 \
       -device vfio-pci,host=03:00.3 -device vfio-pci,host=03:08.3
 
-
 #. Running testpmd
 
-   Refer :ref:`notes above <lio_driver-compilation>`
-   to compile and run ``testpmd`` application.
-   Use ``igb_uio`` instead of ``vfio-pci`` in VM.
+   Refer to the document
+   :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` to run
+   ``testpmd`` application.
+
+   .. note::
+
+      Use ``igb_uio`` instead of ``vfio-pci`` in VM.
+
+   Example output:
+
+   .. code-block:: console
+
+      [...]
+      EAL: PCI device 0000:03:00.3 on NUMA socket 0
+      EAL:   probe driver: 177d:9712 net_liovf
+      EAL:   using IOMMU type 1 (Type 1)
+      PMD: net_liovf[03:00.3]INFO: DEVICE : CN23XX VF
+      EAL: PCI device 0000:03:08.3 on NUMA socket 0
+      EAL:   probe driver: 177d:9712 net_liovf
+      PMD: net_liovf[03:08.3]INFO: DEVICE : CN23XX VF
+      Interactive-mode selected
+      USER1: create a new mbuf pool <mbuf_pool_socket_0>: n=171456, size=2176, socket=0
+      Configuring Port 0 (socket 0)
+      PMD: net_liovf[03:00.3]INFO: Starting port 0
+      Port 0: F2:A8:1B:5E:B4:66
+      Configuring Port 1 (socket 0)
+      PMD: net_liovf[03:08.3]INFO: Starting port 1
+      Port 1: 32:76:CC:EE:56:D7
+      Checking link statuses...
+      Port 0 Link Up - speed 10000 Mbps - full-duplex
+      Port 1 Link Up - speed 10000 Mbps - full-duplex
+      Done
+      testpmd>
 
 
 Limitations
-- 
1.8.3.1

  parent reply	other threads:[~2017-04-11 18:59 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   ` [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   ` [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     ` Shijith Thotton [this message]
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=1491937010-16553-8-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 \
    /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.