xref: /openbmc/linux/drivers/gpu/drm/drm_connector.c (revision fcee01b9)
1 /*
2  * Copyright (c) 2016 Intel Corporation
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and its
5  * documentation for any purpose is hereby granted without fee, provided that
6  * the above copyright notice appear in all copies and that both that copyright
7  * notice and this permission notice appear in supporting documentation, and
8  * that the name of the copyright holders not be used in advertising or
9  * publicity pertaining to distribution of the software without specific,
10  * written prior permission.  The copyright holders make no representations
11  * about the suitability of this software for any purpose.  It is provided "as
12  * is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20  * OF THIS SOFTWARE.
21  */
22 
23 #include <drm/drm_connector.h>
24 #include <drm/drm_edid.h>
25 #include <drm/drm_encoder.h>
26 #include <drm/drm_utils.h>
27 #include <drm/drm_print.h>
28 #include <drm/drm_drv.h>
29 #include <drm/drm_file.h>
30 
31 #include <linux/uaccess.h>
32 
33 #include "drm_crtc_internal.h"
34 #include "drm_internal.h"
35 
36 /**
37  * DOC: overview
38  *
39  * In DRM connectors are the general abstraction for display sinks, and include
40  * als fixed panels or anything else that can display pixels in some form. As
41  * opposed to all other KMS objects representing hardware (like CRTC, encoder or
42  * plane abstractions) connectors can be hotplugged and unplugged at runtime.
43  * Hence they are reference-counted using drm_connector_get() and
44  * drm_connector_put().
45  *
46  * KMS driver must create, initialize, register and attach at a &struct
47  * drm_connector for each such sink. The instance is created as other KMS
48  * objects and initialized by setting the following fields. The connector is
49  * initialized with a call to drm_connector_init() with a pointer to the
50  * &struct drm_connector_funcs and a connector type, and then exposed to
51  * userspace with a call to drm_connector_register().
52  *
53  * Connectors must be attached to an encoder to be used. For devices that map
54  * connectors to encoders 1:1, the connector should be attached at
55  * initialization time with a call to drm_connector_attach_encoder(). The
56  * driver must also set the &drm_connector.encoder field to point to the
57  * attached encoder.
58  *
59  * For connectors which are not fixed (like built-in panels) the driver needs to
60  * support hotplug notifications. The simplest way to do that is by using the
61  * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
62  * hardware support for hotplug interrupts. Connectors with hardware hotplug
63  * support can instead use e.g. drm_helper_hpd_irq_event().
64  */
65 
66 struct drm_conn_prop_enum_list {
67 	int type;
68 	const char *name;
69 	struct ida ida;
70 };
71 
72 /*
73  * Connector and encoder types.
74  */
75 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
76 	{ DRM_MODE_CONNECTOR_Unknown, "Unknown" },
77 	{ DRM_MODE_CONNECTOR_VGA, "VGA" },
78 	{ DRM_MODE_CONNECTOR_DVII, "DVI-I" },
79 	{ DRM_MODE_CONNECTOR_DVID, "DVI-D" },
80 	{ DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
81 	{ DRM_MODE_CONNECTOR_Composite, "Composite" },
82 	{ DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
83 	{ DRM_MODE_CONNECTOR_LVDS, "LVDS" },
84 	{ DRM_MODE_CONNECTOR_Component, "Component" },
85 	{ DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
86 	{ DRM_MODE_CONNECTOR_DisplayPort, "DP" },
87 	{ DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
88 	{ DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
89 	{ DRM_MODE_CONNECTOR_TV, "TV" },
90 	{ DRM_MODE_CONNECTOR_eDP, "eDP" },
91 	{ DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
92 	{ DRM_MODE_CONNECTOR_DSI, "DSI" },
93 	{ DRM_MODE_CONNECTOR_DPI, "DPI" },
94 	{ DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
95 };
96 
97 void drm_connector_ida_init(void)
98 {
99 	int i;
100 
101 	for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
102 		ida_init(&drm_connector_enum_list[i].ida);
103 }
104 
105 void drm_connector_ida_destroy(void)
106 {
107 	int i;
108 
109 	for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
110 		ida_destroy(&drm_connector_enum_list[i].ida);
111 }
112 
113 /**
114  * drm_connector_get_cmdline_mode - reads the user's cmdline mode
115  * @connector: connector to quwery
116  *
117  * The kernel supports per-connector configuration of its consoles through
118  * use of the video= parameter. This function parses that option and
119  * extracts the user's specified mode (or enable/disable status) for a
120  * particular connector. This is typically only used during the early fbdev
121  * setup.
122  */
123 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
124 {
125 	struct drm_cmdline_mode *mode = &connector->cmdline_mode;
126 	char *option = NULL;
127 
128 	if (fb_get_options(connector->name, &option))
129 		return;
130 
131 	if (!drm_mode_parse_command_line_for_connector(option,
132 						       connector,
133 						       mode))
134 		return;
135 
136 	if (mode->force) {
137 		DRM_INFO("forcing %s connector %s\n", connector->name,
138 			 drm_get_connector_force_name(mode->force));
139 		connector->force = mode->force;
140 	}
141 
142 	DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
143 		      connector->name,
144 		      mode->xres, mode->yres,
145 		      mode->refresh_specified ? mode->refresh : 60,
146 		      mode->rb ? " reduced blanking" : "",
147 		      mode->margins ? " with margins" : "",
148 		      mode->interlace ?  " interlaced" : "");
149 }
150 
151 static void drm_connector_free(struct kref *kref)
152 {
153 	struct drm_connector *connector =
154 		container_of(kref, struct drm_connector, base.refcount);
155 	struct drm_device *dev = connector->dev;
156 
157 	drm_mode_object_unregister(dev, &connector->base);
158 	connector->funcs->destroy(connector);
159 }
160 
161 void drm_connector_free_work_fn(struct work_struct *work)
162 {
163 	struct drm_connector *connector, *n;
164 	struct drm_device *dev =
165 		container_of(work, struct drm_device, mode_config.connector_free_work);
166 	struct drm_mode_config *config = &dev->mode_config;
167 	unsigned long flags;
168 	struct llist_node *freed;
169 
170 	spin_lock_irqsave(&config->connector_list_lock, flags);
171 	freed = llist_del_all(&config->connector_free_list);
172 	spin_unlock_irqrestore(&config->connector_list_lock, flags);
173 
174 	llist_for_each_entry_safe(connector, n, freed, free_node) {
175 		drm_mode_object_unregister(dev, &connector->base);
176 		connector->funcs->destroy(connector);
177 	}
178 }
179 
180 /**
181  * drm_connector_init - Init a preallocated connector
182  * @dev: DRM device
183  * @connector: the connector to init
184  * @funcs: callbacks for this connector
185  * @connector_type: user visible type of the connector
186  *
187  * Initialises a preallocated connector. Connectors should be
188  * subclassed as part of driver connector objects.
189  *
190  * Returns:
191  * Zero on success, error code on failure.
192  */
193 int drm_connector_init(struct drm_device *dev,
194 		       struct drm_connector *connector,
195 		       const struct drm_connector_funcs *funcs,
196 		       int connector_type)
197 {
198 	struct drm_mode_config *config = &dev->mode_config;
199 	int ret;
200 	struct ida *connector_ida =
201 		&drm_connector_enum_list[connector_type].ida;
202 
203 	WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
204 		(!funcs->atomic_destroy_state ||
205 		 !funcs->atomic_duplicate_state));
206 
207 	ret = __drm_mode_object_add(dev, &connector->base,
208 				    DRM_MODE_OBJECT_CONNECTOR,
209 				    false, drm_connector_free);
210 	if (ret)
211 		return ret;
212 
213 	connector->base.properties = &connector->properties;
214 	connector->dev = dev;
215 	connector->funcs = funcs;
216 
217 	/* connector index is used with 32bit bitmasks */
218 	ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
219 	if (ret < 0) {
220 		DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
221 			      drm_connector_enum_list[connector_type].name,
222 			      ret);
223 		goto out_put;
224 	}
225 	connector->index = ret;
226 	ret = 0;
227 
228 	connector->connector_type = connector_type;
229 	connector->connector_type_id =
230 		ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
231 	if (connector->connector_type_id < 0) {
232 		ret = connector->connector_type_id;
233 		goto out_put_id;
234 	}
235 	connector->name =
236 		kasprintf(GFP_KERNEL, "%s-%d",
237 			  drm_connector_enum_list[connector_type].name,
238 			  connector->connector_type_id);
239 	if (!connector->name) {
240 		ret = -ENOMEM;
241 		goto out_put_type_id;
242 	}
243 
244 	INIT_LIST_HEAD(&connector->probed_modes);
245 	INIT_LIST_HEAD(&connector->modes);
246 	mutex_init(&connector->mutex);
247 	connector->edid_blob_ptr = NULL;
248 	connector->tile_blob_ptr = NULL;
249 	connector->status = connector_status_unknown;
250 	connector->display_info.panel_orientation =
251 		DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
252 
253 	drm_connector_get_cmdline_mode(connector);
254 
255 	/* We should add connectors at the end to avoid upsetting the connector
256 	 * index too much. */
257 	spin_lock_irq(&config->connector_list_lock);
258 	list_add_tail(&connector->head, &config->connector_list);
259 	config->num_connector++;
260 	spin_unlock_irq(&config->connector_list_lock);
261 
262 	if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
263 	    connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
264 		drm_connector_attach_edid_property(connector);
265 
266 	drm_object_attach_property(&connector->base,
267 				      config->dpms_property, 0);
268 
269 	drm_object_attach_property(&connector->base,
270 				   config->link_status_property,
271 				   0);
272 
273 	drm_object_attach_property(&connector->base,
274 				   config->non_desktop_property,
275 				   0);
276 	drm_object_attach_property(&connector->base,
277 				   config->tile_property,
278 				   0);
279 
280 	if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
281 		drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
282 	}
283 
284 	connector->debugfs_entry = NULL;
285 out_put_type_id:
286 	if (ret)
287 		ida_simple_remove(connector_ida, connector->connector_type_id);
288 out_put_id:
289 	if (ret)
290 		ida_simple_remove(&config->connector_ida, connector->index);
291 out_put:
292 	if (ret)
293 		drm_mode_object_unregister(dev, &connector->base);
294 
295 	return ret;
296 }
297 EXPORT_SYMBOL(drm_connector_init);
298 
299 /**
300  * drm_connector_attach_edid_property - attach edid property.
301  * @connector: the connector
302  *
303  * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
304  * edid property attached by default.  This function can be used to
305  * explicitly enable the edid property in these cases.
306  */
307 void drm_connector_attach_edid_property(struct drm_connector *connector)
308 {
309 	struct drm_mode_config *config = &connector->dev->mode_config;
310 
311 	drm_object_attach_property(&connector->base,
312 				   config->edid_property,
313 				   0);
314 }
315 EXPORT_SYMBOL(drm_connector_attach_edid_property);
316 
317 /**
318  * drm_connector_attach_encoder - attach a connector to an encoder
319  * @connector: connector to attach
320  * @encoder: encoder to attach @connector to
321  *
322  * This function links up a connector to an encoder. Note that the routing
323  * restrictions between encoders and crtcs are exposed to userspace through the
324  * possible_clones and possible_crtcs bitmasks.
325  *
326  * Returns:
327  * Zero on success, negative errno on failure.
328  */
329 int drm_connector_attach_encoder(struct drm_connector *connector,
330 				 struct drm_encoder *encoder)
331 {
332 	int i;
333 
334 	/*
335 	 * In the past, drivers have attempted to model the static association
336 	 * of connector to encoder in simple connector/encoder devices using a
337 	 * direct assignment of connector->encoder = encoder. This connection
338 	 * is a logical one and the responsibility of the core, so drivers are
339 	 * expected not to mess with this.
340 	 *
341 	 * Note that the error return should've been enough here, but a large
342 	 * majority of drivers ignores the return value, so add in a big WARN
343 	 * to get people's attention.
344 	 */
345 	if (WARN_ON(connector->encoder))
346 		return -EINVAL;
347 
348 	for (i = 0; i < ARRAY_SIZE(connector->encoder_ids); i++) {
349 		if (connector->encoder_ids[i] == 0) {
350 			connector->encoder_ids[i] = encoder->base.id;
351 			return 0;
352 		}
353 	}
354 	return -ENOMEM;
355 }
356 EXPORT_SYMBOL(drm_connector_attach_encoder);
357 
358 /**
359  * drm_connector_has_possible_encoder - check if the connector and encoder are assosicated with each other
360  * @connector: the connector
361  * @encoder: the encoder
362  *
363  * Returns:
364  * True if @encoder is one of the possible encoders for @connector.
365  */
366 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
367 					struct drm_encoder *encoder)
368 {
369 	struct drm_encoder *enc;
370 	int i;
371 
372 	drm_connector_for_each_possible_encoder(connector, enc, i) {
373 		if (enc == encoder)
374 			return true;
375 	}
376 
377 	return false;
378 }
379 EXPORT_SYMBOL(drm_connector_has_possible_encoder);
380 
381 static void drm_mode_remove(struct drm_connector *connector,
382 			    struct drm_display_mode *mode)
383 {
384 	list_del(&mode->head);
385 	drm_mode_destroy(connector->dev, mode);
386 }
387 
388 /**
389  * drm_connector_cleanup - cleans up an initialised connector
390  * @connector: connector to cleanup
391  *
392  * Cleans up the connector but doesn't free the object.
393  */
394 void drm_connector_cleanup(struct drm_connector *connector)
395 {
396 	struct drm_device *dev = connector->dev;
397 	struct drm_display_mode *mode, *t;
398 
399 	/* The connector should have been removed from userspace long before
400 	 * it is finally destroyed.
401 	 */
402 	if (WARN_ON(connector->registration_state ==
403 		    DRM_CONNECTOR_REGISTERED))
404 		drm_connector_unregister(connector);
405 
406 	if (connector->tile_group) {
407 		drm_mode_put_tile_group(dev, connector->tile_group);
408 		connector->tile_group = NULL;
409 	}
410 
411 	list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
412 		drm_mode_remove(connector, mode);
413 
414 	list_for_each_entry_safe(mode, t, &connector->modes, head)
415 		drm_mode_remove(connector, mode);
416 
417 	ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
418 			  connector->connector_type_id);
419 
420 	ida_simple_remove(&dev->mode_config.connector_ida,
421 			  connector->index);
422 
423 	kfree(connector->display_info.bus_formats);
424 	drm_mode_object_unregister(dev, &connector->base);
425 	kfree(connector->name);
426 	connector->name = NULL;
427 	spin_lock_irq(&dev->mode_config.connector_list_lock);
428 	list_del(&connector->head);
429 	dev->mode_config.num_connector--;
430 	spin_unlock_irq(&dev->mode_config.connector_list_lock);
431 
432 	WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
433 	if (connector->state && connector->funcs->atomic_destroy_state)
434 		connector->funcs->atomic_destroy_state(connector,
435 						       connector->state);
436 
437 	mutex_destroy(&connector->mutex);
438 
439 	memset(connector, 0, sizeof(*connector));
440 }
441 EXPORT_SYMBOL(drm_connector_cleanup);
442 
443 /**
444  * drm_connector_register - register a connector
445  * @connector: the connector to register
446  *
447  * Register userspace interfaces for a connector
448  *
449  * Returns:
450  * Zero on success, error code on failure.
451  */
452 int drm_connector_register(struct drm_connector *connector)
453 {
454 	int ret = 0;
455 
456 	if (!connector->dev->registered)
457 		return 0;
458 
459 	mutex_lock(&connector->mutex);
460 	if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
461 		goto unlock;
462 
463 	ret = drm_sysfs_connector_add(connector);
464 	if (ret)
465 		goto unlock;
466 
467 	ret = drm_debugfs_connector_add(connector);
468 	if (ret) {
469 		goto err_sysfs;
470 	}
471 
472 	if (connector->funcs->late_register) {
473 		ret = connector->funcs->late_register(connector);
474 		if (ret)
475 			goto err_debugfs;
476 	}
477 
478 	drm_mode_object_register(connector->dev, &connector->base);
479 
480 	connector->registration_state = DRM_CONNECTOR_REGISTERED;
481 	goto unlock;
482 
483 err_debugfs:
484 	drm_debugfs_connector_remove(connector);
485 err_sysfs:
486 	drm_sysfs_connector_remove(connector);
487 unlock:
488 	mutex_unlock(&connector->mutex);
489 	return ret;
490 }
491 EXPORT_SYMBOL(drm_connector_register);
492 
493 /**
494  * drm_connector_unregister - unregister a connector
495  * @connector: the connector to unregister
496  *
497  * Unregister userspace interfaces for a connector
498  */
499 void drm_connector_unregister(struct drm_connector *connector)
500 {
501 	mutex_lock(&connector->mutex);
502 	if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
503 		mutex_unlock(&connector->mutex);
504 		return;
505 	}
506 
507 	if (connector->funcs->early_unregister)
508 		connector->funcs->early_unregister(connector);
509 
510 	drm_sysfs_connector_remove(connector);
511 	drm_debugfs_connector_remove(connector);
512 
513 	connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
514 	mutex_unlock(&connector->mutex);
515 }
516 EXPORT_SYMBOL(drm_connector_unregister);
517 
518 void drm_connector_unregister_all(struct drm_device *dev)
519 {
520 	struct drm_connector *connector;
521 	struct drm_connector_list_iter conn_iter;
522 
523 	drm_connector_list_iter_begin(dev, &conn_iter);
524 	drm_for_each_connector_iter(connector, &conn_iter)
525 		drm_connector_unregister(connector);
526 	drm_connector_list_iter_end(&conn_iter);
527 }
528 
529 int drm_connector_register_all(struct drm_device *dev)
530 {
531 	struct drm_connector *connector;
532 	struct drm_connector_list_iter conn_iter;
533 	int ret = 0;
534 
535 	drm_connector_list_iter_begin(dev, &conn_iter);
536 	drm_for_each_connector_iter(connector, &conn_iter) {
537 		ret = drm_connector_register(connector);
538 		if (ret)
539 			break;
540 	}
541 	drm_connector_list_iter_end(&conn_iter);
542 
543 	if (ret)
544 		drm_connector_unregister_all(dev);
545 	return ret;
546 }
547 
548 /**
549  * drm_get_connector_status_name - return a string for connector status
550  * @status: connector status to compute name of
551  *
552  * In contrast to the other drm_get_*_name functions this one here returns a
553  * const pointer and hence is threadsafe.
554  */
555 const char *drm_get_connector_status_name(enum drm_connector_status status)
556 {
557 	if (status == connector_status_connected)
558 		return "connected";
559 	else if (status == connector_status_disconnected)
560 		return "disconnected";
561 	else
562 		return "unknown";
563 }
564 EXPORT_SYMBOL(drm_get_connector_status_name);
565 
566 /**
567  * drm_get_connector_force_name - return a string for connector force
568  * @force: connector force to get name of
569  *
570  * Returns: const pointer to name.
571  */
572 const char *drm_get_connector_force_name(enum drm_connector_force force)
573 {
574 	switch (force) {
575 	case DRM_FORCE_UNSPECIFIED:
576 		return "unspecified";
577 	case DRM_FORCE_OFF:
578 		return "off";
579 	case DRM_FORCE_ON:
580 		return "on";
581 	case DRM_FORCE_ON_DIGITAL:
582 		return "digital";
583 	default:
584 		return "unknown";
585 	}
586 }
587 
588 #ifdef CONFIG_LOCKDEP
589 static struct lockdep_map connector_list_iter_dep_map = {
590 	.name = "drm_connector_list_iter"
591 };
592 #endif
593 
594 /**
595  * drm_connector_list_iter_begin - initialize a connector_list iterator
596  * @dev: DRM device
597  * @iter: connector_list iterator
598  *
599  * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
600  * must always be cleaned up again by calling drm_connector_list_iter_end().
601  * Iteration itself happens using drm_connector_list_iter_next() or
602  * drm_for_each_connector_iter().
603  */
604 void drm_connector_list_iter_begin(struct drm_device *dev,
605 				   struct drm_connector_list_iter *iter)
606 {
607 	iter->dev = dev;
608 	iter->conn = NULL;
609 	lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
610 }
611 EXPORT_SYMBOL(drm_connector_list_iter_begin);
612 
613 /*
614  * Extra-safe connector put function that works in any context. Should only be
615  * used from the connector_iter functions, where we never really expect to
616  * actually release the connector when dropping our final reference.
617  */
618 static void
619 __drm_connector_put_safe(struct drm_connector *conn)
620 {
621 	struct drm_mode_config *config = &conn->dev->mode_config;
622 
623 	lockdep_assert_held(&config->connector_list_lock);
624 
625 	if (!refcount_dec_and_test(&conn->base.refcount.refcount))
626 		return;
627 
628 	llist_add(&conn->free_node, &config->connector_free_list);
629 	schedule_work(&config->connector_free_work);
630 }
631 
632 /**
633  * drm_connector_list_iter_next - return next connector
634  * @iter: connector_list iterator
635  *
636  * Returns the next connector for @iter, or NULL when the list walk has
637  * completed.
638  */
639 struct drm_connector *
640 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
641 {
642 	struct drm_connector *old_conn = iter->conn;
643 	struct drm_mode_config *config = &iter->dev->mode_config;
644 	struct list_head *lhead;
645 	unsigned long flags;
646 
647 	spin_lock_irqsave(&config->connector_list_lock, flags);
648 	lhead = old_conn ? &old_conn->head : &config->connector_list;
649 
650 	do {
651 		if (lhead->next == &config->connector_list) {
652 			iter->conn = NULL;
653 			break;
654 		}
655 
656 		lhead = lhead->next;
657 		iter->conn = list_entry(lhead, struct drm_connector, head);
658 
659 		/* loop until it's not a zombie connector */
660 	} while (!kref_get_unless_zero(&iter->conn->base.refcount));
661 
662 	if (old_conn)
663 		__drm_connector_put_safe(old_conn);
664 	spin_unlock_irqrestore(&config->connector_list_lock, flags);
665 
666 	return iter->conn;
667 }
668 EXPORT_SYMBOL(drm_connector_list_iter_next);
669 
670 /**
671  * drm_connector_list_iter_end - tear down a connector_list iterator
672  * @iter: connector_list iterator
673  *
674  * Tears down @iter and releases any resources (like &drm_connector references)
675  * acquired while walking the list. This must always be called, both when the
676  * iteration completes fully or when it was aborted without walking the entire
677  * list.
678  */
679 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
680 {
681 	struct drm_mode_config *config = &iter->dev->mode_config;
682 	unsigned long flags;
683 
684 	iter->dev = NULL;
685 	if (iter->conn) {
686 		spin_lock_irqsave(&config->connector_list_lock, flags);
687 		__drm_connector_put_safe(iter->conn);
688 		spin_unlock_irqrestore(&config->connector_list_lock, flags);
689 	}
690 	lock_release(&connector_list_iter_dep_map, 0, _RET_IP_);
691 }
692 EXPORT_SYMBOL(drm_connector_list_iter_end);
693 
694 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
695 	{ SubPixelUnknown, "Unknown" },
696 	{ SubPixelHorizontalRGB, "Horizontal RGB" },
697 	{ SubPixelHorizontalBGR, "Horizontal BGR" },
698 	{ SubPixelVerticalRGB, "Vertical RGB" },
699 	{ SubPixelVerticalBGR, "Vertical BGR" },
700 	{ SubPixelNone, "None" },
701 };
702 
703 /**
704  * drm_get_subpixel_order_name - return a string for a given subpixel enum
705  * @order: enum of subpixel_order
706  *
707  * Note you could abuse this and return something out of bounds, but that
708  * would be a caller error.  No unscrubbed user data should make it here.
709  */
710 const char *drm_get_subpixel_order_name(enum subpixel_order order)
711 {
712 	return drm_subpixel_enum_list[order].name;
713 }
714 EXPORT_SYMBOL(drm_get_subpixel_order_name);
715 
716 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
717 	{ DRM_MODE_DPMS_ON, "On" },
718 	{ DRM_MODE_DPMS_STANDBY, "Standby" },
719 	{ DRM_MODE_DPMS_SUSPEND, "Suspend" },
720 	{ DRM_MODE_DPMS_OFF, "Off" }
721 };
722 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
723 
724 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
725 	{ DRM_MODE_LINK_STATUS_GOOD, "Good" },
726 	{ DRM_MODE_LINK_STATUS_BAD, "Bad" },
727 };
728 
729 /**
730  * drm_display_info_set_bus_formats - set the supported bus formats
731  * @info: display info to store bus formats in
732  * @formats: array containing the supported bus formats
733  * @num_formats: the number of entries in the fmts array
734  *
735  * Store the supported bus formats in display info structure.
736  * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
737  * a full list of available formats.
738  */
739 int drm_display_info_set_bus_formats(struct drm_display_info *info,
740 				     const u32 *formats,
741 				     unsigned int num_formats)
742 {
743 	u32 *fmts = NULL;
744 
745 	if (!formats && num_formats)
746 		return -EINVAL;
747 
748 	if (formats && num_formats) {
749 		fmts = kmemdup(formats, sizeof(*formats) * num_formats,
750 			       GFP_KERNEL);
751 		if (!fmts)
752 			return -ENOMEM;
753 	}
754 
755 	kfree(info->bus_formats);
756 	info->bus_formats = fmts;
757 	info->num_bus_formats = num_formats;
758 
759 	return 0;
760 }
761 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
762 
763 /* Optional connector properties. */
764 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
765 	{ DRM_MODE_SCALE_NONE, "None" },
766 	{ DRM_MODE_SCALE_FULLSCREEN, "Full" },
767 	{ DRM_MODE_SCALE_CENTER, "Center" },
768 	{ DRM_MODE_SCALE_ASPECT, "Full aspect" },
769 };
770 
771 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
772 	{ DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
773 	{ DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
774 	{ DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
775 };
776 
777 static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
778 	{ DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
779 	{ DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
780 	{ DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
781 	{ DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
782 	{ DRM_MODE_CONTENT_TYPE_GAME, "Game" },
783 };
784 
785 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
786 	{ DRM_MODE_PANEL_ORIENTATION_NORMAL,	"Normal"	},
787 	{ DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,	"Upside Down"	},
788 	{ DRM_MODE_PANEL_ORIENTATION_LEFT_UP,	"Left Side Up"	},
789 	{ DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,	"Right Side Up"	},
790 };
791 
792 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
793 	{ DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
794 	{ DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
795 	{ DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
796 };
797 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
798 
799 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
800 	{ DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
801 	{ DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
802 	{ DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
803 };
804 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
805 		 drm_dvi_i_subconnector_enum_list)
806 
807 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
808 	{ DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
809 	{ DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
810 	{ DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
811 	{ DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
812 	{ DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
813 };
814 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
815 
816 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
817 	{ DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
818 	{ DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
819 	{ DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
820 	{ DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
821 	{ DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
822 };
823 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
824 		 drm_tv_subconnector_enum_list)
825 
826 static const struct drm_prop_enum_list hdmi_colorspaces[] = {
827 	/* For Default case, driver will set the colorspace */
828 	{ DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
829 	/* Standard Definition Colorimetry based on CEA 861 */
830 	{ DRM_MODE_COLORIMETRY_SMPTE_170M_YCC, "SMPTE_170M_YCC" },
831 	{ DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
832 	/* Standard Definition Colorimetry based on IEC 61966-2-4 */
833 	{ DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
834 	/* High Definition Colorimetry based on IEC 61966-2-4 */
835 	{ DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
836 	/* Colorimetry based on IEC 61966-2-1/Amendment 1 */
837 	{ DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
838 	/* Colorimetry based on IEC 61966-2-5 [33] */
839 	{ DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
840 	/* Colorimetry based on IEC 61966-2-5 */
841 	{ DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
842 	/* Colorimetry based on ITU-R BT.2020 */
843 	{ DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
844 	/* Colorimetry based on ITU-R BT.2020 */
845 	{ DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
846 	/* Colorimetry based on ITU-R BT.2020 */
847 	{ DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
848 	/* Added as part of Additional Colorimetry Extension in 861.G */
849 	{ DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
850 	{ DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER, "DCI-P3_RGB_Theater" },
851 };
852 
853 /**
854  * DOC: standard connector properties
855  *
856  * DRM connectors have a few standardized properties:
857  *
858  * EDID:
859  * 	Blob property which contains the current EDID read from the sink. This
860  * 	is useful to parse sink identification information like vendor, model
861  * 	and serial. Drivers should update this property by calling
862  * 	drm_connector_update_edid_property(), usually after having parsed
863  * 	the EDID using drm_add_edid_modes(). Userspace cannot change this
864  * 	property.
865  * DPMS:
866  * 	Legacy property for setting the power state of the connector. For atomic
867  * 	drivers this is only provided for backwards compatibility with existing
868  * 	drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
869  * 	connector is linked to. Drivers should never set this property directly,
870  * 	it is handled by the DRM core by calling the &drm_connector_funcs.dpms
871  * 	callback. For atomic drivers the remapping to the "ACTIVE" property is
872  * 	implemented in the DRM core.  This is the only standard connector
873  * 	property that userspace can change.
874  *
875  * 	Note that this property cannot be set through the MODE_ATOMIC ioctl,
876  * 	userspace must use "ACTIVE" on the CRTC instead.
877  *
878  * 	WARNING:
879  *
880  * 	For userspace also running on legacy drivers the "DPMS" semantics are a
881  * 	lot more complicated. First, userspace cannot rely on the "DPMS" value
882  * 	returned by the GETCONNECTOR actually reflecting reality, because many
883  * 	drivers fail to update it. For atomic drivers this is taken care of in
884  * 	drm_atomic_helper_update_legacy_modeset_state().
885  *
886  * 	The second issue is that the DPMS state is only well-defined when the
887  * 	connector is connected to a CRTC. In atomic the DRM core enforces that
888  * 	"ACTIVE" is off in such a case, no such checks exists for "DPMS".
889  *
890  * 	Finally, when enabling an output using the legacy SETCONFIG ioctl then
891  * 	"DPMS" is forced to ON. But see above, that might not be reflected in
892  * 	the software value on legacy drivers.
893  *
894  * 	Summarizing: Only set "DPMS" when the connector is known to be enabled,
895  * 	assume that a successful SETCONFIG call also sets "DPMS" to on, and
896  * 	never read back the value of "DPMS" because it can be incorrect.
897  * PATH:
898  * 	Connector path property to identify how this sink is physically
899  * 	connected. Used by DP MST. This should be set by calling
900  * 	drm_connector_set_path_property(), in the case of DP MST with the
901  * 	path property the MST manager created. Userspace cannot change this
902  * 	property.
903  * TILE:
904  * 	Connector tile group property to indicate how a set of DRM connector
905  * 	compose together into one logical screen. This is used by both high-res
906  * 	external screens (often only using a single cable, but exposing multiple
907  * 	DP MST sinks), or high-res integrated panels (like dual-link DSI) which
908  * 	are not gen-locked. Note that for tiled panels which are genlocked, like
909  * 	dual-link LVDS or dual-link DSI, the driver should try to not expose the
910  * 	tiling and virtualize both &drm_crtc and &drm_plane if needed. Drivers
911  * 	should update this value using drm_connector_set_tile_property().
912  * 	Userspace cannot change this property.
913  * link-status:
914  *      Connector link-status property to indicate the status of link. The
915  *      default value of link-status is "GOOD". If something fails during or
916  *      after modeset, the kernel driver may set this to "BAD" and issue a
917  *      hotplug uevent. Drivers should update this value using
918  *      drm_connector_set_link_status_property().
919  * non_desktop:
920  * 	Indicates the output should be ignored for purposes of displaying a
921  * 	standard desktop environment or console. This is most likely because
922  * 	the output device is not rectilinear.
923  * Content Protection:
924  *	This property is used by userspace to request the kernel protect future
925  *	content communicated over the link. When requested, kernel will apply
926  *	the appropriate means of protection (most often HDCP), and use the
927  *	property to tell userspace the protection is active.
928  *
929  *	Drivers can set this up by calling
930  *	drm_connector_attach_content_protection_property() on initialization.
931  *
932  *	The value of this property can be one of the following:
933  *
934  *	DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
935  *		The link is not protected, content is transmitted in the clear.
936  *	DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
937  *		Userspace has requested content protection, but the link is not
938  *		currently protected. When in this state, kernel should enable
939  *		Content Protection as soon as possible.
940  *	DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
941  *		Userspace has requested content protection, and the link is
942  *		protected. Only the driver can set the property to this value.
943  *		If userspace attempts to set to ENABLED, kernel will return
944  *		-EINVAL.
945  *
946  *	A few guidelines:
947  *
948  *	- DESIRED state should be preserved until userspace de-asserts it by
949  *	  setting the property to UNDESIRED. This means ENABLED should only
950  *	  transition to UNDESIRED when the user explicitly requests it.
951  *	- If the state is DESIRED, kernel should attempt to re-authenticate the
952  *	  link whenever possible. This includes across disable/enable, dpms,
953  *	  hotplug, downstream device changes, link status failures, etc..
954  *	- Userspace is responsible for polling the property to determine when
955  *	  the value transitions from ENABLED to DESIRED. This signifies the link
956  *	  is no longer protected and userspace should take appropriate action
957  *	  (whatever that might be).
958  *
959  * HDR_OUTPUT_METADATA:
960  *	Connector property to enable userspace to send HDR Metadata to
961  *	driver. This metadata is based on the composition and blending
962  *	policies decided by user, taking into account the hardware and
963  *	sink capabilities. The driver gets this metadata and creates a
964  *	Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
965  *	SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
966  *	sent to sink. This notifies the sink of the upcoming frame's Color
967  *	Encoding and Luminance parameters.
968  *
969  *	Userspace first need to detect the HDR capabilities of sink by
970  *	reading and parsing the EDID. Details of HDR metadata for HDMI
971  *	are added in CTA 861.G spec. For DP , its defined in VESA DP
972  *	Standard v1.4. It needs to then get the metadata information
973  *	of the video/game/app content which are encoded in HDR (basically
974  *	using HDR transfer functions). With this information it needs to
975  *	decide on a blending policy and compose the relevant
976  *	layers/overlays into a common format. Once this blending is done,
977  *	userspace will be aware of the metadata of the composed frame to
978  *	be send to sink. It then uses this property to communicate this
979  *	metadata to driver which then make a Infoframe packet and sends
980  *	to sink based on the type of encoder connected.
981  *
982  *	Userspace will be responsible to do Tone mapping operation in case:
983  *		- Some layers are HDR and others are SDR
984  *		- HDR layers luminance is not same as sink
985  *	It will even need to do colorspace conversion and get all layers
986  *	to one common colorspace for blending. It can use either GL, Media
987  *	or display engine to get this done based on the capabilties of the
988  *	associated hardware.
989  *
990  *	Driver expects metadata to be put in &struct hdr_output_metadata
991  *	structure from userspace. This is received as blob and stored in
992  *	&drm_connector_state.hdr_output_metadata. It parses EDID and saves the
993  *	sink metadata in &struct hdr_sink_metadata, as
994  *	&drm_connector.hdr_sink_metadata.  Driver uses
995  *	drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
996  *	hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
997  *	HDMI encoder.
998  *
999  * max bpc:
1000  *	This range property is used by userspace to limit the bit depth. When
1001  *	used the driver would limit the bpc in accordance with the valid range
1002  *	supported by the hardware and sink. Drivers to use the function
1003  *	drm_connector_attach_max_bpc_property() to create and attach the
1004  *	property to the connector during initialization.
1005  *
1006  * Connectors also have one standardized atomic property:
1007  *
1008  * CRTC_ID:
1009  * 	Mode object ID of the &drm_crtc this connector should be connected to.
1010  *
1011  * Connectors for LCD panels may also have one standardized property:
1012  *
1013  * panel orientation:
1014  *	On some devices the LCD panel is mounted in the casing in such a way
1015  *	that the up/top side of the panel does not match with the top side of
1016  *	the device. Userspace can use this property to check for this.
1017  *	Note that input coordinates from touchscreens (input devices with
1018  *	INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1019  *	coordinates, so if userspace rotates the picture to adjust for
1020  *	the orientation it must also apply the same transformation to the
1021  *	touchscreen input coordinates. This property is initialized by calling
1022  *	drm_connector_init_panel_orientation_property().
1023  *
1024  * scaling mode:
1025  *	This property defines how a non-native mode is upscaled to the native
1026  *	mode of an LCD panel:
1027  *
1028  *	None:
1029  *		No upscaling happens, scaling is left to the panel. Not all
1030  *		drivers expose this mode.
1031  *	Full:
1032  *		The output is upscaled to the full resolution of the panel,
1033  *		ignoring the aspect ratio.
1034  *	Center:
1035  *		No upscaling happens, the output is centered within the native
1036  *		resolution the panel.
1037  *	Full aspect:
1038  *		The output is upscaled to maximize either the width or height
1039  *		while retaining the aspect ratio.
1040  *
1041  *	This property should be set up by calling
1042  *	drm_connector_attach_scaling_mode_property(). Note that drivers
1043  *	can also expose this property to external outputs, in which case they
1044  *	must support "None", which should be the default (since external screens
1045  *	have a built-in scaler).
1046  */
1047 
1048 int drm_connector_create_standard_properties(struct drm_device *dev)
1049 {
1050 	struct drm_property *prop;
1051 
1052 	prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1053 				   DRM_MODE_PROP_IMMUTABLE,
1054 				   "EDID", 0);
1055 	if (!prop)
1056 		return -ENOMEM;
1057 	dev->mode_config.edid_property = prop;
1058 
1059 	prop = drm_property_create_enum(dev, 0,
1060 				   "DPMS", drm_dpms_enum_list,
1061 				   ARRAY_SIZE(drm_dpms_enum_list));
1062 	if (!prop)
1063 		return -ENOMEM;
1064 	dev->mode_config.dpms_property = prop;
1065 
1066 	prop = drm_property_create(dev,
1067 				   DRM_MODE_PROP_BLOB |
1068 				   DRM_MODE_PROP_IMMUTABLE,
1069 				   "PATH", 0);
1070 	if (!prop)
1071 		return -ENOMEM;
1072 	dev->mode_config.path_property = prop;
1073 
1074 	prop = drm_property_create(dev,
1075 				   DRM_MODE_PROP_BLOB |
1076 				   DRM_MODE_PROP_IMMUTABLE,
1077 				   "TILE", 0);
1078 	if (!prop)
1079 		return -ENOMEM;
1080 	dev->mode_config.tile_property = prop;
1081 
1082 	prop = drm_property_create_enum(dev, 0, "link-status",
1083 					drm_link_status_enum_list,
1084 					ARRAY_SIZE(drm_link_status_enum_list));
1085 	if (!prop)
1086 		return -ENOMEM;
1087 	dev->mode_config.link_status_property = prop;
1088 
1089 	prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1090 	if (!prop)
1091 		return -ENOMEM;
1092 	dev->mode_config.non_desktop_property = prop;
1093 
1094 	prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1095 				   "HDR_OUTPUT_METADATA", 0);
1096 	if (!prop)
1097 		return -ENOMEM;
1098 	dev->mode_config.hdr_output_metadata_property = prop;
1099 
1100 	return 0;
1101 }
1102 
1103 /**
1104  * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1105  * @dev: DRM device
1106  *
1107  * Called by a driver the first time a DVI-I connector is made.
1108  */
1109 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1110 {
1111 	struct drm_property *dvi_i_selector;
1112 	struct drm_property *dvi_i_subconnector;
1113 
1114 	if (dev->mode_config.dvi_i_select_subconnector_property)
1115 		return 0;
1116 
1117 	dvi_i_selector =
1118 		drm_property_create_enum(dev, 0,
1119 				    "select subconnector",
1120 				    drm_dvi_i_select_enum_list,
1121 				    ARRAY_SIZE(drm_dvi_i_select_enum_list));
1122 	dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1123 
1124 	dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1125 				    "subconnector",
1126 				    drm_dvi_i_subconnector_enum_list,
1127 				    ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1128 	dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1129 
1130 	return 0;
1131 }
1132 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1133 
1134 /**
1135  * DOC: HDMI connector properties
1136  *
1137  * content type (HDMI specific):
1138  *	Indicates content type setting to be used in HDMI infoframes to indicate
1139  *	content type for the external device, so that it adjusts its display
1140  *	settings accordingly.
1141  *
1142  *	The value of this property can be one of the following:
1143  *
1144  *	No Data:
1145  *		Content type is unknown
1146  *	Graphics:
1147  *		Content type is graphics
1148  *	Photo:
1149  *		Content type is photo
1150  *	Cinema:
1151  *		Content type is cinema
1152  *	Game:
1153  *		Content type is game
1154  *
1155  *	Drivers can set up this property by calling
1156  *	drm_connector_attach_content_type_property(). Decoding to
1157  *	infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1158  */
1159 
1160 /**
1161  * drm_connector_attach_content_type_property - attach content-type property
1162  * @connector: connector to attach content type property on.
1163  *
1164  * Called by a driver the first time a HDMI connector is made.
1165  */
1166 int drm_connector_attach_content_type_property(struct drm_connector *connector)
1167 {
1168 	if (!drm_mode_create_content_type_property(connector->dev))
1169 		drm_object_attach_property(&connector->base,
1170 					   connector->dev->mode_config.content_type_property,
1171 					   DRM_MODE_CONTENT_TYPE_NO_DATA);
1172 	return 0;
1173 }
1174 EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1175 
1176 
1177 /**
1178  * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1179  *                                         content type information, based
1180  *                                         on correspondent DRM property.
1181  * @frame: HDMI AVI infoframe
1182  * @conn_state: DRM display connector state
1183  *
1184  */
1185 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1186 					 const struct drm_connector_state *conn_state)
1187 {
1188 	switch (conn_state->content_type) {
1189 	case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1190 		frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1191 		break;
1192 	case DRM_MODE_CONTENT_TYPE_CINEMA:
1193 		frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1194 		break;
1195 	case DRM_MODE_CONTENT_TYPE_GAME:
1196 		frame->content_type = HDMI_CONTENT_TYPE_GAME;
1197 		break;
1198 	case DRM_MODE_CONTENT_TYPE_PHOTO:
1199 		frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1200 		break;
1201 	default:
1202 		/* Graphics is the default(0) */
1203 		frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1204 	}
1205 
1206 	frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1207 }
1208 EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1209 
1210 /**
1211  * drm_mode_attach_tv_margin_properties - attach TV connector margin properties
1212  * @connector: DRM connector
1213  *
1214  * Called by a driver when it needs to attach TV margin props to a connector.
1215  * Typically used on SDTV and HDMI connectors.
1216  */
1217 void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1218 {
1219 	struct drm_device *dev = connector->dev;
1220 
1221 	drm_object_attach_property(&connector->base,
1222 				   dev->mode_config.tv_left_margin_property,
1223 				   0);
1224 	drm_object_attach_property(&connector->base,
1225 				   dev->mode_config.tv_right_margin_property,
1226 				   0);
1227 	drm_object_attach_property(&connector->base,
1228 				   dev->mode_config.tv_top_margin_property,
1229 				   0);
1230 	drm_object_attach_property(&connector->base,
1231 				   dev->mode_config.tv_bottom_margin_property,
1232 				   0);
1233 }
1234 EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1235 
1236 /**
1237  * drm_mode_create_tv_margin_properties - create TV connector margin properties
1238  * @dev: DRM device
1239  *
1240  * Called by a driver's HDMI connector initialization routine, this function
1241  * creates the TV margin properties for a given device. No need to call this
1242  * function for an SDTV connector, it's already called from
1243  * drm_mode_create_tv_properties().
1244  */
1245 int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1246 {
1247 	if (dev->mode_config.tv_left_margin_property)
1248 		return 0;
1249 
1250 	dev->mode_config.tv_left_margin_property =
1251 		drm_property_create_range(dev, 0, "left margin", 0, 100);
1252 	if (!dev->mode_config.tv_left_margin_property)
1253 		return -ENOMEM;
1254 
1255 	dev->mode_config.tv_right_margin_property =
1256 		drm_property_create_range(dev, 0, "right margin", 0, 100);
1257 	if (!dev->mode_config.tv_right_margin_property)
1258 		return -ENOMEM;
1259 
1260 	dev->mode_config.tv_top_margin_property =
1261 		drm_property_create_range(dev, 0, "top margin", 0, 100);
1262 	if (!dev->mode_config.tv_top_margin_property)
1263 		return -ENOMEM;
1264 
1265 	dev->mode_config.tv_bottom_margin_property =
1266 		drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1267 	if (!dev->mode_config.tv_bottom_margin_property)
1268 		return -ENOMEM;
1269 
1270 	return 0;
1271 }
1272 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1273 
1274 /**
1275  * drm_mode_create_tv_properties - create TV specific connector properties
1276  * @dev: DRM device
1277  * @num_modes: number of different TV formats (modes) supported
1278  * @modes: array of pointers to strings containing name of each format
1279  *
1280  * Called by a driver's TV initialization routine, this function creates
1281  * the TV specific connector properties for a given device.  Caller is
1282  * responsible for allocating a list of format names and passing them to
1283  * this routine.
1284  */
1285 int drm_mode_create_tv_properties(struct drm_device *dev,
1286 				  unsigned int num_modes,
1287 				  const char * const modes[])
1288 {
1289 	struct drm_property *tv_selector;
1290 	struct drm_property *tv_subconnector;
1291 	unsigned int i;
1292 
1293 	if (dev->mode_config.tv_select_subconnector_property)
1294 		return 0;
1295 
1296 	/*
1297 	 * Basic connector properties
1298 	 */
1299 	tv_selector = drm_property_create_enum(dev, 0,
1300 					  "select subconnector",
1301 					  drm_tv_select_enum_list,
1302 					  ARRAY_SIZE(drm_tv_select_enum_list));
1303 	if (!tv_selector)
1304 		goto nomem;
1305 
1306 	dev->mode_config.tv_select_subconnector_property = tv_selector;
1307 
1308 	tv_subconnector =
1309 		drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1310 				    "subconnector",
1311 				    drm_tv_subconnector_enum_list,
1312 				    ARRAY_SIZE(drm_tv_subconnector_enum_list));
1313 	if (!tv_subconnector)
1314 		goto nomem;
1315 	dev->mode_config.tv_subconnector_property = tv_subconnector;
1316 
1317 	/*
1318 	 * Other, TV specific properties: margins & TV modes.
1319 	 */
1320 	if (drm_mode_create_tv_margin_properties(dev))
1321 		goto nomem;
1322 
1323 	dev->mode_config.tv_mode_property =
1324 		drm_property_create(dev, DRM_MODE_PROP_ENUM,
1325 				    "mode", num_modes);
1326 	if (!dev->mode_config.tv_mode_property)
1327 		goto nomem;
1328 
1329 	for (i = 0; i < num_modes; i++)
1330 		drm_property_add_enum(dev->mode_config.tv_mode_property,
1331 				      i, modes[i]);
1332 
1333 	dev->mode_config.tv_brightness_property =
1334 		drm_property_create_range(dev, 0, "brightness", 0, 100);
1335 	if (!dev->mode_config.tv_brightness_property)
1336 		goto nomem;
1337 
1338 	dev->mode_config.tv_contrast_property =
1339 		drm_property_create_range(dev, 0, "contrast", 0, 100);
1340 	if (!dev->mode_config.tv_contrast_property)
1341 		goto nomem;
1342 
1343 	dev->mode_config.tv_flicker_reduction_property =
1344 		drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1345 	if (!dev->mode_config.tv_flicker_reduction_property)
1346 		goto nomem;
1347 
1348 	dev->mode_config.tv_overscan_property =
1349 		drm_property_create_range(dev, 0, "overscan", 0, 100);
1350 	if (!dev->mode_config.tv_overscan_property)
1351 		goto nomem;
1352 
1353 	dev->mode_config.tv_saturation_property =
1354 		drm_property_create_range(dev, 0, "saturation", 0, 100);
1355 	if (!dev->mode_config.tv_saturation_property)
1356 		goto nomem;
1357 
1358 	dev->mode_config.tv_hue_property =
1359 		drm_property_create_range(dev, 0, "hue", 0, 100);
1360 	if (!dev->mode_config.tv_hue_property)
1361 		goto nomem;
1362 
1363 	return 0;
1364 nomem:
1365 	return -ENOMEM;
1366 }
1367 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1368 
1369 /**
1370  * drm_mode_create_scaling_mode_property - create scaling mode property
1371  * @dev: DRM device
1372  *
1373  * Called by a driver the first time it's needed, must be attached to desired
1374  * connectors.
1375  *
1376  * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1377  * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1378  * in the atomic state.
1379  */
1380 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1381 {
1382 	struct drm_property *scaling_mode;
1383 
1384 	if (dev->mode_config.scaling_mode_property)
1385 		return 0;
1386 
1387 	scaling_mode =
1388 		drm_property_create_enum(dev, 0, "scaling mode",
1389 				drm_scaling_mode_enum_list,
1390 				    ARRAY_SIZE(drm_scaling_mode_enum_list));
1391 
1392 	dev->mode_config.scaling_mode_property = scaling_mode;
1393 
1394 	return 0;
1395 }
1396 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1397 
1398 /**
1399  * DOC: Variable refresh properties
1400  *
1401  * Variable refresh rate capable displays can dynamically adjust their
1402  * refresh rate by extending the duration of their vertical front porch
1403  * until page flip or timeout occurs. This can reduce or remove stuttering
1404  * and latency in scenarios where the page flip does not align with the
1405  * vblank interval.
1406  *
1407  * An example scenario would be an application flipping at a constant rate
1408  * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1409  * interval and the same contents will be displayed twice. This can be
1410  * observed as stuttering for content with motion.
1411  *
1412  * If variable refresh rate was active on a display that supported a
1413  * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1414  * for the example scenario. The minimum supported variable refresh rate of
1415  * 35Hz is below the page flip frequency and the vertical front porch can
1416  * be extended until the page flip occurs. The vblank interval will be
1417  * directly aligned to the page flip rate.
1418  *
1419  * Not all userspace content is suitable for use with variable refresh rate.
1420  * Large and frequent changes in vertical front porch duration may worsen
1421  * perceived stuttering for input sensitive applications.
1422  *
1423  * Panel brightness will also vary with vertical front porch duration. Some
1424  * panels may have noticeable differences in brightness between the minimum
1425  * vertical front porch duration and the maximum vertical front porch duration.
1426  * Large and frequent changes in vertical front porch duration may produce
1427  * observable flickering for such panels.
1428  *
1429  * Userspace control for variable refresh rate is supported via properties
1430  * on the &drm_connector and &drm_crtc objects.
1431  *
1432  * "vrr_capable":
1433  *	Optional &drm_connector boolean property that drivers should attach
1434  *	with drm_connector_attach_vrr_capable_property() on connectors that
1435  *	could support variable refresh rates. Drivers should update the
1436  *	property value by calling drm_connector_set_vrr_capable_property().
1437  *
1438  *	Absence of the property should indicate absence of support.
1439  *
1440  * "VRR_ENABLED":
1441  *	Default &drm_crtc boolean property that notifies the driver that the
1442  *	content on the CRTC is suitable for variable refresh rate presentation.
1443  *	The driver will take this property as a hint to enable variable
1444  *	refresh rate support if the receiver supports it, ie. if the
1445  *	"vrr_capable" property is true on the &drm_connector object. The
1446  *	vertical front porch duration will be extended until page-flip or
1447  *	timeout when enabled.
1448  *
1449  *	The minimum vertical front porch duration is defined as the vertical
1450  *	front porch duration for the current mode.
1451  *
1452  *	The maximum vertical front porch duration is greater than or equal to
1453  *	the minimum vertical front porch duration. The duration is derived
1454  *	from the minimum supported variable refresh rate for the connector.
1455  *
1456  *	The driver may place further restrictions within these minimum
1457  *	and maximum bounds.
1458  */
1459 
1460 /**
1461  * drm_connector_attach_vrr_capable_property - creates the
1462  * vrr_capable property
1463  * @connector: connector to create the vrr_capable property on.
1464  *
1465  * This is used by atomic drivers to add support for querying
1466  * variable refresh rate capability for a connector.
1467  *
1468  * Returns:
1469  * Zero on success, negative errono on failure.
1470  */
1471 int drm_connector_attach_vrr_capable_property(
1472 	struct drm_connector *connector)
1473 {
1474 	struct drm_device *dev = connector->dev;
1475 	struct drm_property *prop;
1476 
1477 	if (!connector->vrr_capable_property) {
1478 		prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
1479 			"vrr_capable");
1480 		if (!prop)
1481 			return -ENOMEM;
1482 
1483 		connector->vrr_capable_property = prop;
1484 		drm_object_attach_property(&connector->base, prop, 0);
1485 	}
1486 
1487 	return 0;
1488 }
1489 EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
1490 
1491 /**
1492  * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1493  * @connector: connector to attach scaling mode property on.
1494  * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1495  *
1496  * This is used to add support for scaling mode to atomic drivers.
1497  * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1498  * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1499  *
1500  * This is the atomic version of drm_mode_create_scaling_mode_property().
1501  *
1502  * Returns:
1503  * Zero on success, negative errno on failure.
1504  */
1505 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1506 					       u32 scaling_mode_mask)
1507 {
1508 	struct drm_device *dev = connector->dev;
1509 	struct drm_property *scaling_mode_property;
1510 	int i;
1511 	const unsigned valid_scaling_mode_mask =
1512 		(1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1513 
1514 	if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1515 		    scaling_mode_mask & ~valid_scaling_mode_mask))
1516 		return -EINVAL;
1517 
1518 	scaling_mode_property =
1519 		drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1520 				    hweight32(scaling_mode_mask));
1521 
1522 	if (!scaling_mode_property)
1523 		return -ENOMEM;
1524 
1525 	for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1526 		int ret;
1527 
1528 		if (!(BIT(i) & scaling_mode_mask))
1529 			continue;
1530 
1531 		ret = drm_property_add_enum(scaling_mode_property,
1532 					    drm_scaling_mode_enum_list[i].type,
1533 					    drm_scaling_mode_enum_list[i].name);
1534 
1535 		if (ret) {
1536 			drm_property_destroy(dev, scaling_mode_property);
1537 
1538 			return ret;
1539 		}
1540 	}
1541 
1542 	drm_object_attach_property(&connector->base,
1543 				   scaling_mode_property, 0);
1544 
1545 	connector->scaling_mode_property = scaling_mode_property;
1546 
1547 	return 0;
1548 }
1549 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1550 
1551 /**
1552  * drm_mode_create_aspect_ratio_property - create aspect ratio property
1553  * @dev: DRM device
1554  *
1555  * Called by a driver the first time it's needed, must be attached to desired
1556  * connectors.
1557  *
1558  * Returns:
1559  * Zero on success, negative errno on failure.
1560  */
1561 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1562 {
1563 	if (dev->mode_config.aspect_ratio_property)
1564 		return 0;
1565 
1566 	dev->mode_config.aspect_ratio_property =
1567 		drm_property_create_enum(dev, 0, "aspect ratio",
1568 				drm_aspect_ratio_enum_list,
1569 				ARRAY_SIZE(drm_aspect_ratio_enum_list));
1570 
1571 	if (dev->mode_config.aspect_ratio_property == NULL)
1572 		return -ENOMEM;
1573 
1574 	return 0;
1575 }
1576 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1577 
1578 /**
1579  * DOC: standard connector properties
1580  *
1581  * Colorspace:
1582  *     drm_mode_create_colorspace_property - create colorspace property
1583  *     This property helps select a suitable colorspace based on the sink
1584  *     capability. Modern sink devices support wider gamut like BT2020.
1585  *     This helps switch to BT2020 mode if the BT2020 encoded video stream
1586  *     is being played by the user, same for any other colorspace. Thereby
1587  *     giving a good visual experience to users.
1588  *
1589  *     The expectation from userspace is that it should parse the EDID
1590  *     and get supported colorspaces. Use this property and switch to the
1591  *     one supported. Sink supported colorspaces should be retrieved by
1592  *     userspace from EDID and driver will not explicitly expose them.
1593  *
1594  *     Basically the expectation from userspace is:
1595  *      - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1596  *        colorspace
1597  *      - Set this new property to let the sink know what it
1598  *        converted the CRTC output to.
1599  *      - This property is just to inform sink what colorspace
1600  *        source is trying to drive.
1601  *
1602  * Called by a driver the first time it's needed, must be attached to desired
1603  * connectors.
1604  */
1605 int drm_mode_create_colorspace_property(struct drm_connector *connector)
1606 {
1607 	struct drm_device *dev = connector->dev;
1608 	struct drm_property *prop;
1609 
1610 	if (connector->connector_type == DRM_MODE_CONNECTOR_HDMIA ||
1611 	    connector->connector_type == DRM_MODE_CONNECTOR_HDMIB) {
1612 		prop = drm_property_create_enum(dev, DRM_MODE_PROP_ENUM,
1613 						"Colorspace",
1614 						hdmi_colorspaces,
1615 						ARRAY_SIZE(hdmi_colorspaces));
1616 		if (!prop)
1617 			return -ENOMEM;
1618 	} else {
1619 		DRM_DEBUG_KMS("Colorspace property not supported\n");
1620 		return 0;
1621 	}
1622 
1623 	connector->colorspace_property = prop;
1624 
1625 	return 0;
1626 }
1627 EXPORT_SYMBOL(drm_mode_create_colorspace_property);
1628 
1629 /**
1630  * drm_mode_create_content_type_property - create content type property
1631  * @dev: DRM device
1632  *
1633  * Called by a driver the first time it's needed, must be attached to desired
1634  * connectors.
1635  *
1636  * Returns:
1637  * Zero on success, negative errno on failure.
1638  */
1639 int drm_mode_create_content_type_property(struct drm_device *dev)
1640 {
1641 	if (dev->mode_config.content_type_property)
1642 		return 0;
1643 
1644 	dev->mode_config.content_type_property =
1645 		drm_property_create_enum(dev, 0, "content type",
1646 					 drm_content_type_enum_list,
1647 					 ARRAY_SIZE(drm_content_type_enum_list));
1648 
1649 	if (dev->mode_config.content_type_property == NULL)
1650 		return -ENOMEM;
1651 
1652 	return 0;
1653 }
1654 EXPORT_SYMBOL(drm_mode_create_content_type_property);
1655 
1656 /**
1657  * drm_mode_create_suggested_offset_properties - create suggests offset properties
1658  * @dev: DRM device
1659  *
1660  * Create the the suggested x/y offset property for connectors.
1661  */
1662 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1663 {
1664 	if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1665 		return 0;
1666 
1667 	dev->mode_config.suggested_x_property =
1668 		drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1669 
1670 	dev->mode_config.suggested_y_property =
1671 		drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1672 
1673 	if (dev->mode_config.suggested_x_property == NULL ||
1674 	    dev->mode_config.suggested_y_property == NULL)
1675 		return -ENOMEM;
1676 	return 0;
1677 }
1678 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1679 
1680 /**
1681  * drm_connector_set_path_property - set tile property on connector
1682  * @connector: connector to set property on.
1683  * @path: path to use for property; must not be NULL.
1684  *
1685  * This creates a property to expose to userspace to specify a
1686  * connector path. This is mainly used for DisplayPort MST where
1687  * connectors have a topology and we want to allow userspace to give
1688  * them more meaningful names.
1689  *
1690  * Returns:
1691  * Zero on success, negative errno on failure.
1692  */
1693 int drm_connector_set_path_property(struct drm_connector *connector,
1694 				    const char *path)
1695 {
1696 	struct drm_device *dev = connector->dev;
1697 	int ret;
1698 
1699 	ret = drm_property_replace_global_blob(dev,
1700 	                                       &connector->path_blob_ptr,
1701 	                                       strlen(path) + 1,
1702 	                                       path,
1703 	                                       &connector->base,
1704 	                                       dev->mode_config.path_property);
1705 	return ret;
1706 }
1707 EXPORT_SYMBOL(drm_connector_set_path_property);
1708 
1709 /**
1710  * drm_connector_set_tile_property - set tile property on connector
1711  * @connector: connector to set property on.
1712  *
1713  * This looks up the tile information for a connector, and creates a
1714  * property for userspace to parse if it exists. The property is of
1715  * the form of 8 integers using ':' as a separator.
1716  * This is used for dual port tiled displays with DisplayPort SST
1717  * or DisplayPort MST connectors.
1718  *
1719  * Returns:
1720  * Zero on success, errno on failure.
1721  */
1722 int drm_connector_set_tile_property(struct drm_connector *connector)
1723 {
1724 	struct drm_device *dev = connector->dev;
1725 	char tile[256];
1726 	int ret;
1727 
1728 	if (!connector->has_tile) {
1729 		ret  = drm_property_replace_global_blob(dev,
1730 		                                        &connector->tile_blob_ptr,
1731 		                                        0,
1732 		                                        NULL,
1733 		                                        &connector->base,
1734 		                                        dev->mode_config.tile_property);
1735 		return ret;
1736 	}
1737 
1738 	snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
1739 		 connector->tile_group->id, connector->tile_is_single_monitor,
1740 		 connector->num_h_tile, connector->num_v_tile,
1741 		 connector->tile_h_loc, connector->tile_v_loc,
1742 		 connector->tile_h_size, connector->tile_v_size);
1743 
1744 	ret = drm_property_replace_global_blob(dev,
1745 	                                       &connector->tile_blob_ptr,
1746 	                                       strlen(tile) + 1,
1747 	                                       tile,
1748 	                                       &connector->base,
1749 	                                       dev->mode_config.tile_property);
1750 	return ret;
1751 }
1752 EXPORT_SYMBOL(drm_connector_set_tile_property);
1753 
1754 /**
1755  * drm_connector_update_edid_property - update the edid property of a connector
1756  * @connector: drm connector
1757  * @edid: new value of the edid property
1758  *
1759  * This function creates a new blob modeset object and assigns its id to the
1760  * connector's edid property.
1761  * Since we also parse tile information from EDID's displayID block, we also
1762  * set the connector's tile property here. See drm_connector_set_tile_property()
1763  * for more details.
1764  *
1765  * Returns:
1766  * Zero on success, negative errno on failure.
1767  */
1768 int drm_connector_update_edid_property(struct drm_connector *connector,
1769 				       const struct edid *edid)
1770 {
1771 	struct drm_device *dev = connector->dev;
1772 	size_t size = 0;
1773 	int ret;
1774 
1775 	/* ignore requests to set edid when overridden */
1776 	if (connector->override_edid)
1777 		return 0;
1778 
1779 	if (edid)
1780 		size = EDID_LENGTH * (1 + edid->extensions);
1781 
1782 	/* Set the display info, using edid if available, otherwise
1783 	 * reseting the values to defaults. This duplicates the work
1784 	 * done in drm_add_edid_modes, but that function is not
1785 	 * consistently called before this one in all drivers and the
1786 	 * computation is cheap enough that it seems better to
1787 	 * duplicate it rather than attempt to ensure some arbitrary
1788 	 * ordering of calls.
1789 	 */
1790 	if (edid)
1791 		drm_add_display_info(connector, edid);
1792 	else
1793 		drm_reset_display_info(connector);
1794 
1795 	drm_object_property_set_value(&connector->base,
1796 				      dev->mode_config.non_desktop_property,
1797 				      connector->display_info.non_desktop);
1798 
1799 	ret = drm_property_replace_global_blob(dev,
1800 					       &connector->edid_blob_ptr,
1801 	                                       size,
1802 	                                       edid,
1803 	                                       &connector->base,
1804 	                                       dev->mode_config.edid_property);
1805 	if (ret)
1806 		return ret;
1807 	return drm_connector_set_tile_property(connector);
1808 }
1809 EXPORT_SYMBOL(drm_connector_update_edid_property);
1810 
1811 /**
1812  * drm_connector_set_link_status_property - Set link status property of a connector
1813  * @connector: drm connector
1814  * @link_status: new value of link status property (0: Good, 1: Bad)
1815  *
1816  * In usual working scenario, this link status property will always be set to
1817  * "GOOD". If something fails during or after a mode set, the kernel driver
1818  * may set this link status property to "BAD". The caller then needs to send a
1819  * hotplug uevent for userspace to re-check the valid modes through
1820  * GET_CONNECTOR_IOCTL and retry modeset.
1821  *
1822  * Note: Drivers cannot rely on userspace to support this property and
1823  * issue a modeset. As such, they may choose to handle issues (like
1824  * re-training a link) without userspace's intervention.
1825  *
1826  * The reason for adding this property is to handle link training failures, but
1827  * it is not limited to DP or link training. For example, if we implement
1828  * asynchronous setcrtc, this property can be used to report any failures in that.
1829  */
1830 void drm_connector_set_link_status_property(struct drm_connector *connector,
1831 					    uint64_t link_status)
1832 {
1833 	struct drm_device *dev = connector->dev;
1834 
1835 	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
1836 	connector->state->link_status = link_status;
1837 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
1838 }
1839 EXPORT_SYMBOL(drm_connector_set_link_status_property);
1840 
1841 /**
1842  * drm_connector_attach_max_bpc_property - attach "max bpc" property
1843  * @connector: connector to attach max bpc property on.
1844  * @min: The minimum bit depth supported by the connector.
1845  * @max: The maximum bit depth supported by the connector.
1846  *
1847  * This is used to add support for limiting the bit depth on a connector.
1848  *
1849  * Returns:
1850  * Zero on success, negative errno on failure.
1851  */
1852 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1853 					  int min, int max)
1854 {
1855 	struct drm_device *dev = connector->dev;
1856 	struct drm_property *prop;
1857 
1858 	prop = connector->max_bpc_property;
1859 	if (!prop) {
1860 		prop = drm_property_create_range(dev, 0, "max bpc", min, max);
1861 		if (!prop)
1862 			return -ENOMEM;
1863 
1864 		connector->max_bpc_property = prop;
1865 	}
1866 
1867 	drm_object_attach_property(&connector->base, prop, max);
1868 	connector->state->max_requested_bpc = max;
1869 	connector->state->max_bpc = max;
1870 
1871 	return 0;
1872 }
1873 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
1874 
1875 /**
1876  * drm_connector_set_vrr_capable_property - sets the variable refresh rate
1877  * capable property for a connector
1878  * @connector: drm connector
1879  * @capable: True if the connector is variable refresh rate capable
1880  *
1881  * Should be used by atomic drivers to update the indicated support for
1882  * variable refresh rate over a connector.
1883  */
1884 void drm_connector_set_vrr_capable_property(
1885 		struct drm_connector *connector, bool capable)
1886 {
1887 	drm_object_property_set_value(&connector->base,
1888 				      connector->vrr_capable_property,
1889 				      capable);
1890 }
1891 EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
1892 
1893 /**
1894  * drm_connector_init_panel_orientation_property -
1895  *	initialize the connecters panel_orientation property
1896  * @connector: connector for which to init the panel-orientation property.
1897  * @width: width in pixels of the panel, used for panel quirk detection
1898  * @height: height in pixels of the panel, used for panel quirk detection
1899  *
1900  * This function should only be called for built-in panels, after setting
1901  * connector->display_info.panel_orientation first (if known).
1902  *
1903  * This function will check for platform specific (e.g. DMI based) quirks
1904  * overriding display_info.panel_orientation first, then if panel_orientation
1905  * is not DRM_MODE_PANEL_ORIENTATION_UNKNOWN it will attach the
1906  * "panel orientation" property to the connector.
1907  *
1908  * Returns:
1909  * Zero on success, negative errno on failure.
1910  */
1911 int drm_connector_init_panel_orientation_property(
1912 	struct drm_connector *connector, int width, int height)
1913 {
1914 	struct drm_device *dev = connector->dev;
1915 	struct drm_display_info *info = &connector->display_info;
1916 	struct drm_property *prop;
1917 	int orientation_quirk;
1918 
1919 	orientation_quirk = drm_get_panel_orientation_quirk(width, height);
1920 	if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
1921 		info->panel_orientation = orientation_quirk;
1922 
1923 	if (info->panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
1924 		return 0;
1925 
1926 	prop = dev->mode_config.panel_orientation_property;
1927 	if (!prop) {
1928 		prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1929 				"panel orientation",
1930 				drm_panel_orientation_enum_list,
1931 				ARRAY_SIZE(drm_panel_orientation_enum_list));
1932 		if (!prop)
1933 			return -ENOMEM;
1934 
1935 		dev->mode_config.panel_orientation_property = prop;
1936 	}
1937 
1938 	drm_object_attach_property(&connector->base, prop,
1939 				   info->panel_orientation);
1940 	return 0;
1941 }
1942 EXPORT_SYMBOL(drm_connector_init_panel_orientation_property);
1943 
1944 int drm_connector_set_obj_prop(struct drm_mode_object *obj,
1945 				    struct drm_property *property,
1946 				    uint64_t value)
1947 {
1948 	int ret = -EINVAL;
1949 	struct drm_connector *connector = obj_to_connector(obj);
1950 
1951 	/* Do DPMS ourselves */
1952 	if (property == connector->dev->mode_config.dpms_property) {
1953 		ret = (*connector->funcs->dpms)(connector, (int)value);
1954 	} else if (connector->funcs->set_property)
1955 		ret = connector->funcs->set_property(connector, property, value);
1956 
1957 	if (!ret)
1958 		drm_object_property_set_value(&connector->base, property, value);
1959 	return ret;
1960 }
1961 
1962 int drm_connector_property_set_ioctl(struct drm_device *dev,
1963 				     void *data, struct drm_file *file_priv)
1964 {
1965 	struct drm_mode_connector_set_property *conn_set_prop = data;
1966 	struct drm_mode_obj_set_property obj_set_prop = {
1967 		.value = conn_set_prop->value,
1968 		.prop_id = conn_set_prop->prop_id,
1969 		.obj_id = conn_set_prop->connector_id,
1970 		.obj_type = DRM_MODE_OBJECT_CONNECTOR
1971 	};
1972 
1973 	/* It does all the locking and checking we need */
1974 	return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
1975 }
1976 
1977 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
1978 {
1979 	/* For atomic drivers only state objects are synchronously updated and
1980 	 * protected by modeset locks, so check those first. */
1981 	if (connector->state)
1982 		return connector->state->best_encoder;
1983 	return connector->encoder;
1984 }
1985 
1986 static bool
1987 drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
1988 			     const struct list_head *export_list,
1989 			     const struct drm_file *file_priv)
1990 {
1991 	/*
1992 	 * If user-space hasn't configured the driver to expose the stereo 3D
1993 	 * modes, don't expose them.
1994 	 */
1995 	if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
1996 		return false;
1997 	/*
1998 	 * If user-space hasn't configured the driver to expose the modes
1999 	 * with aspect-ratio, don't expose them. However if such a mode
2000 	 * is unique, let it be exposed, but reset the aspect-ratio flags
2001 	 * while preparing the list of user-modes.
2002 	 */
2003 	if (!file_priv->aspect_ratio_allowed) {
2004 		struct drm_display_mode *mode_itr;
2005 
2006 		list_for_each_entry(mode_itr, export_list, export_head)
2007 			if (drm_mode_match(mode_itr, mode,
2008 					   DRM_MODE_MATCH_TIMINGS |
2009 					   DRM_MODE_MATCH_CLOCK |
2010 					   DRM_MODE_MATCH_FLAGS |
2011 					   DRM_MODE_MATCH_3D_FLAGS))
2012 				return false;
2013 	}
2014 
2015 	return true;
2016 }
2017 
2018 int drm_mode_getconnector(struct drm_device *dev, void *data,
2019 			  struct drm_file *file_priv)
2020 {
2021 	struct drm_mode_get_connector *out_resp = data;
2022 	struct drm_connector *connector;
2023 	struct drm_encoder *encoder;
2024 	struct drm_display_mode *mode;
2025 	int mode_count = 0;
2026 	int encoders_count = 0;
2027 	int ret = 0;
2028 	int copied = 0;
2029 	int i;
2030 	struct drm_mode_modeinfo u_mode;
2031 	struct drm_mode_modeinfo __user *mode_ptr;
2032 	uint32_t __user *encoder_ptr;
2033 	LIST_HEAD(export_list);
2034 
2035 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2036 		return -EOPNOTSUPP;
2037 
2038 	memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2039 
2040 	connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2041 	if (!connector)
2042 		return -ENOENT;
2043 
2044 	drm_connector_for_each_possible_encoder(connector, encoder, i)
2045 		encoders_count++;
2046 
2047 	if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2048 		copied = 0;
2049 		encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2050 
2051 		drm_connector_for_each_possible_encoder(connector, encoder, i) {
2052 			if (put_user(encoder->base.id, encoder_ptr + copied)) {
2053 				ret = -EFAULT;
2054 				goto out;
2055 			}
2056 			copied++;
2057 		}
2058 	}
2059 	out_resp->count_encoders = encoders_count;
2060 
2061 	out_resp->connector_id = connector->base.id;
2062 	out_resp->connector_type = connector->connector_type;
2063 	out_resp->connector_type_id = connector->connector_type_id;
2064 
2065 	mutex_lock(&dev->mode_config.mutex);
2066 	if (out_resp->count_modes == 0) {
2067 		connector->funcs->fill_modes(connector,
2068 					     dev->mode_config.max_width,
2069 					     dev->mode_config.max_height);
2070 	}
2071 
2072 	out_resp->mm_width = connector->display_info.width_mm;
2073 	out_resp->mm_height = connector->display_info.height_mm;
2074 	out_resp->subpixel = connector->display_info.subpixel_order;
2075 	out_resp->connection = connector->status;
2076 
2077 	/* delayed so we get modes regardless of pre-fill_modes state */
2078 	list_for_each_entry(mode, &connector->modes, head)
2079 		if (drm_mode_expose_to_userspace(mode, &export_list,
2080 						 file_priv)) {
2081 			list_add_tail(&mode->export_head, &export_list);
2082 			mode_count++;
2083 		}
2084 
2085 	/*
2086 	 * This ioctl is called twice, once to determine how much space is
2087 	 * needed, and the 2nd time to fill it.
2088 	 * The modes that need to be exposed to the user are maintained in the
2089 	 * 'export_list'. When the ioctl is called first time to determine the,
2090 	 * space, the export_list gets filled, to find the no.of modes. In the
2091 	 * 2nd time, the user modes are filled, one by one from the export_list.
2092 	 */
2093 	if ((out_resp->count_modes >= mode_count) && mode_count) {
2094 		copied = 0;
2095 		mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2096 		list_for_each_entry(mode, &export_list, export_head) {
2097 			drm_mode_convert_to_umode(&u_mode, mode);
2098 			/*
2099 			 * Reset aspect ratio flags of user-mode, if modes with
2100 			 * aspect-ratio are not supported.
2101 			 */
2102 			if (!file_priv->aspect_ratio_allowed)
2103 				u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2104 			if (copy_to_user(mode_ptr + copied,
2105 					 &u_mode, sizeof(u_mode))) {
2106 				ret = -EFAULT;
2107 				mutex_unlock(&dev->mode_config.mutex);
2108 
2109 				goto out;
2110 			}
2111 			copied++;
2112 		}
2113 	}
2114 	out_resp->count_modes = mode_count;
2115 	mutex_unlock(&dev->mode_config.mutex);
2116 
2117 	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2118 	encoder = drm_connector_get_encoder(connector);
2119 	if (encoder)
2120 		out_resp->encoder_id = encoder->base.id;
2121 	else
2122 		out_resp->encoder_id = 0;
2123 
2124 	/* Only grab properties after probing, to make sure EDID and other
2125 	 * properties reflect the latest status. */
2126 	ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
2127 			(uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2128 			(uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2129 			&out_resp->count_props);
2130 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
2131 
2132 out:
2133 	drm_connector_put(connector);
2134 
2135 	return ret;
2136 }
2137 
2138 
2139 /**
2140  * DOC: Tile group
2141  *
2142  * Tile groups are used to represent tiled monitors with a unique integer
2143  * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2144  * we store this in a tile group, so we have a common identifier for all tiles
2145  * in a monitor group. The property is called "TILE". Drivers can manage tile
2146  * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2147  * drm_mode_get_tile_group(). But this is only needed for internal panels where
2148  * the tile group information is exposed through a non-standard way.
2149  */
2150 
2151 static void drm_tile_group_free(struct kref *kref)
2152 {
2153 	struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
2154 	struct drm_device *dev = tg->dev;
2155 	mutex_lock(&dev->mode_config.idr_mutex);
2156 	idr_remove(&dev->mode_config.tile_idr, tg->id);
2157 	mutex_unlock(&dev->mode_config.idr_mutex);
2158 	kfree(tg);
2159 }
2160 
2161 /**
2162  * drm_mode_put_tile_group - drop a reference to a tile group.
2163  * @dev: DRM device
2164  * @tg: tile group to drop reference to.
2165  *
2166  * drop reference to tile group and free if 0.
2167  */
2168 void drm_mode_put_tile_group(struct drm_device *dev,
2169 			     struct drm_tile_group *tg)
2170 {
2171 	kref_put(&tg->refcount, drm_tile_group_free);
2172 }
2173 EXPORT_SYMBOL(drm_mode_put_tile_group);
2174 
2175 /**
2176  * drm_mode_get_tile_group - get a reference to an existing tile group
2177  * @dev: DRM device
2178  * @topology: 8-bytes unique per monitor.
2179  *
2180  * Use the unique bytes to get a reference to an existing tile group.
2181  *
2182  * RETURNS:
2183  * tile group or NULL if not found.
2184  */
2185 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2186 					       char topology[8])
2187 {
2188 	struct drm_tile_group *tg;
2189 	int id;
2190 	mutex_lock(&dev->mode_config.idr_mutex);
2191 	idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
2192 		if (!memcmp(tg->group_data, topology, 8)) {
2193 			if (!kref_get_unless_zero(&tg->refcount))
2194 				tg = NULL;
2195 			mutex_unlock(&dev->mode_config.idr_mutex);
2196 			return tg;
2197 		}
2198 	}
2199 	mutex_unlock(&dev->mode_config.idr_mutex);
2200 	return NULL;
2201 }
2202 EXPORT_SYMBOL(drm_mode_get_tile_group);
2203 
2204 /**
2205  * drm_mode_create_tile_group - create a tile group from a displayid description
2206  * @dev: DRM device
2207  * @topology: 8-bytes unique per monitor.
2208  *
2209  * Create a tile group for the unique monitor, and get a unique
2210  * identifier for the tile group.
2211  *
2212  * RETURNS:
2213  * new tile group or NULL.
2214  */
2215 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2216 						  char topology[8])
2217 {
2218 	struct drm_tile_group *tg;
2219 	int ret;
2220 
2221 	tg = kzalloc(sizeof(*tg), GFP_KERNEL);
2222 	if (!tg)
2223 		return NULL;
2224 
2225 	kref_init(&tg->refcount);
2226 	memcpy(tg->group_data, topology, 8);
2227 	tg->dev = dev;
2228 
2229 	mutex_lock(&dev->mode_config.idr_mutex);
2230 	ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
2231 	if (ret >= 0) {
2232 		tg->id = ret;
2233 	} else {
2234 		kfree(tg);
2235 		tg = NULL;
2236 	}
2237 
2238 	mutex_unlock(&dev->mode_config.idr_mutex);
2239 	return tg;
2240 }
2241 EXPORT_SYMBOL(drm_mode_create_tile_group);
2242