gallium: change comments to remove 'state tracker'
[mesa.git] / src / gallium / docs / source / distro.rst
index 33e846e33d2b14cba39cc7095c4eaa44bae3fbb2..d745025d26dd3c9404f51b7e042c858398b1c9d2 100644 (file)
@@ -1,89 +1,99 @@
 Distribution
 ============
 
-Along with the interface definitions, the following drivers, state trackers,
+Along with the interface definitions, the following drivers, gallium frontends,
 and auxiliary modules are shipped in the standard Gallium distribution.
 
 Drivers
 -------
 
-Cell
-^^^^
-
-Failover
-^^^^^^^^
-
-Deprecated.
-
 Intel i915
 ^^^^^^^^^^
 
-Intel i965
-^^^^^^^^^^
-
-Highly experimental.
-
-Identity
-^^^^^^^^
-
-Wrapper driver.
+Driver for Intel i915 and i945 chipsets.
 
 LLVM Softpipe
 ^^^^^^^^^^^^^
 
-nVidia nv04
-^^^^^^^^^^^
+A version of :ref:`softpipe` that uses the Low-Level Virtual Machine to
+dynamically generate optimized rasterizing pipelines.
 
-Deprecated.
-
-nVidia nv10
+nVidia nv30
 ^^^^^^^^^^^
 
-Deprecated.
+Driver for the nVidia nv30 and nv40 families of GPUs.
 
-nVidia nv20
+nVidia nv50
 ^^^^^^^^^^^
 
-Deprecated.
+Driver for the nVidia nv50 family of GPUs.
 
-nVidia nv30
+nVidia nvc0
 ^^^^^^^^^^^
 
-nVidia nv40
-^^^^^^^^^^^
+Driver for the nVidia nvc0 / fermi family of GPUs.
 
-nVidia nv50
+VMware SVGA
 ^^^^^^^^^^^
 
-VMWare SVGA
-^^^^^^^^^^^
+Driver for VMware virtualized guest operating system graphics processing.
 
 ATI r300
 ^^^^^^^^
 
-AMD/ATI r600
+Driver for the ATI/AMD r300, r400, and r500 families of GPUs.
+
+ATI/AMD r600
+^^^^^^^^^^^^
+
+Driver for the ATI/AMD r600, r700, Evergreen and Northern Islands families of GPUs.
+
+AMD radeonsi
 ^^^^^^^^^^^^
 
-Highly experimental.
+Driver for the AMD Southern Islands family of GPUs.
+
+freedreno
+^^^^^^^^^
+
+Driver for Qualcomm Adreno a2xx, a3xx, and a4xx series of GPUs.
+
+.. _softpipe:
 
 Softpipe
 ^^^^^^^^
 
-Reference software rasterizer.
+Reference software rasterizer. Slow but accurate.
+
+.. _trace:
 
 Trace
 ^^^^^
 
-Wrapper driver.
+Wrapper driver. Trace dumps an XML record of the calls made to the
+:ref:`Context` and :ref:`Screen` objects that it wraps.
+
+Rbug
+^^^^
+
+Wrapper driver. :ref:`rbug` driver used with stand alone rbug-gui.
 
-State Trackers
---------------
+Gallium frontends
+-----------------
+
+Clover
+^^^^^^
+
+Tracker that implements the Khronos OpenCL standard.
+
+.. _dri:
 
 Direct Rendering Infrastructure
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-EGL
-^^^
+Tracker that implements the client-side DRI protocol, for providing direct
+acceleration services to X11 servers with the DRI extension. Supports DRI1
+and DRI2. Only GL is supported.
 
 GLX
 ^^^
@@ -91,35 +101,76 @@ GLX
 MesaGL
 ^^^^^^
 
-Python
-^^^^^^
+The gallium frontend implementing a GL state machine. Not usable as
+a standalone frontend; Mesa should be built with another gallium frontend,
+such as :ref:`DRI` or :ref:`EGL`.
 
-OpenVG
-^^^^^^
+VDPAU
+^^^^^
+
+Tracker for Video Decode and Presentation API for Unix.
 
 WGL
 ^^^
 
-Xorg XFree86 DDX
-^^^^^^^^^^^^^^^^
+Xorg DDX
+^^^^^^^^
+
+Tracker for Xorg X11 servers. Provides device-dependent
+modesetting and acceleration as a DDX driver.
+
+XvMC
+^^^^
+
+Tracker for X-Video Motion Compensation.
 
 Auxiliary
 ---------
 
+OS
+^^
+
+The OS module contains the abstractions for basic operating system services:
+
+* memory allocation
+* simple message logging
+* obtaining run-time configuration option
+* threading primitives
+
+This is the bare minimum required to port Gallium to a new platform.
+
+The OS module already provides the implementations of these abstractions for
+the most common platforms.  When targeting an embedded platform no
+implementation will be provided -- these must be provided separately.
+
 CSO Cache
 ^^^^^^^^^
 
+The CSO cache is used to accelerate preparation of state by saving
+driver-specific state structures for later use.
+
+.. _draw:
+
 Draw
 ^^^^
 
+Draw is a software :term:`TCL` pipeline for hardware that lacks vertex shaders
+or other essential parts of pre-rasterization vertex preparation.
+
 Gallivm
 ^^^^^^^
 
 Indices
 ^^^^^^^
 
-Pipe Buffer Manager
-^^^^^^^^^^^^^^^^^^^
+Indices provides tools for translating or generating element indices for
+use with element-based rendering.
+
+Pipe Buffer Managers
+^^^^^^^^^^^^^^^^^^^^
+
+Each of these managers provides various services to drivers that are not
+fully utilizing a memory manager.
 
 Remote Debugger
 ^^^^^^^^^^^^^^^
@@ -127,12 +178,12 @@ Remote Debugger
 Runtime Assembly Emission
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Surface Context Tracker
-^^^^^^^^^^^^^^^^^^^^^^^
-
 TGSI
 ^^^^
 
+The TGSI auxiliary module provides basic utilities for manipulating TGSI
+streams.
+
 Translate
 ^^^^^^^^^