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