xref: /linux/drivers/gpu/drm/drm_connector.c (revision ae22a94997b8a03dcb3c922857c203246711f9d4)
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_auth.h>
24 #include <drm/drm_connector.h>
25 #include <drm/drm_drv.h>
26 #include <drm/drm_edid.h>
27 #include <drm/drm_encoder.h>
28 #include <drm/drm_file.h>
29 #include <drm/drm_managed.h>
30 #include <drm/drm_panel.h>
31 #include <drm/drm_print.h>
32 #include <drm/drm_privacy_screen_consumer.h>
33 #include <drm/drm_sysfs.h>
34 #include <drm/drm_utils.h>
35 
36 #include <linux/property.h>
37 #include <linux/uaccess.h>
38 
39 #include <video/cmdline.h>
40 
41 #include "drm_crtc_internal.h"
42 #include "drm_internal.h"
43 
44 /**
45  * DOC: overview
46  *
47  * In DRM connectors are the general abstraction for display sinks, and include
48  * also fixed panels or anything else that can display pixels in some form. As
49  * opposed to all other KMS objects representing hardware (like CRTC, encoder or
50  * plane abstractions) connectors can be hotplugged and unplugged at runtime.
51  * Hence they are reference-counted using drm_connector_get() and
52  * drm_connector_put().
53  *
54  * KMS driver must create, initialize, register and attach at a &struct
55  * drm_connector for each such sink. The instance is created as other KMS
56  * objects and initialized by setting the following fields. The connector is
57  * initialized with a call to drm_connector_init() with a pointer to the
58  * &struct drm_connector_funcs and a connector type, and then exposed to
59  * userspace with a call to drm_connector_register().
60  *
61  * Connectors must be attached to an encoder to be used. For devices that map
62  * connectors to encoders 1:1, the connector should be attached at
63  * initialization time with a call to drm_connector_attach_encoder(). The
64  * driver must also set the &drm_connector.encoder field to point to the
65  * attached encoder.
66  *
67  * For connectors which are not fixed (like built-in panels) the driver needs to
68  * support hotplug notifications. The simplest way to do that is by using the
69  * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
70  * hardware support for hotplug interrupts. Connectors with hardware hotplug
71  * support can instead use e.g. drm_helper_hpd_irq_event().
72  */
73 
74 /*
75  * Global connector list for drm_connector_find_by_fwnode().
76  * Note drm_connector_[un]register() first take connector->lock and then
77  * take the connector_list_lock.
78  */
79 static DEFINE_MUTEX(connector_list_lock);
80 static LIST_HEAD(connector_list);
81 
82 struct drm_conn_prop_enum_list {
83 	int type;
84 	const char *name;
85 	struct ida ida;
86 };
87 
88 /*
89  * Connector and encoder types.
90  */
91 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
92 	{ DRM_MODE_CONNECTOR_Unknown, "Unknown" },
93 	{ DRM_MODE_CONNECTOR_VGA, "VGA" },
94 	{ DRM_MODE_CONNECTOR_DVII, "DVI-I" },
95 	{ DRM_MODE_CONNECTOR_DVID, "DVI-D" },
96 	{ DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
97 	{ DRM_MODE_CONNECTOR_Composite, "Composite" },
98 	{ DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
99 	{ DRM_MODE_CONNECTOR_LVDS, "LVDS" },
100 	{ DRM_MODE_CONNECTOR_Component, "Component" },
101 	{ DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
102 	{ DRM_MODE_CONNECTOR_DisplayPort, "DP" },
103 	{ DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
104 	{ DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
105 	{ DRM_MODE_CONNECTOR_TV, "TV" },
106 	{ DRM_MODE_CONNECTOR_eDP, "eDP" },
107 	{ DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
108 	{ DRM_MODE_CONNECTOR_DSI, "DSI" },
109 	{ DRM_MODE_CONNECTOR_DPI, "DPI" },
110 	{ DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
111 	{ DRM_MODE_CONNECTOR_SPI, "SPI" },
112 	{ DRM_MODE_CONNECTOR_USB, "USB" },
113 };
114 
115 void drm_connector_ida_init(void)
116 {
117 	int i;
118 
119 	for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
120 		ida_init(&drm_connector_enum_list[i].ida);
121 }
122 
123 void drm_connector_ida_destroy(void)
124 {
125 	int i;
126 
127 	for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
128 		ida_destroy(&drm_connector_enum_list[i].ida);
129 }
130 
131 /**
132  * drm_get_connector_type_name - return a string for connector type
133  * @type: The connector type (DRM_MODE_CONNECTOR_*)
134  *
135  * Returns: the name of the connector type, or NULL if the type is not valid.
136  */
137 const char *drm_get_connector_type_name(unsigned int type)
138 {
139 	if (type < ARRAY_SIZE(drm_connector_enum_list))
140 		return drm_connector_enum_list[type].name;
141 
142 	return NULL;
143 }
144 EXPORT_SYMBOL(drm_get_connector_type_name);
145 
146 /**
147  * drm_connector_get_cmdline_mode - reads the user's cmdline mode
148  * @connector: connector to query
149  *
150  * The kernel supports per-connector configuration of its consoles through
151  * use of the video= parameter. This function parses that option and
152  * extracts the user's specified mode (or enable/disable status) for a
153  * particular connector. This is typically only used during the early fbdev
154  * setup.
155  */
156 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
157 {
158 	struct drm_cmdline_mode *mode = &connector->cmdline_mode;
159 	const char *option;
160 
161 	option = video_get_options(connector->name);
162 	if (!option)
163 		return;
164 
165 	if (!drm_mode_parse_command_line_for_connector(option,
166 						       connector,
167 						       mode))
168 		return;
169 
170 	if (mode->force) {
171 		DRM_INFO("forcing %s connector %s\n", connector->name,
172 			 drm_get_connector_force_name(mode->force));
173 		connector->force = mode->force;
174 	}
175 
176 	if (mode->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN) {
177 		DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
178 			 connector->name, mode->panel_orientation);
179 		drm_connector_set_panel_orientation(connector,
180 						    mode->panel_orientation);
181 	}
182 
183 	DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
184 		      connector->name, mode->name,
185 		      mode->xres, mode->yres,
186 		      mode->refresh_specified ? mode->refresh : 60,
187 		      mode->rb ? " reduced blanking" : "",
188 		      mode->margins ? " with margins" : "",
189 		      mode->interlace ?  " interlaced" : "");
190 }
191 
192 static void drm_connector_free(struct kref *kref)
193 {
194 	struct drm_connector *connector =
195 		container_of(kref, struct drm_connector, base.refcount);
196 	struct drm_device *dev = connector->dev;
197 
198 	drm_mode_object_unregister(dev, &connector->base);
199 	connector->funcs->destroy(connector);
200 }
201 
202 void drm_connector_free_work_fn(struct work_struct *work)
203 {
204 	struct drm_connector *connector, *n;
205 	struct drm_device *dev =
206 		container_of(work, struct drm_device, mode_config.connector_free_work);
207 	struct drm_mode_config *config = &dev->mode_config;
208 	unsigned long flags;
209 	struct llist_node *freed;
210 
211 	spin_lock_irqsave(&config->connector_list_lock, flags);
212 	freed = llist_del_all(&config->connector_free_list);
213 	spin_unlock_irqrestore(&config->connector_list_lock, flags);
214 
215 	llist_for_each_entry_safe(connector, n, freed, free_node) {
216 		drm_mode_object_unregister(dev, &connector->base);
217 		connector->funcs->destroy(connector);
218 	}
219 }
220 
221 static int __drm_connector_init(struct drm_device *dev,
222 				struct drm_connector *connector,
223 				const struct drm_connector_funcs *funcs,
224 				int connector_type,
225 				struct i2c_adapter *ddc)
226 {
227 	struct drm_mode_config *config = &dev->mode_config;
228 	int ret;
229 	struct ida *connector_ida =
230 		&drm_connector_enum_list[connector_type].ida;
231 
232 	WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
233 		(!funcs->atomic_destroy_state ||
234 		 !funcs->atomic_duplicate_state));
235 
236 	ret = __drm_mode_object_add(dev, &connector->base,
237 				    DRM_MODE_OBJECT_CONNECTOR,
238 				    false, drm_connector_free);
239 	if (ret)
240 		return ret;
241 
242 	connector->base.properties = &connector->properties;
243 	connector->dev = dev;
244 	connector->funcs = funcs;
245 
246 	/* connector index is used with 32bit bitmasks */
247 	ret = ida_alloc_max(&config->connector_ida, 31, GFP_KERNEL);
248 	if (ret < 0) {
249 		DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
250 			      drm_connector_enum_list[connector_type].name,
251 			      ret);
252 		goto out_put;
253 	}
254 	connector->index = ret;
255 	ret = 0;
256 
257 	connector->connector_type = connector_type;
258 	connector->connector_type_id =
259 		ida_alloc_min(connector_ida, 1, GFP_KERNEL);
260 	if (connector->connector_type_id < 0) {
261 		ret = connector->connector_type_id;
262 		goto out_put_id;
263 	}
264 	connector->name =
265 		kasprintf(GFP_KERNEL, "%s-%d",
266 			  drm_connector_enum_list[connector_type].name,
267 			  connector->connector_type_id);
268 	if (!connector->name) {
269 		ret = -ENOMEM;
270 		goto out_put_type_id;
271 	}
272 
273 	/* provide ddc symlink in sysfs */
274 	connector->ddc = ddc;
275 
276 	INIT_LIST_HEAD(&connector->global_connector_list_entry);
277 	INIT_LIST_HEAD(&connector->probed_modes);
278 	INIT_LIST_HEAD(&connector->modes);
279 	mutex_init(&connector->mutex);
280 	mutex_init(&connector->edid_override_mutex);
281 	connector->edid_blob_ptr = NULL;
282 	connector->epoch_counter = 0;
283 	connector->tile_blob_ptr = NULL;
284 	connector->status = connector_status_unknown;
285 	connector->display_info.panel_orientation =
286 		DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
287 
288 	drm_connector_get_cmdline_mode(connector);
289 
290 	/* We should add connectors at the end to avoid upsetting the connector
291 	 * index too much.
292 	 */
293 	spin_lock_irq(&config->connector_list_lock);
294 	list_add_tail(&connector->head, &config->connector_list);
295 	config->num_connector++;
296 	spin_unlock_irq(&config->connector_list_lock);
297 
298 	if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
299 	    connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
300 		drm_connector_attach_edid_property(connector);
301 
302 	drm_object_attach_property(&connector->base,
303 				      config->dpms_property, 0);
304 
305 	drm_object_attach_property(&connector->base,
306 				   config->link_status_property,
307 				   0);
308 
309 	drm_object_attach_property(&connector->base,
310 				   config->non_desktop_property,
311 				   0);
312 	drm_object_attach_property(&connector->base,
313 				   config->tile_property,
314 				   0);
315 
316 	if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
317 		drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
318 	}
319 
320 	connector->debugfs_entry = NULL;
321 out_put_type_id:
322 	if (ret)
323 		ida_free(connector_ida, connector->connector_type_id);
324 out_put_id:
325 	if (ret)
326 		ida_free(&config->connector_ida, connector->index);
327 out_put:
328 	if (ret)
329 		drm_mode_object_unregister(dev, &connector->base);
330 
331 	return ret;
332 }
333 
334 /**
335  * drm_connector_init - Init a preallocated connector
336  * @dev: DRM device
337  * @connector: the connector to init
338  * @funcs: callbacks for this connector
339  * @connector_type: user visible type of the connector
340  *
341  * Initialises a preallocated connector. Connectors should be
342  * subclassed as part of driver connector objects.
343  *
344  * At driver unload time the driver's &drm_connector_funcs.destroy hook
345  * should call drm_connector_cleanup() and free the connector structure.
346  * The connector structure should not be allocated with devm_kzalloc().
347  *
348  * Note: consider using drmm_connector_init() instead of
349  * drm_connector_init() to let the DRM managed resource infrastructure
350  * take care of cleanup and deallocation.
351  *
352  * Returns:
353  * Zero on success, error code on failure.
354  */
355 int drm_connector_init(struct drm_device *dev,
356 		       struct drm_connector *connector,
357 		       const struct drm_connector_funcs *funcs,
358 		       int connector_type)
359 {
360 	if (drm_WARN_ON(dev, !(funcs && funcs->destroy)))
361 		return -EINVAL;
362 
363 	return __drm_connector_init(dev, connector, funcs, connector_type, NULL);
364 }
365 EXPORT_SYMBOL(drm_connector_init);
366 
367 /**
368  * drm_connector_init_with_ddc - Init a preallocated connector
369  * @dev: DRM device
370  * @connector: the connector to init
371  * @funcs: callbacks for this connector
372  * @connector_type: user visible type of the connector
373  * @ddc: pointer to the associated ddc adapter
374  *
375  * Initialises a preallocated connector. Connectors should be
376  * subclassed as part of driver connector objects.
377  *
378  * At driver unload time the driver's &drm_connector_funcs.destroy hook
379  * should call drm_connector_cleanup() and free the connector structure.
380  * The connector structure should not be allocated with devm_kzalloc().
381  *
382  * Ensures that the ddc field of the connector is correctly set.
383  *
384  * Note: consider using drmm_connector_init() instead of
385  * drm_connector_init_with_ddc() to let the DRM managed resource
386  * infrastructure take care of cleanup and deallocation.
387  *
388  * Returns:
389  * Zero on success, error code on failure.
390  */
391 int drm_connector_init_with_ddc(struct drm_device *dev,
392 				struct drm_connector *connector,
393 				const struct drm_connector_funcs *funcs,
394 				int connector_type,
395 				struct i2c_adapter *ddc)
396 {
397 	if (drm_WARN_ON(dev, !(funcs && funcs->destroy)))
398 		return -EINVAL;
399 
400 	return __drm_connector_init(dev, connector, funcs, connector_type, ddc);
401 }
402 EXPORT_SYMBOL(drm_connector_init_with_ddc);
403 
404 static void drm_connector_cleanup_action(struct drm_device *dev,
405 					 void *ptr)
406 {
407 	struct drm_connector *connector = ptr;
408 
409 	drm_connector_cleanup(connector);
410 }
411 
412 /**
413  * drmm_connector_init - Init a preallocated connector
414  * @dev: DRM device
415  * @connector: the connector to init
416  * @funcs: callbacks for this connector
417  * @connector_type: user visible type of the connector
418  * @ddc: optional pointer to the associated ddc adapter
419  *
420  * Initialises a preallocated connector. Connectors should be
421  * subclassed as part of driver connector objects.
422  *
423  * Cleanup is automatically handled with a call to
424  * drm_connector_cleanup() in a DRM-managed action.
425  *
426  * The connector structure should be allocated with drmm_kzalloc().
427  *
428  * Returns:
429  * Zero on success, error code on failure.
430  */
431 int drmm_connector_init(struct drm_device *dev,
432 			struct drm_connector *connector,
433 			const struct drm_connector_funcs *funcs,
434 			int connector_type,
435 			struct i2c_adapter *ddc)
436 {
437 	int ret;
438 
439 	if (drm_WARN_ON(dev, funcs && funcs->destroy))
440 		return -EINVAL;
441 
442 	ret = __drm_connector_init(dev, connector, funcs, connector_type, ddc);
443 	if (ret)
444 		return ret;
445 
446 	ret = drmm_add_action_or_reset(dev, drm_connector_cleanup_action,
447 				       connector);
448 	if (ret)
449 		return ret;
450 
451 	return 0;
452 }
453 EXPORT_SYMBOL(drmm_connector_init);
454 
455 /**
456  * drm_connector_attach_edid_property - attach edid property.
457  * @connector: the connector
458  *
459  * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
460  * edid property attached by default.  This function can be used to
461  * explicitly enable the edid property in these cases.
462  */
463 void drm_connector_attach_edid_property(struct drm_connector *connector)
464 {
465 	struct drm_mode_config *config = &connector->dev->mode_config;
466 
467 	drm_object_attach_property(&connector->base,
468 				   config->edid_property,
469 				   0);
470 }
471 EXPORT_SYMBOL(drm_connector_attach_edid_property);
472 
473 /**
474  * drm_connector_attach_encoder - attach a connector to an encoder
475  * @connector: connector to attach
476  * @encoder: encoder to attach @connector to
477  *
478  * This function links up a connector to an encoder. Note that the routing
479  * restrictions between encoders and crtcs are exposed to userspace through the
480  * possible_clones and possible_crtcs bitmasks.
481  *
482  * Returns:
483  * Zero on success, negative errno on failure.
484  */
485 int drm_connector_attach_encoder(struct drm_connector *connector,
486 				 struct drm_encoder *encoder)
487 {
488 	/*
489 	 * In the past, drivers have attempted to model the static association
490 	 * of connector to encoder in simple connector/encoder devices using a
491 	 * direct assignment of connector->encoder = encoder. This connection
492 	 * is a logical one and the responsibility of the core, so drivers are
493 	 * expected not to mess with this.
494 	 *
495 	 * Note that the error return should've been enough here, but a large
496 	 * majority of drivers ignores the return value, so add in a big WARN
497 	 * to get people's attention.
498 	 */
499 	if (WARN_ON(connector->encoder))
500 		return -EINVAL;
501 
502 	connector->possible_encoders |= drm_encoder_mask(encoder);
503 
504 	return 0;
505 }
506 EXPORT_SYMBOL(drm_connector_attach_encoder);
507 
508 /**
509  * drm_connector_has_possible_encoder - check if the connector and encoder are
510  * associated with each other
511  * @connector: the connector
512  * @encoder: the encoder
513  *
514  * Returns:
515  * True if @encoder is one of the possible encoders for @connector.
516  */
517 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
518 					struct drm_encoder *encoder)
519 {
520 	return connector->possible_encoders & drm_encoder_mask(encoder);
521 }
522 EXPORT_SYMBOL(drm_connector_has_possible_encoder);
523 
524 static void drm_mode_remove(struct drm_connector *connector,
525 			    struct drm_display_mode *mode)
526 {
527 	list_del(&mode->head);
528 	drm_mode_destroy(connector->dev, mode);
529 }
530 
531 /**
532  * drm_connector_cleanup - cleans up an initialised connector
533  * @connector: connector to cleanup
534  *
535  * Cleans up the connector but doesn't free the object.
536  */
537 void drm_connector_cleanup(struct drm_connector *connector)
538 {
539 	struct drm_device *dev = connector->dev;
540 	struct drm_display_mode *mode, *t;
541 
542 	/* The connector should have been removed from userspace long before
543 	 * it is finally destroyed.
544 	 */
545 	if (WARN_ON(connector->registration_state ==
546 		    DRM_CONNECTOR_REGISTERED))
547 		drm_connector_unregister(connector);
548 
549 	if (connector->privacy_screen) {
550 		drm_privacy_screen_put(connector->privacy_screen);
551 		connector->privacy_screen = NULL;
552 	}
553 
554 	if (connector->tile_group) {
555 		drm_mode_put_tile_group(dev, connector->tile_group);
556 		connector->tile_group = NULL;
557 	}
558 
559 	list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
560 		drm_mode_remove(connector, mode);
561 
562 	list_for_each_entry_safe(mode, t, &connector->modes, head)
563 		drm_mode_remove(connector, mode);
564 
565 	ida_free(&drm_connector_enum_list[connector->connector_type].ida,
566 			  connector->connector_type_id);
567 
568 	ida_free(&dev->mode_config.connector_ida, connector->index);
569 
570 	kfree(connector->display_info.bus_formats);
571 	kfree(connector->display_info.vics);
572 	drm_mode_object_unregister(dev, &connector->base);
573 	kfree(connector->name);
574 	connector->name = NULL;
575 	fwnode_handle_put(connector->fwnode);
576 	connector->fwnode = NULL;
577 	spin_lock_irq(&dev->mode_config.connector_list_lock);
578 	list_del(&connector->head);
579 	dev->mode_config.num_connector--;
580 	spin_unlock_irq(&dev->mode_config.connector_list_lock);
581 
582 	WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
583 	if (connector->state && connector->funcs->atomic_destroy_state)
584 		connector->funcs->atomic_destroy_state(connector,
585 						       connector->state);
586 
587 	mutex_destroy(&connector->mutex);
588 
589 	memset(connector, 0, sizeof(*connector));
590 
591 	if (dev->registered)
592 		drm_sysfs_hotplug_event(dev);
593 }
594 EXPORT_SYMBOL(drm_connector_cleanup);
595 
596 /**
597  * drm_connector_register - register a connector
598  * @connector: the connector to register
599  *
600  * Register userspace interfaces for a connector. Only call this for connectors
601  * which can be hotplugged after drm_dev_register() has been called already,
602  * e.g. DP MST connectors. All other connectors will be registered automatically
603  * when calling drm_dev_register().
604  *
605  * When the connector is no longer available, callers must call
606  * drm_connector_unregister().
607  *
608  * Returns:
609  * Zero on success, error code on failure.
610  */
611 int drm_connector_register(struct drm_connector *connector)
612 {
613 	int ret = 0;
614 
615 	if (!connector->dev->registered)
616 		return 0;
617 
618 	mutex_lock(&connector->mutex);
619 	if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
620 		goto unlock;
621 
622 	ret = drm_sysfs_connector_add(connector);
623 	if (ret)
624 		goto unlock;
625 
626 	drm_debugfs_connector_add(connector);
627 
628 	if (connector->funcs->late_register) {
629 		ret = connector->funcs->late_register(connector);
630 		if (ret)
631 			goto err_debugfs;
632 	}
633 
634 	ret = drm_sysfs_connector_add_late(connector);
635 	if (ret)
636 		goto err_late_register;
637 
638 	drm_mode_object_register(connector->dev, &connector->base);
639 
640 	connector->registration_state = DRM_CONNECTOR_REGISTERED;
641 
642 	/* Let userspace know we have a new connector */
643 	drm_sysfs_connector_hotplug_event(connector);
644 
645 	if (connector->privacy_screen)
646 		drm_privacy_screen_register_notifier(connector->privacy_screen,
647 					   &connector->privacy_screen_notifier);
648 
649 	mutex_lock(&connector_list_lock);
650 	list_add_tail(&connector->global_connector_list_entry, &connector_list);
651 	mutex_unlock(&connector_list_lock);
652 	goto unlock;
653 
654 err_late_register:
655 	if (connector->funcs->early_unregister)
656 		connector->funcs->early_unregister(connector);
657 err_debugfs:
658 	drm_debugfs_connector_remove(connector);
659 	drm_sysfs_connector_remove(connector);
660 unlock:
661 	mutex_unlock(&connector->mutex);
662 	return ret;
663 }
664 EXPORT_SYMBOL(drm_connector_register);
665 
666 /**
667  * drm_connector_unregister - unregister a connector
668  * @connector: the connector to unregister
669  *
670  * Unregister userspace interfaces for a connector. Only call this for
671  * connectors which have been registered explicitly by calling
672  * drm_connector_register().
673  */
674 void drm_connector_unregister(struct drm_connector *connector)
675 {
676 	mutex_lock(&connector->mutex);
677 	if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
678 		mutex_unlock(&connector->mutex);
679 		return;
680 	}
681 
682 	mutex_lock(&connector_list_lock);
683 	list_del_init(&connector->global_connector_list_entry);
684 	mutex_unlock(&connector_list_lock);
685 
686 	if (connector->privacy_screen)
687 		drm_privacy_screen_unregister_notifier(
688 					connector->privacy_screen,
689 					&connector->privacy_screen_notifier);
690 
691 	drm_sysfs_connector_remove_early(connector);
692 
693 	if (connector->funcs->early_unregister)
694 		connector->funcs->early_unregister(connector);
695 
696 	drm_debugfs_connector_remove(connector);
697 	drm_sysfs_connector_remove(connector);
698 
699 	connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
700 	mutex_unlock(&connector->mutex);
701 }
702 EXPORT_SYMBOL(drm_connector_unregister);
703 
704 void drm_connector_unregister_all(struct drm_device *dev)
705 {
706 	struct drm_connector *connector;
707 	struct drm_connector_list_iter conn_iter;
708 
709 	drm_connector_list_iter_begin(dev, &conn_iter);
710 	drm_for_each_connector_iter(connector, &conn_iter)
711 		drm_connector_unregister(connector);
712 	drm_connector_list_iter_end(&conn_iter);
713 }
714 
715 int drm_connector_register_all(struct drm_device *dev)
716 {
717 	struct drm_connector *connector;
718 	struct drm_connector_list_iter conn_iter;
719 	int ret = 0;
720 
721 	drm_connector_list_iter_begin(dev, &conn_iter);
722 	drm_for_each_connector_iter(connector, &conn_iter) {
723 		ret = drm_connector_register(connector);
724 		if (ret)
725 			break;
726 	}
727 	drm_connector_list_iter_end(&conn_iter);
728 
729 	if (ret)
730 		drm_connector_unregister_all(dev);
731 	return ret;
732 }
733 
734 /**
735  * drm_get_connector_status_name - return a string for connector status
736  * @status: connector status to compute name of
737  *
738  * In contrast to the other drm_get_*_name functions this one here returns a
739  * const pointer and hence is threadsafe.
740  *
741  * Returns: connector status string
742  */
743 const char *drm_get_connector_status_name(enum drm_connector_status status)
744 {
745 	if (status == connector_status_connected)
746 		return "connected";
747 	else if (status == connector_status_disconnected)
748 		return "disconnected";
749 	else
750 		return "unknown";
751 }
752 EXPORT_SYMBOL(drm_get_connector_status_name);
753 
754 /**
755  * drm_get_connector_force_name - return a string for connector force
756  * @force: connector force to get name of
757  *
758  * Returns: const pointer to name.
759  */
760 const char *drm_get_connector_force_name(enum drm_connector_force force)
761 {
762 	switch (force) {
763 	case DRM_FORCE_UNSPECIFIED:
764 		return "unspecified";
765 	case DRM_FORCE_OFF:
766 		return "off";
767 	case DRM_FORCE_ON:
768 		return "on";
769 	case DRM_FORCE_ON_DIGITAL:
770 		return "digital";
771 	default:
772 		return "unknown";
773 	}
774 }
775 
776 #ifdef CONFIG_LOCKDEP
777 static struct lockdep_map connector_list_iter_dep_map = {
778 	.name = "drm_connector_list_iter"
779 };
780 #endif
781 
782 /**
783  * drm_connector_list_iter_begin - initialize a connector_list iterator
784  * @dev: DRM device
785  * @iter: connector_list iterator
786  *
787  * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
788  * must always be cleaned up again by calling drm_connector_list_iter_end().
789  * Iteration itself happens using drm_connector_list_iter_next() or
790  * drm_for_each_connector_iter().
791  */
792 void drm_connector_list_iter_begin(struct drm_device *dev,
793 				   struct drm_connector_list_iter *iter)
794 {
795 	iter->dev = dev;
796 	iter->conn = NULL;
797 	lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
798 }
799 EXPORT_SYMBOL(drm_connector_list_iter_begin);
800 
801 /*
802  * Extra-safe connector put function that works in any context. Should only be
803  * used from the connector_iter functions, where we never really expect to
804  * actually release the connector when dropping our final reference.
805  */
806 static void
807 __drm_connector_put_safe(struct drm_connector *conn)
808 {
809 	struct drm_mode_config *config = &conn->dev->mode_config;
810 
811 	lockdep_assert_held(&config->connector_list_lock);
812 
813 	if (!refcount_dec_and_test(&conn->base.refcount.refcount))
814 		return;
815 
816 	llist_add(&conn->free_node, &config->connector_free_list);
817 	schedule_work(&config->connector_free_work);
818 }
819 
820 /**
821  * drm_connector_list_iter_next - return next connector
822  * @iter: connector_list iterator
823  *
824  * Returns: the next connector for @iter, or NULL when the list walk has
825  * completed.
826  */
827 struct drm_connector *
828 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
829 {
830 	struct drm_connector *old_conn = iter->conn;
831 	struct drm_mode_config *config = &iter->dev->mode_config;
832 	struct list_head *lhead;
833 	unsigned long flags;
834 
835 	spin_lock_irqsave(&config->connector_list_lock, flags);
836 	lhead = old_conn ? &old_conn->head : &config->connector_list;
837 
838 	do {
839 		if (lhead->next == &config->connector_list) {
840 			iter->conn = NULL;
841 			break;
842 		}
843 
844 		lhead = lhead->next;
845 		iter->conn = list_entry(lhead, struct drm_connector, head);
846 
847 		/* loop until it's not a zombie connector */
848 	} while (!kref_get_unless_zero(&iter->conn->base.refcount));
849 
850 	if (old_conn)
851 		__drm_connector_put_safe(old_conn);
852 	spin_unlock_irqrestore(&config->connector_list_lock, flags);
853 
854 	return iter->conn;
855 }
856 EXPORT_SYMBOL(drm_connector_list_iter_next);
857 
858 /**
859  * drm_connector_list_iter_end - tear down a connector_list iterator
860  * @iter: connector_list iterator
861  *
862  * Tears down @iter and releases any resources (like &drm_connector references)
863  * acquired while walking the list. This must always be called, both when the
864  * iteration completes fully or when it was aborted without walking the entire
865  * list.
866  */
867 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
868 {
869 	struct drm_mode_config *config = &iter->dev->mode_config;
870 	unsigned long flags;
871 
872 	iter->dev = NULL;
873 	if (iter->conn) {
874 		spin_lock_irqsave(&config->connector_list_lock, flags);
875 		__drm_connector_put_safe(iter->conn);
876 		spin_unlock_irqrestore(&config->connector_list_lock, flags);
877 	}
878 	lock_release(&connector_list_iter_dep_map, _RET_IP_);
879 }
880 EXPORT_SYMBOL(drm_connector_list_iter_end);
881 
882 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
883 	{ SubPixelUnknown, "Unknown" },
884 	{ SubPixelHorizontalRGB, "Horizontal RGB" },
885 	{ SubPixelHorizontalBGR, "Horizontal BGR" },
886 	{ SubPixelVerticalRGB, "Vertical RGB" },
887 	{ SubPixelVerticalBGR, "Vertical BGR" },
888 	{ SubPixelNone, "None" },
889 };
890 
891 /**
892  * drm_get_subpixel_order_name - return a string for a given subpixel enum
893  * @order: enum of subpixel_order
894  *
895  * Note you could abuse this and return something out of bounds, but that
896  * would be a caller error.  No unscrubbed user data should make it here.
897  *
898  * Returns: string describing an enumerated subpixel property
899  */
900 const char *drm_get_subpixel_order_name(enum subpixel_order order)
901 {
902 	return drm_subpixel_enum_list[order].name;
903 }
904 EXPORT_SYMBOL(drm_get_subpixel_order_name);
905 
906 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
907 	{ DRM_MODE_DPMS_ON, "On" },
908 	{ DRM_MODE_DPMS_STANDBY, "Standby" },
909 	{ DRM_MODE_DPMS_SUSPEND, "Suspend" },
910 	{ DRM_MODE_DPMS_OFF, "Off" }
911 };
912 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
913 
914 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
915 	{ DRM_MODE_LINK_STATUS_GOOD, "Good" },
916 	{ DRM_MODE_LINK_STATUS_BAD, "Bad" },
917 };
918 
919 /**
920  * drm_display_info_set_bus_formats - set the supported bus formats
921  * @info: display info to store bus formats in
922  * @formats: array containing the supported bus formats
923  * @num_formats: the number of entries in the fmts array
924  *
925  * Store the supported bus formats in display info structure.
926  * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
927  * a full list of available formats.
928  *
929  * Returns:
930  * 0 on success or a negative error code on failure.
931  */
932 int drm_display_info_set_bus_formats(struct drm_display_info *info,
933 				     const u32 *formats,
934 				     unsigned int num_formats)
935 {
936 	u32 *fmts = NULL;
937 
938 	if (!formats && num_formats)
939 		return -EINVAL;
940 
941 	if (formats && num_formats) {
942 		fmts = kmemdup(formats, sizeof(*formats) * num_formats,
943 			       GFP_KERNEL);
944 		if (!fmts)
945 			return -ENOMEM;
946 	}
947 
948 	kfree(info->bus_formats);
949 	info->bus_formats = fmts;
950 	info->num_bus_formats = num_formats;
951 
952 	return 0;
953 }
954 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
955 
956 /* Optional connector properties. */
957 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
958 	{ DRM_MODE_SCALE_NONE, "None" },
959 	{ DRM_MODE_SCALE_FULLSCREEN, "Full" },
960 	{ DRM_MODE_SCALE_CENTER, "Center" },
961 	{ DRM_MODE_SCALE_ASPECT, "Full aspect" },
962 };
963 
964 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
965 	{ DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
966 	{ DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
967 	{ DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
968 };
969 
970 static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
971 	{ DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
972 	{ DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
973 	{ DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
974 	{ DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
975 	{ DRM_MODE_CONTENT_TYPE_GAME, "Game" },
976 };
977 
978 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
979 	{ DRM_MODE_PANEL_ORIENTATION_NORMAL,	"Normal"	},
980 	{ DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,	"Upside Down"	},
981 	{ DRM_MODE_PANEL_ORIENTATION_LEFT_UP,	"Left Side Up"	},
982 	{ DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,	"Right Side Up"	},
983 };
984 
985 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
986 	{ DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
987 	{ DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
988 	{ DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
989 };
990 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
991 
992 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
993 	{ DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I, TV-out and DP */
994 	{ DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
995 	{ DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
996 };
997 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
998 		 drm_dvi_i_subconnector_enum_list)
999 
1000 static const struct drm_prop_enum_list drm_tv_mode_enum_list[] = {
1001 	{ DRM_MODE_TV_MODE_NTSC, "NTSC" },
1002 	{ DRM_MODE_TV_MODE_NTSC_443, "NTSC-443" },
1003 	{ DRM_MODE_TV_MODE_NTSC_J, "NTSC-J" },
1004 	{ DRM_MODE_TV_MODE_PAL, "PAL" },
1005 	{ DRM_MODE_TV_MODE_PAL_M, "PAL-M" },
1006 	{ DRM_MODE_TV_MODE_PAL_N, "PAL-N" },
1007 	{ DRM_MODE_TV_MODE_SECAM, "SECAM" },
1008 };
1009 DRM_ENUM_NAME_FN(drm_get_tv_mode_name, drm_tv_mode_enum_list)
1010 
1011 /**
1012  * drm_get_tv_mode_from_name - Translates a TV mode name into its enum value
1013  * @name: TV Mode name we want to convert
1014  * @len: Length of @name
1015  *
1016  * Translates @name into an enum drm_connector_tv_mode.
1017  *
1018  * Returns: the enum value on success, a negative errno otherwise.
1019  */
1020 int drm_get_tv_mode_from_name(const char *name, size_t len)
1021 {
1022 	unsigned int i;
1023 
1024 	for (i = 0; i < ARRAY_SIZE(drm_tv_mode_enum_list); i++) {
1025 		const struct drm_prop_enum_list *item = &drm_tv_mode_enum_list[i];
1026 
1027 		if (strlen(item->name) == len && !strncmp(item->name, name, len))
1028 			return item->type;
1029 	}
1030 
1031 	return -EINVAL;
1032 }
1033 EXPORT_SYMBOL(drm_get_tv_mode_from_name);
1034 
1035 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
1036 	{ DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
1037 	{ DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
1038 	{ DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
1039 	{ DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
1040 	{ DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
1041 };
1042 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
1043 
1044 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
1045 	{ DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I, TV-out and DP */
1046 	{ DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
1047 	{ DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
1048 	{ DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
1049 	{ DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
1050 };
1051 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
1052 		 drm_tv_subconnector_enum_list)
1053 
1054 static const struct drm_prop_enum_list drm_dp_subconnector_enum_list[] = {
1055 	{ DRM_MODE_SUBCONNECTOR_Unknown,     "Unknown"   }, /* DVI-I, TV-out and DP */
1056 	{ DRM_MODE_SUBCONNECTOR_VGA,	     "VGA"       }, /* DP */
1057 	{ DRM_MODE_SUBCONNECTOR_DVID,	     "DVI-D"     }, /* DP */
1058 	{ DRM_MODE_SUBCONNECTOR_HDMIA,	     "HDMI"      }, /* DP */
1059 	{ DRM_MODE_SUBCONNECTOR_DisplayPort, "DP"        }, /* DP */
1060 	{ DRM_MODE_SUBCONNECTOR_Wireless,    "Wireless"  }, /* DP */
1061 	{ DRM_MODE_SUBCONNECTOR_Native,	     "Native"    }, /* DP */
1062 };
1063 
1064 DRM_ENUM_NAME_FN(drm_get_dp_subconnector_name,
1065 		 drm_dp_subconnector_enum_list)
1066 
1067 
1068 static const char * const colorspace_names[] = {
1069 	/* For Default case, driver will set the colorspace */
1070 	[DRM_MODE_COLORIMETRY_DEFAULT] = "Default",
1071 	/* Standard Definition Colorimetry based on CEA 861 */
1072 	[DRM_MODE_COLORIMETRY_SMPTE_170M_YCC] = "SMPTE_170M_YCC",
1073 	[DRM_MODE_COLORIMETRY_BT709_YCC] = "BT709_YCC",
1074 	/* Standard Definition Colorimetry based on IEC 61966-2-4 */
1075 	[DRM_MODE_COLORIMETRY_XVYCC_601] = "XVYCC_601",
1076 	/* High Definition Colorimetry based on IEC 61966-2-4 */
1077 	[DRM_MODE_COLORIMETRY_XVYCC_709] = "XVYCC_709",
1078 	/* Colorimetry based on IEC 61966-2-1/Amendment 1 */
1079 	[DRM_MODE_COLORIMETRY_SYCC_601] = "SYCC_601",
1080 	/* Colorimetry based on IEC 61966-2-5 [33] */
1081 	[DRM_MODE_COLORIMETRY_OPYCC_601] = "opYCC_601",
1082 	/* Colorimetry based on IEC 61966-2-5 */
1083 	[DRM_MODE_COLORIMETRY_OPRGB] = "opRGB",
1084 	/* Colorimetry based on ITU-R BT.2020 */
1085 	[DRM_MODE_COLORIMETRY_BT2020_CYCC] = "BT2020_CYCC",
1086 	/* Colorimetry based on ITU-R BT.2020 */
1087 	[DRM_MODE_COLORIMETRY_BT2020_RGB] = "BT2020_RGB",
1088 	/* Colorimetry based on ITU-R BT.2020 */
1089 	[DRM_MODE_COLORIMETRY_BT2020_YCC] = "BT2020_YCC",
1090 	/* Added as part of Additional Colorimetry Extension in 861.G */
1091 	[DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65] = "DCI-P3_RGB_D65",
1092 	[DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER] = "DCI-P3_RGB_Theater",
1093 	[DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED] = "RGB_WIDE_FIXED",
1094 	/* Colorimetry based on scRGB (IEC 61966-2-2) */
1095 	[DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT] = "RGB_WIDE_FLOAT",
1096 	[DRM_MODE_COLORIMETRY_BT601_YCC] = "BT601_YCC",
1097 };
1098 
1099 /**
1100  * drm_get_colorspace_name - return a string for color encoding
1101  * @colorspace: color space to compute name of
1102  *
1103  * In contrast to the other drm_get_*_name functions this one here returns a
1104  * const pointer and hence is threadsafe.
1105  */
1106 const char *drm_get_colorspace_name(enum drm_colorspace colorspace)
1107 {
1108 	if (colorspace < ARRAY_SIZE(colorspace_names) && colorspace_names[colorspace])
1109 		return colorspace_names[colorspace];
1110 	else
1111 		return "(null)";
1112 }
1113 
1114 static const u32 hdmi_colorspaces =
1115 	BIT(DRM_MODE_COLORIMETRY_SMPTE_170M_YCC) |
1116 	BIT(DRM_MODE_COLORIMETRY_BT709_YCC) |
1117 	BIT(DRM_MODE_COLORIMETRY_XVYCC_601) |
1118 	BIT(DRM_MODE_COLORIMETRY_XVYCC_709) |
1119 	BIT(DRM_MODE_COLORIMETRY_SYCC_601) |
1120 	BIT(DRM_MODE_COLORIMETRY_OPYCC_601) |
1121 	BIT(DRM_MODE_COLORIMETRY_OPRGB) |
1122 	BIT(DRM_MODE_COLORIMETRY_BT2020_CYCC) |
1123 	BIT(DRM_MODE_COLORIMETRY_BT2020_RGB) |
1124 	BIT(DRM_MODE_COLORIMETRY_BT2020_YCC) |
1125 	BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65) |
1126 	BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER);
1127 
1128 /*
1129  * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
1130  * Format Table 2-120
1131  */
1132 static const u32 dp_colorspaces =
1133 	BIT(DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED) |
1134 	BIT(DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT) |
1135 	BIT(DRM_MODE_COLORIMETRY_OPRGB) |
1136 	BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65) |
1137 	BIT(DRM_MODE_COLORIMETRY_BT2020_RGB) |
1138 	BIT(DRM_MODE_COLORIMETRY_BT601_YCC) |
1139 	BIT(DRM_MODE_COLORIMETRY_BT709_YCC) |
1140 	BIT(DRM_MODE_COLORIMETRY_XVYCC_601) |
1141 	BIT(DRM_MODE_COLORIMETRY_XVYCC_709) |
1142 	BIT(DRM_MODE_COLORIMETRY_SYCC_601) |
1143 	BIT(DRM_MODE_COLORIMETRY_OPYCC_601) |
1144 	BIT(DRM_MODE_COLORIMETRY_BT2020_CYCC) |
1145 	BIT(DRM_MODE_COLORIMETRY_BT2020_YCC);
1146 
1147 /**
1148  * DOC: standard connector properties
1149  *
1150  * DRM connectors have a few standardized properties:
1151  *
1152  * EDID:
1153  * 	Blob property which contains the current EDID read from the sink. This
1154  * 	is useful to parse sink identification information like vendor, model
1155  * 	and serial. Drivers should update this property by calling
1156  * 	drm_connector_update_edid_property(), usually after having parsed
1157  * 	the EDID using drm_add_edid_modes(). Userspace cannot change this
1158  * 	property.
1159  *
1160  * 	User-space should not parse the EDID to obtain information exposed via
1161  * 	other KMS properties (because the kernel might apply limits, quirks or
1162  * 	fixups to the EDID). For instance, user-space should not try to parse
1163  * 	mode lists from the EDID.
1164  * DPMS:
1165  * 	Legacy property for setting the power state of the connector. For atomic
1166  * 	drivers this is only provided for backwards compatibility with existing
1167  * 	drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
1168  * 	connector is linked to. Drivers should never set this property directly,
1169  * 	it is handled by the DRM core by calling the &drm_connector_funcs.dpms
1170  * 	callback. For atomic drivers the remapping to the "ACTIVE" property is
1171  * 	implemented in the DRM core.
1172  *
1173  * 	Note that this property cannot be set through the MODE_ATOMIC ioctl,
1174  * 	userspace must use "ACTIVE" on the CRTC instead.
1175  *
1176  * 	WARNING:
1177  *
1178  * 	For userspace also running on legacy drivers the "DPMS" semantics are a
1179  * 	lot more complicated. First, userspace cannot rely on the "DPMS" value
1180  * 	returned by the GETCONNECTOR actually reflecting reality, because many
1181  * 	drivers fail to update it. For atomic drivers this is taken care of in
1182  * 	drm_atomic_helper_update_legacy_modeset_state().
1183  *
1184  * 	The second issue is that the DPMS state is only well-defined when the
1185  * 	connector is connected to a CRTC. In atomic the DRM core enforces that
1186  * 	"ACTIVE" is off in such a case, no such checks exists for "DPMS".
1187  *
1188  * 	Finally, when enabling an output using the legacy SETCONFIG ioctl then
1189  * 	"DPMS" is forced to ON. But see above, that might not be reflected in
1190  * 	the software value on legacy drivers.
1191  *
1192  * 	Summarizing: Only set "DPMS" when the connector is known to be enabled,
1193  * 	assume that a successful SETCONFIG call also sets "DPMS" to on, and
1194  * 	never read back the value of "DPMS" because it can be incorrect.
1195  * PATH:
1196  * 	Connector path property to identify how this sink is physically
1197  * 	connected. Used by DP MST. This should be set by calling
1198  * 	drm_connector_set_path_property(), in the case of DP MST with the
1199  * 	path property the MST manager created. Userspace cannot change this
1200  * 	property.
1201  *
1202  * 	In the case of DP MST, the property has the format
1203  * 	``mst:<parent>-<ports>`` where ``<parent>`` is the KMS object ID of the
1204  * 	parent connector and ``<ports>`` is a hyphen-separated list of DP MST
1205  * 	port numbers. Note, KMS object IDs are not guaranteed to be stable
1206  * 	across reboots.
1207  * TILE:
1208  * 	Connector tile group property to indicate how a set of DRM connector
1209  * 	compose together into one logical screen. This is used by both high-res
1210  * 	external screens (often only using a single cable, but exposing multiple
1211  * 	DP MST sinks), or high-res integrated panels (like dual-link DSI) which
1212  * 	are not gen-locked. Note that for tiled panels which are genlocked, like
1213  * 	dual-link LVDS or dual-link DSI, the driver should try to not expose the
1214  * 	tiling and virtualise both &drm_crtc and &drm_plane if needed. Drivers
1215  * 	should update this value using drm_connector_set_tile_property().
1216  * 	Userspace cannot change this property.
1217  * link-status:
1218  *      Connector link-status property to indicate the status of link. The
1219  *      default value of link-status is "GOOD". If something fails during or
1220  *      after modeset, the kernel driver may set this to "BAD" and issue a
1221  *      hotplug uevent. Drivers should update this value using
1222  *      drm_connector_set_link_status_property().
1223  *
1224  *      When user-space receives the hotplug uevent and detects a "BAD"
1225  *      link-status, the sink doesn't receive pixels anymore (e.g. the screen
1226  *      becomes completely black). The list of available modes may have
1227  *      changed. User-space is expected to pick a new mode if the current one
1228  *      has disappeared and perform a new modeset with link-status set to
1229  *      "GOOD" to re-enable the connector.
1230  *
1231  *      If multiple connectors share the same CRTC and one of them gets a "BAD"
1232  *      link-status, the other are unaffected (ie. the sinks still continue to
1233  *      receive pixels).
1234  *
1235  *      When user-space performs an atomic commit on a connector with a "BAD"
1236  *      link-status without resetting the property to "GOOD", the sink may
1237  *      still not receive pixels. When user-space performs an atomic commit
1238  *      which resets the link-status property to "GOOD" without the
1239  *      ALLOW_MODESET flag set, it might fail because a modeset is required.
1240  *
1241  *      User-space can only change link-status to "GOOD", changing it to "BAD"
1242  *      is a no-op.
1243  *
1244  *      For backwards compatibility with non-atomic userspace the kernel
1245  *      tries to automatically set the link-status back to "GOOD" in the
1246  *      SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1247  *      to how it might fail if a different screen has been connected in the
1248  *      interim.
1249  * non_desktop:
1250  * 	Indicates the output should be ignored for purposes of displaying a
1251  * 	standard desktop environment or console. This is most likely because
1252  * 	the output device is not rectilinear.
1253  * Content Protection:
1254  *	This property is used by userspace to request the kernel protect future
1255  *	content communicated over the link. When requested, kernel will apply
1256  *	the appropriate means of protection (most often HDCP), and use the
1257  *	property to tell userspace the protection is active.
1258  *
1259  *	Drivers can set this up by calling
1260  *	drm_connector_attach_content_protection_property() on initialization.
1261  *
1262  *	The value of this property can be one of the following:
1263  *
1264  *	DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1265  *		The link is not protected, content is transmitted in the clear.
1266  *	DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1267  *		Userspace has requested content protection, but the link is not
1268  *		currently protected. When in this state, kernel should enable
1269  *		Content Protection as soon as possible.
1270  *	DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1271  *		Userspace has requested content protection, and the link is
1272  *		protected. Only the driver can set the property to this value.
1273  *		If userspace attempts to set to ENABLED, kernel will return
1274  *		-EINVAL.
1275  *
1276  *	A few guidelines:
1277  *
1278  *	- DESIRED state should be preserved until userspace de-asserts it by
1279  *	  setting the property to UNDESIRED. This means ENABLED should only
1280  *	  transition to UNDESIRED when the user explicitly requests it.
1281  *	- If the state is DESIRED, kernel should attempt to re-authenticate the
1282  *	  link whenever possible. This includes across disable/enable, dpms,
1283  *	  hotplug, downstream device changes, link status failures, etc..
1284  *	- Kernel sends uevent with the connector id and property id through
1285  *	  @drm_hdcp_update_content_protection, upon below kernel triggered
1286  *	  scenarios:
1287  *
1288  *		- DESIRED -> ENABLED (authentication success)
1289  *		- ENABLED -> DESIRED (termination of authentication)
1290  *	- Please note no uevents for userspace triggered property state changes,
1291  *	  which can't fail such as
1292  *
1293  *		- DESIRED/ENABLED -> UNDESIRED
1294  *		- UNDESIRED -> DESIRED
1295  *	- Userspace is responsible for polling the property or listen to uevents
1296  *	  to determine when the value transitions from ENABLED to DESIRED.
1297  *	  This signifies the link is no longer protected and userspace should
1298  *	  take appropriate action (whatever that might be).
1299  *
1300  * HDCP Content Type:
1301  *	This Enum property is used by the userspace to declare the content type
1302  *	of the display stream, to kernel. Here display stream stands for any
1303  *	display content that userspace intended to display through HDCP
1304  *	encryption.
1305  *
1306  *	Content Type of a stream is decided by the owner of the stream, as
1307  *	"HDCP Type0" or "HDCP Type1".
1308  *
1309  *	The value of the property can be one of the below:
1310  *	  - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1311  *	  - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1312  *
1313  *	When kernel starts the HDCP authentication (see "Content Protection"
1314  *	for details), it uses the content type in "HDCP Content Type"
1315  *	for performing the HDCP authentication with the display sink.
1316  *
1317  *	Please note in HDCP spec versions, a link can be authenticated with
1318  *	HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1319  *	authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1320  *	in nature. As there is no reference for Content Type in HDCP1.4).
1321  *
1322  *	HDCP2.2 authentication protocol itself takes the "Content Type" as a
1323  *	parameter, which is a input for the DP HDCP2.2 encryption algo.
1324  *
1325  *	In case of Type 0 content protection request, kernel driver can choose
1326  *	either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1327  *	"HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1328  *	that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1329  *	But if the content is classified as "HDCP Type 1", above mentioned
1330  *	HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1331  *	authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1332  *
1333  *	Please note userspace can be ignorant of the HDCP versions used by the
1334  *	kernel driver to achieve the "HDCP Content Type".
1335  *
1336  *	At current scenario, classifying a content as Type 1 ensures that the
1337  *	content will be displayed only through the HDCP2.2 encrypted link.
1338  *
1339  *	Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1340  *	defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1341  *	(hence supporting Type 0 and Type 1). Based on how next versions of
1342  *	HDCP specs are defined content Type could be used for higher versions
1343  *	too.
1344  *
1345  *	If content type is changed when "Content Protection" is not UNDESIRED,
1346  *	then kernel will disable the HDCP and re-enable with new type in the
1347  *	same atomic commit. And when "Content Protection" is ENABLED, it means
1348  *	that link is HDCP authenticated and encrypted, for the transmission of
1349  *	the Type of stream mentioned at "HDCP Content Type".
1350  *
1351  * HDR_OUTPUT_METADATA:
1352  *	Connector property to enable userspace to send HDR Metadata to
1353  *	driver. This metadata is based on the composition and blending
1354  *	policies decided by user, taking into account the hardware and
1355  *	sink capabilities. The driver gets this metadata and creates a
1356  *	Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1357  *	SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1358  *	sent to sink. This notifies the sink of the upcoming frame's Color
1359  *	Encoding and Luminance parameters.
1360  *
1361  *	Userspace first need to detect the HDR capabilities of sink by
1362  *	reading and parsing the EDID. Details of HDR metadata for HDMI
1363  *	are added in CTA 861.G spec. For DP , its defined in VESA DP
1364  *	Standard v1.4. It needs to then get the metadata information
1365  *	of the video/game/app content which are encoded in HDR (basically
1366  *	using HDR transfer functions). With this information it needs to
1367  *	decide on a blending policy and compose the relevant
1368  *	layers/overlays into a common format. Once this blending is done,
1369  *	userspace will be aware of the metadata of the composed frame to
1370  *	be send to sink. It then uses this property to communicate this
1371  *	metadata to driver which then make a Infoframe packet and sends
1372  *	to sink based on the type of encoder connected.
1373  *
1374  *	Userspace will be responsible to do Tone mapping operation in case:
1375  *		- Some layers are HDR and others are SDR
1376  *		- HDR layers luminance is not same as sink
1377  *
1378  *	It will even need to do colorspace conversion and get all layers
1379  *	to one common colorspace for blending. It can use either GL, Media
1380  *	or display engine to get this done based on the capabilities of the
1381  *	associated hardware.
1382  *
1383  *	Driver expects metadata to be put in &struct hdr_output_metadata
1384  *	structure from userspace. This is received as blob and stored in
1385  *	&drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1386  *	sink metadata in &struct hdr_sink_metadata, as
1387  *	&drm_connector.hdr_sink_metadata.  Driver uses
1388  *	drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1389  *	hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1390  *	HDMI encoder.
1391  *
1392  * max bpc:
1393  *	This range property is used by userspace to limit the bit depth. When
1394  *	used the driver would limit the bpc in accordance with the valid range
1395  *	supported by the hardware and sink. Drivers to use the function
1396  *	drm_connector_attach_max_bpc_property() to create and attach the
1397  *	property to the connector during initialization.
1398  *
1399  * Connectors also have one standardized atomic property:
1400  *
1401  * CRTC_ID:
1402  * 	Mode object ID of the &drm_crtc this connector should be connected to.
1403  *
1404  * Connectors for LCD panels may also have one standardized property:
1405  *
1406  * panel orientation:
1407  *	On some devices the LCD panel is mounted in the casing in such a way
1408  *	that the up/top side of the panel does not match with the top side of
1409  *	the device. Userspace can use this property to check for this.
1410  *	Note that input coordinates from touchscreens (input devices with
1411  *	INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1412  *	coordinates, so if userspace rotates the picture to adjust for
1413  *	the orientation it must also apply the same transformation to the
1414  *	touchscreen input coordinates. This property is initialized by calling
1415  *	drm_connector_set_panel_orientation() or
1416  *	drm_connector_set_panel_orientation_with_quirk()
1417  *
1418  * scaling mode:
1419  *	This property defines how a non-native mode is upscaled to the native
1420  *	mode of an LCD panel:
1421  *
1422  *	None:
1423  *		No upscaling happens, scaling is left to the panel. Not all
1424  *		drivers expose this mode.
1425  *	Full:
1426  *		The output is upscaled to the full resolution of the panel,
1427  *		ignoring the aspect ratio.
1428  *	Center:
1429  *		No upscaling happens, the output is centered within the native
1430  *		resolution the panel.
1431  *	Full aspect:
1432  *		The output is upscaled to maximize either the width or height
1433  *		while retaining the aspect ratio.
1434  *
1435  *	This property should be set up by calling
1436  *	drm_connector_attach_scaling_mode_property(). Note that drivers
1437  *	can also expose this property to external outputs, in which case they
1438  *	must support "None", which should be the default (since external screens
1439  *	have a built-in scaler).
1440  *
1441  * subconnector:
1442  *	This property is used by DVI-I, TVout and DisplayPort to indicate different
1443  *	connector subtypes. Enum values more or less match with those from main
1444  *	connector types.
1445  *	For DVI-I and TVout there is also a matching property "select subconnector"
1446  *	allowing to switch between signal types.
1447  *	DP subconnector corresponds to a downstream port.
1448  *
1449  * privacy-screen sw-state, privacy-screen hw-state:
1450  *	These 2 optional properties can be used to query the state of the
1451  *	electronic privacy screen that is available on some displays; and in
1452  *	some cases also control the state. If a driver implements these
1453  *	properties then both properties must be present.
1454  *
1455  *	"privacy-screen hw-state" is read-only and reflects the actual state
1456  *	of the privacy-screen, possible values: "Enabled", "Disabled,
1457  *	"Enabled-locked", "Disabled-locked". The locked states indicate
1458  *	that the state cannot be changed through the DRM API. E.g. there
1459  *	might be devices where the firmware-setup options, or a hardware
1460  *	slider-switch, offer always on / off modes.
1461  *
1462  *	"privacy-screen sw-state" can be set to change the privacy-screen state
1463  *	when not locked. In this case the driver must update the hw-state
1464  *	property to reflect the new state on completion of the commit of the
1465  *	sw-state property. Setting the sw-state property when the hw-state is
1466  *	locked must be interpreted by the driver as a request to change the
1467  *	state to the set state when the hw-state becomes unlocked. E.g. if
1468  *	"privacy-screen hw-state" is "Enabled-locked" and the sw-state
1469  *	gets set to "Disabled" followed by the user unlocking the state by
1470  *	changing the slider-switch position, then the driver must set the
1471  *	state to "Disabled" upon receiving the unlock event.
1472  *
1473  *	In some cases the privacy-screen's actual state might change outside of
1474  *	control of the DRM code. E.g. there might be a firmware handled hotkey
1475  *	which toggles the actual state, or the actual state might be changed
1476  *	through another userspace API such as writing /proc/acpi/ibm/lcdshadow.
1477  *	In this case the driver must update both the hw-state and the sw-state
1478  *	to reflect the new value, overwriting any pending state requests in the
1479  *	sw-state. Any pending sw-state requests are thus discarded.
1480  *
1481  *	Note that the ability for the state to change outside of control of
1482  *	the DRM master process means that userspace must not cache the value
1483  *	of the sw-state. Caching the sw-state value and including it in later
1484  *	atomic commits may lead to overriding a state change done through e.g.
1485  *	a firmware handled hotkey. Therefor userspace must not include the
1486  *	privacy-screen sw-state in an atomic commit unless it wants to change
1487  *	its value.
1488  *
1489  * left margin, right margin, top margin, bottom margin:
1490  *	Add margins to the connector's viewport. This is typically used to
1491  *	mitigate overscan on TVs.
1492  *
1493  *	The value is the size in pixels of the black border which will be
1494  *	added. The attached CRTC's content will be scaled to fill the whole
1495  *	area inside the margin.
1496  *
1497  *	The margins configuration might be sent to the sink, e.g. via HDMI AVI
1498  *	InfoFrames.
1499  *
1500  *	Drivers can set up these properties by calling
1501  *	drm_mode_create_tv_margin_properties().
1502  */
1503 
1504 int drm_connector_create_standard_properties(struct drm_device *dev)
1505 {
1506 	struct drm_property *prop;
1507 
1508 	prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1509 				   DRM_MODE_PROP_IMMUTABLE,
1510 				   "EDID", 0);
1511 	if (!prop)
1512 		return -ENOMEM;
1513 	dev->mode_config.edid_property = prop;
1514 
1515 	prop = drm_property_create_enum(dev, 0,
1516 				   "DPMS", drm_dpms_enum_list,
1517 				   ARRAY_SIZE(drm_dpms_enum_list));
1518 	if (!prop)
1519 		return -ENOMEM;
1520 	dev->mode_config.dpms_property = prop;
1521 
1522 	prop = drm_property_create(dev,
1523 				   DRM_MODE_PROP_BLOB |
1524 				   DRM_MODE_PROP_IMMUTABLE,
1525 				   "PATH", 0);
1526 	if (!prop)
1527 		return -ENOMEM;
1528 	dev->mode_config.path_property = prop;
1529 
1530 	prop = drm_property_create(dev,
1531 				   DRM_MODE_PROP_BLOB |
1532 				   DRM_MODE_PROP_IMMUTABLE,
1533 				   "TILE", 0);
1534 	if (!prop)
1535 		return -ENOMEM;
1536 	dev->mode_config.tile_property = prop;
1537 
1538 	prop = drm_property_create_enum(dev, 0, "link-status",
1539 					drm_link_status_enum_list,
1540 					ARRAY_SIZE(drm_link_status_enum_list));
1541 	if (!prop)
1542 		return -ENOMEM;
1543 	dev->mode_config.link_status_property = prop;
1544 
1545 	prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1546 	if (!prop)
1547 		return -ENOMEM;
1548 	dev->mode_config.non_desktop_property = prop;
1549 
1550 	prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1551 				   "HDR_OUTPUT_METADATA", 0);
1552 	if (!prop)
1553 		return -ENOMEM;
1554 	dev->mode_config.hdr_output_metadata_property = prop;
1555 
1556 	return 0;
1557 }
1558 
1559 /**
1560  * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1561  * @dev: DRM device
1562  *
1563  * Called by a driver the first time a DVI-I connector is made.
1564  *
1565  * Returns: %0
1566  */
1567 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1568 {
1569 	struct drm_property *dvi_i_selector;
1570 	struct drm_property *dvi_i_subconnector;
1571 
1572 	if (dev->mode_config.dvi_i_select_subconnector_property)
1573 		return 0;
1574 
1575 	dvi_i_selector =
1576 		drm_property_create_enum(dev, 0,
1577 				    "select subconnector",
1578 				    drm_dvi_i_select_enum_list,
1579 				    ARRAY_SIZE(drm_dvi_i_select_enum_list));
1580 	dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1581 
1582 	dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1583 				    "subconnector",
1584 				    drm_dvi_i_subconnector_enum_list,
1585 				    ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1586 	dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1587 
1588 	return 0;
1589 }
1590 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1591 
1592 /**
1593  * drm_connector_attach_dp_subconnector_property - create subconnector property for DP
1594  * @connector: drm_connector to attach property
1595  *
1596  * Called by a driver when DP connector is created.
1597  */
1598 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector)
1599 {
1600 	struct drm_mode_config *mode_config = &connector->dev->mode_config;
1601 
1602 	if (!mode_config->dp_subconnector_property)
1603 		mode_config->dp_subconnector_property =
1604 			drm_property_create_enum(connector->dev,
1605 				DRM_MODE_PROP_IMMUTABLE,
1606 				"subconnector",
1607 				drm_dp_subconnector_enum_list,
1608 				ARRAY_SIZE(drm_dp_subconnector_enum_list));
1609 
1610 	drm_object_attach_property(&connector->base,
1611 				   mode_config->dp_subconnector_property,
1612 				   DRM_MODE_SUBCONNECTOR_Unknown);
1613 }
1614 EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
1615 
1616 /**
1617  * DOC: HDMI connector properties
1618  *
1619  * content type (HDMI specific):
1620  *	Indicates content type setting to be used in HDMI infoframes to indicate
1621  *	content type for the external device, so that it adjusts its display
1622  *	settings accordingly.
1623  *
1624  *	The value of this property can be one of the following:
1625  *
1626  *	No Data:
1627  *		Content type is unknown
1628  *	Graphics:
1629  *		Content type is graphics
1630  *	Photo:
1631  *		Content type is photo
1632  *	Cinema:
1633  *		Content type is cinema
1634  *	Game:
1635  *		Content type is game
1636  *
1637  *	The meaning of each content type is defined in CTA-861-G table 15.
1638  *
1639  *	Drivers can set up this property by calling
1640  *	drm_connector_attach_content_type_property(). Decoding to
1641  *	infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1642  */
1643 
1644 /*
1645  * TODO: Document the properties:
1646  *   - brightness
1647  *   - contrast
1648  *   - flicker reduction
1649  *   - hue
1650  *   - mode
1651  *   - overscan
1652  *   - saturation
1653  *   - select subconnector
1654  */
1655 /**
1656  * DOC: Analog TV Connector Properties
1657  *
1658  * TV Mode:
1659  *	Indicates the TV Mode used on an analog TV connector. The value
1660  *	of this property can be one of the following:
1661  *
1662  *	NTSC:
1663  *		TV Mode is CCIR System M (aka 525-lines) together with
1664  *		the NTSC Color Encoding.
1665  *
1666  *	NTSC-443:
1667  *
1668  *		TV Mode is CCIR System M (aka 525-lines) together with
1669  *		the NTSC Color Encoding, but with a color subcarrier
1670  *		frequency of 4.43MHz
1671  *
1672  *	NTSC-J:
1673  *
1674  *		TV Mode is CCIR System M (aka 525-lines) together with
1675  *		the NTSC Color Encoding, but with a black level equal to
1676  *		the blanking level.
1677  *
1678  *	PAL:
1679  *
1680  *		TV Mode is CCIR System B (aka 625-lines) together with
1681  *		the PAL Color Encoding.
1682  *
1683  *	PAL-M:
1684  *
1685  *		TV Mode is CCIR System M (aka 525-lines) together with
1686  *		the PAL Color Encoding.
1687  *
1688  *	PAL-N:
1689  *
1690  *		TV Mode is CCIR System N together with the PAL Color
1691  *		Encoding, a color subcarrier frequency of 3.58MHz, the
1692  *		SECAM color space, and narrower channels than other PAL
1693  *		variants.
1694  *
1695  *	SECAM:
1696  *
1697  *		TV Mode is CCIR System B (aka 625-lines) together with
1698  *		the SECAM Color Encoding.
1699  *
1700  *	Drivers can set up this property by calling
1701  *	drm_mode_create_tv_properties().
1702  */
1703 
1704 /**
1705  * drm_connector_attach_content_type_property - attach content-type property
1706  * @connector: connector to attach content type property on.
1707  *
1708  * Called by a driver the first time a HDMI connector is made.
1709  *
1710  * Returns: %0
1711  */
1712 int drm_connector_attach_content_type_property(struct drm_connector *connector)
1713 {
1714 	if (!drm_mode_create_content_type_property(connector->dev))
1715 		drm_object_attach_property(&connector->base,
1716 					   connector->dev->mode_config.content_type_property,
1717 					   DRM_MODE_CONTENT_TYPE_NO_DATA);
1718 	return 0;
1719 }
1720 EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1721 
1722 /**
1723  * drm_connector_attach_tv_margin_properties - attach TV connector margin
1724  * 	properties
1725  * @connector: DRM connector
1726  *
1727  * Called by a driver when it needs to attach TV margin props to a connector.
1728  * Typically used on SDTV and HDMI connectors.
1729  */
1730 void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1731 {
1732 	struct drm_device *dev = connector->dev;
1733 
1734 	drm_object_attach_property(&connector->base,
1735 				   dev->mode_config.tv_left_margin_property,
1736 				   0);
1737 	drm_object_attach_property(&connector->base,
1738 				   dev->mode_config.tv_right_margin_property,
1739 				   0);
1740 	drm_object_attach_property(&connector->base,
1741 				   dev->mode_config.tv_top_margin_property,
1742 				   0);
1743 	drm_object_attach_property(&connector->base,
1744 				   dev->mode_config.tv_bottom_margin_property,
1745 				   0);
1746 }
1747 EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1748 
1749 /**
1750  * drm_mode_create_tv_margin_properties - create TV connector margin properties
1751  * @dev: DRM device
1752  *
1753  * Called by a driver's HDMI connector initialization routine, this function
1754  * creates the TV margin properties for a given device. No need to call this
1755  * function for an SDTV connector, it's already called from
1756  * drm_mode_create_tv_properties_legacy().
1757  *
1758  * Returns:
1759  * 0 on success or a negative error code on failure.
1760  */
1761 int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1762 {
1763 	if (dev->mode_config.tv_left_margin_property)
1764 		return 0;
1765 
1766 	dev->mode_config.tv_left_margin_property =
1767 		drm_property_create_range(dev, 0, "left margin", 0, 100);
1768 	if (!dev->mode_config.tv_left_margin_property)
1769 		return -ENOMEM;
1770 
1771 	dev->mode_config.tv_right_margin_property =
1772 		drm_property_create_range(dev, 0, "right margin", 0, 100);
1773 	if (!dev->mode_config.tv_right_margin_property)
1774 		return -ENOMEM;
1775 
1776 	dev->mode_config.tv_top_margin_property =
1777 		drm_property_create_range(dev, 0, "top margin", 0, 100);
1778 	if (!dev->mode_config.tv_top_margin_property)
1779 		return -ENOMEM;
1780 
1781 	dev->mode_config.tv_bottom_margin_property =
1782 		drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1783 	if (!dev->mode_config.tv_bottom_margin_property)
1784 		return -ENOMEM;
1785 
1786 	return 0;
1787 }
1788 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1789 
1790 /**
1791  * drm_mode_create_tv_properties_legacy - create TV specific connector properties
1792  * @dev: DRM device
1793  * @num_modes: number of different TV formats (modes) supported
1794  * @modes: array of pointers to strings containing name of each format
1795  *
1796  * Called by a driver's TV initialization routine, this function creates
1797  * the TV specific connector properties for a given device.  Caller is
1798  * responsible for allocating a list of format names and passing them to
1799  * this routine.
1800  *
1801  * NOTE: This functions registers the deprecated "mode" connector
1802  * property to select the analog TV mode (ie, NTSC, PAL, etc.). New
1803  * drivers must use drm_mode_create_tv_properties() instead.
1804  *
1805  * Returns:
1806  * 0 on success or a negative error code on failure.
1807  */
1808 int drm_mode_create_tv_properties_legacy(struct drm_device *dev,
1809 					 unsigned int num_modes,
1810 					 const char * const modes[])
1811 {
1812 	struct drm_property *tv_selector;
1813 	struct drm_property *tv_subconnector;
1814 	unsigned int i;
1815 
1816 	if (dev->mode_config.tv_select_subconnector_property)
1817 		return 0;
1818 
1819 	/*
1820 	 * Basic connector properties
1821 	 */
1822 	tv_selector = drm_property_create_enum(dev, 0,
1823 					  "select subconnector",
1824 					  drm_tv_select_enum_list,
1825 					  ARRAY_SIZE(drm_tv_select_enum_list));
1826 	if (!tv_selector)
1827 		goto nomem;
1828 
1829 	dev->mode_config.tv_select_subconnector_property = tv_selector;
1830 
1831 	tv_subconnector =
1832 		drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1833 				    "subconnector",
1834 				    drm_tv_subconnector_enum_list,
1835 				    ARRAY_SIZE(drm_tv_subconnector_enum_list));
1836 	if (!tv_subconnector)
1837 		goto nomem;
1838 	dev->mode_config.tv_subconnector_property = tv_subconnector;
1839 
1840 	/*
1841 	 * Other, TV specific properties: margins & TV modes.
1842 	 */
1843 	if (drm_mode_create_tv_margin_properties(dev))
1844 		goto nomem;
1845 
1846 	if (num_modes) {
1847 		dev->mode_config.legacy_tv_mode_property =
1848 			drm_property_create(dev, DRM_MODE_PROP_ENUM,
1849 					    "mode", num_modes);
1850 		if (!dev->mode_config.legacy_tv_mode_property)
1851 			goto nomem;
1852 
1853 		for (i = 0; i < num_modes; i++)
1854 			drm_property_add_enum(dev->mode_config.legacy_tv_mode_property,
1855 					      i, modes[i]);
1856 	}
1857 
1858 	dev->mode_config.tv_brightness_property =
1859 		drm_property_create_range(dev, 0, "brightness", 0, 100);
1860 	if (!dev->mode_config.tv_brightness_property)
1861 		goto nomem;
1862 
1863 	dev->mode_config.tv_contrast_property =
1864 		drm_property_create_range(dev, 0, "contrast", 0, 100);
1865 	if (!dev->mode_config.tv_contrast_property)
1866 		goto nomem;
1867 
1868 	dev->mode_config.tv_flicker_reduction_property =
1869 		drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1870 	if (!dev->mode_config.tv_flicker_reduction_property)
1871 		goto nomem;
1872 
1873 	dev->mode_config.tv_overscan_property =
1874 		drm_property_create_range(dev, 0, "overscan", 0, 100);
1875 	if (!dev->mode_config.tv_overscan_property)
1876 		goto nomem;
1877 
1878 	dev->mode_config.tv_saturation_property =
1879 		drm_property_create_range(dev, 0, "saturation", 0, 100);
1880 	if (!dev->mode_config.tv_saturation_property)
1881 		goto nomem;
1882 
1883 	dev->mode_config.tv_hue_property =
1884 		drm_property_create_range(dev, 0, "hue", 0, 100);
1885 	if (!dev->mode_config.tv_hue_property)
1886 		goto nomem;
1887 
1888 	return 0;
1889 nomem:
1890 	return -ENOMEM;
1891 }
1892 EXPORT_SYMBOL(drm_mode_create_tv_properties_legacy);
1893 
1894 /**
1895  * drm_mode_create_tv_properties - create TV specific connector properties
1896  * @dev: DRM device
1897  * @supported_tv_modes: Bitmask of TV modes supported (See DRM_MODE_TV_MODE_*)
1898  *
1899  * Called by a driver's TV initialization routine, this function creates
1900  * the TV specific connector properties for a given device.
1901  *
1902  * Returns:
1903  * 0 on success or a negative error code on failure.
1904  */
1905 int drm_mode_create_tv_properties(struct drm_device *dev,
1906 				  unsigned int supported_tv_modes)
1907 {
1908 	struct drm_prop_enum_list tv_mode_list[DRM_MODE_TV_MODE_MAX];
1909 	struct drm_property *tv_mode;
1910 	unsigned int i, len = 0;
1911 
1912 	if (dev->mode_config.tv_mode_property)
1913 		return 0;
1914 
1915 	for (i = 0; i < DRM_MODE_TV_MODE_MAX; i++) {
1916 		if (!(supported_tv_modes & BIT(i)))
1917 			continue;
1918 
1919 		tv_mode_list[len].type = i;
1920 		tv_mode_list[len].name = drm_get_tv_mode_name(i);
1921 		len++;
1922 	}
1923 
1924 	tv_mode = drm_property_create_enum(dev, 0, "TV mode",
1925 					   tv_mode_list, len);
1926 	if (!tv_mode)
1927 		return -ENOMEM;
1928 
1929 	dev->mode_config.tv_mode_property = tv_mode;
1930 
1931 	return drm_mode_create_tv_properties_legacy(dev, 0, NULL);
1932 }
1933 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1934 
1935 /**
1936  * drm_mode_create_scaling_mode_property - create scaling mode property
1937  * @dev: DRM device
1938  *
1939  * Called by a driver the first time it's needed, must be attached to desired
1940  * connectors.
1941  *
1942  * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1943  * instead to correctly assign &drm_connector_state.scaling_mode
1944  * in the atomic state.
1945  *
1946  * Returns: %0
1947  */
1948 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1949 {
1950 	struct drm_property *scaling_mode;
1951 
1952 	if (dev->mode_config.scaling_mode_property)
1953 		return 0;
1954 
1955 	scaling_mode =
1956 		drm_property_create_enum(dev, 0, "scaling mode",
1957 				drm_scaling_mode_enum_list,
1958 				    ARRAY_SIZE(drm_scaling_mode_enum_list));
1959 
1960 	dev->mode_config.scaling_mode_property = scaling_mode;
1961 
1962 	return 0;
1963 }
1964 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1965 
1966 /**
1967  * DOC: Variable refresh properties
1968  *
1969  * Variable refresh rate capable displays can dynamically adjust their
1970  * refresh rate by extending the duration of their vertical front porch
1971  * until page flip or timeout occurs. This can reduce or remove stuttering
1972  * and latency in scenarios where the page flip does not align with the
1973  * vblank interval.
1974  *
1975  * An example scenario would be an application flipping at a constant rate
1976  * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1977  * interval and the same contents will be displayed twice. This can be
1978  * observed as stuttering for content with motion.
1979  *
1980  * If variable refresh rate was active on a display that supported a
1981  * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1982  * for the example scenario. The minimum supported variable refresh rate of
1983  * 35Hz is below the page flip frequency and the vertical front porch can
1984  * be extended until the page flip occurs. The vblank interval will be
1985  * directly aligned to the page flip rate.
1986  *
1987  * Not all userspace content is suitable for use with variable refresh rate.
1988  * Large and frequent changes in vertical front porch duration may worsen
1989  * perceived stuttering for input sensitive applications.
1990  *
1991  * Panel brightness will also vary with vertical front porch duration. Some
1992  * panels may have noticeable differences in brightness between the minimum
1993  * vertical front porch duration and the maximum vertical front porch duration.
1994  * Large and frequent changes in vertical front porch duration may produce
1995  * observable flickering for such panels.
1996  *
1997  * Userspace control for variable refresh rate is supported via properties
1998  * on the &drm_connector and &drm_crtc objects.
1999  *
2000  * "vrr_capable":
2001  *	Optional &drm_connector boolean property that drivers should attach
2002  *	with drm_connector_attach_vrr_capable_property() on connectors that
2003  *	could support variable refresh rates. Drivers should update the
2004  *	property value by calling drm_connector_set_vrr_capable_property().
2005  *
2006  *	Absence of the property should indicate absence of support.
2007  *
2008  * "VRR_ENABLED":
2009  *	Default &drm_crtc boolean property that notifies the driver that the
2010  *	content on the CRTC is suitable for variable refresh rate presentation.
2011  *	The driver will take this property as a hint to enable variable
2012  *	refresh rate support if the receiver supports it, ie. if the
2013  *	"vrr_capable" property is true on the &drm_connector object. The
2014  *	vertical front porch duration will be extended until page-flip or
2015  *	timeout when enabled.
2016  *
2017  *	The minimum vertical front porch duration is defined as the vertical
2018  *	front porch duration for the current mode.
2019  *
2020  *	The maximum vertical front porch duration is greater than or equal to
2021  *	the minimum vertical front porch duration. The duration is derived
2022  *	from the minimum supported variable refresh rate for the connector.
2023  *
2024  *	The driver may place further restrictions within these minimum
2025  *	and maximum bounds.
2026  */
2027 
2028 /**
2029  * drm_connector_attach_vrr_capable_property - creates the
2030  * vrr_capable property
2031  * @connector: connector to create the vrr_capable property on.
2032  *
2033  * This is used by atomic drivers to add support for querying
2034  * variable refresh rate capability for a connector.
2035  *
2036  * Returns:
2037  * Zero on success, negative errno on failure.
2038  */
2039 int drm_connector_attach_vrr_capable_property(
2040 	struct drm_connector *connector)
2041 {
2042 	struct drm_device *dev = connector->dev;
2043 	struct drm_property *prop;
2044 
2045 	if (!connector->vrr_capable_property) {
2046 		prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
2047 			"vrr_capable");
2048 		if (!prop)
2049 			return -ENOMEM;
2050 
2051 		connector->vrr_capable_property = prop;
2052 		drm_object_attach_property(&connector->base, prop, 0);
2053 	}
2054 
2055 	return 0;
2056 }
2057 EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
2058 
2059 /**
2060  * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
2061  * @connector: connector to attach scaling mode property on.
2062  * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
2063  *
2064  * This is used to add support for scaling mode to atomic drivers.
2065  * The scaling mode will be set to &drm_connector_state.scaling_mode
2066  * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
2067  *
2068  * This is the atomic version of drm_mode_create_scaling_mode_property().
2069  *
2070  * Returns:
2071  * Zero on success, negative errno on failure.
2072  */
2073 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
2074 					       u32 scaling_mode_mask)
2075 {
2076 	struct drm_device *dev = connector->dev;
2077 	struct drm_property *scaling_mode_property;
2078 	int i;
2079 	const unsigned valid_scaling_mode_mask =
2080 		(1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
2081 
2082 	if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
2083 		    scaling_mode_mask & ~valid_scaling_mode_mask))
2084 		return -EINVAL;
2085 
2086 	scaling_mode_property =
2087 		drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
2088 				    hweight32(scaling_mode_mask));
2089 
2090 	if (!scaling_mode_property)
2091 		return -ENOMEM;
2092 
2093 	for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
2094 		int ret;
2095 
2096 		if (!(BIT(i) & scaling_mode_mask))
2097 			continue;
2098 
2099 		ret = drm_property_add_enum(scaling_mode_property,
2100 					    drm_scaling_mode_enum_list[i].type,
2101 					    drm_scaling_mode_enum_list[i].name);
2102 
2103 		if (ret) {
2104 			drm_property_destroy(dev, scaling_mode_property);
2105 
2106 			return ret;
2107 		}
2108 	}
2109 
2110 	drm_object_attach_property(&connector->base,
2111 				   scaling_mode_property, 0);
2112 
2113 	connector->scaling_mode_property = scaling_mode_property;
2114 
2115 	return 0;
2116 }
2117 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
2118 
2119 /**
2120  * drm_mode_create_aspect_ratio_property - create aspect ratio property
2121  * @dev: DRM device
2122  *
2123  * Called by a driver the first time it's needed, must be attached to desired
2124  * connectors.
2125  *
2126  * Returns:
2127  * Zero on success, negative errno on failure.
2128  */
2129 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
2130 {
2131 	if (dev->mode_config.aspect_ratio_property)
2132 		return 0;
2133 
2134 	dev->mode_config.aspect_ratio_property =
2135 		drm_property_create_enum(dev, 0, "aspect ratio",
2136 				drm_aspect_ratio_enum_list,
2137 				ARRAY_SIZE(drm_aspect_ratio_enum_list));
2138 
2139 	if (dev->mode_config.aspect_ratio_property == NULL)
2140 		return -ENOMEM;
2141 
2142 	return 0;
2143 }
2144 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
2145 
2146 /**
2147  * DOC: standard connector properties
2148  *
2149  * Colorspace:
2150  *     This property helps select a suitable colorspace based on the sink
2151  *     capability. Modern sink devices support wider gamut like BT2020.
2152  *     This helps switch to BT2020 mode if the BT2020 encoded video stream
2153  *     is being played by the user, same for any other colorspace. Thereby
2154  *     giving a good visual experience to users.
2155  *
2156  *     The expectation from userspace is that it should parse the EDID
2157  *     and get supported colorspaces. Use this property and switch to the
2158  *     one supported. Sink supported colorspaces should be retrieved by
2159  *     userspace from EDID and driver will not explicitly expose them.
2160  *
2161  *     Basically the expectation from userspace is:
2162  *      - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
2163  *        colorspace
2164  *      - Set this new property to let the sink know what it
2165  *        converted the CRTC output to.
2166  *      - This property is just to inform sink what colorspace
2167  *        source is trying to drive.
2168  *
2169  * Because between HDMI and DP have different colorspaces,
2170  * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
2171  * drm_mode_create_dp_colorspace_property() is used for DP connector.
2172  */
2173 
2174 static int drm_mode_create_colorspace_property(struct drm_connector *connector,
2175 					u32 supported_colorspaces)
2176 {
2177 	struct drm_device *dev = connector->dev;
2178 	u32 colorspaces = supported_colorspaces | BIT(DRM_MODE_COLORIMETRY_DEFAULT);
2179 	struct drm_prop_enum_list enum_list[DRM_MODE_COLORIMETRY_COUNT];
2180 	int i, len;
2181 
2182 	if (connector->colorspace_property)
2183 		return 0;
2184 
2185 	if (!supported_colorspaces) {
2186 		drm_err(dev, "No supported colorspaces provded on [CONNECTOR:%d:%s]\n",
2187 			    connector->base.id, connector->name);
2188 		return -EINVAL;
2189 	}
2190 
2191 	if ((supported_colorspaces & -BIT(DRM_MODE_COLORIMETRY_COUNT)) != 0) {
2192 		drm_err(dev, "Unknown colorspace provded on [CONNECTOR:%d:%s]\n",
2193 			    connector->base.id, connector->name);
2194 		return -EINVAL;
2195 	}
2196 
2197 	len = 0;
2198 	for (i = 0; i < DRM_MODE_COLORIMETRY_COUNT; i++) {
2199 		if ((colorspaces & BIT(i)) == 0)
2200 			continue;
2201 
2202 		enum_list[len].type = i;
2203 		enum_list[len].name = colorspace_names[i];
2204 		len++;
2205 	}
2206 
2207 	connector->colorspace_property =
2208 		drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
2209 					enum_list,
2210 					len);
2211 
2212 	if (!connector->colorspace_property)
2213 		return -ENOMEM;
2214 
2215 	return 0;
2216 }
2217 
2218 /**
2219  * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
2220  * @connector: connector to create the Colorspace property on.
2221  * @supported_colorspaces: bitmap of supported color spaces
2222  *
2223  * Called by a driver the first time it's needed, must be attached to desired
2224  * HDMI connectors.
2225  *
2226  * Returns:
2227  * Zero on success, negative errno on failure.
2228  */
2229 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector,
2230 					     u32 supported_colorspaces)
2231 {
2232 	u32 colorspaces;
2233 
2234 	if (supported_colorspaces)
2235 		colorspaces = supported_colorspaces & hdmi_colorspaces;
2236 	else
2237 		colorspaces = hdmi_colorspaces;
2238 
2239 	return drm_mode_create_colorspace_property(connector, colorspaces);
2240 }
2241 EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
2242 
2243 /**
2244  * drm_mode_create_dp_colorspace_property - create dp colorspace property
2245  * @connector: connector to create the Colorspace property on.
2246  * @supported_colorspaces: bitmap of supported color spaces
2247  *
2248  * Called by a driver the first time it's needed, must be attached to desired
2249  * DP connectors.
2250  *
2251  * Returns:
2252  * Zero on success, negative errno on failure.
2253  */
2254 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector,
2255 					   u32 supported_colorspaces)
2256 {
2257 	u32 colorspaces;
2258 
2259 	if (supported_colorspaces)
2260 		colorspaces = supported_colorspaces & dp_colorspaces;
2261 	else
2262 		colorspaces = dp_colorspaces;
2263 
2264 	return drm_mode_create_colorspace_property(connector, colorspaces);
2265 }
2266 EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
2267 
2268 /**
2269  * drm_mode_create_content_type_property - create content type property
2270  * @dev: DRM device
2271  *
2272  * Called by a driver the first time it's needed, must be attached to desired
2273  * connectors.
2274  *
2275  * Returns:
2276  * Zero on success, negative errno on failure.
2277  */
2278 int drm_mode_create_content_type_property(struct drm_device *dev)
2279 {
2280 	if (dev->mode_config.content_type_property)
2281 		return 0;
2282 
2283 	dev->mode_config.content_type_property =
2284 		drm_property_create_enum(dev, 0, "content type",
2285 					 drm_content_type_enum_list,
2286 					 ARRAY_SIZE(drm_content_type_enum_list));
2287 
2288 	if (dev->mode_config.content_type_property == NULL)
2289 		return -ENOMEM;
2290 
2291 	return 0;
2292 }
2293 EXPORT_SYMBOL(drm_mode_create_content_type_property);
2294 
2295 /**
2296  * drm_mode_create_suggested_offset_properties - create suggests offset properties
2297  * @dev: DRM device
2298  *
2299  * Create the suggested x/y offset property for connectors.
2300  *
2301  * Returns:
2302  * 0 on success or a negative error code on failure.
2303  */
2304 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
2305 {
2306 	if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
2307 		return 0;
2308 
2309 	dev->mode_config.suggested_x_property =
2310 		drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
2311 
2312 	dev->mode_config.suggested_y_property =
2313 		drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
2314 
2315 	if (dev->mode_config.suggested_x_property == NULL ||
2316 	    dev->mode_config.suggested_y_property == NULL)
2317 		return -ENOMEM;
2318 	return 0;
2319 }
2320 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
2321 
2322 /**
2323  * drm_connector_set_path_property - set tile property on connector
2324  * @connector: connector to set property on.
2325  * @path: path to use for property; must not be NULL.
2326  *
2327  * This creates a property to expose to userspace to specify a
2328  * connector path. This is mainly used for DisplayPort MST where
2329  * connectors have a topology and we want to allow userspace to give
2330  * them more meaningful names.
2331  *
2332  * Returns:
2333  * Zero on success, negative errno on failure.
2334  */
2335 int drm_connector_set_path_property(struct drm_connector *connector,
2336 				    const char *path)
2337 {
2338 	struct drm_device *dev = connector->dev;
2339 	int ret;
2340 
2341 	ret = drm_property_replace_global_blob(dev,
2342 					       &connector->path_blob_ptr,
2343 					       strlen(path) + 1,
2344 					       path,
2345 					       &connector->base,
2346 					       dev->mode_config.path_property);
2347 	return ret;
2348 }
2349 EXPORT_SYMBOL(drm_connector_set_path_property);
2350 
2351 /**
2352  * drm_connector_set_tile_property - set tile property on connector
2353  * @connector: connector to set property on.
2354  *
2355  * This looks up the tile information for a connector, and creates a
2356  * property for userspace to parse if it exists. The property is of
2357  * the form of 8 integers using ':' as a separator.
2358  * This is used for dual port tiled displays with DisplayPort SST
2359  * or DisplayPort MST connectors.
2360  *
2361  * Returns:
2362  * Zero on success, errno on failure.
2363  */
2364 int drm_connector_set_tile_property(struct drm_connector *connector)
2365 {
2366 	struct drm_device *dev = connector->dev;
2367 	char tile[256];
2368 	int ret;
2369 
2370 	if (!connector->has_tile) {
2371 		ret  = drm_property_replace_global_blob(dev,
2372 							&connector->tile_blob_ptr,
2373 							0,
2374 							NULL,
2375 							&connector->base,
2376 							dev->mode_config.tile_property);
2377 		return ret;
2378 	}
2379 
2380 	snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
2381 		 connector->tile_group->id, connector->tile_is_single_monitor,
2382 		 connector->num_h_tile, connector->num_v_tile,
2383 		 connector->tile_h_loc, connector->tile_v_loc,
2384 		 connector->tile_h_size, connector->tile_v_size);
2385 
2386 	ret = drm_property_replace_global_blob(dev,
2387 					       &connector->tile_blob_ptr,
2388 					       strlen(tile) + 1,
2389 					       tile,
2390 					       &connector->base,
2391 					       dev->mode_config.tile_property);
2392 	return ret;
2393 }
2394 EXPORT_SYMBOL(drm_connector_set_tile_property);
2395 
2396 /**
2397  * drm_connector_set_link_status_property - Set link status property of a connector
2398  * @connector: drm connector
2399  * @link_status: new value of link status property (0: Good, 1: Bad)
2400  *
2401  * In usual working scenario, this link status property will always be set to
2402  * "GOOD". If something fails during or after a mode set, the kernel driver
2403  * may set this link status property to "BAD". The caller then needs to send a
2404  * hotplug uevent for userspace to re-check the valid modes through
2405  * GET_CONNECTOR_IOCTL and retry modeset.
2406  *
2407  * Note: Drivers cannot rely on userspace to support this property and
2408  * issue a modeset. As such, they may choose to handle issues (like
2409  * re-training a link) without userspace's intervention.
2410  *
2411  * The reason for adding this property is to handle link training failures, but
2412  * it is not limited to DP or link training. For example, if we implement
2413  * asynchronous setcrtc, this property can be used to report any failures in that.
2414  */
2415 void drm_connector_set_link_status_property(struct drm_connector *connector,
2416 					    uint64_t link_status)
2417 {
2418 	struct drm_device *dev = connector->dev;
2419 
2420 	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2421 	connector->state->link_status = link_status;
2422 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
2423 }
2424 EXPORT_SYMBOL(drm_connector_set_link_status_property);
2425 
2426 /**
2427  * drm_connector_attach_max_bpc_property - attach "max bpc" property
2428  * @connector: connector to attach max bpc property on.
2429  * @min: The minimum bit depth supported by the connector.
2430  * @max: The maximum bit depth supported by the connector.
2431  *
2432  * This is used to add support for limiting the bit depth on a connector.
2433  *
2434  * Returns:
2435  * Zero on success, negative errno on failure.
2436  */
2437 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2438 					  int min, int max)
2439 {
2440 	struct drm_device *dev = connector->dev;
2441 	struct drm_property *prop;
2442 
2443 	prop = connector->max_bpc_property;
2444 	if (!prop) {
2445 		prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2446 		if (!prop)
2447 			return -ENOMEM;
2448 
2449 		connector->max_bpc_property = prop;
2450 	}
2451 
2452 	drm_object_attach_property(&connector->base, prop, max);
2453 	connector->state->max_requested_bpc = max;
2454 	connector->state->max_bpc = max;
2455 
2456 	return 0;
2457 }
2458 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2459 
2460 /**
2461  * drm_connector_attach_hdr_output_metadata_property - attach "HDR_OUTPUT_METADA" property
2462  * @connector: connector to attach the property on.
2463  *
2464  * This is used to allow the userspace to send HDR Metadata to the
2465  * driver.
2466  *
2467  * Returns:
2468  * Zero on success, negative errno on failure.
2469  */
2470 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector)
2471 {
2472 	struct drm_device *dev = connector->dev;
2473 	struct drm_property *prop = dev->mode_config.hdr_output_metadata_property;
2474 
2475 	drm_object_attach_property(&connector->base, prop, 0);
2476 
2477 	return 0;
2478 }
2479 EXPORT_SYMBOL(drm_connector_attach_hdr_output_metadata_property);
2480 
2481 /**
2482  * drm_connector_attach_colorspace_property - attach "Colorspace" property
2483  * @connector: connector to attach the property on.
2484  *
2485  * This is used to allow the userspace to signal the output colorspace
2486  * to the driver.
2487  *
2488  * Returns:
2489  * Zero on success, negative errno on failure.
2490  */
2491 int drm_connector_attach_colorspace_property(struct drm_connector *connector)
2492 {
2493 	struct drm_property *prop = connector->colorspace_property;
2494 
2495 	drm_object_attach_property(&connector->base, prop, DRM_MODE_COLORIMETRY_DEFAULT);
2496 
2497 	return 0;
2498 }
2499 EXPORT_SYMBOL(drm_connector_attach_colorspace_property);
2500 
2501 /**
2502  * drm_connector_atomic_hdr_metadata_equal - checks if the hdr metadata changed
2503  * @old_state: old connector state to compare
2504  * @new_state: new connector state to compare
2505  *
2506  * This is used by HDR-enabled drivers to test whether the HDR metadata
2507  * have changed between two different connector state (and thus probably
2508  * requires a full blown mode change).
2509  *
2510  * Returns:
2511  * True if the metadata are equal, False otherwise
2512  */
2513 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
2514 					     struct drm_connector_state *new_state)
2515 {
2516 	struct drm_property_blob *old_blob = old_state->hdr_output_metadata;
2517 	struct drm_property_blob *new_blob = new_state->hdr_output_metadata;
2518 
2519 	if (!old_blob || !new_blob)
2520 		return old_blob == new_blob;
2521 
2522 	if (old_blob->length != new_blob->length)
2523 		return false;
2524 
2525 	return !memcmp(old_blob->data, new_blob->data, old_blob->length);
2526 }
2527 EXPORT_SYMBOL(drm_connector_atomic_hdr_metadata_equal);
2528 
2529 /**
2530  * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2531  * capable property for a connector
2532  * @connector: drm connector
2533  * @capable: True if the connector is variable refresh rate capable
2534  *
2535  * Should be used by atomic drivers to update the indicated support for
2536  * variable refresh rate over a connector.
2537  */
2538 void drm_connector_set_vrr_capable_property(
2539 		struct drm_connector *connector, bool capable)
2540 {
2541 	if (!connector->vrr_capable_property)
2542 		return;
2543 
2544 	drm_object_property_set_value(&connector->base,
2545 				      connector->vrr_capable_property,
2546 				      capable);
2547 }
2548 EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2549 
2550 /**
2551  * drm_connector_set_panel_orientation - sets the connector's panel_orientation
2552  * @connector: connector for which to set the panel-orientation property.
2553  * @panel_orientation: drm_panel_orientation value to set
2554  *
2555  * This function sets the connector's panel_orientation and attaches
2556  * a "panel orientation" property to the connector.
2557  *
2558  * Calling this function on a connector where the panel_orientation has
2559  * already been set is a no-op (e.g. the orientation has been overridden with
2560  * a kernel commandline option).
2561  *
2562  * It is allowed to call this function with a panel_orientation of
2563  * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2564  *
2565  * The function shouldn't be called in panel after drm is registered (i.e.
2566  * drm_dev_register() is called in drm).
2567  *
2568  * Returns:
2569  * Zero on success, negative errno on failure.
2570  */
2571 int drm_connector_set_panel_orientation(
2572 	struct drm_connector *connector,
2573 	enum drm_panel_orientation panel_orientation)
2574 {
2575 	struct drm_device *dev = connector->dev;
2576 	struct drm_display_info *info = &connector->display_info;
2577 	struct drm_property *prop;
2578 
2579 	/* Already set? */
2580 	if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2581 		return 0;
2582 
2583 	/* Don't attach the property if the orientation is unknown */
2584 	if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2585 		return 0;
2586 
2587 	info->panel_orientation = panel_orientation;
2588 
2589 	prop = dev->mode_config.panel_orientation_property;
2590 	if (!prop) {
2591 		prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2592 				"panel orientation",
2593 				drm_panel_orientation_enum_list,
2594 				ARRAY_SIZE(drm_panel_orientation_enum_list));
2595 		if (!prop)
2596 			return -ENOMEM;
2597 
2598 		dev->mode_config.panel_orientation_property = prop;
2599 	}
2600 
2601 	drm_object_attach_property(&connector->base, prop,
2602 				   info->panel_orientation);
2603 	return 0;
2604 }
2605 EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2606 
2607 /**
2608  * drm_connector_set_panel_orientation_with_quirk - set the
2609  *	connector's panel_orientation after checking for quirks
2610  * @connector: connector for which to init the panel-orientation property.
2611  * @panel_orientation: drm_panel_orientation value to set
2612  * @width: width in pixels of the panel, used for panel quirk detection
2613  * @height: height in pixels of the panel, used for panel quirk detection
2614  *
2615  * Like drm_connector_set_panel_orientation(), but with a check for platform
2616  * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2617  *
2618  * Returns:
2619  * Zero on success, negative errno on failure.
2620  */
2621 int drm_connector_set_panel_orientation_with_quirk(
2622 	struct drm_connector *connector,
2623 	enum drm_panel_orientation panel_orientation,
2624 	int width, int height)
2625 {
2626 	int orientation_quirk;
2627 
2628 	orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2629 	if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2630 		panel_orientation = orientation_quirk;
2631 
2632 	return drm_connector_set_panel_orientation(connector,
2633 						   panel_orientation);
2634 }
2635 EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2636 
2637 /**
2638  * drm_connector_set_orientation_from_panel -
2639  *	set the connector's panel_orientation from panel's callback.
2640  * @connector: connector for which to init the panel-orientation property.
2641  * @panel: panel that can provide orientation information.
2642  *
2643  * Drm drivers should call this function before drm_dev_register().
2644  * Orientation is obtained from panel's .get_orientation() callback.
2645  *
2646  * Returns:
2647  * Zero on success, negative errno on failure.
2648  */
2649 int drm_connector_set_orientation_from_panel(
2650 	struct drm_connector *connector,
2651 	struct drm_panel *panel)
2652 {
2653 	enum drm_panel_orientation orientation;
2654 
2655 	if (panel && panel->funcs && panel->funcs->get_orientation)
2656 		orientation = panel->funcs->get_orientation(panel);
2657 	else
2658 		orientation = DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
2659 
2660 	return drm_connector_set_panel_orientation(connector, orientation);
2661 }
2662 EXPORT_SYMBOL(drm_connector_set_orientation_from_panel);
2663 
2664 static const struct drm_prop_enum_list privacy_screen_enum[] = {
2665 	{ PRIVACY_SCREEN_DISABLED,		"Disabled" },
2666 	{ PRIVACY_SCREEN_ENABLED,		"Enabled" },
2667 	{ PRIVACY_SCREEN_DISABLED_LOCKED,	"Disabled-locked" },
2668 	{ PRIVACY_SCREEN_ENABLED_LOCKED,	"Enabled-locked" },
2669 };
2670 
2671 /**
2672  * drm_connector_create_privacy_screen_properties - create the drm connecter's
2673  *    privacy-screen properties.
2674  * @connector: connector for which to create the privacy-screen properties
2675  *
2676  * This function creates the "privacy-screen sw-state" and "privacy-screen
2677  * hw-state" properties for the connector. They are not attached.
2678  */
2679 void
2680 drm_connector_create_privacy_screen_properties(struct drm_connector *connector)
2681 {
2682 	if (connector->privacy_screen_sw_state_property)
2683 		return;
2684 
2685 	/* Note sw-state only supports the first 2 values of the enum */
2686 	connector->privacy_screen_sw_state_property =
2687 		drm_property_create_enum(connector->dev, DRM_MODE_PROP_ENUM,
2688 				"privacy-screen sw-state",
2689 				privacy_screen_enum, 2);
2690 
2691 	connector->privacy_screen_hw_state_property =
2692 		drm_property_create_enum(connector->dev,
2693 				DRM_MODE_PROP_IMMUTABLE | DRM_MODE_PROP_ENUM,
2694 				"privacy-screen hw-state",
2695 				privacy_screen_enum,
2696 				ARRAY_SIZE(privacy_screen_enum));
2697 }
2698 EXPORT_SYMBOL(drm_connector_create_privacy_screen_properties);
2699 
2700 /**
2701  * drm_connector_attach_privacy_screen_properties - attach the drm connecter's
2702  *    privacy-screen properties.
2703  * @connector: connector on which to attach the privacy-screen properties
2704  *
2705  * This function attaches the "privacy-screen sw-state" and "privacy-screen
2706  * hw-state" properties to the connector. The initial state of both is set
2707  * to "Disabled".
2708  */
2709 void
2710 drm_connector_attach_privacy_screen_properties(struct drm_connector *connector)
2711 {
2712 	if (!connector->privacy_screen_sw_state_property)
2713 		return;
2714 
2715 	drm_object_attach_property(&connector->base,
2716 				   connector->privacy_screen_sw_state_property,
2717 				   PRIVACY_SCREEN_DISABLED);
2718 
2719 	drm_object_attach_property(&connector->base,
2720 				   connector->privacy_screen_hw_state_property,
2721 				   PRIVACY_SCREEN_DISABLED);
2722 }
2723 EXPORT_SYMBOL(drm_connector_attach_privacy_screen_properties);
2724 
2725 static void drm_connector_update_privacy_screen_properties(
2726 	struct drm_connector *connector, bool set_sw_state)
2727 {
2728 	enum drm_privacy_screen_status sw_state, hw_state;
2729 
2730 	drm_privacy_screen_get_state(connector->privacy_screen,
2731 				     &sw_state, &hw_state);
2732 
2733 	if (set_sw_state)
2734 		connector->state->privacy_screen_sw_state = sw_state;
2735 	drm_object_property_set_value(&connector->base,
2736 			connector->privacy_screen_hw_state_property, hw_state);
2737 }
2738 
2739 static int drm_connector_privacy_screen_notifier(
2740 	struct notifier_block *nb, unsigned long action, void *data)
2741 {
2742 	struct drm_connector *connector =
2743 		container_of(nb, struct drm_connector, privacy_screen_notifier);
2744 	struct drm_device *dev = connector->dev;
2745 
2746 	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2747 	drm_connector_update_privacy_screen_properties(connector, true);
2748 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
2749 
2750 	drm_sysfs_connector_property_event(connector,
2751 					   connector->privacy_screen_sw_state_property);
2752 	drm_sysfs_connector_property_event(connector,
2753 					   connector->privacy_screen_hw_state_property);
2754 
2755 	return NOTIFY_DONE;
2756 }
2757 
2758 /**
2759  * drm_connector_attach_privacy_screen_provider - attach a privacy-screen to
2760  *    the connector
2761  * @connector: connector to attach the privacy-screen to
2762  * @priv: drm_privacy_screen to attach
2763  *
2764  * Create and attach the standard privacy-screen properties and register
2765  * a generic notifier for generating sysfs-connector-status-events
2766  * on external changes to the privacy-screen status.
2767  * This function takes ownership of the passed in drm_privacy_screen and will
2768  * call drm_privacy_screen_put() on it when the connector is destroyed.
2769  */
2770 void drm_connector_attach_privacy_screen_provider(
2771 	struct drm_connector *connector, struct drm_privacy_screen *priv)
2772 {
2773 	connector->privacy_screen = priv;
2774 	connector->privacy_screen_notifier.notifier_call =
2775 		drm_connector_privacy_screen_notifier;
2776 
2777 	drm_connector_create_privacy_screen_properties(connector);
2778 	drm_connector_update_privacy_screen_properties(connector, true);
2779 	drm_connector_attach_privacy_screen_properties(connector);
2780 }
2781 EXPORT_SYMBOL(drm_connector_attach_privacy_screen_provider);
2782 
2783 /**
2784  * drm_connector_update_privacy_screen - update connector's privacy-screen sw-state
2785  * @connector_state: connector-state to update the privacy-screen for
2786  *
2787  * This function calls drm_privacy_screen_set_sw_state() on the connector's
2788  * privacy-screen.
2789  *
2790  * If the connector has no privacy-screen, then this is a no-op.
2791  */
2792 void drm_connector_update_privacy_screen(const struct drm_connector_state *connector_state)
2793 {
2794 	struct drm_connector *connector = connector_state->connector;
2795 	int ret;
2796 
2797 	if (!connector->privacy_screen)
2798 		return;
2799 
2800 	ret = drm_privacy_screen_set_sw_state(connector->privacy_screen,
2801 					      connector_state->privacy_screen_sw_state);
2802 	if (ret) {
2803 		drm_err(connector->dev, "Error updating privacy-screen sw_state\n");
2804 		return;
2805 	}
2806 
2807 	/* The hw_state property value may have changed, update it. */
2808 	drm_connector_update_privacy_screen_properties(connector, false);
2809 }
2810 EXPORT_SYMBOL(drm_connector_update_privacy_screen);
2811 
2812 int drm_connector_set_obj_prop(struct drm_mode_object *obj,
2813 				    struct drm_property *property,
2814 				    uint64_t value)
2815 {
2816 	int ret = -EINVAL;
2817 	struct drm_connector *connector = obj_to_connector(obj);
2818 
2819 	/* Do DPMS ourselves */
2820 	if (property == connector->dev->mode_config.dpms_property) {
2821 		ret = (*connector->funcs->dpms)(connector, (int)value);
2822 	} else if (connector->funcs->set_property)
2823 		ret = connector->funcs->set_property(connector, property, value);
2824 
2825 	if (!ret)
2826 		drm_object_property_set_value(&connector->base, property, value);
2827 	return ret;
2828 }
2829 
2830 int drm_connector_property_set_ioctl(struct drm_device *dev,
2831 				     void *data, struct drm_file *file_priv)
2832 {
2833 	struct drm_mode_connector_set_property *conn_set_prop = data;
2834 	struct drm_mode_obj_set_property obj_set_prop = {
2835 		.value = conn_set_prop->value,
2836 		.prop_id = conn_set_prop->prop_id,
2837 		.obj_id = conn_set_prop->connector_id,
2838 		.obj_type = DRM_MODE_OBJECT_CONNECTOR
2839 	};
2840 
2841 	/* It does all the locking and checking we need */
2842 	return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
2843 }
2844 
2845 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2846 {
2847 	/* For atomic drivers only state objects are synchronously updated and
2848 	 * protected by modeset locks, so check those first.
2849 	 */
2850 	if (connector->state)
2851 		return connector->state->best_encoder;
2852 	return connector->encoder;
2853 }
2854 
2855 static bool
2856 drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2857 			     const struct list_head *modes,
2858 			     const struct drm_file *file_priv)
2859 {
2860 	/*
2861 	 * If user-space hasn't configured the driver to expose the stereo 3D
2862 	 * modes, don't expose them.
2863 	 */
2864 	if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2865 		return false;
2866 	/*
2867 	 * If user-space hasn't configured the driver to expose the modes
2868 	 * with aspect-ratio, don't expose them. However if such a mode
2869 	 * is unique, let it be exposed, but reset the aspect-ratio flags
2870 	 * while preparing the list of user-modes.
2871 	 */
2872 	if (!file_priv->aspect_ratio_allowed) {
2873 		const struct drm_display_mode *mode_itr;
2874 
2875 		list_for_each_entry(mode_itr, modes, head) {
2876 			if (mode_itr->expose_to_userspace &&
2877 			    drm_mode_match(mode_itr, mode,
2878 					   DRM_MODE_MATCH_TIMINGS |
2879 					   DRM_MODE_MATCH_CLOCK |
2880 					   DRM_MODE_MATCH_FLAGS |
2881 					   DRM_MODE_MATCH_3D_FLAGS))
2882 				return false;
2883 		}
2884 	}
2885 
2886 	return true;
2887 }
2888 
2889 int drm_mode_getconnector(struct drm_device *dev, void *data,
2890 			  struct drm_file *file_priv)
2891 {
2892 	struct drm_mode_get_connector *out_resp = data;
2893 	struct drm_connector *connector;
2894 	struct drm_encoder *encoder;
2895 	struct drm_display_mode *mode;
2896 	int mode_count = 0;
2897 	int encoders_count = 0;
2898 	int ret = 0;
2899 	int copied = 0;
2900 	struct drm_mode_modeinfo u_mode;
2901 	struct drm_mode_modeinfo __user *mode_ptr;
2902 	uint32_t __user *encoder_ptr;
2903 	bool is_current_master;
2904 
2905 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2906 		return -EOPNOTSUPP;
2907 
2908 	memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2909 
2910 	connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2911 	if (!connector)
2912 		return -ENOENT;
2913 
2914 	encoders_count = hweight32(connector->possible_encoders);
2915 
2916 	if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2917 		copied = 0;
2918 		encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2919 
2920 		drm_connector_for_each_possible_encoder(connector, encoder) {
2921 			if (put_user(encoder->base.id, encoder_ptr + copied)) {
2922 				ret = -EFAULT;
2923 				goto out;
2924 			}
2925 			copied++;
2926 		}
2927 	}
2928 	out_resp->count_encoders = encoders_count;
2929 
2930 	out_resp->connector_id = connector->base.id;
2931 	out_resp->connector_type = connector->connector_type;
2932 	out_resp->connector_type_id = connector->connector_type_id;
2933 
2934 	is_current_master = drm_is_current_master(file_priv);
2935 
2936 	mutex_lock(&dev->mode_config.mutex);
2937 	if (out_resp->count_modes == 0) {
2938 		if (is_current_master)
2939 			connector->funcs->fill_modes(connector,
2940 						     dev->mode_config.max_width,
2941 						     dev->mode_config.max_height);
2942 		else
2943 			drm_dbg_kms(dev, "User-space requested a forced probe on [CONNECTOR:%d:%s] but is not the DRM master, demoting to read-only probe",
2944 				    connector->base.id, connector->name);
2945 	}
2946 
2947 	out_resp->mm_width = connector->display_info.width_mm;
2948 	out_resp->mm_height = connector->display_info.height_mm;
2949 	out_resp->subpixel = connector->display_info.subpixel_order;
2950 	out_resp->connection = connector->status;
2951 
2952 	/* delayed so we get modes regardless of pre-fill_modes state */
2953 	list_for_each_entry(mode, &connector->modes, head) {
2954 		WARN_ON(mode->expose_to_userspace);
2955 
2956 		if (drm_mode_expose_to_userspace(mode, &connector->modes,
2957 						 file_priv)) {
2958 			mode->expose_to_userspace = true;
2959 			mode_count++;
2960 		}
2961 	}
2962 
2963 	/*
2964 	 * This ioctl is called twice, once to determine how much space is
2965 	 * needed, and the 2nd time to fill it.
2966 	 */
2967 	if ((out_resp->count_modes >= mode_count) && mode_count) {
2968 		copied = 0;
2969 		mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2970 		list_for_each_entry(mode, &connector->modes, head) {
2971 			if (!mode->expose_to_userspace)
2972 				continue;
2973 
2974 			/* Clear the tag for the next time around */
2975 			mode->expose_to_userspace = false;
2976 
2977 			drm_mode_convert_to_umode(&u_mode, mode);
2978 			/*
2979 			 * Reset aspect ratio flags of user-mode, if modes with
2980 			 * aspect-ratio are not supported.
2981 			 */
2982 			if (!file_priv->aspect_ratio_allowed)
2983 				u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2984 			if (copy_to_user(mode_ptr + copied,
2985 					 &u_mode, sizeof(u_mode))) {
2986 				ret = -EFAULT;
2987 
2988 				/*
2989 				 * Clear the tag for the rest of
2990 				 * the modes for the next time around.
2991 				 */
2992 				list_for_each_entry_continue(mode, &connector->modes, head)
2993 					mode->expose_to_userspace = false;
2994 
2995 				mutex_unlock(&dev->mode_config.mutex);
2996 
2997 				goto out;
2998 			}
2999 			copied++;
3000 		}
3001 	} else {
3002 		/* Clear the tag for the next time around */
3003 		list_for_each_entry(mode, &connector->modes, head)
3004 			mode->expose_to_userspace = false;
3005 	}
3006 
3007 	out_resp->count_modes = mode_count;
3008 	mutex_unlock(&dev->mode_config.mutex);
3009 
3010 	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
3011 	encoder = drm_connector_get_encoder(connector);
3012 	if (encoder)
3013 		out_resp->encoder_id = encoder->base.id;
3014 	else
3015 		out_resp->encoder_id = 0;
3016 
3017 	/* Only grab properties after probing, to make sure EDID and other
3018 	 * properties reflect the latest status.
3019 	 */
3020 	ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
3021 			(uint32_t __user *)(unsigned long)(out_resp->props_ptr),
3022 			(uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
3023 			&out_resp->count_props);
3024 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
3025 
3026 out:
3027 	drm_connector_put(connector);
3028 
3029 	return ret;
3030 }
3031 
3032 /**
3033  * drm_connector_find_by_fwnode - Find a connector based on the associated fwnode
3034  * @fwnode: fwnode for which to find the matching drm_connector
3035  *
3036  * This functions looks up a drm_connector based on its associated fwnode. When
3037  * a connector is found a reference to the connector is returned. The caller must
3038  * call drm_connector_put() to release this reference when it is done with the
3039  * connector.
3040  *
3041  * Returns: A reference to the found connector or an ERR_PTR().
3042  */
3043 struct drm_connector *drm_connector_find_by_fwnode(struct fwnode_handle *fwnode)
3044 {
3045 	struct drm_connector *connector, *found = ERR_PTR(-ENODEV);
3046 
3047 	if (!fwnode)
3048 		return ERR_PTR(-ENODEV);
3049 
3050 	mutex_lock(&connector_list_lock);
3051 
3052 	list_for_each_entry(connector, &connector_list, global_connector_list_entry) {
3053 		if (connector->fwnode == fwnode ||
3054 		    (connector->fwnode && connector->fwnode->secondary == fwnode)) {
3055 			drm_connector_get(connector);
3056 			found = connector;
3057 			break;
3058 		}
3059 	}
3060 
3061 	mutex_unlock(&connector_list_lock);
3062 
3063 	return found;
3064 }
3065 
3066 /**
3067  * drm_connector_oob_hotplug_event - Report out-of-band hotplug event to connector
3068  * @connector_fwnode: fwnode_handle to report the event on
3069  * @status: hot plug detect logical state
3070  *
3071  * On some hardware a hotplug event notification may come from outside the display
3072  * driver / device. An example of this is some USB Type-C setups where the hardware
3073  * muxes the DisplayPort data and aux-lines but does not pass the altmode HPD
3074  * status bit to the GPU's DP HPD pin.
3075  *
3076  * This function can be used to report these out-of-band events after obtaining
3077  * a drm_connector reference through calling drm_connector_find_by_fwnode().
3078  */
3079 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode,
3080 				     enum drm_connector_status status)
3081 {
3082 	struct drm_connector *connector;
3083 
3084 	connector = drm_connector_find_by_fwnode(connector_fwnode);
3085 	if (IS_ERR(connector))
3086 		return;
3087 
3088 	if (connector->funcs->oob_hotplug_event)
3089 		connector->funcs->oob_hotplug_event(connector, status);
3090 
3091 	drm_connector_put(connector);
3092 }
3093 EXPORT_SYMBOL(drm_connector_oob_hotplug_event);
3094 
3095 
3096 /**
3097  * DOC: Tile group
3098  *
3099  * Tile groups are used to represent tiled monitors with a unique integer
3100  * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
3101  * we store this in a tile group, so we have a common identifier for all tiles
3102  * in a monitor group. The property is called "TILE". Drivers can manage tile
3103  * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
3104  * drm_mode_get_tile_group(). But this is only needed for internal panels where
3105  * the tile group information is exposed through a non-standard way.
3106  */
3107 
3108 static void drm_tile_group_free(struct kref *kref)
3109 {
3110 	struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
3111 	struct drm_device *dev = tg->dev;
3112 
3113 	mutex_lock(&dev->mode_config.idr_mutex);
3114 	idr_remove(&dev->mode_config.tile_idr, tg->id);
3115 	mutex_unlock(&dev->mode_config.idr_mutex);
3116 	kfree(tg);
3117 }
3118 
3119 /**
3120  * drm_mode_put_tile_group - drop a reference to a tile group.
3121  * @dev: DRM device
3122  * @tg: tile group to drop reference to.
3123  *
3124  * drop reference to tile group and free if 0.
3125  */
3126 void drm_mode_put_tile_group(struct drm_device *dev,
3127 			     struct drm_tile_group *tg)
3128 {
3129 	kref_put(&tg->refcount, drm_tile_group_free);
3130 }
3131 EXPORT_SYMBOL(drm_mode_put_tile_group);
3132 
3133 /**
3134  * drm_mode_get_tile_group - get a reference to an existing tile group
3135  * @dev: DRM device
3136  * @topology: 8-bytes unique per monitor.
3137  *
3138  * Use the unique bytes to get a reference to an existing tile group.
3139  *
3140  * RETURNS:
3141  * tile group or NULL if not found.
3142  */
3143 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
3144 					       const char topology[8])
3145 {
3146 	struct drm_tile_group *tg;
3147 	int id;
3148 
3149 	mutex_lock(&dev->mode_config.idr_mutex);
3150 	idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
3151 		if (!memcmp(tg->group_data, topology, 8)) {
3152 			if (!kref_get_unless_zero(&tg->refcount))
3153 				tg = NULL;
3154 			mutex_unlock(&dev->mode_config.idr_mutex);
3155 			return tg;
3156 		}
3157 	}
3158 	mutex_unlock(&dev->mode_config.idr_mutex);
3159 	return NULL;
3160 }
3161 EXPORT_SYMBOL(drm_mode_get_tile_group);
3162 
3163 /**
3164  * drm_mode_create_tile_group - create a tile group from a displayid description
3165  * @dev: DRM device
3166  * @topology: 8-bytes unique per monitor.
3167  *
3168  * Create a tile group for the unique monitor, and get a unique
3169  * identifier for the tile group.
3170  *
3171  * RETURNS:
3172  * new tile group or NULL.
3173  */
3174 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
3175 						  const char topology[8])
3176 {
3177 	struct drm_tile_group *tg;
3178 	int ret;
3179 
3180 	tg = kzalloc(sizeof(*tg), GFP_KERNEL);
3181 	if (!tg)
3182 		return NULL;
3183 
3184 	kref_init(&tg->refcount);
3185 	memcpy(tg->group_data, topology, 8);
3186 	tg->dev = dev;
3187 
3188 	mutex_lock(&dev->mode_config.idr_mutex);
3189 	ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
3190 	if (ret >= 0) {
3191 		tg->id = ret;
3192 	} else {
3193 		kfree(tg);
3194 		tg = NULL;
3195 	}
3196 
3197 	mutex_unlock(&dev->mode_config.idr_mutex);
3198 	return tg;
3199 }
3200 EXPORT_SYMBOL(drm_mode_create_tile_group);
3201