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