[GitHub/mt8127/android_kernel_alcatel_ttab.git] / Documentation / fb / tridentfb.txt

Tridentfb is a framebuffer driver for some Trident chip based cards.

The following list of chips is thought to be supported although not all are
tested:

those from the TGUI series 9440/96XX and with Cyber in their names
those from the Image series and with Cyber in their names
those with Blade in their names (Blade3D,CyberBlade...)
the newer CyberBladeXP family

All families are accelerated. Only PCI/AGP based cards are supported,
none of the older Tridents.
The driver supports 8, 16 and 32 bits per pixel depths.
The TGUI family requires a line length to be power of 2 if acceleration
is enabled. This means that range of possible resolutions and bpp is
limited comparing to the range if acceleration is disabled (see list
of parameters below).

Known bugs:
1. The driver randomly locks up on 3DImage975 chip with acceleration
   enabled. The same happens in X11 (Xorg).
2. The ramdac speeds require some more fine tuning. It is possible to
   switch resolution which the chip does not support at some depths for
   older chips.

How to use it?
==============

When booting you can pass the video parameter.
video=tridentfb

The parameters for tridentfb are concatenated with a ':' as in this example.

video=tridentfb:800x600-16@75,noaccel

The second level parameters that tridentfb understands are:

noaccel - turns off acceleration (when it doesn't work for your card)

fp	- use flat panel related stuff
crt 	- assume monitor is present instead of fp

center 	- for flat panels and resolutions smaller than native size center the
	  image, otherwise use
stretch

memsize - integer value in KB, use if your card's memory size is misdetected.
	  look at the driver output to see what it says when initializing.

memdiff - integer value in KB, should be nonzero if your card reports
	  more memory than it actually has. For instance mine is 192K less than
	  detection says in all three BIOS selectable situations 2M, 4M, 8M.
	  Only use if your video memory is taken from main memory hence of
	  configurable size. Otherwise use memsize.
	  If in some modes which barely fit the memory you see garbage
	  at the bottom this might help by not letting change to that mode
	  anymore.

nativex - the width in pixels of the flat panel.If you know it (usually 1024
	  800 or 1280) and it is not what the driver seems to detect use it.

bpp	- bits per pixel (8,16 or 32)
mode	- a mode name like 800x600-8@75 as described in
	  Documentation/fb/modedb.txt

Using insane values for the above parameters will probably result in driver
misbehaviour so take care(for instance memsize=12345678 or memdiff=23784 or
nativex=93)

Contact: jani@astechnix.ro
Commit	Line	Data
1da177e4 LT	1	Tridentfb is a framebuffer driver for some Trident chip based cards.
	2
	3	The following list of chips is thought to be supported although not all are
	4	tested:
	5
a90ed92e KH	6	those from the TGUI series 9440/96XX and with Cyber in their names
	7	those from the Image series and with Cyber in their names
	8	those with Blade in their names (Blade3D,CyberBlade...)
	9	the newer CyberBladeXP family
	10
	11	All families are accelerated. Only PCI/AGP based cards are supported,
	12	none of the older Tridents.
	13	The driver supports 8, 16 and 32 bits per pixel depths.
	14	The TGUI family requires a line length to be power of 2 if acceleration
	15	is enabled. This means that range of possible resolutions and bpp is
	16	limited comparing to the range if acceleration is disabled (see list
	17	of parameters below).
	18
	19	Known bugs:
	20	1. The driver randomly locks up on 3DImage975 chip with acceleration
	21	enabled. The same happens in X11 (Xorg).
	22	2. The ramdac speeds require some more fine tuning. It is possible to
	23	switch resolution which the chip does not support at some depths for
	24	older chips.
1da177e4 LT	25
	26	How to use it?
	27	==============
	28
	29	When booting you can pass the video parameter.
	30	video=tridentfb
	31
	32	The parameters for tridentfb are concatenated with a ':' as in this example.
	33
a90ed92e	34	video=tridentfb:800x600-16@75,noaccel
1da177e4 LT	35
	36	The second level parameters that tridentfb understands are:
	37
	38	noaccel - turns off acceleration (when it doesn't work for your card)
1da177e4 LT	39
	40	fp - use flat panel related stuff
	41	crt - assume monitor is present instead of fp
	42
	43	center - for flat panels and resolutions smaller than native size center the
	44	image, otherwise use
	45	stretch
	46
a90ed92e	47	memsize - integer value in KB, use if your card's memory size is misdetected.
1da177e4	48	look at the driver output to see what it says when initializing.
a90ed92e KH	49
	50	memdiff - integer value in KB, should be nonzero if your card reports
	51	more memory than it actually has. For instance mine is 192K less than
1da177e4 LT	52	detection says in all three BIOS selectable situations 2M, 4M, 8M.
1da177e4 LT	53	Only use if your video memory is taken from main memory hence of
a90ed92e KH	54	configurable size. Otherwise use memsize.
	55	If in some modes which barely fit the memory you see garbage
	56	at the bottom this might help by not letting change to that mode
	57	anymore.
1da177e4 LT	58
	59	nativex - the width in pixels of the flat panel.If you know it (usually 1024
	60	800 or 1280) and it is not what the driver seems to detect use it.
	61
a90ed92e KH	62	bpp - bits per pixel (8,16 or 32)
	63	mode - a mode name like 800x600-8@75 as described in
	64	Documentation/fb/modedb.txt
1da177e4 LT	65
	66	Using insane values for the above parameters will probably result in driver
	67	misbehaviour so take care(for instance memsize=12345678 or memdiff=23784 or
	68	nativex=93)
	69
	70	Contact: jani@astechnix.ro