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