dt-bindings: mtd: ingenic: Use standard ecc-engine property
[linux/fpc-iii.git] / drivers / gpu / drm / drm_modes.c
blob869ac6f4671efd621f4383824b6b947c71f33f29
1 /*
2 * Copyright © 1997-2003 by The XFree86 Project, Inc.
3 * Copyright © 2007 Dave Airlie
4 * Copyright © 2007-2008 Intel Corporation
5 * Jesse Barnes <jesse.barnes@intel.com>
6 * Copyright 2005-2006 Luc Verhaegen
7 * Copyright (c) 2001, Andy Ritger aritger@nvidia.com
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
27 * Except as contained in this notice, the name of the copyright holder(s)
28 * and author(s) shall not be used in advertising or otherwise to promote
29 * the sale, use or other dealings in this Software without prior written
30 * authorization from the copyright holder(s) and author(s).
33 #include <linux/list.h>
34 #include <linux/list_sort.h>
35 #include <linux/export.h>
36 #include <drm/drmP.h>
37 #include <drm/drm_crtc.h>
38 #include <video/of_videomode.h>
39 #include <video/videomode.h>
40 #include <drm/drm_modes.h>
42 #include "drm_crtc_internal.h"
44 /**
45 * drm_mode_debug_printmodeline - print a mode to dmesg
46 * @mode: mode to print
48 * Describe @mode using DRM_DEBUG.
50 void drm_mode_debug_printmodeline(const struct drm_display_mode *mode)
52 DRM_DEBUG_KMS("Modeline " DRM_MODE_FMT "\n", DRM_MODE_ARG(mode));
54 EXPORT_SYMBOL(drm_mode_debug_printmodeline);
56 /**
57 * drm_mode_create - create a new display mode
58 * @dev: DRM device
60 * Create a new, cleared drm_display_mode with kzalloc, allocate an ID for it
61 * and return it.
63 * Returns:
64 * Pointer to new mode on success, NULL on error.
66 struct drm_display_mode *drm_mode_create(struct drm_device *dev)
68 struct drm_display_mode *nmode;
70 nmode = kzalloc(sizeof(struct drm_display_mode), GFP_KERNEL);
71 if (!nmode)
72 return NULL;
74 return nmode;
76 EXPORT_SYMBOL(drm_mode_create);
78 /**
79 * drm_mode_destroy - remove a mode
80 * @dev: DRM device
81 * @mode: mode to remove
83 * Release @mode's unique ID, then free it @mode structure itself using kfree.
85 void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode)
87 if (!mode)
88 return;
90 kfree(mode);
92 EXPORT_SYMBOL(drm_mode_destroy);
94 /**
95 * drm_mode_probed_add - add a mode to a connector's probed_mode list
96 * @connector: connector the new mode
97 * @mode: mode data
99 * Add @mode to @connector's probed_mode list for later use. This list should
100 * then in a second step get filtered and all the modes actually supported by
101 * the hardware moved to the @connector's modes list.
103 void drm_mode_probed_add(struct drm_connector *connector,
104 struct drm_display_mode *mode)
106 WARN_ON(!mutex_is_locked(&connector->dev->mode_config.mutex));
108 list_add_tail(&mode->head, &connector->probed_modes);
110 EXPORT_SYMBOL(drm_mode_probed_add);
113 * drm_cvt_mode -create a modeline based on the CVT algorithm
114 * @dev: drm device
115 * @hdisplay: hdisplay size
116 * @vdisplay: vdisplay size
117 * @vrefresh: vrefresh rate
118 * @reduced: whether to use reduced blanking
119 * @interlaced: whether to compute an interlaced mode
120 * @margins: whether to add margins (borders)
122 * This function is called to generate the modeline based on CVT algorithm
123 * according to the hdisplay, vdisplay, vrefresh.
124 * It is based from the VESA(TM) Coordinated Video Timing Generator by
125 * Graham Loveridge April 9, 2003 available at
126 * http://www.elo.utfsm.cl/~elo212/docs/CVTd6r1.xls
128 * And it is copied from xf86CVTmode in xserver/hw/xfree86/modes/xf86cvt.c.
129 * What I have done is to translate it by using integer calculation.
131 * Returns:
132 * The modeline based on the CVT algorithm stored in a drm_display_mode object.
133 * The display mode object is allocated with drm_mode_create(). Returns NULL
134 * when no mode could be allocated.
136 struct drm_display_mode *drm_cvt_mode(struct drm_device *dev, int hdisplay,
137 int vdisplay, int vrefresh,
138 bool reduced, bool interlaced, bool margins)
140 #define HV_FACTOR 1000
141 /* 1) top/bottom margin size (% of height) - default: 1.8, */
142 #define CVT_MARGIN_PERCENTAGE 18
143 /* 2) character cell horizontal granularity (pixels) - default 8 */
144 #define CVT_H_GRANULARITY 8
145 /* 3) Minimum vertical porch (lines) - default 3 */
146 #define CVT_MIN_V_PORCH 3
147 /* 4) Minimum number of vertical back porch lines - default 6 */
148 #define CVT_MIN_V_BPORCH 6
149 /* Pixel Clock step (kHz) */
150 #define CVT_CLOCK_STEP 250
151 struct drm_display_mode *drm_mode;
152 unsigned int vfieldrate, hperiod;
153 int hdisplay_rnd, hmargin, vdisplay_rnd, vmargin, vsync;
154 int interlace;
155 u64 tmp;
157 /* allocate the drm_display_mode structure. If failure, we will
158 * return directly
160 drm_mode = drm_mode_create(dev);
161 if (!drm_mode)
162 return NULL;
164 /* the CVT default refresh rate is 60Hz */
165 if (!vrefresh)
166 vrefresh = 60;
168 /* the required field fresh rate */
169 if (interlaced)
170 vfieldrate = vrefresh * 2;
171 else
172 vfieldrate = vrefresh;
174 /* horizontal pixels */
175 hdisplay_rnd = hdisplay - (hdisplay % CVT_H_GRANULARITY);
177 /* determine the left&right borders */
178 hmargin = 0;
179 if (margins) {
180 hmargin = hdisplay_rnd * CVT_MARGIN_PERCENTAGE / 1000;
181 hmargin -= hmargin % CVT_H_GRANULARITY;
183 /* find the total active pixels */
184 drm_mode->hdisplay = hdisplay_rnd + 2 * hmargin;
186 /* find the number of lines per field */
187 if (interlaced)
188 vdisplay_rnd = vdisplay / 2;
189 else
190 vdisplay_rnd = vdisplay;
192 /* find the top & bottom borders */
193 vmargin = 0;
194 if (margins)
195 vmargin = vdisplay_rnd * CVT_MARGIN_PERCENTAGE / 1000;
197 drm_mode->vdisplay = vdisplay + 2 * vmargin;
199 /* Interlaced */
200 if (interlaced)
201 interlace = 1;
202 else
203 interlace = 0;
205 /* Determine VSync Width from aspect ratio */
206 if (!(vdisplay % 3) && ((vdisplay * 4 / 3) == hdisplay))
207 vsync = 4;
208 else if (!(vdisplay % 9) && ((vdisplay * 16 / 9) == hdisplay))
209 vsync = 5;
210 else if (!(vdisplay % 10) && ((vdisplay * 16 / 10) == hdisplay))
211 vsync = 6;
212 else if (!(vdisplay % 4) && ((vdisplay * 5 / 4) == hdisplay))
213 vsync = 7;
214 else if (!(vdisplay % 9) && ((vdisplay * 15 / 9) == hdisplay))
215 vsync = 7;
216 else /* custom */
217 vsync = 10;
219 if (!reduced) {
220 /* simplify the GTF calculation */
221 /* 4) Minimum time of vertical sync + back porch interval (µs)
222 * default 550.0
224 int tmp1, tmp2;
225 #define CVT_MIN_VSYNC_BP 550
226 /* 3) Nominal HSync width (% of line period) - default 8 */
227 #define CVT_HSYNC_PERCENTAGE 8
228 unsigned int hblank_percentage;
229 int vsyncandback_porch, vback_porch, hblank;
231 /* estimated the horizontal period */
232 tmp1 = HV_FACTOR * 1000000 -
233 CVT_MIN_VSYNC_BP * HV_FACTOR * vfieldrate;
234 tmp2 = (vdisplay_rnd + 2 * vmargin + CVT_MIN_V_PORCH) * 2 +
235 interlace;
236 hperiod = tmp1 * 2 / (tmp2 * vfieldrate);
238 tmp1 = CVT_MIN_VSYNC_BP * HV_FACTOR / hperiod + 1;
239 /* 9. Find number of lines in sync + backporch */
240 if (tmp1 < (vsync + CVT_MIN_V_PORCH))
241 vsyncandback_porch = vsync + CVT_MIN_V_PORCH;
242 else
243 vsyncandback_porch = tmp1;
244 /* 10. Find number of lines in back porch */
245 vback_porch = vsyncandback_porch - vsync;
246 drm_mode->vtotal = vdisplay_rnd + 2 * vmargin +
247 vsyncandback_porch + CVT_MIN_V_PORCH;
248 /* 5) Definition of Horizontal blanking time limitation */
249 /* Gradient (%/kHz) - default 600 */
250 #define CVT_M_FACTOR 600
251 /* Offset (%) - default 40 */
252 #define CVT_C_FACTOR 40
253 /* Blanking time scaling factor - default 128 */
254 #define CVT_K_FACTOR 128
255 /* Scaling factor weighting - default 20 */
256 #define CVT_J_FACTOR 20
257 #define CVT_M_PRIME (CVT_M_FACTOR * CVT_K_FACTOR / 256)
258 #define CVT_C_PRIME ((CVT_C_FACTOR - CVT_J_FACTOR) * CVT_K_FACTOR / 256 + \
259 CVT_J_FACTOR)
260 /* 12. Find ideal blanking duty cycle from formula */
261 hblank_percentage = CVT_C_PRIME * HV_FACTOR - CVT_M_PRIME *
262 hperiod / 1000;
263 /* 13. Blanking time */
264 if (hblank_percentage < 20 * HV_FACTOR)
265 hblank_percentage = 20 * HV_FACTOR;
266 hblank = drm_mode->hdisplay * hblank_percentage /
267 (100 * HV_FACTOR - hblank_percentage);
268 hblank -= hblank % (2 * CVT_H_GRANULARITY);
269 /* 14. find the total pixels per line */
270 drm_mode->htotal = drm_mode->hdisplay + hblank;
271 drm_mode->hsync_end = drm_mode->hdisplay + hblank / 2;
272 drm_mode->hsync_start = drm_mode->hsync_end -
273 (drm_mode->htotal * CVT_HSYNC_PERCENTAGE) / 100;
274 drm_mode->hsync_start += CVT_H_GRANULARITY -
275 drm_mode->hsync_start % CVT_H_GRANULARITY;
276 /* fill the Vsync values */
277 drm_mode->vsync_start = drm_mode->vdisplay + CVT_MIN_V_PORCH;
278 drm_mode->vsync_end = drm_mode->vsync_start + vsync;
279 } else {
280 /* Reduced blanking */
281 /* Minimum vertical blanking interval time (µs)- default 460 */
282 #define CVT_RB_MIN_VBLANK 460
283 /* Fixed number of clocks for horizontal sync */
284 #define CVT_RB_H_SYNC 32
285 /* Fixed number of clocks for horizontal blanking */
286 #define CVT_RB_H_BLANK 160
287 /* Fixed number of lines for vertical front porch - default 3*/
288 #define CVT_RB_VFPORCH 3
289 int vbilines;
290 int tmp1, tmp2;
291 /* 8. Estimate Horizontal period. */
292 tmp1 = HV_FACTOR * 1000000 -
293 CVT_RB_MIN_VBLANK * HV_FACTOR * vfieldrate;
294 tmp2 = vdisplay_rnd + 2 * vmargin;
295 hperiod = tmp1 / (tmp2 * vfieldrate);
296 /* 9. Find number of lines in vertical blanking */
297 vbilines = CVT_RB_MIN_VBLANK * HV_FACTOR / hperiod + 1;
298 /* 10. Check if vertical blanking is sufficient */
299 if (vbilines < (CVT_RB_VFPORCH + vsync + CVT_MIN_V_BPORCH))
300 vbilines = CVT_RB_VFPORCH + vsync + CVT_MIN_V_BPORCH;
301 /* 11. Find total number of lines in vertical field */
302 drm_mode->vtotal = vdisplay_rnd + 2 * vmargin + vbilines;
303 /* 12. Find total number of pixels in a line */
304 drm_mode->htotal = drm_mode->hdisplay + CVT_RB_H_BLANK;
305 /* Fill in HSync values */
306 drm_mode->hsync_end = drm_mode->hdisplay + CVT_RB_H_BLANK / 2;
307 drm_mode->hsync_start = drm_mode->hsync_end - CVT_RB_H_SYNC;
308 /* Fill in VSync values */
309 drm_mode->vsync_start = drm_mode->vdisplay + CVT_RB_VFPORCH;
310 drm_mode->vsync_end = drm_mode->vsync_start + vsync;
312 /* 15/13. Find pixel clock frequency (kHz for xf86) */
313 tmp = drm_mode->htotal; /* perform intermediate calcs in u64 */
314 tmp *= HV_FACTOR * 1000;
315 do_div(tmp, hperiod);
316 tmp -= drm_mode->clock % CVT_CLOCK_STEP;
317 drm_mode->clock = tmp;
318 /* 18/16. Find actual vertical frame frequency */
319 /* ignore - just set the mode flag for interlaced */
320 if (interlaced) {
321 drm_mode->vtotal *= 2;
322 drm_mode->flags |= DRM_MODE_FLAG_INTERLACE;
324 /* Fill the mode line name */
325 drm_mode_set_name(drm_mode);
326 if (reduced)
327 drm_mode->flags |= (DRM_MODE_FLAG_PHSYNC |
328 DRM_MODE_FLAG_NVSYNC);
329 else
330 drm_mode->flags |= (DRM_MODE_FLAG_PVSYNC |
331 DRM_MODE_FLAG_NHSYNC);
333 return drm_mode;
335 EXPORT_SYMBOL(drm_cvt_mode);
338 * drm_gtf_mode_complex - create the modeline based on the full GTF algorithm
339 * @dev: drm device
340 * @hdisplay: hdisplay size
341 * @vdisplay: vdisplay size
342 * @vrefresh: vrefresh rate.
343 * @interlaced: whether to compute an interlaced mode
344 * @margins: desired margin (borders) size
345 * @GTF_M: extended GTF formula parameters
346 * @GTF_2C: extended GTF formula parameters
347 * @GTF_K: extended GTF formula parameters
348 * @GTF_2J: extended GTF formula parameters
350 * GTF feature blocks specify C and J in multiples of 0.5, so we pass them
351 * in here multiplied by two. For a C of 40, pass in 80.
353 * Returns:
354 * The modeline based on the full GTF algorithm stored in a drm_display_mode object.
355 * The display mode object is allocated with drm_mode_create(). Returns NULL
356 * when no mode could be allocated.
358 struct drm_display_mode *
359 drm_gtf_mode_complex(struct drm_device *dev, int hdisplay, int vdisplay,
360 int vrefresh, bool interlaced, int margins,
361 int GTF_M, int GTF_2C, int GTF_K, int GTF_2J)
362 { /* 1) top/bottom margin size (% of height) - default: 1.8, */
363 #define GTF_MARGIN_PERCENTAGE 18
364 /* 2) character cell horizontal granularity (pixels) - default 8 */
365 #define GTF_CELL_GRAN 8
366 /* 3) Minimum vertical porch (lines) - default 3 */
367 #define GTF_MIN_V_PORCH 1
368 /* width of vsync in lines */
369 #define V_SYNC_RQD 3
370 /* width of hsync as % of total line */
371 #define H_SYNC_PERCENT 8
372 /* min time of vsync + back porch (microsec) */
373 #define MIN_VSYNC_PLUS_BP 550
374 /* C' and M' are part of the Blanking Duty Cycle computation */
375 #define GTF_C_PRIME ((((GTF_2C - GTF_2J) * GTF_K / 256) + GTF_2J) / 2)
376 #define GTF_M_PRIME (GTF_K * GTF_M / 256)
377 struct drm_display_mode *drm_mode;
378 unsigned int hdisplay_rnd, vdisplay_rnd, vfieldrate_rqd;
379 int top_margin, bottom_margin;
380 int interlace;
381 unsigned int hfreq_est;
382 int vsync_plus_bp, vback_porch;
383 unsigned int vtotal_lines, vfieldrate_est, hperiod;
384 unsigned int vfield_rate, vframe_rate;
385 int left_margin, right_margin;
386 unsigned int total_active_pixels, ideal_duty_cycle;
387 unsigned int hblank, total_pixels, pixel_freq;
388 int hsync, hfront_porch, vodd_front_porch_lines;
389 unsigned int tmp1, tmp2;
391 drm_mode = drm_mode_create(dev);
392 if (!drm_mode)
393 return NULL;
395 /* 1. In order to give correct results, the number of horizontal
396 * pixels requested is first processed to ensure that it is divisible
397 * by the character size, by rounding it to the nearest character
398 * cell boundary:
400 hdisplay_rnd = (hdisplay + GTF_CELL_GRAN / 2) / GTF_CELL_GRAN;
401 hdisplay_rnd = hdisplay_rnd * GTF_CELL_GRAN;
403 /* 2. If interlace is requested, the number of vertical lines assumed
404 * by the calculation must be halved, as the computation calculates
405 * the number of vertical lines per field.
407 if (interlaced)
408 vdisplay_rnd = vdisplay / 2;
409 else
410 vdisplay_rnd = vdisplay;
412 /* 3. Find the frame rate required: */
413 if (interlaced)
414 vfieldrate_rqd = vrefresh * 2;
415 else
416 vfieldrate_rqd = vrefresh;
418 /* 4. Find number of lines in Top margin: */
419 top_margin = 0;
420 if (margins)
421 top_margin = (vdisplay_rnd * GTF_MARGIN_PERCENTAGE + 500) /
422 1000;
423 /* 5. Find number of lines in bottom margin: */
424 bottom_margin = top_margin;
426 /* 6. If interlace is required, then set variable interlace: */
427 if (interlaced)
428 interlace = 1;
429 else
430 interlace = 0;
432 /* 7. Estimate the Horizontal frequency */
434 tmp1 = (1000000 - MIN_VSYNC_PLUS_BP * vfieldrate_rqd) / 500;
435 tmp2 = (vdisplay_rnd + 2 * top_margin + GTF_MIN_V_PORCH) *
436 2 + interlace;
437 hfreq_est = (tmp2 * 1000 * vfieldrate_rqd) / tmp1;
440 /* 8. Find the number of lines in V sync + back porch */
441 /* [V SYNC+BP] = RINT(([MIN VSYNC+BP] * hfreq_est / 1000000)) */
442 vsync_plus_bp = MIN_VSYNC_PLUS_BP * hfreq_est / 1000;
443 vsync_plus_bp = (vsync_plus_bp + 500) / 1000;
444 /* 9. Find the number of lines in V back porch alone: */
445 vback_porch = vsync_plus_bp - V_SYNC_RQD;
446 /* 10. Find the total number of lines in Vertical field period: */
447 vtotal_lines = vdisplay_rnd + top_margin + bottom_margin +
448 vsync_plus_bp + GTF_MIN_V_PORCH;
449 /* 11. Estimate the Vertical field frequency: */
450 vfieldrate_est = hfreq_est / vtotal_lines;
451 /* 12. Find the actual horizontal period: */
452 hperiod = 1000000 / (vfieldrate_rqd * vtotal_lines);
454 /* 13. Find the actual Vertical field frequency: */
455 vfield_rate = hfreq_est / vtotal_lines;
456 /* 14. Find the Vertical frame frequency: */
457 if (interlaced)
458 vframe_rate = vfield_rate / 2;
459 else
460 vframe_rate = vfield_rate;
461 /* 15. Find number of pixels in left margin: */
462 if (margins)
463 left_margin = (hdisplay_rnd * GTF_MARGIN_PERCENTAGE + 500) /
464 1000;
465 else
466 left_margin = 0;
468 /* 16.Find number of pixels in right margin: */
469 right_margin = left_margin;
470 /* 17.Find total number of active pixels in image and left and right */
471 total_active_pixels = hdisplay_rnd + left_margin + right_margin;
472 /* 18.Find the ideal blanking duty cycle from blanking duty cycle */
473 ideal_duty_cycle = GTF_C_PRIME * 1000 -
474 (GTF_M_PRIME * 1000000 / hfreq_est);
475 /* 19.Find the number of pixels in the blanking time to the nearest
476 * double character cell: */
477 hblank = total_active_pixels * ideal_duty_cycle /
478 (100000 - ideal_duty_cycle);
479 hblank = (hblank + GTF_CELL_GRAN) / (2 * GTF_CELL_GRAN);
480 hblank = hblank * 2 * GTF_CELL_GRAN;
481 /* 20.Find total number of pixels: */
482 total_pixels = total_active_pixels + hblank;
483 /* 21.Find pixel clock frequency: */
484 pixel_freq = total_pixels * hfreq_est / 1000;
485 /* Stage 1 computations are now complete; I should really pass
486 * the results to another function and do the Stage 2 computations,
487 * but I only need a few more values so I'll just append the
488 * computations here for now */
489 /* 17. Find the number of pixels in the horizontal sync period: */
490 hsync = H_SYNC_PERCENT * total_pixels / 100;
491 hsync = (hsync + GTF_CELL_GRAN / 2) / GTF_CELL_GRAN;
492 hsync = hsync * GTF_CELL_GRAN;
493 /* 18. Find the number of pixels in horizontal front porch period */
494 hfront_porch = hblank / 2 - hsync;
495 /* 36. Find the number of lines in the odd front porch period: */
496 vodd_front_porch_lines = GTF_MIN_V_PORCH ;
498 /* finally, pack the results in the mode struct */
499 drm_mode->hdisplay = hdisplay_rnd;
500 drm_mode->hsync_start = hdisplay_rnd + hfront_porch;
501 drm_mode->hsync_end = drm_mode->hsync_start + hsync;
502 drm_mode->htotal = total_pixels;
503 drm_mode->vdisplay = vdisplay_rnd;
504 drm_mode->vsync_start = vdisplay_rnd + vodd_front_porch_lines;
505 drm_mode->vsync_end = drm_mode->vsync_start + V_SYNC_RQD;
506 drm_mode->vtotal = vtotal_lines;
508 drm_mode->clock = pixel_freq;
510 if (interlaced) {
511 drm_mode->vtotal *= 2;
512 drm_mode->flags |= DRM_MODE_FLAG_INTERLACE;
515 drm_mode_set_name(drm_mode);
516 if (GTF_M == 600 && GTF_2C == 80 && GTF_K == 128 && GTF_2J == 40)
517 drm_mode->flags = DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC;
518 else
519 drm_mode->flags = DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_NVSYNC;
521 return drm_mode;
523 EXPORT_SYMBOL(drm_gtf_mode_complex);
526 * drm_gtf_mode - create the modeline based on the GTF algorithm
527 * @dev: drm device
528 * @hdisplay: hdisplay size
529 * @vdisplay: vdisplay size
530 * @vrefresh: vrefresh rate.
531 * @interlaced: whether to compute an interlaced mode
532 * @margins: desired margin (borders) size
534 * return the modeline based on GTF algorithm
536 * This function is to create the modeline based on the GTF algorithm.
537 * Generalized Timing Formula is derived from:
539 * GTF Spreadsheet by Andy Morrish (1/5/97)
540 * available at http://www.vesa.org
542 * And it is copied from the file of xserver/hw/xfree86/modes/xf86gtf.c.
543 * What I have done is to translate it by using integer calculation.
544 * I also refer to the function of fb_get_mode in the file of
545 * drivers/video/fbmon.c
547 * Standard GTF parameters::
549 * M = 600
550 * C = 40
551 * K = 128
552 * J = 20
554 * Returns:
555 * The modeline based on the GTF algorithm stored in a drm_display_mode object.
556 * The display mode object is allocated with drm_mode_create(). Returns NULL
557 * when no mode could be allocated.
559 struct drm_display_mode *
560 drm_gtf_mode(struct drm_device *dev, int hdisplay, int vdisplay, int vrefresh,
561 bool interlaced, int margins)
563 return drm_gtf_mode_complex(dev, hdisplay, vdisplay, vrefresh,
564 interlaced, margins,
565 600, 40 * 2, 128, 20 * 2);
567 EXPORT_SYMBOL(drm_gtf_mode);
569 #ifdef CONFIG_VIDEOMODE_HELPERS
571 * drm_display_mode_from_videomode - fill in @dmode using @vm,
572 * @vm: videomode structure to use as source
573 * @dmode: drm_display_mode structure to use as destination
575 * Fills out @dmode using the display mode specified in @vm.
577 void drm_display_mode_from_videomode(const struct videomode *vm,
578 struct drm_display_mode *dmode)
580 dmode->hdisplay = vm->hactive;
581 dmode->hsync_start = dmode->hdisplay + vm->hfront_porch;
582 dmode->hsync_end = dmode->hsync_start + vm->hsync_len;
583 dmode->htotal = dmode->hsync_end + vm->hback_porch;
585 dmode->vdisplay = vm->vactive;
586 dmode->vsync_start = dmode->vdisplay + vm->vfront_porch;
587 dmode->vsync_end = dmode->vsync_start + vm->vsync_len;
588 dmode->vtotal = dmode->vsync_end + vm->vback_porch;
590 dmode->clock = vm->pixelclock / 1000;
592 dmode->flags = 0;
593 if (vm->flags & DISPLAY_FLAGS_HSYNC_HIGH)
594 dmode->flags |= DRM_MODE_FLAG_PHSYNC;
595 else if (vm->flags & DISPLAY_FLAGS_HSYNC_LOW)
596 dmode->flags |= DRM_MODE_FLAG_NHSYNC;
597 if (vm->flags & DISPLAY_FLAGS_VSYNC_HIGH)
598 dmode->flags |= DRM_MODE_FLAG_PVSYNC;
599 else if (vm->flags & DISPLAY_FLAGS_VSYNC_LOW)
600 dmode->flags |= DRM_MODE_FLAG_NVSYNC;
601 if (vm->flags & DISPLAY_FLAGS_INTERLACED)
602 dmode->flags |= DRM_MODE_FLAG_INTERLACE;
603 if (vm->flags & DISPLAY_FLAGS_DOUBLESCAN)
604 dmode->flags |= DRM_MODE_FLAG_DBLSCAN;
605 if (vm->flags & DISPLAY_FLAGS_DOUBLECLK)
606 dmode->flags |= DRM_MODE_FLAG_DBLCLK;
607 drm_mode_set_name(dmode);
609 EXPORT_SYMBOL_GPL(drm_display_mode_from_videomode);
612 * drm_display_mode_to_videomode - fill in @vm using @dmode,
613 * @dmode: drm_display_mode structure to use as source
614 * @vm: videomode structure to use as destination
616 * Fills out @vm using the display mode specified in @dmode.
618 void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
619 struct videomode *vm)
621 vm->hactive = dmode->hdisplay;
622 vm->hfront_porch = dmode->hsync_start - dmode->hdisplay;
623 vm->hsync_len = dmode->hsync_end - dmode->hsync_start;
624 vm->hback_porch = dmode->htotal - dmode->hsync_end;
626 vm->vactive = dmode->vdisplay;
627 vm->vfront_porch = dmode->vsync_start - dmode->vdisplay;
628 vm->vsync_len = dmode->vsync_end - dmode->vsync_start;
629 vm->vback_porch = dmode->vtotal - dmode->vsync_end;
631 vm->pixelclock = dmode->clock * 1000;
633 vm->flags = 0;
634 if (dmode->flags & DRM_MODE_FLAG_PHSYNC)
635 vm->flags |= DISPLAY_FLAGS_HSYNC_HIGH;
636 else if (dmode->flags & DRM_MODE_FLAG_NHSYNC)
637 vm->flags |= DISPLAY_FLAGS_HSYNC_LOW;
638 if (dmode->flags & DRM_MODE_FLAG_PVSYNC)
639 vm->flags |= DISPLAY_FLAGS_VSYNC_HIGH;
640 else if (dmode->flags & DRM_MODE_FLAG_NVSYNC)
641 vm->flags |= DISPLAY_FLAGS_VSYNC_LOW;
642 if (dmode->flags & DRM_MODE_FLAG_INTERLACE)
643 vm->flags |= DISPLAY_FLAGS_INTERLACED;
644 if (dmode->flags & DRM_MODE_FLAG_DBLSCAN)
645 vm->flags |= DISPLAY_FLAGS_DOUBLESCAN;
646 if (dmode->flags & DRM_MODE_FLAG_DBLCLK)
647 vm->flags |= DISPLAY_FLAGS_DOUBLECLK;
649 EXPORT_SYMBOL_GPL(drm_display_mode_to_videomode);
652 * drm_bus_flags_from_videomode - extract information about pixelclk and
653 * DE polarity from videomode and store it in a separate variable
654 * @vm: videomode structure to use
655 * @bus_flags: information about pixelclk, sync and DE polarity will be stored
656 * here
658 * Sets DRM_BUS_FLAG_DE_(LOW|HIGH), DRM_BUS_FLAG_PIXDATA_(POS|NEG)EDGE and
659 * DISPLAY_FLAGS_SYNC_(POS|NEG)EDGE in @bus_flags according to DISPLAY_FLAGS
660 * found in @vm
662 void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags)
664 *bus_flags = 0;
665 if (vm->flags & DISPLAY_FLAGS_PIXDATA_POSEDGE)
666 *bus_flags |= DRM_BUS_FLAG_PIXDATA_POSEDGE;
667 if (vm->flags & DISPLAY_FLAGS_PIXDATA_NEGEDGE)
668 *bus_flags |= DRM_BUS_FLAG_PIXDATA_NEGEDGE;
670 if (vm->flags & DISPLAY_FLAGS_SYNC_POSEDGE)
671 *bus_flags |= DRM_BUS_FLAG_SYNC_POSEDGE;
672 if (vm->flags & DISPLAY_FLAGS_SYNC_NEGEDGE)
673 *bus_flags |= DRM_BUS_FLAG_SYNC_NEGEDGE;
675 if (vm->flags & DISPLAY_FLAGS_DE_LOW)
676 *bus_flags |= DRM_BUS_FLAG_DE_LOW;
677 if (vm->flags & DISPLAY_FLAGS_DE_HIGH)
678 *bus_flags |= DRM_BUS_FLAG_DE_HIGH;
680 EXPORT_SYMBOL_GPL(drm_bus_flags_from_videomode);
682 #ifdef CONFIG_OF
684 * of_get_drm_display_mode - get a drm_display_mode from devicetree
685 * @np: device_node with the timing specification
686 * @dmode: will be set to the return value
687 * @bus_flags: information about pixelclk, sync and DE polarity
688 * @index: index into the list of display timings in devicetree
690 * This function is expensive and should only be used, if only one mode is to be
691 * read from DT. To get multiple modes start with of_get_display_timings and
692 * work with that instead.
694 * Returns:
695 * 0 on success, a negative errno code when no of videomode node was found.
697 int of_get_drm_display_mode(struct device_node *np,
698 struct drm_display_mode *dmode, u32 *bus_flags,
699 int index)
701 struct videomode vm;
702 int ret;
704 ret = of_get_videomode(np, &vm, index);
705 if (ret)
706 return ret;
708 drm_display_mode_from_videomode(&vm, dmode);
709 if (bus_flags)
710 drm_bus_flags_from_videomode(&vm, bus_flags);
712 pr_debug("%pOF: got %dx%d display mode\n",
713 np, vm.hactive, vm.vactive);
714 drm_mode_debug_printmodeline(dmode);
716 return 0;
718 EXPORT_SYMBOL_GPL(of_get_drm_display_mode);
719 #endif /* CONFIG_OF */
720 #endif /* CONFIG_VIDEOMODE_HELPERS */
723 * drm_mode_set_name - set the name on a mode
724 * @mode: name will be set in this mode
726 * Set the name of @mode to a standard format which is <hdisplay>x<vdisplay>
727 * with an optional 'i' suffix for interlaced modes.
729 void drm_mode_set_name(struct drm_display_mode *mode)
731 bool interlaced = !!(mode->flags & DRM_MODE_FLAG_INTERLACE);
733 snprintf(mode->name, DRM_DISPLAY_MODE_LEN, "%dx%d%s",
734 mode->hdisplay, mode->vdisplay,
735 interlaced ? "i" : "");
737 EXPORT_SYMBOL(drm_mode_set_name);
740 * drm_mode_hsync - get the hsync of a mode
741 * @mode: mode
743 * Returns:
744 * @modes's hsync rate in kHz, rounded to the nearest integer. Calculates the
745 * value first if it is not yet set.
747 int drm_mode_hsync(const struct drm_display_mode *mode)
749 unsigned int calc_val;
751 if (mode->hsync)
752 return mode->hsync;
754 if (mode->htotal <= 0)
755 return 0;
757 calc_val = (mode->clock * 1000) / mode->htotal; /* hsync in Hz */
758 calc_val += 500; /* round to 1000Hz */
759 calc_val /= 1000; /* truncate to kHz */
761 return calc_val;
763 EXPORT_SYMBOL(drm_mode_hsync);
766 * drm_mode_vrefresh - get the vrefresh of a mode
767 * @mode: mode
769 * Returns:
770 * @modes's vrefresh rate in Hz, rounded to the nearest integer. Calculates the
771 * value first if it is not yet set.
773 int drm_mode_vrefresh(const struct drm_display_mode *mode)
775 int refresh = 0;
777 if (mode->vrefresh > 0)
778 refresh = mode->vrefresh;
779 else if (mode->htotal > 0 && mode->vtotal > 0) {
780 unsigned int num, den;
782 num = mode->clock * 1000;
783 den = mode->htotal * mode->vtotal;
785 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
786 num *= 2;
787 if (mode->flags & DRM_MODE_FLAG_DBLSCAN)
788 den *= 2;
789 if (mode->vscan > 1)
790 den *= mode->vscan;
792 refresh = DIV_ROUND_CLOSEST(num, den);
794 return refresh;
796 EXPORT_SYMBOL(drm_mode_vrefresh);
799 * drm_mode_get_hv_timing - Fetches hdisplay/vdisplay for given mode
800 * @mode: mode to query
801 * @hdisplay: hdisplay value to fill in
802 * @vdisplay: vdisplay value to fill in
804 * The vdisplay value will be doubled if the specified mode is a stereo mode of
805 * the appropriate layout.
807 void drm_mode_get_hv_timing(const struct drm_display_mode *mode,
808 int *hdisplay, int *vdisplay)
810 struct drm_display_mode adjusted = *mode;
812 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
813 *hdisplay = adjusted.crtc_hdisplay;
814 *vdisplay = adjusted.crtc_vdisplay;
816 EXPORT_SYMBOL(drm_mode_get_hv_timing);
819 * drm_mode_set_crtcinfo - set CRTC modesetting timing parameters
820 * @p: mode
821 * @adjust_flags: a combination of adjustment flags
823 * Setup the CRTC modesetting timing parameters for @p, adjusting if necessary.
825 * - The CRTC_INTERLACE_HALVE_V flag can be used to halve vertical timings of
826 * interlaced modes.
827 * - The CRTC_STEREO_DOUBLE flag can be used to compute the timings for
828 * buffers containing two eyes (only adjust the timings when needed, eg. for
829 * "frame packing" or "side by side full").
830 * - The CRTC_NO_DBLSCAN and CRTC_NO_VSCAN flags request that adjustment *not*
831 * be performed for doublescan and vscan > 1 modes respectively.
833 void drm_mode_set_crtcinfo(struct drm_display_mode *p, int adjust_flags)
835 if (!p)
836 return;
838 p->crtc_clock = p->clock;
839 p->crtc_hdisplay = p->hdisplay;
840 p->crtc_hsync_start = p->hsync_start;
841 p->crtc_hsync_end = p->hsync_end;
842 p->crtc_htotal = p->htotal;
843 p->crtc_hskew = p->hskew;
844 p->crtc_vdisplay = p->vdisplay;
845 p->crtc_vsync_start = p->vsync_start;
846 p->crtc_vsync_end = p->vsync_end;
847 p->crtc_vtotal = p->vtotal;
849 if (p->flags & DRM_MODE_FLAG_INTERLACE) {
850 if (adjust_flags & CRTC_INTERLACE_HALVE_V) {
851 p->crtc_vdisplay /= 2;
852 p->crtc_vsync_start /= 2;
853 p->crtc_vsync_end /= 2;
854 p->crtc_vtotal /= 2;
858 if (!(adjust_flags & CRTC_NO_DBLSCAN)) {
859 if (p->flags & DRM_MODE_FLAG_DBLSCAN) {
860 p->crtc_vdisplay *= 2;
861 p->crtc_vsync_start *= 2;
862 p->crtc_vsync_end *= 2;
863 p->crtc_vtotal *= 2;
867 if (!(adjust_flags & CRTC_NO_VSCAN)) {
868 if (p->vscan > 1) {
869 p->crtc_vdisplay *= p->vscan;
870 p->crtc_vsync_start *= p->vscan;
871 p->crtc_vsync_end *= p->vscan;
872 p->crtc_vtotal *= p->vscan;
876 if (adjust_flags & CRTC_STEREO_DOUBLE) {
877 unsigned int layout = p->flags & DRM_MODE_FLAG_3D_MASK;
879 switch (layout) {
880 case DRM_MODE_FLAG_3D_FRAME_PACKING:
881 p->crtc_clock *= 2;
882 p->crtc_vdisplay += p->crtc_vtotal;
883 p->crtc_vsync_start += p->crtc_vtotal;
884 p->crtc_vsync_end += p->crtc_vtotal;
885 p->crtc_vtotal += p->crtc_vtotal;
886 break;
890 p->crtc_vblank_start = min(p->crtc_vsync_start, p->crtc_vdisplay);
891 p->crtc_vblank_end = max(p->crtc_vsync_end, p->crtc_vtotal);
892 p->crtc_hblank_start = min(p->crtc_hsync_start, p->crtc_hdisplay);
893 p->crtc_hblank_end = max(p->crtc_hsync_end, p->crtc_htotal);
895 EXPORT_SYMBOL(drm_mode_set_crtcinfo);
898 * drm_mode_copy - copy the mode
899 * @dst: mode to overwrite
900 * @src: mode to copy
902 * Copy an existing mode into another mode, preserving the object id and
903 * list head of the destination mode.
905 void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src)
907 struct list_head head = dst->head;
909 *dst = *src;
910 dst->head = head;
912 EXPORT_SYMBOL(drm_mode_copy);
915 * drm_mode_duplicate - allocate and duplicate an existing mode
916 * @dev: drm_device to allocate the duplicated mode for
917 * @mode: mode to duplicate
919 * Just allocate a new mode, copy the existing mode into it, and return
920 * a pointer to it. Used to create new instances of established modes.
922 * Returns:
923 * Pointer to duplicated mode on success, NULL on error.
925 struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
926 const struct drm_display_mode *mode)
928 struct drm_display_mode *nmode;
930 nmode = drm_mode_create(dev);
931 if (!nmode)
932 return NULL;
934 drm_mode_copy(nmode, mode);
936 return nmode;
938 EXPORT_SYMBOL(drm_mode_duplicate);
940 static bool drm_mode_match_timings(const struct drm_display_mode *mode1,
941 const struct drm_display_mode *mode2)
943 return mode1->hdisplay == mode2->hdisplay &&
944 mode1->hsync_start == mode2->hsync_start &&
945 mode1->hsync_end == mode2->hsync_end &&
946 mode1->htotal == mode2->htotal &&
947 mode1->hskew == mode2->hskew &&
948 mode1->vdisplay == mode2->vdisplay &&
949 mode1->vsync_start == mode2->vsync_start &&
950 mode1->vsync_end == mode2->vsync_end &&
951 mode1->vtotal == mode2->vtotal &&
952 mode1->vscan == mode2->vscan;
955 static bool drm_mode_match_clock(const struct drm_display_mode *mode1,
956 const struct drm_display_mode *mode2)
959 * do clock check convert to PICOS
960 * so fb modes get matched the same
962 if (mode1->clock && mode2->clock)
963 return KHZ2PICOS(mode1->clock) == KHZ2PICOS(mode2->clock);
964 else
965 return mode1->clock == mode2->clock;
968 static bool drm_mode_match_flags(const struct drm_display_mode *mode1,
969 const struct drm_display_mode *mode2)
971 return (mode1->flags & ~DRM_MODE_FLAG_3D_MASK) ==
972 (mode2->flags & ~DRM_MODE_FLAG_3D_MASK);
975 static bool drm_mode_match_3d_flags(const struct drm_display_mode *mode1,
976 const struct drm_display_mode *mode2)
978 return (mode1->flags & DRM_MODE_FLAG_3D_MASK) ==
979 (mode2->flags & DRM_MODE_FLAG_3D_MASK);
982 static bool drm_mode_match_aspect_ratio(const struct drm_display_mode *mode1,
983 const struct drm_display_mode *mode2)
985 return mode1->picture_aspect_ratio == mode2->picture_aspect_ratio;
989 * drm_mode_match - test modes for (partial) equality
990 * @mode1: first mode
991 * @mode2: second mode
992 * @match_flags: which parts need to match (DRM_MODE_MATCH_*)
994 * Check to see if @mode1 and @mode2 are equivalent.
996 * Returns:
997 * True if the modes are (partially) equal, false otherwise.
999 bool drm_mode_match(const struct drm_display_mode *mode1,
1000 const struct drm_display_mode *mode2,
1001 unsigned int match_flags)
1003 if (!mode1 && !mode2)
1004 return true;
1006 if (!mode1 || !mode2)
1007 return false;
1009 if (match_flags & DRM_MODE_MATCH_TIMINGS &&
1010 !drm_mode_match_timings(mode1, mode2))
1011 return false;
1013 if (match_flags & DRM_MODE_MATCH_CLOCK &&
1014 !drm_mode_match_clock(mode1, mode2))
1015 return false;
1017 if (match_flags & DRM_MODE_MATCH_FLAGS &&
1018 !drm_mode_match_flags(mode1, mode2))
1019 return false;
1021 if (match_flags & DRM_MODE_MATCH_3D_FLAGS &&
1022 !drm_mode_match_3d_flags(mode1, mode2))
1023 return false;
1025 if (match_flags & DRM_MODE_MATCH_ASPECT_RATIO &&
1026 !drm_mode_match_aspect_ratio(mode1, mode2))
1027 return false;
1029 return true;
1031 EXPORT_SYMBOL(drm_mode_match);
1034 * drm_mode_equal - test modes for equality
1035 * @mode1: first mode
1036 * @mode2: second mode
1038 * Check to see if @mode1 and @mode2 are equivalent.
1040 * Returns:
1041 * True if the modes are equal, false otherwise.
1043 bool drm_mode_equal(const struct drm_display_mode *mode1,
1044 const struct drm_display_mode *mode2)
1046 return drm_mode_match(mode1, mode2,
1047 DRM_MODE_MATCH_TIMINGS |
1048 DRM_MODE_MATCH_CLOCK |
1049 DRM_MODE_MATCH_FLAGS |
1050 DRM_MODE_MATCH_3D_FLAGS|
1051 DRM_MODE_MATCH_ASPECT_RATIO);
1053 EXPORT_SYMBOL(drm_mode_equal);
1056 * drm_mode_equal_no_clocks - test modes for equality
1057 * @mode1: first mode
1058 * @mode2: second mode
1060 * Check to see if @mode1 and @mode2 are equivalent, but
1061 * don't check the pixel clocks.
1063 * Returns:
1064 * True if the modes are equal, false otherwise.
1066 bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1,
1067 const struct drm_display_mode *mode2)
1069 return drm_mode_match(mode1, mode2,
1070 DRM_MODE_MATCH_TIMINGS |
1071 DRM_MODE_MATCH_FLAGS |
1072 DRM_MODE_MATCH_3D_FLAGS);
1074 EXPORT_SYMBOL(drm_mode_equal_no_clocks);
1077 * drm_mode_equal_no_clocks_no_stereo - test modes for equality
1078 * @mode1: first mode
1079 * @mode2: second mode
1081 * Check to see if @mode1 and @mode2 are equivalent, but
1082 * don't check the pixel clocks nor the stereo layout.
1084 * Returns:
1085 * True if the modes are equal, false otherwise.
1087 bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
1088 const struct drm_display_mode *mode2)
1090 return drm_mode_match(mode1, mode2,
1091 DRM_MODE_MATCH_TIMINGS |
1092 DRM_MODE_MATCH_FLAGS);
1094 EXPORT_SYMBOL(drm_mode_equal_no_clocks_no_stereo);
1096 static enum drm_mode_status
1097 drm_mode_validate_basic(const struct drm_display_mode *mode)
1099 if (mode->type & ~DRM_MODE_TYPE_ALL)
1100 return MODE_BAD;
1102 if (mode->flags & ~DRM_MODE_FLAG_ALL)
1103 return MODE_BAD;
1105 if ((mode->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1106 return MODE_BAD;
1108 if (mode->clock == 0)
1109 return MODE_CLOCK_LOW;
1111 if (mode->hdisplay == 0 ||
1112 mode->hsync_start < mode->hdisplay ||
1113 mode->hsync_end < mode->hsync_start ||
1114 mode->htotal < mode->hsync_end)
1115 return MODE_H_ILLEGAL;
1117 if (mode->vdisplay == 0 ||
1118 mode->vsync_start < mode->vdisplay ||
1119 mode->vsync_end < mode->vsync_start ||
1120 mode->vtotal < mode->vsync_end)
1121 return MODE_V_ILLEGAL;
1123 return MODE_OK;
1127 * drm_mode_validate_driver - make sure the mode is somewhat sane
1128 * @dev: drm device
1129 * @mode: mode to check
1131 * First do basic validation on the mode, and then allow the driver
1132 * to check for device/driver specific limitations via the optional
1133 * &drm_mode_config_helper_funcs.mode_valid hook.
1135 * Returns:
1136 * The mode status
1138 enum drm_mode_status
1139 drm_mode_validate_driver(struct drm_device *dev,
1140 const struct drm_display_mode *mode)
1142 enum drm_mode_status status;
1144 status = drm_mode_validate_basic(mode);
1145 if (status != MODE_OK)
1146 return status;
1148 if (dev->mode_config.funcs->mode_valid)
1149 return dev->mode_config.funcs->mode_valid(dev, mode);
1150 else
1151 return MODE_OK;
1153 EXPORT_SYMBOL(drm_mode_validate_driver);
1156 * drm_mode_validate_size - make sure modes adhere to size constraints
1157 * @mode: mode to check
1158 * @maxX: maximum width
1159 * @maxY: maximum height
1161 * This function is a helper which can be used to validate modes against size
1162 * limitations of the DRM device/connector. If a mode is too big its status
1163 * member is updated with the appropriate validation failure code. The list
1164 * itself is not changed.
1166 * Returns:
1167 * The mode status
1169 enum drm_mode_status
1170 drm_mode_validate_size(const struct drm_display_mode *mode,
1171 int maxX, int maxY)
1173 if (maxX > 0 && mode->hdisplay > maxX)
1174 return MODE_VIRTUAL_X;
1176 if (maxY > 0 && mode->vdisplay > maxY)
1177 return MODE_VIRTUAL_Y;
1179 return MODE_OK;
1181 EXPORT_SYMBOL(drm_mode_validate_size);
1184 * drm_mode_validate_ycbcr420 - add 'ycbcr420-only' modes only when allowed
1185 * @mode: mode to check
1186 * @connector: drm connector under action
1188 * This function is a helper which can be used to filter out any YCBCR420
1189 * only mode, when the source doesn't support it.
1191 * Returns:
1192 * The mode status
1194 enum drm_mode_status
1195 drm_mode_validate_ycbcr420(const struct drm_display_mode *mode,
1196 struct drm_connector *connector)
1198 u8 vic = drm_match_cea_mode(mode);
1199 enum drm_mode_status status = MODE_OK;
1200 struct drm_hdmi_info *hdmi = &connector->display_info.hdmi;
1202 if (test_bit(vic, hdmi->y420_vdb_modes)) {
1203 if (!connector->ycbcr_420_allowed)
1204 status = MODE_NO_420;
1207 return status;
1209 EXPORT_SYMBOL(drm_mode_validate_ycbcr420);
1211 #define MODE_STATUS(status) [MODE_ ## status + 3] = #status
1213 static const char * const drm_mode_status_names[] = {
1214 MODE_STATUS(OK),
1215 MODE_STATUS(HSYNC),
1216 MODE_STATUS(VSYNC),
1217 MODE_STATUS(H_ILLEGAL),
1218 MODE_STATUS(V_ILLEGAL),
1219 MODE_STATUS(BAD_WIDTH),
1220 MODE_STATUS(NOMODE),
1221 MODE_STATUS(NO_INTERLACE),
1222 MODE_STATUS(NO_DBLESCAN),
1223 MODE_STATUS(NO_VSCAN),
1224 MODE_STATUS(MEM),
1225 MODE_STATUS(VIRTUAL_X),
1226 MODE_STATUS(VIRTUAL_Y),
1227 MODE_STATUS(MEM_VIRT),
1228 MODE_STATUS(NOCLOCK),
1229 MODE_STATUS(CLOCK_HIGH),
1230 MODE_STATUS(CLOCK_LOW),
1231 MODE_STATUS(CLOCK_RANGE),
1232 MODE_STATUS(BAD_HVALUE),
1233 MODE_STATUS(BAD_VVALUE),
1234 MODE_STATUS(BAD_VSCAN),
1235 MODE_STATUS(HSYNC_NARROW),
1236 MODE_STATUS(HSYNC_WIDE),
1237 MODE_STATUS(HBLANK_NARROW),
1238 MODE_STATUS(HBLANK_WIDE),
1239 MODE_STATUS(VSYNC_NARROW),
1240 MODE_STATUS(VSYNC_WIDE),
1241 MODE_STATUS(VBLANK_NARROW),
1242 MODE_STATUS(VBLANK_WIDE),
1243 MODE_STATUS(PANEL),
1244 MODE_STATUS(INTERLACE_WIDTH),
1245 MODE_STATUS(ONE_WIDTH),
1246 MODE_STATUS(ONE_HEIGHT),
1247 MODE_STATUS(ONE_SIZE),
1248 MODE_STATUS(NO_REDUCED),
1249 MODE_STATUS(NO_STEREO),
1250 MODE_STATUS(NO_420),
1251 MODE_STATUS(STALE),
1252 MODE_STATUS(BAD),
1253 MODE_STATUS(ERROR),
1256 #undef MODE_STATUS
1258 const char *drm_get_mode_status_name(enum drm_mode_status status)
1260 int index = status + 3;
1262 if (WARN_ON(index < 0 || index >= ARRAY_SIZE(drm_mode_status_names)))
1263 return "";
1265 return drm_mode_status_names[index];
1269 * drm_mode_prune_invalid - remove invalid modes from mode list
1270 * @dev: DRM device
1271 * @mode_list: list of modes to check
1272 * @verbose: be verbose about it
1274 * This helper function can be used to prune a display mode list after
1275 * validation has been completed. All modes whose status is not MODE_OK will be
1276 * removed from the list, and if @verbose the status code and mode name is also
1277 * printed to dmesg.
1279 void drm_mode_prune_invalid(struct drm_device *dev,
1280 struct list_head *mode_list, bool verbose)
1282 struct drm_display_mode *mode, *t;
1284 list_for_each_entry_safe(mode, t, mode_list, head) {
1285 if (mode->status != MODE_OK) {
1286 list_del(&mode->head);
1287 if (verbose) {
1288 drm_mode_debug_printmodeline(mode);
1289 DRM_DEBUG_KMS("Not using %s mode: %s\n",
1290 mode->name,
1291 drm_get_mode_status_name(mode->status));
1293 drm_mode_destroy(dev, mode);
1297 EXPORT_SYMBOL(drm_mode_prune_invalid);
1300 * drm_mode_compare - compare modes for favorability
1301 * @priv: unused
1302 * @lh_a: list_head for first mode
1303 * @lh_b: list_head for second mode
1305 * Compare two modes, given by @lh_a and @lh_b, returning a value indicating
1306 * which is better.
1308 * Returns:
1309 * Negative if @lh_a is better than @lh_b, zero if they're equivalent, or
1310 * positive if @lh_b is better than @lh_a.
1312 static int drm_mode_compare(void *priv, struct list_head *lh_a, struct list_head *lh_b)
1314 struct drm_display_mode *a = list_entry(lh_a, struct drm_display_mode, head);
1315 struct drm_display_mode *b = list_entry(lh_b, struct drm_display_mode, head);
1316 int diff;
1318 diff = ((b->type & DRM_MODE_TYPE_PREFERRED) != 0) -
1319 ((a->type & DRM_MODE_TYPE_PREFERRED) != 0);
1320 if (diff)
1321 return diff;
1322 diff = b->hdisplay * b->vdisplay - a->hdisplay * a->vdisplay;
1323 if (diff)
1324 return diff;
1326 diff = b->vrefresh - a->vrefresh;
1327 if (diff)
1328 return diff;
1330 diff = b->clock - a->clock;
1331 return diff;
1335 * drm_mode_sort - sort mode list
1336 * @mode_list: list of drm_display_mode structures to sort
1338 * Sort @mode_list by favorability, moving good modes to the head of the list.
1340 void drm_mode_sort(struct list_head *mode_list)
1342 list_sort(NULL, mode_list, drm_mode_compare);
1344 EXPORT_SYMBOL(drm_mode_sort);
1347 * drm_connector_list_update - update the mode list for the connector
1348 * @connector: the connector to update
1350 * This moves the modes from the @connector probed_modes list
1351 * to the actual mode list. It compares the probed mode against the current
1352 * list and only adds different/new modes.
1354 * This is just a helper functions doesn't validate any modes itself and also
1355 * doesn't prune any invalid modes. Callers need to do that themselves.
1357 void drm_connector_list_update(struct drm_connector *connector)
1359 struct drm_display_mode *pmode, *pt;
1361 WARN_ON(!mutex_is_locked(&connector->dev->mode_config.mutex));
1363 list_for_each_entry_safe(pmode, pt, &connector->probed_modes, head) {
1364 struct drm_display_mode *mode;
1365 bool found_it = false;
1367 /* go through current modes checking for the new probed mode */
1368 list_for_each_entry(mode, &connector->modes, head) {
1369 if (!drm_mode_equal(pmode, mode))
1370 continue;
1372 found_it = true;
1375 * If the old matching mode is stale (ie. left over
1376 * from a previous probe) just replace it outright.
1377 * Otherwise just merge the type bits between all
1378 * equal probed modes.
1380 * If two probed modes are considered equal, pick the
1381 * actual timings from the one that's marked as
1382 * preferred (in case the match isn't 100%). If
1383 * multiple or zero preferred modes are present, favor
1384 * the mode added to the probed_modes list first.
1386 if (mode->status == MODE_STALE) {
1387 drm_mode_copy(mode, pmode);
1388 } else if ((mode->type & DRM_MODE_TYPE_PREFERRED) == 0 &&
1389 (pmode->type & DRM_MODE_TYPE_PREFERRED) != 0) {
1390 pmode->type |= mode->type;
1391 drm_mode_copy(mode, pmode);
1392 } else {
1393 mode->type |= pmode->type;
1396 list_del(&pmode->head);
1397 drm_mode_destroy(connector->dev, pmode);
1398 break;
1401 if (!found_it) {
1402 list_move_tail(&pmode->head, &connector->modes);
1406 EXPORT_SYMBOL(drm_connector_list_update);
1409 * drm_mode_parse_command_line_for_connector - parse command line modeline for connector
1410 * @mode_option: optional per connector mode option
1411 * @connector: connector to parse modeline for
1412 * @mode: preallocated drm_cmdline_mode structure to fill out
1414 * This parses @mode_option command line modeline for modes and options to
1415 * configure the connector. If @mode_option is NULL the default command line
1416 * modeline in fb_mode_option will be parsed instead.
1418 * This uses the same parameters as the fb modedb.c, except for an extra
1419 * force-enable, force-enable-digital and force-disable bit at the end::
1421 * <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m][eDd]
1423 * The intermediate drm_cmdline_mode structure is required to store additional
1424 * options from the command line modline like the force-enable/disable flag.
1426 * Returns:
1427 * True if a valid modeline has been parsed, false otherwise.
1429 bool drm_mode_parse_command_line_for_connector(const char *mode_option,
1430 struct drm_connector *connector,
1431 struct drm_cmdline_mode *mode)
1433 const char *name;
1434 unsigned int namelen;
1435 bool res_specified = false, bpp_specified = false, refresh_specified = false;
1436 unsigned int xres = 0, yres = 0, bpp = 32, refresh = 0;
1437 bool yres_specified = false, cvt = false, rb = false;
1438 bool interlace = false, margins = false, was_digit = false;
1439 int i;
1440 enum drm_connector_force force = DRM_FORCE_UNSPECIFIED;
1442 #ifdef CONFIG_FB
1443 if (!mode_option)
1444 mode_option = fb_mode_option;
1445 #endif
1447 if (!mode_option) {
1448 mode->specified = false;
1449 return false;
1452 name = mode_option;
1453 namelen = strlen(name);
1454 for (i = namelen-1; i >= 0; i--) {
1455 switch (name[i]) {
1456 case '@':
1457 if (!refresh_specified && !bpp_specified &&
1458 !yres_specified && !cvt && !rb && was_digit) {
1459 refresh = simple_strtol(&name[i+1], NULL, 10);
1460 refresh_specified = true;
1461 was_digit = false;
1462 } else
1463 goto done;
1464 break;
1465 case '-':
1466 if (!bpp_specified && !yres_specified && !cvt &&
1467 !rb && was_digit) {
1468 bpp = simple_strtol(&name[i+1], NULL, 10);
1469 bpp_specified = true;
1470 was_digit = false;
1471 } else
1472 goto done;
1473 break;
1474 case 'x':
1475 if (!yres_specified && was_digit) {
1476 yres = simple_strtol(&name[i+1], NULL, 10);
1477 yres_specified = true;
1478 was_digit = false;
1479 } else
1480 goto done;
1481 break;
1482 case '0' ... '9':
1483 was_digit = true;
1484 break;
1485 case 'M':
1486 if (yres_specified || cvt || was_digit)
1487 goto done;
1488 cvt = true;
1489 break;
1490 case 'R':
1491 if (yres_specified || cvt || rb || was_digit)
1492 goto done;
1493 rb = true;
1494 break;
1495 case 'm':
1496 if (cvt || yres_specified || was_digit)
1497 goto done;
1498 margins = true;
1499 break;
1500 case 'i':
1501 if (cvt || yres_specified || was_digit)
1502 goto done;
1503 interlace = true;
1504 break;
1505 case 'e':
1506 if (yres_specified || bpp_specified || refresh_specified ||
1507 was_digit || (force != DRM_FORCE_UNSPECIFIED))
1508 goto done;
1510 force = DRM_FORCE_ON;
1511 break;
1512 case 'D':
1513 if (yres_specified || bpp_specified || refresh_specified ||
1514 was_digit || (force != DRM_FORCE_UNSPECIFIED))
1515 goto done;
1517 if ((connector->connector_type != DRM_MODE_CONNECTOR_DVII) &&
1518 (connector->connector_type != DRM_MODE_CONNECTOR_HDMIB))
1519 force = DRM_FORCE_ON;
1520 else
1521 force = DRM_FORCE_ON_DIGITAL;
1522 break;
1523 case 'd':
1524 if (yres_specified || bpp_specified || refresh_specified ||
1525 was_digit || (force != DRM_FORCE_UNSPECIFIED))
1526 goto done;
1528 force = DRM_FORCE_OFF;
1529 break;
1530 default:
1531 goto done;
1535 if (i < 0 && yres_specified) {
1536 char *ch;
1537 xres = simple_strtol(name, &ch, 10);
1538 if ((ch != NULL) && (*ch == 'x'))
1539 res_specified = true;
1540 else
1541 i = ch - name;
1542 } else if (!yres_specified && was_digit) {
1543 /* catch mode that begins with digits but has no 'x' */
1544 i = 0;
1546 done:
1547 if (i >= 0) {
1548 pr_warn("[drm] parse error at position %i in video mode '%s'\n",
1549 i, name);
1550 mode->specified = false;
1551 return false;
1554 if (res_specified) {
1555 mode->specified = true;
1556 mode->xres = xres;
1557 mode->yres = yres;
1560 if (refresh_specified) {
1561 mode->refresh_specified = true;
1562 mode->refresh = refresh;
1565 if (bpp_specified) {
1566 mode->bpp_specified = true;
1567 mode->bpp = bpp;
1569 mode->rb = rb;
1570 mode->cvt = cvt;
1571 mode->interlace = interlace;
1572 mode->margins = margins;
1573 mode->force = force;
1575 return true;
1577 EXPORT_SYMBOL(drm_mode_parse_command_line_for_connector);
1580 * drm_mode_create_from_cmdline_mode - convert a command line modeline into a DRM display mode
1581 * @dev: DRM device to create the new mode for
1582 * @cmd: input command line modeline
1584 * Returns:
1585 * Pointer to converted mode on success, NULL on error.
1587 struct drm_display_mode *
1588 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1589 struct drm_cmdline_mode *cmd)
1591 struct drm_display_mode *mode;
1593 if (cmd->cvt)
1594 mode = drm_cvt_mode(dev,
1595 cmd->xres, cmd->yres,
1596 cmd->refresh_specified ? cmd->refresh : 60,
1597 cmd->rb, cmd->interlace,
1598 cmd->margins);
1599 else
1600 mode = drm_gtf_mode(dev,
1601 cmd->xres, cmd->yres,
1602 cmd->refresh_specified ? cmd->refresh : 60,
1603 cmd->interlace,
1604 cmd->margins);
1605 if (!mode)
1606 return NULL;
1608 mode->type |= DRM_MODE_TYPE_USERDEF;
1609 /* fix up 1368x768: GFT/CVT can't express 1366 width due to alignment */
1610 if (cmd->xres == 1366)
1611 drm_mode_fixup_1366x768(mode);
1612 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
1613 return mode;
1615 EXPORT_SYMBOL(drm_mode_create_from_cmdline_mode);
1618 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1619 * @out: drm_mode_modeinfo struct to return to the user
1620 * @in: drm_display_mode to use
1622 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1623 * the user.
1625 void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
1626 const struct drm_display_mode *in)
1628 WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1629 in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1630 in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1631 in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1632 in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1633 "timing values too large for mode info\n");
1635 out->clock = in->clock;
1636 out->hdisplay = in->hdisplay;
1637 out->hsync_start = in->hsync_start;
1638 out->hsync_end = in->hsync_end;
1639 out->htotal = in->htotal;
1640 out->hskew = in->hskew;
1641 out->vdisplay = in->vdisplay;
1642 out->vsync_start = in->vsync_start;
1643 out->vsync_end = in->vsync_end;
1644 out->vtotal = in->vtotal;
1645 out->vscan = in->vscan;
1646 out->vrefresh = in->vrefresh;
1647 out->flags = in->flags;
1648 out->type = in->type;
1650 switch (in->picture_aspect_ratio) {
1651 case HDMI_PICTURE_ASPECT_4_3:
1652 out->flags |= DRM_MODE_FLAG_PIC_AR_4_3;
1653 break;
1654 case HDMI_PICTURE_ASPECT_16_9:
1655 out->flags |= DRM_MODE_FLAG_PIC_AR_16_9;
1656 break;
1657 case HDMI_PICTURE_ASPECT_64_27:
1658 out->flags |= DRM_MODE_FLAG_PIC_AR_64_27;
1659 break;
1660 case HDMI_PICTURE_ASPECT_256_135:
1661 out->flags |= DRM_MODE_FLAG_PIC_AR_256_135;
1662 break;
1663 case HDMI_PICTURE_ASPECT_RESERVED:
1664 default:
1665 out->flags |= DRM_MODE_FLAG_PIC_AR_NONE;
1666 break;
1669 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1670 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1674 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1675 * @dev: drm device
1676 * @out: drm_display_mode to return to the user
1677 * @in: drm_mode_modeinfo to use
1679 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1680 * the caller.
1682 * Returns:
1683 * Zero on success, negative errno on failure.
1685 int drm_mode_convert_umode(struct drm_device *dev,
1686 struct drm_display_mode *out,
1687 const struct drm_mode_modeinfo *in)
1689 if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1690 return -ERANGE;
1692 out->clock = in->clock;
1693 out->hdisplay = in->hdisplay;
1694 out->hsync_start = in->hsync_start;
1695 out->hsync_end = in->hsync_end;
1696 out->htotal = in->htotal;
1697 out->hskew = in->hskew;
1698 out->vdisplay = in->vdisplay;
1699 out->vsync_start = in->vsync_start;
1700 out->vsync_end = in->vsync_end;
1701 out->vtotal = in->vtotal;
1702 out->vscan = in->vscan;
1703 out->vrefresh = in->vrefresh;
1704 out->flags = in->flags;
1706 * Old xf86-video-vmware (possibly others too) used to
1707 * leave 'type' unititialized. Just ignore any bits we
1708 * don't like. It's a just hint after all, and more
1709 * useful for the kernel->userspace direction anyway.
1711 out->type = in->type & DRM_MODE_TYPE_ALL;
1712 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1713 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1715 /* Clearing picture aspect ratio bits from out flags,
1716 * as the aspect-ratio information is not stored in
1717 * flags for kernel-mode, but in picture_aspect_ratio.
1719 out->flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
1721 switch (in->flags & DRM_MODE_FLAG_PIC_AR_MASK) {
1722 case DRM_MODE_FLAG_PIC_AR_4_3:
1723 out->picture_aspect_ratio |= HDMI_PICTURE_ASPECT_4_3;
1724 break;
1725 case DRM_MODE_FLAG_PIC_AR_16_9:
1726 out->picture_aspect_ratio |= HDMI_PICTURE_ASPECT_16_9;
1727 break;
1728 case DRM_MODE_FLAG_PIC_AR_64_27:
1729 out->picture_aspect_ratio |= HDMI_PICTURE_ASPECT_64_27;
1730 break;
1731 case DRM_MODE_FLAG_PIC_AR_256_135:
1732 out->picture_aspect_ratio |= HDMI_PICTURE_ASPECT_256_135;
1733 break;
1734 default:
1735 out->picture_aspect_ratio = HDMI_PICTURE_ASPECT_NONE;
1736 break;
1739 out->status = drm_mode_validate_driver(dev, out);
1740 if (out->status != MODE_OK)
1741 return -EINVAL;
1743 drm_mode_set_crtcinfo(out, CRTC_INTERLACE_HALVE_V);
1745 return 0;
1749 * drm_mode_is_420_only - if a given videomode can be only supported in YCBCR420
1750 * output format
1752 * @display: display under action
1753 * @mode: video mode to be tested.
1755 * Returns:
1756 * true if the mode can be supported in YCBCR420 format
1757 * false if not.
1759 bool drm_mode_is_420_only(const struct drm_display_info *display,
1760 const struct drm_display_mode *mode)
1762 u8 vic = drm_match_cea_mode(mode);
1764 return test_bit(vic, display->hdmi.y420_vdb_modes);
1766 EXPORT_SYMBOL(drm_mode_is_420_only);
1769 * drm_mode_is_420_also - if a given videomode can be supported in YCBCR420
1770 * output format also (along with RGB/YCBCR444/422)
1772 * @display: display under action.
1773 * @mode: video mode to be tested.
1775 * Returns:
1776 * true if the mode can be support YCBCR420 format
1777 * false if not.
1779 bool drm_mode_is_420_also(const struct drm_display_info *display,
1780 const struct drm_display_mode *mode)
1782 u8 vic = drm_match_cea_mode(mode);
1784 return test_bit(vic, display->hdmi.y420_cmdb_modes);
1786 EXPORT_SYMBOL(drm_mode_is_420_also);
1788 * drm_mode_is_420 - if a given videomode can be supported in YCBCR420
1789 * output format
1791 * @display: display under action.
1792 * @mode: video mode to be tested.
1794 * Returns:
1795 * true if the mode can be supported in YCBCR420 format
1796 * false if not.
1798 bool drm_mode_is_420(const struct drm_display_info *display,
1799 const struct drm_display_mode *mode)
1801 return drm_mode_is_420_only(display, mode) ||
1802 drm_mode_is_420_also(display, mode);
1804 EXPORT_SYMBOL(drm_mode_is_420);