[deliverable/linux.git] / drivers / staging / sm750fb / readme

Introduction:
	SM750 of Silicon MOtion is pci express display controller device.
	The SM750 embedded graphics features include:
	- dual display
	- 2D acceleration
	- 16MB integrated video memory

About the kernel module parameter of driver:

	Use 1280,8bpp index color and 60 hz mode:
	insmod ./sm750fb.ko g_option="1280x1024-8@60"

	Disable MTRR,Disable 2d acceleration,Disable hardware cursor,
	and use a 800x600 mode :
	insmod ./sm750fb.ko g_option="noaccel:nomtrr:nohwc:800x600"

	dual frame buffer for driver with "dual" parameter
	insmod ./sm750fb.ko g_option="dual,800x600:1024x768"
	it will create fb0 and fb1 (or fb1,fb2 if fb0 already exist) under /dev
	and user can use con2fb to link fbX and ttyX

	Notes:
	1) if you build the driver with built-in method, the parameter
		you edited in the grub config file will be also the
		same format as above modular method,but additionally add
		"video=sm750fb:"
		ahead of parameters,so,it looks like:
		video=sm750fb:noaccel,1280x1024@60,otherparam,etc...
		it equal to modular method with below command:
		insmod ./sm750fb.ko g_option="noaccel:1280x1024@60:otherparm:etc..."

	2) if you put 800x600 into the parameter without bpp and
		refresh rate, kernel driver will defaulty use 16bpp and 60hz

Important:
	if you have vesafb enabled in your config then /dev/fb0 will be created by vesafb
	and this driver will use fb1, fb2. In that case, you need to configure your X-server
	to use fb1. Another simple althernative is to disable vesafb from your config.
Commit	Line	Data
81dee67e SM	1	Introduction:
	2	SM750 of Silicon MOtion is pci express display controller device.
	3	The SM750 embedded graphics features include:
	4	- dual display
	5	- 2D acceleration
	6	- 16MB integrated video memory
	7
69e98df7	8	About the kernel module parameter of driver:
81dee67e SM	9
	10	Use 1280,8bpp index color and 60 hz mode:
	11	insmod ./sm750fb.ko g_option="1280x1024-8@60"
	12
	13	Disable MTRR,Disable 2d acceleration,Disable hardware cursor,
	14	and use a 800x600 mode :
	15	insmod ./sm750fb.ko g_option="noaccel:nomtrr:nohwc:800x600"
	16
	17	dual frame buffer for driver with "dual" parameter
	18	insmod ./sm750fb.ko g_option="dual,800x600:1024x768"
	19	it will create fb0 and fb1 (or fb1,fb2 if fb0 already exist) under /dev
	20	and user can use con2fb to link fbX and ttyX
	21
	22	Notes:
69e98df7	23	1) if you build the driver with built-in method, the parameter
81dee67e	24	you edited in the grub config file will be also the
69e98df7	25	same format as above modular method,but additionally add
81dee67e SM	26	"video=sm750fb:"
	27	ahead of parameters,so,it looks like:
	28	video=sm750fb:noaccel,1280x1024@60,otherparam,etc...
	29	it equal to modular method with below command:
	30	insmod ./sm750fb.ko g_option="noaccel:1280x1024@60:otherparm:etc..."
	31
69e98df7	32	2) if you put 800x600 into the parameter without bpp and
81dee67e SM	33	refresh rate, kernel driver will defaulty use 16bpp and 60hz
	34
	35	Important:
	36	if you have vesafb enabled in your config then /dev/fb0 will be created by vesafb
	37	and this driver will use fb1, fb2. In that case, you need to configure your X-server
	38	to use fb1. Another simple althernative is to disable vesafb from your config.