Reformat README

1 files changed, 81 insertions, 70 deletions

diff --git a/README b/README
index 46d6747d..804f79da 100644
--- a/README
+++ b/README
@@ -1,8 +1,6 @@
-  $XFree86:
-  xc/programs/Xserver/hw/xfree86/doc/sgml/i810.sgml,v 1.4
-  2001/04/04 01:34:18 dawes Exp $ Information for i810 Users
-  Precision Insight, Inc.
-  3 March 2000
+  Information for Intel graphics driver users
+  Eric Anholt
+  206-08-04
   ____________________________________________________________
 
   Table of Contents
@@ -12,88 +10,85 @@
   2. Supported Hardware
   3. Features
   4. Technical Notes
-  5. Reported Working Video Cards
-  6. Configuration
-  7. Driver Options
-  8. Known Limitations
-  9. Author
+  5. Configuration
+  6. Driver Options
+  7. Known Limitations
+  8. Author
 
 
   ______________________________________________________________________
 
-  1.  Introduction
+  11..  IInnttrroodduuccttiioonn
 
-  This document provides a brief summary of the i810/i815 support
-  provided by the i810 driver.  Support for later chipsets is not
-  covered here.  More up to date information about the i810 driver can
-  be found in the i810(4) manual page.
+  This document provides a brief summary of the Intel graphics support
+  provided by the xf86-video-intel driver.  More information can also be
+  found in the i810(4) manual page.
 
 
-  2.  Supported Hardware
+  22..  SSuuppppoorrtteedd HHaarrddwwaarree
 
 
-  +o  Intel 810 motherboards:
+  +o  i810,
 
-     +o  i810,
+  +o  i810-dc100,
 
-     +o  i810-dc100,
+  +o  i810e
 
-     +o  i810e
+  +o  i815
 
-     +o  i815
+  +o  i830
 
+  +o  i845
 
+  +o  i852
 
-  3.  Features
+  +o  i855
 
+  +o  i915
 
-  +o  Full support for 8, 15, 16, and 24 bit pixel depths.
+  +o  i945
 
-  +o  Hardware cursor support to reduce sprite flicker.
+  +o  i965
 
-  +o  Hardware accelerated 2D drawing engine support for 8, 15, 16 and 24
-     bit pixel depths.
 
-  +o  Support for high resolution video modes up to 1600x1200.
 
-  +o  Fully programmable clock supported.
+  33..  FFeeaattuurreess
 
-  +o  Robust text mode restore for VT switching.
 
+  +o  Full support for 8, 15, 16, and 24 bit pixel depths.
 
+  +o  Hardware accelerated 2D drawing engine support for 8, 15, 16 and 24
+     bit pixel depths.
 
-  4.  Technical Notes
+  +o  Hardware accelerated 3D drawing using OpenGL and the DRI.
 
+  +o  Hardware cursor support to reduce sprite flicker.
 
-  +o  Hardware acceleration is not possible when using the framebuffer in
-     32 bit per pixel format, and this mode is not supported by this
-     driver.
+  +o  Textured video XV implementation on i915 through i965.
 
-  +o  Interlace modes cannot be supported.
+  +o  Hardware overlay XV implementation up through i945.
 
-  +o  This driver currently only works for Linux/ix86 and recent versions
-     of FreeBSD.  It requires the agpgart kernel support, which is
-     included in Linux kernels 2.3.42 and higher, and FreeBSD 4.1 and
-     higher.
+  +o  Screen resize and rotation on chipsets up through i945.
 
+  +o  Screen resize on i965.
 
 
-  5.  Reported Working Video Cards
 
+  44..  TTeecchhnniiccaall NNootteess
 
-  +o  Intel evaluation hardware - i810, i810-dc100, i810e and i815.
 
-  +o  Tyan Tomcat Motherboard.
+  +o  Interlace modes cannot be supported.
 
-  +o  HappyPC set-top box.
+  +o  This driver  requires kernel support for AGP, which is included in
+     Linux kernels 2.3.42 and higher, and FreeBSD 4.1 and higher.
 
 
 
-  6.  Configuration
+  55..  CCoonnffiigguurraattiioonn
 
   The driver auto-detects all device information necessary to initialize
-  the card.  The only lines you need in the "Device" section of your
-  xorg.conf file are:
+  the card.  The only lines you should need in the "Device" section of
+  your xorg.conf file are:
 
          Section "Device"
              Identifier "Intel i810"
@@ -101,54 +96,68 @@
          EndSection
 
 
-  or let xorgconfig do this for you.
 
-  However, if you have problems with auto-detection, you can specify:
+  In order to use most resolutions, it is necessary to install the
+  "agpgart.o" module.  You will probably have to compile the module
+  yourself (see the notes in the module).
 
-  +o  DacSpeed - in MHz
 
-  +o  MemBase  - physical address of the linear framebuffer
+  66..  DDrriivveerr OOppttiioonnss
 
-  +o  IOBase   - physical address of the memory mapped IO registers
+  Please refer to the i810(4) manual page for information on
+  configuration options.
 
-  In order to use most resolutions, it is necessary to install the (see
-  the notes in the module).
 
-  Note: the i810 driver detects whether your motherboard has display
-  cache video memory.  This memory is has reduced bandwidth compared to
-  normal system memory, and isn't used by the server.  The main function
-  of this memory is for ancillary buffers (eg. z buffer) in a
-  forthcoming 3d capable server.
 
+  77..  KKnnoowwnn LLiimmiittaattiioonnss
 
 
-  7.  Driver Options
+  +o  Many systems with Intel graphics have issues with setting video
+     modes at larger than some small maximum resolution.  This is not
+     fixed in the current release, but is being actively worked on in
+     the modesetting branch.
 
+  +o  Bug #5774: Some systems have issues with VT switching.  This should
+     be fixed with the modesetting brach integration.
 
-  +o  "NoAccel"  - Turn off hardware acceleration
+  +o  Bug #5817: Hotkey switching from LVDS to CRT breaks CRT output.
+     This is a known issue, but will not be fixed in the current
+     release.
 
+  +o  Bug #6635: Video is output from an incorrect offset in the
+     framebuffer.  This is expected to be fixed with the modesetting
+     branch integration.
 
-  +o  "SWCursor" - Request a software cursor (hardware is default)
+  +o  GL_EXT_texture_compression_s3tc is not supported.  We can't support
+     the extension due to patent restrictions on compression, but may be
+     able to support an option for partial extension support in the
+     future.  For now, this prevents Quake4 and some other games from
+     running.
 
-  +o  "Dac6Bit"  - Force the use of a 6 Bit Dac (8 Bit is the default)
+  +o  Some X Test Suite cases sometimes fail due to a timeout. These
+     cases include: Xt8/XtResizeWindow, Xt8/XtQueryGeometry,
+     Xt9/XtAppAddInput, Xt9/XtRemoveInput, Xt9/XtAppAddTimeOut,
+     Xt9/XtRemoveTimeOut, Xt9/XtAddGrab, Xt9/XtRemoveGrab.
 
+  +o  Some X Test Suite cases fail in 64-bit mode: Xlib9/XDrawArc,
+     XDrawImageString, XDrawLine, XDrawRectangle, XDrawSegments,
+     XFillArc, XFillPolygon, XFillRectangle, XPutImage,
+     Xt11/XtVaGetSubresources, XtSetSubvalues, and XtVaSetSubvalues.
 
-  8.  Known Limitations
+  +o  Some GLEAN test cases fail if DRI is enabled: pointAtten,
+     readPixSanity, texCombine, texCube, texEnv, texgen,
+     coloredTexPerf2, and coloredLitPerf2.
 
 
-  +o  No 3D support in this release.
 
-  +o  Running two X servers on different VTs is not supported at this
-     time.
+  88..  AAuutthhoorr
 
 
-
-  9.  Author
-
+  +o  Eric Anholt
 
   +o  Keith Whitwell
 
-  The X11R6.8 version of this driver originally came from XFree86 4.4
+  The X11R7.1 version of this driver originally came from XFree86 4.4
   rc2.
 
   The XFree86 version of this driver was donated to The XFree86 Project
@@ -160,7 +169,9 @@
 
 
 
-  http://www.precisioninsight.com
+  The X.Org version of this driver is maintained by Intel Corporation.
+
+  http://www.intellinuxgraphics.org