README

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