1 ================================= 1 =================================
2 modedb default video mode support 2 modedb default video mode support
3 ================================= 3 =================================
4 4
5 5
6 Currently all frame buffer device drivers have 6 Currently all frame buffer device drivers have their own video mode databases,
7 which is a mess and a waste of resources. The 7 which is a mess and a waste of resources. The main idea of modedb is to have
8 8
9 - one routine to probe for video modes, whic 9 - one routine to probe for video modes, which can be used by all frame buffer
10 devices 10 devices
11 - one generic video mode database with a fai 11 - one generic video mode database with a fair amount of standard videomodes
12 (taken from XFree86) 12 (taken from XFree86)
13 - the possibility to supply your own mode da 13 - the possibility to supply your own mode database for graphics hardware that
14 needs non-standard modes, like amifb and M 14 needs non-standard modes, like amifb and Mac frame buffer drivers (which
15 use macmodes.c) 15 use macmodes.c)
16 16
17 When a frame buffer device receives a video= o 17 When a frame buffer device receives a video= option it doesn't know, it should
18 consider that to be a video mode option. If no 18 consider that to be a video mode option. If no frame buffer device is specified
19 in a video= option, fbmem considers that to be 19 in a video= option, fbmem considers that to be a global video mode option.
20 20
21 Valid mode specifiers (mode_option argument):: 21 Valid mode specifiers (mode_option argument)::
22 22
23 <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][ 23 <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m][eDd]
24 <name>[-<bpp>][@<refresh>] 24 <name>[-<bpp>][@<refresh>]
25 25
26 with <xres>, <yres>, <bpp> and <refresh> decim 26 with <xres>, <yres>, <bpp> and <refresh> decimal numbers and <name> a string.
27 Things between square brackets are optional. 27 Things between square brackets are optional.
28 28
29 Valid names are:: <<
30 <<
31 - NSTC: 480i output, with the CCIR System-M <<
32 - NTSC-J: 480i output, with the CCIR System- <<
33 encoding, and a black level equal to the b <<
34 - PAL: 576i output, with the CCIR System-B T <<
35 - PAL-M: 480i output, with the CCIR System-M <<
36 <<
37 If 'M' is specified in the mode_option argumen 29 If 'M' is specified in the mode_option argument (after <yres> and before
38 <bpp> and <refresh>, if specified) the timings 30 <bpp> and <refresh>, if specified) the timings will be calculated using
39 VESA(TM) Coordinated Video Timings instead of 31 VESA(TM) Coordinated Video Timings instead of looking up the mode from a table.
40 If 'R' is specified, do a 'reduced blanking' c 32 If 'R' is specified, do a 'reduced blanking' calculation for digital displays.
41 If 'i' is specified, calculate for an interlac 33 If 'i' is specified, calculate for an interlaced mode. And if 'm' is
42 specified, add margins to the calculation (1.8 34 specified, add margins to the calculation (1.8% of xres rounded down to 8
43 pixels and 1.8% of yres). 35 pixels and 1.8% of yres).
44 36
45 Sample usage: 1024x768M@60m - CVT timin 37 Sample usage: 1024x768M@60m - CVT timing with margins
46 38
47 DRM drivers also add options to enable or disa 39 DRM drivers also add options to enable or disable outputs:
48 40
49 'e' will force the display to be enabled, i.e. 41 'e' will force the display to be enabled, i.e. it will override the detection
50 if a display is connected. 'D' will force the 42 if a display is connected. 'D' will force the display to be enabled and use
51 digital output. This is useful for outputs tha 43 digital output. This is useful for outputs that have both analog and digital
52 signals (e.g. HDMI and DVI-I). For other outpu 44 signals (e.g. HDMI and DVI-I). For other outputs it behaves like 'e'. If 'd'
53 is specified the output is disabled. 45 is specified the output is disabled.
54 46
55 You can additionally specify which output the 47 You can additionally specify which output the options matches to.
56 To force the VGA output to be enabled and driv 48 To force the VGA output to be enabled and drive a specific mode say::
57 49
58 video=VGA-1:1280x1024@60me 50 video=VGA-1:1280x1024@60me
59 51
60 Specifying the option multiple times for diffe 52 Specifying the option multiple times for different ports is possible, e.g.::
61 53
62 video=LVDS-1:d video=HDMI-1:D 54 video=LVDS-1:d video=HDMI-1:D
63 55
64 Options can also be passed after the mode, usi 56 Options can also be passed after the mode, using commas as separator.
65 57
66 Sample usage: 720x480,rotate=180 - 720x 58 Sample usage: 720x480,rotate=180 - 720x480 mode, rotated by 180 degrees
67 59
68 Valid options are:: 60 Valid options are::
69 61
70 - margin_top, margin_bottom, margin_left, ma 62 - margin_top, margin_bottom, margin_left, margin_right (integer):
71 Number of pixels in the margins, typically 63 Number of pixels in the margins, typically to deal with overscan on TVs
72 - reflect_x (boolean): Perform an axial symm 64 - reflect_x (boolean): Perform an axial symmetry on the X axis
73 - reflect_y (boolean): Perform an axial symm 65 - reflect_y (boolean): Perform an axial symmetry on the Y axis
74 - rotate (integer): Rotate the initial frame 66 - rotate (integer): Rotate the initial framebuffer by x
75 degrees. Valid values are 0, 90, 180 and 2 67 degrees. Valid values are 0, 90, 180 and 270.
76 - tv_mode: Analog TV mode. One of "NTSC", "N <<
77 "PAL-M", "PAL-N", or "SECAM". <<
78 - panel_orientation, one of "normal", "upsid 68 - panel_orientation, one of "normal", "upside_down", "left_side_up", or
79 "right_side_up". For KMS drivers only, thi 69 "right_side_up". For KMS drivers only, this sets the "panel orientation"
80 property on the kms connector as hint for 70 property on the kms connector as hint for kms users.
81 71
82 72
83 ---------------------------------------------- 73 -----------------------------------------------------------------------------
84 74
85 What is the VESA(TM) Coordinated Video Timings 75 What is the VESA(TM) Coordinated Video Timings (CVT)?
86 ============================================== 76 =====================================================
87 77
88 From the VESA(TM) Website: 78 From the VESA(TM) Website:
89 79
90 "The purpose of CVT is to provide a metho 80 "The purpose of CVT is to provide a method for generating a consistent
91 and coordinated set of standard formats, 81 and coordinated set of standard formats, display refresh rates, and
92 timing specifications for computer displ 82 timing specifications for computer display products, both those
93 employing CRTs, and those using other di 83 employing CRTs, and those using other display technologies. The
94 intention of CVT is to give both source 84 intention of CVT is to give both source and display manufacturers a
95 common set of tools to enable new timing 85 common set of tools to enable new timings to be developed in a
96 consistent manner that ensures greater c 86 consistent manner that ensures greater compatibility."
97 87
98 This is the third standard approved by VESA(TM 88 This is the third standard approved by VESA(TM) concerning video timings. The
99 first was the Discrete Video Timings (DVT) whi 89 first was the Discrete Video Timings (DVT) which is a collection of
100 pre-defined modes approved by VESA(TM). The s 90 pre-defined modes approved by VESA(TM). The second is the Generalized Timing
101 Formula (GTF) which is an algorithm to calcula 91 Formula (GTF) which is an algorithm to calculate the timings, given the
102 pixelclock, the horizontal sync frequency, or 92 pixelclock, the horizontal sync frequency, or the vertical refresh rate.
103 93
104 The GTF is limited by the fact that it is desi 94 The GTF is limited by the fact that it is designed mainly for CRT displays.
105 It artificially increases the pixelclock becau 95 It artificially increases the pixelclock because of its high blanking
106 requirement. This is inappropriate for digital 96 requirement. This is inappropriate for digital display interface with its high
107 data rate which requires that it conserves the 97 data rate which requires that it conserves the pixelclock as much as possible.
108 Also, GTF does not take into account the aspec 98 Also, GTF does not take into account the aspect ratio of the display.
109 99
110 The CVT addresses these limitations. If used 100 The CVT addresses these limitations. If used with CRT's, the formula used
111 is a derivation of GTF with a few modification 101 is a derivation of GTF with a few modifications. If used with digital
112 displays, the "reduced blanking" calculation c 102 displays, the "reduced blanking" calculation can be used.
113 103
114 From the framebuffer subsystem perspective, ne 104 From the framebuffer subsystem perspective, new formats need not be added
115 to the global mode database whenever a new mod 105 to the global mode database whenever a new mode is released by display
116 manufacturers. Specifying for CVT will work fo 106 manufacturers. Specifying for CVT will work for most, if not all, relatively
117 new CRT displays and probably with most flatpa 107 new CRT displays and probably with most flatpanels, if 'reduced blanking'
118 calculation is specified. (The CVT compatibil 108 calculation is specified. (The CVT compatibility of the display can be
119 determined from its EDID. The version 1.3 of t 109 determined from its EDID. The version 1.3 of the EDID has extra 128-byte
120 blocks where additional timing information is 110 blocks where additional timing information is placed. As of this time, there
121 is no support yet in the layer to parse this a 111 is no support yet in the layer to parse this additional blocks.)
122 112
123 CVT also introduced a new naming convention (s 113 CVT also introduced a new naming convention (should be seen from dmesg output)::
124 114
125 <pix>M<a>[-R] 115 <pix>M<a>[-R]
126 116
127 where: pix = total amount of pixels in MB 117 where: pix = total amount of pixels in MB (xres x yres)
128 M = always present 118 M = always present
129 a = aspect ratio (3 - 4:3; 4 - 5: 119 a = aspect ratio (3 - 4:3; 4 - 5:4; 9 - 15:9, 16:9; A - 16:10)
130 -R = reduced blanking 120 -R = reduced blanking
131 121
132 example: .48M3-R - 800x600 with red 122 example: .48M3-R - 800x600 with reduced blanking
133 123
134 Note: VESA(TM) has restrictions on what is a s 124 Note: VESA(TM) has restrictions on what is a standard CVT timing:
135 125
136 - aspect ratio can only be one of the ab 126 - aspect ratio can only be one of the above values
137 - acceptable refresh rates are 50, 60, 7 127 - acceptable refresh rates are 50, 60, 70 or 85 Hz only
138 - if reduced blanking, the refresh rate 128 - if reduced blanking, the refresh rate must be at 60Hz
139 129
140 If one of the above are not satisfied, the ker 130 If one of the above are not satisfied, the kernel will print a warning but the
141 timings will still be calculated. 131 timings will still be calculated.
142 132
143 ---------------------------------------------- 133 -----------------------------------------------------------------------------
144 134
145 To find a suitable video mode, you just call:: 135 To find a suitable video mode, you just call::
146 136
147 int __init fb_find_mode(struct fb_var_screen 137 int __init fb_find_mode(struct fb_var_screeninfo *var,
148 struct fb_info *info 138 struct fb_info *info, const char *mode_option,
149 const struct fb_vide 139 const struct fb_videomode *db, unsigned int dbsize,
150 const struct fb_vide 140 const struct fb_videomode *default_mode,
151 unsigned int default 141 unsigned int default_bpp)
152 142
153 with db/dbsize your non-standard video mode da 143 with db/dbsize your non-standard video mode database, or NULL to use the
154 standard video mode database. 144 standard video mode database.
155 145
156 fb_find_mode() first tries the specified video 146 fb_find_mode() first tries the specified video mode (or any mode that matches,
157 e.g. there can be multiple 640x480 modes, each 147 e.g. there can be multiple 640x480 modes, each of them is tried). If that
158 fails, the default mode is tried. If that fail 148 fails, the default mode is tried. If that fails, it walks over all modes.
159 149
160 To specify a video mode at bootup, use the fol 150 To specify a video mode at bootup, use the following boot options::
161 151
162 video=<driver>:<xres>x<yres>[-<bpp>][@refr 152 video=<driver>:<xres>x<yres>[-<bpp>][@refresh]
163 153
164 where <driver> is a name from the table below. 154 where <driver> is a name from the table below. Valid default modes can be
165 found in drivers/video/fbdev/core/modedb.c. C 155 found in drivers/video/fbdev/core/modedb.c. Check your driver's documentation.
166 There may be more modes:: 156 There may be more modes::
167 157
168 Drivers that support modedb boot options 158 Drivers that support modedb boot options
169 Boot Name Cards Supported 159 Boot Name Cards Supported
170 160
171 amifb - Amiga chipset frame buffer 161 amifb - Amiga chipset frame buffer
172 aty128fb - ATI Rage128 / Pro frame buff 162 aty128fb - ATI Rage128 / Pro frame buffer
173 atyfb - ATI Mach64 frame buffer 163 atyfb - ATI Mach64 frame buffer
174 pm2fb - Permedia 2/2V frame buffer 164 pm2fb - Permedia 2/2V frame buffer
175 pm3fb - Permedia 3 frame buffer 165 pm3fb - Permedia 3 frame buffer
176 sstfb - Voodoo 1/2 (SST1) chipset fr 166 sstfb - Voodoo 1/2 (SST1) chipset frame buffer
177 tdfxfb - 3D Fx frame buffer 167 tdfxfb - 3D Fx frame buffer
178 tridentfb - Trident (Cyber)blade chipset 168 tridentfb - Trident (Cyber)blade chipset frame buffer
179 vt8623fb - VIA 8623 frame buffer 169 vt8623fb - VIA 8623 frame buffer
180 170
181 BTW, only a few fb drivers use this at the mom 171 BTW, only a few fb drivers use this at the moment. Others are to follow
182 (feel free to send patches). The DRM drivers a 172 (feel free to send patches). The DRM drivers also support this.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.