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