]> mj.ucw.cz Git - pciutils.git/blob - README
97bdc60eff7da87696c39643de8668f61aaad75e
[pciutils.git] / README
1 This package contains the Linux PCI Utilities, version 1.99.3-alpha.
2
3 Copyright (c) 1997--1999 Martin Mares <mj@atrey.karlin.mff.cuni.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. This is the same distribution
8 policy as for the Linux kernel itself -- see /usr/src/linux/COPYING
9 for details.
10
11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 BIG FAT WARNING: This is an ALPHA version. The documentation is out of date
13                  and the same holds for spec files and even for this README.
14                  And, of course, you should expect this release to contain BUGS.
15
16 WHY ALPHA?       I've split the real PCI access primitives from the rest
17                  of the code and created libpci, which supports not only
18                  /proc/bus/pci, but also direct hardware access and reading
19                  of configuration space dumps and it's intended to work
20                  on all Linux versions and even on non-Linux systems, making
21                  creation of portable programs communicating with PCI devices
22                  possible.
23
24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25
26    The Linux PCI Utilities contain various utilities for dealing with the PCI
27 bus in Linux:
28
29         - lspci: displays detailed information about all PCI busses and devices
30           in the system, replacing the original /proc/pci interface.
31
32         - setpci: allows to read from and write to PCI device configuration
33           registers. For example, you can adjust the latency timers with it.
34
35    See manual pages for more details.
36
37    You need kernel 2.1.82 or newer to use all functions of this package.
38 For older kernels, only direct hardware access is supported and you must
39 be root to use it.
40
41    If you have any bug reports or suggestions, send them to the author.
42
43    If you want, subscribe to linux-pci@atrey.karlin.mff.cuni.cz (send
44 "subscribe linux-pci Your Full Name" to listproc@atrey.karlin.mff.cuni.cz).
45 Release notes about new versions will be send to the list and problems with
46 the Linux PCI support will be probably discussed there, too.
47
48    You also might want to look at the pciutils web page containing release
49 notes and other news: http://atrey.karlin.mff.cuni.cz/~mj/pciutils.html.
50
51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52
53 TODO:
54         - lspci: "scan hard" function
55         - lib: "syscall" access method