Merge branch 'for-linus' into for-next
[platform/kernel/linux-starfive.git] / Documentation / fb / gxfb.rst
1 =============
2 What is gxfb?
3 =============
4
5 .. [This file is cloned from VesaFB/aty128fb]
6
7 This is a graphics framebuffer driver for AMD Geode GX2 based processors.
8
9 Advantages:
10
11  * No need to use AMD's VSA code (or other VESA emulation layer) in the
12    BIOS.
13  * It provides a nice large console (128 cols + 48 lines with 1024x768)
14    without using tiny, unreadable fonts.
15  * You can run XF68_FBDev on top of /dev/fb0
16  * Most important: boot logo :-)
17
18 Disadvantages:
19
20  * graphic mode is slower than text mode...
21
22
23 How to use it?
24 ==============
25
26 Switching modes is done using  gxfb.mode_option=<resolution>... boot
27 parameter or using `fbset` program.
28
29 See Documentation/fb/modedb.rst for more information on modedb
30 resolutions.
31
32
33 X11
34 ===
35
36 XF68_FBDev should generally work fine, but it is non-accelerated.
37
38
39 Configuration
40 =============
41
42 You can pass kernel command line options to gxfb with gxfb.<option>.
43 For example, gxfb.mode_option=800x600@75.
44 Accepted options:
45
46 ================ ==================================================
47 mode_option      specify the video mode.  Of the form
48                  <x>x<y>[-<bpp>][@<refresh>]
49 vram             size of video ram (normally auto-detected)
50 vt_switch        enable vt switching during suspend/resume.  The vt
51                  switch is slow, but harmless.
52 ================ ==================================================
53
54 Andres Salomon <dilinger@debian.org>