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