drivers/gpu/drm/drm_modes.c

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