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/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_fb_helper.h>
40 #include <drm/drm_fourcc.h>
41 #include <drm/drm_modeset_helper_vtables.h>
42 #include <drm/drm_print.h>
43 #include <drm/drm_probe_helper.h>
44 #include <drm/drm_sysfs.h>
45 
46 #include "drm_crtc_helper_internal.h"
47 
48 /**
49  * DOC: output probing helper overview
50  *
51  * This library provides some helper code for output probing. It provides an
52  * implementation of the core &drm_connector_funcs.fill_modes interface with
53  * drm_helper_probe_single_connector_modes().
54  *
55  * It also provides support for polling connectors with a work item and for
56  * generic hotplug interrupt handling where the driver doesn't or cannot keep
57  * track of a per-connector hpd interrupt.
58  *
59  * This helper library can be used independently of the modeset helper library.
60  * Drivers can also overwrite different parts e.g. use their own hotplug
61  * handling code to avoid probing unrelated outputs.
62  *
63  * The probe helpers share the function table structures with other display
64  * helper libraries. See &struct drm_connector_helper_funcs for the details.
65  */
66 
67 static bool drm_kms_helper_poll = true;
68 module_param_named(poll, drm_kms_helper_poll, bool, 0600);
69 
70 static enum drm_mode_status
71 drm_mode_validate_flag(const struct drm_display_mode *mode,
72 		       int flags)
73 {
74 	if ((mode->flags & DRM_MODE_FLAG_INTERLACE) &&
75 	    !(flags & DRM_MODE_FLAG_INTERLACE))
76 		return MODE_NO_INTERLACE;
77 
78 	if ((mode->flags & DRM_MODE_FLAG_DBLSCAN) &&
79 	    !(flags & DRM_MODE_FLAG_DBLSCAN))
80 		return MODE_NO_DBLESCAN;
81 
82 	if ((mode->flags & DRM_MODE_FLAG_3D_MASK) &&
83 	    !(flags & DRM_MODE_FLAG_3D_MASK))
84 		return MODE_NO_STEREO;
85 
86 	return MODE_OK;
87 }
88 
89 static int
90 drm_mode_validate_pipeline(struct drm_display_mode *mode,
91 			   struct drm_connector *connector,
92 			   struct drm_modeset_acquire_ctx *ctx,
93 			   enum drm_mode_status *status)
94 {
95 	struct drm_device *dev = connector->dev;
96 	struct drm_encoder *encoder;
97 	int ret;
98 
99 	/* Step 1: Validate against connector */
100 	ret = drm_connector_mode_valid(connector, mode, ctx, status);
101 	if (ret || *status != MODE_OK)
102 		return ret;
103 
104 	/* Step 2: Validate against encoders and crtcs */
105 	drm_connector_for_each_possible_encoder(connector, encoder) {
106 		struct drm_bridge *bridge;
107 		struct drm_crtc *crtc;
108 
109 		*status = drm_encoder_mode_valid(encoder, mode);
110 		if (*status != MODE_OK) {
111 			/* No point in continuing for crtc check as this encoder
112 			 * will not accept the mode anyway. If all encoders
113 			 * reject the mode then, at exit, ret will not be
114 			 * MODE_OK. */
115 			continue;
116 		}
117 
118 		bridge = drm_bridge_chain_get_first_bridge(encoder);
119 		*status = drm_bridge_chain_mode_valid(bridge,
120 						      &connector->display_info,
121 						      mode);
122 		if (*status != MODE_OK) {
123 			/* There is also no point in continuing for crtc check
124 			 * here. */
125 			continue;
126 		}
127 
128 		drm_for_each_crtc(crtc, dev) {
129 			if (!drm_encoder_crtc_ok(encoder, crtc))
130 				continue;
131 
132 			*status = drm_crtc_mode_valid(crtc, mode);
133 			if (*status == MODE_OK) {
134 				/* If we get to this point there is at least
135 				 * one combination of encoder+crtc that works
136 				 * for this mode. Lets return now. */
137 				return 0;
138 			}
139 		}
140 	}
141 
142 	return 0;
143 }
144 
145 static int drm_helper_probe_add_cmdline_mode(struct drm_connector *connector)
146 {
147 	struct drm_cmdline_mode *cmdline_mode;
148 	struct drm_display_mode *mode;
149 
150 	cmdline_mode = &connector->cmdline_mode;
151 	if (!cmdline_mode->specified)
152 		return 0;
153 
154 	/* Only add a GTF mode if we find no matching probed modes */
155 	list_for_each_entry(mode, &connector->probed_modes, head) {
156 		if (mode->hdisplay != cmdline_mode->xres ||
157 		    mode->vdisplay != cmdline_mode->yres)
158 			continue;
159 
160 		if (cmdline_mode->refresh_specified) {
161 			/* The probed mode's vrefresh is set until later */
162 			if (drm_mode_vrefresh(mode) != cmdline_mode->refresh)
163 				continue;
164 		}
165 
166 		/* Mark the matching mode as being preferred by the user */
167 		mode->type |= DRM_MODE_TYPE_USERDEF;
168 		return 0;
169 	}
170 
171 	mode = drm_mode_create_from_cmdline_mode(connector->dev,
172 						 cmdline_mode);
173 	if (mode == NULL)
174 		return 0;
175 
176 	drm_mode_probed_add(connector, mode);
177 	return 1;
178 }
179 
180 enum drm_mode_status drm_crtc_mode_valid(struct drm_crtc *crtc,
181 					 const struct drm_display_mode *mode)
182 {
183 	const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
184 
185 	if (!crtc_funcs || !crtc_funcs->mode_valid)
186 		return MODE_OK;
187 
188 	return crtc_funcs->mode_valid(crtc, mode);
189 }
190 
191 enum drm_mode_status drm_encoder_mode_valid(struct drm_encoder *encoder,
192 					    const struct drm_display_mode *mode)
193 {
194 	const struct drm_encoder_helper_funcs *encoder_funcs =
195 		encoder->helper_private;
196 
197 	if (!encoder_funcs || !encoder_funcs->mode_valid)
198 		return MODE_OK;
199 
200 	return encoder_funcs->mode_valid(encoder, mode);
201 }
202 
203 int
204 drm_connector_mode_valid(struct drm_connector *connector,
205 			 struct drm_display_mode *mode,
206 			 struct drm_modeset_acquire_ctx *ctx,
207 			 enum drm_mode_status *status)
208 {
209 	const struct drm_connector_helper_funcs *connector_funcs =
210 		connector->helper_private;
211 	int ret = 0;
212 
213 	if (!connector_funcs)
214 		*status = MODE_OK;
215 	else if (connector_funcs->mode_valid_ctx)
216 		ret = connector_funcs->mode_valid_ctx(connector, mode, ctx,
217 						      status);
218 	else if (connector_funcs->mode_valid)
219 		*status = connector_funcs->mode_valid(connector, mode);
220 	else
221 		*status = MODE_OK;
222 
223 	return ret;
224 }
225 
226 #define DRM_OUTPUT_POLL_PERIOD (10*HZ)
227 /**
228  * drm_kms_helper_poll_enable - re-enable output polling.
229  * @dev: drm_device
230  *
231  * This function re-enables the output polling work, after it has been
232  * temporarily disabled using drm_kms_helper_poll_disable(), for example over
233  * suspend/resume.
234  *
235  * Drivers can call this helper from their device resume implementation. It is
236  * not an error to call this even when output polling isn't enabled.
237  *
238  * Note that calls to enable and disable polling must be strictly ordered, which
239  * is automatically the case when they're only call from suspend/resume
240  * callbacks.
241  */
242 void drm_kms_helper_poll_enable(struct drm_device *dev)
243 {
244 	bool poll = false;
245 	struct drm_connector *connector;
246 	struct drm_connector_list_iter conn_iter;
247 	unsigned long delay = DRM_OUTPUT_POLL_PERIOD;
248 
249 	if (!dev->mode_config.poll_enabled || !drm_kms_helper_poll)
250 		return;
251 
252 	drm_connector_list_iter_begin(dev, &conn_iter);
253 	drm_for_each_connector_iter(connector, &conn_iter) {
254 		if (connector->polled & (DRM_CONNECTOR_POLL_CONNECT |
255 					 DRM_CONNECTOR_POLL_DISCONNECT))
256 			poll = true;
257 	}
258 	drm_connector_list_iter_end(&conn_iter);
259 
260 	if (dev->mode_config.delayed_event) {
261 		/*
262 		 * FIXME:
263 		 *
264 		 * Use short (1s) delay to handle the initial delayed event.
265 		 * This delay should not be needed, but Optimus/nouveau will
266 		 * fail in a mysterious way if the delayed event is handled as
267 		 * soon as possible like it is done in
268 		 * drm_helper_probe_single_connector_modes() in case the poll
269 		 * was enabled before.
270 		 */
271 		poll = true;
272 		delay = HZ;
273 	}
274 
275 	if (poll)
276 		schedule_delayed_work(&dev->mode_config.output_poll_work, delay);
277 }
278 EXPORT_SYMBOL(drm_kms_helper_poll_enable);
279 
280 static enum drm_connector_status
281 drm_helper_probe_detect_ctx(struct drm_connector *connector, bool force)
282 {
283 	const struct drm_connector_helper_funcs *funcs = connector->helper_private;
284 	struct drm_modeset_acquire_ctx ctx;
285 	int ret;
286 
287 	drm_modeset_acquire_init(&ctx, 0);
288 
289 retry:
290 	ret = drm_modeset_lock(&connector->dev->mode_config.connection_mutex, &ctx);
291 	if (!ret) {
292 		if (funcs->detect_ctx)
293 			ret = funcs->detect_ctx(connector, &ctx, force);
294 		else if (connector->funcs->detect)
295 			ret = connector->funcs->detect(connector, force);
296 		else
297 			ret = connector_status_connected;
298 	}
299 
300 	if (ret == -EDEADLK) {
301 		drm_modeset_backoff(&ctx);
302 		goto retry;
303 	}
304 
305 	if (WARN_ON(ret < 0))
306 		ret = connector_status_unknown;
307 
308 	if (ret != connector->status)
309 		connector->epoch_counter += 1;
310 
311 	drm_modeset_drop_locks(&ctx);
312 	drm_modeset_acquire_fini(&ctx);
313 
314 	return ret;
315 }
316 
317 /**
318  * drm_helper_probe_detect - probe connector status
319  * @connector: connector to probe
320  * @ctx: acquire_ctx, or NULL to let this function handle locking.
321  * @force: Whether destructive probe operations should be performed.
322  *
323  * This function calls the detect callbacks of the connector.
324  * This function returns &drm_connector_status, or
325  * if @ctx is set, it might also return -EDEADLK.
326  */
327 int
328 drm_helper_probe_detect(struct drm_connector *connector,
329 			struct drm_modeset_acquire_ctx *ctx,
330 			bool force)
331 {
332 	const struct drm_connector_helper_funcs *funcs = connector->helper_private;
333 	struct drm_device *dev = connector->dev;
334 	int ret;
335 
336 	if (!ctx)
337 		return drm_helper_probe_detect_ctx(connector, force);
338 
339 	ret = drm_modeset_lock(&dev->mode_config.connection_mutex, ctx);
340 	if (ret)
341 		return ret;
342 
343 	if (funcs->detect_ctx)
344 		ret = funcs->detect_ctx(connector, ctx, force);
345 	else if (connector->funcs->detect)
346 		ret = connector->funcs->detect(connector, force);
347 	else
348 		ret = connector_status_connected;
349 
350 	if (ret != connector->status)
351 		connector->epoch_counter += 1;
352 
353 	return ret;
354 }
355 EXPORT_SYMBOL(drm_helper_probe_detect);
356 
357 static int __drm_helper_update_and_validate(struct drm_connector *connector,
358 					    uint32_t maxX, uint32_t maxY,
359 					    struct drm_modeset_acquire_ctx *ctx)
360 {
361 	struct drm_device *dev = connector->dev;
362 	struct drm_display_mode *mode;
363 	int mode_flags = 0;
364 	int ret;
365 
366 	drm_connector_list_update(connector);
367 
368 	if (connector->interlace_allowed)
369 		mode_flags |= DRM_MODE_FLAG_INTERLACE;
370 	if (connector->doublescan_allowed)
371 		mode_flags |= DRM_MODE_FLAG_DBLSCAN;
372 	if (connector->stereo_allowed)
373 		mode_flags |= DRM_MODE_FLAG_3D_MASK;
374 
375 	list_for_each_entry(mode, &connector->modes, head) {
376 		if (mode->status != MODE_OK)
377 			continue;
378 
379 		mode->status = drm_mode_validate_driver(dev, mode);
380 		if (mode->status != MODE_OK)
381 			continue;
382 
383 		mode->status = drm_mode_validate_size(mode, maxX, maxY);
384 		if (mode->status != MODE_OK)
385 			continue;
386 
387 		mode->status = drm_mode_validate_flag(mode, mode_flags);
388 		if (mode->status != MODE_OK)
389 			continue;
390 
391 		ret = drm_mode_validate_pipeline(mode, connector, ctx,
392 						 &mode->status);
393 		if (ret) {
394 			drm_dbg_kms(dev,
395 				    "drm_mode_validate_pipeline failed: %d\n",
396 				    ret);
397 
398 			if (drm_WARN_ON_ONCE(dev, ret != -EDEADLK))
399 				mode->status = MODE_ERROR;
400 			else
401 				return -EDEADLK;
402 		}
403 
404 		if (mode->status != MODE_OK)
405 			continue;
406 		mode->status = drm_mode_validate_ycbcr420(mode, connector);
407 	}
408 
409 	return 0;
410 }
411 
412 /**
413  * drm_helper_probe_single_connector_modes - get complete set of display modes
414  * @connector: connector to probe
415  * @maxX: max width for modes
416  * @maxY: max height for modes
417  *
418  * Based on the helper callbacks implemented by @connector in struct
419  * &drm_connector_helper_funcs try to detect all valid modes.  Modes will first
420  * be added to the connector's probed_modes list, then culled (based on validity
421  * and the @maxX, @maxY parameters) and put into the normal modes list.
422  *
423  * Intended to be used as a generic implementation of the
424  * &drm_connector_funcs.fill_modes() vfunc for drivers that use the CRTC helpers
425  * for output mode filtering and detection.
426  *
427  * The basic procedure is as follows
428  *
429  * 1. All modes currently on the connector's modes list are marked as stale
430  *
431  * 2. New modes are added to the connector's probed_modes list with
432  *    drm_mode_probed_add(). New modes start their life with status as OK.
433  *    Modes are added from a single source using the following priority order.
434  *
435  *    - &drm_connector_helper_funcs.get_modes vfunc
436  *    - if the connector status is connector_status_connected, standard
437  *      VESA DMT modes up to 1024x768 are automatically added
438  *      (drm_add_modes_noedid())
439  *
440  *    Finally modes specified via the kernel command line (video=...) are
441  *    added in addition to what the earlier probes produced
442  *    (drm_helper_probe_add_cmdline_mode()). These modes are generated
443  *    using the VESA GTF/CVT formulas.
444  *
445  * 3. Modes are moved from the probed_modes list to the modes list. Potential
446  *    duplicates are merged together (see drm_connector_list_update()).
447  *    After this step the probed_modes list will be empty again.
448  *
449  * 4. Any non-stale mode on the modes list then undergoes validation
450  *
451  *    - drm_mode_validate_basic() performs basic sanity checks
452  *    - drm_mode_validate_size() filters out modes larger than @maxX and @maxY
453  *      (if specified)
454  *    - drm_mode_validate_flag() checks the modes against basic connector
455  *      capabilities (interlace_allowed,doublescan_allowed,stereo_allowed)
456  *    - the optional &drm_connector_helper_funcs.mode_valid or
457  *      &drm_connector_helper_funcs.mode_valid_ctx helpers can perform driver
458  *      and/or sink specific checks
459  *    - the optional &drm_crtc_helper_funcs.mode_valid,
460  *      &drm_bridge_funcs.mode_valid and &drm_encoder_helper_funcs.mode_valid
461  *      helpers can perform driver and/or source specific checks which are also
462  *      enforced by the modeset/atomic helpers
463  *
464  * 5. Any mode whose status is not OK is pruned from the connector's modes list,
465  *    accompanied by a debug message indicating the reason for the mode's
466  *    rejection (see drm_mode_prune_invalid()).
467  *
468  * Returns:
469  * The number of modes found on @connector.
470  */
471 int drm_helper_probe_single_connector_modes(struct drm_connector *connector,
472 					    uint32_t maxX, uint32_t maxY)
473 {
474 	struct drm_device *dev = connector->dev;
475 	struct drm_display_mode *mode;
476 	const struct drm_connector_helper_funcs *connector_funcs =
477 		connector->helper_private;
478 	int count = 0, ret;
479 	enum drm_connector_status old_status;
480 	struct drm_modeset_acquire_ctx ctx;
481 
482 	WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
483 
484 	drm_modeset_acquire_init(&ctx, 0);
485 
486 	DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n", connector->base.id,
487 			connector->name);
488 
489 retry:
490 	ret = drm_modeset_lock(&dev->mode_config.connection_mutex, &ctx);
491 	if (ret == -EDEADLK) {
492 		drm_modeset_backoff(&ctx);
493 		goto retry;
494 	} else
495 		WARN_ON(ret < 0);
496 
497 	/* set all old modes to the stale state */
498 	list_for_each_entry(mode, &connector->modes, head)
499 		mode->status = MODE_STALE;
500 
501 	old_status = connector->status;
502 
503 	if (connector->force) {
504 		if (connector->force == DRM_FORCE_ON ||
505 		    connector->force == DRM_FORCE_ON_DIGITAL)
506 			connector->status = connector_status_connected;
507 		else
508 			connector->status = connector_status_disconnected;
509 		if (connector->funcs->force)
510 			connector->funcs->force(connector);
511 	} else {
512 		ret = drm_helper_probe_detect(connector, &ctx, true);
513 
514 		if (ret == -EDEADLK) {
515 			drm_modeset_backoff(&ctx);
516 			goto retry;
517 		} else if (WARN(ret < 0, "Invalid return value %i for connector detection\n", ret))
518 			ret = connector_status_unknown;
519 
520 		connector->status = ret;
521 	}
522 
523 	/*
524 	 * Normally either the driver's hpd code or the poll loop should
525 	 * pick up any changes and fire the hotplug event. But if
526 	 * userspace sneaks in a probe, we might miss a change. Hence
527 	 * check here, and if anything changed start the hotplug code.
528 	 */
529 	if (old_status != connector->status) {
530 		DRM_DEBUG_KMS("[CONNECTOR:%d:%s] status updated from %s to %s\n",
531 			      connector->base.id,
532 			      connector->name,
533 			      drm_get_connector_status_name(old_status),
534 			      drm_get_connector_status_name(connector->status));
535 
536 		/*
537 		 * The hotplug event code might call into the fb
538 		 * helpers, and so expects that we do not hold any
539 		 * locks. Fire up the poll struct instead, it will
540 		 * disable itself again.
541 		 */
542 		dev->mode_config.delayed_event = true;
543 		if (dev->mode_config.poll_enabled)
544 			schedule_delayed_work(&dev->mode_config.output_poll_work,
545 					      0);
546 	}
547 
548 	/* Re-enable polling in case the global poll config changed. */
549 	if (drm_kms_helper_poll != dev->mode_config.poll_running)
550 		drm_kms_helper_poll_enable(dev);
551 
552 	dev->mode_config.poll_running = drm_kms_helper_poll;
553 
554 	if (connector->status == connector_status_disconnected) {
555 		DRM_DEBUG_KMS("[CONNECTOR:%d:%s] disconnected\n",
556 			connector->base.id, connector->name);
557 		drm_connector_update_edid_property(connector, NULL);
558 		drm_mode_prune_invalid(dev, &connector->modes, false);
559 		goto exit;
560 	}
561 
562 	count = (*connector_funcs->get_modes)(connector);
563 
564 	/*
565 	 * Fallback for when DDC probe failed in drm_get_edid() and thus skipped
566 	 * override/firmware EDID.
567 	 */
568 	if (count == 0 && connector->status == connector_status_connected)
569 		count = drm_add_override_edid_modes(connector);
570 
571 	if (count == 0 && (connector->status == connector_status_connected ||
572 			   connector->status == connector_status_unknown))
573 		count = drm_add_modes_noedid(connector, 1024, 768);
574 	count += drm_helper_probe_add_cmdline_mode(connector);
575 	if (count != 0) {
576 		ret = __drm_helper_update_and_validate(connector, maxX, maxY, &ctx);
577 		if (ret == -EDEADLK) {
578 			drm_modeset_backoff(&ctx);
579 			goto retry;
580 		}
581 	}
582 
583 	drm_mode_prune_invalid(dev, &connector->modes, true);
584 
585 	/*
586 	 * Displayport spec section 5.2.1.2 ("Video Timing Format") says that
587 	 * all detachable sinks shall support 640x480 @60Hz as a fail safe
588 	 * mode. If all modes were pruned, perhaps because they need more
589 	 * lanes or a higher pixel clock than available, at least try to add
590 	 * in 640x480.
591 	 */
592 	if (list_empty(&connector->modes) &&
593 	    connector->connector_type == DRM_MODE_CONNECTOR_DisplayPort) {
594 		count = drm_add_modes_noedid(connector, 640, 480);
595 		ret = __drm_helper_update_and_validate(connector, maxX, maxY, &ctx);
596 		if (ret == -EDEADLK) {
597 			drm_modeset_backoff(&ctx);
598 			goto retry;
599 		}
600 		drm_mode_prune_invalid(dev, &connector->modes, true);
601 	}
602 
603 exit:
604 	drm_modeset_drop_locks(&ctx);
605 	drm_modeset_acquire_fini(&ctx);
606 
607 	if (list_empty(&connector->modes))
608 		return 0;
609 
610 	drm_mode_sort(&connector->modes);
611 
612 	DRM_DEBUG_KMS("[CONNECTOR:%d:%s] probed modes :\n", connector->base.id,
613 			connector->name);
614 	list_for_each_entry(mode, &connector->modes, head) {
615 		drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
616 		drm_mode_debug_printmodeline(mode);
617 	}
618 
619 	return count;
620 }
621 EXPORT_SYMBOL(drm_helper_probe_single_connector_modes);
622 
623 /**
624  * drm_kms_helper_hotplug_event - fire off KMS hotplug events
625  * @dev: drm_device whose connector state changed
626  *
627  * This function fires off the uevent for userspace and also calls the
628  * output_poll_changed function, which is most commonly used to inform the fbdev
629  * emulation code and allow it to update the fbcon output configuration.
630  *
631  * Drivers should call this from their hotplug handling code when a change is
632  * detected. Note that this function does not do any output detection of its
633  * own, like drm_helper_hpd_irq_event() does - this is assumed to be done by the
634  * driver already.
635  *
636  * This function must be called from process context with no mode
637  * setting locks held.
638  *
639  * If only a single connector has changed, consider calling
640  * drm_kms_helper_connector_hotplug_event() instead.
641  */
642 void drm_kms_helper_hotplug_event(struct drm_device *dev)
643 {
644 	/* send a uevent + call fbdev */
645 	drm_sysfs_hotplug_event(dev);
646 	if (dev->mode_config.funcs->output_poll_changed)
647 		dev->mode_config.funcs->output_poll_changed(dev);
648 
649 	drm_client_dev_hotplug(dev);
650 }
651 EXPORT_SYMBOL(drm_kms_helper_hotplug_event);
652 
653 /**
654  * drm_kms_helper_connector_hotplug_event - fire off a KMS connector hotplug event
655  * @connector: drm_connector which has changed
656  *
657  * This is the same as drm_kms_helper_hotplug_event(), except it fires a more
658  * fine-grained uevent for a single connector.
659  */
660 void drm_kms_helper_connector_hotplug_event(struct drm_connector *connector)
661 {
662 	struct drm_device *dev = connector->dev;
663 
664 	/* send a uevent + call fbdev */
665 	drm_sysfs_connector_hotplug_event(connector);
666 	if (dev->mode_config.funcs->output_poll_changed)
667 		dev->mode_config.funcs->output_poll_changed(dev);
668 
669 	drm_client_dev_hotplug(dev);
670 }
671 EXPORT_SYMBOL(drm_kms_helper_connector_hotplug_event);
672 
673 static void output_poll_execute(struct work_struct *work)
674 {
675 	struct delayed_work *delayed_work = to_delayed_work(work);
676 	struct drm_device *dev = container_of(delayed_work, struct drm_device, mode_config.output_poll_work);
677 	struct drm_connector *connector;
678 	struct drm_connector_list_iter conn_iter;
679 	enum drm_connector_status old_status;
680 	bool repoll = false, changed;
681 	u64 old_epoch_counter;
682 
683 	if (!dev->mode_config.poll_enabled)
684 		return;
685 
686 	/* Pick up any changes detected by the probe functions. */
687 	changed = dev->mode_config.delayed_event;
688 	dev->mode_config.delayed_event = false;
689 
690 	if (!drm_kms_helper_poll)
691 		goto out;
692 
693 	if (!mutex_trylock(&dev->mode_config.mutex)) {
694 		repoll = true;
695 		goto out;
696 	}
697 
698 	drm_connector_list_iter_begin(dev, &conn_iter);
699 	drm_for_each_connector_iter(connector, &conn_iter) {
700 		/* Ignore forced connectors. */
701 		if (connector->force)
702 			continue;
703 
704 		/* Ignore HPD capable connectors and connectors where we don't
705 		 * want any hotplug detection at all for polling. */
706 		if (!connector->polled || connector->polled == DRM_CONNECTOR_POLL_HPD)
707 			continue;
708 
709 		old_status = connector->status;
710 		/* if we are connected and don't want to poll for disconnect
711 		   skip it */
712 		if (old_status == connector_status_connected &&
713 		    !(connector->polled & DRM_CONNECTOR_POLL_DISCONNECT))
714 			continue;
715 
716 		repoll = true;
717 
718 		old_epoch_counter = connector->epoch_counter;
719 		connector->status = drm_helper_probe_detect(connector, NULL, false);
720 		if (old_epoch_counter != connector->epoch_counter) {
721 			const char *old, *new;
722 
723 			/*
724 			 * The poll work sets force=false when calling detect so
725 			 * that drivers can avoid to do disruptive tests (e.g.
726 			 * when load detect cycles could cause flickering on
727 			 * other, running displays). This bears the risk that we
728 			 * flip-flop between unknown here in the poll work and
729 			 * the real state when userspace forces a full detect
730 			 * call after receiving a hotplug event due to this
731 			 * change.
732 			 *
733 			 * Hence clamp an unknown detect status to the old
734 			 * value.
735 			 */
736 			if (connector->status == connector_status_unknown) {
737 				connector->status = old_status;
738 				continue;
739 			}
740 
741 			old = drm_get_connector_status_name(old_status);
742 			new = drm_get_connector_status_name(connector->status);
743 
744 			DRM_DEBUG_KMS("[CONNECTOR:%d:%s] "
745 				      "status updated from %s to %s\n",
746 				      connector->base.id,
747 				      connector->name,
748 				      old, new);
749 			DRM_DEBUG_KMS("[CONNECTOR:%d:%s] epoch counter %llu -> %llu\n",
750 				      connector->base.id, connector->name,
751 				      old_epoch_counter, connector->epoch_counter);
752 
753 			changed = true;
754 		}
755 	}
756 	drm_connector_list_iter_end(&conn_iter);
757 
758 	mutex_unlock(&dev->mode_config.mutex);
759 
760 out:
761 	if (changed)
762 		drm_kms_helper_hotplug_event(dev);
763 
764 	if (repoll)
765 		schedule_delayed_work(delayed_work, DRM_OUTPUT_POLL_PERIOD);
766 }
767 
768 /**
769  * drm_kms_helper_is_poll_worker - is %current task an output poll worker?
770  *
771  * Determine if %current task is an output poll worker.  This can be used
772  * to select distinct code paths for output polling versus other contexts.
773  *
774  * One use case is to avoid a deadlock between the output poll worker and
775  * the autosuspend worker wherein the latter waits for polling to finish
776  * upon calling drm_kms_helper_poll_disable(), while the former waits for
777  * runtime suspend to finish upon calling pm_runtime_get_sync() in a
778  * connector ->detect hook.
779  */
780 bool drm_kms_helper_is_poll_worker(void)
781 {
782 	struct work_struct *work = current_work();
783 
784 	return work && work->func == output_poll_execute;
785 }
786 EXPORT_SYMBOL(drm_kms_helper_is_poll_worker);
787 
788 /**
789  * drm_kms_helper_poll_disable - disable output polling
790  * @dev: drm_device
791  *
792  * This function disables the output polling work.
793  *
794  * Drivers can call this helper from their device suspend implementation. It is
795  * not an error to call this even when output polling isn't enabled or already
796  * disabled. Polling is re-enabled by calling drm_kms_helper_poll_enable().
797  *
798  * Note that calls to enable and disable polling must be strictly ordered, which
799  * is automatically the case when they're only call from suspend/resume
800  * callbacks.
801  */
802 void drm_kms_helper_poll_disable(struct drm_device *dev)
803 {
804 	if (!dev->mode_config.poll_enabled)
805 		return;
806 	cancel_delayed_work_sync(&dev->mode_config.output_poll_work);
807 }
808 EXPORT_SYMBOL(drm_kms_helper_poll_disable);
809 
810 /**
811  * drm_kms_helper_poll_init - initialize and enable output polling
812  * @dev: drm_device
813  *
814  * This function initializes and then also enables output polling support for
815  * @dev. Drivers which do not have reliable hotplug support in hardware can use
816  * this helper infrastructure to regularly poll such connectors for changes in
817  * their connection state.
818  *
819  * Drivers can control which connectors are polled by setting the
820  * DRM_CONNECTOR_POLL_CONNECT and DRM_CONNECTOR_POLL_DISCONNECT flags. On
821  * connectors where probing live outputs can result in visual distortion drivers
822  * should not set the DRM_CONNECTOR_POLL_DISCONNECT flag to avoid this.
823  * Connectors which have no flag or only DRM_CONNECTOR_POLL_HPD set are
824  * completely ignored by the polling logic.
825  *
826  * Note that a connector can be both polled and probed from the hotplug handler,
827  * in case the hotplug interrupt is known to be unreliable.
828  */
829 void drm_kms_helper_poll_init(struct drm_device *dev)
830 {
831 	INIT_DELAYED_WORK(&dev->mode_config.output_poll_work, output_poll_execute);
832 	dev->mode_config.poll_enabled = true;
833 
834 	drm_kms_helper_poll_enable(dev);
835 }
836 EXPORT_SYMBOL(drm_kms_helper_poll_init);
837 
838 /**
839  * drm_kms_helper_poll_fini - disable output polling and clean it up
840  * @dev: drm_device
841  */
842 void drm_kms_helper_poll_fini(struct drm_device *dev)
843 {
844 	if (!dev->mode_config.poll_enabled)
845 		return;
846 
847 	dev->mode_config.poll_enabled = false;
848 	cancel_delayed_work_sync(&dev->mode_config.output_poll_work);
849 }
850 EXPORT_SYMBOL(drm_kms_helper_poll_fini);
851 
852 static bool check_connector_changed(struct drm_connector *connector)
853 {
854 	struct drm_device *dev = connector->dev;
855 	enum drm_connector_status old_status;
856 	u64 old_epoch_counter;
857 
858 	/* Only handle HPD capable connectors. */
859 	drm_WARN_ON(dev, !(connector->polled & DRM_CONNECTOR_POLL_HPD));
860 
861 	drm_WARN_ON(dev, !mutex_is_locked(&dev->mode_config.mutex));
862 
863 	old_status = connector->status;
864 	old_epoch_counter = connector->epoch_counter;
865 	connector->status = drm_helper_probe_detect(connector, NULL, false);
866 
867 	if (old_epoch_counter == connector->epoch_counter) {
868 		drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Same epoch counter %llu\n",
869 			    connector->base.id,
870 			    connector->name,
871 			    connector->epoch_counter);
872 
873 		return false;
874 	}
875 
876 	drm_dbg_kms(dev, "[CONNECTOR:%d:%s] status updated from %s to %s\n",
877 		    connector->base.id,
878 		    connector->name,
879 		    drm_get_connector_status_name(old_status),
880 		    drm_get_connector_status_name(connector->status));
881 
882 	drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Changed epoch counter %llu => %llu\n",
883 		    connector->base.id,
884 		    connector->name,
885 		    old_epoch_counter,
886 		    connector->epoch_counter);
887 
888 	return true;
889 }
890 
891 /**
892  * drm_connector_helper_hpd_irq_event - hotplug processing
893  * @connector: drm_connector
894  *
895  * Drivers can use this helper function to run a detect cycle on a connector
896  * which has the DRM_CONNECTOR_POLL_HPD flag set in its &polled member.
897  *
898  * This helper function is useful for drivers which can track hotplug
899  * interrupts for a single connector. Drivers that want to send a
900  * hotplug event for all connectors or can't track hotplug interrupts
901  * per connector need to use drm_helper_hpd_irq_event().
902  *
903  * This function must be called from process context with no mode
904  * setting locks held.
905  *
906  * Note that a connector can be both polled and probed from the hotplug
907  * handler, in case the hotplug interrupt is known to be unreliable.
908  *
909  * Returns:
910  * A boolean indicating whether the connector status changed or not
911  */
912 bool drm_connector_helper_hpd_irq_event(struct drm_connector *connector)
913 {
914 	struct drm_device *dev = connector->dev;
915 	bool changed;
916 
917 	mutex_lock(&dev->mode_config.mutex);
918 	changed = check_connector_changed(connector);
919 	mutex_unlock(&dev->mode_config.mutex);
920 
921 	if (changed) {
922 		drm_kms_helper_connector_hotplug_event(connector);
923 		drm_dbg_kms(dev, "[CONNECTOR:%d:%s] Sent hotplug event\n",
924 			    connector->base.id,
925 			    connector->name);
926 	}
927 
928 	return changed;
929 }
930 EXPORT_SYMBOL(drm_connector_helper_hpd_irq_event);
931 
932 /**
933  * drm_helper_hpd_irq_event - hotplug processing
934  * @dev: drm_device
935  *
936  * Drivers can use this helper function to run a detect cycle on all connectors
937  * which have the DRM_CONNECTOR_POLL_HPD flag set in their &polled member. All
938  * other connectors are ignored, which is useful to avoid reprobing fixed
939  * panels.
940  *
941  * This helper function is useful for drivers which can't or don't track hotplug
942  * interrupts for each connector.
943  *
944  * Drivers which support hotplug interrupts for each connector individually and
945  * which have a more fine-grained detect logic can use
946  * drm_connector_helper_hpd_irq_event(). Alternatively, they should bypass this
947  * code and directly call drm_kms_helper_hotplug_event() in case the connector
948  * state changed.
949  *
950  * This function must be called from process context with no mode
951  * setting locks held.
952  *
953  * Note that a connector can be both polled and probed from the hotplug handler,
954  * in case the hotplug interrupt is known to be unreliable.
955  *
956  * Returns:
957  * A boolean indicating whether the connector status changed or not
958  */
959 bool drm_helper_hpd_irq_event(struct drm_device *dev)
960 {
961 	struct drm_connector *connector, *first_changed_connector = NULL;
962 	struct drm_connector_list_iter conn_iter;
963 	int changed = 0;
964 
965 	if (!dev->mode_config.poll_enabled)
966 		return false;
967 
968 	mutex_lock(&dev->mode_config.mutex);
969 	drm_connector_list_iter_begin(dev, &conn_iter);
970 	drm_for_each_connector_iter(connector, &conn_iter) {
971 		/* Only handle HPD capable connectors. */
972 		if (!(connector->polled & DRM_CONNECTOR_POLL_HPD))
973 			continue;
974 
975 		if (check_connector_changed(connector)) {
976 			if (!first_changed_connector) {
977 				drm_connector_get(connector);
978 				first_changed_connector = connector;
979 			}
980 
981 			changed++;
982 		}
983 	}
984 	drm_connector_list_iter_end(&conn_iter);
985 	mutex_unlock(&dev->mode_config.mutex);
986 
987 	if (changed == 1)
988 		drm_kms_helper_connector_hotplug_event(first_changed_connector);
989 	else if (changed > 0)
990 		drm_kms_helper_hotplug_event(dev);
991 
992 	if (first_changed_connector)
993 		drm_connector_put(first_changed_connector);
994 
995 	return changed;
996 }
997 EXPORT_SYMBOL(drm_helper_hpd_irq_event);
998 
999 /**
1000  * drm_connector_helper_get_modes_from_ddc - Updates the connector's EDID
1001  *                                           property from the connector's
1002  *                                           DDC channel
1003  * @connector: The connector
1004  *
1005  * Returns:
1006  * The number of detected display modes.
1007  *
1008  * Uses a connector's DDC channel to retrieve EDID data and update the
1009  * connector's EDID property and display modes. Drivers can use this
1010  * function to implement struct &drm_connector_helper_funcs.get_modes
1011  * for connectors with a DDC channel.
1012  */
1013 int drm_connector_helper_get_modes_from_ddc(struct drm_connector *connector)
1014 {
1015 	struct edid *edid;
1016 	int count = 0;
1017 
1018 	if (!connector->ddc)
1019 		return 0;
1020 
1021 	edid = drm_get_edid(connector, connector->ddc);
1022 
1023 	// clears property if EDID is NULL
1024 	drm_connector_update_edid_property(connector, edid);
1025 
1026 	if (edid) {
1027 		count = drm_add_edid_modes(connector, edid);
1028 		kfree(edid);
1029 	}
1030 
1031 	return count;
1032 }
1033 EXPORT_SYMBOL(drm_connector_helper_get_modes_from_ddc);
1034