README

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