2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
4 * Copyright (c) 2008 Red Hat Inc.
6 * DRM core CRTC related functions
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
28 * Eric Anholt <eric@anholt.net>
29 * Dave Airlie <airlied@linux.ie>
30 * Jesse Barnes <jesse.barnes@intel.com>
32 #include <linux/ctype.h>
33 #include <linux/list.h>
34 #include <linux/slab.h>
35 #include <linux/export.h>
37 #include <drm/drm_crtc.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_fourcc.h>
40 #include <drm/drm_modeset_lock.h>
41 #include <drm/drm_atomic.h>
43 #include "drm_crtc_internal.h"
44 #include "drm_internal.h"
46 static struct drm_framebuffer *
47 internal_framebuffer_create(struct drm_device *dev,
48 struct drm_mode_fb_cmd2 *r,
49 struct drm_file *file_priv);
51 /* Avoid boilerplate. I'm tired of typing. */
52 #define DRM_ENUM_NAME_FN(fnname, list) \
53 const char *fnname(int val) \
56 for (i = 0; i < ARRAY_SIZE(list); i++) { \
57 if (list[i].type == val) \
58 return list[i].name; \
66 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
67 { DRM_MODE_DPMS_ON, "On" },
68 { DRM_MODE_DPMS_STANDBY, "Standby" },
69 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
70 { DRM_MODE_DPMS_OFF, "Off" }
73 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
75 static const struct drm_prop_enum_list drm_plane_type_enum_list[] = {
76 { DRM_PLANE_TYPE_OVERLAY, "Overlay" },
77 { DRM_PLANE_TYPE_PRIMARY, "Primary" },
78 { DRM_PLANE_TYPE_CURSOR, "Cursor" },
84 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
85 { DRM_MODE_SCALE_NONE, "None" },
86 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
87 { DRM_MODE_SCALE_CENTER, "Center" },
88 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
91 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
92 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
93 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
94 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
98 * Non-global properties, but "required" for certain connectors.
100 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
101 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
102 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
103 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
106 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
108 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
109 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
110 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
111 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
114 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
115 drm_dvi_i_subconnector_enum_list)
117 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
118 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
119 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
120 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
121 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
122 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
125 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
127 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
128 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
129 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
130 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
131 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
132 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
135 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
136 drm_tv_subconnector_enum_list)
138 static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
139 { DRM_MODE_DIRTY_OFF, "Off" },
140 { DRM_MODE_DIRTY_ON, "On" },
141 { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
144 struct drm_conn_prop_enum_list {
151 * Connector and encoder types.
153 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
154 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
155 { DRM_MODE_CONNECTOR_VGA, "VGA" },
156 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
157 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
158 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
159 { DRM_MODE_CONNECTOR_Composite, "Composite" },
160 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
161 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
162 { DRM_MODE_CONNECTOR_Component, "Component" },
163 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
164 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
165 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
166 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
167 { DRM_MODE_CONNECTOR_TV, "TV" },
168 { DRM_MODE_CONNECTOR_eDP, "eDP" },
169 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
170 { DRM_MODE_CONNECTOR_DSI, "DSI" },
173 static const struct drm_prop_enum_list drm_encoder_enum_list[] = {
174 { DRM_MODE_ENCODER_NONE, "None" },
175 { DRM_MODE_ENCODER_DAC, "DAC" },
176 { DRM_MODE_ENCODER_TMDS, "TMDS" },
177 { DRM_MODE_ENCODER_LVDS, "LVDS" },
178 { DRM_MODE_ENCODER_TVDAC, "TV" },
179 { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
180 { DRM_MODE_ENCODER_DSI, "DSI" },
181 { DRM_MODE_ENCODER_DPMST, "DP MST" },
184 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
185 { SubPixelUnknown, "Unknown" },
186 { SubPixelHorizontalRGB, "Horizontal RGB" },
187 { SubPixelHorizontalBGR, "Horizontal BGR" },
188 { SubPixelVerticalRGB, "Vertical RGB" },
189 { SubPixelVerticalBGR, "Vertical BGR" },
190 { SubPixelNone, "None" },
193 void drm_connector_ida_init(void)
197 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
198 ida_init(&drm_connector_enum_list[i].ida);
201 void drm_connector_ida_destroy(void)
205 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
206 ida_destroy(&drm_connector_enum_list[i].ida);
210 * drm_get_connector_status_name - return a string for connector status
211 * @status: connector status to compute name of
213 * In contrast to the other drm_get_*_name functions this one here returns a
214 * const pointer and hence is threadsafe.
216 const char *drm_get_connector_status_name(enum drm_connector_status status)
218 if (status == connector_status_connected)
220 else if (status == connector_status_disconnected)
221 return "disconnected";
225 EXPORT_SYMBOL(drm_get_connector_status_name);
228 * drm_get_subpixel_order_name - return a string for a given subpixel enum
229 * @order: enum of subpixel_order
231 * Note you could abuse this and return something out of bounds, but that
232 * would be a caller error. No unscrubbed user data should make it here.
234 const char *drm_get_subpixel_order_name(enum subpixel_order order)
236 return drm_subpixel_enum_list[order].name;
238 EXPORT_SYMBOL(drm_get_subpixel_order_name);
240 static char printable_char(int c)
242 return isascii(c) && isprint(c) ? c : '?';
246 * drm_get_format_name - return a string for drm fourcc format
247 * @format: format to compute name of
249 * Note that the buffer used by this function is globally shared and owned by
250 * the function itself.
252 * FIXME: This isn't really multithreading safe.
254 const char *drm_get_format_name(uint32_t format)
258 snprintf(buf, sizeof(buf),
259 "%c%c%c%c %s-endian (0x%08x)",
260 printable_char(format & 0xff),
261 printable_char((format >> 8) & 0xff),
262 printable_char((format >> 16) & 0xff),
263 printable_char((format >> 24) & 0x7f),
264 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
269 EXPORT_SYMBOL(drm_get_format_name);
272 * Internal function to assign a slot in the object idr and optionally
273 * register the object into the idr.
275 static int drm_mode_object_get_reg(struct drm_device *dev,
276 struct drm_mode_object *obj,
282 mutex_lock(&dev->mode_config.idr_mutex);
283 ret = idr_alloc(&dev->mode_config.crtc_idr, register_obj ? obj : NULL, 1, 0, GFP_KERNEL);
286 * Set up the object linking under the protection of the idr
287 * lock so that other users can't see inconsistent state.
290 obj->type = obj_type;
292 mutex_unlock(&dev->mode_config.idr_mutex);
294 return ret < 0 ? ret : 0;
298 * drm_mode_object_get - allocate a new modeset identifier
300 * @obj: object pointer, used to generate unique ID
301 * @obj_type: object type
303 * Create a unique identifier based on @ptr in @dev's identifier space. Used
304 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
305 * modeset identifiers are _not_ reference counted. Hence don't use this for
306 * reference counted modeset objects like framebuffers.
309 * Zero on success, error code on failure.
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 */
355 (obj->type == DRM_MODE_OBJECT_FB ||
356 obj->type == DRM_MODE_OBJECT_BLOB))
358 mutex_unlock(&dev->mode_config.idr_mutex);
364 * drm_mode_object_find - look up a drm object with static lifetime
366 * @id: id of the mode object
367 * @type: type of the mode object
369 * Note that framebuffers cannot be looked up with this functions - since those
370 * are reference counted, they need special treatment. Even with
371 * DRM_MODE_OBJECT_ANY (although that will simply return NULL
372 * rather than WARN_ON()).
374 struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
375 uint32_t id, uint32_t type)
377 struct drm_mode_object *obj = NULL;
379 /* Framebuffers are reference counted and need their own lookup
381 WARN_ON(type == DRM_MODE_OBJECT_FB || type == DRM_MODE_OBJECT_BLOB);
382 obj = _object_find(dev, id, type);
385 EXPORT_SYMBOL(drm_mode_object_find);
388 * drm_framebuffer_init - initialize a framebuffer
390 * @fb: framebuffer to be initialized
391 * @funcs: ... with these functions
393 * Allocates an ID for the framebuffer's parent mode object, sets its mode
394 * functions & device file and adds it to the master fd list.
397 * This functions publishes the fb and makes it available for concurrent access
398 * by other users. Which means by this point the fb _must_ be fully set up -
399 * since all the fb attributes are invariant over its lifetime, no further
400 * locking but only correct reference counting is required.
403 * Zero on success, error code on failure.
405 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
406 const struct drm_framebuffer_funcs *funcs)
410 mutex_lock(&dev->mode_config.fb_lock);
411 kref_init(&fb->refcount);
412 INIT_LIST_HEAD(&fb->filp_head);
416 ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
420 dev->mode_config.num_fb++;
421 list_add(&fb->head, &dev->mode_config.fb_list);
423 mutex_unlock(&dev->mode_config.fb_lock);
427 EXPORT_SYMBOL(drm_framebuffer_init);
429 /* dev->mode_config.fb_lock must be held! */
430 static void __drm_framebuffer_unregister(struct drm_device *dev,
431 struct drm_framebuffer *fb)
433 mutex_lock(&dev->mode_config.idr_mutex);
434 idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
435 mutex_unlock(&dev->mode_config.idr_mutex);
440 static void drm_framebuffer_free(struct kref *kref)
442 struct drm_framebuffer *fb =
443 container_of(kref, struct drm_framebuffer, refcount);
444 struct drm_device *dev = fb->dev;
447 * The lookup idr holds a weak reference, which has not necessarily been
448 * removed at this point. Check for that.
450 mutex_lock(&dev->mode_config.fb_lock);
452 /* Mark fb as reaped and drop idr ref. */
453 __drm_framebuffer_unregister(dev, fb);
455 mutex_unlock(&dev->mode_config.fb_lock);
457 fb->funcs->destroy(fb);
460 static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
463 struct drm_mode_object *obj = NULL;
464 struct drm_framebuffer *fb;
466 mutex_lock(&dev->mode_config.idr_mutex);
467 obj = idr_find(&dev->mode_config.crtc_idr, id);
468 if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
472 mutex_unlock(&dev->mode_config.idr_mutex);
478 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
480 * @id: id of the fb object
482 * If successful, this grabs an additional reference to the framebuffer -
483 * callers need to make sure to eventually unreference the returned framebuffer
484 * again, using @drm_framebuffer_unreference.
486 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
489 struct drm_framebuffer *fb;
491 mutex_lock(&dev->mode_config.fb_lock);
492 fb = __drm_framebuffer_lookup(dev, id);
494 if (!kref_get_unless_zero(&fb->refcount))
497 mutex_unlock(&dev->mode_config.fb_lock);
501 EXPORT_SYMBOL(drm_framebuffer_lookup);
504 * drm_framebuffer_unreference - unref a framebuffer
505 * @fb: framebuffer to unref
507 * This functions decrements the fb's refcount and frees it if it drops to zero.
509 void drm_framebuffer_unreference(struct drm_framebuffer *fb)
511 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
512 kref_put(&fb->refcount, drm_framebuffer_free);
514 EXPORT_SYMBOL(drm_framebuffer_unreference);
517 * drm_framebuffer_reference - incr the fb refcnt
520 * This functions increments the fb's refcount.
522 void drm_framebuffer_reference(struct drm_framebuffer *fb)
524 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
525 kref_get(&fb->refcount);
527 EXPORT_SYMBOL(drm_framebuffer_reference);
530 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
531 * @fb: fb to unregister
533 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
534 * those used for fbdev. Note that the caller must hold a reference of it's own,
535 * i.e. the object may not be destroyed through this call (since it'll lead to a
536 * locking inversion).
538 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
540 struct drm_device *dev;
547 mutex_lock(&dev->mode_config.fb_lock);
548 /* Mark fb as reaped and drop idr ref. */
549 __drm_framebuffer_unregister(dev, fb);
550 mutex_unlock(&dev->mode_config.fb_lock);
552 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
555 * drm_framebuffer_cleanup - remove a framebuffer object
556 * @fb: framebuffer to remove
558 * Cleanup framebuffer. This function is intended to be used from the drivers
559 * ->destroy callback. It can also be used to clean up driver private
560 * framebuffers embedded into a larger structure.
562 * Note that this function does not remove the fb from active usuage - if it is
563 * still used anywhere, hilarity can ensue since userspace could call getfb on
564 * the id and get back -EINVAL. Obviously no concern at driver unload time.
566 * Also, the framebuffer will not be removed from the lookup idr - for
567 * user-created framebuffers this will happen in in the rmfb ioctl. For
568 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
569 * drm_framebuffer_unregister_private.
571 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
573 struct drm_device *dev = fb->dev;
575 mutex_lock(&dev->mode_config.fb_lock);
577 dev->mode_config.num_fb--;
578 mutex_unlock(&dev->mode_config.fb_lock);
580 EXPORT_SYMBOL(drm_framebuffer_cleanup);
583 * drm_framebuffer_remove - remove and unreference a framebuffer object
584 * @fb: framebuffer to remove
586 * Scans all the CRTCs and planes in @dev's mode_config. If they're
587 * using @fb, removes it, setting it to NULL. Then drops the reference to the
588 * passed-in framebuffer. Might take the modeset locks.
590 * Note that this function optimizes the cleanup away if the caller holds the
591 * last reference to the framebuffer. It is also guaranteed to not take the
592 * modeset locks in this case.
594 void drm_framebuffer_remove(struct drm_framebuffer *fb)
596 struct drm_device *dev;
597 struct drm_crtc *crtc;
598 struct drm_plane *plane;
599 struct drm_mode_set set;
607 WARN_ON(!list_empty(&fb->filp_head));
610 * drm ABI mandates that we remove any deleted framebuffers from active
611 * useage. But since most sane clients only remove framebuffers they no
612 * longer need, try to optimize this away.
614 * Since we're holding a reference ourselves, observing a refcount of 1
615 * means that we're the last holder and can skip it. Also, the refcount
616 * can never increase from 1 again, so we don't need any barriers or
619 * Note that userspace could try to race with use and instate a new
620 * usage _after_ we've cleared all current ones. End result will be an
621 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
624 if (atomic_read(&fb->refcount.refcount) > 1) {
625 drm_modeset_lock_all(dev);
626 /* remove from any CRTC */
627 drm_for_each_crtc(crtc, dev) {
628 if (crtc->primary->fb == fb) {
629 /* should turn off the crtc */
630 memset(&set, 0, sizeof(struct drm_mode_set));
633 ret = drm_mode_set_config_internal(&set);
635 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
639 drm_for_each_plane(plane, dev) {
641 drm_plane_force_disable(plane);
643 drm_modeset_unlock_all(dev);
646 drm_framebuffer_unreference(fb);
648 EXPORT_SYMBOL(drm_framebuffer_remove);
650 DEFINE_WW_CLASS(crtc_ww_class);
653 * drm_crtc_init_with_planes - Initialise a new CRTC object with
654 * specified primary and cursor planes.
656 * @crtc: CRTC object to init
657 * @primary: Primary plane for CRTC
658 * @cursor: Cursor plane for CRTC
659 * @funcs: callbacks for the new CRTC
660 * @name: printf style format string for the CRTC name, or NULL for default name
662 * Inits a new object created as base part of a driver crtc object.
665 * Zero on success, error code on failure.
667 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
668 struct drm_plane *primary,
669 struct drm_plane *cursor,
670 const struct drm_crtc_funcs *funcs,
671 const char *name, ...)
673 struct drm_mode_config *config = &dev->mode_config;
676 WARN_ON(primary && primary->type != DRM_PLANE_TYPE_PRIMARY);
677 WARN_ON(cursor && cursor->type != DRM_PLANE_TYPE_CURSOR);
682 drm_modeset_lock_init(&crtc->mutex);
683 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
687 crtc->base.properties = &crtc->properties;
689 list_add_tail(&crtc->head, &config->crtc_list);
692 crtc->primary = primary;
693 crtc->cursor = cursor;
695 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
697 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
699 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
700 drm_object_attach_property(&crtc->base, config->prop_active, 0);
701 drm_object_attach_property(&crtc->base, config->prop_mode_id, 0);
706 EXPORT_SYMBOL(drm_crtc_init_with_planes);
709 * drm_crtc_cleanup - Clean up the core crtc usage
710 * @crtc: CRTC to cleanup
712 * This function cleans up @crtc and removes it from the DRM mode setting
713 * core. Note that the function does *not* free the crtc structure itself,
714 * this is the responsibility of the caller.
716 void drm_crtc_cleanup(struct drm_crtc *crtc)
718 struct drm_device *dev = crtc->dev;
720 kfree(crtc->gamma_store);
721 crtc->gamma_store = NULL;
723 drm_modeset_lock_fini(&crtc->mutex);
725 drm_mode_object_put(dev, &crtc->base);
726 list_del(&crtc->head);
727 dev->mode_config.num_crtc--;
729 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
730 if (crtc->state && crtc->funcs->atomic_destroy_state)
731 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
733 memset(crtc, 0, sizeof(*crtc));
735 EXPORT_SYMBOL(drm_crtc_cleanup);
738 * drm_crtc_index - find the index of a registered CRTC
739 * @crtc: CRTC to find index for
741 * Given a registered CRTC, return the index of that CRTC within a DRM
742 * device's list of CRTCs.
744 unsigned int drm_crtc_index(struct drm_crtc *crtc)
746 unsigned int index = 0;
747 struct drm_crtc *tmp;
749 drm_for_each_crtc(tmp, crtc->dev) {
758 EXPORT_SYMBOL(drm_crtc_index);
761 * drm_mode_remove - remove and free a mode
762 * @connector: connector list to modify
763 * @mode: mode to remove
765 * Remove @mode from @connector's mode list, then free it.
767 static void drm_mode_remove(struct drm_connector *connector,
768 struct drm_display_mode *mode)
770 list_del(&mode->head);
771 drm_mode_destroy(connector->dev, mode);
775 * drm_display_info_set_bus_formats - set the supported bus formats
776 * @info: display info to store bus formats in
777 * @formats: array containing the supported bus formats
778 * @num_formats: the number of entries in the fmts array
780 * Store the supported bus formats in display info structure.
781 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
782 * a full list of available formats.
784 int drm_display_info_set_bus_formats(struct drm_display_info *info,
786 unsigned int num_formats)
790 if (!formats && num_formats)
793 if (formats && num_formats) {
794 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
800 kfree(info->bus_formats);
801 info->bus_formats = fmts;
802 info->num_bus_formats = num_formats;
806 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
809 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
810 * @connector: connector to quwery
812 * The kernel supports per-connector configration of its consoles through
813 * use of the video= parameter. This function parses that option and
814 * extracts the user's specified mode (or enable/disable status) for a
815 * particular connector. This is typically only used during the early fbdev
818 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
820 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
823 if (fb_get_options(connector->name, &option))
826 if (!drm_mode_parse_command_line_for_connector(option,
834 switch (mode->force) {
838 case DRM_FORCE_ON_DIGITAL:
847 DRM_INFO("forcing %s connector %s\n", connector->name, s);
848 connector->force = mode->force;
851 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
853 mode->xres, mode->yres,
854 mode->refresh_specified ? mode->refresh : 60,
855 mode->rb ? " reduced blanking" : "",
856 mode->margins ? " with margins" : "",
857 mode->interlace ? " interlaced" : "");
861 * drm_connector_init - Init a preallocated connector
863 * @connector: the connector to init
864 * @funcs: callbacks for this connector
865 * @connector_type: user visible type of the connector
867 * Initialises a preallocated connector. Connectors should be
868 * subclassed as part of driver connector objects.
871 * Zero on success, error code on failure.
873 int drm_connector_init(struct drm_device *dev,
874 struct drm_connector *connector,
875 const struct drm_connector_funcs *funcs,
878 struct drm_mode_config *config = &dev->mode_config;
880 struct ida *connector_ida =
881 &drm_connector_enum_list[connector_type].ida;
883 drm_modeset_lock_all(dev);
885 ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
889 connector->base.properties = &connector->properties;
890 connector->dev = dev;
891 connector->funcs = funcs;
892 connector->connector_type = connector_type;
893 connector->connector_type_id =
894 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
895 if (connector->connector_type_id < 0) {
896 ret = connector->connector_type_id;
900 kasprintf(GFP_KERNEL, "%s-%d",
901 drm_connector_enum_list[connector_type].name,
902 connector->connector_type_id);
903 if (!connector->name) {
908 INIT_LIST_HEAD(&connector->probed_modes);
909 INIT_LIST_HEAD(&connector->modes);
910 connector->edid_blob_ptr = NULL;
911 connector->status = connector_status_unknown;
913 drm_connector_get_cmdline_mode(connector);
915 /* We should add connectors at the end to avoid upsetting the connector
917 list_add_tail(&connector->head, &config->connector_list);
918 config->num_connector++;
920 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
921 drm_object_attach_property(&connector->base,
922 config->edid_property,
925 drm_object_attach_property(&connector->base,
926 config->dpms_property, 0);
928 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
929 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
932 connector->debugfs_entry = NULL;
936 drm_mode_object_put(dev, &connector->base);
939 drm_modeset_unlock_all(dev);
943 EXPORT_SYMBOL(drm_connector_init);
946 * drm_connector_cleanup - cleans up an initialised connector
947 * @connector: connector to cleanup
949 * Cleans up the connector but doesn't free the object.
951 void drm_connector_cleanup(struct drm_connector *connector)
953 struct drm_device *dev = connector->dev;
954 struct drm_display_mode *mode, *t;
956 if (connector->tile_group) {
957 drm_mode_put_tile_group(dev, connector->tile_group);
958 connector->tile_group = NULL;
961 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
962 drm_mode_remove(connector, mode);
964 list_for_each_entry_safe(mode, t, &connector->modes, head)
965 drm_mode_remove(connector, mode);
967 ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
968 connector->connector_type_id);
970 kfree(connector->display_info.bus_formats);
971 drm_mode_object_put(dev, &connector->base);
972 kfree(connector->name);
973 connector->name = NULL;
974 list_del(&connector->head);
975 dev->mode_config.num_connector--;
977 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
978 if (connector->state && connector->funcs->atomic_destroy_state)
979 connector->funcs->atomic_destroy_state(connector,
982 memset(connector, 0, sizeof(*connector));
984 EXPORT_SYMBOL(drm_connector_cleanup);
987 * drm_connector_index - find the index of a registered connector
988 * @connector: connector to find index for
990 * Given a registered connector, return the index of that connector within a DRM
991 * device's list of connectors.
993 unsigned int drm_connector_index(struct drm_connector *connector)
995 unsigned int index = 0;
996 struct drm_connector *tmp;
997 struct drm_mode_config *config = &connector->dev->mode_config;
999 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
1001 drm_for_each_connector(tmp, connector->dev) {
1002 if (tmp == connector)
1010 EXPORT_SYMBOL(drm_connector_index);
1013 * drm_connector_register - register a connector
1014 * @connector: the connector to register
1016 * Register userspace interfaces for a connector
1019 * Zero on success, error code on failure.
1021 int drm_connector_register(struct drm_connector *connector)
1025 drm_mode_object_register(connector->dev, &connector->base);
1027 ret = drm_sysfs_connector_add(connector);
1031 ret = drm_debugfs_connector_add(connector);
1033 drm_sysfs_connector_remove(connector);
1039 EXPORT_SYMBOL(drm_connector_register);
1042 * drm_connector_unregister - unregister a connector
1043 * @connector: the connector to unregister
1045 * Unregister userspace interfaces for a connector
1047 void drm_connector_unregister(struct drm_connector *connector)
1049 drm_sysfs_connector_remove(connector);
1050 drm_debugfs_connector_remove(connector);
1052 EXPORT_SYMBOL(drm_connector_unregister);
1056 * drm_connector_unplug_all - unregister connector userspace interfaces
1059 * This function unregisters all connector userspace interfaces in sysfs. Should
1060 * be call when the device is disconnected, e.g. from an usb driver's
1061 * ->disconnect callback.
1063 void drm_connector_unplug_all(struct drm_device *dev)
1065 struct drm_connector *connector;
1067 /* FIXME: taking the mode config mutex ends up in a clash with sysfs */
1068 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1069 drm_connector_unregister(connector);
1072 EXPORT_SYMBOL(drm_connector_unplug_all);
1075 * drm_encoder_init - Init a preallocated encoder
1077 * @encoder: the encoder to init
1078 * @funcs: callbacks for this encoder
1079 * @encoder_type: user visible type of the encoder
1080 * @name: printf style format string for the encoder name, or NULL for default name
1082 * Initialises a preallocated encoder. Encoder should be
1083 * subclassed as part of driver encoder objects.
1086 * Zero on success, error code on failure.
1088 int drm_encoder_init(struct drm_device *dev,
1089 struct drm_encoder *encoder,
1090 const struct drm_encoder_funcs *funcs,
1091 int encoder_type, const char *name, ...)
1095 drm_modeset_lock_all(dev);
1097 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1102 encoder->encoder_type = encoder_type;
1103 encoder->funcs = funcs;
1104 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1105 drm_encoder_enum_list[encoder_type].name,
1107 if (!encoder->name) {
1112 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1113 dev->mode_config.num_encoder++;
1117 drm_mode_object_put(dev, &encoder->base);
1120 drm_modeset_unlock_all(dev);
1124 EXPORT_SYMBOL(drm_encoder_init);
1127 * drm_encoder_cleanup - cleans up an initialised encoder
1128 * @encoder: encoder to cleanup
1130 * Cleans up the encoder but doesn't free the object.
1132 void drm_encoder_cleanup(struct drm_encoder *encoder)
1134 struct drm_device *dev = encoder->dev;
1136 drm_modeset_lock_all(dev);
1137 drm_mode_object_put(dev, &encoder->base);
1138 kfree(encoder->name);
1139 list_del(&encoder->head);
1140 dev->mode_config.num_encoder--;
1141 drm_modeset_unlock_all(dev);
1143 memset(encoder, 0, sizeof(*encoder));
1145 EXPORT_SYMBOL(drm_encoder_cleanup);
1148 * drm_universal_plane_init - Initialize a new universal plane object
1150 * @plane: plane object to init
1151 * @possible_crtcs: bitmask of possible CRTCs
1152 * @funcs: callbacks for the new plane
1153 * @formats: array of supported formats (%DRM_FORMAT_*)
1154 * @format_count: number of elements in @formats
1155 * @type: type of plane (overlay, primary, cursor)
1156 * @name: printf style format string for the plane name, or NULL for default name
1158 * Initializes a plane object of type @type.
1161 * Zero on success, error code on failure.
1163 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1164 unsigned long possible_crtcs,
1165 const struct drm_plane_funcs *funcs,
1166 const uint32_t *formats, unsigned int format_count,
1167 enum drm_plane_type type,
1168 const char *name, ...)
1170 struct drm_mode_config *config = &dev->mode_config;
1173 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1177 drm_modeset_lock_init(&plane->mutex);
1179 plane->base.properties = &plane->properties;
1181 plane->funcs = funcs;
1182 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1184 if (!plane->format_types) {
1185 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1186 drm_mode_object_put(dev, &plane->base);
1190 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1191 plane->format_count = format_count;
1192 plane->possible_crtcs = possible_crtcs;
1195 list_add_tail(&plane->head, &config->plane_list);
1196 config->num_total_plane++;
1197 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1198 config->num_overlay_plane++;
1200 drm_object_attach_property(&plane->base,
1201 config->plane_type_property,
1204 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1205 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1206 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1207 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1208 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1209 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1210 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1211 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1212 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1213 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1214 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1219 EXPORT_SYMBOL(drm_universal_plane_init);
1222 * drm_plane_init - Initialize a legacy plane
1224 * @plane: plane object to init
1225 * @possible_crtcs: bitmask of possible CRTCs
1226 * @funcs: callbacks for the new plane
1227 * @formats: array of supported formats (%DRM_FORMAT_*)
1228 * @format_count: number of elements in @formats
1229 * @is_primary: plane type (primary vs overlay)
1231 * Legacy API to initialize a DRM plane.
1233 * New drivers should call drm_universal_plane_init() instead.
1236 * Zero on success, error code on failure.
1238 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1239 unsigned long possible_crtcs,
1240 const struct drm_plane_funcs *funcs,
1241 const uint32_t *formats, unsigned int format_count,
1244 enum drm_plane_type type;
1246 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1247 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1248 formats, format_count, type, NULL);
1250 EXPORT_SYMBOL(drm_plane_init);
1253 * drm_share_plane_init - Initialize a share plane
1255 * @plane: plane object to init
1256 * @parent: this plane share some resources with parent plane.
1257 * @possible_crtcs: bitmask of possible CRTCs
1258 * @funcs: callbacks for the new plane
1259 * @formats: array of supported formats (%DRM_FORMAT_*)
1260 * @format_count: number of elements in @formats
1261 * @type: type of plane (overlay, primary, cursor)
1263 * With this API, the plane can share hardware resources with other planes.
1265 * --------------------------------------------------
1267 * | ------------------ |
1268 * | | parent plane | |
1269 * | | active scanout | |
1270 * | | | ----------------- |
1271 * | ------------------ | share plane 1 | |
1272 * | ----------------- |active scanout | |
1273 * | | share plane 0 | | | |
1274 * | |active scanout | ----------------- |
1276 * | ----------------- |
1277 * --------------------------------------------------
1284 * The plane hardware is used when the display scanout run into plane active
1285 * scanout, that means we can reuse the plane hardware resources on plane
1286 * non-active scanout.
1288 * Because resource share, There are some limit on share plane: one group
1289 * of share planes need use same zpos, can't not overlap, etc.
1291 * Here assume share plane is a universal plane with some limit flags.
1292 * people who use the share plane need know the limit, should call the ioctl
1293 * DRM_CLIENT_CAP_SHARE_PLANES, and judge the planes limit before use it.
1296 * Zero on success, error code on failure.
1299 int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1300 struct drm_plane *parent,
1301 unsigned long possible_crtcs,
1302 const struct drm_plane_funcs *funcs,
1303 const uint32_t *formats, unsigned int format_count,
1304 enum drm_plane_type type)
1306 struct drm_mode_config *config = &dev->mode_config;
1311 * TODO: only verified on ATOMIC drm driver.
1313 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1316 ret = drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1317 formats, format_count, type, NULL);
1323 * Can't support more than two level plane share.
1325 WARN_ON(parent->parent);
1326 share_id = parent->base.id;
1327 plane->parent = parent;
1329 config->num_share_plane++;
1330 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1331 config->num_share_overlay_plane++;
1333 share_id = plane->base.id;
1336 drm_object_attach_property(&plane->base,
1337 config->prop_share_id, share_id);
1340 EXPORT_SYMBOL(drm_share_plane_init);
1343 * drm_plane_cleanup - Clean up the core plane usage
1344 * @plane: plane to cleanup
1346 * This function cleans up @plane and removes it from the DRM mode setting
1347 * core. Note that the function does *not* free the plane structure itself,
1348 * this is the responsibility of the caller.
1350 void drm_plane_cleanup(struct drm_plane *plane)
1352 struct drm_device *dev = plane->dev;
1354 drm_modeset_lock_all(dev);
1355 kfree(plane->format_types);
1356 drm_mode_object_put(dev, &plane->base);
1358 BUG_ON(list_empty(&plane->head));
1360 list_del(&plane->head);
1361 dev->mode_config.num_total_plane--;
1362 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1363 dev->mode_config.num_overlay_plane--;
1364 if (plane->parent) {
1365 dev->mode_config.num_share_plane--;
1366 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1367 dev->mode_config.num_share_overlay_plane--;
1369 drm_modeset_unlock_all(dev);
1371 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1372 if (plane->state && plane->funcs->atomic_destroy_state)
1373 plane->funcs->atomic_destroy_state(plane, plane->state);
1375 memset(plane, 0, sizeof(*plane));
1377 EXPORT_SYMBOL(drm_plane_cleanup);
1380 * drm_plane_index - find the index of a registered plane
1381 * @plane: plane to find index for
1383 * Given a registered plane, return the index of that CRTC within a DRM
1384 * device's list of planes.
1386 unsigned int drm_plane_index(struct drm_plane *plane)
1388 unsigned int index = 0;
1389 struct drm_plane *tmp;
1391 drm_for_each_plane(tmp, plane->dev) {
1400 EXPORT_SYMBOL(drm_plane_index);
1403 * drm_plane_from_index - find the registered plane at an index
1405 * @idx: index of registered plane to find for
1407 * Given a plane index, return the registered plane from DRM device's
1408 * list of planes with matching index.
1411 drm_plane_from_index(struct drm_device *dev, int idx)
1413 struct drm_plane *plane;
1416 drm_for_each_plane(plane, dev) {
1423 EXPORT_SYMBOL(drm_plane_from_index);
1426 * drm_plane_force_disable - Forcibly disable a plane
1427 * @plane: plane to disable
1429 * Forces the plane to be disabled.
1431 * Used when the plane's current framebuffer is destroyed,
1432 * and when restoring fbdev mode.
1434 void drm_plane_force_disable(struct drm_plane *plane)
1441 plane->old_fb = plane->fb;
1442 ret = plane->funcs->disable_plane(plane);
1444 DRM_ERROR("failed to disable plane with busy fb\n");
1445 plane->old_fb = NULL;
1448 /* disconnect the plane from the fb and crtc: */
1449 drm_framebuffer_unreference(plane->old_fb);
1450 plane->old_fb = NULL;
1454 EXPORT_SYMBOL(drm_plane_force_disable);
1456 static int drm_mode_create_standard_properties(struct drm_device *dev)
1458 struct drm_property *prop;
1461 * Standard properties (apply to all connectors)
1463 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1464 DRM_MODE_PROP_IMMUTABLE,
1468 dev->mode_config.edid_property = prop;
1470 prop = drm_property_create_enum(dev, 0,
1471 "DPMS", drm_dpms_enum_list,
1472 ARRAY_SIZE(drm_dpms_enum_list));
1475 dev->mode_config.dpms_property = prop;
1477 prop = drm_property_create(dev,
1478 DRM_MODE_PROP_BLOB |
1479 DRM_MODE_PROP_IMMUTABLE,
1483 dev->mode_config.path_property = prop;
1485 prop = drm_property_create(dev,
1486 DRM_MODE_PROP_BLOB |
1487 DRM_MODE_PROP_IMMUTABLE,
1491 dev->mode_config.tile_property = prop;
1493 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1494 "type", drm_plane_type_enum_list,
1495 ARRAY_SIZE(drm_plane_type_enum_list));
1498 dev->mode_config.plane_type_property = prop;
1500 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1501 "SHARE_ID", 0, UINT_MAX);
1505 dev->mode_config.prop_share_id = prop;
1506 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1507 "SHARE_FLAGS", 0, UINT_MAX);
1510 dev->mode_config.prop_share_flags = prop;
1512 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1513 "SRC_X", 0, UINT_MAX);
1516 dev->mode_config.prop_src_x = prop;
1518 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1519 "SRC_Y", 0, UINT_MAX);
1522 dev->mode_config.prop_src_y = prop;
1524 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1525 "SRC_W", 0, UINT_MAX);
1528 dev->mode_config.prop_src_w = prop;
1530 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1531 "SRC_H", 0, UINT_MAX);
1534 dev->mode_config.prop_src_h = prop;
1536 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1537 "CRTC_X", INT_MIN, INT_MAX);
1540 dev->mode_config.prop_crtc_x = prop;
1542 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1543 "CRTC_Y", INT_MIN, INT_MAX);
1546 dev->mode_config.prop_crtc_y = prop;
1548 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1549 "CRTC_W", 0, INT_MAX);
1552 dev->mode_config.prop_crtc_w = prop;
1554 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1555 "CRTC_H", 0, INT_MAX);
1558 dev->mode_config.prop_crtc_h = prop;
1560 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1561 "FB_ID", DRM_MODE_OBJECT_FB);
1564 dev->mode_config.prop_fb_id = prop;
1566 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1567 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1570 dev->mode_config.prop_crtc_id = prop;
1572 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
1576 dev->mode_config.prop_active = prop;
1578 prop = drm_property_create(dev,
1579 DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
1583 dev->mode_config.prop_mode_id = prop;
1589 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1592 * Called by a driver the first time a DVI-I connector is made.
1594 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1596 struct drm_property *dvi_i_selector;
1597 struct drm_property *dvi_i_subconnector;
1599 if (dev->mode_config.dvi_i_select_subconnector_property)
1603 drm_property_create_enum(dev, 0,
1604 "select subconnector",
1605 drm_dvi_i_select_enum_list,
1606 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1607 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1609 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1611 drm_dvi_i_subconnector_enum_list,
1612 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1613 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1617 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1620 * drm_create_tv_properties - create TV specific connector properties
1622 * @num_modes: number of different TV formats (modes) supported
1623 * @modes: array of pointers to strings containing name of each format
1625 * Called by a driver's TV initialization routine, this function creates
1626 * the TV specific connector properties for a given device. Caller is
1627 * responsible for allocating a list of format names and passing them to
1630 int drm_mode_create_tv_properties(struct drm_device *dev,
1631 unsigned int num_modes,
1632 const char * const modes[])
1634 struct drm_property *tv_selector;
1635 struct drm_property *tv_subconnector;
1638 if (dev->mode_config.tv_select_subconnector_property)
1642 * Basic connector properties
1644 tv_selector = drm_property_create_enum(dev, 0,
1645 "select subconnector",
1646 drm_tv_select_enum_list,
1647 ARRAY_SIZE(drm_tv_select_enum_list));
1651 dev->mode_config.tv_select_subconnector_property = tv_selector;
1654 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1656 drm_tv_subconnector_enum_list,
1657 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1658 if (!tv_subconnector)
1660 dev->mode_config.tv_subconnector_property = tv_subconnector;
1663 * Other, TV specific properties: margins & TV modes.
1665 dev->mode_config.tv_left_margin_property =
1666 drm_property_create_range(dev, 0, "left margin", 0, 100);
1667 if (!dev->mode_config.tv_left_margin_property)
1670 dev->mode_config.tv_right_margin_property =
1671 drm_property_create_range(dev, 0, "right margin", 0, 100);
1672 if (!dev->mode_config.tv_right_margin_property)
1675 dev->mode_config.tv_top_margin_property =
1676 drm_property_create_range(dev, 0, "top margin", 0, 100);
1677 if (!dev->mode_config.tv_top_margin_property)
1680 dev->mode_config.tv_bottom_margin_property =
1681 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1682 if (!dev->mode_config.tv_bottom_margin_property)
1685 dev->mode_config.tv_mode_property =
1686 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1688 if (!dev->mode_config.tv_mode_property)
1691 for (i = 0; i < num_modes; i++)
1692 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1695 dev->mode_config.tv_brightness_property =
1696 drm_property_create_range(dev, 0, "brightness", 0, 100);
1697 if (!dev->mode_config.tv_brightness_property)
1700 dev->mode_config.tv_contrast_property =
1701 drm_property_create_range(dev, 0, "contrast", 0, 100);
1702 if (!dev->mode_config.tv_contrast_property)
1705 dev->mode_config.tv_flicker_reduction_property =
1706 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1707 if (!dev->mode_config.tv_flicker_reduction_property)
1710 dev->mode_config.tv_overscan_property =
1711 drm_property_create_range(dev, 0, "overscan", 0, 100);
1712 if (!dev->mode_config.tv_overscan_property)
1715 dev->mode_config.tv_saturation_property =
1716 drm_property_create_range(dev, 0, "saturation", 0, 100);
1717 if (!dev->mode_config.tv_saturation_property)
1720 dev->mode_config.tv_hue_property =
1721 drm_property_create_range(dev, 0, "hue", 0, 100);
1722 if (!dev->mode_config.tv_hue_property)
1729 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1732 * drm_mode_create_scaling_mode_property - create scaling mode property
1735 * Called by a driver the first time it's needed, must be attached to desired
1738 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1740 struct drm_property *scaling_mode;
1742 if (dev->mode_config.scaling_mode_property)
1746 drm_property_create_enum(dev, 0, "scaling mode",
1747 drm_scaling_mode_enum_list,
1748 ARRAY_SIZE(drm_scaling_mode_enum_list));
1750 dev->mode_config.scaling_mode_property = scaling_mode;
1754 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1757 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1760 * Called by a driver the first time it's needed, must be attached to desired
1764 * Zero on success, negative errno on failure.
1766 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1768 if (dev->mode_config.aspect_ratio_property)
1771 dev->mode_config.aspect_ratio_property =
1772 drm_property_create_enum(dev, 0, "aspect ratio",
1773 drm_aspect_ratio_enum_list,
1774 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1776 if (dev->mode_config.aspect_ratio_property == NULL)
1781 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1784 * drm_mode_create_dirty_property - create dirty property
1787 * Called by a driver the first time it's needed, must be attached to desired
1790 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1792 struct drm_property *dirty_info;
1794 if (dev->mode_config.dirty_info_property)
1798 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1800 drm_dirty_info_enum_list,
1801 ARRAY_SIZE(drm_dirty_info_enum_list));
1802 dev->mode_config.dirty_info_property = dirty_info;
1806 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1809 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1812 * Create the the suggested x/y offset property for connectors.
1814 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1816 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1819 dev->mode_config.suggested_x_property =
1820 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1822 dev->mode_config.suggested_y_property =
1823 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1825 if (dev->mode_config.suggested_x_property == NULL ||
1826 dev->mode_config.suggested_y_property == NULL)
1830 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1833 * drm_mode_getresources - get graphics configuration
1834 * @dev: drm device for the ioctl
1835 * @data: data pointer for the ioctl
1836 * @file_priv: drm file for the ioctl call
1838 * Construct a set of configuration description structures and return
1839 * them to the user, including CRTC, connector and framebuffer configuration.
1841 * Called by the user via ioctl.
1844 * Zero on success, negative errno on failure.
1846 int drm_mode_getresources(struct drm_device *dev, void *data,
1847 struct drm_file *file_priv)
1849 struct drm_mode_card_res *card_res = data;
1850 struct list_head *lh;
1851 struct drm_framebuffer *fb;
1852 struct drm_connector *connector;
1853 struct drm_crtc *crtc;
1854 struct drm_encoder *encoder;
1856 int connector_count = 0;
1859 int encoder_count = 0;
1861 uint32_t __user *fb_id;
1862 uint32_t __user *crtc_id;
1863 uint32_t __user *connector_id;
1864 uint32_t __user *encoder_id;
1866 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1870 mutex_lock(&file_priv->fbs_lock);
1872 * For the non-control nodes we need to limit the list of resources
1873 * by IDs in the group list for this node
1875 list_for_each(lh, &file_priv->fbs)
1878 /* handle this in 4 parts */
1880 if (card_res->count_fbs >= fb_count) {
1882 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1883 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1884 if (put_user(fb->base.id, fb_id + copied)) {
1885 mutex_unlock(&file_priv->fbs_lock);
1891 card_res->count_fbs = fb_count;
1892 mutex_unlock(&file_priv->fbs_lock);
1894 /* mode_config.mutex protects the connector list against e.g. DP MST
1895 * connector hot-adding. CRTC/Plane lists are invariant. */
1896 mutex_lock(&dev->mode_config.mutex);
1897 drm_for_each_crtc(crtc, dev)
1900 drm_for_each_connector(connector, dev)
1903 drm_for_each_encoder(encoder, dev)
1906 card_res->max_height = dev->mode_config.max_height;
1907 card_res->min_height = dev->mode_config.min_height;
1908 card_res->max_width = dev->mode_config.max_width;
1909 card_res->min_width = dev->mode_config.min_width;
1912 if (card_res->count_crtcs >= crtc_count) {
1914 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1915 drm_for_each_crtc(crtc, dev) {
1916 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1917 if (put_user(crtc->base.id, crtc_id + copied)) {
1924 card_res->count_crtcs = crtc_count;
1927 if (card_res->count_encoders >= encoder_count) {
1929 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1930 drm_for_each_encoder(encoder, dev) {
1931 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1933 if (put_user(encoder->base.id, encoder_id +
1941 card_res->count_encoders = encoder_count;
1944 if (card_res->count_connectors >= connector_count) {
1946 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1947 drm_for_each_connector(connector, dev) {
1948 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1951 if (put_user(connector->base.id,
1952 connector_id + copied)) {
1959 card_res->count_connectors = connector_count;
1961 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1962 card_res->count_connectors, card_res->count_encoders);
1965 mutex_unlock(&dev->mode_config.mutex);
1970 * drm_mode_getcrtc - get CRTC configuration
1971 * @dev: drm device for the ioctl
1972 * @data: data pointer for the ioctl
1973 * @file_priv: drm file for the ioctl call
1975 * Construct a CRTC configuration structure to return to the user.
1977 * Called by the user via ioctl.
1980 * Zero on success, negative errno on failure.
1982 int drm_mode_getcrtc(struct drm_device *dev,
1983 void *data, struct drm_file *file_priv)
1985 struct drm_mode_crtc *crtc_resp = data;
1986 struct drm_crtc *crtc;
1988 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1991 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
1995 drm_modeset_lock_crtc(crtc, crtc->primary);
1996 crtc_resp->gamma_size = crtc->gamma_size;
1997 if (crtc->primary->fb)
1998 crtc_resp->fb_id = crtc->primary->fb->base.id;
2000 crtc_resp->fb_id = 0;
2003 crtc_resp->x = crtc->primary->state->src_x >> 16;
2004 crtc_resp->y = crtc->primary->state->src_y >> 16;
2005 if (crtc->state->enable) {
2006 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
2007 crtc_resp->mode_valid = 1;
2010 crtc_resp->mode_valid = 0;
2013 crtc_resp->x = crtc->x;
2014 crtc_resp->y = crtc->y;
2015 if (crtc->enabled) {
2016 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2017 crtc_resp->mode_valid = 1;
2020 crtc_resp->mode_valid = 0;
2023 drm_modeset_unlock_crtc(crtc);
2028 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2029 const struct drm_file *file_priv)
2032 * If user-space hasn't configured the driver to expose the stereo 3D
2033 * modes, don't expose them.
2035 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2041 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2043 /* For atomic drivers only state objects are synchronously updated and
2044 * protected by modeset locks, so check those first. */
2045 if (connector->state)
2046 return connector->state->best_encoder;
2047 return connector->encoder;
2050 /* helper for getconnector and getproperties ioctls */
2051 static int get_properties(struct drm_mode_object *obj, bool atomic,
2052 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2053 uint32_t *arg_count_props)
2058 props_count = obj->properties->count;
2060 props_count -= obj->properties->atomic_count;
2062 if ((*arg_count_props >= props_count) && props_count) {
2063 for (i = 0, copied = 0; copied < props_count; i++) {
2064 struct drm_property *prop = obj->properties->properties[i];
2067 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2070 ret = drm_object_property_get_value(obj, prop, &val);
2074 if (put_user(prop->base.id, prop_ptr + copied))
2077 if (put_user(val, prop_values + copied))
2083 *arg_count_props = props_count;
2089 * drm_mode_getconnector - get connector configuration
2090 * @dev: drm device for the ioctl
2091 * @data: data pointer for the ioctl
2092 * @file_priv: drm file for the ioctl call
2094 * Construct a connector configuration structure to return to the user.
2096 * Called by the user via ioctl.
2099 * Zero on success, negative errno on failure.
2101 int drm_mode_getconnector(struct drm_device *dev, void *data,
2102 struct drm_file *file_priv)
2104 struct drm_mode_get_connector *out_resp = data;
2105 struct drm_connector *connector;
2106 struct drm_encoder *encoder;
2107 struct drm_display_mode *mode;
2109 int encoders_count = 0;
2113 struct drm_mode_modeinfo u_mode;
2114 struct drm_mode_modeinfo __user *mode_ptr;
2115 uint32_t __user *encoder_ptr;
2117 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2120 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2122 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2124 mutex_lock(&dev->mode_config.mutex);
2126 connector = drm_connector_find(dev, out_resp->connector_id);
2132 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2133 if (connector->encoder_ids[i] != 0)
2136 if (out_resp->count_modes == 0) {
2137 connector->funcs->fill_modes(connector,
2138 dev->mode_config.max_width,
2139 dev->mode_config.max_height);
2142 /* delayed so we get modes regardless of pre-fill_modes state */
2143 list_for_each_entry(mode, &connector->modes, head)
2144 if (drm_mode_expose_to_userspace(mode, file_priv))
2147 out_resp->connector_id = connector->base.id;
2148 out_resp->connector_type = connector->connector_type;
2149 out_resp->connector_type_id = connector->connector_type_id;
2150 out_resp->mm_width = connector->display_info.width_mm;
2151 out_resp->mm_height = connector->display_info.height_mm;
2152 out_resp->subpixel = connector->display_info.subpixel_order;
2153 out_resp->connection = connector->status;
2155 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2156 encoder = drm_connector_get_encoder(connector);
2158 out_resp->encoder_id = encoder->base.id;
2160 out_resp->encoder_id = 0;
2163 * This ioctl is called twice, once to determine how much space is
2164 * needed, and the 2nd time to fill it.
2166 if ((out_resp->count_modes >= mode_count) && mode_count) {
2168 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2169 list_for_each_entry(mode, &connector->modes, head) {
2170 if (!drm_mode_expose_to_userspace(mode, file_priv))
2173 drm_mode_convert_to_umode(&u_mode, mode);
2174 if (copy_to_user(mode_ptr + copied,
2175 &u_mode, sizeof(u_mode))) {
2182 out_resp->count_modes = mode_count;
2184 ret = get_properties(&connector->base, file_priv->atomic,
2185 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2186 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2187 &out_resp->count_props);
2191 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2193 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2194 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2195 if (connector->encoder_ids[i] != 0) {
2196 if (put_user(connector->encoder_ids[i],
2197 encoder_ptr + copied)) {
2205 out_resp->count_encoders = encoders_count;
2208 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2211 mutex_unlock(&dev->mode_config.mutex);
2216 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2218 struct drm_connector *connector;
2219 struct drm_device *dev = encoder->dev;
2220 bool uses_atomic = false;
2222 /* For atomic drivers only state objects are synchronously updated and
2223 * protected by modeset locks, so check those first. */
2224 drm_for_each_connector(connector, dev) {
2225 if (!connector->state)
2230 if (connector->state->best_encoder != encoder)
2233 return connector->state->crtc;
2236 /* Don't return stale data (e.g. pending async disable). */
2240 return encoder->crtc;
2244 * drm_mode_getencoder - get encoder configuration
2245 * @dev: drm device for the ioctl
2246 * @data: data pointer for the ioctl
2247 * @file_priv: drm file for the ioctl call
2249 * Construct a encoder configuration structure to return to the user.
2251 * Called by the user via ioctl.
2254 * Zero on success, negative errno on failure.
2256 int drm_mode_getencoder(struct drm_device *dev, void *data,
2257 struct drm_file *file_priv)
2259 struct drm_mode_get_encoder *enc_resp = data;
2260 struct drm_encoder *encoder;
2261 struct drm_crtc *crtc;
2263 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2266 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2270 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2271 crtc = drm_encoder_get_crtc(encoder);
2273 enc_resp->crtc_id = crtc->base.id;
2275 enc_resp->crtc_id = 0;
2276 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2278 enc_resp->encoder_type = encoder->encoder_type;
2279 enc_resp->encoder_id = encoder->base.id;
2280 enc_resp->possible_crtcs = encoder->possible_crtcs;
2281 enc_resp->possible_clones = encoder->possible_clones;
2287 * drm_mode_getplane_res - enumerate all plane resources
2290 * @file_priv: DRM file info
2292 * Construct a list of plane ids to return to the user.
2294 * Called by the user via ioctl.
2297 * Zero on success, negative errno on failure.
2299 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2300 struct drm_file *file_priv)
2302 struct drm_mode_get_plane_res *plane_resp = data;
2303 struct drm_mode_config *config;
2304 struct drm_plane *plane;
2305 uint32_t __user *plane_ptr;
2307 unsigned num_planes;
2309 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2312 config = &dev->mode_config;
2314 if (file_priv->universal_planes)
2315 num_planes = config->num_total_plane;
2317 num_planes = config->num_overlay_plane;
2318 if (!file_priv->share_planes) {
2319 if (file_priv->universal_planes)
2320 num_planes -= config->num_share_plane;
2322 num_planes -= config->num_share_overlay_plane;
2326 * This ioctl is called twice, once to determine how much space is
2327 * needed, and the 2nd time to fill it.
2330 (plane_resp->count_planes >= num_planes)) {
2331 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2333 /* Plane lists are invariant, no locking needed. */
2334 drm_for_each_plane(plane, dev) {
2336 * Unless userspace set the 'universal planes'
2337 * capability bit, only advertise overlays.
2339 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2340 !file_priv->universal_planes)
2342 if (plane->parent && !file_priv->share_planes)
2345 if (put_user(plane->base.id, plane_ptr + copied))
2350 plane_resp->count_planes = num_planes;
2356 * drm_mode_getplane - get plane configuration
2359 * @file_priv: DRM file info
2361 * Construct a plane configuration structure to return to the user.
2363 * Called by the user via ioctl.
2366 * Zero on success, negative errno on failure.
2368 int drm_mode_getplane(struct drm_device *dev, void *data,
2369 struct drm_file *file_priv)
2371 struct drm_mode_get_plane *plane_resp = data;
2372 struct drm_plane *plane;
2373 uint32_t __user *format_ptr;
2375 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2378 plane = drm_plane_find(dev, plane_resp->plane_id);
2382 drm_modeset_lock(&plane->mutex, NULL);
2384 plane_resp->crtc_id = plane->crtc->base.id;
2386 plane_resp->crtc_id = 0;
2389 plane_resp->fb_id = plane->fb->base.id;
2391 plane_resp->fb_id = 0;
2392 drm_modeset_unlock(&plane->mutex);
2394 plane_resp->plane_id = plane->base.id;
2395 plane_resp->possible_crtcs = plane->possible_crtcs;
2396 plane_resp->gamma_size = 0;
2399 * This ioctl is called twice, once to determine how much space is
2400 * needed, and the 2nd time to fill it.
2402 if (plane->format_count &&
2403 (plane_resp->count_format_types >= plane->format_count)) {
2404 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2405 if (copy_to_user(format_ptr,
2406 plane->format_types,
2407 sizeof(uint32_t) * plane->format_count)) {
2411 plane_resp->count_format_types = plane->format_count;
2417 * drm_plane_check_pixel_format - Check if the plane supports the pixel format
2418 * @plane: plane to check for format support
2419 * @format: the pixel format
2422 * Zero of @plane has @format in its list of supported pixel formats, -EINVAL
2425 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
2429 for (i = 0; i < plane->format_count; i++) {
2430 if (format == plane->format_types[i])
2437 static int check_src_coords(uint32_t src_x, uint32_t src_y,
2438 uint32_t src_w, uint32_t src_h,
2439 const struct drm_framebuffer *fb)
2441 unsigned int fb_width, fb_height;
2443 fb_width = fb->width << 16;
2444 fb_height = fb->height << 16;
2446 /* Make sure source coordinates are inside the fb. */
2447 if (src_w > fb_width ||
2448 src_x > fb_width - src_w ||
2449 src_h > fb_height ||
2450 src_y > fb_height - src_h) {
2451 DRM_DEBUG_KMS("Invalid source coordinates "
2452 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2453 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2454 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2455 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2456 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2464 * setplane_internal - setplane handler for internal callers
2466 * Note that we assume an extra reference has already been taken on fb. If the
2467 * update fails, this reference will be dropped before return; if it succeeds,
2468 * the previous framebuffer (if any) will be unreferenced instead.
2470 * src_{x,y,w,h} are provided in 16.16 fixed point format
2472 static int __setplane_internal(struct drm_plane *plane,
2473 struct drm_crtc *crtc,
2474 struct drm_framebuffer *fb,
2475 int32_t crtc_x, int32_t crtc_y,
2476 uint32_t crtc_w, uint32_t crtc_h,
2477 /* src_{x,y,w,h} values are 16.16 fixed point */
2478 uint32_t src_x, uint32_t src_y,
2479 uint32_t src_w, uint32_t src_h)
2483 /* No fb means shut it down */
2485 plane->old_fb = plane->fb;
2486 ret = plane->funcs->disable_plane(plane);
2491 plane->old_fb = NULL;
2496 /* Check whether this plane is usable on this CRTC */
2497 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2498 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2503 /* Check whether this plane supports the fb pixel format. */
2504 ret = drm_plane_check_pixel_format(plane, fb->pixel_format);
2506 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2507 drm_get_format_name(fb->pixel_format));
2511 /* Give drivers some help against integer overflows */
2512 if (crtc_w > INT_MAX ||
2513 crtc_x > INT_MAX - (int32_t) crtc_w ||
2515 crtc_y > INT_MAX - (int32_t) crtc_h) {
2516 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2517 crtc_w, crtc_h, crtc_x, crtc_y);
2522 ret = check_src_coords(src_x, src_y, src_w, src_h, fb);
2526 plane->old_fb = plane->fb;
2527 ret = plane->funcs->update_plane(plane, crtc, fb,
2528 crtc_x, crtc_y, crtc_w, crtc_h,
2529 src_x, src_y, src_w, src_h);
2535 plane->old_fb = NULL;
2540 drm_framebuffer_unreference(fb);
2542 drm_framebuffer_unreference(plane->old_fb);
2543 plane->old_fb = NULL;
2548 static int setplane_internal(struct drm_plane *plane,
2549 struct drm_crtc *crtc,
2550 struct drm_framebuffer *fb,
2551 int32_t crtc_x, int32_t crtc_y,
2552 uint32_t crtc_w, uint32_t crtc_h,
2553 /* src_{x,y,w,h} values are 16.16 fixed point */
2554 uint32_t src_x, uint32_t src_y,
2555 uint32_t src_w, uint32_t src_h)
2559 drm_modeset_lock_all(plane->dev);
2560 ret = __setplane_internal(plane, crtc, fb,
2561 crtc_x, crtc_y, crtc_w, crtc_h,
2562 src_x, src_y, src_w, src_h);
2563 drm_modeset_unlock_all(plane->dev);
2569 * drm_mode_setplane - configure a plane's configuration
2571 * @data: ioctl data*
2572 * @file_priv: DRM file info
2574 * Set plane configuration, including placement, fb, scaling, and other factors.
2575 * Or pass a NULL fb to disable (planes may be disabled without providing a
2579 * Zero on success, negative errno on failure.
2581 int drm_mode_setplane(struct drm_device *dev, void *data,
2582 struct drm_file *file_priv)
2584 struct drm_mode_set_plane *plane_req = data;
2585 struct drm_plane *plane;
2586 struct drm_crtc *crtc = NULL;
2587 struct drm_framebuffer *fb = NULL;
2589 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2593 * First, find the plane, crtc, and fb objects. If not available,
2594 * we don't bother to call the driver.
2596 plane = drm_plane_find(dev, plane_req->plane_id);
2598 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2599 plane_req->plane_id);
2603 if (plane_req->fb_id) {
2604 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2606 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2611 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2613 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2614 plane_req->crtc_id);
2620 * setplane_internal will take care of deref'ing either the old or new
2621 * framebuffer depending on success.
2623 return setplane_internal(plane, crtc, fb,
2624 plane_req->crtc_x, plane_req->crtc_y,
2625 plane_req->crtc_w, plane_req->crtc_h,
2626 plane_req->src_x, plane_req->src_y,
2627 plane_req->src_w, plane_req->src_h);
2631 * drm_mode_set_config_internal - helper to call ->set_config
2632 * @set: modeset config to set
2634 * This is a little helper to wrap internal calls to the ->set_config driver
2635 * interface. The only thing it adds is correct refcounting dance.
2638 * Zero on success, negative errno on failure.
2640 int drm_mode_set_config_internal(struct drm_mode_set *set)
2642 struct drm_crtc *crtc = set->crtc;
2643 struct drm_framebuffer *fb;
2644 struct drm_crtc *tmp;
2648 * NOTE: ->set_config can also disable other crtcs (if we steal all
2649 * connectors from it), hence we need to refcount the fbs across all
2650 * crtcs. Atomic modeset will have saner semantics ...
2652 drm_for_each_crtc(tmp, crtc->dev)
2653 tmp->primary->old_fb = tmp->primary->fb;
2657 ret = crtc->funcs->set_config(set);
2659 crtc->primary->crtc = crtc;
2660 crtc->primary->fb = fb;
2663 drm_for_each_crtc(tmp, crtc->dev) {
2664 if (tmp->primary->fb)
2665 drm_framebuffer_reference(tmp->primary->fb);
2666 if (tmp->primary->old_fb)
2667 drm_framebuffer_unreference(tmp->primary->old_fb);
2668 tmp->primary->old_fb = NULL;
2673 EXPORT_SYMBOL(drm_mode_set_config_internal);
2676 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
2677 * @mode: mode to query
2678 * @hdisplay: hdisplay value to fill in
2679 * @vdisplay: vdisplay value to fill in
2681 * The vdisplay value will be doubled if the specified mode is a stereo mode of
2682 * the appropriate layout.
2684 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2685 int *hdisplay, int *vdisplay)
2687 struct drm_display_mode adjusted;
2689 drm_mode_copy(&adjusted, mode);
2690 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
2691 *hdisplay = adjusted.crtc_hdisplay;
2692 *vdisplay = adjusted.crtc_vdisplay;
2694 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
2697 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2699 * @crtc: CRTC that framebuffer will be displayed on
2702 * @mode: mode that framebuffer will be displayed under
2703 * @fb: framebuffer to check size of
2705 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2707 const struct drm_display_mode *mode,
2708 const struct drm_framebuffer *fb)
2711 int hdisplay, vdisplay;
2713 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
2716 crtc->primary->state->rotation & (BIT(DRM_ROTATE_90) |
2717 BIT(DRM_ROTATE_270)))
2718 swap(hdisplay, vdisplay);
2720 return check_src_coords(x << 16, y << 16,
2721 hdisplay << 16, vdisplay << 16, fb);
2723 EXPORT_SYMBOL(drm_crtc_check_viewport);
2726 * drm_mode_setcrtc - set CRTC configuration
2727 * @dev: drm device for the ioctl
2728 * @data: data pointer for the ioctl
2729 * @file_priv: drm file for the ioctl call
2731 * Build a new CRTC configuration based on user request.
2733 * Called by the user via ioctl.
2736 * Zero on success, negative errno on failure.
2738 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2739 struct drm_file *file_priv)
2741 struct drm_mode_config *config = &dev->mode_config;
2742 struct drm_mode_crtc *crtc_req = data;
2743 struct drm_crtc *crtc;
2744 struct drm_connector **connector_set = NULL, *connector;
2745 struct drm_framebuffer *fb = NULL;
2746 struct drm_display_mode *mode = NULL;
2747 struct drm_mode_set set;
2748 uint32_t __user *set_connectors_ptr;
2752 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2756 * Universal plane src offsets are only 16.16, prevent havoc for
2757 * drivers using universal plane code internally.
2759 if (crtc_req->x & 0xffff0000 || crtc_req->y & 0xffff0000)
2762 drm_modeset_lock_all(dev);
2763 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2765 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2769 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2771 if (crtc_req->mode_valid) {
2772 /* If we have a mode we need a framebuffer. */
2773 /* If we pass -1, set the mode with the currently bound fb */
2774 if (crtc_req->fb_id == -1) {
2775 if (!crtc->primary->fb) {
2776 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2780 fb = crtc->primary->fb;
2781 /* Make refcounting symmetric with the lookup path. */
2782 drm_framebuffer_reference(fb);
2784 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2786 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2793 mode = drm_mode_create(dev);
2799 ret = drm_mode_convert_umode(mode, &crtc_req->mode);
2801 DRM_DEBUG_KMS("Invalid mode\n");
2806 * Check whether the primary plane supports the fb pixel format.
2807 * Drivers not implementing the universal planes API use a
2808 * default formats list provided by the DRM core which doesn't
2809 * match real hardware capabilities. Skip the check in that
2812 if (!crtc->primary->format_default) {
2813 ret = drm_plane_check_pixel_format(crtc->primary,
2816 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2817 drm_get_format_name(fb->pixel_format));
2822 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2829 if (crtc_req->count_connectors == 0 && mode) {
2830 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2835 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2836 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2837 crtc_req->count_connectors);
2842 if (crtc_req->count_connectors > 0) {
2845 /* Avoid unbounded kernel memory allocation */
2846 if (crtc_req->count_connectors > config->num_connector) {
2851 connector_set = kmalloc_array(crtc_req->count_connectors,
2852 sizeof(struct drm_connector *),
2854 if (!connector_set) {
2859 for (i = 0; i < crtc_req->count_connectors; i++) {
2860 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2861 if (get_user(out_id, &set_connectors_ptr[i])) {
2866 connector = drm_connector_find(dev, out_id);
2868 DRM_DEBUG_KMS("Connector id %d unknown\n",
2873 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2877 connector_set[i] = connector;
2882 set.x = crtc_req->x;
2883 set.y = crtc_req->y;
2885 set.connectors = connector_set;
2886 set.num_connectors = crtc_req->count_connectors;
2888 ret = drm_mode_set_config_internal(&set);
2892 drm_framebuffer_unreference(fb);
2894 kfree(connector_set);
2895 drm_mode_destroy(dev, mode);
2896 drm_modeset_unlock_all(dev);
2901 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2902 * universal plane handler call
2903 * @crtc: crtc to update cursor for
2904 * @req: data pointer for the ioctl
2905 * @file_priv: drm file for the ioctl call
2907 * Legacy cursor ioctl's work directly with driver buffer handles. To
2908 * translate legacy ioctl calls into universal plane handler calls, we need to
2909 * wrap the native buffer handle in a drm_framebuffer.
2911 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2912 * buffer with a pitch of 4*width; the universal plane interface should be used
2913 * directly in cases where the hardware can support other buffer settings and
2914 * userspace wants to make use of these capabilities.
2917 * Zero on success, negative errno on failure.
2919 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2920 struct drm_mode_cursor2 *req,
2921 struct drm_file *file_priv)
2923 struct drm_device *dev = crtc->dev;
2924 struct drm_framebuffer *fb = NULL;
2925 struct drm_mode_fb_cmd2 fbreq = {
2926 .width = req->width,
2927 .height = req->height,
2928 .pixel_format = DRM_FORMAT_ARGB8888,
2929 .pitches = { req->width * 4 },
2930 .handles = { req->handle },
2932 int32_t crtc_x, crtc_y;
2933 uint32_t crtc_w = 0, crtc_h = 0;
2934 uint32_t src_w = 0, src_h = 0;
2937 BUG_ON(!crtc->cursor);
2938 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2941 * Obtain fb we'll be using (either new or existing) and take an extra
2942 * reference to it if fb != null. setplane will take care of dropping
2943 * the reference if the plane update fails.
2945 if (req->flags & DRM_MODE_CURSOR_BO) {
2947 fb = internal_framebuffer_create(dev, &fbreq, file_priv);
2949 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2956 fb = crtc->cursor->fb;
2958 drm_framebuffer_reference(fb);
2961 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2965 crtc_x = crtc->cursor_x;
2966 crtc_y = crtc->cursor_y;
2971 crtc_h = fb->height;
2972 src_w = fb->width << 16;
2973 src_h = fb->height << 16;
2977 * setplane_internal will take care of deref'ing either the old or new
2978 * framebuffer depending on success.
2980 ret = __setplane_internal(crtc->cursor, crtc, fb,
2981 crtc_x, crtc_y, crtc_w, crtc_h,
2982 0, 0, src_w, src_h);
2984 /* Update successful; save new cursor position, if necessary */
2985 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
2986 crtc->cursor_x = req->x;
2987 crtc->cursor_y = req->y;
2993 static int drm_mode_cursor_common(struct drm_device *dev,
2994 struct drm_mode_cursor2 *req,
2995 struct drm_file *file_priv)
2997 struct drm_crtc *crtc;
3000 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3003 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
3006 crtc = drm_crtc_find(dev, req->crtc_id);
3008 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
3013 * If this crtc has a universal cursor plane, call that plane's update
3014 * handler rather than using legacy cursor handlers.
3016 drm_modeset_lock_crtc(crtc, crtc->cursor);
3018 ret = drm_mode_cursor_universal(crtc, req, file_priv);
3022 if (req->flags & DRM_MODE_CURSOR_BO) {
3023 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
3027 /* Turns off the cursor if handle is 0 */
3028 if (crtc->funcs->cursor_set2)
3029 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
3030 req->width, req->height, req->hot_x, req->hot_y);
3032 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
3033 req->width, req->height);
3036 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3037 if (crtc->funcs->cursor_move) {
3038 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3045 drm_modeset_unlock_crtc(crtc);
3053 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3054 * @dev: drm device for the ioctl
3055 * @data: data pointer for the ioctl
3056 * @file_priv: drm file for the ioctl call
3058 * Set the cursor configuration based on user request.
3060 * Called by the user via ioctl.
3063 * Zero on success, negative errno on failure.
3065 int drm_mode_cursor_ioctl(struct drm_device *dev,
3066 void *data, struct drm_file *file_priv)
3068 struct drm_mode_cursor *req = data;
3069 struct drm_mode_cursor2 new_req;
3071 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3072 new_req.hot_x = new_req.hot_y = 0;
3074 return drm_mode_cursor_common(dev, &new_req, file_priv);
3078 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3079 * @dev: drm device for the ioctl
3080 * @data: data pointer for the ioctl
3081 * @file_priv: drm file for the ioctl call
3083 * Set the cursor configuration based on user request. This implements the 2nd
3084 * version of the cursor ioctl, which allows userspace to additionally specify
3085 * the hotspot of the pointer.
3087 * Called by the user via ioctl.
3090 * Zero on success, negative errno on failure.
3092 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3093 void *data, struct drm_file *file_priv)
3095 struct drm_mode_cursor2 *req = data;
3097 return drm_mode_cursor_common(dev, req, file_priv);
3101 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3102 * @bpp: bits per pixels
3103 * @depth: bit depth per pixel
3105 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3106 * Useful in fbdev emulation code, since that deals in those values.
3108 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3114 fmt = DRM_FORMAT_C8;
3118 fmt = DRM_FORMAT_XRGB1555;
3120 fmt = DRM_FORMAT_RGB565;
3123 fmt = DRM_FORMAT_RGB888;
3127 fmt = DRM_FORMAT_XRGB8888;
3128 else if (depth == 30)
3129 fmt = DRM_FORMAT_XRGB2101010;
3131 fmt = DRM_FORMAT_ARGB8888;
3134 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3135 fmt = DRM_FORMAT_XRGB8888;
3141 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3144 * drm_mode_addfb - add an FB to the graphics configuration
3145 * @dev: drm device for the ioctl
3146 * @data: data pointer for the ioctl
3147 * @file_priv: drm file for the ioctl call
3149 * Add a new FB to the specified CRTC, given a user request. This is the
3150 * original addfb ioctl which only supported RGB formats.
3152 * Called by the user via ioctl.
3155 * Zero on success, negative errno on failure.
3157 int drm_mode_addfb(struct drm_device *dev,
3158 void *data, struct drm_file *file_priv)
3160 struct drm_mode_fb_cmd *or = data;
3161 struct drm_mode_fb_cmd2 r = {};
3164 /* convert to new format and call new ioctl */
3165 r.fb_id = or->fb_id;
3166 r.width = or->width;
3167 r.height = or->height;
3168 r.pitches[0] = or->pitch;
3169 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3170 r.handles[0] = or->handle;
3172 ret = drm_mode_addfb2(dev, &r, file_priv);
3176 or->fb_id = r.fb_id;
3181 static int format_check(const struct drm_mode_fb_cmd2 *r)
3183 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3187 case DRM_FORMAT_RGB332:
3188 case DRM_FORMAT_BGR233:
3189 case DRM_FORMAT_XRGB4444:
3190 case DRM_FORMAT_XBGR4444:
3191 case DRM_FORMAT_RGBX4444:
3192 case DRM_FORMAT_BGRX4444:
3193 case DRM_FORMAT_ARGB4444:
3194 case DRM_FORMAT_ABGR4444:
3195 case DRM_FORMAT_RGBA4444:
3196 case DRM_FORMAT_BGRA4444:
3197 case DRM_FORMAT_XRGB1555:
3198 case DRM_FORMAT_XBGR1555:
3199 case DRM_FORMAT_RGBX5551:
3200 case DRM_FORMAT_BGRX5551:
3201 case DRM_FORMAT_ARGB1555:
3202 case DRM_FORMAT_ABGR1555:
3203 case DRM_FORMAT_RGBA5551:
3204 case DRM_FORMAT_BGRA5551:
3205 case DRM_FORMAT_RGB565:
3206 case DRM_FORMAT_BGR565:
3207 case DRM_FORMAT_RGB888:
3208 case DRM_FORMAT_BGR888:
3209 case DRM_FORMAT_XRGB8888:
3210 case DRM_FORMAT_XBGR8888:
3211 case DRM_FORMAT_RGBX8888:
3212 case DRM_FORMAT_BGRX8888:
3213 case DRM_FORMAT_ARGB8888:
3214 case DRM_FORMAT_ABGR8888:
3215 case DRM_FORMAT_RGBA8888:
3216 case DRM_FORMAT_BGRA8888:
3217 case DRM_FORMAT_XRGB2101010:
3218 case DRM_FORMAT_XBGR2101010:
3219 case DRM_FORMAT_RGBX1010102:
3220 case DRM_FORMAT_BGRX1010102:
3221 case DRM_FORMAT_ARGB2101010:
3222 case DRM_FORMAT_ABGR2101010:
3223 case DRM_FORMAT_RGBA1010102:
3224 case DRM_FORMAT_BGRA1010102:
3225 case DRM_FORMAT_YUYV:
3226 case DRM_FORMAT_YVYU:
3227 case DRM_FORMAT_UYVY:
3228 case DRM_FORMAT_VYUY:
3229 case DRM_FORMAT_AYUV:
3230 case DRM_FORMAT_NV12:
3231 case DRM_FORMAT_NV21:
3232 case DRM_FORMAT_NV16:
3233 case DRM_FORMAT_NV61:
3234 case DRM_FORMAT_NV24:
3235 case DRM_FORMAT_NV42:
3236 case DRM_FORMAT_NV12_10:
3237 case DRM_FORMAT_NV21_10:
3238 case DRM_FORMAT_NV16_10:
3239 case DRM_FORMAT_NV61_10:
3240 case DRM_FORMAT_NV24_10:
3241 case DRM_FORMAT_NV42_10:
3242 case DRM_FORMAT_YUV410:
3243 case DRM_FORMAT_YVU410:
3244 case DRM_FORMAT_YUV411:
3245 case DRM_FORMAT_YVU411:
3246 case DRM_FORMAT_YUV420:
3247 case DRM_FORMAT_YVU420:
3248 case DRM_FORMAT_YUV422:
3249 case DRM_FORMAT_YVU422:
3250 case DRM_FORMAT_YUV444:
3251 case DRM_FORMAT_YVU444:
3254 DRM_DEBUG_KMS("invalid pixel format %s\n",
3255 drm_get_format_name(r->pixel_format));
3260 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3262 int ret, hsub, vsub, num_planes, i;
3264 ret = format_check(r);
3266 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3267 drm_get_format_name(r->pixel_format));
3271 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3272 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3273 num_planes = drm_format_num_planes(r->pixel_format);
3275 if (r->width == 0 || r->width % hsub) {
3276 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3280 if (r->height == 0 || r->height % vsub) {
3281 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3285 for (i = 0; i < num_planes; i++) {
3286 unsigned int width = r->width / (i != 0 ? hsub : 1);
3287 unsigned int height = r->height / (i != 0 ? vsub : 1);
3288 unsigned int bpp = drm_format_plane_bpp(r->pixel_format, i);
3290 if (!r->handles[i]) {
3291 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3295 if ((uint64_t) width * bpp / 8 > UINT_MAX)
3298 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3301 if (r->pitches[i] < roundup(width * bpp, 8) / 8) {
3302 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3306 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
3307 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
3312 /* modifier specific checks: */
3313 switch (r->modifier[i]) {
3314 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
3315 /* NOTE: the pitch restriction may be lifted later if it turns
3316 * out that no hw has this restriction:
3318 if (r->pixel_format != DRM_FORMAT_NV12 ||
3319 width % 128 || height % 32 ||
3320 r->pitches[i] % 128) {
3321 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
3331 for (i = num_planes; i < 4; i++) {
3332 if (r->modifier[i]) {
3333 DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
3337 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
3338 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
3341 if (r->handles[i]) {
3342 DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
3346 if (r->pitches[i]) {
3347 DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
3351 if (r->offsets[i]) {
3352 DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
3360 static struct drm_framebuffer *
3361 internal_framebuffer_create(struct drm_device *dev,
3362 struct drm_mode_fb_cmd2 *r,
3363 struct drm_file *file_priv)
3365 struct drm_mode_config *config = &dev->mode_config;
3366 struct drm_framebuffer *fb;
3369 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
3370 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3371 return ERR_PTR(-EINVAL);
3374 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3375 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3376 r->width, config->min_width, config->max_width);
3377 return ERR_PTR(-EINVAL);
3379 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3380 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3381 r->height, config->min_height, config->max_height);
3382 return ERR_PTR(-EINVAL);
3385 if (r->flags & DRM_MODE_FB_MODIFIERS &&
3386 !dev->mode_config.allow_fb_modifiers) {
3387 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
3388 return ERR_PTR(-EINVAL);
3391 ret = framebuffer_check(r);
3393 return ERR_PTR(ret);
3395 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3397 DRM_DEBUG_KMS("could not create framebuffer\n");
3405 * drm_mode_addfb2 - add an FB to the graphics configuration
3406 * @dev: drm device for the ioctl
3407 * @data: data pointer for the ioctl
3408 * @file_priv: drm file for the ioctl call
3410 * Add a new FB to the specified CRTC, given a user request with format. This is
3411 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3412 * and uses fourcc codes as pixel format specifiers.
3414 * Called by the user via ioctl.
3417 * Zero on success, negative errno on failure.
3419 int drm_mode_addfb2(struct drm_device *dev,
3420 void *data, struct drm_file *file_priv)
3422 struct drm_mode_fb_cmd2 *r = data;
3423 struct drm_framebuffer *fb;
3425 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3428 fb = internal_framebuffer_create(dev, r, file_priv);
3432 /* Transfer ownership to the filp for reaping on close */
3434 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3435 mutex_lock(&file_priv->fbs_lock);
3436 r->fb_id = fb->base.id;
3437 list_add(&fb->filp_head, &file_priv->fbs);
3438 mutex_unlock(&file_priv->fbs_lock);
3443 struct drm_mode_rmfb_work {
3444 struct work_struct work;
3445 struct list_head fbs;
3448 static void drm_mode_rmfb_work_fn(struct work_struct *w)
3450 struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
3452 while (!list_empty(&arg->fbs)) {
3453 struct drm_framebuffer *fb =
3454 list_first_entry(&arg->fbs, typeof(*fb), filp_head);
3456 list_del_init(&fb->filp_head);
3457 drm_framebuffer_remove(fb);
3462 * drm_mode_rmfb - remove an FB from the configuration
3463 * @dev: drm device for the ioctl
3464 * @data: data pointer for the ioctl
3465 * @file_priv: drm file for the ioctl call
3467 * Remove the FB specified by the user.
3469 * Called by the user via ioctl.
3472 * Zero on success, negative errno on failure.
3474 int drm_mode_rmfb(struct drm_device *dev,
3475 void *data, struct drm_file *file_priv)
3477 struct drm_framebuffer *fb = NULL;
3478 struct drm_framebuffer *fbl = NULL;
3479 uint32_t *id = data;
3482 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3485 mutex_lock(&file_priv->fbs_lock);
3486 mutex_lock(&dev->mode_config.fb_lock);
3487 fb = __drm_framebuffer_lookup(dev, *id);
3491 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3497 list_del_init(&fb->filp_head);
3498 mutex_unlock(&dev->mode_config.fb_lock);
3499 mutex_unlock(&file_priv->fbs_lock);
3502 * we now own the reference that was stored in the fbs list
3504 * drm_framebuffer_remove may fail with -EINTR on pending signals,
3505 * so run this in a separate stack as there's no way to correctly
3506 * handle this after the fb is already removed from the lookup table.
3508 if (atomic_read(&fb->refcount.refcount) > 1) {
3509 struct drm_mode_rmfb_work arg;
3511 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3512 INIT_LIST_HEAD(&arg.fbs);
3513 list_add_tail(&fb->filp_head, &arg.fbs);
3515 schedule_work(&arg.work);
3516 flush_work(&arg.work);
3517 destroy_work_on_stack(&arg.work);
3519 drm_framebuffer_unreference(fb);
3524 mutex_unlock(&dev->mode_config.fb_lock);
3525 mutex_unlock(&file_priv->fbs_lock);
3531 * drm_mode_getfb - get FB info
3532 * @dev: drm device for the ioctl
3533 * @data: data pointer for the ioctl
3534 * @file_priv: drm file for the ioctl call
3536 * Lookup the FB given its ID and return info about it.
3538 * Called by the user via ioctl.
3541 * Zero on success, negative errno on failure.
3543 int drm_mode_getfb(struct drm_device *dev,
3544 void *data, struct drm_file *file_priv)
3546 struct drm_mode_fb_cmd *r = data;
3547 struct drm_framebuffer *fb;
3550 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3553 fb = drm_framebuffer_lookup(dev, r->fb_id);
3557 r->height = fb->height;
3558 r->width = fb->width;
3559 r->depth = fb->depth;
3560 r->bpp = fb->bits_per_pixel;
3561 r->pitch = fb->pitches[0];
3562 if (fb->funcs->create_handle) {
3563 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3564 drm_is_control_client(file_priv)) {
3565 ret = fb->funcs->create_handle(fb, file_priv,
3568 /* GET_FB() is an unprivileged ioctl so we must not
3569 * return a buffer-handle to non-master processes! For
3570 * backwards-compatibility reasons, we cannot make
3571 * GET_FB() privileged, so just return an invalid handle
3572 * for non-masters. */
3580 drm_framebuffer_unreference(fb);
3586 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3587 * @dev: drm device for the ioctl
3588 * @data: data pointer for the ioctl
3589 * @file_priv: drm file for the ioctl call
3591 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3592 * rectangle list. Generic userspace which does frontbuffer rendering must call
3593 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3594 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3596 * Modesetting drivers which always update the frontbuffer do not need to
3597 * implement the corresponding ->dirty framebuffer callback.
3599 * Called by the user via ioctl.
3602 * Zero on success, negative errno on failure.
3604 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3605 void *data, struct drm_file *file_priv)
3607 struct drm_clip_rect __user *clips_ptr;
3608 struct drm_clip_rect *clips = NULL;
3609 struct drm_mode_fb_dirty_cmd *r = data;
3610 struct drm_framebuffer *fb;
3615 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3618 fb = drm_framebuffer_lookup(dev, r->fb_id);
3622 num_clips = r->num_clips;
3623 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3625 if (!num_clips != !clips_ptr) {
3630 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3632 /* If userspace annotates copy, clips must come in pairs */
3633 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3638 if (num_clips && clips_ptr) {
3639 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3643 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3649 ret = copy_from_user(clips, clips_ptr,
3650 num_clips * sizeof(*clips));
3657 if (fb->funcs->dirty) {
3658 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3667 drm_framebuffer_unreference(fb);
3673 * drm_fb_release - remove and free the FBs on this file
3674 * @priv: drm file for the ioctl
3676 * Destroy all the FBs associated with @filp.
3678 * Called by the user via ioctl.
3681 * Zero on success, negative errno on failure.
3683 void drm_fb_release(struct drm_file *priv)
3685 struct drm_framebuffer *fb, *tfb;
3686 struct drm_mode_rmfb_work arg;
3688 INIT_LIST_HEAD(&arg.fbs);
3691 * When the file gets released that means no one else can access the fb
3692 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3693 * avoid upsetting lockdep since the universal cursor code adds a
3694 * framebuffer while holding mutex locks.
3696 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3697 * locks is impossible here since no one else but this function can get
3700 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3701 if (atomic_read(&fb->refcount.refcount) > 1) {
3702 list_move_tail(&fb->filp_head, &arg.fbs);
3704 list_del_init(&fb->filp_head);
3706 /* This drops the fpriv->fbs reference. */
3707 drm_framebuffer_unreference(fb);
3711 if (!list_empty(&arg.fbs)) {
3712 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3714 schedule_work(&arg.work);
3715 flush_work(&arg.work);
3716 destroy_work_on_stack(&arg.work);
3721 * drm_property_create - create a new property type
3723 * @flags: flags specifying the property type
3724 * @name: name of the property
3725 * @num_values: number of pre-defined values
3727 * This creates a new generic drm property which can then be attached to a drm
3728 * object with drm_object_attach_property. The returned property object must be
3729 * freed with drm_property_destroy.
3731 * Note that the DRM core keeps a per-device list of properties and that, if
3732 * drm_mode_config_cleanup() is called, it will destroy all properties created
3736 * A pointer to the newly created property on success, NULL on failure.
3738 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3739 const char *name, int num_values)
3741 struct drm_property *property = NULL;
3744 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3748 property->dev = dev;
3751 property->values = kcalloc(num_values, sizeof(uint64_t),
3753 if (!property->values)
3757 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3761 property->flags = flags;
3762 property->num_values = num_values;
3763 INIT_LIST_HEAD(&property->enum_list);
3766 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3767 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3770 list_add_tail(&property->head, &dev->mode_config.property_list);
3772 WARN_ON(!drm_property_type_valid(property));
3776 kfree(property->values);
3780 EXPORT_SYMBOL(drm_property_create);
3783 * drm_property_create_enum - create a new enumeration property type
3785 * @flags: flags specifying the property type
3786 * @name: name of the property
3787 * @props: enumeration lists with property values
3788 * @num_values: number of pre-defined values
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 only allowed to set one of the predefined values for enumeration
3798 * A pointer to the newly created property on success, NULL on failure.
3800 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3802 const struct drm_prop_enum_list *props,
3805 struct drm_property *property;
3808 flags |= DRM_MODE_PROP_ENUM;
3810 property = drm_property_create(dev, flags, name, num_values);
3814 for (i = 0; i < num_values; i++) {
3815 ret = drm_property_add_enum(property, i,
3819 drm_property_destroy(dev, property);
3826 EXPORT_SYMBOL(drm_property_create_enum);
3829 * drm_property_create_bitmask - create a new bitmask property type
3831 * @flags: flags specifying the property type
3832 * @name: name of the property
3833 * @props: enumeration lists with property bitflags
3834 * @num_props: size of the @props array
3835 * @supported_bits: bitmask of all supported enumeration values
3837 * This creates a new bitmask drm property which can then be attached to a drm
3838 * object with drm_object_attach_property. The returned property object must be
3839 * freed with drm_property_destroy.
3841 * Compared to plain enumeration properties userspace is allowed to set any
3842 * or'ed together combination of the predefined property bitflag values
3845 * A pointer to the newly created property on success, NULL on failure.
3847 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3848 int flags, const char *name,
3849 const struct drm_prop_enum_list *props,
3851 uint64_t supported_bits)
3853 struct drm_property *property;
3854 int i, ret, index = 0;
3855 int num_values = hweight64(supported_bits);
3857 flags |= DRM_MODE_PROP_BITMASK;
3859 property = drm_property_create(dev, flags, name, num_values);
3862 for (i = 0; i < num_props; i++) {
3863 if (!(supported_bits & (1ULL << props[i].type)))
3866 if (WARN_ON(index >= num_values)) {
3867 drm_property_destroy(dev, property);
3871 ret = drm_property_add_enum(property, index++,
3875 drm_property_destroy(dev, property);
3882 EXPORT_SYMBOL(drm_property_create_bitmask);
3884 static struct drm_property *property_create_range(struct drm_device *dev,
3885 int flags, const char *name,
3886 uint64_t min, uint64_t max)
3888 struct drm_property *property;
3890 property = drm_property_create(dev, flags, name, 2);
3894 property->values[0] = min;
3895 property->values[1] = max;
3901 * drm_property_create_range - create a new unsigned ranged property type
3903 * @flags: flags specifying the property type
3904 * @name: name of the property
3905 * @min: minimum value of the property
3906 * @max: maximum value of the property
3908 * This creates a new generic drm property which can then be attached to a drm
3909 * object with drm_object_attach_property. The returned property object must be
3910 * freed with drm_property_destroy.
3912 * Userspace is allowed to set any unsigned integer value in the (min, max)
3916 * A pointer to the newly created property on success, NULL on failure.
3918 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3920 uint64_t min, uint64_t max)
3922 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3925 EXPORT_SYMBOL(drm_property_create_range);
3928 * drm_property_create_signed_range - create a new signed ranged property type
3930 * @flags: flags specifying the property type
3931 * @name: name of the property
3932 * @min: minimum value of the property
3933 * @max: maximum value of the property
3935 * This creates a new generic drm property which can then be attached to a drm
3936 * object with drm_object_attach_property. The returned property object must be
3937 * freed with drm_property_destroy.
3939 * Userspace is allowed to set any signed integer value in the (min, max)
3943 * A pointer to the newly created property on success, NULL on failure.
3945 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3946 int flags, const char *name,
3947 int64_t min, int64_t max)
3949 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3950 name, I642U64(min), I642U64(max));
3952 EXPORT_SYMBOL(drm_property_create_signed_range);
3955 * drm_property_create_object - create a new object property type
3957 * @flags: flags specifying the property type
3958 * @name: name of the property
3959 * @type: object type from DRM_MODE_OBJECT_* defines
3961 * This creates a new generic drm property which can then be attached to a drm
3962 * object with drm_object_attach_property. The returned property object must be
3963 * freed with drm_property_destroy.
3965 * Userspace is only allowed to set this to any property value of the given
3966 * @type. Only useful for atomic properties, which is enforced.
3969 * A pointer to the newly created property on success, NULL on failure.
3971 struct drm_property *drm_property_create_object(struct drm_device *dev,
3972 int flags, const char *name, uint32_t type)
3974 struct drm_property *property;
3976 flags |= DRM_MODE_PROP_OBJECT;
3978 if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
3981 property = drm_property_create(dev, flags, name, 1);
3985 property->values[0] = type;
3989 EXPORT_SYMBOL(drm_property_create_object);
3992 * drm_property_create_bool - create a new boolean property type
3994 * @flags: flags specifying the property type
3995 * @name: name of the property
3997 * This creates a new generic drm property which can then be attached to a drm
3998 * object with drm_object_attach_property. The returned property object must be
3999 * freed with drm_property_destroy.
4001 * This is implemented as a ranged property with only {0, 1} as valid values.
4004 * A pointer to the newly created property on success, NULL on failure.
4006 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
4009 return drm_property_create_range(dev, flags, name, 0, 1);
4011 EXPORT_SYMBOL(drm_property_create_bool);
4014 * drm_property_add_enum - add a possible value to an enumeration property
4015 * @property: enumeration property to change
4016 * @index: index of the new enumeration
4017 * @value: value of the new enumeration
4018 * @name: symbolic name of the new enumeration
4020 * This functions adds enumerations to a property.
4022 * It's use is deprecated, drivers should use one of the more specific helpers
4023 * to directly create the property with all enumerations already attached.
4026 * Zero on success, error code on failure.
4028 int drm_property_add_enum(struct drm_property *property, int index,
4029 uint64_t value, const char *name)
4031 struct drm_property_enum *prop_enum;
4033 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4034 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
4038 * Bitmask enum properties have the additional constraint of values
4041 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
4045 if (!list_empty(&property->enum_list)) {
4046 list_for_each_entry(prop_enum, &property->enum_list, head) {
4047 if (prop_enum->value == value) {
4048 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4049 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4055 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
4059 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4060 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4061 prop_enum->value = value;
4063 property->values[index] = value;
4064 list_add_tail(&prop_enum->head, &property->enum_list);
4067 EXPORT_SYMBOL(drm_property_add_enum);
4070 * drm_property_destroy - destroy a drm property
4072 * @property: property to destry
4074 * This function frees a property including any attached resources like
4075 * enumeration values.
4077 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
4079 struct drm_property_enum *prop_enum, *pt;
4081 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
4082 list_del(&prop_enum->head);
4086 if (property->num_values)
4087 kfree(property->values);
4088 drm_mode_object_put(dev, &property->base);
4089 list_del(&property->head);
4092 EXPORT_SYMBOL(drm_property_destroy);
4095 * drm_object_attach_property - attach a property to a modeset object
4096 * @obj: drm modeset object
4097 * @property: property to attach
4098 * @init_val: initial value of the property
4100 * This attaches the given property to the modeset object with the given initial
4101 * value. Currently this function cannot fail since the properties are stored in
4102 * a statically sized array.
4104 void drm_object_attach_property(struct drm_mode_object *obj,
4105 struct drm_property *property,
4108 int count = obj->properties->count;
4110 if (count == DRM_OBJECT_MAX_PROPERTY) {
4111 WARN(1, "Failed to attach object property (type: 0x%x). Please "
4112 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
4113 "you see this message on the same object type.\n",
4118 obj->properties->properties[count] = property;
4119 obj->properties->values[count] = init_val;
4120 obj->properties->count++;
4121 if (property->flags & DRM_MODE_PROP_ATOMIC)
4122 obj->properties->atomic_count++;
4124 EXPORT_SYMBOL(drm_object_attach_property);
4127 * drm_object_property_set_value - set the value of a property
4128 * @obj: drm mode object to set property value for
4129 * @property: property to set
4130 * @val: value the property should be set to
4132 * This functions sets a given property on a given object. This function only
4133 * changes the software state of the property, it does not call into the
4134 * driver's ->set_property callback.
4137 * Zero on success, error code on failure.
4139 int drm_object_property_set_value(struct drm_mode_object *obj,
4140 struct drm_property *property, uint64_t val)
4144 for (i = 0; i < obj->properties->count; i++) {
4145 if (obj->properties->properties[i] == property) {
4146 obj->properties->values[i] = val;
4153 EXPORT_SYMBOL(drm_object_property_set_value);
4156 * drm_object_property_get_value - retrieve the value of a property
4157 * @obj: drm mode object to get property value from
4158 * @property: property to retrieve
4159 * @val: storage for the property value
4161 * This function retrieves the softare state of the given property for the given
4162 * property. Since there is no driver callback to retrieve the current property
4163 * value this might be out of sync with the hardware, depending upon the driver
4167 * Zero on success, error code on failure.
4169 int drm_object_property_get_value(struct drm_mode_object *obj,
4170 struct drm_property *property, uint64_t *val)
4174 /* read-only properties bypass atomic mechanism and still store
4175 * their value in obj->properties->values[].. mostly to avoid
4176 * having to deal w/ EDID and similar props in atomic paths:
4178 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
4179 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
4180 return drm_atomic_get_property(obj, property, val);
4182 for (i = 0; i < obj->properties->count; i++) {
4183 if (obj->properties->properties[i] == property) {
4184 *val = obj->properties->values[i];
4191 EXPORT_SYMBOL(drm_object_property_get_value);
4194 * drm_mode_getproperty_ioctl - get the property metadata
4197 * @file_priv: DRM file info
4199 * This function retrieves the metadata for a given property, like the different
4200 * possible values for an enum property or the limits for a range property.
4202 * Blob properties are special
4204 * Called by the user via ioctl.
4207 * Zero on success, negative errno on failure.
4209 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4210 void *data, struct drm_file *file_priv)
4212 struct drm_mode_get_property *out_resp = data;
4213 struct drm_property *property;
4215 int value_count = 0;
4218 struct drm_property_enum *prop_enum;
4219 struct drm_mode_property_enum __user *enum_ptr;
4220 uint64_t __user *values_ptr;
4222 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4225 drm_modeset_lock_all(dev);
4226 property = drm_property_find(dev, out_resp->prop_id);
4232 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4233 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4234 list_for_each_entry(prop_enum, &property->enum_list, head)
4238 value_count = property->num_values;
4240 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4241 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4242 out_resp->flags = property->flags;
4244 if ((out_resp->count_values >= value_count) && value_count) {
4245 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4246 for (i = 0; i < value_count; i++) {
4247 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4253 out_resp->count_values = value_count;
4255 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4256 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4257 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4259 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4260 list_for_each_entry(prop_enum, &property->enum_list, head) {
4262 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4267 if (copy_to_user(&enum_ptr[copied].name,
4268 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4275 out_resp->count_enum_blobs = enum_count;
4279 * NOTE: The idea seems to have been to use this to read all the blob
4280 * property values. But nothing ever added them to the corresponding
4281 * list, userspace always used the special-purpose get_blob ioctl to
4282 * read the value for a blob property. It also doesn't make a lot of
4283 * sense to return values here when everything else is just metadata for
4284 * the property itself.
4286 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4287 out_resp->count_enum_blobs = 0;
4289 drm_modeset_unlock_all(dev);
4294 * drm_property_create_blob - Create new blob property
4296 * Creates a new blob property for a specified DRM device, optionally
4299 * @dev: DRM device to create property for
4300 * @length: Length to allocate for blob data
4301 * @data: If specified, copies data into blob
4304 * New blob property with a single reference on success, or an ERR_PTR
4307 struct drm_property_blob *
4308 drm_property_create_blob(struct drm_device *dev, size_t length,
4311 struct drm_property_blob *blob;
4314 if (!length || length > ULONG_MAX - sizeof(struct drm_property_blob))
4315 return ERR_PTR(-EINVAL);
4317 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4319 return ERR_PTR(-ENOMEM);
4321 /* This must be explicitly initialised, so we can safely call list_del
4322 * on it in the removal handler, even if it isn't in a file list. */
4323 INIT_LIST_HEAD(&blob->head_file);
4324 blob->length = length;
4328 memcpy(blob->data, data, length);
4330 mutex_lock(&dev->mode_config.blob_lock);
4332 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4335 mutex_unlock(&dev->mode_config.blob_lock);
4336 return ERR_PTR(-EINVAL);
4339 kref_init(&blob->refcount);
4341 list_add_tail(&blob->head_global,
4342 &dev->mode_config.property_blob_list);
4344 mutex_unlock(&dev->mode_config.blob_lock);
4348 EXPORT_SYMBOL(drm_property_create_blob);
4351 * drm_property_free_blob - Blob property destructor
4353 * Internal free function for blob properties; must not be used directly.
4357 static void drm_property_free_blob(struct kref *kref)
4359 struct drm_property_blob *blob =
4360 container_of(kref, struct drm_property_blob, refcount);
4362 WARN_ON(!mutex_is_locked(&blob->dev->mode_config.blob_lock));
4364 list_del(&blob->head_global);
4365 list_del(&blob->head_file);
4366 drm_mode_object_put(blob->dev, &blob->base);
4372 * drm_property_unreference_blob - Unreference a blob property
4374 * Drop a reference on a blob property. May free the object.
4376 * @blob: Pointer to blob property
4378 void drm_property_unreference_blob(struct drm_property_blob *blob)
4380 struct drm_device *dev;
4387 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4389 if (kref_put_mutex(&blob->refcount, drm_property_free_blob,
4390 &dev->mode_config.blob_lock))
4391 mutex_unlock(&dev->mode_config.blob_lock);
4393 might_lock(&dev->mode_config.blob_lock);
4395 EXPORT_SYMBOL(drm_property_unreference_blob);
4398 * drm_property_unreference_blob_locked - Unreference a blob property with blob_lock held
4400 * Drop a reference on a blob property. May free the object. This must be
4401 * called with blob_lock held.
4403 * @blob: Pointer to blob property
4405 static void drm_property_unreference_blob_locked(struct drm_property_blob *blob)
4410 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4412 kref_put(&blob->refcount, drm_property_free_blob);
4416 * drm_property_destroy_user_blobs - destroy all blobs created by this client
4418 * @file_priv: destroy all blobs owned by this file handle
4420 void drm_property_destroy_user_blobs(struct drm_device *dev,
4421 struct drm_file *file_priv)
4423 struct drm_property_blob *blob, *bt;
4425 mutex_lock(&dev->mode_config.blob_lock);
4427 list_for_each_entry_safe(blob, bt, &file_priv->blobs, head_file) {
4428 list_del_init(&blob->head_file);
4429 drm_property_unreference_blob_locked(blob);
4432 mutex_unlock(&dev->mode_config.blob_lock);
4436 * drm_property_reference_blob - Take a reference on an existing property
4438 * Take a new reference on an existing blob property.
4440 * @blob: Pointer to blob property
4442 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob)
4444 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4445 kref_get(&blob->refcount);
4448 EXPORT_SYMBOL(drm_property_reference_blob);
4451 * Like drm_property_lookup_blob, but does not return an additional reference.
4452 * Must be called with blob_lock held.
4454 static struct drm_property_blob *__drm_property_lookup_blob(struct drm_device *dev,
4457 struct drm_mode_object *obj = NULL;
4458 struct drm_property_blob *blob;
4460 WARN_ON(!mutex_is_locked(&dev->mode_config.blob_lock));
4462 mutex_lock(&dev->mode_config.idr_mutex);
4463 obj = idr_find(&dev->mode_config.crtc_idr, id);
4464 if (!obj || (obj->type != DRM_MODE_OBJECT_BLOB) || (obj->id != id))
4467 blob = obj_to_blob(obj);
4468 mutex_unlock(&dev->mode_config.idr_mutex);
4474 * drm_property_lookup_blob - look up a blob property and take a reference
4476 * @id: id of the blob property
4478 * If successful, this takes an additional reference to the blob property.
4479 * callers need to make sure to eventually unreference the returned property
4480 * again, using @drm_property_unreference_blob.
4482 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
4485 struct drm_property_blob *blob;
4487 mutex_lock(&dev->mode_config.blob_lock);
4488 blob = __drm_property_lookup_blob(dev, id);
4490 if (!kref_get_unless_zero(&blob->refcount))
4493 mutex_unlock(&dev->mode_config.blob_lock);
4497 EXPORT_SYMBOL(drm_property_lookup_blob);
4500 * drm_property_replace_global_blob - atomically replace existing blob property
4502 * @replace: location of blob property pointer to be replaced
4503 * @length: length of data for new blob, or 0 for no data
4504 * @data: content for new blob, or NULL for no data
4505 * @obj_holds_id: optional object for property holding blob ID
4506 * @prop_holds_id: optional property holding blob ID
4507 * @return 0 on success or error on failure
4509 * This function will atomically replace a global property in the blob list,
4510 * optionally updating a property which holds the ID of that property. It is
4511 * guaranteed to be atomic: no caller will be allowed to see intermediate
4512 * results, and either the entire operation will succeed and clean up the
4513 * previous property, or it will fail and the state will be unchanged.
4515 * If length is 0 or data is NULL, no new blob will be created, and the holding
4516 * property, if specified, will be set to 0.
4518 * Access to the replace pointer is assumed to be protected by the caller, e.g.
4519 * by holding the relevant modesetting object lock for its parent.
4521 * For example, a drm_connector has a 'PATH' property, which contains the ID
4522 * of a blob property with the value of the MST path information. Calling this
4523 * function with replace pointing to the connector's path_blob_ptr, length and
4524 * data set for the new path information, obj_holds_id set to the connector's
4525 * base object, and prop_holds_id set to the path property name, will perform
4526 * a completely atomic update. The access to path_blob_ptr is protected by the
4527 * caller holding a lock on the connector.
4529 static int drm_property_replace_global_blob(struct drm_device *dev,
4530 struct drm_property_blob **replace,
4533 struct drm_mode_object *obj_holds_id,
4534 struct drm_property *prop_holds_id)
4536 struct drm_property_blob *new_blob = NULL;
4537 struct drm_property_blob *old_blob = NULL;
4540 WARN_ON(replace == NULL);
4542 old_blob = *replace;
4544 if (length && data) {
4545 new_blob = drm_property_create_blob(dev, length, data);
4546 if (IS_ERR(new_blob))
4547 return PTR_ERR(new_blob);
4550 /* This does not need to be synchronised with blob_lock, as the
4551 * get_properties ioctl locks all modesetting objects, and
4552 * obj_holds_id must be locked before calling here, so we cannot
4553 * have its value out of sync with the list membership modified
4554 * below under blob_lock. */
4556 ret = drm_object_property_set_value(obj_holds_id,
4559 new_blob->base.id : 0);
4564 drm_property_unreference_blob(old_blob);
4565 *replace = new_blob;
4570 drm_property_unreference_blob(new_blob);
4575 * drm_mode_getblob_ioctl - get the contents of a blob property value
4578 * @file_priv: DRM file info
4580 * This function retrieves the contents of a blob property. The value stored in
4581 * an object's blob property is just a normal modeset object id.
4583 * Called by the user via ioctl.
4586 * Zero on success, negative errno on failure.
4588 int drm_mode_getblob_ioctl(struct drm_device *dev,
4589 void *data, struct drm_file *file_priv)
4591 struct drm_mode_get_blob *out_resp = data;
4592 struct drm_property_blob *blob;
4594 void __user *blob_ptr;
4596 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4599 drm_modeset_lock_all(dev);
4600 mutex_lock(&dev->mode_config.blob_lock);
4601 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4607 if (out_resp->length == blob->length) {
4608 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4609 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4614 out_resp->length = blob->length;
4617 mutex_unlock(&dev->mode_config.blob_lock);
4618 drm_modeset_unlock_all(dev);
4623 * drm_mode_createblob_ioctl - create a new blob property
4626 * @file_priv: DRM file info
4628 * This function creates a new blob property with user-defined values. In order
4629 * to give us sensible validation and checking when creating, rather than at
4630 * every potential use, we also require a type to be provided upfront.
4632 * Called by the user via ioctl.
4635 * Zero on success, negative errno on failure.
4637 int drm_mode_createblob_ioctl(struct drm_device *dev,
4638 void *data, struct drm_file *file_priv)
4640 struct drm_mode_create_blob *out_resp = data;
4641 struct drm_property_blob *blob;
4642 void __user *blob_ptr;
4645 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4648 blob = drm_property_create_blob(dev, out_resp->length, NULL);
4650 return PTR_ERR(blob);
4652 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4653 if (copy_from_user(blob->data, blob_ptr, out_resp->length)) {
4658 /* Dropping the lock between create_blob and our access here is safe
4659 * as only the same file_priv can remove the blob; at this point, it is
4660 * not associated with any file_priv. */
4661 mutex_lock(&dev->mode_config.blob_lock);
4662 out_resp->blob_id = blob->base.id;
4663 list_add_tail(&blob->head_file, &file_priv->blobs);
4664 mutex_unlock(&dev->mode_config.blob_lock);
4669 drm_property_unreference_blob(blob);
4674 * drm_mode_destroyblob_ioctl - destroy a user blob property
4677 * @file_priv: DRM file info
4679 * Destroy an existing user-defined blob property.
4681 * Called by the user via ioctl.
4684 * Zero on success, negative errno on failure.
4686 int drm_mode_destroyblob_ioctl(struct drm_device *dev,
4687 void *data, struct drm_file *file_priv)
4689 struct drm_mode_destroy_blob *out_resp = data;
4690 struct drm_property_blob *blob = NULL, *bt;
4694 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4697 mutex_lock(&dev->mode_config.blob_lock);
4698 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4704 /* Ensure the property was actually created by this user. */
4705 list_for_each_entry(bt, &file_priv->blobs, head_file) {
4717 /* We must drop head_file here, because we may not be the last
4718 * reference on the blob. */
4719 list_del_init(&blob->head_file);
4720 drm_property_unreference_blob_locked(blob);
4721 mutex_unlock(&dev->mode_config.blob_lock);
4726 mutex_unlock(&dev->mode_config.blob_lock);
4731 * drm_mode_connector_set_path_property - set tile property on connector
4732 * @connector: connector to set property on.
4733 * @path: path to use for property; must not be NULL.
4735 * This creates a property to expose to userspace to specify a
4736 * connector path. This is mainly used for DisplayPort MST where
4737 * connectors have a topology and we want to allow userspace to give
4738 * them more meaningful names.
4741 * Zero on success, negative errno on failure.
4743 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4746 struct drm_device *dev = connector->dev;
4749 ret = drm_property_replace_global_blob(dev,
4750 &connector->path_blob_ptr,
4754 dev->mode_config.path_property);
4757 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4760 * drm_mode_connector_set_tile_property - set tile property on connector
4761 * @connector: connector to set property on.
4763 * This looks up the tile information for a connector, and creates a
4764 * property for userspace to parse if it exists. The property is of
4765 * the form of 8 integers using ':' as a separator.
4768 * Zero on success, errno on failure.
4770 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4772 struct drm_device *dev = connector->dev;
4776 if (!connector->has_tile) {
4777 ret = drm_property_replace_global_blob(dev,
4778 &connector->tile_blob_ptr,
4782 dev->mode_config.tile_property);
4786 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4787 connector->tile_group->id, connector->tile_is_single_monitor,
4788 connector->num_h_tile, connector->num_v_tile,
4789 connector->tile_h_loc, connector->tile_v_loc,
4790 connector->tile_h_size, connector->tile_v_size);
4792 ret = drm_property_replace_global_blob(dev,
4793 &connector->tile_blob_ptr,
4797 dev->mode_config.tile_property);
4800 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4803 * drm_mode_connector_update_edid_property - update the edid property of a connector
4804 * @connector: drm connector
4805 * @edid: new value of the edid property
4807 * This function creates a new blob modeset object and assigns its id to the
4808 * connector's edid property.
4811 * Zero on success, negative errno on failure.
4813 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4814 const struct edid *edid)
4816 struct drm_device *dev = connector->dev;
4820 /* ignore requests to set edid when overridden */
4821 if (connector->override_edid)
4825 size = EDID_LENGTH * (1 + edid->extensions);
4827 ret = drm_property_replace_global_blob(dev,
4828 &connector->edid_blob_ptr,
4832 dev->mode_config.edid_property);
4835 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4837 /* Some properties could refer to dynamic refcnt'd objects, or things that
4838 * need special locking to handle lifetime issues (ie. to ensure the prop
4839 * value doesn't become invalid part way through the property update due to
4840 * race). The value returned by reference via 'obj' should be passed back
4841 * to drm_property_change_valid_put() after the property is set (and the
4842 * object to which the property is attached has a chance to take it's own
4845 bool drm_property_change_valid_get(struct drm_property *property,
4846 uint64_t value, struct drm_mode_object **ref)
4850 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4855 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4856 if (value < property->values[0] || value > property->values[1])
4859 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4860 int64_t svalue = U642I64(value);
4862 if (svalue < U642I64(property->values[0]) ||
4863 svalue > U642I64(property->values[1]))
4866 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4867 uint64_t valid_mask = 0;
4869 for (i = 0; i < property->num_values; i++)
4870 valid_mask |= (1ULL << property->values[i]);
4871 return !(value & ~valid_mask);
4872 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4873 struct drm_property_blob *blob;
4878 blob = drm_property_lookup_blob(property->dev, value);
4885 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4886 /* a zero value for an object property translates to null: */
4890 /* handle refcnt'd objects specially: */
4891 if (property->values[0] == DRM_MODE_OBJECT_FB) {
4892 struct drm_framebuffer *fb;
4893 fb = drm_framebuffer_lookup(property->dev, value);
4901 return _object_find(property->dev, value, property->values[0]) != NULL;
4905 for (i = 0; i < property->num_values; i++)
4906 if (property->values[i] == value)
4911 void drm_property_change_valid_put(struct drm_property *property,
4912 struct drm_mode_object *ref)
4917 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4918 if (property->values[0] == DRM_MODE_OBJECT_FB)
4919 drm_framebuffer_unreference(obj_to_fb(ref));
4920 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4921 drm_property_unreference_blob(obj_to_blob(ref));
4925 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4928 * @file_priv: DRM file info
4930 * This function sets the current value for a connectors's property. It also
4931 * calls into a driver's ->set_property callback to update the hardware state
4933 * Called by the user via ioctl.
4936 * Zero on success, negative errno on failure.
4938 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4939 void *data, struct drm_file *file_priv)
4941 struct drm_mode_connector_set_property *conn_set_prop = data;
4942 struct drm_mode_obj_set_property obj_set_prop = {
4943 .value = conn_set_prop->value,
4944 .prop_id = conn_set_prop->prop_id,
4945 .obj_id = conn_set_prop->connector_id,
4946 .obj_type = DRM_MODE_OBJECT_CONNECTOR
4949 /* It does all the locking and checking we need */
4950 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4953 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4954 struct drm_property *property,
4958 struct drm_connector *connector = obj_to_connector(obj);
4960 /* Do DPMS ourselves */
4961 if (property == connector->dev->mode_config.dpms_property) {
4963 if (connector->funcs->dpms)
4964 ret = (*connector->funcs->dpms)(connector, (int)value);
4965 } else if (connector->funcs->set_property)
4966 ret = connector->funcs->set_property(connector, property, value);
4968 /* store the property value if successful */
4970 drm_object_property_set_value(&connector->base, property, value);
4974 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4975 struct drm_property *property,
4979 struct drm_crtc *crtc = obj_to_crtc(obj);
4981 if (crtc->funcs->set_property)
4982 ret = crtc->funcs->set_property(crtc, property, value);
4984 drm_object_property_set_value(obj, property, value);
4990 * drm_mode_plane_set_obj_prop - set the value of a property
4991 * @plane: drm plane object to set property value for
4992 * @property: property to set
4993 * @value: value the property should be set to
4995 * This functions sets a given property on a given plane object. This function
4996 * calls the driver's ->set_property callback and changes the software state of
4997 * the property if the callback succeeds.
5000 * Zero on success, error code on failure.
5002 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
5003 struct drm_property *property,
5007 struct drm_mode_object *obj = &plane->base;
5009 if (plane->funcs->set_property)
5010 ret = plane->funcs->set_property(plane, property, value);
5012 drm_object_property_set_value(obj, property, value);
5016 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
5019 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
5022 * @file_priv: DRM file info
5024 * This function retrieves the current value for an object's property. Compared
5025 * to the connector specific ioctl this one is extended to also work on crtc and
5028 * Called by the user via ioctl.
5031 * Zero on success, negative errno on failure.
5033 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
5034 struct drm_file *file_priv)
5036 struct drm_mode_obj_get_properties *arg = data;
5037 struct drm_mode_object *obj;
5040 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5043 drm_modeset_lock_all(dev);
5045 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5050 if (!obj->properties) {
5055 ret = get_properties(obj, file_priv->atomic,
5056 (uint32_t __user *)(unsigned long)(arg->props_ptr),
5057 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
5061 drm_modeset_unlock_all(dev);
5066 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
5069 * @file_priv: DRM file info
5071 * This function sets the current value for an object's property. It also calls
5072 * into a driver's ->set_property callback to update the hardware state.
5073 * Compared to the connector specific ioctl this one is extended to also work on
5074 * crtc and plane objects.
5076 * Called by the user via ioctl.
5079 * Zero on success, negative errno on failure.
5081 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
5082 struct drm_file *file_priv)
5084 struct drm_mode_obj_set_property *arg = data;
5085 struct drm_mode_object *arg_obj;
5086 struct drm_mode_object *prop_obj;
5087 struct drm_property *property;
5088 int i, ret = -EINVAL;
5089 struct drm_mode_object *ref;
5091 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5094 drm_modeset_lock_all(dev);
5096 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5101 if (!arg_obj->properties)
5104 for (i = 0; i < arg_obj->properties->count; i++)
5105 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
5108 if (i == arg_obj->properties->count)
5111 prop_obj = drm_mode_object_find(dev, arg->prop_id,
5112 DRM_MODE_OBJECT_PROPERTY);
5117 property = obj_to_property(prop_obj);
5119 if (!drm_property_change_valid_get(property, arg->value, &ref))
5122 switch (arg_obj->type) {
5123 case DRM_MODE_OBJECT_CONNECTOR:
5124 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
5127 case DRM_MODE_OBJECT_CRTC:
5128 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
5130 case DRM_MODE_OBJECT_PLANE:
5131 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
5132 property, arg->value);
5136 drm_property_change_valid_put(property, ref);
5139 drm_modeset_unlock_all(dev);
5144 * drm_mode_connector_attach_encoder - attach a connector to an encoder
5145 * @connector: connector to attach
5146 * @encoder: encoder to attach @connector to
5148 * This function links up a connector to an encoder. Note that the routing
5149 * restrictions between encoders and crtcs are exposed to userspace through the
5150 * possible_clones and possible_crtcs bitmasks.
5153 * Zero on success, negative errno on failure.
5155 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
5156 struct drm_encoder *encoder)
5161 * In the past, drivers have attempted to model the static association
5162 * of connector to encoder in simple connector/encoder devices using a
5163 * direct assignment of connector->encoder = encoder. This connection
5164 * is a logical one and the responsibility of the core, so drivers are
5165 * expected not to mess with this.
5167 * Note that the error return should've been enough here, but a large
5168 * majority of drivers ignores the return value, so add in a big WARN
5169 * to get people's attention.
5171 if (WARN_ON(connector->encoder))
5174 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
5175 if (connector->encoder_ids[i] == 0) {
5176 connector->encoder_ids[i] = encoder->base.id;
5182 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
5185 * drm_mode_crtc_set_gamma_size - set the gamma table size
5186 * @crtc: CRTC to set the gamma table size for
5187 * @gamma_size: size of the gamma table
5189 * Drivers which support gamma tables should set this to the supported gamma
5190 * table size when initializing the CRTC. Currently the drm core only supports a
5191 * fixed gamma table size.
5194 * Zero on success, negative errno on failure.
5196 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
5199 crtc->gamma_size = gamma_size;
5201 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
5203 if (!crtc->gamma_store) {
5204 crtc->gamma_size = 0;
5210 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
5213 * drm_mode_gamma_set_ioctl - set the gamma table
5216 * @file_priv: DRM file info
5218 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
5219 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
5221 * Called by the user via ioctl.
5224 * Zero on success, negative errno on failure.
5226 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
5227 void *data, struct drm_file *file_priv)
5229 struct drm_mode_crtc_lut *crtc_lut = data;
5230 struct drm_crtc *crtc;
5231 void *r_base, *g_base, *b_base;
5235 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5238 drm_modeset_lock_all(dev);
5239 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5245 if (crtc->funcs->gamma_set == NULL) {
5250 /* memcpy into gamma store */
5251 if (crtc_lut->gamma_size != crtc->gamma_size) {
5256 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5257 r_base = crtc->gamma_store;
5258 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
5263 g_base = r_base + size;
5264 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
5269 b_base = g_base + size;
5270 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
5275 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
5278 drm_modeset_unlock_all(dev);
5284 * drm_mode_gamma_get_ioctl - get the gamma table
5287 * @file_priv: DRM file info
5289 * Copy the current gamma table into the storage provided. This also provides
5290 * the gamma table size the driver expects, which can be used to size the
5291 * allocated storage.
5293 * Called by the user via ioctl.
5296 * Zero on success, negative errno on failure.
5298 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
5299 void *data, struct drm_file *file_priv)
5301 struct drm_mode_crtc_lut *crtc_lut = data;
5302 struct drm_crtc *crtc;
5303 void *r_base, *g_base, *b_base;
5307 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5310 drm_modeset_lock_all(dev);
5311 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5317 /* memcpy into gamma store */
5318 if (crtc_lut->gamma_size != crtc->gamma_size) {
5323 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5324 r_base = crtc->gamma_store;
5325 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
5330 g_base = r_base + size;
5331 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
5336 b_base = g_base + size;
5337 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
5342 drm_modeset_unlock_all(dev);
5347 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
5350 * @file_priv: DRM file info
5352 * This schedules an asynchronous update on a given CRTC, called page flip.
5353 * Optionally a drm event is generated to signal the completion of the event.
5354 * Generic drivers cannot assume that a pageflip with changed framebuffer
5355 * properties (including driver specific metadata like tiling layout) will work,
5356 * but some drivers support e.g. pixel format changes through the pageflip
5359 * Called by the user via ioctl.
5362 * Zero on success, negative errno on failure.
5364 int drm_mode_page_flip_ioctl(struct drm_device *dev,
5365 void *data, struct drm_file *file_priv)
5367 struct drm_mode_crtc_page_flip *page_flip = data;
5368 struct drm_crtc *crtc;
5369 struct drm_framebuffer *fb = NULL;
5370 struct drm_pending_vblank_event *e = NULL;
5371 unsigned long flags;
5374 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5377 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
5378 page_flip->reserved != 0)
5381 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
5384 crtc = drm_crtc_find(dev, page_flip->crtc_id);
5388 drm_modeset_lock_crtc(crtc, crtc->primary);
5389 if (crtc->primary->fb == NULL) {
5390 /* The framebuffer is currently unbound, presumably
5391 * due to a hotplug event, that userspace has not
5398 if (crtc->funcs->page_flip == NULL)
5401 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
5408 const struct drm_plane_state *state = crtc->primary->state;
5410 ret = check_src_coords(state->src_x, state->src_y,
5411 state->src_w, state->src_h, fb);
5413 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
5418 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
5419 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
5424 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5426 spin_lock_irqsave(&dev->event_lock, flags);
5427 if (file_priv->event_space < sizeof(e->event)) {
5428 spin_unlock_irqrestore(&dev->event_lock, flags);
5431 file_priv->event_space -= sizeof(e->event);
5432 spin_unlock_irqrestore(&dev->event_lock, flags);
5434 e = kzalloc(sizeof(*e), GFP_KERNEL);
5436 spin_lock_irqsave(&dev->event_lock, flags);
5437 file_priv->event_space += sizeof(e->event);
5438 spin_unlock_irqrestore(&dev->event_lock, flags);
5442 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
5443 e->event.base.length = sizeof(e->event);
5444 e->event.user_data = page_flip->user_data;
5445 e->base.event = &e->event.base;
5446 e->base.file_priv = file_priv;
5448 (void (*) (struct drm_pending_event *)) kfree;
5451 crtc->primary->old_fb = crtc->primary->fb;
5452 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
5454 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5455 spin_lock_irqsave(&dev->event_lock, flags);
5456 file_priv->event_space += sizeof(e->event);
5457 spin_unlock_irqrestore(&dev->event_lock, flags);
5460 /* Keep the old fb, don't unref it. */
5461 crtc->primary->old_fb = NULL;
5463 crtc->primary->fb = fb;
5464 /* Unref only the old framebuffer. */
5470 drm_framebuffer_unreference(fb);
5471 if (crtc->primary->old_fb)
5472 drm_framebuffer_unreference(crtc->primary->old_fb);
5473 crtc->primary->old_fb = NULL;
5474 drm_modeset_unlock_crtc(crtc);
5480 * drm_mode_config_reset - call ->reset callbacks
5483 * This functions calls all the crtc's, encoder's and connector's ->reset
5484 * callback. Drivers can use this in e.g. their driver load or resume code to
5485 * reset hardware and software state.
5487 void drm_mode_config_reset(struct drm_device *dev)
5489 struct drm_crtc *crtc;
5490 struct drm_plane *plane;
5491 struct drm_encoder *encoder;
5492 struct drm_connector *connector;
5494 drm_for_each_plane(plane, dev)
5495 if (plane->funcs->reset)
5496 plane->funcs->reset(plane);
5498 drm_for_each_crtc(crtc, dev)
5499 if (crtc->funcs->reset)
5500 crtc->funcs->reset(crtc);
5502 drm_for_each_encoder(encoder, dev)
5503 if (encoder->funcs->reset)
5504 encoder->funcs->reset(encoder);
5506 mutex_lock(&dev->mode_config.mutex);
5507 drm_for_each_connector(connector, dev)
5508 if (connector->funcs->reset)
5509 connector->funcs->reset(connector);
5510 mutex_unlock(&dev->mode_config.mutex);
5512 EXPORT_SYMBOL(drm_mode_config_reset);
5515 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
5518 * @file_priv: DRM file info
5520 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
5521 * TTM or something else entirely) and returns the resulting buffer handle. This
5522 * handle can then be wrapped up into a framebuffer modeset object.
5524 * Note that userspace is not allowed to use such objects for render
5525 * acceleration - drivers must create their own private ioctls for such a use
5528 * Called by the user via ioctl.
5531 * Zero on success, negative errno on failure.
5533 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
5534 void *data, struct drm_file *file_priv)
5536 struct drm_mode_create_dumb *args = data;
5537 u32 cpp, stride, size;
5539 if (!dev->driver->dumb_create)
5541 if (!args->width || !args->height || !args->bpp)
5544 /* overflow checks for 32bit size calculations */
5545 /* NOTE: DIV_ROUND_UP() can overflow */
5546 cpp = DIV_ROUND_UP(args->bpp, 8);
5547 if (!cpp || cpp > 0xffffffffU / args->width)
5549 stride = cpp * args->width;
5550 if (args->height > 0xffffffffU / stride)
5553 /* test for wrap-around */
5554 size = args->height * stride;
5555 if (PAGE_ALIGN(size) == 0)
5559 * handle, pitch and size are output parameters. Zero them out to
5560 * prevent drivers from accidentally using uninitialized data. Since
5561 * not all existing userspace is clearing these fields properly we
5562 * cannot reject IOCTL with garbage in them.
5568 return dev->driver->dumb_create(file_priv, dev, args);
5572 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5575 * @file_priv: DRM file info
5577 * Allocate an offset in the drm device node's address space to be able to
5578 * memory map a dumb buffer.
5580 * Called by the user via ioctl.
5583 * Zero on success, negative errno on failure.
5585 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5586 void *data, struct drm_file *file_priv)
5588 struct drm_mode_map_dumb *args = data;
5590 /* call driver ioctl to get mmap offset */
5591 if (!dev->driver->dumb_map_offset)
5594 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5598 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5601 * @file_priv: DRM file info
5603 * This destroys the userspace handle for the given dumb backing storage buffer.
5604 * Since buffer objects must be reference counted in the kernel a buffer object
5605 * won't be immediately freed if a framebuffer modeset object still uses it.
5607 * Called by the user via ioctl.
5610 * Zero on success, negative errno on failure.
5612 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5613 void *data, struct drm_file *file_priv)
5615 struct drm_mode_destroy_dumb *args = data;
5617 if (!dev->driver->dumb_destroy)
5620 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5624 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5625 * @format: pixel format (DRM_FORMAT_*)
5626 * @depth: storage for the depth value
5627 * @bpp: storage for the bpp value
5629 * This only supports RGB formats here for compat with code that doesn't use
5630 * pixel formats directly yet.
5632 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5637 case DRM_FORMAT_RGB332:
5638 case DRM_FORMAT_BGR233:
5642 case DRM_FORMAT_XRGB1555:
5643 case DRM_FORMAT_XBGR1555:
5644 case DRM_FORMAT_RGBX5551:
5645 case DRM_FORMAT_BGRX5551:
5646 case DRM_FORMAT_ARGB1555:
5647 case DRM_FORMAT_ABGR1555:
5648 case DRM_FORMAT_RGBA5551:
5649 case DRM_FORMAT_BGRA5551:
5653 case DRM_FORMAT_RGB565:
5654 case DRM_FORMAT_BGR565:
5658 case DRM_FORMAT_RGB888:
5659 case DRM_FORMAT_BGR888:
5663 case DRM_FORMAT_XRGB8888:
5664 case DRM_FORMAT_XBGR8888:
5665 case DRM_FORMAT_RGBX8888:
5666 case DRM_FORMAT_BGRX8888:
5670 case DRM_FORMAT_XRGB2101010:
5671 case DRM_FORMAT_XBGR2101010:
5672 case DRM_FORMAT_RGBX1010102:
5673 case DRM_FORMAT_BGRX1010102:
5674 case DRM_FORMAT_ARGB2101010:
5675 case DRM_FORMAT_ABGR2101010:
5676 case DRM_FORMAT_RGBA1010102:
5677 case DRM_FORMAT_BGRA1010102:
5681 case DRM_FORMAT_ARGB8888:
5682 case DRM_FORMAT_ABGR8888:
5683 case DRM_FORMAT_RGBA8888:
5684 case DRM_FORMAT_BGRA8888:
5689 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5690 drm_get_format_name(format));
5696 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5699 * drm_format_num_planes - get the number of planes for format
5700 * @format: pixel format (DRM_FORMAT_*)
5703 * The number of planes used by the specified pixel format.
5705 int drm_format_num_planes(uint32_t format)
5708 case DRM_FORMAT_YUV410:
5709 case DRM_FORMAT_YVU410:
5710 case DRM_FORMAT_YUV411:
5711 case DRM_FORMAT_YVU411:
5712 case DRM_FORMAT_YUV420:
5713 case DRM_FORMAT_YVU420:
5714 case DRM_FORMAT_YUV422:
5715 case DRM_FORMAT_YVU422:
5716 case DRM_FORMAT_YUV444:
5717 case DRM_FORMAT_YVU444:
5719 case DRM_FORMAT_NV12:
5720 case DRM_FORMAT_NV21:
5721 case DRM_FORMAT_NV16:
5722 case DRM_FORMAT_NV61:
5723 case DRM_FORMAT_NV24:
5724 case DRM_FORMAT_NV42:
5725 case DRM_FORMAT_NV12_10:
5726 case DRM_FORMAT_NV21_10:
5727 case DRM_FORMAT_NV16_10:
5728 case DRM_FORMAT_NV61_10:
5729 case DRM_FORMAT_NV24_10:
5730 case DRM_FORMAT_NV42_10:
5736 EXPORT_SYMBOL(drm_format_num_planes);
5739 * drm_format_plane_bpp - get the bpp for format
5740 * @format: pixel format (DRM_FORMAT_*)
5741 * @plane: plane index
5744 * The bpp for the specified plane.
5746 int drm_format_plane_bpp(uint32_t format, int plane)
5751 if (plane >= drm_format_num_planes(format))
5755 case DRM_FORMAT_YUYV:
5756 case DRM_FORMAT_YVYU:
5757 case DRM_FORMAT_UYVY:
5758 case DRM_FORMAT_VYUY:
5760 case DRM_FORMAT_NV12_10:
5761 case DRM_FORMAT_NV21_10:
5762 case DRM_FORMAT_NV16_10:
5763 case DRM_FORMAT_NV61_10:
5764 case DRM_FORMAT_NV24_10:
5765 case DRM_FORMAT_NV42_10:
5766 return plane ? 20 : 10;
5767 case DRM_FORMAT_NV12:
5768 case DRM_FORMAT_NV21:
5769 case DRM_FORMAT_NV16:
5770 case DRM_FORMAT_NV61:
5771 case DRM_FORMAT_NV24:
5772 case DRM_FORMAT_NV42:
5773 return plane ? 16 : 8;
5774 case DRM_FORMAT_YUV410:
5775 case DRM_FORMAT_YVU410:
5776 case DRM_FORMAT_YUV411:
5777 case DRM_FORMAT_YVU411:
5778 case DRM_FORMAT_YUV420:
5779 case DRM_FORMAT_YVU420:
5780 case DRM_FORMAT_YUV422:
5781 case DRM_FORMAT_YVU422:
5782 case DRM_FORMAT_YUV444:
5783 case DRM_FORMAT_YVU444:
5786 drm_fb_get_bpp_depth(format, &depth, &bpp);
5790 EXPORT_SYMBOL(drm_format_plane_bpp);
5793 * drm_format_plane_cpp - determine the bytes per pixel value
5794 * @format: pixel format (DRM_FORMAT_*)
5795 * @plane: plane index
5798 * The bytes per pixel value for the specified plane.
5800 int drm_format_plane_cpp(uint32_t format, int plane)
5802 return drm_format_plane_bpp(format, plane) >> 3;
5804 EXPORT_SYMBOL(drm_format_plane_cpp);
5807 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5808 * @format: pixel format (DRM_FORMAT_*)
5811 * The horizontal chroma subsampling factor for the
5812 * specified pixel format.
5814 int drm_format_horz_chroma_subsampling(uint32_t format)
5817 case DRM_FORMAT_YUV411:
5818 case DRM_FORMAT_YVU411:
5819 case DRM_FORMAT_YUV410:
5820 case DRM_FORMAT_YVU410:
5822 case DRM_FORMAT_YUYV:
5823 case DRM_FORMAT_YVYU:
5824 case DRM_FORMAT_UYVY:
5825 case DRM_FORMAT_VYUY:
5826 case DRM_FORMAT_NV12:
5827 case DRM_FORMAT_NV21:
5828 case DRM_FORMAT_NV16:
5829 case DRM_FORMAT_NV61:
5830 case DRM_FORMAT_NV12_10:
5831 case DRM_FORMAT_NV21_10:
5832 case DRM_FORMAT_NV16_10:
5833 case DRM_FORMAT_NV61_10:
5834 case DRM_FORMAT_YUV422:
5835 case DRM_FORMAT_YVU422:
5836 case DRM_FORMAT_YUV420:
5837 case DRM_FORMAT_YVU420:
5843 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5846 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5847 * @format: pixel format (DRM_FORMAT_*)
5850 * The vertical chroma subsampling factor for the
5851 * specified pixel format.
5853 int drm_format_vert_chroma_subsampling(uint32_t format)
5856 case DRM_FORMAT_YUV410:
5857 case DRM_FORMAT_YVU410:
5859 case DRM_FORMAT_YUV420:
5860 case DRM_FORMAT_YVU420:
5861 case DRM_FORMAT_NV12:
5862 case DRM_FORMAT_NV12_10:
5863 case DRM_FORMAT_NV21:
5864 case DRM_FORMAT_NV21_10:
5870 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5873 * drm_rotation_simplify() - Try to simplify the rotation
5874 * @rotation: Rotation to be simplified
5875 * @supported_rotations: Supported rotations
5877 * Attempt to simplify the rotation to a form that is supported.
5878 * Eg. if the hardware supports everything except DRM_REFLECT_X
5879 * one could call this function like this:
5881 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5882 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5883 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5885 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5886 * transforms the hardware supports, this function may not
5887 * be able to produce a supported transform, so the caller should
5888 * check the result afterwards.
5890 unsigned int drm_rotation_simplify(unsigned int rotation,
5891 unsigned int supported_rotations)
5893 if (rotation & ~supported_rotations) {
5894 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5895 rotation = (rotation & DRM_REFLECT_MASK) |
5896 BIT((ffs(rotation & DRM_ROTATE_MASK) + 1) % 4);
5901 EXPORT_SYMBOL(drm_rotation_simplify);
5904 * drm_mode_config_init - initialize DRM mode_configuration structure
5907 * Initialize @dev's mode_config structure, used for tracking the graphics
5908 * configuration of @dev.
5910 * Since this initializes the modeset locks, no locking is possible. Which is no
5911 * problem, since this should happen single threaded at init time. It is the
5912 * driver's problem to ensure this guarantee.
5915 void drm_mode_config_init(struct drm_device *dev)
5917 mutex_init(&dev->mode_config.mutex);
5918 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5919 mutex_init(&dev->mode_config.idr_mutex);
5920 mutex_init(&dev->mode_config.fb_lock);
5921 mutex_init(&dev->mode_config.blob_lock);
5922 INIT_LIST_HEAD(&dev->mode_config.fb_list);
5923 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5924 INIT_LIST_HEAD(&dev->mode_config.connector_list);
5925 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5926 INIT_LIST_HEAD(&dev->mode_config.property_list);
5927 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5928 INIT_LIST_HEAD(&dev->mode_config.plane_list);
5929 idr_init(&dev->mode_config.crtc_idr);
5930 idr_init(&dev->mode_config.tile_idr);
5932 drm_modeset_lock_all(dev);
5933 drm_mode_create_standard_properties(dev);
5934 drm_modeset_unlock_all(dev);
5936 /* Just to be sure */
5937 dev->mode_config.num_fb = 0;
5938 dev->mode_config.num_connector = 0;
5939 dev->mode_config.num_crtc = 0;
5940 dev->mode_config.num_encoder = 0;
5941 dev->mode_config.num_overlay_plane = 0;
5942 dev->mode_config.num_total_plane = 0;
5944 EXPORT_SYMBOL(drm_mode_config_init);
5947 * drm_mode_config_cleanup - free up DRM mode_config info
5950 * Free up all the connectors and CRTCs associated with this DRM device, then
5951 * free up the framebuffers and associated buffer objects.
5953 * Note that since this /should/ happen single-threaded at driver/device
5954 * teardown time, no locking is required. It's the driver's job to ensure that
5955 * this guarantee actually holds true.
5957 * FIXME: cleanup any dangling user buffer objects too
5959 void drm_mode_config_cleanup(struct drm_device *dev)
5961 struct drm_connector *connector, *ot;
5962 struct drm_crtc *crtc, *ct;
5963 struct drm_encoder *encoder, *enct;
5964 struct drm_framebuffer *fb, *fbt;
5965 struct drm_property *property, *pt;
5966 struct drm_property_blob *blob, *bt;
5967 struct drm_plane *plane, *plt;
5969 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5971 encoder->funcs->destroy(encoder);
5974 list_for_each_entry_safe(connector, ot,
5975 &dev->mode_config.connector_list, head) {
5976 connector->funcs->destroy(connector);
5979 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5981 drm_property_destroy(dev, property);
5984 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
5986 drm_property_unreference_blob(blob);
5990 * Single-threaded teardown context, so it's not required to grab the
5991 * fb_lock to protect against concurrent fb_list access. Contrary, it
5992 * would actually deadlock with the drm_framebuffer_cleanup function.
5994 * Also, if there are any framebuffers left, that's a driver leak now,
5995 * so politely WARN about this.
5997 WARN_ON(!list_empty(&dev->mode_config.fb_list));
5998 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
5999 drm_framebuffer_free(&fb->refcount);
6002 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
6004 plane->funcs->destroy(plane);
6007 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
6008 crtc->funcs->destroy(crtc);
6011 idr_destroy(&dev->mode_config.tile_idr);
6012 idr_destroy(&dev->mode_config.crtc_idr);
6013 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
6015 EXPORT_SYMBOL(drm_mode_config_cleanup);
6017 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
6018 unsigned int supported_rotations)
6020 static const struct drm_prop_enum_list props[] = {
6021 { DRM_ROTATE_0, "rotate-0" },
6022 { DRM_ROTATE_90, "rotate-90" },
6023 { DRM_ROTATE_180, "rotate-180" },
6024 { DRM_ROTATE_270, "rotate-270" },
6025 { DRM_REFLECT_X, "reflect-x" },
6026 { DRM_REFLECT_Y, "reflect-y" },
6029 return drm_property_create_bitmask(dev, 0, "rotation",
6030 props, ARRAY_SIZE(props),
6031 supported_rotations);
6033 EXPORT_SYMBOL(drm_mode_create_rotation_property);
6038 * Tile groups are used to represent tiled monitors with a unique
6039 * integer identifier. Tiled monitors using DisplayID v1.3 have
6040 * a unique 8-byte handle, we store this in a tile group, so we
6041 * have a common identifier for all tiles in a monitor group.
6043 static void drm_tile_group_free(struct kref *kref)
6045 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
6046 struct drm_device *dev = tg->dev;
6047 mutex_lock(&dev->mode_config.idr_mutex);
6048 idr_remove(&dev->mode_config.tile_idr, tg->id);
6049 mutex_unlock(&dev->mode_config.idr_mutex);
6054 * drm_mode_put_tile_group - drop a reference to a tile group.
6056 * @tg: tile group to drop reference to.
6058 * drop reference to tile group and free if 0.
6060 void drm_mode_put_tile_group(struct drm_device *dev,
6061 struct drm_tile_group *tg)
6063 kref_put(&tg->refcount, drm_tile_group_free);
6067 * drm_mode_get_tile_group - get a reference to an existing tile group
6069 * @topology: 8-bytes unique per monitor.
6071 * Use the unique bytes to get a reference to an existing tile group.
6074 * tile group or NULL if not found.
6076 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
6079 struct drm_tile_group *tg;
6081 mutex_lock(&dev->mode_config.idr_mutex);
6082 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
6083 if (!memcmp(tg->group_data, topology, 8)) {
6084 if (!kref_get_unless_zero(&tg->refcount))
6086 mutex_unlock(&dev->mode_config.idr_mutex);
6090 mutex_unlock(&dev->mode_config.idr_mutex);
6093 EXPORT_SYMBOL(drm_mode_get_tile_group);
6096 * drm_mode_create_tile_group - create a tile group from a displayid description
6098 * @topology: 8-bytes unique per monitor.
6100 * Create a tile group for the unique monitor, and get a unique
6101 * identifier for the tile group.
6104 * new tile group or error.
6106 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
6109 struct drm_tile_group *tg;
6112 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
6114 return ERR_PTR(-ENOMEM);
6116 kref_init(&tg->refcount);
6117 memcpy(tg->group_data, topology, 8);
6120 mutex_lock(&dev->mode_config.idr_mutex);
6121 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
6129 mutex_unlock(&dev->mode_config.idr_mutex);
6132 EXPORT_SYMBOL(drm_mode_create_tile_group);