Merged more PCI Express updates.

[pciutils.git] / lspci.man

diff --git a/lspci.man b/lspci.man
index addcd235398bc4c6e4198de20cbd9744e21a3c0f..a5112d2ff701c52ad0d34a99ae6e1d906a02cc22 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,11 +10,6 @@ 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.
-

 If you are going to report bugs in PCI device drivers or in
 .I lspci
 itself, please include output of "lspci -vvx".
 If you are going to report bugs in PCI device drivers or in
 .I lspci
 itself, please include output of "lspci -vvx".


@@ -49,9 +44,12 @@ itself.
 Show hexadecimal dump of whole PCI configuration space. Available only for root
 as several PCI devices
 .B crash
 Show hexadecimal dump of whole PCI configuration space. Available only for root
 as several PCI devices
 .B crash

-when you try to read undefined portions of the config space (this behaviour probably
+when you try to read undefined portions of the config space (this behavior probably

 doesn't violate the PCI standard, but it's at least very stupid).
 .TP
 doesn't violate the PCI standard, but it's at least very stupid).
 .TP

+.B -xxxx
+Show hexadecimal dump of the extended PCI configuration space.
+.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.
 .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.


@@ -60,22 +58,24 @@ 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 PCI ID database instead of @SHAREDIR@/pci.ids.

 .TP
 .B -p <dir>
 Use
 .TP
 .B -p <dir>
 Use


@@ -87,18 +87,16 @@ Dump PCI device data in machine readable form (both normal and verbose format su
 for easy parsing by scripts.
 .TP
 .B -M
 for easy parsing by scripts.
 .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
 Shows 
 .I lspci
 .TP
 .B --version
 Shows 
 .I lspci

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

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


@@ -110,7 +108,7 @@ it's supported in.
 
 .TP
 .B -P <dir>
 
 .TP
 .B -P <dir>

-Use Linux 2.1 style configuration access to directory
+Force use of Linux /proc/bus/pci style configuration access, using

 .B <dir>
 instead of /proc/bus/pci. (Linux 2.1 or newer only)
 .TP
 .B <dir>
 instead of /proc/bus/pci. (Linux 2.1 or newer only)
 .TP


@@ -120,10 +118,7 @@ Use direct hardware access via Intel configuration mechanism 1. (i386 and compat
 .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
 .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)
+unreliable in many cases. (i386 and compatible only)

 .TP
 .B -F <file>
 Extract all information from given file containing output of lspci -x. This is very
 .TP
 .B -F <file>
 Extract all information from given file containing output of lspci -x. This is very


@@ -136,7 +131,7 @@ Increase debug level of the library. (All systems)
 
 .SH FILES
 .TP
 
 .SH FILES
 .TP

-.B /usr/share/pci.ids
+.B @SHAREDIR@/pci.ids

 A list of all known PCI ID's (vendors, devices, classes and subclasses).
 .TP
 .B /proc/bus/pci
 A list of all known PCI ID's (vendors, devices, classes and subclasses).
 .TP
 .B /proc/bus/pci


@@ -146,7 +141,8 @@ kernels. Contains per-bus subdirectories with per-card config space files and a
 file containing a list of all PCI devices.
 
 .SH SEE ALSO
 file containing a list of all PCI devices.
 
 .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@suse.cz>.
+The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.