X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=lspci.man;h=601a48a97841c9dd8267e600f9e0a38e1b758e0d;hb=77120d53649678ea1cb72591f522d63c27b6a261;hp=7f44fd1a160651c70f94b284801017c394060549;hpb=cc062b4ade94481589af2b6dc94e280caab94498;p=pciutils.git diff --git a/lspci.man b/lspci.man index 7f44fd1..601a48a 100644 --- a/lspci.man +++ b/lspci.man @@ -7,8 +7,8 @@ lspci \- list all PCI devices .RB [ options ] .SH DESCRIPTION .B lspci -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 PCI buses in the system and +devices connected to them. 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 @@ -19,8 +19,8 @@ If you are going to report bugs in PCI device drivers or in 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 +Some parts of the output, especially in the highly verbose modes, are probably +intelligible only to experienced PCI hackers. For exact definitions of the fields, please consult either the PCI specifications or the .B header.h and @@ -38,6 +38,22 @@ information with text. .SH OPTIONS + +.SS Basic display modes +.TP +.B -m +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 -t +Show a tree-like diagram containing all buses, bridges, devices and connections +between them. + +.SS Display options .TP .B -v Be verbose and display detailed information about all devices. @@ -50,12 +66,12 @@ useful. 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 -PCI ID list. -.TP -.B -nn -Show PCI vendor and device codes as both numbers and names. +.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 -x Show hexadecimal dump of the standard part of the configuration space (the first @@ -77,9 +93,39 @@ on PCI-X 2.0 and PCI Express buses. Bus-centric view. Show all IRQ numbers and addresses as seen by the cards on the PCI bus instead of as seen by the kernel. .TP -.B -t -Show a tree-like diagram containing all buses, bridges, devices and connections -between them. +.B -D +Always show PCI domain numbers. By default, lspci suppresses them on machines which +have only domain 0. + +.SS Options to control resolving ID's to names +.TP +.B -n +Show PCI vendor and device codes as numbers instead of looking them up in the +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. + +.SS Options for selection of devices .TP .B -s [[[[]:]]:][][.[]] Show only devices in the specified domain (in case your machine has several host bridges, @@ -93,6 +139,8 @@ the fourth function of each device. .B -d []:[] Show only devices with specified vendor and device ID. Both ID's are given in hexadecimal and may be omitted or given as "*", both meaning "any value". + +.SS Other options .TP .B -i Use @@ -100,93 +148,175 @@ Use as the PCI ID list instead of @IDSDIR@/pci.ids. .TP -.B -m -Dump PCI device data in machine readable form (both normal and verbose format supported) -for easy parsing by scripts. Please don't use any other formats for this purpose, they -are likely to change in the future versions of lspci. -.TP -.B -D -Always show PCI domain numbers. By default, lspci suppresses them on machines which -have only domain 0. +.B -p +Use +.B + +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 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. +those behind misconfigured bridges, etc. This option gives meaningful results only +with a direct hardware access mode, which usually requires root privileges. +Please note that the bus mapper only scans PCI domain 0. .TP .B --version -Shows +Shows .I lspci version. This option should be used stand-alone. -.SH PCILIB AND ITS OPTIONS -The PCI utilities use PCILIB (a portable library providing platform-independent -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 and PCI domains. -.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 aix_device -Access method used on AIX. Requires root privileges. -.TP -.B nbsd_libpci -The -.B /dev/pci0 -device on NetBSD accessed using the local libpci library. - -.P -By default, PCILIB uses the first available access method and displays no debugging -messages, but you can use the following switches to control its behavior: - -.TP -.B -P -Force use of the linux_proc access method, using -.B -instead of /proc/bus/pci. +.SS PCI access options +.PP +The PCI utilities use the PCI library to talk to PCI devices (see +\fBpcilib\fP(7) for details). You can use the following options to +influence its behavior: +.TP +.B -A +The library supports a variety of methods to access the PCI hardware. +By default, it uses the first access method available, but you can use +this option to override this decision. See \fB-A help\fP for a list of +available methods and their descriptions. +.TP +.B -O = +The behavior of the library is controlled by several named parameters. +This option allows to set the value of any of the parameters. Use \fB-O help\fP +for a list of known parameters and their default values. .TP .B -H1 Use direct hardware access via Intel configuration mechanism 1. +(This is a shorthand for \fB-A intel-conf1\fP.) .TP .B -H2 Use direct hardware access via Intel configuration mechanism 2. +(This is a shorthand for \fB-A intel-conf2\fP.) .TP .B -F -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 +Instead of accessing real hardware, read the list of devices and values of their +configuration registers from the given file produced by an earlier run 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. .TP .B -G 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 PhySlot +The physical slot where the device resides (optional, Linux only). + +.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 .B @IDSDIR@/pci.ids @@ -198,15 +328,26 @@ utility to download the most recent version. .B @IDSDIR@/pci.ids.gz If lspci is compiled with support for compression, this file is tried before pci.ids. .TP -.B /proc/bus/pci -An interface to PCI bus configuration space provided by the post-2.1.82 Linux -kernels. Contains per-bus subdirectories with per-card config space files and a -.I devices -file containing a list of all PCI devices. +.B ~/.pciids-cache +All ID's found in the DNS query mode are cached in this file. + +.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 .BR setpci (8), -.BR update-pciids (8) +.BR update-pciids (8), +.BR pcilib (7) .SH AUTHOR The PCI Utilities are maintained by Martin Mares .