xref: /linux/drivers/gpu/drm/drm_modes.c (revision 6b8a024d25ebf7535eb4a3e926309aa693cfe1bd)
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/export.h>
35 #include <linux/fb.h> /* for KHZ2PICOS() */
36 #include <linux/list.h>
37 #include <linux/list_sort.h>
38 #include <linux/of.h>
39 
40 #include <video/of_display_timing.h>
41 #include <video/of_videomode.h>
42 #include <video/videomode.h>
43 
44 #include <drm/drm_crtc.h>
45 #include <drm/drm_device.h>
46 #include <drm/drm_edid.h>
47 #include <drm/drm_modes.h>
48 #include <drm/drm_print.h>
49 
50 #include "drm_crtc_internal.h"
51 
52 /**
53  * drm_mode_debug_printmodeline - print a mode to dmesg
54  * @mode: mode to print
55  *
56  * Describe @mode using DRM_DEBUG.
57  */
58 void drm_mode_debug_printmodeline(const struct drm_display_mode *mode)
59 {
60 	DRM_DEBUG_KMS("Modeline " DRM_MODE_FMT "\n", DRM_MODE_ARG(mode));
61 }
62 EXPORT_SYMBOL(drm_mode_debug_printmodeline);
63 
64 /**
65  * drm_mode_create - create a new display mode
66  * @dev: DRM device
67  *
68  * Create a new, cleared drm_display_mode with kzalloc, allocate an ID for it
69  * and return it.
70  *
71  * Returns:
72  * Pointer to new mode on success, NULL on error.
73  */
74 struct drm_display_mode *drm_mode_create(struct drm_device *dev)
75 {
76 	struct drm_display_mode *nmode;
77 
78 	nmode = kzalloc(sizeof(struct drm_display_mode), GFP_KERNEL);
79 	if (!nmode)
80 		return NULL;
81 
82 	return nmode;
83 }
84 EXPORT_SYMBOL(drm_mode_create);
85 
86 /**
87  * drm_mode_destroy - remove a mode
88  * @dev: DRM device
89  * @mode: mode to remove
90  *
91  * Release @mode's unique ID, then free it @mode structure itself using kfree.
92  */
93 void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode)
94 {
95 	if (!mode)
96 		return;
97 
98 	kfree(mode);
99 }
100 EXPORT_SYMBOL(drm_mode_destroy);
101 
102 /**
103  * drm_mode_probed_add - add a mode to a connector's probed_mode list
104  * @connector: connector the new mode
105  * @mode: mode data
106  *
107  * Add @mode to @connector's probed_mode list for later use. This list should
108  * then in a second step get filtered and all the modes actually supported by
109  * the hardware moved to the @connector's modes list.
110  */
111 void drm_mode_probed_add(struct drm_connector *connector,
112 			 struct drm_display_mode *mode)
113 {
114 	WARN_ON(!mutex_is_locked(&connector->dev->mode_config.mutex));
115 
116 	list_add_tail(&mode->head, &connector->probed_modes);
117 }
118 EXPORT_SYMBOL(drm_mode_probed_add);
119 
120 enum drm_mode_analog {
121 	DRM_MODE_ANALOG_NTSC, /* 525 lines, 60Hz */
122 	DRM_MODE_ANALOG_PAL, /* 625 lines, 50Hz */
123 };
124 
125 /*
126  * The timings come from:
127  * - https://web.archive.org/web/20220406232708/http://www.kolumbus.fi/pami1/video/pal_ntsc.html
128  * - https://web.archive.org/web/20220406124914/http://martin.hinner.info/vga/pal.html
129  * - https://web.archive.org/web/20220609202433/http://www.batsocks.co.uk/readme/video_timing.htm
130  */
131 #define NTSC_LINE_DURATION_NS		63556U
132 #define NTSC_LINES_NUMBER		525
133 
134 #define NTSC_HBLK_DURATION_TYP_NS	10900U
135 #define NTSC_HBLK_DURATION_MIN_NS	(NTSC_HBLK_DURATION_TYP_NS - 200)
136 #define NTSC_HBLK_DURATION_MAX_NS	(NTSC_HBLK_DURATION_TYP_NS + 200)
137 
138 #define NTSC_HACT_DURATION_TYP_NS	(NTSC_LINE_DURATION_NS - NTSC_HBLK_DURATION_TYP_NS)
139 #define NTSC_HACT_DURATION_MIN_NS	(NTSC_LINE_DURATION_NS - NTSC_HBLK_DURATION_MAX_NS)
140 #define NTSC_HACT_DURATION_MAX_NS	(NTSC_LINE_DURATION_NS - NTSC_HBLK_DURATION_MIN_NS)
141 
142 #define NTSC_HFP_DURATION_TYP_NS	1500
143 #define NTSC_HFP_DURATION_MIN_NS	1270
144 #define NTSC_HFP_DURATION_MAX_NS	2220
145 
146 #define NTSC_HSLEN_DURATION_TYP_NS	4700
147 #define NTSC_HSLEN_DURATION_MIN_NS	(NTSC_HSLEN_DURATION_TYP_NS - 100)
148 #define NTSC_HSLEN_DURATION_MAX_NS	(NTSC_HSLEN_DURATION_TYP_NS + 100)
149 
150 #define NTSC_HBP_DURATION_TYP_NS	4700
151 
152 /*
153  * I couldn't find the actual tolerance for the back porch, so let's
154  * just reuse the sync length ones.
155  */
156 #define NTSC_HBP_DURATION_MIN_NS	(NTSC_HBP_DURATION_TYP_NS - 100)
157 #define NTSC_HBP_DURATION_MAX_NS	(NTSC_HBP_DURATION_TYP_NS + 100)
158 
159 #define PAL_LINE_DURATION_NS		64000U
160 #define PAL_LINES_NUMBER		625
161 
162 #define PAL_HACT_DURATION_TYP_NS	51950U
163 #define PAL_HACT_DURATION_MIN_NS	(PAL_HACT_DURATION_TYP_NS - 100)
164 #define PAL_HACT_DURATION_MAX_NS	(PAL_HACT_DURATION_TYP_NS + 400)
165 
166 #define PAL_HBLK_DURATION_TYP_NS	(PAL_LINE_DURATION_NS - PAL_HACT_DURATION_TYP_NS)
167 #define PAL_HBLK_DURATION_MIN_NS	(PAL_LINE_DURATION_NS - PAL_HACT_DURATION_MAX_NS)
168 #define PAL_HBLK_DURATION_MAX_NS	(PAL_LINE_DURATION_NS - PAL_HACT_DURATION_MIN_NS)
169 
170 #define PAL_HFP_DURATION_TYP_NS		1650
171 #define PAL_HFP_DURATION_MIN_NS		(PAL_HFP_DURATION_TYP_NS - 100)
172 #define PAL_HFP_DURATION_MAX_NS		(PAL_HFP_DURATION_TYP_NS + 400)
173 
174 #define PAL_HSLEN_DURATION_TYP_NS	4700
175 #define PAL_HSLEN_DURATION_MIN_NS	(PAL_HSLEN_DURATION_TYP_NS - 200)
176 #define PAL_HSLEN_DURATION_MAX_NS	(PAL_HSLEN_DURATION_TYP_NS + 200)
177 
178 #define PAL_HBP_DURATION_TYP_NS		5700
179 #define PAL_HBP_DURATION_MIN_NS		(PAL_HBP_DURATION_TYP_NS - 200)
180 #define PAL_HBP_DURATION_MAX_NS		(PAL_HBP_DURATION_TYP_NS + 200)
181 
182 struct analog_param_field {
183 	unsigned int even, odd;
184 };
185 
186 #define PARAM_FIELD(_odd, _even)		\
187 	{ .even = _even, .odd = _odd }
188 
189 struct analog_param_range {
190 	unsigned int	min, typ, max;
191 };
192 
193 #define PARAM_RANGE(_min, _typ, _max)		\
194 	{ .min = _min, .typ = _typ, .max = _max }
195 
196 struct analog_parameters {
197 	unsigned int			num_lines;
198 	unsigned int			line_duration_ns;
199 
200 	struct analog_param_range	hact_ns;
201 	struct analog_param_range	hfp_ns;
202 	struct analog_param_range	hslen_ns;
203 	struct analog_param_range	hbp_ns;
204 	struct analog_param_range	hblk_ns;
205 
206 	unsigned int			bt601_hfp;
207 
208 	struct analog_param_field	vfp_lines;
209 	struct analog_param_field	vslen_lines;
210 	struct analog_param_field	vbp_lines;
211 };
212 
213 #define TV_MODE_PARAMETER(_mode, _lines, _line_dur, _hact, _hfp,	\
214 			  _hslen, _hbp, _hblk, _bt601_hfp, _vfp,	\
215 			  _vslen, _vbp)					\
216 	[_mode] = {							\
217 		.num_lines = _lines,					\
218 		.line_duration_ns = _line_dur,				\
219 		.hact_ns = _hact,					\
220 		.hfp_ns = _hfp,						\
221 		.hslen_ns = _hslen,					\
222 		.hbp_ns = _hbp,						\
223 		.hblk_ns = _hblk,					\
224 		.bt601_hfp = _bt601_hfp,				\
225 		.vfp_lines = _vfp,					\
226 		.vslen_lines = _vslen,					\
227 		.vbp_lines = _vbp,					\
228 	}
229 
230 static const struct analog_parameters tv_modes_parameters[] = {
231 	TV_MODE_PARAMETER(DRM_MODE_ANALOG_NTSC,
232 			  NTSC_LINES_NUMBER,
233 			  NTSC_LINE_DURATION_NS,
234 			  PARAM_RANGE(NTSC_HACT_DURATION_MIN_NS,
235 				      NTSC_HACT_DURATION_TYP_NS,
236 				      NTSC_HACT_DURATION_MAX_NS),
237 			  PARAM_RANGE(NTSC_HFP_DURATION_MIN_NS,
238 				      NTSC_HFP_DURATION_TYP_NS,
239 				      NTSC_HFP_DURATION_MAX_NS),
240 			  PARAM_RANGE(NTSC_HSLEN_DURATION_MIN_NS,
241 				      NTSC_HSLEN_DURATION_TYP_NS,
242 				      NTSC_HSLEN_DURATION_MAX_NS),
243 			  PARAM_RANGE(NTSC_HBP_DURATION_MIN_NS,
244 				      NTSC_HBP_DURATION_TYP_NS,
245 				      NTSC_HBP_DURATION_MAX_NS),
246 			  PARAM_RANGE(NTSC_HBLK_DURATION_MIN_NS,
247 				      NTSC_HBLK_DURATION_TYP_NS,
248 				      NTSC_HBLK_DURATION_MAX_NS),
249 			  16,
250 			  PARAM_FIELD(3, 3),
251 			  PARAM_FIELD(3, 3),
252 			  PARAM_FIELD(16, 17)),
253 	TV_MODE_PARAMETER(DRM_MODE_ANALOG_PAL,
254 			  PAL_LINES_NUMBER,
255 			  PAL_LINE_DURATION_NS,
256 			  PARAM_RANGE(PAL_HACT_DURATION_MIN_NS,
257 				      PAL_HACT_DURATION_TYP_NS,
258 				      PAL_HACT_DURATION_MAX_NS),
259 			  PARAM_RANGE(PAL_HFP_DURATION_MIN_NS,
260 				      PAL_HFP_DURATION_TYP_NS,
261 				      PAL_HFP_DURATION_MAX_NS),
262 			  PARAM_RANGE(PAL_HSLEN_DURATION_MIN_NS,
263 				      PAL_HSLEN_DURATION_TYP_NS,
264 				      PAL_HSLEN_DURATION_MAX_NS),
265 			  PARAM_RANGE(PAL_HBP_DURATION_MIN_NS,
266 				      PAL_HBP_DURATION_TYP_NS,
267 				      PAL_HBP_DURATION_MAX_NS),
268 			  PARAM_RANGE(PAL_HBLK_DURATION_MIN_NS,
269 				      PAL_HBLK_DURATION_TYP_NS,
270 				      PAL_HBLK_DURATION_MAX_NS),
271 			  12,
272 
273 			  /*
274 			   * The front porch is actually 6 short sync
275 			   * pulses for the even field, and 5 for the
276 			   * odd field. Each sync takes half a life so
277 			   * the odd field front porch is shorter by
278 			   * half a line.
279 			   *
280 			   * In progressive, we're supposed to use 6
281 			   * pulses, so we're fine there
282 			   */
283 			  PARAM_FIELD(3, 2),
284 
285 			  /*
286 			   * The vsync length is 5 long sync pulses,
287 			   * each field taking half a line. We're
288 			   * shorter for both fields by half a line.
289 			   *
290 			   * In progressive, we're supposed to use 5
291 			   * pulses, so we're off by half
292 			   * a line.
293 			   *
294 			   * In interlace, we're now off by half a line
295 			   * for the even field and one line for the odd
296 			   * field.
297 			   */
298 			  PARAM_FIELD(3, 3),
299 
300 			  /*
301 			   * The back porch starts with post-equalizing
302 			   * pulses, consisting in 5 short sync pulses
303 			   * for the even field, 4 for the odd field. In
304 			   * progressive, it's 5 short syncs.
305 			   *
306 			   * In progressive, we thus have 2.5 lines,
307 			   * plus the 0.5 line we were missing
308 			   * previously, so we should use 3 lines.
309 			   *
310 			   * In interlace, the even field is in the
311 			   * exact same case than progressive. For the
312 			   * odd field, we should be using 2 lines but
313 			   * we're one line short, so we'll make up for
314 			   * it here by using 3.
315 			   *
316 			   * The entire blanking area is supposed to
317 			   * take 25 lines, so we also need to account
318 			   * for the rest of the blanking area that
319 			   * can't be in either the front porch or sync
320 			   * period.
321 			   */
322 			  PARAM_FIELD(19, 20)),
323 };
324 
325 static int fill_analog_mode(struct drm_device *dev,
326 			    struct drm_display_mode *mode,
327 			    const struct analog_parameters *params,
328 			    unsigned long pixel_clock_hz,
329 			    unsigned int hactive,
330 			    unsigned int vactive,
331 			    bool interlace)
332 {
333 	unsigned long pixel_duration_ns = NSEC_PER_SEC / pixel_clock_hz;
334 	unsigned int htotal, vtotal;
335 	unsigned int max_hact, hact_duration_ns;
336 	unsigned int hblk, hblk_duration_ns;
337 	unsigned int hfp, hfp_duration_ns;
338 	unsigned int hslen, hslen_duration_ns;
339 	unsigned int hbp, hbp_duration_ns;
340 	unsigned int porches, porches_duration_ns;
341 	unsigned int vfp, vfp_min;
342 	unsigned int vbp, vbp_min;
343 	unsigned int vslen;
344 	bool bt601 = false;
345 	int porches_rem;
346 	u64 result;
347 
348 	drm_dbg_kms(dev,
349 		    "Generating a %ux%u%c, %u-line mode with a %lu kHz clock\n",
350 		    hactive, vactive,
351 		    interlace ? 'i' : 'p',
352 		    params->num_lines,
353 		    pixel_clock_hz / 1000);
354 
355 	max_hact = params->hact_ns.max / pixel_duration_ns;
356 	if (pixel_clock_hz == 13500000 && hactive > max_hact && hactive <= 720) {
357 		drm_dbg_kms(dev, "Trying to generate a BT.601 mode. Disabling checks.\n");
358 		bt601 = true;
359 	}
360 
361 	/*
362 	 * Our pixel duration is going to be round down by the division,
363 	 * so rounding up is probably going to introduce even more
364 	 * deviation.
365 	 */
366 	result = (u64)params->line_duration_ns * pixel_clock_hz;
367 	do_div(result, NSEC_PER_SEC);
368 	htotal = result;
369 
370 	drm_dbg_kms(dev, "Total Horizontal Number of Pixels: %u\n", htotal);
371 
372 	hact_duration_ns = hactive * pixel_duration_ns;
373 	if (!bt601 &&
374 	    (hact_duration_ns < params->hact_ns.min ||
375 	     hact_duration_ns > params->hact_ns.max)) {
376 		drm_err(dev, "Invalid horizontal active area duration: %uns (min: %u, max %u)\n",
377 			hact_duration_ns, params->hact_ns.min, params->hact_ns.max);
378 		return -EINVAL;
379 	}
380 
381 	hblk = htotal - hactive;
382 	drm_dbg_kms(dev, "Horizontal Blanking Period: %u\n", hblk);
383 
384 	hblk_duration_ns = hblk * pixel_duration_ns;
385 	if (!bt601 &&
386 	    (hblk_duration_ns < params->hblk_ns.min ||
387 	     hblk_duration_ns > params->hblk_ns.max)) {
388 		drm_err(dev, "Invalid horizontal blanking duration: %uns (min: %u, max %u)\n",
389 			hblk_duration_ns, params->hblk_ns.min, params->hblk_ns.max);
390 		return -EINVAL;
391 	}
392 
393 	hslen = DIV_ROUND_UP(params->hslen_ns.typ, pixel_duration_ns);
394 	drm_dbg_kms(dev, "Horizontal Sync Period: %u\n", hslen);
395 
396 	hslen_duration_ns = hslen * pixel_duration_ns;
397 	if (!bt601 &&
398 	    (hslen_duration_ns < params->hslen_ns.min ||
399 	     hslen_duration_ns > params->hslen_ns.max)) {
400 		drm_err(dev, "Invalid horizontal sync duration: %uns (min: %u, max %u)\n",
401 			hslen_duration_ns, params->hslen_ns.min, params->hslen_ns.max);
402 		return -EINVAL;
403 	}
404 
405 	porches = hblk - hslen;
406 	drm_dbg_kms(dev, "Remaining horizontal pixels for both porches: %u\n", porches);
407 
408 	porches_duration_ns = porches * pixel_duration_ns;
409 	if (!bt601 &&
410 	    (porches_duration_ns > (params->hfp_ns.max + params->hbp_ns.max) ||
411 	     porches_duration_ns < (params->hfp_ns.min + params->hbp_ns.min))) {
412 		drm_err(dev, "Invalid horizontal porches duration: %uns\n",
413 			porches_duration_ns);
414 		return -EINVAL;
415 	}
416 
417 	if (bt601) {
418 		hfp = params->bt601_hfp;
419 	} else {
420 		unsigned int hfp_min = DIV_ROUND_UP(params->hfp_ns.min,
421 						    pixel_duration_ns);
422 		unsigned int hbp_min = DIV_ROUND_UP(params->hbp_ns.min,
423 						    pixel_duration_ns);
424 		int porches_rem = porches - hfp_min - hbp_min;
425 
426 		hfp = hfp_min + DIV_ROUND_UP(porches_rem, 2);
427 	}
428 
429 	drm_dbg_kms(dev, "Horizontal Front Porch: %u\n", hfp);
430 
431 	hfp_duration_ns = hfp * pixel_duration_ns;
432 	if (!bt601 &&
433 	    (hfp_duration_ns < params->hfp_ns.min ||
434 	     hfp_duration_ns > params->hfp_ns.max)) {
435 		drm_err(dev, "Invalid horizontal front porch duration: %uns (min: %u, max %u)\n",
436 			hfp_duration_ns, params->hfp_ns.min, params->hfp_ns.max);
437 		return -EINVAL;
438 	}
439 
440 	hbp = porches - hfp;
441 	drm_dbg_kms(dev, "Horizontal Back Porch: %u\n", hbp);
442 
443 	hbp_duration_ns = hbp * pixel_duration_ns;
444 	if (!bt601 &&
445 	    (hbp_duration_ns < params->hbp_ns.min ||
446 	     hbp_duration_ns > params->hbp_ns.max)) {
447 		drm_err(dev, "Invalid horizontal back porch duration: %uns (min: %u, max %u)\n",
448 			hbp_duration_ns, params->hbp_ns.min, params->hbp_ns.max);
449 		return -EINVAL;
450 	}
451 
452 	if (htotal != (hactive + hfp + hslen + hbp))
453 		return -EINVAL;
454 
455 	mode->clock = pixel_clock_hz / 1000;
456 	mode->hdisplay = hactive;
457 	mode->hsync_start = mode->hdisplay + hfp;
458 	mode->hsync_end = mode->hsync_start + hslen;
459 	mode->htotal = mode->hsync_end + hbp;
460 
461 	if (interlace) {
462 		vfp_min = params->vfp_lines.even + params->vfp_lines.odd;
463 		vbp_min = params->vbp_lines.even + params->vbp_lines.odd;
464 		vslen = params->vslen_lines.even + params->vslen_lines.odd;
465 	} else {
466 		/*
467 		 * By convention, NTSC (aka 525/60) systems start with
468 		 * the even field, but PAL (aka 625/50) systems start
469 		 * with the odd one.
470 		 *
471 		 * PAL systems also have asymmetric timings between the
472 		 * even and odd field, while NTSC is symmetric.
473 		 *
474 		 * Moreover, if we want to create a progressive mode for
475 		 * PAL, we need to use the odd field timings.
476 		 *
477 		 * Since odd == even for NTSC, we can just use the odd
478 		 * one all the time to simplify the code a bit.
479 		 */
480 		vfp_min = params->vfp_lines.odd;
481 		vbp_min = params->vbp_lines.odd;
482 		vslen = params->vslen_lines.odd;
483 	}
484 
485 	drm_dbg_kms(dev, "Vertical Sync Period: %u\n", vslen);
486 
487 	porches = params->num_lines - vactive - vslen;
488 	drm_dbg_kms(dev, "Remaining vertical pixels for both porches: %u\n", porches);
489 
490 	porches_rem = porches - vfp_min - vbp_min;
491 	vfp = vfp_min + (porches_rem / 2);
492 	drm_dbg_kms(dev, "Vertical Front Porch: %u\n", vfp);
493 
494 	vbp = porches - vfp;
495 	drm_dbg_kms(dev, "Vertical Back Porch: %u\n", vbp);
496 
497 	vtotal = vactive + vfp + vslen + vbp;
498 	if (params->num_lines != vtotal) {
499 		drm_err(dev, "Invalid vertical total: %upx (expected %upx)\n",
500 			vtotal, params->num_lines);
501 		return -EINVAL;
502 	}
503 
504 	mode->vdisplay = vactive;
505 	mode->vsync_start = mode->vdisplay + vfp;
506 	mode->vsync_end = mode->vsync_start + vslen;
507 	mode->vtotal = mode->vsync_end + vbp;
508 
509 	if (mode->vtotal != params->num_lines)
510 		return -EINVAL;
511 
512 	mode->type = DRM_MODE_TYPE_DRIVER;
513 	mode->flags = DRM_MODE_FLAG_NVSYNC | DRM_MODE_FLAG_NHSYNC;
514 	if (interlace)
515 		mode->flags |= DRM_MODE_FLAG_INTERLACE;
516 
517 	drm_mode_set_name(mode);
518 
519 	drm_dbg_kms(dev, "Generated mode " DRM_MODE_FMT "\n", DRM_MODE_ARG(mode));
520 
521 	return 0;
522 }
523 
524 /**
525  * drm_analog_tv_mode - create a display mode for an analog TV
526  * @dev: drm device
527  * @tv_mode: TV Mode standard to create a mode for. See DRM_MODE_TV_MODE_*.
528  * @pixel_clock_hz: Pixel Clock Frequency, in Hertz
529  * @hdisplay: hdisplay size
530  * @vdisplay: vdisplay size
531  * @interlace: whether to compute an interlaced mode
532  *
533  * This function creates a struct drm_display_mode instance suited for
534  * an analog TV output, for one of the usual analog TV modes. Where
535  * this is DRM_MODE_TV_MODE_MONOCHROME, a 625-line mode will be created.
536  *
537  * Note that @hdisplay is larger than the usual constraints for the PAL
538  * and NTSC timings, and we'll choose to ignore most timings constraints
539  * to reach those resolutions.
540  *
541  * Returns:
542  *
543  * A pointer to the mode, allocated with drm_mode_create(). Returns NULL
544  * on error.
545  */
546 struct drm_display_mode *drm_analog_tv_mode(struct drm_device *dev,
547 					    enum drm_connector_tv_mode tv_mode,
548 					    unsigned long pixel_clock_hz,
549 					    unsigned int hdisplay,
550 					    unsigned int vdisplay,
551 					    bool interlace)
552 {
553 	struct drm_display_mode *mode;
554 	enum drm_mode_analog analog;
555 	int ret;
556 
557 	switch (tv_mode) {
558 	case DRM_MODE_TV_MODE_NTSC:
559 		fallthrough;
560 	case DRM_MODE_TV_MODE_NTSC_443:
561 		fallthrough;
562 	case DRM_MODE_TV_MODE_NTSC_J:
563 		fallthrough;
564 	case DRM_MODE_TV_MODE_PAL_M:
565 		analog = DRM_MODE_ANALOG_NTSC;
566 		break;
567 
568 	case DRM_MODE_TV_MODE_PAL:
569 		fallthrough;
570 	case DRM_MODE_TV_MODE_PAL_N:
571 		fallthrough;
572 	case DRM_MODE_TV_MODE_SECAM:
573 		fallthrough;
574 	case DRM_MODE_TV_MODE_MONOCHROME:
575 		analog = DRM_MODE_ANALOG_PAL;
576 		break;
577 
578 	default:
579 		return NULL;
580 	}
581 
582 	mode = drm_mode_create(dev);
583 	if (!mode)
584 		return NULL;
585 
586 	ret = fill_analog_mode(dev, mode,
587 			       &tv_modes_parameters[analog],
588 			       pixel_clock_hz, hdisplay, vdisplay, interlace);
589 	if (ret)
590 		goto err_free_mode;
591 
592 	return mode;
593 
594 err_free_mode:
595 	drm_mode_destroy(dev, mode);
596 	return NULL;
597 }
598 EXPORT_SYMBOL(drm_analog_tv_mode);
599 
600 /**
601  * drm_cvt_mode -create a modeline based on the CVT algorithm
602  * @dev: drm device
603  * @hdisplay: hdisplay size
604  * @vdisplay: vdisplay size
605  * @vrefresh: vrefresh rate
606  * @reduced: whether to use reduced blanking
607  * @interlaced: whether to compute an interlaced mode
608  * @margins: whether to add margins (borders)
609  *
610  * This function is called to generate the modeline based on CVT algorithm
611  * according to the hdisplay, vdisplay, vrefresh.
612  * It is based from the VESA(TM) Coordinated Video Timing Generator by
613  * Graham Loveridge April 9, 2003 available at
614  * http://www.elo.utfsm.cl/~elo212/docs/CVTd6r1.xls
615  *
616  * And it is copied from xf86CVTmode in xserver/hw/xfree86/modes/xf86cvt.c.
617  * What I have done is to translate it by using integer calculation.
618  *
619  * Returns:
620  * The modeline based on the CVT algorithm stored in a drm_display_mode object.
621  * The display mode object is allocated with drm_mode_create(). Returns NULL
622  * when no mode could be allocated.
623  */
624 struct drm_display_mode *drm_cvt_mode(struct drm_device *dev, int hdisplay,
625 				      int vdisplay, int vrefresh,
626 				      bool reduced, bool interlaced, bool margins)
627 {
628 #define HV_FACTOR			1000
629 	/* 1) top/bottom margin size (% of height) - default: 1.8, */
630 #define	CVT_MARGIN_PERCENTAGE		18
631 	/* 2) character cell horizontal granularity (pixels) - default 8 */
632 #define	CVT_H_GRANULARITY		8
633 	/* 3) Minimum vertical porch (lines) - default 3 */
634 #define	CVT_MIN_V_PORCH			3
635 	/* 4) Minimum number of vertical back porch lines - default 6 */
636 #define	CVT_MIN_V_BPORCH		6
637 	/* Pixel Clock step (kHz) */
638 #define CVT_CLOCK_STEP			250
639 	struct drm_display_mode *drm_mode;
640 	unsigned int vfieldrate, hperiod;
641 	int hdisplay_rnd, hmargin, vdisplay_rnd, vmargin, vsync;
642 	int interlace;
643 	u64 tmp;
644 
645 	if (!hdisplay || !vdisplay)
646 		return NULL;
647 
648 	/* allocate the drm_display_mode structure. If failure, we will
649 	 * return directly
650 	 */
651 	drm_mode = drm_mode_create(dev);
652 	if (!drm_mode)
653 		return NULL;
654 
655 	/* the CVT default refresh rate is 60Hz */
656 	if (!vrefresh)
657 		vrefresh = 60;
658 
659 	/* the required field fresh rate */
660 	if (interlaced)
661 		vfieldrate = vrefresh * 2;
662 	else
663 		vfieldrate = vrefresh;
664 
665 	/* horizontal pixels */
666 	hdisplay_rnd = hdisplay - (hdisplay % CVT_H_GRANULARITY);
667 
668 	/* determine the left&right borders */
669 	hmargin = 0;
670 	if (margins) {
671 		hmargin = hdisplay_rnd * CVT_MARGIN_PERCENTAGE / 1000;
672 		hmargin -= hmargin % CVT_H_GRANULARITY;
673 	}
674 	/* find the total active pixels */
675 	drm_mode->hdisplay = hdisplay_rnd + 2 * hmargin;
676 
677 	/* find the number of lines per field */
678 	if (interlaced)
679 		vdisplay_rnd = vdisplay / 2;
680 	else
681 		vdisplay_rnd = vdisplay;
682 
683 	/* find the top & bottom borders */
684 	vmargin = 0;
685 	if (margins)
686 		vmargin = vdisplay_rnd * CVT_MARGIN_PERCENTAGE / 1000;
687 
688 	drm_mode->vdisplay = vdisplay + 2 * vmargin;
689 
690 	/* Interlaced */
691 	if (interlaced)
692 		interlace = 1;
693 	else
694 		interlace = 0;
695 
696 	/* Determine VSync Width from aspect ratio */
697 	if (!(vdisplay % 3) && ((vdisplay * 4 / 3) == hdisplay))
698 		vsync = 4;
699 	else if (!(vdisplay % 9) && ((vdisplay * 16 / 9) == hdisplay))
700 		vsync = 5;
701 	else if (!(vdisplay % 10) && ((vdisplay * 16 / 10) == hdisplay))
702 		vsync = 6;
703 	else if (!(vdisplay % 4) && ((vdisplay * 5 / 4) == hdisplay))
704 		vsync = 7;
705 	else if (!(vdisplay % 9) && ((vdisplay * 15 / 9) == hdisplay))
706 		vsync = 7;
707 	else /* custom */
708 		vsync = 10;
709 
710 	if (!reduced) {
711 		/* simplify the GTF calculation */
712 		/* 4) Minimum time of vertical sync + back porch interval (µs)
713 		 * default 550.0
714 		 */
715 		int tmp1, tmp2;
716 #define CVT_MIN_VSYNC_BP	550
717 		/* 3) Nominal HSync width (% of line period) - default 8 */
718 #define CVT_HSYNC_PERCENTAGE	8
719 		unsigned int hblank_percentage;
720 		int vsyncandback_porch, __maybe_unused vback_porch, hblank;
721 
722 		/* estimated the horizontal period */
723 		tmp1 = HV_FACTOR * 1000000  -
724 				CVT_MIN_VSYNC_BP * HV_FACTOR * vfieldrate;
725 		tmp2 = (vdisplay_rnd + 2 * vmargin + CVT_MIN_V_PORCH) * 2 +
726 				interlace;
727 		hperiod = tmp1 * 2 / (tmp2 * vfieldrate);
728 
729 		tmp1 = CVT_MIN_VSYNC_BP * HV_FACTOR / hperiod + 1;
730 		/* 9. Find number of lines in sync + backporch */
731 		if (tmp1 < (vsync + CVT_MIN_V_PORCH))
732 			vsyncandback_porch = vsync + CVT_MIN_V_PORCH;
733 		else
734 			vsyncandback_porch = tmp1;
735 		/* 10. Find number of lines in back porch */
736 		vback_porch = vsyncandback_porch - vsync;
737 		drm_mode->vtotal = vdisplay_rnd + 2 * vmargin +
738 				vsyncandback_porch + CVT_MIN_V_PORCH;
739 		/* 5) Definition of Horizontal blanking time limitation */
740 		/* Gradient (%/kHz) - default 600 */
741 #define CVT_M_FACTOR	600
742 		/* Offset (%) - default 40 */
743 #define CVT_C_FACTOR	40
744 		/* Blanking time scaling factor - default 128 */
745 #define CVT_K_FACTOR	128
746 		/* Scaling factor weighting - default 20 */
747 #define CVT_J_FACTOR	20
748 #define CVT_M_PRIME	(CVT_M_FACTOR * CVT_K_FACTOR / 256)
749 #define CVT_C_PRIME	((CVT_C_FACTOR - CVT_J_FACTOR) * CVT_K_FACTOR / 256 + \
750 			 CVT_J_FACTOR)
751 		/* 12. Find ideal blanking duty cycle from formula */
752 		hblank_percentage = CVT_C_PRIME * HV_FACTOR - CVT_M_PRIME *
753 					hperiod / 1000;
754 		/* 13. Blanking time */
755 		if (hblank_percentage < 20 * HV_FACTOR)
756 			hblank_percentage = 20 * HV_FACTOR;
757 		hblank = drm_mode->hdisplay * hblank_percentage /
758 			 (100 * HV_FACTOR - hblank_percentage);
759 		hblank -= hblank % (2 * CVT_H_GRANULARITY);
760 		/* 14. find the total pixels per line */
761 		drm_mode->htotal = drm_mode->hdisplay + hblank;
762 		drm_mode->hsync_end = drm_mode->hdisplay + hblank / 2;
763 		drm_mode->hsync_start = drm_mode->hsync_end -
764 			(drm_mode->htotal * CVT_HSYNC_PERCENTAGE) / 100;
765 		drm_mode->hsync_start += CVT_H_GRANULARITY -
766 			drm_mode->hsync_start % CVT_H_GRANULARITY;
767 		/* fill the Vsync values */
768 		drm_mode->vsync_start = drm_mode->vdisplay + CVT_MIN_V_PORCH;
769 		drm_mode->vsync_end = drm_mode->vsync_start + vsync;
770 	} else {
771 		/* Reduced blanking */
772 		/* Minimum vertical blanking interval time (µs)- default 460 */
773 #define CVT_RB_MIN_VBLANK	460
774 		/* Fixed number of clocks for horizontal sync */
775 #define CVT_RB_H_SYNC		32
776 		/* Fixed number of clocks for horizontal blanking */
777 #define CVT_RB_H_BLANK		160
778 		/* Fixed number of lines for vertical front porch - default 3*/
779 #define CVT_RB_VFPORCH		3
780 		int vbilines;
781 		int tmp1, tmp2;
782 		/* 8. Estimate Horizontal period. */
783 		tmp1 = HV_FACTOR * 1000000 -
784 			CVT_RB_MIN_VBLANK * HV_FACTOR * vfieldrate;
785 		tmp2 = vdisplay_rnd + 2 * vmargin;
786 		hperiod = tmp1 / (tmp2 * vfieldrate);
787 		/* 9. Find number of lines in vertical blanking */
788 		vbilines = CVT_RB_MIN_VBLANK * HV_FACTOR / hperiod + 1;
789 		/* 10. Check if vertical blanking is sufficient */
790 		if (vbilines < (CVT_RB_VFPORCH + vsync + CVT_MIN_V_BPORCH))
791 			vbilines = CVT_RB_VFPORCH + vsync + CVT_MIN_V_BPORCH;
792 		/* 11. Find total number of lines in vertical field */
793 		drm_mode->vtotal = vdisplay_rnd + 2 * vmargin + vbilines;
794 		/* 12. Find total number of pixels in a line */
795 		drm_mode->htotal = drm_mode->hdisplay + CVT_RB_H_BLANK;
796 		/* Fill in HSync values */
797 		drm_mode->hsync_end = drm_mode->hdisplay + CVT_RB_H_BLANK / 2;
798 		drm_mode->hsync_start = drm_mode->hsync_end - CVT_RB_H_SYNC;
799 		/* Fill in VSync values */
800 		drm_mode->vsync_start = drm_mode->vdisplay + CVT_RB_VFPORCH;
801 		drm_mode->vsync_end = drm_mode->vsync_start + vsync;
802 	}
803 	/* 15/13. Find pixel clock frequency (kHz for xf86) */
804 	tmp = drm_mode->htotal; /* perform intermediate calcs in u64 */
805 	tmp *= HV_FACTOR * 1000;
806 	do_div(tmp, hperiod);
807 	tmp -= drm_mode->clock % CVT_CLOCK_STEP;
808 	drm_mode->clock = tmp;
809 	/* 18/16. Find actual vertical frame frequency */
810 	/* ignore - just set the mode flag for interlaced */
811 	if (interlaced) {
812 		drm_mode->vtotal *= 2;
813 		drm_mode->flags |= DRM_MODE_FLAG_INTERLACE;
814 	}
815 	/* Fill the mode line name */
816 	drm_mode_set_name(drm_mode);
817 	if (reduced)
818 		drm_mode->flags |= (DRM_MODE_FLAG_PHSYNC |
819 					DRM_MODE_FLAG_NVSYNC);
820 	else
821 		drm_mode->flags |= (DRM_MODE_FLAG_PVSYNC |
822 					DRM_MODE_FLAG_NHSYNC);
823 
824 	return drm_mode;
825 }
826 EXPORT_SYMBOL(drm_cvt_mode);
827 
828 /**
829  * drm_gtf_mode_complex - create the modeline based on the full GTF algorithm
830  * @dev: drm device
831  * @hdisplay: hdisplay size
832  * @vdisplay: vdisplay size
833  * @vrefresh: vrefresh rate.
834  * @interlaced: whether to compute an interlaced mode
835  * @margins: desired margin (borders) size
836  * @GTF_M: extended GTF formula parameters
837  * @GTF_2C: extended GTF formula parameters
838  * @GTF_K: extended GTF formula parameters
839  * @GTF_2J: extended GTF formula parameters
840  *
841  * GTF feature blocks specify C and J in multiples of 0.5, so we pass them
842  * in here multiplied by two.  For a C of 40, pass in 80.
843  *
844  * Returns:
845  * The modeline based on the full GTF algorithm stored in a drm_display_mode object.
846  * The display mode object is allocated with drm_mode_create(). Returns NULL
847  * when no mode could be allocated.
848  */
849 struct drm_display_mode *
850 drm_gtf_mode_complex(struct drm_device *dev, int hdisplay, int vdisplay,
851 		     int vrefresh, bool interlaced, int margins,
852 		     int GTF_M, int GTF_2C, int GTF_K, int GTF_2J)
853 {	/* 1) top/bottom margin size (% of height) - default: 1.8, */
854 #define	GTF_MARGIN_PERCENTAGE		18
855 	/* 2) character cell horizontal granularity (pixels) - default 8 */
856 #define	GTF_CELL_GRAN			8
857 	/* 3) Minimum vertical porch (lines) - default 3 */
858 #define	GTF_MIN_V_PORCH			1
859 	/* width of vsync in lines */
860 #define V_SYNC_RQD			3
861 	/* width of hsync as % of total line */
862 #define H_SYNC_PERCENT			8
863 	/* min time of vsync + back porch (microsec) */
864 #define MIN_VSYNC_PLUS_BP		550
865 	/* C' and M' are part of the Blanking Duty Cycle computation */
866 #define GTF_C_PRIME	((((GTF_2C - GTF_2J) * GTF_K / 256) + GTF_2J) / 2)
867 #define GTF_M_PRIME	(GTF_K * GTF_M / 256)
868 	struct drm_display_mode *drm_mode;
869 	unsigned int hdisplay_rnd, vdisplay_rnd, vfieldrate_rqd;
870 	int top_margin, bottom_margin;
871 	int interlace;
872 	unsigned int hfreq_est;
873 	int vsync_plus_bp, __maybe_unused vback_porch;
874 	unsigned int vtotal_lines, __maybe_unused vfieldrate_est;
875 	unsigned int __maybe_unused hperiod;
876 	unsigned int vfield_rate, __maybe_unused vframe_rate;
877 	int left_margin, right_margin;
878 	unsigned int total_active_pixels, ideal_duty_cycle;
879 	unsigned int hblank, total_pixels, pixel_freq;
880 	int hsync, hfront_porch, vodd_front_porch_lines;
881 	unsigned int tmp1, tmp2;
882 
883 	if (!hdisplay || !vdisplay)
884 		return NULL;
885 
886 	drm_mode = drm_mode_create(dev);
887 	if (!drm_mode)
888 		return NULL;
889 
890 	/* 1. In order to give correct results, the number of horizontal
891 	 * pixels requested is first processed to ensure that it is divisible
892 	 * by the character size, by rounding it to the nearest character
893 	 * cell boundary:
894 	 */
895 	hdisplay_rnd = (hdisplay + GTF_CELL_GRAN / 2) / GTF_CELL_GRAN;
896 	hdisplay_rnd = hdisplay_rnd * GTF_CELL_GRAN;
897 
898 	/* 2. If interlace is requested, the number of vertical lines assumed
899 	 * by the calculation must be halved, as the computation calculates
900 	 * the number of vertical lines per field.
901 	 */
902 	if (interlaced)
903 		vdisplay_rnd = vdisplay / 2;
904 	else
905 		vdisplay_rnd = vdisplay;
906 
907 	/* 3. Find the frame rate required: */
908 	if (interlaced)
909 		vfieldrate_rqd = vrefresh * 2;
910 	else
911 		vfieldrate_rqd = vrefresh;
912 
913 	/* 4. Find number of lines in Top margin: */
914 	top_margin = 0;
915 	if (margins)
916 		top_margin = (vdisplay_rnd * GTF_MARGIN_PERCENTAGE + 500) /
917 				1000;
918 	/* 5. Find number of lines in bottom margin: */
919 	bottom_margin = top_margin;
920 
921 	/* 6. If interlace is required, then set variable interlace: */
922 	if (interlaced)
923 		interlace = 1;
924 	else
925 		interlace = 0;
926 
927 	/* 7. Estimate the Horizontal frequency */
928 	{
929 		tmp1 = (1000000  - MIN_VSYNC_PLUS_BP * vfieldrate_rqd) / 500;
930 		tmp2 = (vdisplay_rnd + 2 * top_margin + GTF_MIN_V_PORCH) *
931 				2 + interlace;
932 		hfreq_est = (tmp2 * 1000 * vfieldrate_rqd) / tmp1;
933 	}
934 
935 	/* 8. Find the number of lines in V sync + back porch */
936 	/* [V SYNC+BP] = RINT(([MIN VSYNC+BP] * hfreq_est / 1000000)) */
937 	vsync_plus_bp = MIN_VSYNC_PLUS_BP * hfreq_est / 1000;
938 	vsync_plus_bp = (vsync_plus_bp + 500) / 1000;
939 	/*  9. Find the number of lines in V back porch alone: */
940 	vback_porch = vsync_plus_bp - V_SYNC_RQD;
941 	/*  10. Find the total number of lines in Vertical field period: */
942 	vtotal_lines = vdisplay_rnd + top_margin + bottom_margin +
943 			vsync_plus_bp + GTF_MIN_V_PORCH;
944 	/*  11. Estimate the Vertical field frequency: */
945 	vfieldrate_est = hfreq_est / vtotal_lines;
946 	/*  12. Find the actual horizontal period: */
947 	hperiod = 1000000 / (vfieldrate_rqd * vtotal_lines);
948 
949 	/*  13. Find the actual Vertical field frequency: */
950 	vfield_rate = hfreq_est / vtotal_lines;
951 	/*  14. Find the Vertical frame frequency: */
952 	if (interlaced)
953 		vframe_rate = vfield_rate / 2;
954 	else
955 		vframe_rate = vfield_rate;
956 	/*  15. Find number of pixels in left margin: */
957 	if (margins)
958 		left_margin = (hdisplay_rnd * GTF_MARGIN_PERCENTAGE + 500) /
959 				1000;
960 	else
961 		left_margin = 0;
962 
963 	/* 16.Find number of pixels in right margin: */
964 	right_margin = left_margin;
965 	/* 17.Find total number of active pixels in image and left and right */
966 	total_active_pixels = hdisplay_rnd + left_margin + right_margin;
967 	/* 18.Find the ideal blanking duty cycle from blanking duty cycle */
968 	ideal_duty_cycle = GTF_C_PRIME * 1000 -
969 				(GTF_M_PRIME * 1000000 / hfreq_est);
970 	/* 19.Find the number of pixels in the blanking time to the nearest
971 	 * double character cell: */
972 	hblank = total_active_pixels * ideal_duty_cycle /
973 			(100000 - ideal_duty_cycle);
974 	hblank = (hblank + GTF_CELL_GRAN) / (2 * GTF_CELL_GRAN);
975 	hblank = hblank * 2 * GTF_CELL_GRAN;
976 	/* 20.Find total number of pixels: */
977 	total_pixels = total_active_pixels + hblank;
978 	/* 21.Find pixel clock frequency: */
979 	pixel_freq = total_pixels * hfreq_est / 1000;
980 	/* Stage 1 computations are now complete; I should really pass
981 	 * the results to another function and do the Stage 2 computations,
982 	 * but I only need a few more values so I'll just append the
983 	 * computations here for now */
984 	/* 17. Find the number of pixels in the horizontal sync period: */
985 	hsync = H_SYNC_PERCENT * total_pixels / 100;
986 	hsync = (hsync + GTF_CELL_GRAN / 2) / GTF_CELL_GRAN;
987 	hsync = hsync * GTF_CELL_GRAN;
988 	/* 18. Find the number of pixels in horizontal front porch period */
989 	hfront_porch = hblank / 2 - hsync;
990 	/*  36. Find the number of lines in the odd front porch period: */
991 	vodd_front_porch_lines = GTF_MIN_V_PORCH ;
992 
993 	/* finally, pack the results in the mode struct */
994 	drm_mode->hdisplay = hdisplay_rnd;
995 	drm_mode->hsync_start = hdisplay_rnd + hfront_porch;
996 	drm_mode->hsync_end = drm_mode->hsync_start + hsync;
997 	drm_mode->htotal = total_pixels;
998 	drm_mode->vdisplay = vdisplay_rnd;
999 	drm_mode->vsync_start = vdisplay_rnd + vodd_front_porch_lines;
1000 	drm_mode->vsync_end = drm_mode->vsync_start + V_SYNC_RQD;
1001 	drm_mode->vtotal = vtotal_lines;
1002 
1003 	drm_mode->clock = pixel_freq;
1004 
1005 	if (interlaced) {
1006 		drm_mode->vtotal *= 2;
1007 		drm_mode->flags |= DRM_MODE_FLAG_INTERLACE;
1008 	}
1009 
1010 	drm_mode_set_name(drm_mode);
1011 	if (GTF_M == 600 && GTF_2C == 80 && GTF_K == 128 && GTF_2J == 40)
1012 		drm_mode->flags = DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC;
1013 	else
1014 		drm_mode->flags = DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_NVSYNC;
1015 
1016 	return drm_mode;
1017 }
1018 EXPORT_SYMBOL(drm_gtf_mode_complex);
1019 
1020 /**
1021  * drm_gtf_mode - create the modeline based on the GTF algorithm
1022  * @dev: drm device
1023  * @hdisplay: hdisplay size
1024  * @vdisplay: vdisplay size
1025  * @vrefresh: vrefresh rate.
1026  * @interlaced: whether to compute an interlaced mode
1027  * @margins: desired margin (borders) size
1028  *
1029  * return the modeline based on GTF algorithm
1030  *
1031  * This function is to create the modeline based on the GTF algorithm.
1032  * Generalized Timing Formula is derived from:
1033  *
1034  *	GTF Spreadsheet by Andy Morrish (1/5/97)
1035  *	available at https://www.vesa.org
1036  *
1037  * And it is copied from the file of xserver/hw/xfree86/modes/xf86gtf.c.
1038  * What I have done is to translate it by using integer calculation.
1039  * I also refer to the function of fb_get_mode in the file of
1040  * drivers/video/fbmon.c
1041  *
1042  * Standard GTF parameters::
1043  *
1044  *     M = 600
1045  *     C = 40
1046  *     K = 128
1047  *     J = 20
1048  *
1049  * Returns:
1050  * The modeline based on the GTF algorithm stored in a drm_display_mode object.
1051  * The display mode object is allocated with drm_mode_create(). Returns NULL
1052  * when no mode could be allocated.
1053  */
1054 struct drm_display_mode *
1055 drm_gtf_mode(struct drm_device *dev, int hdisplay, int vdisplay, int vrefresh,
1056 	     bool interlaced, int margins)
1057 {
1058 	return drm_gtf_mode_complex(dev, hdisplay, vdisplay, vrefresh,
1059 				    interlaced, margins,
1060 				    600, 40 * 2, 128, 20 * 2);
1061 }
1062 EXPORT_SYMBOL(drm_gtf_mode);
1063 
1064 #ifdef CONFIG_VIDEOMODE_HELPERS
1065 /**
1066  * drm_display_mode_from_videomode - fill in @dmode using @vm,
1067  * @vm: videomode structure to use as source
1068  * @dmode: drm_display_mode structure to use as destination
1069  *
1070  * Fills out @dmode using the display mode specified in @vm.
1071  */
1072 void drm_display_mode_from_videomode(const struct videomode *vm,
1073 				     struct drm_display_mode *dmode)
1074 {
1075 	dmode->hdisplay = vm->hactive;
1076 	dmode->hsync_start = dmode->hdisplay + vm->hfront_porch;
1077 	dmode->hsync_end = dmode->hsync_start + vm->hsync_len;
1078 	dmode->htotal = dmode->hsync_end + vm->hback_porch;
1079 
1080 	dmode->vdisplay = vm->vactive;
1081 	dmode->vsync_start = dmode->vdisplay + vm->vfront_porch;
1082 	dmode->vsync_end = dmode->vsync_start + vm->vsync_len;
1083 	dmode->vtotal = dmode->vsync_end + vm->vback_porch;
1084 
1085 	dmode->clock = vm->pixelclock / 1000;
1086 
1087 	dmode->flags = 0;
1088 	if (vm->flags & DISPLAY_FLAGS_HSYNC_HIGH)
1089 		dmode->flags |= DRM_MODE_FLAG_PHSYNC;
1090 	else if (vm->flags & DISPLAY_FLAGS_HSYNC_LOW)
1091 		dmode->flags |= DRM_MODE_FLAG_NHSYNC;
1092 	if (vm->flags & DISPLAY_FLAGS_VSYNC_HIGH)
1093 		dmode->flags |= DRM_MODE_FLAG_PVSYNC;
1094 	else if (vm->flags & DISPLAY_FLAGS_VSYNC_LOW)
1095 		dmode->flags |= DRM_MODE_FLAG_NVSYNC;
1096 	if (vm->flags & DISPLAY_FLAGS_INTERLACED)
1097 		dmode->flags |= DRM_MODE_FLAG_INTERLACE;
1098 	if (vm->flags & DISPLAY_FLAGS_DOUBLESCAN)
1099 		dmode->flags |= DRM_MODE_FLAG_DBLSCAN;
1100 	if (vm->flags & DISPLAY_FLAGS_DOUBLECLK)
1101 		dmode->flags |= DRM_MODE_FLAG_DBLCLK;
1102 	drm_mode_set_name(dmode);
1103 }
1104 EXPORT_SYMBOL_GPL(drm_display_mode_from_videomode);
1105 
1106 /**
1107  * drm_display_mode_to_videomode - fill in @vm using @dmode,
1108  * @dmode: drm_display_mode structure to use as source
1109  * @vm: videomode structure to use as destination
1110  *
1111  * Fills out @vm using the display mode specified in @dmode.
1112  */
1113 void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
1114 				   struct videomode *vm)
1115 {
1116 	vm->hactive = dmode->hdisplay;
1117 	vm->hfront_porch = dmode->hsync_start - dmode->hdisplay;
1118 	vm->hsync_len = dmode->hsync_end - dmode->hsync_start;
1119 	vm->hback_porch = dmode->htotal - dmode->hsync_end;
1120 
1121 	vm->vactive = dmode->vdisplay;
1122 	vm->vfront_porch = dmode->vsync_start - dmode->vdisplay;
1123 	vm->vsync_len = dmode->vsync_end - dmode->vsync_start;
1124 	vm->vback_porch = dmode->vtotal - dmode->vsync_end;
1125 
1126 	vm->pixelclock = dmode->clock * 1000;
1127 
1128 	vm->flags = 0;
1129 	if (dmode->flags & DRM_MODE_FLAG_PHSYNC)
1130 		vm->flags |= DISPLAY_FLAGS_HSYNC_HIGH;
1131 	else if (dmode->flags & DRM_MODE_FLAG_NHSYNC)
1132 		vm->flags |= DISPLAY_FLAGS_HSYNC_LOW;
1133 	if (dmode->flags & DRM_MODE_FLAG_PVSYNC)
1134 		vm->flags |= DISPLAY_FLAGS_VSYNC_HIGH;
1135 	else if (dmode->flags & DRM_MODE_FLAG_NVSYNC)
1136 		vm->flags |= DISPLAY_FLAGS_VSYNC_LOW;
1137 	if (dmode->flags & DRM_MODE_FLAG_INTERLACE)
1138 		vm->flags |= DISPLAY_FLAGS_INTERLACED;
1139 	if (dmode->flags & DRM_MODE_FLAG_DBLSCAN)
1140 		vm->flags |= DISPLAY_FLAGS_DOUBLESCAN;
1141 	if (dmode->flags & DRM_MODE_FLAG_DBLCLK)
1142 		vm->flags |= DISPLAY_FLAGS_DOUBLECLK;
1143 }
1144 EXPORT_SYMBOL_GPL(drm_display_mode_to_videomode);
1145 
1146 /**
1147  * drm_bus_flags_from_videomode - extract information about pixelclk and
1148  * DE polarity from videomode and store it in a separate variable
1149  * @vm: videomode structure to use
1150  * @bus_flags: information about pixelclk, sync and DE polarity will be stored
1151  * here
1152  *
1153  * Sets DRM_BUS_FLAG_DE_(LOW|HIGH),  DRM_BUS_FLAG_PIXDATA_DRIVE_(POS|NEG)EDGE
1154  * and DISPLAY_FLAGS_SYNC_(POS|NEG)EDGE in @bus_flags according to DISPLAY_FLAGS
1155  * found in @vm
1156  */
1157 void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags)
1158 {
1159 	*bus_flags = 0;
1160 	if (vm->flags & DISPLAY_FLAGS_PIXDATA_POSEDGE)
1161 		*bus_flags |= DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE;
1162 	if (vm->flags & DISPLAY_FLAGS_PIXDATA_NEGEDGE)
1163 		*bus_flags |= DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE;
1164 
1165 	if (vm->flags & DISPLAY_FLAGS_SYNC_POSEDGE)
1166 		*bus_flags |= DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE;
1167 	if (vm->flags & DISPLAY_FLAGS_SYNC_NEGEDGE)
1168 		*bus_flags |= DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE;
1169 
1170 	if (vm->flags & DISPLAY_FLAGS_DE_LOW)
1171 		*bus_flags |= DRM_BUS_FLAG_DE_LOW;
1172 	if (vm->flags & DISPLAY_FLAGS_DE_HIGH)
1173 		*bus_flags |= DRM_BUS_FLAG_DE_HIGH;
1174 }
1175 EXPORT_SYMBOL_GPL(drm_bus_flags_from_videomode);
1176 
1177 #ifdef CONFIG_OF
1178 /**
1179  * of_get_drm_display_mode - get a drm_display_mode from devicetree
1180  * @np: device_node with the timing specification
1181  * @dmode: will be set to the return value
1182  * @bus_flags: information about pixelclk, sync and DE polarity
1183  * @index: index into the list of display timings in devicetree
1184  *
1185  * This function is expensive and should only be used, if only one mode is to be
1186  * read from DT. To get multiple modes start with of_get_display_timings and
1187  * work with that instead.
1188  *
1189  * Returns:
1190  * 0 on success, a negative errno code when no of videomode node was found.
1191  */
1192 int of_get_drm_display_mode(struct device_node *np,
1193 			    struct drm_display_mode *dmode, u32 *bus_flags,
1194 			    int index)
1195 {
1196 	struct videomode vm;
1197 	int ret;
1198 
1199 	ret = of_get_videomode(np, &vm, index);
1200 	if (ret)
1201 		return ret;
1202 
1203 	drm_display_mode_from_videomode(&vm, dmode);
1204 	if (bus_flags)
1205 		drm_bus_flags_from_videomode(&vm, bus_flags);
1206 
1207 	pr_debug("%pOF: got %dx%d display mode: " DRM_MODE_FMT "\n",
1208 		 np, vm.hactive, vm.vactive, DRM_MODE_ARG(dmode));
1209 
1210 	return 0;
1211 }
1212 EXPORT_SYMBOL_GPL(of_get_drm_display_mode);
1213 
1214 /**
1215  * of_get_drm_panel_display_mode - get a panel-timing drm_display_mode from devicetree
1216  * @np: device_node with the panel-timing specification
1217  * @dmode: will be set to the return value
1218  * @bus_flags: information about pixelclk, sync and DE polarity
1219  *
1220  * The mandatory Device Tree properties width-mm and height-mm
1221  * are read and set on the display mode.
1222  *
1223  * Returns:
1224  * Zero on success, negative error code on failure.
1225  */
1226 int of_get_drm_panel_display_mode(struct device_node *np,
1227 				  struct drm_display_mode *dmode, u32 *bus_flags)
1228 {
1229 	u32 width_mm = 0, height_mm = 0;
1230 	struct display_timing timing;
1231 	struct videomode vm;
1232 	int ret;
1233 
1234 	ret = of_get_display_timing(np, "panel-timing", &timing);
1235 	if (ret)
1236 		return ret;
1237 
1238 	videomode_from_timing(&timing, &vm);
1239 
1240 	memset(dmode, 0, sizeof(*dmode));
1241 	drm_display_mode_from_videomode(&vm, dmode);
1242 	if (bus_flags)
1243 		drm_bus_flags_from_videomode(&vm, bus_flags);
1244 
1245 	ret = of_property_read_u32(np, "width-mm", &width_mm);
1246 	if (ret)
1247 		return ret;
1248 
1249 	ret = of_property_read_u32(np, "height-mm", &height_mm);
1250 	if (ret)
1251 		return ret;
1252 
1253 	dmode->width_mm = width_mm;
1254 	dmode->height_mm = height_mm;
1255 
1256 	pr_debug(DRM_MODE_FMT "\n", DRM_MODE_ARG(dmode));
1257 
1258 	return 0;
1259 }
1260 EXPORT_SYMBOL_GPL(of_get_drm_panel_display_mode);
1261 #endif /* CONFIG_OF */
1262 #endif /* CONFIG_VIDEOMODE_HELPERS */
1263 
1264 /**
1265  * drm_mode_set_name - set the name on a mode
1266  * @mode: name will be set in this mode
1267  *
1268  * Set the name of @mode to a standard format which is <hdisplay>x<vdisplay>
1269  * with an optional 'i' suffix for interlaced modes.
1270  */
1271 void drm_mode_set_name(struct drm_display_mode *mode)
1272 {
1273 	bool interlaced = !!(mode->flags & DRM_MODE_FLAG_INTERLACE);
1274 
1275 	snprintf(mode->name, DRM_DISPLAY_MODE_LEN, "%dx%d%s",
1276 		 mode->hdisplay, mode->vdisplay,
1277 		 interlaced ? "i" : "");
1278 }
1279 EXPORT_SYMBOL(drm_mode_set_name);
1280 
1281 /**
1282  * drm_mode_vrefresh - get the vrefresh of a mode
1283  * @mode: mode
1284  *
1285  * Returns:
1286  * @modes's vrefresh rate in Hz, rounded to the nearest integer. Calculates the
1287  * value first if it is not yet set.
1288  */
1289 int drm_mode_vrefresh(const struct drm_display_mode *mode)
1290 {
1291 	unsigned int num, den;
1292 
1293 	if (mode->htotal == 0 || mode->vtotal == 0)
1294 		return 0;
1295 
1296 	num = mode->clock;
1297 	den = mode->htotal * mode->vtotal;
1298 
1299 	if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1300 		num *= 2;
1301 	if (mode->flags & DRM_MODE_FLAG_DBLSCAN)
1302 		den *= 2;
1303 	if (mode->vscan > 1)
1304 		den *= mode->vscan;
1305 
1306 	return DIV_ROUND_CLOSEST_ULL(mul_u32_u32(num, 1000), den);
1307 }
1308 EXPORT_SYMBOL(drm_mode_vrefresh);
1309 
1310 /**
1311  * drm_mode_get_hv_timing - Fetches hdisplay/vdisplay for given mode
1312  * @mode: mode to query
1313  * @hdisplay: hdisplay value to fill in
1314  * @vdisplay: vdisplay value to fill in
1315  *
1316  * The vdisplay value will be doubled if the specified mode is a stereo mode of
1317  * the appropriate layout.
1318  */
1319 void drm_mode_get_hv_timing(const struct drm_display_mode *mode,
1320 			    int *hdisplay, int *vdisplay)
1321 {
1322 	struct drm_display_mode adjusted;
1323 
1324 	drm_mode_init(&adjusted, mode);
1325 
1326 	drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
1327 	*hdisplay = adjusted.crtc_hdisplay;
1328 	*vdisplay = adjusted.crtc_vdisplay;
1329 }
1330 EXPORT_SYMBOL(drm_mode_get_hv_timing);
1331 
1332 /**
1333  * drm_mode_set_crtcinfo - set CRTC modesetting timing parameters
1334  * @p: mode
1335  * @adjust_flags: a combination of adjustment flags
1336  *
1337  * Setup the CRTC modesetting timing parameters for @p, adjusting if necessary.
1338  *
1339  * - The CRTC_INTERLACE_HALVE_V flag can be used to halve vertical timings of
1340  *   interlaced modes.
1341  * - The CRTC_STEREO_DOUBLE flag can be used to compute the timings for
1342  *   buffers containing two eyes (only adjust the timings when needed, eg. for
1343  *   "frame packing" or "side by side full").
1344  * - The CRTC_NO_DBLSCAN and CRTC_NO_VSCAN flags request that adjustment *not*
1345  *   be performed for doublescan and vscan > 1 modes respectively.
1346  */
1347 void drm_mode_set_crtcinfo(struct drm_display_mode *p, int adjust_flags)
1348 {
1349 	if (!p)
1350 		return;
1351 
1352 	p->crtc_clock = p->clock;
1353 	p->crtc_hdisplay = p->hdisplay;
1354 	p->crtc_hsync_start = p->hsync_start;
1355 	p->crtc_hsync_end = p->hsync_end;
1356 	p->crtc_htotal = p->htotal;
1357 	p->crtc_hskew = p->hskew;
1358 	p->crtc_vdisplay = p->vdisplay;
1359 	p->crtc_vsync_start = p->vsync_start;
1360 	p->crtc_vsync_end = p->vsync_end;
1361 	p->crtc_vtotal = p->vtotal;
1362 
1363 	if (p->flags & DRM_MODE_FLAG_INTERLACE) {
1364 		if (adjust_flags & CRTC_INTERLACE_HALVE_V) {
1365 			p->crtc_vdisplay /= 2;
1366 			p->crtc_vsync_start /= 2;
1367 			p->crtc_vsync_end /= 2;
1368 			p->crtc_vtotal /= 2;
1369 		}
1370 	}
1371 
1372 	if (!(adjust_flags & CRTC_NO_DBLSCAN)) {
1373 		if (p->flags & DRM_MODE_FLAG_DBLSCAN) {
1374 			p->crtc_vdisplay *= 2;
1375 			p->crtc_vsync_start *= 2;
1376 			p->crtc_vsync_end *= 2;
1377 			p->crtc_vtotal *= 2;
1378 		}
1379 	}
1380 
1381 	if (!(adjust_flags & CRTC_NO_VSCAN)) {
1382 		if (p->vscan > 1) {
1383 			p->crtc_vdisplay *= p->vscan;
1384 			p->crtc_vsync_start *= p->vscan;
1385 			p->crtc_vsync_end *= p->vscan;
1386 			p->crtc_vtotal *= p->vscan;
1387 		}
1388 	}
1389 
1390 	if (adjust_flags & CRTC_STEREO_DOUBLE) {
1391 		unsigned int layout = p->flags & DRM_MODE_FLAG_3D_MASK;
1392 
1393 		switch (layout) {
1394 		case DRM_MODE_FLAG_3D_FRAME_PACKING:
1395 			p->crtc_clock *= 2;
1396 			p->crtc_vdisplay += p->crtc_vtotal;
1397 			p->crtc_vsync_start += p->crtc_vtotal;
1398 			p->crtc_vsync_end += p->crtc_vtotal;
1399 			p->crtc_vtotal += p->crtc_vtotal;
1400 			break;
1401 		}
1402 	}
1403 
1404 	p->crtc_vblank_start = min(p->crtc_vsync_start, p->crtc_vdisplay);
1405 	p->crtc_vblank_end = max(p->crtc_vsync_end, p->crtc_vtotal);
1406 	p->crtc_hblank_start = min(p->crtc_hsync_start, p->crtc_hdisplay);
1407 	p->crtc_hblank_end = max(p->crtc_hsync_end, p->crtc_htotal);
1408 }
1409 EXPORT_SYMBOL(drm_mode_set_crtcinfo);
1410 
1411 /**
1412  * drm_mode_copy - copy the mode
1413  * @dst: mode to overwrite
1414  * @src: mode to copy
1415  *
1416  * Copy an existing mode into another mode, preserving the
1417  * list head of the destination mode.
1418  */
1419 void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src)
1420 {
1421 	struct list_head head = dst->head;
1422 
1423 	*dst = *src;
1424 	dst->head = head;
1425 }
1426 EXPORT_SYMBOL(drm_mode_copy);
1427 
1428 /**
1429  * drm_mode_init - initialize the mode from another mode
1430  * @dst: mode to overwrite
1431  * @src: mode to copy
1432  *
1433  * Copy an existing mode into another mode, zeroing the
1434  * list head of the destination mode. Typically used
1435  * to guarantee the list head is not left with stack
1436  * garbage in on-stack modes.
1437  */
1438 void drm_mode_init(struct drm_display_mode *dst, const struct drm_display_mode *src)
1439 {
1440 	memset(dst, 0, sizeof(*dst));
1441 	drm_mode_copy(dst, src);
1442 }
1443 EXPORT_SYMBOL(drm_mode_init);
1444 
1445 /**
1446  * drm_mode_duplicate - allocate and duplicate an existing mode
1447  * @dev: drm_device to allocate the duplicated mode for
1448  * @mode: mode to duplicate
1449  *
1450  * Just allocate a new mode, copy the existing mode into it, and return
1451  * a pointer to it.  Used to create new instances of established modes.
1452  *
1453  * Returns:
1454  * Pointer to duplicated mode on success, NULL on error.
1455  */
1456 struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
1457 					    const struct drm_display_mode *mode)
1458 {
1459 	struct drm_display_mode *nmode;
1460 
1461 	nmode = drm_mode_create(dev);
1462 	if (!nmode)
1463 		return NULL;
1464 
1465 	drm_mode_copy(nmode, mode);
1466 
1467 	return nmode;
1468 }
1469 EXPORT_SYMBOL(drm_mode_duplicate);
1470 
1471 static bool drm_mode_match_timings(const struct drm_display_mode *mode1,
1472 				   const struct drm_display_mode *mode2)
1473 {
1474 	return mode1->hdisplay == mode2->hdisplay &&
1475 		mode1->hsync_start == mode2->hsync_start &&
1476 		mode1->hsync_end == mode2->hsync_end &&
1477 		mode1->htotal == mode2->htotal &&
1478 		mode1->hskew == mode2->hskew &&
1479 		mode1->vdisplay == mode2->vdisplay &&
1480 		mode1->vsync_start == mode2->vsync_start &&
1481 		mode1->vsync_end == mode2->vsync_end &&
1482 		mode1->vtotal == mode2->vtotal &&
1483 		mode1->vscan == mode2->vscan;
1484 }
1485 
1486 static bool drm_mode_match_clock(const struct drm_display_mode *mode1,
1487 				  const struct drm_display_mode *mode2)
1488 {
1489 	/*
1490 	 * do clock check convert to PICOS
1491 	 * so fb modes get matched the same
1492 	 */
1493 	if (mode1->clock && mode2->clock)
1494 		return KHZ2PICOS(mode1->clock) == KHZ2PICOS(mode2->clock);
1495 	else
1496 		return mode1->clock == mode2->clock;
1497 }
1498 
1499 static bool drm_mode_match_flags(const struct drm_display_mode *mode1,
1500 				 const struct drm_display_mode *mode2)
1501 {
1502 	return (mode1->flags & ~DRM_MODE_FLAG_3D_MASK) ==
1503 		(mode2->flags & ~DRM_MODE_FLAG_3D_MASK);
1504 }
1505 
1506 static bool drm_mode_match_3d_flags(const struct drm_display_mode *mode1,
1507 				    const struct drm_display_mode *mode2)
1508 {
1509 	return (mode1->flags & DRM_MODE_FLAG_3D_MASK) ==
1510 		(mode2->flags & DRM_MODE_FLAG_3D_MASK);
1511 }
1512 
1513 static bool drm_mode_match_aspect_ratio(const struct drm_display_mode *mode1,
1514 					const struct drm_display_mode *mode2)
1515 {
1516 	return mode1->picture_aspect_ratio == mode2->picture_aspect_ratio;
1517 }
1518 
1519 /**
1520  * drm_mode_match - test modes for (partial) equality
1521  * @mode1: first mode
1522  * @mode2: second mode
1523  * @match_flags: which parts need to match (DRM_MODE_MATCH_*)
1524  *
1525  * Check to see if @mode1 and @mode2 are equivalent.
1526  *
1527  * Returns:
1528  * True if the modes are (partially) equal, false otherwise.
1529  */
1530 bool drm_mode_match(const struct drm_display_mode *mode1,
1531 		    const struct drm_display_mode *mode2,
1532 		    unsigned int match_flags)
1533 {
1534 	if (!mode1 && !mode2)
1535 		return true;
1536 
1537 	if (!mode1 || !mode2)
1538 		return false;
1539 
1540 	if (match_flags & DRM_MODE_MATCH_TIMINGS &&
1541 	    !drm_mode_match_timings(mode1, mode2))
1542 		return false;
1543 
1544 	if (match_flags & DRM_MODE_MATCH_CLOCK &&
1545 	    !drm_mode_match_clock(mode1, mode2))
1546 		return false;
1547 
1548 	if (match_flags & DRM_MODE_MATCH_FLAGS &&
1549 	    !drm_mode_match_flags(mode1, mode2))
1550 		return false;
1551 
1552 	if (match_flags & DRM_MODE_MATCH_3D_FLAGS &&
1553 	    !drm_mode_match_3d_flags(mode1, mode2))
1554 		return false;
1555 
1556 	if (match_flags & DRM_MODE_MATCH_ASPECT_RATIO &&
1557 	    !drm_mode_match_aspect_ratio(mode1, mode2))
1558 		return false;
1559 
1560 	return true;
1561 }
1562 EXPORT_SYMBOL(drm_mode_match);
1563 
1564 /**
1565  * drm_mode_equal - test modes for equality
1566  * @mode1: first mode
1567  * @mode2: second mode
1568  *
1569  * Check to see if @mode1 and @mode2 are equivalent.
1570  *
1571  * Returns:
1572  * True if the modes are equal, false otherwise.
1573  */
1574 bool drm_mode_equal(const struct drm_display_mode *mode1,
1575 		    const struct drm_display_mode *mode2)
1576 {
1577 	return drm_mode_match(mode1, mode2,
1578 			      DRM_MODE_MATCH_TIMINGS |
1579 			      DRM_MODE_MATCH_CLOCK |
1580 			      DRM_MODE_MATCH_FLAGS |
1581 			      DRM_MODE_MATCH_3D_FLAGS|
1582 			      DRM_MODE_MATCH_ASPECT_RATIO);
1583 }
1584 EXPORT_SYMBOL(drm_mode_equal);
1585 
1586 /**
1587  * drm_mode_equal_no_clocks - test modes for equality
1588  * @mode1: first mode
1589  * @mode2: second mode
1590  *
1591  * Check to see if @mode1 and @mode2 are equivalent, but
1592  * don't check the pixel clocks.
1593  *
1594  * Returns:
1595  * True if the modes are equal, false otherwise.
1596  */
1597 bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1,
1598 			      const struct drm_display_mode *mode2)
1599 {
1600 	return drm_mode_match(mode1, mode2,
1601 			      DRM_MODE_MATCH_TIMINGS |
1602 			      DRM_MODE_MATCH_FLAGS |
1603 			      DRM_MODE_MATCH_3D_FLAGS);
1604 }
1605 EXPORT_SYMBOL(drm_mode_equal_no_clocks);
1606 
1607 /**
1608  * drm_mode_equal_no_clocks_no_stereo - test modes for equality
1609  * @mode1: first mode
1610  * @mode2: second mode
1611  *
1612  * Check to see if @mode1 and @mode2 are equivalent, but
1613  * don't check the pixel clocks nor the stereo layout.
1614  *
1615  * Returns:
1616  * True if the modes are equal, false otherwise.
1617  */
1618 bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
1619 					const struct drm_display_mode *mode2)
1620 {
1621 	return drm_mode_match(mode1, mode2,
1622 			      DRM_MODE_MATCH_TIMINGS |
1623 			      DRM_MODE_MATCH_FLAGS);
1624 }
1625 EXPORT_SYMBOL(drm_mode_equal_no_clocks_no_stereo);
1626 
1627 static enum drm_mode_status
1628 drm_mode_validate_basic(const struct drm_display_mode *mode)
1629 {
1630 	if (mode->type & ~DRM_MODE_TYPE_ALL)
1631 		return MODE_BAD;
1632 
1633 	if (mode->flags & ~DRM_MODE_FLAG_ALL)
1634 		return MODE_BAD;
1635 
1636 	if ((mode->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1637 		return MODE_BAD;
1638 
1639 	if (mode->clock == 0)
1640 		return MODE_CLOCK_LOW;
1641 
1642 	if (mode->hdisplay == 0 ||
1643 	    mode->hsync_start < mode->hdisplay ||
1644 	    mode->hsync_end < mode->hsync_start ||
1645 	    mode->htotal < mode->hsync_end)
1646 		return MODE_H_ILLEGAL;
1647 
1648 	if (mode->vdisplay == 0 ||
1649 	    mode->vsync_start < mode->vdisplay ||
1650 	    mode->vsync_end < mode->vsync_start ||
1651 	    mode->vtotal < mode->vsync_end)
1652 		return MODE_V_ILLEGAL;
1653 
1654 	return MODE_OK;
1655 }
1656 
1657 /**
1658  * drm_mode_validate_driver - make sure the mode is somewhat sane
1659  * @dev: drm device
1660  * @mode: mode to check
1661  *
1662  * First do basic validation on the mode, and then allow the driver
1663  * to check for device/driver specific limitations via the optional
1664  * &drm_mode_config_helper_funcs.mode_valid hook.
1665  *
1666  * Returns:
1667  * The mode status
1668  */
1669 enum drm_mode_status
1670 drm_mode_validate_driver(struct drm_device *dev,
1671 			const struct drm_display_mode *mode)
1672 {
1673 	enum drm_mode_status status;
1674 
1675 	status = drm_mode_validate_basic(mode);
1676 	if (status != MODE_OK)
1677 		return status;
1678 
1679 	if (dev->mode_config.funcs->mode_valid)
1680 		return dev->mode_config.funcs->mode_valid(dev, mode);
1681 	else
1682 		return MODE_OK;
1683 }
1684 EXPORT_SYMBOL(drm_mode_validate_driver);
1685 
1686 /**
1687  * drm_mode_validate_size - make sure modes adhere to size constraints
1688  * @mode: mode to check
1689  * @maxX: maximum width
1690  * @maxY: maximum height
1691  *
1692  * This function is a helper which can be used to validate modes against size
1693  * limitations of the DRM device/connector. If a mode is too big its status
1694  * member is updated with the appropriate validation failure code. The list
1695  * itself is not changed.
1696  *
1697  * Returns:
1698  * The mode status
1699  */
1700 enum drm_mode_status
1701 drm_mode_validate_size(const struct drm_display_mode *mode,
1702 		       int maxX, int maxY)
1703 {
1704 	if (maxX > 0 && mode->hdisplay > maxX)
1705 		return MODE_VIRTUAL_X;
1706 
1707 	if (maxY > 0 && mode->vdisplay > maxY)
1708 		return MODE_VIRTUAL_Y;
1709 
1710 	return MODE_OK;
1711 }
1712 EXPORT_SYMBOL(drm_mode_validate_size);
1713 
1714 /**
1715  * drm_mode_validate_ycbcr420 - add 'ycbcr420-only' modes only when allowed
1716  * @mode: mode to check
1717  * @connector: drm connector under action
1718  *
1719  * This function is a helper which can be used to filter out any YCBCR420
1720  * only mode, when the source doesn't support it.
1721  *
1722  * Returns:
1723  * The mode status
1724  */
1725 enum drm_mode_status
1726 drm_mode_validate_ycbcr420(const struct drm_display_mode *mode,
1727 			   struct drm_connector *connector)
1728 {
1729 	if (!connector->ycbcr_420_allowed &&
1730 	    drm_mode_is_420_only(&connector->display_info, mode))
1731 		return MODE_NO_420;
1732 
1733 	return MODE_OK;
1734 }
1735 EXPORT_SYMBOL(drm_mode_validate_ycbcr420);
1736 
1737 #define MODE_STATUS(status) [MODE_ ## status + 3] = #status
1738 
1739 static const char * const drm_mode_status_names[] = {
1740 	MODE_STATUS(OK),
1741 	MODE_STATUS(HSYNC),
1742 	MODE_STATUS(VSYNC),
1743 	MODE_STATUS(H_ILLEGAL),
1744 	MODE_STATUS(V_ILLEGAL),
1745 	MODE_STATUS(BAD_WIDTH),
1746 	MODE_STATUS(NOMODE),
1747 	MODE_STATUS(NO_INTERLACE),
1748 	MODE_STATUS(NO_DBLESCAN),
1749 	MODE_STATUS(NO_VSCAN),
1750 	MODE_STATUS(MEM),
1751 	MODE_STATUS(VIRTUAL_X),
1752 	MODE_STATUS(VIRTUAL_Y),
1753 	MODE_STATUS(MEM_VIRT),
1754 	MODE_STATUS(NOCLOCK),
1755 	MODE_STATUS(CLOCK_HIGH),
1756 	MODE_STATUS(CLOCK_LOW),
1757 	MODE_STATUS(CLOCK_RANGE),
1758 	MODE_STATUS(BAD_HVALUE),
1759 	MODE_STATUS(BAD_VVALUE),
1760 	MODE_STATUS(BAD_VSCAN),
1761 	MODE_STATUS(HSYNC_NARROW),
1762 	MODE_STATUS(HSYNC_WIDE),
1763 	MODE_STATUS(HBLANK_NARROW),
1764 	MODE_STATUS(HBLANK_WIDE),
1765 	MODE_STATUS(VSYNC_NARROW),
1766 	MODE_STATUS(VSYNC_WIDE),
1767 	MODE_STATUS(VBLANK_NARROW),
1768 	MODE_STATUS(VBLANK_WIDE),
1769 	MODE_STATUS(PANEL),
1770 	MODE_STATUS(INTERLACE_WIDTH),
1771 	MODE_STATUS(ONE_WIDTH),
1772 	MODE_STATUS(ONE_HEIGHT),
1773 	MODE_STATUS(ONE_SIZE),
1774 	MODE_STATUS(NO_REDUCED),
1775 	MODE_STATUS(NO_STEREO),
1776 	MODE_STATUS(NO_420),
1777 	MODE_STATUS(STALE),
1778 	MODE_STATUS(BAD),
1779 	MODE_STATUS(ERROR),
1780 };
1781 
1782 #undef MODE_STATUS
1783 
1784 const char *drm_get_mode_status_name(enum drm_mode_status status)
1785 {
1786 	int index = status + 3;
1787 
1788 	if (WARN_ON(index < 0 || index >= ARRAY_SIZE(drm_mode_status_names)))
1789 		return "";
1790 
1791 	return drm_mode_status_names[index];
1792 }
1793 
1794 /**
1795  * drm_mode_prune_invalid - remove invalid modes from mode list
1796  * @dev: DRM device
1797  * @mode_list: list of modes to check
1798  * @verbose: be verbose about it
1799  *
1800  * This helper function can be used to prune a display mode list after
1801  * validation has been completed. All modes whose status is not MODE_OK will be
1802  * removed from the list, and if @verbose the status code and mode name is also
1803  * printed to dmesg.
1804  */
1805 void drm_mode_prune_invalid(struct drm_device *dev,
1806 			    struct list_head *mode_list, bool verbose)
1807 {
1808 	struct drm_display_mode *mode, *t;
1809 
1810 	list_for_each_entry_safe(mode, t, mode_list, head) {
1811 		if (mode->status != MODE_OK) {
1812 			list_del(&mode->head);
1813 			if (mode->type & DRM_MODE_TYPE_USERDEF) {
1814 				drm_warn(dev, "User-defined mode not supported: "
1815 					 DRM_MODE_FMT "\n", DRM_MODE_ARG(mode));
1816 			}
1817 			if (verbose) {
1818 				drm_dbg_kms(dev, "Rejected mode: " DRM_MODE_FMT " (%s)\n",
1819 					    DRM_MODE_ARG(mode), drm_get_mode_status_name(mode->status));
1820 			}
1821 			drm_mode_destroy(dev, mode);
1822 		}
1823 	}
1824 }
1825 EXPORT_SYMBOL(drm_mode_prune_invalid);
1826 
1827 /**
1828  * drm_mode_compare - compare modes for favorability
1829  * @priv: unused
1830  * @lh_a: list_head for first mode
1831  * @lh_b: list_head for second mode
1832  *
1833  * Compare two modes, given by @lh_a and @lh_b, returning a value indicating
1834  * which is better.
1835  *
1836  * Returns:
1837  * Negative if @lh_a is better than @lh_b, zero if they're equivalent, or
1838  * positive if @lh_b is better than @lh_a.
1839  */
1840 static int drm_mode_compare(void *priv, const struct list_head *lh_a,
1841 			    const struct list_head *lh_b)
1842 {
1843 	struct drm_display_mode *a = list_entry(lh_a, struct drm_display_mode, head);
1844 	struct drm_display_mode *b = list_entry(lh_b, struct drm_display_mode, head);
1845 	int diff;
1846 
1847 	diff = ((b->type & DRM_MODE_TYPE_PREFERRED) != 0) -
1848 		((a->type & DRM_MODE_TYPE_PREFERRED) != 0);
1849 	if (diff)
1850 		return diff;
1851 	diff = b->hdisplay * b->vdisplay - a->hdisplay * a->vdisplay;
1852 	if (diff)
1853 		return diff;
1854 
1855 	diff = drm_mode_vrefresh(b) - drm_mode_vrefresh(a);
1856 	if (diff)
1857 		return diff;
1858 
1859 	diff = b->clock - a->clock;
1860 	return diff;
1861 }
1862 
1863 /**
1864  * drm_mode_sort - sort mode list
1865  * @mode_list: list of drm_display_mode structures to sort
1866  *
1867  * Sort @mode_list by favorability, moving good modes to the head of the list.
1868  */
1869 void drm_mode_sort(struct list_head *mode_list)
1870 {
1871 	list_sort(NULL, mode_list, drm_mode_compare);
1872 }
1873 EXPORT_SYMBOL(drm_mode_sort);
1874 
1875 /**
1876  * drm_connector_list_update - update the mode list for the connector
1877  * @connector: the connector to update
1878  *
1879  * This moves the modes from the @connector probed_modes list
1880  * to the actual mode list. It compares the probed mode against the current
1881  * list and only adds different/new modes.
1882  *
1883  * This is just a helper functions doesn't validate any modes itself and also
1884  * doesn't prune any invalid modes. Callers need to do that themselves.
1885  */
1886 void drm_connector_list_update(struct drm_connector *connector)
1887 {
1888 	struct drm_display_mode *pmode, *pt;
1889 
1890 	WARN_ON(!mutex_is_locked(&connector->dev->mode_config.mutex));
1891 
1892 	list_for_each_entry_safe(pmode, pt, &connector->probed_modes, head) {
1893 		struct drm_display_mode *mode;
1894 		bool found_it = false;
1895 
1896 		/* go through current modes checking for the new probed mode */
1897 		list_for_each_entry(mode, &connector->modes, head) {
1898 			if (!drm_mode_equal(pmode, mode))
1899 				continue;
1900 
1901 			found_it = true;
1902 
1903 			/*
1904 			 * If the old matching mode is stale (ie. left over
1905 			 * from a previous probe) just replace it outright.
1906 			 * Otherwise just merge the type bits between all
1907 			 * equal probed modes.
1908 			 *
1909 			 * If two probed modes are considered equal, pick the
1910 			 * actual timings from the one that's marked as
1911 			 * preferred (in case the match isn't 100%). If
1912 			 * multiple or zero preferred modes are present, favor
1913 			 * the mode added to the probed_modes list first.
1914 			 */
1915 			if (mode->status == MODE_STALE) {
1916 				drm_mode_copy(mode, pmode);
1917 			} else if ((mode->type & DRM_MODE_TYPE_PREFERRED) == 0 &&
1918 				   (pmode->type & DRM_MODE_TYPE_PREFERRED) != 0) {
1919 				pmode->type |= mode->type;
1920 				drm_mode_copy(mode, pmode);
1921 			} else {
1922 				mode->type |= pmode->type;
1923 			}
1924 
1925 			list_del(&pmode->head);
1926 			drm_mode_destroy(connector->dev, pmode);
1927 			break;
1928 		}
1929 
1930 		if (!found_it) {
1931 			list_move_tail(&pmode->head, &connector->modes);
1932 		}
1933 	}
1934 }
1935 EXPORT_SYMBOL(drm_connector_list_update);
1936 
1937 static int drm_mode_parse_cmdline_bpp(const char *str, char **end_ptr,
1938 				      struct drm_cmdline_mode *mode)
1939 {
1940 	unsigned int bpp;
1941 
1942 	if (str[0] != '-')
1943 		return -EINVAL;
1944 
1945 	str++;
1946 	bpp = simple_strtol(str, end_ptr, 10);
1947 	if (*end_ptr == str)
1948 		return -EINVAL;
1949 
1950 	mode->bpp = bpp;
1951 	mode->bpp_specified = true;
1952 
1953 	return 0;
1954 }
1955 
1956 static int drm_mode_parse_cmdline_refresh(const char *str, char **end_ptr,
1957 					  struct drm_cmdline_mode *mode)
1958 {
1959 	unsigned int refresh;
1960 
1961 	if (str[0] != '@')
1962 		return -EINVAL;
1963 
1964 	str++;
1965 	refresh = simple_strtol(str, end_ptr, 10);
1966 	if (*end_ptr == str)
1967 		return -EINVAL;
1968 
1969 	mode->refresh = refresh;
1970 	mode->refresh_specified = true;
1971 
1972 	return 0;
1973 }
1974 
1975 static int drm_mode_parse_cmdline_extra(const char *str, int length,
1976 					bool freestanding,
1977 					const struct drm_connector *connector,
1978 					struct drm_cmdline_mode *mode)
1979 {
1980 	int i;
1981 
1982 	for (i = 0; i < length; i++) {
1983 		switch (str[i]) {
1984 		case 'i':
1985 			if (freestanding)
1986 				return -EINVAL;
1987 
1988 			mode->interlace = true;
1989 			break;
1990 		case 'm':
1991 			if (freestanding)
1992 				return -EINVAL;
1993 
1994 			mode->margins = true;
1995 			break;
1996 		case 'D':
1997 			if (mode->force != DRM_FORCE_UNSPECIFIED)
1998 				return -EINVAL;
1999 
2000 			if ((connector->connector_type != DRM_MODE_CONNECTOR_DVII) &&
2001 			    (connector->connector_type != DRM_MODE_CONNECTOR_HDMIB))
2002 				mode->force = DRM_FORCE_ON;
2003 			else
2004 				mode->force = DRM_FORCE_ON_DIGITAL;
2005 			break;
2006 		case 'd':
2007 			if (mode->force != DRM_FORCE_UNSPECIFIED)
2008 				return -EINVAL;
2009 
2010 			mode->force = DRM_FORCE_OFF;
2011 			break;
2012 		case 'e':
2013 			if (mode->force != DRM_FORCE_UNSPECIFIED)
2014 				return -EINVAL;
2015 
2016 			mode->force = DRM_FORCE_ON;
2017 			break;
2018 		default:
2019 			return -EINVAL;
2020 		}
2021 	}
2022 
2023 	return 0;
2024 }
2025 
2026 static int drm_mode_parse_cmdline_res_mode(const char *str, unsigned int length,
2027 					   bool extras,
2028 					   const struct drm_connector *connector,
2029 					   struct drm_cmdline_mode *mode)
2030 {
2031 	const char *str_start = str;
2032 	bool rb = false, cvt = false;
2033 	int xres = 0, yres = 0;
2034 	int remaining, i;
2035 	char *end_ptr;
2036 
2037 	xres = simple_strtol(str, &end_ptr, 10);
2038 	if (end_ptr == str)
2039 		return -EINVAL;
2040 
2041 	if (end_ptr[0] != 'x')
2042 		return -EINVAL;
2043 	end_ptr++;
2044 
2045 	str = end_ptr;
2046 	yres = simple_strtol(str, &end_ptr, 10);
2047 	if (end_ptr == str)
2048 		return -EINVAL;
2049 
2050 	remaining = length - (end_ptr - str_start);
2051 	if (remaining < 0)
2052 		return -EINVAL;
2053 
2054 	for (i = 0; i < remaining; i++) {
2055 		switch (end_ptr[i]) {
2056 		case 'M':
2057 			cvt = true;
2058 			break;
2059 		case 'R':
2060 			rb = true;
2061 			break;
2062 		default:
2063 			/*
2064 			 * Try to pass that to our extras parsing
2065 			 * function to handle the case where the
2066 			 * extras are directly after the resolution
2067 			 */
2068 			if (extras) {
2069 				int ret = drm_mode_parse_cmdline_extra(end_ptr + i,
2070 								       1,
2071 								       false,
2072 								       connector,
2073 								       mode);
2074 				if (ret)
2075 					return ret;
2076 			} else {
2077 				return -EINVAL;
2078 			}
2079 		}
2080 	}
2081 
2082 	mode->xres = xres;
2083 	mode->yres = yres;
2084 	mode->cvt = cvt;
2085 	mode->rb = rb;
2086 
2087 	return 0;
2088 }
2089 
2090 static int drm_mode_parse_cmdline_int(const char *delim, unsigned int *int_ret)
2091 {
2092 	const char *value;
2093 	char *endp;
2094 
2095 	/*
2096 	 * delim must point to the '=', otherwise it is a syntax error and
2097 	 * if delim points to the terminating zero, then delim + 1 will point
2098 	 * past the end of the string.
2099 	 */
2100 	if (*delim != '=')
2101 		return -EINVAL;
2102 
2103 	value = delim + 1;
2104 	*int_ret = simple_strtol(value, &endp, 10);
2105 
2106 	/* Make sure we have parsed something */
2107 	if (endp == value)
2108 		return -EINVAL;
2109 
2110 	return 0;
2111 }
2112 
2113 static int drm_mode_parse_panel_orientation(const char *delim,
2114 					    struct drm_cmdline_mode *mode)
2115 {
2116 	const char *value;
2117 
2118 	if (*delim != '=')
2119 		return -EINVAL;
2120 
2121 	value = delim + 1;
2122 	delim = strchr(value, ',');
2123 	if (!delim)
2124 		delim = value + strlen(value);
2125 
2126 	if (!strncmp(value, "normal", delim - value))
2127 		mode->panel_orientation = DRM_MODE_PANEL_ORIENTATION_NORMAL;
2128 	else if (!strncmp(value, "upside_down", delim - value))
2129 		mode->panel_orientation = DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP;
2130 	else if (!strncmp(value, "left_side_up", delim - value))
2131 		mode->panel_orientation = DRM_MODE_PANEL_ORIENTATION_LEFT_UP;
2132 	else if (!strncmp(value, "right_side_up", delim - value))
2133 		mode->panel_orientation = DRM_MODE_PANEL_ORIENTATION_RIGHT_UP;
2134 	else
2135 		return -EINVAL;
2136 
2137 	return 0;
2138 }
2139 
2140 static int drm_mode_parse_tv_mode(const char *delim,
2141 				  struct drm_cmdline_mode *mode)
2142 {
2143 	const char *value;
2144 	int ret;
2145 
2146 	if (*delim != '=')
2147 		return -EINVAL;
2148 
2149 	value = delim + 1;
2150 	delim = strchr(value, ',');
2151 	if (!delim)
2152 		delim = value + strlen(value);
2153 
2154 	ret = drm_get_tv_mode_from_name(value, delim - value);
2155 	if (ret < 0)
2156 		return ret;
2157 
2158 	mode->tv_mode_specified = true;
2159 	mode->tv_mode = ret;
2160 
2161 	return 0;
2162 }
2163 
2164 static int drm_mode_parse_cmdline_options(const char *str,
2165 					  bool freestanding,
2166 					  const struct drm_connector *connector,
2167 					  struct drm_cmdline_mode *mode)
2168 {
2169 	unsigned int deg, margin, rotation = 0;
2170 	const char *delim, *option, *sep;
2171 
2172 	option = str;
2173 	do {
2174 		delim = strchr(option, '=');
2175 		if (!delim) {
2176 			delim = strchr(option, ',');
2177 
2178 			if (!delim)
2179 				delim = option + strlen(option);
2180 		}
2181 
2182 		if (!strncmp(option, "rotate", delim - option)) {
2183 			if (drm_mode_parse_cmdline_int(delim, &deg))
2184 				return -EINVAL;
2185 
2186 			switch (deg) {
2187 			case 0:
2188 				rotation |= DRM_MODE_ROTATE_0;
2189 				break;
2190 
2191 			case 90:
2192 				rotation |= DRM_MODE_ROTATE_90;
2193 				break;
2194 
2195 			case 180:
2196 				rotation |= DRM_MODE_ROTATE_180;
2197 				break;
2198 
2199 			case 270:
2200 				rotation |= DRM_MODE_ROTATE_270;
2201 				break;
2202 
2203 			default:
2204 				return -EINVAL;
2205 			}
2206 		} else if (!strncmp(option, "reflect_x", delim - option)) {
2207 			rotation |= DRM_MODE_REFLECT_X;
2208 		} else if (!strncmp(option, "reflect_y", delim - option)) {
2209 			rotation |= DRM_MODE_REFLECT_Y;
2210 		} else if (!strncmp(option, "margin_right", delim - option)) {
2211 			if (drm_mode_parse_cmdline_int(delim, &margin))
2212 				return -EINVAL;
2213 
2214 			mode->tv_margins.right = margin;
2215 		} else if (!strncmp(option, "margin_left", delim - option)) {
2216 			if (drm_mode_parse_cmdline_int(delim, &margin))
2217 				return -EINVAL;
2218 
2219 			mode->tv_margins.left = margin;
2220 		} else if (!strncmp(option, "margin_top", delim - option)) {
2221 			if (drm_mode_parse_cmdline_int(delim, &margin))
2222 				return -EINVAL;
2223 
2224 			mode->tv_margins.top = margin;
2225 		} else if (!strncmp(option, "margin_bottom", delim - option)) {
2226 			if (drm_mode_parse_cmdline_int(delim, &margin))
2227 				return -EINVAL;
2228 
2229 			mode->tv_margins.bottom = margin;
2230 		} else if (!strncmp(option, "panel_orientation", delim - option)) {
2231 			if (drm_mode_parse_panel_orientation(delim, mode))
2232 				return -EINVAL;
2233 		} else if (!strncmp(option, "tv_mode", delim - option)) {
2234 			if (drm_mode_parse_tv_mode(delim, mode))
2235 				return -EINVAL;
2236 		} else {
2237 			return -EINVAL;
2238 		}
2239 		sep = strchr(delim, ',');
2240 		option = sep + 1;
2241 	} while (sep);
2242 
2243 	if (rotation && freestanding)
2244 		return -EINVAL;
2245 
2246 	if (!(rotation & DRM_MODE_ROTATE_MASK))
2247 		rotation |= DRM_MODE_ROTATE_0;
2248 
2249 	/* Make sure there is exactly one rotation defined */
2250 	if (!is_power_of_2(rotation & DRM_MODE_ROTATE_MASK))
2251 		return -EINVAL;
2252 
2253 	mode->rotation_reflection = rotation;
2254 
2255 	return 0;
2256 }
2257 
2258 struct drm_named_mode {
2259 	const char *name;
2260 	unsigned int pixel_clock_khz;
2261 	unsigned int xres;
2262 	unsigned int yres;
2263 	unsigned int flags;
2264 	unsigned int tv_mode;
2265 };
2266 
2267 #define NAMED_MODE(_name, _pclk, _x, _y, _flags, _mode)	\
2268 	{						\
2269 		.name = _name,				\
2270 		.pixel_clock_khz = _pclk,		\
2271 		.xres = _x,				\
2272 		.yres = _y,				\
2273 		.flags = _flags,			\
2274 		.tv_mode = _mode,			\
2275 	}
2276 
2277 static const struct drm_named_mode drm_named_modes[] = {
2278 	NAMED_MODE("NTSC", 13500, 720, 480, DRM_MODE_FLAG_INTERLACE, DRM_MODE_TV_MODE_NTSC),
2279 	NAMED_MODE("NTSC-J", 13500, 720, 480, DRM_MODE_FLAG_INTERLACE, DRM_MODE_TV_MODE_NTSC_J),
2280 	NAMED_MODE("PAL", 13500, 720, 576, DRM_MODE_FLAG_INTERLACE, DRM_MODE_TV_MODE_PAL),
2281 	NAMED_MODE("PAL-M", 13500, 720, 480, DRM_MODE_FLAG_INTERLACE, DRM_MODE_TV_MODE_PAL_M),
2282 };
2283 
2284 static int drm_mode_parse_cmdline_named_mode(const char *name,
2285 					     unsigned int name_end,
2286 					     struct drm_cmdline_mode *cmdline_mode)
2287 {
2288 	unsigned int i;
2289 
2290 	if (!name_end)
2291 		return 0;
2292 
2293 	/* If the name starts with a digit, it's not a named mode */
2294 	if (isdigit(name[0]))
2295 		return 0;
2296 
2297 	/*
2298 	 * If there's an equal sign in the name, the command-line
2299 	 * contains only an option and no mode.
2300 	 */
2301 	if (strnchr(name, name_end, '='))
2302 		return 0;
2303 
2304 	/* The connection status extras can be set without a mode. */
2305 	if (name_end == 1 &&
2306 	    (name[0] == 'd' || name[0] == 'D' || name[0] == 'e'))
2307 		return 0;
2308 
2309 	/*
2310 	 * We're sure we're a named mode at this point, iterate over the
2311 	 * list of modes we're aware of.
2312 	 */
2313 	for (i = 0; i < ARRAY_SIZE(drm_named_modes); i++) {
2314 		const struct drm_named_mode *mode = &drm_named_modes[i];
2315 		int ret;
2316 
2317 		ret = str_has_prefix(name, mode->name);
2318 		if (ret != name_end)
2319 			continue;
2320 
2321 		strscpy(cmdline_mode->name, mode->name, sizeof(cmdline_mode->name));
2322 		cmdline_mode->pixel_clock = mode->pixel_clock_khz;
2323 		cmdline_mode->xres = mode->xres;
2324 		cmdline_mode->yres = mode->yres;
2325 		cmdline_mode->interlace = !!(mode->flags & DRM_MODE_FLAG_INTERLACE);
2326 		cmdline_mode->tv_mode = mode->tv_mode;
2327 		cmdline_mode->tv_mode_specified = true;
2328 		cmdline_mode->specified = true;
2329 
2330 		return 1;
2331 	}
2332 
2333 	return -EINVAL;
2334 }
2335 
2336 /**
2337  * drm_mode_parse_command_line_for_connector - parse command line modeline for connector
2338  * @mode_option: optional per connector mode option
2339  * @connector: connector to parse modeline for
2340  * @mode: preallocated drm_cmdline_mode structure to fill out
2341  *
2342  * This parses @mode_option command line modeline for modes and options to
2343  * configure the connector.
2344  *
2345  * This uses the same parameters as the fb modedb.c, except for an extra
2346  * force-enable, force-enable-digital and force-disable bit at the end::
2347  *
2348  *	<xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m][eDd]
2349  *
2350  * Additionals options can be provided following the mode, using a comma to
2351  * separate each option. Valid options can be found in
2352  * Documentation/fb/modedb.rst.
2353  *
2354  * The intermediate drm_cmdline_mode structure is required to store additional
2355  * options from the command line modline like the force-enable/disable flag.
2356  *
2357  * Returns:
2358  * True if a valid modeline has been parsed, false otherwise.
2359  */
2360 bool drm_mode_parse_command_line_for_connector(const char *mode_option,
2361 					       const struct drm_connector *connector,
2362 					       struct drm_cmdline_mode *mode)
2363 {
2364 	const char *name;
2365 	bool freestanding = false, parse_extras = false;
2366 	unsigned int bpp_off = 0, refresh_off = 0, options_off = 0;
2367 	unsigned int mode_end = 0;
2368 	const char *bpp_ptr = NULL, *refresh_ptr = NULL, *extra_ptr = NULL;
2369 	const char *options_ptr = NULL;
2370 	char *bpp_end_ptr = NULL, *refresh_end_ptr = NULL;
2371 	int len, ret;
2372 
2373 	memset(mode, 0, sizeof(*mode));
2374 	mode->panel_orientation = DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
2375 
2376 	if (!mode_option)
2377 		return false;
2378 
2379 	name = mode_option;
2380 
2381 	/* Locate the start of named options */
2382 	options_ptr = strchr(name, ',');
2383 	if (options_ptr)
2384 		options_off = options_ptr - name;
2385 	else
2386 		options_off = strlen(name);
2387 
2388 	/* Try to locate the bpp and refresh specifiers, if any */
2389 	bpp_ptr = strnchr(name, options_off, '-');
2390 	while (bpp_ptr && !isdigit(bpp_ptr[1]))
2391 		bpp_ptr = strnchr(bpp_ptr + 1, options_off, '-');
2392 	if (bpp_ptr)
2393 		bpp_off = bpp_ptr - name;
2394 
2395 	refresh_ptr = strnchr(name, options_off, '@');
2396 	if (refresh_ptr)
2397 		refresh_off = refresh_ptr - name;
2398 
2399 	/* Locate the end of the name / resolution, and parse it */
2400 	if (bpp_ptr) {
2401 		mode_end = bpp_off;
2402 	} else if (refresh_ptr) {
2403 		mode_end = refresh_off;
2404 	} else if (options_ptr) {
2405 		mode_end = options_off;
2406 		parse_extras = true;
2407 	} else {
2408 		mode_end = strlen(name);
2409 		parse_extras = true;
2410 	}
2411 
2412 	if (!mode_end)
2413 		return false;
2414 
2415 	ret = drm_mode_parse_cmdline_named_mode(name, mode_end, mode);
2416 	if (ret < 0)
2417 		return false;
2418 
2419 	/*
2420 	 * Having a mode that starts by a letter (and thus is named) and
2421 	 * an at-sign (used to specify a refresh rate) is disallowed.
2422 	 */
2423 	if (ret && refresh_ptr)
2424 		return false;
2425 
2426 	/* No named mode? Check for a normal mode argument, e.g. 1024x768 */
2427 	if (!mode->specified && isdigit(name[0])) {
2428 		ret = drm_mode_parse_cmdline_res_mode(name, mode_end,
2429 						      parse_extras,
2430 						      connector,
2431 						      mode);
2432 		if (ret)
2433 			return false;
2434 
2435 		mode->specified = true;
2436 	}
2437 
2438 	/* No mode? Check for freestanding extras and/or options */
2439 	if (!mode->specified) {
2440 		unsigned int len = strlen(mode_option);
2441 
2442 		if (bpp_ptr || refresh_ptr)
2443 			return false; /* syntax error */
2444 
2445 		if (len == 1 || (len >= 2 && mode_option[1] == ','))
2446 			extra_ptr = mode_option;
2447 		else
2448 			options_ptr = mode_option - 1;
2449 
2450 		freestanding = true;
2451 	}
2452 
2453 	if (bpp_ptr) {
2454 		ret = drm_mode_parse_cmdline_bpp(bpp_ptr, &bpp_end_ptr, mode);
2455 		if (ret)
2456 			return false;
2457 
2458 		mode->bpp_specified = true;
2459 	}
2460 
2461 	if (refresh_ptr) {
2462 		ret = drm_mode_parse_cmdline_refresh(refresh_ptr,
2463 						     &refresh_end_ptr, mode);
2464 		if (ret)
2465 			return false;
2466 
2467 		mode->refresh_specified = true;
2468 	}
2469 
2470 	/*
2471 	 * Locate the end of the bpp / refresh, and parse the extras
2472 	 * if relevant
2473 	 */
2474 	if (bpp_ptr && refresh_ptr)
2475 		extra_ptr = max(bpp_end_ptr, refresh_end_ptr);
2476 	else if (bpp_ptr)
2477 		extra_ptr = bpp_end_ptr;
2478 	else if (refresh_ptr)
2479 		extra_ptr = refresh_end_ptr;
2480 
2481 	if (extra_ptr) {
2482 		if (options_ptr)
2483 			len = options_ptr - extra_ptr;
2484 		else
2485 			len = strlen(extra_ptr);
2486 
2487 		ret = drm_mode_parse_cmdline_extra(extra_ptr, len, freestanding,
2488 						   connector, mode);
2489 		if (ret)
2490 			return false;
2491 	}
2492 
2493 	if (options_ptr) {
2494 		ret = drm_mode_parse_cmdline_options(options_ptr + 1,
2495 						     freestanding,
2496 						     connector, mode);
2497 		if (ret)
2498 			return false;
2499 	}
2500 
2501 	return true;
2502 }
2503 EXPORT_SYMBOL(drm_mode_parse_command_line_for_connector);
2504 
2505 static struct drm_display_mode *drm_named_mode(struct drm_device *dev,
2506 					       struct drm_cmdline_mode *cmd)
2507 {
2508 	unsigned int i;
2509 
2510 	for (i = 0; i < ARRAY_SIZE(drm_named_modes); i++) {
2511 		const struct drm_named_mode *named_mode = &drm_named_modes[i];
2512 
2513 		if (strcmp(cmd->name, named_mode->name))
2514 			continue;
2515 
2516 		if (!cmd->tv_mode_specified)
2517 			continue;
2518 
2519 		return drm_analog_tv_mode(dev,
2520 					  named_mode->tv_mode,
2521 					  named_mode->pixel_clock_khz * 1000,
2522 					  named_mode->xres,
2523 					  named_mode->yres,
2524 					  named_mode->flags & DRM_MODE_FLAG_INTERLACE);
2525 	}
2526 
2527 	return NULL;
2528 }
2529 
2530 /**
2531  * drm_mode_create_from_cmdline_mode - convert a command line modeline into a DRM display mode
2532  * @dev: DRM device to create the new mode for
2533  * @cmd: input command line modeline
2534  *
2535  * Returns:
2536  * Pointer to converted mode on success, NULL on error.
2537  */
2538 struct drm_display_mode *
2539 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
2540 				  struct drm_cmdline_mode *cmd)
2541 {
2542 	struct drm_display_mode *mode;
2543 
2544 	if (cmd->xres == 0 || cmd->yres == 0)
2545 		return NULL;
2546 
2547 	if (strlen(cmd->name))
2548 		mode = drm_named_mode(dev, cmd);
2549 	else if (cmd->cvt)
2550 		mode = drm_cvt_mode(dev,
2551 				    cmd->xres, cmd->yres,
2552 				    cmd->refresh_specified ? cmd->refresh : 60,
2553 				    cmd->rb, cmd->interlace,
2554 				    cmd->margins);
2555 	else
2556 		mode = drm_gtf_mode(dev,
2557 				    cmd->xres, cmd->yres,
2558 				    cmd->refresh_specified ? cmd->refresh : 60,
2559 				    cmd->interlace,
2560 				    cmd->margins);
2561 	if (!mode)
2562 		return NULL;
2563 
2564 	mode->type |= DRM_MODE_TYPE_USERDEF;
2565 	/* fix up 1368x768: GFT/CVT can't express 1366 width due to alignment */
2566 	if (cmd->xres == 1366)
2567 		drm_mode_fixup_1366x768(mode);
2568 	drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2569 	return mode;
2570 }
2571 EXPORT_SYMBOL(drm_mode_create_from_cmdline_mode);
2572 
2573 /**
2574  * drm_mode_convert_to_umode - convert a drm_display_mode into a modeinfo
2575  * @out: drm_mode_modeinfo struct to return to the user
2576  * @in: drm_display_mode to use
2577  *
2578  * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
2579  * the user.
2580  */
2581 void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
2582 			       const struct drm_display_mode *in)
2583 {
2584 	out->clock = in->clock;
2585 	out->hdisplay = in->hdisplay;
2586 	out->hsync_start = in->hsync_start;
2587 	out->hsync_end = in->hsync_end;
2588 	out->htotal = in->htotal;
2589 	out->hskew = in->hskew;
2590 	out->vdisplay = in->vdisplay;
2591 	out->vsync_start = in->vsync_start;
2592 	out->vsync_end = in->vsync_end;
2593 	out->vtotal = in->vtotal;
2594 	out->vscan = in->vscan;
2595 	out->vrefresh = drm_mode_vrefresh(in);
2596 	out->flags = in->flags;
2597 	out->type = in->type;
2598 
2599 	switch (in->picture_aspect_ratio) {
2600 	case HDMI_PICTURE_ASPECT_4_3:
2601 		out->flags |= DRM_MODE_FLAG_PIC_AR_4_3;
2602 		break;
2603 	case HDMI_PICTURE_ASPECT_16_9:
2604 		out->flags |= DRM_MODE_FLAG_PIC_AR_16_9;
2605 		break;
2606 	case HDMI_PICTURE_ASPECT_64_27:
2607 		out->flags |= DRM_MODE_FLAG_PIC_AR_64_27;
2608 		break;
2609 	case HDMI_PICTURE_ASPECT_256_135:
2610 		out->flags |= DRM_MODE_FLAG_PIC_AR_256_135;
2611 		break;
2612 	default:
2613 		WARN(1, "Invalid aspect ratio (0%x) on mode\n",
2614 		     in->picture_aspect_ratio);
2615 		fallthrough;
2616 	case HDMI_PICTURE_ASPECT_NONE:
2617 		out->flags |= DRM_MODE_FLAG_PIC_AR_NONE;
2618 		break;
2619 	}
2620 
2621 	strscpy_pad(out->name, in->name, sizeof(out->name));
2622 }
2623 
2624 /**
2625  * drm_mode_convert_umode - convert a modeinfo into a drm_display_mode
2626  * @dev: drm device
2627  * @out: drm_display_mode to return to the user
2628  * @in: drm_mode_modeinfo to use
2629  *
2630  * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
2631  * the caller.
2632  *
2633  * Returns:
2634  * Zero on success, negative errno on failure.
2635  */
2636 int drm_mode_convert_umode(struct drm_device *dev,
2637 			   struct drm_display_mode *out,
2638 			   const struct drm_mode_modeinfo *in)
2639 {
2640 	if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
2641 		return -ERANGE;
2642 
2643 	out->clock = in->clock;
2644 	out->hdisplay = in->hdisplay;
2645 	out->hsync_start = in->hsync_start;
2646 	out->hsync_end = in->hsync_end;
2647 	out->htotal = in->htotal;
2648 	out->hskew = in->hskew;
2649 	out->vdisplay = in->vdisplay;
2650 	out->vsync_start = in->vsync_start;
2651 	out->vsync_end = in->vsync_end;
2652 	out->vtotal = in->vtotal;
2653 	out->vscan = in->vscan;
2654 	out->flags = in->flags;
2655 	/*
2656 	 * Old xf86-video-vmware (possibly others too) used to
2657 	 * leave 'type' uninitialized. Just ignore any bits we
2658 	 * don't like. It's a just hint after all, and more
2659 	 * useful for the kernel->userspace direction anyway.
2660 	 */
2661 	out->type = in->type & DRM_MODE_TYPE_ALL;
2662 	strscpy_pad(out->name, in->name, sizeof(out->name));
2663 
2664 	/* Clearing picture aspect ratio bits from out flags,
2665 	 * as the aspect-ratio information is not stored in
2666 	 * flags for kernel-mode, but in picture_aspect_ratio.
2667 	 */
2668 	out->flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2669 
2670 	switch (in->flags & DRM_MODE_FLAG_PIC_AR_MASK) {
2671 	case DRM_MODE_FLAG_PIC_AR_4_3:
2672 		out->picture_aspect_ratio = HDMI_PICTURE_ASPECT_4_3;
2673 		break;
2674 	case DRM_MODE_FLAG_PIC_AR_16_9:
2675 		out->picture_aspect_ratio = HDMI_PICTURE_ASPECT_16_9;
2676 		break;
2677 	case DRM_MODE_FLAG_PIC_AR_64_27:
2678 		out->picture_aspect_ratio = HDMI_PICTURE_ASPECT_64_27;
2679 		break;
2680 	case DRM_MODE_FLAG_PIC_AR_256_135:
2681 		out->picture_aspect_ratio = HDMI_PICTURE_ASPECT_256_135;
2682 		break;
2683 	case DRM_MODE_FLAG_PIC_AR_NONE:
2684 		out->picture_aspect_ratio = HDMI_PICTURE_ASPECT_NONE;
2685 		break;
2686 	default:
2687 		return -EINVAL;
2688 	}
2689 
2690 	out->status = drm_mode_validate_driver(dev, out);
2691 	if (out->status != MODE_OK)
2692 		return -EINVAL;
2693 
2694 	drm_mode_set_crtcinfo(out, CRTC_INTERLACE_HALVE_V);
2695 
2696 	return 0;
2697 }
2698 
2699 /**
2700  * drm_mode_is_420_only - if a given videomode can be only supported in YCBCR420
2701  * output format
2702  *
2703  * @display: display under action
2704  * @mode: video mode to be tested.
2705  *
2706  * Returns:
2707  * true if the mode can be supported in YCBCR420 format
2708  * false if not.
2709  */
2710 bool drm_mode_is_420_only(const struct drm_display_info *display,
2711 			  const struct drm_display_mode *mode)
2712 {
2713 	u8 vic = drm_match_cea_mode(mode);
2714 
2715 	return test_bit(vic, display->hdmi.y420_vdb_modes);
2716 }
2717 EXPORT_SYMBOL(drm_mode_is_420_only);
2718 
2719 /**
2720  * drm_mode_is_420_also - if a given videomode can be supported in YCBCR420
2721  * output format also (along with RGB/YCBCR444/422)
2722  *
2723  * @display: display under action.
2724  * @mode: video mode to be tested.
2725  *
2726  * Returns:
2727  * true if the mode can be support YCBCR420 format
2728  * false if not.
2729  */
2730 bool drm_mode_is_420_also(const struct drm_display_info *display,
2731 			  const struct drm_display_mode *mode)
2732 {
2733 	u8 vic = drm_match_cea_mode(mode);
2734 
2735 	return test_bit(vic, display->hdmi.y420_cmdb_modes);
2736 }
2737 EXPORT_SYMBOL(drm_mode_is_420_also);
2738 /**
2739  * drm_mode_is_420 - if a given videomode can be supported in YCBCR420
2740  * output format
2741  *
2742  * @display: display under action.
2743  * @mode: video mode to be tested.
2744  *
2745  * Returns:
2746  * true if the mode can be supported in YCBCR420 format
2747  * false if not.
2748  */
2749 bool drm_mode_is_420(const struct drm_display_info *display,
2750 		     const struct drm_display_mode *mode)
2751 {
2752 	return drm_mode_is_420_only(display, mode) ||
2753 		drm_mode_is_420_also(display, mode);
2754 }
2755 EXPORT_SYMBOL(drm_mode_is_420);
2756 
2757 /**
2758  * drm_set_preferred_mode - Sets the preferred mode of a connector
2759  * @connector: connector whose mode list should be processed
2760  * @hpref: horizontal resolution of preferred mode
2761  * @vpref: vertical resolution of preferred mode
2762  *
2763  * Marks a mode as preferred if it matches the resolution specified by @hpref
2764  * and @vpref.
2765  */
2766 void drm_set_preferred_mode(struct drm_connector *connector,
2767 			    int hpref, int vpref)
2768 {
2769 	struct drm_display_mode *mode;
2770 
2771 	list_for_each_entry(mode, &connector->probed_modes, head) {
2772 		if (mode->hdisplay == hpref &&
2773 		    mode->vdisplay == vpref)
2774 			mode->type |= DRM_MODE_TYPE_PREFERRED;
2775 	}
2776 }
2777 EXPORT_SYMBOL(drm_set_preferred_mode);
2778