From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <Shijith.Thotton@cavium.com>
Received: from NAM03-CO1-obe.outbound.protection.outlook.com
(mail-co1nam03on0067.outbound.protection.outlook.com [104.47.40.67])
by dpdk.org (Postfix) with ESMTP id 75E3A68C5
for <dev@dpdk.org>; Tue, 11 Apr 2017 20:59:35 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com;
h=From:Date:Subject:Message-ID:Content-Type:MIME-Version;
bh=ucdhLQtioGnFbTUyO4RkaKxaSoMroxpYzi9HYbp7ukA=;
b=lc0YoPOsVXv0eqB7q1ARaH9nCCbZdvA0C7VdKrlVU0luCj+yViby/h0r0IdNgxeyg7TSPvjkSag6t07DmfVucRXLZDOo6QMHUQOJXtpvgRDU27muhSm/PriFh9KW1qpAmqQLccd3iEzyv+Yo7UgmwEPl78R/lPz160A8ChaG0SA=
Authentication-Results: intel.com; dkim=none (message not signed)
header.d=none;intel.com; dmarc=none action=none
header.from=caviumnetworks.com;
Received: from lio357.in.caveonetworks.com (14.140.2.178) by
DM3PR07MB2284.namprd07.prod.outlook.com (10.164.33.158) with Microsoft SMTP
Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id
15.1.1019.17; Tue, 11 Apr 2017 18:59:30 +0000
From: Shijith Thotton <shijith.thotton@caviumnetworks.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
John McNamara <john.mcnamara@intel.com>,
Helin Zhang <helin.zhang@intel.com>, Jingjing Wu <jingjing.wu@intel.com>
Cc: dev@dpdk.org
Date: Wed, 12 Apr 2017 00:26:46 +0530
Message-Id: <1491937010-16553-7-git-send-email-shijith.thotton@caviumnetworks.com>
X-Mailer: git-send-email 1.8.3.1
In-Reply-To: <1491937010-16553-1-git-send-email-shijith.thotton@caviumnetworks.com>
References: <1491465117-11252-1-git-send-email-shijith.thotton@caviumnetworks.com>
<1491937010-16553-1-git-send-email-shijith.thotton@caviumnetworks.com>
MIME-Version: 1.0
Content-Type: text/plain
X-Originating-IP: [14.140.2.178]
X-ClientProxiedBy: MAXPR01CA0027.INDPRD01.PROD.OUTLOOK.COM (10.164.147.34) To
DM3PR07MB2284.namprd07.prod.outlook.com (10.164.33.158)
X-MS-Office365-Filtering-Correlation-Id: 9ae27fac-67a5-4d24-04ae-08d4810ce3a5
X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0;
RULEID:(22001)(201703131423075)(201703031133081); SRVR:DM3PR07MB2284;
X-Microsoft-Exchange-Diagnostics: 1; DM3PR07MB2284;
3:Nto5y6+sVK163KFUrWOBZP0AUN4SewGvCGUJwf0eNpJ04sVfkdKNHndnOzCA5PwMQ5txYaVOAlhBouUrc4iB0j6SMPXB6gn1A4CxL/e89fPTW8IG8uc3B7X0sWiVmCpMcqxI5M78HLg60VUQrbwXD1wVKDGIgqo+4X+/bqkZROkuYcUQzypcsh17tsO4MuNs679uNmB8EznYN0vPWCyplCRmNxIvG/a93/1HQK/5e+baowEtIROUQ2aH3DUUx31rcRz209vrNgBPLGn2vVeUhSatCw28KIIIyM0kuqCuhCXTlqvBCPhzbKEUucGNQNsHbTaMvMBXUxZx/rZ/x+a44Q==;
25:9vNY9bJq1I7NvwolwZt+Fg1xdfNc5Je0RqZVLjj+xqf3PVE3kN28uQols4cqsijzjQNXm1dHofUob+0wpav4/leTpMxLkWRlUrQk/zstZCRZpGufmdCLuGLINzlCS1BQxTAqxirxaO513CzA3BT93+ipYds5i3iw4tuGwPbZcNL9wwgIiovstTjCnTJxVnuZUuyRA5e9QhnbVf/VTjVV9eY8qDElYiT2qZc+a+knBz3avvK1ZHiSESXNEnb4C9ai8WODAQ+z09sxE6r3cUhGCnMx+Mm88SMqmvXaspw4dShhSnIrkJ1oPyo3WDwiLAKGNwfcE8UaVTZllomg6rHz/FBJYVE0bXqLYddh1x6fvs+rDlsiOMGRfJTowZoKb3u2AeXty8YCoUy6JQK2OS/f2R/wIJwwtdFDkwSW5M5dejOH9uwMO4zyGrETlS90+I6n0fWrEAq6hmmg7hl8yGKnzg==
X-Microsoft-Exchange-Diagnostics: 1; DM3PR07MB2284;
31:4tOI5n0H5BbAcVYDPfBK2kynvwHXJh4u5VWJ9Lxghsl3L5YGm1sdgOIK6dAsr499v3Eba0cQdSSKg6fLJZMhTc/f3PGQkAc+i+QJbbTvUbbcTuVb/9OY5d6Xc1bLgCdCYAuT0W/H8bhgr/5+fmmHqdrPZDuAJVKDwOKOMQ8makxK8HToYPzv7OomVGS9fBoDqm5hG2tg6cMPb8RRW/O5kp8R3wo+lycJzWrT8nB6MMqldyUOABCbGNuryIW56euWsLht0aJvW5fkA/msG5AsPw==;
20:zxrVqnrRXnG71sAVNC0zvyU2qe7Z/+i7aPMCYv+PAT2CYhNjxK6Q/FJb7Cv9oMaSTkTx5BGJrIjdXXannBEoMy1iiGKd17euvJ0dz1LNLtigFyc9BKeiLTmmVwnIDNdwVoj05X2Yd8JxDNu28crwmEakcHWXYzCDmVJsft8/N1uPgE+77aQXwWT/vhhOIHNgYns4BOCRPuKzBW8AKb7uvBApgaMOS51Xmq+A2GtkbjKG19ENTJtPX1kFDL4vvO/ZJuqjYdz5uOi/K+XEUEKHPXOXgKDKmeC0vzSEA9nEa+eulD+FEB5sq0+NoBn8DN5LgdAux/lJcJD17FtLykwvN4o58sJXNi+ci26IJSRa0yvWceubLQiPwATW3PneyLtjRXRowAdp+BpDxeHatxlwCOrf0O3rL/Yo0vCjkwH9GHfCLhlj5Cw+9NfVlZgEmWJ/e0r+UK7qH6+2pg3pqiRg2DU6P6t4nUxRw/ZnZSC96r03CUsO/hbJzuIbKXXTbkd+xGt3zc4ankwx5lI9ms7zV/zgCkWfongd9tCG2i1Us118SVSA24BWL1aRFwT2rLWw6vaKKDAv2/WfvXjyFHQLSuAF9hD9e3QIVr2ZhAhXeVo=
X-Microsoft-Antispam-PRVS: <DM3PR07MB22843168CD5D44530FBCD34881000@DM3PR07MB2284.namprd07.prod.outlook.com>
X-Exchange-Antispam-Report-Test: UriScan:(228905959029699);
X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0;
RULEID:(6040450)(601004)(2401047)(8121501046)(5005006)(3002001)(10201501046)(93006095)(6041248)(20161123562025)(20161123560025)(201703131423075)(201702281528075)(201703061421075)(20161123555025)(20161123564025)(6072148);
SRVR:DM3PR07MB2284; BCL:0; PCL:0; RULEID:; SRVR:DM3PR07MB2284;
X-Microsoft-Exchange-Diagnostics: 1; DM3PR07MB2284;
4:Vd4PeCyR4mzktLBPUiq2eMKQRQAB6eIa90NydD6L+MuIrPvzfQsVrNai/mjnsSpmXxDFhiINBX4dGj3KrgqzONpN0XHzhg7npESbuZnMWx//CyUwGNKWqlCyobZNekVaZJfbWR9lhQdZNWDqKJQb0EZWCOB0jRMh5qjfnZ1qKanSvL6Cc3oRrV61cjeTmeonfUPwGGMQ6ihKsej8D174sBO8wybaJC2txs/Y/BRTwZDZcRI1IUMN2Y6Hgj4EoMi/b2LwnpOTEUqABxOQv+UkOXH9B+e9hRzhBHIIP98Gvw6HJkfZ0z3EE0Ias9oHSN/dy9qPm7HzPh+n9sRfUPYslAxqc5uBgzfLdaDBT9HioxgE1lwxsIlwcjmuXkOtaCXNKlkC/6pt5J8PBwpC1ZfKwY0AAcfRAcEg5rzmHq4ckyv6hYcSaBjZFpb7yTxeg/mFsJJPkBd6mih01V5Ryrfu0duqIYP3uQOkzMCJyHek4NODZL1SAZFP6Px6WEwpTHz/fOydiHw/i9kGg6rU6lLamTZ+fk+mV39lF5wj2IJZ7zsk+hFwtepUQfx4Is52QXllo03M/6svUpPTdX4dAlpsXsNhJLpOikurS5kW6zo+jK7xYFBmWAR/RrJEdlvBHYsRe8Pz6iVoj51ISQm/Bj2+EsI9rPna9A/zkTr7bnVU3jfhZSivosaNmQB0iQ5nJYdbFD9YUqUTDoMeSrR1Pee6WD8wi+VJkWF3mPOpTg0b7TZWJPCPUJlf8cAa/pvdX7WS
X-Forefront-PRVS: 0274272F87
X-Forefront-Antispam-Report: SFV:NSPM;
SFS:(10009020)(4630300001)(6009001)(39450400003)(39840400002)(39410400002)(39850400002)(39400400002)(5660300001)(6506006)(5003940100001)(66066001)(2950100002)(25786009)(42186005)(3846002)(6116002)(47776003)(6486002)(4720700003)(42882006)(6666003)(33646002)(5009440100003)(189998001)(305945005)(50466002)(81166006)(8676002)(36756003)(2906002)(6512007)(53936002)(4326008)(7736002)(38730400002)(48376002)(50226002)(76176999)(50986999)(110426004);
DIR:OUT; SFP:1101; SCL:1; SRVR:DM3PR07MB2284; H:lio357.in.caveonetworks.com;
FPR:; SPF:None; MLV:nov; PTR:InfoNoRecords; LANG:en;
X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; DM3PR07MB2284;
23:2NUyWYZdNanavZGQpJdxGbBVaQo0yMXx3bOM61hjJ?=
=?us-ascii?Q?44SCmfq1mbQbv7Kmou/kVPdr1kqD558EADZ9T1LmgP23kzD7U1H+M2DuycXr?=
=?us-ascii?Q?gydZk/063r3x58J54zhi3Nhp+KjDZXmEOFd6Idwd6Tdkt2KLiz8HBTyBW0k6?=
=?us-ascii?Q?XyIcgP/3xplpZBitD2N4Nye8lKZGZQCU4YNKLKU2dYzo0b8IJi5bZjHCA44N?=
=?us-ascii?Q?4vM7vHeT9EsYchV1WVVRHEeTsh+Arucl0h5WrJf56DX4GANsv3W8VcEv5/r0?=
=?us-ascii?Q?lPUkDzzBEJgIucrp+iZaDbd01rpiVy5R6/6adFwzyZNeRbYZ59eMXWDvKGZB?=
=?us-ascii?Q?8aeoYu/QOSaP9VBIRQTYUWLLUAYcjQ2NbW3xVyylSD68xQ2my217dz70S5v5?=
=?us-ascii?Q?r+NdsvR33NB0aK7T5BY1upNO1yqJlL2sB2o2Ml5sgCHBME9dSuG1+GIgzpPH?=
=?us-ascii?Q?I26kQiofJ0VgO46dxm2qRWvdNT/Tcd0sr1hRHVxfeHUzBqNzYh4R6OGc7TMY?=
=?us-ascii?Q?Rdw5kNcSgrsS1fB618I5PYLI1IrY4ZeOWqLUo0DRxJvtH37YY9odGMmxWfXW?=
=?us-ascii?Q?PY54e/WvefRRPZeELeNAHapBHl8ybVQpjKjS3XnjcHDcgndqjk7zoZGQ8UqL?=
=?us-ascii?Q?nZZeKfLTTTZ8KgJRS9WbFjLYbwxB9t3yEAQ1TQ8XFBeZA9L2rJfQgfIMNwOj?=
=?us-ascii?Q?z/P65J/5AjwsU4TP1f/NmJ8gg5wZ+7EYIUnCMZNP92akhue5XI18pMQ377ca?=
=?us-ascii?Q?tZSEKjY0opdDYPuBIboUNBGkS8lyPZq9QYsOJB8eFfWRFFNm9ejB3STNXv8I?=
=?us-ascii?Q?f14Wh+PNJKGJcMs/VnKFxtFDE3O1sk9RsBWfqjFsQni0Oq09HZ1mtVGaMGOn?=
=?us-ascii?Q?cDY/KyEm3xpTK1rUVtqlOgOnITzxC7gsym5kMlcUnVSUM0lN7umzjeSVkHjh?=
=?us-ascii?Q?enqhAR9VYPBrHEPU7C+zmfYp0fqZtszgeMvYHj/T0jNPzvO0gnAIk1UtGrYu?=
=?us-ascii?Q?ghYCzy928lHKE7BloUQFEkfjcMt1dGHejFu6QJ+zG+kuOSeAP9XKrwPDOysH?=
=?us-ascii?Q?rKkiv8=3D?=
X-Microsoft-Exchange-Diagnostics: 1; DM3PR07MB2284;
6:KXvHkeT8/TsG6enFolA/tkdN/b1OZBIAYCqmlkhmH6z9Hoha789yOWwBlYKULQ/sujR1cXfPekLP/aj6ipUT6teU12gqGcbyIZEsZo14yTxrQ2RRiFFyZquZ1XMa8oPOSvA7OC3DvBCzUKIjbtTUMu+6UanGtmH8QTXbsSYjadQ3WbJ6hTt3IS2nNCY2CnrJQW5XkjfY5fKzcKublgdILI6MO5Gt3zOWiLPLsnVbXpQb+GPtNZvG1OhulTyNSvkBuV1zTTXEZa69ZJWRm2JBynvkfrCMz6VLINrKOJsjojJBv6l/UdV1wc+KbS86iN0gd8lg9p6lvrwaeolCgu8DXmLk7YLK1S4vuqahzNrG4Mx7A9vTL+/ll8C3ar67471m2dGbWKBxIYlMJpoiHlCsrR3rfdAjLEUj6q1pJm8eTCNW4epWQoSYWg9RF55xy3x/XCF1W2fDHPAUAAluTdveuA==;
5:ptOf4RSdz8PPtphlZ0GknJ042m+RCZgNQSNiCDJF2X9bsj1hcU5eiYOhHi9hFsNeymaGhZIRAMM2DAG9Uq85+K55IMjMkM/cKrCeHNiDd4sWhlf8+HSXXGK9kGuELYfIe2omakPBDJNqsRt6FRsI6g==;
24:cdFMi053KVd3FbAswOH9hdL0ZhTeOFCQLIuF4x9QQ7p9zebATqDFUPhecUjJUsNoejE0le7gz2uObtRpbQr3ALJXZ6m9x4cEvN4Vxt0RcxY=
SpamDiagnosticOutput: 1:99
SpamDiagnosticMetadata: NSPM
X-Microsoft-Exchange-Diagnostics: 1; DM3PR07MB2284;
7:fJHbiNiFucQ1teJHPuN5GBemuhfQwZee3fZlPddFIpNn+tdiwmq80nUkRHOX6Vxug72BzRjZoxzJEB9gv+ZLHwAGhEXXUBSchNp6XOnwQEqf5FGyI45GqDYRD52602xT4wb6uYQGbfrB4RcngShHwbj+V0L8+EQl5ERCTg0xgVUi+N5bKvsGz1Jac3p10KJrYE1dGSENFLVXShrSAvsMAXix7y73WRWnigFpDqx3th7HPtOprI26GCvHwz/xVPVQFlL/71LQf2u8VFqXSD9TvzewkcIyFi/oLM9u0Gaqntp5cBs/Bz+saUNQCc6JxPsEkBF2LB8mCmOGVXdc0XQOcg==
X-OriginatorOrg: caviumnetworks.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Apr 2017 18:59:30.6860 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM3PR07MB2284
Subject: [dpdk-dev] [PATCH v2 06/10] doc: refer PMD compile and test section
from i40e doc
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Tue, 11 Apr 2017 18:59:36 -0000
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/i40e.rst | 108 ++++++++++++++++-------------------------------
1 file changed, 36 insertions(+), 72 deletions(-)
diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index d5efa3f..4d3c7ca 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -126,82 +126,15 @@ Please note that enabling debugging options may affect system performance.
Interrupt Throttling interval.
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the I40E PMD see :ref:`Getting Started Guide for Linux <linux_gsg>` or
-:ref:`Getting Started Guide for FreeBSD <freebsd_gsg>` depending on your platform.
-
-
-Linux
------
-
-
-Running testpmd
-~~~~~~~~~~~~~~~
-
-This section demonstrates how to launch ``testpmd`` with Intel XL710/X710
-devices managed by ``librte_pmd_i40e`` in the Linux operating system.
-
-#. Load ``igb_uio`` or ``vfio-pci`` driver:
-
- .. code-block:: console
-
- modprobe uio
- insmod ./x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
-
- or
-
- .. code-block:: console
-
- modprobe vfio-pci
-
-#. Bind the XL710/X710 adapters to ``igb_uio`` or ``vfio-pci`` loaded in the previous step:
-
- .. code-block:: console
-
- ./usertools/dpdk-devbind.py --bind igb_uio 0000:83:00.0
-
- Or setup VFIO permissions for regular users and then bind to ``vfio-pci``:
-
- .. code-block:: console
-
- ./usertools/dpdk-devbind.py --bind vfio-pci 0000:83:00.0
-
-#. Start ``testpmd`` with basic parameters:
-
- .. code-block:: console
-
- ./x86_64-native-linuxapp-gcc/app/testpmd -l 0-3 -n 4 -w 83:00.0 -- -i
-
- Example output:
-
- .. code-block:: console
-
- ...
- EAL: PCI device 0000:83:00.0 on NUMA socket 1
- EAL: probe driver: 8086:1572 rte_i40e_pmd
- EAL: PCI memory mapped at 0x7f7f80000000
- EAL: PCI memory mapped at 0x7f7f80800000
- PMD: eth_i40e_dev_init(): FW 5.0 API 1.5 NVM 05.00.02 eetrack 8000208a
- Interactive-mode selected
- Configuring Port 0 (socket 0)
- ...
-
- PMD: i40e_dev_rx_queue_setup(): Rx Burst Bulk Alloc Preconditions are
- satisfied.Rx Burst Bulk Alloc function will be used on port=0, queue=0.
-
- ...
- Port 0: 68:05:CA:26:85:84
- Checking link statuses...
- Port 0 Link Up - speed 10000 Mbps - full-duplex
- Done
+Driver compilation and testing
+------------------------------
- testpmd>
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.
SR-IOV: Prerequisites and sample Application Notes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------------------------
#. Load the kernel module:
@@ -250,6 +183,37 @@ SR-IOV: Prerequisites and sample Application Notes
#. Assign VF to VM, and bring up the VM.
Please see the documentation for the *I40E/IXGBE/IGB Virtual Function Driver*.
+#. Running testpmd:
+
+ Follow instructions available in the document
+ :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+ to run testpmd.
+
+ Example output:
+
+ .. code-block:: console
+
+ ...
+ EAL: PCI device 0000:83:00.0 on NUMA socket 1
+ EAL: probe driver: 8086:1572 rte_i40e_pmd
+ EAL: PCI memory mapped at 0x7f7f80000000
+ EAL: PCI memory mapped at 0x7f7f80800000
+ PMD: eth_i40e_dev_init(): FW 5.0 API 1.5 NVM 05.00.02 eetrack 8000208a
+ Interactive-mode selected
+ Configuring Port 0 (socket 0)
+ ...
+
+ PMD: i40e_dev_rx_queue_setup(): Rx Burst Bulk Alloc Preconditions are
+ satisfied.Rx Burst Bulk Alloc function will be used on port=0, queue=0.
+
+ ...
+ Port 0: 68:05:CA:26:85:84
+ Checking link statuses...
+ Port 0 Link Up - speed 10000 Mbps - full-duplex
+ Done
+
+ testpmd>
+
Sample Application Notes
------------------------
--
1.8.3.1