From 8afe8267b853f095f620cf93f937952a76c218ff Mon Sep 17 00:00:00 2001 From: Christian Ehrhardt Date: Wed, 31 Aug 2016 09:50:11 +0200 Subject: [PATCH] doc: add basic guide for pmdinfo This summarizes the "how to call dpdk-pmdinfo" in one place to be picked up by html/pdf/man-page docs. Signed-off-by: Christian Ehrhardt Acked-by: Luca Boccassi Acked-by: John McNamara --- MAINTAINERS | 1 + doc/guides/conf.py | 4 ++- doc/guides/tools/index.rst | 1 + doc/guides/tools/pmdinfo.rst | 55 ++++++++++++++++++++++++++++++++++++ 4 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 doc/guides/tools/pmdinfo.rst diff --git a/MAINTAINERS b/MAINTAINERS index bc37294f5f..4891d4bef5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -75,6 +75,7 @@ F: scripts/validate-abi.sh Driver information F: buildtools/pmdinfogen/ F: tools/dpdk-pmdinfo.py +F: doc/guides/tools/pmdinfo.rst Environment Abstraction Layer diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 55b6b2f4f3..c45c4bec9d 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -111,7 +111,9 @@ man_pages = [("testpmd_app_ug/run_app", "testpmd", ("tools/pdump", "dpdk-pdump", "enable packet capture on dpdk ports", "", 1), ("tools/proc_info", "dpdk-procinfo", - "access dpdk port stats and memory info", "", 1)] + "access dpdk port stats and memory info", "", 1), + ("tools/pmdinfo", "dpdk-pmdinfo", + "dump a PMDs hardware support info", "", 1)] ######## :numref: fallback ######## # The following hook functions add some simple handling for the :numref: diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst index d7654a23d4..80f2115583 100644 --- a/doc/guides/tools/index.rst +++ b/doc/guides/tools/index.rst @@ -37,4 +37,5 @@ Tool User Guides proc_info pdump + pmdinfo diff --git a/doc/guides/tools/pmdinfo.rst b/doc/guides/tools/pmdinfo.rst new file mode 100644 index 0000000000..efbf527f40 --- /dev/null +++ b/doc/guides/tools/pmdinfo.rst @@ -0,0 +1,55 @@ +.. BSD LICENSE + Copyright(c) 2016 Canonical Limited. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +dpdk-pmdinfo Application +======================== + +The ``dpdk-pmdinfo`` tool is a Data Plane Development Kit (DPDK) utility that +can dump a PMDs hardware support info. + + +Running the Application +----------------------- + +The tool has a number of command line options: + +.. code-block:: console + + dpdk-pmdinfo [-hrtp] [-d + + -h, --help Show a short help message and exit + -r, --raw Dump as raw json strings + -d FILE, --pcidb=FILE Specify a pci database to get vendor names from + -t, --table Output information on hw support as a hex table + -p, --plugindir Scan dpdk for autoload plugins + +.. Note:: + + * Parameters inside the square brackets represents optional parameters. -- 2.20.1