README

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