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
 133         WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
 134
 135         if (!dev->mode_config.poll_enabled || !drm_kms_helper_poll)
 136                 return;
 137
 138         drm_for_each_connector(connector, dev) {
 139                 if (connector->polled & (DRM_CONNECTOR_POLL_CONNECT |
 140                                          DRM_CONNECTOR_POLL_DISCONNECT))
 141                         poll = true;
 142         }
 143
 144         if (poll)
 145                 schedule_delayed_work(&dev->mode_config.output_poll_work, DRM_OUTPUT_POLL_PERIOD);
 146 }
 147 EXPORT_SYMBOL(drm_kms_helper_poll_enable_locked);
 148
 149 /**
 150  * drm_helper_probe_single_connector_modes - get complete set of display modes
 151  * @connector: connector to probe
 152  * @maxX: max width for modes
 153  * @maxY: max height for modes
 154  *
 155  * Based on the helper callbacks implemented by @connector in struct
 156  * &drm_connector_helper_funcs try to detect all valid modes.  Modes will first
 157  * be added to the connector's probed_modes list, then culled (based on validity
 158  * and the @maxX, @maxY parameters) and put into the normal modes list.
 159  *
 160  * Intended to be used as a generic implementation of the ->fill_modes()
 161  * @connector vfunc for drivers that use the CRTC helpers for output mode
 162  * filtering and detection.
 163  *
 164  * The basic procedure is as follows
 165  *
 166  * 1. All modes currently on the connector's modes list are marked as stale
 167  *
 168  * 2. New modes are added to the connector's probed_modes list with
 169  *    drm_mode_probed_add(). New modes start their life with status as OK.
 170  *    Modes are added from a single source using the following priority order.
 171  *
 172  *    - debugfs 'override_edid' (used for testing only)
 173  *    - firmware EDID (drm_load_edid_firmware())
 174  *    - connector helper ->get_modes() vfunc
 175  *    - if the connector status is connector_status_connected, standard
 176  *      VESA DMT modes up to 1024x768 are automatically added
 177  *      (drm_add_modes_noedid())
 178  *
 179  *    Finally modes specified via the kernel command line (video=...) are
 180  *    added in addition to what the earlier probes produced
 181  *    (drm_helper_probe_add_cmdline_mode()). These modes are generated
 182  *    using the VESA GTF/CVT formulas.
 183  *
 184  * 3. Modes are moved from the probed_modes list to the modes list. Potential
 185  *    duplicates are merged together (see drm_mode_connector_list_update()).
 186  *    After this step the probed_modes list will be empty again.
 187  *
 188  * 4. Any non-stale mode on the modes list then undergoes validation
 189  *
 190  *    - drm_mode_validate_basic() performs basic sanity checks
 191  *    - drm_mode_validate_size() filters out modes larger than @maxX and @maxY
 192  *      (if specified)
 193  *    - drm_mode_validate_flag() checks the modes againt basic connector
 194  *      capabilites (interlace_allowed,doublescan_allowed,stereo_allowed)
 195  *    - the optional connector ->mode_valid() helper can perform driver and/or
 196  *      hardware specific checks
 197  *
 198  * 5. Any mode whose status is not OK is pruned from the connector's modes list,
 199  *    accompanied by a debug message indicating the reason for the mode's
 200  *    rejection (see drm_mode_prune_invalid()).
 201  *
 202  * Returns:
 203  * The number of modes found on @connector.
 204  */
 205 int drm_helper_probe_single_connector_modes(struct drm_connector *connector,
 206                                             uint32_t maxX, uint32_t maxY)
 207 {
 208         struct drm_device *dev = connector->dev;
 209         struct drm_display_mode *mode;
 210         const struct drm_connector_helper_funcs *connector_funcs =
 211                 connector->helper_private;
 212         int count = 0;
 213         int mode_flags = 0;
 214         bool verbose_prune = true;
 215         enum drm_connector_status old_status;
 216
 217         WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
 218
 219         DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n", connector->base.id,
 220                         connector->name);
 221         /* set all old modes to the stale state */
 222         list_for_each_entry(mode, &connector->modes, head)
 223                 mode->status = MODE_STALE;
 224
 225         old_status = connector->status;
 226
 227         if (connector->force) {
 228                 if (connector->force == DRM_FORCE_ON ||
 229                     connector->force == DRM_FORCE_ON_DIGITAL)
 230                         connector->status = connector_status_connected;
 231                 else
 232                         connector->status = connector_status_disconnected;
 233                 if (connector->funcs->force)
 234                         connector->funcs->force(connector);
 235         } else {
 236                 connector->status = connector->funcs->detect(connector, true);
 237         }
 238
 239         /*
 240          * Normally either the driver's hpd code or the poll loop should
 241          * pick up any changes and fire the hotplug event. But if
 242          * userspace sneaks in a probe, we might miss a change. Hence
 243          * check here, and if anything changed start the hotplug code.
 244          */
 245         if (old_status != connector->status) {
 246                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] status updated from %s to %s\n",
 247                               connector->base.id,
 248                               connector->name,
 249                               drm_get_connector_status_name(old_status),
 250                               drm_get_connector_status_name(connector->status));
 251
 252                 /*
 253                  * The hotplug event code might call into the fb
 254                  * helpers, and so expects that we do not hold any
 255                  * locks. Fire up the poll struct instead, it will
 256                  * disable itself again.
 257                  */
 258                 dev->mode_config.delayed_event = true;
 259                 if (dev->mode_config.poll_enabled)
 260                         schedule_delayed_work(&dev->mode_config.output_poll_work,
 261                                               0);
 262         }
 263
 264         /* Re-enable polling in case the global poll config changed. */
 265         if (drm_kms_helper_poll != dev->mode_config.poll_running)
 266                 drm_kms_helper_poll_enable_locked(dev);
 267
 268         dev->mode_config.poll_running = drm_kms_helper_poll;
 269
 270         if (connector->status == connector_status_disconnected) {
 271                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] disconnected\n",
 272                         connector->base.id, connector->name);
 273                 drm_mode_connector_update_edid_property(connector, NULL);
 274                 verbose_prune = false;
 275                 goto prune;
 276         }
 277
 278         if (connector->override_edid) {
 279                 struct edid *edid = (struct edid *) connector->edid_blob_ptr->data;
 280
 281                 count = drm_add_edid_modes(connector, edid);
 282                 drm_edid_to_eld(connector, edid);
 283         } else {
 284                 count = drm_load_edid_firmware(connector);
 285                 if (count == 0)
 286                         count = (*connector_funcs->get_modes)(connector);
 287         }
 288
 289         if (count == 0 && connector->status == connector_status_connected)
 290                 count = drm_add_modes_noedid(connector, 1024, 768);
 291         count += drm_helper_probe_add_cmdline_mode(connector);
 292         if (count == 0)
 293                 goto prune;
 294
 295         drm_mode_connector_list_update(connector);
 296
 297         if (connector->interlace_allowed)
 298                 mode_flags |= DRM_MODE_FLAG_INTERLACE;
 299         if (connector->doublescan_allowed)
 300                 mode_flags |= DRM_MODE_FLAG_DBLSCAN;
 301         if (connector->stereo_allowed)
 302                 mode_flags |= DRM_MODE_FLAG_3D_MASK;
 303
 304         list_for_each_entry(mode, &connector->modes, head) {
 305                 if (mode->status == MODE_OK)
 306                         mode->status = drm_mode_validate_basic(mode);
 307
 308                 if (mode->status == MODE_OK)
 309                         mode->status = drm_mode_validate_size(mode, maxX, maxY);
 310
 311                 if (mode->status == MODE_OK)
 312                         mode->status = drm_mode_validate_flag(mode, mode_flags);
 313
 314                 if (mode->status == MODE_OK && connector_funcs->mode_valid)
 315                         mode->status = connector_funcs->mode_valid(connector,
 316                                                                    mode);
 317         }
 318
 319 prune:
 320         drm_mode_prune_invalid(dev, &connector->modes, verbose_prune);
 321
 322         if (list_empty(&connector->modes))
 323                 return 0;
 324
 325         list_for_each_entry(mode, &connector->modes, head)
 326                 mode->vrefresh = drm_mode_vrefresh(mode);
 327
 328         drm_mode_sort(&connector->modes);
 329
 330         DRM_DEBUG_KMS("[CONNECTOR:%d:%s] probed modes :\n", connector->base.id,
 331                         connector->name);
 332         list_for_each_entry(mode, &connector->modes, head) {
 333                 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
 334                 drm_mode_debug_printmodeline(mode);
 335         }
 336
 337         return count;
 338 }
 339 EXPORT_SYMBOL(drm_helper_probe_single_connector_modes);
 340
 341 /**
 342  * drm_kms_helper_hotplug_event - fire off KMS hotplug events
 343  * @dev: drm_device whose connector state changed
 344  *
 345  * This function fires off the uevent for userspace and also calls the
 346  * output_poll_changed function, which is most commonly used to inform the fbdev
 347  * emulation code and allow it to update the fbcon output configuration.
 348  *
 349  * Drivers should call this from their hotplug handling code when a change is
 350  * detected. Note that this function does not do any output detection of its
 351  * own, like drm_helper_hpd_irq_event() does - this is assumed to be done by the
 352  * driver already.
 353  *
 354  * This function must be called from process context with no mode
 355  * setting locks held.
 356  */
 357 void drm_kms_helper_hotplug_event(struct drm_device *dev)
 358 {
 359         /* send a uevent + call fbdev */
 360         drm_sysfs_hotplug_event(dev);
 361         if (dev->mode_config.funcs->output_poll_changed)
 362                 dev->mode_config.funcs->output_poll_changed(dev);
 363 }
 364 EXPORT_SYMBOL(drm_kms_helper_hotplug_event);
 365
 366 static void output_poll_execute(struct work_struct *work)
 367 {
 368         struct delayed_work *delayed_work = to_delayed_work(work);
 369         struct drm_device *dev = container_of(delayed_work, struct drm_device, mode_config.output_poll_work);
 370         struct drm_connector *connector;
 371         enum drm_connector_status old_status;
 372         bool repoll = false, changed;
 373
 374         /* Pick up any changes detected by the probe functions. */
 375         changed = dev->mode_config.delayed_event;
 376         dev->mode_config.delayed_event = false;
 377
 378         if (!drm_kms_helper_poll)
 379                 goto out;
 380
 381         mutex_lock(&dev->mode_config.mutex);
 382         drm_for_each_connector(connector, dev) {
 383
 384                 /* Ignore forced connectors. */
 385                 if (connector->force)
 386                         continue;
 387
 388                 /* Ignore HPD capable connectors and connectors where we don't
 389                  * want any hotplug detection at all for polling. */
 390                 if (!connector->polled || connector->polled == DRM_CONNECTOR_POLL_HPD)
 391                         continue;
 392
 393                 old_status = connector->status;
 394                 /* if we are connected and don't want to poll for disconnect
 395                    skip it */
 396                 if (old_status == connector_status_connected &&
 397                     !(connector->polled & DRM_CONNECTOR_POLL_DISCONNECT))
 398                         continue;
 399
 400                 repoll = true;
 401
 402                 connector->status = connector->funcs->detect(connector, false);
 403                 if (old_status != connector->status) {
 404                         const char *old, *new;
 405
 406                         /*
 407                          * The poll work sets force=false when calling detect so
 408                          * that drivers can avoid to do disruptive tests (e.g.
 409                          * when load detect cycles could cause flickering on
 410                          * other, running displays). This bears the risk that we
 411                          * flip-flop between unknown here in the poll work and
 412                          * the real state when userspace forces a full detect
 413                          * call after receiving a hotplug event due to this
 414                          * change.
 415                          *
 416                          * Hence clamp an unknown detect status to the old
 417                          * value.
 418                          */
 419                         if (connector->status == connector_status_unknown) {
 420                                 connector->status = old_status;
 421                                 continue;
 422                         }
 423
 424                         old = drm_get_connector_status_name(old_status);
 425                         new = drm_get_connector_status_name(connector->status);
 426
 427                         DRM_DEBUG_KMS("[CONNECTOR:%d:%s] "
 428                                       "status updated from %s to %s\n",
 429                                       connector->base.id,
 430                                       connector->name,
 431                                       old, new);
 432
 433                         changed = true;
 434                 }
 435         }
 436
 437         mutex_unlock(&dev->mode_config.mutex);
 438
 439 out:
 440         if (changed)
 441                 drm_kms_helper_hotplug_event(dev);
 442
 443         if (repoll)
 444                 schedule_delayed_work(delayed_work, DRM_OUTPUT_POLL_PERIOD);
 445 }
 446
 447 /**
 448  * drm_kms_helper_poll_disable - disable output polling
 449  * @dev: drm_device
 450  *
 451  * This function disables the output polling work.
 452  *
 453  * Drivers can call this helper from their device suspend implementation. It is
 454  * not an error to call this even when output polling isn't enabled or arlready
 455  * disabled.
 456  */
 457 void drm_kms_helper_poll_disable(struct drm_device *dev)
 458 {
 459         if (!dev->mode_config.poll_enabled)
 460                 return;
 461         cancel_delayed_work_sync(&dev->mode_config.output_poll_work);
 462 }
 463 EXPORT_SYMBOL(drm_kms_helper_poll_disable);
 464
 465 /**
 466  * drm_kms_helper_poll_enable - re-enable output polling.
 467  * @dev: drm_device
 468  *
 469  * This function re-enables the output polling work.
 470  *
 471  * Drivers can call this helper from their device resume implementation. It is
 472  * an error to call this when the output polling support has not yet been set
 473  * up.
 474  */
 475 void drm_kms_helper_poll_enable(struct drm_device *dev)
 476 {
 477         mutex_lock(&dev->mode_config.mutex);
 478         drm_kms_helper_poll_enable_locked(dev);
 479         mutex_unlock(&dev->mode_config.mutex);
 480 }
 481 EXPORT_SYMBOL(drm_kms_helper_poll_enable);
 482
 483 /**
 484  * drm_kms_helper_poll_init - initialize and enable output polling
 485  * @dev: drm_device
 486  *
 487  * This function intializes and then also enables output polling support for
 488  * @dev. Drivers which do not have reliable hotplug support in hardware can use
 489  * this helper infrastructure to regularly poll such connectors for changes in
 490  * their connection state.
 491  *
 492  * Drivers can control which connectors are polled by setting the
 493  * DRM_CONNECTOR_POLL_CONNECT and DRM_CONNECTOR_POLL_DISCONNECT flags. On
 494  * connectors where probing live outputs can result in visual distortion drivers
 495  * should not set the DRM_CONNECTOR_POLL_DISCONNECT flag to avoid this.
 496  * Connectors which have no flag or only DRM_CONNECTOR_POLL_HPD set are
 497  * completely ignored by the polling logic.
 498  *
 499  * Note that a connector can be both polled and probed from the hotplug handler,
 500  * in case the hotplug interrupt is known to be unreliable.
 501  */
 502 void drm_kms_helper_poll_init(struct drm_device *dev)
 503 {
 504         INIT_DELAYED_WORK(&dev->mode_config.output_poll_work, output_poll_execute);
 505         dev->mode_config.poll_enabled = true;
 506
 507         drm_kms_helper_poll_enable(dev);
 508 }
 509 EXPORT_SYMBOL(drm_kms_helper_poll_init);
 510
 511 /**
 512  * drm_kms_helper_poll_fini - disable output polling and clean it up
 513  * @dev: drm_device
 514  */
 515 void drm_kms_helper_poll_fini(struct drm_device *dev)
 516 {
 517         drm_kms_helper_poll_disable(dev);
 518 }
 519 EXPORT_SYMBOL(drm_kms_helper_poll_fini);
 520
 521 /**
 522  * drm_helper_hpd_irq_event - hotplug processing
 523  * @dev: drm_device
 524  *
 525  * Drivers can use this helper function to run a detect cycle on all connectors
 526  * which have the DRM_CONNECTOR_POLL_HPD flag set in their &polled member. All
 527  * other connectors are ignored, which is useful to avoid reprobing fixed
 528  * panels.
 529  *
 530  * This helper function is useful for drivers which can't or don't track hotplug
 531  * interrupts for each connector.
 532  *
 533  * Drivers which support hotplug interrupts for each connector individually and
 534  * which have a more fine-grained detect logic should bypass this code and
 535  * directly call drm_kms_helper_hotplug_event() in case the connector state
 536  * changed.
 537  *
 538  * This function must be called from process context with no mode
 539  * setting locks held.
 540  *
 541  * Note that a connector can be both polled and probed from the hotplug handler,
 542  * in case the hotplug interrupt is known to be unreliable.
 543  */
 544 bool drm_helper_hpd_irq_event(struct drm_device *dev)
 545 {
 546         struct drm_connector *connector;
 547         enum drm_connector_status old_status;
 548         bool changed = false;
 549
 550         if (!dev->mode_config.poll_enabled)
 551                 return false;
 552
 553         mutex_lock(&dev->mode_config.mutex);
 554         drm_for_each_connector(connector, dev) {
 555
 556                 /* Only handle HPD capable connectors. */
 557                 if (!(connector->polled & DRM_CONNECTOR_POLL_HPD))
 558                         continue;
 559
 560                 old_status = connector->status;
 561
 562                 connector->status = connector->funcs->detect(connector, false);
 563                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] status updated from %s to %s\n",
 564                               connector->base.id,
 565                               connector->name,
 566                               drm_get_connector_status_name(old_status),
 567                               drm_get_connector_status_name(connector->status));
 568                 if (old_status != connector->status)
 569                         changed = true;
 570         }
 571
 572         mutex_unlock(&dev->mode_config.mutex);
 573
 574         if (changed)
 575                 drm_kms_helper_hotplug_event(dev);
 576
 577         return changed;
 578 }
 579 EXPORT_SYMBOL(drm_helper_hpd_irq_event);