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