Blame pcilib.man

Packit 9fb349
.TH pcilib 7 "@TODAY@" "@VERSION@" "The PCI Utilities"
Packit 9fb349
.SH NAME
Packit 9fb349
pcilib \- a library for accessing PCI devices
Packit 9fb349
Packit 9fb349
.SH DESCRIPTION
Packit 9fb349
Packit 9fb349
The PCI library (also known as \fIpcilib\fP and \fIlibpci\fP) is a portable library
Packit 9fb349
for accessing PCI devices and their configuration space.
Packit 9fb349
Packit 9fb349
.SH ACCESS METHODS
Packit 9fb349
Packit 9fb349
.PP
Packit 9fb349
The library supports a variety of methods to access the configuration space
Packit 9fb349
on different operating systems. By default, the first matching method in this
Packit 9fb349
list is used, but you can specify override the decision (see the \fB-A\fP switch
Packit 9fb349
of \fIlspci\fP).
Packit 9fb349
Packit 9fb349
.TP
Packit 9fb349
.B linux-sysfs
Packit 9fb349
The
Packit 9fb349
.B /sys
Packit 9fb349
filesystem on Linux 2.6 and newer. The standard header of the config space is available
Packit 9fb349
to all users, the rest only to root. Supports extended configuration space, PCI domains,
Packit 9fb349
VPD (from Linux 2.6.26), physical slots (also since Linux 2.6.26) and information on attached
Packit 9fb349
kernel drivers.
Packit 9fb349
.TP
Packit 9fb349
.B linux-proc
Packit 9fb349
The
Packit 9fb349
.B /proc/bus/pci
Packit 9fb349
interface supported by Linux 2.1 and newer. The standard header of the config space is available
Packit 9fb349
to all users, the rest only to root.
Packit 9fb349
.TP
Packit 9fb349
.B intel-conf1
Packit 9fb349
Direct hardware access via Intel configuration mechanism 1. Available on i386 and compatibles
Packit 9fb349
on Linux, Solaris/x86, GNU Hurd, Windows, BeOS and Haiku. Requires root privileges.
Packit 9fb349
.TP
Packit 9fb349
.B intel-conf2
Packit 9fb349
Direct hardware access via Intel configuration mechanism 2. Available on i386 and compatibles
Packit 9fb349
on Linux, Solaris/x86, GNU Hurd, Windows, BeOS and Haiku. Requires root privileges. Warning: This method
Packit 9fb349
is able to address only the first 16 devices on any bus and it seems to be very
Packit 9fb349
unreliable in many cases.
Packit 9fb349
.TP
Packit 9fb349
.B fbsd-device
Packit 9fb349
The
Packit 9fb349
.B /dev/pci
Packit 9fb349
device on FreeBSD. Requires root privileges.
Packit 9fb349
.TP
Packit 9fb349
.B aix-device
Packit 9fb349
Access method used on AIX. Requires root privileges.
Packit 9fb349
.TP
Packit 9fb349
.B nbsd-libpci
Packit 9fb349
The
Packit 9fb349
.B /dev/pci0
Packit 9fb349
device on NetBSD accessed using the local libpci library.
Packit 9fb349
.TP
Packit 9fb349
.B obsd-device
Packit 9fb349
The
Packit 9fb349
.B /dev/pci
Packit 9fb349
device on OpenBSD. Requires root privileges.
Packit 9fb349
.TP
Packit 9fb349
.B dump
Packit 9fb349
Read the contents of configuration registers from a file specified in the
Packit 9fb349
.B dump.name
Packit 9fb349
parameter. The format corresponds to the output of \fIlspci\fP \fB-x\fP.
Packit 9fb349
.TP
Packit 9fb349
.B darwin
Packit 9fb349
Access method used on Mac OS X / Darwin. Must be run as root and the system
Packit 9fb349
must have been booted with debug=0x144.
Packit 9fb349
Packit 9fb349
.SH PARAMETERS
Packit 9fb349
Packit 9fb349
.PP
Packit 9fb349
The library is controlled by several parameters. They should have sensible default
Packit 9fb349
values, but in case you want to do something unusual (or even something weird),
Packit 9fb349
you can override them (see the \fB-O\fP switch of \fIlspci\fP).
Packit 9fb349
Packit 9fb349
.SS Parameters of specific access methods
Packit 9fb349
Packit 9fb349
.TP
Packit 9fb349
.B dump.name
Packit 9fb349
Name of the bus dump file to read from.
Packit 9fb349
.TP
Packit 9fb349
.B fbsd.path
Packit 9fb349
Path to the FreeBSD PCI device.
Packit 9fb349
.TP
Packit 9fb349
.B nbsd.path
Packit 9fb349
Path to the NetBSD PCI device.
Packit 9fb349
.TP
Packit 9fb349
.B obsd.path
Packit 9fb349
Path to the OpenBSD PCI device.
Packit 9fb349
.TP
Packit 9fb349
.B proc.path
Packit 9fb349
Path to the procfs bus tree.
Packit 9fb349
.TP
Packit 9fb349
.B sysfs.path
Packit 9fb349
Path to the sysfs device tree.
Packit 9fb349
Packit 9fb349
.SS Parameters for resolving of ID's via DNS
Packit 9fb349
.TP
Packit 9fb349
.B net.domain
Packit 9fb349
DNS domain containing the ID database.
Packit 9fb349
.TP
Packit 9fb349
.B net.cache_name
Packit 9fb349
Name of the file used for caching of resolved ID's.
Packit 9fb349
Packit 9fb349
.SS Parameters for resolving of ID's via UDEV's HWDB
Packit 9fb349
.TP
Packit 9fb349
.B hwdb.disable
Packit 9fb349
Disable use of HWDB if set to a non-zero value.
Packit 9fb349
Packit 9fb349
.SH SEE ALSO
Packit 9fb349
Packit 9fb349
.BR lspci (8),
Packit 9fb349
.BR setpci (8),
Packit 9fb349
.BR pci.ids (5),
Packit 9fb349
.BR update-pciids (8)
Packit 9fb349
Packit 9fb349
.SH AUTHOR
Packit 9fb349
The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.