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 		      bool irq_received)
275 {
276 	struct drm_device *dev = connector->base.dev;
277 	enum drm_connector_status old_status;
278 
279 	drm_WARN_ON(dev, !mutex_is_locked(&dev->mode_config.mutex));
280 	old_status = connector->base.status;
281 
282 	connector->base.status =
283 		drm_helper_probe_detect(&connector->base, NULL, false);
284 
285 	if (old_status == connector->base.status)
286 		return INTEL_HOTPLUG_UNCHANGED;
287 
288 	drm_dbg_kms(&to_i915(dev)->drm,
289 		    "[CONNECTOR:%d:%s] status updated from %s to %s\n",
290 		    connector->base.base.id,
291 		    connector->base.name,
292 		    drm_get_connector_status_name(old_status),
293 		    drm_get_connector_status_name(connector->base.status));
294 
295 	return INTEL_HOTPLUG_CHANGED;
296 }
297 
298 static bool intel_encoder_has_hpd_pulse(struct intel_encoder *encoder)
299 {
300 	return intel_encoder_is_dig_port(encoder) &&
301 		enc_to_dig_port(encoder)->hpd_pulse != NULL;
302 }
303 
304 static void i915_digport_work_func(struct work_struct *work)
305 {
306 	struct drm_i915_private *dev_priv =
307 		container_of(work, struct drm_i915_private, hotplug.dig_port_work);
308 	u32 long_port_mask, short_port_mask;
309 	struct intel_encoder *encoder;
310 	u32 old_bits = 0;
311 
312 	spin_lock_irq(&dev_priv->irq_lock);
313 	long_port_mask = dev_priv->hotplug.long_port_mask;
314 	dev_priv->hotplug.long_port_mask = 0;
315 	short_port_mask = dev_priv->hotplug.short_port_mask;
316 	dev_priv->hotplug.short_port_mask = 0;
317 	spin_unlock_irq(&dev_priv->irq_lock);
318 
319 	for_each_intel_encoder(&dev_priv->drm, encoder) {
320 		struct intel_digital_port *dig_port;
321 		enum port port = encoder->port;
322 		bool long_hpd, short_hpd;
323 		enum irqreturn ret;
324 
325 		if (!intel_encoder_has_hpd_pulse(encoder))
326 			continue;
327 
328 		long_hpd = long_port_mask & BIT(port);
329 		short_hpd = short_port_mask & BIT(port);
330 
331 		if (!long_hpd && !short_hpd)
332 			continue;
333 
334 		dig_port = enc_to_dig_port(encoder);
335 
336 		ret = dig_port->hpd_pulse(dig_port, long_hpd);
337 		if (ret == IRQ_NONE) {
338 			/* fall back to old school hpd */
339 			old_bits |= BIT(encoder->hpd_pin);
340 		}
341 	}
342 
343 	if (old_bits) {
344 		spin_lock_irq(&dev_priv->irq_lock);
345 		dev_priv->hotplug.event_bits |= old_bits;
346 		spin_unlock_irq(&dev_priv->irq_lock);
347 		queue_delayed_work(system_wq, &dev_priv->hotplug.hotplug_work, 0);
348 	}
349 }
350 
351 /**
352  * intel_hpd_trigger_irq - trigger an hpd irq event for a port
353  * @dig_port: digital port
354  *
355  * Trigger an HPD interrupt event for the given port, emulating a short pulse
356  * generated by the sink, and schedule the dig port work to handle it.
357  */
358 void intel_hpd_trigger_irq(struct intel_digital_port *dig_port)
359 {
360 	struct drm_i915_private *i915 = to_i915(dig_port->base.base.dev);
361 
362 	spin_lock_irq(&i915->irq_lock);
363 	i915->hotplug.short_port_mask |= BIT(dig_port->base.port);
364 	spin_unlock_irq(&i915->irq_lock);
365 
366 	queue_work(i915->hotplug.dp_wq, &i915->hotplug.dig_port_work);
367 }
368 
369 /*
370  * Handle hotplug events outside the interrupt handler proper.
371  */
372 static void i915_hotplug_work_func(struct work_struct *work)
373 {
374 	struct drm_i915_private *dev_priv =
375 		container_of(work, struct drm_i915_private,
376 			     hotplug.hotplug_work.work);
377 	struct drm_device *dev = &dev_priv->drm;
378 	struct drm_connector_list_iter conn_iter;
379 	struct intel_connector *connector;
380 	u32 changed = 0, retry = 0;
381 	u32 hpd_event_bits;
382 	u32 hpd_retry_bits;
383 
384 	mutex_lock(&dev->mode_config.mutex);
385 	drm_dbg_kms(&dev_priv->drm, "running encoder hotplug functions\n");
386 
387 	spin_lock_irq(&dev_priv->irq_lock);
388 
389 	hpd_event_bits = dev_priv->hotplug.event_bits;
390 	dev_priv->hotplug.event_bits = 0;
391 	hpd_retry_bits = dev_priv->hotplug.retry_bits;
392 	dev_priv->hotplug.retry_bits = 0;
393 
394 	/* Enable polling for connectors which had HPD IRQ storms */
395 	intel_hpd_irq_storm_switch_to_polling(dev_priv);
396 
397 	spin_unlock_irq(&dev_priv->irq_lock);
398 
399 	drm_connector_list_iter_begin(dev, &conn_iter);
400 	for_each_intel_connector_iter(connector, &conn_iter) {
401 		enum hpd_pin pin;
402 		u32 hpd_bit;
403 
404 		pin = intel_connector_hpd_pin(connector);
405 		if (pin == HPD_NONE)
406 			continue;
407 
408 		hpd_bit = BIT(pin);
409 		if ((hpd_event_bits | hpd_retry_bits) & hpd_bit) {
410 			struct intel_encoder *encoder =
411 				intel_attached_encoder(connector);
412 
413 			drm_dbg_kms(&dev_priv->drm,
414 				    "Connector %s (pin %i) received hotplug event.\n",
415 				    connector->base.name, pin);
416 
417 			switch (encoder->hotplug(encoder, connector,
418 						 hpd_event_bits & hpd_bit)) {
419 			case INTEL_HOTPLUG_UNCHANGED:
420 				break;
421 			case INTEL_HOTPLUG_CHANGED:
422 				changed |= hpd_bit;
423 				break;
424 			case INTEL_HOTPLUG_RETRY:
425 				retry |= hpd_bit;
426 				break;
427 			}
428 		}
429 	}
430 	drm_connector_list_iter_end(&conn_iter);
431 	mutex_unlock(&dev->mode_config.mutex);
432 
433 	if (changed)
434 		drm_kms_helper_hotplug_event(dev);
435 
436 	/* Remove shared HPD pins that have changed */
437 	retry &= ~changed;
438 	if (retry) {
439 		spin_lock_irq(&dev_priv->irq_lock);
440 		dev_priv->hotplug.retry_bits |= retry;
441 		spin_unlock_irq(&dev_priv->irq_lock);
442 
443 		mod_delayed_work(system_wq, &dev_priv->hotplug.hotplug_work,
444 				 msecs_to_jiffies(HPD_RETRY_DELAY));
445 	}
446 }
447 
448 
449 /**
450  * intel_hpd_irq_handler - main hotplug irq handler
451  * @dev_priv: drm_i915_private
452  * @pin_mask: a mask of hpd pins that have triggered the irq
453  * @long_mask: a mask of hpd pins that may be long hpd pulses
454  *
455  * This is the main hotplug irq handler for all platforms. The platform specific
456  * irq handlers call the platform specific hotplug irq handlers, which read and
457  * decode the appropriate registers into bitmasks about hpd pins that have
458  * triggered (@pin_mask), and which of those pins may be long pulses
459  * (@long_mask). The @long_mask is ignored if the port corresponding to the pin
460  * is not a digital port.
461  *
462  * Here, we do hotplug irq storm detection and mitigation, and pass further
463  * processing to appropriate bottom halves.
464  */
465 void intel_hpd_irq_handler(struct drm_i915_private *dev_priv,
466 			   u32 pin_mask, u32 long_mask)
467 {
468 	struct intel_encoder *encoder;
469 	bool storm_detected = false;
470 	bool queue_dig = false, queue_hp = false;
471 	u32 long_hpd_pulse_mask = 0;
472 	u32 short_hpd_pulse_mask = 0;
473 	enum hpd_pin pin;
474 
475 	if (!pin_mask)
476 		return;
477 
478 	spin_lock(&dev_priv->irq_lock);
479 
480 	/*
481 	 * Determine whether ->hpd_pulse() exists for each pin, and
482 	 * whether we have a short or a long pulse. This is needed
483 	 * as each pin may have up to two encoders (HDMI and DP) and
484 	 * only the one of them (DP) will have ->hpd_pulse().
485 	 */
486 	for_each_intel_encoder(&dev_priv->drm, encoder) {
487 		bool has_hpd_pulse = intel_encoder_has_hpd_pulse(encoder);
488 		enum port port = encoder->port;
489 		bool long_hpd;
490 
491 		pin = encoder->hpd_pin;
492 		if (!(BIT(pin) & pin_mask))
493 			continue;
494 
495 		if (!has_hpd_pulse)
496 			continue;
497 
498 		long_hpd = long_mask & BIT(pin);
499 
500 		drm_dbg(&dev_priv->drm,
501 			"digital hpd on [ENCODER:%d:%s] - %s\n",
502 			encoder->base.base.id, encoder->base.name,
503 			long_hpd ? "long" : "short");
504 		queue_dig = true;
505 
506 		if (long_hpd) {
507 			long_hpd_pulse_mask |= BIT(pin);
508 			dev_priv->hotplug.long_port_mask |= BIT(port);
509 		} else {
510 			short_hpd_pulse_mask |= BIT(pin);
511 			dev_priv->hotplug.short_port_mask |= BIT(port);
512 		}
513 	}
514 
515 	/* Now process each pin just once */
516 	for_each_hpd_pin(pin) {
517 		bool long_hpd;
518 
519 		if (!(BIT(pin) & pin_mask))
520 			continue;
521 
522 		if (dev_priv->hotplug.stats[pin].state == HPD_DISABLED) {
523 			/*
524 			 * On GMCH platforms the interrupt mask bits only
525 			 * prevent irq generation, not the setting of the
526 			 * hotplug bits itself. So only WARN about unexpected
527 			 * interrupts on saner platforms.
528 			 */
529 			drm_WARN_ONCE(&dev_priv->drm, !HAS_GMCH(dev_priv),
530 				      "Received HPD interrupt on pin %d although disabled\n",
531 				      pin);
532 			continue;
533 		}
534 
535 		if (dev_priv->hotplug.stats[pin].state != HPD_ENABLED)
536 			continue;
537 
538 		/*
539 		 * Delegate to ->hpd_pulse() if one of the encoders for this
540 		 * pin has it, otherwise let the hotplug_work deal with this
541 		 * pin directly.
542 		 */
543 		if (((short_hpd_pulse_mask | long_hpd_pulse_mask) & BIT(pin))) {
544 			long_hpd = long_hpd_pulse_mask & BIT(pin);
545 		} else {
546 			dev_priv->hotplug.event_bits |= BIT(pin);
547 			long_hpd = true;
548 			queue_hp = true;
549 		}
550 
551 		if (intel_hpd_irq_storm_detect(dev_priv, pin, long_hpd)) {
552 			dev_priv->hotplug.event_bits &= ~BIT(pin);
553 			storm_detected = true;
554 			queue_hp = true;
555 		}
556 	}
557 
558 	/*
559 	 * Disable any IRQs that storms were detected on. Polling enablement
560 	 * happens later in our hotplug work.
561 	 */
562 	if (storm_detected && dev_priv->display_irqs_enabled)
563 		dev_priv->display.hpd_irq_setup(dev_priv);
564 	spin_unlock(&dev_priv->irq_lock);
565 
566 	/*
567 	 * Our hotplug handler can grab modeset locks (by calling down into the
568 	 * fb helpers). Hence it must not be run on our own dev-priv->wq work
569 	 * queue for otherwise the flush_work in the pageflip code will
570 	 * deadlock.
571 	 */
572 	if (queue_dig)
573 		queue_work(dev_priv->hotplug.dp_wq, &dev_priv->hotplug.dig_port_work);
574 	if (queue_hp)
575 		queue_delayed_work(system_wq, &dev_priv->hotplug.hotplug_work, 0);
576 }
577 
578 /**
579  * intel_hpd_init - initializes and enables hpd support
580  * @dev_priv: i915 device instance
581  *
582  * This function enables the hotplug support. It requires that interrupts have
583  * already been enabled with intel_irq_init_hw(). From this point on hotplug and
584  * poll request can run concurrently to other code, so locking rules must be
585  * obeyed.
586  *
587  * This is a separate step from interrupt enabling to simplify the locking rules
588  * in the driver load and resume code.
589  *
590  * Also see: intel_hpd_poll_init(), which enables connector polling
591  */
592 void intel_hpd_init(struct drm_i915_private *dev_priv)
593 {
594 	int i;
595 
596 	for_each_hpd_pin(i) {
597 		dev_priv->hotplug.stats[i].count = 0;
598 		dev_priv->hotplug.stats[i].state = HPD_ENABLED;
599 	}
600 
601 	WRITE_ONCE(dev_priv->hotplug.poll_enabled, false);
602 	schedule_work(&dev_priv->hotplug.poll_init_work);
603 
604 	/*
605 	 * Interrupt setup is already guaranteed to be single-threaded, this is
606 	 * just to make the assert_spin_locked checks happy.
607 	 */
608 	if (dev_priv->display_irqs_enabled && dev_priv->display.hpd_irq_setup) {
609 		spin_lock_irq(&dev_priv->irq_lock);
610 		if (dev_priv->display_irqs_enabled)
611 			dev_priv->display.hpd_irq_setup(dev_priv);
612 		spin_unlock_irq(&dev_priv->irq_lock);
613 	}
614 }
615 
616 static void i915_hpd_poll_init_work(struct work_struct *work)
617 {
618 	struct drm_i915_private *dev_priv =
619 		container_of(work, struct drm_i915_private,
620 			     hotplug.poll_init_work);
621 	struct drm_device *dev = &dev_priv->drm;
622 	struct drm_connector_list_iter conn_iter;
623 	struct intel_connector *connector;
624 	bool enabled;
625 
626 	mutex_lock(&dev->mode_config.mutex);
627 
628 	enabled = READ_ONCE(dev_priv->hotplug.poll_enabled);
629 
630 	drm_connector_list_iter_begin(dev, &conn_iter);
631 	for_each_intel_connector_iter(connector, &conn_iter) {
632 		enum hpd_pin pin;
633 
634 		pin = intel_connector_hpd_pin(connector);
635 		if (pin == HPD_NONE)
636 			continue;
637 
638 		connector->base.polled = connector->polled;
639 
640 		if (enabled && connector->base.polled == DRM_CONNECTOR_POLL_HPD)
641 			connector->base.polled = DRM_CONNECTOR_POLL_CONNECT |
642 				DRM_CONNECTOR_POLL_DISCONNECT;
643 	}
644 	drm_connector_list_iter_end(&conn_iter);
645 
646 	if (enabled)
647 		drm_kms_helper_poll_enable(dev);
648 
649 	mutex_unlock(&dev->mode_config.mutex);
650 
651 	/*
652 	 * We might have missed any hotplugs that happened while we were
653 	 * in the middle of disabling polling
654 	 */
655 	if (!enabled)
656 		drm_helper_hpd_irq_event(dev);
657 }
658 
659 /**
660  * intel_hpd_poll_init - enables/disables polling for connectors with hpd
661  * @dev_priv: i915 device instance
662  *
663  * This function enables polling for all connectors, regardless of whether or
664  * not they support hotplug detection. Under certain conditions HPD may not be
665  * functional. On most Intel GPUs, this happens when we enter runtime suspend.
666  * On Valleyview and Cherryview systems, this also happens when we shut off all
667  * of the powerwells.
668  *
669  * Since this function can get called in contexts where we're already holding
670  * dev->mode_config.mutex, we do the actual hotplug enabling in a seperate
671  * worker.
672  *
673  * Also see: intel_hpd_init(), which restores hpd handling.
674  */
675 void intel_hpd_poll_init(struct drm_i915_private *dev_priv)
676 {
677 	WRITE_ONCE(dev_priv->hotplug.poll_enabled, true);
678 
679 	/*
680 	 * We might already be holding dev->mode_config.mutex, so do this in a
681 	 * seperate worker
682 	 * As well, there's no issue if we race here since we always reschedule
683 	 * this worker anyway
684 	 */
685 	schedule_work(&dev_priv->hotplug.poll_init_work);
686 }
687 
688 void intel_hpd_init_work(struct drm_i915_private *dev_priv)
689 {
690 	INIT_DELAYED_WORK(&dev_priv->hotplug.hotplug_work,
691 			  i915_hotplug_work_func);
692 	INIT_WORK(&dev_priv->hotplug.dig_port_work, i915_digport_work_func);
693 	INIT_WORK(&dev_priv->hotplug.poll_init_work, i915_hpd_poll_init_work);
694 	INIT_DELAYED_WORK(&dev_priv->hotplug.reenable_work,
695 			  intel_hpd_irq_storm_reenable_work);
696 }
697 
698 void intel_hpd_cancel_work(struct drm_i915_private *dev_priv)
699 {
700 	spin_lock_irq(&dev_priv->irq_lock);
701 
702 	dev_priv->hotplug.long_port_mask = 0;
703 	dev_priv->hotplug.short_port_mask = 0;
704 	dev_priv->hotplug.event_bits = 0;
705 	dev_priv->hotplug.retry_bits = 0;
706 
707 	spin_unlock_irq(&dev_priv->irq_lock);
708 
709 	cancel_work_sync(&dev_priv->hotplug.dig_port_work);
710 	cancel_delayed_work_sync(&dev_priv->hotplug.hotplug_work);
711 	cancel_work_sync(&dev_priv->hotplug.poll_init_work);
712 	cancel_delayed_work_sync(&dev_priv->hotplug.reenable_work);
713 }
714 
715 bool intel_hpd_disable(struct drm_i915_private *dev_priv, enum hpd_pin pin)
716 {
717 	bool ret = false;
718 
719 	if (pin == HPD_NONE)
720 		return false;
721 
722 	spin_lock_irq(&dev_priv->irq_lock);
723 	if (dev_priv->hotplug.stats[pin].state == HPD_ENABLED) {
724 		dev_priv->hotplug.stats[pin].state = HPD_DISABLED;
725 		ret = true;
726 	}
727 	spin_unlock_irq(&dev_priv->irq_lock);
728 
729 	return ret;
730 }
731 
732 void intel_hpd_enable(struct drm_i915_private *dev_priv, enum hpd_pin pin)
733 {
734 	if (pin == HPD_NONE)
735 		return;
736 
737 	spin_lock_irq(&dev_priv->irq_lock);
738 	dev_priv->hotplug.stats[pin].state = HPD_ENABLED;
739 	spin_unlock_irq(&dev_priv->irq_lock);
740 }
741