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