doc/guides/tools/pmdinfo.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2016 Canonical Limited. All rights reserved.
   3
   4     Redistribution and use in source and binary forms, with or without
   5     modification, are permitted provided that the following conditions
   6     are met:
   7
   8     * Redistributions of source code must retain the above copyright
   9     notice, this list of conditions and the following disclaimer.
  10     * Redistributions in binary form must reproduce the above copyright
  11     notice, this list of conditions and the following disclaimer in
  12     the documentation and/or other materials provided with the
  13     distribution.
  14     * Neither the name of Intel Corporation nor the names of its
  15     contributors may be used to endorse or promote products derived
  16     from this software without specific prior written permission.
  17
  18     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30
  31 dpdk-pmdinfo Application
  32 ========================
  33
  34 The ``dpdk-pmdinfo`` tool is a Data Plane Development Kit (DPDK) utility that
  35 can dump a PMDs hardware support info.
  36
  37
  38 Running the Application
  39 -----------------------
  40
  41 The tool has a number of command line options:
  42
  43 .. code-block:: console
  44
  45    dpdk-pmdinfo [-hrtp] [-d <pci id file] <elf-file>
  46
  47    -h, --help            Show a short help message and exit
  48    -r, --raw             Dump as raw json strings
  49    -d FILE, --pcidb=FILE Specify a pci database to get vendor names from
  50    -t, --table           Output information on hw support as a hex table
  51    -p, --plugindir       Scan dpdk for autoload plugins
  52
  53 .. Note::
  54
  55    * Parameters inside the square brackets represents optional parameters.