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 * @formats: array containing the supported bus formats
772 * @num_formats: 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_encoder_init - Init a preallocated encoder
1071 * @encoder: the encoder to init
1072 * @funcs: callbacks for this encoder
1073 * @encoder_type: user visible type of the encoder
1075 * Initialises a preallocated encoder. Encoder should be
1076 * subclassed as part of driver encoder objects.
1079 * Zero on success, error code on failure.
1081 int drm_encoder_init(struct drm_device *dev,
1082 struct drm_encoder *encoder,
1083 const struct drm_encoder_funcs *funcs,
1088 drm_modeset_lock_all(dev);
1090 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1095 encoder->encoder_type = encoder_type;
1096 encoder->funcs = funcs;
1097 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1098 drm_encoder_enum_list[encoder_type].name,
1100 if (!encoder->name) {
1105 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1106 dev->mode_config.num_encoder++;
1110 drm_mode_object_put(dev, &encoder->base);
1113 drm_modeset_unlock_all(dev);
1117 EXPORT_SYMBOL(drm_encoder_init);
1120 * drm_encoder_cleanup - cleans up an initialised encoder
1121 * @encoder: encoder to cleanup
1123 * Cleans up the encoder but doesn't free the object.
1125 void drm_encoder_cleanup(struct drm_encoder *encoder)
1127 struct drm_device *dev = encoder->dev;
1129 drm_modeset_lock_all(dev);
1130 drm_mode_object_put(dev, &encoder->base);
1131 kfree(encoder->name);
1132 list_del(&encoder->head);
1133 dev->mode_config.num_encoder--;
1134 drm_modeset_unlock_all(dev);
1136 memset(encoder, 0, sizeof(*encoder));
1138 EXPORT_SYMBOL(drm_encoder_cleanup);
1141 * drm_universal_plane_init - Initialize a new universal plane object
1143 * @plane: plane object to init
1144 * @possible_crtcs: bitmask of possible CRTCs
1145 * @funcs: callbacks for the new plane
1146 * @formats: array of supported formats (%DRM_FORMAT_*)
1147 * @format_count: number of elements in @formats
1148 * @type: type of plane (overlay, primary, cursor)
1150 * Initializes a plane object of type @type.
1153 * Zero on success, error code on failure.
1155 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1156 unsigned long possible_crtcs,
1157 const struct drm_plane_funcs *funcs,
1158 const uint32_t *formats, uint32_t format_count,
1159 enum drm_plane_type type)
1161 struct drm_mode_config *config = &dev->mode_config;
1164 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1168 drm_modeset_lock_init(&plane->mutex);
1170 plane->base.properties = &plane->properties;
1172 plane->funcs = funcs;
1173 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1175 if (!plane->format_types) {
1176 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1177 drm_mode_object_put(dev, &plane->base);
1181 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1182 plane->format_count = format_count;
1183 plane->possible_crtcs = possible_crtcs;
1186 list_add_tail(&plane->head, &config->plane_list);
1187 config->num_total_plane++;
1188 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1189 config->num_overlay_plane++;
1191 drm_object_attach_property(&plane->base,
1192 config->plane_type_property,
1195 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1196 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1197 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1198 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1199 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1200 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1201 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1202 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1203 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1204 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1205 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1210 EXPORT_SYMBOL(drm_universal_plane_init);
1213 * drm_plane_init - Initialize a legacy plane
1215 * @plane: plane object to init
1216 * @possible_crtcs: bitmask of possible CRTCs
1217 * @funcs: callbacks for the new plane
1218 * @formats: array of supported formats (%DRM_FORMAT_*)
1219 * @format_count: number of elements in @formats
1220 * @is_primary: plane type (primary vs overlay)
1222 * Legacy API to initialize a DRM plane.
1224 * New drivers should call drm_universal_plane_init() instead.
1227 * Zero on success, error code on failure.
1229 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1230 unsigned long possible_crtcs,
1231 const struct drm_plane_funcs *funcs,
1232 const uint32_t *formats, uint32_t format_count,
1235 enum drm_plane_type type;
1237 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1238 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1239 formats, format_count, type);
1241 EXPORT_SYMBOL(drm_plane_init);
1244 * drm_plane_cleanup - Clean up the core plane usage
1245 * @plane: plane to cleanup
1247 * This function cleans up @plane and removes it from the DRM mode setting
1248 * core. Note that the function does *not* free the plane structure itself,
1249 * this is the responsibility of the caller.
1251 void drm_plane_cleanup(struct drm_plane *plane)
1253 struct drm_device *dev = plane->dev;
1255 drm_modeset_lock_all(dev);
1256 kfree(plane->format_types);
1257 drm_mode_object_put(dev, &plane->base);
1259 BUG_ON(list_empty(&plane->head));
1261 list_del(&plane->head);
1262 dev->mode_config.num_total_plane--;
1263 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1264 dev->mode_config.num_overlay_plane--;
1265 drm_modeset_unlock_all(dev);
1267 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1268 if (plane->state && plane->funcs->atomic_destroy_state)
1269 plane->funcs->atomic_destroy_state(plane, plane->state);
1271 memset(plane, 0, sizeof(*plane));
1273 EXPORT_SYMBOL(drm_plane_cleanup);
1276 * drm_plane_index - find the index of a registered plane
1277 * @plane: plane to find index for
1279 * Given a registered plane, return the index of that CRTC within a DRM
1280 * device's list of planes.
1282 unsigned int drm_plane_index(struct drm_plane *plane)
1284 unsigned int index = 0;
1285 struct drm_plane *tmp;
1287 list_for_each_entry(tmp, &plane->dev->mode_config.plane_list, head) {
1296 EXPORT_SYMBOL(drm_plane_index);
1299 * drm_plane_force_disable - Forcibly disable a plane
1300 * @plane: plane to disable
1302 * Forces the plane to be disabled.
1304 * Used when the plane's current framebuffer is destroyed,
1305 * and when restoring fbdev mode.
1307 void drm_plane_force_disable(struct drm_plane *plane)
1314 plane->old_fb = plane->fb;
1315 ret = plane->funcs->disable_plane(plane);
1317 DRM_ERROR("failed to disable plane with busy fb\n");
1318 plane->old_fb = NULL;
1321 /* disconnect the plane from the fb and crtc: */
1322 __drm_framebuffer_unreference(plane->old_fb);
1323 plane->old_fb = NULL;
1327 EXPORT_SYMBOL(drm_plane_force_disable);
1329 static int drm_mode_create_standard_properties(struct drm_device *dev)
1331 struct drm_property *prop;
1334 * Standard properties (apply to all connectors)
1336 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1337 DRM_MODE_PROP_IMMUTABLE,
1341 dev->mode_config.edid_property = prop;
1343 prop = drm_property_create_enum(dev, 0,
1344 "DPMS", drm_dpms_enum_list,
1345 ARRAY_SIZE(drm_dpms_enum_list));
1348 dev->mode_config.dpms_property = prop;
1350 prop = drm_property_create(dev,
1351 DRM_MODE_PROP_BLOB |
1352 DRM_MODE_PROP_IMMUTABLE,
1356 dev->mode_config.path_property = prop;
1358 prop = drm_property_create(dev,
1359 DRM_MODE_PROP_BLOB |
1360 DRM_MODE_PROP_IMMUTABLE,
1364 dev->mode_config.tile_property = prop;
1366 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1367 "type", drm_plane_type_enum_list,
1368 ARRAY_SIZE(drm_plane_type_enum_list));
1371 dev->mode_config.plane_type_property = prop;
1373 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1374 "SRC_X", 0, UINT_MAX);
1377 dev->mode_config.prop_src_x = prop;
1379 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1380 "SRC_Y", 0, UINT_MAX);
1383 dev->mode_config.prop_src_y = prop;
1385 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1386 "SRC_W", 0, UINT_MAX);
1389 dev->mode_config.prop_src_w = prop;
1391 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1392 "SRC_H", 0, UINT_MAX);
1395 dev->mode_config.prop_src_h = prop;
1397 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1398 "CRTC_X", INT_MIN, INT_MAX);
1401 dev->mode_config.prop_crtc_x = prop;
1403 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1404 "CRTC_Y", INT_MIN, INT_MAX);
1407 dev->mode_config.prop_crtc_y = prop;
1409 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1410 "CRTC_W", 0, INT_MAX);
1413 dev->mode_config.prop_crtc_w = prop;
1415 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1416 "CRTC_H", 0, INT_MAX);
1419 dev->mode_config.prop_crtc_h = prop;
1421 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1422 "FB_ID", DRM_MODE_OBJECT_FB);
1425 dev->mode_config.prop_fb_id = prop;
1427 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1428 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1431 dev->mode_config.prop_crtc_id = prop;
1433 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
1437 dev->mode_config.prop_active = prop;
1443 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1446 * Called by a driver the first time a DVI-I connector is made.
1448 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1450 struct drm_property *dvi_i_selector;
1451 struct drm_property *dvi_i_subconnector;
1453 if (dev->mode_config.dvi_i_select_subconnector_property)
1457 drm_property_create_enum(dev, 0,
1458 "select subconnector",
1459 drm_dvi_i_select_enum_list,
1460 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1461 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1463 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1465 drm_dvi_i_subconnector_enum_list,
1466 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1467 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1471 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1474 * drm_create_tv_properties - create TV specific connector properties
1476 * @num_modes: number of different TV formats (modes) supported
1477 * @modes: array of pointers to strings containing name of each format
1479 * Called by a driver's TV initialization routine, this function creates
1480 * the TV specific connector properties for a given device. Caller is
1481 * responsible for allocating a list of format names and passing them to
1484 int drm_mode_create_tv_properties(struct drm_device *dev,
1485 unsigned int num_modes,
1488 struct drm_property *tv_selector;
1489 struct drm_property *tv_subconnector;
1492 if (dev->mode_config.tv_select_subconnector_property)
1496 * Basic connector properties
1498 tv_selector = drm_property_create_enum(dev, 0,
1499 "select subconnector",
1500 drm_tv_select_enum_list,
1501 ARRAY_SIZE(drm_tv_select_enum_list));
1502 dev->mode_config.tv_select_subconnector_property = tv_selector;
1505 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1507 drm_tv_subconnector_enum_list,
1508 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1509 dev->mode_config.tv_subconnector_property = tv_subconnector;
1512 * Other, TV specific properties: margins & TV modes.
1514 dev->mode_config.tv_left_margin_property =
1515 drm_property_create_range(dev, 0, "left margin", 0, 100);
1517 dev->mode_config.tv_right_margin_property =
1518 drm_property_create_range(dev, 0, "right margin", 0, 100);
1520 dev->mode_config.tv_top_margin_property =
1521 drm_property_create_range(dev, 0, "top margin", 0, 100);
1523 dev->mode_config.tv_bottom_margin_property =
1524 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1526 dev->mode_config.tv_mode_property =
1527 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1529 for (i = 0; i < num_modes; i++)
1530 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1533 dev->mode_config.tv_brightness_property =
1534 drm_property_create_range(dev, 0, "brightness", 0, 100);
1536 dev->mode_config.tv_contrast_property =
1537 drm_property_create_range(dev, 0, "contrast", 0, 100);
1539 dev->mode_config.tv_flicker_reduction_property =
1540 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1542 dev->mode_config.tv_overscan_property =
1543 drm_property_create_range(dev, 0, "overscan", 0, 100);
1545 dev->mode_config.tv_saturation_property =
1546 drm_property_create_range(dev, 0, "saturation", 0, 100);
1548 dev->mode_config.tv_hue_property =
1549 drm_property_create_range(dev, 0, "hue", 0, 100);
1553 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1556 * drm_mode_create_scaling_mode_property - create scaling mode property
1559 * Called by a driver the first time it's needed, must be attached to desired
1562 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1564 struct drm_property *scaling_mode;
1566 if (dev->mode_config.scaling_mode_property)
1570 drm_property_create_enum(dev, 0, "scaling mode",
1571 drm_scaling_mode_enum_list,
1572 ARRAY_SIZE(drm_scaling_mode_enum_list));
1574 dev->mode_config.scaling_mode_property = scaling_mode;
1578 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1581 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1584 * Called by a driver the first time it's needed, must be attached to desired
1588 * Zero on success, negative errno on failure.
1590 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1592 if (dev->mode_config.aspect_ratio_property)
1595 dev->mode_config.aspect_ratio_property =
1596 drm_property_create_enum(dev, 0, "aspect ratio",
1597 drm_aspect_ratio_enum_list,
1598 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1600 if (dev->mode_config.aspect_ratio_property == NULL)
1605 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1608 * drm_mode_create_dirty_property - create dirty property
1611 * Called by a driver the first time it's needed, must be attached to desired
1614 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1616 struct drm_property *dirty_info;
1618 if (dev->mode_config.dirty_info_property)
1622 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1624 drm_dirty_info_enum_list,
1625 ARRAY_SIZE(drm_dirty_info_enum_list));
1626 dev->mode_config.dirty_info_property = dirty_info;
1630 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1633 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1636 * Create the the suggested x/y offset property for connectors.
1638 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1640 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1643 dev->mode_config.suggested_x_property =
1644 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1646 dev->mode_config.suggested_y_property =
1647 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1649 if (dev->mode_config.suggested_x_property == NULL ||
1650 dev->mode_config.suggested_y_property == NULL)
1654 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1656 static int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
1658 uint32_t total_objects = 0;
1660 total_objects += dev->mode_config.num_crtc;
1661 total_objects += dev->mode_config.num_connector;
1662 total_objects += dev->mode_config.num_encoder;
1664 group->id_list = kcalloc(total_objects, sizeof(uint32_t), GFP_KERNEL);
1665 if (!group->id_list)
1668 group->num_crtcs = 0;
1669 group->num_connectors = 0;
1670 group->num_encoders = 0;
1674 void drm_mode_group_destroy(struct drm_mode_group *group)
1676 kfree(group->id_list);
1677 group->id_list = NULL;
1681 * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1682 * the drm core's responsibility to set up mode control groups.
1684 int drm_mode_group_init_legacy_group(struct drm_device *dev,
1685 struct drm_mode_group *group)
1687 struct drm_crtc *crtc;
1688 struct drm_encoder *encoder;
1689 struct drm_connector *connector;
1692 ret = drm_mode_group_init(dev, group);
1696 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
1697 group->id_list[group->num_crtcs++] = crtc->base.id;
1699 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
1700 group->id_list[group->num_crtcs + group->num_encoders++] =
1703 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1704 group->id_list[group->num_crtcs + group->num_encoders +
1705 group->num_connectors++] = connector->base.id;
1709 EXPORT_SYMBOL(drm_mode_group_init_legacy_group);
1711 void drm_reinit_primary_mode_group(struct drm_device *dev)
1713 drm_modeset_lock_all(dev);
1714 drm_mode_group_destroy(&dev->primary->mode_group);
1715 drm_mode_group_init_legacy_group(dev, &dev->primary->mode_group);
1716 drm_modeset_unlock_all(dev);
1718 EXPORT_SYMBOL(drm_reinit_primary_mode_group);
1721 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1722 * @out: drm_mode_modeinfo struct to return to the user
1723 * @in: drm_display_mode to use
1725 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1728 static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
1729 const struct drm_display_mode *in)
1731 WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1732 in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1733 in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1734 in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1735 in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1736 "timing values too large for mode info\n");
1738 out->clock = in->clock;
1739 out->hdisplay = in->hdisplay;
1740 out->hsync_start = in->hsync_start;
1741 out->hsync_end = in->hsync_end;
1742 out->htotal = in->htotal;
1743 out->hskew = in->hskew;
1744 out->vdisplay = in->vdisplay;
1745 out->vsync_start = in->vsync_start;
1746 out->vsync_end = in->vsync_end;
1747 out->vtotal = in->vtotal;
1748 out->vscan = in->vscan;
1749 out->vrefresh = in->vrefresh;
1750 out->flags = in->flags;
1751 out->type = in->type;
1752 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1753 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1757 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1758 * @out: drm_display_mode to return to the user
1759 * @in: drm_mode_modeinfo to use
1761 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1765 * Zero on success, negative errno on failure.
1767 static int drm_crtc_convert_umode(struct drm_display_mode *out,
1768 const struct drm_mode_modeinfo *in)
1770 if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1773 if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1776 out->clock = in->clock;
1777 out->hdisplay = in->hdisplay;
1778 out->hsync_start = in->hsync_start;
1779 out->hsync_end = in->hsync_end;
1780 out->htotal = in->htotal;
1781 out->hskew = in->hskew;
1782 out->vdisplay = in->vdisplay;
1783 out->vsync_start = in->vsync_start;
1784 out->vsync_end = in->vsync_end;
1785 out->vtotal = in->vtotal;
1786 out->vscan = in->vscan;
1787 out->vrefresh = in->vrefresh;
1788 out->flags = in->flags;
1789 out->type = in->type;
1790 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1791 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1797 * drm_mode_getresources - get graphics configuration
1798 * @dev: drm device for the ioctl
1799 * @data: data pointer for the ioctl
1800 * @file_priv: drm file for the ioctl call
1802 * Construct a set of configuration description structures and return
1803 * them to the user, including CRTC, connector and framebuffer configuration.
1805 * Called by the user via ioctl.
1808 * Zero on success, negative errno on failure.
1810 int drm_mode_getresources(struct drm_device *dev, void *data,
1811 struct drm_file *file_priv)
1813 struct drm_mode_card_res *card_res = data;
1814 struct list_head *lh;
1815 struct drm_framebuffer *fb;
1816 struct drm_connector *connector;
1817 struct drm_crtc *crtc;
1818 struct drm_encoder *encoder;
1820 int connector_count = 0;
1823 int encoder_count = 0;
1825 uint32_t __user *fb_id;
1826 uint32_t __user *crtc_id;
1827 uint32_t __user *connector_id;
1828 uint32_t __user *encoder_id;
1829 struct drm_mode_group *mode_group;
1831 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1835 mutex_lock(&file_priv->fbs_lock);
1837 * For the non-control nodes we need to limit the list of resources
1838 * by IDs in the group list for this node
1840 list_for_each(lh, &file_priv->fbs)
1843 /* handle this in 4 parts */
1845 if (card_res->count_fbs >= fb_count) {
1847 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1848 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1849 if (put_user(fb->base.id, fb_id + copied)) {
1850 mutex_unlock(&file_priv->fbs_lock);
1856 card_res->count_fbs = fb_count;
1857 mutex_unlock(&file_priv->fbs_lock);
1859 /* mode_config.mutex protects the connector list against e.g. DP MST
1860 * connector hot-adding. CRTC/Plane lists are invariant. */
1861 mutex_lock(&dev->mode_config.mutex);
1862 if (!drm_is_primary_client(file_priv)) {
1865 list_for_each(lh, &dev->mode_config.crtc_list)
1868 list_for_each(lh, &dev->mode_config.connector_list)
1871 list_for_each(lh, &dev->mode_config.encoder_list)
1875 mode_group = &file_priv->master->minor->mode_group;
1876 crtc_count = mode_group->num_crtcs;
1877 connector_count = mode_group->num_connectors;
1878 encoder_count = mode_group->num_encoders;
1881 card_res->max_height = dev->mode_config.max_height;
1882 card_res->min_height = dev->mode_config.min_height;
1883 card_res->max_width = dev->mode_config.max_width;
1884 card_res->min_width = dev->mode_config.min_width;
1887 if (card_res->count_crtcs >= crtc_count) {
1889 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1891 list_for_each_entry(crtc, &dev->mode_config.crtc_list,
1893 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1894 if (put_user(crtc->base.id, crtc_id + copied)) {
1901 for (i = 0; i < mode_group->num_crtcs; i++) {
1902 if (put_user(mode_group->id_list[i],
1903 crtc_id + copied)) {
1911 card_res->count_crtcs = crtc_count;
1914 if (card_res->count_encoders >= encoder_count) {
1916 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1918 list_for_each_entry(encoder,
1919 &dev->mode_config.encoder_list,
1921 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1923 if (put_user(encoder->base.id, encoder_id +
1931 for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
1932 if (put_user(mode_group->id_list[i],
1933 encoder_id + copied)) {
1942 card_res->count_encoders = encoder_count;
1945 if (card_res->count_connectors >= connector_count) {
1947 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1949 list_for_each_entry(connector,
1950 &dev->mode_config.connector_list,
1952 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1955 if (put_user(connector->base.id,
1956 connector_id + copied)) {
1963 int start = mode_group->num_crtcs +
1964 mode_group->num_encoders;
1965 for (i = start; i < start + mode_group->num_connectors; i++) {
1966 if (put_user(mode_group->id_list[i],
1967 connector_id + copied)) {
1975 card_res->count_connectors = connector_count;
1977 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1978 card_res->count_connectors, card_res->count_encoders);
1981 mutex_unlock(&dev->mode_config.mutex);
1986 * drm_mode_getcrtc - get CRTC configuration
1987 * @dev: drm device for the ioctl
1988 * @data: data pointer for the ioctl
1989 * @file_priv: drm file for the ioctl call
1991 * Construct a CRTC configuration structure to return to the user.
1993 * Called by the user via ioctl.
1996 * Zero on success, negative errno on failure.
1998 int drm_mode_getcrtc(struct drm_device *dev,
1999 void *data, struct drm_file *file_priv)
2001 struct drm_mode_crtc *crtc_resp = data;
2002 struct drm_crtc *crtc;
2004 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2007 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
2011 drm_modeset_lock_crtc(crtc, crtc->primary);
2012 crtc_resp->gamma_size = crtc->gamma_size;
2013 if (crtc->primary->fb)
2014 crtc_resp->fb_id = crtc->primary->fb->base.id;
2016 crtc_resp->fb_id = 0;
2019 crtc_resp->x = crtc->primary->state->src_x >> 16;
2020 crtc_resp->y = crtc->primary->state->src_y >> 16;
2021 if (crtc->state->enable) {
2022 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
2023 crtc_resp->mode_valid = 1;
2026 crtc_resp->mode_valid = 0;
2029 crtc_resp->x = crtc->x;
2030 crtc_resp->y = crtc->y;
2031 if (crtc->enabled) {
2032 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2033 crtc_resp->mode_valid = 1;
2036 crtc_resp->mode_valid = 0;
2039 drm_modeset_unlock_crtc(crtc);
2044 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2045 const struct drm_file *file_priv)
2048 * If user-space hasn't configured the driver to expose the stereo 3D
2049 * modes, don't expose them.
2051 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2057 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2059 /* For atomic drivers only state objects are synchronously updated and
2060 * protected by modeset locks, so check those first. */
2061 if (connector->state)
2062 return connector->state->best_encoder;
2063 return connector->encoder;
2066 /* helper for getconnector and getproperties ioctls */
2067 static int get_properties(struct drm_mode_object *obj, bool atomic,
2068 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2069 uint32_t *arg_count_props)
2074 props_count = obj->properties->count;
2076 props_count -= obj->properties->atomic_count;
2078 if ((*arg_count_props >= props_count) && props_count) {
2079 for (i = 0, copied = 0; copied < props_count; i++) {
2080 struct drm_property *prop = obj->properties->properties[i];
2083 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2086 ret = drm_object_property_get_value(obj, prop, &val);
2090 if (put_user(prop->base.id, prop_ptr + copied))
2093 if (put_user(val, prop_values + copied))
2099 *arg_count_props = props_count;
2105 * drm_mode_getconnector - get connector configuration
2106 * @dev: drm device for the ioctl
2107 * @data: data pointer for the ioctl
2108 * @file_priv: drm file for the ioctl call
2110 * Construct a connector configuration structure to return to the user.
2112 * Called by the user via ioctl.
2115 * Zero on success, negative errno on failure.
2117 int drm_mode_getconnector(struct drm_device *dev, void *data,
2118 struct drm_file *file_priv)
2120 struct drm_mode_get_connector *out_resp = data;
2121 struct drm_connector *connector;
2122 struct drm_encoder *encoder;
2123 struct drm_display_mode *mode;
2125 int encoders_count = 0;
2129 struct drm_mode_modeinfo u_mode;
2130 struct drm_mode_modeinfo __user *mode_ptr;
2131 uint32_t __user *encoder_ptr;
2133 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2136 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2138 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2140 mutex_lock(&dev->mode_config.mutex);
2141 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2143 connector = drm_connector_find(dev, out_resp->connector_id);
2149 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2150 if (connector->encoder_ids[i] != 0)
2153 if (out_resp->count_modes == 0) {
2154 connector->funcs->fill_modes(connector,
2155 dev->mode_config.max_width,
2156 dev->mode_config.max_height);
2159 /* delayed so we get modes regardless of pre-fill_modes state */
2160 list_for_each_entry(mode, &connector->modes, head)
2161 if (drm_mode_expose_to_userspace(mode, file_priv))
2164 out_resp->connector_id = connector->base.id;
2165 out_resp->connector_type = connector->connector_type;
2166 out_resp->connector_type_id = connector->connector_type_id;
2167 out_resp->mm_width = connector->display_info.width_mm;
2168 out_resp->mm_height = connector->display_info.height_mm;
2169 out_resp->subpixel = connector->display_info.subpixel_order;
2170 out_resp->connection = connector->status;
2171 encoder = drm_connector_get_encoder(connector);
2173 out_resp->encoder_id = encoder->base.id;
2175 out_resp->encoder_id = 0;
2178 * This ioctl is called twice, once to determine how much space is
2179 * needed, and the 2nd time to fill it.
2181 if ((out_resp->count_modes >= mode_count) && mode_count) {
2183 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2184 list_for_each_entry(mode, &connector->modes, head) {
2185 if (!drm_mode_expose_to_userspace(mode, file_priv))
2188 drm_crtc_convert_to_umode(&u_mode, mode);
2189 if (copy_to_user(mode_ptr + copied,
2190 &u_mode, sizeof(u_mode))) {
2197 out_resp->count_modes = mode_count;
2199 ret = get_properties(&connector->base, file_priv->atomic,
2200 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2201 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2202 &out_resp->count_props);
2206 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2208 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2209 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2210 if (connector->encoder_ids[i] != 0) {
2211 if (put_user(connector->encoder_ids[i],
2212 encoder_ptr + copied)) {
2220 out_resp->count_encoders = encoders_count;
2223 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2224 mutex_unlock(&dev->mode_config.mutex);
2229 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2231 struct drm_connector *connector;
2232 struct drm_device *dev = encoder->dev;
2233 bool uses_atomic = false;
2235 /* For atomic drivers only state objects are synchronously updated and
2236 * protected by modeset locks, so check those first. */
2237 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
2238 if (!connector->state)
2243 if (connector->state->best_encoder != encoder)
2246 return connector->state->crtc;
2249 /* Don't return stale data (e.g. pending async disable). */
2253 return encoder->crtc;
2257 * drm_mode_getencoder - get encoder configuration
2258 * @dev: drm device for the ioctl
2259 * @data: data pointer for the ioctl
2260 * @file_priv: drm file for the ioctl call
2262 * Construct a encoder configuration structure to return to the user.
2264 * Called by the user via ioctl.
2267 * Zero on success, negative errno on failure.
2269 int drm_mode_getencoder(struct drm_device *dev, void *data,
2270 struct drm_file *file_priv)
2272 struct drm_mode_get_encoder *enc_resp = data;
2273 struct drm_encoder *encoder;
2274 struct drm_crtc *crtc;
2276 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2279 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2283 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2284 crtc = drm_encoder_get_crtc(encoder);
2286 enc_resp->crtc_id = crtc->base.id;
2287 else if (encoder->crtc)
2288 enc_resp->crtc_id = encoder->crtc->base.id;
2290 enc_resp->crtc_id = 0;
2291 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2293 enc_resp->encoder_type = encoder->encoder_type;
2294 enc_resp->encoder_id = encoder->base.id;
2295 enc_resp->possible_crtcs = encoder->possible_crtcs;
2296 enc_resp->possible_clones = encoder->possible_clones;
2302 * drm_mode_getplane_res - enumerate all plane resources
2305 * @file_priv: DRM file info
2307 * Construct a list of plane ids to return to the user.
2309 * Called by the user via ioctl.
2312 * Zero on success, negative errno on failure.
2314 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2315 struct drm_file *file_priv)
2317 struct drm_mode_get_plane_res *plane_resp = data;
2318 struct drm_mode_config *config;
2319 struct drm_plane *plane;
2320 uint32_t __user *plane_ptr;
2322 unsigned num_planes;
2324 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2327 config = &dev->mode_config;
2329 if (file_priv->universal_planes)
2330 num_planes = config->num_total_plane;
2332 num_planes = config->num_overlay_plane;
2335 * This ioctl is called twice, once to determine how much space is
2336 * needed, and the 2nd time to fill it.
2339 (plane_resp->count_planes >= num_planes)) {
2340 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2342 /* Plane lists are invariant, no locking needed. */
2343 list_for_each_entry(plane, &config->plane_list, head) {
2345 * Unless userspace set the 'universal planes'
2346 * capability bit, only advertise overlays.
2348 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2349 !file_priv->universal_planes)
2352 if (put_user(plane->base.id, plane_ptr + copied))
2357 plane_resp->count_planes = num_planes;
2363 * drm_mode_getplane - get plane configuration
2366 * @file_priv: DRM file info
2368 * Construct a plane configuration structure to return to the user.
2370 * Called by the user via ioctl.
2373 * Zero on success, negative errno on failure.
2375 int drm_mode_getplane(struct drm_device *dev, void *data,
2376 struct drm_file *file_priv)
2378 struct drm_mode_get_plane *plane_resp = data;
2379 struct drm_plane *plane;
2380 uint32_t __user *format_ptr;
2382 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2385 plane = drm_plane_find(dev, plane_resp->plane_id);
2389 drm_modeset_lock(&plane->mutex, NULL);
2391 plane_resp->crtc_id = plane->crtc->base.id;
2393 plane_resp->crtc_id = 0;
2396 plane_resp->fb_id = plane->fb->base.id;
2398 plane_resp->fb_id = 0;
2399 drm_modeset_unlock(&plane->mutex);
2401 plane_resp->plane_id = plane->base.id;
2402 plane_resp->possible_crtcs = plane->possible_crtcs;
2403 plane_resp->gamma_size = 0;
2406 * This ioctl is called twice, once to determine how much space is
2407 * needed, and the 2nd time to fill it.
2409 if (plane->format_count &&
2410 (plane_resp->count_format_types >= plane->format_count)) {
2411 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2412 if (copy_to_user(format_ptr,
2413 plane->format_types,
2414 sizeof(uint32_t) * plane->format_count)) {
2418 plane_resp->count_format_types = plane->format_count;
2424 * setplane_internal - setplane handler for internal callers
2426 * Note that we assume an extra reference has already been taken on fb. If the
2427 * update fails, this reference will be dropped before return; if it succeeds,
2428 * the previous framebuffer (if any) will be unreferenced instead.
2430 * src_{x,y,w,h} are provided in 16.16 fixed point format
2432 static int __setplane_internal(struct drm_plane *plane,
2433 struct drm_crtc *crtc,
2434 struct drm_framebuffer *fb,
2435 int32_t crtc_x, int32_t crtc_y,
2436 uint32_t crtc_w, uint32_t crtc_h,
2437 /* src_{x,y,w,h} values are 16.16 fixed point */
2438 uint32_t src_x, uint32_t src_y,
2439 uint32_t src_w, uint32_t src_h)
2442 unsigned int fb_width, fb_height;
2445 /* No fb means shut it down */
2447 plane->old_fb = plane->fb;
2448 ret = plane->funcs->disable_plane(plane);
2453 plane->old_fb = NULL;
2458 /* Check whether this plane is usable on this CRTC */
2459 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2460 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2465 /* Check whether this plane supports the fb pixel format. */
2466 for (i = 0; i < plane->format_count; i++)
2467 if (fb->pixel_format == plane->format_types[i])
2469 if (i == plane->format_count) {
2470 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2471 drm_get_format_name(fb->pixel_format));
2476 fb_width = fb->width << 16;
2477 fb_height = fb->height << 16;
2479 /* Make sure source coordinates are inside the fb. */
2480 if (src_w > fb_width ||
2481 src_x > fb_width - src_w ||
2482 src_h > fb_height ||
2483 src_y > fb_height - src_h) {
2484 DRM_DEBUG_KMS("Invalid source coordinates "
2485 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2486 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2487 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2488 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2489 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2494 plane->old_fb = plane->fb;
2495 ret = plane->funcs->update_plane(plane, crtc, fb,
2496 crtc_x, crtc_y, crtc_w, crtc_h,
2497 src_x, src_y, src_w, src_h);
2503 plane->old_fb = NULL;
2508 drm_framebuffer_unreference(fb);
2510 drm_framebuffer_unreference(plane->old_fb);
2511 plane->old_fb = NULL;
2516 static int setplane_internal(struct drm_plane *plane,
2517 struct drm_crtc *crtc,
2518 struct drm_framebuffer *fb,
2519 int32_t crtc_x, int32_t crtc_y,
2520 uint32_t crtc_w, uint32_t crtc_h,
2521 /* src_{x,y,w,h} values are 16.16 fixed point */
2522 uint32_t src_x, uint32_t src_y,
2523 uint32_t src_w, uint32_t src_h)
2527 drm_modeset_lock_all(plane->dev);
2528 ret = __setplane_internal(plane, crtc, fb,
2529 crtc_x, crtc_y, crtc_w, crtc_h,
2530 src_x, src_y, src_w, src_h);
2531 drm_modeset_unlock_all(plane->dev);
2537 * drm_mode_setplane - configure a plane's configuration
2539 * @data: ioctl data*
2540 * @file_priv: DRM file info
2542 * Set plane configuration, including placement, fb, scaling, and other factors.
2543 * Or pass a NULL fb to disable (planes may be disabled without providing a
2547 * Zero on success, negative errno on failure.
2549 int drm_mode_setplane(struct drm_device *dev, void *data,
2550 struct drm_file *file_priv)
2552 struct drm_mode_set_plane *plane_req = data;
2553 struct drm_plane *plane;
2554 struct drm_crtc *crtc = NULL;
2555 struct drm_framebuffer *fb = NULL;
2557 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2560 /* Give drivers some help against integer overflows */
2561 if (plane_req->crtc_w > INT_MAX ||
2562 plane_req->crtc_x > INT_MAX - (int32_t) plane_req->crtc_w ||
2563 plane_req->crtc_h > INT_MAX ||
2564 plane_req->crtc_y > INT_MAX - (int32_t) plane_req->crtc_h) {
2565 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2566 plane_req->crtc_w, plane_req->crtc_h,
2567 plane_req->crtc_x, plane_req->crtc_y);
2572 * First, find the plane, crtc, and fb objects. If not available,
2573 * we don't bother to call the driver.
2575 plane = drm_plane_find(dev, plane_req->plane_id);
2577 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2578 plane_req->plane_id);
2582 if (plane_req->fb_id) {
2583 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2585 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2590 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2592 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2593 plane_req->crtc_id);
2599 * setplane_internal will take care of deref'ing either the old or new
2600 * framebuffer depending on success.
2602 return setplane_internal(plane, crtc, fb,
2603 plane_req->crtc_x, plane_req->crtc_y,
2604 plane_req->crtc_w, plane_req->crtc_h,
2605 plane_req->src_x, plane_req->src_y,
2606 plane_req->src_w, plane_req->src_h);
2610 * drm_mode_set_config_internal - helper to call ->set_config
2611 * @set: modeset config to set
2613 * This is a little helper to wrap internal calls to the ->set_config driver
2614 * interface. The only thing it adds is correct refcounting dance.
2617 * Zero on success, negative errno on failure.
2619 int drm_mode_set_config_internal(struct drm_mode_set *set)
2621 struct drm_crtc *crtc = set->crtc;
2622 struct drm_framebuffer *fb;
2623 struct drm_crtc *tmp;
2627 * NOTE: ->set_config can also disable other crtcs (if we steal all
2628 * connectors from it), hence we need to refcount the fbs across all
2629 * crtcs. Atomic modeset will have saner semantics ...
2631 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head)
2632 tmp->primary->old_fb = tmp->primary->fb;
2636 ret = crtc->funcs->set_config(set);
2638 crtc->primary->crtc = crtc;
2639 crtc->primary->fb = fb;
2642 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
2643 if (tmp->primary->fb)
2644 drm_framebuffer_reference(tmp->primary->fb);
2645 if (tmp->primary->old_fb)
2646 drm_framebuffer_unreference(tmp->primary->old_fb);
2647 tmp->primary->old_fb = NULL;
2652 EXPORT_SYMBOL(drm_mode_set_config_internal);
2655 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
2656 * @mode: mode to query
2657 * @hdisplay: hdisplay value to fill in
2658 * @vdisplay: vdisplay value to fill in
2660 * The vdisplay value will be doubled if the specified mode is a stereo mode of
2661 * the appropriate layout.
2663 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2664 int *hdisplay, int *vdisplay)
2666 struct drm_display_mode adjusted;
2668 drm_mode_copy(&adjusted, mode);
2669 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
2670 *hdisplay = adjusted.crtc_hdisplay;
2671 *vdisplay = adjusted.crtc_vdisplay;
2673 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
2676 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2678 * @crtc: CRTC that framebuffer will be displayed on
2681 * @mode: mode that framebuffer will be displayed under
2682 * @fb: framebuffer to check size of
2684 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2686 const struct drm_display_mode *mode,
2687 const struct drm_framebuffer *fb)
2690 int hdisplay, vdisplay;
2692 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
2694 if (crtc->invert_dimensions)
2695 swap(hdisplay, vdisplay);
2697 if (hdisplay > fb->width ||
2698 vdisplay > fb->height ||
2699 x > fb->width - hdisplay ||
2700 y > fb->height - vdisplay) {
2701 DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2702 fb->width, fb->height, hdisplay, vdisplay, x, y,
2703 crtc->invert_dimensions ? " (inverted)" : "");
2709 EXPORT_SYMBOL(drm_crtc_check_viewport);
2712 * drm_mode_setcrtc - set CRTC configuration
2713 * @dev: drm device for the ioctl
2714 * @data: data pointer for the ioctl
2715 * @file_priv: drm file for the ioctl call
2717 * Build a new CRTC configuration based on user request.
2719 * Called by the user via ioctl.
2722 * Zero on success, negative errno on failure.
2724 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2725 struct drm_file *file_priv)
2727 struct drm_mode_config *config = &dev->mode_config;
2728 struct drm_mode_crtc *crtc_req = data;
2729 struct drm_crtc *crtc;
2730 struct drm_connector **connector_set = NULL, *connector;
2731 struct drm_framebuffer *fb = NULL;
2732 struct drm_display_mode *mode = NULL;
2733 struct drm_mode_set set;
2734 uint32_t __user *set_connectors_ptr;
2738 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2741 /* For some reason crtc x/y offsets are signed internally. */
2742 if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
2745 drm_modeset_lock_all(dev);
2746 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2748 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2752 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2754 if (crtc_req->mode_valid) {
2755 /* If we have a mode we need a framebuffer. */
2756 /* If we pass -1, set the mode with the currently bound fb */
2757 if (crtc_req->fb_id == -1) {
2758 if (!crtc->primary->fb) {
2759 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2763 fb = crtc->primary->fb;
2764 /* Make refcounting symmetric with the lookup path. */
2765 drm_framebuffer_reference(fb);
2767 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2769 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2776 mode = drm_mode_create(dev);
2782 ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
2784 DRM_DEBUG_KMS("Invalid mode\n");
2788 mode->status = drm_mode_validate_basic(mode);
2789 if (mode->status != MODE_OK) {
2794 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2796 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2803 if (crtc_req->count_connectors == 0 && mode) {
2804 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2809 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2810 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2811 crtc_req->count_connectors);
2816 if (crtc_req->count_connectors > 0) {
2819 /* Avoid unbounded kernel memory allocation */
2820 if (crtc_req->count_connectors > config->num_connector) {
2825 connector_set = kmalloc_array(crtc_req->count_connectors,
2826 sizeof(struct drm_connector *),
2828 if (!connector_set) {
2833 for (i = 0; i < crtc_req->count_connectors; i++) {
2834 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2835 if (get_user(out_id, &set_connectors_ptr[i])) {
2840 connector = drm_connector_find(dev, out_id);
2842 DRM_DEBUG_KMS("Connector id %d unknown\n",
2847 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2851 connector_set[i] = connector;
2856 set.x = crtc_req->x;
2857 set.y = crtc_req->y;
2859 set.connectors = connector_set;
2860 set.num_connectors = crtc_req->count_connectors;
2862 ret = drm_mode_set_config_internal(&set);
2866 drm_framebuffer_unreference(fb);
2868 kfree(connector_set);
2869 drm_mode_destroy(dev, mode);
2870 drm_modeset_unlock_all(dev);
2875 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2876 * universal plane handler call
2877 * @crtc: crtc to update cursor for
2878 * @req: data pointer for the ioctl
2879 * @file_priv: drm file for the ioctl call
2881 * Legacy cursor ioctl's work directly with driver buffer handles. To
2882 * translate legacy ioctl calls into universal plane handler calls, we need to
2883 * wrap the native buffer handle in a drm_framebuffer.
2885 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2886 * buffer with a pitch of 4*width; the universal plane interface should be used
2887 * directly in cases where the hardware can support other buffer settings and
2888 * userspace wants to make use of these capabilities.
2891 * Zero on success, negative errno on failure.
2893 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2894 struct drm_mode_cursor2 *req,
2895 struct drm_file *file_priv)
2897 struct drm_device *dev = crtc->dev;
2898 struct drm_framebuffer *fb = NULL;
2899 struct drm_mode_fb_cmd2 fbreq = {
2900 .width = req->width,
2901 .height = req->height,
2902 .pixel_format = DRM_FORMAT_ARGB8888,
2903 .pitches = { req->width * 4 },
2904 .handles = { req->handle },
2906 int32_t crtc_x, crtc_y;
2907 uint32_t crtc_w = 0, crtc_h = 0;
2908 uint32_t src_w = 0, src_h = 0;
2911 BUG_ON(!crtc->cursor);
2912 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2915 * Obtain fb we'll be using (either new or existing) and take an extra
2916 * reference to it if fb != null. setplane will take care of dropping
2917 * the reference if the plane update fails.
2919 if (req->flags & DRM_MODE_CURSOR_BO) {
2921 fb = add_framebuffer_internal(dev, &fbreq, file_priv);
2923 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2927 drm_framebuffer_reference(fb);
2932 fb = crtc->cursor->fb;
2934 drm_framebuffer_reference(fb);
2937 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2941 crtc_x = crtc->cursor_x;
2942 crtc_y = crtc->cursor_y;
2947 crtc_h = fb->height;
2948 src_w = fb->width << 16;
2949 src_h = fb->height << 16;
2953 * setplane_internal will take care of deref'ing either the old or new
2954 * framebuffer depending on success.
2956 ret = __setplane_internal(crtc->cursor, crtc, fb,
2957 crtc_x, crtc_y, crtc_w, crtc_h,
2958 0, 0, src_w, src_h);
2960 /* Update successful; save new cursor position, if necessary */
2961 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
2962 crtc->cursor_x = req->x;
2963 crtc->cursor_y = req->y;
2969 static int drm_mode_cursor_common(struct drm_device *dev,
2970 struct drm_mode_cursor2 *req,
2971 struct drm_file *file_priv)
2973 struct drm_crtc *crtc;
2976 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2979 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
2982 crtc = drm_crtc_find(dev, req->crtc_id);
2984 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
2989 * If this crtc has a universal cursor plane, call that plane's update
2990 * handler rather than using legacy cursor handlers.
2992 drm_modeset_lock_crtc(crtc, crtc->cursor);
2994 ret = drm_mode_cursor_universal(crtc, req, file_priv);
2998 if (req->flags & DRM_MODE_CURSOR_BO) {
2999 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
3003 /* Turns off the cursor if handle is 0 */
3004 if (crtc->funcs->cursor_set2)
3005 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
3006 req->width, req->height, req->hot_x, req->hot_y);
3008 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
3009 req->width, req->height);
3012 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3013 if (crtc->funcs->cursor_move) {
3014 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3021 drm_modeset_unlock_crtc(crtc);
3029 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3030 * @dev: drm device for the ioctl
3031 * @data: data pointer for the ioctl
3032 * @file_priv: drm file for the ioctl call
3034 * Set the cursor configuration based on user request.
3036 * Called by the user via ioctl.
3039 * Zero on success, negative errno on failure.
3041 int drm_mode_cursor_ioctl(struct drm_device *dev,
3042 void *data, struct drm_file *file_priv)
3044 struct drm_mode_cursor *req = data;
3045 struct drm_mode_cursor2 new_req;
3047 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3048 new_req.hot_x = new_req.hot_y = 0;
3050 return drm_mode_cursor_common(dev, &new_req, file_priv);
3054 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3055 * @dev: drm device for the ioctl
3056 * @data: data pointer for the ioctl
3057 * @file_priv: drm file for the ioctl call
3059 * Set the cursor configuration based on user request. This implements the 2nd
3060 * version of the cursor ioctl, which allows userspace to additionally specify
3061 * the hotspot of the pointer.
3063 * Called by the user via ioctl.
3066 * Zero on success, negative errno on failure.
3068 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3069 void *data, struct drm_file *file_priv)
3071 struct drm_mode_cursor2 *req = data;
3073 return drm_mode_cursor_common(dev, req, file_priv);
3077 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3078 * @bpp: bits per pixels
3079 * @depth: bit depth per pixel
3081 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3082 * Useful in fbdev emulation code, since that deals in those values.
3084 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3090 fmt = DRM_FORMAT_C8;
3094 fmt = DRM_FORMAT_XRGB1555;
3096 fmt = DRM_FORMAT_RGB565;
3099 fmt = DRM_FORMAT_RGB888;
3103 fmt = DRM_FORMAT_XRGB8888;
3104 else if (depth == 30)
3105 fmt = DRM_FORMAT_XRGB2101010;
3107 fmt = DRM_FORMAT_ARGB8888;
3110 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3111 fmt = DRM_FORMAT_XRGB8888;
3117 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3120 * drm_mode_addfb - add an FB to the graphics configuration
3121 * @dev: drm device for the ioctl
3122 * @data: data pointer for the ioctl
3123 * @file_priv: drm file for the ioctl call
3125 * Add a new FB to the specified CRTC, given a user request. This is the
3126 * original addfb ioctl which only supported RGB formats.
3128 * Called by the user via ioctl.
3131 * Zero on success, negative errno on failure.
3133 int drm_mode_addfb(struct drm_device *dev,
3134 void *data, struct drm_file *file_priv)
3136 struct drm_mode_fb_cmd *or = data;
3137 struct drm_mode_fb_cmd2 r = {};
3140 /* convert to new format and call new ioctl */
3141 r.fb_id = or->fb_id;
3142 r.width = or->width;
3143 r.height = or->height;
3144 r.pitches[0] = or->pitch;
3145 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3146 r.handles[0] = or->handle;
3148 ret = drm_mode_addfb2(dev, &r, file_priv);
3152 or->fb_id = r.fb_id;
3157 static int format_check(const struct drm_mode_fb_cmd2 *r)
3159 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3163 case DRM_FORMAT_RGB332:
3164 case DRM_FORMAT_BGR233:
3165 case DRM_FORMAT_XRGB4444:
3166 case DRM_FORMAT_XBGR4444:
3167 case DRM_FORMAT_RGBX4444:
3168 case DRM_FORMAT_BGRX4444:
3169 case DRM_FORMAT_ARGB4444:
3170 case DRM_FORMAT_ABGR4444:
3171 case DRM_FORMAT_RGBA4444:
3172 case DRM_FORMAT_BGRA4444:
3173 case DRM_FORMAT_XRGB1555:
3174 case DRM_FORMAT_XBGR1555:
3175 case DRM_FORMAT_RGBX5551:
3176 case DRM_FORMAT_BGRX5551:
3177 case DRM_FORMAT_ARGB1555:
3178 case DRM_FORMAT_ABGR1555:
3179 case DRM_FORMAT_RGBA5551:
3180 case DRM_FORMAT_BGRA5551:
3181 case DRM_FORMAT_RGB565:
3182 case DRM_FORMAT_BGR565:
3183 case DRM_FORMAT_RGB888:
3184 case DRM_FORMAT_BGR888:
3185 case DRM_FORMAT_XRGB8888:
3186 case DRM_FORMAT_XBGR8888:
3187 case DRM_FORMAT_RGBX8888:
3188 case DRM_FORMAT_BGRX8888:
3189 case DRM_FORMAT_ARGB8888:
3190 case DRM_FORMAT_ABGR8888:
3191 case DRM_FORMAT_RGBA8888:
3192 case DRM_FORMAT_BGRA8888:
3193 case DRM_FORMAT_XRGB2101010:
3194 case DRM_FORMAT_XBGR2101010:
3195 case DRM_FORMAT_RGBX1010102:
3196 case DRM_FORMAT_BGRX1010102:
3197 case DRM_FORMAT_ARGB2101010:
3198 case DRM_FORMAT_ABGR2101010:
3199 case DRM_FORMAT_RGBA1010102:
3200 case DRM_FORMAT_BGRA1010102:
3201 case DRM_FORMAT_YUYV:
3202 case DRM_FORMAT_YVYU:
3203 case DRM_FORMAT_UYVY:
3204 case DRM_FORMAT_VYUY:
3205 case DRM_FORMAT_AYUV:
3206 case DRM_FORMAT_NV12:
3207 case DRM_FORMAT_NV21:
3208 case DRM_FORMAT_NV16:
3209 case DRM_FORMAT_NV61:
3210 case DRM_FORMAT_NV24:
3211 case DRM_FORMAT_NV42:
3212 case DRM_FORMAT_YUV410:
3213 case DRM_FORMAT_YVU410:
3214 case DRM_FORMAT_YUV411:
3215 case DRM_FORMAT_YVU411:
3216 case DRM_FORMAT_YUV420:
3217 case DRM_FORMAT_YVU420:
3218 case DRM_FORMAT_YUV422:
3219 case DRM_FORMAT_YVU422:
3220 case DRM_FORMAT_YUV444:
3221 case DRM_FORMAT_YVU444:
3224 DRM_DEBUG_KMS("invalid pixel format %s\n",
3225 drm_get_format_name(r->pixel_format));
3230 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3232 int ret, hsub, vsub, num_planes, i;
3234 ret = format_check(r);
3236 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3237 drm_get_format_name(r->pixel_format));
3241 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3242 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3243 num_planes = drm_format_num_planes(r->pixel_format);
3245 if (r->width == 0 || r->width % hsub) {
3246 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3250 if (r->height == 0 || r->height % vsub) {
3251 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3255 for (i = 0; i < num_planes; i++) {
3256 unsigned int width = r->width / (i != 0 ? hsub : 1);
3257 unsigned int height = r->height / (i != 0 ? vsub : 1);
3258 unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);
3260 if (!r->handles[i]) {
3261 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3265 if ((uint64_t) width * cpp > UINT_MAX)
3268 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3271 if (r->pitches[i] < width * cpp) {
3272 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3276 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
3277 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
3286 static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
3287 struct drm_mode_fb_cmd2 *r,
3288 struct drm_file *file_priv)
3290 struct drm_mode_config *config = &dev->mode_config;
3291 struct drm_framebuffer *fb;
3294 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
3295 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3296 return ERR_PTR(-EINVAL);
3299 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3300 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3301 r->width, config->min_width, config->max_width);
3302 return ERR_PTR(-EINVAL);
3304 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3305 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3306 r->height, config->min_height, config->max_height);
3307 return ERR_PTR(-EINVAL);
3310 if (r->flags & DRM_MODE_FB_MODIFIERS &&
3311 !dev->mode_config.allow_fb_modifiers) {
3312 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
3313 return ERR_PTR(-EINVAL);
3316 ret = framebuffer_check(r);
3318 return ERR_PTR(ret);
3320 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3322 DRM_DEBUG_KMS("could not create framebuffer\n");
3326 mutex_lock(&file_priv->fbs_lock);
3327 r->fb_id = fb->base.id;
3328 list_add(&fb->filp_head, &file_priv->fbs);
3329 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3330 mutex_unlock(&file_priv->fbs_lock);
3336 * drm_mode_addfb2 - add an FB to the graphics configuration
3337 * @dev: drm device for the ioctl
3338 * @data: data pointer for the ioctl
3339 * @file_priv: drm file for the ioctl call
3341 * Add a new FB to the specified CRTC, given a user request with format. This is
3342 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3343 * and uses fourcc codes as pixel format specifiers.
3345 * Called by the user via ioctl.
3348 * Zero on success, negative errno on failure.
3350 int drm_mode_addfb2(struct drm_device *dev,
3351 void *data, struct drm_file *file_priv)
3353 struct drm_framebuffer *fb;
3355 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3358 fb = add_framebuffer_internal(dev, data, file_priv);
3366 * drm_mode_rmfb - remove an FB from the configuration
3367 * @dev: drm device for the ioctl
3368 * @data: data pointer for the ioctl
3369 * @file_priv: drm file for the ioctl call
3371 * Remove the FB specified by the user.
3373 * Called by the user via ioctl.
3376 * Zero on success, negative errno on failure.
3378 int drm_mode_rmfb(struct drm_device *dev,
3379 void *data, struct drm_file *file_priv)
3381 struct drm_framebuffer *fb = NULL;
3382 struct drm_framebuffer *fbl = NULL;
3383 uint32_t *id = data;
3386 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3389 mutex_lock(&file_priv->fbs_lock);
3390 mutex_lock(&dev->mode_config.fb_lock);
3391 fb = __drm_framebuffer_lookup(dev, *id);
3395 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3401 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3402 __drm_framebuffer_unregister(dev, fb);
3404 list_del_init(&fb->filp_head);
3405 mutex_unlock(&dev->mode_config.fb_lock);
3406 mutex_unlock(&file_priv->fbs_lock);
3408 drm_framebuffer_remove(fb);
3413 mutex_unlock(&dev->mode_config.fb_lock);
3414 mutex_unlock(&file_priv->fbs_lock);
3420 * drm_mode_getfb - get FB info
3421 * @dev: drm device for the ioctl
3422 * @data: data pointer for the ioctl
3423 * @file_priv: drm file for the ioctl call
3425 * Lookup the FB given its ID and return info about it.
3427 * Called by the user via ioctl.
3430 * Zero on success, negative errno on failure.
3432 int drm_mode_getfb(struct drm_device *dev,
3433 void *data, struct drm_file *file_priv)
3435 struct drm_mode_fb_cmd *r = data;
3436 struct drm_framebuffer *fb;
3439 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3442 fb = drm_framebuffer_lookup(dev, r->fb_id);
3446 r->height = fb->height;
3447 r->width = fb->width;
3448 r->depth = fb->depth;
3449 r->bpp = fb->bits_per_pixel;
3450 r->pitch = fb->pitches[0];
3451 if (fb->funcs->create_handle) {
3452 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3453 drm_is_control_client(file_priv)) {
3454 ret = fb->funcs->create_handle(fb, file_priv,
3457 /* GET_FB() is an unprivileged ioctl so we must not
3458 * return a buffer-handle to non-master processes! For
3459 * backwards-compatibility reasons, we cannot make
3460 * GET_FB() privileged, so just return an invalid handle
3461 * for non-masters. */
3469 drm_framebuffer_unreference(fb);
3475 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3476 * @dev: drm device for the ioctl
3477 * @data: data pointer for the ioctl
3478 * @file_priv: drm file for the ioctl call
3480 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3481 * rectangle list. Generic userspace which does frontbuffer rendering must call
3482 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3483 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3485 * Modesetting drivers which always update the frontbuffer do not need to
3486 * implement the corresponding ->dirty framebuffer callback.
3488 * Called by the user via ioctl.
3491 * Zero on success, negative errno on failure.
3493 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3494 void *data, struct drm_file *file_priv)
3496 struct drm_clip_rect __user *clips_ptr;
3497 struct drm_clip_rect *clips = NULL;
3498 struct drm_mode_fb_dirty_cmd *r = data;
3499 struct drm_framebuffer *fb;
3504 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3507 fb = drm_framebuffer_lookup(dev, r->fb_id);
3511 num_clips = r->num_clips;
3512 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3514 if (!num_clips != !clips_ptr) {
3519 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3521 /* If userspace annotates copy, clips must come in pairs */
3522 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3527 if (num_clips && clips_ptr) {
3528 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3532 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3538 ret = copy_from_user(clips, clips_ptr,
3539 num_clips * sizeof(*clips));
3546 if (fb->funcs->dirty) {
3547 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3556 drm_framebuffer_unreference(fb);
3563 * drm_fb_release - remove and free the FBs on this file
3564 * @priv: drm file for the ioctl
3566 * Destroy all the FBs associated with @filp.
3568 * Called by the user via ioctl.
3571 * Zero on success, negative errno on failure.
3573 void drm_fb_release(struct drm_file *priv)
3575 struct drm_device *dev = priv->minor->dev;
3576 struct drm_framebuffer *fb, *tfb;
3579 * When the file gets released that means no one else can access the fb
3580 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3581 * avoid upsetting lockdep since the universal cursor code adds a
3582 * framebuffer while holding mutex locks.
3584 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3585 * locks is impossible here since no one else but this function can get
3588 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3590 mutex_lock(&dev->mode_config.fb_lock);
3591 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3592 __drm_framebuffer_unregister(dev, fb);
3593 mutex_unlock(&dev->mode_config.fb_lock);
3595 list_del_init(&fb->filp_head);
3597 /* This will also drop the fpriv->fbs reference. */
3598 drm_framebuffer_remove(fb);
3603 * drm_property_create - create a new property type
3605 * @flags: flags specifying the property type
3606 * @name: name of the property
3607 * @num_values: number of pre-defined values
3609 * This creates a new generic drm property which can then be attached to a drm
3610 * object with drm_object_attach_property. The returned property object must be
3611 * freed with drm_property_destroy.
3613 * Note that the DRM core keeps a per-device list of properties and that, if
3614 * drm_mode_config_cleanup() is called, it will destroy all properties created
3618 * A pointer to the newly created property on success, NULL on failure.
3620 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3621 const char *name, int num_values)
3623 struct drm_property *property = NULL;
3626 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3630 property->dev = dev;
3633 property->values = kcalloc(num_values, sizeof(uint64_t),
3635 if (!property->values)
3639 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3643 property->flags = flags;
3644 property->num_values = num_values;
3645 INIT_LIST_HEAD(&property->enum_list);
3648 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3649 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3652 list_add_tail(&property->head, &dev->mode_config.property_list);
3654 WARN_ON(!drm_property_type_valid(property));
3658 kfree(property->values);
3662 EXPORT_SYMBOL(drm_property_create);
3665 * drm_property_create_enum - create a new enumeration property type
3667 * @flags: flags specifying the property type
3668 * @name: name of the property
3669 * @props: enumeration lists with property values
3670 * @num_values: number of pre-defined values
3672 * This creates a new generic drm property which can then be attached to a drm
3673 * object with drm_object_attach_property. The returned property object must be
3674 * freed with drm_property_destroy.
3676 * Userspace is only allowed to set one of the predefined values for enumeration
3680 * A pointer to the newly created property on success, NULL on failure.
3682 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3684 const struct drm_prop_enum_list *props,
3687 struct drm_property *property;
3690 flags |= DRM_MODE_PROP_ENUM;
3692 property = drm_property_create(dev, flags, name, num_values);
3696 for (i = 0; i < num_values; i++) {
3697 ret = drm_property_add_enum(property, i,
3701 drm_property_destroy(dev, property);
3708 EXPORT_SYMBOL(drm_property_create_enum);
3711 * drm_property_create_bitmask - create a new bitmask property type
3713 * @flags: flags specifying the property type
3714 * @name: name of the property
3715 * @props: enumeration lists with property bitflags
3716 * @num_props: size of the @props array
3717 * @supported_bits: bitmask of all supported enumeration values
3719 * This creates a new bitmask drm property which can then be attached to a drm
3720 * object with drm_object_attach_property. The returned property object must be
3721 * freed with drm_property_destroy.
3723 * Compared to plain enumeration properties userspace is allowed to set any
3724 * or'ed together combination of the predefined property bitflag values
3727 * A pointer to the newly created property on success, NULL on failure.
3729 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3730 int flags, const char *name,
3731 const struct drm_prop_enum_list *props,
3733 uint64_t supported_bits)
3735 struct drm_property *property;
3736 int i, ret, index = 0;
3737 int num_values = hweight64(supported_bits);
3739 flags |= DRM_MODE_PROP_BITMASK;
3741 property = drm_property_create(dev, flags, name, num_values);
3744 for (i = 0; i < num_props; i++) {
3745 if (!(supported_bits & (1ULL << props[i].type)))
3748 if (WARN_ON(index >= num_values)) {
3749 drm_property_destroy(dev, property);
3753 ret = drm_property_add_enum(property, index++,
3757 drm_property_destroy(dev, property);
3764 EXPORT_SYMBOL(drm_property_create_bitmask);
3766 static struct drm_property *property_create_range(struct drm_device *dev,
3767 int flags, const char *name,
3768 uint64_t min, uint64_t max)
3770 struct drm_property *property;
3772 property = drm_property_create(dev, flags, name, 2);
3776 property->values[0] = min;
3777 property->values[1] = max;
3783 * drm_property_create_range - create a new unsigned ranged property type
3785 * @flags: flags specifying the property type
3786 * @name: name of the property
3787 * @min: minimum value of the property
3788 * @max: maximum value of the property
3790 * This creates a new generic drm property which can then be attached to a drm
3791 * object with drm_object_attach_property. The returned property object must be
3792 * freed with drm_property_destroy.
3794 * Userspace is allowed to set any unsigned integer value in the (min, max)
3798 * A pointer to the newly created property on success, NULL on failure.
3800 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3802 uint64_t min, uint64_t max)
3804 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3807 EXPORT_SYMBOL(drm_property_create_range);
3810 * drm_property_create_signed_range - create a new signed ranged property type
3812 * @flags: flags specifying the property type
3813 * @name: name of the property
3814 * @min: minimum value of the property
3815 * @max: maximum value of the property
3817 * This creates a new generic drm property which can then be attached to a drm
3818 * object with drm_object_attach_property. The returned property object must be
3819 * freed with drm_property_destroy.
3821 * Userspace is allowed to set any signed integer value in the (min, max)
3825 * A pointer to the newly created property on success, NULL on failure.
3827 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3828 int flags, const char *name,
3829 int64_t min, int64_t max)
3831 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3832 name, I642U64(min), I642U64(max));
3834 EXPORT_SYMBOL(drm_property_create_signed_range);
3837 * drm_property_create_object - create a new object property type
3839 * @flags: flags specifying the property type
3840 * @name: name of the property
3841 * @type: object type from DRM_MODE_OBJECT_* defines
3843 * This creates a new generic drm property which can then be attached to a drm
3844 * object with drm_object_attach_property. The returned property object must be
3845 * freed with drm_property_destroy.
3847 * Userspace is only allowed to set this to any property value of the given
3848 * @type. Only useful for atomic properties, which is enforced.
3851 * A pointer to the newly created property on success, NULL on failure.
3853 struct drm_property *drm_property_create_object(struct drm_device *dev,
3854 int flags, const char *name, uint32_t type)
3856 struct drm_property *property;
3858 flags |= DRM_MODE_PROP_OBJECT;
3860 if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
3863 property = drm_property_create(dev, flags, name, 1);
3867 property->values[0] = type;
3871 EXPORT_SYMBOL(drm_property_create_object);
3874 * drm_property_create_bool - create a new boolean property type
3876 * @flags: flags specifying the property type
3877 * @name: name of the property
3879 * This creates a new generic drm property which can then be attached to a drm
3880 * object with drm_object_attach_property. The returned property object must be
3881 * freed with drm_property_destroy.
3883 * This is implemented as a ranged property with only {0, 1} as valid values.
3886 * A pointer to the newly created property on success, NULL on failure.
3888 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
3891 return drm_property_create_range(dev, flags, name, 0, 1);
3893 EXPORT_SYMBOL(drm_property_create_bool);
3896 * drm_property_add_enum - add a possible value to an enumeration property
3897 * @property: enumeration property to change
3898 * @index: index of the new enumeration
3899 * @value: value of the new enumeration
3900 * @name: symbolic name of the new enumeration
3902 * This functions adds enumerations to a property.
3904 * It's use is deprecated, drivers should use one of the more specific helpers
3905 * to directly create the property with all enumerations already attached.
3908 * Zero on success, error code on failure.
3910 int drm_property_add_enum(struct drm_property *property, int index,
3911 uint64_t value, const char *name)
3913 struct drm_property_enum *prop_enum;
3915 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3916 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
3920 * Bitmask enum properties have the additional constraint of values
3923 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
3927 if (!list_empty(&property->enum_list)) {
3928 list_for_each_entry(prop_enum, &property->enum_list, head) {
3929 if (prop_enum->value == value) {
3930 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3931 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3937 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
3941 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3942 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3943 prop_enum->value = value;
3945 property->values[index] = value;
3946 list_add_tail(&prop_enum->head, &property->enum_list);
3949 EXPORT_SYMBOL(drm_property_add_enum);
3952 * drm_property_destroy - destroy a drm property
3954 * @property: property to destry
3956 * This function frees a property including any attached resources like
3957 * enumeration values.
3959 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
3961 struct drm_property_enum *prop_enum, *pt;
3963 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
3964 list_del(&prop_enum->head);
3968 if (property->num_values)
3969 kfree(property->values);
3970 drm_mode_object_put(dev, &property->base);
3971 list_del(&property->head);
3974 EXPORT_SYMBOL(drm_property_destroy);
3977 * drm_object_attach_property - attach a property to a modeset object
3978 * @obj: drm modeset object
3979 * @property: property to attach
3980 * @init_val: initial value of the property
3982 * This attaches the given property to the modeset object with the given initial
3983 * value. Currently this function cannot fail since the properties are stored in
3984 * a statically sized array.
3986 void drm_object_attach_property(struct drm_mode_object *obj,
3987 struct drm_property *property,
3990 int count = obj->properties->count;
3992 if (count == DRM_OBJECT_MAX_PROPERTY) {
3993 WARN(1, "Failed to attach object property (type: 0x%x). Please "
3994 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
3995 "you see this message on the same object type.\n",
4000 obj->properties->properties[count] = property;
4001 obj->properties->values[count] = init_val;
4002 obj->properties->count++;
4003 if (property->flags & DRM_MODE_PROP_ATOMIC)
4004 obj->properties->atomic_count++;
4006 EXPORT_SYMBOL(drm_object_attach_property);
4009 * drm_object_property_set_value - set the value of a property
4010 * @obj: drm mode object to set property value for
4011 * @property: property to set
4012 * @val: value the property should be set to
4014 * This functions sets a given property on a given object. This function only
4015 * changes the software state of the property, it does not call into the
4016 * driver's ->set_property callback.
4019 * Zero on success, error code on failure.
4021 int drm_object_property_set_value(struct drm_mode_object *obj,
4022 struct drm_property *property, uint64_t val)
4026 for (i = 0; i < obj->properties->count; i++) {
4027 if (obj->properties->properties[i] == property) {
4028 obj->properties->values[i] = val;
4035 EXPORT_SYMBOL(drm_object_property_set_value);
4038 * drm_object_property_get_value - retrieve the value of a property
4039 * @obj: drm mode object to get property value from
4040 * @property: property to retrieve
4041 * @val: storage for the property value
4043 * This function retrieves the softare state of the given property for the given
4044 * property. Since there is no driver callback to retrieve the current property
4045 * value this might be out of sync with the hardware, depending upon the driver
4049 * Zero on success, error code on failure.
4051 int drm_object_property_get_value(struct drm_mode_object *obj,
4052 struct drm_property *property, uint64_t *val)
4056 /* read-only properties bypass atomic mechanism and still store
4057 * their value in obj->properties->values[].. mostly to avoid
4058 * having to deal w/ EDID and similar props in atomic paths:
4060 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
4061 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
4062 return drm_atomic_get_property(obj, property, val);
4064 for (i = 0; i < obj->properties->count; i++) {
4065 if (obj->properties->properties[i] == property) {
4066 *val = obj->properties->values[i];
4073 EXPORT_SYMBOL(drm_object_property_get_value);
4076 * drm_mode_getproperty_ioctl - get the property metadata
4079 * @file_priv: DRM file info
4081 * This function retrieves the metadata for a given property, like the different
4082 * possible values for an enum property or the limits for a range property.
4084 * Blob properties are special
4086 * Called by the user via ioctl.
4089 * Zero on success, negative errno on failure.
4091 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4092 void *data, struct drm_file *file_priv)
4094 struct drm_mode_get_property *out_resp = data;
4095 struct drm_property *property;
4097 int value_count = 0;
4100 struct drm_property_enum *prop_enum;
4101 struct drm_mode_property_enum __user *enum_ptr;
4102 uint64_t __user *values_ptr;
4104 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4107 drm_modeset_lock_all(dev);
4108 property = drm_property_find(dev, out_resp->prop_id);
4114 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4115 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4116 list_for_each_entry(prop_enum, &property->enum_list, head)
4120 value_count = property->num_values;
4122 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4123 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4124 out_resp->flags = property->flags;
4126 if ((out_resp->count_values >= value_count) && value_count) {
4127 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4128 for (i = 0; i < value_count; i++) {
4129 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4135 out_resp->count_values = value_count;
4137 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4138 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4139 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4141 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4142 list_for_each_entry(prop_enum, &property->enum_list, head) {
4144 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4149 if (copy_to_user(&enum_ptr[copied].name,
4150 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4157 out_resp->count_enum_blobs = enum_count;
4161 * NOTE: The idea seems to have been to use this to read all the blob
4162 * property values. But nothing ever added them to the corresponding
4163 * list, userspace always used the special-purpose get_blob ioctl to
4164 * read the value for a blob property. It also doesn't make a lot of
4165 * sense to return values here when everything else is just metadata for
4166 * the property itself.
4168 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4169 out_resp->count_enum_blobs = 0;
4171 drm_modeset_unlock_all(dev);
4175 static struct drm_property_blob *
4176 drm_property_create_blob(struct drm_device *dev, size_t length,
4179 struct drm_property_blob *blob;
4182 if (!length || !data)
4185 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4189 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4195 blob->length = length;
4197 memcpy(blob->data, data, length);
4199 list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
4203 static void drm_property_destroy_blob(struct drm_device *dev,
4204 struct drm_property_blob *blob)
4206 drm_mode_object_put(dev, &blob->base);
4207 list_del(&blob->head);
4212 * drm_mode_getblob_ioctl - get the contents of a blob property value
4215 * @file_priv: DRM file info
4217 * This function retrieves the contents of a blob property. The value stored in
4218 * an object's blob property is just a normal modeset object id.
4220 * Called by the user via ioctl.
4223 * Zero on success, negative errno on failure.
4225 int drm_mode_getblob_ioctl(struct drm_device *dev,
4226 void *data, struct drm_file *file_priv)
4228 struct drm_mode_get_blob *out_resp = data;
4229 struct drm_property_blob *blob;
4231 void __user *blob_ptr;
4233 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4236 drm_modeset_lock_all(dev);
4237 blob = drm_property_blob_find(dev, out_resp->blob_id);
4243 if (out_resp->length == blob->length) {
4244 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4245 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4250 out_resp->length = blob->length;
4253 drm_modeset_unlock_all(dev);
4258 * drm_mode_connector_set_path_property - set tile property on connector
4259 * @connector: connector to set property on.
4260 * @path: path to use for property.
4262 * This creates a property to expose to userspace to specify a
4263 * connector path. This is mainly used for DisplayPort MST where
4264 * connectors have a topology and we want to allow userspace to give
4265 * them more meaningful names.
4268 * Zero on success, negative errno on failure.
4270 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4273 struct drm_device *dev = connector->dev;
4274 size_t size = strlen(path) + 1;
4277 connector->path_blob_ptr = drm_property_create_blob(connector->dev,
4279 if (!connector->path_blob_ptr)
4282 ret = drm_object_property_set_value(&connector->base,
4283 dev->mode_config.path_property,
4284 connector->path_blob_ptr->base.id);
4287 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4290 * drm_mode_connector_set_tile_property - set tile property on connector
4291 * @connector: connector to set property on.
4293 * This looks up the tile information for a connector, and creates a
4294 * property for userspace to parse if it exists. The property is of
4295 * the form of 8 integers using ':' as a separator.
4298 * Zero on success, errno on failure.
4300 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4302 struct drm_device *dev = connector->dev;
4306 if (connector->tile_blob_ptr)
4307 drm_property_destroy_blob(dev, connector->tile_blob_ptr);
4309 if (!connector->has_tile) {
4310 connector->tile_blob_ptr = NULL;
4311 ret = drm_object_property_set_value(&connector->base,
4312 dev->mode_config.tile_property, 0);
4316 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4317 connector->tile_group->id, connector->tile_is_single_monitor,
4318 connector->num_h_tile, connector->num_v_tile,
4319 connector->tile_h_loc, connector->tile_v_loc,
4320 connector->tile_h_size, connector->tile_v_size);
4321 size = strlen(tile) + 1;
4323 connector->tile_blob_ptr = drm_property_create_blob(connector->dev,
4325 if (!connector->tile_blob_ptr)
4328 ret = drm_object_property_set_value(&connector->base,
4329 dev->mode_config.tile_property,
4330 connector->tile_blob_ptr->base.id);
4333 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4336 * drm_mode_connector_update_edid_property - update the edid property of a connector
4337 * @connector: drm connector
4338 * @edid: new value of the edid property
4340 * This function creates a new blob modeset object and assigns its id to the
4341 * connector's edid property.
4344 * Zero on success, negative errno on failure.
4346 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4347 const struct edid *edid)
4349 struct drm_device *dev = connector->dev;
4353 /* ignore requests to set edid when overridden */
4354 if (connector->override_edid)
4357 if (connector->edid_blob_ptr)
4358 drm_property_destroy_blob(dev, connector->edid_blob_ptr);
4360 /* Delete edid, when there is none. */
4362 connector->edid_blob_ptr = NULL;
4363 ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
4367 size = EDID_LENGTH * (1 + edid->extensions);
4368 connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
4370 if (!connector->edid_blob_ptr)
4373 ret = drm_object_property_set_value(&connector->base,
4374 dev->mode_config.edid_property,
4375 connector->edid_blob_ptr->base.id);
4379 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4381 /* Some properties could refer to dynamic refcnt'd objects, or things that
4382 * need special locking to handle lifetime issues (ie. to ensure the prop
4383 * value doesn't become invalid part way through the property update due to
4384 * race). The value returned by reference via 'obj' should be passed back
4385 * to drm_property_change_valid_put() after the property is set (and the
4386 * object to which the property is attached has a chance to take it's own
4389 bool drm_property_change_valid_get(struct drm_property *property,
4390 uint64_t value, struct drm_mode_object **ref)
4394 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4399 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4400 if (value < property->values[0] || value > property->values[1])
4403 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4404 int64_t svalue = U642I64(value);
4406 if (svalue < U642I64(property->values[0]) ||
4407 svalue > U642I64(property->values[1]))
4410 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4411 uint64_t valid_mask = 0;
4413 for (i = 0; i < property->num_values; i++)
4414 valid_mask |= (1ULL << property->values[i]);
4415 return !(value & ~valid_mask);
4416 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4417 /* Only the driver knows */
4419 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4420 /* a zero value for an object property translates to null: */
4424 /* handle refcnt'd objects specially: */
4425 if (property->values[0] == DRM_MODE_OBJECT_FB) {
4426 struct drm_framebuffer *fb;
4427 fb = drm_framebuffer_lookup(property->dev, value);
4435 return _object_find(property->dev, value, property->values[0]) != NULL;
4439 for (i = 0; i < property->num_values; i++)
4440 if (property->values[i] == value)
4445 void drm_property_change_valid_put(struct drm_property *property,
4446 struct drm_mode_object *ref)
4451 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4452 if (property->values[0] == DRM_MODE_OBJECT_FB)
4453 drm_framebuffer_unreference(obj_to_fb(ref));
4458 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4461 * @file_priv: DRM file info
4463 * This function sets the current value for a connectors's property. It also
4464 * calls into a driver's ->set_property callback to update the hardware state
4466 * Called by the user via ioctl.
4469 * Zero on success, negative errno on failure.
4471 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4472 void *data, struct drm_file *file_priv)
4474 struct drm_mode_connector_set_property *conn_set_prop = data;
4475 struct drm_mode_obj_set_property obj_set_prop = {
4476 .value = conn_set_prop->value,
4477 .prop_id = conn_set_prop->prop_id,
4478 .obj_id = conn_set_prop->connector_id,
4479 .obj_type = DRM_MODE_OBJECT_CONNECTOR
4482 /* It does all the locking and checking we need */
4483 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4486 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4487 struct drm_property *property,
4491 struct drm_connector *connector = obj_to_connector(obj);
4493 /* Do DPMS ourselves */
4494 if (property == connector->dev->mode_config.dpms_property) {
4495 if (connector->funcs->dpms)
4496 (*connector->funcs->dpms)(connector, (int)value);
4498 } else if (connector->funcs->set_property)
4499 ret = connector->funcs->set_property(connector, property, value);
4501 /* store the property value if successful */
4503 drm_object_property_set_value(&connector->base, property, value);
4507 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4508 struct drm_property *property,
4512 struct drm_crtc *crtc = obj_to_crtc(obj);
4514 if (crtc->funcs->set_property)
4515 ret = crtc->funcs->set_property(crtc, property, value);
4517 drm_object_property_set_value(obj, property, value);
4523 * drm_mode_plane_set_obj_prop - set the value of a property
4524 * @plane: drm plane object to set property value for
4525 * @property: property to set
4526 * @value: value the property should be set to
4528 * This functions sets a given property on a given plane object. This function
4529 * calls the driver's ->set_property callback and changes the software state of
4530 * the property if the callback succeeds.
4533 * Zero on success, error code on failure.
4535 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
4536 struct drm_property *property,
4540 struct drm_mode_object *obj = &plane->base;
4542 if (plane->funcs->set_property)
4543 ret = plane->funcs->set_property(plane, property, value);
4545 drm_object_property_set_value(obj, property, value);
4549 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
4552 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
4555 * @file_priv: DRM file info
4557 * This function retrieves the current value for an object's property. Compared
4558 * to the connector specific ioctl this one is extended to also work on crtc and
4561 * Called by the user via ioctl.
4564 * Zero on success, negative errno on failure.
4566 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
4567 struct drm_file *file_priv)
4569 struct drm_mode_obj_get_properties *arg = data;
4570 struct drm_mode_object *obj;
4573 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4576 drm_modeset_lock_all(dev);
4578 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4583 if (!obj->properties) {
4588 ret = get_properties(obj, file_priv->atomic,
4589 (uint32_t __user *)(unsigned long)(arg->props_ptr),
4590 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
4594 drm_modeset_unlock_all(dev);
4599 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
4602 * @file_priv: DRM file info
4604 * This function sets the current value for an object's property. It also calls
4605 * into a driver's ->set_property callback to update the hardware state.
4606 * Compared to the connector specific ioctl this one is extended to also work on
4607 * crtc and plane objects.
4609 * Called by the user via ioctl.
4612 * Zero on success, negative errno on failure.
4614 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
4615 struct drm_file *file_priv)
4617 struct drm_mode_obj_set_property *arg = data;
4618 struct drm_mode_object *arg_obj;
4619 struct drm_mode_object *prop_obj;
4620 struct drm_property *property;
4621 int i, ret = -EINVAL;
4622 struct drm_mode_object *ref;
4624 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4627 drm_modeset_lock_all(dev);
4629 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4634 if (!arg_obj->properties)
4637 for (i = 0; i < arg_obj->properties->count; i++)
4638 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
4641 if (i == arg_obj->properties->count)
4644 prop_obj = drm_mode_object_find(dev, arg->prop_id,
4645 DRM_MODE_OBJECT_PROPERTY);
4650 property = obj_to_property(prop_obj);
4652 if (!drm_property_change_valid_get(property, arg->value, &ref))
4655 switch (arg_obj->type) {
4656 case DRM_MODE_OBJECT_CONNECTOR:
4657 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
4660 case DRM_MODE_OBJECT_CRTC:
4661 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
4663 case DRM_MODE_OBJECT_PLANE:
4664 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
4665 property, arg->value);
4669 drm_property_change_valid_put(property, ref);
4672 drm_modeset_unlock_all(dev);
4677 * drm_mode_connector_attach_encoder - attach a connector to an encoder
4678 * @connector: connector to attach
4679 * @encoder: encoder to attach @connector to
4681 * This function links up a connector to an encoder. Note that the routing
4682 * restrictions between encoders and crtcs are exposed to userspace through the
4683 * possible_clones and possible_crtcs bitmasks.
4686 * Zero on success, negative errno on failure.
4688 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
4689 struct drm_encoder *encoder)
4693 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
4694 if (connector->encoder_ids[i] == 0) {
4695 connector->encoder_ids[i] = encoder->base.id;
4701 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
4704 * drm_mode_crtc_set_gamma_size - set the gamma table size
4705 * @crtc: CRTC to set the gamma table size for
4706 * @gamma_size: size of the gamma table
4708 * Drivers which support gamma tables should set this to the supported gamma
4709 * table size when initializing the CRTC. Currently the drm core only supports a
4710 * fixed gamma table size.
4713 * Zero on success, negative errno on failure.
4715 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
4718 crtc->gamma_size = gamma_size;
4720 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
4722 if (!crtc->gamma_store) {
4723 crtc->gamma_size = 0;
4729 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
4732 * drm_mode_gamma_set_ioctl - set the gamma table
4735 * @file_priv: DRM file info
4737 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
4738 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
4740 * Called by the user via ioctl.
4743 * Zero on success, negative errno on failure.
4745 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
4746 void *data, struct drm_file *file_priv)
4748 struct drm_mode_crtc_lut *crtc_lut = data;
4749 struct drm_crtc *crtc;
4750 void *r_base, *g_base, *b_base;
4754 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4757 drm_modeset_lock_all(dev);
4758 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4764 if (crtc->funcs->gamma_set == NULL) {
4769 /* memcpy into gamma store */
4770 if (crtc_lut->gamma_size != crtc->gamma_size) {
4775 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4776 r_base = crtc->gamma_store;
4777 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
4782 g_base = r_base + size;
4783 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
4788 b_base = g_base + size;
4789 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
4794 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
4797 drm_modeset_unlock_all(dev);
4803 * drm_mode_gamma_get_ioctl - get the gamma table
4806 * @file_priv: DRM file info
4808 * Copy the current gamma table into the storage provided. This also provides
4809 * the gamma table size the driver expects, which can be used to size the
4810 * allocated storage.
4812 * Called by the user via ioctl.
4815 * Zero on success, negative errno on failure.
4817 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
4818 void *data, struct drm_file *file_priv)
4820 struct drm_mode_crtc_lut *crtc_lut = data;
4821 struct drm_crtc *crtc;
4822 void *r_base, *g_base, *b_base;
4826 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4829 drm_modeset_lock_all(dev);
4830 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4836 /* memcpy into gamma store */
4837 if (crtc_lut->gamma_size != crtc->gamma_size) {
4842 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4843 r_base = crtc->gamma_store;
4844 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
4849 g_base = r_base + size;
4850 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
4855 b_base = g_base + size;
4856 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
4861 drm_modeset_unlock_all(dev);
4866 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4869 * @file_priv: DRM file info
4871 * This schedules an asynchronous update on a given CRTC, called page flip.
4872 * Optionally a drm event is generated to signal the completion of the event.
4873 * Generic drivers cannot assume that a pageflip with changed framebuffer
4874 * properties (including driver specific metadata like tiling layout) will work,
4875 * but some drivers support e.g. pixel format changes through the pageflip
4878 * Called by the user via ioctl.
4881 * Zero on success, negative errno on failure.
4883 int drm_mode_page_flip_ioctl(struct drm_device *dev,
4884 void *data, struct drm_file *file_priv)
4886 struct drm_mode_crtc_page_flip *page_flip = data;
4887 struct drm_crtc *crtc;
4888 struct drm_framebuffer *fb = NULL;
4889 struct drm_pending_vblank_event *e = NULL;
4890 unsigned long flags;
4893 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
4894 page_flip->reserved != 0)
4897 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
4900 crtc = drm_crtc_find(dev, page_flip->crtc_id);
4904 drm_modeset_lock_crtc(crtc, crtc->primary);
4905 if (crtc->primary->fb == NULL) {
4906 /* The framebuffer is currently unbound, presumably
4907 * due to a hotplug event, that userspace has not
4914 if (crtc->funcs->page_flip == NULL)
4917 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
4923 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
4927 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
4928 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4933 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4935 spin_lock_irqsave(&dev->event_lock, flags);
4936 if (file_priv->event_space < sizeof(e->event)) {
4937 spin_unlock_irqrestore(&dev->event_lock, flags);
4940 file_priv->event_space -= sizeof(e->event);
4941 spin_unlock_irqrestore(&dev->event_lock, flags);
4943 e = kzalloc(sizeof(*e), GFP_KERNEL);
4945 spin_lock_irqsave(&dev->event_lock, flags);
4946 file_priv->event_space += sizeof(e->event);
4947 spin_unlock_irqrestore(&dev->event_lock, flags);
4951 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
4952 e->event.base.length = sizeof(e->event);
4953 e->event.user_data = page_flip->user_data;
4954 e->base.event = &e->event.base;
4955 e->base.file_priv = file_priv;
4957 (void (*) (struct drm_pending_event *)) kfree;
4960 crtc->primary->old_fb = crtc->primary->fb;
4961 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
4963 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4964 spin_lock_irqsave(&dev->event_lock, flags);
4965 file_priv->event_space += sizeof(e->event);
4966 spin_unlock_irqrestore(&dev->event_lock, flags);
4969 /* Keep the old fb, don't unref it. */
4970 crtc->primary->old_fb = NULL;
4973 * Warn if the driver hasn't properly updated the crtc->fb
4974 * field to reflect that the new framebuffer is now used.
4975 * Failing to do so will screw with the reference counting
4978 WARN_ON(crtc->primary->fb != fb);
4979 /* Unref only the old framebuffer. */
4985 drm_framebuffer_unreference(fb);
4986 if (crtc->primary->old_fb)
4987 drm_framebuffer_unreference(crtc->primary->old_fb);
4988 crtc->primary->old_fb = NULL;
4989 drm_modeset_unlock_crtc(crtc);
4995 * drm_mode_config_reset - call ->reset callbacks
4998 * This functions calls all the crtc's, encoder's and connector's ->reset
4999 * callback. Drivers can use this in e.g. their driver load or resume code to
5000 * reset hardware and software state.
5002 void drm_mode_config_reset(struct drm_device *dev)
5004 struct drm_crtc *crtc;
5005 struct drm_plane *plane;
5006 struct drm_encoder *encoder;
5007 struct drm_connector *connector;
5009 list_for_each_entry(plane, &dev->mode_config.plane_list, head)
5010 if (plane->funcs->reset)
5011 plane->funcs->reset(plane);
5013 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
5014 if (crtc->funcs->reset)
5015 crtc->funcs->reset(crtc);
5017 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
5018 if (encoder->funcs->reset)
5019 encoder->funcs->reset(encoder);
5021 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
5022 connector->status = connector_status_unknown;
5024 if (connector->funcs->reset)
5025 connector->funcs->reset(connector);
5028 EXPORT_SYMBOL(drm_mode_config_reset);
5031 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
5034 * @file_priv: DRM file info
5036 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
5037 * TTM or something else entirely) and returns the resulting buffer handle. This
5038 * handle can then be wrapped up into a framebuffer modeset object.
5040 * Note that userspace is not allowed to use such objects for render
5041 * acceleration - drivers must create their own private ioctls for such a use
5044 * Called by the user via ioctl.
5047 * Zero on success, negative errno on failure.
5049 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
5050 void *data, struct drm_file *file_priv)
5052 struct drm_mode_create_dumb *args = data;
5053 u32 cpp, stride, size;
5055 if (!dev->driver->dumb_create)
5057 if (!args->width || !args->height || !args->bpp)
5060 /* overflow checks for 32bit size calculations */
5061 /* NOTE: DIV_ROUND_UP() can overflow */
5062 cpp = DIV_ROUND_UP(args->bpp, 8);
5063 if (!cpp || cpp > 0xffffffffU / args->width)
5065 stride = cpp * args->width;
5066 if (args->height > 0xffffffffU / stride)
5069 /* test for wrap-around */
5070 size = args->height * stride;
5071 if (PAGE_ALIGN(size) == 0)
5075 * handle, pitch and size are output parameters. Zero them out to
5076 * prevent drivers from accidentally using uninitialized data. Since
5077 * not all existing userspace is clearing these fields properly we
5078 * cannot reject IOCTL with garbage in them.
5084 return dev->driver->dumb_create(file_priv, dev, args);
5088 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5091 * @file_priv: DRM file info
5093 * Allocate an offset in the drm device node's address space to be able to
5094 * memory map a dumb buffer.
5096 * Called by the user via ioctl.
5099 * Zero on success, negative errno on failure.
5101 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5102 void *data, struct drm_file *file_priv)
5104 struct drm_mode_map_dumb *args = data;
5106 /* call driver ioctl to get mmap offset */
5107 if (!dev->driver->dumb_map_offset)
5110 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5114 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5117 * @file_priv: DRM file info
5119 * This destroys the userspace handle for the given dumb backing storage buffer.
5120 * Since buffer objects must be reference counted in the kernel a buffer object
5121 * won't be immediately freed if a framebuffer modeset object still uses it.
5123 * Called by the user via ioctl.
5126 * Zero on success, negative errno on failure.
5128 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5129 void *data, struct drm_file *file_priv)
5131 struct drm_mode_destroy_dumb *args = data;
5133 if (!dev->driver->dumb_destroy)
5136 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5140 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5141 * @format: pixel format (DRM_FORMAT_*)
5142 * @depth: storage for the depth value
5143 * @bpp: storage for the bpp value
5145 * This only supports RGB formats here for compat with code that doesn't use
5146 * pixel formats directly yet.
5148 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5153 case DRM_FORMAT_RGB332:
5154 case DRM_FORMAT_BGR233:
5158 case DRM_FORMAT_XRGB1555:
5159 case DRM_FORMAT_XBGR1555:
5160 case DRM_FORMAT_RGBX5551:
5161 case DRM_FORMAT_BGRX5551:
5162 case DRM_FORMAT_ARGB1555:
5163 case DRM_FORMAT_ABGR1555:
5164 case DRM_FORMAT_RGBA5551:
5165 case DRM_FORMAT_BGRA5551:
5169 case DRM_FORMAT_RGB565:
5170 case DRM_FORMAT_BGR565:
5174 case DRM_FORMAT_RGB888:
5175 case DRM_FORMAT_BGR888:
5179 case DRM_FORMAT_XRGB8888:
5180 case DRM_FORMAT_XBGR8888:
5181 case DRM_FORMAT_RGBX8888:
5182 case DRM_FORMAT_BGRX8888:
5186 case DRM_FORMAT_XRGB2101010:
5187 case DRM_FORMAT_XBGR2101010:
5188 case DRM_FORMAT_RGBX1010102:
5189 case DRM_FORMAT_BGRX1010102:
5190 case DRM_FORMAT_ARGB2101010:
5191 case DRM_FORMAT_ABGR2101010:
5192 case DRM_FORMAT_RGBA1010102:
5193 case DRM_FORMAT_BGRA1010102:
5197 case DRM_FORMAT_ARGB8888:
5198 case DRM_FORMAT_ABGR8888:
5199 case DRM_FORMAT_RGBA8888:
5200 case DRM_FORMAT_BGRA8888:
5205 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5206 drm_get_format_name(format));
5212 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5215 * drm_format_num_planes - get the number of planes for format
5216 * @format: pixel format (DRM_FORMAT_*)
5219 * The number of planes used by the specified pixel format.
5221 int drm_format_num_planes(uint32_t format)
5224 case DRM_FORMAT_YUV410:
5225 case DRM_FORMAT_YVU410:
5226 case DRM_FORMAT_YUV411:
5227 case DRM_FORMAT_YVU411:
5228 case DRM_FORMAT_YUV420:
5229 case DRM_FORMAT_YVU420:
5230 case DRM_FORMAT_YUV422:
5231 case DRM_FORMAT_YVU422:
5232 case DRM_FORMAT_YUV444:
5233 case DRM_FORMAT_YVU444:
5235 case DRM_FORMAT_NV12:
5236 case DRM_FORMAT_NV21:
5237 case DRM_FORMAT_NV16:
5238 case DRM_FORMAT_NV61:
5239 case DRM_FORMAT_NV24:
5240 case DRM_FORMAT_NV42:
5246 EXPORT_SYMBOL(drm_format_num_planes);
5249 * drm_format_plane_cpp - determine the bytes per pixel value
5250 * @format: pixel format (DRM_FORMAT_*)
5251 * @plane: plane index
5254 * The bytes per pixel value for the specified plane.
5256 int drm_format_plane_cpp(uint32_t format, int plane)
5261 if (plane >= drm_format_num_planes(format))
5265 case DRM_FORMAT_YUYV:
5266 case DRM_FORMAT_YVYU:
5267 case DRM_FORMAT_UYVY:
5268 case DRM_FORMAT_VYUY:
5270 case DRM_FORMAT_NV12:
5271 case DRM_FORMAT_NV21:
5272 case DRM_FORMAT_NV16:
5273 case DRM_FORMAT_NV61:
5274 case DRM_FORMAT_NV24:
5275 case DRM_FORMAT_NV42:
5276 return plane ? 2 : 1;
5277 case DRM_FORMAT_YUV410:
5278 case DRM_FORMAT_YVU410:
5279 case DRM_FORMAT_YUV411:
5280 case DRM_FORMAT_YVU411:
5281 case DRM_FORMAT_YUV420:
5282 case DRM_FORMAT_YVU420:
5283 case DRM_FORMAT_YUV422:
5284 case DRM_FORMAT_YVU422:
5285 case DRM_FORMAT_YUV444:
5286 case DRM_FORMAT_YVU444:
5289 drm_fb_get_bpp_depth(format, &depth, &bpp);
5293 EXPORT_SYMBOL(drm_format_plane_cpp);
5296 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5297 * @format: pixel format (DRM_FORMAT_*)
5300 * The horizontal chroma subsampling factor for the
5301 * specified pixel format.
5303 int drm_format_horz_chroma_subsampling(uint32_t format)
5306 case DRM_FORMAT_YUV411:
5307 case DRM_FORMAT_YVU411:
5308 case DRM_FORMAT_YUV410:
5309 case DRM_FORMAT_YVU410:
5311 case DRM_FORMAT_YUYV:
5312 case DRM_FORMAT_YVYU:
5313 case DRM_FORMAT_UYVY:
5314 case DRM_FORMAT_VYUY:
5315 case DRM_FORMAT_NV12:
5316 case DRM_FORMAT_NV21:
5317 case DRM_FORMAT_NV16:
5318 case DRM_FORMAT_NV61:
5319 case DRM_FORMAT_YUV422:
5320 case DRM_FORMAT_YVU422:
5321 case DRM_FORMAT_YUV420:
5322 case DRM_FORMAT_YVU420:
5328 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5331 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5332 * @format: pixel format (DRM_FORMAT_*)
5335 * The vertical chroma subsampling factor for the
5336 * specified pixel format.
5338 int drm_format_vert_chroma_subsampling(uint32_t format)
5341 case DRM_FORMAT_YUV410:
5342 case DRM_FORMAT_YVU410:
5344 case DRM_FORMAT_YUV420:
5345 case DRM_FORMAT_YVU420:
5346 case DRM_FORMAT_NV12:
5347 case DRM_FORMAT_NV21:
5353 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5356 * drm_rotation_simplify() - Try to simplify the rotation
5357 * @rotation: Rotation to be simplified
5358 * @supported_rotations: Supported rotations
5360 * Attempt to simplify the rotation to a form that is supported.
5361 * Eg. if the hardware supports everything except DRM_REFLECT_X
5362 * one could call this function like this:
5364 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5365 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5366 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5368 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5369 * transforms the hardware supports, this function may not
5370 * be able to produce a supported transform, so the caller should
5371 * check the result afterwards.
5373 unsigned int drm_rotation_simplify(unsigned int rotation,
5374 unsigned int supported_rotations)
5376 if (rotation & ~supported_rotations) {
5377 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5378 rotation = (rotation & ~0xf) | BIT((ffs(rotation & 0xf) + 1) % 4);
5383 EXPORT_SYMBOL(drm_rotation_simplify);
5386 * drm_mode_config_init - initialize DRM mode_configuration structure
5389 * Initialize @dev's mode_config structure, used for tracking the graphics
5390 * configuration of @dev.
5392 * Since this initializes the modeset locks, no locking is possible. Which is no
5393 * problem, since this should happen single threaded at init time. It is the
5394 * driver's problem to ensure this guarantee.
5397 void drm_mode_config_init(struct drm_device *dev)
5399 mutex_init(&dev->mode_config.mutex);
5400 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5401 mutex_init(&dev->mode_config.idr_mutex);
5402 mutex_init(&dev->mode_config.fb_lock);
5403 INIT_LIST_HEAD(&dev->mode_config.fb_list);
5404 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5405 INIT_LIST_HEAD(&dev->mode_config.connector_list);
5406 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5407 INIT_LIST_HEAD(&dev->mode_config.property_list);
5408 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5409 INIT_LIST_HEAD(&dev->mode_config.plane_list);
5410 idr_init(&dev->mode_config.crtc_idr);
5411 idr_init(&dev->mode_config.tile_idr);
5413 drm_modeset_lock_all(dev);
5414 drm_mode_create_standard_properties(dev);
5415 drm_modeset_unlock_all(dev);
5417 /* Just to be sure */
5418 dev->mode_config.num_fb = 0;
5419 dev->mode_config.num_connector = 0;
5420 dev->mode_config.num_crtc = 0;
5421 dev->mode_config.num_encoder = 0;
5422 dev->mode_config.num_overlay_plane = 0;
5423 dev->mode_config.num_total_plane = 0;
5425 EXPORT_SYMBOL(drm_mode_config_init);
5428 * drm_mode_config_cleanup - free up DRM mode_config info
5431 * Free up all the connectors and CRTCs associated with this DRM device, then
5432 * free up the framebuffers and associated buffer objects.
5434 * Note that since this /should/ happen single-threaded at driver/device
5435 * teardown time, no locking is required. It's the driver's job to ensure that
5436 * this guarantee actually holds true.
5438 * FIXME: cleanup any dangling user buffer objects too
5440 void drm_mode_config_cleanup(struct drm_device *dev)
5442 struct drm_connector *connector, *ot;
5443 struct drm_crtc *crtc, *ct;
5444 struct drm_encoder *encoder, *enct;
5445 struct drm_framebuffer *fb, *fbt;
5446 struct drm_property *property, *pt;
5447 struct drm_property_blob *blob, *bt;
5448 struct drm_plane *plane, *plt;
5450 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5452 encoder->funcs->destroy(encoder);
5455 list_for_each_entry_safe(connector, ot,
5456 &dev->mode_config.connector_list, head) {
5457 connector->funcs->destroy(connector);
5460 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5462 drm_property_destroy(dev, property);
5465 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
5467 drm_property_destroy_blob(dev, blob);
5471 * Single-threaded teardown context, so it's not required to grab the
5472 * fb_lock to protect against concurrent fb_list access. Contrary, it
5473 * would actually deadlock with the drm_framebuffer_cleanup function.
5475 * Also, if there are any framebuffers left, that's a driver leak now,
5476 * so politely WARN about this.
5478 WARN_ON(!list_empty(&dev->mode_config.fb_list));
5479 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
5480 drm_framebuffer_remove(fb);
5483 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
5485 plane->funcs->destroy(plane);
5488 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
5489 crtc->funcs->destroy(crtc);
5492 idr_destroy(&dev->mode_config.tile_idr);
5493 idr_destroy(&dev->mode_config.crtc_idr);
5494 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
5496 EXPORT_SYMBOL(drm_mode_config_cleanup);
5498 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
5499 unsigned int supported_rotations)
5501 static const struct drm_prop_enum_list props[] = {
5502 { DRM_ROTATE_0, "rotate-0" },
5503 { DRM_ROTATE_90, "rotate-90" },
5504 { DRM_ROTATE_180, "rotate-180" },
5505 { DRM_ROTATE_270, "rotate-270" },
5506 { DRM_REFLECT_X, "reflect-x" },
5507 { DRM_REFLECT_Y, "reflect-y" },
5510 return drm_property_create_bitmask(dev, 0, "rotation",
5511 props, ARRAY_SIZE(props),
5512 supported_rotations);
5514 EXPORT_SYMBOL(drm_mode_create_rotation_property);
5519 * Tile groups are used to represent tiled monitors with a unique
5520 * integer identifier. Tiled monitors using DisplayID v1.3 have
5521 * a unique 8-byte handle, we store this in a tile group, so we
5522 * have a common identifier for all tiles in a monitor group.
5524 static void drm_tile_group_free(struct kref *kref)
5526 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
5527 struct drm_device *dev = tg->dev;
5528 mutex_lock(&dev->mode_config.idr_mutex);
5529 idr_remove(&dev->mode_config.tile_idr, tg->id);
5530 mutex_unlock(&dev->mode_config.idr_mutex);
5535 * drm_mode_put_tile_group - drop a reference to a tile group.
5537 * @tg: tile group to drop reference to.
5539 * drop reference to tile group and free if 0.
5541 void drm_mode_put_tile_group(struct drm_device *dev,
5542 struct drm_tile_group *tg)
5544 kref_put(&tg->refcount, drm_tile_group_free);
5548 * drm_mode_get_tile_group - get a reference to an existing tile group
5550 * @topology: 8-bytes unique per monitor.
5552 * Use the unique bytes to get a reference to an existing tile group.
5555 * tile group or NULL if not found.
5557 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
5560 struct drm_tile_group *tg;
5562 mutex_lock(&dev->mode_config.idr_mutex);
5563 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
5564 if (!memcmp(tg->group_data, topology, 8)) {
5565 if (!kref_get_unless_zero(&tg->refcount))
5567 mutex_unlock(&dev->mode_config.idr_mutex);
5571 mutex_unlock(&dev->mode_config.idr_mutex);
5576 * drm_mode_create_tile_group - create a tile group from a displayid description
5578 * @topology: 8-bytes unique per monitor.
5580 * Create a tile group for the unique monitor, and get a unique
5581 * identifier for the tile group.
5584 * new tile group or error.
5586 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
5589 struct drm_tile_group *tg;
5592 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
5594 return ERR_PTR(-ENOMEM);
5596 kref_init(&tg->refcount);
5597 memcpy(tg->group_data, topology, 8);
5600 mutex_lock(&dev->mode_config.idr_mutex);
5601 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
5609 mutex_unlock(&dev->mode_config.idr_mutex);