[linux-block.git] / drivers / gpu / drm / drm_encoder.c

/*
 * Copyright (c) 2016 Intel Corporation
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting documentation, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 */

#include <linux/export.h>

#include <drm/drm_bridge.h>
#include <drm/drm_device.h>
#include <drm/drm_drv.h>
#include <drm/drm_encoder.h>
#include <drm/drm_managed.h>

#include "drm_crtc_internal.h"

/**
 * DOC: overview
 *
 * Encoders represent the connecting element between the CRTC (as the overall
 * pixel pipeline, represented by &struct drm_crtc) and the connectors (as the
 * generic sink entity, represented by &struct drm_connector). An encoder takes
 * pixel data from a CRTC and converts it to a format suitable for any attached
 * connector. Encoders are objects exposed to userspace, originally to allow
 * userspace to infer cloning and connector/CRTC restrictions. Unfortunately
 * almost all drivers get this wrong, making the uabi pretty much useless. On
 * top of that the exposed restrictions are too simple for today's hardware, and
 * the recommended way to infer restrictions is by using the
 * DRM_MODE_ATOMIC_TEST_ONLY flag for the atomic IOCTL.
 *
 * Otherwise encoders aren't used in the uapi at all (any modeset request from
 * userspace directly connects a connector with a CRTC), drivers are therefore
 * free to use them however they wish. Modeset helper libraries make strong use
 * of encoders to facilitate code sharing. But for more complex settings it is
 * usually better to move shared code into a separate &drm_bridge. Compared to
 * encoders, bridges also have the benefit of being purely an internal
 * abstraction since they are not exposed to userspace at all.
 *
 * Encoders are initialized with drm_encoder_init() and cleaned up using
 * drm_encoder_cleanup().
 */
static const struct drm_prop_enum_list drm_encoder_enum_list[] = {
	{ DRM_MODE_ENCODER_NONE, "None" },
	{ DRM_MODE_ENCODER_DAC, "DAC" },
	{ DRM_MODE_ENCODER_TMDS, "TMDS" },
	{ DRM_MODE_ENCODER_LVDS, "LVDS" },
	{ DRM_MODE_ENCODER_TVDAC, "TV" },
	{ DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
	{ DRM_MODE_ENCODER_DSI, "DSI" },
	{ DRM_MODE_ENCODER_DPMST, "DP MST" },
	{ DRM_MODE_ENCODER_DPI, "DPI" },
};

int drm_encoder_register_all(struct drm_device *dev)
{
	struct drm_encoder *encoder;
	int ret = 0;

	drm_for_each_encoder(encoder, dev) {
		if (encoder->funcs && encoder->funcs->late_register)
			ret = encoder->funcs->late_register(encoder);
		if (ret)
			return ret;
	}

	return 0;
}

void drm_encoder_unregister_all(struct drm_device *dev)
{
	struct drm_encoder *encoder;

	drm_for_each_encoder(encoder, dev) {
		if (encoder->funcs && encoder->funcs->early_unregister)
			encoder->funcs->early_unregister(encoder);
	}
}

__printf(5, 0)
static int __drm_encoder_init(struct drm_device *dev,
			      struct drm_encoder *encoder,
			      const struct drm_encoder_funcs *funcs,
			      int encoder_type, const char *name, va_list ap)
{
	int ret;

	/* encoder index is used with 32bit bitmasks */
	if (WARN_ON(dev->mode_config.num_encoder >= 32))
		return -EINVAL;

	ret = drm_mode_object_add(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
	if (ret)
		return ret;

	encoder->dev = dev;
	encoder->encoder_type = encoder_type;
	encoder->funcs = funcs;
	if (name) {
		encoder->name = kvasprintf(GFP_KERNEL, name, ap);
	} else {
		encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
					  drm_encoder_enum_list[encoder_type].name,
					  encoder->base.id);
	}
	if (!encoder->name) {
		ret = -ENOMEM;
		goto out_put;
	}

	INIT_LIST_HEAD(&encoder->bridge_chain);
	list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
	encoder->index = dev->mode_config.num_encoder++;

out_put:
	if (ret)
		drm_mode_object_unregister(dev, &encoder->base);

	return ret;
}

/**
 * drm_encoder_init - Init a preallocated encoder
 * @dev: drm device
 * @encoder: the encoder to init
 * @funcs: callbacks for this encoder
 * @encoder_type: user visible type of the encoder
 * @name: printf style format string for the encoder name, or NULL for default name
 *
 * Initializes a preallocated encoder. Encoder should be subclassed as part of
 * driver encoder objects. At driver unload time the driver's
 * &drm_encoder_funcs.destroy hook should call drm_encoder_cleanup() and kfree()
 * the encoder structure. The encoder structure should not be allocated with
 * devm_kzalloc().
 *
 * Note: consider using drmm_encoder_alloc() instead of drm_encoder_init() to
 * let the DRM managed resource infrastructure take care of cleanup and
 * deallocation.
 *
 * Returns:
 * Zero on success, error code on failure.
 */
int drm_encoder_init(struct drm_device *dev,
		     struct drm_encoder *encoder,
		     const struct drm_encoder_funcs *funcs,
		     int encoder_type, const char *name, ...)
{
	va_list ap;
	int ret;

	WARN_ON(!funcs->destroy);

	va_start(ap, name);
	ret = __drm_encoder_init(dev, encoder, funcs, encoder_type, name, ap);
	va_end(ap);

	return ret;
}
EXPORT_SYMBOL(drm_encoder_init);

/**
 * drm_encoder_cleanup - cleans up an initialised encoder
 * @encoder: encoder to cleanup
 *
 * Cleans up the encoder but doesn't free the object.
 */
void drm_encoder_cleanup(struct drm_encoder *encoder)
{
	struct drm_device *dev = encoder->dev;
	struct drm_bridge *bridge, *next;

	/* Note that the encoder_list is considered to be static; should we
	 * remove the drm_encoder at runtime we would have to decrement all
	 * the indices on the drm_encoder after us in the encoder_list.
	 */

	list_for_each_entry_safe(bridge, next, &encoder->bridge_chain,
				 chain_node)
		drm_bridge_detach(bridge);

	drm_mode_object_unregister(dev, &encoder->base);
	kfree(encoder->name);
	list_del(&encoder->head);
	dev->mode_config.num_encoder--;

	memset(encoder, 0, sizeof(*encoder));
}
EXPORT_SYMBOL(drm_encoder_cleanup);

static void drmm_encoder_alloc_release(struct drm_device *dev, void *ptr)
{
	struct drm_encoder *encoder = ptr;

	if (WARN_ON(!encoder->dev))
		return;

	drm_encoder_cleanup(encoder);
}

void *__drmm_encoder_alloc(struct drm_device *dev, size_t size, size_t offset,
			   const struct drm_encoder_funcs *funcs,
			   int encoder_type, const char *name, ...)
{
	void *container;
	struct drm_encoder *encoder;
	va_list ap;
	int ret;

	if (WARN_ON(funcs && funcs->destroy))
		return ERR_PTR(-EINVAL);

	container = drmm_kzalloc(dev, size, GFP_KERNEL);
	if (!container)
		return ERR_PTR(-EINVAL);

	encoder = container + offset;

	va_start(ap, name);
	ret = __drm_encoder_init(dev, encoder, funcs, encoder_type, name, ap);
	va_end(ap);
	if (ret)
		return ERR_PTR(ret);

	ret = drmm_add_action_or_reset(dev, drmm_encoder_alloc_release, encoder);
	if (ret)
		return ERR_PTR(ret);

	return container;
}
EXPORT_SYMBOL(__drmm_encoder_alloc);

static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
{
	struct drm_connector *connector;
	struct drm_device *dev = encoder->dev;
	bool uses_atomic = false;
	struct drm_connector_list_iter conn_iter;

	/* For atomic drivers only state objects are synchronously updated and
	 * protected by modeset locks, so check those first. */
	drm_connector_list_iter_begin(dev, &conn_iter);
	drm_for_each_connector_iter(connector, &conn_iter) {
		if (!connector->state)
			continue;

		uses_atomic = true;

		if (connector->state->best_encoder != encoder)
			continue;

		drm_connector_list_iter_end(&conn_iter);
		return connector->state->crtc;
	}
	drm_connector_list_iter_end(&conn_iter);

	/* Don't return stale data (e.g. pending async disable). */
	if (uses_atomic)
		return NULL;

	return encoder->crtc;
}

int drm_mode_getencoder(struct drm_device *dev, void *data,
			struct drm_file *file_priv)
{
	struct drm_mode_get_encoder *enc_resp = data;
	struct drm_encoder *encoder;
	struct drm_crtc *crtc;

	if (!drm_core_check_feature(dev, DRIVER_MODESET))
		return -EOPNOTSUPP;

	encoder = drm_encoder_find(dev, file_priv, enc_resp->encoder_id);
	if (!encoder)
		return -ENOENT;

	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
	crtc = drm_encoder_get_crtc(encoder);
	if (crtc && drm_lease_held(file_priv, crtc->base.id))
		enc_resp->crtc_id = crtc->base.id;
	else
		enc_resp->crtc_id = 0;
	drm_modeset_unlock(&dev->mode_config.connection_mutex);

	enc_resp->encoder_type = encoder->encoder_type;
	enc_resp->encoder_id = encoder->base.id;
	enc_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv,
							  encoder->possible_crtcs);
	enc_resp->possible_clones = encoder->possible_clones;

	return 0;
}
Commit	Line	Data
321a95ae DV	1	/*
	2	* Copyright (c) 2016 Intel Corporation
	3	*
	4	* Permission to use, copy, modify, distribute, and sell this software and its
	5	* documentation for any purpose is hereby granted without fee, provided that
	6	* the above copyright notice appear in all copies and that both that copyright
	7	* notice and this permission notice appear in supporting documentation, and
	8	* that the name of the copyright holders not be used in advertising or
	9	* publicity pertaining to distribution of the software without specific,
	10	* written prior permission. The copyright holders make no representations
	11	* about the suitability of this software for any purpose. It is provided "as
	12	* is" without express or implied warranty.
	13	*
	14	* THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
	15	* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
	16	* EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
	17	* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
	18	* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
	19	* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
	20	* OF THIS SOFTWARE.
	21	*/
	22
	23	#include <linux/export.h>
0500c04e	24
ee68c743	25	#include <drm/drm_bridge.h>
0500c04e SR	26	#include <drm/drm_device.h>
0500c04e SR	27	#include <drm/drm_drv.h>
321a95ae	28	#include <drm/drm_encoder.h>
ca5092d0	29	#include <drm/drm_managed.h>
321a95ae DV	30
	31	#include "drm_crtc_internal.h"
	32
e03e6de0 DV	33	/**
	34	* DOC: overview
	35	*
	36	* Encoders represent the connecting element between the CRTC (as the overall
ea0dd85a DV	37	* pixel pipeline, represented by &struct drm_crtc) and the connectors (as the
ea0dd85a DV	38	* generic sink entity, represented by &struct drm_connector). An encoder takes
f15e6bb0 DP	39	* pixel data from a CRTC and converts it to a format suitable for any attached
	40	* connector. Encoders are objects exposed to userspace, originally to allow
	41	* userspace to infer cloning and connector/CRTC restrictions. Unfortunately
	42	* almost all drivers get this wrong, making the uabi pretty much useless. On
	43	* top of that the exposed restrictions are too simple for today's hardware, and
	44	* the recommended way to infer restrictions is by using the
	45	* DRM_MODE_ATOMIC_TEST_ONLY flag for the atomic IOCTL.
e03e6de0 DV	46	*
	47	* Otherwise encoders aren't used in the uapi at all (any modeset request from
	48	* userspace directly connects a connector with a CRTC), drivers are therefore
	49	* free to use them however they wish. Modeset helper libraries make strong use
	50	* of encoders to facilitate code sharing. But for more complex settings it is
	51	* usually better to move shared code into a separate &drm_bridge. Compared to
f15e6bb0	52	* encoders, bridges also have the benefit of being purely an internal
e03e6de0 DV	53	* abstraction since they are not exposed to userspace at all.
	54	*
	55	* Encoders are initialized with drm_encoder_init() and cleaned up using
	56	* drm_encoder_cleanup().
	57	*/
321a95ae DV	58	static const struct drm_prop_enum_list drm_encoder_enum_list[] = {
	59	{ DRM_MODE_ENCODER_NONE, "None" },
	60	{ DRM_MODE_ENCODER_DAC, "DAC" },
	61	{ DRM_MODE_ENCODER_TMDS, "TMDS" },
	62	{ DRM_MODE_ENCODER_LVDS, "LVDS" },
	63	{ DRM_MODE_ENCODER_TVDAC, "TV" },
	64	{ DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
	65	{ DRM_MODE_ENCODER_DSI, "DSI" },
	66	{ DRM_MODE_ENCODER_DPMST, "DP MST" },
	67	{ DRM_MODE_ENCODER_DPI, "DPI" },
	68	};
	69
	70	int drm_encoder_register_all(struct drm_device *dev)
	71	{
	72	struct drm_encoder *encoder;
	73	int ret = 0;
	74
	75	drm_for_each_encoder(encoder, dev) {
f35a2a99	76	if (encoder->funcs && encoder->funcs->late_register)
321a95ae DV	77	ret = encoder->funcs->late_register(encoder);
	78	if (ret)
	79	return ret;
	80	}
	81
	82	return 0;
	83	}
	84
	85	void drm_encoder_unregister_all(struct drm_device *dev)
	86	{
	87	struct drm_encoder *encoder;
	88
	89	drm_for_each_encoder(encoder, dev) {
f35a2a99	90	if (encoder->funcs && encoder->funcs->early_unregister)
321a95ae DV	91	encoder->funcs->early_unregister(encoder);
	92	}
	93	}
	94
ca5092d0 PZ	95	__printf(5, 0)
	96	static int __drm_encoder_init(struct drm_device *dev,
	97	struct drm_encoder *encoder,
	98	const struct drm_encoder_funcs *funcs,
	99	int encoder_type, const char *name, va_list ap)
321a95ae DV	100	{
	101	int ret;
	102
2a8d3eac VS	103	/* encoder index is used with 32bit bitmasks */
	104	if (WARN_ON(dev->mode_config.num_encoder >= 32))
	105	return -EINVAL;
	106
2135ea7a	107	ret = drm_mode_object_add(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
321a95ae	108	if (ret)
661a3755	109	return ret;
321a95ae DV	110
	111	encoder->dev = dev;
	112	encoder->encoder_type = encoder_type;
	113	encoder->funcs = funcs;
	114	if (name) {
321a95ae	115	encoder->name = kvasprintf(GFP_KERNEL, name, ap);
321a95ae DV	116	} else {
	117	encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
	118	drm_encoder_enum_list[encoder_type].name,
	119	encoder->base.id);
	120	}
	121	if (!encoder->name) {
	122	ret = -ENOMEM;
	123	goto out_put;
	124	}
	125
05193dc3	126	INIT_LIST_HEAD(&encoder->bridge_chain);
321a95ae DV	127	list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
	128	encoder->index = dev->mode_config.num_encoder++;
	129
	130	out_put:
	131	if (ret)
	132	drm_mode_object_unregister(dev, &encoder->base);
	133
321a95ae DV	134	return ret;
321a95ae DV	135	}
ca5092d0 PZ	136
	137	/**
	138	* drm_encoder_init - Init a preallocated encoder
	139	* @dev: drm device
	140	* @encoder: the encoder to init
	141	* @funcs: callbacks for this encoder
	142	* @encoder_type: user visible type of the encoder
	143	* @name: printf style format string for the encoder name, or NULL for default name
	144	*
	145	* Initializes a preallocated encoder. Encoder should be subclassed as part of
	146	* driver encoder objects. At driver unload time the driver's
	147	* &drm_encoder_funcs.destroy hook should call drm_encoder_cleanup() and kfree()
	148	* the encoder structure. The encoder structure should not be allocated with
	149	* devm_kzalloc().
	150	*
	151	* Note: consider using drmm_encoder_alloc() instead of drm_encoder_init() to
	152	* let the DRM managed resource infrastructure take care of cleanup and
	153	* deallocation.
	154	*
	155	* Returns:
	156	* Zero on success, error code on failure.
	157	*/
	158	int drm_encoder_init(struct drm_device *dev,
	159	struct drm_encoder *encoder,
	160	const struct drm_encoder_funcs *funcs,
	161	int encoder_type, const char *name, ...)
	162	{
	163	va_list ap;
	164	int ret;
	165
	166	WARN_ON(!funcs->destroy);
	167
	168	va_start(ap, name);
	169	ret = __drm_encoder_init(dev, encoder, funcs, encoder_type, name, ap);
	170	va_end(ap);
	171
	172	return ret;
	173	}
321a95ae DV	174	EXPORT_SYMBOL(drm_encoder_init);
	175
	176	/**
	177	* drm_encoder_cleanup - cleans up an initialised encoder
	178	* @encoder: encoder to cleanup
	179	*
	180	* Cleans up the encoder but doesn't free the object.
	181	*/
	182	void drm_encoder_cleanup(struct drm_encoder *encoder)
	183	{
	184	struct drm_device *dev = encoder->dev;
05193dc3	185	struct drm_bridge bridge, next;
321a95ae DV	186
	187	/* Note that the encoder_list is considered to be static; should we
	188	* remove the drm_encoder at runtime we would have to decrement all
	189	* the indices on the drm_encoder after us in the encoder_list.
	190	*/
	191
05193dc3 BB	192	list_for_each_entry_safe(bridge, next, &encoder->bridge_chain,
	193	chain_node)
	194	drm_bridge_detach(bridge);
4a878c03	195
321a95ae DV	196	drm_mode_object_unregister(dev, &encoder->base);
	197	kfree(encoder->name);
	198	list_del(&encoder->head);
	199	dev->mode_config.num_encoder--;
321a95ae DV	200
	201	memset(encoder, 0, sizeof(*encoder));
	202	}
	203	EXPORT_SYMBOL(drm_encoder_cleanup);
	204
ca5092d0 PZ	205	static void drmm_encoder_alloc_release(struct drm_device dev, void ptr)
	206	{
	207	struct drm_encoder *encoder = ptr;
	208
	209	if (WARN_ON(!encoder->dev))
	210	return;
	211
	212	drm_encoder_cleanup(encoder);
	213	}
	214
	215	void __drmm_encoder_alloc(struct drm_device dev, size_t size, size_t offset,
	216	const struct drm_encoder_funcs *funcs,
	217	int encoder_type, const char *name, ...)
	218	{
	219	void *container;
	220	struct drm_encoder *encoder;
	221	va_list ap;
	222	int ret;
	223
	224	if (WARN_ON(funcs && funcs->destroy))
	225	return ERR_PTR(-EINVAL);
	226
	227	container = drmm_kzalloc(dev, size, GFP_KERNEL);
	228	if (!container)
	229	return ERR_PTR(-EINVAL);
	230
	231	encoder = container + offset;
	232
	233	va_start(ap, name);
	234	ret = __drm_encoder_init(dev, encoder, funcs, encoder_type, name, ap);
	235	va_end(ap);
	236	if (ret)
	237	return ERR_PTR(ret);
	238
	239	ret = drmm_add_action_or_reset(dev, drmm_encoder_alloc_release, encoder);
	240	if (ret)
	241	return ERR_PTR(ret);
	242
	243	return container;
	244	}
	245	EXPORT_SYMBOL(__drmm_encoder_alloc);
	246
321a95ae DV	247	static struct drm_crtc drm_encoder_get_crtc(struct drm_encoder encoder)
	248	{
	249	struct drm_connector *connector;
	250	struct drm_device *dev = encoder->dev;
	251	bool uses_atomic = false;
613051da	252	struct drm_connector_list_iter conn_iter;
321a95ae DV	253
	254	/* For atomic drivers only state objects are synchronously updated and
	255	* protected by modeset locks, so check those first. */
b982dab1	256	drm_connector_list_iter_begin(dev, &conn_iter);
613051da	257	drm_for_each_connector_iter(connector, &conn_iter) {
321a95ae DV	258	if (!connector->state)
	259	continue;
	260
	261	uses_atomic = true;
	262
	263	if (connector->state->best_encoder != encoder)
	264	continue;
	265
b982dab1	266	drm_connector_list_iter_end(&conn_iter);
321a95ae DV	267	return connector->state->crtc;
321a95ae DV	268	}
b982dab1	269	drm_connector_list_iter_end(&conn_iter);
321a95ae DV	270
	271	/* Don't return stale data (e.g. pending async disable). */
	272	if (uses_atomic)
	273	return NULL;
	274
	275	return encoder->crtc;
	276	}
	277
321a95ae DV	278	int drm_mode_getencoder(struct drm_device dev, void data,
	279	struct drm_file *file_priv)
	280	{
	281	struct drm_mode_get_encoder *enc_resp = data;
	282	struct drm_encoder *encoder;
	283	struct drm_crtc *crtc;
	284
	285	if (!drm_core_check_feature(dev, DRIVER_MODESET))
69fdf420	286	return -EOPNOTSUPP;
321a95ae	287
418da172	288	encoder = drm_encoder_find(dev, file_priv, enc_resp->encoder_id);
321a95ae DV	289	if (!encoder)
	290	return -ENOENT;
	291
	292	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
	293	crtc = drm_encoder_get_crtc(encoder);
7de440db	294	if (crtc && drm_lease_held(file_priv, crtc->base.id))
321a95ae DV	295	enc_resp->crtc_id = crtc->base.id;
	296	else
	297	enc_resp->crtc_id = 0;
	298	drm_modeset_unlock(&dev->mode_config.connection_mutex);
	299
	300	enc_resp->encoder_type = encoder->encoder_type;
	301	enc_resp->encoder_id = encoder->base.id;
7de440db KP	302	enc_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv,
7de440db KP	303	encoder->possible_crtcs);
321a95ae DV	304	enc_resp->possible_clones = encoder->possible_clones;
	305
	306	return 0;
	307	}