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 *add_framebuffer_internal(struct drm_device *dev,
47 struct drm_mode_fb_cmd2 *r,
48 struct drm_file *file_priv);
50 /* Avoid boilerplate. I'm tired of typing. */
51 #define DRM_ENUM_NAME_FN(fnname, list) \
52 const char *fnname(int val) \
55 for (i = 0; i < ARRAY_SIZE(list); i++) { \
56 if (list[i].type == val) \
57 return list[i].name; \
65 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
66 { DRM_MODE_DPMS_ON, "On" },
67 { DRM_MODE_DPMS_STANDBY, "Standby" },
68 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
69 { DRM_MODE_DPMS_OFF, "Off" }
72 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
74 static const struct drm_prop_enum_list drm_plane_type_enum_list[] = {
75 { DRM_PLANE_TYPE_OVERLAY, "Overlay" },
76 { DRM_PLANE_TYPE_PRIMARY, "Primary" },
77 { DRM_PLANE_TYPE_CURSOR, "Cursor" },
83 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
84 { DRM_MODE_SCALE_NONE, "None" },
85 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
86 { DRM_MODE_SCALE_CENTER, "Center" },
87 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
90 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
91 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
92 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
93 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
97 * Non-global properties, but "required" for certain connectors.
99 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
100 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
101 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
102 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
105 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
107 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
108 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
109 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
110 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
113 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
114 drm_dvi_i_subconnector_enum_list)
116 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
117 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
118 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
119 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
120 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
121 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
124 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
126 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
127 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
128 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
129 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
130 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
131 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
134 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
135 drm_tv_subconnector_enum_list)
137 static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
138 { DRM_MODE_DIRTY_OFF, "Off" },
139 { DRM_MODE_DIRTY_ON, "On" },
140 { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
143 struct drm_conn_prop_enum_list {
150 * Connector and encoder types.
152 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
153 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
154 { DRM_MODE_CONNECTOR_VGA, "VGA" },
155 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
156 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
157 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
158 { DRM_MODE_CONNECTOR_Composite, "Composite" },
159 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
160 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
161 { DRM_MODE_CONNECTOR_Component, "Component" },
162 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
163 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
164 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
165 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
166 { DRM_MODE_CONNECTOR_TV, "TV" },
167 { DRM_MODE_CONNECTOR_eDP, "eDP" },
168 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
169 { DRM_MODE_CONNECTOR_DSI, "DSI" },
172 static const struct drm_prop_enum_list drm_encoder_enum_list[] = {
173 { DRM_MODE_ENCODER_NONE, "None" },
174 { DRM_MODE_ENCODER_DAC, "DAC" },
175 { DRM_MODE_ENCODER_TMDS, "TMDS" },
176 { DRM_MODE_ENCODER_LVDS, "LVDS" },
177 { DRM_MODE_ENCODER_TVDAC, "TV" },
178 { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
179 { DRM_MODE_ENCODER_DSI, "DSI" },
180 { DRM_MODE_ENCODER_DPMST, "DP MST" },
183 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
184 { SubPixelUnknown, "Unknown" },
185 { SubPixelHorizontalRGB, "Horizontal RGB" },
186 { SubPixelHorizontalBGR, "Horizontal BGR" },
187 { SubPixelVerticalRGB, "Vertical RGB" },
188 { SubPixelVerticalBGR, "Vertical BGR" },
189 { SubPixelNone, "None" },
192 void drm_connector_ida_init(void)
196 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
197 ida_init(&drm_connector_enum_list[i].ida);
200 void drm_connector_ida_destroy(void)
204 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
205 ida_destroy(&drm_connector_enum_list[i].ida);
209 * drm_get_connector_status_name - return a string for connector status
210 * @status: connector status to compute name of
212 * In contrast to the other drm_get_*_name functions this one here returns a
213 * const pointer and hence is threadsafe.
215 const char *drm_get_connector_status_name(enum drm_connector_status status)
217 if (status == connector_status_connected)
219 else if (status == connector_status_disconnected)
220 return "disconnected";
224 EXPORT_SYMBOL(drm_get_connector_status_name);
227 * drm_get_subpixel_order_name - return a string for a given subpixel enum
228 * @order: enum of subpixel_order
230 * Note you could abuse this and return something out of bounds, but that
231 * would be a caller error. No unscrubbed user data should make it here.
233 const char *drm_get_subpixel_order_name(enum subpixel_order order)
235 return drm_subpixel_enum_list[order].name;
237 EXPORT_SYMBOL(drm_get_subpixel_order_name);
239 static char printable_char(int c)
241 return isascii(c) && isprint(c) ? c : '?';
245 * drm_get_format_name - return a string for drm fourcc format
246 * @format: format to compute name of
248 * Note that the buffer used by this function is globally shared and owned by
249 * the function itself.
251 * FIXME: This isn't really multithreading safe.
253 const char *drm_get_format_name(uint32_t format)
257 snprintf(buf, sizeof(buf),
258 "%c%c%c%c %s-endian (0x%08x)",
259 printable_char(format & 0xff),
260 printable_char((format >> 8) & 0xff),
261 printable_char((format >> 16) & 0xff),
262 printable_char((format >> 24) & 0x7f),
263 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
268 EXPORT_SYMBOL(drm_get_format_name);
271 * Internal function to assign a slot in the object idr and optionally
272 * register the object into the idr.
274 static int drm_mode_object_get_reg(struct drm_device *dev,
275 struct drm_mode_object *obj,
281 mutex_lock(&dev->mode_config.idr_mutex);
282 ret = idr_alloc(&dev->mode_config.crtc_idr, register_obj ? obj : NULL, 1, 0, GFP_KERNEL);
285 * Set up the object linking under the protection of the idr
286 * lock so that other users can't see inconsistent state.
289 obj->type = obj_type;
291 mutex_unlock(&dev->mode_config.idr_mutex);
293 return ret < 0 ? ret : 0;
297 * drm_mode_object_get - allocate a new modeset identifier
299 * @obj: object pointer, used to generate unique ID
300 * @obj_type: object type
302 * Create a unique identifier based on @ptr in @dev's identifier space. Used
303 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
304 * modeset identifiers are _not_ reference counted. Hence don't use this for
305 * reference counted modeset objects like framebuffers.
308 * New unique (relative to other objects in @dev) integer identifier for the
311 int drm_mode_object_get(struct drm_device *dev,
312 struct drm_mode_object *obj, uint32_t obj_type)
314 return drm_mode_object_get_reg(dev, obj, obj_type, true);
317 static void drm_mode_object_register(struct drm_device *dev,
318 struct drm_mode_object *obj)
320 mutex_lock(&dev->mode_config.idr_mutex);
321 idr_replace(&dev->mode_config.crtc_idr, obj, obj->id);
322 mutex_unlock(&dev->mode_config.idr_mutex);
326 * drm_mode_object_put - free a modeset identifer
328 * @object: object to free
330 * Free @id from @dev's unique identifier pool. Note that despite the _get
331 * postfix modeset identifiers are _not_ reference counted. Hence don't use this
332 * for reference counted modeset objects like framebuffers.
334 void drm_mode_object_put(struct drm_device *dev,
335 struct drm_mode_object *object)
337 mutex_lock(&dev->mode_config.idr_mutex);
338 idr_remove(&dev->mode_config.crtc_idr, object->id);
339 mutex_unlock(&dev->mode_config.idr_mutex);
342 static struct drm_mode_object *_object_find(struct drm_device *dev,
343 uint32_t id, uint32_t type)
345 struct drm_mode_object *obj = NULL;
347 mutex_lock(&dev->mode_config.idr_mutex);
348 obj = idr_find(&dev->mode_config.crtc_idr, id);
349 if (obj && type != DRM_MODE_OBJECT_ANY && obj->type != type)
351 if (obj && obj->id != id)
353 /* don't leak out unref'd fb's */
354 if (obj && (obj->type == DRM_MODE_OBJECT_FB))
356 mutex_unlock(&dev->mode_config.idr_mutex);
362 * drm_mode_object_find - look up a drm object with static lifetime
364 * @id: id of the mode object
365 * @type: type of the mode object
367 * Note that framebuffers cannot be looked up with this functions - since those
368 * are reference counted, they need special treatment. Even with
369 * DRM_MODE_OBJECT_ANY (although that will simply return NULL
370 * rather than WARN_ON()).
372 struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
373 uint32_t id, uint32_t type)
375 struct drm_mode_object *obj = NULL;
377 /* Framebuffers are reference counted and need their own lookup
379 WARN_ON(type == DRM_MODE_OBJECT_FB);
380 obj = _object_find(dev, id, type);
383 EXPORT_SYMBOL(drm_mode_object_find);
386 * drm_framebuffer_init - initialize a framebuffer
388 * @fb: framebuffer to be initialized
389 * @funcs: ... with these functions
391 * Allocates an ID for the framebuffer's parent mode object, sets its mode
392 * functions & device file and adds it to the master fd list.
395 * This functions publishes the fb and makes it available for concurrent access
396 * by other users. Which means by this point the fb _must_ be fully set up -
397 * since all the fb attributes are invariant over its lifetime, no further
398 * locking but only correct reference counting is required.
401 * Zero on success, error code on failure.
403 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
404 const struct drm_framebuffer_funcs *funcs)
408 mutex_lock(&dev->mode_config.fb_lock);
409 kref_init(&fb->refcount);
410 INIT_LIST_HEAD(&fb->filp_head);
414 ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
418 dev->mode_config.num_fb++;
419 list_add(&fb->head, &dev->mode_config.fb_list);
421 mutex_unlock(&dev->mode_config.fb_lock);
425 EXPORT_SYMBOL(drm_framebuffer_init);
427 /* dev->mode_config.fb_lock must be held! */
428 static void __drm_framebuffer_unregister(struct drm_device *dev,
429 struct drm_framebuffer *fb)
431 mutex_lock(&dev->mode_config.idr_mutex);
432 idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
433 mutex_unlock(&dev->mode_config.idr_mutex);
438 static void drm_framebuffer_free(struct kref *kref)
440 struct drm_framebuffer *fb =
441 container_of(kref, struct drm_framebuffer, refcount);
442 struct drm_device *dev = fb->dev;
445 * The lookup idr holds a weak reference, which has not necessarily been
446 * removed at this point. Check for that.
448 mutex_lock(&dev->mode_config.fb_lock);
450 /* Mark fb as reaped and drop idr ref. */
451 __drm_framebuffer_unregister(dev, fb);
453 mutex_unlock(&dev->mode_config.fb_lock);
455 fb->funcs->destroy(fb);
458 static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
461 struct drm_mode_object *obj = NULL;
462 struct drm_framebuffer *fb;
464 mutex_lock(&dev->mode_config.idr_mutex);
465 obj = idr_find(&dev->mode_config.crtc_idr, id);
466 if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
470 mutex_unlock(&dev->mode_config.idr_mutex);
476 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
478 * @id: id of the fb object
480 * If successful, this grabs an additional reference to the framebuffer -
481 * callers need to make sure to eventually unreference the returned framebuffer
482 * again, using @drm_framebuffer_unreference.
484 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
487 struct drm_framebuffer *fb;
489 mutex_lock(&dev->mode_config.fb_lock);
490 fb = __drm_framebuffer_lookup(dev, id);
492 if (!kref_get_unless_zero(&fb->refcount))
495 mutex_unlock(&dev->mode_config.fb_lock);
499 EXPORT_SYMBOL(drm_framebuffer_lookup);
502 * drm_framebuffer_unreference - unref a framebuffer
503 * @fb: framebuffer to unref
505 * This functions decrements the fb's refcount and frees it if it drops to zero.
507 void drm_framebuffer_unreference(struct drm_framebuffer *fb)
509 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
510 kref_put(&fb->refcount, drm_framebuffer_free);
512 EXPORT_SYMBOL(drm_framebuffer_unreference);
515 * drm_framebuffer_reference - incr the fb refcnt
518 * This functions increments the fb's refcount.
520 void drm_framebuffer_reference(struct drm_framebuffer *fb)
522 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
523 kref_get(&fb->refcount);
525 EXPORT_SYMBOL(drm_framebuffer_reference);
527 static void drm_framebuffer_free_bug(struct kref *kref)
532 static void __drm_framebuffer_unreference(struct drm_framebuffer *fb)
534 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
535 kref_put(&fb->refcount, drm_framebuffer_free_bug);
539 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
540 * @fb: fb to unregister
542 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
543 * those used for fbdev. Note that the caller must hold a reference of it's own,
544 * i.e. the object may not be destroyed through this call (since it'll lead to a
545 * locking inversion).
547 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
549 struct drm_device *dev = fb->dev;
551 mutex_lock(&dev->mode_config.fb_lock);
552 /* Mark fb as reaped and drop idr ref. */
553 __drm_framebuffer_unregister(dev, fb);
554 mutex_unlock(&dev->mode_config.fb_lock);
556 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
559 * drm_framebuffer_cleanup - remove a framebuffer object
560 * @fb: framebuffer to remove
562 * Cleanup framebuffer. This function is intended to be used from the drivers
563 * ->destroy callback. It can also be used to clean up driver private
564 * framebuffers embedded into a larger structure.
566 * Note that this function does not remove the fb from active usuage - if it is
567 * still used anywhere, hilarity can ensue since userspace could call getfb on
568 * the id and get back -EINVAL. Obviously no concern at driver unload time.
570 * Also, the framebuffer will not be removed from the lookup idr - for
571 * user-created framebuffers this will happen in in the rmfb ioctl. For
572 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
573 * drm_framebuffer_unregister_private.
575 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
577 struct drm_device *dev = fb->dev;
579 mutex_lock(&dev->mode_config.fb_lock);
581 dev->mode_config.num_fb--;
582 mutex_unlock(&dev->mode_config.fb_lock);
584 EXPORT_SYMBOL(drm_framebuffer_cleanup);
587 * drm_framebuffer_remove - remove and unreference a framebuffer object
588 * @fb: framebuffer to remove
590 * Scans all the CRTCs and planes in @dev's mode_config. If they're
591 * using @fb, removes it, setting it to NULL. Then drops the reference to the
592 * passed-in framebuffer. Might take the modeset locks.
594 * Note that this function optimizes the cleanup away if the caller holds the
595 * last reference to the framebuffer. It is also guaranteed to not take the
596 * modeset locks in this case.
598 void drm_framebuffer_remove(struct drm_framebuffer *fb)
600 struct drm_device *dev = fb->dev;
601 struct drm_crtc *crtc;
602 struct drm_plane *plane;
603 struct drm_mode_set set;
606 WARN_ON(!list_empty(&fb->filp_head));
609 * drm ABI mandates that we remove any deleted framebuffers from active
610 * useage. But since most sane clients only remove framebuffers they no
611 * longer need, try to optimize this away.
613 * Since we're holding a reference ourselves, observing a refcount of 1
614 * means that we're the last holder and can skip it. Also, the refcount
615 * can never increase from 1 again, so we don't need any barriers or
618 * Note that userspace could try to race with use and instate a new
619 * usage _after_ we've cleared all current ones. End result will be an
620 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
623 if (atomic_read(&fb->refcount.refcount) > 1) {
624 drm_modeset_lock_all(dev);
625 /* remove from any CRTC */
626 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
627 if (crtc->primary->fb == fb) {
628 /* should turn off the crtc */
629 memset(&set, 0, sizeof(struct drm_mode_set));
632 ret = drm_mode_set_config_internal(&set);
634 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
638 list_for_each_entry(plane, &dev->mode_config.plane_list, head) {
640 drm_plane_force_disable(plane);
642 drm_modeset_unlock_all(dev);
645 drm_framebuffer_unreference(fb);
647 EXPORT_SYMBOL(drm_framebuffer_remove);
649 DEFINE_WW_CLASS(crtc_ww_class);
652 * drm_crtc_init_with_planes - Initialise a new CRTC object with
653 * specified primary and cursor planes.
655 * @crtc: CRTC object to init
656 * @primary: Primary plane for CRTC
657 * @cursor: Cursor plane for CRTC
658 * @funcs: callbacks for the new CRTC
660 * Inits a new object created as base part of a driver crtc object.
663 * Zero on success, error code on failure.
665 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
666 struct drm_plane *primary,
667 struct drm_plane *cursor,
668 const struct drm_crtc_funcs *funcs)
670 struct drm_mode_config *config = &dev->mode_config;
675 crtc->invert_dimensions = false;
677 drm_modeset_lock_init(&crtc->mutex);
678 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
682 crtc->base.properties = &crtc->properties;
684 list_add_tail(&crtc->head, &config->crtc_list);
687 crtc->primary = primary;
688 crtc->cursor = cursor;
690 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
692 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
694 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
695 drm_object_attach_property(&crtc->base, config->prop_active, 0);
700 EXPORT_SYMBOL(drm_crtc_init_with_planes);
703 * drm_crtc_cleanup - Clean up the core crtc usage
704 * @crtc: CRTC to cleanup
706 * This function cleans up @crtc and removes it from the DRM mode setting
707 * core. Note that the function does *not* free the crtc structure itself,
708 * this is the responsibility of the caller.
710 void drm_crtc_cleanup(struct drm_crtc *crtc)
712 struct drm_device *dev = crtc->dev;
714 kfree(crtc->gamma_store);
715 crtc->gamma_store = NULL;
717 drm_modeset_lock_fini(&crtc->mutex);
719 drm_mode_object_put(dev, &crtc->base);
720 list_del(&crtc->head);
721 dev->mode_config.num_crtc--;
723 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
724 if (crtc->state && crtc->funcs->atomic_destroy_state)
725 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
727 memset(crtc, 0, sizeof(*crtc));
729 EXPORT_SYMBOL(drm_crtc_cleanup);
732 * drm_crtc_index - find the index of a registered CRTC
733 * @crtc: CRTC to find index for
735 * Given a registered CRTC, return the index of that CRTC within a DRM
736 * device's list of CRTCs.
738 unsigned int drm_crtc_index(struct drm_crtc *crtc)
740 unsigned int index = 0;
741 struct drm_crtc *tmp;
743 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
752 EXPORT_SYMBOL(drm_crtc_index);
755 * drm_mode_remove - remove and free a mode
756 * @connector: connector list to modify
757 * @mode: mode to remove
759 * Remove @mode from @connector's mode list, then free it.
761 static void drm_mode_remove(struct drm_connector *connector,
762 struct drm_display_mode *mode)
764 list_del(&mode->head);
765 drm_mode_destroy(connector->dev, mode);
769 * drm_display_info_set_bus_formats - set the supported bus formats
770 * @info: display info to store bus formats in
771 * @fmts: array containing the supported bus formats
772 * @nfmts: the number of entries in the fmts array
774 * Store the supported bus formats in display info structure.
775 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
776 * a full list of available formats.
778 int drm_display_info_set_bus_formats(struct drm_display_info *info,
780 unsigned int num_formats)
784 if (!formats && num_formats)
787 if (formats && num_formats) {
788 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
794 kfree(info->bus_formats);
795 info->bus_formats = fmts;
796 info->num_bus_formats = num_formats;
800 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
803 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
804 * @connector: connector to quwery
806 * The kernel supports per-connector configration of its consoles through
807 * use of the video= parameter. This function parses that option and
808 * extracts the user's specified mode (or enable/disable status) for a
809 * particular connector. This is typically only used during the early fbdev
812 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
814 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
817 if (fb_get_options(connector->name, &option))
820 if (!drm_mode_parse_command_line_for_connector(option,
828 switch (mode->force) {
832 case DRM_FORCE_ON_DIGITAL:
841 DRM_INFO("forcing %s connector %s\n", connector->name, s);
842 connector->force = mode->force;
845 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
847 mode->xres, mode->yres,
848 mode->refresh_specified ? mode->refresh : 60,
849 mode->rb ? " reduced blanking" : "",
850 mode->margins ? " with margins" : "",
851 mode->interlace ? " interlaced" : "");
855 * drm_connector_init - Init a preallocated connector
857 * @connector: the connector to init
858 * @funcs: callbacks for this connector
859 * @connector_type: user visible type of the connector
861 * Initialises a preallocated connector. Connectors should be
862 * subclassed as part of driver connector objects.
865 * Zero on success, error code on failure.
867 int drm_connector_init(struct drm_device *dev,
868 struct drm_connector *connector,
869 const struct drm_connector_funcs *funcs,
872 struct drm_mode_config *config = &dev->mode_config;
874 struct ida *connector_ida =
875 &drm_connector_enum_list[connector_type].ida;
877 drm_modeset_lock_all(dev);
879 ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
883 connector->base.properties = &connector->properties;
884 connector->dev = dev;
885 connector->funcs = funcs;
886 connector->connector_type = connector_type;
887 connector->connector_type_id =
888 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
889 if (connector->connector_type_id < 0) {
890 ret = connector->connector_type_id;
894 kasprintf(GFP_KERNEL, "%s-%d",
895 drm_connector_enum_list[connector_type].name,
896 connector->connector_type_id);
897 if (!connector->name) {
902 INIT_LIST_HEAD(&connector->probed_modes);
903 INIT_LIST_HEAD(&connector->modes);
904 connector->edid_blob_ptr = NULL;
905 connector->status = connector_status_unknown;
907 drm_connector_get_cmdline_mode(connector);
909 /* We should add connectors at the end to avoid upsetting the connector
911 list_add_tail(&connector->head, &config->connector_list);
912 config->num_connector++;
914 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
915 drm_object_attach_property(&connector->base,
916 config->edid_property,
919 drm_object_attach_property(&connector->base,
920 config->dpms_property, 0);
922 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
923 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
926 connector->debugfs_entry = NULL;
930 drm_mode_object_put(dev, &connector->base);
933 drm_modeset_unlock_all(dev);
937 EXPORT_SYMBOL(drm_connector_init);
940 * drm_connector_cleanup - cleans up an initialised connector
941 * @connector: connector to cleanup
943 * Cleans up the connector but doesn't free the object.
945 void drm_connector_cleanup(struct drm_connector *connector)
947 struct drm_device *dev = connector->dev;
948 struct drm_display_mode *mode, *t;
950 if (connector->tile_group) {
951 drm_mode_put_tile_group(dev, connector->tile_group);
952 connector->tile_group = NULL;
955 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
956 drm_mode_remove(connector, mode);
958 list_for_each_entry_safe(mode, t, &connector->modes, head)
959 drm_mode_remove(connector, mode);
961 ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
962 connector->connector_type_id);
964 kfree(connector->display_info.bus_formats);
965 drm_mode_object_put(dev, &connector->base);
966 kfree(connector->name);
967 connector->name = NULL;
968 list_del(&connector->head);
969 dev->mode_config.num_connector--;
971 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
972 if (connector->state && connector->funcs->atomic_destroy_state)
973 connector->funcs->atomic_destroy_state(connector,
976 memset(connector, 0, sizeof(*connector));
978 EXPORT_SYMBOL(drm_connector_cleanup);
981 * drm_connector_index - find the index of a registered connector
982 * @connector: connector to find index for
984 * Given a registered connector, return the index of that connector within a DRM
985 * device's list of connectors.
987 unsigned int drm_connector_index(struct drm_connector *connector)
989 unsigned int index = 0;
990 struct drm_connector *tmp;
991 struct drm_mode_config *config = &connector->dev->mode_config;
993 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
995 list_for_each_entry(tmp, &connector->dev->mode_config.connector_list, head) {
996 if (tmp == connector)
1004 EXPORT_SYMBOL(drm_connector_index);
1007 * drm_connector_register - register a connector
1008 * @connector: the connector to register
1010 * Register userspace interfaces for a connector
1013 * Zero on success, error code on failure.
1015 int drm_connector_register(struct drm_connector *connector)
1019 drm_mode_object_register(connector->dev, &connector->base);
1021 ret = drm_sysfs_connector_add(connector);
1025 ret = drm_debugfs_connector_add(connector);
1027 drm_sysfs_connector_remove(connector);
1033 EXPORT_SYMBOL(drm_connector_register);
1036 * drm_connector_unregister - unregister a connector
1037 * @connector: the connector to unregister
1039 * Unregister userspace interfaces for a connector
1041 void drm_connector_unregister(struct drm_connector *connector)
1043 drm_sysfs_connector_remove(connector);
1044 drm_debugfs_connector_remove(connector);
1046 EXPORT_SYMBOL(drm_connector_unregister);
1050 * drm_connector_unplug_all - unregister connector userspace interfaces
1053 * This function unregisters all connector userspace interfaces in sysfs. Should
1054 * be call when the device is disconnected, e.g. from an usb driver's
1055 * ->disconnect callback.
1057 void drm_connector_unplug_all(struct drm_device *dev)
1059 struct drm_connector *connector;
1061 /* taking the mode config mutex ends up in a clash with sysfs */
1062 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1063 drm_connector_unregister(connector);
1066 EXPORT_SYMBOL(drm_connector_unplug_all);
1069 * drm_bridge_init - initialize a drm transcoder/bridge
1071 * @bridge: transcoder/bridge to set up
1072 * @funcs: bridge function table
1074 * Initialises a preallocated bridge. Bridges should be
1075 * subclassed as part of driver connector objects.
1078 * Zero on success, error code on failure.
1080 int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
1081 const struct drm_bridge_funcs *funcs)
1085 drm_modeset_lock_all(dev);
1087 ret = drm_mode_object_get(dev, &bridge->base, DRM_MODE_OBJECT_BRIDGE);
1092 bridge->funcs = funcs;
1094 list_add_tail(&bridge->head, &dev->mode_config.bridge_list);
1095 dev->mode_config.num_bridge++;
1098 drm_modeset_unlock_all(dev);
1101 EXPORT_SYMBOL(drm_bridge_init);
1104 * drm_bridge_cleanup - cleans up an initialised bridge
1105 * @bridge: bridge to cleanup
1107 * Cleans up the bridge but doesn't free the object.
1109 void drm_bridge_cleanup(struct drm_bridge *bridge)
1111 struct drm_device *dev = bridge->dev;
1113 drm_modeset_lock_all(dev);
1114 drm_mode_object_put(dev, &bridge->base);
1115 list_del(&bridge->head);
1116 dev->mode_config.num_bridge--;
1117 drm_modeset_unlock_all(dev);
1119 memset(bridge, 0, sizeof(*bridge));
1121 EXPORT_SYMBOL(drm_bridge_cleanup);
1124 * drm_encoder_init - Init a preallocated encoder
1126 * @encoder: the encoder to init
1127 * @funcs: callbacks for this encoder
1128 * @encoder_type: user visible type of the encoder
1130 * Initialises a preallocated encoder. Encoder should be
1131 * subclassed as part of driver encoder objects.
1134 * Zero on success, error code on failure.
1136 int drm_encoder_init(struct drm_device *dev,
1137 struct drm_encoder *encoder,
1138 const struct drm_encoder_funcs *funcs,
1143 drm_modeset_lock_all(dev);
1145 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1150 encoder->encoder_type = encoder_type;
1151 encoder->funcs = funcs;
1152 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1153 drm_encoder_enum_list[encoder_type].name,
1155 if (!encoder->name) {
1160 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1161 dev->mode_config.num_encoder++;
1165 drm_mode_object_put(dev, &encoder->base);
1168 drm_modeset_unlock_all(dev);
1172 EXPORT_SYMBOL(drm_encoder_init);
1175 * drm_encoder_cleanup - cleans up an initialised encoder
1176 * @encoder: encoder to cleanup
1178 * Cleans up the encoder but doesn't free the object.
1180 void drm_encoder_cleanup(struct drm_encoder *encoder)
1182 struct drm_device *dev = encoder->dev;
1184 drm_modeset_lock_all(dev);
1185 drm_mode_object_put(dev, &encoder->base);
1186 kfree(encoder->name);
1187 list_del(&encoder->head);
1188 dev->mode_config.num_encoder--;
1189 drm_modeset_unlock_all(dev);
1191 memset(encoder, 0, sizeof(*encoder));
1193 EXPORT_SYMBOL(drm_encoder_cleanup);
1196 * drm_universal_plane_init - Initialize a new universal plane object
1198 * @plane: plane object to init
1199 * @possible_crtcs: bitmask of possible CRTCs
1200 * @funcs: callbacks for the new plane
1201 * @formats: array of supported formats (%DRM_FORMAT_*)
1202 * @format_count: number of elements in @formats
1203 * @type: type of plane (overlay, primary, cursor)
1205 * Initializes a plane object of type @type.
1208 * Zero on success, error code on failure.
1210 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1211 unsigned long possible_crtcs,
1212 const struct drm_plane_funcs *funcs,
1213 const uint32_t *formats, uint32_t format_count,
1214 enum drm_plane_type type)
1216 struct drm_mode_config *config = &dev->mode_config;
1219 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1223 drm_modeset_lock_init(&plane->mutex);
1225 plane->base.properties = &plane->properties;
1227 plane->funcs = funcs;
1228 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1230 if (!plane->format_types) {
1231 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1232 drm_mode_object_put(dev, &plane->base);
1236 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1237 plane->format_count = format_count;
1238 plane->possible_crtcs = possible_crtcs;
1241 list_add_tail(&plane->head, &config->plane_list);
1242 config->num_total_plane++;
1243 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1244 config->num_overlay_plane++;
1246 drm_object_attach_property(&plane->base,
1247 config->plane_type_property,
1250 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1251 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1252 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1253 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1254 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1255 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1256 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1257 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1258 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1259 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1260 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1265 EXPORT_SYMBOL(drm_universal_plane_init);
1268 * drm_plane_init - Initialize a legacy plane
1270 * @plane: plane object to init
1271 * @possible_crtcs: bitmask of possible CRTCs
1272 * @funcs: callbacks for the new plane
1273 * @formats: array of supported formats (%DRM_FORMAT_*)
1274 * @format_count: number of elements in @formats
1275 * @is_primary: plane type (primary vs overlay)
1277 * Legacy API to initialize a DRM plane.
1279 * New drivers should call drm_universal_plane_init() instead.
1282 * Zero on success, error code on failure.
1284 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1285 unsigned long possible_crtcs,
1286 const struct drm_plane_funcs *funcs,
1287 const uint32_t *formats, uint32_t format_count,
1290 enum drm_plane_type type;
1292 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1293 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1294 formats, format_count, type);
1296 EXPORT_SYMBOL(drm_plane_init);
1299 * drm_plane_cleanup - Clean up the core plane usage
1300 * @plane: plane to cleanup
1302 * This function cleans up @plane and removes it from the DRM mode setting
1303 * core. Note that the function does *not* free the plane structure itself,
1304 * this is the responsibility of the caller.
1306 void drm_plane_cleanup(struct drm_plane *plane)
1308 struct drm_device *dev = plane->dev;
1310 drm_modeset_lock_all(dev);
1311 kfree(plane->format_types);
1312 drm_mode_object_put(dev, &plane->base);
1314 BUG_ON(list_empty(&plane->head));
1316 list_del(&plane->head);
1317 dev->mode_config.num_total_plane--;
1318 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1319 dev->mode_config.num_overlay_plane--;
1320 drm_modeset_unlock_all(dev);
1322 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1323 if (plane->state && plane->funcs->atomic_destroy_state)
1324 plane->funcs->atomic_destroy_state(plane, plane->state);
1326 memset(plane, 0, sizeof(*plane));
1328 EXPORT_SYMBOL(drm_plane_cleanup);
1331 * drm_plane_index - find the index of a registered plane
1332 * @plane: plane to find index for
1334 * Given a registered plane, return the index of that CRTC within a DRM
1335 * device's list of planes.
1337 unsigned int drm_plane_index(struct drm_plane *plane)
1339 unsigned int index = 0;
1340 struct drm_plane *tmp;
1342 list_for_each_entry(tmp, &plane->dev->mode_config.plane_list, head) {
1351 EXPORT_SYMBOL(drm_plane_index);
1354 * drm_plane_force_disable - Forcibly disable a plane
1355 * @plane: plane to disable
1357 * Forces the plane to be disabled.
1359 * Used when the plane's current framebuffer is destroyed,
1360 * and when restoring fbdev mode.
1362 void drm_plane_force_disable(struct drm_plane *plane)
1369 plane->old_fb = plane->fb;
1370 ret = plane->funcs->disable_plane(plane);
1372 DRM_ERROR("failed to disable plane with busy fb\n");
1373 plane->old_fb = NULL;
1376 /* disconnect the plane from the fb and crtc: */
1377 __drm_framebuffer_unreference(plane->old_fb);
1378 plane->old_fb = NULL;
1382 EXPORT_SYMBOL(drm_plane_force_disable);
1384 static int drm_mode_create_standard_properties(struct drm_device *dev)
1386 struct drm_property *prop;
1389 * Standard properties (apply to all connectors)
1391 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1392 DRM_MODE_PROP_IMMUTABLE,
1396 dev->mode_config.edid_property = prop;
1398 prop = drm_property_create_enum(dev, 0,
1399 "DPMS", drm_dpms_enum_list,
1400 ARRAY_SIZE(drm_dpms_enum_list));
1403 dev->mode_config.dpms_property = prop;
1405 prop = drm_property_create(dev,
1406 DRM_MODE_PROP_BLOB |
1407 DRM_MODE_PROP_IMMUTABLE,
1411 dev->mode_config.path_property = prop;
1413 prop = drm_property_create(dev,
1414 DRM_MODE_PROP_BLOB |
1415 DRM_MODE_PROP_IMMUTABLE,
1419 dev->mode_config.tile_property = prop;
1421 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1422 "type", drm_plane_type_enum_list,
1423 ARRAY_SIZE(drm_plane_type_enum_list));
1426 dev->mode_config.plane_type_property = prop;
1428 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1429 "SRC_X", 0, UINT_MAX);
1432 dev->mode_config.prop_src_x = prop;
1434 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1435 "SRC_Y", 0, UINT_MAX);
1438 dev->mode_config.prop_src_y = prop;
1440 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1441 "SRC_W", 0, UINT_MAX);
1444 dev->mode_config.prop_src_w = prop;
1446 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1447 "SRC_H", 0, UINT_MAX);
1450 dev->mode_config.prop_src_h = prop;
1452 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1453 "CRTC_X", INT_MIN, INT_MAX);
1456 dev->mode_config.prop_crtc_x = prop;
1458 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1459 "CRTC_Y", INT_MIN, INT_MAX);
1462 dev->mode_config.prop_crtc_y = prop;
1464 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1465 "CRTC_W", 0, INT_MAX);
1468 dev->mode_config.prop_crtc_w = prop;
1470 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1471 "CRTC_H", 0, INT_MAX);
1474 dev->mode_config.prop_crtc_h = prop;
1476 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1477 "FB_ID", DRM_MODE_OBJECT_FB);
1480 dev->mode_config.prop_fb_id = prop;
1482 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1483 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1486 dev->mode_config.prop_crtc_id = prop;
1488 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
1492 dev->mode_config.prop_active = prop;
1498 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1501 * Called by a driver the first time a DVI-I connector is made.
1503 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1505 struct drm_property *dvi_i_selector;
1506 struct drm_property *dvi_i_subconnector;
1508 if (dev->mode_config.dvi_i_select_subconnector_property)
1512 drm_property_create_enum(dev, 0,
1513 "select subconnector",
1514 drm_dvi_i_select_enum_list,
1515 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1516 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1518 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1520 drm_dvi_i_subconnector_enum_list,
1521 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1522 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1526 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1529 * drm_create_tv_properties - create TV specific connector properties
1531 * @num_modes: number of different TV formats (modes) supported
1532 * @modes: array of pointers to strings containing name of each format
1534 * Called by a driver's TV initialization routine, this function creates
1535 * the TV specific connector properties for a given device. Caller is
1536 * responsible for allocating a list of format names and passing them to
1539 int drm_mode_create_tv_properties(struct drm_device *dev,
1540 unsigned int num_modes,
1543 struct drm_property *tv_selector;
1544 struct drm_property *tv_subconnector;
1547 if (dev->mode_config.tv_select_subconnector_property)
1551 * Basic connector properties
1553 tv_selector = drm_property_create_enum(dev, 0,
1554 "select subconnector",
1555 drm_tv_select_enum_list,
1556 ARRAY_SIZE(drm_tv_select_enum_list));
1557 dev->mode_config.tv_select_subconnector_property = tv_selector;
1560 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1562 drm_tv_subconnector_enum_list,
1563 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1564 dev->mode_config.tv_subconnector_property = tv_subconnector;
1567 * Other, TV specific properties: margins & TV modes.
1569 dev->mode_config.tv_left_margin_property =
1570 drm_property_create_range(dev, 0, "left margin", 0, 100);
1572 dev->mode_config.tv_right_margin_property =
1573 drm_property_create_range(dev, 0, "right margin", 0, 100);
1575 dev->mode_config.tv_top_margin_property =
1576 drm_property_create_range(dev, 0, "top margin", 0, 100);
1578 dev->mode_config.tv_bottom_margin_property =
1579 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1581 dev->mode_config.tv_mode_property =
1582 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1584 for (i = 0; i < num_modes; i++)
1585 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1588 dev->mode_config.tv_brightness_property =
1589 drm_property_create_range(dev, 0, "brightness", 0, 100);
1591 dev->mode_config.tv_contrast_property =
1592 drm_property_create_range(dev, 0, "contrast", 0, 100);
1594 dev->mode_config.tv_flicker_reduction_property =
1595 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1597 dev->mode_config.tv_overscan_property =
1598 drm_property_create_range(dev, 0, "overscan", 0, 100);
1600 dev->mode_config.tv_saturation_property =
1601 drm_property_create_range(dev, 0, "saturation", 0, 100);
1603 dev->mode_config.tv_hue_property =
1604 drm_property_create_range(dev, 0, "hue", 0, 100);
1608 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1611 * drm_mode_create_scaling_mode_property - create scaling mode property
1614 * Called by a driver the first time it's needed, must be attached to desired
1617 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1619 struct drm_property *scaling_mode;
1621 if (dev->mode_config.scaling_mode_property)
1625 drm_property_create_enum(dev, 0, "scaling mode",
1626 drm_scaling_mode_enum_list,
1627 ARRAY_SIZE(drm_scaling_mode_enum_list));
1629 dev->mode_config.scaling_mode_property = scaling_mode;
1633 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1636 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1639 * Called by a driver the first time it's needed, must be attached to desired
1643 * Zero on success, negative errno on failure.
1645 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1647 if (dev->mode_config.aspect_ratio_property)
1650 dev->mode_config.aspect_ratio_property =
1651 drm_property_create_enum(dev, 0, "aspect ratio",
1652 drm_aspect_ratio_enum_list,
1653 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1655 if (dev->mode_config.aspect_ratio_property == NULL)
1660 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1663 * drm_mode_create_dirty_property - create dirty property
1666 * Called by a driver the first time it's needed, must be attached to desired
1669 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1671 struct drm_property *dirty_info;
1673 if (dev->mode_config.dirty_info_property)
1677 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1679 drm_dirty_info_enum_list,
1680 ARRAY_SIZE(drm_dirty_info_enum_list));
1681 dev->mode_config.dirty_info_property = dirty_info;
1685 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1688 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1691 * Create the the suggested x/y offset property for connectors.
1693 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1695 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1698 dev->mode_config.suggested_x_property =
1699 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1701 dev->mode_config.suggested_y_property =
1702 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1704 if (dev->mode_config.suggested_x_property == NULL ||
1705 dev->mode_config.suggested_y_property == NULL)
1709 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1711 static int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
1713 uint32_t total_objects = 0;
1715 total_objects += dev->mode_config.num_crtc;
1716 total_objects += dev->mode_config.num_connector;
1717 total_objects += dev->mode_config.num_encoder;
1718 total_objects += dev->mode_config.num_bridge;
1720 group->id_list = kcalloc(total_objects, sizeof(uint32_t), GFP_KERNEL);
1721 if (!group->id_list)
1724 group->num_crtcs = 0;
1725 group->num_connectors = 0;
1726 group->num_encoders = 0;
1727 group->num_bridges = 0;
1731 void drm_mode_group_destroy(struct drm_mode_group *group)
1733 kfree(group->id_list);
1734 group->id_list = NULL;
1738 * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1739 * the drm core's responsibility to set up mode control groups.
1741 int drm_mode_group_init_legacy_group(struct drm_device *dev,
1742 struct drm_mode_group *group)
1744 struct drm_crtc *crtc;
1745 struct drm_encoder *encoder;
1746 struct drm_connector *connector;
1747 struct drm_bridge *bridge;
1750 ret = drm_mode_group_init(dev, group);
1754 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
1755 group->id_list[group->num_crtcs++] = crtc->base.id;
1757 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
1758 group->id_list[group->num_crtcs + group->num_encoders++] =
1761 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1762 group->id_list[group->num_crtcs + group->num_encoders +
1763 group->num_connectors++] = connector->base.id;
1765 list_for_each_entry(bridge, &dev->mode_config.bridge_list, head)
1766 group->id_list[group->num_crtcs + group->num_encoders +
1767 group->num_connectors + group->num_bridges++] =
1772 EXPORT_SYMBOL(drm_mode_group_init_legacy_group);
1774 void drm_reinit_primary_mode_group(struct drm_device *dev)
1776 drm_modeset_lock_all(dev);
1777 drm_mode_group_destroy(&dev->primary->mode_group);
1778 drm_mode_group_init_legacy_group(dev, &dev->primary->mode_group);
1779 drm_modeset_unlock_all(dev);
1781 EXPORT_SYMBOL(drm_reinit_primary_mode_group);
1784 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1785 * @out: drm_mode_modeinfo struct to return to the user
1786 * @in: drm_display_mode to use
1788 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1791 static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
1792 const struct drm_display_mode *in)
1794 WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1795 in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1796 in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1797 in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1798 in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1799 "timing values too large for mode info\n");
1801 out->clock = in->clock;
1802 out->hdisplay = in->hdisplay;
1803 out->hsync_start = in->hsync_start;
1804 out->hsync_end = in->hsync_end;
1805 out->htotal = in->htotal;
1806 out->hskew = in->hskew;
1807 out->vdisplay = in->vdisplay;
1808 out->vsync_start = in->vsync_start;
1809 out->vsync_end = in->vsync_end;
1810 out->vtotal = in->vtotal;
1811 out->vscan = in->vscan;
1812 out->vrefresh = in->vrefresh;
1813 out->flags = in->flags;
1814 out->type = in->type;
1815 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1816 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1820 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1821 * @out: drm_display_mode to return to the user
1822 * @in: drm_mode_modeinfo to use
1824 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1828 * Zero on success, negative errno on failure.
1830 static int drm_crtc_convert_umode(struct drm_display_mode *out,
1831 const struct drm_mode_modeinfo *in)
1833 if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1836 if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1839 out->clock = in->clock;
1840 out->hdisplay = in->hdisplay;
1841 out->hsync_start = in->hsync_start;
1842 out->hsync_end = in->hsync_end;
1843 out->htotal = in->htotal;
1844 out->hskew = in->hskew;
1845 out->vdisplay = in->vdisplay;
1846 out->vsync_start = in->vsync_start;
1847 out->vsync_end = in->vsync_end;
1848 out->vtotal = in->vtotal;
1849 out->vscan = in->vscan;
1850 out->vrefresh = in->vrefresh;
1851 out->flags = in->flags;
1852 out->type = in->type;
1853 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1854 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1860 * drm_mode_getresources - get graphics configuration
1861 * @dev: drm device for the ioctl
1862 * @data: data pointer for the ioctl
1863 * @file_priv: drm file for the ioctl call
1865 * Construct a set of configuration description structures and return
1866 * them to the user, including CRTC, connector and framebuffer configuration.
1868 * Called by the user via ioctl.
1871 * Zero on success, negative errno on failure.
1873 int drm_mode_getresources(struct drm_device *dev, void *data,
1874 struct drm_file *file_priv)
1876 struct drm_mode_card_res *card_res = data;
1877 struct list_head *lh;
1878 struct drm_framebuffer *fb;
1879 struct drm_connector *connector;
1880 struct drm_crtc *crtc;
1881 struct drm_encoder *encoder;
1883 int connector_count = 0;
1886 int encoder_count = 0;
1888 uint32_t __user *fb_id;
1889 uint32_t __user *crtc_id;
1890 uint32_t __user *connector_id;
1891 uint32_t __user *encoder_id;
1892 struct drm_mode_group *mode_group;
1894 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1898 mutex_lock(&file_priv->fbs_lock);
1900 * For the non-control nodes we need to limit the list of resources
1901 * by IDs in the group list for this node
1903 list_for_each(lh, &file_priv->fbs)
1906 /* handle this in 4 parts */
1908 if (card_res->count_fbs >= fb_count) {
1910 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1911 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1912 if (put_user(fb->base.id, fb_id + copied)) {
1913 mutex_unlock(&file_priv->fbs_lock);
1919 card_res->count_fbs = fb_count;
1920 mutex_unlock(&file_priv->fbs_lock);
1922 /* mode_config.mutex protects the connector list against e.g. DP MST
1923 * connector hot-adding. CRTC/Plane lists are invariant. */
1924 mutex_lock(&dev->mode_config.mutex);
1925 if (!drm_is_primary_client(file_priv)) {
1928 list_for_each(lh, &dev->mode_config.crtc_list)
1931 list_for_each(lh, &dev->mode_config.connector_list)
1934 list_for_each(lh, &dev->mode_config.encoder_list)
1938 mode_group = &file_priv->master->minor->mode_group;
1939 crtc_count = mode_group->num_crtcs;
1940 connector_count = mode_group->num_connectors;
1941 encoder_count = mode_group->num_encoders;
1944 card_res->max_height = dev->mode_config.max_height;
1945 card_res->min_height = dev->mode_config.min_height;
1946 card_res->max_width = dev->mode_config.max_width;
1947 card_res->min_width = dev->mode_config.min_width;
1950 if (card_res->count_crtcs >= crtc_count) {
1952 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1954 list_for_each_entry(crtc, &dev->mode_config.crtc_list,
1956 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1957 if (put_user(crtc->base.id, crtc_id + copied)) {
1964 for (i = 0; i < mode_group->num_crtcs; i++) {
1965 if (put_user(mode_group->id_list[i],
1966 crtc_id + copied)) {
1974 card_res->count_crtcs = crtc_count;
1977 if (card_res->count_encoders >= encoder_count) {
1979 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1981 list_for_each_entry(encoder,
1982 &dev->mode_config.encoder_list,
1984 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1986 if (put_user(encoder->base.id, encoder_id +
1994 for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
1995 if (put_user(mode_group->id_list[i],
1996 encoder_id + copied)) {
2005 card_res->count_encoders = encoder_count;
2008 if (card_res->count_connectors >= connector_count) {
2010 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
2012 list_for_each_entry(connector,
2013 &dev->mode_config.connector_list,
2015 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2018 if (put_user(connector->base.id,
2019 connector_id + copied)) {
2026 int start = mode_group->num_crtcs +
2027 mode_group->num_encoders;
2028 for (i = start; i < start + mode_group->num_connectors; i++) {
2029 if (put_user(mode_group->id_list[i],
2030 connector_id + copied)) {
2038 card_res->count_connectors = connector_count;
2040 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
2041 card_res->count_connectors, card_res->count_encoders);
2044 mutex_unlock(&dev->mode_config.mutex);
2049 * drm_mode_getcrtc - get CRTC configuration
2050 * @dev: drm device for the ioctl
2051 * @data: data pointer for the ioctl
2052 * @file_priv: drm file for the ioctl call
2054 * Construct a CRTC configuration structure to return to the user.
2056 * Called by the user via ioctl.
2059 * Zero on success, negative errno on failure.
2061 int drm_mode_getcrtc(struct drm_device *dev,
2062 void *data, struct drm_file *file_priv)
2064 struct drm_mode_crtc *crtc_resp = data;
2065 struct drm_crtc *crtc;
2067 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2070 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
2074 drm_modeset_lock_crtc(crtc, crtc->primary);
2075 crtc_resp->x = crtc->x;
2076 crtc_resp->y = crtc->y;
2077 crtc_resp->gamma_size = crtc->gamma_size;
2078 if (crtc->primary->fb)
2079 crtc_resp->fb_id = crtc->primary->fb->base.id;
2081 crtc_resp->fb_id = 0;
2083 if (crtc->enabled) {
2085 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2086 crtc_resp->mode_valid = 1;
2089 crtc_resp->mode_valid = 0;
2091 drm_modeset_unlock_crtc(crtc);
2096 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2097 const struct drm_file *file_priv)
2100 * If user-space hasn't configured the driver to expose the stereo 3D
2101 * modes, don't expose them.
2103 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2109 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2111 /* For atomic drivers only state objects are synchronously updated and
2112 * protected by modeset locks, so check those first. */
2113 if (connector->state)
2114 return connector->state->best_encoder;
2115 return connector->encoder;
2118 /* helper for getconnector and getproperties ioctls */
2119 static int get_properties(struct drm_mode_object *obj, bool atomic,
2120 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2121 uint32_t *arg_count_props)
2126 props_count = obj->properties->count;
2128 props_count -= obj->properties->atomic_count;
2130 if ((*arg_count_props >= props_count) && props_count) {
2131 for (i = 0, copied = 0; copied < props_count; i++) {
2132 struct drm_property *prop = obj->properties->properties[i];
2135 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2138 ret = drm_object_property_get_value(obj, prop, &val);
2142 if (put_user(prop->base.id, prop_ptr + copied))
2145 if (put_user(val, prop_values + copied))
2151 *arg_count_props = props_count;
2157 * drm_mode_getconnector - get connector configuration
2158 * @dev: drm device for the ioctl
2159 * @data: data pointer for the ioctl
2160 * @file_priv: drm file for the ioctl call
2162 * Construct a connector configuration structure to return to the user.
2164 * Called by the user via ioctl.
2167 * Zero on success, negative errno on failure.
2169 int drm_mode_getconnector(struct drm_device *dev, void *data,
2170 struct drm_file *file_priv)
2172 struct drm_mode_get_connector *out_resp = data;
2173 struct drm_connector *connector;
2174 struct drm_encoder *encoder;
2175 struct drm_display_mode *mode;
2177 int encoders_count = 0;
2181 struct drm_mode_modeinfo u_mode;
2182 struct drm_mode_modeinfo __user *mode_ptr;
2183 uint32_t __user *encoder_ptr;
2185 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2188 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2190 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2192 mutex_lock(&dev->mode_config.mutex);
2193 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2195 connector = drm_connector_find(dev, out_resp->connector_id);
2201 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2202 if (connector->encoder_ids[i] != 0)
2205 if (out_resp->count_modes == 0) {
2206 connector->funcs->fill_modes(connector,
2207 dev->mode_config.max_width,
2208 dev->mode_config.max_height);
2211 /* delayed so we get modes regardless of pre-fill_modes state */
2212 list_for_each_entry(mode, &connector->modes, head)
2213 if (drm_mode_expose_to_userspace(mode, file_priv))
2216 out_resp->connector_id = connector->base.id;
2217 out_resp->connector_type = connector->connector_type;
2218 out_resp->connector_type_id = connector->connector_type_id;
2219 out_resp->mm_width = connector->display_info.width_mm;
2220 out_resp->mm_height = connector->display_info.height_mm;
2221 out_resp->subpixel = connector->display_info.subpixel_order;
2222 out_resp->connection = connector->status;
2223 encoder = drm_connector_get_encoder(connector);
2225 out_resp->encoder_id = encoder->base.id;
2227 out_resp->encoder_id = 0;
2230 * This ioctl is called twice, once to determine how much space is
2231 * needed, and the 2nd time to fill it.
2233 if ((out_resp->count_modes >= mode_count) && mode_count) {
2235 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2236 list_for_each_entry(mode, &connector->modes, head) {
2237 if (!drm_mode_expose_to_userspace(mode, file_priv))
2240 drm_crtc_convert_to_umode(&u_mode, mode);
2241 if (copy_to_user(mode_ptr + copied,
2242 &u_mode, sizeof(u_mode))) {
2249 out_resp->count_modes = mode_count;
2251 ret = get_properties(&connector->base, file_priv->atomic,
2252 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2253 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2254 &out_resp->count_props);
2258 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2260 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2261 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2262 if (connector->encoder_ids[i] != 0) {
2263 if (put_user(connector->encoder_ids[i],
2264 encoder_ptr + copied)) {
2272 out_resp->count_encoders = encoders_count;
2275 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2276 mutex_unlock(&dev->mode_config.mutex);
2281 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2283 struct drm_connector *connector;
2284 struct drm_device *dev = encoder->dev;
2285 bool uses_atomic = false;
2287 /* For atomic drivers only state objects are synchronously updated and
2288 * protected by modeset locks, so check those first. */
2289 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
2290 if (!connector->state)
2295 if (connector->state->best_encoder != encoder)
2298 return connector->state->crtc;
2301 /* Don't return stale data (e.g. pending async disable). */
2305 return encoder->crtc;
2309 * drm_mode_getencoder - get encoder configuration
2310 * @dev: drm device for the ioctl
2311 * @data: data pointer for the ioctl
2312 * @file_priv: drm file for the ioctl call
2314 * Construct a encoder configuration structure to return to the user.
2316 * Called by the user via ioctl.
2319 * Zero on success, negative errno on failure.
2321 int drm_mode_getencoder(struct drm_device *dev, void *data,
2322 struct drm_file *file_priv)
2324 struct drm_mode_get_encoder *enc_resp = data;
2325 struct drm_encoder *encoder;
2326 struct drm_crtc *crtc;
2328 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2331 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2335 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2336 crtc = drm_encoder_get_crtc(encoder);
2338 enc_resp->crtc_id = crtc->base.id;
2339 else if (encoder->crtc)
2340 enc_resp->crtc_id = encoder->crtc->base.id;
2342 enc_resp->crtc_id = 0;
2343 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2345 enc_resp->encoder_type = encoder->encoder_type;
2346 enc_resp->encoder_id = encoder->base.id;
2347 enc_resp->possible_crtcs = encoder->possible_crtcs;
2348 enc_resp->possible_clones = encoder->possible_clones;
2354 * drm_mode_getplane_res - enumerate all plane resources
2357 * @file_priv: DRM file info
2359 * Construct a list of plane ids to return to the user.
2361 * Called by the user via ioctl.
2364 * Zero on success, negative errno on failure.
2366 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2367 struct drm_file *file_priv)
2369 struct drm_mode_get_plane_res *plane_resp = data;
2370 struct drm_mode_config *config;
2371 struct drm_plane *plane;
2372 uint32_t __user *plane_ptr;
2374 unsigned num_planes;
2376 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2379 config = &dev->mode_config;
2381 if (file_priv->universal_planes)
2382 num_planes = config->num_total_plane;
2384 num_planes = config->num_overlay_plane;
2387 * This ioctl is called twice, once to determine how much space is
2388 * needed, and the 2nd time to fill it.
2391 (plane_resp->count_planes >= num_planes)) {
2392 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2394 /* Plane lists are invariant, no locking needed. */
2395 list_for_each_entry(plane, &config->plane_list, head) {
2397 * Unless userspace set the 'universal planes'
2398 * capability bit, only advertise overlays.
2400 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2401 !file_priv->universal_planes)
2404 if (put_user(plane->base.id, plane_ptr + copied))
2409 plane_resp->count_planes = num_planes;
2415 * drm_mode_getplane - get plane configuration
2418 * @file_priv: DRM file info
2420 * Construct a plane configuration structure to return to the user.
2422 * Called by the user via ioctl.
2425 * Zero on success, negative errno on failure.
2427 int drm_mode_getplane(struct drm_device *dev, void *data,
2428 struct drm_file *file_priv)
2430 struct drm_mode_get_plane *plane_resp = data;
2431 struct drm_plane *plane;
2432 uint32_t __user *format_ptr;
2434 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2437 plane = drm_plane_find(dev, plane_resp->plane_id);
2441 drm_modeset_lock(&plane->mutex, NULL);
2443 plane_resp->crtc_id = plane->crtc->base.id;
2445 plane_resp->crtc_id = 0;
2448 plane_resp->fb_id = plane->fb->base.id;
2450 plane_resp->fb_id = 0;
2451 drm_modeset_unlock(&plane->mutex);
2453 plane_resp->plane_id = plane->base.id;
2454 plane_resp->possible_crtcs = plane->possible_crtcs;
2455 plane_resp->gamma_size = 0;
2458 * This ioctl is called twice, once to determine how much space is
2459 * needed, and the 2nd time to fill it.
2461 if (plane->format_count &&
2462 (plane_resp->count_format_types >= plane->format_count)) {
2463 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2464 if (copy_to_user(format_ptr,
2465 plane->format_types,
2466 sizeof(uint32_t) * plane->format_count)) {
2470 plane_resp->count_format_types = plane->format_count;
2476 * setplane_internal - setplane handler for internal callers
2478 * Note that we assume an extra reference has already been taken on fb. If the
2479 * update fails, this reference will be dropped before return; if it succeeds,
2480 * the previous framebuffer (if any) will be unreferenced instead.
2482 * src_{x,y,w,h} are provided in 16.16 fixed point format
2484 static int __setplane_internal(struct drm_plane *plane,
2485 struct drm_crtc *crtc,
2486 struct drm_framebuffer *fb,
2487 int32_t crtc_x, int32_t crtc_y,
2488 uint32_t crtc_w, uint32_t crtc_h,
2489 /* src_{x,y,w,h} values are 16.16 fixed point */
2490 uint32_t src_x, uint32_t src_y,
2491 uint32_t src_w, uint32_t src_h)
2494 unsigned int fb_width, fb_height;
2497 /* No fb means shut it down */
2499 plane->old_fb = plane->fb;
2500 ret = plane->funcs->disable_plane(plane);
2505 plane->old_fb = NULL;
2510 /* Check whether this plane is usable on this CRTC */
2511 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2512 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2517 /* Check whether this plane supports the fb pixel format. */
2518 for (i = 0; i < plane->format_count; i++)
2519 if (fb->pixel_format == plane->format_types[i])
2521 if (i == plane->format_count) {
2522 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2523 drm_get_format_name(fb->pixel_format));
2528 fb_width = fb->width << 16;
2529 fb_height = fb->height << 16;
2531 /* Make sure source coordinates are inside the fb. */
2532 if (src_w > fb_width ||
2533 src_x > fb_width - src_w ||
2534 src_h > fb_height ||
2535 src_y > fb_height - src_h) {
2536 DRM_DEBUG_KMS("Invalid source coordinates "
2537 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2538 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2539 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2540 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2541 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2546 plane->old_fb = plane->fb;
2547 ret = plane->funcs->update_plane(plane, crtc, fb,
2548 crtc_x, crtc_y, crtc_w, crtc_h,
2549 src_x, src_y, src_w, src_h);
2555 plane->old_fb = NULL;
2560 drm_framebuffer_unreference(fb);
2562 drm_framebuffer_unreference(plane->old_fb);
2563 plane->old_fb = NULL;
2568 static int setplane_internal(struct drm_plane *plane,
2569 struct drm_crtc *crtc,
2570 struct drm_framebuffer *fb,
2571 int32_t crtc_x, int32_t crtc_y,
2572 uint32_t crtc_w, uint32_t crtc_h,
2573 /* src_{x,y,w,h} values are 16.16 fixed point */
2574 uint32_t src_x, uint32_t src_y,
2575 uint32_t src_w, uint32_t src_h)
2579 drm_modeset_lock_all(plane->dev);
2580 ret = __setplane_internal(plane, crtc, fb,
2581 crtc_x, crtc_y, crtc_w, crtc_h,
2582 src_x, src_y, src_w, src_h);
2583 drm_modeset_unlock_all(plane->dev);
2589 * drm_mode_setplane - configure a plane's configuration
2591 * @data: ioctl data*
2592 * @file_priv: DRM file info
2594 * Set plane configuration, including placement, fb, scaling, and other factors.
2595 * Or pass a NULL fb to disable (planes may be disabled without providing a
2599 * Zero on success, negative errno on failure.
2601 int drm_mode_setplane(struct drm_device *dev, void *data,
2602 struct drm_file *file_priv)
2604 struct drm_mode_set_plane *plane_req = data;
2605 struct drm_plane *plane;
2606 struct drm_crtc *crtc = NULL;
2607 struct drm_framebuffer *fb = NULL;
2609 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2612 /* Give drivers some help against integer overflows */
2613 if (plane_req->crtc_w > INT_MAX ||
2614 plane_req->crtc_x > INT_MAX - (int32_t) plane_req->crtc_w ||
2615 plane_req->crtc_h > INT_MAX ||
2616 plane_req->crtc_y > INT_MAX - (int32_t) plane_req->crtc_h) {
2617 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2618 plane_req->crtc_w, plane_req->crtc_h,
2619 plane_req->crtc_x, plane_req->crtc_y);
2624 * First, find the plane, crtc, and fb objects. If not available,
2625 * we don't bother to call the driver.
2627 plane = drm_plane_find(dev, plane_req->plane_id);
2629 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2630 plane_req->plane_id);
2634 if (plane_req->fb_id) {
2635 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2637 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2642 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2644 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2645 plane_req->crtc_id);
2651 * setplane_internal will take care of deref'ing either the old or new
2652 * framebuffer depending on success.
2654 return setplane_internal(plane, crtc, fb,
2655 plane_req->crtc_x, plane_req->crtc_y,
2656 plane_req->crtc_w, plane_req->crtc_h,
2657 plane_req->src_x, plane_req->src_y,
2658 plane_req->src_w, plane_req->src_h);
2662 * drm_mode_set_config_internal - helper to call ->set_config
2663 * @set: modeset config to set
2665 * This is a little helper to wrap internal calls to the ->set_config driver
2666 * interface. The only thing it adds is correct refcounting dance.
2669 * Zero on success, negative errno on failure.
2671 int drm_mode_set_config_internal(struct drm_mode_set *set)
2673 struct drm_crtc *crtc = set->crtc;
2674 struct drm_framebuffer *fb;
2675 struct drm_crtc *tmp;
2679 * NOTE: ->set_config can also disable other crtcs (if we steal all
2680 * connectors from it), hence we need to refcount the fbs across all
2681 * crtcs. Atomic modeset will have saner semantics ...
2683 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head)
2684 tmp->primary->old_fb = tmp->primary->fb;
2688 ret = crtc->funcs->set_config(set);
2690 crtc->primary->crtc = crtc;
2691 crtc->primary->fb = fb;
2694 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
2695 if (tmp->primary->fb)
2696 drm_framebuffer_reference(tmp->primary->fb);
2697 if (tmp->primary->old_fb)
2698 drm_framebuffer_unreference(tmp->primary->old_fb);
2699 tmp->primary->old_fb = NULL;
2704 EXPORT_SYMBOL(drm_mode_set_config_internal);
2707 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
2708 * @mode: mode to query
2709 * @hdisplay: hdisplay value to fill in
2710 * @vdisplay: vdisplay value to fill in
2712 * The vdisplay value will be doubled if the specified mode is a stereo mode of
2713 * the appropriate layout.
2715 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2716 int *hdisplay, int *vdisplay)
2718 struct drm_display_mode adjusted;
2720 drm_mode_copy(&adjusted, mode);
2721 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
2722 *hdisplay = adjusted.crtc_hdisplay;
2723 *vdisplay = adjusted.crtc_vdisplay;
2725 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
2728 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2730 * @crtc: CRTC that framebuffer will be displayed on
2733 * @mode: mode that framebuffer will be displayed under
2734 * @fb: framebuffer to check size of
2736 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2738 const struct drm_display_mode *mode,
2739 const struct drm_framebuffer *fb)
2742 int hdisplay, vdisplay;
2744 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
2746 if (crtc->invert_dimensions)
2747 swap(hdisplay, vdisplay);
2749 if (hdisplay > fb->width ||
2750 vdisplay > fb->height ||
2751 x > fb->width - hdisplay ||
2752 y > fb->height - vdisplay) {
2753 DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2754 fb->width, fb->height, hdisplay, vdisplay, x, y,
2755 crtc->invert_dimensions ? " (inverted)" : "");
2761 EXPORT_SYMBOL(drm_crtc_check_viewport);
2764 * drm_mode_setcrtc - set CRTC configuration
2765 * @dev: drm device for the ioctl
2766 * @data: data pointer for the ioctl
2767 * @file_priv: drm file for the ioctl call
2769 * Build a new CRTC configuration based on user request.
2771 * Called by the user via ioctl.
2774 * Zero on success, negative errno on failure.
2776 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2777 struct drm_file *file_priv)
2779 struct drm_mode_config *config = &dev->mode_config;
2780 struct drm_mode_crtc *crtc_req = data;
2781 struct drm_crtc *crtc;
2782 struct drm_connector **connector_set = NULL, *connector;
2783 struct drm_framebuffer *fb = NULL;
2784 struct drm_display_mode *mode = NULL;
2785 struct drm_mode_set set;
2786 uint32_t __user *set_connectors_ptr;
2790 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2793 /* For some reason crtc x/y offsets are signed internally. */
2794 if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
2797 drm_modeset_lock_all(dev);
2798 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2800 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2804 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2806 if (crtc_req->mode_valid) {
2807 /* If we have a mode we need a framebuffer. */
2808 /* If we pass -1, set the mode with the currently bound fb */
2809 if (crtc_req->fb_id == -1) {
2810 if (!crtc->primary->fb) {
2811 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2815 fb = crtc->primary->fb;
2816 /* Make refcounting symmetric with the lookup path. */
2817 drm_framebuffer_reference(fb);
2819 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2821 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2828 mode = drm_mode_create(dev);
2834 ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
2836 DRM_DEBUG_KMS("Invalid mode\n");
2840 mode->status = drm_mode_validate_basic(mode);
2841 if (mode->status != MODE_OK) {
2846 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2848 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2855 if (crtc_req->count_connectors == 0 && mode) {
2856 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2861 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2862 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2863 crtc_req->count_connectors);
2868 if (crtc_req->count_connectors > 0) {
2871 /* Avoid unbounded kernel memory allocation */
2872 if (crtc_req->count_connectors > config->num_connector) {
2877 connector_set = kmalloc_array(crtc_req->count_connectors,
2878 sizeof(struct drm_connector *),
2880 if (!connector_set) {
2885 for (i = 0; i < crtc_req->count_connectors; i++) {
2886 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2887 if (get_user(out_id, &set_connectors_ptr[i])) {
2892 connector = drm_connector_find(dev, out_id);
2894 DRM_DEBUG_KMS("Connector id %d unknown\n",
2899 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2903 connector_set[i] = connector;
2908 set.x = crtc_req->x;
2909 set.y = crtc_req->y;
2911 set.connectors = connector_set;
2912 set.num_connectors = crtc_req->count_connectors;
2914 ret = drm_mode_set_config_internal(&set);
2918 drm_framebuffer_unreference(fb);
2920 kfree(connector_set);
2921 drm_mode_destroy(dev, mode);
2922 drm_modeset_unlock_all(dev);
2927 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2928 * universal plane handler call
2929 * @crtc: crtc to update cursor for
2930 * @req: data pointer for the ioctl
2931 * @file_priv: drm file for the ioctl call
2933 * Legacy cursor ioctl's work directly with driver buffer handles. To
2934 * translate legacy ioctl calls into universal plane handler calls, we need to
2935 * wrap the native buffer handle in a drm_framebuffer.
2937 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2938 * buffer with a pitch of 4*width; the universal plane interface should be used
2939 * directly in cases where the hardware can support other buffer settings and
2940 * userspace wants to make use of these capabilities.
2943 * Zero on success, negative errno on failure.
2945 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2946 struct drm_mode_cursor2 *req,
2947 struct drm_file *file_priv)
2949 struct drm_device *dev = crtc->dev;
2950 struct drm_framebuffer *fb = NULL;
2951 struct drm_mode_fb_cmd2 fbreq = {
2952 .width = req->width,
2953 .height = req->height,
2954 .pixel_format = DRM_FORMAT_ARGB8888,
2955 .pitches = { req->width * 4 },
2956 .handles = { req->handle },
2958 int32_t crtc_x, crtc_y;
2959 uint32_t crtc_w = 0, crtc_h = 0;
2960 uint32_t src_w = 0, src_h = 0;
2963 BUG_ON(!crtc->cursor);
2964 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2967 * Obtain fb we'll be using (either new or existing) and take an extra
2968 * reference to it if fb != null. setplane will take care of dropping
2969 * the reference if the plane update fails.
2971 if (req->flags & DRM_MODE_CURSOR_BO) {
2973 fb = add_framebuffer_internal(dev, &fbreq, file_priv);
2975 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2979 drm_framebuffer_reference(fb);
2984 fb = crtc->cursor->fb;
2986 drm_framebuffer_reference(fb);
2989 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2993 crtc_x = crtc->cursor_x;
2994 crtc_y = crtc->cursor_y;
2999 crtc_h = fb->height;
3000 src_w = fb->width << 16;
3001 src_h = fb->height << 16;
3005 * setplane_internal will take care of deref'ing either the old or new
3006 * framebuffer depending on success.
3008 ret = __setplane_internal(crtc->cursor, crtc, fb,
3009 crtc_x, crtc_y, crtc_w, crtc_h,
3010 0, 0, src_w, src_h);
3012 /* Update successful; save new cursor position, if necessary */
3013 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
3014 crtc->cursor_x = req->x;
3015 crtc->cursor_y = req->y;
3021 static int drm_mode_cursor_common(struct drm_device *dev,
3022 struct drm_mode_cursor2 *req,
3023 struct drm_file *file_priv)
3025 struct drm_crtc *crtc;
3028 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3031 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
3034 crtc = drm_crtc_find(dev, req->crtc_id);
3036 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
3041 * If this crtc has a universal cursor plane, call that plane's update
3042 * handler rather than using legacy cursor handlers.
3044 drm_modeset_lock_crtc(crtc, crtc->cursor);
3046 ret = drm_mode_cursor_universal(crtc, req, file_priv);
3050 if (req->flags & DRM_MODE_CURSOR_BO) {
3051 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
3055 /* Turns off the cursor if handle is 0 */
3056 if (crtc->funcs->cursor_set2)
3057 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
3058 req->width, req->height, req->hot_x, req->hot_y);
3060 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
3061 req->width, req->height);
3064 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3065 if (crtc->funcs->cursor_move) {
3066 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3073 drm_modeset_unlock_crtc(crtc);
3081 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3082 * @dev: drm device for the ioctl
3083 * @data: data pointer for the ioctl
3084 * @file_priv: drm file for the ioctl call
3086 * Set the cursor configuration based on user request.
3088 * Called by the user via ioctl.
3091 * Zero on success, negative errno on failure.
3093 int drm_mode_cursor_ioctl(struct drm_device *dev,
3094 void *data, struct drm_file *file_priv)
3096 struct drm_mode_cursor *req = data;
3097 struct drm_mode_cursor2 new_req;
3099 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3100 new_req.hot_x = new_req.hot_y = 0;
3102 return drm_mode_cursor_common(dev, &new_req, file_priv);
3106 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3107 * @dev: drm device for the ioctl
3108 * @data: data pointer for the ioctl
3109 * @file_priv: drm file for the ioctl call
3111 * Set the cursor configuration based on user request. This implements the 2nd
3112 * version of the cursor ioctl, which allows userspace to additionally specify
3113 * the hotspot of the pointer.
3115 * Called by the user via ioctl.
3118 * Zero on success, negative errno on failure.
3120 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3121 void *data, struct drm_file *file_priv)
3123 struct drm_mode_cursor2 *req = data;
3125 return drm_mode_cursor_common(dev, req, file_priv);
3129 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3130 * @bpp: bits per pixels
3131 * @depth: bit depth per pixel
3133 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3134 * Useful in fbdev emulation code, since that deals in those values.
3136 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3142 fmt = DRM_FORMAT_C8;
3146 fmt = DRM_FORMAT_XRGB1555;
3148 fmt = DRM_FORMAT_RGB565;
3151 fmt = DRM_FORMAT_RGB888;
3155 fmt = DRM_FORMAT_XRGB8888;
3156 else if (depth == 30)
3157 fmt = DRM_FORMAT_XRGB2101010;
3159 fmt = DRM_FORMAT_ARGB8888;
3162 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3163 fmt = DRM_FORMAT_XRGB8888;
3169 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3172 * drm_mode_addfb - add an FB to the graphics configuration
3173 * @dev: drm device for the ioctl
3174 * @data: data pointer for the ioctl
3175 * @file_priv: drm file for the ioctl call
3177 * Add a new FB to the specified CRTC, given a user request. This is the
3178 * original addfb ioctl which only supported RGB formats.
3180 * Called by the user via ioctl.
3183 * Zero on success, negative errno on failure.
3185 int drm_mode_addfb(struct drm_device *dev,
3186 void *data, struct drm_file *file_priv)
3188 struct drm_mode_fb_cmd *or = data;
3189 struct drm_mode_fb_cmd2 r = {};
3192 /* convert to new format and call new ioctl */
3193 r.fb_id = or->fb_id;
3194 r.width = or->width;
3195 r.height = or->height;
3196 r.pitches[0] = or->pitch;
3197 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3198 r.handles[0] = or->handle;
3200 ret = drm_mode_addfb2(dev, &r, file_priv);
3204 or->fb_id = r.fb_id;
3209 static int format_check(const struct drm_mode_fb_cmd2 *r)
3211 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3215 case DRM_FORMAT_RGB332:
3216 case DRM_FORMAT_BGR233:
3217 case DRM_FORMAT_XRGB4444:
3218 case DRM_FORMAT_XBGR4444:
3219 case DRM_FORMAT_RGBX4444:
3220 case DRM_FORMAT_BGRX4444:
3221 case DRM_FORMAT_ARGB4444:
3222 case DRM_FORMAT_ABGR4444:
3223 case DRM_FORMAT_RGBA4444:
3224 case DRM_FORMAT_BGRA4444:
3225 case DRM_FORMAT_XRGB1555:
3226 case DRM_FORMAT_XBGR1555:
3227 case DRM_FORMAT_RGBX5551:
3228 case DRM_FORMAT_BGRX5551:
3229 case DRM_FORMAT_ARGB1555:
3230 case DRM_FORMAT_ABGR1555:
3231 case DRM_FORMAT_RGBA5551:
3232 case DRM_FORMAT_BGRA5551:
3233 case DRM_FORMAT_RGB565:
3234 case DRM_FORMAT_BGR565:
3235 case DRM_FORMAT_RGB888:
3236 case DRM_FORMAT_BGR888:
3237 case DRM_FORMAT_XRGB8888:
3238 case DRM_FORMAT_XBGR8888:
3239 case DRM_FORMAT_RGBX8888:
3240 case DRM_FORMAT_BGRX8888:
3241 case DRM_FORMAT_ARGB8888:
3242 case DRM_FORMAT_ABGR8888:
3243 case DRM_FORMAT_RGBA8888:
3244 case DRM_FORMAT_BGRA8888:
3245 case DRM_FORMAT_XRGB2101010:
3246 case DRM_FORMAT_XBGR2101010:
3247 case DRM_FORMAT_RGBX1010102:
3248 case DRM_FORMAT_BGRX1010102:
3249 case DRM_FORMAT_ARGB2101010:
3250 case DRM_FORMAT_ABGR2101010:
3251 case DRM_FORMAT_RGBA1010102:
3252 case DRM_FORMAT_BGRA1010102:
3253 case DRM_FORMAT_YUYV:
3254 case DRM_FORMAT_YVYU:
3255 case DRM_FORMAT_UYVY:
3256 case DRM_FORMAT_VYUY:
3257 case DRM_FORMAT_AYUV:
3258 case DRM_FORMAT_NV12:
3259 case DRM_FORMAT_NV21:
3260 case DRM_FORMAT_NV16:
3261 case DRM_FORMAT_NV61:
3262 case DRM_FORMAT_NV24:
3263 case DRM_FORMAT_NV42:
3264 case DRM_FORMAT_YUV410:
3265 case DRM_FORMAT_YVU410:
3266 case DRM_FORMAT_YUV411:
3267 case DRM_FORMAT_YVU411:
3268 case DRM_FORMAT_YUV420:
3269 case DRM_FORMAT_YVU420:
3270 case DRM_FORMAT_YUV422:
3271 case DRM_FORMAT_YVU422:
3272 case DRM_FORMAT_YUV444:
3273 case DRM_FORMAT_YVU444:
3276 DRM_DEBUG_KMS("invalid pixel format %s\n",
3277 drm_get_format_name(r->pixel_format));
3282 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3284 int ret, hsub, vsub, num_planes, i;
3286 ret = format_check(r);
3288 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3289 drm_get_format_name(r->pixel_format));
3293 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3294 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3295 num_planes = drm_format_num_planes(r->pixel_format);
3297 if (r->width == 0 || r->width % hsub) {
3298 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3302 if (r->height == 0 || r->height % vsub) {
3303 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3307 for (i = 0; i < num_planes; i++) {
3308 unsigned int width = r->width / (i != 0 ? hsub : 1);
3309 unsigned int height = r->height / (i != 0 ? vsub : 1);
3310 unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);
3312 if (!r->handles[i]) {
3313 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3317 if ((uint64_t) width * cpp > UINT_MAX)
3320 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3323 if (r->pitches[i] < width * cpp) {
3324 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3332 static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
3333 struct drm_mode_fb_cmd2 *r,
3334 struct drm_file *file_priv)
3336 struct drm_mode_config *config = &dev->mode_config;
3337 struct drm_framebuffer *fb;
3340 if (r->flags & ~DRM_MODE_FB_INTERLACED) {
3341 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3342 return ERR_PTR(-EINVAL);
3345 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3346 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3347 r->width, config->min_width, config->max_width);
3348 return ERR_PTR(-EINVAL);
3350 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3351 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3352 r->height, config->min_height, config->max_height);
3353 return ERR_PTR(-EINVAL);
3356 ret = framebuffer_check(r);
3358 return ERR_PTR(ret);
3360 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3362 DRM_DEBUG_KMS("could not create framebuffer\n");
3366 mutex_lock(&file_priv->fbs_lock);
3367 r->fb_id = fb->base.id;
3368 list_add(&fb->filp_head, &file_priv->fbs);
3369 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3370 mutex_unlock(&file_priv->fbs_lock);
3376 * drm_mode_addfb2 - add an FB to the graphics configuration
3377 * @dev: drm device for the ioctl
3378 * @data: data pointer for the ioctl
3379 * @file_priv: drm file for the ioctl call
3381 * Add a new FB to the specified CRTC, given a user request with format. This is
3382 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3383 * and uses fourcc codes as pixel format specifiers.
3385 * Called by the user via ioctl.
3388 * Zero on success, negative errno on failure.
3390 int drm_mode_addfb2(struct drm_device *dev,
3391 void *data, struct drm_file *file_priv)
3393 struct drm_framebuffer *fb;
3395 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3398 fb = add_framebuffer_internal(dev, data, file_priv);
3406 * drm_mode_rmfb - remove an FB from the configuration
3407 * @dev: drm device for the ioctl
3408 * @data: data pointer for the ioctl
3409 * @file_priv: drm file for the ioctl call
3411 * Remove the FB specified by the user.
3413 * Called by the user via ioctl.
3416 * Zero on success, negative errno on failure.
3418 int drm_mode_rmfb(struct drm_device *dev,
3419 void *data, struct drm_file *file_priv)
3421 struct drm_framebuffer *fb = NULL;
3422 struct drm_framebuffer *fbl = NULL;
3423 uint32_t *id = data;
3426 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3429 mutex_lock(&file_priv->fbs_lock);
3430 mutex_lock(&dev->mode_config.fb_lock);
3431 fb = __drm_framebuffer_lookup(dev, *id);
3435 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3441 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3442 __drm_framebuffer_unregister(dev, fb);
3444 list_del_init(&fb->filp_head);
3445 mutex_unlock(&dev->mode_config.fb_lock);
3446 mutex_unlock(&file_priv->fbs_lock);
3448 drm_framebuffer_remove(fb);
3453 mutex_unlock(&dev->mode_config.fb_lock);
3454 mutex_unlock(&file_priv->fbs_lock);
3460 * drm_mode_getfb - get FB info
3461 * @dev: drm device for the ioctl
3462 * @data: data pointer for the ioctl
3463 * @file_priv: drm file for the ioctl call
3465 * Lookup the FB given its ID and return info about it.
3467 * Called by the user via ioctl.
3470 * Zero on success, negative errno on failure.
3472 int drm_mode_getfb(struct drm_device *dev,
3473 void *data, struct drm_file *file_priv)
3475 struct drm_mode_fb_cmd *r = data;
3476 struct drm_framebuffer *fb;
3479 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3482 fb = drm_framebuffer_lookup(dev, r->fb_id);
3486 r->height = fb->height;
3487 r->width = fb->width;
3488 r->depth = fb->depth;
3489 r->bpp = fb->bits_per_pixel;
3490 r->pitch = fb->pitches[0];
3491 if (fb->funcs->create_handle) {
3492 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3493 drm_is_control_client(file_priv)) {
3494 ret = fb->funcs->create_handle(fb, file_priv,
3497 /* GET_FB() is an unprivileged ioctl so we must not
3498 * return a buffer-handle to non-master processes! For
3499 * backwards-compatibility reasons, we cannot make
3500 * GET_FB() privileged, so just return an invalid handle
3501 * for non-masters. */
3509 drm_framebuffer_unreference(fb);
3515 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3516 * @dev: drm device for the ioctl
3517 * @data: data pointer for the ioctl
3518 * @file_priv: drm file for the ioctl call
3520 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3521 * rectangle list. Generic userspace which does frontbuffer rendering must call
3522 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3523 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3525 * Modesetting drivers which always update the frontbuffer do not need to
3526 * implement the corresponding ->dirty framebuffer callback.
3528 * Called by the user via ioctl.
3531 * Zero on success, negative errno on failure.
3533 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3534 void *data, struct drm_file *file_priv)
3536 struct drm_clip_rect __user *clips_ptr;
3537 struct drm_clip_rect *clips = NULL;
3538 struct drm_mode_fb_dirty_cmd *r = data;
3539 struct drm_framebuffer *fb;
3544 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3547 fb = drm_framebuffer_lookup(dev, r->fb_id);
3551 num_clips = r->num_clips;
3552 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3554 if (!num_clips != !clips_ptr) {
3559 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3561 /* If userspace annotates copy, clips must come in pairs */
3562 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3567 if (num_clips && clips_ptr) {
3568 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3572 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3578 ret = copy_from_user(clips, clips_ptr,
3579 num_clips * sizeof(*clips));
3586 if (fb->funcs->dirty) {
3587 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3596 drm_framebuffer_unreference(fb);
3603 * drm_fb_release - remove and free the FBs on this file
3604 * @priv: drm file for the ioctl
3606 * Destroy all the FBs associated with @filp.
3608 * Called by the user via ioctl.
3611 * Zero on success, negative errno on failure.
3613 void drm_fb_release(struct drm_file *priv)
3615 struct drm_device *dev = priv->minor->dev;
3616 struct drm_framebuffer *fb, *tfb;
3619 * When the file gets released that means no one else can access the fb
3620 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3621 * avoid upsetting lockdep since the universal cursor code adds a
3622 * framebuffer while holding mutex locks.
3624 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3625 * locks is impossible here since no one else but this function can get
3628 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3630 mutex_lock(&dev->mode_config.fb_lock);
3631 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3632 __drm_framebuffer_unregister(dev, fb);
3633 mutex_unlock(&dev->mode_config.fb_lock);
3635 list_del_init(&fb->filp_head);
3637 /* This will also drop the fpriv->fbs reference. */
3638 drm_framebuffer_remove(fb);
3643 * drm_property_create - create a new property type
3645 * @flags: flags specifying the property type
3646 * @name: name of the property
3647 * @num_values: number of pre-defined values
3649 * This creates a new generic drm property which can then be attached to a drm
3650 * object with drm_object_attach_property. The returned property object must be
3651 * freed with drm_property_destroy.
3653 * Note that the DRM core keeps a per-device list of properties and that, if
3654 * drm_mode_config_cleanup() is called, it will destroy all properties created
3658 * A pointer to the newly created property on success, NULL on failure.
3660 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3661 const char *name, int num_values)
3663 struct drm_property *property = NULL;
3666 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3670 property->dev = dev;
3673 property->values = kcalloc(num_values, sizeof(uint64_t),
3675 if (!property->values)
3679 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3683 property->flags = flags;
3684 property->num_values = num_values;
3685 INIT_LIST_HEAD(&property->enum_list);
3688 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3689 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3692 list_add_tail(&property->head, &dev->mode_config.property_list);
3694 WARN_ON(!drm_property_type_valid(property));
3698 kfree(property->values);
3702 EXPORT_SYMBOL(drm_property_create);
3705 * drm_property_create_enum - create a new enumeration property type
3707 * @flags: flags specifying the property type
3708 * @name: name of the property
3709 * @props: enumeration lists with property values
3710 * @num_values: number of pre-defined values
3712 * This creates a new generic drm property which can then be attached to a drm
3713 * object with drm_object_attach_property. The returned property object must be
3714 * freed with drm_property_destroy.
3716 * Userspace is only allowed to set one of the predefined values for enumeration
3720 * A pointer to the newly created property on success, NULL on failure.
3722 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3724 const struct drm_prop_enum_list *props,
3727 struct drm_property *property;
3730 flags |= DRM_MODE_PROP_ENUM;
3732 property = drm_property_create(dev, flags, name, num_values);
3736 for (i = 0; i < num_values; i++) {
3737 ret = drm_property_add_enum(property, i,
3741 drm_property_destroy(dev, property);
3748 EXPORT_SYMBOL(drm_property_create_enum);
3751 * drm_property_create_bitmask - create a new bitmask property type
3753 * @flags: flags specifying the property type
3754 * @name: name of the property
3755 * @props: enumeration lists with property bitflags
3756 * @num_props: size of the @props array
3757 * @supported_bits: bitmask of all supported enumeration values
3759 * This creates a new bitmask drm property which can then be attached to a drm
3760 * object with drm_object_attach_property. The returned property object must be
3761 * freed with drm_property_destroy.
3763 * Compared to plain enumeration properties userspace is allowed to set any
3764 * or'ed together combination of the predefined property bitflag values
3767 * A pointer to the newly created property on success, NULL on failure.
3769 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3770 int flags, const char *name,
3771 const struct drm_prop_enum_list *props,
3773 uint64_t supported_bits)
3775 struct drm_property *property;
3776 int i, ret, index = 0;
3777 int num_values = hweight64(supported_bits);
3779 flags |= DRM_MODE_PROP_BITMASK;
3781 property = drm_property_create(dev, flags, name, num_values);
3784 for (i = 0; i < num_props; i++) {
3785 if (!(supported_bits & (1ULL << props[i].type)))
3788 if (WARN_ON(index >= num_values)) {
3789 drm_property_destroy(dev, property);
3793 ret = drm_property_add_enum(property, index++,
3797 drm_property_destroy(dev, property);
3804 EXPORT_SYMBOL(drm_property_create_bitmask);
3806 static struct drm_property *property_create_range(struct drm_device *dev,
3807 int flags, const char *name,
3808 uint64_t min, uint64_t max)
3810 struct drm_property *property;
3812 property = drm_property_create(dev, flags, name, 2);
3816 property->values[0] = min;
3817 property->values[1] = max;
3823 * drm_property_create_range - create a new unsigned ranged property type
3825 * @flags: flags specifying the property type
3826 * @name: name of the property
3827 * @min: minimum value of the property
3828 * @max: maximum value of the property
3830 * This creates a new generic drm property which can then be attached to a drm
3831 * object with drm_object_attach_property. The returned property object must be
3832 * freed with drm_property_destroy.
3834 * Userspace is allowed to set any unsigned integer value in the (min, max)
3838 * A pointer to the newly created property on success, NULL on failure.
3840 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3842 uint64_t min, uint64_t max)
3844 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3847 EXPORT_SYMBOL(drm_property_create_range);
3850 * drm_property_create_signed_range - create a new signed ranged property type
3852 * @flags: flags specifying the property type
3853 * @name: name of the property
3854 * @min: minimum value of the property
3855 * @max: maximum value of the property
3857 * This creates a new generic drm property which can then be attached to a drm
3858 * object with drm_object_attach_property. The returned property object must be
3859 * freed with drm_property_destroy.
3861 * Userspace is allowed to set any signed integer value in the (min, max)
3865 * A pointer to the newly created property on success, NULL on failure.
3867 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3868 int flags, const char *name,
3869 int64_t min, int64_t max)
3871 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3872 name, I642U64(min), I642U64(max));
3874 EXPORT_SYMBOL(drm_property_create_signed_range);
3877 * drm_property_create_object - create a new object property type
3879 * @flags: flags specifying the property type
3880 * @name: name of the property
3881 * @type: object type from DRM_MODE_OBJECT_* defines
3883 * This creates a new generic drm property which can then be attached to a drm
3884 * object with drm_object_attach_property. The returned property object must be
3885 * freed with drm_property_destroy.
3887 * Userspace is only allowed to set this to any property value of the given
3888 * @type. Only useful for atomic properties, which is enforced.
3891 * A pointer to the newly created property on success, NULL on failure.
3893 struct drm_property *drm_property_create_object(struct drm_device *dev,
3894 int flags, const char *name, uint32_t type)
3896 struct drm_property *property;
3898 flags |= DRM_MODE_PROP_OBJECT;
3900 if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
3903 property = drm_property_create(dev, flags, name, 1);
3907 property->values[0] = type;
3911 EXPORT_SYMBOL(drm_property_create_object);
3914 * drm_property_create_bool - create a new boolean property type
3916 * @flags: flags specifying the property type
3917 * @name: name of the property
3919 * This creates a new generic drm property which can then be attached to a drm
3920 * object with drm_object_attach_property. The returned property object must be
3921 * freed with drm_property_destroy.
3923 * This is implemented as a ranged property with only {0, 1} as valid values.
3926 * A pointer to the newly created property on success, NULL on failure.
3928 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
3931 return drm_property_create_range(dev, flags, name, 0, 1);
3933 EXPORT_SYMBOL(drm_property_create_bool);
3936 * drm_property_add_enum - add a possible value to an enumeration property
3937 * @property: enumeration property to change
3938 * @index: index of the new enumeration
3939 * @value: value of the new enumeration
3940 * @name: symbolic name of the new enumeration
3942 * This functions adds enumerations to a property.
3944 * It's use is deprecated, drivers should use one of the more specific helpers
3945 * to directly create the property with all enumerations already attached.
3948 * Zero on success, error code on failure.
3950 int drm_property_add_enum(struct drm_property *property, int index,
3951 uint64_t value, const char *name)
3953 struct drm_property_enum *prop_enum;
3955 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3956 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
3960 * Bitmask enum properties have the additional constraint of values
3963 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
3967 if (!list_empty(&property->enum_list)) {
3968 list_for_each_entry(prop_enum, &property->enum_list, head) {
3969 if (prop_enum->value == value) {
3970 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3971 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3977 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
3981 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3982 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3983 prop_enum->value = value;
3985 property->values[index] = value;
3986 list_add_tail(&prop_enum->head, &property->enum_list);
3989 EXPORT_SYMBOL(drm_property_add_enum);
3992 * drm_property_destroy - destroy a drm property
3994 * @property: property to destry
3996 * This function frees a property including any attached resources like
3997 * enumeration values.
3999 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
4001 struct drm_property_enum *prop_enum, *pt;
4003 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
4004 list_del(&prop_enum->head);
4008 if (property->num_values)
4009 kfree(property->values);
4010 drm_mode_object_put(dev, &property->base);
4011 list_del(&property->head);
4014 EXPORT_SYMBOL(drm_property_destroy);
4017 * drm_object_attach_property - attach a property to a modeset object
4018 * @obj: drm modeset object
4019 * @property: property to attach
4020 * @init_val: initial value of the property
4022 * This attaches the given property to the modeset object with the given initial
4023 * value. Currently this function cannot fail since the properties are stored in
4024 * a statically sized array.
4026 void drm_object_attach_property(struct drm_mode_object *obj,
4027 struct drm_property *property,
4030 int count = obj->properties->count;
4032 if (count == DRM_OBJECT_MAX_PROPERTY) {
4033 WARN(1, "Failed to attach object property (type: 0x%x). Please "
4034 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
4035 "you see this message on the same object type.\n",
4040 obj->properties->properties[count] = property;
4041 obj->properties->values[count] = init_val;
4042 obj->properties->count++;
4043 if (property->flags & DRM_MODE_PROP_ATOMIC)
4044 obj->properties->atomic_count++;
4046 EXPORT_SYMBOL(drm_object_attach_property);
4049 * drm_object_property_set_value - set the value of a property
4050 * @obj: drm mode object to set property value for
4051 * @property: property to set
4052 * @val: value the property should be set to
4054 * This functions sets a given property on a given object. This function only
4055 * changes the software state of the property, it does not call into the
4056 * driver's ->set_property callback.
4059 * Zero on success, error code on failure.
4061 int drm_object_property_set_value(struct drm_mode_object *obj,
4062 struct drm_property *property, uint64_t val)
4066 for (i = 0; i < obj->properties->count; i++) {
4067 if (obj->properties->properties[i] == property) {
4068 obj->properties->values[i] = val;
4075 EXPORT_SYMBOL(drm_object_property_set_value);
4078 * drm_object_property_get_value - retrieve the value of a property
4079 * @obj: drm mode object to get property value from
4080 * @property: property to retrieve
4081 * @val: storage for the property value
4083 * This function retrieves the softare state of the given property for the given
4084 * property. Since there is no driver callback to retrieve the current property
4085 * value this might be out of sync with the hardware, depending upon the driver
4089 * Zero on success, error code on failure.
4091 int drm_object_property_get_value(struct drm_mode_object *obj,
4092 struct drm_property *property, uint64_t *val)
4096 /* read-only properties bypass atomic mechanism and still store
4097 * their value in obj->properties->values[].. mostly to avoid
4098 * having to deal w/ EDID and similar props in atomic paths:
4100 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
4101 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
4102 return drm_atomic_get_property(obj, property, val);
4104 for (i = 0; i < obj->properties->count; i++) {
4105 if (obj->properties->properties[i] == property) {
4106 *val = obj->properties->values[i];
4113 EXPORT_SYMBOL(drm_object_property_get_value);
4116 * drm_mode_getproperty_ioctl - get the property metadata
4119 * @file_priv: DRM file info
4121 * This function retrieves the metadata for a given property, like the different
4122 * possible values for an enum property or the limits for a range property.
4124 * Blob properties are special
4126 * Called by the user via ioctl.
4129 * Zero on success, negative errno on failure.
4131 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4132 void *data, struct drm_file *file_priv)
4134 struct drm_mode_get_property *out_resp = data;
4135 struct drm_property *property;
4137 int value_count = 0;
4140 struct drm_property_enum *prop_enum;
4141 struct drm_mode_property_enum __user *enum_ptr;
4142 uint64_t __user *values_ptr;
4144 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4147 drm_modeset_lock_all(dev);
4148 property = drm_property_find(dev, out_resp->prop_id);
4154 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4155 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4156 list_for_each_entry(prop_enum, &property->enum_list, head)
4160 value_count = property->num_values;
4162 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4163 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4164 out_resp->flags = property->flags;
4166 if ((out_resp->count_values >= value_count) && value_count) {
4167 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4168 for (i = 0; i < value_count; i++) {
4169 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4175 out_resp->count_values = value_count;
4177 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4178 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4179 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4181 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4182 list_for_each_entry(prop_enum, &property->enum_list, head) {
4184 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4189 if (copy_to_user(&enum_ptr[copied].name,
4190 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4197 out_resp->count_enum_blobs = enum_count;
4201 * NOTE: The idea seems to have been to use this to read all the blob
4202 * property values. But nothing ever added them to the corresponding
4203 * list, userspace always used the special-purpose get_blob ioctl to
4204 * read the value for a blob property. It also doesn't make a lot of
4205 * sense to return values here when everything else is just metadata for
4206 * the property itself.
4208 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4209 out_resp->count_enum_blobs = 0;
4211 drm_modeset_unlock_all(dev);
4215 static struct drm_property_blob *
4216 drm_property_create_blob(struct drm_device *dev, size_t length,
4219 struct drm_property_blob *blob;
4222 if (!length || !data)
4225 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4229 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4235 blob->length = length;
4237 memcpy(blob->data, data, length);
4239 list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
4243 static void drm_property_destroy_blob(struct drm_device *dev,
4244 struct drm_property_blob *blob)
4246 drm_mode_object_put(dev, &blob->base);
4247 list_del(&blob->head);
4252 * drm_mode_getblob_ioctl - get the contents of a blob property value
4255 * @file_priv: DRM file info
4257 * This function retrieves the contents of a blob property. The value stored in
4258 * an object's blob property is just a normal modeset object id.
4260 * Called by the user via ioctl.
4263 * Zero on success, negative errno on failure.
4265 int drm_mode_getblob_ioctl(struct drm_device *dev,
4266 void *data, struct drm_file *file_priv)
4268 struct drm_mode_get_blob *out_resp = data;
4269 struct drm_property_blob *blob;
4271 void __user *blob_ptr;
4273 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4276 drm_modeset_lock_all(dev);
4277 blob = drm_property_blob_find(dev, out_resp->blob_id);
4283 if (out_resp->length == blob->length) {
4284 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4285 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4290 out_resp->length = blob->length;
4293 drm_modeset_unlock_all(dev);
4298 * drm_mode_connector_set_path_property - set tile property on connector
4299 * @connector: connector to set property on.
4300 * @path: path to use for property.
4302 * This creates a property to expose to userspace to specify a
4303 * connector path. This is mainly used for DisplayPort MST where
4304 * connectors have a topology and we want to allow userspace to give
4305 * them more meaningful names.
4308 * Zero on success, negative errno on failure.
4310 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4313 struct drm_device *dev = connector->dev;
4314 size_t size = strlen(path) + 1;
4317 connector->path_blob_ptr = drm_property_create_blob(connector->dev,
4319 if (!connector->path_blob_ptr)
4322 ret = drm_object_property_set_value(&connector->base,
4323 dev->mode_config.path_property,
4324 connector->path_blob_ptr->base.id);
4327 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4330 * drm_mode_connector_set_tile_property - set tile property on connector
4331 * @connector: connector to set property on.
4333 * This looks up the tile information for a connector, and creates a
4334 * property for userspace to parse if it exists. The property is of
4335 * the form of 8 integers using ':' as a separator.
4338 * Zero on success, errno on failure.
4340 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4342 struct drm_device *dev = connector->dev;
4346 if (connector->tile_blob_ptr)
4347 drm_property_destroy_blob(dev, connector->tile_blob_ptr);
4349 if (!connector->has_tile) {
4350 connector->tile_blob_ptr = NULL;
4351 ret = drm_object_property_set_value(&connector->base,
4352 dev->mode_config.tile_property, 0);
4356 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4357 connector->tile_group->id, connector->tile_is_single_monitor,
4358 connector->num_h_tile, connector->num_v_tile,
4359 connector->tile_h_loc, connector->tile_v_loc,
4360 connector->tile_h_size, connector->tile_v_size);
4361 size = strlen(tile) + 1;
4363 connector->tile_blob_ptr = drm_property_create_blob(connector->dev,
4365 if (!connector->tile_blob_ptr)
4368 ret = drm_object_property_set_value(&connector->base,
4369 dev->mode_config.tile_property,
4370 connector->tile_blob_ptr->base.id);
4373 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4376 * drm_mode_connector_update_edid_property - update the edid property of a connector
4377 * @connector: drm connector
4378 * @edid: new value of the edid property
4380 * This function creates a new blob modeset object and assigns its id to the
4381 * connector's edid property.
4384 * Zero on success, negative errno on failure.
4386 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4387 const struct edid *edid)
4389 struct drm_device *dev = connector->dev;
4393 /* ignore requests to set edid when overridden */
4394 if (connector->override_edid)
4397 if (connector->edid_blob_ptr)
4398 drm_property_destroy_blob(dev, connector->edid_blob_ptr);
4400 /* Delete edid, when there is none. */
4402 connector->edid_blob_ptr = NULL;
4403 ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
4407 size = EDID_LENGTH * (1 + edid->extensions);
4408 connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
4410 if (!connector->edid_blob_ptr)
4413 ret = drm_object_property_set_value(&connector->base,
4414 dev->mode_config.edid_property,
4415 connector->edid_blob_ptr->base.id);
4419 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4421 /* Some properties could refer to dynamic refcnt'd objects, or things that
4422 * need special locking to handle lifetime issues (ie. to ensure the prop
4423 * value doesn't become invalid part way through the property update due to
4424 * race). The value returned by reference via 'obj' should be passed back
4425 * to drm_property_change_valid_put() after the property is set (and the
4426 * object to which the property is attached has a chance to take it's own
4429 bool drm_property_change_valid_get(struct drm_property *property,
4430 uint64_t value, struct drm_mode_object **ref)
4434 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4439 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4440 if (value < property->values[0] || value > property->values[1])
4443 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4444 int64_t svalue = U642I64(value);
4446 if (svalue < U642I64(property->values[0]) ||
4447 svalue > U642I64(property->values[1]))
4450 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4451 uint64_t valid_mask = 0;
4453 for (i = 0; i < property->num_values; i++)
4454 valid_mask |= (1ULL << property->values[i]);
4455 return !(value & ~valid_mask);
4456 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4457 /* Only the driver knows */
4459 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4460 /* a zero value for an object property translates to null: */
4464 /* handle refcnt'd objects specially: */
4465 if (property->values[0] == DRM_MODE_OBJECT_FB) {
4466 struct drm_framebuffer *fb;
4467 fb = drm_framebuffer_lookup(property->dev, value);
4475 return _object_find(property->dev, value, property->values[0]) != NULL;
4479 for (i = 0; i < property->num_values; i++)
4480 if (property->values[i] == value)
4485 void drm_property_change_valid_put(struct drm_property *property,
4486 struct drm_mode_object *ref)
4491 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4492 if (property->values[0] == DRM_MODE_OBJECT_FB)
4493 drm_framebuffer_unreference(obj_to_fb(ref));
4498 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4501 * @file_priv: DRM file info
4503 * This function sets the current value for a connectors's property. It also
4504 * calls into a driver's ->set_property callback to update the hardware state
4506 * Called by the user via ioctl.
4509 * Zero on success, negative errno on failure.
4511 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4512 void *data, struct drm_file *file_priv)
4514 struct drm_mode_connector_set_property *conn_set_prop = data;
4515 struct drm_mode_obj_set_property obj_set_prop = {
4516 .value = conn_set_prop->value,
4517 .prop_id = conn_set_prop->prop_id,
4518 .obj_id = conn_set_prop->connector_id,
4519 .obj_type = DRM_MODE_OBJECT_CONNECTOR
4522 /* It does all the locking and checking we need */
4523 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4526 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4527 struct drm_property *property,
4531 struct drm_connector *connector = obj_to_connector(obj);
4533 /* Do DPMS ourselves */
4534 if (property == connector->dev->mode_config.dpms_property) {
4535 if (connector->funcs->dpms)
4536 (*connector->funcs->dpms)(connector, (int)value);
4538 } else if (connector->funcs->set_property)
4539 ret = connector->funcs->set_property(connector, property, value);
4541 /* store the property value if successful */
4543 drm_object_property_set_value(&connector->base, property, value);
4547 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4548 struct drm_property *property,
4552 struct drm_crtc *crtc = obj_to_crtc(obj);
4554 if (crtc->funcs->set_property)
4555 ret = crtc->funcs->set_property(crtc, property, value);
4557 drm_object_property_set_value(obj, property, value);
4563 * drm_mode_plane_set_obj_prop - set the value of a property
4564 * @plane: drm plane object to set property value for
4565 * @property: property to set
4566 * @value: value the property should be set to
4568 * This functions sets a given property on a given plane object. This function
4569 * calls the driver's ->set_property callback and changes the software state of
4570 * the property if the callback succeeds.
4573 * Zero on success, error code on failure.
4575 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
4576 struct drm_property *property,
4580 struct drm_mode_object *obj = &plane->base;
4582 if (plane->funcs->set_property)
4583 ret = plane->funcs->set_property(plane, property, value);
4585 drm_object_property_set_value(obj, property, value);
4589 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
4592 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
4595 * @file_priv: DRM file info
4597 * This function retrieves the current value for an object's property. Compared
4598 * to the connector specific ioctl this one is extended to also work on crtc and
4601 * Called by the user via ioctl.
4604 * Zero on success, negative errno on failure.
4606 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
4607 struct drm_file *file_priv)
4609 struct drm_mode_obj_get_properties *arg = data;
4610 struct drm_mode_object *obj;
4613 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4616 drm_modeset_lock_all(dev);
4618 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4623 if (!obj->properties) {
4628 ret = get_properties(obj, file_priv->atomic,
4629 (uint32_t __user *)(unsigned long)(arg->props_ptr),
4630 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
4634 drm_modeset_unlock_all(dev);
4639 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
4642 * @file_priv: DRM file info
4644 * This function sets the current value for an object's property. It also calls
4645 * into a driver's ->set_property callback to update the hardware state.
4646 * Compared to the connector specific ioctl this one is extended to also work on
4647 * crtc and plane objects.
4649 * Called by the user via ioctl.
4652 * Zero on success, negative errno on failure.
4654 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
4655 struct drm_file *file_priv)
4657 struct drm_mode_obj_set_property *arg = data;
4658 struct drm_mode_object *arg_obj;
4659 struct drm_mode_object *prop_obj;
4660 struct drm_property *property;
4661 int i, ret = -EINVAL;
4662 struct drm_mode_object *ref;
4664 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4667 drm_modeset_lock_all(dev);
4669 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4674 if (!arg_obj->properties)
4677 for (i = 0; i < arg_obj->properties->count; i++)
4678 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
4681 if (i == arg_obj->properties->count)
4684 prop_obj = drm_mode_object_find(dev, arg->prop_id,
4685 DRM_MODE_OBJECT_PROPERTY);
4690 property = obj_to_property(prop_obj);
4692 if (!drm_property_change_valid_get(property, arg->value, &ref))
4695 switch (arg_obj->type) {
4696 case DRM_MODE_OBJECT_CONNECTOR:
4697 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
4700 case DRM_MODE_OBJECT_CRTC:
4701 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
4703 case DRM_MODE_OBJECT_PLANE:
4704 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
4705 property, arg->value);
4709 drm_property_change_valid_put(property, ref);
4712 drm_modeset_unlock_all(dev);
4717 * drm_mode_connector_attach_encoder - attach a connector to an encoder
4718 * @connector: connector to attach
4719 * @encoder: encoder to attach @connector to
4721 * This function links up a connector to an encoder. Note that the routing
4722 * restrictions between encoders and crtcs are exposed to userspace through the
4723 * possible_clones and possible_crtcs bitmasks.
4726 * Zero on success, negative errno on failure.
4728 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
4729 struct drm_encoder *encoder)
4733 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
4734 if (connector->encoder_ids[i] == 0) {
4735 connector->encoder_ids[i] = encoder->base.id;
4741 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
4744 * drm_mode_crtc_set_gamma_size - set the gamma table size
4745 * @crtc: CRTC to set the gamma table size for
4746 * @gamma_size: size of the gamma table
4748 * Drivers which support gamma tables should set this to the supported gamma
4749 * table size when initializing the CRTC. Currently the drm core only supports a
4750 * fixed gamma table size.
4753 * Zero on success, negative errno on failure.
4755 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
4758 crtc->gamma_size = gamma_size;
4760 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
4762 if (!crtc->gamma_store) {
4763 crtc->gamma_size = 0;
4769 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
4772 * drm_mode_gamma_set_ioctl - set the gamma table
4775 * @file_priv: DRM file info
4777 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
4778 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
4780 * Called by the user via ioctl.
4783 * Zero on success, negative errno on failure.
4785 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
4786 void *data, struct drm_file *file_priv)
4788 struct drm_mode_crtc_lut *crtc_lut = data;
4789 struct drm_crtc *crtc;
4790 void *r_base, *g_base, *b_base;
4794 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4797 drm_modeset_lock_all(dev);
4798 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4804 if (crtc->funcs->gamma_set == NULL) {
4809 /* memcpy into gamma store */
4810 if (crtc_lut->gamma_size != crtc->gamma_size) {
4815 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4816 r_base = crtc->gamma_store;
4817 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
4822 g_base = r_base + size;
4823 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
4828 b_base = g_base + size;
4829 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
4834 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
4837 drm_modeset_unlock_all(dev);
4843 * drm_mode_gamma_get_ioctl - get the gamma table
4846 * @file_priv: DRM file info
4848 * Copy the current gamma table into the storage provided. This also provides
4849 * the gamma table size the driver expects, which can be used to size the
4850 * allocated storage.
4852 * Called by the user via ioctl.
4855 * Zero on success, negative errno on failure.
4857 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
4858 void *data, struct drm_file *file_priv)
4860 struct drm_mode_crtc_lut *crtc_lut = data;
4861 struct drm_crtc *crtc;
4862 void *r_base, *g_base, *b_base;
4866 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4869 drm_modeset_lock_all(dev);
4870 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4876 /* memcpy into gamma store */
4877 if (crtc_lut->gamma_size != crtc->gamma_size) {
4882 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4883 r_base = crtc->gamma_store;
4884 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
4889 g_base = r_base + size;
4890 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
4895 b_base = g_base + size;
4896 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
4901 drm_modeset_unlock_all(dev);
4906 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4909 * @file_priv: DRM file info
4911 * This schedules an asynchronous update on a given CRTC, called page flip.
4912 * Optionally a drm event is generated to signal the completion of the event.
4913 * Generic drivers cannot assume that a pageflip with changed framebuffer
4914 * properties (including driver specific metadata like tiling layout) will work,
4915 * but some drivers support e.g. pixel format changes through the pageflip
4918 * Called by the user via ioctl.
4921 * Zero on success, negative errno on failure.
4923 int drm_mode_page_flip_ioctl(struct drm_device *dev,
4924 void *data, struct drm_file *file_priv)
4926 struct drm_mode_crtc_page_flip *page_flip = data;
4927 struct drm_crtc *crtc;
4928 struct drm_framebuffer *fb = NULL;
4929 struct drm_pending_vblank_event *e = NULL;
4930 unsigned long flags;
4933 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
4934 page_flip->reserved != 0)
4937 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
4940 crtc = drm_crtc_find(dev, page_flip->crtc_id);
4944 drm_modeset_lock_crtc(crtc, crtc->primary);
4945 if (crtc->primary->fb == NULL) {
4946 /* The framebuffer is currently unbound, presumably
4947 * due to a hotplug event, that userspace has not
4954 if (crtc->funcs->page_flip == NULL)
4957 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
4963 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
4967 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
4968 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4973 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4975 spin_lock_irqsave(&dev->event_lock, flags);
4976 if (file_priv->event_space < sizeof(e->event)) {
4977 spin_unlock_irqrestore(&dev->event_lock, flags);
4980 file_priv->event_space -= sizeof(e->event);
4981 spin_unlock_irqrestore(&dev->event_lock, flags);
4983 e = kzalloc(sizeof(*e), GFP_KERNEL);
4985 spin_lock_irqsave(&dev->event_lock, flags);
4986 file_priv->event_space += sizeof(e->event);
4987 spin_unlock_irqrestore(&dev->event_lock, flags);
4991 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
4992 e->event.base.length = sizeof(e->event);
4993 e->event.user_data = page_flip->user_data;
4994 e->base.event = &e->event.base;
4995 e->base.file_priv = file_priv;
4997 (void (*) (struct drm_pending_event *)) kfree;
5000 crtc->primary->old_fb = crtc->primary->fb;
5001 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
5003 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5004 spin_lock_irqsave(&dev->event_lock, flags);
5005 file_priv->event_space += sizeof(e->event);
5006 spin_unlock_irqrestore(&dev->event_lock, flags);
5009 /* Keep the old fb, don't unref it. */
5010 crtc->primary->old_fb = NULL;
5013 * Warn if the driver hasn't properly updated the crtc->fb
5014 * field to reflect that the new framebuffer is now used.
5015 * Failing to do so will screw with the reference counting
5018 WARN_ON(crtc->primary->fb != fb);
5019 /* Unref only the old framebuffer. */
5025 drm_framebuffer_unreference(fb);
5026 if (crtc->primary->old_fb)
5027 drm_framebuffer_unreference(crtc->primary->old_fb);
5028 crtc->primary->old_fb = NULL;
5029 drm_modeset_unlock_crtc(crtc);
5035 * drm_mode_config_reset - call ->reset callbacks
5038 * This functions calls all the crtc's, encoder's and connector's ->reset
5039 * callback. Drivers can use this in e.g. their driver load or resume code to
5040 * reset hardware and software state.
5042 void drm_mode_config_reset(struct drm_device *dev)
5044 struct drm_crtc *crtc;
5045 struct drm_plane *plane;
5046 struct drm_encoder *encoder;
5047 struct drm_connector *connector;
5049 list_for_each_entry(plane, &dev->mode_config.plane_list, head)
5050 if (plane->funcs->reset)
5051 plane->funcs->reset(plane);
5053 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
5054 if (crtc->funcs->reset)
5055 crtc->funcs->reset(crtc);
5057 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
5058 if (encoder->funcs->reset)
5059 encoder->funcs->reset(encoder);
5061 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
5062 connector->status = connector_status_unknown;
5064 if (connector->funcs->reset)
5065 connector->funcs->reset(connector);
5068 EXPORT_SYMBOL(drm_mode_config_reset);
5071 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
5074 * @file_priv: DRM file info
5076 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
5077 * TTM or something else entirely) and returns the resulting buffer handle. This
5078 * handle can then be wrapped up into a framebuffer modeset object.
5080 * Note that userspace is not allowed to use such objects for render
5081 * acceleration - drivers must create their own private ioctls for such a use
5084 * Called by the user via ioctl.
5087 * Zero on success, negative errno on failure.
5089 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
5090 void *data, struct drm_file *file_priv)
5092 struct drm_mode_create_dumb *args = data;
5093 u32 cpp, stride, size;
5095 if (!dev->driver->dumb_create)
5097 if (!args->width || !args->height || !args->bpp)
5100 /* overflow checks for 32bit size calculations */
5101 /* NOTE: DIV_ROUND_UP() can overflow */
5102 cpp = DIV_ROUND_UP(args->bpp, 8);
5103 if (!cpp || cpp > 0xffffffffU / args->width)
5105 stride = cpp * args->width;
5106 if (args->height > 0xffffffffU / stride)
5109 /* test for wrap-around */
5110 size = args->height * stride;
5111 if (PAGE_ALIGN(size) == 0)
5115 * handle, pitch and size are output parameters. Zero them out to
5116 * prevent drivers from accidentally using uninitialized data. Since
5117 * not all existing userspace is clearing these fields properly we
5118 * cannot reject IOCTL with garbage in them.
5124 return dev->driver->dumb_create(file_priv, dev, args);
5128 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5131 * @file_priv: DRM file info
5133 * Allocate an offset in the drm device node's address space to be able to
5134 * memory map a dumb buffer.
5136 * Called by the user via ioctl.
5139 * Zero on success, negative errno on failure.
5141 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5142 void *data, struct drm_file *file_priv)
5144 struct drm_mode_map_dumb *args = data;
5146 /* call driver ioctl to get mmap offset */
5147 if (!dev->driver->dumb_map_offset)
5150 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5154 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5157 * @file_priv: DRM file info
5159 * This destroys the userspace handle for the given dumb backing storage buffer.
5160 * Since buffer objects must be reference counted in the kernel a buffer object
5161 * won't be immediately freed if a framebuffer modeset object still uses it.
5163 * Called by the user via ioctl.
5166 * Zero on success, negative errno on failure.
5168 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5169 void *data, struct drm_file *file_priv)
5171 struct drm_mode_destroy_dumb *args = data;
5173 if (!dev->driver->dumb_destroy)
5176 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5180 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5181 * @format: pixel format (DRM_FORMAT_*)
5182 * @depth: storage for the depth value
5183 * @bpp: storage for the bpp value
5185 * This only supports RGB formats here for compat with code that doesn't use
5186 * pixel formats directly yet.
5188 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5193 case DRM_FORMAT_RGB332:
5194 case DRM_FORMAT_BGR233:
5198 case DRM_FORMAT_XRGB1555:
5199 case DRM_FORMAT_XBGR1555:
5200 case DRM_FORMAT_RGBX5551:
5201 case DRM_FORMAT_BGRX5551:
5202 case DRM_FORMAT_ARGB1555:
5203 case DRM_FORMAT_ABGR1555:
5204 case DRM_FORMAT_RGBA5551:
5205 case DRM_FORMAT_BGRA5551:
5209 case DRM_FORMAT_RGB565:
5210 case DRM_FORMAT_BGR565:
5214 case DRM_FORMAT_RGB888:
5215 case DRM_FORMAT_BGR888:
5219 case DRM_FORMAT_XRGB8888:
5220 case DRM_FORMAT_XBGR8888:
5221 case DRM_FORMAT_RGBX8888:
5222 case DRM_FORMAT_BGRX8888:
5226 case DRM_FORMAT_XRGB2101010:
5227 case DRM_FORMAT_XBGR2101010:
5228 case DRM_FORMAT_RGBX1010102:
5229 case DRM_FORMAT_BGRX1010102:
5230 case DRM_FORMAT_ARGB2101010:
5231 case DRM_FORMAT_ABGR2101010:
5232 case DRM_FORMAT_RGBA1010102:
5233 case DRM_FORMAT_BGRA1010102:
5237 case DRM_FORMAT_ARGB8888:
5238 case DRM_FORMAT_ABGR8888:
5239 case DRM_FORMAT_RGBA8888:
5240 case DRM_FORMAT_BGRA8888:
5245 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5246 drm_get_format_name(format));
5252 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5255 * drm_format_num_planes - get the number of planes for format
5256 * @format: pixel format (DRM_FORMAT_*)
5259 * The number of planes used by the specified pixel format.
5261 int drm_format_num_planes(uint32_t format)
5264 case DRM_FORMAT_YUV410:
5265 case DRM_FORMAT_YVU410:
5266 case DRM_FORMAT_YUV411:
5267 case DRM_FORMAT_YVU411:
5268 case DRM_FORMAT_YUV420:
5269 case DRM_FORMAT_YVU420:
5270 case DRM_FORMAT_YUV422:
5271 case DRM_FORMAT_YVU422:
5272 case DRM_FORMAT_YUV444:
5273 case DRM_FORMAT_YVU444:
5275 case DRM_FORMAT_NV12:
5276 case DRM_FORMAT_NV21:
5277 case DRM_FORMAT_NV16:
5278 case DRM_FORMAT_NV61:
5279 case DRM_FORMAT_NV24:
5280 case DRM_FORMAT_NV42:
5286 EXPORT_SYMBOL(drm_format_num_planes);
5289 * drm_format_plane_cpp - determine the bytes per pixel value
5290 * @format: pixel format (DRM_FORMAT_*)
5291 * @plane: plane index
5294 * The bytes per pixel value for the specified plane.
5296 int drm_format_plane_cpp(uint32_t format, int plane)
5301 if (plane >= drm_format_num_planes(format))
5305 case DRM_FORMAT_YUYV:
5306 case DRM_FORMAT_YVYU:
5307 case DRM_FORMAT_UYVY:
5308 case DRM_FORMAT_VYUY:
5310 case DRM_FORMAT_NV12:
5311 case DRM_FORMAT_NV21:
5312 case DRM_FORMAT_NV16:
5313 case DRM_FORMAT_NV61:
5314 case DRM_FORMAT_NV24:
5315 case DRM_FORMAT_NV42:
5316 return plane ? 2 : 1;
5317 case DRM_FORMAT_YUV410:
5318 case DRM_FORMAT_YVU410:
5319 case DRM_FORMAT_YUV411:
5320 case DRM_FORMAT_YVU411:
5321 case DRM_FORMAT_YUV420:
5322 case DRM_FORMAT_YVU420:
5323 case DRM_FORMAT_YUV422:
5324 case DRM_FORMAT_YVU422:
5325 case DRM_FORMAT_YUV444:
5326 case DRM_FORMAT_YVU444:
5329 drm_fb_get_bpp_depth(format, &depth, &bpp);
5333 EXPORT_SYMBOL(drm_format_plane_cpp);
5336 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5337 * @format: pixel format (DRM_FORMAT_*)
5340 * The horizontal chroma subsampling factor for the
5341 * specified pixel format.
5343 int drm_format_horz_chroma_subsampling(uint32_t format)
5346 case DRM_FORMAT_YUV411:
5347 case DRM_FORMAT_YVU411:
5348 case DRM_FORMAT_YUV410:
5349 case DRM_FORMAT_YVU410:
5351 case DRM_FORMAT_YUYV:
5352 case DRM_FORMAT_YVYU:
5353 case DRM_FORMAT_UYVY:
5354 case DRM_FORMAT_VYUY:
5355 case DRM_FORMAT_NV12:
5356 case DRM_FORMAT_NV21:
5357 case DRM_FORMAT_NV16:
5358 case DRM_FORMAT_NV61:
5359 case DRM_FORMAT_YUV422:
5360 case DRM_FORMAT_YVU422:
5361 case DRM_FORMAT_YUV420:
5362 case DRM_FORMAT_YVU420:
5368 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5371 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5372 * @format: pixel format (DRM_FORMAT_*)
5375 * The vertical chroma subsampling factor for the
5376 * specified pixel format.
5378 int drm_format_vert_chroma_subsampling(uint32_t format)
5381 case DRM_FORMAT_YUV410:
5382 case DRM_FORMAT_YVU410:
5384 case DRM_FORMAT_YUV420:
5385 case DRM_FORMAT_YVU420:
5386 case DRM_FORMAT_NV12:
5387 case DRM_FORMAT_NV21:
5393 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5396 * drm_rotation_simplify() - Try to simplify the rotation
5397 * @rotation: Rotation to be simplified
5398 * @supported_rotations: Supported rotations
5400 * Attempt to simplify the rotation to a form that is supported.
5401 * Eg. if the hardware supports everything except DRM_REFLECT_X
5402 * one could call this function like this:
5404 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5405 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5406 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5408 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5409 * transforms the hardware supports, this function may not
5410 * be able to produce a supported transform, so the caller should
5411 * check the result afterwards.
5413 unsigned int drm_rotation_simplify(unsigned int rotation,
5414 unsigned int supported_rotations)
5416 if (rotation & ~supported_rotations) {
5417 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5418 rotation = (rotation & ~0xf) | BIT((ffs(rotation & 0xf) + 1) % 4);
5423 EXPORT_SYMBOL(drm_rotation_simplify);
5426 * drm_mode_config_init - initialize DRM mode_configuration structure
5429 * Initialize @dev's mode_config structure, used for tracking the graphics
5430 * configuration of @dev.
5432 * Since this initializes the modeset locks, no locking is possible. Which is no
5433 * problem, since this should happen single threaded at init time. It is the
5434 * driver's problem to ensure this guarantee.
5437 void drm_mode_config_init(struct drm_device *dev)
5439 mutex_init(&dev->mode_config.mutex);
5440 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5441 mutex_init(&dev->mode_config.idr_mutex);
5442 mutex_init(&dev->mode_config.fb_lock);
5443 INIT_LIST_HEAD(&dev->mode_config.fb_list);
5444 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5445 INIT_LIST_HEAD(&dev->mode_config.connector_list);
5446 INIT_LIST_HEAD(&dev->mode_config.bridge_list);
5447 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5448 INIT_LIST_HEAD(&dev->mode_config.property_list);
5449 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5450 INIT_LIST_HEAD(&dev->mode_config.plane_list);
5451 idr_init(&dev->mode_config.crtc_idr);
5452 idr_init(&dev->mode_config.tile_idr);
5454 drm_modeset_lock_all(dev);
5455 drm_mode_create_standard_properties(dev);
5456 drm_modeset_unlock_all(dev);
5458 /* Just to be sure */
5459 dev->mode_config.num_fb = 0;
5460 dev->mode_config.num_connector = 0;
5461 dev->mode_config.num_crtc = 0;
5462 dev->mode_config.num_encoder = 0;
5463 dev->mode_config.num_overlay_plane = 0;
5464 dev->mode_config.num_total_plane = 0;
5466 EXPORT_SYMBOL(drm_mode_config_init);
5469 * drm_mode_config_cleanup - free up DRM mode_config info
5472 * Free up all the connectors and CRTCs associated with this DRM device, then
5473 * free up the framebuffers and associated buffer objects.
5475 * Note that since this /should/ happen single-threaded at driver/device
5476 * teardown time, no locking is required. It's the driver's job to ensure that
5477 * this guarantee actually holds true.
5479 * FIXME: cleanup any dangling user buffer objects too
5481 void drm_mode_config_cleanup(struct drm_device *dev)
5483 struct drm_connector *connector, *ot;
5484 struct drm_crtc *crtc, *ct;
5485 struct drm_encoder *encoder, *enct;
5486 struct drm_bridge *bridge, *brt;
5487 struct drm_framebuffer *fb, *fbt;
5488 struct drm_property *property, *pt;
5489 struct drm_property_blob *blob, *bt;
5490 struct drm_plane *plane, *plt;
5492 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5494 encoder->funcs->destroy(encoder);
5497 list_for_each_entry_safe(bridge, brt,
5498 &dev->mode_config.bridge_list, head) {
5499 bridge->funcs->destroy(bridge);
5502 list_for_each_entry_safe(connector, ot,
5503 &dev->mode_config.connector_list, head) {
5504 connector->funcs->destroy(connector);
5507 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5509 drm_property_destroy(dev, property);
5512 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
5514 drm_property_destroy_blob(dev, blob);
5518 * Single-threaded teardown context, so it's not required to grab the
5519 * fb_lock to protect against concurrent fb_list access. Contrary, it
5520 * would actually deadlock with the drm_framebuffer_cleanup function.
5522 * Also, if there are any framebuffers left, that's a driver leak now,
5523 * so politely WARN about this.
5525 WARN_ON(!list_empty(&dev->mode_config.fb_list));
5526 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
5527 drm_framebuffer_remove(fb);
5530 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
5532 plane->funcs->destroy(plane);
5535 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
5536 crtc->funcs->destroy(crtc);
5539 idr_destroy(&dev->mode_config.tile_idr);
5540 idr_destroy(&dev->mode_config.crtc_idr);
5541 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
5543 EXPORT_SYMBOL(drm_mode_config_cleanup);
5545 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
5546 unsigned int supported_rotations)
5548 static const struct drm_prop_enum_list props[] = {
5549 { DRM_ROTATE_0, "rotate-0" },
5550 { DRM_ROTATE_90, "rotate-90" },
5551 { DRM_ROTATE_180, "rotate-180" },
5552 { DRM_ROTATE_270, "rotate-270" },
5553 { DRM_REFLECT_X, "reflect-x" },
5554 { DRM_REFLECT_Y, "reflect-y" },
5557 return drm_property_create_bitmask(dev, 0, "rotation",
5558 props, ARRAY_SIZE(props),
5559 supported_rotations);
5561 EXPORT_SYMBOL(drm_mode_create_rotation_property);
5566 * Tile groups are used to represent tiled monitors with a unique
5567 * integer identifier. Tiled monitors using DisplayID v1.3 have
5568 * a unique 8-byte handle, we store this in a tile group, so we
5569 * have a common identifier for all tiles in a monitor group.
5571 static void drm_tile_group_free(struct kref *kref)
5573 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
5574 struct drm_device *dev = tg->dev;
5575 mutex_lock(&dev->mode_config.idr_mutex);
5576 idr_remove(&dev->mode_config.tile_idr, tg->id);
5577 mutex_unlock(&dev->mode_config.idr_mutex);
5582 * drm_mode_put_tile_group - drop a reference to a tile group.
5584 * @tg: tile group to drop reference to.
5586 * drop reference to tile group and free if 0.
5588 void drm_mode_put_tile_group(struct drm_device *dev,
5589 struct drm_tile_group *tg)
5591 kref_put(&tg->refcount, drm_tile_group_free);
5595 * drm_mode_get_tile_group - get a reference to an existing tile group
5597 * @topology: 8-bytes unique per monitor.
5599 * Use the unique bytes to get a reference to an existing tile group.
5602 * tile group or NULL if not found.
5604 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
5607 struct drm_tile_group *tg;
5609 mutex_lock(&dev->mode_config.idr_mutex);
5610 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
5611 if (!memcmp(tg->group_data, topology, 8)) {
5612 if (!kref_get_unless_zero(&tg->refcount))
5614 mutex_unlock(&dev->mode_config.idr_mutex);
5618 mutex_unlock(&dev->mode_config.idr_mutex);
5623 * drm_mode_create_tile_group - create a tile group from a displayid description
5625 * @topology: 8-bytes unique per monitor.
5627 * Create a tile group for the unique monitor, and get a unique
5628 * identifier for the tile group.
5631 * new tile group or error.
5633 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
5636 struct drm_tile_group *tg;
5639 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
5641 return ERR_PTR(-ENOMEM);
5643 kref_init(&tg->refcount);
5644 memcpy(tg->group_data, topology, 8);
5647 mutex_lock(&dev->mode_config.idr_mutex);
5648 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
5656 mutex_unlock(&dev->mode_config.idr_mutex);