README

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