1 /*
2  * Copyright © 2015 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  */
23 
24 #include <linux/kernel.h>
25 
26 #include "i915_drv.h"
27 #include "intel_display_types.h"
28 #include "intel_hotplug.h"
29 
30 /**
31  * DOC: Hotplug
32  *
33  * Simply put, hotplug occurs when a display is connected to or disconnected
34  * from the system. However, there may be adapters and docking stations and
35  * Display Port short pulses and MST devices involved, complicating matters.
36  *
37  * Hotplug in i915 is handled in many different levels of abstraction.
38  *
39  * The platform dependent interrupt handling code in i915_irq.c enables,
40  * disables, and does preliminary handling of the interrupts. The interrupt
41  * handlers gather the hotplug detect (HPD) information from relevant registers
42  * into a platform independent mask of hotplug pins that have fired.
43  *
44  * The platform independent interrupt handler intel_hpd_irq_handler() in
45  * intel_hotplug.c does hotplug irq storm detection and mitigation, and passes
46  * further processing to appropriate bottom halves (Display Port specific and
47  * regular hotplug).
48  *
49  * The Display Port work function i915_digport_work_func() calls into
50  * intel_dp_hpd_pulse() via hooks, which handles DP short pulses and DP MST long
51  * pulses, with failures and non-MST long pulses triggering regular hotplug
52  * processing on the connector.
53  *
54  * The regular hotplug work function i915_hotplug_work_func() calls connector
55  * detect hooks, and, if connector status changes, triggers sending of hotplug
56  * uevent to userspace via drm_kms_helper_hotplug_event().
57  *
58  * Finally, the userspace is responsible for triggering a modeset upon receiving
59  * the hotplug uevent, disabling or enabling the crtc as needed.
60  *
61  * The hotplug interrupt storm detection and mitigation code keeps track of the
62  * number of interrupts per hotplug pin per a period of time, and if the number
63  * of interrupts exceeds a certain threshold, the interrupt is disabled for a
64  * while before being re-enabled. The intention is to mitigate issues raising
65  * from broken hardware triggering massive amounts of interrupts and grinding
66  * the system to a halt.
67  *
68  * Current implementation expects that hotplug interrupt storm will not be
69  * seen when display port sink is connected, hence on platforms whose DP
70  * callback is handled by i915_digport_work_func reenabling of hpd is not
71  * performed (it was never expected to be disabled in the first place ;) )
72  * this is specific to DP sinks handled by this routine and any other display
73  * such as HDMI or DVI enabled on the same port will have proper logic since
74  * it will use i915_hotplug_work_func where this logic is handled.
75  */
76 
77 /**
78  * intel_hpd_pin_default - return default pin associated with certain port.
79  * @dev_priv: private driver data pointer
80  * @port: the hpd port to get associated pin
81  *
82  * It is only valid and used by digital port encoder.
83  *
84  * Return pin that is associatade with @port and HDP_NONE if no pin is
85  * hard associated with that @port.
86  */
87 enum hpd_pin intel_hpd_pin_default(struct drm_i915_private *dev_priv,
88 				   enum port port)
89 {
90 	enum phy phy = intel_port_to_phy(dev_priv, port);
91 
92 	switch (phy) {
93 	case PHY_F:
94 		return IS_CNL_WITH_PORT_F(dev_priv) ? HPD_PORT_E : HPD_PORT_F;
95 	case PHY_A ... PHY_E:
96 	case PHY_G ... PHY_I:
97 		return HPD_PORT_A + phy - PHY_A;
98 	default:
99 		MISSING_CASE(phy);
100 		return HPD_NONE;
101 	}
102 }
103 
104 #define HPD_STORM_DETECT_PERIOD		1000
105 #define HPD_STORM_REENABLE_DELAY	(2 * 60 * 1000)
106 #define HPD_RETRY_DELAY			1000
107 
108 static enum hpd_pin
109 intel_connector_hpd_pin(struct intel_connector *connector)
110 {
111 	struct intel_encoder *encoder = intel_attached_encoder(connector);
112 
113 	/*
114 	 * MST connectors get their encoder attached dynamically
115 	 * so need to make sure we have an encoder here. But since
116 	 * MST encoders have their hpd_pin set to HPD_NONE we don't
117 	 * have to special case them beyond that.
118 	 */
119 	return encoder ? encoder->hpd_pin : HPD_NONE;
120 }
121 
122 /**
123  * intel_hpd_irq_storm_detect - gather stats and detect HPD IRQ storm on a pin
124  * @dev_priv: private driver data pointer
125  * @pin: the pin to gather stats on
126  * @long_hpd: whether the HPD IRQ was long or short
127  *
128  * Gather stats about HPD IRQs from the specified @pin, and detect IRQ
129  * storms. Only the pin specific stats and state are changed, the caller is
130  * responsible for further action.
131  *
132  * The number of IRQs that are allowed within @HPD_STORM_DETECT_PERIOD is
133  * stored in @dev_priv->hotplug.hpd_storm_threshold which defaults to
134  * @HPD_STORM_DEFAULT_THRESHOLD. Long IRQs count as +10 to this threshold, and
135  * short IRQs count as +1. If this threshold is exceeded, it's considered an
136  * IRQ storm and the IRQ state is set to @HPD_MARK_DISABLED.
137  *
138  * By default, most systems will only count long IRQs towards
139  * &dev_priv->hotplug.hpd_storm_threshold. However, some older systems also
140  * suffer from short IRQ storms and must also track these. Because short IRQ
141  * storms are naturally caused by sideband interactions with DP MST devices,
142  * short IRQ detection is only enabled for systems without DP MST support.
143  * Systems which are new enough to support DP MST are far less likely to
144  * suffer from IRQ storms at all, so this is fine.
145  *
146  * The HPD threshold can be controlled through i915_hpd_storm_ctl in debugfs,
147  * and should only be adjusted for automated hotplug testing.
148  *
149  * Return true if an IRQ storm was detected on @pin.
150  */
151 static bool intel_hpd_irq_storm_detect(struct drm_i915_private *dev_priv,
152 				       enum hpd_pin pin, bool long_hpd)
153 {
154 	struct i915_hotplug *hpd = &dev_priv->hotplug;
155 	unsigned long start = hpd->stats[pin].last_jiffies;
156 	unsigned long end = start + msecs_to_jiffies(HPD_STORM_DETECT_PERIOD);
157 	const int increment = long_hpd ? 10 : 1;
158 	const int threshold = hpd->hpd_storm_threshold;
159 	bool storm = false;
160 
161 	if (!threshold ||
162 	    (!long_hpd && !dev_priv->hotplug.hpd_short_storm_enabled))
163 		return false;
164 
165 	if (!time_in_range(jiffies, start, end)) {
166 		hpd->stats[pin].last_jiffies = jiffies;
167 		hpd->stats[pin].count = 0;
168 	}
169 
170 	hpd->stats[pin].count += increment;
171 	if (hpd->stats[pin].count > threshold) {
172 		hpd->stats[pin].state = HPD_MARK_DISABLED;
173 		drm_dbg_kms(&dev_priv->drm,
174 			    "HPD interrupt storm detected on PIN %d\n", pin);
175 		storm = true;
176 	} else {
177 		drm_dbg_kms(&dev_priv->drm,
178 			    "Received HPD interrupt on PIN %d - cnt: %d\n",
179 			      pin,
180 			      hpd->stats[pin].count);
181 	}
182 
183 	return storm;
184 }
185 
186 static void
187 intel_hpd_irq_storm_switch_to_polling(struct drm_i915_private *dev_priv)
188 {
189 	struct drm_device *dev = &dev_priv->drm;
190 	struct drm_connector_list_iter conn_iter;
191 	struct intel_connector *connector;
192 	bool hpd_disabled = false;
193 
194 	lockdep_assert_held(&dev_priv->irq_lock);
195 
196 	drm_connector_list_iter_begin(dev, &conn_iter);
197 	for_each_intel_connector_iter(connector, &conn_iter) {
198 		enum hpd_pin pin;
199 
200 		if (connector->base.polled != DRM_CONNECTOR_POLL_HPD)
201 			continue;
202 
203 		pin = intel_connector_hpd_pin(connector);
204 		if (pin == HPD_NONE ||
205 		    dev_priv->hotplug.stats[pin].state != HPD_MARK_DISABLED)
206 			continue;
207 
208 		drm_info(&dev_priv->drm,
209 			 "HPD interrupt storm detected on connector %s: "
210 			 "switching from hotplug detection to polling\n",
211 			 connector->base.name);
212 
213 		dev_priv->hotplug.stats[pin].state = HPD_DISABLED;
214 		connector->base.polled = DRM_CONNECTOR_POLL_CONNECT |
215 			DRM_CONNECTOR_POLL_DISCONNECT;
216 		hpd_disabled = true;
217 	}
218 	drm_connector_list_iter_end(&conn_iter);
219 
220 	/* Enable polling and queue hotplug re-enabling. */
221 	if (hpd_disabled) {
222 		drm_kms_helper_poll_enable(dev);
223 		mod_delayed_work(system_wq, &dev_priv->hotplug.reenable_work,
224 				 msecs_to_jiffies(HPD_STORM_REENABLE_DELAY));
225 	}
226 }
227 
228 static void intel_hpd_irq_storm_reenable_work(struct work_struct *work)
229 {
230 	struct drm_i915_private *dev_priv =
231 		container_of(work, typeof(*dev_priv),
232 			     hotplug.reenable_work.work);
233 	struct drm_device *dev = &dev_priv->drm;
234 	struct drm_connector_list_iter conn_iter;
235 	struct intel_connector *connector;
236 	intel_wakeref_t wakeref;
237 	enum hpd_pin pin;
238 
239 	wakeref = intel_runtime_pm_get(&dev_priv->runtime_pm);
240 
241 	spin_lock_irq(&dev_priv->irq_lock);
242 
243 	drm_connector_list_iter_begin(dev, &conn_iter);
244 	for_each_intel_connector_iter(connector, &conn_iter) {
245 		pin = intel_connector_hpd_pin(connector);
246 		if (pin == HPD_NONE ||
247 		    dev_priv->hotplug.stats[pin].state != HPD_DISABLED)
248 			continue;
249 
250 		if (connector->base.polled != connector->polled)
251 			drm_dbg(&dev_priv->drm,
252 				"Reenabling HPD on connector %s\n",
253 				connector->base.name);
254 		connector->base.polled = connector->polled;
255 	}
256 	drm_connector_list_iter_end(&conn_iter);
257 
258 	for_each_hpd_pin(pin) {
259 		if (dev_priv->hotplug.stats[pin].state == HPD_DISABLED)
260 			dev_priv->hotplug.stats[pin].state = HPD_ENABLED;
261 	}
262 
263 	if (dev_priv->display_irqs_enabled && dev_priv->display.hpd_irq_setup)
264 		dev_priv->display.hpd_irq_setup(dev_priv);
265 
266 	spin_unlock_irq(&dev_priv->irq_lock);
267 
268 	intel_runtime_pm_put(&dev_priv->runtime_pm, wakeref);
269 }
270 
271 enum intel_hotplug_state
272 intel_encoder_hotplug(struct intel_encoder *encoder,
273 		      struct intel_connector *connector)
274 {
275 	struct drm_device *dev = connector->base.dev;
276 	enum drm_connector_status old_status;
277 
278 	drm_WARN_ON(dev, !mutex_is_locked(&dev->mode_config.mutex));
279 	old_status = connector->base.status;
280 
281 	connector->base.status =
282 		drm_helper_probe_detect(&connector->base, NULL, false);
283 
284 	if (old_status == connector->base.status)
285 		return INTEL_HOTPLUG_UNCHANGED;
286 
287 	drm_dbg_kms(&to_i915(dev)->drm,
288 		    "[CONNECTOR:%d:%s] status updated from %s to %s\n",
289 		    connector->base.base.id,
290 		    connector->base.name,
291 		    drm_get_connector_status_name(old_status),
292 		    drm_get_connector_status_name(connector->base.status));
293 
294 	return INTEL_HOTPLUG_CHANGED;
295 }
296 
297 static bool intel_encoder_has_hpd_pulse(struct intel_encoder *encoder)
298 {
299 	return intel_encoder_is_dig_port(encoder) &&
300 		enc_to_dig_port(encoder)->hpd_pulse != NULL;
301 }
302 
303 static void i915_digport_work_func(struct work_struct *work)
304 {
305 	struct drm_i915_private *dev_priv =
306 		container_of(work, struct drm_i915_private, hotplug.dig_port_work);
307 	u32 long_port_mask, short_port_mask;
308 	struct intel_encoder *encoder;
309 	u32 old_bits = 0;
310 
311 	spin_lock_irq(&dev_priv->irq_lock);
312 	long_port_mask = dev_priv->hotplug.long_port_mask;
313 	dev_priv->hotplug.long_port_mask = 0;
314 	short_port_mask = dev_priv->hotplug.short_port_mask;
315 	dev_priv->hotplug.short_port_mask = 0;
316 	spin_unlock_irq(&dev_priv->irq_lock);
317 
318 	for_each_intel_encoder(&dev_priv->drm, encoder) {
319 		struct intel_digital_port *dig_port;
320 		enum port port = encoder->port;
321 		bool long_hpd, short_hpd;
322 		enum irqreturn ret;
323 
324 		if (!intel_encoder_has_hpd_pulse(encoder))
325 			continue;
326 
327 		long_hpd = long_port_mask & BIT(port);
328 		short_hpd = short_port_mask & BIT(port);
329 
330 		if (!long_hpd && !short_hpd)
331 			continue;
332 
333 		dig_port = enc_to_dig_port(encoder);
334 
335 		ret = dig_port->hpd_pulse(dig_port, long_hpd);
336 		if (ret == IRQ_NONE) {
337 			/* fall back to old school hpd */
338 			old_bits |= BIT(encoder->hpd_pin);
339 		}
340 	}
341 
342 	if (old_bits) {
343 		spin_lock_irq(&dev_priv->irq_lock);
344 		dev_priv->hotplug.event_bits |= old_bits;
345 		spin_unlock_irq(&dev_priv->irq_lock);
346 		queue_delayed_work(system_wq, &dev_priv->hotplug.hotplug_work, 0);
347 	}
348 }
349 
350 /**
351  * intel_hpd_trigger_irq - trigger an hpd irq event for a port
352  * @dig_port: digital port
353  *
354  * Trigger an HPD interrupt event for the given port, emulating a short pulse
355  * generated by the sink, and schedule the dig port work to handle it.
356  */
357 void intel_hpd_trigger_irq(struct intel_digital_port *dig_port)
358 {
359 	struct drm_i915_private *i915 = to_i915(dig_port->base.base.dev);
360 
361 	spin_lock_irq(&i915->irq_lock);
362 	i915->hotplug.short_port_mask |= BIT(dig_port->base.port);
363 	spin_unlock_irq(&i915->irq_lock);
364 
365 	queue_work(i915->hotplug.dp_wq, &i915->hotplug.dig_port_work);
366 }
367 
368 /*
369  * Handle hotplug events outside the interrupt handler proper.
370  */
371 static void i915_hotplug_work_func(struct work_struct *work)
372 {
373 	struct drm_i915_private *dev_priv =
374 		container_of(work, struct drm_i915_private,
375 			     hotplug.hotplug_work.work);
376 	struct drm_device *dev = &dev_priv->drm;
377 	struct drm_connector_list_iter conn_iter;
378 	struct intel_connector *connector;
379 	u32 changed = 0, retry = 0;
380 	u32 hpd_event_bits;
381 	u32 hpd_retry_bits;
382 
383 	mutex_lock(&dev->mode_config.mutex);
384 	drm_dbg_kms(&dev_priv->drm, "running encoder hotplug functions\n");
385 
386 	spin_lock_irq(&dev_priv->irq_lock);
387 
388 	hpd_event_bits = dev_priv->hotplug.event_bits;
389 	dev_priv->hotplug.event_bits = 0;
390 	hpd_retry_bits = dev_priv->hotplug.retry_bits;
391 	dev_priv->hotplug.retry_bits = 0;
392 
393 	/* Enable polling for connectors which had HPD IRQ storms */
394 	intel_hpd_irq_storm_switch_to_polling(dev_priv);
395 
396 	spin_unlock_irq(&dev_priv->irq_lock);
397 
398 	drm_connector_list_iter_begin(dev, &conn_iter);
399 	for_each_intel_connector_iter(connector, &conn_iter) {
400 		enum hpd_pin pin;
401 		u32 hpd_bit;
402 
403 		pin = intel_connector_hpd_pin(connector);
404 		if (pin == HPD_NONE)
405 			continue;
406 
407 		hpd_bit = BIT(pin);
408 		if ((hpd_event_bits | hpd_retry_bits) & hpd_bit) {
409 			struct intel_encoder *encoder =
410 				intel_attached_encoder(connector);
411 
412 			if (hpd_event_bits & hpd_bit)
413 				connector->hotplug_retries = 0;
414 			else
415 				connector->hotplug_retries++;
416 
417 			drm_dbg_kms(&dev_priv->drm,
418 				    "Connector %s (pin %i) received hotplug event. (retry %d)\n",
419 				    connector->base.name, pin,
420 				    connector->hotplug_retries);
421 
422 			switch (encoder->hotplug(encoder, connector)) {
423 			case INTEL_HOTPLUG_UNCHANGED:
424 				break;
425 			case INTEL_HOTPLUG_CHANGED:
426 				changed |= hpd_bit;
427 				break;
428 			case INTEL_HOTPLUG_RETRY:
429 				retry |= hpd_bit;
430 				break;
431 			}
432 		}
433 	}
434 	drm_connector_list_iter_end(&conn_iter);
435 	mutex_unlock(&dev->mode_config.mutex);
436 
437 	if (changed)
438 		drm_kms_helper_hotplug_event(dev);
439 
440 	/* Remove shared HPD pins that have changed */
441 	retry &= ~changed;
442 	if (retry) {
443 		spin_lock_irq(&dev_priv->irq_lock);
444 		dev_priv->hotplug.retry_bits |= retry;
445 		spin_unlock_irq(&dev_priv->irq_lock);
446 
447 		mod_delayed_work(system_wq, &dev_priv->hotplug.hotplug_work,
448 				 msecs_to_jiffies(HPD_RETRY_DELAY));
449 	}
450 }
451 
452 
453 /**
454  * intel_hpd_irq_handler - main hotplug irq handler
455  * @dev_priv: drm_i915_private
456  * @pin_mask: a mask of hpd pins that have triggered the irq
457  * @long_mask: a mask of hpd pins that may be long hpd pulses
458  *
459  * This is the main hotplug irq handler for all platforms. The platform specific
460  * irq handlers call the platform specific hotplug irq handlers, which read and
461  * decode the appropriate registers into bitmasks about hpd pins that have
462  * triggered (@pin_mask), and which of those pins may be long pulses
463  * (@long_mask). The @long_mask is ignored if the port corresponding to the pin
464  * is not a digital port.
465  *
466  * Here, we do hotplug irq storm detection and mitigation, and pass further
467  * processing to appropriate bottom halves.
468  */
469 void intel_hpd_irq_handler(struct drm_i915_private *dev_priv,
470 			   u32 pin_mask, u32 long_mask)
471 {
472 	struct intel_encoder *encoder;
473 	bool storm_detected = false;
474 	bool queue_dig = false, queue_hp = false;
475 	u32 long_hpd_pulse_mask = 0;
476 	u32 short_hpd_pulse_mask = 0;
477 	enum hpd_pin pin;
478 
479 	if (!pin_mask)
480 		return;
481 
482 	spin_lock(&dev_priv->irq_lock);
483 
484 	/*
485 	 * Determine whether ->hpd_pulse() exists for each pin, and
486 	 * whether we have a short or a long pulse. This is needed
487 	 * as each pin may have up to two encoders (HDMI and DP) and
488 	 * only the one of them (DP) will have ->hpd_pulse().
489 	 */
490 	for_each_intel_encoder(&dev_priv->drm, encoder) {
491 		bool has_hpd_pulse = intel_encoder_has_hpd_pulse(encoder);
492 		enum port port = encoder->port;
493 		bool long_hpd;
494 
495 		pin = encoder->hpd_pin;
496 		if (!(BIT(pin) & pin_mask))
497 			continue;
498 
499 		if (!has_hpd_pulse)
500 			continue;
501 
502 		long_hpd = long_mask & BIT(pin);
503 
504 		drm_dbg(&dev_priv->drm,
505 			"digital hpd on [ENCODER:%d:%s] - %s\n",
506 			encoder->base.base.id, encoder->base.name,
507 			long_hpd ? "long" : "short");
508 		queue_dig = true;
509 
510 		if (long_hpd) {
511 			long_hpd_pulse_mask |= BIT(pin);
512 			dev_priv->hotplug.long_port_mask |= BIT(port);
513 		} else {
514 			short_hpd_pulse_mask |= BIT(pin);
515 			dev_priv->hotplug.short_port_mask |= BIT(port);
516 		}
517 	}
518 
519 	/* Now process each pin just once */
520 	for_each_hpd_pin(pin) {
521 		bool long_hpd;
522 
523 		if (!(BIT(pin) & pin_mask))
524 			continue;
525 
526 		if (dev_priv->hotplug.stats[pin].state == HPD_DISABLED) {
527 			/*
528 			 * On GMCH platforms the interrupt mask bits only
529 			 * prevent irq generation, not the setting of the
530 			 * hotplug bits itself. So only WARN about unexpected
531 			 * interrupts on saner platforms.
532 			 */
533 			drm_WARN_ONCE(&dev_priv->drm, !HAS_GMCH(dev_priv),
534 				      "Received HPD interrupt on pin %d although disabled\n",
535 				      pin);
536 			continue;
537 		}
538 
539 		if (dev_priv->hotplug.stats[pin].state != HPD_ENABLED)
540 			continue;
541 
542 		/*
543 		 * Delegate to ->hpd_pulse() if one of the encoders for this
544 		 * pin has it, otherwise let the hotplug_work deal with this
545 		 * pin directly.
546 		 */
547 		if (((short_hpd_pulse_mask | long_hpd_pulse_mask) & BIT(pin))) {
548 			long_hpd = long_hpd_pulse_mask & BIT(pin);
549 		} else {
550 			dev_priv->hotplug.event_bits |= BIT(pin);
551 			long_hpd = true;
552 			queue_hp = true;
553 		}
554 
555 		if (intel_hpd_irq_storm_detect(dev_priv, pin, long_hpd)) {
556 			dev_priv->hotplug.event_bits &= ~BIT(pin);
557 			storm_detected = true;
558 			queue_hp = true;
559 		}
560 	}
561 
562 	/*
563 	 * Disable any IRQs that storms were detected on. Polling enablement
564 	 * happens later in our hotplug work.
565 	 */
566 	if (storm_detected && dev_priv->display_irqs_enabled)
567 		dev_priv->display.hpd_irq_setup(dev_priv);
568 	spin_unlock(&dev_priv->irq_lock);
569 
570 	/*
571 	 * Our hotplug handler can grab modeset locks (by calling down into the
572 	 * fb helpers). Hence it must not be run on our own dev-priv->wq work
573 	 * queue for otherwise the flush_work in the pageflip code will
574 	 * deadlock.
575 	 */
576 	if (queue_dig)
577 		queue_work(dev_priv->hotplug.dp_wq, &dev_priv->hotplug.dig_port_work);
578 	if (queue_hp)
579 		queue_delayed_work(system_wq, &dev_priv->hotplug.hotplug_work, 0);
580 }
581 
582 /**
583  * intel_hpd_init - initializes and enables hpd support
584  * @dev_priv: i915 device instance
585  *
586  * This function enables the hotplug support. It requires that interrupts have
587  * already been enabled with intel_irq_init_hw(). From this point on hotplug and
588  * poll request can run concurrently to other code, so locking rules must be
589  * obeyed.
590  *
591  * This is a separate step from interrupt enabling to simplify the locking rules
592  * in the driver load and resume code.
593  *
594  * Also see: intel_hpd_poll_init(), which enables connector polling
595  */
596 void intel_hpd_init(struct drm_i915_private *dev_priv)
597 {
598 	int i;
599 
600 	for_each_hpd_pin(i) {
601 		dev_priv->hotplug.stats[i].count = 0;
602 		dev_priv->hotplug.stats[i].state = HPD_ENABLED;
603 	}
604 
605 	WRITE_ONCE(dev_priv->hotplug.poll_enabled, false);
606 	schedule_work(&dev_priv->hotplug.poll_init_work);
607 
608 	/*
609 	 * Interrupt setup is already guaranteed to be single-threaded, this is
610 	 * just to make the assert_spin_locked checks happy.
611 	 */
612 	if (dev_priv->display_irqs_enabled && dev_priv->display.hpd_irq_setup) {
613 		spin_lock_irq(&dev_priv->irq_lock);
614 		if (dev_priv->display_irqs_enabled)
615 			dev_priv->display.hpd_irq_setup(dev_priv);
616 		spin_unlock_irq(&dev_priv->irq_lock);
617 	}
618 }
619 
620 static void i915_hpd_poll_init_work(struct work_struct *work)
621 {
622 	struct drm_i915_private *dev_priv =
623 		container_of(work, struct drm_i915_private,
624 			     hotplug.poll_init_work);
625 	struct drm_device *dev = &dev_priv->drm;
626 	struct drm_connector_list_iter conn_iter;
627 	struct intel_connector *connector;
628 	bool enabled;
629 
630 	mutex_lock(&dev->mode_config.mutex);
631 
632 	enabled = READ_ONCE(dev_priv->hotplug.poll_enabled);
633 
634 	drm_connector_list_iter_begin(dev, &conn_iter);
635 	for_each_intel_connector_iter(connector, &conn_iter) {
636 		enum hpd_pin pin;
637 
638 		pin = intel_connector_hpd_pin(connector);
639 		if (pin == HPD_NONE)
640 			continue;
641 
642 		connector->base.polled = connector->polled;
643 
644 		if (enabled && connector->base.polled == DRM_CONNECTOR_POLL_HPD)
645 			connector->base.polled = DRM_CONNECTOR_POLL_CONNECT |
646 				DRM_CONNECTOR_POLL_DISCONNECT;
647 	}
648 	drm_connector_list_iter_end(&conn_iter);
649 
650 	if (enabled)
651 		drm_kms_helper_poll_enable(dev);
652 
653 	mutex_unlock(&dev->mode_config.mutex);
654 
655 	/*
656 	 * We might have missed any hotplugs that happened while we were
657 	 * in the middle of disabling polling
658 	 */
659 	if (!enabled)
660 		drm_helper_hpd_irq_event(dev);
661 }
662 
663 /**
664  * intel_hpd_poll_init - enables/disables polling for connectors with hpd
665  * @dev_priv: i915 device instance
666  *
667  * This function enables polling for all connectors, regardless of whether or
668  * not they support hotplug detection. Under certain conditions HPD may not be
669  * functional. On most Intel GPUs, this happens when we enter runtime suspend.
670  * On Valleyview and Cherryview systems, this also happens when we shut off all
671  * of the powerwells.
672  *
673  * Since this function can get called in contexts where we're already holding
674  * dev->mode_config.mutex, we do the actual hotplug enabling in a seperate
675  * worker.
676  *
677  * Also see: intel_hpd_init(), which restores hpd handling.
678  */
679 void intel_hpd_poll_init(struct drm_i915_private *dev_priv)
680 {
681 	WRITE_ONCE(dev_priv->hotplug.poll_enabled, true);
682 
683 	/*
684 	 * We might already be holding dev->mode_config.mutex, so do this in a
685 	 * seperate worker
686 	 * As well, there's no issue if we race here since we always reschedule
687 	 * this worker anyway
688 	 */
689 	schedule_work(&dev_priv->hotplug.poll_init_work);
690 }
691 
692 void intel_hpd_init_work(struct drm_i915_private *dev_priv)
693 {
694 	INIT_DELAYED_WORK(&dev_priv->hotplug.hotplug_work,
695 			  i915_hotplug_work_func);
696 	INIT_WORK(&dev_priv->hotplug.dig_port_work, i915_digport_work_func);
697 	INIT_WORK(&dev_priv->hotplug.poll_init_work, i915_hpd_poll_init_work);
698 	INIT_DELAYED_WORK(&dev_priv->hotplug.reenable_work,
699 			  intel_hpd_irq_storm_reenable_work);
700 }
701 
702 void intel_hpd_cancel_work(struct drm_i915_private *dev_priv)
703 {
704 	spin_lock_irq(&dev_priv->irq_lock);
705 
706 	dev_priv->hotplug.long_port_mask = 0;
707 	dev_priv->hotplug.short_port_mask = 0;
708 	dev_priv->hotplug.event_bits = 0;
709 	dev_priv->hotplug.retry_bits = 0;
710 
711 	spin_unlock_irq(&dev_priv->irq_lock);
712 
713 	cancel_work_sync(&dev_priv->hotplug.dig_port_work);
714 	cancel_delayed_work_sync(&dev_priv->hotplug.hotplug_work);
715 	cancel_work_sync(&dev_priv->hotplug.poll_init_work);
716 	cancel_delayed_work_sync(&dev_priv->hotplug.reenable_work);
717 }
718 
719 bool intel_hpd_disable(struct drm_i915_private *dev_priv, enum hpd_pin pin)
720 {
721 	bool ret = false;
722 
723 	if (pin == HPD_NONE)
724 		return false;
725 
726 	spin_lock_irq(&dev_priv->irq_lock);
727 	if (dev_priv->hotplug.stats[pin].state == HPD_ENABLED) {
728 		dev_priv->hotplug.stats[pin].state = HPD_DISABLED;
729 		ret = true;
730 	}
731 	spin_unlock_irq(&dev_priv->irq_lock);
732 
733 	return ret;
734 }
735 
736 void intel_hpd_enable(struct drm_i915_private *dev_priv, enum hpd_pin pin)
737 {
738 	if (pin == HPD_NONE)
739 		return;
740 
741 	spin_lock_irq(&dev_priv->irq_lock);
742 	dev_priv->hotplug.stats[pin].state = HPD_ENABLED;
743 	spin_unlock_irq(&dev_priv->irq_lock);
744 }
745