1 =====
2 sstfb
3 =====
4
5 Introduction
6 ============
7
8 This is a frame buffer device driver for 3dfx'
9 (aka voodoo 1, aka sst1) and Voodoo² (aka Voo
10 video boards. It's highly experimental code, b
11 on my computer, with my "Maxi Gamer 3D" and "M
12 and with me "between chair and keyboard". Some
13 combinations and it seems that it works.
14 The main page is located at <http://sstfb.sour
15 you want the latest version, check out the CVS
16 in progress, I feel uncomfortable with releasi
17 not completely working...Don't worry, it's sti
18 (I eat my own dog food)
19
20 Please read the Bug section, and report any su
21 (Ghozlane Toumi <gtoumi@laposte.net>).
22 BTW, If you have only one monitor , and you do
23 with the vga passthrou cable, I can only sugge
24 somewhere...
25
26
27 Installation
28 ============
29
30 This driver (should) work on ix86, with "late"
31 with x = 19) and "recent" 2.4.x kernel, as a m
32 It has been included in mainstream kernel sinc
33 You can apply the patches found in `sstfb/kern
34 and copy sstfb.c to linux/drivers/video/, or a
35 `sstfb/patch-2.{2|4}.x-sstfb-yymmdd` to your l
36
37 Then configure your kernel as usual: choose "m
38 Graphics in section "console". Compile, instal
39 drop me a report :)
40
41
42 Module Usage
43 ============
44
45 .. warning::
46
47 #. You should read completely this sect
48
49 #. If you have only one monitor to play
50 module, the 3dfx takes control of th
51 plug the monitor to the "normal" vid
52 the commands, or you can blindly use
53 in the tools directory (See Tools).
54 parameter vgapass=1 when insmodding
55 Options)
56
57 Module insertion
58 ----------------
59
60 #. insmod sstfb.o
61
62 you should see some strange output f
63 a big blue square, a green and a red
64 white rectangle. why? the function's
65 "sstfb_test()"...
66 (if you don't have a second monitor,
67 directly to the 2D videocard to see
68
69 #. con2fb /dev/fbx /dev/ttyx
70
71 bind a tty to the new frame buffer.
72 buffer driver, the voodoo fb will li
73 the device will be /dev/fb0. You can
74 cat /proc/fb. You can find a copy of
75 if you don't have another fb device,
76 as the console subsystem automagical
77 #. switch to the virtual console you ju
78
79 Module removal
80 --------------
81
82 #. con2fb /dev/fbx /dev/ttyx
83
84 bind the tty to the old frame buffer
85 (how does it work with vgacon ? shor
86
87 #. rmmod sstfb
88
89
90 Kernel/Modules Options
91 ----------------------
92
93 You can pass some options to the sstfb module,
94 command line when the driver is compiled in:
95 for module : insmod sstfb.o option1=value1 opt
96 in kernel : video=sstfb:option1,option2:value
97
98 sstfb supports the following options:
99
100 =============== =============== ==============
101 Module Kernel Description
102 =============== =============== ==============
103 vgapass=0 vganopass Enable or disa
104 vgapass=1 vgapass When enabled,
105 from the VGA b
106
107 Default: nopas
108
109 mem=x mem:x Force frame bu
110 allowed values
111
112 Default: 0 (=
113
114 inverse=1 inverse Supposed to en
115 doesn't work y
116
117 clipping=1 clipping Enable or disa
118 clipping=0 noclipping With clipping
119 reads and writ
120
121 Default: enabl
122
123 gfxclk=x gfxclk:x Force graphic
124 Be careful wit
125 DANGEROUS.
126
127 Default: auto
128
129 - 50Mh
130 - 75MH
131
132 slowpci=1 fastpci Enable or disa
133 slowpci=1 slowpci Default : fast
134
135 dev=x dev:x Attach the dri
136 0 is the first
137 lspci order)
138 =============== =============== ==============
139
140 Tools
141 =====
142
143 These tools are mostly for debugging purposes,
144 find some of these interesting:
145
146 - `con2fb`, maps a tty to a fbramebuffer::
147
148 con2fb /dev/fb1 /dev/tty5
149
150 - `sst_dbg_vgapass`, changes vga passthrou. Yo
151 driver with SST_DEBUG and SST_DEBUG_IOCTL se
152
153 sst_dbg_vgapass /dev/fb1 1 (enables vg
154 sst_dbg_vgapass /dev/fb1 0 (disables v
155
156 - `glide_reset`, resets the voodoo using glide
157 use this after rmmoding sstfb, if the module
158 reinsert.
159
160 Bugs
161 ====
162
163 - DO NOT use glide while the sstfb module is i
164 hang your computer.
165 - If you see some artefacts (pixels not cleani
166 try turning off clipping (clipping=0), and/o
167 - the driver don't detect the 4Mb frame buffer
168 the 2 last Mbs wrap around. looking into tha
169 - The driver is 16 bpp only, 24/32 won't work.
170 - The driver is not your_favorite_toy-safe. th
171
172 [Actually from inspection it seems to
173
174 - When using XFree86 FBdev (X over fbdev) you
175 patterns at the border of your windows (the
176 byte -> basically the blue component and som
177 to reproduce this with XFree86-3.3, but one
178 problem with XFree86-4. Apparently recent Xf
179 problem.
180 - I didn't really test changing the palette, s
181 things when playing with that.
182 - Sometimes the driver will not recognise the
183 initialisation will fail. This is specifical
184 voodoo 2 boards, but it should be solved in
185 contact me.
186 - The 24/32 is not likely to work anytime soon
187 hardware does ... unusual things in 24/32 bp
188
189 Todo
190 ====
191
192 - Get rid of the previous paragraph.
193 - Buy more coffee.
194 - test/port to other arch.
195 - try to add panning using tweeks with front a
196 - try to implement accel on voodoo2, this boar
197 lot in 2D even if it was sold as a 3D only b
198
199 Ghozlane Toumi <gtoumi@laposte.net>
200
201
202 Date: 2002/05/09 20:11:45
203
204 http://sstfb.sourceforge.net/README
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.