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 PREFIX variable specified in the Makefile -- e.g., you can use
  49 "make PREFIX=/opt/pciutils install" to create a separate installation
  50 not interfering with the rest of your system.  Setting the DESTDIR variable
  51 will allow you to install to a different directory from the one you intend
  52 to eventually run it from.  This is useful for people who are packaging
  53 pciutils to install on other computers.
  54
  55 When you are bored of dumping PCI registers, just use "make uninstall".
  56
  57
  58 3. Getting new ID's
  59 ~~~~~~~~~~~~~~~~~~~
  60 The database of PCI ID's (the pci.ids file) gets out of date much faster
  61 than I release new versions of this package.
  62
  63 If you are missing names for any of your devices or you just want to stay
  64 on the bleeding edge, download the most recent pci.ids file from
  65 http://pciids.sf.net/ (e.g., by running the update-ids utility).
  66
  67 If your devices still appear as unknown, please send us their ID's and
  68 names, the detailed instructions for submissions are listed on the
  69 sf.net web page.
  70
  71
  72 4. Getting new versions
  73 ~~~~~~~~~~~~~~~~~~~~~~~
  74 New versions of pciutils are available at the following places:
  75
  76         ftp://atrey.karlin.mff.cuni.cz/pub/linux/pci/
  77         ftp://ftp.kernel.org/pub/software/utils/pciutils/ (expect a couple of hours delay)
  78         ftp://metalab.unc.edu/pub/Linux/hardware/ (expect a couple of days delay)
  79
  80 There is also a public GIT tree at:
  81
  82         git://git.kernel.org/pub/scm/utils/pciutils/pciutils.git
  83
  84
  85 5. Using the library
  86 ~~~~~~~~~~~~~~~~~~~~
  87 There is still no documentation for the library, if you want to use it
  88 in your programs, please follow the comments in lib/pci.h and in the
  89 example program lib/example.c.
  90
  91
  92 6. Feedback
  93 ~~~~~~~~~~~
  94 If you have any bug reports or suggestions, send them to the author.
  95
  96 If you have any new ID's, I'll be very glad to add them to the database, but
  97 please take a look at http://pciids.sf.net/ first and follow the instructions.
  98
  99 If you want, subscribe to linux-pci@atrey.karlin.mff.cuni.cz (send
 100 "subscribe linux-pci" to majordomo@atrey.karlin.mff.cuni.cz).
 101 Release notes about new versions will be send to the list and problems with
 102 the Linux PCI support will be probably discussed there, too.
 103
 104
 105 7. Miscellanea
 106 ~~~~~~~~~~~~~~
 107 You also might want to look at the pciutils web page containing release
 108 notes and other news: http://atrey.karlin.mff.cuni.cz/~mj/pciutils.shtml .
 109
 110 There also exists a utility called PowerTweak which is able to fine tune
 111 parameters of many chipsets much better than the Bridge Optimization code
 112 in Linux kernel (already removed in 2.3.x). See http://powertweak.sf.net/
 113 for more information.
 114
 115                                         Have fun
 116                                                         Martin