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