1/*
2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
4 * Copyright (c) 2008 Red Hat Inc.
5 *
6 * DRM core CRTC related functions
7 *
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission.  The copyright holders make no representations
15 * about the suitability of this software for any purpose.  It is provided "as
16 * is" without express or implied warranty.
17 *
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24 * OF THIS SOFTWARE.
25 *
26 * Authors:
27 *      Keith Packard
28 *	Eric Anholt <eric@anholt.net>
29 *      Dave Airlie <airlied@linux.ie>
30 *      Jesse Barnes <jesse.barnes@intel.com>
31 */
32#include <linux/ctype.h>
33#include <linux/list.h>
34#include <linux/slab.h>
35#include <linux/export.h>
36#include <drm/drmP.h>
37#include <drm/drm_crtc.h>
38#include <drm/drm_edid.h>
39#include <drm/drm_fourcc.h>
40#include <drm/drm_modeset_lock.h>
41
42#include "drm_crtc_internal.h"
43#include "drm_internal.h"
44
45static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
46							struct drm_mode_fb_cmd2 *r,
47							struct drm_file *file_priv);
48
49/* Avoid boilerplate.  I'm tired of typing. */
50#define DRM_ENUM_NAME_FN(fnname, list)				\
51	const char *fnname(int val)				\
52	{							\
53		int i;						\
54		for (i = 0; i < ARRAY_SIZE(list); i++) {	\
55			if (list[i].type == val)		\
56				return list[i].name;		\
57		}						\
58		return "(unknown)";				\
59	}
60
61/*
62 * Global properties
63 */
64static const struct drm_prop_enum_list drm_dpms_enum_list[] =
65{	{ DRM_MODE_DPMS_ON, "On" },
66	{ DRM_MODE_DPMS_STANDBY, "Standby" },
67	{ DRM_MODE_DPMS_SUSPEND, "Suspend" },
68	{ DRM_MODE_DPMS_OFF, "Off" }
69};
70
71DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
72
73static const struct drm_prop_enum_list drm_plane_type_enum_list[] =
74{
75	{ DRM_PLANE_TYPE_OVERLAY, "Overlay" },
76	{ DRM_PLANE_TYPE_PRIMARY, "Primary" },
77	{ DRM_PLANE_TYPE_CURSOR, "Cursor" },
78};
79
80/*
81 * Optional properties
82 */
83static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] =
84{
85	{ DRM_MODE_SCALE_NONE, "None" },
86	{ DRM_MODE_SCALE_FULLSCREEN, "Full" },
87	{ DRM_MODE_SCALE_CENTER, "Center" },
88	{ DRM_MODE_SCALE_ASPECT, "Full aspect" },
89};
90
91static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
92	{ DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
93	{ DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
94	{ DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
95};
96
97/*
98 * Non-global properties, but "required" for certain connectors.
99 */
100static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] =
101{
102	{ DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
103	{ DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
104	{ DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
105};
106
107DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
108
109static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] =
110{
111	{ DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
112	{ DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
113	{ DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
114};
115
116DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
117		 drm_dvi_i_subconnector_enum_list)
118
119static const struct drm_prop_enum_list drm_tv_select_enum_list[] =
120{
121	{ DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
122	{ DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
123	{ DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
124	{ DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
125	{ DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
126};
127
128DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
129
130static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] =
131{
132	{ DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
133	{ DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
134	{ DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
135	{ DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
136	{ DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
137};
138
139DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
140		 drm_tv_subconnector_enum_list)
141
142static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
143	{ DRM_MODE_DIRTY_OFF,      "Off"      },
144	{ DRM_MODE_DIRTY_ON,       "On"       },
145	{ DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
146};
147
148struct drm_conn_prop_enum_list {
149	int type;
150	const char *name;
151	struct ida ida;
152};
153
154/*
155 * Connector and encoder types.
156 */
157static struct drm_conn_prop_enum_list drm_connector_enum_list[] =
158{	{ DRM_MODE_CONNECTOR_Unknown, "Unknown" },
159	{ DRM_MODE_CONNECTOR_VGA, "VGA" },
160	{ DRM_MODE_CONNECTOR_DVII, "DVI-I" },
161	{ DRM_MODE_CONNECTOR_DVID, "DVI-D" },
162	{ DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
163	{ DRM_MODE_CONNECTOR_Composite, "Composite" },
164	{ DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
165	{ DRM_MODE_CONNECTOR_LVDS, "LVDS" },
166	{ DRM_MODE_CONNECTOR_Component, "Component" },
167	{ DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
168	{ DRM_MODE_CONNECTOR_DisplayPort, "DP" },
169	{ DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
170	{ DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
171	{ DRM_MODE_CONNECTOR_TV, "TV" },
172	{ DRM_MODE_CONNECTOR_eDP, "eDP" },
173	{ DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
174	{ DRM_MODE_CONNECTOR_DSI, "DSI" },
175};
176
177static const struct drm_prop_enum_list drm_encoder_enum_list[] =
178{	{ DRM_MODE_ENCODER_NONE, "None" },
179	{ DRM_MODE_ENCODER_DAC, "DAC" },
180	{ DRM_MODE_ENCODER_TMDS, "TMDS" },
181	{ DRM_MODE_ENCODER_LVDS, "LVDS" },
182	{ DRM_MODE_ENCODER_TVDAC, "TV" },
183	{ DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
184	{ DRM_MODE_ENCODER_DSI, "DSI" },
185	{ DRM_MODE_ENCODER_DPMST, "DP MST" },
186};
187
188static const struct drm_prop_enum_list drm_subpixel_enum_list[] =
189{
190	{ SubPixelUnknown, "Unknown" },
191	{ SubPixelHorizontalRGB, "Horizontal RGB" },
192	{ SubPixelHorizontalBGR, "Horizontal BGR" },
193	{ SubPixelVerticalRGB, "Vertical RGB" },
194	{ SubPixelVerticalBGR, "Vertical BGR" },
195	{ SubPixelNone, "None" },
196};
197
198void drm_connector_ida_init(void)
199{
200	int i;
201
202	for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
203		ida_init(&drm_connector_enum_list[i].ida);
204}
205
206void drm_connector_ida_destroy(void)
207{
208	int i;
209
210	for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
211		ida_destroy(&drm_connector_enum_list[i].ida);
212}
213
214/**
215 * drm_get_connector_status_name - return a string for connector status
216 * @status: connector status to compute name of
217 *
218 * In contrast to the other drm_get_*_name functions this one here returns a
219 * const pointer and hence is threadsafe.
220 */
221const char *drm_get_connector_status_name(enum drm_connector_status status)
222{
223	if (status == connector_status_connected)
224		return "connected";
225	else if (status == connector_status_disconnected)
226		return "disconnected";
227	else
228		return "unknown";
229}
230EXPORT_SYMBOL(drm_get_connector_status_name);
231
232/**
233 * drm_get_subpixel_order_name - return a string for a given subpixel enum
234 * @order: enum of subpixel_order
235 *
236 * Note you could abuse this and return something out of bounds, but that
237 * would be a caller error.  No unscrubbed user data should make it here.
238 */
239const char *drm_get_subpixel_order_name(enum subpixel_order order)
240{
241	return drm_subpixel_enum_list[order].name;
242}
243EXPORT_SYMBOL(drm_get_subpixel_order_name);
244
245static char printable_char(int c)
246{
247	return isascii(c) && isprint(c) ? c : '?';
248}
249
250/**
251 * drm_get_format_name - return a string for drm fourcc format
252 * @format: format to compute name of
253 *
254 * Note that the buffer used by this function is globally shared and owned by
255 * the function itself.
256 *
257 * FIXME: This isn't really multithreading safe.
258 */
259const char *drm_get_format_name(uint32_t format)
260{
261	static char buf[32];
262
263	snprintf(buf, sizeof(buf),
264		 "%c%c%c%c %s-endian (0x%08x)",
265		 printable_char(format & 0xff),
266		 printable_char((format >> 8) & 0xff),
267		 printable_char((format >> 16) & 0xff),
268		 printable_char((format >> 24) & 0x7f),
269		 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
270		 format);
271
272	return buf;
273}
274EXPORT_SYMBOL(drm_get_format_name);
275
276/*
277 * Internal function to assign a slot in the object idr and optionally
278 * register the object into the idr.
279 */
280static int drm_mode_object_get_reg(struct drm_device *dev,
281				   struct drm_mode_object *obj,
282				   uint32_t obj_type,
283				   bool register_obj)
284{
285	int ret;
286
287	mutex_lock(&dev->mode_config.idr_mutex);
288	ret = idr_alloc(&dev->mode_config.crtc_idr, register_obj ? obj : NULL, 1, 0, GFP_KERNEL);
289	if (ret >= 0) {
290		/*
291		 * Set up the object linking under the protection of the idr
292		 * lock so that other users can't see inconsistent state.
293		 */
294		obj->id = ret;
295		obj->type = obj_type;
296	}
297	mutex_unlock(&dev->mode_config.idr_mutex);
298
299	return ret < 0 ? ret : 0;
300}
301
302/**
303 * drm_mode_object_get - allocate a new modeset identifier
304 * @dev: DRM device
305 * @obj: object pointer, used to generate unique ID
306 * @obj_type: object type
307 *
308 * Create a unique identifier based on @ptr in @dev's identifier space.  Used
309 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
310 * modeset identifiers are _not_ reference counted. Hence don't use this for
311 * reference counted modeset objects like framebuffers.
312 *
313 * Returns:
314 * New unique (relative to other objects in @dev) integer identifier for the
315 * object.
316 */
317int drm_mode_object_get(struct drm_device *dev,
318			struct drm_mode_object *obj, uint32_t obj_type)
319{
320	return drm_mode_object_get_reg(dev, obj, obj_type, true);
321}
322
323static void drm_mode_object_register(struct drm_device *dev,
324				     struct drm_mode_object *obj)
325{
326	mutex_lock(&dev->mode_config.idr_mutex);
327	idr_replace(&dev->mode_config.crtc_idr, obj, obj->id);
328	mutex_unlock(&dev->mode_config.idr_mutex);
329}
330
331/**
332 * drm_mode_object_put - free a modeset identifer
333 * @dev: DRM device
334 * @object: object to free
335 *
336 * Free @id from @dev's unique identifier pool. Note that despite the _get
337 * postfix modeset identifiers are _not_ reference counted. Hence don't use this
338 * for reference counted modeset objects like framebuffers.
339 */
340void drm_mode_object_put(struct drm_device *dev,
341			 struct drm_mode_object *object)
342{
343	mutex_lock(&dev->mode_config.idr_mutex);
344	idr_remove(&dev->mode_config.crtc_idr, object->id);
345	mutex_unlock(&dev->mode_config.idr_mutex);
346}
347
348static struct drm_mode_object *_object_find(struct drm_device *dev,
349		uint32_t id, uint32_t type)
350{
351	struct drm_mode_object *obj = NULL;
352
353	mutex_lock(&dev->mode_config.idr_mutex);
354	obj = idr_find(&dev->mode_config.crtc_idr, id);
355	if (obj && type != DRM_MODE_OBJECT_ANY && obj->type != type)
356		obj = NULL;
357	if (obj && obj->id != id)
358		obj = NULL;
359	/* don't leak out unref'd fb's */
360	if (obj && (obj->type == DRM_MODE_OBJECT_FB))
361		obj = NULL;
362	mutex_unlock(&dev->mode_config.idr_mutex);
363
364	return obj;
365}
366
367/**
368 * drm_mode_object_find - look up a drm object with static lifetime
369 * @dev: drm device
370 * @id: id of the mode object
371 * @type: type of the mode object
372 *
373 * Note that framebuffers cannot be looked up with this functions - since those
374 * are reference counted, they need special treatment.  Even with
375 * DRM_MODE_OBJECT_ANY (although that will simply return NULL
376 * rather than WARN_ON()).
377 */
378struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
379		uint32_t id, uint32_t type)
380{
381	struct drm_mode_object *obj = NULL;
382
383	/* Framebuffers are reference counted and need their own lookup
384	 * function.*/
385	WARN_ON(type == DRM_MODE_OBJECT_FB);
386	obj = _object_find(dev, id, type);
387	return obj;
388}
389EXPORT_SYMBOL(drm_mode_object_find);
390
391/**
392 * drm_framebuffer_init - initialize a framebuffer
393 * @dev: DRM device
394 * @fb: framebuffer to be initialized
395 * @funcs: ... with these functions
396 *
397 * Allocates an ID for the framebuffer's parent mode object, sets its mode
398 * functions & device file and adds it to the master fd list.
399 *
400 * IMPORTANT:
401 * This functions publishes the fb and makes it available for concurrent access
402 * by other users. Which means by this point the fb _must_ be fully set up -
403 * since all the fb attributes are invariant over its lifetime, no further
404 * locking but only correct reference counting is required.
405 *
406 * Returns:
407 * Zero on success, error code on failure.
408 */
409int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
410			 const struct drm_framebuffer_funcs *funcs)
411{
412	int ret;
413
414	mutex_lock(&dev->mode_config.fb_lock);
415	kref_init(&fb->refcount);
416	INIT_LIST_HEAD(&fb->filp_head);
417	fb->dev = dev;
418	fb->funcs = funcs;
419
420	ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
421	if (ret)
422		goto out;
423
424	dev->mode_config.num_fb++;
425	list_add(&fb->head, &dev->mode_config.fb_list);
426out:
427	mutex_unlock(&dev->mode_config.fb_lock);
428
429	return 0;
430}
431EXPORT_SYMBOL(drm_framebuffer_init);
432
433/* dev->mode_config.fb_lock must be held! */
434static void __drm_framebuffer_unregister(struct drm_device *dev,
435					 struct drm_framebuffer *fb)
436{
437	mutex_lock(&dev->mode_config.idr_mutex);
438	idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
439	mutex_unlock(&dev->mode_config.idr_mutex);
440
441	fb->base.id = 0;
442}
443
444static void drm_framebuffer_free(struct kref *kref)
445{
446	struct drm_framebuffer *fb =
447			container_of(kref, struct drm_framebuffer, refcount);
448	struct drm_device *dev = fb->dev;
449
450	/*
451	 * The lookup idr holds a weak reference, which has not necessarily been
452	 * removed at this point. Check for that.
453	 */
454	mutex_lock(&dev->mode_config.fb_lock);
455	if (fb->base.id) {
456		/* Mark fb as reaped and drop idr ref. */
457		__drm_framebuffer_unregister(dev, fb);
458	}
459	mutex_unlock(&dev->mode_config.fb_lock);
460
461	fb->funcs->destroy(fb);
462}
463
464static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
465							uint32_t id)
466{
467	struct drm_mode_object *obj = NULL;
468	struct drm_framebuffer *fb;
469
470	mutex_lock(&dev->mode_config.idr_mutex);
471	obj = idr_find(&dev->mode_config.crtc_idr, id);
472	if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
473		fb = NULL;
474	else
475		fb = obj_to_fb(obj);
476	mutex_unlock(&dev->mode_config.idr_mutex);
477
478	return fb;
479}
480
481/**
482 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
483 * @dev: drm device
484 * @id: id of the fb object
485 *
486 * If successful, this grabs an additional reference to the framebuffer -
487 * callers need to make sure to eventually unreference the returned framebuffer
488 * again, using @drm_framebuffer_unreference.
489 */
490struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
491					       uint32_t id)
492{
493	struct drm_framebuffer *fb;
494
495	mutex_lock(&dev->mode_config.fb_lock);
496	fb = __drm_framebuffer_lookup(dev, id);
497	if (fb) {
498		if (!kref_get_unless_zero(&fb->refcount))
499			fb = NULL;
500	}
501	mutex_unlock(&dev->mode_config.fb_lock);
502
503	return fb;
504}
505EXPORT_SYMBOL(drm_framebuffer_lookup);
506
507/**
508 * drm_framebuffer_unreference - unref a framebuffer
509 * @fb: framebuffer to unref
510 *
511 * This functions decrements the fb's refcount and frees it if it drops to zero.
512 */
513void drm_framebuffer_unreference(struct drm_framebuffer *fb)
514{
515	DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
516	kref_put(&fb->refcount, drm_framebuffer_free);
517}
518EXPORT_SYMBOL(drm_framebuffer_unreference);
519
520/**
521 * drm_framebuffer_reference - incr the fb refcnt
522 * @fb: framebuffer
523 *
524 * This functions increments the fb's refcount.
525 */
526void drm_framebuffer_reference(struct drm_framebuffer *fb)
527{
528	DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
529	kref_get(&fb->refcount);
530}
531EXPORT_SYMBOL(drm_framebuffer_reference);
532
533static void drm_framebuffer_free_bug(struct kref *kref)
534{
535	BUG();
536}
537
538static void __drm_framebuffer_unreference(struct drm_framebuffer *fb)
539{
540	DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
541	kref_put(&fb->refcount, drm_framebuffer_free_bug);
542}
543
544/**
545 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
546 * @fb: fb to unregister
547 *
548 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
549 * those used for fbdev. Note that the caller must hold a reference of it's own,
550 * i.e. the object may not be destroyed through this call (since it'll lead to a
551 * locking inversion).
552 */
553void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
554{
555	struct drm_device *dev = fb->dev;
556
557	mutex_lock(&dev->mode_config.fb_lock);
558	/* Mark fb as reaped and drop idr ref. */
559	__drm_framebuffer_unregister(dev, fb);
560	mutex_unlock(&dev->mode_config.fb_lock);
561}
562EXPORT_SYMBOL(drm_framebuffer_unregister_private);
563
564/**
565 * drm_framebuffer_cleanup - remove a framebuffer object
566 * @fb: framebuffer to remove
567 *
568 * Cleanup framebuffer. This function is intended to be used from the drivers
569 * ->destroy callback. It can also be used to clean up driver private
570 *  framebuffers embedded into a larger structure.
571 *
572 * Note that this function does not remove the fb from active usuage - if it is
573 * still used anywhere, hilarity can ensue since userspace could call getfb on
574 * the id and get back -EINVAL. Obviously no concern at driver unload time.
575 *
576 * Also, the framebuffer will not be removed from the lookup idr - for
577 * user-created framebuffers this will happen in in the rmfb ioctl. For
578 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
579 * drm_framebuffer_unregister_private.
580 */
581void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
582{
583	struct drm_device *dev = fb->dev;
584
585	mutex_lock(&dev->mode_config.fb_lock);
586	list_del(&fb->head);
587	dev->mode_config.num_fb--;
588	mutex_unlock(&dev->mode_config.fb_lock);
589}
590EXPORT_SYMBOL(drm_framebuffer_cleanup);
591
592/**
593 * drm_framebuffer_remove - remove and unreference a framebuffer object
594 * @fb: framebuffer to remove
595 *
596 * Scans all the CRTCs and planes in @dev's mode_config.  If they're
597 * using @fb, removes it, setting it to NULL. Then drops the reference to the
598 * passed-in framebuffer. Might take the modeset locks.
599 *
600 * Note that this function optimizes the cleanup away if the caller holds the
601 * last reference to the framebuffer. It is also guaranteed to not take the
602 * modeset locks in this case.
603 */
604void drm_framebuffer_remove(struct drm_framebuffer *fb)
605{
606	struct drm_device *dev = fb->dev;
607	struct drm_crtc *crtc;
608	struct drm_plane *plane;
609	struct drm_mode_set set;
610	int ret;
611
612	WARN_ON(!list_empty(&fb->filp_head));
613
614	/*
615	 * drm ABI mandates that we remove any deleted framebuffers from active
616	 * useage. But since most sane clients only remove framebuffers they no
617	 * longer need, try to optimize this away.
618	 *
619	 * Since we're holding a reference ourselves, observing a refcount of 1
620	 * means that we're the last holder and can skip it. Also, the refcount
621	 * can never increase from 1 again, so we don't need any barriers or
622	 * locks.
623	 *
624	 * Note that userspace could try to race with use and instate a new
625	 * usage _after_ we've cleared all current ones. End result will be an
626	 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
627	 * in this manner.
628	 */
629	if (atomic_read(&fb->refcount.refcount) > 1) {
630		drm_modeset_lock_all(dev);
631		/* remove from any CRTC */
632		list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
633			if (crtc->primary->fb == fb) {
634				/* should turn off the crtc */
635				memset(&set, 0, sizeof(struct drm_mode_set));
636				set.crtc = crtc;
637				set.fb = NULL;
638				ret = drm_mode_set_config_internal(&set);
639				if (ret)
640					DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
641			}
642		}
643
644		list_for_each_entry(plane, &dev->mode_config.plane_list, head) {
645			if (plane->fb == fb)
646				drm_plane_force_disable(plane);
647		}
648		drm_modeset_unlock_all(dev);
649	}
650
651	drm_framebuffer_unreference(fb);
652}
653EXPORT_SYMBOL(drm_framebuffer_remove);
654
655DEFINE_WW_CLASS(crtc_ww_class);
656
657/**
658 * drm_crtc_init_with_planes - Initialise a new CRTC object with
659 *    specified primary and cursor planes.
660 * @dev: DRM device
661 * @crtc: CRTC object to init
662 * @primary: Primary plane for CRTC
663 * @cursor: Cursor plane for CRTC
664 * @funcs: callbacks for the new CRTC
665 *
666 * Inits a new object created as base part of a driver crtc object.
667 *
668 * Returns:
669 * Zero on success, error code on failure.
670 */
671int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
672			      struct drm_plane *primary,
673			      struct drm_plane *cursor,
674			      const struct drm_crtc_funcs *funcs)
675{
676	struct drm_mode_config *config = &dev->mode_config;
677	int ret;
678
679	crtc->dev = dev;
680	crtc->funcs = funcs;
681	crtc->invert_dimensions = false;
682
683	drm_modeset_lock_init(&crtc->mutex);
684	ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
685	if (ret)
686		goto out;
687
688	crtc->base.properties = &crtc->properties;
689
690	list_add_tail(&crtc->head, &config->crtc_list);
691	config->num_crtc++;
692
693	crtc->primary = primary;
694	crtc->cursor = cursor;
695	if (primary)
696		primary->possible_crtcs = 1 << drm_crtc_index(crtc);
697	if (cursor)
698		cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
699
700 out:
701
702	return ret;
703}
704EXPORT_SYMBOL(drm_crtc_init_with_planes);
705
706/**
707 * drm_crtc_cleanup - Clean up the core crtc usage
708 * @crtc: CRTC to cleanup
709 *
710 * This function cleans up @crtc and removes it from the DRM mode setting
711 * core. Note that the function does *not* free the crtc structure itself,
712 * this is the responsibility of the caller.
713 */
714void drm_crtc_cleanup(struct drm_crtc *crtc)
715{
716	struct drm_device *dev = crtc->dev;
717
718	kfree(crtc->gamma_store);
719	crtc->gamma_store = NULL;
720
721	drm_modeset_lock_fini(&crtc->mutex);
722
723	drm_mode_object_put(dev, &crtc->base);
724	list_del(&crtc->head);
725	dev->mode_config.num_crtc--;
726}
727EXPORT_SYMBOL(drm_crtc_cleanup);
728
729/**
730 * drm_crtc_index - find the index of a registered CRTC
731 * @crtc: CRTC to find index for
732 *
733 * Given a registered CRTC, return the index of that CRTC within a DRM
734 * device's list of CRTCs.
735 */
736unsigned int drm_crtc_index(struct drm_crtc *crtc)
737{
738	unsigned int index = 0;
739	struct drm_crtc *tmp;
740
741	list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
742		if (tmp == crtc)
743			return index;
744
745		index++;
746	}
747
748	BUG();
749}
750EXPORT_SYMBOL(drm_crtc_index);
751
752/*
753 * drm_mode_remove - remove and free a mode
754 * @connector: connector list to modify
755 * @mode: mode to remove
756 *
757 * Remove @mode from @connector's mode list, then free it.
758 */
759static void drm_mode_remove(struct drm_connector *connector,
760			    struct drm_display_mode *mode)
761{
762	list_del(&mode->head);
763	drm_mode_destroy(connector->dev, mode);
764}
765
766/**
767 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
768 * @connector: connector to quwery
769 * @mode: returned mode
770 *
771 * The kernel supports per-connector configration of its consoles through
772 * use of the video= parameter. This function parses that option and
773 * extracts the user's specified mode (or enable/disable status) for a
774 * particular connector. This is typically only used during the early fbdev
775 * setup.
776 */
777static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
778{
779	struct drm_cmdline_mode *mode = &connector->cmdline_mode;
780	char *option = NULL;
781
782	if (fb_get_options(connector->name, &option))
783		return;
784
785	if (!drm_mode_parse_command_line_for_connector(option,
786						       connector,
787						       mode))
788		return;
789
790	if (mode->force) {
791		const char *s;
792
793		switch (mode->force) {
794		case DRM_FORCE_OFF:
795			s = "OFF";
796			break;
797		case DRM_FORCE_ON_DIGITAL:
798			s = "ON - dig";
799			break;
800		default:
801		case DRM_FORCE_ON:
802			s = "ON";
803			break;
804		}
805
806		DRM_INFO("forcing %s connector %s\n", connector->name, s);
807		connector->force = mode->force;
808	}
809
810	DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
811		      connector->name,
812		      mode->xres, mode->yres,
813		      mode->refresh_specified ? mode->refresh : 60,
814		      mode->rb ? " reduced blanking" : "",
815		      mode->margins ? " with margins" : "",
816		      mode->interlace ?  " interlaced" : "");
817}
818
819/**
820 * drm_connector_init - Init a preallocated connector
821 * @dev: DRM device
822 * @connector: the connector to init
823 * @funcs: callbacks for this connector
824 * @connector_type: user visible type of the connector
825 *
826 * Initialises a preallocated connector. Connectors should be
827 * subclassed as part of driver connector objects.
828 *
829 * Returns:
830 * Zero on success, error code on failure.
831 */
832int drm_connector_init(struct drm_device *dev,
833		       struct drm_connector *connector,
834		       const struct drm_connector_funcs *funcs,
835		       int connector_type)
836{
837	int ret;
838	struct ida *connector_ida =
839		&drm_connector_enum_list[connector_type].ida;
840
841	drm_modeset_lock_all(dev);
842
843	ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
844	if (ret)
845		goto out_unlock;
846
847	connector->base.properties = &connector->properties;
848	connector->dev = dev;
849	connector->funcs = funcs;
850	connector->connector_type = connector_type;
851	connector->connector_type_id =
852		ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
853	if (connector->connector_type_id < 0) {
854		ret = connector->connector_type_id;
855		goto out_put;
856	}
857	connector->name =
858		kasprintf(GFP_KERNEL, "%s-%d",
859			  drm_connector_enum_list[connector_type].name,
860			  connector->connector_type_id);
861	if (!connector->name) {
862		ret = -ENOMEM;
863		goto out_put;
864	}
865
866	INIT_LIST_HEAD(&connector->probed_modes);
867	INIT_LIST_HEAD(&connector->modes);
868	connector->edid_blob_ptr = NULL;
869	connector->status = connector_status_unknown;
870
871	drm_connector_get_cmdline_mode(connector);
872
873	list_add_tail(&connector->head, &dev->mode_config.connector_list);
874	dev->mode_config.num_connector++;
875
876	if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
877		drm_object_attach_property(&connector->base,
878					      dev->mode_config.edid_property,
879					      0);
880
881	drm_object_attach_property(&connector->base,
882				      dev->mode_config.dpms_property, 0);
883
884	connector->debugfs_entry = NULL;
885
886out_put:
887	if (ret)
888		drm_mode_object_put(dev, &connector->base);
889
890out_unlock:
891	drm_modeset_unlock_all(dev);
892
893	return ret;
894}
895EXPORT_SYMBOL(drm_connector_init);
896
897/**
898 * drm_connector_cleanup - cleans up an initialised connector
899 * @connector: connector to cleanup
900 *
901 * Cleans up the connector but doesn't free the object.
902 */
903void drm_connector_cleanup(struct drm_connector *connector)
904{
905	struct drm_device *dev = connector->dev;
906	struct drm_display_mode *mode, *t;
907
908	list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
909		drm_mode_remove(connector, mode);
910
911	list_for_each_entry_safe(mode, t, &connector->modes, head)
912		drm_mode_remove(connector, mode);
913
914	ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
915		   connector->connector_type_id);
916
917	drm_mode_object_put(dev, &connector->base);
918	kfree(connector->name);
919	connector->name = NULL;
920	list_del(&connector->head);
921	dev->mode_config.num_connector--;
922}
923EXPORT_SYMBOL(drm_connector_cleanup);
924
925/**
926 * drm_connector_index - find the index of a registered connector
927 * @connector: connector to find index for
928 *
929 * Given a registered connector, return the index of that connector within a DRM
930 * device's list of connectors.
931 */
932unsigned int drm_connector_index(struct drm_connector *connector)
933{
934	unsigned int index = 0;
935	struct drm_connector *tmp;
936
937	list_for_each_entry(tmp, &connector->dev->mode_config.connector_list, head) {
938		if (tmp == connector)
939			return index;
940
941		index++;
942	}
943
944	BUG();
945}
946EXPORT_SYMBOL(drm_connector_index);
947
948/**
949 * drm_connector_register - register a connector
950 * @connector: the connector to register
951 *
952 * Register userspace interfaces for a connector
953 *
954 * Returns:
955 * Zero on success, error code on failure.
956 */
957int drm_connector_register(struct drm_connector *connector)
958{
959	int ret;
960
961	drm_mode_object_register(connector->dev, &connector->base);
962
963	ret = drm_sysfs_connector_add(connector);
964	if (ret)
965		return ret;
966
967	ret = drm_debugfs_connector_add(connector);
968	if (ret) {
969		drm_sysfs_connector_remove(connector);
970		return ret;
971	}
972
973	return 0;
974}
975EXPORT_SYMBOL(drm_connector_register);
976
977/**
978 * drm_connector_unregister - unregister a connector
979 * @connector: the connector to unregister
980 *
981 * Unregister userspace interfaces for a connector
982 */
983void drm_connector_unregister(struct drm_connector *connector)
984{
985	drm_sysfs_connector_remove(connector);
986	drm_debugfs_connector_remove(connector);
987}
988EXPORT_SYMBOL(drm_connector_unregister);
989
990
991/**
992 * drm_connector_unplug_all - unregister connector userspace interfaces
993 * @dev: drm device
994 *
995 * This function unregisters all connector userspace interfaces in sysfs. Should
996 * be call when the device is disconnected, e.g. from an usb driver's
997 * ->disconnect callback.
998 */
999void drm_connector_unplug_all(struct drm_device *dev)
1000{
1001	struct drm_connector *connector;
1002
1003	/* taking the mode config mutex ends up in a clash with sysfs */
1004	list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1005		drm_connector_unregister(connector);
1006
1007}
1008EXPORT_SYMBOL(drm_connector_unplug_all);
1009
1010/**
1011 * drm_bridge_init - initialize a drm transcoder/bridge
1012 * @dev: drm device
1013 * @bridge: transcoder/bridge to set up
1014 * @funcs: bridge function table
1015 *
1016 * Initialises a preallocated bridge. Bridges should be
1017 * subclassed as part of driver connector objects.
1018 *
1019 * Returns:
1020 * Zero on success, error code on failure.
1021 */
1022int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
1023		const struct drm_bridge_funcs *funcs)
1024{
1025	int ret;
1026
1027	drm_modeset_lock_all(dev);
1028
1029	ret = drm_mode_object_get(dev, &bridge->base, DRM_MODE_OBJECT_BRIDGE);
1030	if (ret)
1031		goto out;
1032
1033	bridge->dev = dev;
1034	bridge->funcs = funcs;
1035
1036	list_add_tail(&bridge->head, &dev->mode_config.bridge_list);
1037	dev->mode_config.num_bridge++;
1038
1039 out:
1040	drm_modeset_unlock_all(dev);
1041	return ret;
1042}
1043EXPORT_SYMBOL(drm_bridge_init);
1044
1045/**
1046 * drm_bridge_cleanup - cleans up an initialised bridge
1047 * @bridge: bridge to cleanup
1048 *
1049 * Cleans up the bridge but doesn't free the object.
1050 */
1051void drm_bridge_cleanup(struct drm_bridge *bridge)
1052{
1053	struct drm_device *dev = bridge->dev;
1054
1055	drm_modeset_lock_all(dev);
1056	drm_mode_object_put(dev, &bridge->base);
1057	list_del(&bridge->head);
1058	dev->mode_config.num_bridge--;
1059	drm_modeset_unlock_all(dev);
1060}
1061EXPORT_SYMBOL(drm_bridge_cleanup);
1062
1063/**
1064 * drm_encoder_init - Init a preallocated encoder
1065 * @dev: drm device
1066 * @encoder: the encoder to init
1067 * @funcs: callbacks for this encoder
1068 * @encoder_type: user visible type of the encoder
1069 *
1070 * Initialises a preallocated encoder. Encoder should be
1071 * subclassed as part of driver encoder objects.
1072 *
1073 * Returns:
1074 * Zero on success, error code on failure.
1075 */
1076int drm_encoder_init(struct drm_device *dev,
1077		      struct drm_encoder *encoder,
1078		      const struct drm_encoder_funcs *funcs,
1079		      int encoder_type)
1080{
1081	int ret;
1082
1083	drm_modeset_lock_all(dev);
1084
1085	ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1086	if (ret)
1087		goto out_unlock;
1088
1089	encoder->dev = dev;
1090	encoder->encoder_type = encoder_type;
1091	encoder->funcs = funcs;
1092	encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1093				  drm_encoder_enum_list[encoder_type].name,
1094				  encoder->base.id);
1095	if (!encoder->name) {
1096		ret = -ENOMEM;
1097		goto out_put;
1098	}
1099
1100	list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1101	dev->mode_config.num_encoder++;
1102
1103out_put:
1104	if (ret)
1105		drm_mode_object_put(dev, &encoder->base);
1106
1107out_unlock:
1108	drm_modeset_unlock_all(dev);
1109
1110	return ret;
1111}
1112EXPORT_SYMBOL(drm_encoder_init);
1113
1114/**
1115 * drm_encoder_cleanup - cleans up an initialised encoder
1116 * @encoder: encoder to cleanup
1117 *
1118 * Cleans up the encoder but doesn't free the object.
1119 */
1120void drm_encoder_cleanup(struct drm_encoder *encoder)
1121{
1122	struct drm_device *dev = encoder->dev;
1123	drm_modeset_lock_all(dev);
1124	drm_mode_object_put(dev, &encoder->base);
1125	kfree(encoder->name);
1126	encoder->name = NULL;
1127	list_del(&encoder->head);
1128	dev->mode_config.num_encoder--;
1129	drm_modeset_unlock_all(dev);
1130}
1131EXPORT_SYMBOL(drm_encoder_cleanup);
1132
1133/**
1134 * drm_universal_plane_init - Initialize a new universal plane object
1135 * @dev: DRM device
1136 * @plane: plane object to init
1137 * @possible_crtcs: bitmask of possible CRTCs
1138 * @funcs: callbacks for the new plane
1139 * @formats: array of supported formats (%DRM_FORMAT_*)
1140 * @format_count: number of elements in @formats
1141 * @type: type of plane (overlay, primary, cursor)
1142 *
1143 * Initializes a plane object of type @type.
1144 *
1145 * Returns:
1146 * Zero on success, error code on failure.
1147 */
1148int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1149			     unsigned long possible_crtcs,
1150			     const struct drm_plane_funcs *funcs,
1151			     const uint32_t *formats, uint32_t format_count,
1152			     enum drm_plane_type type)
1153{
1154	int ret;
1155
1156	drm_modeset_lock_all(dev);
1157
1158	ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1159	if (ret)
1160		goto out;
1161
1162	plane->base.properties = &plane->properties;
1163	plane->dev = dev;
1164	plane->funcs = funcs;
1165	plane->format_types = kmalloc(sizeof(uint32_t) * format_count,
1166				      GFP_KERNEL);
1167	if (!plane->format_types) {
1168		DRM_DEBUG_KMS("out of memory when allocating plane\n");
1169		drm_mode_object_put(dev, &plane->base);
1170		ret = -ENOMEM;
1171		goto out;
1172	}
1173
1174	memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1175	plane->format_count = format_count;
1176	plane->possible_crtcs = possible_crtcs;
1177	plane->type = type;
1178
1179	list_add_tail(&plane->head, &dev->mode_config.plane_list);
1180	dev->mode_config.num_total_plane++;
1181	if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1182		dev->mode_config.num_overlay_plane++;
1183
1184	drm_object_attach_property(&plane->base,
1185				   dev->mode_config.plane_type_property,
1186				   plane->type);
1187
1188 out:
1189	drm_modeset_unlock_all(dev);
1190
1191	return ret;
1192}
1193EXPORT_SYMBOL(drm_universal_plane_init);
1194
1195/**
1196 * drm_plane_init - Initialize a legacy plane
1197 * @dev: DRM device
1198 * @plane: plane object to init
1199 * @possible_crtcs: bitmask of possible CRTCs
1200 * @funcs: callbacks for the new plane
1201 * @formats: array of supported formats (%DRM_FORMAT_*)
1202 * @format_count: number of elements in @formats
1203 * @is_primary: plane type (primary vs overlay)
1204 *
1205 * Legacy API to initialize a DRM plane.
1206 *
1207 * New drivers should call drm_universal_plane_init() instead.
1208 *
1209 * Returns:
1210 * Zero on success, error code on failure.
1211 */
1212int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1213		   unsigned long possible_crtcs,
1214		   const struct drm_plane_funcs *funcs,
1215		   const uint32_t *formats, uint32_t format_count,
1216		   bool is_primary)
1217{
1218	enum drm_plane_type type;
1219
1220	type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1221	return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1222					formats, format_count, type);
1223}
1224EXPORT_SYMBOL(drm_plane_init);
1225
1226/**
1227 * drm_plane_cleanup - Clean up the core plane usage
1228 * @plane: plane to cleanup
1229 *
1230 * This function cleans up @plane and removes it from the DRM mode setting
1231 * core. Note that the function does *not* free the plane structure itself,
1232 * this is the responsibility of the caller.
1233 */
1234void drm_plane_cleanup(struct drm_plane *plane)
1235{
1236	struct drm_device *dev = plane->dev;
1237
1238	drm_modeset_lock_all(dev);
1239	kfree(plane->format_types);
1240	drm_mode_object_put(dev, &plane->base);
1241
1242	BUG_ON(list_empty(&plane->head));
1243
1244	list_del(&plane->head);
1245	dev->mode_config.num_total_plane--;
1246	if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1247		dev->mode_config.num_overlay_plane--;
1248	drm_modeset_unlock_all(dev);
1249}
1250EXPORT_SYMBOL(drm_plane_cleanup);
1251
1252/**
1253 * drm_plane_index - find the index of a registered plane
1254 * @plane: plane to find index for
1255 *
1256 * Given a registered plane, return the index of that CRTC within a DRM
1257 * device's list of planes.
1258 */
1259unsigned int drm_plane_index(struct drm_plane *plane)
1260{
1261	unsigned int index = 0;
1262	struct drm_plane *tmp;
1263
1264	list_for_each_entry(tmp, &plane->dev->mode_config.plane_list, head) {
1265		if (tmp == plane)
1266			return index;
1267
1268		index++;
1269	}
1270
1271	BUG();
1272}
1273EXPORT_SYMBOL(drm_plane_index);
1274
1275/**
1276 * drm_plane_force_disable - Forcibly disable a plane
1277 * @plane: plane to disable
1278 *
1279 * Forces the plane to be disabled.
1280 *
1281 * Used when the plane's current framebuffer is destroyed,
1282 * and when restoring fbdev mode.
1283 */
1284void drm_plane_force_disable(struct drm_plane *plane)
1285{
1286	int ret;
1287
1288	if (!plane->fb)
1289		return;
1290
1291	plane->old_fb = plane->fb;
1292	ret = plane->funcs->disable_plane(plane);
1293	if (ret) {
1294		DRM_ERROR("failed to disable plane with busy fb\n");
1295		plane->old_fb = NULL;
1296		return;
1297	}
1298	/* disconnect the plane from the fb and crtc: */
1299	__drm_framebuffer_unreference(plane->old_fb);
1300	plane->old_fb = NULL;
1301	plane->fb = NULL;
1302	plane->crtc = NULL;
1303}
1304EXPORT_SYMBOL(drm_plane_force_disable);
1305
1306static int drm_mode_create_standard_connector_properties(struct drm_device *dev)
1307{
1308	struct drm_property *edid;
1309	struct drm_property *dpms;
1310	struct drm_property *dev_path;
1311
1312	/*
1313	 * Standard properties (apply to all connectors)
1314	 */
1315	edid = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1316				   DRM_MODE_PROP_IMMUTABLE,
1317				   "EDID", 0);
1318	dev->mode_config.edid_property = edid;
1319
1320	dpms = drm_property_create_enum(dev, 0,
1321				   "DPMS", drm_dpms_enum_list,
1322				   ARRAY_SIZE(drm_dpms_enum_list));
1323	dev->mode_config.dpms_property = dpms;
1324
1325	dev_path = drm_property_create(dev,
1326				       DRM_MODE_PROP_BLOB |
1327				       DRM_MODE_PROP_IMMUTABLE,
1328				       "PATH", 0);
1329	dev->mode_config.path_property = dev_path;
1330
1331	return 0;
1332}
1333
1334static int drm_mode_create_standard_plane_properties(struct drm_device *dev)
1335{
1336	struct drm_property *type;
1337
1338	/*
1339	 * Standard properties (apply to all planes)
1340	 */
1341	type = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1342					"type", drm_plane_type_enum_list,
1343					ARRAY_SIZE(drm_plane_type_enum_list));
1344	dev->mode_config.plane_type_property = type;
1345
1346	return 0;
1347}
1348
1349/**
1350 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1351 * @dev: DRM device
1352 *
1353 * Called by a driver the first time a DVI-I connector is made.
1354 */
1355int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1356{
1357	struct drm_property *dvi_i_selector;
1358	struct drm_property *dvi_i_subconnector;
1359
1360	if (dev->mode_config.dvi_i_select_subconnector_property)
1361		return 0;
1362
1363	dvi_i_selector =
1364		drm_property_create_enum(dev, 0,
1365				    "select subconnector",
1366				    drm_dvi_i_select_enum_list,
1367				    ARRAY_SIZE(drm_dvi_i_select_enum_list));
1368	dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1369
1370	dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1371				    "subconnector",
1372				    drm_dvi_i_subconnector_enum_list,
1373				    ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1374	dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1375
1376	return 0;
1377}
1378EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1379
1380/**
1381 * drm_create_tv_properties - create TV specific connector properties
1382 * @dev: DRM device
1383 * @num_modes: number of different TV formats (modes) supported
1384 * @modes: array of pointers to strings containing name of each format
1385 *
1386 * Called by a driver's TV initialization routine, this function creates
1387 * the TV specific connector properties for a given device.  Caller is
1388 * responsible for allocating a list of format names and passing them to
1389 * this routine.
1390 */
1391int drm_mode_create_tv_properties(struct drm_device *dev, int num_modes,
1392				  char *modes[])
1393{
1394	struct drm_property *tv_selector;
1395	struct drm_property *tv_subconnector;
1396	int i;
1397
1398	if (dev->mode_config.tv_select_subconnector_property)
1399		return 0;
1400
1401	/*
1402	 * Basic connector properties
1403	 */
1404	tv_selector = drm_property_create_enum(dev, 0,
1405					  "select subconnector",
1406					  drm_tv_select_enum_list,
1407					  ARRAY_SIZE(drm_tv_select_enum_list));
1408	dev->mode_config.tv_select_subconnector_property = tv_selector;
1409
1410	tv_subconnector =
1411		drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1412				    "subconnector",
1413				    drm_tv_subconnector_enum_list,
1414				    ARRAY_SIZE(drm_tv_subconnector_enum_list));
1415	dev->mode_config.tv_subconnector_property = tv_subconnector;
1416
1417	/*
1418	 * Other, TV specific properties: margins & TV modes.
1419	 */
1420	dev->mode_config.tv_left_margin_property =
1421		drm_property_create_range(dev, 0, "left margin", 0, 100);
1422
1423	dev->mode_config.tv_right_margin_property =
1424		drm_property_create_range(dev, 0, "right margin", 0, 100);
1425
1426	dev->mode_config.tv_top_margin_property =
1427		drm_property_create_range(dev, 0, "top margin", 0, 100);
1428
1429	dev->mode_config.tv_bottom_margin_property =
1430		drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1431
1432	dev->mode_config.tv_mode_property =
1433		drm_property_create(dev, DRM_MODE_PROP_ENUM,
1434				    "mode", num_modes);
1435	for (i = 0; i < num_modes; i++)
1436		drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1437				      i, modes[i]);
1438
1439	dev->mode_config.tv_brightness_property =
1440		drm_property_create_range(dev, 0, "brightness", 0, 100);
1441
1442	dev->mode_config.tv_contrast_property =
1443		drm_property_create_range(dev, 0, "contrast", 0, 100);
1444
1445	dev->mode_config.tv_flicker_reduction_property =
1446		drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1447
1448	dev->mode_config.tv_overscan_property =
1449		drm_property_create_range(dev, 0, "overscan", 0, 100);
1450
1451	dev->mode_config.tv_saturation_property =
1452		drm_property_create_range(dev, 0, "saturation", 0, 100);
1453
1454	dev->mode_config.tv_hue_property =
1455		drm_property_create_range(dev, 0, "hue", 0, 100);
1456
1457	return 0;
1458}
1459EXPORT_SYMBOL(drm_mode_create_tv_properties);
1460
1461/**
1462 * drm_mode_create_scaling_mode_property - create scaling mode property
1463 * @dev: DRM device
1464 *
1465 * Called by a driver the first time it's needed, must be attached to desired
1466 * connectors.
1467 */
1468int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1469{
1470	struct drm_property *scaling_mode;
1471
1472	if (dev->mode_config.scaling_mode_property)
1473		return 0;
1474
1475	scaling_mode =
1476		drm_property_create_enum(dev, 0, "scaling mode",
1477				drm_scaling_mode_enum_list,
1478				    ARRAY_SIZE(drm_scaling_mode_enum_list));
1479
1480	dev->mode_config.scaling_mode_property = scaling_mode;
1481
1482	return 0;
1483}
1484EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1485
1486/**
1487 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1488 * @dev: DRM device
1489 *
1490 * Called by a driver the first time it's needed, must be attached to desired
1491 * connectors.
1492 *
1493 * Returns:
1494 * Zero on success, errno on failure.
1495 */
1496int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1497{
1498	if (dev->mode_config.aspect_ratio_property)
1499		return 0;
1500
1501	dev->mode_config.aspect_ratio_property =
1502		drm_property_create_enum(dev, 0, "aspect ratio",
1503				drm_aspect_ratio_enum_list,
1504				ARRAY_SIZE(drm_aspect_ratio_enum_list));
1505
1506	if (dev->mode_config.aspect_ratio_property == NULL)
1507		return -ENOMEM;
1508
1509	return 0;
1510}
1511EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1512
1513/**
1514 * drm_mode_create_dirty_property - create dirty property
1515 * @dev: DRM device
1516 *
1517 * Called by a driver the first time it's needed, must be attached to desired
1518 * connectors.
1519 */
1520int drm_mode_create_dirty_info_property(struct drm_device *dev)
1521{
1522	struct drm_property *dirty_info;
1523
1524	if (dev->mode_config.dirty_info_property)
1525		return 0;
1526
1527	dirty_info =
1528		drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1529				    "dirty",
1530				    drm_dirty_info_enum_list,
1531				    ARRAY_SIZE(drm_dirty_info_enum_list));
1532	dev->mode_config.dirty_info_property = dirty_info;
1533
1534	return 0;
1535}
1536EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1537
1538static int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
1539{
1540	uint32_t total_objects = 0;
1541
1542	total_objects += dev->mode_config.num_crtc;
1543	total_objects += dev->mode_config.num_connector;
1544	total_objects += dev->mode_config.num_encoder;
1545	total_objects += dev->mode_config.num_bridge;
1546
1547	group->id_list = kzalloc(total_objects * sizeof(uint32_t), GFP_KERNEL);
1548	if (!group->id_list)
1549		return -ENOMEM;
1550
1551	group->num_crtcs = 0;
1552	group->num_connectors = 0;
1553	group->num_encoders = 0;
1554	group->num_bridges = 0;
1555	return 0;
1556}
1557
1558void drm_mode_group_destroy(struct drm_mode_group *group)
1559{
1560	kfree(group->id_list);
1561	group->id_list = NULL;
1562}
1563
1564/*
1565 * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1566 * the drm core's responsibility to set up mode control groups.
1567 */
1568int drm_mode_group_init_legacy_group(struct drm_device *dev,
1569				     struct drm_mode_group *group)
1570{
1571	struct drm_crtc *crtc;
1572	struct drm_encoder *encoder;
1573	struct drm_connector *connector;
1574	struct drm_bridge *bridge;
1575	int ret;
1576
1577	if ((ret = drm_mode_group_init(dev, group)))
1578		return ret;
1579
1580	list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
1581		group->id_list[group->num_crtcs++] = crtc->base.id;
1582
1583	list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
1584		group->id_list[group->num_crtcs + group->num_encoders++] =
1585		encoder->base.id;
1586
1587	list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1588		group->id_list[group->num_crtcs + group->num_encoders +
1589			       group->num_connectors++] = connector->base.id;
1590
1591	list_for_each_entry(bridge, &dev->mode_config.bridge_list, head)
1592		group->id_list[group->num_crtcs + group->num_encoders +
1593			       group->num_connectors + group->num_bridges++] =
1594					bridge->base.id;
1595
1596	return 0;
1597}
1598EXPORT_SYMBOL(drm_mode_group_init_legacy_group);
1599
1600void drm_reinit_primary_mode_group(struct drm_device *dev)
1601{
1602	drm_modeset_lock_all(dev);
1603	drm_mode_group_destroy(&dev->primary->mode_group);
1604	drm_mode_group_init_legacy_group(dev, &dev->primary->mode_group);
1605	drm_modeset_unlock_all(dev);
1606}
1607EXPORT_SYMBOL(drm_reinit_primary_mode_group);
1608
1609/**
1610 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1611 * @out: drm_mode_modeinfo struct to return to the user
1612 * @in: drm_display_mode to use
1613 *
1614 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1615 * the user.
1616 */
1617static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
1618				      const struct drm_display_mode *in)
1619{
1620	WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1621	     in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1622	     in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1623	     in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1624	     in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1625	     "timing values too large for mode info\n");
1626
1627	out->clock = in->clock;
1628	out->hdisplay = in->hdisplay;
1629	out->hsync_start = in->hsync_start;
1630	out->hsync_end = in->hsync_end;
1631	out->htotal = in->htotal;
1632	out->hskew = in->hskew;
1633	out->vdisplay = in->vdisplay;
1634	out->vsync_start = in->vsync_start;
1635	out->vsync_end = in->vsync_end;
1636	out->vtotal = in->vtotal;
1637	out->vscan = in->vscan;
1638	out->vrefresh = in->vrefresh;
1639	out->flags = in->flags;
1640	out->type = in->type;
1641	strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1642	out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1643}
1644
1645/**
1646 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1647 * @out: drm_display_mode to return to the user
1648 * @in: drm_mode_modeinfo to use
1649 *
1650 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1651 * the caller.
1652 *
1653 * Returns:
1654 * Zero on success, errno on failure.
1655 */
1656static int drm_crtc_convert_umode(struct drm_display_mode *out,
1657				  const struct drm_mode_modeinfo *in)
1658{
1659	if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1660		return -ERANGE;
1661
1662	if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1663		return -EINVAL;
1664
1665	out->clock = in->clock;
1666	out->hdisplay = in->hdisplay;
1667	out->hsync_start = in->hsync_start;
1668	out->hsync_end = in->hsync_end;
1669	out->htotal = in->htotal;
1670	out->hskew = in->hskew;
1671	out->vdisplay = in->vdisplay;
1672	out->vsync_start = in->vsync_start;
1673	out->vsync_end = in->vsync_end;
1674	out->vtotal = in->vtotal;
1675	out->vscan = in->vscan;
1676	out->vrefresh = in->vrefresh;
1677	out->flags = in->flags;
1678	out->type = in->type;
1679	strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1680	out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1681
1682	return 0;
1683}
1684
1685/**
1686 * drm_mode_getresources - get graphics configuration
1687 * @dev: drm device for the ioctl
1688 * @data: data pointer for the ioctl
1689 * @file_priv: drm file for the ioctl call
1690 *
1691 * Construct a set of configuration description structures and return
1692 * them to the user, including CRTC, connector and framebuffer configuration.
1693 *
1694 * Called by the user via ioctl.
1695 *
1696 * Returns:
1697 * Zero on success, errno on failure.
1698 */
1699int drm_mode_getresources(struct drm_device *dev, void *data,
1700			  struct drm_file *file_priv)
1701{
1702	struct drm_mode_card_res *card_res = data;
1703	struct list_head *lh;
1704	struct drm_framebuffer *fb;
1705	struct drm_connector *connector;
1706	struct drm_crtc *crtc;
1707	struct drm_encoder *encoder;
1708	int ret = 0;
1709	int connector_count = 0;
1710	int crtc_count = 0;
1711	int fb_count = 0;
1712	int encoder_count = 0;
1713	int copied = 0, i;
1714	uint32_t __user *fb_id;
1715	uint32_t __user *crtc_id;
1716	uint32_t __user *connector_id;
1717	uint32_t __user *encoder_id;
1718	struct drm_mode_group *mode_group;
1719
1720	if (!drm_core_check_feature(dev, DRIVER_MODESET))
1721		return -EINVAL;
1722
1723
1724	mutex_lock(&file_priv->fbs_lock);
1725	/*
1726	 * For the non-control nodes we need to limit the list of resources
1727	 * by IDs in the group list for this node
1728	 */
1729	list_for_each(lh, &file_priv->fbs)
1730		fb_count++;
1731
1732	/* handle this in 4 parts */
1733	/* FBs */
1734	if (card_res->count_fbs >= fb_count) {
1735		copied = 0;
1736		fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1737		list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1738			if (put_user(fb->base.id, fb_id + copied)) {
1739				mutex_unlock(&file_priv->fbs_lock);
1740				return -EFAULT;
1741			}
1742			copied++;
1743		}
1744	}
1745	card_res->count_fbs = fb_count;
1746	mutex_unlock(&file_priv->fbs_lock);
1747
1748	drm_modeset_lock_all(dev);
1749	if (!drm_is_primary_client(file_priv)) {
1750
1751		mode_group = NULL;
1752		list_for_each(lh, &dev->mode_config.crtc_list)
1753			crtc_count++;
1754
1755		list_for_each(lh, &dev->mode_config.connector_list)
1756			connector_count++;
1757
1758		list_for_each(lh, &dev->mode_config.encoder_list)
1759			encoder_count++;
1760	} else {
1761
1762		mode_group = &file_priv->master->minor->mode_group;
1763		crtc_count = mode_group->num_crtcs;
1764		connector_count = mode_group->num_connectors;
1765		encoder_count = mode_group->num_encoders;
1766	}
1767
1768	card_res->max_height = dev->mode_config.max_height;
1769	card_res->min_height = dev->mode_config.min_height;
1770	card_res->max_width = dev->mode_config.max_width;
1771	card_res->min_width = dev->mode_config.min_width;
1772
1773	/* CRTCs */
1774	if (card_res->count_crtcs >= crtc_count) {
1775		copied = 0;
1776		crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1777		if (!mode_group) {
1778			list_for_each_entry(crtc, &dev->mode_config.crtc_list,
1779					    head) {
1780				DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1781				if (put_user(crtc->base.id, crtc_id + copied)) {
1782					ret = -EFAULT;
1783					goto out;
1784				}
1785				copied++;
1786			}
1787		} else {
1788			for (i = 0; i < mode_group->num_crtcs; i++) {
1789				if (put_user(mode_group->id_list[i],
1790					     crtc_id + copied)) {
1791					ret = -EFAULT;
1792					goto out;
1793				}
1794				copied++;
1795			}
1796		}
1797	}
1798	card_res->count_crtcs = crtc_count;
1799
1800	/* Encoders */
1801	if (card_res->count_encoders >= encoder_count) {
1802		copied = 0;
1803		encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1804		if (!mode_group) {
1805			list_for_each_entry(encoder,
1806					    &dev->mode_config.encoder_list,
1807					    head) {
1808				DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1809						encoder->name);
1810				if (put_user(encoder->base.id, encoder_id +
1811					     copied)) {
1812					ret = -EFAULT;
1813					goto out;
1814				}
1815				copied++;
1816			}
1817		} else {
1818			for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
1819				if (put_user(mode_group->id_list[i],
1820					     encoder_id + copied)) {
1821					ret = -EFAULT;
1822					goto out;
1823				}
1824				copied++;
1825			}
1826
1827		}
1828	}
1829	card_res->count_encoders = encoder_count;
1830
1831	/* Connectors */
1832	if (card_res->count_connectors >= connector_count) {
1833		copied = 0;
1834		connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1835		if (!mode_group) {
1836			list_for_each_entry(connector,
1837					    &dev->mode_config.connector_list,
1838					    head) {
1839				DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1840					connector->base.id,
1841					connector->name);
1842				if (put_user(connector->base.id,
1843					     connector_id + copied)) {
1844					ret = -EFAULT;
1845					goto out;
1846				}
1847				copied++;
1848			}
1849		} else {
1850			int start = mode_group->num_crtcs +
1851				mode_group->num_encoders;
1852			for (i = start; i < start + mode_group->num_connectors; i++) {
1853				if (put_user(mode_group->id_list[i],
1854					     connector_id + copied)) {
1855					ret = -EFAULT;
1856					goto out;
1857				}
1858				copied++;
1859			}
1860		}
1861	}
1862	card_res->count_connectors = connector_count;
1863
1864	DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1865		  card_res->count_connectors, card_res->count_encoders);
1866
1867out:
1868	drm_modeset_unlock_all(dev);
1869	return ret;
1870}
1871
1872/**
1873 * drm_mode_getcrtc - get CRTC configuration
1874 * @dev: drm device for the ioctl
1875 * @data: data pointer for the ioctl
1876 * @file_priv: drm file for the ioctl call
1877 *
1878 * Construct a CRTC configuration structure to return to the user.
1879 *
1880 * Called by the user via ioctl.
1881 *
1882 * Returns:
1883 * Zero on success, errno on failure.
1884 */
1885int drm_mode_getcrtc(struct drm_device *dev,
1886		     void *data, struct drm_file *file_priv)
1887{
1888	struct drm_mode_crtc *crtc_resp = data;
1889	struct drm_crtc *crtc;
1890	int ret = 0;
1891
1892	if (!drm_core_check_feature(dev, DRIVER_MODESET))
1893		return -EINVAL;
1894
1895	drm_modeset_lock_all(dev);
1896
1897	crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
1898	if (!crtc) {
1899		ret = -ENOENT;
1900		goto out;
1901	}
1902
1903	crtc_resp->x = crtc->x;
1904	crtc_resp->y = crtc->y;
1905	crtc_resp->gamma_size = crtc->gamma_size;
1906	if (crtc->primary->fb)
1907		crtc_resp->fb_id = crtc->primary->fb->base.id;
1908	else
1909		crtc_resp->fb_id = 0;
1910
1911	if (crtc->enabled) {
1912
1913		drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
1914		crtc_resp->mode_valid = 1;
1915
1916	} else {
1917		crtc_resp->mode_valid = 0;
1918	}
1919
1920out:
1921	drm_modeset_unlock_all(dev);
1922	return ret;
1923}
1924
1925static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
1926					 const struct drm_file *file_priv)
1927{
1928	/*
1929	 * If user-space hasn't configured the driver to expose the stereo 3D
1930	 * modes, don't expose them.
1931	 */
1932	if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
1933		return false;
1934
1935	return true;
1936}
1937
1938/**
1939 * drm_mode_getconnector - get connector configuration
1940 * @dev: drm device for the ioctl
1941 * @data: data pointer for the ioctl
1942 * @file_priv: drm file for the ioctl call
1943 *
1944 * Construct a connector configuration structure to return to the user.
1945 *
1946 * Called by the user via ioctl.
1947 *
1948 * Returns:
1949 * Zero on success, errno on failure.
1950 */
1951int drm_mode_getconnector(struct drm_device *dev, void *data,
1952			  struct drm_file *file_priv)
1953{
1954	struct drm_mode_get_connector *out_resp = data;
1955	struct drm_connector *connector;
1956	struct drm_display_mode *mode;
1957	int mode_count = 0;
1958	int props_count = 0;
1959	int encoders_count = 0;
1960	int ret = 0;
1961	int copied = 0;
1962	int i;
1963	struct drm_mode_modeinfo u_mode;
1964	struct drm_mode_modeinfo __user *mode_ptr;
1965	uint32_t __user *prop_ptr;
1966	uint64_t __user *prop_values;
1967	uint32_t __user *encoder_ptr;
1968
1969	if (!drm_core_check_feature(dev, DRIVER_MODESET))
1970		return -EINVAL;
1971
1972	memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
1973
1974	DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
1975
1976	mutex_lock(&dev->mode_config.mutex);
1977
1978	connector = drm_connector_find(dev, out_resp->connector_id);
1979	if (!connector) {
1980		ret = -ENOENT;
1981		goto out;
1982	}
1983
1984	props_count = connector->properties.count;
1985
1986	for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
1987		if (connector->encoder_ids[i] != 0) {
1988			encoders_count++;
1989		}
1990	}
1991
1992	if (out_resp->count_modes == 0) {
1993		connector->funcs->fill_modes(connector,
1994					     dev->mode_config.max_width,
1995					     dev->mode_config.max_height);
1996	}
1997
1998	/* delayed so we get modes regardless of pre-fill_modes state */
1999	list_for_each_entry(mode, &connector->modes, head)
2000		if (drm_mode_expose_to_userspace(mode, file_priv))
2001			mode_count++;
2002
2003	out_resp->connector_id = connector->base.id;
2004	out_resp->connector_type = connector->connector_type;
2005	out_resp->connector_type_id = connector->connector_type_id;
2006	out_resp->mm_width = connector->display_info.width_mm;
2007	out_resp->mm_height = connector->display_info.height_mm;
2008	out_resp->subpixel = connector->display_info.subpixel_order;
2009	out_resp->connection = connector->status;
2010	drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2011	if (connector->encoder)
2012		out_resp->encoder_id = connector->encoder->base.id;
2013	else
2014		out_resp->encoder_id = 0;
2015	drm_modeset_unlock(&dev->mode_config.connection_mutex);
2016
2017	/*
2018	 * This ioctl is called twice, once to determine how much space is
2019	 * needed, and the 2nd time to fill it.
2020	 */
2021	if ((out_resp->count_modes >= mode_count) && mode_count) {
2022		copied = 0;
2023		mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2024		list_for_each_entry(mode, &connector->modes, head) {
2025			if (!drm_mode_expose_to_userspace(mode, file_priv))
2026				continue;
2027
2028			drm_crtc_convert_to_umode(&u_mode, mode);
2029			if (copy_to_user(mode_ptr + copied,
2030					 &u_mode, sizeof(u_mode))) {
2031				ret = -EFAULT;
2032				goto out;
2033			}
2034			copied++;
2035		}
2036	}
2037	out_resp->count_modes = mode_count;
2038
2039	if ((out_resp->count_props >= props_count) && props_count) {
2040		copied = 0;
2041		prop_ptr = (uint32_t __user *)(unsigned long)(out_resp->props_ptr);
2042		prop_values = (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr);
2043		for (i = 0; i < connector->properties.count; i++) {
2044			if (put_user(connector->properties.ids[i],
2045				     prop_ptr + copied)) {
2046				ret = -EFAULT;
2047				goto out;
2048			}
2049
2050			if (put_user(connector->properties.values[i],
2051				     prop_values + copied)) {
2052				ret = -EFAULT;
2053				goto out;
2054			}
2055			copied++;
2056		}
2057	}
2058	out_resp->count_props = props_count;
2059
2060	if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2061		copied = 0;
2062		encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2063		for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2064			if (connector->encoder_ids[i] != 0) {
2065				if (put_user(connector->encoder_ids[i],
2066					     encoder_ptr + copied)) {
2067					ret = -EFAULT;
2068					goto out;
2069				}
2070				copied++;
2071			}
2072		}
2073	}
2074	out_resp->count_encoders = encoders_count;
2075
2076out:
2077	mutex_unlock(&dev->mode_config.mutex);
2078
2079	return ret;
2080}
2081
2082/**
2083 * drm_mode_getencoder - get encoder configuration
2084 * @dev: drm device for the ioctl
2085 * @data: data pointer for the ioctl
2086 * @file_priv: drm file for the ioctl call
2087 *
2088 * Construct a encoder configuration structure to return to the user.
2089 *
2090 * Called by the user via ioctl.
2091 *
2092 * Returns:
2093 * Zero on success, errno on failure.
2094 */
2095int drm_mode_getencoder(struct drm_device *dev, void *data,
2096			struct drm_file *file_priv)
2097{
2098	struct drm_mode_get_encoder *enc_resp = data;
2099	struct drm_encoder *encoder;
2100	int ret = 0;
2101
2102	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2103		return -EINVAL;
2104
2105	drm_modeset_lock_all(dev);
2106	encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2107	if (!encoder) {
2108		ret = -ENOENT;
2109		goto out;
2110	}
2111
2112	if (encoder->crtc)
2113		enc_resp->crtc_id = encoder->crtc->base.id;
2114	else
2115		enc_resp->crtc_id = 0;
2116	enc_resp->encoder_type = encoder->encoder_type;
2117	enc_resp->encoder_id = encoder->base.id;
2118	enc_resp->possible_crtcs = encoder->possible_crtcs;
2119	enc_resp->possible_clones = encoder->possible_clones;
2120
2121out:
2122	drm_modeset_unlock_all(dev);
2123	return ret;
2124}
2125
2126/**
2127 * drm_mode_getplane_res - enumerate all plane resources
2128 * @dev: DRM device
2129 * @data: ioctl data
2130 * @file_priv: DRM file info
2131 *
2132 * Construct a list of plane ids to return to the user.
2133 *
2134 * Called by the user via ioctl.
2135 *
2136 * Returns:
2137 * Zero on success, errno on failure.
2138 */
2139int drm_mode_getplane_res(struct drm_device *dev, void *data,
2140			  struct drm_file *file_priv)
2141{
2142	struct drm_mode_get_plane_res *plane_resp = data;
2143	struct drm_mode_config *config;
2144	struct drm_plane *plane;
2145	uint32_t __user *plane_ptr;
2146	int copied = 0, ret = 0;
2147	unsigned num_planes;
2148
2149	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2150		return -EINVAL;
2151
2152	drm_modeset_lock_all(dev);
2153	config = &dev->mode_config;
2154
2155	if (file_priv->universal_planes)
2156		num_planes = config->num_total_plane;
2157	else
2158		num_planes = config->num_overlay_plane;
2159
2160	/*
2161	 * This ioctl is called twice, once to determine how much space is
2162	 * needed, and the 2nd time to fill it.
2163	 */
2164	if (num_planes &&
2165	    (plane_resp->count_planes >= num_planes)) {
2166		plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2167
2168		list_for_each_entry(plane, &config->plane_list, head) {
2169			/*
2170			 * Unless userspace set the 'universal planes'
2171			 * capability bit, only advertise overlays.
2172			 */
2173			if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2174			    !file_priv->universal_planes)
2175				continue;
2176
2177			if (put_user(plane->base.id, plane_ptr + copied)) {
2178				ret = -EFAULT;
2179				goto out;
2180			}
2181			copied++;
2182		}
2183	}
2184	plane_resp->count_planes = num_planes;
2185
2186out:
2187	drm_modeset_unlock_all(dev);
2188	return ret;
2189}
2190
2191/**
2192 * drm_mode_getplane - get plane configuration
2193 * @dev: DRM device
2194 * @data: ioctl data
2195 * @file_priv: DRM file info
2196 *
2197 * Construct a plane configuration structure to return to the user.
2198 *
2199 * Called by the user via ioctl.
2200 *
2201 * Returns:
2202 * Zero on success, errno on failure.
2203 */
2204int drm_mode_getplane(struct drm_device *dev, void *data,
2205		      struct drm_file *file_priv)
2206{
2207	struct drm_mode_get_plane *plane_resp = data;
2208	struct drm_plane *plane;
2209	uint32_t __user *format_ptr;
2210	int ret = 0;
2211
2212	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2213		return -EINVAL;
2214
2215	drm_modeset_lock_all(dev);
2216	plane = drm_plane_find(dev, plane_resp->plane_id);
2217	if (!plane) {
2218		ret = -ENOENT;
2219		goto out;
2220	}
2221
2222	if (plane->crtc)
2223		plane_resp->crtc_id = plane->crtc->base.id;
2224	else
2225		plane_resp->crtc_id = 0;
2226
2227	if (plane->fb)
2228		plane_resp->fb_id = plane->fb->base.id;
2229	else
2230		plane_resp->fb_id = 0;
2231
2232	plane_resp->plane_id = plane->base.id;
2233	plane_resp->possible_crtcs = plane->possible_crtcs;
2234	plane_resp->gamma_size = 0;
2235
2236	/*
2237	 * This ioctl is called twice, once to determine how much space is
2238	 * needed, and the 2nd time to fill it.
2239	 */
2240	if (plane->format_count &&
2241	    (plane_resp->count_format_types >= plane->format_count)) {
2242		format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2243		if (copy_to_user(format_ptr,
2244				 plane->format_types,
2245				 sizeof(uint32_t) * plane->format_count)) {
2246			ret = -EFAULT;
2247			goto out;
2248		}
2249	}
2250	plane_resp->count_format_types = plane->format_count;
2251
2252out:
2253	drm_modeset_unlock_all(dev);
2254	return ret;
2255}
2256
2257/*
2258 * setplane_internal - setplane handler for internal callers
2259 *
2260 * Note that we assume an extra reference has already been taken on fb.  If the
2261 * update fails, this reference will be dropped before return; if it succeeds,
2262 * the previous framebuffer (if any) will be unreferenced instead.
2263 *
2264 * src_{x,y,w,h} are provided in 16.16 fixed point format
2265 */
2266static int __setplane_internal(struct drm_plane *plane,
2267			       struct drm_crtc *crtc,
2268			       struct drm_framebuffer *fb,
2269			       int32_t crtc_x, int32_t crtc_y,
2270			       uint32_t crtc_w, uint32_t crtc_h,
2271			       /* src_{x,y,w,h} values are 16.16 fixed point */
2272			       uint32_t src_x, uint32_t src_y,
2273			       uint32_t src_w, uint32_t src_h)
2274{
2275	int ret = 0;
2276	unsigned int fb_width, fb_height;
2277	int i;
2278
2279	/* No fb means shut it down */
2280	if (!fb) {
2281		plane->old_fb = plane->fb;
2282		ret = plane->funcs->disable_plane(plane);
2283		if (!ret) {
2284			plane->crtc = NULL;
2285			plane->fb = NULL;
2286		} else {
2287			plane->old_fb = NULL;
2288		}
2289		goto out;
2290	}
2291
2292	/* Check whether this plane is usable on this CRTC */
2293	if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2294		DRM_DEBUG_KMS("Invalid crtc for plane\n");
2295		ret = -EINVAL;
2296		goto out;
2297	}
2298
2299	/* Check whether this plane supports the fb pixel format. */
2300	for (i = 0; i < plane->format_count; i++)
2301		if (fb->pixel_format == plane->format_types[i])
2302			break;
2303	if (i == plane->format_count) {
2304		DRM_DEBUG_KMS("Invalid pixel format %s\n",
2305			      drm_get_format_name(fb->pixel_format));
2306		ret = -EINVAL;
2307		goto out;
2308	}
2309
2310	fb_width = fb->width << 16;
2311	fb_height = fb->height << 16;
2312
2313	/* Make sure source coordinates are inside the fb. */
2314	if (src_w > fb_width ||
2315	    src_x > fb_width - src_w ||
2316	    src_h > fb_height ||
2317	    src_y > fb_height - src_h) {
2318		DRM_DEBUG_KMS("Invalid source coordinates "
2319			      "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2320			      src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2321			      src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2322			      src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2323			      src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2324		ret = -ENOSPC;
2325		goto out;
2326	}
2327
2328	plane->old_fb = plane->fb;
2329	ret = plane->funcs->update_plane(plane, crtc, fb,
2330					 crtc_x, crtc_y, crtc_w, crtc_h,
2331					 src_x, src_y, src_w, src_h);
2332	if (!ret) {
2333		plane->crtc = crtc;
2334		plane->fb = fb;
2335		fb = NULL;
2336	} else {
2337		plane->old_fb = NULL;
2338	}
2339
2340out:
2341	if (fb)
2342		drm_framebuffer_unreference(fb);
2343	if (plane->old_fb)
2344		drm_framebuffer_unreference(plane->old_fb);
2345	plane->old_fb = NULL;
2346
2347	return ret;
2348}
2349
2350static int setplane_internal(struct drm_plane *plane,
2351			     struct drm_crtc *crtc,
2352			     struct drm_framebuffer *fb,
2353			     int32_t crtc_x, int32_t crtc_y,
2354			     uint32_t crtc_w, uint32_t crtc_h,
2355			     /* src_{x,y,w,h} values are 16.16 fixed point */
2356			     uint32_t src_x, uint32_t src_y,
2357			     uint32_t src_w, uint32_t src_h)
2358{
2359	int ret;
2360
2361	drm_modeset_lock_all(plane->dev);
2362	ret = __setplane_internal(plane, crtc, fb,
2363				  crtc_x, crtc_y, crtc_w, crtc_h,
2364				  src_x, src_y, src_w, src_h);
2365	drm_modeset_unlock_all(plane->dev);
2366
2367	return ret;
2368}
2369
2370/**
2371 * drm_mode_setplane - configure a plane's configuration
2372 * @dev: DRM device
2373 * @data: ioctl data*
2374 * @file_priv: DRM file info
2375 *
2376 * Set plane configuration, including placement, fb, scaling, and other factors.
2377 * Or pass a NULL fb to disable (planes may be disabled without providing a
2378 * valid crtc).
2379 *
2380 * Returns:
2381 * Zero on success, errno on failure.
2382 */
2383int drm_mode_setplane(struct drm_device *dev, void *data,
2384		      struct drm_file *file_priv)
2385{
2386	struct drm_mode_set_plane *plane_req = data;
2387	struct drm_mode_object *obj;
2388	struct drm_plane *plane;
2389	struct drm_crtc *crtc = NULL;
2390	struct drm_framebuffer *fb = NULL;
2391
2392	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2393		return -EINVAL;
2394
2395	/* Give drivers some help against integer overflows */
2396	if (plane_req->crtc_w > INT_MAX ||
2397	    plane_req->crtc_x > INT_MAX - (int32_t) plane_req->crtc_w ||
2398	    plane_req->crtc_h > INT_MAX ||
2399	    plane_req->crtc_y > INT_MAX - (int32_t) plane_req->crtc_h) {
2400		DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2401			      plane_req->crtc_w, plane_req->crtc_h,
2402			      plane_req->crtc_x, plane_req->crtc_y);
2403		return -ERANGE;
2404	}
2405
2406	/*
2407	 * First, find the plane, crtc, and fb objects.  If not available,
2408	 * we don't bother to call the driver.
2409	 */
2410	obj = drm_mode_object_find(dev, plane_req->plane_id,
2411				   DRM_MODE_OBJECT_PLANE);
2412	if (!obj) {
2413		DRM_DEBUG_KMS("Unknown plane ID %d\n",
2414			      plane_req->plane_id);
2415		return -ENOENT;
2416	}
2417	plane = obj_to_plane(obj);
2418
2419	if (plane_req->fb_id) {
2420		fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2421		if (!fb) {
2422			DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2423				      plane_req->fb_id);
2424			return -ENOENT;
2425		}
2426
2427		obj = drm_mode_object_find(dev, plane_req->crtc_id,
2428					   DRM_MODE_OBJECT_CRTC);
2429		if (!obj) {
2430			DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2431				      plane_req->crtc_id);
2432			return -ENOENT;
2433		}
2434		crtc = obj_to_crtc(obj);
2435	}
2436
2437	/*
2438	 * setplane_internal will take care of deref'ing either the old or new
2439	 * framebuffer depending on success.
2440	 */
2441	return setplane_internal(plane, crtc, fb,
2442				 plane_req->crtc_x, plane_req->crtc_y,
2443				 plane_req->crtc_w, plane_req->crtc_h,
2444				 plane_req->src_x, plane_req->src_y,
2445				 plane_req->src_w, plane_req->src_h);
2446}
2447
2448/**
2449 * drm_mode_set_config_internal - helper to call ->set_config
2450 * @set: modeset config to set
2451 *
2452 * This is a little helper to wrap internal calls to the ->set_config driver
2453 * interface. The only thing it adds is correct refcounting dance.
2454 *
2455 * Returns:
2456 * Zero on success, errno on failure.
2457 */
2458int drm_mode_set_config_internal(struct drm_mode_set *set)
2459{
2460	struct drm_crtc *crtc = set->crtc;
2461	struct drm_framebuffer *fb;
2462	struct drm_crtc *tmp;
2463	int ret;
2464
2465	/*
2466	 * NOTE: ->set_config can also disable other crtcs (if we steal all
2467	 * connectors from it), hence we need to refcount the fbs across all
2468	 * crtcs. Atomic modeset will have saner semantics ...
2469	 */
2470	list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head)
2471		tmp->primary->old_fb = tmp->primary->fb;
2472
2473	fb = set->fb;
2474
2475	ret = crtc->funcs->set_config(set);
2476	if (ret == 0) {
2477		crtc->primary->crtc = crtc;
2478		crtc->primary->fb = fb;
2479	}
2480
2481	list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
2482		if (tmp->primary->fb)
2483			drm_framebuffer_reference(tmp->primary->fb);
2484		if (tmp->primary->old_fb)
2485			drm_framebuffer_unreference(tmp->primary->old_fb);
2486		tmp->primary->old_fb = NULL;
2487	}
2488
2489	return ret;
2490}
2491EXPORT_SYMBOL(drm_mode_set_config_internal);
2492
2493/**
2494 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2495 *     CRTC viewport
2496 * @crtc: CRTC that framebuffer will be displayed on
2497 * @x: x panning
2498 * @y: y panning
2499 * @mode: mode that framebuffer will be displayed under
2500 * @fb: framebuffer to check size of
2501 */
2502int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2503			    int x, int y,
2504			    const struct drm_display_mode *mode,
2505			    const struct drm_framebuffer *fb)
2506
2507{
2508	int hdisplay, vdisplay;
2509
2510	hdisplay = mode->hdisplay;
2511	vdisplay = mode->vdisplay;
2512
2513	if (drm_mode_is_stereo(mode)) {
2514		struct drm_display_mode adjusted = *mode;
2515
2516		drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE);
2517		hdisplay = adjusted.crtc_hdisplay;
2518		vdisplay = adjusted.crtc_vdisplay;
2519	}
2520
2521	if (crtc->invert_dimensions)
2522		swap(hdisplay, vdisplay);
2523
2524	if (hdisplay > fb->width ||
2525	    vdisplay > fb->height ||
2526	    x > fb->width - hdisplay ||
2527	    y > fb->height - vdisplay) {
2528		DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2529			      fb->width, fb->height, hdisplay, vdisplay, x, y,
2530			      crtc->invert_dimensions ? " (inverted)" : "");
2531		return -ENOSPC;
2532	}
2533
2534	return 0;
2535}
2536EXPORT_SYMBOL(drm_crtc_check_viewport);
2537
2538/**
2539 * drm_mode_setcrtc - set CRTC configuration
2540 * @dev: drm device for the ioctl
2541 * @data: data pointer for the ioctl
2542 * @file_priv: drm file for the ioctl call
2543 *
2544 * Build a new CRTC configuration based on user request.
2545 *
2546 * Called by the user via ioctl.
2547 *
2548 * Returns:
2549 * Zero on success, errno on failure.
2550 */
2551int drm_mode_setcrtc(struct drm_device *dev, void *data,
2552		     struct drm_file *file_priv)
2553{
2554	struct drm_mode_config *config = &dev->mode_config;
2555	struct drm_mode_crtc *crtc_req = data;
2556	struct drm_crtc *crtc;
2557	struct drm_connector **connector_set = NULL, *connector;
2558	struct drm_framebuffer *fb = NULL;
2559	struct drm_display_mode *mode = NULL;
2560	struct drm_mode_set set;
2561	uint32_t __user *set_connectors_ptr;
2562	int ret;
2563	int i;
2564
2565	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2566		return -EINVAL;
2567
2568	/* For some reason crtc x/y offsets are signed internally. */
2569	if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
2570		return -ERANGE;
2571
2572	drm_modeset_lock_all(dev);
2573	crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2574	if (!crtc) {
2575		DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2576		ret = -ENOENT;
2577		goto out;
2578	}
2579	DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2580
2581	if (crtc_req->mode_valid) {
2582		/* If we have a mode we need a framebuffer. */
2583		/* If we pass -1, set the mode with the currently bound fb */
2584		if (crtc_req->fb_id == -1) {
2585			if (!crtc->primary->fb) {
2586				DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2587				ret = -EINVAL;
2588				goto out;
2589			}
2590			fb = crtc->primary->fb;
2591			/* Make refcounting symmetric with the lookup path. */
2592			drm_framebuffer_reference(fb);
2593		} else {
2594			fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2595			if (!fb) {
2596				DRM_DEBUG_KMS("Unknown FB ID%d\n",
2597						crtc_req->fb_id);
2598				ret = -ENOENT;
2599				goto out;
2600			}
2601		}
2602
2603		mode = drm_mode_create(dev);
2604		if (!mode) {
2605			ret = -ENOMEM;
2606			goto out;
2607		}
2608
2609		ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
2610		if (ret) {
2611			DRM_DEBUG_KMS("Invalid mode\n");
2612			goto out;
2613		}
2614
2615		drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2616
2617		ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2618					      mode, fb);
2619		if (ret)
2620			goto out;
2621
2622	}
2623
2624	if (crtc_req->count_connectors == 0 && mode) {
2625		DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2626		ret = -EINVAL;
2627		goto out;
2628	}
2629
2630	if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2631		DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2632			  crtc_req->count_connectors);
2633		ret = -EINVAL;
2634		goto out;
2635	}
2636
2637	if (crtc_req->count_connectors > 0) {
2638		u32 out_id;
2639
2640		/* Avoid unbounded kernel memory allocation */
2641		if (crtc_req->count_connectors > config->num_connector) {
2642			ret = -EINVAL;
2643			goto out;
2644		}
2645
2646		connector_set = kmalloc(crtc_req->count_connectors *
2647					sizeof(struct drm_connector *),
2648					GFP_KERNEL);
2649		if (!connector_set) {
2650			ret = -ENOMEM;
2651			goto out;
2652		}
2653
2654		for (i = 0; i < crtc_req->count_connectors; i++) {
2655			set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2656			if (get_user(out_id, &set_connectors_ptr[i])) {
2657				ret = -EFAULT;
2658				goto out;
2659			}
2660
2661			connector = drm_connector_find(dev, out_id);
2662			if (!connector) {
2663				DRM_DEBUG_KMS("Connector id %d unknown\n",
2664						out_id);
2665				ret = -ENOENT;
2666				goto out;
2667			}
2668			DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2669					connector->base.id,
2670					connector->name);
2671
2672			connector_set[i] = connector;
2673		}
2674	}
2675
2676	set.crtc = crtc;
2677	set.x = crtc_req->x;
2678	set.y = crtc_req->y;
2679	set.mode = mode;
2680	set.connectors = connector_set;
2681	set.num_connectors = crtc_req->count_connectors;
2682	set.fb = fb;
2683	ret = drm_mode_set_config_internal(&set);
2684
2685out:
2686	if (fb)
2687		drm_framebuffer_unreference(fb);
2688
2689	kfree(connector_set);
2690	drm_mode_destroy(dev, mode);
2691	drm_modeset_unlock_all(dev);
2692	return ret;
2693}
2694
2695/**
2696 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2697 *     universal plane handler call
2698 * @crtc: crtc to update cursor for
2699 * @req: data pointer for the ioctl
2700 * @file_priv: drm file for the ioctl call
2701 *
2702 * Legacy cursor ioctl's work directly with driver buffer handles.  To
2703 * translate legacy ioctl calls into universal plane handler calls, we need to
2704 * wrap the native buffer handle in a drm_framebuffer.
2705 *
2706 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2707 * buffer with a pitch of 4*width; the universal plane interface should be used
2708 * directly in cases where the hardware can support other buffer settings and
2709 * userspace wants to make use of these capabilities.
2710 *
2711 * Returns:
2712 * Zero on success, errno on failure.
2713 */
2714static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2715				     struct drm_mode_cursor2 *req,
2716				     struct drm_file *file_priv)
2717{
2718	struct drm_device *dev = crtc->dev;
2719	struct drm_framebuffer *fb = NULL;
2720	struct drm_mode_fb_cmd2 fbreq = {
2721		.width = req->width,
2722		.height = req->height,
2723		.pixel_format = DRM_FORMAT_ARGB8888,
2724		.pitches = { req->width * 4 },
2725		.handles = { req->handle },
2726	};
2727	int32_t crtc_x, crtc_y;
2728	uint32_t crtc_w = 0, crtc_h = 0;
2729	uint32_t src_w = 0, src_h = 0;
2730	int ret = 0;
2731
2732	BUG_ON(!crtc->cursor);
2733	WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2734
2735	/*
2736	 * Obtain fb we'll be using (either new or existing) and take an extra
2737	 * reference to it if fb != null.  setplane will take care of dropping
2738	 * the reference if the plane update fails.
2739	 */
2740	if (req->flags & DRM_MODE_CURSOR_BO) {
2741		if (req->handle) {
2742			fb = add_framebuffer_internal(dev, &fbreq, file_priv);
2743			if (IS_ERR(fb)) {
2744				DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2745				return PTR_ERR(fb);
2746			}
2747
2748			drm_framebuffer_reference(fb);
2749		} else {
2750			fb = NULL;
2751		}
2752	} else {
2753		fb = crtc->cursor->fb;
2754		if (fb)
2755			drm_framebuffer_reference(fb);
2756	}
2757
2758	if (req->flags & DRM_MODE_CURSOR_MOVE) {
2759		crtc_x = req->x;
2760		crtc_y = req->y;
2761	} else {
2762		crtc_x = crtc->cursor_x;
2763		crtc_y = crtc->cursor_y;
2764	}
2765
2766	if (fb) {
2767		crtc_w = fb->width;
2768		crtc_h = fb->height;
2769		src_w = fb->width << 16;
2770		src_h = fb->height << 16;
2771	}
2772
2773	/*
2774	 * setplane_internal will take care of deref'ing either the old or new
2775	 * framebuffer depending on success.
2776	 */
2777	ret = __setplane_internal(crtc->cursor, crtc, fb,
2778				crtc_x, crtc_y, crtc_w, crtc_h,
2779				0, 0, src_w, src_h);
2780
2781	/* Update successful; save new cursor position, if necessary */
2782	if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
2783		crtc->cursor_x = req->x;
2784		crtc->cursor_y = req->y;
2785	}
2786
2787	return ret;
2788}
2789
2790static int drm_mode_cursor_common(struct drm_device *dev,
2791				  struct drm_mode_cursor2 *req,
2792				  struct drm_file *file_priv)
2793{
2794	struct drm_crtc *crtc;
2795	int ret = 0;
2796
2797	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2798		return -EINVAL;
2799
2800	if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
2801		return -EINVAL;
2802
2803	crtc = drm_crtc_find(dev, req->crtc_id);
2804	if (!crtc) {
2805		DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
2806		return -ENOENT;
2807	}
2808
2809	/*
2810	 * If this crtc has a universal cursor plane, call that plane's update
2811	 * handler rather than using legacy cursor handlers.
2812	 */
2813	drm_modeset_lock_crtc(crtc);
2814	if (crtc->cursor) {
2815		ret = drm_mode_cursor_universal(crtc, req, file_priv);
2816		goto out;
2817	}
2818
2819	if (req->flags & DRM_MODE_CURSOR_BO) {
2820		if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
2821			ret = -ENXIO;
2822			goto out;
2823		}
2824		/* Turns off the cursor if handle is 0 */
2825		if (crtc->funcs->cursor_set2)
2826			ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
2827						      req->width, req->height, req->hot_x, req->hot_y);
2828		else
2829			ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
2830						      req->width, req->height);
2831	}
2832
2833	if (req->flags & DRM_MODE_CURSOR_MOVE) {
2834		if (crtc->funcs->cursor_move) {
2835			ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
2836		} else {
2837			ret = -EFAULT;
2838			goto out;
2839		}
2840	}
2841out:
2842	drm_modeset_unlock_crtc(crtc);
2843
2844	return ret;
2845
2846}
2847
2848
2849/**
2850 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
2851 * @dev: drm device for the ioctl
2852 * @data: data pointer for the ioctl
2853 * @file_priv: drm file for the ioctl call
2854 *
2855 * Set the cursor configuration based on user request.
2856 *
2857 * Called by the user via ioctl.
2858 *
2859 * Returns:
2860 * Zero on success, errno on failure.
2861 */
2862int drm_mode_cursor_ioctl(struct drm_device *dev,
2863			  void *data, struct drm_file *file_priv)
2864{
2865	struct drm_mode_cursor *req = data;
2866	struct drm_mode_cursor2 new_req;
2867
2868	memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
2869	new_req.hot_x = new_req.hot_y = 0;
2870
2871	return drm_mode_cursor_common(dev, &new_req, file_priv);
2872}
2873
2874/**
2875 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
2876 * @dev: drm device for the ioctl
2877 * @data: data pointer for the ioctl
2878 * @file_priv: drm file for the ioctl call
2879 *
2880 * Set the cursor configuration based on user request. This implements the 2nd
2881 * version of the cursor ioctl, which allows userspace to additionally specify
2882 * the hotspot of the pointer.
2883 *
2884 * Called by the user via ioctl.
2885 *
2886 * Returns:
2887 * Zero on success, errno on failure.
2888 */
2889int drm_mode_cursor2_ioctl(struct drm_device *dev,
2890			   void *data, struct drm_file *file_priv)
2891{
2892	struct drm_mode_cursor2 *req = data;
2893	return drm_mode_cursor_common(dev, req, file_priv);
2894}
2895
2896/**
2897 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
2898 * @bpp: bits per pixels
2899 * @depth: bit depth per pixel
2900 *
2901 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
2902 * Useful in fbdev emulation code, since that deals in those values.
2903 */
2904uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
2905{
2906	uint32_t fmt;
2907
2908	switch (bpp) {
2909	case 8:
2910		fmt = DRM_FORMAT_C8;
2911		break;
2912	case 16:
2913		if (depth == 15)
2914			fmt = DRM_FORMAT_XRGB1555;
2915		else
2916			fmt = DRM_FORMAT_RGB565;
2917		break;
2918	case 24:
2919		fmt = DRM_FORMAT_RGB888;
2920		break;
2921	case 32:
2922		if (depth == 24)
2923			fmt = DRM_FORMAT_XRGB8888;
2924		else if (depth == 30)
2925			fmt = DRM_FORMAT_XRGB2101010;
2926		else
2927			fmt = DRM_FORMAT_ARGB8888;
2928		break;
2929	default:
2930		DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
2931		fmt = DRM_FORMAT_XRGB8888;
2932		break;
2933	}
2934
2935	return fmt;
2936}
2937EXPORT_SYMBOL(drm_mode_legacy_fb_format);
2938
2939/**
2940 * drm_mode_addfb - add an FB to the graphics configuration
2941 * @dev: drm device for the ioctl
2942 * @data: data pointer for the ioctl
2943 * @file_priv: drm file for the ioctl call
2944 *
2945 * Add a new FB to the specified CRTC, given a user request. This is the
2946 * original addfb ioclt which only supported RGB formats.
2947 *
2948 * Called by the user via ioctl.
2949 *
2950 * Returns:
2951 * Zero on success, errno on failure.
2952 */
2953int drm_mode_addfb(struct drm_device *dev,
2954		   void *data, struct drm_file *file_priv)
2955{
2956	struct drm_mode_fb_cmd *or = data;
2957	struct drm_mode_fb_cmd2 r = {};
2958	struct drm_mode_config *config = &dev->mode_config;
2959	struct drm_framebuffer *fb;
2960	int ret = 0;
2961
2962	/* Use new struct with format internally */
2963	r.fb_id = or->fb_id;
2964	r.width = or->width;
2965	r.height = or->height;
2966	r.pitches[0] = or->pitch;
2967	r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
2968	r.handles[0] = or->handle;
2969
2970	if (!drm_core_check_feature(dev, DRIVER_MODESET))
2971		return -EINVAL;
2972
2973	if ((config->min_width > r.width) || (r.width > config->max_width))
2974		return -EINVAL;
2975
2976	if ((config->min_height > r.height) || (r.height > config->max_height))
2977		return -EINVAL;
2978
2979	fb = dev->mode_config.funcs->fb_create(dev, file_priv, &r);
2980	if (IS_ERR(fb)) {
2981		DRM_DEBUG_KMS("could not create framebuffer\n");
2982		return PTR_ERR(fb);
2983	}
2984
2985	mutex_lock(&file_priv->fbs_lock);
2986	or->fb_id = fb->base.id;
2987	list_add(&fb->filp_head, &file_priv->fbs);
2988	DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
2989	mutex_unlock(&file_priv->fbs_lock);
2990
2991	return ret;
2992}
2993
2994static int format_check(const struct drm_mode_fb_cmd2 *r)
2995{
2996	uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
2997
2998	switch (format) {
2999	case DRM_FORMAT_C8:
3000	case DRM_FORMAT_RGB332:
3001	case DRM_FORMAT_BGR233:
3002	case DRM_FORMAT_XRGB4444:
3003	case DRM_FORMAT_XBGR4444:
3004	case DRM_FORMAT_RGBX4444:
3005	case DRM_FORMAT_BGRX4444:
3006	case DRM_FORMAT_ARGB4444:
3007	case DRM_FORMAT_ABGR4444:
3008	case DRM_FORMAT_RGBA4444:
3009	case DRM_FORMAT_BGRA4444:
3010	case DRM_FORMAT_XRGB1555:
3011	case DRM_FORMAT_XBGR1555:
3012	case DRM_FORMAT_RGBX5551:
3013	case DRM_FORMAT_BGRX5551:
3014	case DRM_FORMAT_ARGB1555:
3015	case DRM_FORMAT_ABGR1555:
3016	case DRM_FORMAT_RGBA5551:
3017	case DRM_FORMAT_BGRA5551:
3018	case DRM_FORMAT_RGB565:
3019	case DRM_FORMAT_BGR565:
3020	case DRM_FORMAT_RGB888:
3021	case DRM_FORMAT_BGR888:
3022	case DRM_FORMAT_XRGB8888:
3023	case DRM_FORMAT_XBGR8888:
3024	case DRM_FORMAT_RGBX8888:
3025	case DRM_FORMAT_BGRX8888:
3026	case DRM_FORMAT_ARGB8888:
3027	case DRM_FORMAT_ABGR8888:
3028	case DRM_FORMAT_RGBA8888:
3029	case DRM_FORMAT_BGRA8888:
3030	case DRM_FORMAT_XRGB2101010:
3031	case DRM_FORMAT_XBGR2101010:
3032	case DRM_FORMAT_RGBX1010102:
3033	case DRM_FORMAT_BGRX1010102:
3034	case DRM_FORMAT_ARGB2101010:
3035	case DRM_FORMAT_ABGR2101010:
3036	case DRM_FORMAT_RGBA1010102:
3037	case DRM_FORMAT_BGRA1010102:
3038	case DRM_FORMAT_YUYV:
3039	case DRM_FORMAT_YVYU:
3040	case DRM_FORMAT_UYVY:
3041	case DRM_FORMAT_VYUY:
3042	case DRM_FORMAT_AYUV:
3043	case DRM_FORMAT_NV12:
3044	case DRM_FORMAT_NV21:
3045	case DRM_FORMAT_NV16:
3046	case DRM_FORMAT_NV61:
3047	case DRM_FORMAT_NV24:
3048	case DRM_FORMAT_NV42:
3049	case DRM_FORMAT_YUV410:
3050	case DRM_FORMAT_YVU410:
3051	case DRM_FORMAT_YUV411:
3052	case DRM_FORMAT_YVU411:
3053	case DRM_FORMAT_YUV420:
3054	case DRM_FORMAT_YVU420:
3055	case DRM_FORMAT_YUV422:
3056	case DRM_FORMAT_YVU422:
3057	case DRM_FORMAT_YUV444:
3058	case DRM_FORMAT_YVU444:
3059		return 0;
3060	default:
3061		DRM_DEBUG_KMS("invalid pixel format %s\n",
3062			      drm_get_format_name(r->pixel_format));
3063		return -EINVAL;
3064	}
3065}
3066
3067static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3068{
3069	int ret, hsub, vsub, num_planes, i;
3070
3071	ret = format_check(r);
3072	if (ret) {
3073		DRM_DEBUG_KMS("bad framebuffer format %s\n",
3074			      drm_get_format_name(r->pixel_format));
3075		return ret;
3076	}
3077
3078	hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3079	vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3080	num_planes = drm_format_num_planes(r->pixel_format);
3081
3082	if (r->width == 0 || r->width % hsub) {
3083		DRM_DEBUG_KMS("bad framebuffer width %u\n", r->height);
3084		return -EINVAL;
3085	}
3086
3087	if (r->height == 0 || r->height % vsub) {
3088		DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3089		return -EINVAL;
3090	}
3091
3092	for (i = 0; i < num_planes; i++) {
3093		unsigned int width = r->width / (i != 0 ? hsub : 1);
3094		unsigned int height = r->height / (i != 0 ? vsub : 1);
3095		unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);
3096
3097		if (!r->handles[i]) {
3098			DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3099			return -EINVAL;
3100		}
3101
3102		if ((uint64_t) width * cpp > UINT_MAX)
3103			return -ERANGE;
3104
3105		if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3106			return -ERANGE;
3107
3108		if (r->pitches[i] < width * cpp) {
3109			DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3110			return -EINVAL;
3111		}
3112	}
3113
3114	return 0;
3115}
3116
3117static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
3118							struct drm_mode_fb_cmd2 *r,
3119							struct drm_file *file_priv)
3120{
3121	struct drm_mode_config *config = &dev->mode_config;
3122	struct drm_framebuffer *fb;
3123	int ret;
3124
3125	if (r->flags & ~DRM_MODE_FB_INTERLACED) {
3126		DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3127		return ERR_PTR(-EINVAL);
3128	}
3129
3130	if ((config->min_width > r->width) || (r->width > config->max_width)) {
3131		DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3132			  r->width, config->min_width, config->max_width);
3133		return ERR_PTR(-EINVAL);
3134	}
3135	if ((config->min_height > r->height) || (r->height > config->max_height)) {
3136		DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3137			  r->height, config->min_height, config->max_height);
3138		return ERR_PTR(-EINVAL);
3139	}
3140
3141	ret = framebuffer_check(r);
3142	if (ret)
3143		return ERR_PTR(ret);
3144
3145	fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3146	if (IS_ERR(fb)) {
3147		DRM_DEBUG_KMS("could not create framebuffer\n");
3148		return fb;
3149	}
3150
3151	mutex_lock(&file_priv->fbs_lock);
3152	r->fb_id = fb->base.id;
3153	list_add(&fb->filp_head, &file_priv->fbs);
3154	DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3155	mutex_unlock(&file_priv->fbs_lock);
3156
3157	return fb;
3158}
3159
3160/**
3161 * drm_mode_addfb2 - add an FB to the graphics configuration
3162 * @dev: drm device for the ioctl
3163 * @data: data pointer for the ioctl
3164 * @file_priv: drm file for the ioctl call
3165 *
3166 * Add a new FB to the specified CRTC, given a user request with format. This is
3167 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3168 * and uses fourcc codes as pixel format specifiers.
3169 *
3170 * Called by the user via ioctl.
3171 *
3172 * Returns:
3173 * Zero on success, errno on failure.
3174 */
3175int drm_mode_addfb2(struct drm_device *dev,
3176		    void *data, struct drm_file *file_priv)
3177{
3178	struct drm_framebuffer *fb;
3179
3180	if (!drm_core_check_feature(dev, DRIVER_MODESET))
3181		return -EINVAL;
3182
3183	fb = add_framebuffer_internal(dev, data, file_priv);
3184	if (IS_ERR(fb))
3185		return PTR_ERR(fb);
3186
3187	return 0;
3188}
3189
3190/**
3191 * drm_mode_rmfb - remove an FB from the configuration
3192 * @dev: drm device for the ioctl
3193 * @data: data pointer for the ioctl
3194 * @file_priv: drm file for the ioctl call
3195 *
3196 * Remove the FB specified by the user.
3197 *
3198 * Called by the user via ioctl.
3199 *
3200 * Returns:
3201 * Zero on success, errno on failure.
3202 */
3203int drm_mode_rmfb(struct drm_device *dev,
3204		   void *data, struct drm_file *file_priv)
3205{
3206	struct drm_framebuffer *fb = NULL;
3207	struct drm_framebuffer *fbl = NULL;
3208	uint32_t *id = data;
3209	int found = 0;
3210
3211	if (!drm_core_check_feature(dev, DRIVER_MODESET))
3212		return -EINVAL;
3213
3214	mutex_lock(&file_priv->fbs_lock);
3215	mutex_lock(&dev->mode_config.fb_lock);
3216	fb = __drm_framebuffer_lookup(dev, *id);
3217	if (!fb)
3218		goto fail_lookup;
3219
3220	list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3221		if (fb == fbl)
3222			found = 1;
3223	if (!found)
3224		goto fail_lookup;
3225
3226	/* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3227	__drm_framebuffer_unregister(dev, fb);
3228
3229	list_del_init(&fb->filp_head);
3230	mutex_unlock(&dev->mode_config.fb_lock);
3231	mutex_unlock(&file_priv->fbs_lock);
3232
3233	drm_framebuffer_remove(fb);
3234
3235	return 0;
3236
3237fail_lookup:
3238	mutex_unlock(&dev->mode_config.fb_lock);
3239	mutex_unlock(&file_priv->fbs_lock);
3240
3241	return -ENOENT;
3242}
3243
3244/**
3245 * drm_mode_getfb - get FB info
3246 * @dev: drm device for the ioctl
3247 * @data: data pointer for the ioctl
3248 * @file_priv: drm file for the ioctl call
3249 *
3250 * Lookup the FB given its ID and return info about it.
3251 *
3252 * Called by the user via ioctl.
3253 *
3254 * Returns:
3255 * Zero on success, errno on failure.
3256 */
3257int drm_mode_getfb(struct drm_device *dev,
3258		   void *data, struct drm_file *file_priv)
3259{
3260	struct drm_mode_fb_cmd *r = data;
3261	struct drm_framebuffer *fb;
3262	int ret;
3263
3264	if (!drm_core_check_feature(dev, DRIVER_MODESET))
3265		return -EINVAL;
3266
3267	fb = drm_framebuffer_lookup(dev, r->fb_id);
3268	if (!fb)
3269		return -ENOENT;
3270
3271	r->height = fb->height;
3272	r->width = fb->width;
3273	r->depth = fb->depth;
3274	r->bpp = fb->bits_per_pixel;
3275	r->pitch = fb->pitches[0];
3276	if (fb->funcs->create_handle) {
3277		if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3278		    drm_is_control_client(file_priv)) {
3279			ret = fb->funcs->create_handle(fb, file_priv,
3280						       &r->handle);
3281		} else {
3282			/* GET_FB() is an unprivileged ioctl so we must not
3283			 * return a buffer-handle to non-master processes! For
3284			 * backwards-compatibility reasons, we cannot make
3285			 * GET_FB() privileged, so just return an invalid handle
3286			 * for non-masters. */
3287			r->handle = 0;
3288			ret = 0;
3289		}
3290	} else {
3291		ret = -ENODEV;
3292	}
3293
3294	drm_framebuffer_unreference(fb);
3295
3296	return ret;
3297}
3298
3299/**
3300 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3301 * @dev: drm device for the ioctl
3302 * @data: data pointer for the ioctl
3303 * @file_priv: drm file for the ioctl call
3304 *
3305 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3306 * rectangle list. Generic userspace which does frontbuffer rendering must call
3307 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3308 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3309 *
3310 * Modesetting drivers which always update the frontbuffer do not need to
3311 * implement the corresponding ->dirty framebuffer callback.
3312 *
3313 * Called by the user via ioctl.
3314 *
3315 * Returns:
3316 * Zero on success, errno on failure.
3317 */
3318int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3319			   void *data, struct drm_file *file_priv)
3320{
3321	struct drm_clip_rect __user *clips_ptr;
3322	struct drm_clip_rect *clips = NULL;
3323	struct drm_mode_fb_dirty_cmd *r = data;
3324	struct drm_framebuffer *fb;
3325	unsigned flags;
3326	int num_clips;
3327	int ret;
3328
3329	if (!drm_core_check_feature(dev, DRIVER_MODESET))
3330		return -EINVAL;
3331
3332	fb = drm_framebuffer_lookup(dev, r->fb_id);
3333	if (!fb)
3334		return -ENOENT;
3335
3336	num_clips = r->num_clips;
3337	clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3338
3339	if (!num_clips != !clips_ptr) {
3340		ret = -EINVAL;
3341		goto out_err1;
3342	}
3343
3344	flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3345
3346	/* If userspace annotates copy, clips must come in pairs */
3347	if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3348		ret = -EINVAL;
3349		goto out_err1;
3350	}
3351
3352	if (num_clips && clips_ptr) {
3353		if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3354			ret = -EINVAL;
3355			goto out_err1;
3356		}
3357		clips = kzalloc(num_clips * sizeof(*clips), GFP_KERNEL);
3358		if (!clips) {
3359			ret = -ENOMEM;
3360			goto out_err1;
3361		}
3362
3363		ret = copy_from_user(clips, clips_ptr,
3364				     num_clips * sizeof(*clips));
3365		if (ret) {
3366			ret = -EFAULT;
3367			goto out_err2;
3368		}
3369	}
3370
3371	if (fb->funcs->dirty) {
3372		ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3373				       clips, num_clips);
3374	} else {
3375		ret = -ENOSYS;
3376	}
3377
3378out_err2:
3379	kfree(clips);
3380out_err1:
3381	drm_framebuffer_unreference(fb);
3382
3383	return ret;
3384}
3385
3386
3387/**
3388 * drm_fb_release - remove and free the FBs on this file
3389 * @priv: drm file for the ioctl
3390 *
3391 * Destroy all the FBs associated with @filp.
3392 *
3393 * Called by the user via ioctl.
3394 *
3395 * Returns:
3396 * Zero on success, errno on failure.
3397 */
3398void drm_fb_release(struct drm_file *priv)
3399{
3400	struct drm_device *dev = priv->minor->dev;
3401	struct drm_framebuffer *fb, *tfb;
3402
3403	/*
3404	 * When the file gets released that means no one else can access the fb
3405	 * list any more, so no need to grab fpriv->fbs_lock. And we need to to
3406	 * avoid upsetting lockdep since the universal cursor code adds a
3407	 * framebuffer while holding mutex locks.
3408	 *
3409	 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3410	 * locks is impossible here since no one else but this function can get
3411	 * at it any more.
3412	 */
3413	list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3414
3415		mutex_lock(&dev->mode_config.fb_lock);
3416		/* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3417		__drm_framebuffer_unregister(dev, fb);
3418		mutex_unlock(&dev->mode_config.fb_lock);
3419
3420		list_del_init(&fb->filp_head);
3421
3422		/* This will also drop the fpriv->fbs reference. */
3423		drm_framebuffer_remove(fb);
3424	}
3425}
3426
3427/**
3428 * drm_property_create - create a new property type
3429 * @dev: drm device
3430 * @flags: flags specifying the property type
3431 * @name: name of the property
3432 * @num_values: number of pre-defined values
3433 *
3434 * This creates a new generic drm property which can then be attached to a drm
3435 * object with drm_object_attach_property. The returned property object must be
3436 * freed with drm_property_destroy.
3437 *
3438 * Returns:
3439 * A pointer to the newly created property on success, NULL on failure.
3440 */
3441struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3442					 const char *name, int num_values)
3443{
3444	struct drm_property *property = NULL;
3445	int ret;
3446
3447	property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3448	if (!property)
3449		return NULL;
3450
3451	property->dev = dev;
3452
3453	if (num_values) {
3454		property->values = kzalloc(sizeof(uint64_t)*num_values, GFP_KERNEL);
3455		if (!property->values)
3456			goto fail;
3457	}
3458
3459	ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3460	if (ret)
3461		goto fail;
3462
3463	property->flags = flags;
3464	property->num_values = num_values;
3465	INIT_LIST_HEAD(&property->enum_blob_list);
3466
3467	if (name) {
3468		strncpy(property->name, name, DRM_PROP_NAME_LEN);
3469		property->name[DRM_PROP_NAME_LEN-1] = '\0';
3470	}
3471
3472	list_add_tail(&property->head, &dev->mode_config.property_list);
3473
3474	WARN_ON(!drm_property_type_valid(property));
3475
3476	return property;
3477fail:
3478	kfree(property->values);
3479	kfree(property);
3480	return NULL;
3481}
3482EXPORT_SYMBOL(drm_property_create);
3483
3484/**
3485 * drm_property_create_enum - create a new enumeration property type
3486 * @dev: drm device
3487 * @flags: flags specifying the property type
3488 * @name: name of the property
3489 * @props: enumeration lists with property values
3490 * @num_values: number of pre-defined values
3491 *
3492 * This creates a new generic drm property which can then be attached to a drm
3493 * object with drm_object_attach_property. The returned property object must be
3494 * freed with drm_property_destroy.
3495 *
3496 * Userspace is only allowed to set one of the predefined values for enumeration
3497 * properties.
3498 *
3499 * Returns:
3500 * A pointer to the newly created property on success, NULL on failure.
3501 */
3502struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3503					 const char *name,
3504					 const struct drm_prop_enum_list *props,
3505					 int num_values)
3506{
3507	struct drm_property *property;
3508	int i, ret;
3509
3510	flags |= DRM_MODE_PROP_ENUM;
3511
3512	property = drm_property_create(dev, flags, name, num_values);
3513	if (!property)
3514		return NULL;
3515
3516	for (i = 0; i < num_values; i++) {
3517		ret = drm_property_add_enum(property, i,
3518				      props[i].type,
3519				      props[i].name);
3520		if (ret) {
3521			drm_property_destroy(dev, property);
3522			return NULL;
3523		}
3524	}
3525
3526	return property;
3527}
3528EXPORT_SYMBOL(drm_property_create_enum);
3529
3530/**
3531 * drm_property_create_bitmask - create a new bitmask property type
3532 * @dev: drm device
3533 * @flags: flags specifying the property type
3534 * @name: name of the property
3535 * @props: enumeration lists with property bitflags
3536 * @num_props: size of the @props array
3537 * @supported_bits: bitmask of all supported enumeration values
3538 *
3539 * This creates a new bitmask drm property which can then be attached to a drm
3540 * object with drm_object_attach_property. The returned property object must be
3541 * freed with drm_property_destroy.
3542 *
3543 * Compared to plain enumeration properties userspace is allowed to set any
3544 * or'ed together combination of the predefined property bitflag values
3545 *
3546 * Returns:
3547 * A pointer to the newly created property on success, NULL on failure.
3548 */
3549struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3550					 int flags, const char *name,
3551					 const struct drm_prop_enum_list *props,
3552					 int num_props,
3553					 uint64_t supported_bits)
3554{
3555	struct drm_property *property;
3556	int i, ret, index = 0;
3557	int num_values = hweight64(supported_bits);
3558
3559	flags |= DRM_MODE_PROP_BITMASK;
3560
3561	property = drm_property_create(dev, flags, name, num_values);
3562	if (!property)
3563		return NULL;
3564	for (i = 0; i < num_props; i++) {
3565		if (!(supported_bits & (1ULL << props[i].type)))
3566			continue;
3567
3568		if (WARN_ON(index >= num_values)) {
3569			drm_property_destroy(dev, property);
3570			return NULL;
3571		}
3572
3573		ret = drm_property_add_enum(property, index++,
3574				      props[i].type,
3575				      props[i].name);
3576		if (ret) {
3577			drm_property_destroy(dev, property);
3578			return NULL;
3579		}
3580	}
3581
3582	return property;
3583}
3584EXPORT_SYMBOL(drm_property_create_bitmask);
3585
3586static struct drm_property *property_create_range(struct drm_device *dev,
3587					 int flags, const char *name,
3588					 uint64_t min, uint64_t max)
3589{
3590	struct drm_property *property;
3591
3592	property = drm_property_create(dev, flags, name, 2);
3593	if (!property)
3594		return NULL;
3595
3596	property->values[0] = min;
3597	property->values[1] = max;
3598
3599	return property;
3600}
3601
3602/**
3603 * drm_property_create_range - create a new ranged property type
3604 * @dev: drm device
3605 * @flags: flags specifying the property type
3606 * @name: name of the property
3607 * @min: minimum value of the property
3608 * @max: maximum value of the property
3609 *
3610 * This creates a new generic drm property which can then be attached to a drm
3611 * object with drm_object_attach_property. The returned property object must be
3612 * freed with drm_property_destroy.
3613 *
3614 * Userspace is allowed to set any interger value in the (min, max) range
3615 * inclusive.
3616 *
3617 * Returns:
3618 * A pointer to the newly created property on success, NULL on failure.
3619 */
3620struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3621					 const char *name,
3622					 uint64_t min, uint64_t max)
3623{
3624	return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3625			name, min, max);
3626}
3627EXPORT_SYMBOL(drm_property_create_range);
3628
3629struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3630					 int flags, const char *name,
3631					 int64_t min, int64_t max)
3632{
3633	return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3634			name, I642U64(min), I642U64(max));
3635}
3636EXPORT_SYMBOL(drm_property_create_signed_range);
3637
3638struct drm_property *drm_property_create_object(struct drm_device *dev,
3639					 int flags, const char *name, uint32_t type)
3640{
3641	struct drm_property *property;
3642
3643	flags |= DRM_MODE_PROP_OBJECT;
3644
3645	property = drm_property_create(dev, flags, name, 1);
3646	if (!property)
3647		return NULL;
3648
3649	property->values[0] = type;
3650
3651	return property;
3652}
3653EXPORT_SYMBOL(drm_property_create_object);
3654
3655/**
3656 * drm_property_add_enum - add a possible value to an enumeration property
3657 * @property: enumeration property to change
3658 * @index: index of the new enumeration
3659 * @value: value of the new enumeration
3660 * @name: symbolic name of the new enumeration
3661 *
3662 * This functions adds enumerations to a property.
3663 *
3664 * It's use is deprecated, drivers should use one of the more specific helpers
3665 * to directly create the property with all enumerations already attached.
3666 *
3667 * Returns:
3668 * Zero on success, error code on failure.
3669 */
3670int drm_property_add_enum(struct drm_property *property, int index,
3671			  uint64_t value, const char *name)
3672{
3673	struct drm_property_enum *prop_enum;
3674
3675	if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3676			drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
3677		return -EINVAL;
3678
3679	/*
3680	 * Bitmask enum properties have the additional constraint of values
3681	 * from 0 to 63
3682	 */
3683	if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
3684			(value > 63))
3685		return -EINVAL;
3686
3687	if (!list_empty(&property->enum_blob_list)) {
3688		list_for_each_entry(prop_enum, &property->enum_blob_list, head) {
3689			if (prop_enum->value == value) {
3690				strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3691				prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3692				return 0;
3693			}
3694		}
3695	}
3696
3697	prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
3698	if (!prop_enum)
3699		return -ENOMEM;
3700
3701	strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3702	prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3703	prop_enum->value = value;
3704
3705	property->values[index] = value;
3706	list_add_tail(&prop_enum->head, &property->enum_blob_list);
3707	return 0;
3708}
3709EXPORT_SYMBOL(drm_property_add_enum);
3710
3711/**
3712 * drm_property_destroy - destroy a drm property
3713 * @dev: drm device
3714 * @property: property to destry
3715 *
3716 * This function frees a property including any attached resources like
3717 * enumeration values.
3718 */
3719void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
3720{
3721	struct drm_property_enum *prop_enum, *pt;
3722
3723	list_for_each_entry_safe(prop_enum, pt, &property->enum_blob_list, head) {
3724		list_del(&prop_enum->head);
3725		kfree(prop_enum);
3726	}
3727
3728	if (property->num_values)
3729		kfree(property->values);
3730	drm_mode_object_put(dev, &property->base);
3731	list_del(&property->head);
3732	kfree(property);
3733}
3734EXPORT_SYMBOL(drm_property_destroy);
3735
3736/**
3737 * drm_object_attach_property - attach a property to a modeset object
3738 * @obj: drm modeset object
3739 * @property: property to attach
3740 * @init_val: initial value of the property
3741 *
3742 * This attaches the given property to the modeset object with the given initial
3743 * value. Currently this function cannot fail since the properties are stored in
3744 * a statically sized array.
3745 */
3746void drm_object_attach_property(struct drm_mode_object *obj,
3747				struct drm_property *property,
3748				uint64_t init_val)
3749{
3750	int count = obj->properties->count;
3751
3752	if (count == DRM_OBJECT_MAX_PROPERTY) {
3753		WARN(1, "Failed to attach object property (type: 0x%x). Please "
3754			"increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
3755			"you see this message on the same object type.\n",
3756			obj->type);
3757		return;
3758	}
3759
3760	obj->properties->ids[count] = property->base.id;
3761	obj->properties->values[count] = init_val;
3762	obj->properties->count++;
3763}
3764EXPORT_SYMBOL(drm_object_attach_property);
3765
3766/**
3767 * drm_object_property_set_value - set the value of a property
3768 * @obj: drm mode object to set property value for
3769 * @property: property to set
3770 * @val: value the property should be set to
3771 *
3772 * This functions sets a given property on a given object. This function only
3773 * changes the software state of the property, it does not call into the
3774 * driver's ->set_property callback.
3775 *
3776 * Returns:
3777 * Zero on success, error code on failure.
3778 */
3779int drm_object_property_set_value(struct drm_mode_object *obj,
3780				  struct drm_property *property, uint64_t val)
3781{
3782	int i;
3783
3784	for (i = 0; i < obj->properties->count; i++) {
3785		if (obj->properties->ids[i] == property->base.id) {
3786			obj->properties->values[i] = val;
3787			return 0;
3788		}
3789	}
3790
3791	return -EINVAL;
3792}
3793EXPORT_SYMBOL(drm_object_property_set_value);
3794
3795/**
3796 * drm_object_property_get_value - retrieve the value of a property
3797 * @obj: drm mode object to get property value from
3798 * @property: property to retrieve
3799 * @val: storage for the property value
3800 *
3801 * This function retrieves the softare state of the given property for the given
3802 * property. Since there is no driver callback to retrieve the current property
3803 * value this might be out of sync with the hardware, depending upon the driver
3804 * and property.
3805 *
3806 * Returns:
3807 * Zero on success, error code on failure.
3808 */
3809int drm_object_property_get_value(struct drm_mode_object *obj,
3810				  struct drm_property *property, uint64_t *val)
3811{
3812	int i;
3813
3814	for (i = 0; i < obj->properties->count; i++) {
3815		if (obj->properties->ids[i] == property->base.id) {
3816			*val = obj->properties->values[i];
3817			return 0;
3818		}
3819	}
3820
3821	return -EINVAL;
3822}
3823EXPORT_SYMBOL(drm_object_property_get_value);
3824
3825/**
3826 * drm_mode_getproperty_ioctl - get the current value of a connector's property
3827 * @dev: DRM device
3828 * @data: ioctl data
3829 * @file_priv: DRM file info
3830 *
3831 * This function retrieves the current value for an connectors's property.
3832 *
3833 * Called by the user via ioctl.
3834 *
3835 * Returns:
3836 * Zero on success, errno on failure.
3837 */
3838int drm_mode_getproperty_ioctl(struct drm_device *dev,
3839			       void *data, struct drm_file *file_priv)
3840{
3841	struct drm_mode_get_property *out_resp = data;
3842	struct drm_property *property;
3843	int enum_count = 0;
3844	int blob_count = 0;
3845	int value_count = 0;
3846	int ret = 0, i;
3847	int copied;
3848	struct drm_property_enum *prop_enum;
3849	struct drm_mode_property_enum __user *enum_ptr;
3850	struct drm_property_blob *prop_blob;
3851	uint32_t __user *blob_id_ptr;
3852	uint64_t __user *values_ptr;
3853	uint32_t __user *blob_length_ptr;
3854
3855	if (!drm_core_check_feature(dev, DRIVER_MODESET))
3856		return -EINVAL;
3857
3858	drm_modeset_lock_all(dev);
3859	property = drm_property_find(dev, out_resp->prop_id);
3860	if (!property) {
3861		ret = -ENOENT;
3862		goto done;
3863	}
3864
3865	if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3866			drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
3867		list_for_each_entry(prop_enum, &property->enum_blob_list, head)
3868			enum_count++;
3869	} else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
3870		list_for_each_entry(prop_blob, &property->enum_blob_list, head)
3871			blob_count++;
3872	}
3873
3874	value_count = property->num_values;
3875
3876	strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
3877	out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
3878	out_resp->flags = property->flags;
3879
3880	if ((out_resp->count_values >= value_count) && value_count) {
3881		values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
3882		for (i = 0; i < value_count; i++) {
3883			if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
3884				ret = -EFAULT;
3885				goto done;
3886			}
3887		}
3888	}
3889	out_resp->count_values = value_count;
3890
3891	if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3892			drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
3893		if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
3894			copied = 0;
3895			enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
3896			list_for_each_entry(prop_enum, &property->enum_blob_list, head) {
3897
3898				if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
3899					ret = -EFAULT;
3900					goto done;
3901				}
3902
3903				if (copy_to_user(&enum_ptr[copied].name,
3904						 &prop_enum->name, DRM_PROP_NAME_LEN)) {
3905					ret = -EFAULT;
3906					goto done;
3907				}
3908				copied++;
3909			}
3910		}
3911		out_resp->count_enum_blobs = enum_count;
3912	}
3913
3914	if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
3915		if ((out_resp->count_enum_blobs >= blob_count) && blob_count) {
3916			copied = 0;
3917			blob_id_ptr = (uint32_t __user *)(unsigned long)out_resp->enum_blob_ptr;
3918			blob_length_ptr = (uint32_t __user *)(unsigned long)out_resp->values_ptr;
3919
3920			list_for_each_entry(prop_blob, &property->enum_blob_list, head) {
3921				if (put_user(prop_blob->base.id, blob_id_ptr + copied)) {
3922					ret = -EFAULT;
3923					goto done;
3924				}
3925
3926				if (put_user(prop_blob->length, blob_length_ptr + copied)) {
3927					ret = -EFAULT;
3928					goto done;
3929				}
3930
3931				copied++;
3932			}
3933		}
3934		out_resp->count_enum_blobs = blob_count;
3935	}
3936done:
3937	drm_modeset_unlock_all(dev);
3938	return ret;
3939}
3940
3941static struct drm_property_blob *drm_property_create_blob(struct drm_device *dev, int length,
3942							  void *data)
3943{
3944	struct drm_property_blob *blob;
3945	int ret;
3946
3947	if (!length || !data)
3948		return NULL;
3949
3950	blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
3951	if (!blob)
3952		return NULL;
3953
3954	ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
3955	if (ret) {
3956		kfree(blob);
3957		return NULL;
3958	}
3959
3960	blob->length = length;
3961
3962	memcpy(blob->data, data, length);
3963
3964	list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
3965	return blob;
3966}
3967
3968static void drm_property_destroy_blob(struct drm_device *dev,
3969			       struct drm_property_blob *blob)
3970{
3971	drm_mode_object_put(dev, &blob->base);
3972	list_del(&blob->head);
3973	kfree(blob);
3974}
3975
3976/**
3977 * drm_mode_getblob_ioctl - get the contents of a blob property value
3978 * @dev: DRM device
3979 * @data: ioctl data
3980 * @file_priv: DRM file info
3981 *
3982 * This function retrieves the contents of a blob property. The value stored in
3983 * an object's blob property is just a normal modeset object id.
3984 *
3985 * Called by the user via ioctl.
3986 *
3987 * Returns:
3988 * Zero on success, errno on failure.
3989 */
3990int drm_mode_getblob_ioctl(struct drm_device *dev,
3991			   void *data, struct drm_file *file_priv)
3992{
3993	struct drm_mode_get_blob *out_resp = data;
3994	struct drm_property_blob *blob;
3995	int ret = 0;
3996	void __user *blob_ptr;
3997
3998	if (!drm_core_check_feature(dev, DRIVER_MODESET))
3999		return -EINVAL;
4000
4001	drm_modeset_lock_all(dev);
4002	blob = drm_property_blob_find(dev, out_resp->blob_id);
4003	if (!blob) {
4004		ret = -ENOENT;
4005		goto done;
4006	}
4007
4008	if (out_resp->length == blob->length) {
4009		blob_ptr = (void __user *)(unsigned long)out_resp->data;
4010		if (copy_to_user(blob_ptr, blob->data, blob->length)){
4011			ret = -EFAULT;
4012			goto done;
4013		}
4014	}
4015	out_resp->length = blob->length;
4016
4017done:
4018	drm_modeset_unlock_all(dev);
4019	return ret;
4020}
4021
4022int drm_mode_connector_set_path_property(struct drm_connector *connector,
4023					 char *path)
4024{
4025	struct drm_device *dev = connector->dev;
4026	int ret, size;
4027	size = strlen(path) + 1;
4028
4029	connector->path_blob_ptr = drm_property_create_blob(connector->dev,
4030							    size, path);
4031	if (!connector->path_blob_ptr)
4032		return -EINVAL;
4033
4034	ret = drm_object_property_set_value(&connector->base,
4035					    dev->mode_config.path_property,
4036					    connector->path_blob_ptr->base.id);
4037	return ret;
4038}
4039EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4040
4041/**
4042 * drm_mode_connector_update_edid_property - update the edid property of a connector
4043 * @connector: drm connector
4044 * @edid: new value of the edid property
4045 *
4046 * This function creates a new blob modeset object and assigns its id to the
4047 * connector's edid property.
4048 *
4049 * Returns:
4050 * Zero on success, errno on failure.
4051 */
4052int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4053					    struct edid *edid)
4054{
4055	struct drm_device *dev = connector->dev;
4056	int ret, size;
4057
4058	/* ignore requests to set edid when overridden */
4059	if (connector->override_edid)
4060		return 0;
4061
4062	if (connector->edid_blob_ptr)
4063		drm_property_destroy_blob(dev, connector->edid_blob_ptr);
4064
4065	/* Delete edid, when there is none. */
4066	if (!edid) {
4067		connector->edid_blob_ptr = NULL;
4068		ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
4069		return ret;
4070	}
4071
4072	size = EDID_LENGTH * (1 + edid->extensions);
4073	connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
4074							    size, edid);
4075	if (!connector->edid_blob_ptr)
4076		return -EINVAL;
4077
4078	ret = drm_object_property_set_value(&connector->base,
4079					       dev->mode_config.edid_property,
4080					       connector->edid_blob_ptr->base.id);
4081
4082	return ret;
4083}
4084EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4085
4086static bool drm_property_change_is_valid(struct drm_property *property,
4087					 uint64_t value)
4088{
4089	if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4090		return false;
4091
4092	if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4093		if (value < property->values[0] || value > property->values[1])
4094			return false;
4095		return true;
4096	} else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4097		int64_t svalue = U642I64(value);
4098		if (svalue < U642I64(property->values[0]) ||
4099				svalue > U642I64(property->values[1]))
4100			return false;
4101		return true;
4102	} else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4103		int i;
4104		uint64_t valid_mask = 0;
4105		for (i = 0; i < property->num_values; i++)
4106			valid_mask |= (1ULL << property->values[i]);
4107		return !(value & ~valid_mask);
4108	} else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4109		/* Only the driver knows */
4110		return true;
4111	} else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4112		struct drm_mode_object *obj;
4113		/* a zero value for an object property translates to null: */
4114		if (value == 0)
4115			return true;
4116		/*
4117		 * NOTE: use _object_find() directly to bypass restriction on
4118		 * looking up refcnt'd objects (ie. fb's).  For a refcnt'd
4119		 * object this could race against object finalization, so it
4120		 * simply tells us that the object *was* valid.  Which is good
4121		 * enough.
4122		 */
4123		obj = _object_find(property->dev, value, property->values[0]);
4124		return obj != NULL;
4125	} else {
4126		int i;
4127		for (i = 0; i < property->num_values; i++)
4128			if (property->values[i] == value)
4129				return true;
4130		return false;
4131	}
4132}
4133
4134/**
4135 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4136 * @dev: DRM device
4137 * @data: ioctl data
4138 * @file_priv: DRM file info
4139 *
4140 * This function sets the current value for a connectors's property. It also
4141 * calls into a driver's ->set_property callback to update the hardware state
4142 *
4143 * Called by the user via ioctl.
4144 *
4145 * Returns:
4146 * Zero on success, errno on failure.
4147 */
4148int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4149				       void *data, struct drm_file *file_priv)
4150{
4151	struct drm_mode_connector_set_property *conn_set_prop = data;
4152	struct drm_mode_obj_set_property obj_set_prop = {
4153		.value = conn_set_prop->value,
4154		.prop_id = conn_set_prop->prop_id,
4155		.obj_id = conn_set_prop->connector_id,
4156		.obj_type = DRM_MODE_OBJECT_CONNECTOR
4157	};
4158
4159	/* It does all the locking and checking we need */
4160	return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4161}
4162
4163static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4164					   struct drm_property *property,
4165					   uint64_t value)
4166{
4167	int ret = -EINVAL;
4168	struct drm_connector *connector = obj_to_connector(obj);
4169
4170	/* Do DPMS ourselves */
4171	if (property == connector->dev->mode_config.dpms_property) {
4172		if (connector->funcs->dpms)
4173			(*connector->funcs->dpms)(connector, (int)value);
4174		ret = 0;
4175	} else if (connector->funcs->set_property)
4176		ret = connector->funcs->set_property(connector, property, value);
4177
4178	/* store the property value if successful */
4179	if (!ret)
4180		drm_object_property_set_value(&connector->base, property, value);
4181	return ret;
4182}
4183
4184static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4185				      struct drm_property *property,
4186				      uint64_t value)
4187{
4188	int ret = -EINVAL;
4189	struct drm_crtc *crtc = obj_to_crtc(obj);
4190
4191	if (crtc->funcs->set_property)
4192		ret = crtc->funcs->set_property(crtc, property, value);
4193	if (!ret)
4194		drm_object_property_set_value(obj, property, value);
4195
4196	return ret;
4197}
4198
4199/**
4200 * drm_mode_plane_set_obj_prop - set the value of a property
4201 * @plane: drm plane object to set property value for
4202 * @property: property to set
4203 * @value: value the property should be set to
4204 *
4205 * This functions sets a given property on a given plane object. This function
4206 * calls the driver's ->set_property callback and changes the software state of
4207 * the property if the callback succeeds.
4208 *
4209 * Returns:
4210 * Zero on success, error code on failure.
4211 */
4212int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
4213				struct drm_property *property,
4214				uint64_t value)
4215{
4216	int ret = -EINVAL;
4217	struct drm_mode_object *obj = &plane->base;
4218
4219	if (plane->funcs->set_property)
4220		ret = plane->funcs->set_property(plane, property, value);
4221	if (!ret)
4222		drm_object_property_set_value(obj, property, value);
4223
4224	return ret;
4225}
4226EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
4227
4228/**
4229 * drm_mode_getproperty_ioctl - get the current value of a object's property
4230 * @dev: DRM device
4231 * @data: ioctl data
4232 * @file_priv: DRM file info
4233 *
4234 * This function retrieves the current value for an object's property. Compared
4235 * to the connector specific ioctl this one is extended to also work on crtc and
4236 * plane objects.
4237 *
4238 * Called by the user via ioctl.
4239 *
4240 * Returns:
4241 * Zero on success, errno on failure.
4242 */
4243int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
4244				      struct drm_file *file_priv)
4245{
4246	struct drm_mode_obj_get_properties *arg = data;
4247	struct drm_mode_object *obj;
4248	int ret = 0;
4249	int i;
4250	int copied = 0;
4251	int props_count = 0;
4252	uint32_t __user *props_ptr;
4253	uint64_t __user *prop_values_ptr;
4254
4255	if (!drm_core_check_feature(dev, DRIVER_MODESET))
4256		return -EINVAL;
4257
4258	drm_modeset_lock_all(dev);
4259
4260	obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4261	if (!obj) {
4262		ret = -ENOENT;
4263		goto out;
4264	}
4265	if (!obj->properties) {
4266		ret = -EINVAL;
4267		goto out;
4268	}
4269
4270	props_count = obj->properties->count;
4271
4272	/* This ioctl is called twice, once to determine how much space is
4273	 * needed, and the 2nd time to fill it. */
4274	if ((arg->count_props >= props_count) && props_count) {
4275		copied = 0;
4276		props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
4277		prop_values_ptr = (uint64_t __user *)(unsigned long)
4278				  (arg->prop_values_ptr);
4279		for (i = 0; i < props_count; i++) {
4280			if (put_user(obj->properties->ids[i],
4281				     props_ptr + copied)) {
4282				ret = -EFAULT;
4283				goto out;
4284			}
4285			if (put_user(obj->properties->values[i],
4286				     prop_values_ptr + copied)) {
4287				ret = -EFAULT;
4288				goto out;
4289			}
4290			copied++;
4291		}
4292	}
4293	arg->count_props = props_count;
4294out:
4295	drm_modeset_unlock_all(dev);
4296	return ret;
4297}
4298
4299/**
4300 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
4301 * @dev: DRM device
4302 * @data: ioctl data
4303 * @file_priv: DRM file info
4304 *
4305 * This function sets the current value for an object's property. It also calls
4306 * into a driver's ->set_property callback to update the hardware state.
4307 * Compared to the connector specific ioctl this one is extended to also work on
4308 * crtc and plane objects.
4309 *
4310 * Called by the user via ioctl.
4311 *
4312 * Returns:
4313 * Zero on success, errno on failure.
4314 */
4315int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
4316				    struct drm_file *file_priv)
4317{
4318	struct drm_mode_obj_set_property *arg = data;
4319	struct drm_mode_object *arg_obj;
4320	struct drm_mode_object *prop_obj;
4321	struct drm_property *property;
4322	int ret = -EINVAL;
4323	int i;
4324
4325	if (!drm_core_check_feature(dev, DRIVER_MODESET))
4326		return -EINVAL;
4327
4328	drm_modeset_lock_all(dev);
4329
4330	arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4331	if (!arg_obj) {
4332		ret = -ENOENT;
4333		goto out;
4334	}
4335	if (!arg_obj->properties)
4336		goto out;
4337
4338	for (i = 0; i < arg_obj->properties->count; i++)
4339		if (arg_obj->properties->ids[i] == arg->prop_id)
4340			break;
4341
4342	if (i == arg_obj->properties->count)
4343		goto out;
4344
4345	prop_obj = drm_mode_object_find(dev, arg->prop_id,
4346					DRM_MODE_OBJECT_PROPERTY);
4347	if (!prop_obj) {
4348		ret = -ENOENT;
4349		goto out;
4350	}
4351	property = obj_to_property(prop_obj);
4352
4353	if (!drm_property_change_is_valid(property, arg->value))
4354		goto out;
4355
4356	switch (arg_obj->type) {
4357	case DRM_MODE_OBJECT_CONNECTOR:
4358		ret = drm_mode_connector_set_obj_prop(arg_obj, property,
4359						      arg->value);
4360		break;
4361	case DRM_MODE_OBJECT_CRTC:
4362		ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
4363		break;
4364	case DRM_MODE_OBJECT_PLANE:
4365		ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
4366						  property, arg->value);
4367		break;
4368	}
4369
4370out:
4371	drm_modeset_unlock_all(dev);
4372	return ret;
4373}
4374
4375/**
4376 * drm_mode_connector_attach_encoder - attach a connector to an encoder
4377 * @connector: connector to attach
4378 * @encoder: encoder to attach @connector to
4379 *
4380 * This function links up a connector to an encoder. Note that the routing
4381 * restrictions between encoders and crtcs are exposed to userspace through the
4382 * possible_clones and possible_crtcs bitmasks.
4383 *
4384 * Returns:
4385 * Zero on success, errno on failure.
4386 */
4387int drm_mode_connector_attach_encoder(struct drm_connector *connector,
4388				      struct drm_encoder *encoder)
4389{
4390	int i;
4391
4392	for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
4393		if (connector->encoder_ids[i] == 0) {
4394			connector->encoder_ids[i] = encoder->base.id;
4395			return 0;
4396		}
4397	}
4398	return -ENOMEM;
4399}
4400EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
4401
4402/**
4403 * drm_mode_crtc_set_gamma_size - set the gamma table size
4404 * @crtc: CRTC to set the gamma table size for
4405 * @gamma_size: size of the gamma table
4406 *
4407 * Drivers which support gamma tables should set this to the supported gamma
4408 * table size when initializing the CRTC. Currently the drm core only supports a
4409 * fixed gamma table size.
4410 *
4411 * Returns:
4412 * Zero on success, errno on failure.
4413 */
4414int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
4415				 int gamma_size)
4416{
4417	crtc->gamma_size = gamma_size;
4418
4419	crtc->gamma_store = kzalloc(gamma_size * sizeof(uint16_t) * 3, GFP_KERNEL);
4420	if (!crtc->gamma_store) {
4421		crtc->gamma_size = 0;
4422		return -ENOMEM;
4423	}
4424
4425	return 0;
4426}
4427EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
4428
4429/**
4430 * drm_mode_gamma_set_ioctl - set the gamma table
4431 * @dev: DRM device
4432 * @data: ioctl data
4433 * @file_priv: DRM file info
4434 *
4435 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
4436 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
4437 *
4438 * Called by the user via ioctl.
4439 *
4440 * Returns:
4441 * Zero on success, errno on failure.
4442 */
4443int drm_mode_gamma_set_ioctl(struct drm_device *dev,
4444			     void *data, struct drm_file *file_priv)
4445{
4446	struct drm_mode_crtc_lut *crtc_lut = data;
4447	struct drm_crtc *crtc;
4448	void *r_base, *g_base, *b_base;
4449	int size;
4450	int ret = 0;
4451
4452	if (!drm_core_check_feature(dev, DRIVER_MODESET))
4453		return -EINVAL;
4454
4455	drm_modeset_lock_all(dev);
4456	crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4457	if (!crtc) {
4458		ret = -ENOENT;
4459		goto out;
4460	}
4461
4462	if (crtc->funcs->gamma_set == NULL) {
4463		ret = -ENOSYS;
4464		goto out;
4465	}
4466
4467	/* memcpy into gamma store */
4468	if (crtc_lut->gamma_size != crtc->gamma_size) {
4469		ret = -EINVAL;
4470		goto out;
4471	}
4472
4473	size = crtc_lut->gamma_size * (sizeof(uint16_t));
4474	r_base = crtc->gamma_store;
4475	if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
4476		ret = -EFAULT;
4477		goto out;
4478	}
4479
4480	g_base = r_base + size;
4481	if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
4482		ret = -EFAULT;
4483		goto out;
4484	}
4485
4486	b_base = g_base + size;
4487	if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
4488		ret = -EFAULT;
4489		goto out;
4490	}
4491
4492	crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
4493
4494out:
4495	drm_modeset_unlock_all(dev);
4496	return ret;
4497
4498}
4499
4500/**
4501 * drm_mode_gamma_get_ioctl - get the gamma table
4502 * @dev: DRM device
4503 * @data: ioctl data
4504 * @file_priv: DRM file info
4505 *
4506 * Copy the current gamma table into the storage provided. This also provides
4507 * the gamma table size the driver expects, which can be used to size the
4508 * allocated storage.
4509 *
4510 * Called by the user via ioctl.
4511 *
4512 * Returns:
4513 * Zero on success, errno on failure.
4514 */
4515int drm_mode_gamma_get_ioctl(struct drm_device *dev,
4516			     void *data, struct drm_file *file_priv)
4517{
4518	struct drm_mode_crtc_lut *crtc_lut = data;
4519	struct drm_crtc *crtc;
4520	void *r_base, *g_base, *b_base;
4521	int size;
4522	int ret = 0;
4523
4524	if (!drm_core_check_feature(dev, DRIVER_MODESET))
4525		return -EINVAL;
4526
4527	drm_modeset_lock_all(dev);
4528	crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4529	if (!crtc) {
4530		ret = -ENOENT;
4531		goto out;
4532	}
4533
4534	/* memcpy into gamma store */
4535	if (crtc_lut->gamma_size != crtc->gamma_size) {
4536		ret = -EINVAL;
4537		goto out;
4538	}
4539
4540	size = crtc_lut->gamma_size * (sizeof(uint16_t));
4541	r_base = crtc->gamma_store;
4542	if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
4543		ret = -EFAULT;
4544		goto out;
4545	}
4546
4547	g_base = r_base + size;
4548	if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
4549		ret = -EFAULT;
4550		goto out;
4551	}
4552
4553	b_base = g_base + size;
4554	if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
4555		ret = -EFAULT;
4556		goto out;
4557	}
4558out:
4559	drm_modeset_unlock_all(dev);
4560	return ret;
4561}
4562
4563/**
4564 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4565 * @dev: DRM device
4566 * @data: ioctl data
4567 * @file_priv: DRM file info
4568 *
4569 * This schedules an asynchronous update on a given CRTC, called page flip.
4570 * Optionally a drm event is generated to signal the completion of the event.
4571 * Generic drivers cannot assume that a pageflip with changed framebuffer
4572 * properties (including driver specific metadata like tiling layout) will work,
4573 * but some drivers support e.g. pixel format changes through the pageflip
4574 * ioctl.
4575 *
4576 * Called by the user via ioctl.
4577 *
4578 * Returns:
4579 * Zero on success, errno on failure.
4580 */
4581int drm_mode_page_flip_ioctl(struct drm_device *dev,
4582			     void *data, struct drm_file *file_priv)
4583{
4584	struct drm_mode_crtc_page_flip *page_flip = data;
4585	struct drm_crtc *crtc;
4586	struct drm_framebuffer *fb = NULL;
4587	struct drm_pending_vblank_event *e = NULL;
4588	unsigned long flags;
4589	int ret = -EINVAL;
4590
4591	if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
4592	    page_flip->reserved != 0)
4593		return -EINVAL;
4594
4595	if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
4596		return -EINVAL;
4597
4598	crtc = drm_crtc_find(dev, page_flip->crtc_id);
4599	if (!crtc)
4600		return -ENOENT;
4601
4602	drm_modeset_lock_crtc(crtc);
4603	if (crtc->primary->fb == NULL) {
4604		/* The framebuffer is currently unbound, presumably
4605		 * due to a hotplug event, that userspace has not
4606		 * yet discovered.
4607		 */
4608		ret = -EBUSY;
4609		goto out;
4610	}
4611
4612	if (crtc->funcs->page_flip == NULL)
4613		goto out;
4614
4615	fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
4616	if (!fb) {
4617		ret = -ENOENT;
4618		goto out;
4619	}
4620
4621	ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
4622	if (ret)
4623		goto out;
4624
4625	if (crtc->primary->fb->pixel_format != fb->pixel_format) {
4626		DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4627		ret = -EINVAL;
4628		goto out;
4629	}
4630
4631	if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4632		ret = -ENOMEM;
4633		spin_lock_irqsave(&dev->event_lock, flags);
4634		if (file_priv->event_space < sizeof e->event) {
4635			spin_unlock_irqrestore(&dev->event_lock, flags);
4636			goto out;
4637		}
4638		file_priv->event_space -= sizeof e->event;
4639		spin_unlock_irqrestore(&dev->event_lock, flags);
4640
4641		e = kzalloc(sizeof *e, GFP_KERNEL);
4642		if (e == NULL) {
4643			spin_lock_irqsave(&dev->event_lock, flags);
4644			file_priv->event_space += sizeof e->event;
4645			spin_unlock_irqrestore(&dev->event_lock, flags);
4646			goto out;
4647		}
4648
4649		e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
4650		e->event.base.length = sizeof e->event;
4651		e->event.user_data = page_flip->user_data;
4652		e->base.event = &e->event.base;
4653		e->base.file_priv = file_priv;
4654		e->base.destroy =
4655			(void (*) (struct drm_pending_event *)) kfree;
4656	}
4657
4658	crtc->primary->old_fb = crtc->primary->fb;
4659	ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
4660	if (ret) {
4661		if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4662			spin_lock_irqsave(&dev->event_lock, flags);
4663			file_priv->event_space += sizeof e->event;
4664			spin_unlock_irqrestore(&dev->event_lock, flags);
4665			kfree(e);
4666		}
4667		/* Keep the old fb, don't unref it. */
4668		crtc->primary->old_fb = NULL;
4669	} else {
4670		/*
4671		 * Warn if the driver hasn't properly updated the crtc->fb
4672		 * field to reflect that the new framebuffer is now used.
4673		 * Failing to do so will screw with the reference counting
4674		 * on framebuffers.
4675		 */
4676		WARN_ON(crtc->primary->fb != fb);
4677		/* Unref only the old framebuffer. */
4678		fb = NULL;
4679	}
4680
4681out:
4682	if (fb)
4683		drm_framebuffer_unreference(fb);
4684	if (crtc->primary->old_fb)
4685		drm_framebuffer_unreference(crtc->primary->old_fb);
4686	crtc->primary->old_fb = NULL;
4687	drm_modeset_unlock_crtc(crtc);
4688
4689	return ret;
4690}
4691
4692/**
4693 * drm_mode_config_reset - call ->reset callbacks
4694 * @dev: drm device
4695 *
4696 * This functions calls all the crtc's, encoder's and connector's ->reset
4697 * callback. Drivers can use this in e.g. their driver load or resume code to
4698 * reset hardware and software state.
4699 */
4700void drm_mode_config_reset(struct drm_device *dev)
4701{
4702	struct drm_crtc *crtc;
4703	struct drm_plane *plane;
4704	struct drm_encoder *encoder;
4705	struct drm_connector *connector;
4706
4707	list_for_each_entry(plane, &dev->mode_config.plane_list, head)
4708		if (plane->funcs->reset)
4709			plane->funcs->reset(plane);
4710
4711	list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
4712		if (crtc->funcs->reset)
4713			crtc->funcs->reset(crtc);
4714
4715	list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
4716		if (encoder->funcs->reset)
4717			encoder->funcs->reset(encoder);
4718
4719	list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
4720		connector->status = connector_status_unknown;
4721
4722		if (connector->funcs->reset)
4723			connector->funcs->reset(connector);
4724	}
4725}
4726EXPORT_SYMBOL(drm_mode_config_reset);
4727
4728/**
4729 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
4730 * @dev: DRM device
4731 * @data: ioctl data
4732 * @file_priv: DRM file info
4733 *
4734 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
4735 * TTM or something else entirely) and returns the resulting buffer handle. This
4736 * handle can then be wrapped up into a framebuffer modeset object.
4737 *
4738 * Note that userspace is not allowed to use such objects for render
4739 * acceleration - drivers must create their own private ioctls for such a use
4740 * case.
4741 *
4742 * Called by the user via ioctl.
4743 *
4744 * Returns:
4745 * Zero on success, errno on failure.
4746 */
4747int drm_mode_create_dumb_ioctl(struct drm_device *dev,
4748			       void *data, struct drm_file *file_priv)
4749{
4750	struct drm_mode_create_dumb *args = data;
4751	u32 cpp, stride, size;
4752
4753	if (!dev->driver->dumb_create)
4754		return -ENOSYS;
4755	if (!args->width || !args->height || !args->bpp)
4756		return -EINVAL;
4757
4758	/* overflow checks for 32bit size calculations */
4759	/* NOTE: DIV_ROUND_UP() can overflow */
4760	cpp = DIV_ROUND_UP(args->bpp, 8);
4761	if (!cpp || cpp > 0xffffffffU / args->width)
4762		return -EINVAL;
4763	stride = cpp * args->width;
4764	if (args->height > 0xffffffffU / stride)
4765		return -EINVAL;
4766
4767	/* test for wrap-around */
4768	size = args->height * stride;
4769	if (PAGE_ALIGN(size) == 0)
4770		return -EINVAL;
4771
4772	return dev->driver->dumb_create(file_priv, dev, args);
4773}
4774
4775/**
4776 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
4777 * @dev: DRM device
4778 * @data: ioctl data
4779 * @file_priv: DRM file info
4780 *
4781 * Allocate an offset in the drm device node's address space to be able to
4782 * memory map a dumb buffer.
4783 *
4784 * Called by the user via ioctl.
4785 *
4786 * Returns:
4787 * Zero on success, errno on failure.
4788 */
4789int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
4790			     void *data, struct drm_file *file_priv)
4791{
4792	struct drm_mode_map_dumb *args = data;
4793
4794	/* call driver ioctl to get mmap offset */
4795	if (!dev->driver->dumb_map_offset)
4796		return -ENOSYS;
4797
4798	return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
4799}
4800
4801/**
4802 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
4803 * @dev: DRM device
4804 * @data: ioctl data
4805 * @file_priv: DRM file info
4806 *
4807 * This destroys the userspace handle for the given dumb backing storage buffer.
4808 * Since buffer objects must be reference counted in the kernel a buffer object
4809 * won't be immediately freed if a framebuffer modeset object still uses it.
4810 *
4811 * Called by the user via ioctl.
4812 *
4813 * Returns:
4814 * Zero on success, errno on failure.
4815 */
4816int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
4817				void *data, struct drm_file *file_priv)
4818{
4819	struct drm_mode_destroy_dumb *args = data;
4820
4821	if (!dev->driver->dumb_destroy)
4822		return -ENOSYS;
4823
4824	return dev->driver->dumb_destroy(file_priv, dev, args->handle);
4825}
4826
4827/**
4828 * drm_fb_get_bpp_depth - get the bpp/depth values for format
4829 * @format: pixel format (DRM_FORMAT_*)
4830 * @depth: storage for the depth value
4831 * @bpp: storage for the bpp value
4832 *
4833 * This only supports RGB formats here for compat with code that doesn't use
4834 * pixel formats directly yet.
4835 */
4836void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
4837			  int *bpp)
4838{
4839	switch (format) {
4840	case DRM_FORMAT_C8:
4841	case DRM_FORMAT_RGB332:
4842	case DRM_FORMAT_BGR233:
4843		*depth = 8;
4844		*bpp = 8;
4845		break;
4846	case DRM_FORMAT_XRGB1555:
4847	case DRM_FORMAT_XBGR1555:
4848	case DRM_FORMAT_RGBX5551:
4849	case DRM_FORMAT_BGRX5551:
4850	case DRM_FORMAT_ARGB1555:
4851	case DRM_FORMAT_ABGR1555:
4852	case DRM_FORMAT_RGBA5551:
4853	case DRM_FORMAT_BGRA5551:
4854		*depth = 15;
4855		*bpp = 16;
4856		break;
4857	case DRM_FORMAT_RGB565:
4858	case DRM_FORMAT_BGR565:
4859		*depth = 16;
4860		*bpp = 16;
4861		break;
4862	case DRM_FORMAT_RGB888:
4863	case DRM_FORMAT_BGR888:
4864		*depth = 24;
4865		*bpp = 24;
4866		break;
4867	case DRM_FORMAT_XRGB8888:
4868	case DRM_FORMAT_XBGR8888:
4869	case DRM_FORMAT_RGBX8888:
4870	case DRM_FORMAT_BGRX8888:
4871		*depth = 24;
4872		*bpp = 32;
4873		break;
4874	case DRM_FORMAT_XRGB2101010:
4875	case DRM_FORMAT_XBGR2101010:
4876	case DRM_FORMAT_RGBX1010102:
4877	case DRM_FORMAT_BGRX1010102:
4878	case DRM_FORMAT_ARGB2101010:
4879	case DRM_FORMAT_ABGR2101010:
4880	case DRM_FORMAT_RGBA1010102:
4881	case DRM_FORMAT_BGRA1010102:
4882		*depth = 30;
4883		*bpp = 32;
4884		break;
4885	case DRM_FORMAT_ARGB8888:
4886	case DRM_FORMAT_ABGR8888:
4887	case DRM_FORMAT_RGBA8888:
4888	case DRM_FORMAT_BGRA8888:
4889		*depth = 32;
4890		*bpp = 32;
4891		break;
4892	default:
4893		DRM_DEBUG_KMS("unsupported pixel format %s\n",
4894			      drm_get_format_name(format));
4895		*depth = 0;
4896		*bpp = 0;
4897		break;
4898	}
4899}
4900EXPORT_SYMBOL(drm_fb_get_bpp_depth);
4901
4902/**
4903 * drm_format_num_planes - get the number of planes for format
4904 * @format: pixel format (DRM_FORMAT_*)
4905 *
4906 * Returns:
4907 * The number of planes used by the specified pixel format.
4908 */
4909int drm_format_num_planes(uint32_t format)
4910{
4911	switch (format) {
4912	case DRM_FORMAT_YUV410:
4913	case DRM_FORMAT_YVU410:
4914	case DRM_FORMAT_YUV411:
4915	case DRM_FORMAT_YVU411:
4916	case DRM_FORMAT_YUV420:
4917	case DRM_FORMAT_YVU420:
4918	case DRM_FORMAT_YUV422:
4919	case DRM_FORMAT_YVU422:
4920	case DRM_FORMAT_YUV444:
4921	case DRM_FORMAT_YVU444:
4922		return 3;
4923	case DRM_FORMAT_NV12:
4924	case DRM_FORMAT_NV21:
4925	case DRM_FORMAT_NV16:
4926	case DRM_FORMAT_NV61:
4927	case DRM_FORMAT_NV24:
4928	case DRM_FORMAT_NV42:
4929		return 2;
4930	default:
4931		return 1;
4932	}
4933}
4934EXPORT_SYMBOL(drm_format_num_planes);
4935
4936/**
4937 * drm_format_plane_cpp - determine the bytes per pixel value
4938 * @format: pixel format (DRM_FORMAT_*)
4939 * @plane: plane index
4940 *
4941 * Returns:
4942 * The bytes per pixel value for the specified plane.
4943 */
4944int drm_format_plane_cpp(uint32_t format, int plane)
4945{
4946	unsigned int depth;
4947	int bpp;
4948
4949	if (plane >= drm_format_num_planes(format))
4950		return 0;
4951
4952	switch (format) {
4953	case DRM_FORMAT_YUYV:
4954	case DRM_FORMAT_YVYU:
4955	case DRM_FORMAT_UYVY:
4956	case DRM_FORMAT_VYUY:
4957		return 2;
4958	case DRM_FORMAT_NV12:
4959	case DRM_FORMAT_NV21:
4960	case DRM_FORMAT_NV16:
4961	case DRM_FORMAT_NV61:
4962	case DRM_FORMAT_NV24:
4963	case DRM_FORMAT_NV42:
4964		return plane ? 2 : 1;
4965	case DRM_FORMAT_YUV410:
4966	case DRM_FORMAT_YVU410:
4967	case DRM_FORMAT_YUV411:
4968	case DRM_FORMAT_YVU411:
4969	case DRM_FORMAT_YUV420:
4970	case DRM_FORMAT_YVU420:
4971	case DRM_FORMAT_YUV422:
4972	case DRM_FORMAT_YVU422:
4973	case DRM_FORMAT_YUV444:
4974	case DRM_FORMAT_YVU444:
4975		return 1;
4976	default:
4977		drm_fb_get_bpp_depth(format, &depth, &bpp);
4978		return bpp >> 3;
4979	}
4980}
4981EXPORT_SYMBOL(drm_format_plane_cpp);
4982
4983/**
4984 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
4985 * @format: pixel format (DRM_FORMAT_*)
4986 *
4987 * Returns:
4988 * The horizontal chroma subsampling factor for the
4989 * specified pixel format.
4990 */
4991int drm_format_horz_chroma_subsampling(uint32_t format)
4992{
4993	switch (format) {
4994	case DRM_FORMAT_YUV411:
4995	case DRM_FORMAT_YVU411:
4996	case DRM_FORMAT_YUV410:
4997	case DRM_FORMAT_YVU410:
4998		return 4;
4999	case DRM_FORMAT_YUYV:
5000	case DRM_FORMAT_YVYU:
5001	case DRM_FORMAT_UYVY:
5002	case DRM_FORMAT_VYUY:
5003	case DRM_FORMAT_NV12:
5004	case DRM_FORMAT_NV21:
5005	case DRM_FORMAT_NV16:
5006	case DRM_FORMAT_NV61:
5007	case DRM_FORMAT_YUV422:
5008	case DRM_FORMAT_YVU422:
5009	case DRM_FORMAT_YUV420:
5010	case DRM_FORMAT_YVU420:
5011		return 2;
5012	default:
5013		return 1;
5014	}
5015}
5016EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5017
5018/**
5019 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5020 * @format: pixel format (DRM_FORMAT_*)
5021 *
5022 * Returns:
5023 * The vertical chroma subsampling factor for the
5024 * specified pixel format.
5025 */
5026int drm_format_vert_chroma_subsampling(uint32_t format)
5027{
5028	switch (format) {
5029	case DRM_FORMAT_YUV410:
5030	case DRM_FORMAT_YVU410:
5031		return 4;
5032	case DRM_FORMAT_YUV420:
5033	case DRM_FORMAT_YVU420:
5034	case DRM_FORMAT_NV12:
5035	case DRM_FORMAT_NV21:
5036		return 2;
5037	default:
5038		return 1;
5039	}
5040}
5041EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5042
5043/**
5044 * drm_rotation_simplify() - Try to simplify the rotation
5045 * @rotation: Rotation to be simplified
5046 * @supported_rotations: Supported rotations
5047 *
5048 * Attempt to simplify the rotation to a form that is supported.
5049 * Eg. if the hardware supports everything except DRM_REFLECT_X
5050 * one could call this function like this:
5051 *
5052 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5053 *                       BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5054 *                       BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5055 *
5056 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5057 * transforms the hardware supports, this function may not
5058 * be able to produce a supported transform, so the caller should
5059 * check the result afterwards.
5060 */
5061unsigned int drm_rotation_simplify(unsigned int rotation,
5062				   unsigned int supported_rotations)
5063{
5064	if (rotation & ~supported_rotations) {
5065		rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5066		rotation = (rotation & ~0xf) | BIT((ffs(rotation & 0xf) + 1) % 4);
5067	}
5068
5069	return rotation;
5070}
5071EXPORT_SYMBOL(drm_rotation_simplify);
5072
5073/**
5074 * drm_mode_config_init - initialize DRM mode_configuration structure
5075 * @dev: DRM device
5076 *
5077 * Initialize @dev's mode_config structure, used for tracking the graphics
5078 * configuration of @dev.
5079 *
5080 * Since this initializes the modeset locks, no locking is possible. Which is no
5081 * problem, since this should happen single threaded at init time. It is the
5082 * driver's problem to ensure this guarantee.
5083 *
5084 */
5085void drm_mode_config_init(struct drm_device *dev)
5086{
5087	mutex_init(&dev->mode_config.mutex);
5088	drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5089	mutex_init(&dev->mode_config.idr_mutex);
5090	mutex_init(&dev->mode_config.fb_lock);
5091	INIT_LIST_HEAD(&dev->mode_config.fb_list);
5092	INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5093	INIT_LIST_HEAD(&dev->mode_config.connector_list);
5094	INIT_LIST_HEAD(&dev->mode_config.bridge_list);
5095	INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5096	INIT_LIST_HEAD(&dev->mode_config.property_list);
5097	INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5098	INIT_LIST_HEAD(&dev->mode_config.plane_list);
5099	idr_init(&dev->mode_config.crtc_idr);
5100
5101	drm_modeset_lock_all(dev);
5102	drm_mode_create_standard_connector_properties(dev);
5103	drm_mode_create_standard_plane_properties(dev);
5104	drm_modeset_unlock_all(dev);
5105
5106	/* Just to be sure */
5107	dev->mode_config.num_fb = 0;
5108	dev->mode_config.num_connector = 0;
5109	dev->mode_config.num_crtc = 0;
5110	dev->mode_config.num_encoder = 0;
5111	dev->mode_config.num_overlay_plane = 0;
5112	dev->mode_config.num_total_plane = 0;
5113}
5114EXPORT_SYMBOL(drm_mode_config_init);
5115
5116/**
5117 * drm_mode_config_cleanup - free up DRM mode_config info
5118 * @dev: DRM device
5119 *
5120 * Free up all the connectors and CRTCs associated with this DRM device, then
5121 * free up the framebuffers and associated buffer objects.
5122 *
5123 * Note that since this /should/ happen single-threaded at driver/device
5124 * teardown time, no locking is required. It's the driver's job to ensure that
5125 * this guarantee actually holds true.
5126 *
5127 * FIXME: cleanup any dangling user buffer objects too
5128 */
5129void drm_mode_config_cleanup(struct drm_device *dev)
5130{
5131	struct drm_connector *connector, *ot;
5132	struct drm_crtc *crtc, *ct;
5133	struct drm_encoder *encoder, *enct;
5134	struct drm_bridge *bridge, *brt;
5135	struct drm_framebuffer *fb, *fbt;
5136	struct drm_property *property, *pt;
5137	struct drm_property_blob *blob, *bt;
5138	struct drm_plane *plane, *plt;
5139
5140	list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5141				 head) {
5142		encoder->funcs->destroy(encoder);
5143	}
5144
5145	list_for_each_entry_safe(bridge, brt,
5146				 &dev->mode_config.bridge_list, head) {
5147		bridge->funcs->destroy(bridge);
5148	}
5149
5150	list_for_each_entry_safe(connector, ot,
5151				 &dev->mode_config.connector_list, head) {
5152		connector->funcs->destroy(connector);
5153	}
5154
5155	list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5156				 head) {
5157		drm_property_destroy(dev, property);
5158	}
5159
5160	list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
5161				 head) {
5162		drm_property_destroy_blob(dev, blob);
5163	}
5164
5165	/*
5166	 * Single-threaded teardown context, so it's not required to grab the
5167	 * fb_lock to protect against concurrent fb_list access. Contrary, it
5168	 * would actually deadlock with the drm_framebuffer_cleanup function.
5169	 *
5170	 * Also, if there are any framebuffers left, that's a driver leak now,
5171	 * so politely WARN about this.
5172	 */
5173	WARN_ON(!list_empty(&dev->mode_config.fb_list));
5174	list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
5175		drm_framebuffer_remove(fb);
5176	}
5177
5178	list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
5179				 head) {
5180		plane->funcs->destroy(plane);
5181	}
5182
5183	list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
5184		crtc->funcs->destroy(crtc);
5185	}
5186
5187	idr_destroy(&dev->mode_config.crtc_idr);
5188	drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
5189}
5190EXPORT_SYMBOL(drm_mode_config_cleanup);
5191
5192struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
5193						       unsigned int supported_rotations)
5194{
5195	static const struct drm_prop_enum_list props[] = {
5196		{ DRM_ROTATE_0,   "rotate-0" },
5197		{ DRM_ROTATE_90,  "rotate-90" },
5198		{ DRM_ROTATE_180, "rotate-180" },
5199		{ DRM_ROTATE_270, "rotate-270" },
5200		{ DRM_REFLECT_X,  "reflect-x" },
5201		{ DRM_REFLECT_Y,  "reflect-y" },
5202	};
5203
5204	return drm_property_create_bitmask(dev, 0, "rotation",
5205					   props, ARRAY_SIZE(props),
5206					   supported_rotations);
5207}
5208EXPORT_SYMBOL(drm_mode_create_rotation_property);
5209