[dpdk-dev,5/8] doc: refer PMD compile and test section from ena 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/ena.rst | 66 +++----------------------------------------------
1 file changed, 4 insertions(+), 62 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>; Jan Medala <jan@semihalf.com>; Jakub Palider
> <jpa@semihalf.com>; Netanel Belgazal <netanel@amazon.com>; Evgeny
> Schemeilin <evgenys@amazon.com>
> Cc: dev@dpdk.org
> Subject: [PATCH 5/8] doc: refer PMD compile and test section from ena 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>
@@ -140,16 +140,11 @@ Configuration information
will be the minimum between the requested size and the maximal receive/transmit
supported by the device.
-Building DPDK
--------------
-
-See the :ref:`DPDK Getting Started Guide for Linux <linux_gsg>` for
-instructions on how to build DPDK.
-
-By default the ENA PMD library will be built into the DPDK library.
+Driver compilation and testing
+------------------------------
-For configuring and using UIO and VFIO frameworks, please also refer :ref:`the
-documentation that comes with DPDK suite <linux_gsg>`.
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.
Supported ENA adapters
----------------------
@@ -196,56 +191,3 @@ Prerequisites
At this point the system should be ready to run DPDK applications. Once the
application runs to completion, the ENA can be detached from igb_uio if necessary.
-
-Usage example
--------------
-
-This section demonstrates how to launch **testpmd** with Amazon ENA
-devices managed by librte_pmd_ena.
-
-#. Load the kernel modules:
-
- .. code-block:: console
-
- modprobe uio
- insmod ./x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
-
- .. note::
-
- Currently Amazon ENA PMD driver depends on igb_uio user space I/O kernel module
-
-#. Mount and request huge pages:
-
- .. code-block:: console
-
- mount -t hugetlbfs nodev /mnt/hugepages
- echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
-
-#. Bind UIO driver to ENA device (using provided by DPDK binding tool):
-
- .. code-block:: console
-
- ./usertools/dpdk-devbind.py --bind=igb_uio 0000:02:00.1
-
-#. Start testpmd with basic parameters:
-
- .. code-block:: console
-
- ./x86_64-native-linuxapp-gcc/app/testpmd -l 0-3 -n 4 -- -i
-
- Example output:
-
- .. code-block:: console
-
- [...]
- EAL: PCI device 0000:02:00.1 on NUMA socket -1
- EAL: probe driver: 1d0f:ec20 rte_ena_pmd
- EAL: PCI memory mapped at 0x7f9b6c400000
- PMD: eth_ena_dev_init(): Initializing 0:2:0.1
- Interactive-mode selected
- Configuring Port 0 (socket 0)
- Port 0: 00:00:00:11:00:01
- Checking link statuses...
- Port 0 Link Up - speed 10000 Mbps - full-duplex
- Done
- testpmd>