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