[thirdparty/pciutils.git] / pcilib.man

.TH pcilib 7 "@TODAY@" "@VERSION@" "The PCI Utilities"
.IX pcilib
.SH NAME
pcilib \- a library for accessing PCI devices

.SH DESCRIPTION

The PCI library (also known as \fIpcilib\fP and \fIlibpci\fP) is a portable library
for accessing PCI devices and their configuration space.

.SH ACCESS METHODS

.PP
The library supports a variety of methods to access the configuration space
on different operating systems. By default, the first matching method in this
list is used, but you can specify override the decision (see the \fB-A\fP switch
of \fIlspci\fP).

.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,
VPD (from Linux 2.6.26), physical slots (also since Linux 2.6.26) 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, Windows, BeOS and Haiku. Requires root privileges.
.TP
.B intel-conf2
Direct hardware access via Intel configuration mechanism 2. Available on i386 and compatibles
on Linux, Solaris/x86, GNU Hurd, Windows, BeOS and Haiku. Requires root privileges. Warning: This method
is able to address only the 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.
.TP
.B obsd-device
The
.B /dev/pci
device on OpenBSD. Requires root privileges.
.TP
.B dump
Read the contents of configuration registers from a file specified in the
.B dump.name
parameter. The format corresponds to the output of \fIlspci\fP \fB-x\fP.

.SH PARAMETERS

.PP
The library is controlled by several parameters. They should have sensible default
values, but in case you want to do something unusual (or even something weird),
you can override them (see the \fB-O\fP switch of \fIlspci\fP).

.SS Parameters of specific access methods

.TP
.B dump.name
Name of the bus dump file to read from.
.TP
.B fbsd.path
Path to the FreeBSD PCI device.
.TP
.B nbsd.path
Path to the NetBSD PCI device.
.TP
.B obsd.path
Path to the OpenBSD PCI device.
.TP
.B proc.path
Path to the procfs bus tree.
.TP
.B sysfs.path
Path to the sysfs device tree.

.SS Parameters for resolving of ID's via DNS
.TP
.B net.domain
DNS domain containing the ID database.
.TP
.B net.cache_name
Name of the file used for caching of resolved ID's.

.SH SEE ALSO

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

.SH AUTHOR
The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.
Commit	Line	Data
f2bf13dc MM	1	.TH pcilib 7 "@TODAY@" "@VERSION@" "The PCI Utilities"
	2	.IX pcilib
	3	.SH NAME
	4	pcilib \- a library for accessing PCI devices
	5
	6	.SH DESCRIPTION
	7
	8	The PCI library (also known as \fIpcilib\fP and \fIlibpci\fP) is a portable library
	9	for accessing PCI devices and their configuration space.
	10
	11	.SH ACCESS METHODS
	12
	13	.PP
	14	The library supports a variety of methods to access the configuration space
	15	on different operating systems. By default, the first matching method in this
	16	list is used, but you can specify override the decision (see the \fB-A\fP switch
	17	of \fIlspci\fP).
	18
	19	.TP
	20	.B linux-sysfs
	21	The
	22	.B /sys
	23	filesystem on Linux 2.6 and newer. The standard header of the config space is available
9bd5b1cf	24	to all users, the rest only to root. Supports extended configuration space, PCI domains,
e16e04e8 MM	25	VPD (from Linux 2.6.26), physical slots (also since Linux 2.6.26) and information on attached
e16e04e8 MM	26	kernel drivers.
f2bf13dc MM	27	.TP
	28	.B linux-proc
	29	The
	30	.B /proc/bus/pci
	31	interface supported by Linux 2.1 and newer. The standard header of the config space is available
	32	to all users, the rest only to root.
	33	.TP
	34	.B intel-conf1
	35	Direct hardware access via Intel configuration mechanism 1. Available on i386 and compatibles
40e253d7	36	on Linux, Solaris/x86, GNU Hurd, Windows, BeOS and Haiku. Requires root privileges.
f2bf13dc MM	37	.TP
	38	.B intel-conf2
	39	Direct hardware access via Intel configuration mechanism 2. Available on i386 and compatibles
40e253d7	40	on Linux, Solaris/x86, GNU Hurd, Windows, BeOS and Haiku. Requires root privileges. Warning: This method
f2bf13dc MM	41	is able to address only the first 16 devices on any bus and it seems to be very
	42	unreliable in many cases.
	43	.TP
	44	.B fbsd-device
	45	The
	46	.B /dev/pci
	47	device on FreeBSD. Requires root privileges.
	48	.TP
	49	.B aix-device
	50	Access method used on AIX. Requires root privileges.
	51	.TP
	52	.B nbsd-libpci
	53	The
	54	.B /dev/pci0
	55	device on NetBSD accessed using the local libpci library.
	56	.TP
	57	.B obsd-device
	58	The
	59	.B /dev/pci
	60	device on OpenBSD. Requires root privileges.
	61	.TP
	62	.B dump
	63	Read the contents of configuration registers from a file specified in the
	64	.B dump.name
	65	parameter. The format corresponds to the output of \fIlspci\fP \fB-x\fP.
	66
	67	.SH PARAMETERS
	68
	69	.PP
	70	The library is controlled by several parameters. They should have sensible default
	71	values, but in case you want to do something unusual (or even something weird),
	72	you can override them (see the \fB-O\fP switch of \fIlspci\fP).
	73
	74	.SS Parameters of specific access methods
	75
	76	.TP
	77	.B dump.name
	78	Name of the bus dump file to read from.
	79	.TP
	80	.B fbsd.path
	81	Path to the FreeBSD PCI device.
	82	.TP
	83	.B nbsd.path
	84	Path to the NetBSD PCI device.
	85	.TP
	86	.B obsd.path
	87	Path to the OpenBSD PCI device.
	88	.TP
	89	.B proc.path
	90	Path to the procfs bus tree.
	91	.TP
	92	.B sysfs.path
	93	Path to the sysfs device tree.
	94
	95	.SS Parameters for resolving of ID's via DNS
	96	.TP
	97	.B net.domain
	98	DNS domain containing the ID database.
	99	.TP
	100	.B net.cache_name
	101	Name of the file used for caching of resolved ID's.
	102
	103	.SH SEE ALSO
	104
105	.BR lspci (8),
106	.BR setpci (8),
107	.BR update-pciids (8)
108
109	.SH AUTHOR
110	The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.