Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ab42b818 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: fb: convert docs to ReST and rename to *.rst 



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.

Also, removed the Maintained by, as requested by Geert.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 10ffebbe

Documentation/admin-guide/kernel-parameters.txt

+1 −1
Original line number Diff line number Diff line
@@ -5024,7 +5024,7 @@ 
			vector=percpu: enable percpu vector domain



	video=		[FB] Frame buffer configuration

			See Documentation/fb/modedb.txt.

			See Documentation/fb/modedb.rst.



	video.brightness_switch_enabled= [0,1]

			If set to 1, on receiving an ACPI notify event

Documentation/fb/api.txt→Documentation/fb/api.rst

+15 −14
Original line number Diff line number Diff line 
===========================

The Frame Buffer Device API

			---------------------------

===========================



Last revised: June 21, 2011
@@ -21,7 +22,7 @@ deal with different behaviours. 
---------------



Device and driver capabilities are reported in the fixed screen information

capabilities field.

capabilities field::



  struct fb_fix_screeninfo {

	...
@@ -151,7 +152,7 @@ fb_fix_screeninfo and fb_var_screeninfo structure respectively. 
struct fb_fix_screeninfo stores device independent unchangeable information

about the frame buffer device and the current format. Those information can't

be directly modified by applications, but can be changed by the driver when an

application modifies the format.

application modifies the format::



  struct fb_fix_screeninfo {

	char id[16];			/* identification string eg "TT Builtin" */
@@ -176,7 +177,7 @@ struct fb_fix_screeninfo { 


struct fb_var_screeninfo stores device independent changeable information

about a frame buffer device, its current format and video mode, as well as

other miscellaneous parameters.

other miscellaneous parameters::



  struct fb_var_screeninfo {

	__u32 xres;			/* visible resolution		*/
@@ -255,7 +256,7 @@ monochrome, grayscale or pseudocolor visuals, although this is not required. 


- For truecolor and directcolor formats, applications set the grayscale field

  to zero, and the red, blue, green and transp fields to describe the layout of

  color components in memory.

  color components in memory::



    struct fb_bitfield {

	__u32 offset;			/* beginning of bitfield	*/

Documentation/fb/arkfb.txt→Documentation/fb/arkfb.rst

+4 −4
Original line number Diff line number Diff line 


========================================

arkfb - fbdev driver for ARK Logic chips

========================================

Documentation/fb/aty128fb.txt→Documentation/fb/aty128fb.rst

+19 −16
Original line number Diff line number Diff line 
[This file is cloned from VesaFB/matroxfb]



=================

What is aty128fb?

=================



.. [This file is cloned from VesaFB/matroxfb]



This is a driver for a graphic framebuffer for ATI Rage128 based devices

on Intel and PPC boxes.
@@ -24,15 +25,15 @@ How to use it? 
==============



Switching modes is done using the  video=aty128fb:<resolution>... modedb

boot parameter or using `fbset' program.

boot parameter or using `fbset` program.



See Documentation/fb/modedb.txt for more information on modedb

See Documentation/fb/modedb.rst for more information on modedb

resolutions.



You should compile in both vgacon (to boot if you remove your Rage128 from

box) and aty128fb (for graphics mode). You should not compile-in vesafb

unless you have primary display on non-Rage128 VBE2.0 device (see

Documentation/fb/vesafb.txt for details).

Documentation/fb/vesafb.rst for details).





X11
@@ -48,16 +49,18 @@ Configuration 
=============



You can pass kernel command line options to vesafb with

`video=aty128fb:option1,option2:value2,option3' (multiple options should

be separated by comma, values are separated from options by `:'). 

`video=aty128fb:option1,option2:value2,option3` (multiple options should

be separated by comma, values are separated from options by `:`).

Accepted options:



noaccel  - do not use acceleration engine. It is default.

accel    - use acceleration engine. Not finished.

vmode:x  - chooses PowerMacintosh video mode <x>. Deprecated.

cmode:x  - chooses PowerMacintosh colour mode <x>. Deprecated.

<XxX@X>  - selects startup videomode. See modedb.txt for detailed

========= =======================================================

noaccel   do not use acceleration engine. It is default.

accel     use acceleration engine. Not finished.

vmode:x   chooses PowerMacintosh video mode <x>. Deprecated.

cmode:x   chooses PowerMacintosh colour mode <x>. Deprecated.

<XxX@X>   selects startup videomode. See modedb.txt for detailed

	  explanation. Default is 640x480x8bpp.

========= =======================================================





Limitations
@@ -65,8 +68,8 @@ Limitations 


There are known and unknown bugs, features and misfeatures.

Currently there are following known bugs:

 + This driver is still experimental and is not finished.  Too many



 - This driver is still experimental and is not finished.  Too many

   bugs/errata to list here.



--

Brad Douglas <brad@neruo.com>

Documentation/fb/cirrusfb.txt→Documentation/fb/cirrusfb.rst

+22 −25
Original line number Diff line number Diff line 


============================================

Framebuffer driver for Cirrus Logic chipsets

		Copyright 1999 Jeff Garzik <jgarzik@pobox.com>



============================================



Copyright 1999 Jeff Garzik <jgarzik@pobox.com>



{ just a little something to get people going; contributors welcome! }



.. just a little something to get people going; contributors welcome!





Chip families supported:

	SD64

	Piccolo

	Picasso

	Spectrum

	Alpine (GD-543x/4x)

	Picasso4 (GD-5446)

	GD-5480

	Laguna (GD-546x)

	- SD64

	- Piccolo

	- Picasso

	- Spectrum

	- Alpine (GD-543x/4x)

	- Picasso4 (GD-5446)

	- GD-5480

	- Laguna (GD-546x)



Bus's supported:

	PCI

	Zorro

	- PCI

	- Zorro



Architectures supported:

	i386

	Alpha

	PPC (Motorola Powerstack)

	m68k (Amiga)

	- i386

	- Alpha

	- PPC (Motorola Powerstack)

	- m68k (Amiga)
@@ -34,10 +34,9 @@ Default video modes 
-------------------

At the moment, there are two kernel command line arguments supported:



mode:640x480

mode:800x600

	or

mode:1024x768

- mode:640x480

- mode:800x600

- mode:1024x768



Full support for startup video modes (modedb) will be integrated soon.
@@ -93,5 +92,3 @@ Version 1.9.4 
Version 1.9.3

-------------

* Bundled with kernel 2.3.14-pre1 or later.