WSL2-Linux-Kernel/drivers/staging/sm750fb
Mauro Carvalho Chehab cd238effef docs: kbuild: convert docs to ReST and rename to *.rst
The kbuild documentation clearly shows that the documents
there are written at different times: some use markdown,
some use their own peculiar logic to split sections.

Convert everything to ReST without affecting too much
the author's style and avoiding adding uneeded markups.

The conversion is actually:
  - add blank lines and identation in order to identify paragraphs;
  - fix tables markups;
  - add some lists markups;
  - mark literal blocks;
  - adjust title markups.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-14 14:21:21 -06:00
..
Kconfig docs: kbuild: convert docs to ReST and rename to *.rst 2019-06-14 14:21:21 -06:00
Makefile staging: add missing SPDX lines to Makefile files 2019-04-03 11:10:15 +02:00
TODO staging: sm750fb: add drm development branch details 2018-05-06 18:51:38 -07:00
ddk750.h staging: sm750fb: add proper SPDX identifier to driver 2019-04-03 11:10:16 +02:00
ddk750_chip.c staging: sm750fb: lower case to fix camelcase checkpatch warning 2019-03-27 23:33:26 +09:00
ddk750_chip.h staging: sm750fb: Edit CamelCase in local variables 2019-03-18 07:05:22 +01:00
ddk750_display.c staging: sm750fb: Eliminate camel case 2019-03-20 07:50:35 +01:00
ddk750_display.h staging: sm750fb: Eliminate camel case 2019-03-20 07:50:35 +01:00
ddk750_dvi.c staging: sm750fb: Edit CamelCase in local variables 2019-03-18 07:05:22 +01:00
ddk750_dvi.h Staging/IIO patches for 4.15-rc1 2017-11-13 20:53:28 -08:00
ddk750_hwi2c.c License cleanup: add SPDX GPL-2.0 license identifier to files with no license 2017-11-02 11:10:55 +01:00
ddk750_hwi2c.h License cleanup: add SPDX GPL-2.0 license identifier to files with no license 2017-11-02 11:10:55 +01:00
ddk750_mode.c staging: sm750fb: Remove extra space character 2018-10-02 15:19:19 -07:00
ddk750_mode.h staging: sm750fb: Remove typedefs from enums 2018-02-16 15:41:27 +01:00
ddk750_power.c Staging/IIO patches for 4.15-rc1 2017-11-13 20:53:28 -08:00
ddk750_power.h staging: sm750fb: Eliminate camel case 2019-03-20 07:50:35 +01:00
ddk750_reg.h License cleanup: add SPDX GPL-2.0 license identifier to files with no license 2017-11-02 11:10:55 +01:00
ddk750_sii164.c staging: sm750fb: Edit CamelCase in local variables 2019-03-18 07:05:22 +01:00
ddk750_sii164.h staging: sm750fb: Remove multiple blank lines 2018-01-08 16:47:23 +01:00
ddk750_swi2c.c staging: sm750fb: add proper SPDX identifier to driver 2019-04-03 11:10:16 +02:00
ddk750_swi2c.h staging: sm750fb: add proper SPDX identifier to driver 2019-04-03 11:10:16 +02:00
readme
sm750.c Staging: sm750fb: Change *array into *const array 2019-04-30 15:03:42 +02:00
sm750.h License cleanup: add SPDX GPL-2.0 license identifier to files with no license 2017-11-02 11:10:55 +01:00
sm750_accel.c staging: sm750fb: trivial comment indention fix. 2019-03-18 07:05:21 +01:00
sm750_accel.h License cleanup: add SPDX GPL-2.0 license identifier to files with no license 2017-11-02 11:10:55 +01:00
sm750_cursor.c Staging/IIO patches for 4.15-rc1 2017-11-13 20:53:28 -08:00
sm750_cursor.h License cleanup: add SPDX GPL-2.0 license identifier to files with no license 2017-11-02 11:10:55 +01:00
sm750_hw.c staging: sm750fb: Eliminate camel case 2019-03-20 07:50:35 +01:00

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.