README

   1 This package contains the PCI Utilities, version 2.1.11.
   2
   3 Copyright (c) 1997--2003 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 Currently, pciutils work on all versions of Linux and they also have somewhat
  16 experimental support for FreeBSD, NetBSD and AIX. It should be very easy to add
  17 support for other systems as well (volunteers wanted; if you want to try that,
  18 please send the patches to me, so that I can include them in the next version).
  19
  20 The utilities include:  (See manual pages for more details)
  21
  22   - lspci: displays detailed information about all PCI busses and devices.
  23
  24   - setpci: allows to read from and write to PCI device configuration
  25     registers. For example, you can adjust the latency timers with it.
  26     CAUTION: There is a couple of dangerous points and caveats, please read
  27     the manual page first!
  28
  29
  30 2. Compiling and (un)installing
  31 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32 Just run "make" to compile the package and then "make install" to install it.
  33
  34 If you want to change the default installation location, please override
  35 the ROOT and PREFIX variables specified in the Makefile -- e.g., you can
  36 use "make PREFIX=/opt/pciutils ROOT=/opt/pciutils install" to create
  37 a separate installation not interfering with the rest of your system.
  38
  39 When you are bored of dumping PCI registers, just use "make uninstall".
  40
  41
  42 3. Getting new ID's
  43 ~~~~~~~~~~~~~~~~~~~
  44 The database of PCI ID's (the pci.ids file) gets out of date much faster
  45 than I release new versions of this package.
  46
  47 If you are missing names for any of your devices or you just want to stay
  48 on the bleeding edge, download the most recent pci.ids file from
  49 http://pciids.sf.net/. You can try "make update-ids" to accomplish that
  50 automatically (requires wget and bzip2).
  51
  52 If your devices still appear as unknown, please send us their ID's and
  53 names, the detailed instructions for submissions are listed on the
  54 sf.net web page.
  55
  56
  57 4. Available access methods
  58 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  59 The library (and therefore all the utilities) know a variety of methods for
  60 accessing the PCI registers. Here is a list of them:
  61
  62    /proc/bus/pci        on all Linux systems since kernel 2.1.82.
  63    direct port access   on all Linux systems with i386, to be used when
  64                         /proc/bus/pci is unavailable or you want to scan
  65                         the bus manually when hunting kernel bugs.
  66    dumps                reading of dumps produced by `lspci -x'.
  67    lsdev + odmget       used on AIX
  68    /dev/pci             used on FreeBSD
  69    libpci               used on NetBSD
  70
  71
  72 5. Using the library
  73 ~~~~~~~~~~~~~~~~~~~~
  74 There is still no documentation for the library, if you want to use it
  75 in your programs, please follow the comments in lib/pci.h and in the
  76 example program lib/example.c.
  77
  78
  79 6. Feedback
  80 ~~~~~~~~~~~
  81 If you have any bug reports or suggestions, send them to the author.
  82
  83 If you have any new ID's, I'll be very glad to add them to the database, but
  84 please take a look at http://pciids.sf.net/ first and follow the instructions.
  85
  86 If you want, subscribe to linux-pci@atrey.karlin.mff.cuni.cz (send
  87 "subscribe linux-pci" to majordomo@atrey.karlin.mff.cuni.cz).
  88 Release notes about new versions will be send to the list and problems with
  89 the Linux PCI support will be probably discussed there, too.
  90
  91
  92 7. Miscellanea
  93 ~~~~~~~~~~~~~~
  94 You also might want to look at the pciutils web page containing release
  95 notes and other news: http://atrey.karlin.mff.cuni.cz/~mj/pciutils.html .
  96
  97 There also exists a utility called PowerTweak which is able to fine tune
  98 parameters of many chipsets much better than the Bridge Optimization code
  99 in Linux kernel (already removed in 2.3.x). See http://powertweak.sf.net/
 100 for more information.
 101
 102                                         Have fun
 103                                                         Martin