Merge branch 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[linux-2.6] / Documentation / fb / aty128fb.txt
1 [This file is cloned from VesaFB/matroxfb]
2
3 What is aty128fb?
4 =================
5
6 This is a driver for a graphic framebuffer for ATI Rage128 based devices
7 on Intel and PPC boxes.
8
9 Advantages:
10
11  * It provides a nice large console (128 cols + 48 lines with 1024x768)
12    without using tiny, unreadable fonts.
13  * You can run XF68_FBDev on top of /dev/fb0
14  * Most important: boot logo :-)
15
16 Disadvantages:
17
18  * graphic mode is slower than text mode... but you should not notice
19    if you use same resolution as you used in textmode.
20  * still experimental.
21
22
23 How to use it?
24 ==============
25
26 Switching modes is done using the  video=aty128fb:<resolution>... modedb
27 boot parameter or using `fbset' program.
28
29 See Documentation/fb/modedb.txt for more information on modedb
30 resolutions.
31
32 You should compile in both vgacon (to boot if you remove your Rage128 from
33 box) and aty128fb (for graphics mode). You should not compile-in vesafb
34 unless you have primary display on non-Rage128 VBE2.0 device (see 
35 Documentation/fb/vesafb.txt for details).
36
37
38 X11
39 ===
40
41 XF68_FBDev should generally work fine, but it is non-accelerated. As of
42 this document, 8 and 32bpp works fine.  There have been palette issues
43 when switching from X to console and back to X.  You will have to restart
44 X to fix this.
45
46
47 Configuration
48 =============
49
50 You can pass kernel command line options to vesafb with
51 `video=aty128fb:option1,option2:value2,option3' (multiple options should
52 be separated by comma, values are separated from options by `:'). 
53 Accepted options:
54
55 noaccel  - do not use acceleration engine. It is default.
56 accel    - use acceleration engine. Not finished.
57 vmode:x  - chooses PowerMacintosh video mode <x>. Deprecated.
58 cmode:x  - chooses PowerMacintosh colour mode <x>. Deprecated.
59 <XxX@X>  - selects startup videomode. See modedb.txt for detailed
60            explanation. Default is 640x480x8bpp.
61
62
63 Limitations
64 ===========
65
66 There are known and unknown bugs, features and misfeatures.
67 Currently there are following known bugs:
68  + This driver is still experimental and is not finished.  Too many
69    bugs/errata to list here.
70
71 --
72 Brad Douglas <brad@neruo.com>