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