xref: /openbmc/linux/drivers/gpu/drm/drm_connector.c (revision cfbb9be8)
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/drmP.h>
24 #include <drm/drm_connector.h>
25 #include <drm/drm_edid.h>
26 #include <drm/drm_encoder.h>
27 #include <drm/drm_utils.h>
28 
29 #include "drm_crtc_internal.h"
30 #include "drm_internal.h"
31 
32 /**
33  * DOC: overview
34  *
35  * In DRM connectors are the general abstraction for display sinks, and include
36  * als fixed panels or anything else that can display pixels in some form. As
37  * opposed to all other KMS objects representing hardware (like CRTC, encoder or
38  * plane abstractions) connectors can be hotplugged and unplugged at runtime.
39  * Hence they are reference-counted using drm_connector_get() and
40  * drm_connector_put().
41  *
42  * KMS driver must create, initialize, register and attach at a &struct
43  * drm_connector for each such sink. The instance is created as other KMS
44  * objects and initialized by setting the following fields. The connector is
45  * initialized with a call to drm_connector_init() with a pointer to the
46  * &struct drm_connector_funcs and a connector type, and then exposed to
47  * userspace with a call to drm_connector_register().
48  *
49  * Connectors must be attached to an encoder to be used. For devices that map
50  * connectors to encoders 1:1, the connector should be attached at
51  * initialization time with a call to drm_mode_connector_attach_encoder(). The
52  * driver must also set the &drm_connector.encoder field to point to the
53  * attached encoder.
54  *
55  * For connectors which are not fixed (like built-in panels) the driver needs to
56  * support hotplug notifications. The simplest way to do that is by using the
57  * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
58  * hardware support for hotplug interrupts. Connectors with hardware hotplug
59  * support can instead use e.g. drm_helper_hpd_irq_event().
60  */
61 
62 struct drm_conn_prop_enum_list {
63 	int type;
64 	const char *name;
65 	struct ida ida;
66 };
67 
68 /*
69  * Connector and encoder types.
70  */
71 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
72 	{ DRM_MODE_CONNECTOR_Unknown, "Unknown" },
73 	{ DRM_MODE_CONNECTOR_VGA, "VGA" },
74 	{ DRM_MODE_CONNECTOR_DVII, "DVI-I" },
75 	{ DRM_MODE_CONNECTOR_DVID, "DVI-D" },
76 	{ DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
77 	{ DRM_MODE_CONNECTOR_Composite, "Composite" },
78 	{ DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
79 	{ DRM_MODE_CONNECTOR_LVDS, "LVDS" },
80 	{ DRM_MODE_CONNECTOR_Component, "Component" },
81 	{ DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
82 	{ DRM_MODE_CONNECTOR_DisplayPort, "DP" },
83 	{ DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
84 	{ DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
85 	{ DRM_MODE_CONNECTOR_TV, "TV" },
86 	{ DRM_MODE_CONNECTOR_eDP, "eDP" },
87 	{ DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
88 	{ DRM_MODE_CONNECTOR_DSI, "DSI" },
89 	{ DRM_MODE_CONNECTOR_DPI, "DPI" },
90 };
91 
92 void drm_connector_ida_init(void)
93 {
94 	int i;
95 
96 	for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
97 		ida_init(&drm_connector_enum_list[i].ida);
98 }
99 
100 void drm_connector_ida_destroy(void)
101 {
102 	int i;
103 
104 	for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
105 		ida_destroy(&drm_connector_enum_list[i].ida);
106 }
107 
108 /**
109  * drm_connector_get_cmdline_mode - reads the user's cmdline mode
110  * @connector: connector to quwery
111  *
112  * The kernel supports per-connector configuration of its consoles through
113  * use of the video= parameter. This function parses that option and
114  * extracts the user's specified mode (or enable/disable status) for a
115  * particular connector. This is typically only used during the early fbdev
116  * setup.
117  */
118 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
119 {
120 	struct drm_cmdline_mode *mode = &connector->cmdline_mode;
121 	char *option = NULL;
122 
123 	if (fb_get_options(connector->name, &option))
124 		return;
125 
126 	if (!drm_mode_parse_command_line_for_connector(option,
127 						       connector,
128 						       mode))
129 		return;
130 
131 	if (mode->force) {
132 		DRM_INFO("forcing %s connector %s\n", connector->name,
133 			 drm_get_connector_force_name(mode->force));
134 		connector->force = mode->force;
135 	}
136 
137 	DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
138 		      connector->name,
139 		      mode->xres, mode->yres,
140 		      mode->refresh_specified ? mode->refresh : 60,
141 		      mode->rb ? " reduced blanking" : "",
142 		      mode->margins ? " with margins" : "",
143 		      mode->interlace ?  " interlaced" : "");
144 }
145 
146 static void drm_connector_free(struct kref *kref)
147 {
148 	struct drm_connector *connector =
149 		container_of(kref, struct drm_connector, base.refcount);
150 	struct drm_device *dev = connector->dev;
151 
152 	drm_mode_object_unregister(dev, &connector->base);
153 	connector->funcs->destroy(connector);
154 }
155 
156 void drm_connector_free_work_fn(struct work_struct *work)
157 {
158 	struct drm_connector *connector, *n;
159 	struct drm_device *dev =
160 		container_of(work, struct drm_device, mode_config.connector_free_work);
161 	struct drm_mode_config *config = &dev->mode_config;
162 	unsigned long flags;
163 	struct llist_node *freed;
164 
165 	spin_lock_irqsave(&config->connector_list_lock, flags);
166 	freed = llist_del_all(&config->connector_free_list);
167 	spin_unlock_irqrestore(&config->connector_list_lock, flags);
168 
169 	llist_for_each_entry_safe(connector, n, freed, free_node) {
170 		drm_mode_object_unregister(dev, &connector->base);
171 		connector->funcs->destroy(connector);
172 	}
173 }
174 
175 /**
176  * drm_connector_init - Init a preallocated connector
177  * @dev: DRM device
178  * @connector: the connector to init
179  * @funcs: callbacks for this connector
180  * @connector_type: user visible type of the connector
181  *
182  * Initialises a preallocated connector. Connectors should be
183  * subclassed as part of driver connector objects.
184  *
185  * Returns:
186  * Zero on success, error code on failure.
187  */
188 int drm_connector_init(struct drm_device *dev,
189 		       struct drm_connector *connector,
190 		       const struct drm_connector_funcs *funcs,
191 		       int connector_type)
192 {
193 	struct drm_mode_config *config = &dev->mode_config;
194 	int ret;
195 	struct ida *connector_ida =
196 		&drm_connector_enum_list[connector_type].ida;
197 
198 	ret = __drm_mode_object_add(dev, &connector->base,
199 				    DRM_MODE_OBJECT_CONNECTOR,
200 				    false, drm_connector_free);
201 	if (ret)
202 		return ret;
203 
204 	connector->base.properties = &connector->properties;
205 	connector->dev = dev;
206 	connector->funcs = funcs;
207 
208 	ret = ida_simple_get(&config->connector_ida, 0, 0, GFP_KERNEL);
209 	if (ret < 0)
210 		goto out_put;
211 	connector->index = ret;
212 	ret = 0;
213 
214 	connector->connector_type = connector_type;
215 	connector->connector_type_id =
216 		ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
217 	if (connector->connector_type_id < 0) {
218 		ret = connector->connector_type_id;
219 		goto out_put_id;
220 	}
221 	connector->name =
222 		kasprintf(GFP_KERNEL, "%s-%d",
223 			  drm_connector_enum_list[connector_type].name,
224 			  connector->connector_type_id);
225 	if (!connector->name) {
226 		ret = -ENOMEM;
227 		goto out_put_type_id;
228 	}
229 
230 	INIT_LIST_HEAD(&connector->probed_modes);
231 	INIT_LIST_HEAD(&connector->modes);
232 	mutex_init(&connector->mutex);
233 	connector->edid_blob_ptr = NULL;
234 	connector->status = connector_status_unknown;
235 	connector->display_info.panel_orientation =
236 		DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
237 
238 	drm_connector_get_cmdline_mode(connector);
239 
240 	/* We should add connectors at the end to avoid upsetting the connector
241 	 * index too much. */
242 	spin_lock_irq(&config->connector_list_lock);
243 	list_add_tail(&connector->head, &config->connector_list);
244 	config->num_connector++;
245 	spin_unlock_irq(&config->connector_list_lock);
246 
247 	if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
248 		drm_object_attach_property(&connector->base,
249 					      config->edid_property,
250 					      0);
251 
252 	drm_object_attach_property(&connector->base,
253 				      config->dpms_property, 0);
254 
255 	drm_object_attach_property(&connector->base,
256 				   config->link_status_property,
257 				   0);
258 
259 	drm_object_attach_property(&connector->base,
260 				   config->non_desktop_property,
261 				   0);
262 
263 	if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
264 		drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
265 	}
266 
267 	connector->debugfs_entry = NULL;
268 out_put_type_id:
269 	if (ret)
270 		ida_simple_remove(connector_ida, connector->connector_type_id);
271 out_put_id:
272 	if (ret)
273 		ida_simple_remove(&config->connector_ida, connector->index);
274 out_put:
275 	if (ret)
276 		drm_mode_object_unregister(dev, &connector->base);
277 
278 	return ret;
279 }
280 EXPORT_SYMBOL(drm_connector_init);
281 
282 /**
283  * drm_mode_connector_attach_encoder - attach a connector to an encoder
284  * @connector: connector to attach
285  * @encoder: encoder to attach @connector to
286  *
287  * This function links up a connector to an encoder. Note that the routing
288  * restrictions between encoders and crtcs are exposed to userspace through the
289  * possible_clones and possible_crtcs bitmasks.
290  *
291  * Returns:
292  * Zero on success, negative errno on failure.
293  */
294 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
295 				      struct drm_encoder *encoder)
296 {
297 	int i;
298 
299 	/*
300 	 * In the past, drivers have attempted to model the static association
301 	 * of connector to encoder in simple connector/encoder devices using a
302 	 * direct assignment of connector->encoder = encoder. This connection
303 	 * is a logical one and the responsibility of the core, so drivers are
304 	 * expected not to mess with this.
305 	 *
306 	 * Note that the error return should've been enough here, but a large
307 	 * majority of drivers ignores the return value, so add in a big WARN
308 	 * to get people's attention.
309 	 */
310 	if (WARN_ON(connector->encoder))
311 		return -EINVAL;
312 
313 	for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
314 		if (connector->encoder_ids[i] == 0) {
315 			connector->encoder_ids[i] = encoder->base.id;
316 			return 0;
317 		}
318 	}
319 	return -ENOMEM;
320 }
321 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
322 
323 static void drm_mode_remove(struct drm_connector *connector,
324 			    struct drm_display_mode *mode)
325 {
326 	list_del(&mode->head);
327 	drm_mode_destroy(connector->dev, mode);
328 }
329 
330 /**
331  * drm_connector_cleanup - cleans up an initialised connector
332  * @connector: connector to cleanup
333  *
334  * Cleans up the connector but doesn't free the object.
335  */
336 void drm_connector_cleanup(struct drm_connector *connector)
337 {
338 	struct drm_device *dev = connector->dev;
339 	struct drm_display_mode *mode, *t;
340 
341 	/* The connector should have been removed from userspace long before
342 	 * it is finally destroyed.
343 	 */
344 	if (WARN_ON(connector->registered))
345 		drm_connector_unregister(connector);
346 
347 	if (connector->tile_group) {
348 		drm_mode_put_tile_group(dev, connector->tile_group);
349 		connector->tile_group = NULL;
350 	}
351 
352 	list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
353 		drm_mode_remove(connector, mode);
354 
355 	list_for_each_entry_safe(mode, t, &connector->modes, head)
356 		drm_mode_remove(connector, mode);
357 
358 	ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
359 			  connector->connector_type_id);
360 
361 	ida_simple_remove(&dev->mode_config.connector_ida,
362 			  connector->index);
363 
364 	kfree(connector->display_info.bus_formats);
365 	drm_mode_object_unregister(dev, &connector->base);
366 	kfree(connector->name);
367 	connector->name = NULL;
368 	spin_lock_irq(&dev->mode_config.connector_list_lock);
369 	list_del(&connector->head);
370 	dev->mode_config.num_connector--;
371 	spin_unlock_irq(&dev->mode_config.connector_list_lock);
372 
373 	WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
374 	if (connector->state && connector->funcs->atomic_destroy_state)
375 		connector->funcs->atomic_destroy_state(connector,
376 						       connector->state);
377 
378 	mutex_destroy(&connector->mutex);
379 
380 	memset(connector, 0, sizeof(*connector));
381 }
382 EXPORT_SYMBOL(drm_connector_cleanup);
383 
384 /**
385  * drm_connector_register - register a connector
386  * @connector: the connector to register
387  *
388  * Register userspace interfaces for a connector
389  *
390  * Returns:
391  * Zero on success, error code on failure.
392  */
393 int drm_connector_register(struct drm_connector *connector)
394 {
395 	int ret = 0;
396 
397 	if (!connector->dev->registered)
398 		return 0;
399 
400 	mutex_lock(&connector->mutex);
401 	if (connector->registered)
402 		goto unlock;
403 
404 	ret = drm_sysfs_connector_add(connector);
405 	if (ret)
406 		goto unlock;
407 
408 	ret = drm_debugfs_connector_add(connector);
409 	if (ret) {
410 		goto err_sysfs;
411 	}
412 
413 	if (connector->funcs->late_register) {
414 		ret = connector->funcs->late_register(connector);
415 		if (ret)
416 			goto err_debugfs;
417 	}
418 
419 	drm_mode_object_register(connector->dev, &connector->base);
420 
421 	connector->registered = true;
422 	goto unlock;
423 
424 err_debugfs:
425 	drm_debugfs_connector_remove(connector);
426 err_sysfs:
427 	drm_sysfs_connector_remove(connector);
428 unlock:
429 	mutex_unlock(&connector->mutex);
430 	return ret;
431 }
432 EXPORT_SYMBOL(drm_connector_register);
433 
434 /**
435  * drm_connector_unregister - unregister a connector
436  * @connector: the connector to unregister
437  *
438  * Unregister userspace interfaces for a connector
439  */
440 void drm_connector_unregister(struct drm_connector *connector)
441 {
442 	mutex_lock(&connector->mutex);
443 	if (!connector->registered) {
444 		mutex_unlock(&connector->mutex);
445 		return;
446 	}
447 
448 	if (connector->funcs->early_unregister)
449 		connector->funcs->early_unregister(connector);
450 
451 	drm_sysfs_connector_remove(connector);
452 	drm_debugfs_connector_remove(connector);
453 
454 	connector->registered = false;
455 	mutex_unlock(&connector->mutex);
456 }
457 EXPORT_SYMBOL(drm_connector_unregister);
458 
459 void drm_connector_unregister_all(struct drm_device *dev)
460 {
461 	struct drm_connector *connector;
462 	struct drm_connector_list_iter conn_iter;
463 
464 	drm_connector_list_iter_begin(dev, &conn_iter);
465 	drm_for_each_connector_iter(connector, &conn_iter)
466 		drm_connector_unregister(connector);
467 	drm_connector_list_iter_end(&conn_iter);
468 }
469 
470 int drm_connector_register_all(struct drm_device *dev)
471 {
472 	struct drm_connector *connector;
473 	struct drm_connector_list_iter conn_iter;
474 	int ret = 0;
475 
476 	drm_connector_list_iter_begin(dev, &conn_iter);
477 	drm_for_each_connector_iter(connector, &conn_iter) {
478 		ret = drm_connector_register(connector);
479 		if (ret)
480 			break;
481 	}
482 	drm_connector_list_iter_end(&conn_iter);
483 
484 	if (ret)
485 		drm_connector_unregister_all(dev);
486 	return ret;
487 }
488 
489 /**
490  * drm_get_connector_status_name - return a string for connector status
491  * @status: connector status to compute name of
492  *
493  * In contrast to the other drm_get_*_name functions this one here returns a
494  * const pointer and hence is threadsafe.
495  */
496 const char *drm_get_connector_status_name(enum drm_connector_status status)
497 {
498 	if (status == connector_status_connected)
499 		return "connected";
500 	else if (status == connector_status_disconnected)
501 		return "disconnected";
502 	else
503 		return "unknown";
504 }
505 EXPORT_SYMBOL(drm_get_connector_status_name);
506 
507 /**
508  * drm_get_connector_force_name - return a string for connector force
509  * @force: connector force to get name of
510  *
511  * Returns: const pointer to name.
512  */
513 const char *drm_get_connector_force_name(enum drm_connector_force force)
514 {
515 	switch (force) {
516 	case DRM_FORCE_UNSPECIFIED:
517 		return "unspecified";
518 	case DRM_FORCE_OFF:
519 		return "off";
520 	case DRM_FORCE_ON:
521 		return "on";
522 	case DRM_FORCE_ON_DIGITAL:
523 		return "digital";
524 	default:
525 		return "unknown";
526 	}
527 }
528 
529 #ifdef CONFIG_LOCKDEP
530 static struct lockdep_map connector_list_iter_dep_map = {
531 	.name = "drm_connector_list_iter"
532 };
533 #endif
534 
535 /**
536  * drm_connector_list_iter_begin - initialize a connector_list iterator
537  * @dev: DRM device
538  * @iter: connector_list iterator
539  *
540  * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
541  * must always be cleaned up again by calling drm_connector_list_iter_end().
542  * Iteration itself happens using drm_connector_list_iter_next() or
543  * drm_for_each_connector_iter().
544  */
545 void drm_connector_list_iter_begin(struct drm_device *dev,
546 				   struct drm_connector_list_iter *iter)
547 {
548 	iter->dev = dev;
549 	iter->conn = NULL;
550 	lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
551 }
552 EXPORT_SYMBOL(drm_connector_list_iter_begin);
553 
554 /*
555  * Extra-safe connector put function that works in any context. Should only be
556  * used from the connector_iter functions, where we never really expect to
557  * actually release the connector when dropping our final reference.
558  */
559 static void
560 __drm_connector_put_safe(struct drm_connector *conn)
561 {
562 	struct drm_mode_config *config = &conn->dev->mode_config;
563 
564 	lockdep_assert_held(&config->connector_list_lock);
565 
566 	if (!refcount_dec_and_test(&conn->base.refcount.refcount))
567 		return;
568 
569 	llist_add(&conn->free_node, &config->connector_free_list);
570 	schedule_work(&config->connector_free_work);
571 }
572 
573 /**
574  * drm_connector_list_iter_next - return next connector
575  * @iter: connectr_list iterator
576  *
577  * Returns the next connector for @iter, or NULL when the list walk has
578  * completed.
579  */
580 struct drm_connector *
581 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
582 {
583 	struct drm_connector *old_conn = iter->conn;
584 	struct drm_mode_config *config = &iter->dev->mode_config;
585 	struct list_head *lhead;
586 	unsigned long flags;
587 
588 	spin_lock_irqsave(&config->connector_list_lock, flags);
589 	lhead = old_conn ? &old_conn->head : &config->connector_list;
590 
591 	do {
592 		if (lhead->next == &config->connector_list) {
593 			iter->conn = NULL;
594 			break;
595 		}
596 
597 		lhead = lhead->next;
598 		iter->conn = list_entry(lhead, struct drm_connector, head);
599 
600 		/* loop until it's not a zombie connector */
601 	} while (!kref_get_unless_zero(&iter->conn->base.refcount));
602 
603 	if (old_conn)
604 		__drm_connector_put_safe(old_conn);
605 	spin_unlock_irqrestore(&config->connector_list_lock, flags);
606 
607 	return iter->conn;
608 }
609 EXPORT_SYMBOL(drm_connector_list_iter_next);
610 
611 /**
612  * drm_connector_list_iter_end - tear down a connector_list iterator
613  * @iter: connector_list iterator
614  *
615  * Tears down @iter and releases any resources (like &drm_connector references)
616  * acquired while walking the list. This must always be called, both when the
617  * iteration completes fully or when it was aborted without walking the entire
618  * list.
619  */
620 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
621 {
622 	struct drm_mode_config *config = &iter->dev->mode_config;
623 	unsigned long flags;
624 
625 	iter->dev = NULL;
626 	if (iter->conn) {
627 		spin_lock_irqsave(&config->connector_list_lock, flags);
628 		__drm_connector_put_safe(iter->conn);
629 		spin_unlock_irqrestore(&config->connector_list_lock, flags);
630 	}
631 	lock_release(&connector_list_iter_dep_map, 0, _RET_IP_);
632 }
633 EXPORT_SYMBOL(drm_connector_list_iter_end);
634 
635 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
636 	{ SubPixelUnknown, "Unknown" },
637 	{ SubPixelHorizontalRGB, "Horizontal RGB" },
638 	{ SubPixelHorizontalBGR, "Horizontal BGR" },
639 	{ SubPixelVerticalRGB, "Vertical RGB" },
640 	{ SubPixelVerticalBGR, "Vertical BGR" },
641 	{ SubPixelNone, "None" },
642 };
643 
644 /**
645  * drm_get_subpixel_order_name - return a string for a given subpixel enum
646  * @order: enum of subpixel_order
647  *
648  * Note you could abuse this and return something out of bounds, but that
649  * would be a caller error.  No unscrubbed user data should make it here.
650  */
651 const char *drm_get_subpixel_order_name(enum subpixel_order order)
652 {
653 	return drm_subpixel_enum_list[order].name;
654 }
655 EXPORT_SYMBOL(drm_get_subpixel_order_name);
656 
657 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
658 	{ DRM_MODE_DPMS_ON, "On" },
659 	{ DRM_MODE_DPMS_STANDBY, "Standby" },
660 	{ DRM_MODE_DPMS_SUSPEND, "Suspend" },
661 	{ DRM_MODE_DPMS_OFF, "Off" }
662 };
663 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
664 
665 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
666 	{ DRM_MODE_LINK_STATUS_GOOD, "Good" },
667 	{ DRM_MODE_LINK_STATUS_BAD, "Bad" },
668 };
669 
670 /**
671  * drm_display_info_set_bus_formats - set the supported bus formats
672  * @info: display info to store bus formats in
673  * @formats: array containing the supported bus formats
674  * @num_formats: the number of entries in the fmts array
675  *
676  * Store the supported bus formats in display info structure.
677  * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
678  * a full list of available formats.
679  */
680 int drm_display_info_set_bus_formats(struct drm_display_info *info,
681 				     const u32 *formats,
682 				     unsigned int num_formats)
683 {
684 	u32 *fmts = NULL;
685 
686 	if (!formats && num_formats)
687 		return -EINVAL;
688 
689 	if (formats && num_formats) {
690 		fmts = kmemdup(formats, sizeof(*formats) * num_formats,
691 			       GFP_KERNEL);
692 		if (!fmts)
693 			return -ENOMEM;
694 	}
695 
696 	kfree(info->bus_formats);
697 	info->bus_formats = fmts;
698 	info->num_bus_formats = num_formats;
699 
700 	return 0;
701 }
702 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
703 
704 /* Optional connector properties. */
705 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
706 	{ DRM_MODE_SCALE_NONE, "None" },
707 	{ DRM_MODE_SCALE_FULLSCREEN, "Full" },
708 	{ DRM_MODE_SCALE_CENTER, "Center" },
709 	{ DRM_MODE_SCALE_ASPECT, "Full aspect" },
710 };
711 
712 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
713 	{ DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
714 	{ DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
715 	{ DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
716 };
717 
718 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
719 	{ DRM_MODE_PANEL_ORIENTATION_NORMAL,	"Normal"	},
720 	{ DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,	"Upside Down"	},
721 	{ DRM_MODE_PANEL_ORIENTATION_LEFT_UP,	"Left Side Up"	},
722 	{ DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,	"Right Side Up"	},
723 };
724 
725 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
726 	{ DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
727 	{ DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
728 	{ DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
729 };
730 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
731 
732 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
733 	{ DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
734 	{ DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
735 	{ DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
736 };
737 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
738 		 drm_dvi_i_subconnector_enum_list)
739 
740 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
741 	{ DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
742 	{ DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
743 	{ DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
744 	{ DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
745 	{ DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
746 };
747 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
748 
749 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
750 	{ DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
751 	{ DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
752 	{ DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
753 	{ DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
754 	{ DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
755 };
756 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
757 		 drm_tv_subconnector_enum_list)
758 
759 /**
760  * DOC: standard connector properties
761  *
762  * DRM connectors have a few standardized properties:
763  *
764  * EDID:
765  * 	Blob property which contains the current EDID read from the sink. This
766  * 	is useful to parse sink identification information like vendor, model
767  * 	and serial. Drivers should update this property by calling
768  * 	drm_mode_connector_update_edid_property(), usually after having parsed
769  * 	the EDID using drm_add_edid_modes(). Userspace cannot change this
770  * 	property.
771  * DPMS:
772  * 	Legacy property for setting the power state of the connector. For atomic
773  * 	drivers this is only provided for backwards compatibility with existing
774  * 	drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
775  * 	connector is linked to. Drivers should never set this property directly,
776  * 	it is handled by the DRM core by calling the &drm_connector_funcs.dpms
777  * 	callback. For atomic drivers the remapping to the "ACTIVE" property is
778  * 	implemented in the DRM core.  This is the only standard connector
779  * 	property that userspace can change.
780  *
781  * 	Note that this property cannot be set through the MODE_ATOMIC ioctl,
782  * 	userspace must use "ACTIVE" on the CRTC instead.
783  *
784  * 	WARNING:
785  *
786  * 	For userspace also running on legacy drivers the "DPMS" semantics are a
787  * 	lot more complicated. First, userspace cannot rely on the "DPMS" value
788  * 	returned by the GETCONNECTOR actually reflecting reality, because many
789  * 	drivers fail to update it. For atomic drivers this is taken care of in
790  * 	drm_atomic_helper_update_legacy_modeset_state().
791  *
792  * 	The second issue is that the DPMS state is only well-defined when the
793  * 	connector is connected to a CRTC. In atomic the DRM core enforces that
794  * 	"ACTIVE" is off in such a case, no such checks exists for "DPMS".
795  *
796  * 	Finally, when enabling an output using the legacy SETCONFIG ioctl then
797  * 	"DPMS" is forced to ON. But see above, that might not be reflected in
798  * 	the software value on legacy drivers.
799  *
800  * 	Summarizing: Only set "DPMS" when the connector is known to be enabled,
801  * 	assume that a successful SETCONFIG call also sets "DPMS" to on, and
802  * 	never read back the value of "DPMS" because it can be incorrect.
803  * PATH:
804  * 	Connector path property to identify how this sink is physically
805  * 	connected. Used by DP MST. This should be set by calling
806  * 	drm_mode_connector_set_path_property(), in the case of DP MST with the
807  * 	path property the MST manager created. Userspace cannot change this
808  * 	property.
809  * TILE:
810  * 	Connector tile group property to indicate how a set of DRM connector
811  * 	compose together into one logical screen. This is used by both high-res
812  * 	external screens (often only using a single cable, but exposing multiple
813  * 	DP MST sinks), or high-res integrated panels (like dual-link DSI) which
814  * 	are not gen-locked. Note that for tiled panels which are genlocked, like
815  * 	dual-link LVDS or dual-link DSI, the driver should try to not expose the
816  * 	tiling and virtualize both &drm_crtc and &drm_plane if needed. Drivers
817  * 	should update this value using drm_mode_connector_set_tile_property().
818  * 	Userspace cannot change this property.
819  * link-status:
820  *      Connector link-status property to indicate the status of link. The default
821  *      value of link-status is "GOOD". If something fails during or after modeset,
822  *      the kernel driver may set this to "BAD" and issue a hotplug uevent. Drivers
823  *      should update this value using drm_mode_connector_set_link_status_property().
824  * non_desktop:
825  * 	Indicates the output should be ignored for purposes of displaying a
826  * 	standard desktop environment or console. This is most likely because
827  * 	the output device is not rectilinear.
828  *
829  * Connectors also have one standardized atomic property:
830  *
831  * CRTC_ID:
832  * 	Mode object ID of the &drm_crtc this connector should be connected to.
833  *
834  * Connectors for LCD panels may also have one standardized property:
835  *
836  * panel orientation:
837  *	On some devices the LCD panel is mounted in the casing in such a way
838  *	that the up/top side of the panel does not match with the top side of
839  *	the device. Userspace can use this property to check for this.
840  *	Note that input coordinates from touchscreens (input devices with
841  *	INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
842  *	coordinates, so if userspace rotates the picture to adjust for
843  *	the orientation it must also apply the same transformation to the
844  *	touchscreen input coordinates.
845  */
846 
847 int drm_connector_create_standard_properties(struct drm_device *dev)
848 {
849 	struct drm_property *prop;
850 
851 	prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
852 				   DRM_MODE_PROP_IMMUTABLE,
853 				   "EDID", 0);
854 	if (!prop)
855 		return -ENOMEM;
856 	dev->mode_config.edid_property = prop;
857 
858 	prop = drm_property_create_enum(dev, 0,
859 				   "DPMS", drm_dpms_enum_list,
860 				   ARRAY_SIZE(drm_dpms_enum_list));
861 	if (!prop)
862 		return -ENOMEM;
863 	dev->mode_config.dpms_property = prop;
864 
865 	prop = drm_property_create(dev,
866 				   DRM_MODE_PROP_BLOB |
867 				   DRM_MODE_PROP_IMMUTABLE,
868 				   "PATH", 0);
869 	if (!prop)
870 		return -ENOMEM;
871 	dev->mode_config.path_property = prop;
872 
873 	prop = drm_property_create(dev,
874 				   DRM_MODE_PROP_BLOB |
875 				   DRM_MODE_PROP_IMMUTABLE,
876 				   "TILE", 0);
877 	if (!prop)
878 		return -ENOMEM;
879 	dev->mode_config.tile_property = prop;
880 
881 	prop = drm_property_create_enum(dev, 0, "link-status",
882 					drm_link_status_enum_list,
883 					ARRAY_SIZE(drm_link_status_enum_list));
884 	if (!prop)
885 		return -ENOMEM;
886 	dev->mode_config.link_status_property = prop;
887 
888 	prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
889 	if (!prop)
890 		return -ENOMEM;
891 	dev->mode_config.non_desktop_property = prop;
892 
893 	return 0;
894 }
895 
896 /**
897  * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
898  * @dev: DRM device
899  *
900  * Called by a driver the first time a DVI-I connector is made.
901  */
902 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
903 {
904 	struct drm_property *dvi_i_selector;
905 	struct drm_property *dvi_i_subconnector;
906 
907 	if (dev->mode_config.dvi_i_select_subconnector_property)
908 		return 0;
909 
910 	dvi_i_selector =
911 		drm_property_create_enum(dev, 0,
912 				    "select subconnector",
913 				    drm_dvi_i_select_enum_list,
914 				    ARRAY_SIZE(drm_dvi_i_select_enum_list));
915 	dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
916 
917 	dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
918 				    "subconnector",
919 				    drm_dvi_i_subconnector_enum_list,
920 				    ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
921 	dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
922 
923 	return 0;
924 }
925 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
926 
927 /**
928  * drm_create_tv_properties - create TV specific connector properties
929  * @dev: DRM device
930  * @num_modes: number of different TV formats (modes) supported
931  * @modes: array of pointers to strings containing name of each format
932  *
933  * Called by a driver's TV initialization routine, this function creates
934  * the TV specific connector properties for a given device.  Caller is
935  * responsible for allocating a list of format names and passing them to
936  * this routine.
937  */
938 int drm_mode_create_tv_properties(struct drm_device *dev,
939 				  unsigned int num_modes,
940 				  const char * const modes[])
941 {
942 	struct drm_property *tv_selector;
943 	struct drm_property *tv_subconnector;
944 	unsigned int i;
945 
946 	if (dev->mode_config.tv_select_subconnector_property)
947 		return 0;
948 
949 	/*
950 	 * Basic connector properties
951 	 */
952 	tv_selector = drm_property_create_enum(dev, 0,
953 					  "select subconnector",
954 					  drm_tv_select_enum_list,
955 					  ARRAY_SIZE(drm_tv_select_enum_list));
956 	if (!tv_selector)
957 		goto nomem;
958 
959 	dev->mode_config.tv_select_subconnector_property = tv_selector;
960 
961 	tv_subconnector =
962 		drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
963 				    "subconnector",
964 				    drm_tv_subconnector_enum_list,
965 				    ARRAY_SIZE(drm_tv_subconnector_enum_list));
966 	if (!tv_subconnector)
967 		goto nomem;
968 	dev->mode_config.tv_subconnector_property = tv_subconnector;
969 
970 	/*
971 	 * Other, TV specific properties: margins & TV modes.
972 	 */
973 	dev->mode_config.tv_left_margin_property =
974 		drm_property_create_range(dev, 0, "left margin", 0, 100);
975 	if (!dev->mode_config.tv_left_margin_property)
976 		goto nomem;
977 
978 	dev->mode_config.tv_right_margin_property =
979 		drm_property_create_range(dev, 0, "right margin", 0, 100);
980 	if (!dev->mode_config.tv_right_margin_property)
981 		goto nomem;
982 
983 	dev->mode_config.tv_top_margin_property =
984 		drm_property_create_range(dev, 0, "top margin", 0, 100);
985 	if (!dev->mode_config.tv_top_margin_property)
986 		goto nomem;
987 
988 	dev->mode_config.tv_bottom_margin_property =
989 		drm_property_create_range(dev, 0, "bottom margin", 0, 100);
990 	if (!dev->mode_config.tv_bottom_margin_property)
991 		goto nomem;
992 
993 	dev->mode_config.tv_mode_property =
994 		drm_property_create(dev, DRM_MODE_PROP_ENUM,
995 				    "mode", num_modes);
996 	if (!dev->mode_config.tv_mode_property)
997 		goto nomem;
998 
999 	for (i = 0; i < num_modes; i++)
1000 		drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1001 				      i, modes[i]);
1002 
1003 	dev->mode_config.tv_brightness_property =
1004 		drm_property_create_range(dev, 0, "brightness", 0, 100);
1005 	if (!dev->mode_config.tv_brightness_property)
1006 		goto nomem;
1007 
1008 	dev->mode_config.tv_contrast_property =
1009 		drm_property_create_range(dev, 0, "contrast", 0, 100);
1010 	if (!dev->mode_config.tv_contrast_property)
1011 		goto nomem;
1012 
1013 	dev->mode_config.tv_flicker_reduction_property =
1014 		drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1015 	if (!dev->mode_config.tv_flicker_reduction_property)
1016 		goto nomem;
1017 
1018 	dev->mode_config.tv_overscan_property =
1019 		drm_property_create_range(dev, 0, "overscan", 0, 100);
1020 	if (!dev->mode_config.tv_overscan_property)
1021 		goto nomem;
1022 
1023 	dev->mode_config.tv_saturation_property =
1024 		drm_property_create_range(dev, 0, "saturation", 0, 100);
1025 	if (!dev->mode_config.tv_saturation_property)
1026 		goto nomem;
1027 
1028 	dev->mode_config.tv_hue_property =
1029 		drm_property_create_range(dev, 0, "hue", 0, 100);
1030 	if (!dev->mode_config.tv_hue_property)
1031 		goto nomem;
1032 
1033 	return 0;
1034 nomem:
1035 	return -ENOMEM;
1036 }
1037 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1038 
1039 /**
1040  * drm_mode_create_scaling_mode_property - create scaling mode property
1041  * @dev: DRM device
1042  *
1043  * Called by a driver the first time it's needed, must be attached to desired
1044  * connectors.
1045  *
1046  * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1047  * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1048  * in the atomic state.
1049  */
1050 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1051 {
1052 	struct drm_property *scaling_mode;
1053 
1054 	if (dev->mode_config.scaling_mode_property)
1055 		return 0;
1056 
1057 	scaling_mode =
1058 		drm_property_create_enum(dev, 0, "scaling mode",
1059 				drm_scaling_mode_enum_list,
1060 				    ARRAY_SIZE(drm_scaling_mode_enum_list));
1061 
1062 	dev->mode_config.scaling_mode_property = scaling_mode;
1063 
1064 	return 0;
1065 }
1066 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1067 
1068 /**
1069  * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1070  * @connector: connector to attach scaling mode property on.
1071  * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1072  *
1073  * This is used to add support for scaling mode to atomic drivers.
1074  * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1075  * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1076  *
1077  * This is the atomic version of drm_mode_create_scaling_mode_property().
1078  *
1079  * Returns:
1080  * Zero on success, negative errno on failure.
1081  */
1082 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1083 					       u32 scaling_mode_mask)
1084 {
1085 	struct drm_device *dev = connector->dev;
1086 	struct drm_property *scaling_mode_property;
1087 	int i, j = 0;
1088 	const unsigned valid_scaling_mode_mask =
1089 		(1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1090 
1091 	if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1092 		    scaling_mode_mask & ~valid_scaling_mode_mask))
1093 		return -EINVAL;
1094 
1095 	scaling_mode_property =
1096 		drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1097 				    hweight32(scaling_mode_mask));
1098 
1099 	if (!scaling_mode_property)
1100 		return -ENOMEM;
1101 
1102 	for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1103 		int ret;
1104 
1105 		if (!(BIT(i) & scaling_mode_mask))
1106 			continue;
1107 
1108 		ret = drm_property_add_enum(scaling_mode_property, j++,
1109 					    drm_scaling_mode_enum_list[i].type,
1110 					    drm_scaling_mode_enum_list[i].name);
1111 
1112 		if (ret) {
1113 			drm_property_destroy(dev, scaling_mode_property);
1114 
1115 			return ret;
1116 		}
1117 	}
1118 
1119 	drm_object_attach_property(&connector->base,
1120 				   scaling_mode_property, 0);
1121 
1122 	connector->scaling_mode_property = scaling_mode_property;
1123 
1124 	return 0;
1125 }
1126 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1127 
1128 /**
1129  * drm_mode_create_aspect_ratio_property - create aspect ratio property
1130  * @dev: DRM device
1131  *
1132  * Called by a driver the first time it's needed, must be attached to desired
1133  * connectors.
1134  *
1135  * Returns:
1136  * Zero on success, negative errno on failure.
1137  */
1138 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1139 {
1140 	if (dev->mode_config.aspect_ratio_property)
1141 		return 0;
1142 
1143 	dev->mode_config.aspect_ratio_property =
1144 		drm_property_create_enum(dev, 0, "aspect ratio",
1145 				drm_aspect_ratio_enum_list,
1146 				ARRAY_SIZE(drm_aspect_ratio_enum_list));
1147 
1148 	if (dev->mode_config.aspect_ratio_property == NULL)
1149 		return -ENOMEM;
1150 
1151 	return 0;
1152 }
1153 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1154 
1155 /**
1156  * drm_mode_create_suggested_offset_properties - create suggests offset properties
1157  * @dev: DRM device
1158  *
1159  * Create the the suggested x/y offset property for connectors.
1160  */
1161 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1162 {
1163 	if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1164 		return 0;
1165 
1166 	dev->mode_config.suggested_x_property =
1167 		drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1168 
1169 	dev->mode_config.suggested_y_property =
1170 		drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1171 
1172 	if (dev->mode_config.suggested_x_property == NULL ||
1173 	    dev->mode_config.suggested_y_property == NULL)
1174 		return -ENOMEM;
1175 	return 0;
1176 }
1177 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1178 
1179 /**
1180  * drm_mode_connector_set_path_property - set tile property on connector
1181  * @connector: connector to set property on.
1182  * @path: path to use for property; must not be NULL.
1183  *
1184  * This creates a property to expose to userspace to specify a
1185  * connector path. This is mainly used for DisplayPort MST where
1186  * connectors have a topology and we want to allow userspace to give
1187  * them more meaningful names.
1188  *
1189  * Returns:
1190  * Zero on success, negative errno on failure.
1191  */
1192 int drm_mode_connector_set_path_property(struct drm_connector *connector,
1193 					 const char *path)
1194 {
1195 	struct drm_device *dev = connector->dev;
1196 	int ret;
1197 
1198 	ret = drm_property_replace_global_blob(dev,
1199 	                                       &connector->path_blob_ptr,
1200 	                                       strlen(path) + 1,
1201 	                                       path,
1202 	                                       &connector->base,
1203 	                                       dev->mode_config.path_property);
1204 	return ret;
1205 }
1206 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
1207 
1208 /**
1209  * drm_mode_connector_set_tile_property - set tile property on connector
1210  * @connector: connector to set property on.
1211  *
1212  * This looks up the tile information for a connector, and creates a
1213  * property for userspace to parse if it exists. The property is of
1214  * the form of 8 integers using ':' as a separator.
1215  *
1216  * Returns:
1217  * Zero on success, errno on failure.
1218  */
1219 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
1220 {
1221 	struct drm_device *dev = connector->dev;
1222 	char tile[256];
1223 	int ret;
1224 
1225 	if (!connector->has_tile) {
1226 		ret  = drm_property_replace_global_blob(dev,
1227 		                                        &connector->tile_blob_ptr,
1228 		                                        0,
1229 		                                        NULL,
1230 		                                        &connector->base,
1231 		                                        dev->mode_config.tile_property);
1232 		return ret;
1233 	}
1234 
1235 	snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
1236 		 connector->tile_group->id, connector->tile_is_single_monitor,
1237 		 connector->num_h_tile, connector->num_v_tile,
1238 		 connector->tile_h_loc, connector->tile_v_loc,
1239 		 connector->tile_h_size, connector->tile_v_size);
1240 
1241 	ret = drm_property_replace_global_blob(dev,
1242 	                                       &connector->tile_blob_ptr,
1243 	                                       strlen(tile) + 1,
1244 	                                       tile,
1245 	                                       &connector->base,
1246 	                                       dev->mode_config.tile_property);
1247 	return ret;
1248 }
1249 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
1250 
1251 /**
1252  * drm_mode_connector_update_edid_property - update the edid property of a connector
1253  * @connector: drm connector
1254  * @edid: new value of the edid property
1255  *
1256  * This function creates a new blob modeset object and assigns its id to the
1257  * connector's edid property.
1258  *
1259  * Returns:
1260  * Zero on success, negative errno on failure.
1261  */
1262 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1263 					    const struct edid *edid)
1264 {
1265 	struct drm_device *dev = connector->dev;
1266 	size_t size = 0;
1267 	int ret;
1268 
1269 	/* ignore requests to set edid when overridden */
1270 	if (connector->override_edid)
1271 		return 0;
1272 
1273 	if (edid)
1274 		size = EDID_LENGTH * (1 + edid->extensions);
1275 
1276 	/* Set the display info, using edid if available, otherwise
1277 	 * reseting the values to defaults. This duplicates the work
1278 	 * done in drm_add_edid_modes, but that function is not
1279 	 * consistently called before this one in all drivers and the
1280 	 * computation is cheap enough that it seems better to
1281 	 * duplicate it rather than attempt to ensure some arbitrary
1282 	 * ordering of calls.
1283 	 */
1284 	if (edid)
1285 		drm_add_display_info(connector, edid);
1286 	else
1287 		drm_reset_display_info(connector);
1288 
1289 	drm_object_property_set_value(&connector->base,
1290 				      dev->mode_config.non_desktop_property,
1291 				      connector->display_info.non_desktop);
1292 
1293 	ret = drm_property_replace_global_blob(dev,
1294 					       &connector->edid_blob_ptr,
1295 	                                       size,
1296 	                                       edid,
1297 	                                       &connector->base,
1298 	                                       dev->mode_config.edid_property);
1299 	return ret;
1300 }
1301 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
1302 
1303 /**
1304  * drm_mode_connector_set_link_status_property - Set link status property of a connector
1305  * @connector: drm connector
1306  * @link_status: new value of link status property (0: Good, 1: Bad)
1307  *
1308  * In usual working scenario, this link status property will always be set to
1309  * "GOOD". If something fails during or after a mode set, the kernel driver
1310  * may set this link status property to "BAD". The caller then needs to send a
1311  * hotplug uevent for userspace to re-check the valid modes through
1312  * GET_CONNECTOR_IOCTL and retry modeset.
1313  *
1314  * Note: Drivers cannot rely on userspace to support this property and
1315  * issue a modeset. As such, they may choose to handle issues (like
1316  * re-training a link) without userspace's intervention.
1317  *
1318  * The reason for adding this property is to handle link training failures, but
1319  * it is not limited to DP or link training. For example, if we implement
1320  * asynchronous setcrtc, this property can be used to report any failures in that.
1321  */
1322 void drm_mode_connector_set_link_status_property(struct drm_connector *connector,
1323 						 uint64_t link_status)
1324 {
1325 	struct drm_device *dev = connector->dev;
1326 
1327 	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
1328 	connector->state->link_status = link_status;
1329 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
1330 }
1331 EXPORT_SYMBOL(drm_mode_connector_set_link_status_property);
1332 
1333 /**
1334  * drm_connector_init_panel_orientation_property -
1335  *	initialize the connecters panel_orientation property
1336  * @connector: connector for which to init the panel-orientation property.
1337  * @width: width in pixels of the panel, used for panel quirk detection
1338  * @height: height in pixels of the panel, used for panel quirk detection
1339  *
1340  * This function should only be called for built-in panels, after setting
1341  * connector->display_info.panel_orientation first (if known).
1342  *
1343  * This function will check for platform specific (e.g. DMI based) quirks
1344  * overriding display_info.panel_orientation first, then if panel_orientation
1345  * is not DRM_MODE_PANEL_ORIENTATION_UNKNOWN it will attach the
1346  * "panel orientation" property to the connector.
1347  *
1348  * Returns:
1349  * Zero on success, negative errno on failure.
1350  */
1351 int drm_connector_init_panel_orientation_property(
1352 	struct drm_connector *connector, int width, int height)
1353 {
1354 	struct drm_device *dev = connector->dev;
1355 	struct drm_display_info *info = &connector->display_info;
1356 	struct drm_property *prop;
1357 	int orientation_quirk;
1358 
1359 	orientation_quirk = drm_get_panel_orientation_quirk(width, height);
1360 	if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
1361 		info->panel_orientation = orientation_quirk;
1362 
1363 	if (info->panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
1364 		return 0;
1365 
1366 	prop = dev->mode_config.panel_orientation_property;
1367 	if (!prop) {
1368 		prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1369 				"panel orientation",
1370 				drm_panel_orientation_enum_list,
1371 				ARRAY_SIZE(drm_panel_orientation_enum_list));
1372 		if (!prop)
1373 			return -ENOMEM;
1374 
1375 		dev->mode_config.panel_orientation_property = prop;
1376 	}
1377 
1378 	drm_object_attach_property(&connector->base, prop,
1379 				   info->panel_orientation);
1380 	return 0;
1381 }
1382 EXPORT_SYMBOL(drm_connector_init_panel_orientation_property);
1383 
1384 int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
1385 				    struct drm_property *property,
1386 				    uint64_t value)
1387 {
1388 	int ret = -EINVAL;
1389 	struct drm_connector *connector = obj_to_connector(obj);
1390 
1391 	/* Do DPMS ourselves */
1392 	if (property == connector->dev->mode_config.dpms_property) {
1393 		ret = (*connector->funcs->dpms)(connector, (int)value);
1394 	} else if (connector->funcs->set_property)
1395 		ret = connector->funcs->set_property(connector, property, value);
1396 
1397 	if (!ret)
1398 		drm_object_property_set_value(&connector->base, property, value);
1399 	return ret;
1400 }
1401 
1402 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1403 				       void *data, struct drm_file *file_priv)
1404 {
1405 	struct drm_mode_connector_set_property *conn_set_prop = data;
1406 	struct drm_mode_obj_set_property obj_set_prop = {
1407 		.value = conn_set_prop->value,
1408 		.prop_id = conn_set_prop->prop_id,
1409 		.obj_id = conn_set_prop->connector_id,
1410 		.obj_type = DRM_MODE_OBJECT_CONNECTOR
1411 	};
1412 
1413 	/* It does all the locking and checking we need */
1414 	return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
1415 }
1416 
1417 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
1418 {
1419 	/* For atomic drivers only state objects are synchronously updated and
1420 	 * protected by modeset locks, so check those first. */
1421 	if (connector->state)
1422 		return connector->state->best_encoder;
1423 	return connector->encoder;
1424 }
1425 
1426 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
1427 					 const struct drm_file *file_priv)
1428 {
1429 	/*
1430 	 * If user-space hasn't configured the driver to expose the stereo 3D
1431 	 * modes, don't expose them.
1432 	 */
1433 	if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
1434 		return false;
1435 
1436 	return true;
1437 }
1438 
1439 int drm_mode_getconnector(struct drm_device *dev, void *data,
1440 			  struct drm_file *file_priv)
1441 {
1442 	struct drm_mode_get_connector *out_resp = data;
1443 	struct drm_connector *connector;
1444 	struct drm_encoder *encoder;
1445 	struct drm_display_mode *mode;
1446 	int mode_count = 0;
1447 	int encoders_count = 0;
1448 	int ret = 0;
1449 	int copied = 0;
1450 	int i;
1451 	struct drm_mode_modeinfo u_mode;
1452 	struct drm_mode_modeinfo __user *mode_ptr;
1453 	uint32_t __user *encoder_ptr;
1454 
1455 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
1456 		return -EINVAL;
1457 
1458 	memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
1459 
1460 	connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
1461 	if (!connector)
1462 		return -ENOENT;
1463 
1464 	for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
1465 		if (connector->encoder_ids[i] != 0)
1466 			encoders_count++;
1467 
1468 	if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
1469 		copied = 0;
1470 		encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
1471 		for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
1472 			if (connector->encoder_ids[i] != 0) {
1473 				if (put_user(connector->encoder_ids[i],
1474 					     encoder_ptr + copied)) {
1475 					ret = -EFAULT;
1476 					goto out;
1477 				}
1478 				copied++;
1479 			}
1480 		}
1481 	}
1482 	out_resp->count_encoders = encoders_count;
1483 
1484 	out_resp->connector_id = connector->base.id;
1485 	out_resp->connector_type = connector->connector_type;
1486 	out_resp->connector_type_id = connector->connector_type_id;
1487 
1488 	mutex_lock(&dev->mode_config.mutex);
1489 	if (out_resp->count_modes == 0) {
1490 		connector->funcs->fill_modes(connector,
1491 					     dev->mode_config.max_width,
1492 					     dev->mode_config.max_height);
1493 	}
1494 
1495 	out_resp->mm_width = connector->display_info.width_mm;
1496 	out_resp->mm_height = connector->display_info.height_mm;
1497 	out_resp->subpixel = connector->display_info.subpixel_order;
1498 	out_resp->connection = connector->status;
1499 
1500 	/* delayed so we get modes regardless of pre-fill_modes state */
1501 	list_for_each_entry(mode, &connector->modes, head)
1502 		if (drm_mode_expose_to_userspace(mode, file_priv))
1503 			mode_count++;
1504 
1505 	/*
1506 	 * This ioctl is called twice, once to determine how much space is
1507 	 * needed, and the 2nd time to fill it.
1508 	 */
1509 	if ((out_resp->count_modes >= mode_count) && mode_count) {
1510 		copied = 0;
1511 		mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
1512 		list_for_each_entry(mode, &connector->modes, head) {
1513 			if (!drm_mode_expose_to_userspace(mode, file_priv))
1514 				continue;
1515 
1516 			drm_mode_convert_to_umode(&u_mode, mode);
1517 			if (copy_to_user(mode_ptr + copied,
1518 					 &u_mode, sizeof(u_mode))) {
1519 				ret = -EFAULT;
1520 				mutex_unlock(&dev->mode_config.mutex);
1521 
1522 				goto out;
1523 			}
1524 			copied++;
1525 		}
1526 	}
1527 	out_resp->count_modes = mode_count;
1528 	mutex_unlock(&dev->mode_config.mutex);
1529 
1530 	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
1531 	encoder = drm_connector_get_encoder(connector);
1532 	if (encoder)
1533 		out_resp->encoder_id = encoder->base.id;
1534 	else
1535 		out_resp->encoder_id = 0;
1536 
1537 	/* Only grab properties after probing, to make sure EDID and other
1538 	 * properties reflect the latest status. */
1539 	ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
1540 			(uint32_t __user *)(unsigned long)(out_resp->props_ptr),
1541 			(uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
1542 			&out_resp->count_props);
1543 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
1544 
1545 out:
1546 	drm_connector_put(connector);
1547 
1548 	return ret;
1549 }
1550 
1551 
1552 /**
1553  * DOC: Tile group
1554  *
1555  * Tile groups are used to represent tiled monitors with a unique integer
1556  * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
1557  * we store this in a tile group, so we have a common identifier for all tiles
1558  * in a monitor group. The property is called "TILE". Drivers can manage tile
1559  * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
1560  * drm_mode_get_tile_group(). But this is only needed for internal panels where
1561  * the tile group information is exposed through a non-standard way.
1562  */
1563 
1564 static void drm_tile_group_free(struct kref *kref)
1565 {
1566 	struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
1567 	struct drm_device *dev = tg->dev;
1568 	mutex_lock(&dev->mode_config.idr_mutex);
1569 	idr_remove(&dev->mode_config.tile_idr, tg->id);
1570 	mutex_unlock(&dev->mode_config.idr_mutex);
1571 	kfree(tg);
1572 }
1573 
1574 /**
1575  * drm_mode_put_tile_group - drop a reference to a tile group.
1576  * @dev: DRM device
1577  * @tg: tile group to drop reference to.
1578  *
1579  * drop reference to tile group and free if 0.
1580  */
1581 void drm_mode_put_tile_group(struct drm_device *dev,
1582 			     struct drm_tile_group *tg)
1583 {
1584 	kref_put(&tg->refcount, drm_tile_group_free);
1585 }
1586 EXPORT_SYMBOL(drm_mode_put_tile_group);
1587 
1588 /**
1589  * drm_mode_get_tile_group - get a reference to an existing tile group
1590  * @dev: DRM device
1591  * @topology: 8-bytes unique per monitor.
1592  *
1593  * Use the unique bytes to get a reference to an existing tile group.
1594  *
1595  * RETURNS:
1596  * tile group or NULL if not found.
1597  */
1598 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1599 					       char topology[8])
1600 {
1601 	struct drm_tile_group *tg;
1602 	int id;
1603 	mutex_lock(&dev->mode_config.idr_mutex);
1604 	idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
1605 		if (!memcmp(tg->group_data, topology, 8)) {
1606 			if (!kref_get_unless_zero(&tg->refcount))
1607 				tg = NULL;
1608 			mutex_unlock(&dev->mode_config.idr_mutex);
1609 			return tg;
1610 		}
1611 	}
1612 	mutex_unlock(&dev->mode_config.idr_mutex);
1613 	return NULL;
1614 }
1615 EXPORT_SYMBOL(drm_mode_get_tile_group);
1616 
1617 /**
1618  * drm_mode_create_tile_group - create a tile group from a displayid description
1619  * @dev: DRM device
1620  * @topology: 8-bytes unique per monitor.
1621  *
1622  * Create a tile group for the unique monitor, and get a unique
1623  * identifier for the tile group.
1624  *
1625  * RETURNS:
1626  * new tile group or error.
1627  */
1628 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1629 						  char topology[8])
1630 {
1631 	struct drm_tile_group *tg;
1632 	int ret;
1633 
1634 	tg = kzalloc(sizeof(*tg), GFP_KERNEL);
1635 	if (!tg)
1636 		return ERR_PTR(-ENOMEM);
1637 
1638 	kref_init(&tg->refcount);
1639 	memcpy(tg->group_data, topology, 8);
1640 	tg->dev = dev;
1641 
1642 	mutex_lock(&dev->mode_config.idr_mutex);
1643 	ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
1644 	if (ret >= 0) {
1645 		tg->id = ret;
1646 	} else {
1647 		kfree(tg);
1648 		tg = ERR_PTR(ret);
1649 	}
1650 
1651 	mutex_unlock(&dev->mode_config.idr_mutex);
1652 	return tg;
1653 }
1654 EXPORT_SYMBOL(drm_mode_create_tile_group);
1655