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/list.h>
  34 #include <linux/list_sort.h>
  35 #include <linux/export.h>
  36 #include <drm/drmP.h>
  37 #include <drm/drm_crtc.h>
  38 #include <video/of_videomode.h>
  39 #include <video/videomode.h>
  40 #include <drm/drm_modes.h>
  41
  42 #include "drm_crtc_internal.h"
  43
  44 /**
  45  * drm_mode_debug_printmodeline - print a mode to dmesg
  46  * @mode: mode to print
  47  *
  48  * Describe @mode using DRM_DEBUG.
  49  */
  50 void drm_mode_debug_printmodeline(const struct drm_display_mode *mode)
  51 {
  52         DRM_DEBUG_KMS("Modeline " DRM_MODE_FMT "\n", DRM_MODE_ARG(mode));
  53 }
  54 EXPORT_SYMBOL(drm_mode_debug_printmodeline);
  55
  56 /**
  57  * drm_mode_create - create a new display mode
  58  * @dev: DRM device
  59  *
  60  * Create a new, cleared drm_display_mode with kzalloc, allocate an ID for it
  61  * and return it.
  62  *
  63  * Returns:
  64  * Pointer to new mode on success, NULL on error.
  65  */
  66 struct drm_display_mode *drm_mode_create(struct drm_device *dev)
  67 {
  68         struct drm_display_mode *nmode;
  69
  70         nmode = kzalloc(sizeof(struct drm_display_mode), GFP_KERNEL);
  71         if (!nmode)
  72                 return NULL;
  73
  74         if (drm_mode_object_get(dev, &nmode->base, DRM_MODE_OBJECT_MODE)) {
  75                 kfree(nmode);
  76                 return NULL;
  77         }
  78
  79         return nmode;
  80 }
  81 EXPORT_SYMBOL(drm_mode_create);
  82
  83 /**
  84  * drm_mode_destroy - remove a mode
  85  * @dev: DRM device
  86  * @mode: mode to remove
  87  *
  88  * Release @mode's unique ID, then free it @mode structure itself using kfree.
  89  */
  90 void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode)
  91 {
  92         if (!mode)
  93                 return;
  94
  95         drm_mode_object_unregister(dev, &mode->base);
  96
  97         kfree(mode);
  98 }
  99 EXPORT_SYMBOL(drm_mode_destroy);
 100
 101 /**
 102  * drm_mode_probed_add - add a mode to a connector's probed_mode list
 103  * @connector: connector the new mode
 104  * @mode: mode data
 105  *
 106  * Add @mode to @connector's probed_mode list for later use. This list should
 107  * then in a second step get filtered and all the modes actually supported by
 108  * the hardware moved to the @connector's modes list.
 109  */
 110 void drm_mode_probed_add(struct drm_connector *connector,
 111                          struct drm_display_mode *mode)
 112 {
 113         WARN_ON(!mutex_is_locked(&connector->dev->mode_config.mutex));
 114
 115         list_add_tail(&mode->head, &connector->probed_modes);
 116 }
 117 EXPORT_SYMBOL(drm_mode_probed_add);
 118
 119 /**
 120  * drm_cvt_mode -create a modeline based on the CVT algorithm
 121  * @dev: drm device
 122  * @hdisplay: hdisplay size
 123  * @vdisplay: vdisplay size
 124  * @vrefresh: vrefresh rate
 125  * @reduced: whether to use reduced blanking
 126  * @interlaced: whether to compute an interlaced mode
 127  * @margins: whether to add margins (borders)
 128  *
 129  * This function is called to generate the modeline based on CVT algorithm
 130  * according to the hdisplay, vdisplay, vrefresh.
 131  * It is based from the VESA(TM) Coordinated Video Timing Generator by
 132  * Graham Loveridge April 9, 2003 available at
 133  * http://www.elo.utfsm.cl/~elo212/docs/CVTd6r1.xls
 134  *
 135  * And it is copied from xf86CVTmode in xserver/hw/xfree86/modes/xf86cvt.c.
 136  * What I have done is to translate it by using integer calculation.
 137  *
 138  * Returns:
 139  * The modeline based on the CVT algorithm stored in a drm_display_mode object.
 140  * The display mode object is allocated with drm_mode_create(). Returns NULL
 141  * when no mode could be allocated.
 142  */
 143 struct drm_display_mode *drm_cvt_mode(struct drm_device *dev, int hdisplay,
 144                                       int vdisplay, int vrefresh,
 145                                       bool reduced, bool interlaced, bool margins)
 146 {
 147 #define HV_FACTOR                       1000
 148         /* 1) top/bottom margin size (% of height) - default: 1.8, */
 149 #define CVT_MARGIN_PERCENTAGE           18
 150         /* 2) character cell horizontal granularity (pixels) - default 8 */
 151 #define CVT_H_GRANULARITY               8
 152         /* 3) Minimum vertical porch (lines) - default 3 */
 153 #define CVT_MIN_V_PORCH                 3
 154         /* 4) Minimum number of vertical back porch lines - default 6 */
 155 #define CVT_MIN_V_BPORCH                6
 156         /* Pixel Clock step (kHz) */
 157 #define CVT_CLOCK_STEP                  250
 158         struct drm_display_mode *drm_mode;
 159         unsigned int vfieldrate, hperiod;
 160         int hdisplay_rnd, hmargin, vdisplay_rnd, vmargin, vsync;
 161         int interlace;
 162         u64 tmp;
 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         drm_mode = drm_mode_create(dev);
 399         if (!drm_mode)
 400                 return NULL;
 401
 402         /* 1. In order to give correct results, the number of horizontal
 403          * pixels requested is first processed to ensure that it is divisible
 404          * by the character size, by rounding it to the nearest character
 405          * cell boundary:
 406          */
 407         hdisplay_rnd = (hdisplay + GTF_CELL_GRAN / 2) / GTF_CELL_GRAN;
 408         hdisplay_rnd = hdisplay_rnd * GTF_CELL_GRAN;
 409
 410         /* 2. If interlace is requested, the number of vertical lines assumed
 411          * by the calculation must be halved, as the computation calculates
 412          * the number of vertical lines per field.
 413          */
 414         if (interlaced)
 415                 vdisplay_rnd = vdisplay / 2;
 416         else
 417                 vdisplay_rnd = vdisplay;
 418
 419         /* 3. Find the frame rate required: */
 420         if (interlaced)
 421                 vfieldrate_rqd = vrefresh * 2;
 422         else
 423                 vfieldrate_rqd = vrefresh;
 424
 425         /* 4. Find number of lines in Top margin: */
 426         top_margin = 0;
 427         if (margins)
 428                 top_margin = (vdisplay_rnd * GTF_MARGIN_PERCENTAGE + 500) /
 429                                 1000;
 430         /* 5. Find number of lines in bottom margin: */
 431         bottom_margin = top_margin;
 432
 433         /* 6. If interlace is required, then set variable interlace: */
 434         if (interlaced)
 435                 interlace = 1;
 436         else
 437                 interlace = 0;
 438
 439         /* 7. Estimate the Horizontal frequency */
 440         {
 441                 tmp1 = (1000000  - MIN_VSYNC_PLUS_BP * vfieldrate_rqd) / 500;
 442                 tmp2 = (vdisplay_rnd + 2 * top_margin + GTF_MIN_V_PORCH) *
 443                                 2 + interlace;
 444                 hfreq_est = (tmp2 * 1000 * vfieldrate_rqd) / tmp1;
 445         }
 446
 447         /* 8. Find the number of lines in V sync + back porch */
 448         /* [V SYNC+BP] = RINT(([MIN VSYNC+BP] * hfreq_est / 1000000)) */
 449         vsync_plus_bp = MIN_VSYNC_PLUS_BP * hfreq_est / 1000;
 450         vsync_plus_bp = (vsync_plus_bp + 500) / 1000;
 451         /*  9. Find the number of lines in V back porch alone: */
 452         vback_porch = vsync_plus_bp - V_SYNC_RQD;
 453         /*  10. Find the total number of lines in Vertical field period: */
 454         vtotal_lines = vdisplay_rnd + top_margin + bottom_margin +
 455                         vsync_plus_bp + GTF_MIN_V_PORCH;
 456         /*  11. Estimate the Vertical field frequency: */
 457         vfieldrate_est = hfreq_est / vtotal_lines;
 458         /*  12. Find the actual horizontal period: */
 459         hperiod = 1000000 / (vfieldrate_rqd * vtotal_lines);
 460
 461         /*  13. Find the actual Vertical field frequency: */
 462         vfield_rate = hfreq_est / vtotal_lines;
 463         /*  14. Find the Vertical frame frequency: */
 464         if (interlaced)
 465                 vframe_rate = vfield_rate / 2;
 466         else
 467                 vframe_rate = vfield_rate;
 468         /*  15. Find number of pixels in left margin: */
 469         if (margins)
 470                 left_margin = (hdisplay_rnd * GTF_MARGIN_PERCENTAGE + 500) /
 471                                 1000;
 472         else
 473                 left_margin = 0;
 474
 475         /* 16.Find number of pixels in right margin: */
 476         right_margin = left_margin;
 477         /* 17.Find total number of active pixels in image and left and right */
 478         total_active_pixels = hdisplay_rnd + left_margin + right_margin;
 479         /* 18.Find the ideal blanking duty cycle from blanking duty cycle */
 480         ideal_duty_cycle = GTF_C_PRIME * 1000 -
 481                                 (GTF_M_PRIME * 1000000 / hfreq_est);
 482         /* 19.Find the number of pixels in the blanking time to the nearest
 483          * double character cell: */
 484         hblank = total_active_pixels * ideal_duty_cycle /
 485                         (100000 - ideal_duty_cycle);
 486         hblank = (hblank + GTF_CELL_GRAN) / (2 * GTF_CELL_GRAN);
 487         hblank = hblank * 2 * GTF_CELL_GRAN;
 488         /* 20.Find total number of pixels: */
 489         total_pixels = total_active_pixels + hblank;
 490         /* 21.Find pixel clock frequency: */
 491         pixel_freq = total_pixels * hfreq_est / 1000;
 492         /* Stage 1 computations are now complete; I should really pass
 493          * the results to another function and do the Stage 2 computations,
 494          * but I only need a few more values so I'll just append the
 495          * computations here for now */
 496         /* 17. Find the number of pixels in the horizontal sync period: */
 497         hsync = H_SYNC_PERCENT * total_pixels / 100;
 498         hsync = (hsync + GTF_CELL_GRAN / 2) / GTF_CELL_GRAN;
 499         hsync = hsync * GTF_CELL_GRAN;
 500         /* 18. Find the number of pixels in horizontal front porch period */
 501         hfront_porch = hblank / 2 - hsync;
 502         /*  36. Find the number of lines in the odd front porch period: */
 503         vodd_front_porch_lines = GTF_MIN_V_PORCH ;
 504
 505         /* finally, pack the results in the mode struct */
 506         drm_mode->hdisplay = hdisplay_rnd;
 507         drm_mode->hsync_start = hdisplay_rnd + hfront_porch;
 508         drm_mode->hsync_end = drm_mode->hsync_start + hsync;
 509         drm_mode->htotal = total_pixels;
 510         drm_mode->vdisplay = vdisplay_rnd;
 511         drm_mode->vsync_start = vdisplay_rnd + vodd_front_porch_lines;
 512         drm_mode->vsync_end = drm_mode->vsync_start + V_SYNC_RQD;
 513         drm_mode->vtotal = vtotal_lines;
 514
 515         drm_mode->clock = pixel_freq;
 516
 517         if (interlaced) {
 518                 drm_mode->vtotal *= 2;
 519                 drm_mode->flags |= DRM_MODE_FLAG_INTERLACE;
 520         }
 521
 522         drm_mode_set_name(drm_mode);
 523         if (GTF_M == 600 && GTF_2C == 80 && GTF_K == 128 && GTF_2J == 40)
 524                 drm_mode->flags = DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC;
 525         else
 526                 drm_mode->flags = DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_NVSYNC;
 527
 528         return drm_mode;
 529 }
 530 EXPORT_SYMBOL(drm_gtf_mode_complex);
 531
 532 /**
 533  * drm_gtf_mode - create the modeline based on the GTF algorithm
 534  * @dev: drm device
 535  * @hdisplay: hdisplay size
 536  * @vdisplay: vdisplay size
 537  * @vrefresh: vrefresh rate.
 538  * @interlaced: whether to compute an interlaced mode
 539  * @margins: desired margin (borders) size
 540  *
 541  * return the modeline based on GTF algorithm
 542  *
 543  * This function is to create the modeline based on the GTF algorithm.
 544  * Generalized Timing Formula is derived from:
 545  *
 546  *      GTF Spreadsheet by Andy Morrish (1/5/97)
 547  *      available at http://www.vesa.org
 548  *
 549  * And it is copied from the file of xserver/hw/xfree86/modes/xf86gtf.c.
 550  * What I have done is to translate it by using integer calculation.
 551  * I also refer to the function of fb_get_mode in the file of
 552  * drivers/video/fbmon.c
 553  *
 554  * Standard GTF parameters::
 555  *
 556  *     M = 600
 557  *     C = 40
 558  *     K = 128
 559  *     J = 20
 560  *
 561  * Returns:
 562  * The modeline based on the GTF algorithm stored in a drm_display_mode object.
 563  * The display mode object is allocated with drm_mode_create(). Returns NULL
 564  * when no mode could be allocated.
 565  */
 566 struct drm_display_mode *
 567 drm_gtf_mode(struct drm_device *dev, int hdisplay, int vdisplay, int vrefresh,
 568              bool interlaced, int margins)
 569 {
 570         return drm_gtf_mode_complex(dev, hdisplay, vdisplay, vrefresh,
 571                                     interlaced, margins,
 572                                     600, 40 * 2, 128, 20 * 2);
 573 }
 574 EXPORT_SYMBOL(drm_gtf_mode);
 575
 576 #ifdef CONFIG_VIDEOMODE_HELPERS
 577 /**
 578  * drm_display_mode_from_videomode - fill in @dmode using @vm,
 579  * @vm: videomode structure to use as source
 580  * @dmode: drm_display_mode structure to use as destination
 581  *
 582  * Fills out @dmode using the display mode specified in @vm.
 583  */
 584 void drm_display_mode_from_videomode(const struct videomode *vm,
 585                                      struct drm_display_mode *dmode)
 586 {
 587         dmode->hdisplay = vm->hactive;
 588         dmode->hsync_start = dmode->hdisplay + vm->hfront_porch;
 589         dmode->hsync_end = dmode->hsync_start + vm->hsync_len;
 590         dmode->htotal = dmode->hsync_end + vm->hback_porch;
 591
 592         dmode->vdisplay = vm->vactive;
 593         dmode->vsync_start = dmode->vdisplay + vm->vfront_porch;
 594         dmode->vsync_end = dmode->vsync_start + vm->vsync_len;
 595         dmode->vtotal = dmode->vsync_end + vm->vback_porch;
 596
 597         dmode->clock = vm->pixelclock / 1000;
 598
 599         dmode->flags = 0;
 600         if (vm->flags & DISPLAY_FLAGS_HSYNC_HIGH)
 601                 dmode->flags |= DRM_MODE_FLAG_PHSYNC;
 602         else if (vm->flags & DISPLAY_FLAGS_HSYNC_LOW)
 603                 dmode->flags |= DRM_MODE_FLAG_NHSYNC;
 604         if (vm->flags & DISPLAY_FLAGS_VSYNC_HIGH)
 605                 dmode->flags |= DRM_MODE_FLAG_PVSYNC;
 606         else if (vm->flags & DISPLAY_FLAGS_VSYNC_LOW)
 607                 dmode->flags |= DRM_MODE_FLAG_NVSYNC;
 608         if (vm->flags & DISPLAY_FLAGS_INTERLACED)
 609                 dmode->flags |= DRM_MODE_FLAG_INTERLACE;
 610         if (vm->flags & DISPLAY_FLAGS_DOUBLESCAN)
 611                 dmode->flags |= DRM_MODE_FLAG_DBLSCAN;
 612         if (vm->flags & DISPLAY_FLAGS_DOUBLECLK)
 613                 dmode->flags |= DRM_MODE_FLAG_DBLCLK;
 614         drm_mode_set_name(dmode);
 615 }
 616 EXPORT_SYMBOL_GPL(drm_display_mode_from_videomode);
 617
 618 /**
 619  * drm_display_mode_to_videomode - fill in @vm using @dmode,
 620  * @dmode: drm_display_mode structure to use as source
 621  * @vm: videomode structure to use as destination
 622  *
 623  * Fills out @vm using the display mode specified in @dmode.
 624  */
 625 void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
 626                                    struct videomode *vm)
 627 {
 628         vm->hactive = dmode->hdisplay;
 629         vm->hfront_porch = dmode->hsync_start - dmode->hdisplay;
 630         vm->hsync_len = dmode->hsync_end - dmode->hsync_start;
 631         vm->hback_porch = dmode->htotal - dmode->hsync_end;
 632
 633         vm->vactive = dmode->vdisplay;
 634         vm->vfront_porch = dmode->vsync_start - dmode->vdisplay;
 635         vm->vsync_len = dmode->vsync_end - dmode->vsync_start;
 636         vm->vback_porch = dmode->vtotal - dmode->vsync_end;
 637
 638         vm->pixelclock = dmode->clock * 1000;
 639
 640         vm->flags = 0;
 641         if (dmode->flags & DRM_MODE_FLAG_PHSYNC)
 642                 vm->flags |= DISPLAY_FLAGS_HSYNC_HIGH;
 643         else if (dmode->flags & DRM_MODE_FLAG_NHSYNC)
 644                 vm->flags |= DISPLAY_FLAGS_HSYNC_LOW;
 645         if (dmode->flags & DRM_MODE_FLAG_PVSYNC)
 646                 vm->flags |= DISPLAY_FLAGS_VSYNC_HIGH;
 647         else if (dmode->flags & DRM_MODE_FLAG_NVSYNC)
 648                 vm->flags |= DISPLAY_FLAGS_VSYNC_LOW;
 649         if (dmode->flags & DRM_MODE_FLAG_INTERLACE)
 650                 vm->flags |= DISPLAY_FLAGS_INTERLACED;
 651         if (dmode->flags & DRM_MODE_FLAG_DBLSCAN)
 652                 vm->flags |= DISPLAY_FLAGS_DOUBLESCAN;
 653         if (dmode->flags & DRM_MODE_FLAG_DBLCLK)
 654                 vm->flags |= DISPLAY_FLAGS_DOUBLECLK;
 655 }
 656 EXPORT_SYMBOL_GPL(drm_display_mode_to_videomode);
 657
 658 /**
 659  * drm_bus_flags_from_videomode - extract information about pixelclk and
 660  * DE polarity from videomode and store it in a separate variable
 661  * @vm: videomode structure to use
 662  * @bus_flags: information about pixelclk and DE polarity will be stored here
 663  *
 664  * Sets DRM_BUS_FLAG_DE_(LOW|HIGH) and DRM_BUS_FLAG_PIXDATA_(POS|NEG)EDGE
 665  * in @bus_flags according to DISPLAY_FLAGS found in @vm
 666  */
 667 void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags)
 668 {
 669         *bus_flags = 0;
 670         if (vm->flags & DISPLAY_FLAGS_PIXDATA_POSEDGE)
 671                 *bus_flags |= DRM_BUS_FLAG_PIXDATA_POSEDGE;
 672         if (vm->flags & DISPLAY_FLAGS_PIXDATA_NEGEDGE)
 673                 *bus_flags |= DRM_BUS_FLAG_PIXDATA_NEGEDGE;
 674
 675         if (vm->flags & DISPLAY_FLAGS_DE_LOW)
 676                 *bus_flags |= DRM_BUS_FLAG_DE_LOW;
 677         if (vm->flags & DISPLAY_FLAGS_DE_HIGH)
 678                 *bus_flags |= DRM_BUS_FLAG_DE_HIGH;
 679 }
 680 EXPORT_SYMBOL_GPL(drm_bus_flags_from_videomode);
 681
 682 #ifdef CONFIG_OF
 683 /**
 684  * of_get_drm_display_mode - get a drm_display_mode from devicetree
 685  * @np: device_node with the timing specification
 686  * @dmode: will be set to the return value
 687  * @bus_flags: information about pixelclk and DE polarity
 688  * @index: index into the list of display timings in devicetree
 689  *
 690  * This function is expensive and should only be used, if only one mode is to be
 691  * read from DT. To get multiple modes start with of_get_display_timings and
 692  * work with that instead.
 693  *
 694  * Returns:
 695  * 0 on success, a negative errno code when no of videomode node was found.
 696  */
 697 int of_get_drm_display_mode(struct device_node *np,
 698                             struct drm_display_mode *dmode, u32 *bus_flags,
 699                             int index)
 700 {
 701         struct videomode vm;
 702         int ret;
 703
 704         ret = of_get_videomode(np, &vm, index);
 705         if (ret)
 706                 return ret;
 707
 708         drm_display_mode_from_videomode(&vm, dmode);
 709         if (bus_flags)
 710                 drm_bus_flags_from_videomode(&vm, bus_flags);
 711
 712         pr_debug("%s: got %dx%d display mode from %s\n",
 713                 of_node_full_name(np), vm.hactive, vm.vactive, np->name);
 714         drm_mode_debug_printmodeline(dmode);
 715
 716         return 0;
 717 }
 718 EXPORT_SYMBOL_GPL(of_get_drm_display_mode);
 719 #endif /* CONFIG_OF */
 720 #endif /* CONFIG_VIDEOMODE_HELPERS */
 721
 722 /**
 723  * drm_mode_set_name - set the name on a mode
 724  * @mode: name will be set in this mode
 725  *
 726  * Set the name of @mode to a standard format which is <hdisplay>x<vdisplay>
 727  * with an optional 'i' suffix for interlaced modes.
 728  */
 729 void drm_mode_set_name(struct drm_display_mode *mode)
 730 {
 731         bool interlaced = !!(mode->flags & DRM_MODE_FLAG_INTERLACE);
 732
 733         snprintf(mode->name, DRM_DISPLAY_MODE_LEN, "%dx%d%s",
 734                  mode->hdisplay, mode->vdisplay,
 735                  interlaced ? "i" : "");
 736 }
 737 EXPORT_SYMBOL(drm_mode_set_name);
 738
 739 /**
 740  * drm_mode_hsync - get the hsync of a mode
 741  * @mode: mode
 742  *
 743  * Returns:
 744  * @modes's hsync rate in kHz, rounded to the nearest integer. Calculates the
 745  * value first if it is not yet set.
 746  */
 747 int drm_mode_hsync(const struct drm_display_mode *mode)
 748 {
 749         unsigned int calc_val;
 750
 751         if (mode->hsync)
 752                 return mode->hsync;
 753
 754         if (mode->htotal < 0)
 755                 return 0;
 756
 757         calc_val = (mode->clock * 1000) / mode->htotal; /* hsync in Hz */
 758         calc_val += 500;                                /* round to 1000Hz */
 759         calc_val /= 1000;                               /* truncate to kHz */
 760
 761         return calc_val;
 762 }
 763 EXPORT_SYMBOL(drm_mode_hsync);
 764
 765 /**
 766  * drm_mode_vrefresh - get the vrefresh of a mode
 767  * @mode: mode
 768  *
 769  * Returns:
 770  * @modes's vrefresh rate in Hz, rounded to the nearest integer. Calculates the
 771  * value first if it is not yet set.
 772  */
 773 int drm_mode_vrefresh(const struct drm_display_mode *mode)
 774 {
 775         int refresh = 0;
 776         unsigned int calc_val;
 777
 778         if (mode->vrefresh > 0)
 779                 refresh = mode->vrefresh;
 780         else if (mode->htotal > 0 && mode->vtotal > 0) {
 781                 int vtotal;
 782                 vtotal = mode->vtotal;
 783                 /* work out vrefresh the value will be x1000 */
 784                 calc_val = (mode->clock * 1000);
 785                 calc_val /= mode->htotal;
 786                 refresh = (calc_val + vtotal / 2) / vtotal;
 787
 788                 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
 789                         refresh *= 2;
 790                 if (mode->flags & DRM_MODE_FLAG_DBLSCAN)
 791                         refresh /= 2;
 792                 if (mode->vscan > 1)
 793                         refresh /= mode->vscan;
 794         }
 795         return refresh;
 796 }
 797 EXPORT_SYMBOL(drm_mode_vrefresh);
 798
 799 /**
 800  * drm_mode_get_hv_timing - Fetches hdisplay/vdisplay for given mode
 801  * @mode: mode to query
 802  * @hdisplay: hdisplay value to fill in
 803  * @vdisplay: vdisplay value to fill in
 804  *
 805  * The vdisplay value will be doubled if the specified mode is a stereo mode of
 806  * the appropriate layout.
 807  */
 808 void drm_mode_get_hv_timing(const struct drm_display_mode *mode,
 809                             int *hdisplay, int *vdisplay)
 810 {
 811         struct drm_display_mode adjusted = *mode;
 812
 813         drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
 814         *hdisplay = adjusted.crtc_hdisplay;
 815         *vdisplay = adjusted.crtc_vdisplay;
 816 }
 817 EXPORT_SYMBOL(drm_mode_get_hv_timing);
 818
 819 /**
 820  * drm_mode_set_crtcinfo - set CRTC modesetting timing parameters
 821  * @p: mode
 822  * @adjust_flags: a combination of adjustment flags
 823  *
 824  * Setup the CRTC modesetting timing parameters for @p, adjusting if necessary.
 825  *
 826  * - The CRTC_INTERLACE_HALVE_V flag can be used to halve vertical timings of
 827  *   interlaced modes.
 828  * - The CRTC_STEREO_DOUBLE flag can be used to compute the timings for
 829  *   buffers containing two eyes (only adjust the timings when needed, eg. for
 830  *   "frame packing" or "side by side full").
 831  * - The CRTC_NO_DBLSCAN and CRTC_NO_VSCAN flags request that adjustment *not*
 832  *   be performed for doublescan and vscan > 1 modes respectively.
 833  */
 834 void drm_mode_set_crtcinfo(struct drm_display_mode *p, int adjust_flags)
 835 {
 836         if ((p == NULL) || ((p->type & DRM_MODE_TYPE_CRTC_C) == DRM_MODE_TYPE_BUILTIN))
 837                 return;
 838
 839         p->crtc_clock = p->clock;
 840         p->crtc_hdisplay = p->hdisplay;
 841         p->crtc_hsync_start = p->hsync_start;
 842         p->crtc_hsync_end = p->hsync_end;
 843         p->crtc_htotal = p->htotal;
 844         p->crtc_hskew = p->hskew;
 845         p->crtc_vdisplay = p->vdisplay;
 846         p->crtc_vsync_start = p->vsync_start;
 847         p->crtc_vsync_end = p->vsync_end;
 848         p->crtc_vtotal = p->vtotal;
 849
 850         if (p->flags & DRM_MODE_FLAG_INTERLACE) {
 851                 if (adjust_flags & CRTC_INTERLACE_HALVE_V) {
 852                         p->crtc_vdisplay /= 2;
 853                         p->crtc_vsync_start /= 2;
 854                         p->crtc_vsync_end /= 2;
 855                         p->crtc_vtotal /= 2;
 856                 }
 857         }
 858
 859         if (!(adjust_flags & CRTC_NO_DBLSCAN)) {
 860                 if (p->flags & DRM_MODE_FLAG_DBLSCAN) {
 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_VSCAN)) {
 869                 if (p->vscan > 1) {
 870                         p->crtc_vdisplay *= p->vscan;
 871                         p->crtc_vsync_start *= p->vscan;
 872                         p->crtc_vsync_end *= p->vscan;
 873                         p->crtc_vtotal *= p->vscan;
 874                 }
 875         }
 876
 877         if (adjust_flags & CRTC_STEREO_DOUBLE) {
 878                 unsigned int layout = p->flags & DRM_MODE_FLAG_3D_MASK;
 879
 880                 switch (layout) {
 881                 case DRM_MODE_FLAG_3D_FRAME_PACKING:
 882                         p->crtc_clock *= 2;
 883                         p->crtc_vdisplay += p->crtc_vtotal;
 884                         p->crtc_vsync_start += p->crtc_vtotal;
 885                         p->crtc_vsync_end += p->crtc_vtotal;
 886                         p->crtc_vtotal += p->crtc_vtotal;
 887                         break;
 888                 }
 889         }
 890
 891         p->crtc_vblank_start = min(p->crtc_vsync_start, p->crtc_vdisplay);
 892         p->crtc_vblank_end = max(p->crtc_vsync_end, p->crtc_vtotal);
 893         p->crtc_hblank_start = min(p->crtc_hsync_start, p->crtc_hdisplay);
 894         p->crtc_hblank_end = max(p->crtc_hsync_end, p->crtc_htotal);
 895 }
 896 EXPORT_SYMBOL(drm_mode_set_crtcinfo);
 897
 898 /**
 899  * drm_mode_copy - copy the mode
 900  * @dst: mode to overwrite
 901  * @src: mode to copy
 902  *
 903  * Copy an existing mode into another mode, preserving the object id and
 904  * list head of the destination mode.
 905  */
 906 void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src)
 907 {
 908         int id = dst->base.id;
 909         struct list_head head = dst->head;
 910
 911         *dst = *src;
 912         dst->base.id = id;
 913         dst->head = head;
 914 }
 915 EXPORT_SYMBOL(drm_mode_copy);
 916
 917 /**
 918  * drm_mode_duplicate - allocate and duplicate an existing mode
 919  * @dev: drm_device to allocate the duplicated mode for
 920  * @mode: mode to duplicate
 921  *
 922  * Just allocate a new mode, copy the existing mode into it, and return
 923  * a pointer to it.  Used to create new instances of established modes.
 924  *
 925  * Returns:
 926  * Pointer to duplicated mode on success, NULL on error.
 927  */
 928 struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
 929                                             const struct drm_display_mode *mode)
 930 {
 931         struct drm_display_mode *nmode;
 932
 933         nmode = drm_mode_create(dev);
 934         if (!nmode)
 935                 return NULL;
 936
 937         drm_mode_copy(nmode, mode);
 938
 939         return nmode;
 940 }
 941 EXPORT_SYMBOL(drm_mode_duplicate);
 942
 943 /**
 944  * drm_mode_equal - test modes for equality
 945  * @mode1: first mode
 946  * @mode2: second mode
 947  *
 948  * Check to see if @mode1 and @mode2 are equivalent.
 949  *
 950  * Returns:
 951  * True if the modes are equal, false otherwise.
 952  */
 953 bool drm_mode_equal(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2)
 954 {
 955         if (!mode1 && !mode2)
 956                 return true;
 957
 958         if (!mode1 || !mode2)
 959                 return false;
 960
 961         /* do clock check convert to PICOS so fb modes get matched
 962          * the same */
 963         if (mode1->clock && mode2->clock) {
 964                 if (KHZ2PICOS(mode1->clock) != KHZ2PICOS(mode2->clock))
 965                         return false;
 966         } else if (mode1->clock != mode2->clock)
 967                 return false;
 968
 969         return drm_mode_equal_no_clocks(mode1, mode2);
 970 }
 971 EXPORT_SYMBOL(drm_mode_equal);
 972
 973 /**
 974  * drm_mode_equal_no_clocks - test modes for equality
 975  * @mode1: first mode
 976  * @mode2: second mode
 977  *
 978  * Check to see if @mode1 and @mode2 are equivalent, but
 979  * don't check the pixel clocks.
 980  *
 981  * Returns:
 982  * True if the modes are equal, false otherwise.
 983  */
 984 bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2)
 985 {
 986         if ((mode1->flags & DRM_MODE_FLAG_3D_MASK) !=
 987             (mode2->flags & DRM_MODE_FLAG_3D_MASK))
 988                 return false;
 989
 990         return drm_mode_equal_no_clocks_no_stereo(mode1, mode2);
 991 }
 992 EXPORT_SYMBOL(drm_mode_equal_no_clocks);
 993
 994 /**
 995  * drm_mode_equal_no_clocks_no_stereo - test modes for equality
 996  * @mode1: first mode
 997  * @mode2: second mode
 998  *
 999  * Check to see if @mode1 and @mode2 are equivalent, but
1000  * don't check the pixel clocks nor the stereo layout.
1001  *
1002  * Returns:
1003  * True if the modes are equal, false otherwise.
1004  */
1005 bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
1006                                         const struct drm_display_mode *mode2)
1007 {
1008         if (mode1->hdisplay == mode2->hdisplay &&
1009             mode1->hsync_start == mode2->hsync_start &&
1010             mode1->hsync_end == mode2->hsync_end &&
1011             mode1->htotal == mode2->htotal &&
1012             mode1->hskew == mode2->hskew &&
1013             mode1->vdisplay == mode2->vdisplay &&
1014             mode1->vsync_start == mode2->vsync_start &&
1015             mode1->vsync_end == mode2->vsync_end &&
1016             mode1->vtotal == mode2->vtotal &&
1017             mode1->vscan == mode2->vscan &&
1018             (mode1->flags & ~DRM_MODE_FLAG_3D_MASK) ==
1019              (mode2->flags & ~DRM_MODE_FLAG_3D_MASK))
1020                 return true;
1021
1022         return false;
1023 }
1024 EXPORT_SYMBOL(drm_mode_equal_no_clocks_no_stereo);
1025
1026 /**
1027  * drm_mode_validate_basic - make sure the mode is somewhat sane
1028  * @mode: mode to check
1029  *
1030  * Check that the mode timings are at least somewhat reasonable.
1031  * Any hardware specific limits are left up for each driver to check.
1032  *
1033  * Returns:
1034  * The mode status
1035  */
1036 enum drm_mode_status
1037 drm_mode_validate_basic(const struct drm_display_mode *mode)
1038 {
1039         if (mode->clock == 0)
1040                 return MODE_CLOCK_LOW;
1041
1042         if (mode->hdisplay == 0 ||
1043             mode->hsync_start < mode->hdisplay ||
1044             mode->hsync_end < mode->hsync_start ||
1045             mode->htotal < mode->hsync_end)
1046                 return MODE_H_ILLEGAL;
1047
1048         if (mode->vdisplay == 0 ||
1049             mode->vsync_start < mode->vdisplay ||
1050             mode->vsync_end < mode->vsync_start ||
1051             mode->vtotal < mode->vsync_end)
1052                 return MODE_V_ILLEGAL;
1053
1054         return MODE_OK;
1055 }
1056 EXPORT_SYMBOL(drm_mode_validate_basic);
1057
1058 /**
1059  * drm_mode_validate_size - make sure modes adhere to size constraints
1060  * @mode: mode to check
1061  * @maxX: maximum width
1062  * @maxY: maximum height
1063  *
1064  * This function is a helper which can be used to validate modes against size
1065  * limitations of the DRM device/connector. If a mode is too big its status
1066  * member is updated with the appropriate validation failure code. The list
1067  * itself is not changed.
1068  *
1069  * Returns:
1070  * The mode status
1071  */
1072 enum drm_mode_status
1073 drm_mode_validate_size(const struct drm_display_mode *mode,
1074                        int maxX, int maxY)
1075 {
1076         if (maxX > 0 && mode->hdisplay > maxX)
1077                 return MODE_VIRTUAL_X;
1078
1079         if (maxY > 0 && mode->vdisplay > maxY)
1080                 return MODE_VIRTUAL_Y;
1081
1082         return MODE_OK;
1083 }
1084 EXPORT_SYMBOL(drm_mode_validate_size);
1085
1086 #define MODE_STATUS(status) [MODE_ ## status + 3] = #status
1087
1088 static const char * const drm_mode_status_names[] = {
1089         MODE_STATUS(OK),
1090         MODE_STATUS(HSYNC),
1091         MODE_STATUS(VSYNC),
1092         MODE_STATUS(H_ILLEGAL),
1093         MODE_STATUS(V_ILLEGAL),
1094         MODE_STATUS(BAD_WIDTH),
1095         MODE_STATUS(NOMODE),
1096         MODE_STATUS(NO_INTERLACE),
1097         MODE_STATUS(NO_DBLESCAN),
1098         MODE_STATUS(NO_VSCAN),
1099         MODE_STATUS(MEM),
1100         MODE_STATUS(VIRTUAL_X),
1101         MODE_STATUS(VIRTUAL_Y),
1102         MODE_STATUS(MEM_VIRT),
1103         MODE_STATUS(NOCLOCK),
1104         MODE_STATUS(CLOCK_HIGH),
1105         MODE_STATUS(CLOCK_LOW),
1106         MODE_STATUS(CLOCK_RANGE),
1107         MODE_STATUS(BAD_HVALUE),
1108         MODE_STATUS(BAD_VVALUE),
1109         MODE_STATUS(BAD_VSCAN),
1110         MODE_STATUS(HSYNC_NARROW),
1111         MODE_STATUS(HSYNC_WIDE),
1112         MODE_STATUS(HBLANK_NARROW),
1113         MODE_STATUS(HBLANK_WIDE),
1114         MODE_STATUS(VSYNC_NARROW),
1115         MODE_STATUS(VSYNC_WIDE),
1116         MODE_STATUS(VBLANK_NARROW),
1117         MODE_STATUS(VBLANK_WIDE),
1118         MODE_STATUS(PANEL),
1119         MODE_STATUS(INTERLACE_WIDTH),
1120         MODE_STATUS(ONE_WIDTH),
1121         MODE_STATUS(ONE_HEIGHT),
1122         MODE_STATUS(ONE_SIZE),
1123         MODE_STATUS(NO_REDUCED),
1124         MODE_STATUS(NO_STEREO),
1125         MODE_STATUS(STALE),
1126         MODE_STATUS(BAD),
1127         MODE_STATUS(ERROR),
1128 };
1129
1130 #undef MODE_STATUS
1131
1132 static const char *drm_get_mode_status_name(enum drm_mode_status status)
1133 {
1134         int index = status + 3;
1135
1136         if (WARN_ON(index < 0 || index >= ARRAY_SIZE(drm_mode_status_names)))
1137                 return "";
1138
1139         return drm_mode_status_names[index];
1140 }
1141
1142 /**
1143  * drm_mode_prune_invalid - remove invalid modes from mode list
1144  * @dev: DRM device
1145  * @mode_list: list of modes to check
1146  * @verbose: be verbose about it
1147  *
1148  * This helper function can be used to prune a display mode list after
1149  * validation has been completed. All modes who's status is not MODE_OK will be
1150  * removed from the list, and if @verbose the status code and mode name is also
1151  * printed to dmesg.
1152  */
1153 void drm_mode_prune_invalid(struct drm_device *dev,
1154                             struct list_head *mode_list, bool verbose)
1155 {
1156         struct drm_display_mode *mode, *t;
1157
1158         list_for_each_entry_safe(mode, t, mode_list, head) {
1159                 if (mode->status != MODE_OK) {
1160                         list_del(&mode->head);
1161                         if (verbose) {
1162                                 drm_mode_debug_printmodeline(mode);
1163                                 DRM_DEBUG_KMS("Not using %s mode: %s\n",
1164                                               mode->name,
1165                                               drm_get_mode_status_name(mode->status));
1166                         }
1167                         drm_mode_destroy(dev, mode);
1168                 }
1169         }
1170 }
1171 EXPORT_SYMBOL(drm_mode_prune_invalid);
1172
1173 /**
1174  * drm_mode_compare - compare modes for favorability
1175  * @priv: unused
1176  * @lh_a: list_head for first mode
1177  * @lh_b: list_head for second mode
1178  *
1179  * Compare two modes, given by @lh_a and @lh_b, returning a value indicating
1180  * which is better.
1181  *
1182  * Returns:
1183  * Negative if @lh_a is better than @lh_b, zero if they're equivalent, or
1184  * positive if @lh_b is better than @lh_a.
1185  */
1186 static int drm_mode_compare(void *priv, struct list_head *lh_a, struct list_head *lh_b)
1187 {
1188         struct drm_display_mode *a = list_entry(lh_a, struct drm_display_mode, head);
1189         struct drm_display_mode *b = list_entry(lh_b, struct drm_display_mode, head);
1190         int diff;
1191
1192         diff = ((b->type & DRM_MODE_TYPE_PREFERRED) != 0) -
1193                 ((a->type & DRM_MODE_TYPE_PREFERRED) != 0);
1194         if (diff)
1195                 return diff;
1196         diff = b->hdisplay * b->vdisplay - a->hdisplay * a->vdisplay;
1197         if (diff)
1198                 return diff;
1199
1200         diff = b->vrefresh - a->vrefresh;
1201         if (diff)
1202                 return diff;
1203
1204         diff = b->clock - a->clock;
1205         return diff;
1206 }
1207
1208 /**
1209  * drm_mode_sort - sort mode list
1210  * @mode_list: list of drm_display_mode structures to sort
1211  *
1212  * Sort @mode_list by favorability, moving good modes to the head of the list.
1213  */
1214 void drm_mode_sort(struct list_head *mode_list)
1215 {
1216         list_sort(NULL, mode_list, drm_mode_compare);
1217 }
1218 EXPORT_SYMBOL(drm_mode_sort);
1219
1220 /**
1221  * drm_mode_connector_list_update - update the mode list for the connector
1222  * @connector: the connector to update
1223  *
1224  * This moves the modes from the @connector probed_modes list
1225  * to the actual mode list. It compares the probed mode against the current
1226  * list and only adds different/new modes.
1227  *
1228  * This is just a helper functions doesn't validate any modes itself and also
1229  * doesn't prune any invalid modes. Callers need to do that themselves.
1230  */
1231 void drm_mode_connector_list_update(struct drm_connector *connector)
1232 {
1233         struct drm_display_mode *pmode, *pt;
1234
1235         WARN_ON(!mutex_is_locked(&connector->dev->mode_config.mutex));
1236
1237         list_for_each_entry_safe(pmode, pt, &connector->probed_modes, head) {
1238                 struct drm_display_mode *mode;
1239                 bool found_it = false;
1240
1241                 /* go through current modes checking for the new probed mode */
1242                 list_for_each_entry(mode, &connector->modes, head) {
1243                         if (!drm_mode_equal(pmode, mode))
1244                                 continue;
1245
1246                         found_it = true;
1247
1248                         /*
1249                          * If the old matching mode is stale (ie. left over
1250                          * from a previous probe) just replace it outright.
1251                          * Otherwise just merge the type bits between all
1252                          * equal probed modes.
1253                          *
1254                          * If two probed modes are considered equal, pick the
1255                          * actual timings from the one that's marked as
1256                          * preferred (in case the match isn't 100%). If
1257                          * multiple or zero preferred modes are present, favor
1258                          * the mode added to the probed_modes list first.
1259                          */
1260                         if (mode->status == MODE_STALE) {
1261                                 drm_mode_copy(mode, pmode);
1262                         } else if ((mode->type & DRM_MODE_TYPE_PREFERRED) == 0 &&
1263                                    (pmode->type & DRM_MODE_TYPE_PREFERRED) != 0) {
1264                                 pmode->type |= mode->type;
1265                                 drm_mode_copy(mode, pmode);
1266                         } else {
1267                                 mode->type |= pmode->type;
1268                         }
1269
1270                         list_del(&pmode->head);
1271                         drm_mode_destroy(connector->dev, pmode);
1272                         break;
1273                 }
1274
1275                 if (!found_it) {
1276                         list_move_tail(&pmode->head, &connector->modes);
1277                 }
1278         }
1279 }
1280 EXPORT_SYMBOL(drm_mode_connector_list_update);
1281
1282 /**
1283  * drm_mode_parse_command_line_for_connector - parse command line modeline for connector
1284  * @mode_option: optional per connector mode option
1285  * @connector: connector to parse modeline for
1286  * @mode: preallocated drm_cmdline_mode structure to fill out
1287  *
1288  * This parses @mode_option command line modeline for modes and options to
1289  * configure the connector. If @mode_option is NULL the default command line
1290  * modeline in fb_mode_option will be parsed instead.
1291  *
1292  * This uses the same parameters as the fb modedb.c, except for an extra
1293  * force-enable, force-enable-digital and force-disable bit at the end:
1294  *
1295  * <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m][eDd]
1296  *
1297  * The intermediate drm_cmdline_mode structure is required to store additional
1298  * options from the command line modline like the force-enable/disable flag.
1299  *
1300  * Returns:
1301  * True if a valid modeline has been parsed, false otherwise.
1302  */
1303 bool drm_mode_parse_command_line_for_connector(const char *mode_option,
1304                                                struct drm_connector *connector,
1305                                                struct drm_cmdline_mode *mode)
1306 {
1307         const char *name;
1308         unsigned int namelen;
1309         bool res_specified = false, bpp_specified = false, refresh_specified = false;
1310         unsigned int xres = 0, yres = 0, bpp = 32, refresh = 0;
1311         bool yres_specified = false, cvt = false, rb = false;
1312         bool interlace = false, margins = false, was_digit = false;
1313         int i;
1314         enum drm_connector_force force = DRM_FORCE_UNSPECIFIED;
1315
1316 #ifdef CONFIG_FB
1317         if (!mode_option)
1318                 mode_option = fb_mode_option;
1319 #endif
1320
1321         if (!mode_option) {
1322                 mode->specified = false;
1323                 return false;
1324         }
1325
1326         name = mode_option;
1327         namelen = strlen(name);
1328         for (i = namelen-1; i >= 0; i--) {
1329                 switch (name[i]) {
1330                 case '@':
1331                         if (!refresh_specified && !bpp_specified &&
1332                             !yres_specified && !cvt && !rb && was_digit) {
1333                                 refresh = simple_strtol(&name[i+1], NULL, 10);
1334                                 refresh_specified = true;
1335                                 was_digit = false;
1336                         } else
1337                                 goto done;
1338                         break;
1339                 case '-':
1340                         if (!bpp_specified && !yres_specified && !cvt &&
1341                             !rb && was_digit) {
1342                                 bpp = simple_strtol(&name[i+1], NULL, 10);
1343                                 bpp_specified = true;
1344                                 was_digit = false;
1345                         } else
1346                                 goto done;
1347                         break;
1348                 case 'x':
1349                         if (!yres_specified && was_digit) {
1350                                 yres = simple_strtol(&name[i+1], NULL, 10);
1351                                 yres_specified = true;
1352                                 was_digit = false;
1353                         } else
1354                                 goto done;
1355                         break;
1356                 case '0' ... '9':
1357                         was_digit = true;
1358                         break;
1359                 case 'M':
1360                         if (yres_specified || cvt || was_digit)
1361                                 goto done;
1362                         cvt = true;
1363                         break;
1364                 case 'R':
1365                         if (yres_specified || cvt || rb || was_digit)
1366                                 goto done;
1367                         rb = true;
1368                         break;
1369                 case 'm':
1370                         if (cvt || yres_specified || was_digit)
1371                                 goto done;
1372                         margins = true;
1373                         break;
1374                 case 'i':
1375                         if (cvt || yres_specified || was_digit)
1376                                 goto done;
1377                         interlace = true;
1378                         break;
1379                 case 'e':
1380                         if (yres_specified || bpp_specified || refresh_specified ||
1381                             was_digit || (force != DRM_FORCE_UNSPECIFIED))
1382                                 goto done;
1383
1384                         force = DRM_FORCE_ON;
1385                         break;
1386                 case 'D':
1387                         if (yres_specified || bpp_specified || refresh_specified ||
1388                             was_digit || (force != DRM_FORCE_UNSPECIFIED))
1389                                 goto done;
1390
1391                         if ((connector->connector_type != DRM_MODE_CONNECTOR_DVII) &&
1392                             (connector->connector_type != DRM_MODE_CONNECTOR_HDMIB))
1393                                 force = DRM_FORCE_ON;
1394                         else
1395                                 force = DRM_FORCE_ON_DIGITAL;
1396                         break;
1397                 case 'd':
1398                         if (yres_specified || bpp_specified || refresh_specified ||
1399                             was_digit || (force != DRM_FORCE_UNSPECIFIED))
1400                                 goto done;
1401
1402                         force = DRM_FORCE_OFF;
1403                         break;
1404                 default:
1405                         goto done;
1406                 }
1407         }
1408
1409         if (i < 0 && yres_specified) {
1410                 char *ch;
1411                 xres = simple_strtol(name, &ch, 10);
1412                 if ((ch != NULL) && (*ch == 'x'))
1413                         res_specified = true;
1414                 else
1415                         i = ch - name;
1416         } else if (!yres_specified && was_digit) {
1417                 /* catch mode that begins with digits but has no 'x' */
1418                 i = 0;
1419         }
1420 done:
1421         if (i >= 0) {
1422                 pr_warn("[drm] parse error at position %i in video mode '%s'\n",
1423                         i, name);
1424                 mode->specified = false;
1425                 return false;
1426         }
1427
1428         if (res_specified) {
1429                 mode->specified = true;
1430                 mode->xres = xres;
1431                 mode->yres = yres;
1432         }
1433
1434         if (refresh_specified) {
1435                 mode->refresh_specified = true;
1436                 mode->refresh = refresh;
1437         }
1438
1439         if (bpp_specified) {
1440                 mode->bpp_specified = true;
1441                 mode->bpp = bpp;
1442         }
1443         mode->rb = rb;
1444         mode->cvt = cvt;
1445         mode->interlace = interlace;
1446         mode->margins = margins;
1447         mode->force = force;
1448
1449         return true;
1450 }
1451 EXPORT_SYMBOL(drm_mode_parse_command_line_for_connector);
1452
1453 /**
1454  * drm_mode_create_from_cmdline_mode - convert a command line modeline into a DRM display mode
1455  * @dev: DRM device to create the new mode for
1456  * @cmd: input command line modeline
1457  *
1458  * Returns:
1459  * Pointer to converted mode on success, NULL on error.
1460  */
1461 struct drm_display_mode *
1462 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1463                                   struct drm_cmdline_mode *cmd)
1464 {
1465         struct drm_display_mode *mode;
1466
1467         if (cmd->cvt)
1468                 mode = drm_cvt_mode(dev,
1469                                     cmd->xres, cmd->yres,
1470                                     cmd->refresh_specified ? cmd->refresh : 60,
1471                                     cmd->rb, cmd->interlace,
1472                                     cmd->margins);
1473         else
1474                 mode = drm_gtf_mode(dev,
1475                                     cmd->xres, cmd->yres,
1476                                     cmd->refresh_specified ? cmd->refresh : 60,
1477                                     cmd->interlace,
1478                                     cmd->margins);
1479         if (!mode)
1480                 return NULL;
1481
1482         mode->type |= DRM_MODE_TYPE_USERDEF;
1483         /* fix up 1368x768: GFT/CVT can't express 1366 width due to alignment */
1484         if (cmd->xres == 1366)
1485                 drm_mode_fixup_1366x768(mode);
1486         drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
1487         return mode;
1488 }
1489 EXPORT_SYMBOL(drm_mode_create_from_cmdline_mode);
1490
1491 /**
1492  * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1493  * @out: drm_mode_modeinfo struct to return to the user
1494  * @in: drm_display_mode to use
1495  *
1496  * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1497  * the user.
1498  */
1499 void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
1500                                const struct drm_display_mode *in)
1501 {
1502         WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1503              in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1504              in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1505              in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1506              in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1507              "timing values too large for mode info\n");
1508
1509         out->clock = in->clock;
1510         out->hdisplay = in->hdisplay;
1511         out->hsync_start = in->hsync_start;
1512         out->hsync_end = in->hsync_end;
1513         out->htotal = in->htotal;
1514         out->hskew = in->hskew;
1515         out->vdisplay = in->vdisplay;
1516         out->vsync_start = in->vsync_start;
1517         out->vsync_end = in->vsync_end;
1518         out->vtotal = in->vtotal;
1519         out->vscan = in->vscan;
1520         out->vrefresh = in->vrefresh;
1521         out->flags = in->flags;
1522         out->type = in->type;
1523         strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1524         out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1525 }
1526
1527 /**
1528  * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1529  * @out: drm_display_mode to return to the user
1530  * @in: drm_mode_modeinfo to use
1531  *
1532  * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1533  * the caller.
1534  *
1535  * Returns:
1536  * Zero on success, negative errno on failure.
1537  */
1538 int drm_mode_convert_umode(struct drm_display_mode *out,
1539                            const struct drm_mode_modeinfo *in)
1540 {
1541         int ret = -EINVAL;
1542
1543         if (in->clock > INT_MAX || in->vrefresh > INT_MAX) {
1544                 ret = -ERANGE;
1545                 goto out;
1546         }
1547
1548         if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1549                 goto out;
1550
1551         out->clock = in->clock;
1552         out->hdisplay = in->hdisplay;
1553         out->hsync_start = in->hsync_start;
1554         out->hsync_end = in->hsync_end;
1555         out->htotal = in->htotal;
1556         out->hskew = in->hskew;
1557         out->vdisplay = in->vdisplay;
1558         out->vsync_start = in->vsync_start;
1559         out->vsync_end = in->vsync_end;
1560         out->vtotal = in->vtotal;
1561         out->vscan = in->vscan;
1562         out->vrefresh = in->vrefresh;
1563         out->flags = in->flags;
1564         out->type = in->type;
1565         strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1566         out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1567
1568         out->status = drm_mode_validate_basic(out);
1569         if (out->status != MODE_OK)
1570                 goto out;
1571
1572         drm_mode_set_crtcinfo(out, CRTC_INTERLACE_HALVE_V);
1573
1574         ret = 0;
1575
1576 out:
1577         return ret;
1578 }