Imported Upstream version 1.11.4
[ubuntu-omap:xserver.git] / hw / xfree86 / modes / xf86cvt.c
1 /*
2  * Copyright 2005-2006 Luc Verhaegen.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  */
22
23 /*
24  * The reason for having this function in a file of its own is
25  * so that ../utils/cvt/cvt can link to it, and that xf86CVTMode
26  * code is shared directly.
27  */
28
29 #ifdef HAVE_XORG_CONFIG_H
30 #include <xorg-config.h>
31 #else
32 #ifdef HAVE_CONFIG_H
33 #include <config.h>
34 #endif
35 #endif
36
37 #include "xf86.h"
38 #include "xf86Modes.h"
39
40 #include <string.h>
41
42 /*
43  * Generate a CVT standard mode from HDisplay, VDisplay and VRefresh.
44  *
45  * These calculations are stolen from the CVT calculation spreadsheet written
46  * by Graham Loveridge. He seems to be claiming no copyright and there seems to
47  * be no license attached to this. He apparently just wants to see his name
48  * mentioned.
49  *
50  * This file can be found at http://www.vesa.org/Public/CVT/CVTd6r1.xls
51  *
52  * Comments and structure corresponds to the comments and structure of the xls.
53  * This should ease importing of future changes to the standard (not very
54  * likely though).
55  *
56  * About margins; i'm sure that they are to be the bit between HDisplay and
57  * HBlankStart, HBlankEnd and HTotal, VDisplay and VBlankStart, VBlankEnd and 
58  * VTotal, where the overscan colour is shown. FB seems to call _all_ blanking
59  * outside sync "margin" for some reason. Since we prefer seeing proper
60  * blanking instead of the overscan colour, and since the Crtc* values will
61  * probably get altered after us, we will disable margins altogether. With
62  * these calculations, Margins will plainly expand H/VDisplay, and we don't
63  * want that. -- libv
64  *
65  */
66 DisplayModePtr
67 xf86CVTMode(int HDisplay, int VDisplay, float VRefresh, Bool Reduced,
68             Bool Interlaced)
69 {
70     DisplayModeRec  *Mode = xnfcalloc(1, sizeof(DisplayModeRec));
71
72     /* 1) top/bottom margin size (% of height) - default: 1.8 */
73 #define CVT_MARGIN_PERCENTAGE 1.8    
74
75     /* 2) character cell horizontal granularity (pixels) - default 8 */
76 #define CVT_H_GRANULARITY 8
77
78     /* 4) Minimum vertical porch (lines) - default 3 */
79 #define CVT_MIN_V_PORCH 3
80
81     /* 4) Minimum number of vertical back porch lines - default 6 */
82 #define CVT_MIN_V_BPORCH 6
83
84     /* Pixel Clock step (kHz) */
85 #define CVT_CLOCK_STEP 250
86
87     Bool Margins = FALSE;
88     float  VFieldRate, HPeriod;
89     int  HDisplayRnd, HMargin;
90     int  VDisplayRnd, VMargin, VSync;
91     float  Interlace; /* Please rename this */
92
93     /* CVT default is 60.0Hz */
94     if (!VRefresh)
95         VRefresh = 60.0;
96
97     /* 1. Required field rate */
98     if (Interlaced)
99         VFieldRate = VRefresh * 2;
100     else
101         VFieldRate = VRefresh;
102
103     /* 2. Horizontal pixels */
104     HDisplayRnd = HDisplay - (HDisplay % CVT_H_GRANULARITY);
105
106     /* 3. Determine left and right borders */
107     if (Margins) {
108         /* right margin is actually exactly the same as left */
109         HMargin = (((float) HDisplayRnd) * CVT_MARGIN_PERCENTAGE / 100.0);
110         HMargin -= HMargin % CVT_H_GRANULARITY;
111     } else
112         HMargin = 0;
113
114     /* 4. Find total active pixels */
115     Mode->HDisplay = HDisplayRnd + 2*HMargin;
116
117     /* 5. Find number of lines per field */
118     if (Interlaced)
119         VDisplayRnd = VDisplay / 2;
120     else
121         VDisplayRnd = VDisplay;
122
123     /* 6. Find top and bottom margins */
124     /* nope. */
125     if (Margins)
126         /* top and bottom margins are equal again. */
127         VMargin = (((float) VDisplayRnd) * CVT_MARGIN_PERCENTAGE / 100.0);
128     else
129         VMargin = 0;
130
131     Mode->VDisplay = VDisplay + 2*VMargin;
132
133     /* 7. Interlace */
134     if (Interlaced)
135         Interlace = 0.5;
136     else
137         Interlace = 0.0;
138
139     /* Determine VSync Width from aspect ratio */
140     if (!(VDisplay % 3) && ((VDisplay * 4 / 3) == HDisplay))
141         VSync = 4;
142     else if (!(VDisplay % 9) && ((VDisplay * 16 / 9) == HDisplay))
143         VSync = 5;
144     else if (!(VDisplay % 10) && ((VDisplay * 16 / 10) == HDisplay))
145         VSync = 6;
146     else if (!(VDisplay % 4) && ((VDisplay * 5 / 4) == HDisplay))
147         VSync = 7;
148     else if (!(VDisplay % 9) && ((VDisplay * 15 / 9) == HDisplay))
149         VSync = 7;
150     else /* Custom */
151         VSync = 10;
152
153     if (!Reduced) { /* simplified GTF calculation */
154
155         /* 4) Minimum time of vertical sync + back porch interval (µs) 
156          * default 550.0 */
157 #define CVT_MIN_VSYNC_BP 550.0
158
159         /* 3) Nominal HSync width (% of line period) - default 8 */
160 #define CVT_HSYNC_PERCENTAGE 8
161
162         float  HBlankPercentage;
163         int  VSyncAndBackPorch, VBackPorch;
164         int  HBlank;
165
166         /* 8. Estimated Horizontal period */
167         HPeriod = ((float) (1000000.0 / VFieldRate - CVT_MIN_VSYNC_BP)) / 
168             (VDisplayRnd + 2 * VMargin + CVT_MIN_V_PORCH + Interlace);
169
170         /* 9. Find number of lines in sync + backporch */
171         if (((int)(CVT_MIN_VSYNC_BP / HPeriod) + 1) < (VSync + CVT_MIN_V_PORCH))
172             VSyncAndBackPorch = VSync + CVT_MIN_V_PORCH;
173         else
174             VSyncAndBackPorch = (int)(CVT_MIN_VSYNC_BP / HPeriod) + 1;
175
176         /* 10. Find number of lines in back porch */
177         VBackPorch = VSyncAndBackPorch - VSync;
178
179         /* 11. Find total number of lines in vertical field */
180         Mode->VTotal = VDisplayRnd + 2 * VMargin + VSyncAndBackPorch + Interlace
181             + CVT_MIN_V_PORCH;
182
183         /* 5) Definition of Horizontal blanking time limitation */
184         /* Gradient (%/kHz) - default 600 */
185 #define CVT_M_FACTOR 600
186
187         /* Offset (%) - default 40 */
188 #define CVT_C_FACTOR 40
189
190         /* Blanking time scaling factor - default 128 */
191 #define CVT_K_FACTOR 128
192
193         /* Scaling factor weighting - default 20 */
194 #define CVT_J_FACTOR 20
195
196 #define CVT_M_PRIME CVT_M_FACTOR * CVT_K_FACTOR / 256
197 #define CVT_C_PRIME (CVT_C_FACTOR - CVT_J_FACTOR) * CVT_K_FACTOR / 256 + \
198         CVT_J_FACTOR
199
200         /* 12. Find ideal blanking duty cycle from formula */
201         HBlankPercentage = CVT_C_PRIME - CVT_M_PRIME * HPeriod/1000.0;
202
203         /* 13. Blanking time */
204         if (HBlankPercentage < 20)
205             HBlankPercentage = 20;
206
207         HBlank = Mode->HDisplay * HBlankPercentage/(100.0 - HBlankPercentage);
208         HBlank -= HBlank % (2*CVT_H_GRANULARITY);
209         
210         /* 14. Find total number of pixels in a line. */
211         Mode->HTotal = Mode->HDisplay + HBlank;
212
213         /* Fill in HSync values */
214         Mode->HSyncEnd = Mode->HDisplay + HBlank / 2;
215
216         Mode->HSyncStart = Mode->HSyncEnd - 
217             (Mode->HTotal * CVT_HSYNC_PERCENTAGE) / 100;
218         Mode->HSyncStart += CVT_H_GRANULARITY - 
219             Mode->HSyncStart % CVT_H_GRANULARITY;
220
221         /* Fill in VSync values */
222         Mode->VSyncStart = Mode->VDisplay + CVT_MIN_V_PORCH;
223         Mode->VSyncEnd = Mode->VSyncStart + VSync;
224
225     } else { /* Reduced blanking */
226         /* Minimum vertical blanking interval time (µs) - default 460 */
227 #define CVT_RB_MIN_VBLANK 460.0
228
229         /* Fixed number of clocks for horizontal sync */
230 #define CVT_RB_H_SYNC 32.0
231
232         /* Fixed number of clocks for horizontal blanking */
233 #define CVT_RB_H_BLANK 160.0
234
235         /* Fixed number of lines for vertical front porch - default 3 */
236 #define CVT_RB_VFPORCH 3
237
238         int  VBILines;
239
240         /* 8. Estimate Horizontal period. */
241         HPeriod = ((float) (1000000.0 / VFieldRate - CVT_RB_MIN_VBLANK)) / 
242             (VDisplayRnd + 2*VMargin);
243
244         /* 9. Find number of lines in vertical blanking */
245         VBILines = ((float) CVT_RB_MIN_VBLANK) / HPeriod + 1;
246
247         /* 10. Check if vertical blanking is sufficient */
248         if (VBILines < (CVT_RB_VFPORCH + VSync + CVT_MIN_V_BPORCH))
249             VBILines = CVT_RB_VFPORCH + VSync + CVT_MIN_V_BPORCH;
250         
251         /* 11. Find total number of lines in vertical field */
252         Mode->VTotal = VDisplayRnd + 2 * VMargin + Interlace + VBILines;
253
254         /* 12. Find total number of pixels in a line */
255         Mode->HTotal = Mode->HDisplay + CVT_RB_H_BLANK;
256
257         /* Fill in HSync values */
258         Mode->HSyncEnd = Mode->HDisplay + CVT_RB_H_BLANK / 2;
259         Mode->HSyncStart = Mode->HSyncEnd - CVT_RB_H_SYNC;
260
261         /* Fill in VSync values */
262         Mode->VSyncStart = Mode->VDisplay + CVT_RB_VFPORCH;
263         Mode->VSyncEnd = Mode->VSyncStart + VSync;
264     }
265
266     /* 15/13. Find pixel clock frequency (kHz for xf86) */
267     Mode->Clock = Mode->HTotal * 1000.0 / HPeriod;
268     Mode->Clock -= Mode->Clock % CVT_CLOCK_STEP;
269
270     /* 16/14. Find actual Horizontal Frequency (kHz) */
271     Mode->HSync = ((float) Mode->Clock) / ((float) Mode->HTotal);
272
273     /* 17/15. Find actual Field rate */
274     Mode->VRefresh = (1000.0 * ((float) Mode->Clock)) / 
275         ((float) (Mode->HTotal * Mode->VTotal));
276
277     /* 18/16. Find actual vertical frame frequency */
278     /* ignore - just set the mode flag for interlaced */
279     if (Interlaced)
280         Mode->VTotal *= 2;
281
282     XNFasprintf(&Mode->name, "%dx%d", HDisplay, VDisplay);
283
284     if (Reduced)
285         Mode->Flags |= V_PHSYNC | V_NVSYNC;
286     else
287         Mode->Flags |= V_NHSYNC | V_PVSYNC;
288
289     if (Interlaced)
290         Mode->Flags |= V_INTERLACE;
291
292     return Mode;
293 }