drivers/gpu/drm/drm_probe_helper.c

   1 /*
   2  * Copyright (c) 2006-2008 Intel Corporation
   3  * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
   4  *
   5  * DRM core CRTC related functions
   6  *
   7  * Permission to use, copy, modify, distribute, and sell this software and its
   8  * documentation for any purpose is hereby granted without fee, provided that
   9  * the above copyright notice appear in all copies and that both that copyright
  10  * notice and this permission notice appear in supporting documentation, and
  11  * that the name of the copyright holders not be used in advertising or
  12  * publicity pertaining to distribution of the software without specific,
  13  * written prior permission.  The copyright holders make no representations
  14  * about the suitability of this software for any purpose.  It is provided "as
  15  * is" without express or implied warranty.
  16  *
  17  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  19  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  20  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  21  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  22  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  23  * OF THIS SOFTWARE.
  24  *
  25  * Authors:
  26  *      Keith Packard
  27  *      Eric Anholt <eric@anholt.net>
  28  *      Dave Airlie <airlied@linux.ie>
  29  *      Jesse Barnes <jesse.barnes@intel.com>
  30  */
  31
  32 #include <linux/export.h>
  33 #include <linux/moduleparam.h>
  34
  35 #include <drm/drmP.h>
  36 #include <drm/drm_crtc.h>
  37 #include <drm/drm_fourcc.h>
  38 #include <drm/drm_crtc_helper.h>
  39 #include <drm/drm_fb_helper.h>
  40 #include <drm/drm_edid.h>
  41
  42 /**
  43  * DOC: output probing helper overview
  44  *
  45  * This library provides some helper code for output probing. It provides an
  46  * implementation of the core connector->fill_modes interface with
  47  * drm_helper_probe_single_connector_modes.
  48  *
  49  * It also provides support for polling connectors with a work item and for
  50  * generic hotplug interrupt handling where the driver doesn't or cannot keep
  51  * track of a per-connector hpd interrupt.
  52  *
  53  * This helper library can be used independently of the modeset helper library.
  54  * Drivers can also overwrite different parts e.g. use their own hotplug
  55  * handling code to avoid probing unrelated outputs.
  56  *
  57  * The probe helpers share the function table structures with other display
  58  * helper libraries. See struct &drm_connector_helper_funcs for the details.
  59  */
  60
  61 static bool drm_kms_helper_poll = true;
  62 module_param_named(poll, drm_kms_helper_poll, bool, 0600);
  63
  64 static enum drm_mode_status
  65 drm_mode_validate_flag(const struct drm_display_mode *mode,
  66                        int flags)
  67 {
  68         if ((mode->flags & DRM_MODE_FLAG_INTERLACE) &&
  69             !(flags & DRM_MODE_FLAG_INTERLACE))
  70                 return MODE_NO_INTERLACE;
  71
  72         if ((mode->flags & DRM_MODE_FLAG_DBLSCAN) &&
  73             !(flags & DRM_MODE_FLAG_DBLSCAN))
  74                 return MODE_NO_DBLESCAN;
  75
  76         if ((mode->flags & DRM_MODE_FLAG_3D_MASK) &&
  77             !(flags & DRM_MODE_FLAG_3D_MASK))
  78                 return MODE_NO_STEREO;
  79
  80         return MODE_OK;
  81 }
  82
  83 static int drm_helper_probe_add_cmdline_mode(struct drm_connector *connector)
  84 {
  85         struct drm_cmdline_mode *cmdline_mode;
  86         struct drm_display_mode *mode;
  87
  88         cmdline_mode = &connector->cmdline_mode;
  89         if (!cmdline_mode->specified)
  90                 return 0;
  91
  92         /* Only add a GTF mode if we find no matching probed modes */
  93         list_for_each_entry(mode, &connector->probed_modes, head) {
  94                 if (mode->hdisplay != cmdline_mode->xres ||
  95                     mode->vdisplay != cmdline_mode->yres)
  96                         continue;
  97
  98                 if (cmdline_mode->refresh_specified) {
  99                         /* The probed mode's vrefresh is set until later */
 100                         if (drm_mode_vrefresh(mode) != cmdline_mode->refresh)
 101                                 continue;
 102                 }
 103
 104                 return 0;
 105         }
 106
 107         mode = drm_mode_create_from_cmdline_mode(connector->dev,
 108                                                  cmdline_mode);
 109         if (mode == NULL)
 110                 return 0;
 111
 112         drm_mode_probed_add(connector, mode);
 113         return 1;
 114 }
 115
 116 #define DRM_OUTPUT_POLL_PERIOD (10*HZ)
 117 /**
 118  * drm_kms_helper_poll_enable_locked - re-enable output polling.
 119  * @dev: drm_device
 120  *
 121  * This function re-enables the output polling work without
 122  * locking the mode_config mutex.
 123  *
 124  * This is like drm_kms_helper_poll_enable() however it is to be
 125  * called from a context where the mode_config mutex is locked
 126  * already.
 127  */
 128 void drm_kms_helper_poll_enable_locked(struct drm_device *dev)
 129 {
 130         bool poll = false;
 131         struct drm_connector *connector;
 132         unsigned long delay = DRM_OUTPUT_POLL_PERIOD;
 133
 134         WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
 135
 136         if (!dev->mode_config.poll_enabled || !drm_kms_helper_poll)
 137                 return;
 138
 139         drm_for_each_connector(connector, dev) {
 140                 if (connector->polled & (DRM_CONNECTOR_POLL_CONNECT |
 141                                          DRM_CONNECTOR_POLL_DISCONNECT))
 142                         poll = true;
 143         }
 144
 145         if (dev->mode_config.delayed_event) {
 146                 poll = true;
 147                 delay = 0;
 148         }
 149
 150         if (poll)
 151                 schedule_delayed_work(&dev->mode_config.output_poll_work, delay);
 152 }
 153 EXPORT_SYMBOL(drm_kms_helper_poll_enable_locked);
 154
 155 static enum drm_connector_status
 156 drm_connector_detect(struct drm_connector *connector, bool force)
 157 {
 158         return connector->funcs->detect ?
 159                 connector->funcs->detect(connector, force) :
 160                 connector_status_connected;
 161 }
 162
 163 /**
 164  * drm_helper_probe_single_connector_modes - get complete set of display modes
 165  * @connector: connector to probe
 166  * @maxX: max width for modes
 167  * @maxY: max height for modes
 168  *
 169  * Based on the helper callbacks implemented by @connector in struct
 170  * &drm_connector_helper_funcs try to detect all valid modes.  Modes will first
 171  * be added to the connector's probed_modes list, then culled (based on validity
 172  * and the @maxX, @maxY parameters) and put into the normal modes list.
 173  *
 174  * Intended to be used as a generic implementation of the ->fill_modes()
 175  * @connector vfunc for drivers that use the CRTC helpers for output mode
 176  * filtering and detection.
 177  *
 178  * The basic procedure is as follows
 179  *
 180  * 1. All modes currently on the connector's modes list are marked as stale
 181  *
 182  * 2. New modes are added to the connector's probed_modes list with
 183  *    drm_mode_probed_add(). New modes start their life with status as OK.
 184  *    Modes are added from a single source using the following priority order.
 185  *
 186  *    - debugfs 'override_edid' (used for testing only)
 187  *    - firmware EDID (drm_load_edid_firmware())
 188  *    - connector helper ->get_modes() vfunc
 189  *    - if the connector status is connector_status_connected, standard
 190  *      VESA DMT modes up to 1024x768 are automatically added
 191  *      (drm_add_modes_noedid())
 192  *
 193  *    Finally modes specified via the kernel command line (video=...) are
 194  *    added in addition to what the earlier probes produced
 195  *    (drm_helper_probe_add_cmdline_mode()). These modes are generated
 196  *    using the VESA GTF/CVT formulas.
 197  *
 198  * 3. Modes are moved from the probed_modes list to the modes list. Potential
 199  *    duplicates are merged together (see drm_mode_connector_list_update()).
 200  *    After this step the probed_modes list will be empty again.
 201  *
 202  * 4. Any non-stale mode on the modes list then undergoes validation
 203  *
 204  *    - drm_mode_validate_basic() performs basic sanity checks
 205  *    - drm_mode_validate_size() filters out modes larger than @maxX and @maxY
 206  *      (if specified)
 207  *    - drm_mode_validate_flag() checks the modes againt basic connector
 208  *      capabilites (interlace_allowed,doublescan_allowed,stereo_allowed)
 209  *    - the optional connector ->mode_valid() helper can perform driver and/or
 210  *      hardware specific checks
 211  *
 212  * 5. Any mode whose status is not OK is pruned from the connector's modes list,
 213  *    accompanied by a debug message indicating the reason for the mode's
 214  *    rejection (see drm_mode_prune_invalid()).
 215  *
 216  * Returns:
 217  * The number of modes found on @connector.
 218  */
 219 int drm_helper_probe_single_connector_modes(struct drm_connector *connector,
 220                                             uint32_t maxX, uint32_t maxY)
 221 {
 222         struct drm_device *dev = connector->dev;
 223         struct drm_display_mode *mode;
 224         const struct drm_connector_helper_funcs *connector_funcs =
 225                 connector->helper_private;
 226         int count = 0;
 227         int mode_flags = 0;
 228         bool verbose_prune = true;
 229         enum drm_connector_status old_status;
 230
 231         WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
 232
 233         DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n", connector->base.id,
 234                         connector->name);
 235         /* set all old modes to the stale state */
 236         list_for_each_entry(mode, &connector->modes, head)
 237                 mode->status = MODE_STALE;
 238
 239         old_status = connector->status;
 240
 241         if (connector->force) {
 242                 if (connector->force == DRM_FORCE_ON ||
 243                     connector->force == DRM_FORCE_ON_DIGITAL)
 244                         connector->status = connector_status_connected;
 245                 else
 246                         connector->status = connector_status_disconnected;
 247                 if (connector->funcs->force)
 248                         connector->funcs->force(connector);
 249         } else {
 250                 connector->status = drm_connector_detect(connector, true);
 251         }
 252
 253         /*
 254          * Normally either the driver's hpd code or the poll loop should
 255          * pick up any changes and fire the hotplug event. But if
 256          * userspace sneaks in a probe, we might miss a change. Hence
 257          * check here, and if anything changed start the hotplug code.
 258          */
 259         if (old_status != connector->status) {
 260                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] status updated from %s to %s\n",
 261                               connector->base.id,
 262                               connector->name,
 263                               drm_get_connector_status_name(old_status),
 264                               drm_get_connector_status_name(connector->status));
 265
 266                 /*
 267                  * The hotplug event code might call into the fb
 268                  * helpers, and so expects that we do not hold any
 269                  * locks. Fire up the poll struct instead, it will
 270                  * disable itself again.
 271                  */
 272                 dev->mode_config.delayed_event = true;
 273                 if (dev->mode_config.poll_enabled)
 274                         schedule_delayed_work(&dev->mode_config.output_poll_work,
 275                                               0);
 276         }
 277
 278         /* Re-enable polling in case the global poll config changed. */
 279         if (drm_kms_helper_poll != dev->mode_config.poll_running)
 280                 drm_kms_helper_poll_enable_locked(dev);
 281
 282         dev->mode_config.poll_running = drm_kms_helper_poll;
 283
 284         if (connector->status == connector_status_disconnected) {
 285                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] disconnected\n",
 286                         connector->base.id, connector->name);
 287                 drm_mode_connector_update_edid_property(connector, NULL);
 288                 verbose_prune = false;
 289                 goto prune;
 290         }
 291
 292         if (connector->override_edid) {
 293                 struct edid *edid = (struct edid *) connector->edid_blob_ptr->data;
 294
 295                 count = drm_add_edid_modes(connector, edid);
 296                 drm_edid_to_eld(connector, edid);
 297         } else {
 298                 count = drm_load_edid_firmware(connector);
 299                 if (count == 0)
 300                         count = (*connector_funcs->get_modes)(connector);
 301         }
 302
 303         if (count == 0 && connector->status == connector_status_connected)
 304                 count = drm_add_modes_noedid(connector, 1024, 768);
 305         count += drm_helper_probe_add_cmdline_mode(connector);
 306         if (count == 0)
 307                 goto prune;
 308
 309         drm_mode_connector_list_update(connector);
 310
 311         if (connector->interlace_allowed)
 312                 mode_flags |= DRM_MODE_FLAG_INTERLACE;
 313         if (connector->doublescan_allowed)
 314                 mode_flags |= DRM_MODE_FLAG_DBLSCAN;
 315         if (connector->stereo_allowed)
 316                 mode_flags |= DRM_MODE_FLAG_3D_MASK;
 317
 318         list_for_each_entry(mode, &connector->modes, head) {
 319                 if (mode->status == MODE_OK)
 320                         mode->status = drm_mode_validate_basic(mode);
 321
 322                 if (mode->status == MODE_OK)
 323                         mode->status = drm_mode_validate_size(mode, maxX, maxY);
 324
 325                 if (mode->status == MODE_OK)
 326                         mode->status = drm_mode_validate_flag(mode, mode_flags);
 327
 328                 if (mode->status == MODE_OK && connector_funcs->mode_valid)
 329                         mode->status = connector_funcs->mode_valid(connector,
 330                                                                    mode);
 331         }
 332
 333 prune:
 334         drm_mode_prune_invalid(dev, &connector->modes, verbose_prune);
 335
 336         if (list_empty(&connector->modes))
 337                 return 0;
 338
 339         list_for_each_entry(mode, &connector->modes, head)
 340                 mode->vrefresh = drm_mode_vrefresh(mode);
 341
 342         drm_mode_sort(&connector->modes);
 343
 344         DRM_DEBUG_KMS("[CONNECTOR:%d:%s] probed modes :\n", connector->base.id,
 345                         connector->name);
 346         list_for_each_entry(mode, &connector->modes, head) {
 347                 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
 348                 drm_mode_debug_printmodeline(mode);
 349         }
 350
 351         return count;
 352 }
 353 EXPORT_SYMBOL(drm_helper_probe_single_connector_modes);
 354
 355 /**
 356  * drm_kms_helper_hotplug_event - fire off KMS hotplug events
 357  * @dev: drm_device whose connector state changed
 358  *
 359  * This function fires off the uevent for userspace and also calls the
 360  * output_poll_changed function, which is most commonly used to inform the fbdev
 361  * emulation code and allow it to update the fbcon output configuration.
 362  *
 363  * Drivers should call this from their hotplug handling code when a change is
 364  * detected. Note that this function does not do any output detection of its
 365  * own, like drm_helper_hpd_irq_event() does - this is assumed to be done by the
 366  * driver already.
 367  *
 368  * This function must be called from process context with no mode
 369  * setting locks held.
 370  */
 371 void drm_kms_helper_hotplug_event(struct drm_device *dev)
 372 {
 373         /* send a uevent + call fbdev */
 374         drm_sysfs_hotplug_event(dev);
 375         if (dev->mode_config.funcs->output_poll_changed)
 376                 dev->mode_config.funcs->output_poll_changed(dev);
 377 }
 378 EXPORT_SYMBOL(drm_kms_helper_hotplug_event);
 379
 380 static void output_poll_execute(struct work_struct *work)
 381 {
 382         struct delayed_work *delayed_work = to_delayed_work(work);
 383         struct drm_device *dev = container_of(delayed_work, struct drm_device, mode_config.output_poll_work);
 384         struct drm_connector *connector;
 385         enum drm_connector_status old_status;
 386         bool repoll = false, changed;
 387
 388         /* Pick up any changes detected by the probe functions. */
 389         changed = dev->mode_config.delayed_event;
 390         dev->mode_config.delayed_event = false;
 391
 392         if (!drm_kms_helper_poll)
 393                 goto out;
 394
 395         if (!mutex_trylock(&dev->mode_config.mutex)) {
 396                 repoll = true;
 397                 goto out;
 398         }
 399
 400         drm_for_each_connector(connector, dev) {
 401
 402                 /* Ignore forced connectors. */
 403                 if (connector->force)
 404                         continue;
 405
 406                 /* Ignore HPD capable connectors and connectors where we don't
 407                  * want any hotplug detection at all for polling. */
 408                 if (!connector->polled || connector->polled == DRM_CONNECTOR_POLL_HPD)
 409                         continue;
 410
 411                 old_status = connector->status;
 412                 /* if we are connected and don't want to poll for disconnect
 413                    skip it */
 414                 if (old_status == connector_status_connected &&
 415                     !(connector->polled & DRM_CONNECTOR_POLL_DISCONNECT))
 416                         continue;
 417
 418                 repoll = true;
 419
 420                 connector->status = drm_connector_detect(connector, false);
 421                 if (old_status != connector->status) {
 422                         const char *old, *new;
 423
 424                         /*
 425                          * The poll work sets force=false when calling detect so
 426                          * that drivers can avoid to do disruptive tests (e.g.
 427                          * when load detect cycles could cause flickering on
 428                          * other, running displays). This bears the risk that we
 429                          * flip-flop between unknown here in the poll work and
 430                          * the real state when userspace forces a full detect
 431                          * call after receiving a hotplug event due to this
 432                          * change.
 433                          *
 434                          * Hence clamp an unknown detect status to the old
 435                          * value.
 436                          */
 437                         if (connector->status == connector_status_unknown) {
 438                                 connector->status = old_status;
 439                                 continue;
 440                         }
 441
 442                         old = drm_get_connector_status_name(old_status);
 443                         new = drm_get_connector_status_name(connector->status);
 444
 445                         DRM_DEBUG_KMS("[CONNECTOR:%d:%s] "
 446                                       "status updated from %s to %s\n",
 447                                       connector->base.id,
 448                                       connector->name,
 449                                       old, new);
 450
 451                         changed = true;
 452                 }
 453         }
 454
 455         mutex_unlock(&dev->mode_config.mutex);
 456
 457 out:
 458         if (changed)
 459                 drm_kms_helper_hotplug_event(dev);
 460
 461         if (repoll)
 462                 schedule_delayed_work(delayed_work, DRM_OUTPUT_POLL_PERIOD);
 463 }
 464
 465 /**
 466  * drm_kms_helper_poll_disable - disable output polling
 467  * @dev: drm_device
 468  *
 469  * This function disables the output polling work.
 470  *
 471  * Drivers can call this helper from their device suspend implementation. It is
 472  * not an error to call this even when output polling isn't enabled or arlready
 473  * disabled.
 474  */
 475 void drm_kms_helper_poll_disable(struct drm_device *dev)
 476 {
 477         if (!dev->mode_config.poll_enabled)
 478                 return;
 479         cancel_delayed_work_sync(&dev->mode_config.output_poll_work);
 480 }
 481 EXPORT_SYMBOL(drm_kms_helper_poll_disable);
 482
 483 /**
 484  * drm_kms_helper_poll_enable - re-enable output polling.
 485  * @dev: drm_device
 486  *
 487  * This function re-enables the output polling work.
 488  *
 489  * Drivers can call this helper from their device resume implementation. It is
 490  * an error to call this when the output polling support has not yet been set
 491  * up.
 492  */
 493 void drm_kms_helper_poll_enable(struct drm_device *dev)
 494 {
 495         mutex_lock(&dev->mode_config.mutex);
 496         drm_kms_helper_poll_enable_locked(dev);
 497         mutex_unlock(&dev->mode_config.mutex);
 498 }
 499 EXPORT_SYMBOL(drm_kms_helper_poll_enable);
 500
 501 /**
 502  * drm_kms_helper_poll_init - initialize and enable output polling
 503  * @dev: drm_device
 504  *
 505  * This function intializes and then also enables output polling support for
 506  * @dev. Drivers which do not have reliable hotplug support in hardware can use
 507  * this helper infrastructure to regularly poll such connectors for changes in
 508  * their connection state.
 509  *
 510  * Drivers can control which connectors are polled by setting the
 511  * DRM_CONNECTOR_POLL_CONNECT and DRM_CONNECTOR_POLL_DISCONNECT flags. On
 512  * connectors where probing live outputs can result in visual distortion drivers
 513  * should not set the DRM_CONNECTOR_POLL_DISCONNECT flag to avoid this.
 514  * Connectors which have no flag or only DRM_CONNECTOR_POLL_HPD set are
 515  * completely ignored by the polling logic.
 516  *
 517  * Note that a connector can be both polled and probed from the hotplug handler,
 518  * in case the hotplug interrupt is known to be unreliable.
 519  */
 520 void drm_kms_helper_poll_init(struct drm_device *dev)
 521 {
 522         INIT_DELAYED_WORK(&dev->mode_config.output_poll_work, output_poll_execute);
 523         dev->mode_config.poll_enabled = true;
 524
 525         drm_kms_helper_poll_enable(dev);
 526 }
 527 EXPORT_SYMBOL(drm_kms_helper_poll_init);
 528
 529 /**
 530  * drm_kms_helper_poll_fini - disable output polling and clean it up
 531  * @dev: drm_device
 532  */
 533 void drm_kms_helper_poll_fini(struct drm_device *dev)
 534 {
 535         drm_kms_helper_poll_disable(dev);
 536 }
 537 EXPORT_SYMBOL(drm_kms_helper_poll_fini);
 538
 539 /**
 540  * drm_helper_hpd_irq_event - hotplug processing
 541  * @dev: drm_device
 542  *
 543  * Drivers can use this helper function to run a detect cycle on all connectors
 544  * which have the DRM_CONNECTOR_POLL_HPD flag set in their &polled member. All
 545  * other connectors are ignored, which is useful to avoid reprobing fixed
 546  * panels.
 547  *
 548  * This helper function is useful for drivers which can't or don't track hotplug
 549  * interrupts for each connector.
 550  *
 551  * Drivers which support hotplug interrupts for each connector individually and
 552  * which have a more fine-grained detect logic should bypass this code and
 553  * directly call drm_kms_helper_hotplug_event() in case the connector state
 554  * changed.
 555  *
 556  * This function must be called from process context with no mode
 557  * setting locks held.
 558  *
 559  * Note that a connector can be both polled and probed from the hotplug handler,
 560  * in case the hotplug interrupt is known to be unreliable.
 561  */
 562 bool drm_helper_hpd_irq_event(struct drm_device *dev)
 563 {
 564         struct drm_connector *connector;
 565         enum drm_connector_status old_status;
 566         bool changed = false;
 567
 568         if (!dev->mode_config.poll_enabled)
 569                 return false;
 570
 571         mutex_lock(&dev->mode_config.mutex);
 572         drm_for_each_connector(connector, dev) {
 573
 574                 /* Only handle HPD capable connectors. */
 575                 if (!(connector->polled & DRM_CONNECTOR_POLL_HPD))
 576                         continue;
 577
 578                 old_status = connector->status;
 579
 580                 connector->status = drm_connector_detect(connector, false);
 581                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] status updated from %s to %s\n",
 582                               connector->base.id,
 583                               connector->name,
 584                               drm_get_connector_status_name(old_status),
 585                               drm_get_connector_status_name(connector->status));
 586                 if (old_status != connector->status)
 587                         changed = true;
 588         }
 589
 590         mutex_unlock(&dev->mode_config.mutex);
 591
 592         if (changed)
 593                 drm_kms_helper_hotplug_event(dev);
 594
 595         return changed;
 596 }
 597 EXPORT_SYMBOL(drm_helper_hpd_irq_event);