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