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