Some more PCI ID's from Michael Neuffer.

[pciutils.git] / README

diff --git a/README b/README
index 0c506849d0011a4b97c0e11c605ff259f8e128b0..8a1fdd3a8a0e15ef641f188f9bd5981bbd3e43db 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
-This package contains the Linux PCI Utilities, version 1.01.
+This package contains the Linux PCI Utilities, version 1.99.4-alpha.
 
-Copyright (c) 1998 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
+Copyright (c) 1997--1999 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
 
 All files in this package can be freely distributed and used according
 to the terms of the GNU General Public License, either version 2 or
@@ -9,11 +9,36 @@ policy as for the Linux kernel itself -- see /usr/src/linux/COPYING
 for details.
 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+BIG FAT WARNING: This is an ALPHA version. The documentation is out of date
+                and the same holds for spec files and even for this README.
+                And, of course, you should expect this release to contain BUGS.
+
+WHY ALPHA?      I've split the real PCI access primitives from the rest
+                of the code and created libpci, which supports not only
+                /proc/bus/pci, but also direct hardware access and reading
+                of configuration space dumps and it's intended to work
+                on all Linux versions and even on non-Linux systems, making
+                creation of portable programs communicating with PCI devices
+                possible.
 
-   The Linux PCI Utilities currently contain only one utility -- lspci,
-indented for displaying of detailed information about all PCI busses and
-devices in the system, replacing the original /proc/pci interface. See
-the manual page (lspci.8) for more details.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+   The Linux PCI Utilities contain various utilities for dealing with the PCI
+bus in Linux:
+
+       - lspci: displays detailed information about all PCI busses and devices
+         in the system, replacing the original /proc/pci interface.
+
+       - setpci: allows to read from and write to PCI device configuration
+         registers. For example, you can adjust the latency timers with it.
+
+   See manual pages for more details.
+
+   To compile the package, just run "make". To install it, "make install".
+
+   You need kernel 2.1.82 or newer to use all functions of this package.
+For older kernels, only direct hardware access is supported and you must
+be root to use it.
 
    If you have any bug reports or suggestions, send them to the author.
 
@@ -22,13 +47,11 @@ the manual page (lspci.8) for more details.
 Release notes about new versions will be send to the list and problems with
 the Linux PCI support will be probably discussed there, too.
 
+   You also might want to look at the pciutils web page containing release
+notes and other news: http://atrey.karlin.mff.cuni.cz/~mj/pciutils.html.
+
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 TODO:
-
-       - Work-around the PIIX4 ACPI crash?
-
-       - Better displaying of IRQ's generated by both PCI and CardBus bridges.
-
-       - Full displaying of CardBus bridge configuration. (Has anyone seen
-         full specs of the CardBus bridge / header type 2?)
+       - lspci: "scan hard" function
+       - lib: "syscall" access method