xref: /pciutils/README (revision 4c2bdb01)
1This package contains the PCI Utilities, version @VERSION@.
2
3Copyright (c) 1997--2010 Martin Mares <[email protected]>
4
5All files in this package can be freely distributed and used according
6to the terms of the GNU General Public License, either version 2 or
7(at your opinion) any newer version. See http://www.gnu.org/ for details.
8
9
101. What's that?
11~~~~~~~~~~~~~~~
12The PCI Utilities package contains a library for portable access to PCI bus
13configuration registers and several utilities based on this library.
14
15In runs on the following systems:
16
17	Linux		(via /sys/bus/pci, /proc/bus/pci or i386 ports)
18	FreeBSD		(via /dev/pci)
19	NetBSD		(via libpci)
20	OpenBSD		(via /dev/pci)
21	GNU/kFreeBSD	(via /dev/pci)
22	Solaris/i386	(direct port access)
23	Aix		(via /dev/pci and odmget)
24	GNU Hurd	(direct port access)
25	Windows		(direct port access)
26	CYGWIN		(direct port access)
27
28It should be very easy to add support for other systems as well (volunteers
29wanted; if you want to try that, I'll be very glad to see the patches and
30include them in the next version).
31
32The utilities include:  (See manual pages for more details)
33
34  - lspci: displays detailed information about all PCI buses and devices.
35
36  - setpci: allows to read from and write to PCI device configuration
37    registers. For example, you can adjust the latency timers with it.
38    CAUTION: There is a couple of dangerous points and caveats, please read
39    the manual page first!
40
41  - update-pciids: download the current version of the pci.ids file.
42
43
442. Compiling and (un)installing
45~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46Just run "make" to compile the package and then "make install" to install it.
47Please note that GNU make is needed on most platforms.
48
49If you want to change the default installation location, please override
50the PREFIX variable specified in the Makefile -- e.g., you can use
51"make PREFIX=/opt/pciutils install" to create a separate installation
52not interfering with the rest of your system.  Setting the DESTDIR variable
53will allow you to install to a different directory from the one you intend
54to eventually run it from.  This is useful for people who are packaging
55pciutils to install on other computers.
56
57There are several options which can be set in the Makefile or overridden
58when running make:
59
60  ZLIB=yes/no	Enable support for compressed pci.ids (requires zlib).
61		If it is enabled, pciutils will use pci.ids.gz in preference to
62		pci.ids, even if the pci.ids file is newer.  If the pci.ids.gz
63		file is missing, it will use pci.ids instead.  If you do not
64		specify this option, the configure script will try to guess
65		automatically based on the presence of zlib.
66
67  DNS=yes/no	Enable support for querying the central database of PCI ID's
68		using DNS.  Requires libresolv (which is available on most
69		systems as a part of the standard libraries) and tries to
70		autodetect its presence if the option is not specified.
71
72  SHARED=yes/	Build libpci as a shared library.  Requires GCC 4.0 or newer.
73  no/local	The ABI of the shared library is intended to remain backward
74		compatible for a long time (we use symbol versioning to achieve
75		that, like GNU libc does).  The value `local' includes the
76		right directory name in the binaries, so the utilities can be
77		run without installation.  This is not recommended for any
78		production builds.
79
80"make install-lib" installs the library together with its header files
81for use by other programs.
82
83When you are bored of dumping PCI registers, just use "make uninstall".
84
85
863. Getting new ID's
87~~~~~~~~~~~~~~~~~~~
88The database of PCI ID's (the pci.ids file) gets out of date much faster
89than I release new versions of this package.
90
91If you are missing names for any of your devices or you just want to stay
92on the bleeding edge, download the most recent pci.ids file from
93http://pciids.sf.net/ (e.g., by running the update-ids utility).
94
95Alternatively, you can use `lspci -q' to query the central database
96for new entries via network.
97
98If your devices still appear as unknown, please send us their ID's and
99names, the detailed instructions for submissions are listed on the
100sf.net web page.
101
102
1034. Getting new versions
104~~~~~~~~~~~~~~~~~~~~~~~
105New versions of pciutils are available at the following places:
106
107	ftp://atrey.karlin.mff.cuni.cz/pub/linux/pci/
108	ftp://ftp.kernel.org/pub/software/utils/pciutils/ (expect a couple of hours delay)
109	ftp://metalab.unc.edu/pub/Linux/hardware/ (expect a couple of days delay)
110
111There is also a public GIT tree at:
112
113	git://git.kernel.org/pub/scm/utils/pciutils/pciutils.git
114
115
1165. Using the library
117~~~~~~~~~~~~~~~~~~~~
118So far, there is only a little documentation for the library except for the
119general introduction in the pcilib(7) man page. If you want to use the
120library in your programs, please follow the comments in lib/pci.h and in
121the example program example.c.
122
123
1246. Feedback
125~~~~~~~~~~~
126If you have any bug reports or suggestions, send them to the author.
127
128If you have any new ID's, I'll be very glad to add them to the database, but
129please take a look at http://pciids.sf.net/ first and follow the instructions.
130
131If you want, subscribe to [email protected] (take a look at
132http://vger.kernel.org/ for instructions).
133Release notes about new versions will be send to the list and problems with
134the Linux PCI support will be probably discussed there, too.
135
136
1377. Miscellanea
138~~~~~~~~~~~~~~
139You also might want to look at the pciutils web page containing release
140notes and other news: http://mj.ucw.cz/pciutils.shtml .
141
142There also exists a utility called PowerTweak which is able to fine tune
143parameters of many chipsets much better than the Bridge Optimization code
144in Linux kernel (already removed in 2.3.x). See http://powertweak.sf.net/
145for more information.
146
147					Have fun
148							Martin
149