1This package contains the PCI Utilities, version @VERSION@. 2 3Copyright (c) 1997--2023 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 https://www.gnu.org/ for details. 8 9The author wants to clarify that he does not consider programs which link 10dynamically to the libpci to be derived works of the library. 11 12 131. What's that? 14~~~~~~~~~~~~~~~ 15The PCI Utilities package contains a library for portable access to PCI bus 16configuration registers and several utilities based on this library. 17 18In runs on the following systems: 19 20 Linux (via /sys/bus/pci, /proc/bus/pci or i386 ports) 21 FreeBSD (via /dev/pci) 22 NetBSD (via libpci) 23 OpenBSD (via /dev/pci or i386 ports) 24 GNU/kFreeBSD (via /dev/pci) 25 Solaris/i386 (direct port access) 26 Aix (via /dev/pci and odmget) 27 GNU Hurd (direct port access) 28 Windows (via cfgmgr32 or direct port access, see README.Windows for caveats) 29 CYGWIN (direct port access) 30 BeOS (via syscalls) 31 Haiku (via /dev/misc/poke) 32 Darwin (via IOKit) 33 DOS/DJGPP (via i386 ports) 34 SylixOS (via /proc/pci) 35 36It should be very easy to add support for other systems as well (volunteers 37wanted; if you want to try that, I'll be very glad to see the patches and 38include them in the next version). 39 40The utilities include: (See manual pages for more details) 41 42 - lspci: displays detailed information about all PCI buses and devices. 43 44 - setpci: allows to read from and write to PCI device configuration 45 registers. For example, you can adjust the latency timers with it. 46 CAUTION: There is a couple of dangerous points and caveats, please read 47 the manual page first! 48 49 - update-pciids: download the current version of the pci.ids file. 50 51 522. Compiling and (un)installing 53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 54Just run "make" to compile the package and then "make install" to install it. 55Please note that a C compiler supporting the C99 standard is required. 56Also, GNU make is needed on most platforms. 57 58If you want to change the default installation location, please override 59the PREFIX variable specified in the Makefile -- e.g., you can use 60"make PREFIX=/opt/pciutils install" to create a separate installation 61not interfering with the rest of your system. Setting the DESTDIR variable 62will allow you to install to a different directory from the one you intend 63to eventually run it from. This is useful for people who are packaging 64pciutils to install on other computers. 65 66There are several options which can be set in the Makefile or overridden 67when running make: 68 69 ZLIB=yes/no Enable support for compressed pci.ids (requires zlib). 70 If it is enabled, pciutils will use pci.ids.gz in preference to 71 pci.ids, even if the pci.ids file is newer. If the pci.ids.gz 72 file is missing, it will use pci.ids instead. If you do not 73 specify this option, the configure script will try to guess 74 automatically based on the presence of zlib. 75 76 DNS=yes/no Enable support for querying the central database of PCI IDs 77 using DNS. Requires libresolv (which is available on most 78 systems as a part of the standard libraries) and tries to 79 autodetect its presence if the option is not specified. 80 81 SHARED=yes/ Build libpci as a shared library. Requires GCC 4.0 or newer. 82 no/local The ABI of the shared library is intended to remain backward 83 compatible for a long time (we use symbol versioning to achieve 84 that, like GNU libc does). The value `local' includes the 85 right directory name in the binaries, so the utilities can be 86 run without installation. This is not recommended for any 87 production builds. 88 89"make install-lib" installs the library together with its header files 90for use by other programs. 91 92When you are bored of dumping PCI registers, just use "make uninstall". 93 94 953. Getting new IDs 96~~~~~~~~~~~~~~~~~~~ 97The database of PCI IDs (the pci.ids file) gets out of date much faster 98than I release new versions of this package, so it is maintained separately. 99 100It lives at https://pci-ids.ucw.cz/, where you can browse the database, 101download the most recent pci.ids file (e.g., by running the update-ids utility) 102and also submit new entries. 103 104Alternatively, you can use `lspci -q' to query the central database 105for new entries via network. 106 107The pci.ids file is also mirrored at https://github.com/pciutils/pciids. 108 109On Linux systems with a recent enough version of libudev, UDEV's HWDB 110database is consulted when pci.ids lacks the device. 111 112 1134. Getting new versions 114~~~~~~~~~~~~~~~~~~~~~~~ 115The current version of pciutils is available at: 116 117 https://mj.ucw.cz/sw/pciutils/ 118 119The tarball can be downloaded at the following places: 120 121 https://mj.ucw.cz/download/linux/pci/ 122 ftp://ftp.ucw.cz/pub/mj/linux/pci/ 123 https://www.kernel.org/pub/software/utils/pciutils/ (expect a couple of hours delay) 124 125There is also a public GIT tree at: 126 127 https://git.kernel.org/pub/scm/utils/pciutils/pciutils.git 128 https://github.com/pciutils/pciutils 129 130 1315. Using the library 132~~~~~~~~~~~~~~~~~~~~ 133So far, there is only a little documentation for the library except for the 134general introduction in the pcilib(7) man page. If you want to use the 135library in your programs, please follow the comments in lib/pci.h and in 136the example program example.c. 137 138 1396. Feedback 140~~~~~~~~~~~ 141If you have any bug reports or suggestions, send them to the author. 142 143If you have any new IDs, I'll be very glad to add them to the database. 144Just submit them at https://pci-ids.ucw.cz/. 145 146Announcements of new versions are sent to [email protected] 147(see http://vger.kernel.org/ for instructions). 148 149 Have fun 150 Martin 151