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