8afe8267b8
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 <christian.ehrhardt@canonical.com> Acked-by: Luca Boccassi <lboccass@brocade.com> Acked-by: John McNamara <john.mcnamara@intel.com>
56 lines
2.3 KiB
ReStructuredText
56 lines
2.3 KiB
ReStructuredText
.. 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 <pci id file] <elf-file>
|
|
|
|
-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.
|