The `-P' option has been removed.

[pciutils.git] / lspci.man

diff --git a/lspci.man b/lspci.man
index 6719277d06b41effe1ada91f020aadd229b76558..e3b1c05ff90c975cd1f0da00ef1eb26a8a5899c6 100644 (file)
--- a/lspci.man
+++ b/lspci.man
@@ -1,4 +1,4 @@
-.TH lspci 8 "@TODAY@" "@VERSION@" "Linux PCI Utilities"
+.TH lspci 8 "@TODAY@" "@VERSION@" "The PCI Utilities"

 .IX lspci
 .SH NAME
 lspci \- list all PCI devices
 .IX lspci
 .SH NAME
 lspci \- list all PCI devices


@@ -10,47 +10,94 @@ lspci \- list all PCI devices
 is a utility for displaying information about all PCI buses in the system and
 all devices connected to them.
 
 is a utility for displaying information about all PCI buses in the system and
 all devices connected to them.
 

-To make use of all the features of this program, you need to have Linux kernel
-2.1.82 or newer which supports the /proc/bus/pci interface. With older kernels,
-the PCI utilities have to use direct hardware access which is available
-only to root and it suffers from numerous race conditions and other problems.
+By default, it shows a brief list of devices. Use the options described
+below to request either a more verbose output or output intended for
+parsing by other programs.

 
 If you are going to report bugs in PCI device drivers or in
 .I lspci
 
 If you are going to report bugs in PCI device drivers or in
 .I lspci

-itself, please include output of "lspci -vvx".
+itself, please include output of "lspci -vvx" or even better "lspci -vvxxx"
+(however, see below for possible caveats).
+
+Some parts of the output, especially in the highly verbose modes, is probably
+intelligible only to experienced PCI hackers. For the exact definitions of
+the fields, please consult either the PCI specifications or the
+.B header.h
+and
+.B /usr/include/linux/pci.h
+include files.
+
+Access to some parts of the PCI configuration space is restricted to root
+on many operating systems, so the features of
+.I lspci
+available to normal users are limited. However,
+.I lspci
+tries its best to display as much as available and mark all other
+information with
+.I <access denied>
+text.

 
 .SH OPTIONS
 .TP
 .B -v
 
 .SH OPTIONS
 .TP
 .B -v

-Tells
-.I lspci
-to be verbose and display detailed information about all devices.
+Be verbose and display detailed information about all devices.

 .TP
 .B -vv
 .TP
 .B -vv

-Tells
-.I lspci
-to be very verbose and display even more information (actually everything the
-PCI device is able to tell). The exact meaning of these data is not explained
-in this manual page, if you want to know more, consult
-.B /usr/include/linux/pci.h
-or the PCI specs.
+Be very verbose and display more details. This level includes everything deemed
+useful.
+.TP
+.B -vvv
+Be even more verbose and display everything we are able to parse,
+even if it doesn't look interesting at all (e.g., undefined memory regions).

 .TP
 .B -n
 Show PCI vendor and device codes as numbers instead of looking them up in the
 .TP
 .B -n
 Show PCI vendor and device codes as numbers instead of looking them up in the

-PCI ID database.
+PCI ID list.
+.TP
+.B -nn
+Show PCI vendor and device codes as both numbers and names.
+.TP
+.B -q
+Use DNS to query the central PCI ID database if a device is not found in the local
+.B pci.ids
+file. If the DNS query succeeds, the result is cached in
+.B ~/.pciids-cache
+and it is recognized in subsequent runs even if
+.B -q
+is not given any more. Please use this switch inside automated scripts only
+with caution to avoid overloading the database servers.
+.TP
+.B -qq
+Same as
+.BR -q ,
+but the local cache is reset.
+.TP
+.B -Q
+Query the central database even for entries which are recognized locally.
+Use this if you suspect that the displayed entry is wrong.

 .TP
 .B -x
 .TP
 .B -x

-Show hexadecimal dump of first 64 bytes of the PCI configuration space (the standard
-header). Useful for debugging of drivers and
-.I lspci
-itself.
+Show hexadecimal dump of the standard part of the configuration space (the first
+64 bytes or 128 bytes for CardBus bridges).

 .TP
 .B -xxx
 .TP
 .B -xxx

-Show hexadecimal dump of whole PCI configuration space. Available only for root
+Show hexadecimal dump of the whole PCI configuration space. It is available only to root

 as several PCI devices
 .B crash
 as several PCI devices
 .B crash

-when you try to read undefined portions of the config space (this behaviour probably
-doesn't violate the PCI standard, but it's at least very stupid).
+when you try to read some parts of the config space (this behavior probably
+doesn't violate the PCI standard, but it's at least very stupid). However, such
+devices are rare, so you needn't worry much.
+.TP
+.B -xxxx
+Show hexadecimal dump of the extended (4096-byte) PCI configuration space available
+on PCI-X 2.0 and PCI Express buses.
+.TP
+.B -k
+Show kernel drivers handling each device and also kernel modules capable of handling it.
+Turned on by default when
+.B -v
+is given in the normal mode of output.
+(Currently works only on Linux with kernel 2.6 or newer.)

 .TP
 .B -b
 Bus-centric view. Show all IRQ numbers and addresses as seen by the cards on the
 .TP
 .B -b
 Bus-centric view. Show all IRQ numbers and addresses as seen by the cards on the


@@ -60,84 +107,253 @@ PCI bus instead of as seen by the kernel.
 Show a tree-like diagram containing all buses, bridges, devices and connections
 between them.
 .TP
 Show a tree-like diagram containing all buses, bridges, devices and connections
 between them.
 .TP

-.B -s [[<bus>]:][<slot>][.[<func>]]
-Show only devices in specified bus, slot and function. Each component of the device
-address can be omitted or set as "*" meaning "any value". All numbers are
+.B -s [[[[<domain>]:]<bus>]:][<slot>][.[<func>]]
+Show only devices in the specified domain (in case your machine has several host bridges,
+they can either share a common bus number space or each of them can address a PCI domain
+of its own; domains are numbered from 0 to ffff), bus (0 to ff), slot (0 to 1f) and function (0 to 7).
+Each component of the device address can be omitted or set to "*", both meaning "any value". All numbers are

 hexadecimal.  E.g., "0:" means all devices on bus 0, "0" means all functions of device 0
 on any bus, "0.3" selects third function of device 0 on all buses and ".4" shows only
 hexadecimal.  E.g., "0:" means all devices on bus 0, "0" means all functions of device 0
 on any bus, "0.3" selects third function of device 0 on all buses and ".4" shows only

-fourth function of each device.
+the fourth function of each device.

 .TP
 .B -d [<vendor>]:[<device>]
 Show only devices with specified vendor and device ID. Both ID's are given in
 .TP
 .B -d [<vendor>]:[<device>]
 Show only devices with specified vendor and device ID. Both ID's are given in

-hexadecimal and may be omitted or given as "*" meaning "any value".
+hexadecimal and may be omitted or given as "*", both meaning "any value".

 .TP
 .B -i <file>
 Use
 .B
 <file>
 .TP
 .B -i <file>
 Use
 .B
 <file>

-as PCI ID database instead of /usr/share/pci.ids.
+as the PCI ID list instead of @IDSDIR@/pci.ids.

 .TP
 .TP

-.B -p <dir>
+.B -p <file>

 Use
 Use

-.B <dir>
-as directory containing PCI bus information instead of /proc/bus/pci.
+.B
+<file>
+as the map of PCI ID's handled by kernel modules. By default, lspci uses
+.RI /lib/modules/ kernel_version /modules.pcimap.
+Applies only to Linux systems with recent enough module tools.

 .TP
 .B -m
 .TP
 .B -m

-Dump PCI device data in machine readable form (both normal and verbose format supported)
-for easy parsing by scripts.
+Dump PCI device data in a backward-compatible machine readable form.
+See below for details.
+.TP
+.B -mm
+Dump PCI device data in a machine readable form for easy parsing by scripts.
+See below for details.
+.TP
+.B -D
+Always show PCI domain numbers. By default, lspci suppresses them on machines which
+have only domain 0.

 .TP
 .B -M
 .TP
 .B -M

-Invoke bus mapping mode which scans the bus extensively to find all devices including
-those behind misconfigured bridges etc. Please note that this is intended only for
-debugging and as it can crash the machine (only in case of buggy devices, but
-unfortunately these happen to exist), it's available only to root. Also using
--M on PCI access methods which don't directly touch the hardware has no
-sense since the results are (modulo bugs in lspci) identical to normal listing
-modes.
+Invoke bus mapping mode which performs a thorough scan of all PCI devices, including
+those behind misconfigured bridges etc. This option is available only to root and it
+gives meaningful results only if combined with direct hardware access mode (otherwise
+the results are identical to normal listing modes, modulo bugs in lspci). Please note
+that the bus mapper doesn't support PCI domains and scans only domain 0.

 .TP
 .B --version
 .TP
 .B --version

-Shows 
+Shows

 .I lspci
 .I lspci

-version. This option should be used standalone.
+version. This option should be used stand-alone.

 
 

-.SH PCILIB OPTIONS
+.SH PCILIB AND ITS OPTIONS

 The PCI utilities use PCILIB (a portable library providing platform-independent
 The PCI utilities use PCILIB (a portable library providing platform-independent

-functions for PCI configuration space access) to talk to the PCI cards. The following
-options control parameters of the library, especially what access method it uses.
+functions for PCI configuration space access) to talk to the PCI cards. It supports
+the following access methods:
+
+.TP
+.B linux_sysfs
+The
+.B /sys
+filesystem on Linux 2.6 and newer. The standard header of the config space is available
+to all users, the rest only to root. Supports extended configuration space, PCI domains
+and information on attached kernel drivers.
+.TP
+.B linux_proc
+The
+.B /proc/bus/pci
+interface supported by Linux 2.1 and newer. The standard header of the config space is available
+to all users, the rest only to root.
+.TP
+.B intel_conf1
+Direct hardware access via Intel configuration mechanism 1. Available on i386 and compatibles
+on Linux, Solaris/x86, GNU Hurd and Windows. Requires root privileges.
+.TP
+.B intel_conf2
+Direct hardware access via Intel configuration mechanism 2. Available on i386 and compatibles
+on Linux, Solaris/x86 and GNU Hurd. Requires root privileges. Warning: This method
+is able to address only first 16 devices on any bus and it seems to be very
+unreliable in many cases.
+.TP
+.B fbsd_device
+The
+.B /dev/pci
+device on FreeBSD. Requires root privileges.
+.TP
+.B obsd_device
+The
+.B /dev/pci
+device on OpenBSD. Requires root privileges.
+.TP
+.B nbsd_libpci
+The
+.B /dev/pci0
+device on NetBSD accessed using the local libpci library.
+.TP
+.B aix_device
+Access method used on AIX. Requires root privileges.
+
+.P

 By default, PCILIB uses the first available access method and displays no debugging
 By default, PCILIB uses the first available access method and displays no debugging

-messages. Each switch is accompanied by a list of hardware/software configurations
-it's supported in.
+messages, but you can use the following switches to control its behavior:

 
 .TP
 .B -P <dir>
 
 .TP
 .B -P <dir>

-Use Linux 2.1 style configuration access to directory
+Force use of the linux_proc access method, using

 .B <dir>
 .B <dir>

-instead of /proc/bus/pci. (Linux 2.1 or newer only)
+instead of /proc/bus/pci.

 .TP
 .B -H1
 .TP
 .B -H1

-Use direct hardware access via Intel configuration mechanism 1. (i386 and compatible only)
+Use direct hardware access via Intel configuration mechanism 1.

 .TP
 .B -H2
 .TP
 .B -H2

-Use direct hardware access via Intel configuration mechanism 2. Warning: This method
-is able to address only first 16 devices on any bus and it seems to be very
-unrealiable in many cases. (i386 and compatible only)
-.TP
-.B -S
-Use PCI access syscalls. (Linux on Alpha and UltraSparc only)
+Use direct hardware access via Intel configuration mechanism 2.

 .TP
 .B -F <file>
 Extract all information from given file containing output of lspci -x. This is very
 useful for analysis of user-supplied bug reports, because you can display the
 hardware configuration in any way you want without disturbing the user with
 .TP
 .B -F <file>
 Extract all information from given file containing output of lspci -x. This is very
 useful for analysis of user-supplied bug reports, because you can display the
 hardware configuration in any way you want without disturbing the user with

-requests for more dumps. (All systems)
+requests for more dumps.

 .TP
 .B -G
 .TP
 .B -G

-Increase debug level of the library. (All systems)
+Increase debug level of the library.
+
+.SH MACHINE READABLE OUTPUT
+If you intend to process the output of lspci automatically, please use one of the
+machine-readable output formats
+.RB ( -m ,
+.BR -vm ,
+.BR -vmm )
+described in this section. All other formats are likely to change
+between versions of lspci.
+
+.P
+All numbers are always printed in hexadecimal. If you want to process numeric ID's instead of
+names, please add the
+.B -n
+switch.
+
+.SS Simple format (-m)
+
+In the simple format, each device is described on a single line, which is
+formatted as parameters suitable for passing to a shell script, i.e., values
+separated by whitespaces, quoted and escaped if necessary.
+Some of the arguments are positional: slot, class, vendor name, device name,
+subsystem vendor name and subsystem name (the last two are empty if
+the device has no subsystem); the remaining arguments are option-like:
+
+.TP
+.BI -r rev
+Revision number.
+
+.TP
+.BI -p progif
+Programming interface.
+
+.P
+The relative order of positional arguments and options is undefined.
+New options can be added in future versions, but they will always
+have a single argument not separated from the option by any spaces,
+so they can be easily ignored if not recognized.
+
+.SS Verbose format (-vmm)
+
+The verbose output is a sequence of records separated by blank lines.
+Each record describes a single device by a sequence of lines, each line
+containing a single
+.RI ` tag :
+.IR value '
+pair. The
+.I tag
+and the
+.I value
+are separated by a single tab character.
+Neither the records nor the lines within a record are in any particular order.
+Tags are case-sensitive.
+
+.P
+The following tags are defined:
+
+.TP
+.B Slot
+The name of the slot where the device resides
+.RI ([ domain :] bus : device . function ).
+This tag is always the first in a record.
+
+.TP
+.B Class
+Name of the class.
+
+.TP
+.B Vendor
+Name of the vendor.
+
+.TP
+.B Device
+Name of the device.
+
+.TP
+.B SVendor
+Name of the subsystem vendor (optional).
+
+.TP
+.B SDevice
+Name of the subsystem (optional).
+
+.TP
+.B Rev
+Revision number (optional).
+
+.TP
+.B ProgIf
+Programming interface (optional).
+
+.TP
+.B Driver
+Kernel driver currently handling the device (optional, Linux only).
+
+.TP
+.B Module
+Kernel module reporting that it is capable of handling the device
+(optional, Linux only).
+
+.P
+New tags can be added in future versions, so you should silently ignore any tags you don't recognize.
+
+.SS Backward-compatible verbose format (-vm)
+
+In this mode, lspci tries to be perfectly compatible with its old versions.
+It's almost the same as the regular verbose format, but the
+.B
+Device
+tag is used for both the slot and the device name, so it occurs twice
+in a single record. Please avoid using this format in any new code.

 
 .SH FILES
 .TP
 
 .SH FILES
 .TP

-.B /usr/share/pci.ids
-A list of all known PCI ID's (vendors, devices, classes and subclasses).
+.B @IDSDIR@/pci.ids
+A list of all known PCI ID's (vendors, devices, classes and subclasses). Maintained
+at http://pciids.sourceforge.net/, use the
+.B update-pciids
+utility to download the most recent version.
+.TP
+.B @IDSDIR@/pci.ids.gz
+If lspci is compiled with support for compression, this file is tried before pci.ids.
+.TP
+.B ~/.pciids-cache
+All ID's found in the DNS query mode are cached in this file.

 .TP
 .B /proc/bus/pci
 An interface to PCI bus configuration space provided by the post-2.1.82 Linux
 .TP
 .B /proc/bus/pci
 An interface to PCI bus configuration space provided by the post-2.1.82 Linux


@@ -145,8 +361,22 @@ kernels. Contains per-bus subdirectories with per-card config space files and a
 .I devices
 file containing a list of all PCI devices.
 
 .I devices
 file containing a list of all PCI devices.
 

+.SH BUGS
+
+Sometimes, lspci is not able to decode the configuration registers completely.
+This usually happens when not enough documentation was available to the authors.
+In such cases, it at least prints the
+.B <?>
+mark to signal that there is potentially something more to say. If you know
+the details, patches will be of course welcome.
+
+Access to the extended configuration space is currently supported only by the
+.B linux_sysfs
+back-end.
+

 .SH SEE ALSO
 .SH SEE ALSO

-.BR setpci (8)
+.BR setpci (8),
+.BR update-pciids (8)

 
 .SH AUTHOR
 
 .SH AUTHOR

-The Linux PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.
+The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.