X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;ds=inline;f=lspci.man;h=624404e8671237dfd75fb1b94bd3a5858a55b67a;hb=9d9aa7055bea757fbe88b8667b07ea2102849e82;hp=5ce14f00ba2e646acd315024b713430108792296;hpb=11339c0d3d0c9064717983fa283bafcdc5298fe7;p=pciutils.git diff --git a/lspci.man b/lspci.man index 5ce14f0..624404e 100644 --- a/lspci.man +++ b/lspci.man @@ -1,5 +1,4 @@ .TH lspci 8 "@TODAY@" "@VERSION@" "The PCI Utilities" -.IX lspci .SH NAME lspci \- list all PCI devices .SH SYNOPSIS @@ -7,8 +6,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 +18,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 +37,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 +65,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 @@ -73,33 +88,66 @@ devices are rare, so you needn't worry much. 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 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. .TP -.B -s [[[[]:]]:][][.[]] +.B -P +Identify PCI devices by path through each bridge, instead of by bus number. +.TP +.B -PP +Identify PCI devices by path through each bridge, showing the bus number as +well as the device number. + +.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, 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). +of its own; domains are numbered from 0 to ffff), bus (0 to ff), device (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 the fourth function of each device. .TP -.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". +.B -d []:[][:[:]] +Show only devices with specified vendor, device, class ID, and programming interface. +The ID's are given in hexadecimal and may be omitted or given as "*", both meaning +"any value". The class ID can contain "x" characters which stand for "any digit". + +.SS Other options .TP .B -i Use @@ -115,97 +163,49 @@ 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 -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 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. +By default, the bus mapper scans domain. You can use the +.B -s +option to select a different domain. .TP .B --version 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: - +.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 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 -messages, but you can use the following switches to control its behavior: - +.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 -P -Force use of the linux_proc access method, using -.B -instead of /proc/bus/pci. +.B -O = +The behavior of the library is controlled by several named parameters. +This option allows one 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 @@ -293,6 +293,10 @@ Name of the subsystem vendor (optional). .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). @@ -308,7 +312,15 @@ 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). +(optional, Linux only). Multiple lines with this tag can occur. + +.TP +.B NUMANode +NUMA node this device is connected to (optional, Linux only). + +.TP +.B IOMMUGroup +IOMMU group that this device is part of (optional, Linux only). .P New tags can be added in future versions, so you should silently ignore any tags you don't recognize. @@ -326,18 +338,15 @@ in a single record. Please avoid using this format in any new code. .TP .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 +at https://pci-ids.ucw.cz/, 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 /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 @@ -354,7 +363,9 @@ back-end. .SH SEE ALSO .BR setpci (8), -.BR update-pciids (8) +.BR pci.ids (5), +.BR update-pciids (8), +.BR pcilib (7) .SH AUTHOR The PCI Utilities are maintained by Martin Mares .