2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
4 * Copyright (c) 2008 Red Hat Inc.
6 * DRM core CRTC related functions
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.
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
28 * Eric Anholt <eric@anholt.net>
29 * Dave Airlie <airlied@linux.ie>
30 * Jesse Barnes <jesse.barnes@intel.com>
32 #include <linux/ctype.h>
33 #include <linux/list.h>
34 #include <linux/slab.h>
35 #include <linux/export.h>
37 #include <drm/drm_crtc.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_fourcc.h>
40 #include <drm/drm_modeset_lock.h>
41 #include <drm/drm_atomic.h>
43 #include "drm_crtc_internal.h"
44 #include "drm_internal.h"
46 static struct drm_framebuffer *
47 internal_framebuffer_create(struct drm_device *dev,
48 struct drm_mode_fb_cmd2 *r,
49 struct drm_file *file_priv);
51 /* Avoid boilerplate. I'm tired of typing. */
52 #define DRM_ENUM_NAME_FN(fnname, list) \
53 const char *fnname(int val) \
56 for (i = 0; i < ARRAY_SIZE(list); i++) { \
57 if (list[i].type == val) \
58 return list[i].name; \
66 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
67 { DRM_MODE_DPMS_ON, "On" },
68 { DRM_MODE_DPMS_STANDBY, "Standby" },
69 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
70 { DRM_MODE_DPMS_OFF, "Off" }
73 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
75 static const struct drm_prop_enum_list drm_plane_type_enum_list[] = {
76 { DRM_PLANE_TYPE_OVERLAY, "Overlay" },
77 { DRM_PLANE_TYPE_PRIMARY, "Primary" },
78 { DRM_PLANE_TYPE_CURSOR, "Cursor" },
84 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
85 { DRM_MODE_SCALE_NONE, "None" },
86 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
87 { DRM_MODE_SCALE_CENTER, "Center" },
88 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
91 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
92 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
93 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
94 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
98 * Non-global properties, but "required" for certain connectors.
100 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
101 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
102 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
103 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
106 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
108 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
109 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
110 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
111 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
114 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
115 drm_dvi_i_subconnector_enum_list)
117 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
118 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
119 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
120 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
121 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
122 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
125 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
127 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
128 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
129 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
130 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
131 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
132 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
135 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
136 drm_tv_subconnector_enum_list)
138 static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
139 { DRM_MODE_DIRTY_OFF, "Off" },
140 { DRM_MODE_DIRTY_ON, "On" },
141 { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
144 struct drm_conn_prop_enum_list {
151 * Connector and encoder types.
153 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
154 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
155 { DRM_MODE_CONNECTOR_VGA, "VGA" },
156 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
157 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
158 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
159 { DRM_MODE_CONNECTOR_Composite, "Composite" },
160 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
161 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
162 { DRM_MODE_CONNECTOR_Component, "Component" },
163 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
164 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
165 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
166 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
167 { DRM_MODE_CONNECTOR_TV, "TV" },
168 { DRM_MODE_CONNECTOR_eDP, "eDP" },
169 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
170 { DRM_MODE_CONNECTOR_DSI, "DSI" },
173 static const struct drm_prop_enum_list drm_encoder_enum_list[] = {
174 { DRM_MODE_ENCODER_NONE, "None" },
175 { DRM_MODE_ENCODER_DAC, "DAC" },
176 { DRM_MODE_ENCODER_TMDS, "TMDS" },
177 { DRM_MODE_ENCODER_LVDS, "LVDS" },
178 { DRM_MODE_ENCODER_TVDAC, "TV" },
179 { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
180 { DRM_MODE_ENCODER_DSI, "DSI" },
181 { DRM_MODE_ENCODER_DPMST, "DP MST" },
184 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
185 { SubPixelUnknown, "Unknown" },
186 { SubPixelHorizontalRGB, "Horizontal RGB" },
187 { SubPixelHorizontalBGR, "Horizontal BGR" },
188 { SubPixelVerticalRGB, "Vertical RGB" },
189 { SubPixelVerticalBGR, "Vertical BGR" },
190 { SubPixelNone, "None" },
193 void drm_connector_ida_init(void)
197 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
198 ida_init(&drm_connector_enum_list[i].ida);
201 void drm_connector_ida_destroy(void)
205 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
206 ida_destroy(&drm_connector_enum_list[i].ida);
210 * drm_get_connector_status_name - return a string for connector status
211 * @status: connector status to compute name of
213 * In contrast to the other drm_get_*_name functions this one here returns a
214 * const pointer and hence is threadsafe.
216 const char *drm_get_connector_status_name(enum drm_connector_status status)
218 if (status == connector_status_connected)
220 else if (status == connector_status_disconnected)
221 return "disconnected";
225 EXPORT_SYMBOL(drm_get_connector_status_name);
228 * drm_get_subpixel_order_name - return a string for a given subpixel enum
229 * @order: enum of subpixel_order
231 * Note you could abuse this and return something out of bounds, but that
232 * would be a caller error. No unscrubbed user data should make it here.
234 const char *drm_get_subpixel_order_name(enum subpixel_order order)
236 return drm_subpixel_enum_list[order].name;
238 EXPORT_SYMBOL(drm_get_subpixel_order_name);
240 static char printable_char(int c)
242 return isascii(c) && isprint(c) ? c : '?';
246 * drm_get_format_name - return a string for drm fourcc format
247 * @format: format to compute name of
249 * Note that the buffer used by this function is globally shared and owned by
250 * the function itself.
252 * FIXME: This isn't really multithreading safe.
254 const char *drm_get_format_name(uint32_t format)
258 snprintf(buf, sizeof(buf),
259 "%c%c%c%c %s-endian (0x%08x)",
260 printable_char(format & 0xff),
261 printable_char((format >> 8) & 0xff),
262 printable_char((format >> 16) & 0xff),
263 printable_char((format >> 24) & 0x7f),
264 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
269 EXPORT_SYMBOL(drm_get_format_name);
272 * Internal function to assign a slot in the object idr and optionally
273 * register the object into the idr.
275 static int drm_mode_object_get_reg(struct drm_device *dev,
276 struct drm_mode_object *obj,
282 mutex_lock(&dev->mode_config.idr_mutex);
283 ret = idr_alloc(&dev->mode_config.crtc_idr, register_obj ? obj : NULL, 1, 0, GFP_KERNEL);
286 * Set up the object linking under the protection of the idr
287 * lock so that other users can't see inconsistent state.
290 obj->type = obj_type;
292 mutex_unlock(&dev->mode_config.idr_mutex);
294 return ret < 0 ? ret : 0;
298 * drm_mode_object_get - allocate a new modeset identifier
300 * @obj: object pointer, used to generate unique ID
301 * @obj_type: object type
303 * Create a unique identifier based on @ptr in @dev's identifier space. Used
304 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
305 * modeset identifiers are _not_ reference counted. Hence don't use this for
306 * reference counted modeset objects like framebuffers.
309 * New unique (relative to other objects in @dev) integer identifier for the
312 int drm_mode_object_get(struct drm_device *dev,
313 struct drm_mode_object *obj, uint32_t obj_type)
315 return drm_mode_object_get_reg(dev, obj, obj_type, true);
318 static void drm_mode_object_register(struct drm_device *dev,
319 struct drm_mode_object *obj)
321 mutex_lock(&dev->mode_config.idr_mutex);
322 idr_replace(&dev->mode_config.crtc_idr, obj, obj->id);
323 mutex_unlock(&dev->mode_config.idr_mutex);
327 * drm_mode_object_put - free a modeset identifer
329 * @object: object to free
331 * Free @id from @dev's unique identifier pool. Note that despite the _get
332 * postfix modeset identifiers are _not_ reference counted. Hence don't use this
333 * for reference counted modeset objects like framebuffers.
335 void drm_mode_object_put(struct drm_device *dev,
336 struct drm_mode_object *object)
338 mutex_lock(&dev->mode_config.idr_mutex);
339 idr_remove(&dev->mode_config.crtc_idr, object->id);
340 mutex_unlock(&dev->mode_config.idr_mutex);
343 static struct drm_mode_object *_object_find(struct drm_device *dev,
344 uint32_t id, uint32_t type)
346 struct drm_mode_object *obj = NULL;
348 mutex_lock(&dev->mode_config.idr_mutex);
349 obj = idr_find(&dev->mode_config.crtc_idr, id);
350 if (obj && type != DRM_MODE_OBJECT_ANY && obj->type != type)
352 if (obj && obj->id != id)
354 /* don't leak out unref'd fb's */
355 if (obj && (obj->type == DRM_MODE_OBJECT_FB))
357 mutex_unlock(&dev->mode_config.idr_mutex);
363 * drm_mode_object_find - look up a drm object with static lifetime
365 * @id: id of the mode object
366 * @type: type of the mode object
368 * Note that framebuffers cannot be looked up with this functions - since those
369 * are reference counted, they need special treatment. Even with
370 * DRM_MODE_OBJECT_ANY (although that will simply return NULL
371 * rather than WARN_ON()).
373 struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
374 uint32_t id, uint32_t type)
376 struct drm_mode_object *obj = NULL;
378 /* Framebuffers are reference counted and need their own lookup
380 WARN_ON(type == DRM_MODE_OBJECT_FB);
381 obj = _object_find(dev, id, type);
384 EXPORT_SYMBOL(drm_mode_object_find);
387 * drm_framebuffer_init - initialize a framebuffer
389 * @fb: framebuffer to be initialized
390 * @funcs: ... with these functions
392 * Allocates an ID for the framebuffer's parent mode object, sets its mode
393 * functions & device file and adds it to the master fd list.
396 * This functions publishes the fb and makes it available for concurrent access
397 * by other users. Which means by this point the fb _must_ be fully set up -
398 * since all the fb attributes are invariant over its lifetime, no further
399 * locking but only correct reference counting is required.
402 * Zero on success, error code on failure.
404 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
405 const struct drm_framebuffer_funcs *funcs)
409 mutex_lock(&dev->mode_config.fb_lock);
410 kref_init(&fb->refcount);
411 INIT_LIST_HEAD(&fb->filp_head);
415 ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
419 dev->mode_config.num_fb++;
420 list_add(&fb->head, &dev->mode_config.fb_list);
422 mutex_unlock(&dev->mode_config.fb_lock);
426 EXPORT_SYMBOL(drm_framebuffer_init);
428 /* dev->mode_config.fb_lock must be held! */
429 static void __drm_framebuffer_unregister(struct drm_device *dev,
430 struct drm_framebuffer *fb)
432 mutex_lock(&dev->mode_config.idr_mutex);
433 idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
434 mutex_unlock(&dev->mode_config.idr_mutex);
439 static void drm_framebuffer_free(struct kref *kref)
441 struct drm_framebuffer *fb =
442 container_of(kref, struct drm_framebuffer, refcount);
443 struct drm_device *dev = fb->dev;
446 * The lookup idr holds a weak reference, which has not necessarily been
447 * removed at this point. Check for that.
449 mutex_lock(&dev->mode_config.fb_lock);
451 /* Mark fb as reaped and drop idr ref. */
452 __drm_framebuffer_unregister(dev, fb);
454 mutex_unlock(&dev->mode_config.fb_lock);
456 fb->funcs->destroy(fb);
459 static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
462 struct drm_mode_object *obj = NULL;
463 struct drm_framebuffer *fb;
465 mutex_lock(&dev->mode_config.idr_mutex);
466 obj = idr_find(&dev->mode_config.crtc_idr, id);
467 if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
471 mutex_unlock(&dev->mode_config.idr_mutex);
477 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
479 * @id: id of the fb object
481 * If successful, this grabs an additional reference to the framebuffer -
482 * callers need to make sure to eventually unreference the returned framebuffer
483 * again, using @drm_framebuffer_unreference.
485 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
488 struct drm_framebuffer *fb;
490 mutex_lock(&dev->mode_config.fb_lock);
491 fb = __drm_framebuffer_lookup(dev, id);
493 if (!kref_get_unless_zero(&fb->refcount))
496 mutex_unlock(&dev->mode_config.fb_lock);
500 EXPORT_SYMBOL(drm_framebuffer_lookup);
503 * drm_framebuffer_unreference - unref a framebuffer
504 * @fb: framebuffer to unref
506 * This functions decrements the fb's refcount and frees it if it drops to zero.
508 void drm_framebuffer_unreference(struct drm_framebuffer *fb)
510 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
511 kref_put(&fb->refcount, drm_framebuffer_free);
513 EXPORT_SYMBOL(drm_framebuffer_unreference);
516 * drm_framebuffer_reference - incr the fb refcnt
519 * This functions increments the fb's refcount.
521 void drm_framebuffer_reference(struct drm_framebuffer *fb)
523 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
524 kref_get(&fb->refcount);
526 EXPORT_SYMBOL(drm_framebuffer_reference);
529 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
530 * @fb: fb to unregister
532 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
533 * those used for fbdev. Note that the caller must hold a reference of it's own,
534 * i.e. the object may not be destroyed through this call (since it'll lead to a
535 * locking inversion).
537 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
539 struct drm_device *dev = fb->dev;
541 mutex_lock(&dev->mode_config.fb_lock);
542 /* Mark fb as reaped and drop idr ref. */
543 __drm_framebuffer_unregister(dev, fb);
544 mutex_unlock(&dev->mode_config.fb_lock);
546 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
549 * drm_framebuffer_cleanup - remove a framebuffer object
550 * @fb: framebuffer to remove
552 * Cleanup framebuffer. This function is intended to be used from the drivers
553 * ->destroy callback. It can also be used to clean up driver private
554 * framebuffers embedded into a larger structure.
556 * Note that this function does not remove the fb from active usuage - if it is
557 * still used anywhere, hilarity can ensue since userspace could call getfb on
558 * the id and get back -EINVAL. Obviously no concern at driver unload time.
560 * Also, the framebuffer will not be removed from the lookup idr - for
561 * user-created framebuffers this will happen in in the rmfb ioctl. For
562 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
563 * drm_framebuffer_unregister_private.
565 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
567 struct drm_device *dev = fb->dev;
569 mutex_lock(&dev->mode_config.fb_lock);
571 dev->mode_config.num_fb--;
572 mutex_unlock(&dev->mode_config.fb_lock);
574 EXPORT_SYMBOL(drm_framebuffer_cleanup);
577 * drm_framebuffer_remove - remove and unreference a framebuffer object
578 * @fb: framebuffer to remove
580 * Scans all the CRTCs and planes in @dev's mode_config. If they're
581 * using @fb, removes it, setting it to NULL. Then drops the reference to the
582 * passed-in framebuffer. Might take the modeset locks.
584 * Note that this function optimizes the cleanup away if the caller holds the
585 * last reference to the framebuffer. It is also guaranteed to not take the
586 * modeset locks in this case.
588 void drm_framebuffer_remove(struct drm_framebuffer *fb)
590 struct drm_device *dev = fb->dev;
591 struct drm_crtc *crtc;
592 struct drm_plane *plane;
593 struct drm_mode_set set;
596 WARN_ON(!list_empty(&fb->filp_head));
599 * drm ABI mandates that we remove any deleted framebuffers from active
600 * useage. But since most sane clients only remove framebuffers they no
601 * longer need, try to optimize this away.
603 * Since we're holding a reference ourselves, observing a refcount of 1
604 * means that we're the last holder and can skip it. Also, the refcount
605 * can never increase from 1 again, so we don't need any barriers or
608 * Note that userspace could try to race with use and instate a new
609 * usage _after_ we've cleared all current ones. End result will be an
610 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
613 if (atomic_read(&fb->refcount.refcount) > 1) {
614 drm_modeset_lock_all(dev);
615 /* remove from any CRTC */
616 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
617 if (crtc->primary->fb == fb) {
618 /* should turn off the crtc */
619 memset(&set, 0, sizeof(struct drm_mode_set));
622 ret = drm_mode_set_config_internal(&set);
624 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
628 list_for_each_entry(plane, &dev->mode_config.plane_list, head) {
630 drm_plane_force_disable(plane);
632 drm_modeset_unlock_all(dev);
635 drm_framebuffer_unreference(fb);
637 EXPORT_SYMBOL(drm_framebuffer_remove);
639 DEFINE_WW_CLASS(crtc_ww_class);
642 * drm_crtc_init_with_planes - Initialise a new CRTC object with
643 * specified primary and cursor planes.
645 * @crtc: CRTC object to init
646 * @primary: Primary plane for CRTC
647 * @cursor: Cursor plane for CRTC
648 * @funcs: callbacks for the new CRTC
650 * Inits a new object created as base part of a driver crtc object.
653 * Zero on success, error code on failure.
655 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
656 struct drm_plane *primary,
657 struct drm_plane *cursor,
658 const struct drm_crtc_funcs *funcs)
660 struct drm_mode_config *config = &dev->mode_config;
663 WARN_ON(primary && primary->type != DRM_PLANE_TYPE_PRIMARY);
664 WARN_ON(cursor && cursor->type != DRM_PLANE_TYPE_CURSOR);
668 crtc->invert_dimensions = false;
670 drm_modeset_lock_init(&crtc->mutex);
671 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
675 crtc->base.properties = &crtc->properties;
677 list_add_tail(&crtc->head, &config->crtc_list);
680 crtc->primary = primary;
681 crtc->cursor = cursor;
683 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
685 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
687 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
688 drm_object_attach_property(&crtc->base, config->prop_active, 0);
693 EXPORT_SYMBOL(drm_crtc_init_with_planes);
696 * drm_crtc_cleanup - Clean up the core crtc usage
697 * @crtc: CRTC to cleanup
699 * This function cleans up @crtc and removes it from the DRM mode setting
700 * core. Note that the function does *not* free the crtc structure itself,
701 * this is the responsibility of the caller.
703 void drm_crtc_cleanup(struct drm_crtc *crtc)
705 struct drm_device *dev = crtc->dev;
707 kfree(crtc->gamma_store);
708 crtc->gamma_store = NULL;
710 drm_modeset_lock_fini(&crtc->mutex);
712 drm_mode_object_put(dev, &crtc->base);
713 list_del(&crtc->head);
714 dev->mode_config.num_crtc--;
716 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
717 if (crtc->state && crtc->funcs->atomic_destroy_state)
718 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
720 memset(crtc, 0, sizeof(*crtc));
722 EXPORT_SYMBOL(drm_crtc_cleanup);
725 * drm_crtc_index - find the index of a registered CRTC
726 * @crtc: CRTC to find index for
728 * Given a registered CRTC, return the index of that CRTC within a DRM
729 * device's list of CRTCs.
731 unsigned int drm_crtc_index(struct drm_crtc *crtc)
733 unsigned int index = 0;
734 struct drm_crtc *tmp;
736 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
745 EXPORT_SYMBOL(drm_crtc_index);
748 * drm_mode_remove - remove and free a mode
749 * @connector: connector list to modify
750 * @mode: mode to remove
752 * Remove @mode from @connector's mode list, then free it.
754 static void drm_mode_remove(struct drm_connector *connector,
755 struct drm_display_mode *mode)
757 list_del(&mode->head);
758 drm_mode_destroy(connector->dev, mode);
762 * drm_display_info_set_bus_formats - set the supported bus formats
763 * @info: display info to store bus formats in
764 * @formats: array containing the supported bus formats
765 * @num_formats: the number of entries in the fmts array
767 * Store the supported bus formats in display info structure.
768 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
769 * a full list of available formats.
771 int drm_display_info_set_bus_formats(struct drm_display_info *info,
773 unsigned int num_formats)
777 if (!formats && num_formats)
780 if (formats && num_formats) {
781 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
787 kfree(info->bus_formats);
788 info->bus_formats = fmts;
789 info->num_bus_formats = num_formats;
793 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
796 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
797 * @connector: connector to quwery
799 * The kernel supports per-connector configration of its consoles through
800 * use of the video= parameter. This function parses that option and
801 * extracts the user's specified mode (or enable/disable status) for a
802 * particular connector. This is typically only used during the early fbdev
805 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
807 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
810 if (fb_get_options(connector->name, &option))
813 if (!drm_mode_parse_command_line_for_connector(option,
821 switch (mode->force) {
825 case DRM_FORCE_ON_DIGITAL:
834 DRM_INFO("forcing %s connector %s\n", connector->name, s);
835 connector->force = mode->force;
838 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
840 mode->xres, mode->yres,
841 mode->refresh_specified ? mode->refresh : 60,
842 mode->rb ? " reduced blanking" : "",
843 mode->margins ? " with margins" : "",
844 mode->interlace ? " interlaced" : "");
848 * drm_connector_init - Init a preallocated connector
850 * @connector: the connector to init
851 * @funcs: callbacks for this connector
852 * @connector_type: user visible type of the connector
854 * Initialises a preallocated connector. Connectors should be
855 * subclassed as part of driver connector objects.
858 * Zero on success, error code on failure.
860 int drm_connector_init(struct drm_device *dev,
861 struct drm_connector *connector,
862 const struct drm_connector_funcs *funcs,
865 struct drm_mode_config *config = &dev->mode_config;
867 struct ida *connector_ida =
868 &drm_connector_enum_list[connector_type].ida;
870 drm_modeset_lock_all(dev);
872 ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
876 connector->base.properties = &connector->properties;
877 connector->dev = dev;
878 connector->funcs = funcs;
879 connector->connector_type = connector_type;
880 connector->connector_type_id =
881 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
882 if (connector->connector_type_id < 0) {
883 ret = connector->connector_type_id;
887 kasprintf(GFP_KERNEL, "%s-%d",
888 drm_connector_enum_list[connector_type].name,
889 connector->connector_type_id);
890 if (!connector->name) {
895 INIT_LIST_HEAD(&connector->probed_modes);
896 INIT_LIST_HEAD(&connector->modes);
897 connector->edid_blob_ptr = NULL;
898 connector->status = connector_status_unknown;
900 drm_connector_get_cmdline_mode(connector);
902 /* We should add connectors at the end to avoid upsetting the connector
904 list_add_tail(&connector->head, &config->connector_list);
905 config->num_connector++;
907 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
908 drm_object_attach_property(&connector->base,
909 config->edid_property,
912 drm_object_attach_property(&connector->base,
913 config->dpms_property, 0);
915 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
916 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
919 connector->debugfs_entry = NULL;
923 drm_mode_object_put(dev, &connector->base);
926 drm_modeset_unlock_all(dev);
930 EXPORT_SYMBOL(drm_connector_init);
933 * drm_connector_cleanup - cleans up an initialised connector
934 * @connector: connector to cleanup
936 * Cleans up the connector but doesn't free the object.
938 void drm_connector_cleanup(struct drm_connector *connector)
940 struct drm_device *dev = connector->dev;
941 struct drm_display_mode *mode, *t;
943 if (connector->tile_group) {
944 drm_mode_put_tile_group(dev, connector->tile_group);
945 connector->tile_group = NULL;
948 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
949 drm_mode_remove(connector, mode);
951 list_for_each_entry_safe(mode, t, &connector->modes, head)
952 drm_mode_remove(connector, mode);
954 ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
955 connector->connector_type_id);
957 kfree(connector->display_info.bus_formats);
958 drm_mode_object_put(dev, &connector->base);
959 kfree(connector->name);
960 connector->name = NULL;
961 list_del(&connector->head);
962 dev->mode_config.num_connector--;
964 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
965 if (connector->state && connector->funcs->atomic_destroy_state)
966 connector->funcs->atomic_destroy_state(connector,
969 memset(connector, 0, sizeof(*connector));
971 EXPORT_SYMBOL(drm_connector_cleanup);
974 * drm_connector_index - find the index of a registered connector
975 * @connector: connector to find index for
977 * Given a registered connector, return the index of that connector within a DRM
978 * device's list of connectors.
980 unsigned int drm_connector_index(struct drm_connector *connector)
982 unsigned int index = 0;
983 struct drm_connector *tmp;
984 struct drm_mode_config *config = &connector->dev->mode_config;
986 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
988 list_for_each_entry(tmp, &connector->dev->mode_config.connector_list, head) {
989 if (tmp == connector)
997 EXPORT_SYMBOL(drm_connector_index);
1000 * drm_connector_register - register a connector
1001 * @connector: the connector to register
1003 * Register userspace interfaces for a connector
1006 * Zero on success, error code on failure.
1008 int drm_connector_register(struct drm_connector *connector)
1012 drm_mode_object_register(connector->dev, &connector->base);
1014 ret = drm_sysfs_connector_add(connector);
1018 ret = drm_debugfs_connector_add(connector);
1020 drm_sysfs_connector_remove(connector);
1026 EXPORT_SYMBOL(drm_connector_register);
1029 * drm_connector_unregister - unregister a connector
1030 * @connector: the connector to unregister
1032 * Unregister userspace interfaces for a connector
1034 void drm_connector_unregister(struct drm_connector *connector)
1036 drm_sysfs_connector_remove(connector);
1037 drm_debugfs_connector_remove(connector);
1039 EXPORT_SYMBOL(drm_connector_unregister);
1043 * drm_connector_unplug_all - unregister connector userspace interfaces
1046 * This function unregisters all connector userspace interfaces in sysfs. Should
1047 * be call when the device is disconnected, e.g. from an usb driver's
1048 * ->disconnect callback.
1050 void drm_connector_unplug_all(struct drm_device *dev)
1052 struct drm_connector *connector;
1054 /* taking the mode config mutex ends up in a clash with sysfs */
1055 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1056 drm_connector_unregister(connector);
1059 EXPORT_SYMBOL(drm_connector_unplug_all);
1062 * drm_encoder_init - Init a preallocated encoder
1064 * @encoder: the encoder to init
1065 * @funcs: callbacks for this encoder
1066 * @encoder_type: user visible type of the encoder
1068 * Initialises a preallocated encoder. Encoder should be
1069 * subclassed as part of driver encoder objects.
1072 * Zero on success, error code on failure.
1074 int drm_encoder_init(struct drm_device *dev,
1075 struct drm_encoder *encoder,
1076 const struct drm_encoder_funcs *funcs,
1081 drm_modeset_lock_all(dev);
1083 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1088 encoder->encoder_type = encoder_type;
1089 encoder->funcs = funcs;
1090 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1091 drm_encoder_enum_list[encoder_type].name,
1093 if (!encoder->name) {
1098 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1099 dev->mode_config.num_encoder++;
1103 drm_mode_object_put(dev, &encoder->base);
1106 drm_modeset_unlock_all(dev);
1110 EXPORT_SYMBOL(drm_encoder_init);
1113 * drm_encoder_cleanup - cleans up an initialised encoder
1114 * @encoder: encoder to cleanup
1116 * Cleans up the encoder but doesn't free the object.
1118 void drm_encoder_cleanup(struct drm_encoder *encoder)
1120 struct drm_device *dev = encoder->dev;
1122 drm_modeset_lock_all(dev);
1123 drm_mode_object_put(dev, &encoder->base);
1124 kfree(encoder->name);
1125 list_del(&encoder->head);
1126 dev->mode_config.num_encoder--;
1127 drm_modeset_unlock_all(dev);
1129 memset(encoder, 0, sizeof(*encoder));
1131 EXPORT_SYMBOL(drm_encoder_cleanup);
1134 * drm_universal_plane_init - Initialize a new universal plane object
1136 * @plane: plane object to init
1137 * @possible_crtcs: bitmask of possible CRTCs
1138 * @funcs: callbacks for the new plane
1139 * @formats: array of supported formats (%DRM_FORMAT_*)
1140 * @format_count: number of elements in @formats
1141 * @type: type of plane (overlay, primary, cursor)
1143 * Initializes a plane object of type @type.
1146 * Zero on success, error code on failure.
1148 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1149 unsigned long possible_crtcs,
1150 const struct drm_plane_funcs *funcs,
1151 const uint32_t *formats, uint32_t format_count,
1152 enum drm_plane_type type)
1154 struct drm_mode_config *config = &dev->mode_config;
1157 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1161 drm_modeset_lock_init(&plane->mutex);
1163 plane->base.properties = &plane->properties;
1165 plane->funcs = funcs;
1166 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1168 if (!plane->format_types) {
1169 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1170 drm_mode_object_put(dev, &plane->base);
1174 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1175 plane->format_count = format_count;
1176 plane->possible_crtcs = possible_crtcs;
1179 list_add_tail(&plane->head, &config->plane_list);
1180 config->num_total_plane++;
1181 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1182 config->num_overlay_plane++;
1184 drm_object_attach_property(&plane->base,
1185 config->plane_type_property,
1188 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1189 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1190 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1191 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1192 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1193 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1194 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1195 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1196 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1197 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1198 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1203 EXPORT_SYMBOL(drm_universal_plane_init);
1206 * drm_plane_init - Initialize a legacy plane
1208 * @plane: plane object to init
1209 * @possible_crtcs: bitmask of possible CRTCs
1210 * @funcs: callbacks for the new plane
1211 * @formats: array of supported formats (%DRM_FORMAT_*)
1212 * @format_count: number of elements in @formats
1213 * @is_primary: plane type (primary vs overlay)
1215 * Legacy API to initialize a DRM plane.
1217 * New drivers should call drm_universal_plane_init() instead.
1220 * Zero on success, error code on failure.
1222 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1223 unsigned long possible_crtcs,
1224 const struct drm_plane_funcs *funcs,
1225 const uint32_t *formats, uint32_t format_count,
1228 enum drm_plane_type type;
1230 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1231 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1232 formats, format_count, type);
1234 EXPORT_SYMBOL(drm_plane_init);
1237 * drm_plane_cleanup - Clean up the core plane usage
1238 * @plane: plane to cleanup
1240 * This function cleans up @plane and removes it from the DRM mode setting
1241 * core. Note that the function does *not* free the plane structure itself,
1242 * this is the responsibility of the caller.
1244 void drm_plane_cleanup(struct drm_plane *plane)
1246 struct drm_device *dev = plane->dev;
1248 drm_modeset_lock_all(dev);
1249 kfree(plane->format_types);
1250 drm_mode_object_put(dev, &plane->base);
1252 BUG_ON(list_empty(&plane->head));
1254 list_del(&plane->head);
1255 dev->mode_config.num_total_plane--;
1256 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1257 dev->mode_config.num_overlay_plane--;
1258 drm_modeset_unlock_all(dev);
1260 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1261 if (plane->state && plane->funcs->atomic_destroy_state)
1262 plane->funcs->atomic_destroy_state(plane, plane->state);
1264 memset(plane, 0, sizeof(*plane));
1266 EXPORT_SYMBOL(drm_plane_cleanup);
1269 * drm_plane_index - find the index of a registered plane
1270 * @plane: plane to find index for
1272 * Given a registered plane, return the index of that CRTC within a DRM
1273 * device's list of planes.
1275 unsigned int drm_plane_index(struct drm_plane *plane)
1277 unsigned int index = 0;
1278 struct drm_plane *tmp;
1280 list_for_each_entry(tmp, &plane->dev->mode_config.plane_list, head) {
1289 EXPORT_SYMBOL(drm_plane_index);
1292 * drm_plane_force_disable - Forcibly disable a plane
1293 * @plane: plane to disable
1295 * Forces the plane to be disabled.
1297 * Used when the plane's current framebuffer is destroyed,
1298 * and when restoring fbdev mode.
1300 void drm_plane_force_disable(struct drm_plane *plane)
1307 plane->old_fb = plane->fb;
1308 ret = plane->funcs->disable_plane(plane);
1310 DRM_ERROR("failed to disable plane with busy fb\n");
1311 plane->old_fb = NULL;
1314 /* disconnect the plane from the fb and crtc: */
1315 drm_framebuffer_unreference(plane->old_fb);
1316 plane->old_fb = NULL;
1320 EXPORT_SYMBOL(drm_plane_force_disable);
1322 static int drm_mode_create_standard_properties(struct drm_device *dev)
1324 struct drm_property *prop;
1327 * Standard properties (apply to all connectors)
1329 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1330 DRM_MODE_PROP_IMMUTABLE,
1334 dev->mode_config.edid_property = prop;
1336 prop = drm_property_create_enum(dev, 0,
1337 "DPMS", drm_dpms_enum_list,
1338 ARRAY_SIZE(drm_dpms_enum_list));
1341 dev->mode_config.dpms_property = prop;
1343 prop = drm_property_create(dev,
1344 DRM_MODE_PROP_BLOB |
1345 DRM_MODE_PROP_IMMUTABLE,
1349 dev->mode_config.path_property = prop;
1351 prop = drm_property_create(dev,
1352 DRM_MODE_PROP_BLOB |
1353 DRM_MODE_PROP_IMMUTABLE,
1357 dev->mode_config.tile_property = prop;
1359 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1360 "type", drm_plane_type_enum_list,
1361 ARRAY_SIZE(drm_plane_type_enum_list));
1364 dev->mode_config.plane_type_property = prop;
1366 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1367 "SRC_X", 0, UINT_MAX);
1370 dev->mode_config.prop_src_x = prop;
1372 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1373 "SRC_Y", 0, UINT_MAX);
1376 dev->mode_config.prop_src_y = prop;
1378 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1379 "SRC_W", 0, UINT_MAX);
1382 dev->mode_config.prop_src_w = prop;
1384 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1385 "SRC_H", 0, UINT_MAX);
1388 dev->mode_config.prop_src_h = prop;
1390 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1391 "CRTC_X", INT_MIN, INT_MAX);
1394 dev->mode_config.prop_crtc_x = prop;
1396 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1397 "CRTC_Y", INT_MIN, INT_MAX);
1400 dev->mode_config.prop_crtc_y = prop;
1402 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1403 "CRTC_W", 0, INT_MAX);
1406 dev->mode_config.prop_crtc_w = prop;
1408 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1409 "CRTC_H", 0, INT_MAX);
1412 dev->mode_config.prop_crtc_h = prop;
1414 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1415 "FB_ID", DRM_MODE_OBJECT_FB);
1418 dev->mode_config.prop_fb_id = prop;
1420 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1421 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1424 dev->mode_config.prop_crtc_id = prop;
1426 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
1430 dev->mode_config.prop_active = prop;
1436 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1439 * Called by a driver the first time a DVI-I connector is made.
1441 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1443 struct drm_property *dvi_i_selector;
1444 struct drm_property *dvi_i_subconnector;
1446 if (dev->mode_config.dvi_i_select_subconnector_property)
1450 drm_property_create_enum(dev, 0,
1451 "select subconnector",
1452 drm_dvi_i_select_enum_list,
1453 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1454 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1456 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1458 drm_dvi_i_subconnector_enum_list,
1459 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1460 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1464 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1467 * drm_create_tv_properties - create TV specific connector properties
1469 * @num_modes: number of different TV formats (modes) supported
1470 * @modes: array of pointers to strings containing name of each format
1472 * Called by a driver's TV initialization routine, this function creates
1473 * the TV specific connector properties for a given device. Caller is
1474 * responsible for allocating a list of format names and passing them to
1477 int drm_mode_create_tv_properties(struct drm_device *dev,
1478 unsigned int num_modes,
1481 struct drm_property *tv_selector;
1482 struct drm_property *tv_subconnector;
1485 if (dev->mode_config.tv_select_subconnector_property)
1489 * Basic connector properties
1491 tv_selector = drm_property_create_enum(dev, 0,
1492 "select subconnector",
1493 drm_tv_select_enum_list,
1494 ARRAY_SIZE(drm_tv_select_enum_list));
1495 dev->mode_config.tv_select_subconnector_property = tv_selector;
1498 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1500 drm_tv_subconnector_enum_list,
1501 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1502 dev->mode_config.tv_subconnector_property = tv_subconnector;
1505 * Other, TV specific properties: margins & TV modes.
1507 dev->mode_config.tv_left_margin_property =
1508 drm_property_create_range(dev, 0, "left margin", 0, 100);
1510 dev->mode_config.tv_right_margin_property =
1511 drm_property_create_range(dev, 0, "right margin", 0, 100);
1513 dev->mode_config.tv_top_margin_property =
1514 drm_property_create_range(dev, 0, "top margin", 0, 100);
1516 dev->mode_config.tv_bottom_margin_property =
1517 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1519 dev->mode_config.tv_mode_property =
1520 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1522 for (i = 0; i < num_modes; i++)
1523 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1526 dev->mode_config.tv_brightness_property =
1527 drm_property_create_range(dev, 0, "brightness", 0, 100);
1529 dev->mode_config.tv_contrast_property =
1530 drm_property_create_range(dev, 0, "contrast", 0, 100);
1532 dev->mode_config.tv_flicker_reduction_property =
1533 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1535 dev->mode_config.tv_overscan_property =
1536 drm_property_create_range(dev, 0, "overscan", 0, 100);
1538 dev->mode_config.tv_saturation_property =
1539 drm_property_create_range(dev, 0, "saturation", 0, 100);
1541 dev->mode_config.tv_hue_property =
1542 drm_property_create_range(dev, 0, "hue", 0, 100);
1546 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1549 * drm_mode_create_scaling_mode_property - create scaling mode property
1552 * Called by a driver the first time it's needed, must be attached to desired
1555 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1557 struct drm_property *scaling_mode;
1559 if (dev->mode_config.scaling_mode_property)
1563 drm_property_create_enum(dev, 0, "scaling mode",
1564 drm_scaling_mode_enum_list,
1565 ARRAY_SIZE(drm_scaling_mode_enum_list));
1567 dev->mode_config.scaling_mode_property = scaling_mode;
1571 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1574 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1577 * Called by a driver the first time it's needed, must be attached to desired
1581 * Zero on success, negative errno on failure.
1583 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1585 if (dev->mode_config.aspect_ratio_property)
1588 dev->mode_config.aspect_ratio_property =
1589 drm_property_create_enum(dev, 0, "aspect ratio",
1590 drm_aspect_ratio_enum_list,
1591 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1593 if (dev->mode_config.aspect_ratio_property == NULL)
1598 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1601 * drm_mode_create_dirty_property - create dirty property
1604 * Called by a driver the first time it's needed, must be attached to desired
1607 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1609 struct drm_property *dirty_info;
1611 if (dev->mode_config.dirty_info_property)
1615 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1617 drm_dirty_info_enum_list,
1618 ARRAY_SIZE(drm_dirty_info_enum_list));
1619 dev->mode_config.dirty_info_property = dirty_info;
1623 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1626 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1629 * Create the the suggested x/y offset property for connectors.
1631 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1633 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1636 dev->mode_config.suggested_x_property =
1637 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1639 dev->mode_config.suggested_y_property =
1640 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1642 if (dev->mode_config.suggested_x_property == NULL ||
1643 dev->mode_config.suggested_y_property == NULL)
1647 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1649 static int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
1651 uint32_t total_objects = 0;
1653 total_objects += dev->mode_config.num_crtc;
1654 total_objects += dev->mode_config.num_connector;
1655 total_objects += dev->mode_config.num_encoder;
1657 group->id_list = kcalloc(total_objects, sizeof(uint32_t), GFP_KERNEL);
1658 if (!group->id_list)
1661 group->num_crtcs = 0;
1662 group->num_connectors = 0;
1663 group->num_encoders = 0;
1667 void drm_mode_group_destroy(struct drm_mode_group *group)
1669 kfree(group->id_list);
1670 group->id_list = NULL;
1674 * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1675 * the drm core's responsibility to set up mode control groups.
1677 int drm_mode_group_init_legacy_group(struct drm_device *dev,
1678 struct drm_mode_group *group)
1680 struct drm_crtc *crtc;
1681 struct drm_encoder *encoder;
1682 struct drm_connector *connector;
1685 ret = drm_mode_group_init(dev, group);
1689 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
1690 group->id_list[group->num_crtcs++] = crtc->base.id;
1692 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
1693 group->id_list[group->num_crtcs + group->num_encoders++] =
1696 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1697 group->id_list[group->num_crtcs + group->num_encoders +
1698 group->num_connectors++] = connector->base.id;
1702 EXPORT_SYMBOL(drm_mode_group_init_legacy_group);
1704 void drm_reinit_primary_mode_group(struct drm_device *dev)
1706 drm_modeset_lock_all(dev);
1707 drm_mode_group_destroy(&dev->primary->mode_group);
1708 drm_mode_group_init_legacy_group(dev, &dev->primary->mode_group);
1709 drm_modeset_unlock_all(dev);
1711 EXPORT_SYMBOL(drm_reinit_primary_mode_group);
1714 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1715 * @out: drm_mode_modeinfo struct to return to the user
1716 * @in: drm_display_mode to use
1718 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1721 static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
1722 const struct drm_display_mode *in)
1724 WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1725 in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1726 in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1727 in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1728 in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1729 "timing values too large for mode info\n");
1731 out->clock = in->clock;
1732 out->hdisplay = in->hdisplay;
1733 out->hsync_start = in->hsync_start;
1734 out->hsync_end = in->hsync_end;
1735 out->htotal = in->htotal;
1736 out->hskew = in->hskew;
1737 out->vdisplay = in->vdisplay;
1738 out->vsync_start = in->vsync_start;
1739 out->vsync_end = in->vsync_end;
1740 out->vtotal = in->vtotal;
1741 out->vscan = in->vscan;
1742 out->vrefresh = in->vrefresh;
1743 out->flags = in->flags;
1744 out->type = in->type;
1745 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1746 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1750 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1751 * @out: drm_display_mode to return to the user
1752 * @in: drm_mode_modeinfo to use
1754 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1758 * Zero on success, negative errno on failure.
1760 static int drm_crtc_convert_umode(struct drm_display_mode *out,
1761 const struct drm_mode_modeinfo *in)
1763 if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1766 if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1769 out->clock = in->clock;
1770 out->hdisplay = in->hdisplay;
1771 out->hsync_start = in->hsync_start;
1772 out->hsync_end = in->hsync_end;
1773 out->htotal = in->htotal;
1774 out->hskew = in->hskew;
1775 out->vdisplay = in->vdisplay;
1776 out->vsync_start = in->vsync_start;
1777 out->vsync_end = in->vsync_end;
1778 out->vtotal = in->vtotal;
1779 out->vscan = in->vscan;
1780 out->vrefresh = in->vrefresh;
1781 out->flags = in->flags;
1782 out->type = in->type;
1783 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1784 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1790 * drm_mode_getresources - get graphics configuration
1791 * @dev: drm device for the ioctl
1792 * @data: data pointer for the ioctl
1793 * @file_priv: drm file for the ioctl call
1795 * Construct a set of configuration description structures and return
1796 * them to the user, including CRTC, connector and framebuffer configuration.
1798 * Called by the user via ioctl.
1801 * Zero on success, negative errno on failure.
1803 int drm_mode_getresources(struct drm_device *dev, void *data,
1804 struct drm_file *file_priv)
1806 struct drm_mode_card_res *card_res = data;
1807 struct list_head *lh;
1808 struct drm_framebuffer *fb;
1809 struct drm_connector *connector;
1810 struct drm_crtc *crtc;
1811 struct drm_encoder *encoder;
1813 int connector_count = 0;
1816 int encoder_count = 0;
1818 uint32_t __user *fb_id;
1819 uint32_t __user *crtc_id;
1820 uint32_t __user *connector_id;
1821 uint32_t __user *encoder_id;
1822 struct drm_mode_group *mode_group;
1824 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1828 mutex_lock(&file_priv->fbs_lock);
1830 * For the non-control nodes we need to limit the list of resources
1831 * by IDs in the group list for this node
1833 list_for_each(lh, &file_priv->fbs)
1836 /* handle this in 4 parts */
1838 if (card_res->count_fbs >= fb_count) {
1840 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1841 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1842 if (put_user(fb->base.id, fb_id + copied)) {
1843 mutex_unlock(&file_priv->fbs_lock);
1849 card_res->count_fbs = fb_count;
1850 mutex_unlock(&file_priv->fbs_lock);
1852 /* mode_config.mutex protects the connector list against e.g. DP MST
1853 * connector hot-adding. CRTC/Plane lists are invariant. */
1854 mutex_lock(&dev->mode_config.mutex);
1855 if (!drm_is_primary_client(file_priv)) {
1858 list_for_each(lh, &dev->mode_config.crtc_list)
1861 list_for_each(lh, &dev->mode_config.connector_list)
1864 list_for_each(lh, &dev->mode_config.encoder_list)
1868 mode_group = &file_priv->master->minor->mode_group;
1869 crtc_count = mode_group->num_crtcs;
1870 connector_count = mode_group->num_connectors;
1871 encoder_count = mode_group->num_encoders;
1874 card_res->max_height = dev->mode_config.max_height;
1875 card_res->min_height = dev->mode_config.min_height;
1876 card_res->max_width = dev->mode_config.max_width;
1877 card_res->min_width = dev->mode_config.min_width;
1880 if (card_res->count_crtcs >= crtc_count) {
1882 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1884 list_for_each_entry(crtc, &dev->mode_config.crtc_list,
1886 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1887 if (put_user(crtc->base.id, crtc_id + copied)) {
1894 for (i = 0; i < mode_group->num_crtcs; i++) {
1895 if (put_user(mode_group->id_list[i],
1896 crtc_id + copied)) {
1904 card_res->count_crtcs = crtc_count;
1907 if (card_res->count_encoders >= encoder_count) {
1909 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1911 list_for_each_entry(encoder,
1912 &dev->mode_config.encoder_list,
1914 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1916 if (put_user(encoder->base.id, encoder_id +
1924 for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
1925 if (put_user(mode_group->id_list[i],
1926 encoder_id + copied)) {
1935 card_res->count_encoders = encoder_count;
1938 if (card_res->count_connectors >= connector_count) {
1940 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1942 list_for_each_entry(connector,
1943 &dev->mode_config.connector_list,
1945 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1948 if (put_user(connector->base.id,
1949 connector_id + copied)) {
1956 int start = mode_group->num_crtcs +
1957 mode_group->num_encoders;
1958 for (i = start; i < start + mode_group->num_connectors; i++) {
1959 if (put_user(mode_group->id_list[i],
1960 connector_id + copied)) {
1968 card_res->count_connectors = connector_count;
1970 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1971 card_res->count_connectors, card_res->count_encoders);
1974 mutex_unlock(&dev->mode_config.mutex);
1979 * drm_mode_getcrtc - get CRTC configuration
1980 * @dev: drm device for the ioctl
1981 * @data: data pointer for the ioctl
1982 * @file_priv: drm file for the ioctl call
1984 * Construct a CRTC configuration structure to return to the user.
1986 * Called by the user via ioctl.
1989 * Zero on success, negative errno on failure.
1991 int drm_mode_getcrtc(struct drm_device *dev,
1992 void *data, struct drm_file *file_priv)
1994 struct drm_mode_crtc *crtc_resp = data;
1995 struct drm_crtc *crtc;
1997 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2000 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
2004 drm_modeset_lock_crtc(crtc, crtc->primary);
2005 crtc_resp->gamma_size = crtc->gamma_size;
2006 if (crtc->primary->fb)
2007 crtc_resp->fb_id = crtc->primary->fb->base.id;
2009 crtc_resp->fb_id = 0;
2012 crtc_resp->x = crtc->primary->state->src_x >> 16;
2013 crtc_resp->y = crtc->primary->state->src_y >> 16;
2014 if (crtc->state->enable) {
2015 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
2016 crtc_resp->mode_valid = 1;
2019 crtc_resp->mode_valid = 0;
2022 crtc_resp->x = crtc->x;
2023 crtc_resp->y = crtc->y;
2024 if (crtc->enabled) {
2025 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2026 crtc_resp->mode_valid = 1;
2029 crtc_resp->mode_valid = 0;
2032 drm_modeset_unlock_crtc(crtc);
2037 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2038 const struct drm_file *file_priv)
2041 * If user-space hasn't configured the driver to expose the stereo 3D
2042 * modes, don't expose them.
2044 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2050 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2052 /* For atomic drivers only state objects are synchronously updated and
2053 * protected by modeset locks, so check those first. */
2054 if (connector->state)
2055 return connector->state->best_encoder;
2056 return connector->encoder;
2059 /* helper for getconnector and getproperties ioctls */
2060 static int get_properties(struct drm_mode_object *obj, bool atomic,
2061 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2062 uint32_t *arg_count_props)
2067 props_count = obj->properties->count;
2069 props_count -= obj->properties->atomic_count;
2071 if ((*arg_count_props >= props_count) && props_count) {
2072 for (i = 0, copied = 0; copied < props_count; i++) {
2073 struct drm_property *prop = obj->properties->properties[i];
2076 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2079 ret = drm_object_property_get_value(obj, prop, &val);
2083 if (put_user(prop->base.id, prop_ptr + copied))
2086 if (put_user(val, prop_values + copied))
2092 *arg_count_props = props_count;
2098 * drm_mode_getconnector - get connector configuration
2099 * @dev: drm device for the ioctl
2100 * @data: data pointer for the ioctl
2101 * @file_priv: drm file for the ioctl call
2103 * Construct a connector configuration structure to return to the user.
2105 * Called by the user via ioctl.
2108 * Zero on success, negative errno on failure.
2110 int drm_mode_getconnector(struct drm_device *dev, void *data,
2111 struct drm_file *file_priv)
2113 struct drm_mode_get_connector *out_resp = data;
2114 struct drm_connector *connector;
2115 struct drm_encoder *encoder;
2116 struct drm_display_mode *mode;
2118 int encoders_count = 0;
2122 struct drm_mode_modeinfo u_mode;
2123 struct drm_mode_modeinfo __user *mode_ptr;
2124 uint32_t __user *encoder_ptr;
2126 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2129 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2131 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2133 mutex_lock(&dev->mode_config.mutex);
2135 connector = drm_connector_find(dev, out_resp->connector_id);
2141 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2142 if (connector->encoder_ids[i] != 0)
2145 if (out_resp->count_modes == 0) {
2146 connector->funcs->fill_modes(connector,
2147 dev->mode_config.max_width,
2148 dev->mode_config.max_height);
2151 /* delayed so we get modes regardless of pre-fill_modes state */
2152 list_for_each_entry(mode, &connector->modes, head)
2153 if (drm_mode_expose_to_userspace(mode, file_priv))
2156 out_resp->connector_id = connector->base.id;
2157 out_resp->connector_type = connector->connector_type;
2158 out_resp->connector_type_id = connector->connector_type_id;
2159 out_resp->mm_width = connector->display_info.width_mm;
2160 out_resp->mm_height = connector->display_info.height_mm;
2161 out_resp->subpixel = connector->display_info.subpixel_order;
2162 out_resp->connection = connector->status;
2164 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2165 encoder = drm_connector_get_encoder(connector);
2167 out_resp->encoder_id = encoder->base.id;
2169 out_resp->encoder_id = 0;
2172 * This ioctl is called twice, once to determine how much space is
2173 * needed, and the 2nd time to fill it.
2175 if ((out_resp->count_modes >= mode_count) && mode_count) {
2177 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2178 list_for_each_entry(mode, &connector->modes, head) {
2179 if (!drm_mode_expose_to_userspace(mode, file_priv))
2182 drm_crtc_convert_to_umode(&u_mode, mode);
2183 if (copy_to_user(mode_ptr + copied,
2184 &u_mode, sizeof(u_mode))) {
2191 out_resp->count_modes = mode_count;
2193 ret = get_properties(&connector->base, file_priv->atomic,
2194 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2195 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2196 &out_resp->count_props);
2200 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2202 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2203 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2204 if (connector->encoder_ids[i] != 0) {
2205 if (put_user(connector->encoder_ids[i],
2206 encoder_ptr + copied)) {
2214 out_resp->count_encoders = encoders_count;
2217 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2220 mutex_unlock(&dev->mode_config.mutex);
2225 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2227 struct drm_connector *connector;
2228 struct drm_device *dev = encoder->dev;
2229 bool uses_atomic = false;
2231 /* For atomic drivers only state objects are synchronously updated and
2232 * protected by modeset locks, so check those first. */
2233 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
2234 if (!connector->state)
2239 if (connector->state->best_encoder != encoder)
2242 return connector->state->crtc;
2245 /* Don't return stale data (e.g. pending async disable). */
2249 return encoder->crtc;
2253 * drm_mode_getencoder - get encoder configuration
2254 * @dev: drm device for the ioctl
2255 * @data: data pointer for the ioctl
2256 * @file_priv: drm file for the ioctl call
2258 * Construct a encoder configuration structure to return to the user.
2260 * Called by the user via ioctl.
2263 * Zero on success, negative errno on failure.
2265 int drm_mode_getencoder(struct drm_device *dev, void *data,
2266 struct drm_file *file_priv)
2268 struct drm_mode_get_encoder *enc_resp = data;
2269 struct drm_encoder *encoder;
2270 struct drm_crtc *crtc;
2272 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2275 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2279 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2280 crtc = drm_encoder_get_crtc(encoder);
2282 enc_resp->crtc_id = crtc->base.id;
2284 enc_resp->crtc_id = 0;
2285 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2287 enc_resp->encoder_type = encoder->encoder_type;
2288 enc_resp->encoder_id = encoder->base.id;
2289 enc_resp->possible_crtcs = encoder->possible_crtcs;
2290 enc_resp->possible_clones = encoder->possible_clones;
2296 * drm_mode_getplane_res - enumerate all plane resources
2299 * @file_priv: DRM file info
2301 * Construct a list of plane ids to return to the user.
2303 * Called by the user via ioctl.
2306 * Zero on success, negative errno on failure.
2308 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2309 struct drm_file *file_priv)
2311 struct drm_mode_get_plane_res *plane_resp = data;
2312 struct drm_mode_config *config;
2313 struct drm_plane *plane;
2314 uint32_t __user *plane_ptr;
2316 unsigned num_planes;
2318 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2321 config = &dev->mode_config;
2323 if (file_priv->universal_planes)
2324 num_planes = config->num_total_plane;
2326 num_planes = config->num_overlay_plane;
2329 * This ioctl is called twice, once to determine how much space is
2330 * needed, and the 2nd time to fill it.
2333 (plane_resp->count_planes >= num_planes)) {
2334 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2336 /* Plane lists are invariant, no locking needed. */
2337 list_for_each_entry(plane, &config->plane_list, head) {
2339 * Unless userspace set the 'universal planes'
2340 * capability bit, only advertise overlays.
2342 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2343 !file_priv->universal_planes)
2346 if (put_user(plane->base.id, plane_ptr + copied))
2351 plane_resp->count_planes = num_planes;
2357 * drm_mode_getplane - get plane configuration
2360 * @file_priv: DRM file info
2362 * Construct a plane configuration structure to return to the user.
2364 * Called by the user via ioctl.
2367 * Zero on success, negative errno on failure.
2369 int drm_mode_getplane(struct drm_device *dev, void *data,
2370 struct drm_file *file_priv)
2372 struct drm_mode_get_plane *plane_resp = data;
2373 struct drm_plane *plane;
2374 uint32_t __user *format_ptr;
2376 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2379 plane = drm_plane_find(dev, plane_resp->plane_id);
2383 drm_modeset_lock(&plane->mutex, NULL);
2385 plane_resp->crtc_id = plane->crtc->base.id;
2387 plane_resp->crtc_id = 0;
2390 plane_resp->fb_id = plane->fb->base.id;
2392 plane_resp->fb_id = 0;
2393 drm_modeset_unlock(&plane->mutex);
2395 plane_resp->plane_id = plane->base.id;
2396 plane_resp->possible_crtcs = plane->possible_crtcs;
2397 plane_resp->gamma_size = 0;
2400 * This ioctl is called twice, once to determine how much space is
2401 * needed, and the 2nd time to fill it.
2403 if (plane->format_count &&
2404 (plane_resp->count_format_types >= plane->format_count)) {
2405 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2406 if (copy_to_user(format_ptr,
2407 plane->format_types,
2408 sizeof(uint32_t) * plane->format_count)) {
2412 plane_resp->count_format_types = plane->format_count;
2418 * drm_plane_check_pixel_format - Check if the plane supports the pixel format
2419 * @plane: plane to check for format support
2420 * @format: the pixel format
2423 * Zero of @plane has @format in its list of supported pixel formats, -EINVAL
2426 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
2430 for (i = 0; i < plane->format_count; i++) {
2431 if (format == plane->format_types[i])
2439 * setplane_internal - setplane handler for internal callers
2441 * Note that we assume an extra reference has already been taken on fb. If the
2442 * update fails, this reference will be dropped before return; if it succeeds,
2443 * the previous framebuffer (if any) will be unreferenced instead.
2445 * src_{x,y,w,h} are provided in 16.16 fixed point format
2447 static int __setplane_internal(struct drm_plane *plane,
2448 struct drm_crtc *crtc,
2449 struct drm_framebuffer *fb,
2450 int32_t crtc_x, int32_t crtc_y,
2451 uint32_t crtc_w, uint32_t crtc_h,
2452 /* src_{x,y,w,h} values are 16.16 fixed point */
2453 uint32_t src_x, uint32_t src_y,
2454 uint32_t src_w, uint32_t src_h)
2457 unsigned int fb_width, fb_height;
2459 /* No fb means shut it down */
2461 plane->old_fb = plane->fb;
2462 ret = plane->funcs->disable_plane(plane);
2467 plane->old_fb = NULL;
2472 /* Check whether this plane is usable on this CRTC */
2473 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2474 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2479 /* Check whether this plane supports the fb pixel format. */
2480 ret = drm_plane_check_pixel_format(plane, fb->pixel_format);
2482 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2483 drm_get_format_name(fb->pixel_format));
2487 /* Give drivers some help against integer overflows */
2488 if (crtc_w > INT_MAX ||
2489 crtc_x > INT_MAX - (int32_t) crtc_w ||
2491 crtc_y > INT_MAX - (int32_t) crtc_h) {
2492 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2493 crtc_w, crtc_h, crtc_x, crtc_y);
2498 fb_width = fb->width << 16;
2499 fb_height = fb->height << 16;
2501 /* Make sure source coordinates are inside the fb. */
2502 if (src_w > fb_width ||
2503 src_x > fb_width - src_w ||
2504 src_h > fb_height ||
2505 src_y > fb_height - src_h) {
2506 DRM_DEBUG_KMS("Invalid source coordinates "
2507 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2508 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2509 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2510 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2511 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2516 plane->old_fb = plane->fb;
2517 ret = plane->funcs->update_plane(plane, crtc, fb,
2518 crtc_x, crtc_y, crtc_w, crtc_h,
2519 src_x, src_y, src_w, src_h);
2525 plane->old_fb = NULL;
2530 drm_framebuffer_unreference(fb);
2532 drm_framebuffer_unreference(plane->old_fb);
2533 plane->old_fb = NULL;
2538 static int setplane_internal(struct drm_plane *plane,
2539 struct drm_crtc *crtc,
2540 struct drm_framebuffer *fb,
2541 int32_t crtc_x, int32_t crtc_y,
2542 uint32_t crtc_w, uint32_t crtc_h,
2543 /* src_{x,y,w,h} values are 16.16 fixed point */
2544 uint32_t src_x, uint32_t src_y,
2545 uint32_t src_w, uint32_t src_h)
2549 drm_modeset_lock_all(plane->dev);
2550 ret = __setplane_internal(plane, crtc, fb,
2551 crtc_x, crtc_y, crtc_w, crtc_h,
2552 src_x, src_y, src_w, src_h);
2553 drm_modeset_unlock_all(plane->dev);
2559 * drm_mode_setplane - configure a plane's configuration
2561 * @data: ioctl data*
2562 * @file_priv: DRM file info
2564 * Set plane configuration, including placement, fb, scaling, and other factors.
2565 * Or pass a NULL fb to disable (planes may be disabled without providing a
2569 * Zero on success, negative errno on failure.
2571 int drm_mode_setplane(struct drm_device *dev, void *data,
2572 struct drm_file *file_priv)
2574 struct drm_mode_set_plane *plane_req = data;
2575 struct drm_plane *plane;
2576 struct drm_crtc *crtc = NULL;
2577 struct drm_framebuffer *fb = NULL;
2579 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2583 * First, find the plane, crtc, and fb objects. If not available,
2584 * we don't bother to call the driver.
2586 plane = drm_plane_find(dev, plane_req->plane_id);
2588 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2589 plane_req->plane_id);
2593 if (plane_req->fb_id) {
2594 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2596 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2601 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2603 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2604 plane_req->crtc_id);
2610 * setplane_internal will take care of deref'ing either the old or new
2611 * framebuffer depending on success.
2613 return setplane_internal(plane, crtc, fb,
2614 plane_req->crtc_x, plane_req->crtc_y,
2615 plane_req->crtc_w, plane_req->crtc_h,
2616 plane_req->src_x, plane_req->src_y,
2617 plane_req->src_w, plane_req->src_h);
2621 * drm_mode_set_config_internal - helper to call ->set_config
2622 * @set: modeset config to set
2624 * This is a little helper to wrap internal calls to the ->set_config driver
2625 * interface. The only thing it adds is correct refcounting dance.
2628 * Zero on success, negative errno on failure.
2630 int drm_mode_set_config_internal(struct drm_mode_set *set)
2632 struct drm_crtc *crtc = set->crtc;
2633 struct drm_framebuffer *fb;
2634 struct drm_crtc *tmp;
2638 * NOTE: ->set_config can also disable other crtcs (if we steal all
2639 * connectors from it), hence we need to refcount the fbs across all
2640 * crtcs. Atomic modeset will have saner semantics ...
2642 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head)
2643 tmp->primary->old_fb = tmp->primary->fb;
2647 ret = crtc->funcs->set_config(set);
2649 crtc->primary->crtc = crtc;
2650 crtc->primary->fb = fb;
2653 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
2654 if (tmp->primary->fb)
2655 drm_framebuffer_reference(tmp->primary->fb);
2656 if (tmp->primary->old_fb)
2657 drm_framebuffer_unreference(tmp->primary->old_fb);
2658 tmp->primary->old_fb = NULL;
2663 EXPORT_SYMBOL(drm_mode_set_config_internal);
2666 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
2667 * @mode: mode to query
2668 * @hdisplay: hdisplay value to fill in
2669 * @vdisplay: vdisplay value to fill in
2671 * The vdisplay value will be doubled if the specified mode is a stereo mode of
2672 * the appropriate layout.
2674 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2675 int *hdisplay, int *vdisplay)
2677 struct drm_display_mode adjusted;
2679 drm_mode_copy(&adjusted, mode);
2680 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
2681 *hdisplay = adjusted.crtc_hdisplay;
2682 *vdisplay = adjusted.crtc_vdisplay;
2684 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
2687 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2689 * @crtc: CRTC that framebuffer will be displayed on
2692 * @mode: mode that framebuffer will be displayed under
2693 * @fb: framebuffer to check size of
2695 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2697 const struct drm_display_mode *mode,
2698 const struct drm_framebuffer *fb)
2701 int hdisplay, vdisplay;
2703 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
2705 if (crtc->invert_dimensions)
2706 swap(hdisplay, vdisplay);
2708 if (hdisplay > fb->width ||
2709 vdisplay > fb->height ||
2710 x > fb->width - hdisplay ||
2711 y > fb->height - vdisplay) {
2712 DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2713 fb->width, fb->height, hdisplay, vdisplay, x, y,
2714 crtc->invert_dimensions ? " (inverted)" : "");
2720 EXPORT_SYMBOL(drm_crtc_check_viewport);
2723 * drm_mode_setcrtc - set CRTC configuration
2724 * @dev: drm device for the ioctl
2725 * @data: data pointer for the ioctl
2726 * @file_priv: drm file for the ioctl call
2728 * Build a new CRTC configuration based on user request.
2730 * Called by the user via ioctl.
2733 * Zero on success, negative errno on failure.
2735 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2736 struct drm_file *file_priv)
2738 struct drm_mode_config *config = &dev->mode_config;
2739 struct drm_mode_crtc *crtc_req = data;
2740 struct drm_crtc *crtc;
2741 struct drm_connector **connector_set = NULL, *connector;
2742 struct drm_framebuffer *fb = NULL;
2743 struct drm_display_mode *mode = NULL;
2744 struct drm_mode_set set;
2745 uint32_t __user *set_connectors_ptr;
2749 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2752 /* For some reason crtc x/y offsets are signed internally. */
2753 if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
2756 drm_modeset_lock_all(dev);
2757 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2759 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2763 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2765 if (crtc_req->mode_valid) {
2766 /* If we have a mode we need a framebuffer. */
2767 /* If we pass -1, set the mode with the currently bound fb */
2768 if (crtc_req->fb_id == -1) {
2769 if (!crtc->primary->fb) {
2770 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2774 fb = crtc->primary->fb;
2775 /* Make refcounting symmetric with the lookup path. */
2776 drm_framebuffer_reference(fb);
2778 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2780 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2787 mode = drm_mode_create(dev);
2793 ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
2795 DRM_DEBUG_KMS("Invalid mode\n");
2799 mode->status = drm_mode_validate_basic(mode);
2800 if (mode->status != MODE_OK) {
2805 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2808 * Check whether the primary plane supports the fb pixel format.
2809 * Drivers not implementing the universal planes API use a
2810 * default formats list provided by the DRM core which doesn't
2811 * match real hardware capabilities. Skip the check in that
2814 if (!crtc->primary->format_default) {
2815 ret = drm_plane_check_pixel_format(crtc->primary,
2818 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2819 drm_get_format_name(fb->pixel_format));
2824 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2831 if (crtc_req->count_connectors == 0 && mode) {
2832 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2837 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2838 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2839 crtc_req->count_connectors);
2844 if (crtc_req->count_connectors > 0) {
2847 /* Avoid unbounded kernel memory allocation */
2848 if (crtc_req->count_connectors > config->num_connector) {
2853 connector_set = kmalloc_array(crtc_req->count_connectors,
2854 sizeof(struct drm_connector *),
2856 if (!connector_set) {
2861 for (i = 0; i < crtc_req->count_connectors; i++) {
2862 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2863 if (get_user(out_id, &set_connectors_ptr[i])) {
2868 connector = drm_connector_find(dev, out_id);
2870 DRM_DEBUG_KMS("Connector id %d unknown\n",
2875 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2879 connector_set[i] = connector;
2884 set.x = crtc_req->x;
2885 set.y = crtc_req->y;
2887 set.connectors = connector_set;
2888 set.num_connectors = crtc_req->count_connectors;
2890 ret = drm_mode_set_config_internal(&set);
2894 drm_framebuffer_unreference(fb);
2896 kfree(connector_set);
2897 drm_mode_destroy(dev, mode);
2898 drm_modeset_unlock_all(dev);
2903 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2904 * universal plane handler call
2905 * @crtc: crtc to update cursor for
2906 * @req: data pointer for the ioctl
2907 * @file_priv: drm file for the ioctl call
2909 * Legacy cursor ioctl's work directly with driver buffer handles. To
2910 * translate legacy ioctl calls into universal plane handler calls, we need to
2911 * wrap the native buffer handle in a drm_framebuffer.
2913 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2914 * buffer with a pitch of 4*width; the universal plane interface should be used
2915 * directly in cases where the hardware can support other buffer settings and
2916 * userspace wants to make use of these capabilities.
2919 * Zero on success, negative errno on failure.
2921 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2922 struct drm_mode_cursor2 *req,
2923 struct drm_file *file_priv)
2925 struct drm_device *dev = crtc->dev;
2926 struct drm_framebuffer *fb = NULL;
2927 struct drm_mode_fb_cmd2 fbreq = {
2928 .width = req->width,
2929 .height = req->height,
2930 .pixel_format = DRM_FORMAT_ARGB8888,
2931 .pitches = { req->width * 4 },
2932 .handles = { req->handle },
2934 int32_t crtc_x, crtc_y;
2935 uint32_t crtc_w = 0, crtc_h = 0;
2936 uint32_t src_w = 0, src_h = 0;
2939 BUG_ON(!crtc->cursor);
2940 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2943 * Obtain fb we'll be using (either new or existing) and take an extra
2944 * reference to it if fb != null. setplane will take care of dropping
2945 * the reference if the plane update fails.
2947 if (req->flags & DRM_MODE_CURSOR_BO) {
2949 fb = internal_framebuffer_create(dev, &fbreq, file_priv);
2951 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2958 fb = crtc->cursor->fb;
2960 drm_framebuffer_reference(fb);
2963 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2967 crtc_x = crtc->cursor_x;
2968 crtc_y = crtc->cursor_y;
2973 crtc_h = fb->height;
2974 src_w = fb->width << 16;
2975 src_h = fb->height << 16;
2979 * setplane_internal will take care of deref'ing either the old or new
2980 * framebuffer depending on success.
2982 ret = __setplane_internal(crtc->cursor, crtc, fb,
2983 crtc_x, crtc_y, crtc_w, crtc_h,
2984 0, 0, src_w, src_h);
2986 /* Update successful; save new cursor position, if necessary */
2987 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
2988 crtc->cursor_x = req->x;
2989 crtc->cursor_y = req->y;
2995 static int drm_mode_cursor_common(struct drm_device *dev,
2996 struct drm_mode_cursor2 *req,
2997 struct drm_file *file_priv)
2999 struct drm_crtc *crtc;
3002 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3005 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
3008 crtc = drm_crtc_find(dev, req->crtc_id);
3010 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
3015 * If this crtc has a universal cursor plane, call that plane's update
3016 * handler rather than using legacy cursor handlers.
3018 drm_modeset_lock_crtc(crtc, crtc->cursor);
3020 ret = drm_mode_cursor_universal(crtc, req, file_priv);
3024 if (req->flags & DRM_MODE_CURSOR_BO) {
3025 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
3029 /* Turns off the cursor if handle is 0 */
3030 if (crtc->funcs->cursor_set2)
3031 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
3032 req->width, req->height, req->hot_x, req->hot_y);
3034 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
3035 req->width, req->height);
3038 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3039 if (crtc->funcs->cursor_move) {
3040 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3047 drm_modeset_unlock_crtc(crtc);
3055 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3056 * @dev: drm device for the ioctl
3057 * @data: data pointer for the ioctl
3058 * @file_priv: drm file for the ioctl call
3060 * Set the cursor configuration based on user request.
3062 * Called by the user via ioctl.
3065 * Zero on success, negative errno on failure.
3067 int drm_mode_cursor_ioctl(struct drm_device *dev,
3068 void *data, struct drm_file *file_priv)
3070 struct drm_mode_cursor *req = data;
3071 struct drm_mode_cursor2 new_req;
3073 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3074 new_req.hot_x = new_req.hot_y = 0;
3076 return drm_mode_cursor_common(dev, &new_req, file_priv);
3080 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3081 * @dev: drm device for the ioctl
3082 * @data: data pointer for the ioctl
3083 * @file_priv: drm file for the ioctl call
3085 * Set the cursor configuration based on user request. This implements the 2nd
3086 * version of the cursor ioctl, which allows userspace to additionally specify
3087 * the hotspot of the pointer.
3089 * Called by the user via ioctl.
3092 * Zero on success, negative errno on failure.
3094 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3095 void *data, struct drm_file *file_priv)
3097 struct drm_mode_cursor2 *req = data;
3099 return drm_mode_cursor_common(dev, req, file_priv);
3103 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3104 * @bpp: bits per pixels
3105 * @depth: bit depth per pixel
3107 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3108 * Useful in fbdev emulation code, since that deals in those values.
3110 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3116 fmt = DRM_FORMAT_C8;
3120 fmt = DRM_FORMAT_XRGB1555;
3122 fmt = DRM_FORMAT_RGB565;
3125 fmt = DRM_FORMAT_RGB888;
3129 fmt = DRM_FORMAT_XRGB8888;
3130 else if (depth == 30)
3131 fmt = DRM_FORMAT_XRGB2101010;
3133 fmt = DRM_FORMAT_ARGB8888;
3136 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3137 fmt = DRM_FORMAT_XRGB8888;
3143 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3146 * drm_mode_addfb - add an FB to the graphics configuration
3147 * @dev: drm device for the ioctl
3148 * @data: data pointer for the ioctl
3149 * @file_priv: drm file for the ioctl call
3151 * Add a new FB to the specified CRTC, given a user request. This is the
3152 * original addfb ioctl which only supported RGB formats.
3154 * Called by the user via ioctl.
3157 * Zero on success, negative errno on failure.
3159 int drm_mode_addfb(struct drm_device *dev,
3160 void *data, struct drm_file *file_priv)
3162 struct drm_mode_fb_cmd *or = data;
3163 struct drm_mode_fb_cmd2 r = {};
3166 /* convert to new format and call new ioctl */
3167 r.fb_id = or->fb_id;
3168 r.width = or->width;
3169 r.height = or->height;
3170 r.pitches[0] = or->pitch;
3171 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3172 r.handles[0] = or->handle;
3174 ret = drm_mode_addfb2(dev, &r, file_priv);
3178 or->fb_id = r.fb_id;
3183 static int format_check(const struct drm_mode_fb_cmd2 *r)
3185 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3189 case DRM_FORMAT_RGB332:
3190 case DRM_FORMAT_BGR233:
3191 case DRM_FORMAT_XRGB4444:
3192 case DRM_FORMAT_XBGR4444:
3193 case DRM_FORMAT_RGBX4444:
3194 case DRM_FORMAT_BGRX4444:
3195 case DRM_FORMAT_ARGB4444:
3196 case DRM_FORMAT_ABGR4444:
3197 case DRM_FORMAT_RGBA4444:
3198 case DRM_FORMAT_BGRA4444:
3199 case DRM_FORMAT_XRGB1555:
3200 case DRM_FORMAT_XBGR1555:
3201 case DRM_FORMAT_RGBX5551:
3202 case DRM_FORMAT_BGRX5551:
3203 case DRM_FORMAT_ARGB1555:
3204 case DRM_FORMAT_ABGR1555:
3205 case DRM_FORMAT_RGBA5551:
3206 case DRM_FORMAT_BGRA5551:
3207 case DRM_FORMAT_RGB565:
3208 case DRM_FORMAT_BGR565:
3209 case DRM_FORMAT_RGB888:
3210 case DRM_FORMAT_BGR888:
3211 case DRM_FORMAT_XRGB8888:
3212 case DRM_FORMAT_XBGR8888:
3213 case DRM_FORMAT_RGBX8888:
3214 case DRM_FORMAT_BGRX8888:
3215 case DRM_FORMAT_ARGB8888:
3216 case DRM_FORMAT_ABGR8888:
3217 case DRM_FORMAT_RGBA8888:
3218 case DRM_FORMAT_BGRA8888:
3219 case DRM_FORMAT_XRGB2101010:
3220 case DRM_FORMAT_XBGR2101010:
3221 case DRM_FORMAT_RGBX1010102:
3222 case DRM_FORMAT_BGRX1010102:
3223 case DRM_FORMAT_ARGB2101010:
3224 case DRM_FORMAT_ABGR2101010:
3225 case DRM_FORMAT_RGBA1010102:
3226 case DRM_FORMAT_BGRA1010102:
3227 case DRM_FORMAT_YUYV:
3228 case DRM_FORMAT_YVYU:
3229 case DRM_FORMAT_UYVY:
3230 case DRM_FORMAT_VYUY:
3231 case DRM_FORMAT_AYUV:
3232 case DRM_FORMAT_NV12:
3233 case DRM_FORMAT_NV21:
3234 case DRM_FORMAT_NV16:
3235 case DRM_FORMAT_NV61:
3236 case DRM_FORMAT_NV24:
3237 case DRM_FORMAT_NV42:
3238 case DRM_FORMAT_YUV410:
3239 case DRM_FORMAT_YVU410:
3240 case DRM_FORMAT_YUV411:
3241 case DRM_FORMAT_YVU411:
3242 case DRM_FORMAT_YUV420:
3243 case DRM_FORMAT_YVU420:
3244 case DRM_FORMAT_YUV422:
3245 case DRM_FORMAT_YVU422:
3246 case DRM_FORMAT_YUV444:
3247 case DRM_FORMAT_YVU444:
3250 DRM_DEBUG_KMS("invalid pixel format %s\n",
3251 drm_get_format_name(r->pixel_format));
3256 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3258 int ret, hsub, vsub, num_planes, i;
3260 ret = format_check(r);
3262 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3263 drm_get_format_name(r->pixel_format));
3267 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3268 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3269 num_planes = drm_format_num_planes(r->pixel_format);
3271 if (r->width == 0 || r->width % hsub) {
3272 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3276 if (r->height == 0 || r->height % vsub) {
3277 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3281 for (i = 0; i < num_planes; i++) {
3282 unsigned int width = r->width / (i != 0 ? hsub : 1);
3283 unsigned int height = r->height / (i != 0 ? vsub : 1);
3284 unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);
3286 if (!r->handles[i]) {
3287 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3291 if ((uint64_t) width * cpp > UINT_MAX)
3294 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3297 if (r->pitches[i] < width * cpp) {
3298 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3302 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
3303 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
3312 static struct drm_framebuffer *
3313 internal_framebuffer_create(struct drm_device *dev,
3314 struct drm_mode_fb_cmd2 *r,
3315 struct drm_file *file_priv)
3317 struct drm_mode_config *config = &dev->mode_config;
3318 struct drm_framebuffer *fb;
3321 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
3322 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3323 return ERR_PTR(-EINVAL);
3326 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3327 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3328 r->width, config->min_width, config->max_width);
3329 return ERR_PTR(-EINVAL);
3331 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3332 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3333 r->height, config->min_height, config->max_height);
3334 return ERR_PTR(-EINVAL);
3337 if (r->flags & DRM_MODE_FB_MODIFIERS &&
3338 !dev->mode_config.allow_fb_modifiers) {
3339 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
3340 return ERR_PTR(-EINVAL);
3343 ret = framebuffer_check(r);
3345 return ERR_PTR(ret);
3347 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3349 DRM_DEBUG_KMS("could not create framebuffer\n");
3357 * drm_mode_addfb2 - add an FB to the graphics configuration
3358 * @dev: drm device for the ioctl
3359 * @data: data pointer for the ioctl
3360 * @file_priv: drm file for the ioctl call
3362 * Add a new FB to the specified CRTC, given a user request with format. This is
3363 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3364 * and uses fourcc codes as pixel format specifiers.
3366 * Called by the user via ioctl.
3369 * Zero on success, negative errno on failure.
3371 int drm_mode_addfb2(struct drm_device *dev,
3372 void *data, struct drm_file *file_priv)
3374 struct drm_mode_fb_cmd2 *r = data;
3375 struct drm_framebuffer *fb;
3377 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3380 fb = internal_framebuffer_create(dev, r, file_priv);
3384 /* Transfer ownership to the filp for reaping on close */
3386 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3387 mutex_lock(&file_priv->fbs_lock);
3388 r->fb_id = fb->base.id;
3389 list_add(&fb->filp_head, &file_priv->fbs);
3390 mutex_unlock(&file_priv->fbs_lock);
3396 * drm_mode_rmfb - remove an FB from the configuration
3397 * @dev: drm device for the ioctl
3398 * @data: data pointer for the ioctl
3399 * @file_priv: drm file for the ioctl call
3401 * Remove the FB specified by the user.
3403 * Called by the user via ioctl.
3406 * Zero on success, negative errno on failure.
3408 int drm_mode_rmfb(struct drm_device *dev,
3409 void *data, struct drm_file *file_priv)
3411 struct drm_framebuffer *fb = NULL;
3412 struct drm_framebuffer *fbl = NULL;
3413 uint32_t *id = data;
3416 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3419 mutex_lock(&file_priv->fbs_lock);
3420 mutex_lock(&dev->mode_config.fb_lock);
3421 fb = __drm_framebuffer_lookup(dev, *id);
3425 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3431 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3432 __drm_framebuffer_unregister(dev, fb);
3434 list_del_init(&fb->filp_head);
3435 mutex_unlock(&dev->mode_config.fb_lock);
3436 mutex_unlock(&file_priv->fbs_lock);
3438 drm_framebuffer_remove(fb);
3443 mutex_unlock(&dev->mode_config.fb_lock);
3444 mutex_unlock(&file_priv->fbs_lock);
3450 * drm_mode_getfb - get FB info
3451 * @dev: drm device for the ioctl
3452 * @data: data pointer for the ioctl
3453 * @file_priv: drm file for the ioctl call
3455 * Lookup the FB given its ID and return info about it.
3457 * Called by the user via ioctl.
3460 * Zero on success, negative errno on failure.
3462 int drm_mode_getfb(struct drm_device *dev,
3463 void *data, struct drm_file *file_priv)
3465 struct drm_mode_fb_cmd *r = data;
3466 struct drm_framebuffer *fb;
3469 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3472 fb = drm_framebuffer_lookup(dev, r->fb_id);
3476 r->height = fb->height;
3477 r->width = fb->width;
3478 r->depth = fb->depth;
3479 r->bpp = fb->bits_per_pixel;
3480 r->pitch = fb->pitches[0];
3481 if (fb->funcs->create_handle) {
3482 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3483 drm_is_control_client(file_priv)) {
3484 ret = fb->funcs->create_handle(fb, file_priv,
3487 /* GET_FB() is an unprivileged ioctl so we must not
3488 * return a buffer-handle to non-master processes! For
3489 * backwards-compatibility reasons, we cannot make
3490 * GET_FB() privileged, so just return an invalid handle
3491 * for non-masters. */
3499 drm_framebuffer_unreference(fb);
3505 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3506 * @dev: drm device for the ioctl
3507 * @data: data pointer for the ioctl
3508 * @file_priv: drm file for the ioctl call
3510 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3511 * rectangle list. Generic userspace which does frontbuffer rendering must call
3512 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3513 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3515 * Modesetting drivers which always update the frontbuffer do not need to
3516 * implement the corresponding ->dirty framebuffer callback.
3518 * Called by the user via ioctl.
3521 * Zero on success, negative errno on failure.
3523 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3524 void *data, struct drm_file *file_priv)
3526 struct drm_clip_rect __user *clips_ptr;
3527 struct drm_clip_rect *clips = NULL;
3528 struct drm_mode_fb_dirty_cmd *r = data;
3529 struct drm_framebuffer *fb;
3534 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3537 fb = drm_framebuffer_lookup(dev, r->fb_id);
3541 num_clips = r->num_clips;
3542 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3544 if (!num_clips != !clips_ptr) {
3549 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3551 /* If userspace annotates copy, clips must come in pairs */
3552 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3557 if (num_clips && clips_ptr) {
3558 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3562 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3568 ret = copy_from_user(clips, clips_ptr,
3569 num_clips * sizeof(*clips));
3576 if (fb->funcs->dirty) {
3577 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3586 drm_framebuffer_unreference(fb);
3593 * drm_fb_release - remove and free the FBs on this file
3594 * @priv: drm file for the ioctl
3596 * Destroy all the FBs associated with @filp.
3598 * Called by the user via ioctl.
3601 * Zero on success, negative errno on failure.
3603 void drm_fb_release(struct drm_file *priv)
3605 struct drm_device *dev = priv->minor->dev;
3606 struct drm_framebuffer *fb, *tfb;
3609 * When the file gets released that means no one else can access the fb
3610 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3611 * avoid upsetting lockdep since the universal cursor code adds a
3612 * framebuffer while holding mutex locks.
3614 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3615 * locks is impossible here since no one else but this function can get
3618 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3620 mutex_lock(&dev->mode_config.fb_lock);
3621 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3622 __drm_framebuffer_unregister(dev, fb);
3623 mutex_unlock(&dev->mode_config.fb_lock);
3625 list_del_init(&fb->filp_head);
3627 /* This will also drop the fpriv->fbs reference. */
3628 drm_framebuffer_remove(fb);
3633 * drm_property_create - create a new property type
3635 * @flags: flags specifying the property type
3636 * @name: name of the property
3637 * @num_values: number of pre-defined values
3639 * This creates a new generic drm property which can then be attached to a drm
3640 * object with drm_object_attach_property. The returned property object must be
3641 * freed with drm_property_destroy.
3643 * Note that the DRM core keeps a per-device list of properties and that, if
3644 * drm_mode_config_cleanup() is called, it will destroy all properties created
3648 * A pointer to the newly created property on success, NULL on failure.
3650 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3651 const char *name, int num_values)
3653 struct drm_property *property = NULL;
3656 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3660 property->dev = dev;
3663 property->values = kcalloc(num_values, sizeof(uint64_t),
3665 if (!property->values)
3669 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3673 property->flags = flags;
3674 property->num_values = num_values;
3675 INIT_LIST_HEAD(&property->enum_list);
3678 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3679 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3682 list_add_tail(&property->head, &dev->mode_config.property_list);
3684 WARN_ON(!drm_property_type_valid(property));
3688 kfree(property->values);
3692 EXPORT_SYMBOL(drm_property_create);
3695 * drm_property_create_enum - create a new enumeration property type
3697 * @flags: flags specifying the property type
3698 * @name: name of the property
3699 * @props: enumeration lists with property values
3700 * @num_values: number of pre-defined values
3702 * This creates a new generic drm property which can then be attached to a drm
3703 * object with drm_object_attach_property. The returned property object must be
3704 * freed with drm_property_destroy.
3706 * Userspace is only allowed to set one of the predefined values for enumeration
3710 * A pointer to the newly created property on success, NULL on failure.
3712 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3714 const struct drm_prop_enum_list *props,
3717 struct drm_property *property;
3720 flags |= DRM_MODE_PROP_ENUM;
3722 property = drm_property_create(dev, flags, name, num_values);
3726 for (i = 0; i < num_values; i++) {
3727 ret = drm_property_add_enum(property, i,
3731 drm_property_destroy(dev, property);
3738 EXPORT_SYMBOL(drm_property_create_enum);
3741 * drm_property_create_bitmask - create a new bitmask property type
3743 * @flags: flags specifying the property type
3744 * @name: name of the property
3745 * @props: enumeration lists with property bitflags
3746 * @num_props: size of the @props array
3747 * @supported_bits: bitmask of all supported enumeration values
3749 * This creates a new bitmask drm property which can then be attached to a drm
3750 * object with drm_object_attach_property. The returned property object must be
3751 * freed with drm_property_destroy.
3753 * Compared to plain enumeration properties userspace is allowed to set any
3754 * or'ed together combination of the predefined property bitflag values
3757 * A pointer to the newly created property on success, NULL on failure.
3759 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3760 int flags, const char *name,
3761 const struct drm_prop_enum_list *props,
3763 uint64_t supported_bits)
3765 struct drm_property *property;
3766 int i, ret, index = 0;
3767 int num_values = hweight64(supported_bits);
3769 flags |= DRM_MODE_PROP_BITMASK;
3771 property = drm_property_create(dev, flags, name, num_values);
3774 for (i = 0; i < num_props; i++) {
3775 if (!(supported_bits & (1ULL << props[i].type)))
3778 if (WARN_ON(index >= num_values)) {
3779 drm_property_destroy(dev, property);
3783 ret = drm_property_add_enum(property, index++,
3787 drm_property_destroy(dev, property);
3794 EXPORT_SYMBOL(drm_property_create_bitmask);
3796 static struct drm_property *property_create_range(struct drm_device *dev,
3797 int flags, const char *name,
3798 uint64_t min, uint64_t max)
3800 struct drm_property *property;
3802 property = drm_property_create(dev, flags, name, 2);
3806 property->values[0] = min;
3807 property->values[1] = max;
3813 * drm_property_create_range - create a new unsigned ranged property type
3815 * @flags: flags specifying the property type
3816 * @name: name of the property
3817 * @min: minimum value of the property
3818 * @max: maximum value of the property
3820 * This creates a new generic drm property which can then be attached to a drm
3821 * object with drm_object_attach_property. The returned property object must be
3822 * freed with drm_property_destroy.
3824 * Userspace is allowed to set any unsigned integer value in the (min, max)
3828 * A pointer to the newly created property on success, NULL on failure.
3830 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3832 uint64_t min, uint64_t max)
3834 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3837 EXPORT_SYMBOL(drm_property_create_range);
3840 * drm_property_create_signed_range - create a new signed ranged property type
3842 * @flags: flags specifying the property type
3843 * @name: name of the property
3844 * @min: minimum value of the property
3845 * @max: maximum value of the property
3847 * This creates a new generic drm property which can then be attached to a drm
3848 * object with drm_object_attach_property. The returned property object must be
3849 * freed with drm_property_destroy.
3851 * Userspace is allowed to set any signed integer value in the (min, max)
3855 * A pointer to the newly created property on success, NULL on failure.
3857 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3858 int flags, const char *name,
3859 int64_t min, int64_t max)
3861 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3862 name, I642U64(min), I642U64(max));
3864 EXPORT_SYMBOL(drm_property_create_signed_range);
3867 * drm_property_create_object - create a new object property type
3869 * @flags: flags specifying the property type
3870 * @name: name of the property
3871 * @type: object type from DRM_MODE_OBJECT_* defines
3873 * This creates a new generic drm property which can then be attached to a drm
3874 * object with drm_object_attach_property. The returned property object must be
3875 * freed with drm_property_destroy.
3877 * Userspace is only allowed to set this to any property value of the given
3878 * @type. Only useful for atomic properties, which is enforced.
3881 * A pointer to the newly created property on success, NULL on failure.
3883 struct drm_property *drm_property_create_object(struct drm_device *dev,
3884 int flags, const char *name, uint32_t type)
3886 struct drm_property *property;
3888 flags |= DRM_MODE_PROP_OBJECT;
3890 if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
3893 property = drm_property_create(dev, flags, name, 1);
3897 property->values[0] = type;
3901 EXPORT_SYMBOL(drm_property_create_object);
3904 * drm_property_create_bool - create a new boolean property type
3906 * @flags: flags specifying the property type
3907 * @name: name of the property
3909 * This creates a new generic drm property which can then be attached to a drm
3910 * object with drm_object_attach_property. The returned property object must be
3911 * freed with drm_property_destroy.
3913 * This is implemented as a ranged property with only {0, 1} as valid values.
3916 * A pointer to the newly created property on success, NULL on failure.
3918 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
3921 return drm_property_create_range(dev, flags, name, 0, 1);
3923 EXPORT_SYMBOL(drm_property_create_bool);
3926 * drm_property_add_enum - add a possible value to an enumeration property
3927 * @property: enumeration property to change
3928 * @index: index of the new enumeration
3929 * @value: value of the new enumeration
3930 * @name: symbolic name of the new enumeration
3932 * This functions adds enumerations to a property.
3934 * It's use is deprecated, drivers should use one of the more specific helpers
3935 * to directly create the property with all enumerations already attached.
3938 * Zero on success, error code on failure.
3940 int drm_property_add_enum(struct drm_property *property, int index,
3941 uint64_t value, const char *name)
3943 struct drm_property_enum *prop_enum;
3945 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3946 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
3950 * Bitmask enum properties have the additional constraint of values
3953 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
3957 if (!list_empty(&property->enum_list)) {
3958 list_for_each_entry(prop_enum, &property->enum_list, head) {
3959 if (prop_enum->value == value) {
3960 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3961 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3967 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
3971 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3972 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3973 prop_enum->value = value;
3975 property->values[index] = value;
3976 list_add_tail(&prop_enum->head, &property->enum_list);
3979 EXPORT_SYMBOL(drm_property_add_enum);
3982 * drm_property_destroy - destroy a drm property
3984 * @property: property to destry
3986 * This function frees a property including any attached resources like
3987 * enumeration values.
3989 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
3991 struct drm_property_enum *prop_enum, *pt;
3993 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
3994 list_del(&prop_enum->head);
3998 if (property->num_values)
3999 kfree(property->values);
4000 drm_mode_object_put(dev, &property->base);
4001 list_del(&property->head);
4004 EXPORT_SYMBOL(drm_property_destroy);
4007 * drm_object_attach_property - attach a property to a modeset object
4008 * @obj: drm modeset object
4009 * @property: property to attach
4010 * @init_val: initial value of the property
4012 * This attaches the given property to the modeset object with the given initial
4013 * value. Currently this function cannot fail since the properties are stored in
4014 * a statically sized array.
4016 void drm_object_attach_property(struct drm_mode_object *obj,
4017 struct drm_property *property,
4020 int count = obj->properties->count;
4022 if (count == DRM_OBJECT_MAX_PROPERTY) {
4023 WARN(1, "Failed to attach object property (type: 0x%x). Please "
4024 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
4025 "you see this message on the same object type.\n",
4030 obj->properties->properties[count] = property;
4031 obj->properties->values[count] = init_val;
4032 obj->properties->count++;
4033 if (property->flags & DRM_MODE_PROP_ATOMIC)
4034 obj->properties->atomic_count++;
4036 EXPORT_SYMBOL(drm_object_attach_property);
4039 * drm_object_property_set_value - set the value of a property
4040 * @obj: drm mode object to set property value for
4041 * @property: property to set
4042 * @val: value the property should be set to
4044 * This functions sets a given property on a given object. This function only
4045 * changes the software state of the property, it does not call into the
4046 * driver's ->set_property callback.
4049 * Zero on success, error code on failure.
4051 int drm_object_property_set_value(struct drm_mode_object *obj,
4052 struct drm_property *property, uint64_t val)
4056 for (i = 0; i < obj->properties->count; i++) {
4057 if (obj->properties->properties[i] == property) {
4058 obj->properties->values[i] = val;
4065 EXPORT_SYMBOL(drm_object_property_set_value);
4068 * drm_object_property_get_value - retrieve the value of a property
4069 * @obj: drm mode object to get property value from
4070 * @property: property to retrieve
4071 * @val: storage for the property value
4073 * This function retrieves the softare state of the given property for the given
4074 * property. Since there is no driver callback to retrieve the current property
4075 * value this might be out of sync with the hardware, depending upon the driver
4079 * Zero on success, error code on failure.
4081 int drm_object_property_get_value(struct drm_mode_object *obj,
4082 struct drm_property *property, uint64_t *val)
4086 /* read-only properties bypass atomic mechanism and still store
4087 * their value in obj->properties->values[].. mostly to avoid
4088 * having to deal w/ EDID and similar props in atomic paths:
4090 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
4091 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
4092 return drm_atomic_get_property(obj, property, val);
4094 for (i = 0; i < obj->properties->count; i++) {
4095 if (obj->properties->properties[i] == property) {
4096 *val = obj->properties->values[i];
4103 EXPORT_SYMBOL(drm_object_property_get_value);
4106 * drm_mode_getproperty_ioctl - get the property metadata
4109 * @file_priv: DRM file info
4111 * This function retrieves the metadata for a given property, like the different
4112 * possible values for an enum property or the limits for a range property.
4114 * Blob properties are special
4116 * Called by the user via ioctl.
4119 * Zero on success, negative errno on failure.
4121 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4122 void *data, struct drm_file *file_priv)
4124 struct drm_mode_get_property *out_resp = data;
4125 struct drm_property *property;
4127 int value_count = 0;
4130 struct drm_property_enum *prop_enum;
4131 struct drm_mode_property_enum __user *enum_ptr;
4132 uint64_t __user *values_ptr;
4134 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4137 drm_modeset_lock_all(dev);
4138 property = drm_property_find(dev, out_resp->prop_id);
4144 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4145 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4146 list_for_each_entry(prop_enum, &property->enum_list, head)
4150 value_count = property->num_values;
4152 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4153 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4154 out_resp->flags = property->flags;
4156 if ((out_resp->count_values >= value_count) && value_count) {
4157 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4158 for (i = 0; i < value_count; i++) {
4159 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4165 out_resp->count_values = value_count;
4167 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4168 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4169 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4171 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4172 list_for_each_entry(prop_enum, &property->enum_list, head) {
4174 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4179 if (copy_to_user(&enum_ptr[copied].name,
4180 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4187 out_resp->count_enum_blobs = enum_count;
4191 * NOTE: The idea seems to have been to use this to read all the blob
4192 * property values. But nothing ever added them to the corresponding
4193 * list, userspace always used the special-purpose get_blob ioctl to
4194 * read the value for a blob property. It also doesn't make a lot of
4195 * sense to return values here when everything else is just metadata for
4196 * the property itself.
4198 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4199 out_resp->count_enum_blobs = 0;
4201 drm_modeset_unlock_all(dev);
4205 static struct drm_property_blob *
4206 drm_property_create_blob(struct drm_device *dev, size_t length,
4209 struct drm_property_blob *blob;
4212 if (!length || !data)
4215 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4219 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4225 blob->length = length;
4227 memcpy(blob->data, data, length);
4229 list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
4233 static void drm_property_destroy_blob(struct drm_device *dev,
4234 struct drm_property_blob *blob)
4236 drm_mode_object_put(dev, &blob->base);
4237 list_del(&blob->head);
4242 * drm_mode_getblob_ioctl - get the contents of a blob property value
4245 * @file_priv: DRM file info
4247 * This function retrieves the contents of a blob property. The value stored in
4248 * an object's blob property is just a normal modeset object id.
4250 * Called by the user via ioctl.
4253 * Zero on success, negative errno on failure.
4255 int drm_mode_getblob_ioctl(struct drm_device *dev,
4256 void *data, struct drm_file *file_priv)
4258 struct drm_mode_get_blob *out_resp = data;
4259 struct drm_property_blob *blob;
4261 void __user *blob_ptr;
4263 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4266 drm_modeset_lock_all(dev);
4267 blob = drm_property_blob_find(dev, out_resp->blob_id);
4273 if (out_resp->length == blob->length) {
4274 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4275 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4280 out_resp->length = blob->length;
4283 drm_modeset_unlock_all(dev);
4288 * drm_mode_connector_set_path_property - set tile property on connector
4289 * @connector: connector to set property on.
4290 * @path: path to use for property.
4292 * This creates a property to expose to userspace to specify a
4293 * connector path. This is mainly used for DisplayPort MST where
4294 * connectors have a topology and we want to allow userspace to give
4295 * them more meaningful names.
4298 * Zero on success, negative errno on failure.
4300 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4303 struct drm_device *dev = connector->dev;
4304 size_t size = strlen(path) + 1;
4307 connector->path_blob_ptr = drm_property_create_blob(connector->dev,
4309 if (!connector->path_blob_ptr)
4312 ret = drm_object_property_set_value(&connector->base,
4313 dev->mode_config.path_property,
4314 connector->path_blob_ptr->base.id);
4317 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4320 * drm_mode_connector_set_tile_property - set tile property on connector
4321 * @connector: connector to set property on.
4323 * This looks up the tile information for a connector, and creates a
4324 * property for userspace to parse if it exists. The property is of
4325 * the form of 8 integers using ':' as a separator.
4328 * Zero on success, errno on failure.
4330 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4332 struct drm_device *dev = connector->dev;
4336 if (connector->tile_blob_ptr)
4337 drm_property_destroy_blob(dev, connector->tile_blob_ptr);
4339 if (!connector->has_tile) {
4340 connector->tile_blob_ptr = NULL;
4341 ret = drm_object_property_set_value(&connector->base,
4342 dev->mode_config.tile_property, 0);
4346 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4347 connector->tile_group->id, connector->tile_is_single_monitor,
4348 connector->num_h_tile, connector->num_v_tile,
4349 connector->tile_h_loc, connector->tile_v_loc,
4350 connector->tile_h_size, connector->tile_v_size);
4351 size = strlen(tile) + 1;
4353 connector->tile_blob_ptr = drm_property_create_blob(connector->dev,
4355 if (!connector->tile_blob_ptr)
4358 ret = drm_object_property_set_value(&connector->base,
4359 dev->mode_config.tile_property,
4360 connector->tile_blob_ptr->base.id);
4363 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4366 * drm_mode_connector_update_edid_property - update the edid property of a connector
4367 * @connector: drm connector
4368 * @edid: new value of the edid property
4370 * This function creates a new blob modeset object and assigns its id to the
4371 * connector's edid property.
4374 * Zero on success, negative errno on failure.
4376 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4377 const struct edid *edid)
4379 struct drm_device *dev = connector->dev;
4383 /* ignore requests to set edid when overridden */
4384 if (connector->override_edid)
4387 if (connector->edid_blob_ptr)
4388 drm_property_destroy_blob(dev, connector->edid_blob_ptr);
4390 /* Delete edid, when there is none. */
4392 connector->edid_blob_ptr = NULL;
4393 ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
4397 size = EDID_LENGTH * (1 + edid->extensions);
4398 connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
4400 if (!connector->edid_blob_ptr)
4403 ret = drm_object_property_set_value(&connector->base,
4404 dev->mode_config.edid_property,
4405 connector->edid_blob_ptr->base.id);
4409 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4411 /* Some properties could refer to dynamic refcnt'd objects, or things that
4412 * need special locking to handle lifetime issues (ie. to ensure the prop
4413 * value doesn't become invalid part way through the property update due to
4414 * race). The value returned by reference via 'obj' should be passed back
4415 * to drm_property_change_valid_put() after the property is set (and the
4416 * object to which the property is attached has a chance to take it's own
4419 bool drm_property_change_valid_get(struct drm_property *property,
4420 uint64_t value, struct drm_mode_object **ref)
4424 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4429 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4430 if (value < property->values[0] || value > property->values[1])
4433 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4434 int64_t svalue = U642I64(value);
4436 if (svalue < U642I64(property->values[0]) ||
4437 svalue > U642I64(property->values[1]))
4440 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4441 uint64_t valid_mask = 0;
4443 for (i = 0; i < property->num_values; i++)
4444 valid_mask |= (1ULL << property->values[i]);
4445 return !(value & ~valid_mask);
4446 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4447 /* Only the driver knows */
4449 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4450 /* a zero value for an object property translates to null: */
4454 /* handle refcnt'd objects specially: */
4455 if (property->values[0] == DRM_MODE_OBJECT_FB) {
4456 struct drm_framebuffer *fb;
4457 fb = drm_framebuffer_lookup(property->dev, value);
4465 return _object_find(property->dev, value, property->values[0]) != NULL;
4469 for (i = 0; i < property->num_values; i++)
4470 if (property->values[i] == value)
4475 void drm_property_change_valid_put(struct drm_property *property,
4476 struct drm_mode_object *ref)
4481 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4482 if (property->values[0] == DRM_MODE_OBJECT_FB)
4483 drm_framebuffer_unreference(obj_to_fb(ref));
4488 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4491 * @file_priv: DRM file info
4493 * This function sets the current value for a connectors's property. It also
4494 * calls into a driver's ->set_property callback to update the hardware state
4496 * Called by the user via ioctl.
4499 * Zero on success, negative errno on failure.
4501 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4502 void *data, struct drm_file *file_priv)
4504 struct drm_mode_connector_set_property *conn_set_prop = data;
4505 struct drm_mode_obj_set_property obj_set_prop = {
4506 .value = conn_set_prop->value,
4507 .prop_id = conn_set_prop->prop_id,
4508 .obj_id = conn_set_prop->connector_id,
4509 .obj_type = DRM_MODE_OBJECT_CONNECTOR
4512 /* It does all the locking and checking we need */
4513 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4516 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4517 struct drm_property *property,
4521 struct drm_connector *connector = obj_to_connector(obj);
4523 /* Do DPMS ourselves */
4524 if (property == connector->dev->mode_config.dpms_property) {
4525 if (connector->funcs->dpms)
4526 (*connector->funcs->dpms)(connector, (int)value);
4528 } else if (connector->funcs->set_property)
4529 ret = connector->funcs->set_property(connector, property, value);
4531 /* store the property value if successful */
4533 drm_object_property_set_value(&connector->base, property, value);
4537 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4538 struct drm_property *property,
4542 struct drm_crtc *crtc = obj_to_crtc(obj);
4544 if (crtc->funcs->set_property)
4545 ret = crtc->funcs->set_property(crtc, property, value);
4547 drm_object_property_set_value(obj, property, value);
4553 * drm_mode_plane_set_obj_prop - set the value of a property
4554 * @plane: drm plane object to set property value for
4555 * @property: property to set
4556 * @value: value the property should be set to
4558 * This functions sets a given property on a given plane object. This function
4559 * calls the driver's ->set_property callback and changes the software state of
4560 * the property if the callback succeeds.
4563 * Zero on success, error code on failure.
4565 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
4566 struct drm_property *property,
4570 struct drm_mode_object *obj = &plane->base;
4572 if (plane->funcs->set_property)
4573 ret = plane->funcs->set_property(plane, property, value);
4575 drm_object_property_set_value(obj, property, value);
4579 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
4582 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
4585 * @file_priv: DRM file info
4587 * This function retrieves the current value for an object's property. Compared
4588 * to the connector specific ioctl this one is extended to also work on crtc and
4591 * Called by the user via ioctl.
4594 * Zero on success, negative errno on failure.
4596 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
4597 struct drm_file *file_priv)
4599 struct drm_mode_obj_get_properties *arg = data;
4600 struct drm_mode_object *obj;
4603 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4606 drm_modeset_lock_all(dev);
4608 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4613 if (!obj->properties) {
4618 ret = get_properties(obj, file_priv->atomic,
4619 (uint32_t __user *)(unsigned long)(arg->props_ptr),
4620 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
4624 drm_modeset_unlock_all(dev);
4629 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
4632 * @file_priv: DRM file info
4634 * This function sets the current value for an object's property. It also calls
4635 * into a driver's ->set_property callback to update the hardware state.
4636 * Compared to the connector specific ioctl this one is extended to also work on
4637 * crtc and plane objects.
4639 * Called by the user via ioctl.
4642 * Zero on success, negative errno on failure.
4644 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
4645 struct drm_file *file_priv)
4647 struct drm_mode_obj_set_property *arg = data;
4648 struct drm_mode_object *arg_obj;
4649 struct drm_mode_object *prop_obj;
4650 struct drm_property *property;
4651 int i, ret = -EINVAL;
4652 struct drm_mode_object *ref;
4654 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4657 drm_modeset_lock_all(dev);
4659 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4664 if (!arg_obj->properties)
4667 for (i = 0; i < arg_obj->properties->count; i++)
4668 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
4671 if (i == arg_obj->properties->count)
4674 prop_obj = drm_mode_object_find(dev, arg->prop_id,
4675 DRM_MODE_OBJECT_PROPERTY);
4680 property = obj_to_property(prop_obj);
4682 if (!drm_property_change_valid_get(property, arg->value, &ref))
4685 switch (arg_obj->type) {
4686 case DRM_MODE_OBJECT_CONNECTOR:
4687 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
4690 case DRM_MODE_OBJECT_CRTC:
4691 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
4693 case DRM_MODE_OBJECT_PLANE:
4694 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
4695 property, arg->value);
4699 drm_property_change_valid_put(property, ref);
4702 drm_modeset_unlock_all(dev);
4707 * drm_mode_connector_attach_encoder - attach a connector to an encoder
4708 * @connector: connector to attach
4709 * @encoder: encoder to attach @connector to
4711 * This function links up a connector to an encoder. Note that the routing
4712 * restrictions between encoders and crtcs are exposed to userspace through the
4713 * possible_clones and possible_crtcs bitmasks.
4716 * Zero on success, negative errno on failure.
4718 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
4719 struct drm_encoder *encoder)
4723 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
4724 if (connector->encoder_ids[i] == 0) {
4725 connector->encoder_ids[i] = encoder->base.id;
4731 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
4734 * drm_mode_crtc_set_gamma_size - set the gamma table size
4735 * @crtc: CRTC to set the gamma table size for
4736 * @gamma_size: size of the gamma table
4738 * Drivers which support gamma tables should set this to the supported gamma
4739 * table size when initializing the CRTC. Currently the drm core only supports a
4740 * fixed gamma table size.
4743 * Zero on success, negative errno on failure.
4745 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
4748 crtc->gamma_size = gamma_size;
4750 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
4752 if (!crtc->gamma_store) {
4753 crtc->gamma_size = 0;
4759 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
4762 * drm_mode_gamma_set_ioctl - set the gamma table
4765 * @file_priv: DRM file info
4767 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
4768 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
4770 * Called by the user via ioctl.
4773 * Zero on success, negative errno on failure.
4775 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
4776 void *data, struct drm_file *file_priv)
4778 struct drm_mode_crtc_lut *crtc_lut = data;
4779 struct drm_crtc *crtc;
4780 void *r_base, *g_base, *b_base;
4784 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4787 drm_modeset_lock_all(dev);
4788 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4794 if (crtc->funcs->gamma_set == NULL) {
4799 /* memcpy into gamma store */
4800 if (crtc_lut->gamma_size != crtc->gamma_size) {
4805 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4806 r_base = crtc->gamma_store;
4807 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
4812 g_base = r_base + size;
4813 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
4818 b_base = g_base + size;
4819 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
4824 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
4827 drm_modeset_unlock_all(dev);
4833 * drm_mode_gamma_get_ioctl - get the gamma table
4836 * @file_priv: DRM file info
4838 * Copy the current gamma table into the storage provided. This also provides
4839 * the gamma table size the driver expects, which can be used to size the
4840 * allocated storage.
4842 * Called by the user via ioctl.
4845 * Zero on success, negative errno on failure.
4847 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
4848 void *data, struct drm_file *file_priv)
4850 struct drm_mode_crtc_lut *crtc_lut = data;
4851 struct drm_crtc *crtc;
4852 void *r_base, *g_base, *b_base;
4856 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4859 drm_modeset_lock_all(dev);
4860 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4866 /* memcpy into gamma store */
4867 if (crtc_lut->gamma_size != crtc->gamma_size) {
4872 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4873 r_base = crtc->gamma_store;
4874 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
4879 g_base = r_base + size;
4880 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
4885 b_base = g_base + size;
4886 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
4891 drm_modeset_unlock_all(dev);
4896 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4899 * @file_priv: DRM file info
4901 * This schedules an asynchronous update on a given CRTC, called page flip.
4902 * Optionally a drm event is generated to signal the completion of the event.
4903 * Generic drivers cannot assume that a pageflip with changed framebuffer
4904 * properties (including driver specific metadata like tiling layout) will work,
4905 * but some drivers support e.g. pixel format changes through the pageflip
4908 * Called by the user via ioctl.
4911 * Zero on success, negative errno on failure.
4913 int drm_mode_page_flip_ioctl(struct drm_device *dev,
4914 void *data, struct drm_file *file_priv)
4916 struct drm_mode_crtc_page_flip *page_flip = data;
4917 struct drm_crtc *crtc;
4918 struct drm_framebuffer *fb = NULL;
4919 struct drm_pending_vblank_event *e = NULL;
4920 unsigned long flags;
4923 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
4924 page_flip->reserved != 0)
4927 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
4930 crtc = drm_crtc_find(dev, page_flip->crtc_id);
4934 drm_modeset_lock_crtc(crtc, crtc->primary);
4935 if (crtc->primary->fb == NULL) {
4936 /* The framebuffer is currently unbound, presumably
4937 * due to a hotplug event, that userspace has not
4944 if (crtc->funcs->page_flip == NULL)
4947 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
4953 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
4957 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
4958 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4963 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4965 spin_lock_irqsave(&dev->event_lock, flags);
4966 if (file_priv->event_space < sizeof(e->event)) {
4967 spin_unlock_irqrestore(&dev->event_lock, flags);
4970 file_priv->event_space -= sizeof(e->event);
4971 spin_unlock_irqrestore(&dev->event_lock, flags);
4973 e = kzalloc(sizeof(*e), GFP_KERNEL);
4975 spin_lock_irqsave(&dev->event_lock, flags);
4976 file_priv->event_space += sizeof(e->event);
4977 spin_unlock_irqrestore(&dev->event_lock, flags);
4981 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
4982 e->event.base.length = sizeof(e->event);
4983 e->event.user_data = page_flip->user_data;
4984 e->base.event = &e->event.base;
4985 e->base.file_priv = file_priv;
4987 (void (*) (struct drm_pending_event *)) kfree;
4990 crtc->primary->old_fb = crtc->primary->fb;
4991 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
4993 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4994 spin_lock_irqsave(&dev->event_lock, flags);
4995 file_priv->event_space += sizeof(e->event);
4996 spin_unlock_irqrestore(&dev->event_lock, flags);
4999 /* Keep the old fb, don't unref it. */
5000 crtc->primary->old_fb = NULL;
5003 * Warn if the driver hasn't properly updated the crtc->fb
5004 * field to reflect that the new framebuffer is now used.
5005 * Failing to do so will screw with the reference counting
5008 WARN_ON(crtc->primary->fb != fb);
5009 /* Unref only the old framebuffer. */
5015 drm_framebuffer_unreference(fb);
5016 if (crtc->primary->old_fb)
5017 drm_framebuffer_unreference(crtc->primary->old_fb);
5018 crtc->primary->old_fb = NULL;
5019 drm_modeset_unlock_crtc(crtc);
5025 * drm_mode_config_reset - call ->reset callbacks
5028 * This functions calls all the crtc's, encoder's and connector's ->reset
5029 * callback. Drivers can use this in e.g. their driver load or resume code to
5030 * reset hardware and software state.
5032 void drm_mode_config_reset(struct drm_device *dev)
5034 struct drm_crtc *crtc;
5035 struct drm_plane *plane;
5036 struct drm_encoder *encoder;
5037 struct drm_connector *connector;
5039 list_for_each_entry(plane, &dev->mode_config.plane_list, head)
5040 if (plane->funcs->reset)
5041 plane->funcs->reset(plane);
5043 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
5044 if (crtc->funcs->reset)
5045 crtc->funcs->reset(crtc);
5047 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
5048 if (encoder->funcs->reset)
5049 encoder->funcs->reset(encoder);
5051 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
5052 connector->status = connector_status_unknown;
5054 if (connector->funcs->reset)
5055 connector->funcs->reset(connector);
5058 EXPORT_SYMBOL(drm_mode_config_reset);
5061 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
5064 * @file_priv: DRM file info
5066 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
5067 * TTM or something else entirely) and returns the resulting buffer handle. This
5068 * handle can then be wrapped up into a framebuffer modeset object.
5070 * Note that userspace is not allowed to use such objects for render
5071 * acceleration - drivers must create their own private ioctls for such a use
5074 * Called by the user via ioctl.
5077 * Zero on success, negative errno on failure.
5079 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
5080 void *data, struct drm_file *file_priv)
5082 struct drm_mode_create_dumb *args = data;
5083 u32 cpp, stride, size;
5085 if (!dev->driver->dumb_create)
5087 if (!args->width || !args->height || !args->bpp)
5090 /* overflow checks for 32bit size calculations */
5091 /* NOTE: DIV_ROUND_UP() can overflow */
5092 cpp = DIV_ROUND_UP(args->bpp, 8);
5093 if (!cpp || cpp > 0xffffffffU / args->width)
5095 stride = cpp * args->width;
5096 if (args->height > 0xffffffffU / stride)
5099 /* test for wrap-around */
5100 size = args->height * stride;
5101 if (PAGE_ALIGN(size) == 0)
5105 * handle, pitch and size are output parameters. Zero them out to
5106 * prevent drivers from accidentally using uninitialized data. Since
5107 * not all existing userspace is clearing these fields properly we
5108 * cannot reject IOCTL with garbage in them.
5114 return dev->driver->dumb_create(file_priv, dev, args);
5118 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5121 * @file_priv: DRM file info
5123 * Allocate an offset in the drm device node's address space to be able to
5124 * memory map a dumb buffer.
5126 * Called by the user via ioctl.
5129 * Zero on success, negative errno on failure.
5131 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5132 void *data, struct drm_file *file_priv)
5134 struct drm_mode_map_dumb *args = data;
5136 /* call driver ioctl to get mmap offset */
5137 if (!dev->driver->dumb_map_offset)
5140 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5144 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5147 * @file_priv: DRM file info
5149 * This destroys the userspace handle for the given dumb backing storage buffer.
5150 * Since buffer objects must be reference counted in the kernel a buffer object
5151 * won't be immediately freed if a framebuffer modeset object still uses it.
5153 * Called by the user via ioctl.
5156 * Zero on success, negative errno on failure.
5158 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5159 void *data, struct drm_file *file_priv)
5161 struct drm_mode_destroy_dumb *args = data;
5163 if (!dev->driver->dumb_destroy)
5166 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5170 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5171 * @format: pixel format (DRM_FORMAT_*)
5172 * @depth: storage for the depth value
5173 * @bpp: storage for the bpp value
5175 * This only supports RGB formats here for compat with code that doesn't use
5176 * pixel formats directly yet.
5178 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5183 case DRM_FORMAT_RGB332:
5184 case DRM_FORMAT_BGR233:
5188 case DRM_FORMAT_XRGB1555:
5189 case DRM_FORMAT_XBGR1555:
5190 case DRM_FORMAT_RGBX5551:
5191 case DRM_FORMAT_BGRX5551:
5192 case DRM_FORMAT_ARGB1555:
5193 case DRM_FORMAT_ABGR1555:
5194 case DRM_FORMAT_RGBA5551:
5195 case DRM_FORMAT_BGRA5551:
5199 case DRM_FORMAT_RGB565:
5200 case DRM_FORMAT_BGR565:
5204 case DRM_FORMAT_RGB888:
5205 case DRM_FORMAT_BGR888:
5209 case DRM_FORMAT_XRGB8888:
5210 case DRM_FORMAT_XBGR8888:
5211 case DRM_FORMAT_RGBX8888:
5212 case DRM_FORMAT_BGRX8888:
5216 case DRM_FORMAT_XRGB2101010:
5217 case DRM_FORMAT_XBGR2101010:
5218 case DRM_FORMAT_RGBX1010102:
5219 case DRM_FORMAT_BGRX1010102:
5220 case DRM_FORMAT_ARGB2101010:
5221 case DRM_FORMAT_ABGR2101010:
5222 case DRM_FORMAT_RGBA1010102:
5223 case DRM_FORMAT_BGRA1010102:
5227 case DRM_FORMAT_ARGB8888:
5228 case DRM_FORMAT_ABGR8888:
5229 case DRM_FORMAT_RGBA8888:
5230 case DRM_FORMAT_BGRA8888:
5235 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5236 drm_get_format_name(format));
5242 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5245 * drm_format_num_planes - get the number of planes for format
5246 * @format: pixel format (DRM_FORMAT_*)
5249 * The number of planes used by the specified pixel format.
5251 int drm_format_num_planes(uint32_t format)
5254 case DRM_FORMAT_YUV410:
5255 case DRM_FORMAT_YVU410:
5256 case DRM_FORMAT_YUV411:
5257 case DRM_FORMAT_YVU411:
5258 case DRM_FORMAT_YUV420:
5259 case DRM_FORMAT_YVU420:
5260 case DRM_FORMAT_YUV422:
5261 case DRM_FORMAT_YVU422:
5262 case DRM_FORMAT_YUV444:
5263 case DRM_FORMAT_YVU444:
5265 case DRM_FORMAT_NV12:
5266 case DRM_FORMAT_NV21:
5267 case DRM_FORMAT_NV16:
5268 case DRM_FORMAT_NV61:
5269 case DRM_FORMAT_NV24:
5270 case DRM_FORMAT_NV42:
5276 EXPORT_SYMBOL(drm_format_num_planes);
5279 * drm_format_plane_cpp - determine the bytes per pixel value
5280 * @format: pixel format (DRM_FORMAT_*)
5281 * @plane: plane index
5284 * The bytes per pixel value for the specified plane.
5286 int drm_format_plane_cpp(uint32_t format, int plane)
5291 if (plane >= drm_format_num_planes(format))
5295 case DRM_FORMAT_YUYV:
5296 case DRM_FORMAT_YVYU:
5297 case DRM_FORMAT_UYVY:
5298 case DRM_FORMAT_VYUY:
5300 case DRM_FORMAT_NV12:
5301 case DRM_FORMAT_NV21:
5302 case DRM_FORMAT_NV16:
5303 case DRM_FORMAT_NV61:
5304 case DRM_FORMAT_NV24:
5305 case DRM_FORMAT_NV42:
5306 return plane ? 2 : 1;
5307 case DRM_FORMAT_YUV410:
5308 case DRM_FORMAT_YVU410:
5309 case DRM_FORMAT_YUV411:
5310 case DRM_FORMAT_YVU411:
5311 case DRM_FORMAT_YUV420:
5312 case DRM_FORMAT_YVU420:
5313 case DRM_FORMAT_YUV422:
5314 case DRM_FORMAT_YVU422:
5315 case DRM_FORMAT_YUV444:
5316 case DRM_FORMAT_YVU444:
5319 drm_fb_get_bpp_depth(format, &depth, &bpp);
5323 EXPORT_SYMBOL(drm_format_plane_cpp);
5326 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5327 * @format: pixel format (DRM_FORMAT_*)
5330 * The horizontal chroma subsampling factor for the
5331 * specified pixel format.
5333 int drm_format_horz_chroma_subsampling(uint32_t format)
5336 case DRM_FORMAT_YUV411:
5337 case DRM_FORMAT_YVU411:
5338 case DRM_FORMAT_YUV410:
5339 case DRM_FORMAT_YVU410:
5341 case DRM_FORMAT_YUYV:
5342 case DRM_FORMAT_YVYU:
5343 case DRM_FORMAT_UYVY:
5344 case DRM_FORMAT_VYUY:
5345 case DRM_FORMAT_NV12:
5346 case DRM_FORMAT_NV21:
5347 case DRM_FORMAT_NV16:
5348 case DRM_FORMAT_NV61:
5349 case DRM_FORMAT_YUV422:
5350 case DRM_FORMAT_YVU422:
5351 case DRM_FORMAT_YUV420:
5352 case DRM_FORMAT_YVU420:
5358 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5361 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5362 * @format: pixel format (DRM_FORMAT_*)
5365 * The vertical chroma subsampling factor for the
5366 * specified pixel format.
5368 int drm_format_vert_chroma_subsampling(uint32_t format)
5371 case DRM_FORMAT_YUV410:
5372 case DRM_FORMAT_YVU410:
5374 case DRM_FORMAT_YUV420:
5375 case DRM_FORMAT_YVU420:
5376 case DRM_FORMAT_NV12:
5377 case DRM_FORMAT_NV21:
5383 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5386 * drm_rotation_simplify() - Try to simplify the rotation
5387 * @rotation: Rotation to be simplified
5388 * @supported_rotations: Supported rotations
5390 * Attempt to simplify the rotation to a form that is supported.
5391 * Eg. if the hardware supports everything except DRM_REFLECT_X
5392 * one could call this function like this:
5394 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5395 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5396 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5398 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5399 * transforms the hardware supports, this function may not
5400 * be able to produce a supported transform, so the caller should
5401 * check the result afterwards.
5403 unsigned int drm_rotation_simplify(unsigned int rotation,
5404 unsigned int supported_rotations)
5406 if (rotation & ~supported_rotations) {
5407 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5408 rotation = (rotation & ~0xf) | BIT((ffs(rotation & 0xf) + 1) % 4);
5413 EXPORT_SYMBOL(drm_rotation_simplify);
5416 * drm_mode_config_init - initialize DRM mode_configuration structure
5419 * Initialize @dev's mode_config structure, used for tracking the graphics
5420 * configuration of @dev.
5422 * Since this initializes the modeset locks, no locking is possible. Which is no
5423 * problem, since this should happen single threaded at init time. It is the
5424 * driver's problem to ensure this guarantee.
5427 void drm_mode_config_init(struct drm_device *dev)
5429 mutex_init(&dev->mode_config.mutex);
5430 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5431 mutex_init(&dev->mode_config.idr_mutex);
5432 mutex_init(&dev->mode_config.fb_lock);
5433 INIT_LIST_HEAD(&dev->mode_config.fb_list);
5434 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5435 INIT_LIST_HEAD(&dev->mode_config.connector_list);
5436 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5437 INIT_LIST_HEAD(&dev->mode_config.property_list);
5438 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5439 INIT_LIST_HEAD(&dev->mode_config.plane_list);
5440 idr_init(&dev->mode_config.crtc_idr);
5441 idr_init(&dev->mode_config.tile_idr);
5443 drm_modeset_lock_all(dev);
5444 drm_mode_create_standard_properties(dev);
5445 drm_modeset_unlock_all(dev);
5447 /* Just to be sure */
5448 dev->mode_config.num_fb = 0;
5449 dev->mode_config.num_connector = 0;
5450 dev->mode_config.num_crtc = 0;
5451 dev->mode_config.num_encoder = 0;
5452 dev->mode_config.num_overlay_plane = 0;
5453 dev->mode_config.num_total_plane = 0;
5455 EXPORT_SYMBOL(drm_mode_config_init);
5458 * drm_mode_config_cleanup - free up DRM mode_config info
5461 * Free up all the connectors and CRTCs associated with this DRM device, then
5462 * free up the framebuffers and associated buffer objects.
5464 * Note that since this /should/ happen single-threaded at driver/device
5465 * teardown time, no locking is required. It's the driver's job to ensure that
5466 * this guarantee actually holds true.
5468 * FIXME: cleanup any dangling user buffer objects too
5470 void drm_mode_config_cleanup(struct drm_device *dev)
5472 struct drm_connector *connector, *ot;
5473 struct drm_crtc *crtc, *ct;
5474 struct drm_encoder *encoder, *enct;
5475 struct drm_framebuffer *fb, *fbt;
5476 struct drm_property *property, *pt;
5477 struct drm_property_blob *blob, *bt;
5478 struct drm_plane *plane, *plt;
5480 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5482 encoder->funcs->destroy(encoder);
5485 list_for_each_entry_safe(connector, ot,
5486 &dev->mode_config.connector_list, head) {
5487 connector->funcs->destroy(connector);
5490 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5492 drm_property_destroy(dev, property);
5495 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
5497 drm_property_destroy_blob(dev, blob);
5501 * Single-threaded teardown context, so it's not required to grab the
5502 * fb_lock to protect against concurrent fb_list access. Contrary, it
5503 * would actually deadlock with the drm_framebuffer_cleanup function.
5505 * Also, if there are any framebuffers left, that's a driver leak now,
5506 * so politely WARN about this.
5508 WARN_ON(!list_empty(&dev->mode_config.fb_list));
5509 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
5510 drm_framebuffer_remove(fb);
5513 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
5515 plane->funcs->destroy(plane);
5518 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
5519 crtc->funcs->destroy(crtc);
5522 idr_destroy(&dev->mode_config.tile_idr);
5523 idr_destroy(&dev->mode_config.crtc_idr);
5524 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
5526 EXPORT_SYMBOL(drm_mode_config_cleanup);
5528 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
5529 unsigned int supported_rotations)
5531 static const struct drm_prop_enum_list props[] = {
5532 { DRM_ROTATE_0, "rotate-0" },
5533 { DRM_ROTATE_90, "rotate-90" },
5534 { DRM_ROTATE_180, "rotate-180" },
5535 { DRM_ROTATE_270, "rotate-270" },
5536 { DRM_REFLECT_X, "reflect-x" },
5537 { DRM_REFLECT_Y, "reflect-y" },
5540 return drm_property_create_bitmask(dev, 0, "rotation",
5541 props, ARRAY_SIZE(props),
5542 supported_rotations);
5544 EXPORT_SYMBOL(drm_mode_create_rotation_property);
5549 * Tile groups are used to represent tiled monitors with a unique
5550 * integer identifier. Tiled monitors using DisplayID v1.3 have
5551 * a unique 8-byte handle, we store this in a tile group, so we
5552 * have a common identifier for all tiles in a monitor group.
5554 static void drm_tile_group_free(struct kref *kref)
5556 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
5557 struct drm_device *dev = tg->dev;
5558 mutex_lock(&dev->mode_config.idr_mutex);
5559 idr_remove(&dev->mode_config.tile_idr, tg->id);
5560 mutex_unlock(&dev->mode_config.idr_mutex);
5565 * drm_mode_put_tile_group - drop a reference to a tile group.
5567 * @tg: tile group to drop reference to.
5569 * drop reference to tile group and free if 0.
5571 void drm_mode_put_tile_group(struct drm_device *dev,
5572 struct drm_tile_group *tg)
5574 kref_put(&tg->refcount, drm_tile_group_free);
5578 * drm_mode_get_tile_group - get a reference to an existing tile group
5580 * @topology: 8-bytes unique per monitor.
5582 * Use the unique bytes to get a reference to an existing tile group.
5585 * tile group or NULL if not found.
5587 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
5590 struct drm_tile_group *tg;
5592 mutex_lock(&dev->mode_config.idr_mutex);
5593 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
5594 if (!memcmp(tg->group_data, topology, 8)) {
5595 if (!kref_get_unless_zero(&tg->refcount))
5597 mutex_unlock(&dev->mode_config.idr_mutex);
5601 mutex_unlock(&dev->mode_config.idr_mutex);
5604 EXPORT_SYMBOL(drm_mode_get_tile_group);
5607 * drm_mode_create_tile_group - create a tile group from a displayid description
5609 * @topology: 8-bytes unique per monitor.
5611 * Create a tile group for the unique monitor, and get a unique
5612 * identifier for the tile group.
5615 * new tile group or error.
5617 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
5620 struct drm_tile_group *tg;
5623 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
5625 return ERR_PTR(-ENOMEM);
5627 kref_init(&tg->refcount);
5628 memcpy(tg->group_data, topology, 8);
5631 mutex_lock(&dev->mode_config.idr_mutex);
5632 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
5640 mutex_unlock(&dev->mode_config.idr_mutex);
5643 EXPORT_SYMBOL(drm_mode_create_tile_group);