2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
5 * DRM core CRTC related functions
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.
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
27 * Eric Anholt <eric@anholt.net>
28 * Dave Airlie <airlied@linux.ie>
29 * Jesse Barnes <jesse.barnes@intel.com>
32 #include <linux/export.h>
33 #include <linux/moduleparam.h>
35 #include <drm/drm_bridge.h>
36 #include <drm/drm_client.h>
37 #include <drm/drm_crtc.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_fourcc.h>
40 #include <drm/drm_modeset_helper_vtables.h>
41 #include <drm/drm_print.h>
42 #include <drm/drm_probe_helper.h>
43 #include <drm/drm_sysfs.h>
45 #include "drm_crtc_helper_internal.h"
48 * DOC: output probing helper overview
50 * This library provides some helper code for output probing. It provides an
51 * implementation of the core &drm_connector_funcs.fill_modes interface with
52 * drm_helper_probe_single_connector_modes().
54 * It also provides support for polling connectors with a work item and for
55 * generic hotplug interrupt handling where the driver doesn't or cannot keep
56 * track of a per-connector hpd interrupt.
58 * This helper library can be used independently of the modeset helper library.
59 * Drivers can also overwrite different parts e.g. use their own hotplug
60 * handling code to avoid probing unrelated outputs.
62 * The probe helpers share the function table structures with other display
63 * helper libraries. See &struct drm_connector_helper_funcs for the details.
66 static bool drm_kms_helper_poll = true;
67 module_param_named(poll, drm_kms_helper_poll, bool, 0600);
69 static enum drm_mode_status
70 drm_mode_validate_flag(const struct drm_display_mode *mode,
73 if ((mode->flags & DRM_MODE_FLAG_INTERLACE) &&
74 !(flags & DRM_MODE_FLAG_INTERLACE))
75 return MODE_NO_INTERLACE;
77 if ((mode->flags & DRM_MODE_FLAG_DBLSCAN) &&
78 !(flags & DRM_MODE_FLAG_DBLSCAN))
79 return MODE_NO_DBLESCAN;
81 if ((mode->flags & DRM_MODE_FLAG_3D_MASK) &&
82 !(flags & DRM_MODE_FLAG_3D_MASK))
83 return MODE_NO_STEREO;
89 drm_mode_validate_pipeline(struct drm_display_mode *mode,
90 struct drm_connector *connector,
91 struct drm_modeset_acquire_ctx *ctx,
92 enum drm_mode_status *status)
94 struct drm_device *dev = connector->dev;
95 struct drm_encoder *encoder;
98 /* Step 1: Validate against connector */
99 ret = drm_connector_mode_valid(connector, mode, ctx, status);
100 if (ret || *status != MODE_OK)
103 /* Step 2: Validate against encoders and crtcs */
104 drm_connector_for_each_possible_encoder(connector, encoder) {
105 struct drm_bridge *bridge;
106 struct drm_crtc *crtc;
108 *status = drm_encoder_mode_valid(encoder, mode);
109 if (*status != MODE_OK) {
110 /* No point in continuing for crtc check as this encoder
111 * will not accept the mode anyway. If all encoders
112 * reject the mode then, at exit, ret will not be
117 bridge = drm_bridge_chain_get_first_bridge(encoder);
118 *status = drm_bridge_chain_mode_valid(bridge,
119 &connector->display_info,
121 if (*status != MODE_OK) {
122 /* There is also no point in continuing for crtc check
127 drm_for_each_crtc(crtc, dev) {
128 if (!drm_encoder_crtc_ok(encoder, crtc))
131 *status = drm_crtc_mode_valid(crtc, mode);
132 if (*status == MODE_OK) {
133 /* If we get to this point there is at least
134 * one combination of encoder+crtc that works
135 * for this mode. Lets return now. */
144 static int drm_helper_probe_add_cmdline_mode(struct drm_connector *connector)
146 struct drm_cmdline_mode *cmdline_mode;
147 struct drm_display_mode *mode;
149 cmdline_mode = &connector->cmdline_mode;
150 if (!cmdline_mode->specified)
153 /* Only add a GTF mode if we find no matching probed modes */
154 list_for_each_entry(mode, &connector->probed_modes, head) {
155 if (mode->hdisplay != cmdline_mode->xres ||
156 mode->vdisplay != cmdline_mode->yres)
159 if (cmdline_mode->refresh_specified) {
160 /* The probed mode's vrefresh is set until later */
161 if (drm_mode_vrefresh(mode) != cmdline_mode->refresh)
165 /* Mark the matching mode as being preferred by the user */
166 mode->type |= DRM_MODE_TYPE_USERDEF;
170 mode = drm_mode_create_from_cmdline_mode(connector->dev,
175 drm_mode_probed_add(connector, mode);
179 enum drm_mode_status drm_crtc_mode_valid(struct drm_crtc *crtc,
180 const struct drm_display_mode *mode)
182 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
184 if (!crtc_funcs || !crtc_funcs->mode_valid)
187 return crtc_funcs->mode_valid(crtc, mode);
190 enum drm_mode_status drm_encoder_mode_valid(struct drm_encoder *encoder,
191 const struct drm_display_mode *mode)
193 const struct drm_encoder_helper_funcs *encoder_funcs =
194 encoder->helper_private;
196 if (!encoder_funcs || !encoder_funcs->mode_valid)
199 return encoder_funcs->mode_valid(encoder, mode);
203 drm_connector_mode_valid(struct drm_connector *connector,
204 struct drm_display_mode *mode,
205 struct drm_modeset_acquire_ctx *ctx,
206 enum drm_mode_status *status)
208 const struct drm_connector_helper_funcs *connector_funcs =
209 connector->helper_private;
212 if (!connector_funcs)
214 else if (connector_funcs->mode_valid_ctx)
215 ret = connector_funcs->mode_valid_ctx(connector, mode, ctx,
217 else if (connector_funcs->mode_valid)
218 *status = connector_funcs->mode_valid(connector, mode);
225 static void drm_kms_helper_disable_hpd(struct drm_device *dev)
227 struct drm_connector *connector;
228 struct drm_connector_list_iter conn_iter;
230 drm_connector_list_iter_begin(dev, &conn_iter);
231 drm_for_each_connector_iter(connector, &conn_iter) {
232 const struct drm_connector_helper_funcs *funcs =
233 connector->helper_private;
235 if (funcs && funcs->disable_hpd)
236 funcs->disable_hpd(connector);
238 drm_connector_list_iter_end(&conn_iter);
241 static bool drm_kms_helper_enable_hpd(struct drm_device *dev)
244 struct drm_connector *connector;
245 struct drm_connector_list_iter conn_iter;
247 drm_connector_list_iter_begin(dev, &conn_iter);
248 drm_for_each_connector_iter(connector, &conn_iter) {
249 const struct drm_connector_helper_funcs *funcs =
250 connector->helper_private;
252 if (funcs && funcs->enable_hpd)
253 funcs->enable_hpd(connector);
255 if (connector->polled & (DRM_CONNECTOR_POLL_CONNECT |
256 DRM_CONNECTOR_POLL_DISCONNECT))
259 drm_connector_list_iter_end(&conn_iter);
264 #define DRM_OUTPUT_POLL_PERIOD (10*HZ)
266 * drm_kms_helper_poll_enable - re-enable output polling.
269 * This function re-enables the output polling work, after it has been
270 * temporarily disabled using drm_kms_helper_poll_disable(), for example over
273 * Drivers can call this helper from their device resume implementation. It is
274 * not an error to call this even when output polling isn't enabled.
276 * Note that calls to enable and disable polling must be strictly ordered, which
277 * is automatically the case when they're only call from suspend/resume
280 void drm_kms_helper_poll_enable(struct drm_device *dev)
283 unsigned long delay = DRM_OUTPUT_POLL_PERIOD;
285 if (!dev->mode_config.poll_enabled || !drm_kms_helper_poll ||
286 dev->mode_config.poll_running)
289 poll = drm_kms_helper_enable_hpd(dev);
291 if (dev->mode_config.delayed_event) {
295 * Use short (1s) delay to handle the initial delayed event.
296 * This delay should not be needed, but Optimus/nouveau will
297 * fail in a mysterious way if the delayed event is handled as
298 * soon as possible like it is done in
299 * drm_helper_probe_single_connector_modes() in case the poll
300 * was enabled before.
307 schedule_delayed_work(&dev->mode_config.output_poll_work, delay);
309 dev->mode_config.poll_running = true;
311 EXPORT_SYMBOL(drm_kms_helper_poll_enable);
313 static enum drm_connector_status
314 drm_helper_probe_detect_ctx(struct drm_connector *connector, bool force)
316 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
317 struct drm_modeset_acquire_ctx ctx;
320 drm_modeset_acquire_init(&ctx, 0);
323 ret = drm_modeset_lock(&connector->dev->mode_config.connection_mutex, &ctx);
325 if (funcs->detect_ctx)
326 ret = funcs->detect_ctx(connector, &ctx, force);
327 else if (connector->funcs->detect)
328 ret = connector->funcs->detect(connector, force);
330 ret = connector_status_connected;
333 if (ret == -EDEADLK) {
334 drm_modeset_backoff(&ctx);
338 if (WARN_ON(ret < 0))
339 ret = connector_status_unknown;
341 if (ret != connector->status)
342 connector->epoch_counter += 1;
344 drm_modeset_drop_locks(&ctx);
345 drm_modeset_acquire_fini(&ctx);
351 * drm_helper_probe_detect - probe connector status
352 * @connector: connector to probe
353 * @ctx: acquire_ctx, or NULL to let this function handle locking.
354 * @force: Whether destructive probe operations should be performed.
356 * This function calls the detect callbacks of the connector.
357 * This function returns &drm_connector_status, or
358 * if @ctx is set, it might also return -EDEADLK.
361 drm_helper_probe_detect(struct drm_connector *connector,
362 struct drm_modeset_acquire_ctx *ctx,
365 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
366 struct drm_device *dev = connector->dev;
370 return drm_helper_probe_detect_ctx(connector, force);
372 ret = drm_modeset_lock(&dev->mode_config.connection_mutex, ctx);
376 if (funcs->detect_ctx)
377 ret = funcs->detect_ctx(connector, ctx, force);
378 else if (connector->funcs->detect)
379 ret = connector->funcs->detect(connector, force);
381 ret = connector_status_connected;
383 if (ret != connector->status)
384 connector->epoch_counter += 1;
388 EXPORT_SYMBOL(drm_helper_probe_detect);
390 static int drm_helper_probe_get_modes(struct drm_connector *connector)
392 const struct drm_connector_helper_funcs *connector_funcs =
393 connector->helper_private;
396 count = connector_funcs->get_modes(connector);
399 * Fallback for when DDC probe failed in drm_get_edid() and thus skipped
400 * override/firmware EDID.
402 if (count == 0 && connector->status == connector_status_connected)
403 count = drm_edid_override_connector_update(connector);
408 static int __drm_helper_update_and_validate(struct drm_connector *connector,
409 uint32_t maxX, uint32_t maxY,
410 struct drm_modeset_acquire_ctx *ctx)
412 struct drm_device *dev = connector->dev;
413 struct drm_display_mode *mode;
417 drm_connector_list_update(connector);
419 if (connector->interlace_allowed)
420 mode_flags |= DRM_MODE_FLAG_INTERLACE;
421 if (connector->doublescan_allowed)
422 mode_flags |= DRM_MODE_FLAG_DBLSCAN;
423 if (connector->stereo_allowed)
424 mode_flags |= DRM_MODE_FLAG_3D_MASK;
426 list_for_each_entry(mode, &connector->modes, head) {
427 if (mode->status != MODE_OK)
430 mode->status = drm_mode_validate_driver(dev, mode);
431 if (mode->status != MODE_OK)
434 mode->status = drm_mode_validate_size(mode, maxX, maxY);
435 if (mode->status != MODE_OK)
438 mode->status = drm_mode_validate_flag(mode, mode_flags);
439 if (mode->status != MODE_OK)
442 ret = drm_mode_validate_pipeline(mode, connector, ctx,
446 "drm_mode_validate_pipeline failed: %d\n",
449 if (drm_WARN_ON_ONCE(dev, ret != -EDEADLK))
450 mode->status = MODE_ERROR;
455 if (mode->status != MODE_OK)
457 mode->status = drm_mode_validate_ycbcr420(mode, connector);
464 * drm_helper_probe_single_connector_modes - get complete set of display modes
465 * @connector: connector to probe
466 * @maxX: max width for modes
467 * @maxY: max height for modes
469 * Based on the helper callbacks implemented by @connector in struct
470 * &drm_connector_helper_funcs try to detect all valid modes. Modes will first
471 * be added to the connector's probed_modes list, then culled (based on validity
472 * and the @maxX, @maxY parameters) and put into the normal modes list.
474 * Intended to be used as a generic implementation of the
475 * &drm_connector_funcs.fill_modes() vfunc for drivers that use the CRTC helpers
476 * for output mode filtering and detection.
478 * The basic procedure is as follows
480 * 1. All modes currently on the connector's modes list are marked as stale
482 * 2. New modes are added to the connector's probed_modes list with
483 * drm_mode_probed_add(). New modes start their life with status as OK.
484 * Modes are added from a single source using the following priority order.
486 * - &drm_connector_helper_funcs.get_modes vfunc
487 * - if the connector status is connector_status_connected, standard
488 * VESA DMT modes up to 1024x768 are automatically added
489 * (drm_add_modes_noedid())
491 * Finally modes specified via the kernel command line (video=...) are
492 * added in addition to what the earlier probes produced
493 * (drm_helper_probe_add_cmdline_mode()). These modes are generated
494 * using the VESA GTF/CVT formulas.
496 * 3. Modes are moved from the probed_modes list to the modes list. Potential
497 * duplicates are merged together (see drm_connector_list_update()).
498 * After this step the probed_modes list will be empty again.
500 * 4. Any non-stale mode on the modes list then undergoes validation
502 * - drm_mode_validate_basic() performs basic sanity checks
503 * - drm_mode_validate_size() filters out modes larger than @maxX and @maxY
505 * - drm_mode_validate_flag() checks the modes against basic connector
506 * capabilities (interlace_allowed,doublescan_allowed,stereo_allowed)
507 * - the optional &drm_connector_helper_funcs.mode_valid or
508 * &drm_connector_helper_funcs.mode_valid_ctx helpers can perform driver
509 * and/or sink specific checks
510 * - the optional &drm_crtc_helper_funcs.mode_valid,
511 * &drm_bridge_funcs.mode_valid and &drm_encoder_helper_funcs.mode_valid
512 * helpers can perform driver and/or source specific checks which are also
513 * enforced by the modeset/atomic helpers
515 * 5. Any mode whose status is not OK is pruned from the connector's modes list,
516 * accompanied by a debug message indicating the reason for the mode's
517 * rejection (see drm_mode_prune_invalid()).
520 * The number of modes found on @connector.
522 int drm_helper_probe_single_connector_modes(struct drm_connector *connector,
523 uint32_t maxX, uint32_t maxY)
525 struct drm_device *dev = connector->dev;
526 struct drm_display_mode *mode;
528 enum drm_connector_status old_status;
529 struct drm_modeset_acquire_ctx ctx;
531 WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
533 drm_modeset_acquire_init(&ctx, 0);
535 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n", connector->base.id,
539 ret = drm_modeset_lock(&dev->mode_config.connection_mutex, &ctx);
540 if (ret == -EDEADLK) {
541 drm_modeset_backoff(&ctx);
546 /* set all old modes to the stale state */
547 list_for_each_entry(mode, &connector->modes, head)
548 mode->status = MODE_STALE;
550 old_status = connector->status;
552 if (connector->force) {
553 if (connector->force == DRM_FORCE_ON ||
554 connector->force == DRM_FORCE_ON_DIGITAL)
555 connector->status = connector_status_connected;
557 connector->status = connector_status_disconnected;
558 if (connector->funcs->force)
559 connector->funcs->force(connector);
561 ret = drm_helper_probe_detect(connector, &ctx, true);
563 if (ret == -EDEADLK) {
564 drm_modeset_backoff(&ctx);
566 } else if (WARN(ret < 0, "Invalid return value %i for connector detection\n", ret))
567 ret = connector_status_unknown;
569 connector->status = ret;
573 * Normally either the driver's hpd code or the poll loop should
574 * pick up any changes and fire the hotplug event. But if
575 * userspace sneaks in a probe, we might miss a change. Hence
576 * check here, and if anything changed start the hotplug code.
578 if (old_status != connector->status) {
579 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] status updated from %s to %s\n",
582 drm_get_connector_status_name(old_status),
583 drm_get_connector_status_name(connector->status));
586 * The hotplug event code might call into the fb
587 * helpers, and so expects that we do not hold any
588 * locks. Fire up the poll struct instead, it will
589 * disable itself again.
591 dev->mode_config.delayed_event = true;
592 if (dev->mode_config.poll_enabled)
593 mod_delayed_work(system_wq,
594 &dev->mode_config.output_poll_work,
598 /* Re-enable polling in case the global poll config changed. */
599 drm_kms_helper_poll_enable(dev);
601 if (connector->status == connector_status_disconnected) {
602 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] disconnected\n",
603 connector->base.id, connector->name);
604 drm_connector_update_edid_property(connector, NULL);
605 drm_mode_prune_invalid(dev, &connector->modes, false);
609 count = drm_helper_probe_get_modes(connector);
611 if (count == 0 && (connector->status == connector_status_connected ||
612 connector->status == connector_status_unknown)) {
613 count = drm_add_modes_noedid(connector, 1024, 768);
616 * Section 4.2.2.6 (EDID Corruption Detection) of the DP 1.4a
617 * Link CTS specifies that 640x480 (the official "failsafe"
618 * mode) needs to be the default if there's no EDID.
620 if (connector->connector_type == DRM_MODE_CONNECTOR_DisplayPort)
621 drm_set_preferred_mode(connector, 640, 480);
623 count += drm_helper_probe_add_cmdline_mode(connector);
625 ret = __drm_helper_update_and_validate(connector, maxX, maxY, &ctx);
626 if (ret == -EDEADLK) {
627 drm_modeset_backoff(&ctx);
632 drm_mode_prune_invalid(dev, &connector->modes, true);
635 * Displayport spec section 5.2.1.2 ("Video Timing Format") says that
636 * all detachable sinks shall support 640x480 @60Hz as a fail safe
637 * mode. If all modes were pruned, perhaps because they need more
638 * lanes or a higher pixel clock than available, at least try to add
641 if (list_empty(&connector->modes) &&
642 connector->connector_type == DRM_MODE_CONNECTOR_DisplayPort) {
643 count = drm_add_modes_noedid(connector, 640, 480);
644 ret = __drm_helper_update_and_validate(connector, maxX, maxY, &ctx);
645 if (ret == -EDEADLK) {
646 drm_modeset_backoff(&ctx);
649 drm_mode_prune_invalid(dev, &connector->modes, true);
653 drm_modeset_drop_locks(&ctx);
654 drm_modeset_acquire_fini(&ctx);
656 if (list_empty(&connector->modes))
659 drm_mode_sort(&connector->modes);
661 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] probed modes :\n", connector->base.id,
663 list_for_each_entry(mode, &connector->modes, head) {
664 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
665 drm_mode_debug_printmodeline(mode);
670 EXPORT_SYMBOL(drm_helper_probe_single_connector_modes);
673 * drm_kms_helper_hotplug_event - fire off KMS hotplug events
674 * @dev: drm_device whose connector state changed
676 * This function fires off the uevent for userspace and also calls the
677 * output_poll_changed function, which is most commonly used to inform the fbdev
678 * emulation code and allow it to update the fbcon output configuration.
680 * Drivers should call this from their hotplug handling code when a change is
681 * detected. Note that this function does not do any output detection of its
682 * own, like drm_helper_hpd_irq_event() does - this is assumed to be done by the
685 * This function must be called from process context with no mode
686 * setting locks held.
688 * If only a single connector has changed, consider calling
689 * drm_kms_helper_connector_hotplug_event() instead.
691 void drm_kms_helper_hotplug_event(struct drm_device *dev)
693 /* send a uevent + call fbdev */
694 drm_sysfs_hotplug_event(dev);
695 if (dev->mode_config.funcs->output_poll_changed)
696 dev->mode_config.funcs->output_poll_changed(dev);
698 drm_client_dev_hotplug(dev);
700 EXPORT_SYMBOL(drm_kms_helper_hotplug_event);
703 * drm_kms_helper_connector_hotplug_event - fire off a KMS connector hotplug event
704 * @connector: drm_connector which has changed
706 * This is the same as drm_kms_helper_hotplug_event(), except it fires a more
707 * fine-grained uevent for a single connector.
709 void drm_kms_helper_connector_hotplug_event(struct drm_connector *connector)
711 struct drm_device *dev = connector->dev;
713 /* send a uevent + call fbdev */
714 drm_sysfs_connector_hotplug_event(connector);
715 if (dev->mode_config.funcs->output_poll_changed)
716 dev->mode_config.funcs->output_poll_changed(dev);
718 drm_client_dev_hotplug(dev);
720 EXPORT_SYMBOL(drm_kms_helper_connector_hotplug_event);
722 static void output_poll_execute(struct work_struct *work)
724 struct delayed_work *delayed_work = to_delayed_work(work);
725 struct drm_device *dev = container_of(delayed_work, struct drm_device, mode_config.output_poll_work);
726 struct drm_connector *connector;
727 struct drm_connector_list_iter conn_iter;
728 enum drm_connector_status old_status;
729 bool repoll = false, changed;
730 u64 old_epoch_counter;
732 if (!dev->mode_config.poll_enabled)
735 /* Pick up any changes detected by the probe functions. */
736 changed = dev->mode_config.delayed_event;
737 dev->mode_config.delayed_event = false;
739 if (!drm_kms_helper_poll && dev->mode_config.poll_running) {
740 drm_kms_helper_disable_hpd(dev);
741 dev->mode_config.poll_running = false;
745 if (!mutex_trylock(&dev->mode_config.mutex)) {
750 drm_connector_list_iter_begin(dev, &conn_iter);
751 drm_for_each_connector_iter(connector, &conn_iter) {
752 /* Ignore forced connectors. */
753 if (connector->force)
756 /* Ignore HPD capable connectors and connectors where we don't
757 * want any hotplug detection at all for polling. */
758 if (!connector->polled || connector->polled == DRM_CONNECTOR_POLL_HPD)
761 old_status = connector->status;
762 /* if we are connected and don't want to poll for disconnect
764 if (old_status == connector_status_connected &&
765 !(connector->polled & DRM_CONNECTOR_POLL_DISCONNECT))
770 old_epoch_counter = connector->epoch_counter;
771 connector->status = drm_helper_probe_detect(connector, NULL, false);
772 if (old_epoch_counter != connector->epoch_counter) {
773 const char *old, *new;
776 * The poll work sets force=false when calling detect so
777 * that drivers can avoid to do disruptive tests (e.g.
778 * when load detect cycles could cause flickering on
779 * other, running displays). This bears the risk that we
780 * flip-flop between unknown here in the poll work and
781 * the real state when userspace forces a full detect
782 * call after receiving a hotplug event due to this
785 * Hence clamp an unknown detect status to the old
788 if (connector->status == connector_status_unknown) {
789 connector->status = old_status;
793 old = drm_get_connector_status_name(old_status);
794 new = drm_get_connector_status_name(connector->status);
796 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] "
797 "status updated from %s to %s\n",
801 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] epoch counter %llu -> %llu\n",
802 connector->base.id, connector->name,
803 old_epoch_counter, connector->epoch_counter);
808 drm_connector_list_iter_end(&conn_iter);
810 mutex_unlock(&dev->mode_config.mutex);
814 drm_kms_helper_hotplug_event(dev);
817 schedule_delayed_work(delayed_work, DRM_OUTPUT_POLL_PERIOD);
821 * drm_kms_helper_is_poll_worker - is %current task an output poll worker?
823 * Determine if %current task is an output poll worker. This can be used
824 * to select distinct code paths for output polling versus other contexts.
826 * One use case is to avoid a deadlock between the output poll worker and
827 * the autosuspend worker wherein the latter waits for polling to finish
828 * upon calling drm_kms_helper_poll_disable(), while the former waits for
829 * runtime suspend to finish upon calling pm_runtime_get_sync() in a
830 * connector ->detect hook.
832 bool drm_kms_helper_is_poll_worker(void)
834 struct work_struct *work = current_work();
836 return work && work->func == output_poll_execute;
838 EXPORT_SYMBOL(drm_kms_helper_is_poll_worker);
841 * drm_kms_helper_poll_disable - disable output polling
844 * This function disables the output polling work.
846 * Drivers can call this helper from their device suspend implementation. It is
847 * not an error to call this even when output polling isn't enabled or already
848 * disabled. Polling is re-enabled by calling drm_kms_helper_poll_enable().
850 * Note that calls to enable and disable polling must be strictly ordered, which
851 * is automatically the case when they're only call from suspend/resume
854 void drm_kms_helper_poll_disable(struct drm_device *dev)
856 if (dev->mode_config.poll_running)
857 drm_kms_helper_disable_hpd(dev);
859 cancel_delayed_work_sync(&dev->mode_config.output_poll_work);
861 dev->mode_config.poll_running = false;
863 EXPORT_SYMBOL(drm_kms_helper_poll_disable);
866 * drm_kms_helper_poll_init - initialize and enable output polling
869 * This function initializes and then also enables output polling support for
870 * @dev. Drivers which do not have reliable hotplug support in hardware can use
871 * this helper infrastructure to regularly poll such connectors for changes in
872 * their connection state.
874 * Drivers can control which connectors are polled by setting the
875 * DRM_CONNECTOR_POLL_CONNECT and DRM_CONNECTOR_POLL_DISCONNECT flags. On
876 * connectors where probing live outputs can result in visual distortion drivers
877 * should not set the DRM_CONNECTOR_POLL_DISCONNECT flag to avoid this.
878 * Connectors which have no flag or only DRM_CONNECTOR_POLL_HPD set are
879 * completely ignored by the polling logic.
881 * Note that a connector can be both polled and probed from the hotplug handler,
882 * in case the hotplug interrupt is known to be unreliable.
884 void drm_kms_helper_poll_init(struct drm_device *dev)
886 INIT_DELAYED_WORK(&dev->mode_config.output_poll_work, output_poll_execute);
887 dev->mode_config.poll_enabled = true;
889 drm_kms_helper_poll_enable(dev);
891 EXPORT_SYMBOL(drm_kms_helper_poll_init);
894 * drm_kms_helper_poll_fini - disable output polling and clean it up
897 void drm_kms_helper_poll_fini(struct drm_device *dev)
899 if (!dev->mode_config.poll_enabled)
902 drm_kms_helper_poll_disable(dev);
904 dev->mode_config.poll_enabled = false;
906 EXPORT_SYMBOL(drm_kms_helper_poll_fini);
908 static bool check_connector_changed(struct drm_connector *connector)
910 struct drm_device *dev = connector->dev;
911 enum drm_connector_status old_status;
912 u64 old_epoch_counter;
914 /* Only handle HPD capable connectors. */
915 drm_WARN_ON(dev, !(connector->polled & DRM_CONNECTOR_POLL_HPD));
917 drm_WARN_ON(dev, !mutex_is_locked(&dev->mode_config.mutex));
919 old_status = connector->status;
920 old_epoch_counter = connector->epoch_counter;
921 connector->status = drm_helper_probe_detect(connector, NULL, false);
923 if (old_epoch_counter == connector->epoch_counter) {
924 drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Same epoch counter %llu\n",
927 connector->epoch_counter);
932 drm_dbg_kms(dev, "[CONNECTOR:%d:%s] status updated from %s to %s\n",
935 drm_get_connector_status_name(old_status),
936 drm_get_connector_status_name(connector->status));
938 drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Changed epoch counter %llu => %llu\n",
942 connector->epoch_counter);
948 * drm_connector_helper_hpd_irq_event - hotplug processing
949 * @connector: drm_connector
951 * Drivers can use this helper function to run a detect cycle on a connector
952 * which has the DRM_CONNECTOR_POLL_HPD flag set in its &polled member.
954 * This helper function is useful for drivers which can track hotplug
955 * interrupts for a single connector. Drivers that want to send a
956 * hotplug event for all connectors or can't track hotplug interrupts
957 * per connector need to use drm_helper_hpd_irq_event().
959 * This function must be called from process context with no mode
960 * setting locks held.
962 * Note that a connector can be both polled and probed from the hotplug
963 * handler, in case the hotplug interrupt is known to be unreliable.
966 * A boolean indicating whether the connector status changed or not
968 bool drm_connector_helper_hpd_irq_event(struct drm_connector *connector)
970 struct drm_device *dev = connector->dev;
973 mutex_lock(&dev->mode_config.mutex);
974 changed = check_connector_changed(connector);
975 mutex_unlock(&dev->mode_config.mutex);
978 drm_kms_helper_connector_hotplug_event(connector);
979 drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Sent hotplug event\n",
986 EXPORT_SYMBOL(drm_connector_helper_hpd_irq_event);
989 * drm_helper_hpd_irq_event - hotplug processing
992 * Drivers can use this helper function to run a detect cycle on all connectors
993 * which have the DRM_CONNECTOR_POLL_HPD flag set in their &polled member. All
994 * other connectors are ignored, which is useful to avoid reprobing fixed
997 * This helper function is useful for drivers which can't or don't track hotplug
998 * interrupts for each connector.
1000 * Drivers which support hotplug interrupts for each connector individually and
1001 * which have a more fine-grained detect logic can use
1002 * drm_connector_helper_hpd_irq_event(). Alternatively, they should bypass this
1003 * code and directly call drm_kms_helper_hotplug_event() in case the connector
1006 * This function must be called from process context with no mode
1007 * setting locks held.
1009 * Note that a connector can be both polled and probed from the hotplug handler,
1010 * in case the hotplug interrupt is known to be unreliable.
1013 * A boolean indicating whether the connector status changed or not
1015 bool drm_helper_hpd_irq_event(struct drm_device *dev)
1017 struct drm_connector *connector, *first_changed_connector = NULL;
1018 struct drm_connector_list_iter conn_iter;
1021 if (!dev->mode_config.poll_enabled)
1024 mutex_lock(&dev->mode_config.mutex);
1025 drm_connector_list_iter_begin(dev, &conn_iter);
1026 drm_for_each_connector_iter(connector, &conn_iter) {
1027 /* Only handle HPD capable connectors. */
1028 if (!(connector->polled & DRM_CONNECTOR_POLL_HPD))
1031 if (check_connector_changed(connector)) {
1032 if (!first_changed_connector) {
1033 drm_connector_get(connector);
1034 first_changed_connector = connector;
1040 drm_connector_list_iter_end(&conn_iter);
1041 mutex_unlock(&dev->mode_config.mutex);
1044 drm_kms_helper_connector_hotplug_event(first_changed_connector);
1045 else if (changed > 0)
1046 drm_kms_helper_hotplug_event(dev);
1048 if (first_changed_connector)
1049 drm_connector_put(first_changed_connector);
1053 EXPORT_SYMBOL(drm_helper_hpd_irq_event);
1056 * drm_crtc_helper_mode_valid_fixed - Validates a display mode
1058 * @mode: the mode to validate
1059 * @fixed_mode: the display hardware's mode
1062 * MODE_OK on success, or another mode-status code otherwise.
1064 enum drm_mode_status drm_crtc_helper_mode_valid_fixed(struct drm_crtc *crtc,
1065 const struct drm_display_mode *mode,
1066 const struct drm_display_mode *fixed_mode)
1068 if (mode->hdisplay != fixed_mode->hdisplay && mode->vdisplay != fixed_mode->vdisplay)
1069 return MODE_ONE_SIZE;
1070 else if (mode->hdisplay != fixed_mode->hdisplay)
1071 return MODE_ONE_WIDTH;
1072 else if (mode->vdisplay != fixed_mode->vdisplay)
1073 return MODE_ONE_HEIGHT;
1077 EXPORT_SYMBOL(drm_crtc_helper_mode_valid_fixed);
1080 * drm_connector_helper_get_modes_from_ddc - Updates the connector's EDID
1081 * property from the connector's
1083 * @connector: The connector
1086 * The number of detected display modes.
1088 * Uses a connector's DDC channel to retrieve EDID data and update the
1089 * connector's EDID property and display modes. Drivers can use this
1090 * function to implement struct &drm_connector_helper_funcs.get_modes
1091 * for connectors with a DDC channel.
1093 int drm_connector_helper_get_modes_from_ddc(struct drm_connector *connector)
1098 if (!connector->ddc)
1101 edid = drm_get_edid(connector, connector->ddc);
1103 // clears property if EDID is NULL
1104 drm_connector_update_edid_property(connector, edid);
1107 count = drm_add_edid_modes(connector, edid);
1113 EXPORT_SYMBOL(drm_connector_helper_get_modes_from_ddc);
1116 * drm_connector_helper_get_modes_fixed - Duplicates a display mode for a connector
1117 * @connector: the connector
1118 * @fixed_mode: the display hardware's mode
1120 * This function duplicates a display modes for a connector. Drivers for hardware
1121 * that only supports a single fixed mode can use this function in their connector's
1125 * The number of created modes.
1127 int drm_connector_helper_get_modes_fixed(struct drm_connector *connector,
1128 const struct drm_display_mode *fixed_mode)
1130 struct drm_device *dev = connector->dev;
1131 struct drm_display_mode *mode;
1133 mode = drm_mode_duplicate(dev, fixed_mode);
1135 drm_err(dev, "Failed to duplicate mode " DRM_MODE_FMT "\n",
1136 DRM_MODE_ARG(fixed_mode));
1140 if (mode->name[0] == '\0')
1141 drm_mode_set_name(mode);
1143 mode->type |= DRM_MODE_TYPE_PREFERRED;
1144 drm_mode_probed_add(connector, mode);
1147 connector->display_info.width_mm = mode->width_mm;
1148 if (mode->height_mm)
1149 connector->display_info.height_mm = mode->height_mm;
1153 EXPORT_SYMBOL(drm_connector_helper_get_modes_fixed);
1156 * drm_connector_helper_get_modes - Read EDID and update connector.
1157 * @connector: The connector
1159 * Read the EDID using drm_edid_read() (which requires that connector->ddc is
1160 * set), and update the connector using the EDID.
1162 * This can be used as the "default" connector helper .get_modes() hook if the
1163 * driver does not need any special processing. This is sets the example what
1164 * custom .get_modes() hooks should do regarding EDID read and connector update.
1166 * Returns: Number of modes.
1168 int drm_connector_helper_get_modes(struct drm_connector *connector)
1170 const struct drm_edid *drm_edid;
1173 drm_edid = drm_edid_read(connector);
1176 * Unconditionally update the connector. If the EDID was read
1177 * successfully, fill in the connector information derived from the
1178 * EDID. Otherwise, if the EDID is NULL, clear the connector
1181 drm_edid_connector_update(connector, drm_edid);
1183 count = drm_edid_connector_add_modes(connector);
1185 drm_edid_free(drm_edid);
1189 EXPORT_SYMBOL(drm_connector_helper_get_modes);
1192 * drm_connector_helper_tv_get_modes - Fills the modes availables to a TV connector
1193 * @connector: The connector
1195 * Fills the available modes for a TV connector based on the supported
1196 * TV modes, and the default mode expressed by the kernel command line.
1198 * This can be used as the default TV connector helper .get_modes() hook
1199 * if the driver does not need any special processing.
1202 * The number of modes added to the connector.
1204 int drm_connector_helper_tv_get_modes(struct drm_connector *connector)
1206 struct drm_device *dev = connector->dev;
1207 struct drm_property *tv_mode_property =
1208 dev->mode_config.tv_mode_property;
1209 struct drm_cmdline_mode *cmdline = &connector->cmdline_mode;
1210 unsigned int ntsc_modes = BIT(DRM_MODE_TV_MODE_NTSC) |
1211 BIT(DRM_MODE_TV_MODE_NTSC_443) |
1212 BIT(DRM_MODE_TV_MODE_NTSC_J) |
1213 BIT(DRM_MODE_TV_MODE_PAL_M);
1214 unsigned int pal_modes = BIT(DRM_MODE_TV_MODE_PAL) |
1215 BIT(DRM_MODE_TV_MODE_PAL_N) |
1216 BIT(DRM_MODE_TV_MODE_SECAM);
1217 unsigned int tv_modes[2] = { UINT_MAX, UINT_MAX };
1218 unsigned int i, supported_tv_modes = 0;
1220 if (!tv_mode_property)
1223 for (i = 0; i < tv_mode_property->num_values; i++)
1224 supported_tv_modes |= BIT(tv_mode_property->values[i]);
1226 if ((supported_tv_modes & ntsc_modes) &&
1227 (supported_tv_modes & pal_modes)) {
1228 uint64_t default_mode;
1230 if (drm_object_property_get_default_value(&connector->base,
1235 if (cmdline->tv_mode_specified)
1236 default_mode = cmdline->tv_mode;
1238 if (BIT(default_mode) & ntsc_modes) {
1239 tv_modes[0] = DRM_MODE_TV_MODE_NTSC;
1240 tv_modes[1] = DRM_MODE_TV_MODE_PAL;
1242 tv_modes[0] = DRM_MODE_TV_MODE_PAL;
1243 tv_modes[1] = DRM_MODE_TV_MODE_NTSC;
1245 } else if (supported_tv_modes & ntsc_modes) {
1246 tv_modes[0] = DRM_MODE_TV_MODE_NTSC;
1247 } else if (supported_tv_modes & pal_modes) {
1248 tv_modes[0] = DRM_MODE_TV_MODE_PAL;
1253 for (i = 0; i < ARRAY_SIZE(tv_modes); i++) {
1254 struct drm_display_mode *mode;
1256 if (tv_modes[i] == DRM_MODE_TV_MODE_NTSC)
1257 mode = drm_mode_analog_ntsc_480i(dev);
1258 else if (tv_modes[i] == DRM_MODE_TV_MODE_PAL)
1259 mode = drm_mode_analog_pal_576i(dev);
1265 mode->type |= DRM_MODE_TYPE_PREFERRED;
1266 drm_mode_probed_add(connector, mode);
1271 EXPORT_SYMBOL(drm_connector_helper_tv_get_modes);