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