drm/modes: Introduce a whitelist for the named modes
[linux-2.6-block.git] / drivers / gpu / drm / drm_modes.c
CommitLineData
f453ba04 1/*
f453ba04
DA
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>
d782c3f9 6 * Copyright 2005-2006 Luc Verhaegen
26bbdada 7 * Copyright (c) 2001, Andy Ritger aritger@nvidia.com
f453ba04
DA
8 *
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:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
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.
26 *
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).
31 */
32
e08ab74b 33#include <linux/ctype.h>
f453ba04 34#include <linux/list.h>
2c761270 35#include <linux/list_sort.h>
2d1a8a48 36#include <linux/export.h>
0500c04e 37
edb37a95 38#include <video/of_videomode.h>
ebc64e45 39#include <video/videomode.h>
0500c04e
SR
40
41#include <drm/drm_crtc.h>
42#include <drm/drm_device.h>
55310008 43#include <drm/drm_modes.h>
0500c04e 44#include <drm/drm_print.h>
f453ba04 45
8bd441b2
DV
46#include "drm_crtc_internal.h"
47
f453ba04 48/**
3ec0db81 49 * drm_mode_debug_printmodeline - print a mode to dmesg
f453ba04
DA
50 * @mode: mode to print
51 *
f453ba04
DA
52 * Describe @mode using DRM_DEBUG.
53 */
0b3904ab 54void drm_mode_debug_printmodeline(const struct drm_display_mode *mode)
f453ba04 55{
65c7dc18 56 DRM_DEBUG_KMS("Modeline " DRM_MODE_FMT "\n", DRM_MODE_ARG(mode));
f453ba04
DA
57}
58EXPORT_SYMBOL(drm_mode_debug_printmodeline);
59
8bd441b2
DV
60/**
61 * drm_mode_create - create a new display mode
62 * @dev: DRM device
63 *
f5aabb97
DV
64 * Create a new, cleared drm_display_mode with kzalloc, allocate an ID for it
65 * and return it.
8bd441b2 66 *
f5aabb97 67 * Returns:
8bd441b2
DV
68 * Pointer to new mode on success, NULL on error.
69 */
70struct drm_display_mode *drm_mode_create(struct drm_device *dev)
71{
72 struct drm_display_mode *nmode;
73
74 nmode = kzalloc(sizeof(struct drm_display_mode), GFP_KERNEL);
75 if (!nmode)
76 return NULL;
77
8bd441b2
DV
78 return nmode;
79}
80EXPORT_SYMBOL(drm_mode_create);
81
82/**
83 * drm_mode_destroy - remove a mode
84 * @dev: DRM device
85 * @mode: mode to remove
86 *
f5aabb97 87 * Release @mode's unique ID, then free it @mode structure itself using kfree.
8bd441b2
DV
88 */
89void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode)
90{
91 if (!mode)
92 return;
93
8bd441b2
DV
94 kfree(mode);
95}
96EXPORT_SYMBOL(drm_mode_destroy);
97
98/**
f5aabb97 99 * drm_mode_probed_add - add a mode to a connector's probed_mode list
8bd441b2
DV
100 * @connector: connector the new mode
101 * @mode: mode data
102 *
f5aabb97
DV
103 * Add @mode to @connector's probed_mode list for later use. This list should
104 * then in a second step get filtered and all the modes actually supported by
105 * the hardware moved to the @connector's modes list.
8bd441b2
DV
106 */
107void drm_mode_probed_add(struct drm_connector *connector,
108 struct drm_display_mode *mode)
109{
110 WARN_ON(!mutex_is_locked(&connector->dev->mode_config.mutex));
111
112 list_add_tail(&mode->head, &connector->probed_modes);
113}
114EXPORT_SYMBOL(drm_mode_probed_add);
115
d782c3f9 116/**
f5aabb97
DV
117 * drm_cvt_mode -create a modeline based on the CVT algorithm
118 * @dev: drm device
d782c3f9
ZY
119 * @hdisplay: hdisplay size
120 * @vdisplay: vdisplay size
f5aabb97
DV
121 * @vrefresh: vrefresh rate
122 * @reduced: whether to use reduced blanking
123 * @interlaced: whether to compute an interlaced mode
124 * @margins: whether to add margins (borders)
d782c3f9
ZY
125 *
126 * This function is called to generate the modeline based on CVT algorithm
127 * according to the hdisplay, vdisplay, vrefresh.
128 * It is based from the VESA(TM) Coordinated Video Timing Generator by
129 * Graham Loveridge April 9, 2003 available at
631dd1a8 130 * http://www.elo.utfsm.cl/~elo212/docs/CVTd6r1.xls
d782c3f9
ZY
131 *
132 * And it is copied from xf86CVTmode in xserver/hw/xfree86/modes/xf86cvt.c.
133 * What I have done is to translate it by using integer calculation.
f5aabb97
DV
134 *
135 * Returns:
136 * The modeline based on the CVT algorithm stored in a drm_display_mode object.
137 * The display mode object is allocated with drm_mode_create(). Returns NULL
138 * when no mode could be allocated.
d782c3f9 139 */
d782c3f9
ZY
140struct drm_display_mode *drm_cvt_mode(struct drm_device *dev, int hdisplay,
141 int vdisplay, int vrefresh,
d50ba256 142 bool reduced, bool interlaced, bool margins)
d782c3f9 143{
3ec0db81 144#define HV_FACTOR 1000
d782c3f9
ZY
145 /* 1) top/bottom margin size (% of height) - default: 1.8, */
146#define CVT_MARGIN_PERCENTAGE 18
147 /* 2) character cell horizontal granularity (pixels) - default 8 */
148#define CVT_H_GRANULARITY 8
149 /* 3) Minimum vertical porch (lines) - default 3 */
150#define CVT_MIN_V_PORCH 3
151 /* 4) Minimum number of vertical back porch lines - default 6 */
152#define CVT_MIN_V_BPORCH 6
153 /* Pixel Clock step (kHz) */
154#define CVT_CLOCK_STEP 250
155 struct drm_display_mode *drm_mode;
d782c3f9
ZY
156 unsigned int vfieldrate, hperiod;
157 int hdisplay_rnd, hmargin, vdisplay_rnd, vmargin, vsync;
158 int interlace;
8a5bbf32 159 u64 tmp;
d782c3f9 160
7f3bbc0b
DO
161 if (!hdisplay || !vdisplay)
162 return NULL;
163
d782c3f9
ZY
164 /* allocate the drm_display_mode structure. If failure, we will
165 * return directly
166 */
167 drm_mode = drm_mode_create(dev);
168 if (!drm_mode)
169 return NULL;
170
171 /* the CVT default refresh rate is 60Hz */
172 if (!vrefresh)
173 vrefresh = 60;
174
175 /* the required field fresh rate */
176 if (interlaced)
177 vfieldrate = vrefresh * 2;
178 else
179 vfieldrate = vrefresh;
180
181 /* horizontal pixels */
182 hdisplay_rnd = hdisplay - (hdisplay % CVT_H_GRANULARITY);
183
184 /* determine the left&right borders */
185 hmargin = 0;
186 if (margins) {
187 hmargin = hdisplay_rnd * CVT_MARGIN_PERCENTAGE / 1000;
188 hmargin -= hmargin % CVT_H_GRANULARITY;
189 }
190 /* find the total active pixels */
191 drm_mode->hdisplay = hdisplay_rnd + 2 * hmargin;
192
193 /* find the number of lines per field */
194 if (interlaced)
195 vdisplay_rnd = vdisplay / 2;
196 else
197 vdisplay_rnd = vdisplay;
198
199 /* find the top & bottom borders */
200 vmargin = 0;
201 if (margins)
202 vmargin = vdisplay_rnd * CVT_MARGIN_PERCENTAGE / 1000;
203
841b4117 204 drm_mode->vdisplay = vdisplay + 2 * vmargin;
d782c3f9
ZY
205
206 /* Interlaced */
207 if (interlaced)
208 interlace = 1;
209 else
210 interlace = 0;
211
212 /* Determine VSync Width from aspect ratio */
213 if (!(vdisplay % 3) && ((vdisplay * 4 / 3) == hdisplay))
214 vsync = 4;
215 else if (!(vdisplay % 9) && ((vdisplay * 16 / 9) == hdisplay))
216 vsync = 5;
217 else if (!(vdisplay % 10) && ((vdisplay * 16 / 10) == hdisplay))
218 vsync = 6;
219 else if (!(vdisplay % 4) && ((vdisplay * 5 / 4) == hdisplay))
220 vsync = 7;
221 else if (!(vdisplay % 9) && ((vdisplay * 15 / 9) == hdisplay))
222 vsync = 7;
223 else /* custom */
224 vsync = 10;
225
226 if (!reduced) {
227 /* simplify the GTF calculation */
228 /* 4) Minimum time of vertical sync + back porch interval (µs)
229 * default 550.0
230 */
231 int tmp1, tmp2;
232#define CVT_MIN_VSYNC_BP 550
233 /* 3) Nominal HSync width (% of line period) - default 8 */
234#define CVT_HSYNC_PERCENTAGE 8
235 unsigned int hblank_percentage;
236 int vsyncandback_porch, vback_porch, hblank;
237
238 /* estimated the horizontal period */
239 tmp1 = HV_FACTOR * 1000000 -
240 CVT_MIN_VSYNC_BP * HV_FACTOR * vfieldrate;
241 tmp2 = (vdisplay_rnd + 2 * vmargin + CVT_MIN_V_PORCH) * 2 +
242 interlace;
243 hperiod = tmp1 * 2 / (tmp2 * vfieldrate);
244
245 tmp1 = CVT_MIN_VSYNC_BP * HV_FACTOR / hperiod + 1;
246 /* 9. Find number of lines in sync + backporch */
247 if (tmp1 < (vsync + CVT_MIN_V_PORCH))
248 vsyncandback_porch = vsync + CVT_MIN_V_PORCH;
249 else
250 vsyncandback_porch = tmp1;
251 /* 10. Find number of lines in back porch */
252 vback_porch = vsyncandback_porch - vsync;
253 drm_mode->vtotal = vdisplay_rnd + 2 * vmargin +
254 vsyncandback_porch + CVT_MIN_V_PORCH;
255 /* 5) Definition of Horizontal blanking time limitation */
256 /* Gradient (%/kHz) - default 600 */
257#define CVT_M_FACTOR 600
258 /* Offset (%) - default 40 */
259#define CVT_C_FACTOR 40
260 /* Blanking time scaling factor - default 128 */
261#define CVT_K_FACTOR 128
262 /* Scaling factor weighting - default 20 */
263#define CVT_J_FACTOR 20
264#define CVT_M_PRIME (CVT_M_FACTOR * CVT_K_FACTOR / 256)
265#define CVT_C_PRIME ((CVT_C_FACTOR - CVT_J_FACTOR) * CVT_K_FACTOR / 256 + \
266 CVT_J_FACTOR)
267 /* 12. Find ideal blanking duty cycle from formula */
268 hblank_percentage = CVT_C_PRIME * HV_FACTOR - CVT_M_PRIME *
269 hperiod / 1000;
270 /* 13. Blanking time */
271 if (hblank_percentage < 20 * HV_FACTOR)
272 hblank_percentage = 20 * HV_FACTOR;
273 hblank = drm_mode->hdisplay * hblank_percentage /
274 (100 * HV_FACTOR - hblank_percentage);
275 hblank -= hblank % (2 * CVT_H_GRANULARITY);
2a97acd6 276 /* 14. find the total pixels per line */
d782c3f9
ZY
277 drm_mode->htotal = drm_mode->hdisplay + hblank;
278 drm_mode->hsync_end = drm_mode->hdisplay + hblank / 2;
279 drm_mode->hsync_start = drm_mode->hsync_end -
280 (drm_mode->htotal * CVT_HSYNC_PERCENTAGE) / 100;
281 drm_mode->hsync_start += CVT_H_GRANULARITY -
282 drm_mode->hsync_start % CVT_H_GRANULARITY;
283 /* fill the Vsync values */
284 drm_mode->vsync_start = drm_mode->vdisplay + CVT_MIN_V_PORCH;
285 drm_mode->vsync_end = drm_mode->vsync_start + vsync;
286 } else {
287 /* Reduced blanking */
288 /* Minimum vertical blanking interval time (µs)- default 460 */
289#define CVT_RB_MIN_VBLANK 460
290 /* Fixed number of clocks for horizontal sync */
291#define CVT_RB_H_SYNC 32
292 /* Fixed number of clocks for horizontal blanking */
293#define CVT_RB_H_BLANK 160
294 /* Fixed number of lines for vertical front porch - default 3*/
295#define CVT_RB_VFPORCH 3
296 int vbilines;
297 int tmp1, tmp2;
298 /* 8. Estimate Horizontal period. */
299 tmp1 = HV_FACTOR * 1000000 -
300 CVT_RB_MIN_VBLANK * HV_FACTOR * vfieldrate;
301 tmp2 = vdisplay_rnd + 2 * vmargin;
302 hperiod = tmp1 / (tmp2 * vfieldrate);
303 /* 9. Find number of lines in vertical blanking */
304 vbilines = CVT_RB_MIN_VBLANK * HV_FACTOR / hperiod + 1;
305 /* 10. Check if vertical blanking is sufficient */
306 if (vbilines < (CVT_RB_VFPORCH + vsync + CVT_MIN_V_BPORCH))
307 vbilines = CVT_RB_VFPORCH + vsync + CVT_MIN_V_BPORCH;
308 /* 11. Find total number of lines in vertical field */
309 drm_mode->vtotal = vdisplay_rnd + 2 * vmargin + vbilines;
310 /* 12. Find total number of pixels in a line */
311 drm_mode->htotal = drm_mode->hdisplay + CVT_RB_H_BLANK;
312 /* Fill in HSync values */
313 drm_mode->hsync_end = drm_mode->hdisplay + CVT_RB_H_BLANK / 2;
adde0f23
AJ
314 drm_mode->hsync_start = drm_mode->hsync_end - CVT_RB_H_SYNC;
315 /* Fill in VSync values */
316 drm_mode->vsync_start = drm_mode->vdisplay + CVT_RB_VFPORCH;
317 drm_mode->vsync_end = drm_mode->vsync_start + vsync;
d782c3f9
ZY
318 }
319 /* 15/13. Find pixel clock frequency (kHz for xf86) */
8a5bbf32
CW
320 tmp = drm_mode->htotal; /* perform intermediate calcs in u64 */
321 tmp *= HV_FACTOR * 1000;
322 do_div(tmp, hperiod);
323 tmp -= drm_mode->clock % CVT_CLOCK_STEP;
324 drm_mode->clock = tmp;
d782c3f9
ZY
325 /* 18/16. Find actual vertical frame frequency */
326 /* ignore - just set the mode flag for interlaced */
171fdd89 327 if (interlaced) {
d782c3f9 328 drm_mode->vtotal *= 2;
171fdd89
AJ
329 drm_mode->flags |= DRM_MODE_FLAG_INTERLACE;
330 }
d782c3f9
ZY
331 /* Fill the mode line name */
332 drm_mode_set_name(drm_mode);
333 if (reduced)
334 drm_mode->flags |= (DRM_MODE_FLAG_PHSYNC |
335 DRM_MODE_FLAG_NVSYNC);
336 else
337 drm_mode->flags |= (DRM_MODE_FLAG_PVSYNC |
338 DRM_MODE_FLAG_NHSYNC);
d782c3f9 339
171fdd89 340 return drm_mode;
d782c3f9
ZY
341}
342EXPORT_SYMBOL(drm_cvt_mode);
343
26bbdada 344/**
f5aabb97
DV
345 * drm_gtf_mode_complex - create the modeline based on the full GTF algorithm
346 * @dev: drm device
347 * @hdisplay: hdisplay size
348 * @vdisplay: vdisplay size
349 * @vrefresh: vrefresh rate.
350 * @interlaced: whether to compute an interlaced mode
351 * @margins: desired margin (borders) size
3ec0db81
DV
352 * @GTF_M: extended GTF formula parameters
353 * @GTF_2C: extended GTF formula parameters
354 * @GTF_K: extended GTF formula parameters
355 * @GTF_2J: extended GTF formula parameters
26bbdada 356 *
7a374350
AJ
357 * GTF feature blocks specify C and J in multiples of 0.5, so we pass them
358 * in here multiplied by two. For a C of 40, pass in 80.
f5aabb97
DV
359 *
360 * Returns:
361 * The modeline based on the full GTF algorithm stored in a drm_display_mode object.
362 * The display mode object is allocated with drm_mode_create(). Returns NULL
363 * when no mode could be allocated.
26bbdada 364 */
7a374350
AJ
365struct drm_display_mode *
366drm_gtf_mode_complex(struct drm_device *dev, int hdisplay, int vdisplay,
367 int vrefresh, bool interlaced, int margins,
368 int GTF_M, int GTF_2C, int GTF_K, int GTF_2J)
369{ /* 1) top/bottom margin size (% of height) - default: 1.8, */
26bbdada
ZY
370#define GTF_MARGIN_PERCENTAGE 18
371 /* 2) character cell horizontal granularity (pixels) - default 8 */
372#define GTF_CELL_GRAN 8
373 /* 3) Minimum vertical porch (lines) - default 3 */
374#define GTF_MIN_V_PORCH 1
375 /* width of vsync in lines */
376#define V_SYNC_RQD 3
377 /* width of hsync as % of total line */
378#define H_SYNC_PERCENT 8
379 /* min time of vsync + back porch (microsec) */
380#define MIN_VSYNC_PLUS_BP 550
26bbdada 381 /* C' and M' are part of the Blanking Duty Cycle computation */
7a374350
AJ
382#define GTF_C_PRIME ((((GTF_2C - GTF_2J) * GTF_K / 256) + GTF_2J) / 2)
383#define GTF_M_PRIME (GTF_K * GTF_M / 256)
26bbdada
ZY
384 struct drm_display_mode *drm_mode;
385 unsigned int hdisplay_rnd, vdisplay_rnd, vfieldrate_rqd;
386 int top_margin, bottom_margin;
387 int interlace;
388 unsigned int hfreq_est;
389 int vsync_plus_bp, vback_porch;
390 unsigned int vtotal_lines, vfieldrate_est, hperiod;
391 unsigned int vfield_rate, vframe_rate;
392 int left_margin, right_margin;
393 unsigned int total_active_pixels, ideal_duty_cycle;
394 unsigned int hblank, total_pixels, pixel_freq;
395 int hsync, hfront_porch, vodd_front_porch_lines;
396 unsigned int tmp1, tmp2;
397
7f3bbc0b
DO
398 if (!hdisplay || !vdisplay)
399 return NULL;
400
26bbdada
ZY
401 drm_mode = drm_mode_create(dev);
402 if (!drm_mode)
403 return NULL;
404
405 /* 1. In order to give correct results, the number of horizontal
406 * pixels requested is first processed to ensure that it is divisible
407 * by the character size, by rounding it to the nearest character
408 * cell boundary:
409 */
410 hdisplay_rnd = (hdisplay + GTF_CELL_GRAN / 2) / GTF_CELL_GRAN;
411 hdisplay_rnd = hdisplay_rnd * GTF_CELL_GRAN;
412
413 /* 2. If interlace is requested, the number of vertical lines assumed
414 * by the calculation must be halved, as the computation calculates
415 * the number of vertical lines per field.
416 */
417 if (interlaced)
418 vdisplay_rnd = vdisplay / 2;
419 else
420 vdisplay_rnd = vdisplay;
421
422 /* 3. Find the frame rate required: */
423 if (interlaced)
424 vfieldrate_rqd = vrefresh * 2;
425 else
426 vfieldrate_rqd = vrefresh;
427
428 /* 4. Find number of lines in Top margin: */
429 top_margin = 0;
430 if (margins)
431 top_margin = (vdisplay_rnd * GTF_MARGIN_PERCENTAGE + 500) /
432 1000;
433 /* 5. Find number of lines in bottom margin: */
434 bottom_margin = top_margin;
435
436 /* 6. If interlace is required, then set variable interlace: */
437 if (interlaced)
438 interlace = 1;
439 else
440 interlace = 0;
441
442 /* 7. Estimate the Horizontal frequency */
443 {
444 tmp1 = (1000000 - MIN_VSYNC_PLUS_BP * vfieldrate_rqd) / 500;
445 tmp2 = (vdisplay_rnd + 2 * top_margin + GTF_MIN_V_PORCH) *
446 2 + interlace;
447 hfreq_est = (tmp2 * 1000 * vfieldrate_rqd) / tmp1;
448 }
449
450 /* 8. Find the number of lines in V sync + back porch */
451 /* [V SYNC+BP] = RINT(([MIN VSYNC+BP] * hfreq_est / 1000000)) */
452 vsync_plus_bp = MIN_VSYNC_PLUS_BP * hfreq_est / 1000;
453 vsync_plus_bp = (vsync_plus_bp + 500) / 1000;
454 /* 9. Find the number of lines in V back porch alone: */
455 vback_porch = vsync_plus_bp - V_SYNC_RQD;
456 /* 10. Find the total number of lines in Vertical field period: */
457 vtotal_lines = vdisplay_rnd + top_margin + bottom_margin +
458 vsync_plus_bp + GTF_MIN_V_PORCH;
459 /* 11. Estimate the Vertical field frequency: */
460 vfieldrate_est = hfreq_est / vtotal_lines;
461 /* 12. Find the actual horizontal period: */
462 hperiod = 1000000 / (vfieldrate_rqd * vtotal_lines);
463
464 /* 13. Find the actual Vertical field frequency: */
465 vfield_rate = hfreq_est / vtotal_lines;
466 /* 14. Find the Vertical frame frequency: */
467 if (interlaced)
468 vframe_rate = vfield_rate / 2;
469 else
470 vframe_rate = vfield_rate;
471 /* 15. Find number of pixels in left margin: */
472 if (margins)
473 left_margin = (hdisplay_rnd * GTF_MARGIN_PERCENTAGE + 500) /
474 1000;
475 else
476 left_margin = 0;
477
478 /* 16.Find number of pixels in right margin: */
479 right_margin = left_margin;
480 /* 17.Find total number of active pixels in image and left and right */
481 total_active_pixels = hdisplay_rnd + left_margin + right_margin;
482 /* 18.Find the ideal blanking duty cycle from blanking duty cycle */
483 ideal_duty_cycle = GTF_C_PRIME * 1000 -
484 (GTF_M_PRIME * 1000000 / hfreq_est);
485 /* 19.Find the number of pixels in the blanking time to the nearest
486 * double character cell: */
487 hblank = total_active_pixels * ideal_duty_cycle /
488 (100000 - ideal_duty_cycle);
489 hblank = (hblank + GTF_CELL_GRAN) / (2 * GTF_CELL_GRAN);
490 hblank = hblank * 2 * GTF_CELL_GRAN;
491 /* 20.Find total number of pixels: */
492 total_pixels = total_active_pixels + hblank;
493 /* 21.Find pixel clock frequency: */
494 pixel_freq = total_pixels * hfreq_est / 1000;
495 /* Stage 1 computations are now complete; I should really pass
496 * the results to another function and do the Stage 2 computations,
497 * but I only need a few more values so I'll just append the
498 * computations here for now */
499 /* 17. Find the number of pixels in the horizontal sync period: */
500 hsync = H_SYNC_PERCENT * total_pixels / 100;
501 hsync = (hsync + GTF_CELL_GRAN / 2) / GTF_CELL_GRAN;
502 hsync = hsync * GTF_CELL_GRAN;
503 /* 18. Find the number of pixels in horizontal front porch period */
504 hfront_porch = hblank / 2 - hsync;
505 /* 36. Find the number of lines in the odd front porch period: */
506 vodd_front_porch_lines = GTF_MIN_V_PORCH ;
507
508 /* finally, pack the results in the mode struct */
509 drm_mode->hdisplay = hdisplay_rnd;
510 drm_mode->hsync_start = hdisplay_rnd + hfront_porch;
511 drm_mode->hsync_end = drm_mode->hsync_start + hsync;
512 drm_mode->htotal = total_pixels;
513 drm_mode->vdisplay = vdisplay_rnd;
514 drm_mode->vsync_start = vdisplay_rnd + vodd_front_porch_lines;
515 drm_mode->vsync_end = drm_mode->vsync_start + V_SYNC_RQD;
516 drm_mode->vtotal = vtotal_lines;
517
518 drm_mode->clock = pixel_freq;
519
26bbdada
ZY
520 if (interlaced) {
521 drm_mode->vtotal *= 2;
522 drm_mode->flags |= DRM_MODE_FLAG_INTERLACE;
523 }
524
171fdd89 525 drm_mode_set_name(drm_mode);
c385e50c
AJ
526 if (GTF_M == 600 && GTF_2C == 80 && GTF_K == 128 && GTF_2J == 40)
527 drm_mode->flags = DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC;
528 else
529 drm_mode->flags = DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_NVSYNC;
171fdd89 530
26bbdada
ZY
531 return drm_mode;
532}
7a374350
AJ
533EXPORT_SYMBOL(drm_gtf_mode_complex);
534
535/**
f5aabb97
DV
536 * drm_gtf_mode - create the modeline based on the GTF algorithm
537 * @dev: drm device
538 * @hdisplay: hdisplay size
539 * @vdisplay: vdisplay size
540 * @vrefresh: vrefresh rate.
541 * @interlaced: whether to compute an interlaced mode
542 * @margins: desired margin (borders) size
7a374350 543 *
7a374350
AJ
544 * return the modeline based on GTF algorithm
545 *
546 * This function is to create the modeline based on the GTF algorithm.
547 * Generalized Timing Formula is derived from:
2e7a5701 548 *
7a374350
AJ
549 * GTF Spreadsheet by Andy Morrish (1/5/97)
550 * available at http://www.vesa.org
551 *
552 * And it is copied from the file of xserver/hw/xfree86/modes/xf86gtf.c.
553 * What I have done is to translate it by using integer calculation.
554 * I also refer to the function of fb_get_mode in the file of
555 * drivers/video/fbmon.c
556 *
da5335b8
DV
557 * Standard GTF parameters::
558 *
f03d8ede
DCLP
559 * M = 600
560 * C = 40
561 * K = 128
562 * J = 20
f5aabb97
DV
563 *
564 * Returns:
565 * The modeline based on the GTF algorithm stored in a drm_display_mode object.
566 * The display mode object is allocated with drm_mode_create(). Returns NULL
567 * when no mode could be allocated.
7a374350
AJ
568 */
569struct drm_display_mode *
570drm_gtf_mode(struct drm_device *dev, int hdisplay, int vdisplay, int vrefresh,
3ec0db81 571 bool interlaced, int margins)
7a374350 572{
3ec0db81
DV
573 return drm_gtf_mode_complex(dev, hdisplay, vdisplay, vrefresh,
574 interlaced, margins,
575 600, 40 * 2, 128, 20 * 2);
7a374350 576}
26bbdada 577EXPORT_SYMBOL(drm_gtf_mode);
7a374350 578
a38884f6 579#ifdef CONFIG_VIDEOMODE_HELPERS
f5aabb97
DV
580/**
581 * drm_display_mode_from_videomode - fill in @dmode using @vm,
582 * @vm: videomode structure to use as source
583 * @dmode: drm_display_mode structure to use as destination
584 *
585 * Fills out @dmode using the display mode specified in @vm.
586 */
ba0c2422
DV
587void drm_display_mode_from_videomode(const struct videomode *vm,
588 struct drm_display_mode *dmode)
ebc64e45
ST
589{
590 dmode->hdisplay = vm->hactive;
591 dmode->hsync_start = dmode->hdisplay + vm->hfront_porch;
592 dmode->hsync_end = dmode->hsync_start + vm->hsync_len;
593 dmode->htotal = dmode->hsync_end + vm->hback_porch;
594
595 dmode->vdisplay = vm->vactive;
596 dmode->vsync_start = dmode->vdisplay + vm->vfront_porch;
597 dmode->vsync_end = dmode->vsync_start + vm->vsync_len;
598 dmode->vtotal = dmode->vsync_end + vm->vback_porch;
599
600 dmode->clock = vm->pixelclock / 1000;
601
602 dmode->flags = 0;
06a33079 603 if (vm->flags & DISPLAY_FLAGS_HSYNC_HIGH)
ebc64e45 604 dmode->flags |= DRM_MODE_FLAG_PHSYNC;
06a33079 605 else if (vm->flags & DISPLAY_FLAGS_HSYNC_LOW)
ebc64e45 606 dmode->flags |= DRM_MODE_FLAG_NHSYNC;
06a33079 607 if (vm->flags & DISPLAY_FLAGS_VSYNC_HIGH)
ebc64e45 608 dmode->flags |= DRM_MODE_FLAG_PVSYNC;
06a33079 609 else if (vm->flags & DISPLAY_FLAGS_VSYNC_LOW)
ebc64e45 610 dmode->flags |= DRM_MODE_FLAG_NVSYNC;
06a33079 611 if (vm->flags & DISPLAY_FLAGS_INTERLACED)
ebc64e45 612 dmode->flags |= DRM_MODE_FLAG_INTERLACE;
06a33079 613 if (vm->flags & DISPLAY_FLAGS_DOUBLESCAN)
ebc64e45 614 dmode->flags |= DRM_MODE_FLAG_DBLSCAN;
328a4719
ST
615 if (vm->flags & DISPLAY_FLAGS_DOUBLECLK)
616 dmode->flags |= DRM_MODE_FLAG_DBLCLK;
ebc64e45 617 drm_mode_set_name(dmode);
ebc64e45
ST
618}
619EXPORT_SYMBOL_GPL(drm_display_mode_from_videomode);
ebc64e45 620
d490f455
SL
621/**
622 * drm_display_mode_to_videomode - fill in @vm using @dmode,
623 * @dmode: drm_display_mode structure to use as source
624 * @vm: videomode structure to use as destination
625 *
626 * Fills out @vm using the display mode specified in @dmode.
627 */
628void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
629 struct videomode *vm)
630{
631 vm->hactive = dmode->hdisplay;
632 vm->hfront_porch = dmode->hsync_start - dmode->hdisplay;
633 vm->hsync_len = dmode->hsync_end - dmode->hsync_start;
634 vm->hback_porch = dmode->htotal - dmode->hsync_end;
635
636 vm->vactive = dmode->vdisplay;
637 vm->vfront_porch = dmode->vsync_start - dmode->vdisplay;
638 vm->vsync_len = dmode->vsync_end - dmode->vsync_start;
639 vm->vback_porch = dmode->vtotal - dmode->vsync_end;
640
641 vm->pixelclock = dmode->clock * 1000;
642
643 vm->flags = 0;
644 if (dmode->flags & DRM_MODE_FLAG_PHSYNC)
645 vm->flags |= DISPLAY_FLAGS_HSYNC_HIGH;
646 else if (dmode->flags & DRM_MODE_FLAG_NHSYNC)
647 vm->flags |= DISPLAY_FLAGS_HSYNC_LOW;
648 if (dmode->flags & DRM_MODE_FLAG_PVSYNC)
649 vm->flags |= DISPLAY_FLAGS_VSYNC_HIGH;
650 else if (dmode->flags & DRM_MODE_FLAG_NVSYNC)
651 vm->flags |= DISPLAY_FLAGS_VSYNC_LOW;
652 if (dmode->flags & DRM_MODE_FLAG_INTERLACE)
653 vm->flags |= DISPLAY_FLAGS_INTERLACED;
654 if (dmode->flags & DRM_MODE_FLAG_DBLSCAN)
655 vm->flags |= DISPLAY_FLAGS_DOUBLESCAN;
656 if (dmode->flags & DRM_MODE_FLAG_DBLCLK)
657 vm->flags |= DISPLAY_FLAGS_DOUBLECLK;
658}
659EXPORT_SYMBOL_GPL(drm_display_mode_to_videomode);
660
cb34d7f2
LW
661/**
662 * drm_bus_flags_from_videomode - extract information about pixelclk and
663 * DE polarity from videomode and store it in a separate variable
664 * @vm: videomode structure to use
955f60db
PU
665 * @bus_flags: information about pixelclk, sync and DE polarity will be stored
666 * here
cb34d7f2 667 *
88bc4178
LP
668 * Sets DRM_BUS_FLAG_DE_(LOW|HIGH), DRM_BUS_FLAG_PIXDATA_DRIVE_(POS|NEG)EDGE
669 * and DISPLAY_FLAGS_SYNC_(POS|NEG)EDGE in @bus_flags according to DISPLAY_FLAGS
955f60db 670 * found in @vm
cb34d7f2 671 */
d72daa0d
LW
672void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags)
673{
674 *bus_flags = 0;
675 if (vm->flags & DISPLAY_FLAGS_PIXDATA_POSEDGE)
88bc4178 676 *bus_flags |= DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE;
d72daa0d 677 if (vm->flags & DISPLAY_FLAGS_PIXDATA_NEGEDGE)
88bc4178 678 *bus_flags |= DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE;
d72daa0d 679
955f60db 680 if (vm->flags & DISPLAY_FLAGS_SYNC_POSEDGE)
88bc4178 681 *bus_flags |= DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE;
955f60db 682 if (vm->flags & DISPLAY_FLAGS_SYNC_NEGEDGE)
88bc4178 683 *bus_flags |= DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE;
955f60db 684
d72daa0d
LW
685 if (vm->flags & DISPLAY_FLAGS_DE_LOW)
686 *bus_flags |= DRM_BUS_FLAG_DE_LOW;
687 if (vm->flags & DISPLAY_FLAGS_DE_HIGH)
688 *bus_flags |= DRM_BUS_FLAG_DE_HIGH;
689}
690EXPORT_SYMBOL_GPL(drm_bus_flags_from_videomode);
691
a38884f6 692#ifdef CONFIG_OF
edb37a95
ST
693/**
694 * of_get_drm_display_mode - get a drm_display_mode from devicetree
695 * @np: device_node with the timing specification
696 * @dmode: will be set to the return value
955f60db 697 * @bus_flags: information about pixelclk, sync and DE polarity
edb37a95
ST
698 * @index: index into the list of display timings in devicetree
699 *
700 * This function is expensive and should only be used, if only one mode is to be
701 * read from DT. To get multiple modes start with of_get_display_timings and
702 * work with that instead.
f5aabb97
DV
703 *
704 * Returns:
705 * 0 on success, a negative errno code when no of videomode node was found.
edb37a95
ST
706 */
707int of_get_drm_display_mode(struct device_node *np,
fafc79ef
LW
708 struct drm_display_mode *dmode, u32 *bus_flags,
709 int index)
edb37a95
ST
710{
711 struct videomode vm;
712 int ret;
713
714 ret = of_get_videomode(np, &vm, index);
715 if (ret)
716 return ret;
717
718 drm_display_mode_from_videomode(&vm, dmode);
fafc79ef
LW
719 if (bus_flags)
720 drm_bus_flags_from_videomode(&vm, bus_flags);
edb37a95 721
f384d7d5
RH
722 pr_debug("%pOF: got %dx%d display mode\n",
723 np, vm.hactive, vm.vactive);
edb37a95
ST
724 drm_mode_debug_printmodeline(dmode);
725
726 return 0;
727}
728EXPORT_SYMBOL_GPL(of_get_drm_display_mode);
a38884f6
TV
729#endif /* CONFIG_OF */
730#endif /* CONFIG_VIDEOMODE_HELPERS */
edb37a95 731
f453ba04
DA
732/**
733 * drm_mode_set_name - set the name on a mode
734 * @mode: name will be set in this mode
735 *
f5aabb97
DV
736 * Set the name of @mode to a standard format which is <hdisplay>x<vdisplay>
737 * with an optional 'i' suffix for interlaced modes.
f453ba04
DA
738 */
739void drm_mode_set_name(struct drm_display_mode *mode)
740{
171fdd89
AJ
741 bool interlaced = !!(mode->flags & DRM_MODE_FLAG_INTERLACE);
742
743 snprintf(mode->name, DRM_DISPLAY_MODE_LEN, "%dx%d%s",
744 mode->hdisplay, mode->vdisplay,
745 interlaced ? "i" : "");
f453ba04
DA
746}
747EXPORT_SYMBOL(drm_mode_set_name);
748
30ecad77
DV
749/**
750 * drm_mode_hsync - get the hsync of a mode
7ac96a9c
AJ
751 * @mode: mode
752 *
f5aabb97
DV
753 * Returns:
754 * @modes's hsync rate in kHz, rounded to the nearest integer. Calculates the
755 * value first if it is not yet set.
7ac96a9c 756 */
b1f559ec 757int drm_mode_hsync(const struct drm_display_mode *mode)
7ac96a9c
AJ
758{
759 unsigned int calc_val;
760
761 if (mode->hsync)
762 return mode->hsync;
763
a2fcd5c8 764 if (mode->htotal <= 0)
7ac96a9c
AJ
765 return 0;
766
767 calc_val = (mode->clock * 1000) / mode->htotal; /* hsync in Hz */
768 calc_val += 500; /* round to 1000Hz */
769 calc_val /= 1000; /* truncate to kHz */
770
771 return calc_val;
772}
773EXPORT_SYMBOL(drm_mode_hsync);
774
f453ba04
DA
775/**
776 * drm_mode_vrefresh - get the vrefresh of a mode
777 * @mode: mode
778 *
f5aabb97
DV
779 * Returns:
780 * @modes's vrefresh rate in Hz, rounded to the nearest integer. Calculates the
781 * value first if it is not yet set.
f453ba04 782 */
b1f559ec 783int drm_mode_vrefresh(const struct drm_display_mode *mode)
f453ba04
DA
784{
785 int refresh = 0;
f453ba04
DA
786
787 if (mode->vrefresh > 0)
788 refresh = mode->vrefresh;
789 else if (mode->htotal > 0 && mode->vtotal > 0) {
2f0e9d80
VS
790 unsigned int num, den;
791
792 num = mode->clock * 1000;
793 den = mode->htotal * mode->vtotal;
f453ba04 794
f453ba04 795 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
2f0e9d80 796 num *= 2;
f453ba04 797 if (mode->flags & DRM_MODE_FLAG_DBLSCAN)
2f0e9d80 798 den *= 2;
f453ba04 799 if (mode->vscan > 1)
2f0e9d80
VS
800 den *= mode->vscan;
801
802 refresh = DIV_ROUND_CLOSEST(num, den);
f453ba04
DA
803 }
804 return refresh;
805}
806EXPORT_SYMBOL(drm_mode_vrefresh);
807
196cd5d3
DV
808/**
809 * drm_mode_get_hv_timing - Fetches hdisplay/vdisplay for given mode
810 * @mode: mode to query
811 * @hdisplay: hdisplay value to fill in
812 * @vdisplay: vdisplay value to fill in
813 *
814 * The vdisplay value will be doubled if the specified mode is a stereo mode of
815 * the appropriate layout.
816 */
817void drm_mode_get_hv_timing(const struct drm_display_mode *mode,
818 int *hdisplay, int *vdisplay)
819{
6f15f84c 820 struct drm_display_mode adjusted = *mode;
196cd5d3 821
196cd5d3
DV
822 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
823 *hdisplay = adjusted.crtc_hdisplay;
824 *vdisplay = adjusted.crtc_vdisplay;
825}
826EXPORT_SYMBOL(drm_mode_get_hv_timing);
827
f453ba04 828/**
f5aabb97 829 * drm_mode_set_crtcinfo - set CRTC modesetting timing parameters
f453ba04 830 * @p: mode
448cce25 831 * @adjust_flags: a combination of adjustment flags
f453ba04 832 *
f5aabb97 833 * Setup the CRTC modesetting timing parameters for @p, adjusting if necessary.
448cce25
DL
834 *
835 * - The CRTC_INTERLACE_HALVE_V flag can be used to halve vertical timings of
836 * interlaced modes.
837 * - The CRTC_STEREO_DOUBLE flag can be used to compute the timings for
838 * buffers containing two eyes (only adjust the timings when needed, eg. for
839 * "frame packing" or "side by side full").
ecb7e16b
GP
840 * - The CRTC_NO_DBLSCAN and CRTC_NO_VSCAN flags request that adjustment *not*
841 * be performed for doublescan and vscan > 1 modes respectively.
f453ba04
DA
842 */
843void drm_mode_set_crtcinfo(struct drm_display_mode *p, int adjust_flags)
844{
4f09c77b 845 if (!p)
f453ba04
DA
846 return;
847
bde2dcf7 848 p->crtc_clock = p->clock;
f453ba04
DA
849 p->crtc_hdisplay = p->hdisplay;
850 p->crtc_hsync_start = p->hsync_start;
851 p->crtc_hsync_end = p->hsync_end;
852 p->crtc_htotal = p->htotal;
853 p->crtc_hskew = p->hskew;
854 p->crtc_vdisplay = p->vdisplay;
855 p->crtc_vsync_start = p->vsync_start;
856 p->crtc_vsync_end = p->vsync_end;
857 p->crtc_vtotal = p->vtotal;
858
859 if (p->flags & DRM_MODE_FLAG_INTERLACE) {
860 if (adjust_flags & CRTC_INTERLACE_HALVE_V) {
861 p->crtc_vdisplay /= 2;
862 p->crtc_vsync_start /= 2;
863 p->crtc_vsync_end /= 2;
864 p->crtc_vtotal /= 2;
865 }
f453ba04
DA
866 }
867
ecb7e16b
GP
868 if (!(adjust_flags & CRTC_NO_DBLSCAN)) {
869 if (p->flags & DRM_MODE_FLAG_DBLSCAN) {
870 p->crtc_vdisplay *= 2;
871 p->crtc_vsync_start *= 2;
872 p->crtc_vsync_end *= 2;
873 p->crtc_vtotal *= 2;
874 }
f453ba04
DA
875 }
876
ecb7e16b
GP
877 if (!(adjust_flags & CRTC_NO_VSCAN)) {
878 if (p->vscan > 1) {
879 p->crtc_vdisplay *= p->vscan;
880 p->crtc_vsync_start *= p->vscan;
881 p->crtc_vsync_end *= p->vscan;
882 p->crtc_vtotal *= p->vscan;
883 }
f453ba04
DA
884 }
885
448cce25
DL
886 if (adjust_flags & CRTC_STEREO_DOUBLE) {
887 unsigned int layout = p->flags & DRM_MODE_FLAG_3D_MASK;
888
889 switch (layout) {
890 case DRM_MODE_FLAG_3D_FRAME_PACKING:
891 p->crtc_clock *= 2;
892 p->crtc_vdisplay += p->crtc_vtotal;
893 p->crtc_vsync_start += p->crtc_vtotal;
894 p->crtc_vsync_end += p->crtc_vtotal;
895 p->crtc_vtotal += p->crtc_vtotal;
896 break;
897 }
898 }
899
f453ba04
DA
900 p->crtc_vblank_start = min(p->crtc_vsync_start, p->crtc_vdisplay);
901 p->crtc_vblank_end = max(p->crtc_vsync_end, p->crtc_vtotal);
902 p->crtc_hblank_start = min(p->crtc_hsync_start, p->crtc_hdisplay);
903 p->crtc_hblank_end = max(p->crtc_hsync_end, p->crtc_htotal);
f453ba04
DA
904}
905EXPORT_SYMBOL(drm_mode_set_crtcinfo);
906
c3c50e8b
VS
907/**
908 * drm_mode_copy - copy the mode
909 * @dst: mode to overwrite
910 * @src: mode to copy
911 *
72e45e92
VS
912 * Copy an existing mode into another mode, preserving the object id and
913 * list head of the destination mode.
c3c50e8b
VS
914 */
915void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src)
916{
72e45e92 917 struct list_head head = dst->head;
c3c50e8b
VS
918
919 *dst = *src;
72e45e92 920 dst->head = head;
c3c50e8b
VS
921}
922EXPORT_SYMBOL(drm_mode_copy);
923
f453ba04
DA
924/**
925 * drm_mode_duplicate - allocate and duplicate an existing mode
3ec0db81
DV
926 * @dev: drm_device to allocate the duplicated mode for
927 * @mode: mode to duplicate
f453ba04 928 *
f453ba04
DA
929 * Just allocate a new mode, copy the existing mode into it, and return
930 * a pointer to it. Used to create new instances of established modes.
f5aabb97
DV
931 *
932 * Returns:
933 * Pointer to duplicated mode on success, NULL on error.
f453ba04
DA
934 */
935struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
b1f559ec 936 const struct drm_display_mode *mode)
f453ba04
DA
937{
938 struct drm_display_mode *nmode;
f453ba04
DA
939
940 nmode = drm_mode_create(dev);
941 if (!nmode)
942 return NULL;
943
c3c50e8b
VS
944 drm_mode_copy(nmode, mode);
945
f453ba04
DA
946 return nmode;
947}
948EXPORT_SYMBOL(drm_mode_duplicate);
949
dd7c2626
VS
950static bool drm_mode_match_timings(const struct drm_display_mode *mode1,
951 const struct drm_display_mode *mode2)
952{
953 return mode1->hdisplay == mode2->hdisplay &&
954 mode1->hsync_start == mode2->hsync_start &&
955 mode1->hsync_end == mode2->hsync_end &&
956 mode1->htotal == mode2->htotal &&
957 mode1->hskew == mode2->hskew &&
958 mode1->vdisplay == mode2->vdisplay &&
959 mode1->vsync_start == mode2->vsync_start &&
960 mode1->vsync_end == mode2->vsync_end &&
961 mode1->vtotal == mode2->vtotal &&
962 mode1->vscan == mode2->vscan;
963}
964
965static bool drm_mode_match_clock(const struct drm_display_mode *mode1,
966 const struct drm_display_mode *mode2)
967{
968 /*
969 * do clock check convert to PICOS
970 * so fb modes get matched the same
971 */
972 if (mode1->clock && mode2->clock)
973 return KHZ2PICOS(mode1->clock) == KHZ2PICOS(mode2->clock);
974 else
975 return mode1->clock == mode2->clock;
976}
977
978static bool drm_mode_match_flags(const struct drm_display_mode *mode1,
979 const struct drm_display_mode *mode2)
980{
981 return (mode1->flags & ~DRM_MODE_FLAG_3D_MASK) ==
982 (mode2->flags & ~DRM_MODE_FLAG_3D_MASK);
983}
984
985static bool drm_mode_match_3d_flags(const struct drm_display_mode *mode1,
986 const struct drm_display_mode *mode2)
987{
988 return (mode1->flags & DRM_MODE_FLAG_3D_MASK) ==
989 (mode2->flags & DRM_MODE_FLAG_3D_MASK);
990}
991
992static bool drm_mode_match_aspect_ratio(const struct drm_display_mode *mode1,
993 const struct drm_display_mode *mode2)
994{
995 return mode1->picture_aspect_ratio == mode2->picture_aspect_ratio;
996}
997
f453ba04 998/**
dd7c2626 999 * drm_mode_match - test modes for (partial) equality
f453ba04
DA
1000 * @mode1: first mode
1001 * @mode2: second mode
dd7c2626 1002 * @match_flags: which parts need to match (DRM_MODE_MATCH_*)
f453ba04 1003 *
f453ba04
DA
1004 * Check to see if @mode1 and @mode2 are equivalent.
1005 *
f5aabb97 1006 * Returns:
dd7c2626 1007 * True if the modes are (partially) equal, false otherwise.
f453ba04 1008 */
dd7c2626
VS
1009bool drm_mode_match(const struct drm_display_mode *mode1,
1010 const struct drm_display_mode *mode2,
1011 unsigned int match_flags)
f453ba04 1012{
54270952
DS
1013 if (!mode1 && !mode2)
1014 return true;
1015
1016 if (!mode1 || !mode2)
1017 return false;
1018
dd7c2626
VS
1019 if (match_flags & DRM_MODE_MATCH_TIMINGS &&
1020 !drm_mode_match_timings(mode1, mode2))
f453ba04
DA
1021 return false;
1022
dd7c2626
VS
1023 if (match_flags & DRM_MODE_MATCH_CLOCK &&
1024 !drm_mode_match_clock(mode1, mode2))
1025 return false;
1026
1027 if (match_flags & DRM_MODE_MATCH_FLAGS &&
1028 !drm_mode_match_flags(mode1, mode2))
1029 return false;
1030
1031 if (match_flags & DRM_MODE_MATCH_3D_FLAGS &&
1032 !drm_mode_match_3d_flags(mode1, mode2))
1033 return false;
1034
1035 if (match_flags & DRM_MODE_MATCH_ASPECT_RATIO &&
1036 !drm_mode_match_aspect_ratio(mode1, mode2))
1037 return false;
1038
1039 return true;
1040}
1041EXPORT_SYMBOL(drm_mode_match);
1042
1043/**
1044 * drm_mode_equal - test modes for equality
1045 * @mode1: first mode
1046 * @mode2: second mode
1047 *
1048 * Check to see if @mode1 and @mode2 are equivalent.
1049 *
1050 * Returns:
1051 * True if the modes are equal, false otherwise.
1052 */
1053bool drm_mode_equal(const struct drm_display_mode *mode1,
1054 const struct drm_display_mode *mode2)
1055{
1056 return drm_mode_match(mode1, mode2,
1057 DRM_MODE_MATCH_TIMINGS |
1058 DRM_MODE_MATCH_CLOCK |
1059 DRM_MODE_MATCH_FLAGS |
222ec161
SS
1060 DRM_MODE_MATCH_3D_FLAGS|
1061 DRM_MODE_MATCH_ASPECT_RATIO);
4c6bcf44
VS
1062}
1063EXPORT_SYMBOL(drm_mode_equal);
1064
1065/**
1066 * drm_mode_equal_no_clocks - test modes for equality
1067 * @mode1: first mode
1068 * @mode2: second mode
1069 *
1070 * Check to see if @mode1 and @mode2 are equivalent, but
1071 * don't check the pixel clocks.
1072 *
1073 * Returns:
1074 * True if the modes are equal, false otherwise.
1075 */
dd7c2626
VS
1076bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1,
1077 const struct drm_display_mode *mode2)
4c6bcf44 1078{
dd7c2626
VS
1079 return drm_mode_match(mode1, mode2,
1080 DRM_MODE_MATCH_TIMINGS |
1081 DRM_MODE_MATCH_FLAGS |
1082 DRM_MODE_MATCH_3D_FLAGS);
8cc3f23c 1083}
4c6bcf44 1084EXPORT_SYMBOL(drm_mode_equal_no_clocks);
8cc3f23c
VS
1085
1086/**
f2ecf2e3 1087 * drm_mode_equal_no_clocks_no_stereo - test modes for equality
8cc3f23c
VS
1088 * @mode1: first mode
1089 * @mode2: second mode
1090 *
8cc3f23c 1091 * Check to see if @mode1 and @mode2 are equivalent, but
f2ecf2e3 1092 * don't check the pixel clocks nor the stereo layout.
8cc3f23c 1093 *
f5aabb97 1094 * Returns:
8cc3f23c
VS
1095 * True if the modes are equal, false otherwise.
1096 */
f2ecf2e3
DL
1097bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
1098 const struct drm_display_mode *mode2)
8cc3f23c 1099{
dd7c2626
VS
1100 return drm_mode_match(mode1, mode2,
1101 DRM_MODE_MATCH_TIMINGS |
1102 DRM_MODE_MATCH_FLAGS);
f453ba04 1103}
f2ecf2e3 1104EXPORT_SYMBOL(drm_mode_equal_no_clocks_no_stereo);
f453ba04 1105
75a655e0 1106static enum drm_mode_status
abc0b144
VS
1107drm_mode_validate_basic(const struct drm_display_mode *mode)
1108{
c6ed6dad
VS
1109 if (mode->type & ~DRM_MODE_TYPE_ALL)
1110 return MODE_BAD;
1111
1112 if (mode->flags & ~DRM_MODE_FLAG_ALL)
1113 return MODE_BAD;
1114
064a3e6e
VS
1115 if ((mode->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1116 return MODE_BAD;
1117
abc0b144
VS
1118 if (mode->clock == 0)
1119 return MODE_CLOCK_LOW;
1120
1121 if (mode->hdisplay == 0 ||
1122 mode->hsync_start < mode->hdisplay ||
1123 mode->hsync_end < mode->hsync_start ||
1124 mode->htotal < mode->hsync_end)
1125 return MODE_H_ILLEGAL;
1126
1127 if (mode->vdisplay == 0 ||
1128 mode->vsync_start < mode->vdisplay ||
1129 mode->vsync_end < mode->vsync_start ||
1130 mode->vtotal < mode->vsync_end)
1131 return MODE_V_ILLEGAL;
1132
1133 return MODE_OK;
1134}
75a655e0
VS
1135
1136/**
1137 * drm_mode_validate_driver - make sure the mode is somewhat sane
1138 * @dev: drm device
1139 * @mode: mode to check
1140 *
1141 * First do basic validation on the mode, and then allow the driver
1142 * to check for device/driver specific limitations via the optional
1143 * &drm_mode_config_helper_funcs.mode_valid hook.
1144 *
1145 * Returns:
1146 * The mode status
1147 */
1148enum drm_mode_status
1149drm_mode_validate_driver(struct drm_device *dev,
1150 const struct drm_display_mode *mode)
1151{
1152 enum drm_mode_status status;
1153
1154 status = drm_mode_validate_basic(mode);
1155 if (status != MODE_OK)
1156 return status;
1157
1158 if (dev->mode_config.funcs->mode_valid)
1159 return dev->mode_config.funcs->mode_valid(dev, mode);
1160 else
1161 return MODE_OK;
1162}
1163EXPORT_SYMBOL(drm_mode_validate_driver);
abc0b144 1164
f453ba04
DA
1165/**
1166 * drm_mode_validate_size - make sure modes adhere to size constraints
05acaec3 1167 * @mode: mode to check
f453ba04
DA
1168 * @maxX: maximum width
1169 * @maxY: maximum height
f453ba04 1170 *
f5aabb97
DV
1171 * This function is a helper which can be used to validate modes against size
1172 * limitations of the DRM device/connector. If a mode is too big its status
32197aab 1173 * member is updated with the appropriate validation failure code. The list
f5aabb97 1174 * itself is not changed.
05acaec3
VS
1175 *
1176 * Returns:
1177 * The mode status
f453ba04 1178 */
05acaec3
VS
1179enum drm_mode_status
1180drm_mode_validate_size(const struct drm_display_mode *mode,
1181 int maxX, int maxY)
f453ba04 1182{
05acaec3
VS
1183 if (maxX > 0 && mode->hdisplay > maxX)
1184 return MODE_VIRTUAL_X;
f453ba04 1185
05acaec3
VS
1186 if (maxY > 0 && mode->vdisplay > maxY)
1187 return MODE_VIRTUAL_Y;
f453ba04 1188
05acaec3 1189 return MODE_OK;
f453ba04
DA
1190}
1191EXPORT_SYMBOL(drm_mode_validate_size);
1192
d8523153
SS
1193/**
1194 * drm_mode_validate_ycbcr420 - add 'ycbcr420-only' modes only when allowed
1195 * @mode: mode to check
1196 * @connector: drm connector under action
1197 *
1198 * This function is a helper which can be used to filter out any YCBCR420
1199 * only mode, when the source doesn't support it.
1200 *
1201 * Returns:
1202 * The mode status
1203 */
1204enum drm_mode_status
1205drm_mode_validate_ycbcr420(const struct drm_display_mode *mode,
1206 struct drm_connector *connector)
1207{
1208 u8 vic = drm_match_cea_mode(mode);
1209 enum drm_mode_status status = MODE_OK;
1210 struct drm_hdmi_info *hdmi = &connector->display_info.hdmi;
1211
1212 if (test_bit(vic, hdmi->y420_vdb_modes)) {
1213 if (!connector->ycbcr_420_allowed)
1214 status = MODE_NO_420;
1215 }
1216
1217 return status;
1218}
1219EXPORT_SYMBOL(drm_mode_validate_ycbcr420);
1220
e4bf44b3
VS
1221#define MODE_STATUS(status) [MODE_ ## status + 3] = #status
1222
1223static const char * const drm_mode_status_names[] = {
1224 MODE_STATUS(OK),
1225 MODE_STATUS(HSYNC),
1226 MODE_STATUS(VSYNC),
1227 MODE_STATUS(H_ILLEGAL),
1228 MODE_STATUS(V_ILLEGAL),
1229 MODE_STATUS(BAD_WIDTH),
1230 MODE_STATUS(NOMODE),
1231 MODE_STATUS(NO_INTERLACE),
1232 MODE_STATUS(NO_DBLESCAN),
1233 MODE_STATUS(NO_VSCAN),
1234 MODE_STATUS(MEM),
1235 MODE_STATUS(VIRTUAL_X),
1236 MODE_STATUS(VIRTUAL_Y),
1237 MODE_STATUS(MEM_VIRT),
1238 MODE_STATUS(NOCLOCK),
1239 MODE_STATUS(CLOCK_HIGH),
1240 MODE_STATUS(CLOCK_LOW),
1241 MODE_STATUS(CLOCK_RANGE),
1242 MODE_STATUS(BAD_HVALUE),
1243 MODE_STATUS(BAD_VVALUE),
1244 MODE_STATUS(BAD_VSCAN),
1245 MODE_STATUS(HSYNC_NARROW),
1246 MODE_STATUS(HSYNC_WIDE),
1247 MODE_STATUS(HBLANK_NARROW),
1248 MODE_STATUS(HBLANK_WIDE),
1249 MODE_STATUS(VSYNC_NARROW),
1250 MODE_STATUS(VSYNC_WIDE),
1251 MODE_STATUS(VBLANK_NARROW),
1252 MODE_STATUS(VBLANK_WIDE),
1253 MODE_STATUS(PANEL),
1254 MODE_STATUS(INTERLACE_WIDTH),
1255 MODE_STATUS(ONE_WIDTH),
1256 MODE_STATUS(ONE_HEIGHT),
1257 MODE_STATUS(ONE_SIZE),
1258 MODE_STATUS(NO_REDUCED),
1259 MODE_STATUS(NO_STEREO),
d8523153 1260 MODE_STATUS(NO_420),
5ba89406 1261 MODE_STATUS(STALE),
e4bf44b3
VS
1262 MODE_STATUS(BAD),
1263 MODE_STATUS(ERROR),
1264};
1265
1266#undef MODE_STATUS
1267
6ab0edf4 1268const char *drm_get_mode_status_name(enum drm_mode_status status)
e4bf44b3
VS
1269{
1270 int index = status + 3;
1271
1272 if (WARN_ON(index < 0 || index >= ARRAY_SIZE(drm_mode_status_names)))
1273 return "";
1274
1275 return drm_mode_status_names[index];
1276}
1277
f453ba04
DA
1278/**
1279 * drm_mode_prune_invalid - remove invalid modes from mode list
1280 * @dev: DRM device
1281 * @mode_list: list of modes to check
1282 * @verbose: be verbose about it
1283 *
f5aabb97 1284 * This helper function can be used to prune a display mode list after
1e55a53a 1285 * validation has been completed. All modes whose status is not MODE_OK will be
f5aabb97
DV
1286 * removed from the list, and if @verbose the status code and mode name is also
1287 * printed to dmesg.
f453ba04
DA
1288 */
1289void drm_mode_prune_invalid(struct drm_device *dev,
1290 struct list_head *mode_list, bool verbose)
1291{
1292 struct drm_display_mode *mode, *t;
1293
1294 list_for_each_entry_safe(mode, t, mode_list, head) {
1295 if (mode->status != MODE_OK) {
1296 list_del(&mode->head);
1297 if (verbose) {
1298 drm_mode_debug_printmodeline(mode);
e4bf44b3
VS
1299 DRM_DEBUG_KMS("Not using %s mode: %s\n",
1300 mode->name,
1301 drm_get_mode_status_name(mode->status));
f453ba04
DA
1302 }
1303 drm_mode_destroy(dev, mode);
1304 }
1305 }
1306}
1307EXPORT_SYMBOL(drm_mode_prune_invalid);
1308
1309/**
1310 * drm_mode_compare - compare modes for favorability
2c761270 1311 * @priv: unused
f453ba04
DA
1312 * @lh_a: list_head for first mode
1313 * @lh_b: list_head for second mode
1314 *
f453ba04
DA
1315 * Compare two modes, given by @lh_a and @lh_b, returning a value indicating
1316 * which is better.
1317 *
f5aabb97 1318 * Returns:
f453ba04
DA
1319 * Negative if @lh_a is better than @lh_b, zero if they're equivalent, or
1320 * positive if @lh_b is better than @lh_a.
1321 */
2c761270 1322static int drm_mode_compare(void *priv, struct list_head *lh_a, struct list_head *lh_b)
f453ba04
DA
1323{
1324 struct drm_display_mode *a = list_entry(lh_a, struct drm_display_mode, head);
1325 struct drm_display_mode *b = list_entry(lh_b, struct drm_display_mode, head);
1326 int diff;
1327
1328 diff = ((b->type & DRM_MODE_TYPE_PREFERRED) != 0) -
1329 ((a->type & DRM_MODE_TYPE_PREFERRED) != 0);
1330 if (diff)
1331 return diff;
1332 diff = b->hdisplay * b->vdisplay - a->hdisplay * a->vdisplay;
1333 if (diff)
1334 return diff;
9bc3cd56
VS
1335
1336 diff = b->vrefresh - a->vrefresh;
1337 if (diff)
1338 return diff;
1339
f453ba04
DA
1340 diff = b->clock - a->clock;
1341 return diff;
1342}
1343
f453ba04
DA
1344/**
1345 * drm_mode_sort - sort mode list
f5aabb97 1346 * @mode_list: list of drm_display_mode structures to sort
f453ba04 1347 *
f5aabb97 1348 * Sort @mode_list by favorability, moving good modes to the head of the list.
f453ba04
DA
1349 */
1350void drm_mode_sort(struct list_head *mode_list)
1351{
2c761270 1352 list_sort(NULL, mode_list, drm_mode_compare);
f453ba04
DA
1353}
1354EXPORT_SYMBOL(drm_mode_sort);
1355
1356/**
97e14fbe 1357 * drm_connector_list_update - update the mode list for the connector
f453ba04
DA
1358 * @connector: the connector to update
1359 *
f453ba04
DA
1360 * This moves the modes from the @connector probed_modes list
1361 * to the actual mode list. It compares the probed mode against the current
f5aabb97
DV
1362 * list and only adds different/new modes.
1363 *
1364 * This is just a helper functions doesn't validate any modes itself and also
1365 * doesn't prune any invalid modes. Callers need to do that themselves.
f453ba04 1366 */
97e14fbe 1367void drm_connector_list_update(struct drm_connector *connector)
f453ba04 1368{
f453ba04 1369 struct drm_display_mode *pmode, *pt;
f453ba04 1370
63951385
DV
1371 WARN_ON(!mutex_is_locked(&connector->dev->mode_config.mutex));
1372
2f8c19e7
VS
1373 list_for_each_entry_safe(pmode, pt, &connector->probed_modes, head) {
1374 struct drm_display_mode *mode;
1375 bool found_it = false;
1376
f453ba04
DA
1377 /* go through current modes checking for the new probed mode */
1378 list_for_each_entry(mode, &connector->modes, head) {
2f8c19e7
VS
1379 if (!drm_mode_equal(pmode, mode))
1380 continue;
1381
1382 found_it = true;
fc245f88
VS
1383
1384 /*
1385 * If the old matching mode is stale (ie. left over
1386 * from a previous probe) just replace it outright.
1387 * Otherwise just merge the type bits between all
1388 * equal probed modes.
1389 *
1390 * If two probed modes are considered equal, pick the
1391 * actual timings from the one that's marked as
1392 * preferred (in case the match isn't 100%). If
1393 * multiple or zero preferred modes are present, favor
1394 * the mode added to the probed_modes list first.
1395 */
1396 if (mode->status == MODE_STALE) {
1397 drm_mode_copy(mode, pmode);
1398 } else if ((mode->type & DRM_MODE_TYPE_PREFERRED) == 0 &&
1399 (pmode->type & DRM_MODE_TYPE_PREFERRED) != 0) {
6af3e656 1400 pmode->type |= mode->type;
fc245f88
VS
1401 drm_mode_copy(mode, pmode);
1402 } else {
6af3e656 1403 mode->type |= pmode->type;
fc245f88
VS
1404 }
1405
2f8c19e7
VS
1406 list_del(&pmode->head);
1407 drm_mode_destroy(connector->dev, pmode);
1408 break;
f453ba04
DA
1409 }
1410
1411 if (!found_it) {
1412 list_move_tail(&pmode->head, &connector->modes);
1413 }
1414 }
1415}
97e14fbe 1416EXPORT_SYMBOL(drm_connector_list_update);
1794d257 1417
e08ab74b
MR
1418static int drm_mode_parse_cmdline_bpp(const char *str, char **end_ptr,
1419 struct drm_cmdline_mode *mode)
1420{
1421 unsigned int bpp;
1422
1423 if (str[0] != '-')
1424 return -EINVAL;
1425
1426 str++;
1427 bpp = simple_strtol(str, end_ptr, 10);
1428 if (*end_ptr == str)
1429 return -EINVAL;
1430
1431 mode->bpp = bpp;
1432 mode->bpp_specified = true;
1433
1434 return 0;
1435}
1436
1437static int drm_mode_parse_cmdline_refresh(const char *str, char **end_ptr,
1438 struct drm_cmdline_mode *mode)
1439{
1440 unsigned int refresh;
1441
1442 if (str[0] != '@')
1443 return -EINVAL;
1444
1445 str++;
1446 refresh = simple_strtol(str, end_ptr, 10);
1447 if (*end_ptr == str)
1448 return -EINVAL;
1449
1450 mode->refresh = refresh;
1451 mode->refresh_specified = true;
1452
1453 return 0;
1454}
1455
1456static int drm_mode_parse_cmdline_extra(const char *str, int length,
325d0ab3 1457 bool freestanding,
c0898fca 1458 const struct drm_connector *connector,
e08ab74b
MR
1459 struct drm_cmdline_mode *mode)
1460{
1461 int i;
1462
1463 for (i = 0; i < length; i++) {
1464 switch (str[i]) {
1465 case 'i':
325d0ab3
MR
1466 if (freestanding)
1467 return -EINVAL;
1468
e08ab74b
MR
1469 mode->interlace = true;
1470 break;
1471 case 'm':
325d0ab3
MR
1472 if (freestanding)
1473 return -EINVAL;
1474
e08ab74b
MR
1475 mode->margins = true;
1476 break;
1477 case 'D':
1478 if (mode->force != DRM_FORCE_UNSPECIFIED)
1479 return -EINVAL;
1480
1481 if ((connector->connector_type != DRM_MODE_CONNECTOR_DVII) &&
1482 (connector->connector_type != DRM_MODE_CONNECTOR_HDMIB))
1483 mode->force = DRM_FORCE_ON;
1484 else
1485 mode->force = DRM_FORCE_ON_DIGITAL;
1486 break;
1487 case 'd':
1488 if (mode->force != DRM_FORCE_UNSPECIFIED)
1489 return -EINVAL;
1490
1491 mode->force = DRM_FORCE_OFF;
1492 break;
1493 case 'e':
1494 if (mode->force != DRM_FORCE_UNSPECIFIED)
1495 return -EINVAL;
1496
1497 mode->force = DRM_FORCE_ON;
1498 break;
1499 default:
1500 return -EINVAL;
1501 }
1502 }
1503
1504 return 0;
1505}
1506
1507static int drm_mode_parse_cmdline_res_mode(const char *str, unsigned int length,
1508 bool extras,
c0898fca 1509 const struct drm_connector *connector,
e08ab74b
MR
1510 struct drm_cmdline_mode *mode)
1511{
1512 const char *str_start = str;
1513 bool rb = false, cvt = false;
1514 int xres = 0, yres = 0;
1515 int remaining, i;
1516 char *end_ptr;
1517
1518 xres = simple_strtol(str, &end_ptr, 10);
1519 if (end_ptr == str)
1520 return -EINVAL;
1521
1522 if (end_ptr[0] != 'x')
1523 return -EINVAL;
1524 end_ptr++;
1525
1526 str = end_ptr;
1527 yres = simple_strtol(str, &end_ptr, 10);
1528 if (end_ptr == str)
1529 return -EINVAL;
1530
1531 remaining = length - (end_ptr - str_start);
1532 if (remaining < 0)
1533 return -EINVAL;
1534
1535 for (i = 0; i < remaining; i++) {
1536 switch (end_ptr[i]) {
1537 case 'M':
1538 cvt = true;
1539 break;
1540 case 'R':
1541 rb = true;
1542 break;
1543 default:
1544 /*
1545 * Try to pass that to our extras parsing
1546 * function to handle the case where the
1547 * extras are directly after the resolution
1548 */
1549 if (extras) {
1550 int ret = drm_mode_parse_cmdline_extra(end_ptr + i,
1551 1,
325d0ab3 1552 false,
e08ab74b
MR
1553 connector,
1554 mode);
1555 if (ret)
1556 return ret;
1557 } else {
1558 return -EINVAL;
1559 }
1560 }
1561 }
1562
1563 mode->xres = xres;
1564 mode->yres = yres;
1565 mode->cvt = cvt;
1566 mode->rb = rb;
1567
1568 return 0;
1569}
1570
1bf4e092 1571static int drm_mode_parse_cmdline_options(char *str, size_t len,
c0898fca 1572 const struct drm_connector *connector,
1bf4e092
MR
1573 struct drm_cmdline_mode *mode)
1574{
1575 unsigned int rotation = 0;
1576 char *sep = str;
1577
1578 while ((sep = strchr(sep, ','))) {
1579 char *delim, *option;
1580
1581 option = sep + 1;
1582 delim = strchr(option, '=');
1583 if (!delim) {
1584 delim = strchr(option, ',');
1585
1586 if (!delim)
1587 delim = str + len;
1588 }
1589
1590 if (!strncmp(option, "rotate", delim - option)) {
1591 const char *value = delim + 1;
1592 unsigned int deg;
1593
1594 deg = simple_strtol(value, &sep, 10);
1595
1596 /* Make sure we have parsed something */
1597 if (sep == value)
1598 return -EINVAL;
1599
1600 switch (deg) {
1601 case 0:
1602 rotation |= DRM_MODE_ROTATE_0;
1603 break;
1604
1605 case 90:
1606 rotation |= DRM_MODE_ROTATE_90;
1607 break;
1608
1609 case 180:
1610 rotation |= DRM_MODE_ROTATE_180;
1611 break;
1612
1613 case 270:
1614 rotation |= DRM_MODE_ROTATE_270;
1615 break;
1616
1617 default:
1618 return -EINVAL;
1619 }
1620 } else if (!strncmp(option, "reflect_x", delim - option)) {
1621 rotation |= DRM_MODE_REFLECT_X;
1622 sep = delim;
1623 } else if (!strncmp(option, "reflect_y", delim - option)) {
1624 rotation |= DRM_MODE_REFLECT_Y;
1625 sep = delim;
3d46a300
MR
1626 } else if (!strncmp(option, "margin_right", delim - option)) {
1627 const char *value = delim + 1;
1628 unsigned int margin;
1629
1630 margin = simple_strtol(value, &sep, 10);
1631
1632 /* Make sure we have parsed something */
1633 if (sep == value)
1634 return -EINVAL;
1635
1636 mode->tv_margins.right = margin;
1637 } else if (!strncmp(option, "margin_left", delim - option)) {
1638 const char *value = delim + 1;
1639 unsigned int margin;
1640
1641 margin = simple_strtol(value, &sep, 10);
1642
1643 /* Make sure we have parsed something */
1644 if (sep == value)
1645 return -EINVAL;
1646
1647 mode->tv_margins.left = margin;
1648 } else if (!strncmp(option, "margin_top", delim - option)) {
1649 const char *value = delim + 1;
1650 unsigned int margin;
1651
1652 margin = simple_strtol(value, &sep, 10);
1653
1654 /* Make sure we have parsed something */
1655 if (sep == value)
1656 return -EINVAL;
1657
1658 mode->tv_margins.top = margin;
1659 } else if (!strncmp(option, "margin_bottom", delim - option)) {
1660 const char *value = delim + 1;
1661 unsigned int margin;
1662
1663 margin = simple_strtol(value, &sep, 10);
1664
1665 /* Make sure we have parsed something */
1666 if (sep == value)
1667 return -EINVAL;
1668
1669 mode->tv_margins.bottom = margin;
1bf4e092
MR
1670 } else {
1671 return -EINVAL;
1672 }
1673 }
1674
1675 mode->rotation_reflection = rotation;
1676
1677 return 0;
1678}
1679
37641379
MR
1680static const char *drm_named_modes_whitelist[] = {
1681 "NTSC",
1682 "PAL",
1683};
1684
1685static bool drm_named_mode_is_in_whitelist(const char *mode, unsigned int size)
1686{
1687 int i;
1688
1689 for (i = 0; i < ARRAY_SIZE(drm_named_modes_whitelist); i++)
1690 if (!strncmp(mode, drm_named_modes_whitelist[i], size))
1691 return true;
1692
1693 return false;
1694}
1695
1794d257 1696/**
f5aabb97
DV
1697 * drm_mode_parse_command_line_for_connector - parse command line modeline for connector
1698 * @mode_option: optional per connector mode option
1699 * @connector: connector to parse modeline for
1700 * @mode: preallocated drm_cmdline_mode structure to fill out
1701 *
1702 * This parses @mode_option command line modeline for modes and options to
1703 * configure the connector. If @mode_option is NULL the default command line
1704 * modeline in fb_mode_option will be parsed instead.
1794d257 1705 *
f5aabb97 1706 * This uses the same parameters as the fb modedb.c, except for an extra
dbd124f0 1707 * force-enable, force-enable-digital and force-disable bit at the end::
1794d257 1708 *
dbd124f0 1709 * <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m][eDd]
1794d257 1710 *
1bf4e092
MR
1711 * Additionals options can be provided following the mode, using a comma to
1712 * separate each option. Valid options can be found in
bff9e34c 1713 * Documentation/fb/modedb.rst.
1bf4e092 1714 *
f5aabb97 1715 * The intermediate drm_cmdline_mode structure is required to store additional
2a97acd6 1716 * options from the command line modline like the force-enable/disable flag.
f5aabb97
DV
1717 *
1718 * Returns:
1719 * True if a valid modeline has been parsed, false otherwise.
1794d257
CW
1720 */
1721bool drm_mode_parse_command_line_for_connector(const char *mode_option,
c0898fca 1722 const struct drm_connector *connector,
1794d257
CW
1723 struct drm_cmdline_mode *mode)
1724{
1725 const char *name;
3aeeb13d 1726 bool named_mode = false, parse_extras = false;
1bf4e092 1727 unsigned int bpp_off = 0, refresh_off = 0, options_off = 0;
e08ab74b
MR
1728 unsigned int mode_end = 0;
1729 char *bpp_ptr = NULL, *refresh_ptr = NULL, *extra_ptr = NULL;
1bf4e092 1730 char *options_ptr = NULL;
e08ab74b
MR
1731 char *bpp_end_ptr = NULL, *refresh_end_ptr = NULL;
1732 int ret;
1794d257 1733
cb3c438e 1734#ifdef CONFIG_FB
1794d257
CW
1735 if (!mode_option)
1736 mode_option = fb_mode_option;
cb3c438e 1737#endif
1794d257
CW
1738
1739 if (!mode_option) {
1740 mode->specified = false;
1741 return false;
1742 }
1743
1744 name = mode_option;
04fee895 1745
3aeeb13d
MR
1746 /*
1747 * This is a bit convoluted. To differentiate between the
1748 * named modes and poorly formatted resolutions, we need a
1749 * bunch of things:
1750 * - We need to make sure that the first character (which
1751 * would be our resolution in X) is a digit.
728a257f
MR
1752 * - If not, then it's either a named mode or a force on/off.
1753 * To distinguish between the two, we need to run the
1754 * extra parsing function, and if not, then we consider it
1755 * a named mode.
3aeeb13d
MR
1756 *
1757 * If this isn't enough, we should add more heuristics here,
1758 * and matching unit-tests.
1759 */
728a257f
MR
1760 if (!isdigit(name[0]) && name[0] != 'x') {
1761 unsigned int namelen = strlen(name);
1762
1763 /*
1764 * Only the force on/off options can be in that case,
1765 * and they all take a single character.
1766 */
1767 if (namelen == 1) {
1768 ret = drm_mode_parse_cmdline_extra(name, namelen, true,
1769 connector, mode);
1770 if (!ret)
1771 return true;
1772 }
1773
3aeeb13d 1774 named_mode = true;
728a257f 1775 }
04fee895 1776
e08ab74b
MR
1777 /* Try to locate the bpp and refresh specifiers, if any */
1778 bpp_ptr = strchr(name, '-');
1779 if (bpp_ptr) {
1780 bpp_off = bpp_ptr - name;
1781 mode->bpp_specified = true;
1782 }
04fee895 1783
e08ab74b
MR
1784 refresh_ptr = strchr(name, '@');
1785 if (refresh_ptr) {
3aeeb13d
MR
1786 if (named_mode)
1787 return false;
1788
e08ab74b
MR
1789 refresh_off = refresh_ptr - name;
1790 mode->refresh_specified = true;
1794d257 1791 }
04fee895 1792
1bf4e092
MR
1793 /* Locate the start of named options */
1794 options_ptr = strchr(name, ',');
1795 if (options_ptr)
1796 options_off = options_ptr - name;
1797
e08ab74b 1798 /* Locate the end of the name / resolution, and parse it */
1bf4e092 1799 if (bpp_ptr) {
e08ab74b
MR
1800 mode_end = bpp_off;
1801 } else if (refresh_ptr) {
1802 mode_end = refresh_off;
1bf4e092
MR
1803 } else if (options_ptr) {
1804 mode_end = options_off;
e08ab74b
MR
1805 } else {
1806 mode_end = strlen(name);
1807 parse_extras = true;
1794d257 1808 }
e08ab74b 1809
3aeeb13d 1810 if (named_mode) {
9b562437
CY
1811 if (mode_end + 1 > DRM_DISPLAY_MODE_LEN)
1812 return false;
37641379
MR
1813
1814 if (!drm_named_mode_is_in_whitelist(name, mode_end))
1815 return false;
1816
9b562437 1817 strscpy(mode->name, name, mode_end + 1);
3aeeb13d
MR
1818 } else {
1819 ret = drm_mode_parse_cmdline_res_mode(name, mode_end,
1820 parse_extras,
1821 connector,
1822 mode);
1823 if (ret)
1824 return false;
1825 }
e08ab74b 1826 mode->specified = true;
04fee895 1827
e08ab74b
MR
1828 if (bpp_ptr) {
1829 ret = drm_mode_parse_cmdline_bpp(bpp_ptr, &bpp_end_ptr, mode);
1830 if (ret)
1831 return false;
1794d257
CW
1832 }
1833
e08ab74b
MR
1834 if (refresh_ptr) {
1835 ret = drm_mode_parse_cmdline_refresh(refresh_ptr,
1836 &refresh_end_ptr, mode);
1837 if (ret)
1838 return false;
1794d257
CW
1839 }
1840
e08ab74b
MR
1841 /*
1842 * Locate the end of the bpp / refresh, and parse the extras
1843 * if relevant
1844 */
1845 if (bpp_ptr && refresh_ptr)
1846 extra_ptr = max(bpp_end_ptr, refresh_end_ptr);
1847 else if (bpp_ptr)
1848 extra_ptr = bpp_end_ptr;
1849 else if (refresh_ptr)
1850 extra_ptr = refresh_end_ptr;
1851
1bf4e092
MR
1852 if (extra_ptr &&
1853 extra_ptr != options_ptr) {
1854 int len = strlen(name) - (extra_ptr - name);
e08ab74b 1855
325d0ab3 1856 ret = drm_mode_parse_cmdline_extra(extra_ptr, len, false,
1bf4e092
MR
1857 connector, mode);
1858 if (ret)
1859 return false;
1860 }
3aeeb13d 1861
1bf4e092
MR
1862 if (options_ptr) {
1863 int len = strlen(name) - (options_ptr - name);
1864
1865 ret = drm_mode_parse_cmdline_options(options_ptr, len,
1866 connector, mode);
1867 if (ret)
1868 return false;
1794d257 1869 }
1794d257
CW
1870
1871 return true;
1872}
1873EXPORT_SYMBOL(drm_mode_parse_command_line_for_connector);
1874
f5aabb97
DV
1875/**
1876 * drm_mode_create_from_cmdline_mode - convert a command line modeline into a DRM display mode
1877 * @dev: DRM device to create the new mode for
1878 * @cmd: input command line modeline
1879 *
1880 * Returns:
1881 * Pointer to converted mode on success, NULL on error.
1882 */
1794d257
CW
1883struct drm_display_mode *
1884drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1885 struct drm_cmdline_mode *cmd)
1886{
1887 struct drm_display_mode *mode;
1888
1889 if (cmd->cvt)
1890 mode = drm_cvt_mode(dev,
1891 cmd->xres, cmd->yres,
1892 cmd->refresh_specified ? cmd->refresh : 60,
1893 cmd->rb, cmd->interlace,
1894 cmd->margins);
1895 else
1896 mode = drm_gtf_mode(dev,
1897 cmd->xres, cmd->yres,
1898 cmd->refresh_specified ? cmd->refresh : 60,
1899 cmd->interlace,
1900 cmd->margins);
1901 if (!mode)
1902 return NULL;
1903
eaf99c74 1904 mode->type |= DRM_MODE_TYPE_USERDEF;
fdf35a6b 1905 /* fix up 1368x768: GFT/CVT can't express 1366 width due to alignment */
969218fe
TI
1906 if (cmd->xres == 1366)
1907 drm_mode_fixup_1366x768(mode);
1794d257
CW
1908 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
1909 return mode;
1910}
1911EXPORT_SYMBOL(drm_mode_create_from_cmdline_mode);
934a8a89
DS
1912
1913/**
1914 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1915 * @out: drm_mode_modeinfo struct to return to the user
1916 * @in: drm_display_mode to use
1917 *
1918 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1919 * the user.
1920 */
1921void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
1922 const struct drm_display_mode *in)
1923{
1924 WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1925 in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1926 in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1927 in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1928 in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1929 "timing values too large for mode info\n");
1930
1931 out->clock = in->clock;
1932 out->hdisplay = in->hdisplay;
1933 out->hsync_start = in->hsync_start;
1934 out->hsync_end = in->hsync_end;
1935 out->htotal = in->htotal;
1936 out->hskew = in->hskew;
1937 out->vdisplay = in->vdisplay;
1938 out->vsync_start = in->vsync_start;
1939 out->vsync_end = in->vsync_end;
1940 out->vtotal = in->vtotal;
1941 out->vscan = in->vscan;
1942 out->vrefresh = in->vrefresh;
1943 out->flags = in->flags;
1944 out->type = in->type;
222ec161
SS
1945
1946 switch (in->picture_aspect_ratio) {
1947 case HDMI_PICTURE_ASPECT_4_3:
1948 out->flags |= DRM_MODE_FLAG_PIC_AR_4_3;
1949 break;
1950 case HDMI_PICTURE_ASPECT_16_9:
1951 out->flags |= DRM_MODE_FLAG_PIC_AR_16_9;
1952 break;
900aa8ad
SS
1953 case HDMI_PICTURE_ASPECT_64_27:
1954 out->flags |= DRM_MODE_FLAG_PIC_AR_64_27;
1955 break;
1956 case HDMI_PICTURE_ASPECT_256_135:
1957 out->flags |= DRM_MODE_FLAG_PIC_AR_256_135;
1958 break;
222ec161
SS
1959 case HDMI_PICTURE_ASPECT_RESERVED:
1960 default:
1961 out->flags |= DRM_MODE_FLAG_PIC_AR_NONE;
1962 break;
1963 }
1964
934a8a89
DS
1965 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1966 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1967}
1968
1969/**
1970 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
75a655e0 1971 * @dev: drm device
934a8a89
DS
1972 * @out: drm_display_mode to return to the user
1973 * @in: drm_mode_modeinfo to use
1974 *
1975 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1976 * the caller.
1977 *
1978 * Returns:
1979 * Zero on success, negative errno on failure.
1980 */
75a655e0
VS
1981int drm_mode_convert_umode(struct drm_device *dev,
1982 struct drm_display_mode *out,
934a8a89
DS
1983 const struct drm_mode_modeinfo *in)
1984{
df550548
VS
1985 if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1986 return -ERANGE;
934a8a89 1987
934a8a89
DS
1988 out->clock = in->clock;
1989 out->hdisplay = in->hdisplay;
1990 out->hsync_start = in->hsync_start;
1991 out->hsync_end = in->hsync_end;
1992 out->htotal = in->htotal;
1993 out->hskew = in->hskew;
1994 out->vdisplay = in->vdisplay;
1995 out->vsync_start = in->vsync_start;
1996 out->vsync_end = in->vsync_end;
1997 out->vtotal = in->vtotal;
1998 out->vscan = in->vscan;
1999 out->vrefresh = in->vrefresh;
2000 out->flags = in->flags;
a01c4773
VS
2001 /*
2002 * Old xf86-video-vmware (possibly others too) used to
2003 * leave 'type' unititialized. Just ignore any bits we
2004 * don't like. It's a just hint after all, and more
2005 * useful for the kernel->userspace direction anyway.
2006 */
2007 out->type = in->type & DRM_MODE_TYPE_ALL;
934a8a89
DS
2008 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
2009 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
2010
222ec161
SS
2011 /* Clearing picture aspect ratio bits from out flags,
2012 * as the aspect-ratio information is not stored in
2013 * flags for kernel-mode, but in picture_aspect_ratio.
2014 */
2015 out->flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2016
2017 switch (in->flags & DRM_MODE_FLAG_PIC_AR_MASK) {
2018 case DRM_MODE_FLAG_PIC_AR_4_3:
2019 out->picture_aspect_ratio |= HDMI_PICTURE_ASPECT_4_3;
2020 break;
2021 case DRM_MODE_FLAG_PIC_AR_16_9:
2022 out->picture_aspect_ratio |= HDMI_PICTURE_ASPECT_16_9;
2023 break;
900aa8ad
SS
2024 case DRM_MODE_FLAG_PIC_AR_64_27:
2025 out->picture_aspect_ratio |= HDMI_PICTURE_ASPECT_64_27;
2026 break;
2027 case DRM_MODE_FLAG_PIC_AR_256_135:
2028 out->picture_aspect_ratio |= HDMI_PICTURE_ASPECT_256_135;
2029 break;
222ec161
SS
2030 default:
2031 out->picture_aspect_ratio = HDMI_PICTURE_ASPECT_NONE;
2032 break;
2033 }
2034
75a655e0 2035 out->status = drm_mode_validate_driver(dev, out);
934a8a89 2036 if (out->status != MODE_OK)
df550548 2037 return -EINVAL;
934a8a89 2038
b201e743
TV
2039 drm_mode_set_crtcinfo(out, CRTC_INTERLACE_HALVE_V);
2040
df550548 2041 return 0;
f03d8ede 2042}
2570fe25
SS
2043
2044/**
2045 * drm_mode_is_420_only - if a given videomode can be only supported in YCBCR420
2046 * output format
2047 *
8d0873a2 2048 * @display: display under action
2570fe25
SS
2049 * @mode: video mode to be tested.
2050 *
2051 * Returns:
2052 * true if the mode can be supported in YCBCR420 format
2053 * false if not.
2054 */
2055bool drm_mode_is_420_only(const struct drm_display_info *display,
2056 const struct drm_display_mode *mode)
2057{
2058 u8 vic = drm_match_cea_mode(mode);
2059
2060 return test_bit(vic, display->hdmi.y420_vdb_modes);
2061}
2062EXPORT_SYMBOL(drm_mode_is_420_only);
2063
2064/**
2065 * drm_mode_is_420_also - if a given videomode can be supported in YCBCR420
2066 * output format also (along with RGB/YCBCR444/422)
2067 *
2068 * @display: display under action.
2069 * @mode: video mode to be tested.
2070 *
2071 * Returns:
2072 * true if the mode can be support YCBCR420 format
2073 * false if not.
2074 */
2075bool drm_mode_is_420_also(const struct drm_display_info *display,
2076 const struct drm_display_mode *mode)
2077{
2078 u8 vic = drm_match_cea_mode(mode);
2079
2080 return test_bit(vic, display->hdmi.y420_cmdb_modes);
2081}
2082EXPORT_SYMBOL(drm_mode_is_420_also);
2083/**
2084 * drm_mode_is_420 - if a given videomode can be supported in YCBCR420
2085 * output format
2086 *
2087 * @display: display under action.
2088 * @mode: video mode to be tested.
2089 *
2090 * Returns:
2091 * true if the mode can be supported in YCBCR420 format
2092 * false if not.
2093 */
2094bool drm_mode_is_420(const struct drm_display_info *display,
2095 const struct drm_display_mode *mode)
2096{
2097 return drm_mode_is_420_only(display, mode) ||
2098 drm_mode_is_420_also(display, mode);
2099}
2100EXPORT_SYMBOL(drm_mode_is_420);