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);
1036 if (connector->funcs->late_register) {
1037 ret = connector->funcs->late_register(connector);
1045 drm_debugfs_connector_remove(connector);
1047 drm_sysfs_connector_remove(connector);
1050 EXPORT_SYMBOL(drm_connector_register);
1053 * drm_connector_unregister - unregister a connector
1054 * @connector: the connector to unregister
1056 * Unregister userspace interfaces for a connector
1058 void drm_connector_unregister(struct drm_connector *connector)
1060 if (connector->funcs->early_unregister)
1061 connector->funcs->early_unregister(connector);
1063 drm_sysfs_connector_remove(connector);
1064 drm_debugfs_connector_remove(connector);
1066 EXPORT_SYMBOL(drm_connector_unregister);
1069 * drm_connector_unregister_all - unregister connector userspace interfaces
1072 * This functions unregisters all connectors from sysfs and other places so
1073 * that userspace can no longer access them. Drivers should call this as the
1074 * first step tearing down the device instace, or when the underlying
1075 * physical device disappeared (e.g. USB unplug), right before calling
1076 * drm_dev_unregister().
1078 void drm_connector_unregister_all(struct drm_device *dev)
1080 struct drm_connector *connector;
1082 /* FIXME: taking the mode config mutex ends up in a clash with sysfs */
1083 drm_for_each_connector(connector, dev)
1084 drm_connector_unregister(connector);
1086 EXPORT_SYMBOL(drm_connector_unregister_all);
1089 * drm_encoder_init - Init a preallocated encoder
1091 * @encoder: the encoder to init
1092 * @funcs: callbacks for this encoder
1093 * @encoder_type: user visible type of the encoder
1094 * @name: printf style format string for the encoder name, or NULL for default name
1096 * Initialises a preallocated encoder. Encoder should be
1097 * subclassed as part of driver encoder objects.
1100 * Zero on success, error code on failure.
1102 int drm_encoder_init(struct drm_device *dev,
1103 struct drm_encoder *encoder,
1104 const struct drm_encoder_funcs *funcs,
1105 int encoder_type, const char *name, ...)
1109 drm_modeset_lock_all(dev);
1111 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1116 encoder->encoder_type = encoder_type;
1117 encoder->funcs = funcs;
1118 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1119 drm_encoder_enum_list[encoder_type].name,
1121 if (!encoder->name) {
1126 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1127 dev->mode_config.num_encoder++;
1131 drm_mode_object_put(dev, &encoder->base);
1134 drm_modeset_unlock_all(dev);
1138 EXPORT_SYMBOL(drm_encoder_init);
1141 * drm_encoder_cleanup - cleans up an initialised encoder
1142 * @encoder: encoder to cleanup
1144 * Cleans up the encoder but doesn't free the object.
1146 void drm_encoder_cleanup(struct drm_encoder *encoder)
1148 struct drm_device *dev = encoder->dev;
1150 drm_modeset_lock_all(dev);
1151 drm_mode_object_put(dev, &encoder->base);
1152 kfree(encoder->name);
1153 list_del(&encoder->head);
1154 dev->mode_config.num_encoder--;
1155 drm_modeset_unlock_all(dev);
1157 memset(encoder, 0, sizeof(*encoder));
1159 EXPORT_SYMBOL(drm_encoder_cleanup);
1162 * drm_universal_plane_init - Initialize a new universal plane object
1164 * @plane: plane object to init
1165 * @possible_crtcs: bitmask of possible CRTCs
1166 * @funcs: callbacks for the new plane
1167 * @formats: array of supported formats (%DRM_FORMAT_*)
1168 * @format_count: number of elements in @formats
1169 * @type: type of plane (overlay, primary, cursor)
1170 * @name: printf style format string for the plane name, or NULL for default name
1172 * Initializes a plane object of type @type.
1175 * Zero on success, error code on failure.
1177 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1178 unsigned long possible_crtcs,
1179 const struct drm_plane_funcs *funcs,
1180 const uint32_t *formats, unsigned int format_count,
1181 enum drm_plane_type type,
1182 const char *name, ...)
1184 struct drm_mode_config *config = &dev->mode_config;
1187 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1191 drm_modeset_lock_init(&plane->mutex);
1193 plane->base.properties = &plane->properties;
1195 plane->funcs = funcs;
1196 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1198 if (!plane->format_types) {
1199 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1200 drm_mode_object_put(dev, &plane->base);
1204 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1205 plane->format_count = format_count;
1206 plane->possible_crtcs = possible_crtcs;
1209 list_add_tail(&plane->head, &config->plane_list);
1210 config->num_total_plane++;
1211 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1212 config->num_overlay_plane++;
1214 drm_object_attach_property(&plane->base,
1215 config->plane_type_property,
1218 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1219 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1220 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1221 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1222 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1223 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1224 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1225 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1226 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1227 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1228 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1233 EXPORT_SYMBOL(drm_universal_plane_init);
1236 * drm_plane_init - Initialize a legacy plane
1238 * @plane: plane object to init
1239 * @possible_crtcs: bitmask of possible CRTCs
1240 * @funcs: callbacks for the new plane
1241 * @formats: array of supported formats (%DRM_FORMAT_*)
1242 * @format_count: number of elements in @formats
1243 * @is_primary: plane type (primary vs overlay)
1245 * Legacy API to initialize a DRM plane.
1247 * New drivers should call drm_universal_plane_init() instead.
1250 * Zero on success, error code on failure.
1252 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1253 unsigned long possible_crtcs,
1254 const struct drm_plane_funcs *funcs,
1255 const uint32_t *formats, unsigned int format_count,
1258 enum drm_plane_type type;
1260 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1261 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1262 formats, format_count, type, NULL);
1264 EXPORT_SYMBOL(drm_plane_init);
1267 * drm_share_plane_init - Initialize a share plane
1269 * @plane: plane object to init
1270 * @parent: this plane share some resources with parent plane.
1271 * @possible_crtcs: bitmask of possible CRTCs
1272 * @funcs: callbacks for the new plane
1273 * @formats: array of supported formats (%DRM_FORMAT_*)
1274 * @format_count: number of elements in @formats
1275 * @type: type of plane (overlay, primary, cursor)
1277 * With this API, the plane can share hardware resources with other planes.
1279 * --------------------------------------------------
1281 * | ------------------ |
1282 * | | parent plane | |
1283 * | | active scanout | |
1284 * | | | ----------------- |
1285 * | ------------------ | share plane 1 | |
1286 * | ----------------- |active scanout | |
1287 * | | share plane 0 | | | |
1288 * | |active scanout | ----------------- |
1290 * | ----------------- |
1291 * --------------------------------------------------
1298 * The plane hardware is used when the display scanout run into plane active
1299 * scanout, that means we can reuse the plane hardware resources on plane
1300 * non-active scanout.
1302 * Because resource share, There are some limit on share plane: one group
1303 * of share planes need use same zpos, can't not overlap, etc.
1305 * Here assume share plane is a universal plane with some limit flags.
1306 * people who use the share plane need know the limit, should call the ioctl
1307 * DRM_CLIENT_CAP_SHARE_PLANES, and judge the planes limit before use it.
1310 * Zero on success, error code on failure.
1313 int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1314 struct drm_plane *parent,
1315 unsigned long possible_crtcs,
1316 const struct drm_plane_funcs *funcs,
1317 const uint32_t *formats, unsigned int format_count,
1318 enum drm_plane_type type)
1320 struct drm_mode_config *config = &dev->mode_config;
1325 * TODO: only verified on ATOMIC drm driver.
1327 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1330 ret = drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1331 formats, format_count, type, NULL);
1337 * Can't support more than two level plane share.
1339 WARN_ON(parent->parent);
1340 share_id = parent->base.id;
1341 plane->parent = parent;
1343 config->num_share_plane++;
1344 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1345 config->num_share_overlay_plane++;
1347 share_id = plane->base.id;
1350 drm_object_attach_property(&plane->base,
1351 config->prop_share_id, share_id);
1354 EXPORT_SYMBOL(drm_share_plane_init);
1357 * drm_plane_cleanup - Clean up the core plane usage
1358 * @plane: plane to cleanup
1360 * This function cleans up @plane and removes it from the DRM mode setting
1361 * core. Note that the function does *not* free the plane structure itself,
1362 * this is the responsibility of the caller.
1364 void drm_plane_cleanup(struct drm_plane *plane)
1366 struct drm_device *dev = plane->dev;
1368 drm_modeset_lock_all(dev);
1369 kfree(plane->format_types);
1370 drm_mode_object_put(dev, &plane->base);
1372 BUG_ON(list_empty(&plane->head));
1374 list_del(&plane->head);
1375 dev->mode_config.num_total_plane--;
1376 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1377 dev->mode_config.num_overlay_plane--;
1378 if (plane->parent) {
1379 dev->mode_config.num_share_plane--;
1380 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1381 dev->mode_config.num_share_overlay_plane--;
1383 drm_modeset_unlock_all(dev);
1385 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1386 if (plane->state && plane->funcs->atomic_destroy_state)
1387 plane->funcs->atomic_destroy_state(plane, plane->state);
1389 memset(plane, 0, sizeof(*plane));
1391 EXPORT_SYMBOL(drm_plane_cleanup);
1394 * drm_plane_index - find the index of a registered plane
1395 * @plane: plane to find index for
1397 * Given a registered plane, return the index of that CRTC within a DRM
1398 * device's list of planes.
1400 unsigned int drm_plane_index(struct drm_plane *plane)
1402 unsigned int index = 0;
1403 struct drm_plane *tmp;
1405 drm_for_each_plane(tmp, plane->dev) {
1414 EXPORT_SYMBOL(drm_plane_index);
1417 * drm_plane_from_index - find the registered plane at an index
1419 * @idx: index of registered plane to find for
1421 * Given a plane index, return the registered plane from DRM device's
1422 * list of planes with matching index.
1425 drm_plane_from_index(struct drm_device *dev, int idx)
1427 struct drm_plane *plane;
1430 drm_for_each_plane(plane, dev) {
1437 EXPORT_SYMBOL(drm_plane_from_index);
1440 * drm_plane_force_disable - Forcibly disable a plane
1441 * @plane: plane to disable
1443 * Forces the plane to be disabled.
1445 * Used when the plane's current framebuffer is destroyed,
1446 * and when restoring fbdev mode.
1448 void drm_plane_force_disable(struct drm_plane *plane)
1455 plane->old_fb = plane->fb;
1456 ret = plane->funcs->disable_plane(plane);
1458 DRM_ERROR("failed to disable plane with busy fb\n");
1459 plane->old_fb = NULL;
1462 /* disconnect the plane from the fb and crtc: */
1463 drm_framebuffer_unreference(plane->old_fb);
1464 plane->old_fb = NULL;
1468 EXPORT_SYMBOL(drm_plane_force_disable);
1470 static int drm_mode_create_standard_properties(struct drm_device *dev)
1472 struct drm_property *prop;
1475 * Standard properties (apply to all connectors)
1477 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1478 DRM_MODE_PROP_IMMUTABLE,
1482 dev->mode_config.edid_property = prop;
1484 prop = drm_property_create_enum(dev, 0,
1485 "DPMS", drm_dpms_enum_list,
1486 ARRAY_SIZE(drm_dpms_enum_list));
1489 dev->mode_config.dpms_property = prop;
1491 prop = drm_property_create(dev,
1492 DRM_MODE_PROP_BLOB |
1493 DRM_MODE_PROP_IMMUTABLE,
1497 dev->mode_config.path_property = prop;
1499 prop = drm_property_create(dev,
1500 DRM_MODE_PROP_BLOB |
1501 DRM_MODE_PROP_IMMUTABLE,
1505 dev->mode_config.tile_property = prop;
1507 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1508 "type", drm_plane_type_enum_list,
1509 ARRAY_SIZE(drm_plane_type_enum_list));
1512 dev->mode_config.plane_type_property = prop;
1514 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1515 "SHARE_ID", 0, UINT_MAX);
1519 dev->mode_config.prop_share_id = prop;
1520 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1521 "SHARE_FLAGS", 0, UINT_MAX);
1524 dev->mode_config.prop_share_flags = prop;
1526 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1527 "SRC_X", 0, UINT_MAX);
1530 dev->mode_config.prop_src_x = prop;
1532 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1533 "SRC_Y", 0, UINT_MAX);
1536 dev->mode_config.prop_src_y = prop;
1538 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1539 "SRC_W", 0, UINT_MAX);
1542 dev->mode_config.prop_src_w = prop;
1544 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1545 "SRC_H", 0, UINT_MAX);
1548 dev->mode_config.prop_src_h = prop;
1550 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1551 "CRTC_X", INT_MIN, INT_MAX);
1554 dev->mode_config.prop_crtc_x = prop;
1556 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1557 "CRTC_Y", INT_MIN, INT_MAX);
1560 dev->mode_config.prop_crtc_y = prop;
1562 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1563 "CRTC_W", 0, INT_MAX);
1566 dev->mode_config.prop_crtc_w = prop;
1568 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1569 "CRTC_H", 0, INT_MAX);
1572 dev->mode_config.prop_crtc_h = prop;
1574 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1575 "FB_ID", DRM_MODE_OBJECT_FB);
1578 dev->mode_config.prop_fb_id = prop;
1580 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1581 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1584 dev->mode_config.prop_crtc_id = prop;
1586 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
1590 dev->mode_config.prop_active = prop;
1592 prop = drm_property_create(dev,
1593 DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
1597 dev->mode_config.prop_mode_id = prop;
1603 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1606 * Called by a driver the first time a DVI-I connector is made.
1608 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1610 struct drm_property *dvi_i_selector;
1611 struct drm_property *dvi_i_subconnector;
1613 if (dev->mode_config.dvi_i_select_subconnector_property)
1617 drm_property_create_enum(dev, 0,
1618 "select subconnector",
1619 drm_dvi_i_select_enum_list,
1620 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1621 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1623 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1625 drm_dvi_i_subconnector_enum_list,
1626 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1627 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1631 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1634 * drm_create_tv_properties - create TV specific connector properties
1636 * @num_modes: number of different TV formats (modes) supported
1637 * @modes: array of pointers to strings containing name of each format
1639 * Called by a driver's TV initialization routine, this function creates
1640 * the TV specific connector properties for a given device. Caller is
1641 * responsible for allocating a list of format names and passing them to
1644 int drm_mode_create_tv_properties(struct drm_device *dev,
1645 unsigned int num_modes,
1646 const char * const modes[])
1648 struct drm_property *tv_selector;
1649 struct drm_property *tv_subconnector;
1652 if (dev->mode_config.tv_select_subconnector_property)
1656 * Basic connector properties
1658 tv_selector = drm_property_create_enum(dev, 0,
1659 "select subconnector",
1660 drm_tv_select_enum_list,
1661 ARRAY_SIZE(drm_tv_select_enum_list));
1665 dev->mode_config.tv_select_subconnector_property = tv_selector;
1668 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1670 drm_tv_subconnector_enum_list,
1671 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1672 if (!tv_subconnector)
1674 dev->mode_config.tv_subconnector_property = tv_subconnector;
1677 * Other, TV specific properties: margins & TV modes.
1679 dev->mode_config.tv_left_margin_property =
1680 drm_property_create_range(dev, 0, "left margin", 0, 100);
1681 if (!dev->mode_config.tv_left_margin_property)
1684 dev->mode_config.tv_right_margin_property =
1685 drm_property_create_range(dev, 0, "right margin", 0, 100);
1686 if (!dev->mode_config.tv_right_margin_property)
1689 dev->mode_config.tv_top_margin_property =
1690 drm_property_create_range(dev, 0, "top margin", 0, 100);
1691 if (!dev->mode_config.tv_top_margin_property)
1694 dev->mode_config.tv_bottom_margin_property =
1695 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1696 if (!dev->mode_config.tv_bottom_margin_property)
1699 dev->mode_config.tv_mode_property =
1700 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1702 if (!dev->mode_config.tv_mode_property)
1705 for (i = 0; i < num_modes; i++)
1706 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1709 dev->mode_config.tv_brightness_property =
1710 drm_property_create_range(dev, 0, "brightness", 0, 100);
1711 if (!dev->mode_config.tv_brightness_property)
1714 dev->mode_config.tv_contrast_property =
1715 drm_property_create_range(dev, 0, "contrast", 0, 100);
1716 if (!dev->mode_config.tv_contrast_property)
1719 dev->mode_config.tv_flicker_reduction_property =
1720 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1721 if (!dev->mode_config.tv_flicker_reduction_property)
1724 dev->mode_config.tv_overscan_property =
1725 drm_property_create_range(dev, 0, "overscan", 0, 100);
1726 if (!dev->mode_config.tv_overscan_property)
1729 dev->mode_config.tv_saturation_property =
1730 drm_property_create_range(dev, 0, "saturation", 0, 100);
1731 if (!dev->mode_config.tv_saturation_property)
1734 dev->mode_config.tv_hue_property =
1735 drm_property_create_range(dev, 0, "hue", 0, 100);
1736 if (!dev->mode_config.tv_hue_property)
1743 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1746 * drm_mode_create_scaling_mode_property - create scaling mode property
1749 * Called by a driver the first time it's needed, must be attached to desired
1752 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1754 struct drm_property *scaling_mode;
1756 if (dev->mode_config.scaling_mode_property)
1760 drm_property_create_enum(dev, 0, "scaling mode",
1761 drm_scaling_mode_enum_list,
1762 ARRAY_SIZE(drm_scaling_mode_enum_list));
1764 dev->mode_config.scaling_mode_property = scaling_mode;
1768 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1771 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1774 * Called by a driver the first time it's needed, must be attached to desired
1778 * Zero on success, negative errno on failure.
1780 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1782 if (dev->mode_config.aspect_ratio_property)
1785 dev->mode_config.aspect_ratio_property =
1786 drm_property_create_enum(dev, 0, "aspect ratio",
1787 drm_aspect_ratio_enum_list,
1788 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1790 if (dev->mode_config.aspect_ratio_property == NULL)
1795 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1798 * drm_mode_create_dirty_property - create dirty property
1801 * Called by a driver the first time it's needed, must be attached to desired
1804 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1806 struct drm_property *dirty_info;
1808 if (dev->mode_config.dirty_info_property)
1812 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1814 drm_dirty_info_enum_list,
1815 ARRAY_SIZE(drm_dirty_info_enum_list));
1816 dev->mode_config.dirty_info_property = dirty_info;
1820 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1823 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1826 * Create the the suggested x/y offset property for connectors.
1828 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1830 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1833 dev->mode_config.suggested_x_property =
1834 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1836 dev->mode_config.suggested_y_property =
1837 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1839 if (dev->mode_config.suggested_x_property == NULL ||
1840 dev->mode_config.suggested_y_property == NULL)
1844 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1847 * drm_mode_getresources - get graphics configuration
1848 * @dev: drm device for the ioctl
1849 * @data: data pointer for the ioctl
1850 * @file_priv: drm file for the ioctl call
1852 * Construct a set of configuration description structures and return
1853 * them to the user, including CRTC, connector and framebuffer configuration.
1855 * Called by the user via ioctl.
1858 * Zero on success, negative errno on failure.
1860 int drm_mode_getresources(struct drm_device *dev, void *data,
1861 struct drm_file *file_priv)
1863 struct drm_mode_card_res *card_res = data;
1864 struct list_head *lh;
1865 struct drm_framebuffer *fb;
1866 struct drm_connector *connector;
1867 struct drm_crtc *crtc;
1868 struct drm_encoder *encoder;
1870 int connector_count = 0;
1873 int encoder_count = 0;
1875 uint32_t __user *fb_id;
1876 uint32_t __user *crtc_id;
1877 uint32_t __user *connector_id;
1878 uint32_t __user *encoder_id;
1880 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1884 mutex_lock(&file_priv->fbs_lock);
1886 * For the non-control nodes we need to limit the list of resources
1887 * by IDs in the group list for this node
1889 list_for_each(lh, &file_priv->fbs)
1892 /* handle this in 4 parts */
1894 if (card_res->count_fbs >= fb_count) {
1896 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1897 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1898 if (put_user(fb->base.id, fb_id + copied)) {
1899 mutex_unlock(&file_priv->fbs_lock);
1905 card_res->count_fbs = fb_count;
1906 mutex_unlock(&file_priv->fbs_lock);
1908 /* mode_config.mutex protects the connector list against e.g. DP MST
1909 * connector hot-adding. CRTC/Plane lists are invariant. */
1910 mutex_lock(&dev->mode_config.mutex);
1911 drm_for_each_crtc(crtc, dev)
1914 drm_for_each_connector(connector, dev)
1917 drm_for_each_encoder(encoder, dev)
1920 card_res->max_height = dev->mode_config.max_height;
1921 card_res->min_height = dev->mode_config.min_height;
1922 card_res->max_width = dev->mode_config.max_width;
1923 card_res->min_width = dev->mode_config.min_width;
1926 if (card_res->count_crtcs >= crtc_count) {
1928 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1929 drm_for_each_crtc(crtc, dev) {
1930 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1931 if (put_user(crtc->base.id, crtc_id + copied)) {
1938 card_res->count_crtcs = crtc_count;
1941 if (card_res->count_encoders >= encoder_count) {
1943 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1944 drm_for_each_encoder(encoder, dev) {
1945 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1947 if (put_user(encoder->base.id, encoder_id +
1955 card_res->count_encoders = encoder_count;
1958 if (card_res->count_connectors >= connector_count) {
1960 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1961 drm_for_each_connector(connector, dev) {
1962 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1965 if (put_user(connector->base.id,
1966 connector_id + copied)) {
1973 card_res->count_connectors = connector_count;
1975 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1976 card_res->count_connectors, card_res->count_encoders);
1979 mutex_unlock(&dev->mode_config.mutex);
1984 * drm_mode_getcrtc - get CRTC configuration
1985 * @dev: drm device for the ioctl
1986 * @data: data pointer for the ioctl
1987 * @file_priv: drm file for the ioctl call
1989 * Construct a CRTC configuration structure to return to the user.
1991 * Called by the user via ioctl.
1994 * Zero on success, negative errno on failure.
1996 int drm_mode_getcrtc(struct drm_device *dev,
1997 void *data, struct drm_file *file_priv)
1999 struct drm_mode_crtc *crtc_resp = data;
2000 struct drm_crtc *crtc;
2002 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2005 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
2009 drm_modeset_lock_crtc(crtc, crtc->primary);
2010 crtc_resp->gamma_size = crtc->gamma_size;
2011 if (crtc->primary->fb)
2012 crtc_resp->fb_id = crtc->primary->fb->base.id;
2014 crtc_resp->fb_id = 0;
2017 crtc_resp->x = crtc->primary->state->src_x >> 16;
2018 crtc_resp->y = crtc->primary->state->src_y >> 16;
2019 if (crtc->state->enable) {
2020 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
2021 crtc_resp->mode_valid = 1;
2024 crtc_resp->mode_valid = 0;
2027 crtc_resp->x = crtc->x;
2028 crtc_resp->y = crtc->y;
2029 if (crtc->enabled) {
2030 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2031 crtc_resp->mode_valid = 1;
2034 crtc_resp->mode_valid = 0;
2037 drm_modeset_unlock_crtc(crtc);
2042 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2043 const struct drm_file *file_priv)
2046 * If user-space hasn't configured the driver to expose the stereo 3D
2047 * modes, don't expose them.
2049 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2055 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2057 /* For atomic drivers only state objects are synchronously updated and
2058 * protected by modeset locks, so check those first. */
2059 if (connector->state)
2060 return connector->state->best_encoder;
2061 return connector->encoder;
2064 /* helper for getconnector and getproperties ioctls */
2065 static int get_properties(struct drm_mode_object *obj, bool atomic,
2066 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2067 uint32_t *arg_count_props)
2072 props_count = obj->properties->count;
2074 props_count -= obj->properties->atomic_count;
2076 if ((*arg_count_props >= props_count) && props_count) {
2077 for (i = 0, copied = 0; copied < props_count; i++) {
2078 struct drm_property *prop = obj->properties->properties[i];
2081 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2084 ret = drm_object_property_get_value(obj, prop, &val);
2088 if (put_user(prop->base.id, prop_ptr + copied))
2091 if (put_user(val, prop_values + copied))
2097 *arg_count_props = props_count;
2103 * drm_mode_getconnector - get connector configuration
2104 * @dev: drm device for the ioctl
2105 * @data: data pointer for the ioctl
2106 * @file_priv: drm file for the ioctl call
2108 * Construct a connector configuration structure to return to the user.
2110 * Called by the user via ioctl.
2113 * Zero on success, negative errno on failure.
2115 int drm_mode_getconnector(struct drm_device *dev, void *data,
2116 struct drm_file *file_priv)
2118 struct drm_mode_get_connector *out_resp = data;
2119 struct drm_connector *connector;
2120 struct drm_encoder *encoder;
2121 struct drm_display_mode *mode;
2123 int encoders_count = 0;
2127 struct drm_mode_modeinfo u_mode;
2128 struct drm_mode_modeinfo __user *mode_ptr;
2129 uint32_t __user *encoder_ptr;
2131 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2134 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2136 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2138 mutex_lock(&dev->mode_config.mutex);
2140 connector = drm_connector_find(dev, out_resp->connector_id);
2146 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2147 if (connector->encoder_ids[i] != 0)
2150 if (out_resp->count_modes == 0) {
2151 connector->funcs->fill_modes(connector,
2152 dev->mode_config.max_width,
2153 dev->mode_config.max_height);
2156 /* delayed so we get modes regardless of pre-fill_modes state */
2157 list_for_each_entry(mode, &connector->modes, head)
2158 if (drm_mode_expose_to_userspace(mode, file_priv))
2161 out_resp->connector_id = connector->base.id;
2162 out_resp->connector_type = connector->connector_type;
2163 out_resp->connector_type_id = connector->connector_type_id;
2164 out_resp->mm_width = connector->display_info.width_mm;
2165 out_resp->mm_height = connector->display_info.height_mm;
2166 out_resp->subpixel = connector->display_info.subpixel_order;
2167 out_resp->connection = connector->status;
2169 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2170 encoder = drm_connector_get_encoder(connector);
2172 out_resp->encoder_id = encoder->base.id;
2174 out_resp->encoder_id = 0;
2177 * This ioctl is called twice, once to determine how much space is
2178 * needed, and the 2nd time to fill it.
2180 if ((out_resp->count_modes >= mode_count) && mode_count) {
2182 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2183 list_for_each_entry(mode, &connector->modes, head) {
2184 if (!drm_mode_expose_to_userspace(mode, file_priv))
2187 drm_mode_convert_to_umode(&u_mode, mode);
2188 if (copy_to_user(mode_ptr + copied,
2189 &u_mode, sizeof(u_mode))) {
2196 out_resp->count_modes = mode_count;
2198 ret = get_properties(&connector->base, file_priv->atomic,
2199 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2200 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2201 &out_resp->count_props);
2205 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2207 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2208 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2209 if (connector->encoder_ids[i] != 0) {
2210 if (put_user(connector->encoder_ids[i],
2211 encoder_ptr + copied)) {
2219 out_resp->count_encoders = encoders_count;
2222 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2225 mutex_unlock(&dev->mode_config.mutex);
2230 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2232 struct drm_connector *connector;
2233 struct drm_device *dev = encoder->dev;
2234 bool uses_atomic = false;
2236 /* For atomic drivers only state objects are synchronously updated and
2237 * protected by modeset locks, so check those first. */
2238 drm_for_each_connector(connector, dev) {
2239 if (!connector->state)
2244 if (connector->state->best_encoder != encoder)
2247 return connector->state->crtc;
2250 /* Don't return stale data (e.g. pending async disable). */
2254 return encoder->crtc;
2258 * drm_mode_getencoder - get encoder configuration
2259 * @dev: drm device for the ioctl
2260 * @data: data pointer for the ioctl
2261 * @file_priv: drm file for the ioctl call
2263 * Construct a encoder configuration structure to return to the user.
2265 * Called by the user via ioctl.
2268 * Zero on success, negative errno on failure.
2270 int drm_mode_getencoder(struct drm_device *dev, void *data,
2271 struct drm_file *file_priv)
2273 struct drm_mode_get_encoder *enc_resp = data;
2274 struct drm_encoder *encoder;
2275 struct drm_crtc *crtc;
2277 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2280 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2284 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2285 crtc = drm_encoder_get_crtc(encoder);
2287 enc_resp->crtc_id = crtc->base.id;
2289 enc_resp->crtc_id = 0;
2290 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2292 enc_resp->encoder_type = encoder->encoder_type;
2293 enc_resp->encoder_id = encoder->base.id;
2294 enc_resp->possible_crtcs = encoder->possible_crtcs;
2295 enc_resp->possible_clones = encoder->possible_clones;
2301 * drm_mode_getplane_res - enumerate all plane resources
2304 * @file_priv: DRM file info
2306 * Construct a list of plane ids to return to the user.
2308 * Called by the user via ioctl.
2311 * Zero on success, negative errno on failure.
2313 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2314 struct drm_file *file_priv)
2316 struct drm_mode_get_plane_res *plane_resp = data;
2317 struct drm_mode_config *config;
2318 struct drm_plane *plane;
2319 uint32_t __user *plane_ptr;
2321 unsigned num_planes;
2323 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2326 config = &dev->mode_config;
2328 if (file_priv->universal_planes)
2329 num_planes = config->num_total_plane;
2331 num_planes = config->num_overlay_plane;
2332 if (!file_priv->share_planes) {
2333 if (file_priv->universal_planes)
2334 num_planes -= config->num_share_plane;
2336 num_planes -= config->num_share_overlay_plane;
2340 * This ioctl is called twice, once to determine how much space is
2341 * needed, and the 2nd time to fill it.
2344 (plane_resp->count_planes >= num_planes)) {
2345 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2347 /* Plane lists are invariant, no locking needed. */
2348 drm_for_each_plane(plane, dev) {
2350 * Unless userspace set the 'universal planes'
2351 * capability bit, only advertise overlays.
2353 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2354 !file_priv->universal_planes)
2356 if (plane->parent && !file_priv->share_planes)
2359 if (put_user(plane->base.id, plane_ptr + copied))
2364 plane_resp->count_planes = num_planes;
2370 * drm_mode_getplane - get plane configuration
2373 * @file_priv: DRM file info
2375 * Construct a plane configuration structure to return to the user.
2377 * Called by the user via ioctl.
2380 * Zero on success, negative errno on failure.
2382 int drm_mode_getplane(struct drm_device *dev, void *data,
2383 struct drm_file *file_priv)
2385 struct drm_mode_get_plane *plane_resp = data;
2386 struct drm_plane *plane;
2387 uint32_t __user *format_ptr;
2389 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2392 plane = drm_plane_find(dev, plane_resp->plane_id);
2396 drm_modeset_lock(&plane->mutex, NULL);
2398 plane_resp->crtc_id = plane->crtc->base.id;
2400 plane_resp->crtc_id = 0;
2403 plane_resp->fb_id = plane->fb->base.id;
2405 plane_resp->fb_id = 0;
2406 drm_modeset_unlock(&plane->mutex);
2408 plane_resp->plane_id = plane->base.id;
2409 plane_resp->possible_crtcs = plane->possible_crtcs;
2410 plane_resp->gamma_size = 0;
2413 * This ioctl is called twice, once to determine how much space is
2414 * needed, and the 2nd time to fill it.
2416 if (plane->format_count &&
2417 (plane_resp->count_format_types >= plane->format_count)) {
2418 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2419 if (copy_to_user(format_ptr,
2420 plane->format_types,
2421 sizeof(uint32_t) * plane->format_count)) {
2425 plane_resp->count_format_types = plane->format_count;
2431 * drm_plane_check_pixel_format - Check if the plane supports the pixel format
2432 * @plane: plane to check for format support
2433 * @format: the pixel format
2436 * Zero of @plane has @format in its list of supported pixel formats, -EINVAL
2439 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
2443 for (i = 0; i < plane->format_count; i++) {
2444 if (format == plane->format_types[i])
2451 static int check_src_coords(uint32_t src_x, uint32_t src_y,
2452 uint32_t src_w, uint32_t src_h,
2453 const struct drm_framebuffer *fb)
2455 unsigned int fb_width, fb_height;
2457 fb_width = fb->width << 16;
2458 fb_height = fb->height << 16;
2460 /* Make sure source coordinates are inside the fb. */
2461 if (src_w > fb_width ||
2462 src_x > fb_width - src_w ||
2463 src_h > fb_height ||
2464 src_y > fb_height - src_h) {
2465 DRM_DEBUG_KMS("Invalid source coordinates "
2466 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2467 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2468 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2469 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2470 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2478 * setplane_internal - setplane handler for internal callers
2480 * Note that we assume an extra reference has already been taken on fb. If the
2481 * update fails, this reference will be dropped before return; if it succeeds,
2482 * the previous framebuffer (if any) will be unreferenced instead.
2484 * src_{x,y,w,h} are provided in 16.16 fixed point format
2486 static int __setplane_internal(struct drm_plane *plane,
2487 struct drm_crtc *crtc,
2488 struct drm_framebuffer *fb,
2489 int32_t crtc_x, int32_t crtc_y,
2490 uint32_t crtc_w, uint32_t crtc_h,
2491 /* src_{x,y,w,h} values are 16.16 fixed point */
2492 uint32_t src_x, uint32_t src_y,
2493 uint32_t src_w, uint32_t src_h)
2497 /* No fb means shut it down */
2499 plane->old_fb = plane->fb;
2500 ret = plane->funcs->disable_plane(plane);
2505 plane->old_fb = NULL;
2510 /* Check whether this plane is usable on this CRTC */
2511 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2512 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2517 /* Check whether this plane supports the fb pixel format. */
2518 ret = drm_plane_check_pixel_format(plane, fb->pixel_format);
2520 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2521 drm_get_format_name(fb->pixel_format));
2525 /* Give drivers some help against integer overflows */
2526 if (crtc_w > INT_MAX ||
2527 crtc_x > INT_MAX - (int32_t) crtc_w ||
2529 crtc_y > INT_MAX - (int32_t) crtc_h) {
2530 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2531 crtc_w, crtc_h, crtc_x, crtc_y);
2536 ret = check_src_coords(src_x, src_y, src_w, src_h, fb);
2540 plane->old_fb = plane->fb;
2541 ret = plane->funcs->update_plane(plane, crtc, fb,
2542 crtc_x, crtc_y, crtc_w, crtc_h,
2543 src_x, src_y, src_w, src_h);
2549 plane->old_fb = NULL;
2554 drm_framebuffer_unreference(fb);
2556 drm_framebuffer_unreference(plane->old_fb);
2557 plane->old_fb = NULL;
2562 static int setplane_internal(struct drm_plane *plane,
2563 struct drm_crtc *crtc,
2564 struct drm_framebuffer *fb,
2565 int32_t crtc_x, int32_t crtc_y,
2566 uint32_t crtc_w, uint32_t crtc_h,
2567 /* src_{x,y,w,h} values are 16.16 fixed point */
2568 uint32_t src_x, uint32_t src_y,
2569 uint32_t src_w, uint32_t src_h)
2573 drm_modeset_lock_all(plane->dev);
2574 ret = __setplane_internal(plane, crtc, fb,
2575 crtc_x, crtc_y, crtc_w, crtc_h,
2576 src_x, src_y, src_w, src_h);
2577 drm_modeset_unlock_all(plane->dev);
2583 * drm_mode_setplane - configure a plane's configuration
2585 * @data: ioctl data*
2586 * @file_priv: DRM file info
2588 * Set plane configuration, including placement, fb, scaling, and other factors.
2589 * Or pass a NULL fb to disable (planes may be disabled without providing a
2593 * Zero on success, negative errno on failure.
2595 int drm_mode_setplane(struct drm_device *dev, void *data,
2596 struct drm_file *file_priv)
2598 struct drm_mode_set_plane *plane_req = data;
2599 struct drm_plane *plane;
2600 struct drm_crtc *crtc = NULL;
2601 struct drm_framebuffer *fb = NULL;
2603 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2607 * First, find the plane, crtc, and fb objects. If not available,
2608 * we don't bother to call the driver.
2610 plane = drm_plane_find(dev, plane_req->plane_id);
2612 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2613 plane_req->plane_id);
2617 if (plane_req->fb_id) {
2618 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2620 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2625 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2627 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2628 plane_req->crtc_id);
2634 * setplane_internal will take care of deref'ing either the old or new
2635 * framebuffer depending on success.
2637 return setplane_internal(plane, crtc, fb,
2638 plane_req->crtc_x, plane_req->crtc_y,
2639 plane_req->crtc_w, plane_req->crtc_h,
2640 plane_req->src_x, plane_req->src_y,
2641 plane_req->src_w, plane_req->src_h);
2645 * drm_mode_set_config_internal - helper to call ->set_config
2646 * @set: modeset config to set
2648 * This is a little helper to wrap internal calls to the ->set_config driver
2649 * interface. The only thing it adds is correct refcounting dance.
2652 * Zero on success, negative errno on failure.
2654 int drm_mode_set_config_internal(struct drm_mode_set *set)
2656 struct drm_crtc *crtc = set->crtc;
2657 struct drm_framebuffer *fb;
2658 struct drm_crtc *tmp;
2662 * NOTE: ->set_config can also disable other crtcs (if we steal all
2663 * connectors from it), hence we need to refcount the fbs across all
2664 * crtcs. Atomic modeset will have saner semantics ...
2666 drm_for_each_crtc(tmp, crtc->dev)
2667 tmp->primary->old_fb = tmp->primary->fb;
2671 ret = crtc->funcs->set_config(set);
2673 crtc->primary->crtc = crtc;
2674 crtc->primary->fb = fb;
2677 drm_for_each_crtc(tmp, crtc->dev) {
2678 if (tmp->primary->fb)
2679 drm_framebuffer_reference(tmp->primary->fb);
2680 if (tmp->primary->old_fb)
2681 drm_framebuffer_unreference(tmp->primary->old_fb);
2682 tmp->primary->old_fb = NULL;
2687 EXPORT_SYMBOL(drm_mode_set_config_internal);
2690 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
2691 * @mode: mode to query
2692 * @hdisplay: hdisplay value to fill in
2693 * @vdisplay: vdisplay value to fill in
2695 * The vdisplay value will be doubled if the specified mode is a stereo mode of
2696 * the appropriate layout.
2698 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2699 int *hdisplay, int *vdisplay)
2701 struct drm_display_mode adjusted;
2703 drm_mode_copy(&adjusted, mode);
2704 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
2705 *hdisplay = adjusted.crtc_hdisplay;
2706 *vdisplay = adjusted.crtc_vdisplay;
2708 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
2711 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2713 * @crtc: CRTC that framebuffer will be displayed on
2716 * @mode: mode that framebuffer will be displayed under
2717 * @fb: framebuffer to check size of
2719 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2721 const struct drm_display_mode *mode,
2722 const struct drm_framebuffer *fb)
2725 int hdisplay, vdisplay;
2727 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
2730 crtc->primary->state->rotation & (BIT(DRM_ROTATE_90) |
2731 BIT(DRM_ROTATE_270)))
2732 swap(hdisplay, vdisplay);
2734 return check_src_coords(x << 16, y << 16,
2735 hdisplay << 16, vdisplay << 16, fb);
2737 EXPORT_SYMBOL(drm_crtc_check_viewport);
2740 * drm_mode_setcrtc - set CRTC configuration
2741 * @dev: drm device for the ioctl
2742 * @data: data pointer for the ioctl
2743 * @file_priv: drm file for the ioctl call
2745 * Build a new CRTC configuration based on user request.
2747 * Called by the user via ioctl.
2750 * Zero on success, negative errno on failure.
2752 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2753 struct drm_file *file_priv)
2755 struct drm_mode_config *config = &dev->mode_config;
2756 struct drm_mode_crtc *crtc_req = data;
2757 struct drm_crtc *crtc;
2758 struct drm_connector **connector_set = NULL, *connector;
2759 struct drm_framebuffer *fb = NULL;
2760 struct drm_display_mode *mode = NULL;
2761 struct drm_mode_set set;
2762 uint32_t __user *set_connectors_ptr;
2766 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2770 * Universal plane src offsets are only 16.16, prevent havoc for
2771 * drivers using universal plane code internally.
2773 if (crtc_req->x & 0xffff0000 || crtc_req->y & 0xffff0000)
2776 drm_modeset_lock_all(dev);
2777 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2779 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2783 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2785 if (crtc_req->mode_valid) {
2786 /* If we have a mode we need a framebuffer. */
2787 /* If we pass -1, set the mode with the currently bound fb */
2788 if (crtc_req->fb_id == -1) {
2789 if (!crtc->primary->fb) {
2790 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2794 fb = crtc->primary->fb;
2795 /* Make refcounting symmetric with the lookup path. */
2796 drm_framebuffer_reference(fb);
2798 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2800 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2807 mode = drm_mode_create(dev);
2813 ret = drm_mode_convert_umode(mode, &crtc_req->mode);
2815 DRM_DEBUG_KMS("Invalid mode\n");
2820 * Check whether the primary plane supports the fb pixel format.
2821 * Drivers not implementing the universal planes API use a
2822 * default formats list provided by the DRM core which doesn't
2823 * match real hardware capabilities. Skip the check in that
2826 if (!crtc->primary->format_default) {
2827 ret = drm_plane_check_pixel_format(crtc->primary,
2830 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2831 drm_get_format_name(fb->pixel_format));
2836 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2843 if (crtc_req->count_connectors == 0 && mode) {
2844 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2849 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2850 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2851 crtc_req->count_connectors);
2856 if (crtc_req->count_connectors > 0) {
2859 /* Avoid unbounded kernel memory allocation */
2860 if (crtc_req->count_connectors > config->num_connector) {
2865 connector_set = kmalloc_array(crtc_req->count_connectors,
2866 sizeof(struct drm_connector *),
2868 if (!connector_set) {
2873 for (i = 0; i < crtc_req->count_connectors; i++) {
2874 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2875 if (get_user(out_id, &set_connectors_ptr[i])) {
2880 connector = drm_connector_find(dev, out_id);
2882 DRM_DEBUG_KMS("Connector id %d unknown\n",
2887 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2891 connector_set[i] = connector;
2896 set.x = crtc_req->x;
2897 set.y = crtc_req->y;
2899 set.connectors = connector_set;
2900 set.num_connectors = crtc_req->count_connectors;
2902 ret = drm_mode_set_config_internal(&set);
2906 drm_framebuffer_unreference(fb);
2908 kfree(connector_set);
2909 drm_mode_destroy(dev, mode);
2910 drm_modeset_unlock_all(dev);
2915 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2916 * universal plane handler call
2917 * @crtc: crtc to update cursor for
2918 * @req: data pointer for the ioctl
2919 * @file_priv: drm file for the ioctl call
2921 * Legacy cursor ioctl's work directly with driver buffer handles. To
2922 * translate legacy ioctl calls into universal plane handler calls, we need to
2923 * wrap the native buffer handle in a drm_framebuffer.
2925 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2926 * buffer with a pitch of 4*width; the universal plane interface should be used
2927 * directly in cases where the hardware can support other buffer settings and
2928 * userspace wants to make use of these capabilities.
2931 * Zero on success, negative errno on failure.
2933 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2934 struct drm_mode_cursor2 *req,
2935 struct drm_file *file_priv)
2937 struct drm_device *dev = crtc->dev;
2938 struct drm_framebuffer *fb = NULL;
2939 struct drm_mode_fb_cmd2 fbreq = {
2940 .width = req->width,
2941 .height = req->height,
2942 .pixel_format = DRM_FORMAT_ARGB8888,
2943 .pitches = { req->width * 4 },
2944 .handles = { req->handle },
2946 int32_t crtc_x, crtc_y;
2947 uint32_t crtc_w = 0, crtc_h = 0;
2948 uint32_t src_w = 0, src_h = 0;
2951 BUG_ON(!crtc->cursor);
2952 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2955 * Obtain fb we'll be using (either new or existing) and take an extra
2956 * reference to it if fb != null. setplane will take care of dropping
2957 * the reference if the plane update fails.
2959 if (req->flags & DRM_MODE_CURSOR_BO) {
2961 fb = internal_framebuffer_create(dev, &fbreq, file_priv);
2963 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2970 fb = crtc->cursor->fb;
2972 drm_framebuffer_reference(fb);
2975 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2979 crtc_x = crtc->cursor_x;
2980 crtc_y = crtc->cursor_y;
2985 crtc_h = fb->height;
2986 src_w = fb->width << 16;
2987 src_h = fb->height << 16;
2991 * setplane_internal will take care of deref'ing either the old or new
2992 * framebuffer depending on success.
2994 ret = __setplane_internal(crtc->cursor, crtc, fb,
2995 crtc_x, crtc_y, crtc_w, crtc_h,
2996 0, 0, src_w, src_h);
2998 /* Update successful; save new cursor position, if necessary */
2999 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
3000 crtc->cursor_x = req->x;
3001 crtc->cursor_y = req->y;
3007 static int drm_mode_cursor_common(struct drm_device *dev,
3008 struct drm_mode_cursor2 *req,
3009 struct drm_file *file_priv)
3011 struct drm_crtc *crtc;
3014 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3017 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
3020 crtc = drm_crtc_find(dev, req->crtc_id);
3022 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
3027 * If this crtc has a universal cursor plane, call that plane's update
3028 * handler rather than using legacy cursor handlers.
3030 drm_modeset_lock_crtc(crtc, crtc->cursor);
3032 ret = drm_mode_cursor_universal(crtc, req, file_priv);
3036 if (req->flags & DRM_MODE_CURSOR_BO) {
3037 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
3041 /* Turns off the cursor if handle is 0 */
3042 if (crtc->funcs->cursor_set2)
3043 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
3044 req->width, req->height, req->hot_x, req->hot_y);
3046 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
3047 req->width, req->height);
3050 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3051 if (crtc->funcs->cursor_move) {
3052 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3059 drm_modeset_unlock_crtc(crtc);
3067 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3068 * @dev: drm device for the ioctl
3069 * @data: data pointer for the ioctl
3070 * @file_priv: drm file for the ioctl call
3072 * Set the cursor configuration based on user request.
3074 * Called by the user via ioctl.
3077 * Zero on success, negative errno on failure.
3079 int drm_mode_cursor_ioctl(struct drm_device *dev,
3080 void *data, struct drm_file *file_priv)
3082 struct drm_mode_cursor *req = data;
3083 struct drm_mode_cursor2 new_req;
3085 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3086 new_req.hot_x = new_req.hot_y = 0;
3088 return drm_mode_cursor_common(dev, &new_req, file_priv);
3092 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3093 * @dev: drm device for the ioctl
3094 * @data: data pointer for the ioctl
3095 * @file_priv: drm file for the ioctl call
3097 * Set the cursor configuration based on user request. This implements the 2nd
3098 * version of the cursor ioctl, which allows userspace to additionally specify
3099 * the hotspot of the pointer.
3101 * Called by the user via ioctl.
3104 * Zero on success, negative errno on failure.
3106 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3107 void *data, struct drm_file *file_priv)
3109 struct drm_mode_cursor2 *req = data;
3111 return drm_mode_cursor_common(dev, req, file_priv);
3115 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3116 * @bpp: bits per pixels
3117 * @depth: bit depth per pixel
3119 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3120 * Useful in fbdev emulation code, since that deals in those values.
3122 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3128 fmt = DRM_FORMAT_C8;
3132 fmt = DRM_FORMAT_XRGB1555;
3134 fmt = DRM_FORMAT_RGB565;
3137 fmt = DRM_FORMAT_RGB888;
3141 fmt = DRM_FORMAT_XRGB8888;
3142 else if (depth == 30)
3143 fmt = DRM_FORMAT_XRGB2101010;
3145 fmt = DRM_FORMAT_ARGB8888;
3148 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3149 fmt = DRM_FORMAT_XRGB8888;
3155 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3158 * drm_mode_addfb - add an FB to the graphics configuration
3159 * @dev: drm device for the ioctl
3160 * @data: data pointer for the ioctl
3161 * @file_priv: drm file for the ioctl call
3163 * Add a new FB to the specified CRTC, given a user request. This is the
3164 * original addfb ioctl which only supported RGB formats.
3166 * Called by the user via ioctl.
3169 * Zero on success, negative errno on failure.
3171 int drm_mode_addfb(struct drm_device *dev,
3172 void *data, struct drm_file *file_priv)
3174 struct drm_mode_fb_cmd *or = data;
3175 struct drm_mode_fb_cmd2 r = {};
3178 /* convert to new format and call new ioctl */
3179 r.fb_id = or->fb_id;
3180 r.width = or->width;
3181 r.height = or->height;
3182 r.pitches[0] = or->pitch;
3183 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3184 r.handles[0] = or->handle;
3186 ret = drm_mode_addfb2(dev, &r, file_priv);
3190 or->fb_id = r.fb_id;
3195 static int format_check(const struct drm_mode_fb_cmd2 *r)
3197 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3201 case DRM_FORMAT_RGB332:
3202 case DRM_FORMAT_BGR233:
3203 case DRM_FORMAT_XRGB4444:
3204 case DRM_FORMAT_XBGR4444:
3205 case DRM_FORMAT_RGBX4444:
3206 case DRM_FORMAT_BGRX4444:
3207 case DRM_FORMAT_ARGB4444:
3208 case DRM_FORMAT_ABGR4444:
3209 case DRM_FORMAT_RGBA4444:
3210 case DRM_FORMAT_BGRA4444:
3211 case DRM_FORMAT_XRGB1555:
3212 case DRM_FORMAT_XBGR1555:
3213 case DRM_FORMAT_RGBX5551:
3214 case DRM_FORMAT_BGRX5551:
3215 case DRM_FORMAT_ARGB1555:
3216 case DRM_FORMAT_ABGR1555:
3217 case DRM_FORMAT_RGBA5551:
3218 case DRM_FORMAT_BGRA5551:
3219 case DRM_FORMAT_RGB565:
3220 case DRM_FORMAT_BGR565:
3221 case DRM_FORMAT_RGB888:
3222 case DRM_FORMAT_BGR888:
3223 case DRM_FORMAT_XRGB8888:
3224 case DRM_FORMAT_XBGR8888:
3225 case DRM_FORMAT_RGBX8888:
3226 case DRM_FORMAT_BGRX8888:
3227 case DRM_FORMAT_ARGB8888:
3228 case DRM_FORMAT_ABGR8888:
3229 case DRM_FORMAT_RGBA8888:
3230 case DRM_FORMAT_BGRA8888:
3231 case DRM_FORMAT_XRGB2101010:
3232 case DRM_FORMAT_XBGR2101010:
3233 case DRM_FORMAT_RGBX1010102:
3234 case DRM_FORMAT_BGRX1010102:
3235 case DRM_FORMAT_ARGB2101010:
3236 case DRM_FORMAT_ABGR2101010:
3237 case DRM_FORMAT_RGBA1010102:
3238 case DRM_FORMAT_BGRA1010102:
3239 case DRM_FORMAT_YUYV:
3240 case DRM_FORMAT_YVYU:
3241 case DRM_FORMAT_UYVY:
3242 case DRM_FORMAT_VYUY:
3243 case DRM_FORMAT_AYUV:
3244 case DRM_FORMAT_NV12:
3245 case DRM_FORMAT_NV21:
3246 case DRM_FORMAT_NV16:
3247 case DRM_FORMAT_NV61:
3248 case DRM_FORMAT_NV24:
3249 case DRM_FORMAT_NV42:
3250 case DRM_FORMAT_NV12_10:
3251 case DRM_FORMAT_NV21_10:
3252 case DRM_FORMAT_NV16_10:
3253 case DRM_FORMAT_NV61_10:
3254 case DRM_FORMAT_NV24_10:
3255 case DRM_FORMAT_NV42_10:
3256 case DRM_FORMAT_YUV410:
3257 case DRM_FORMAT_YVU410:
3258 case DRM_FORMAT_YUV411:
3259 case DRM_FORMAT_YVU411:
3260 case DRM_FORMAT_YUV420:
3261 case DRM_FORMAT_YVU420:
3262 case DRM_FORMAT_YUV422:
3263 case DRM_FORMAT_YVU422:
3264 case DRM_FORMAT_YUV444:
3265 case DRM_FORMAT_YVU444:
3268 DRM_DEBUG_KMS("invalid pixel format %s\n",
3269 drm_get_format_name(r->pixel_format));
3274 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3276 int ret, hsub, vsub, num_planes, i;
3278 ret = format_check(r);
3280 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3281 drm_get_format_name(r->pixel_format));
3285 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3286 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3287 num_planes = drm_format_num_planes(r->pixel_format);
3289 if (r->width == 0 || r->width % hsub) {
3290 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3294 if (r->height == 0 || r->height % vsub) {
3295 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3299 for (i = 0; i < num_planes; i++) {
3300 unsigned int width = r->width / (i != 0 ? hsub : 1);
3301 unsigned int height = r->height / (i != 0 ? vsub : 1);
3302 unsigned int bpp = drm_format_plane_bpp(r->pixel_format, i);
3304 if (!r->handles[i]) {
3305 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3309 if ((uint64_t) width * bpp / 8 > UINT_MAX)
3312 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3315 if (r->pitches[i] < roundup(width * bpp, 8) / 8) {
3316 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3320 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
3321 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
3326 /* modifier specific checks: */
3327 switch (r->modifier[i]) {
3328 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
3329 /* NOTE: the pitch restriction may be lifted later if it turns
3330 * out that no hw has this restriction:
3332 if (r->pixel_format != DRM_FORMAT_NV12 ||
3333 width % 128 || height % 32 ||
3334 r->pitches[i] % 128) {
3335 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
3345 for (i = num_planes; i < 4; i++) {
3346 if (r->modifier[i]) {
3347 DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
3351 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
3352 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
3355 if (r->handles[i]) {
3356 DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
3360 if (r->pitches[i]) {
3361 DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
3365 if (r->offsets[i]) {
3366 DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
3374 static struct drm_framebuffer *
3375 internal_framebuffer_create(struct drm_device *dev,
3376 struct drm_mode_fb_cmd2 *r,
3377 struct drm_file *file_priv)
3379 struct drm_mode_config *config = &dev->mode_config;
3380 struct drm_framebuffer *fb;
3383 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
3384 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3385 return ERR_PTR(-EINVAL);
3388 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3389 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3390 r->width, config->min_width, config->max_width);
3391 return ERR_PTR(-EINVAL);
3393 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3394 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3395 r->height, config->min_height, config->max_height);
3396 return ERR_PTR(-EINVAL);
3399 if (r->flags & DRM_MODE_FB_MODIFIERS &&
3400 !dev->mode_config.allow_fb_modifiers) {
3401 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
3402 return ERR_PTR(-EINVAL);
3405 ret = framebuffer_check(r);
3407 return ERR_PTR(ret);
3409 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3411 DRM_DEBUG_KMS("could not create framebuffer\n");
3419 * drm_mode_addfb2 - add an FB to the graphics configuration
3420 * @dev: drm device for the ioctl
3421 * @data: data pointer for the ioctl
3422 * @file_priv: drm file for the ioctl call
3424 * Add a new FB to the specified CRTC, given a user request with format. This is
3425 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3426 * and uses fourcc codes as pixel format specifiers.
3428 * Called by the user via ioctl.
3431 * Zero on success, negative errno on failure.
3433 int drm_mode_addfb2(struct drm_device *dev,
3434 void *data, struct drm_file *file_priv)
3436 struct drm_mode_fb_cmd2 *r = data;
3437 struct drm_framebuffer *fb;
3439 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3442 fb = internal_framebuffer_create(dev, r, file_priv);
3446 /* Transfer ownership to the filp for reaping on close */
3448 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3449 mutex_lock(&file_priv->fbs_lock);
3450 r->fb_id = fb->base.id;
3451 list_add(&fb->filp_head, &file_priv->fbs);
3452 mutex_unlock(&file_priv->fbs_lock);
3457 struct drm_mode_rmfb_work {
3458 struct work_struct work;
3459 struct list_head fbs;
3462 static void drm_mode_rmfb_work_fn(struct work_struct *w)
3464 struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
3466 while (!list_empty(&arg->fbs)) {
3467 struct drm_framebuffer *fb =
3468 list_first_entry(&arg->fbs, typeof(*fb), filp_head);
3470 list_del_init(&fb->filp_head);
3471 drm_framebuffer_remove(fb);
3476 * drm_mode_rmfb - remove an FB from the configuration
3477 * @dev: drm device for the ioctl
3478 * @data: data pointer for the ioctl
3479 * @file_priv: drm file for the ioctl call
3481 * Remove the FB specified by the user.
3483 * Called by the user via ioctl.
3486 * Zero on success, negative errno on failure.
3488 int drm_mode_rmfb(struct drm_device *dev,
3489 void *data, struct drm_file *file_priv)
3491 struct drm_framebuffer *fb = NULL;
3492 struct drm_framebuffer *fbl = NULL;
3493 uint32_t *id = data;
3496 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3499 mutex_lock(&file_priv->fbs_lock);
3500 mutex_lock(&dev->mode_config.fb_lock);
3501 fb = __drm_framebuffer_lookup(dev, *id);
3505 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3511 list_del_init(&fb->filp_head);
3512 mutex_unlock(&dev->mode_config.fb_lock);
3513 mutex_unlock(&file_priv->fbs_lock);
3516 * we now own the reference that was stored in the fbs list
3518 * drm_framebuffer_remove may fail with -EINTR on pending signals,
3519 * so run this in a separate stack as there's no way to correctly
3520 * handle this after the fb is already removed from the lookup table.
3522 if (atomic_read(&fb->refcount.refcount) > 1) {
3523 struct drm_mode_rmfb_work arg;
3525 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3526 INIT_LIST_HEAD(&arg.fbs);
3527 list_add_tail(&fb->filp_head, &arg.fbs);
3529 schedule_work(&arg.work);
3530 flush_work(&arg.work);
3531 destroy_work_on_stack(&arg.work);
3533 drm_framebuffer_unreference(fb);
3538 mutex_unlock(&dev->mode_config.fb_lock);
3539 mutex_unlock(&file_priv->fbs_lock);
3545 * drm_mode_getfb - get FB info
3546 * @dev: drm device for the ioctl
3547 * @data: data pointer for the ioctl
3548 * @file_priv: drm file for the ioctl call
3550 * Lookup the FB given its ID and return info about it.
3552 * Called by the user via ioctl.
3555 * Zero on success, negative errno on failure.
3557 int drm_mode_getfb(struct drm_device *dev,
3558 void *data, struct drm_file *file_priv)
3560 struct drm_mode_fb_cmd *r = data;
3561 struct drm_framebuffer *fb;
3564 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3567 fb = drm_framebuffer_lookup(dev, r->fb_id);
3571 r->height = fb->height;
3572 r->width = fb->width;
3573 r->depth = fb->depth;
3574 r->bpp = fb->bits_per_pixel;
3575 r->pitch = fb->pitches[0];
3576 if (fb->funcs->create_handle) {
3577 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3578 drm_is_control_client(file_priv)) {
3579 ret = fb->funcs->create_handle(fb, file_priv,
3582 /* GET_FB() is an unprivileged ioctl so we must not
3583 * return a buffer-handle to non-master processes! For
3584 * backwards-compatibility reasons, we cannot make
3585 * GET_FB() privileged, so just return an invalid handle
3586 * for non-masters. */
3594 drm_framebuffer_unreference(fb);
3600 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3601 * @dev: drm device for the ioctl
3602 * @data: data pointer for the ioctl
3603 * @file_priv: drm file for the ioctl call
3605 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3606 * rectangle list. Generic userspace which does frontbuffer rendering must call
3607 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3608 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3610 * Modesetting drivers which always update the frontbuffer do not need to
3611 * implement the corresponding ->dirty framebuffer callback.
3613 * Called by the user via ioctl.
3616 * Zero on success, negative errno on failure.
3618 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3619 void *data, struct drm_file *file_priv)
3621 struct drm_clip_rect __user *clips_ptr;
3622 struct drm_clip_rect *clips = NULL;
3623 struct drm_mode_fb_dirty_cmd *r = data;
3624 struct drm_framebuffer *fb;
3629 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3632 fb = drm_framebuffer_lookup(dev, r->fb_id);
3636 num_clips = r->num_clips;
3637 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3639 if (!num_clips != !clips_ptr) {
3644 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3646 /* If userspace annotates copy, clips must come in pairs */
3647 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3652 if (num_clips && clips_ptr) {
3653 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3657 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3663 ret = copy_from_user(clips, clips_ptr,
3664 num_clips * sizeof(*clips));
3671 if (fb->funcs->dirty) {
3672 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3681 drm_framebuffer_unreference(fb);
3687 * drm_fb_release - remove and free the FBs on this file
3688 * @priv: drm file for the ioctl
3690 * Destroy all the FBs associated with @filp.
3692 * Called by the user via ioctl.
3695 * Zero on success, negative errno on failure.
3697 void drm_fb_release(struct drm_file *priv)
3699 struct drm_framebuffer *fb, *tfb;
3700 struct drm_mode_rmfb_work arg;
3702 INIT_LIST_HEAD(&arg.fbs);
3705 * When the file gets released that means no one else can access the fb
3706 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3707 * avoid upsetting lockdep since the universal cursor code adds a
3708 * framebuffer while holding mutex locks.
3710 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3711 * locks is impossible here since no one else but this function can get
3714 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3715 if (atomic_read(&fb->refcount.refcount) > 1) {
3716 list_move_tail(&fb->filp_head, &arg.fbs);
3718 list_del_init(&fb->filp_head);
3720 /* This drops the fpriv->fbs reference. */
3721 drm_framebuffer_unreference(fb);
3725 if (!list_empty(&arg.fbs)) {
3726 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3728 schedule_work(&arg.work);
3729 flush_work(&arg.work);
3730 destroy_work_on_stack(&arg.work);
3735 * drm_property_create - create a new property type
3737 * @flags: flags specifying the property type
3738 * @name: name of the property
3739 * @num_values: number of pre-defined values
3741 * This creates a new generic drm property which can then be attached to a drm
3742 * object with drm_object_attach_property. The returned property object must be
3743 * freed with drm_property_destroy.
3745 * Note that the DRM core keeps a per-device list of properties and that, if
3746 * drm_mode_config_cleanup() is called, it will destroy all properties created
3750 * A pointer to the newly created property on success, NULL on failure.
3752 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3753 const char *name, int num_values)
3755 struct drm_property *property = NULL;
3758 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3762 property->dev = dev;
3765 property->values = kcalloc(num_values, sizeof(uint64_t),
3767 if (!property->values)
3771 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3775 property->flags = flags;
3776 property->num_values = num_values;
3777 INIT_LIST_HEAD(&property->enum_list);
3780 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3781 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3784 list_add_tail(&property->head, &dev->mode_config.property_list);
3786 WARN_ON(!drm_property_type_valid(property));
3790 kfree(property->values);
3794 EXPORT_SYMBOL(drm_property_create);
3797 * drm_property_create_enum - create a new enumeration property type
3799 * @flags: flags specifying the property type
3800 * @name: name of the property
3801 * @props: enumeration lists with property values
3802 * @num_values: number of pre-defined values
3804 * This creates a new generic drm property which can then be attached to a drm
3805 * object with drm_object_attach_property. The returned property object must be
3806 * freed with drm_property_destroy.
3808 * Userspace is only allowed to set one of the predefined values for enumeration
3812 * A pointer to the newly created property on success, NULL on failure.
3814 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3816 const struct drm_prop_enum_list *props,
3819 struct drm_property *property;
3822 flags |= DRM_MODE_PROP_ENUM;
3824 property = drm_property_create(dev, flags, name, num_values);
3828 for (i = 0; i < num_values; i++) {
3829 ret = drm_property_add_enum(property, i,
3833 drm_property_destroy(dev, property);
3840 EXPORT_SYMBOL(drm_property_create_enum);
3843 * drm_property_create_bitmask - create a new bitmask property type
3845 * @flags: flags specifying the property type
3846 * @name: name of the property
3847 * @props: enumeration lists with property bitflags
3848 * @num_props: size of the @props array
3849 * @supported_bits: bitmask of all supported enumeration values
3851 * This creates a new bitmask drm property which can then be attached to a drm
3852 * object with drm_object_attach_property. The returned property object must be
3853 * freed with drm_property_destroy.
3855 * Compared to plain enumeration properties userspace is allowed to set any
3856 * or'ed together combination of the predefined property bitflag values
3859 * A pointer to the newly created property on success, NULL on failure.
3861 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3862 int flags, const char *name,
3863 const struct drm_prop_enum_list *props,
3865 uint64_t supported_bits)
3867 struct drm_property *property;
3868 int i, ret, index = 0;
3869 int num_values = hweight64(supported_bits);
3871 flags |= DRM_MODE_PROP_BITMASK;
3873 property = drm_property_create(dev, flags, name, num_values);
3876 for (i = 0; i < num_props; i++) {
3877 if (!(supported_bits & (1ULL << props[i].type)))
3880 if (WARN_ON(index >= num_values)) {
3881 drm_property_destroy(dev, property);
3885 ret = drm_property_add_enum(property, index++,
3889 drm_property_destroy(dev, property);
3896 EXPORT_SYMBOL(drm_property_create_bitmask);
3898 static struct drm_property *property_create_range(struct drm_device *dev,
3899 int flags, const char *name,
3900 uint64_t min, uint64_t max)
3902 struct drm_property *property;
3904 property = drm_property_create(dev, flags, name, 2);
3908 property->values[0] = min;
3909 property->values[1] = max;
3915 * drm_property_create_range - create a new unsigned ranged property type
3917 * @flags: flags specifying the property type
3918 * @name: name of the property
3919 * @min: minimum value of the property
3920 * @max: maximum value of the property
3922 * This creates a new generic drm property which can then be attached to a drm
3923 * object with drm_object_attach_property. The returned property object must be
3924 * freed with drm_property_destroy.
3926 * Userspace is allowed to set any unsigned integer value in the (min, max)
3930 * A pointer to the newly created property on success, NULL on failure.
3932 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3934 uint64_t min, uint64_t max)
3936 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3939 EXPORT_SYMBOL(drm_property_create_range);
3942 * drm_property_create_signed_range - create a new signed ranged property type
3944 * @flags: flags specifying the property type
3945 * @name: name of the property
3946 * @min: minimum value of the property
3947 * @max: maximum value of the property
3949 * This creates a new generic drm property which can then be attached to a drm
3950 * object with drm_object_attach_property. The returned property object must be
3951 * freed with drm_property_destroy.
3953 * Userspace is allowed to set any signed integer value in the (min, max)
3957 * A pointer to the newly created property on success, NULL on failure.
3959 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3960 int flags, const char *name,
3961 int64_t min, int64_t max)
3963 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3964 name, I642U64(min), I642U64(max));
3966 EXPORT_SYMBOL(drm_property_create_signed_range);
3969 * drm_property_create_object - create a new object property type
3971 * @flags: flags specifying the property type
3972 * @name: name of the property
3973 * @type: object type from DRM_MODE_OBJECT_* defines
3975 * This creates a new generic drm property which can then be attached to a drm
3976 * object with drm_object_attach_property. The returned property object must be
3977 * freed with drm_property_destroy.
3979 * Userspace is only allowed to set this to any property value of the given
3980 * @type. Only useful for atomic properties, which is enforced.
3983 * A pointer to the newly created property on success, NULL on failure.
3985 struct drm_property *drm_property_create_object(struct drm_device *dev,
3986 int flags, const char *name, uint32_t type)
3988 struct drm_property *property;
3990 flags |= DRM_MODE_PROP_OBJECT;
3992 if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
3995 property = drm_property_create(dev, flags, name, 1);
3999 property->values[0] = type;
4003 EXPORT_SYMBOL(drm_property_create_object);
4006 * drm_property_create_bool - create a new boolean property type
4008 * @flags: flags specifying the property type
4009 * @name: name of the property
4011 * This creates a new generic drm property which can then be attached to a drm
4012 * object with drm_object_attach_property. The returned property object must be
4013 * freed with drm_property_destroy.
4015 * This is implemented as a ranged property with only {0, 1} as valid values.
4018 * A pointer to the newly created property on success, NULL on failure.
4020 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
4023 return drm_property_create_range(dev, flags, name, 0, 1);
4025 EXPORT_SYMBOL(drm_property_create_bool);
4028 * drm_property_add_enum - add a possible value to an enumeration property
4029 * @property: enumeration property to change
4030 * @index: index of the new enumeration
4031 * @value: value of the new enumeration
4032 * @name: symbolic name of the new enumeration
4034 * This functions adds enumerations to a property.
4036 * It's use is deprecated, drivers should use one of the more specific helpers
4037 * to directly create the property with all enumerations already attached.
4040 * Zero on success, error code on failure.
4042 int drm_property_add_enum(struct drm_property *property, int index,
4043 uint64_t value, const char *name)
4045 struct drm_property_enum *prop_enum;
4047 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4048 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
4052 * Bitmask enum properties have the additional constraint of values
4055 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
4059 if (!list_empty(&property->enum_list)) {
4060 list_for_each_entry(prop_enum, &property->enum_list, head) {
4061 if (prop_enum->value == value) {
4062 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4063 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4069 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
4073 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4074 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4075 prop_enum->value = value;
4077 property->values[index] = value;
4078 list_add_tail(&prop_enum->head, &property->enum_list);
4081 EXPORT_SYMBOL(drm_property_add_enum);
4084 * drm_property_destroy - destroy a drm property
4086 * @property: property to destry
4088 * This function frees a property including any attached resources like
4089 * enumeration values.
4091 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
4093 struct drm_property_enum *prop_enum, *pt;
4095 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
4096 list_del(&prop_enum->head);
4100 if (property->num_values)
4101 kfree(property->values);
4102 drm_mode_object_put(dev, &property->base);
4103 list_del(&property->head);
4106 EXPORT_SYMBOL(drm_property_destroy);
4109 * drm_object_attach_property - attach a property to a modeset object
4110 * @obj: drm modeset object
4111 * @property: property to attach
4112 * @init_val: initial value of the property
4114 * This attaches the given property to the modeset object with the given initial
4115 * value. Currently this function cannot fail since the properties are stored in
4116 * a statically sized array.
4118 void drm_object_attach_property(struct drm_mode_object *obj,
4119 struct drm_property *property,
4122 int count = obj->properties->count;
4124 if (count == DRM_OBJECT_MAX_PROPERTY) {
4125 WARN(1, "Failed to attach object property (type: 0x%x). Please "
4126 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
4127 "you see this message on the same object type.\n",
4132 obj->properties->properties[count] = property;
4133 obj->properties->values[count] = init_val;
4134 obj->properties->count++;
4135 if (property->flags & DRM_MODE_PROP_ATOMIC)
4136 obj->properties->atomic_count++;
4138 EXPORT_SYMBOL(drm_object_attach_property);
4141 * drm_object_property_set_value - set the value of a property
4142 * @obj: drm mode object to set property value for
4143 * @property: property to set
4144 * @val: value the property should be set to
4146 * This functions sets a given property on a given object. This function only
4147 * changes the software state of the property, it does not call into the
4148 * driver's ->set_property callback.
4151 * Zero on success, error code on failure.
4153 int drm_object_property_set_value(struct drm_mode_object *obj,
4154 struct drm_property *property, uint64_t val)
4158 for (i = 0; i < obj->properties->count; i++) {
4159 if (obj->properties->properties[i] == property) {
4160 obj->properties->values[i] = val;
4167 EXPORT_SYMBOL(drm_object_property_set_value);
4170 * drm_object_property_get_value - retrieve the value of a property
4171 * @obj: drm mode object to get property value from
4172 * @property: property to retrieve
4173 * @val: storage for the property value
4175 * This function retrieves the softare state of the given property for the given
4176 * property. Since there is no driver callback to retrieve the current property
4177 * value this might be out of sync with the hardware, depending upon the driver
4181 * Zero on success, error code on failure.
4183 int drm_object_property_get_value(struct drm_mode_object *obj,
4184 struct drm_property *property, uint64_t *val)
4188 /* read-only properties bypass atomic mechanism and still store
4189 * their value in obj->properties->values[].. mostly to avoid
4190 * having to deal w/ EDID and similar props in atomic paths:
4192 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
4193 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
4194 return drm_atomic_get_property(obj, property, val);
4196 for (i = 0; i < obj->properties->count; i++) {
4197 if (obj->properties->properties[i] == property) {
4198 *val = obj->properties->values[i];
4205 EXPORT_SYMBOL(drm_object_property_get_value);
4208 * drm_mode_getproperty_ioctl - get the property metadata
4211 * @file_priv: DRM file info
4213 * This function retrieves the metadata for a given property, like the different
4214 * possible values for an enum property or the limits for a range property.
4216 * Blob properties are special
4218 * Called by the user via ioctl.
4221 * Zero on success, negative errno on failure.
4223 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4224 void *data, struct drm_file *file_priv)
4226 struct drm_mode_get_property *out_resp = data;
4227 struct drm_property *property;
4229 int value_count = 0;
4232 struct drm_property_enum *prop_enum;
4233 struct drm_mode_property_enum __user *enum_ptr;
4234 uint64_t __user *values_ptr;
4236 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4239 drm_modeset_lock_all(dev);
4240 property = drm_property_find(dev, out_resp->prop_id);
4246 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4247 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4248 list_for_each_entry(prop_enum, &property->enum_list, head)
4252 value_count = property->num_values;
4254 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4255 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4256 out_resp->flags = property->flags;
4258 if ((out_resp->count_values >= value_count) && value_count) {
4259 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4260 for (i = 0; i < value_count; i++) {
4261 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4267 out_resp->count_values = value_count;
4269 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4270 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4271 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4273 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4274 list_for_each_entry(prop_enum, &property->enum_list, head) {
4276 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4281 if (copy_to_user(&enum_ptr[copied].name,
4282 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4289 out_resp->count_enum_blobs = enum_count;
4293 * NOTE: The idea seems to have been to use this to read all the blob
4294 * property values. But nothing ever added them to the corresponding
4295 * list, userspace always used the special-purpose get_blob ioctl to
4296 * read the value for a blob property. It also doesn't make a lot of
4297 * sense to return values here when everything else is just metadata for
4298 * the property itself.
4300 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4301 out_resp->count_enum_blobs = 0;
4303 drm_modeset_unlock_all(dev);
4308 * drm_property_create_blob - Create new blob property
4310 * Creates a new blob property for a specified DRM device, optionally
4313 * @dev: DRM device to create property for
4314 * @length: Length to allocate for blob data
4315 * @data: If specified, copies data into blob
4318 * New blob property with a single reference on success, or an ERR_PTR
4321 struct drm_property_blob *
4322 drm_property_create_blob(struct drm_device *dev, size_t length,
4325 struct drm_property_blob *blob;
4328 if (!length || length > ULONG_MAX - sizeof(struct drm_property_blob))
4329 return ERR_PTR(-EINVAL);
4331 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4333 return ERR_PTR(-ENOMEM);
4335 /* This must be explicitly initialised, so we can safely call list_del
4336 * on it in the removal handler, even if it isn't in a file list. */
4337 INIT_LIST_HEAD(&blob->head_file);
4338 blob->length = length;
4342 memcpy(blob->data, data, length);
4344 mutex_lock(&dev->mode_config.blob_lock);
4346 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4349 mutex_unlock(&dev->mode_config.blob_lock);
4350 return ERR_PTR(-EINVAL);
4353 kref_init(&blob->refcount);
4355 list_add_tail(&blob->head_global,
4356 &dev->mode_config.property_blob_list);
4358 mutex_unlock(&dev->mode_config.blob_lock);
4362 EXPORT_SYMBOL(drm_property_create_blob);
4365 * drm_property_free_blob - Blob property destructor
4367 * Internal free function for blob properties; must not be used directly.
4371 static void drm_property_free_blob(struct kref *kref)
4373 struct drm_property_blob *blob =
4374 container_of(kref, struct drm_property_blob, refcount);
4376 WARN_ON(!mutex_is_locked(&blob->dev->mode_config.blob_lock));
4378 list_del(&blob->head_global);
4379 list_del(&blob->head_file);
4380 drm_mode_object_put(blob->dev, &blob->base);
4386 * drm_property_unreference_blob - Unreference a blob property
4388 * Drop a reference on a blob property. May free the object.
4390 * @blob: Pointer to blob property
4392 void drm_property_unreference_blob(struct drm_property_blob *blob)
4394 struct drm_device *dev;
4401 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4403 if (kref_put_mutex(&blob->refcount, drm_property_free_blob,
4404 &dev->mode_config.blob_lock))
4405 mutex_unlock(&dev->mode_config.blob_lock);
4407 might_lock(&dev->mode_config.blob_lock);
4409 EXPORT_SYMBOL(drm_property_unreference_blob);
4412 * drm_property_unreference_blob_locked - Unreference a blob property with blob_lock held
4414 * Drop a reference on a blob property. May free the object. This must be
4415 * called with blob_lock held.
4417 * @blob: Pointer to blob property
4419 static void drm_property_unreference_blob_locked(struct drm_property_blob *blob)
4424 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4426 kref_put(&blob->refcount, drm_property_free_blob);
4430 * drm_property_destroy_user_blobs - destroy all blobs created by this client
4432 * @file_priv: destroy all blobs owned by this file handle
4434 void drm_property_destroy_user_blobs(struct drm_device *dev,
4435 struct drm_file *file_priv)
4437 struct drm_property_blob *blob, *bt;
4439 mutex_lock(&dev->mode_config.blob_lock);
4441 list_for_each_entry_safe(blob, bt, &file_priv->blobs, head_file) {
4442 list_del_init(&blob->head_file);
4443 drm_property_unreference_blob_locked(blob);
4446 mutex_unlock(&dev->mode_config.blob_lock);
4450 * drm_property_reference_blob - Take a reference on an existing property
4452 * Take a new reference on an existing blob property.
4454 * @blob: Pointer to blob property
4456 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob)
4458 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4459 kref_get(&blob->refcount);
4462 EXPORT_SYMBOL(drm_property_reference_blob);
4465 * Like drm_property_lookup_blob, but does not return an additional reference.
4466 * Must be called with blob_lock held.
4468 static struct drm_property_blob *__drm_property_lookup_blob(struct drm_device *dev,
4471 struct drm_mode_object *obj = NULL;
4472 struct drm_property_blob *blob;
4474 WARN_ON(!mutex_is_locked(&dev->mode_config.blob_lock));
4476 mutex_lock(&dev->mode_config.idr_mutex);
4477 obj = idr_find(&dev->mode_config.crtc_idr, id);
4478 if (!obj || (obj->type != DRM_MODE_OBJECT_BLOB) || (obj->id != id))
4481 blob = obj_to_blob(obj);
4482 mutex_unlock(&dev->mode_config.idr_mutex);
4488 * drm_property_lookup_blob - look up a blob property and take a reference
4490 * @id: id of the blob property
4492 * If successful, this takes an additional reference to the blob property.
4493 * callers need to make sure to eventually unreference the returned property
4494 * again, using @drm_property_unreference_blob.
4496 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
4499 struct drm_property_blob *blob;
4501 mutex_lock(&dev->mode_config.blob_lock);
4502 blob = __drm_property_lookup_blob(dev, id);
4504 if (!kref_get_unless_zero(&blob->refcount))
4507 mutex_unlock(&dev->mode_config.blob_lock);
4511 EXPORT_SYMBOL(drm_property_lookup_blob);
4514 * drm_property_replace_global_blob - atomically replace existing blob property
4516 * @replace: location of blob property pointer to be replaced
4517 * @length: length of data for new blob, or 0 for no data
4518 * @data: content for new blob, or NULL for no data
4519 * @obj_holds_id: optional object for property holding blob ID
4520 * @prop_holds_id: optional property holding blob ID
4521 * @return 0 on success or error on failure
4523 * This function will atomically replace a global property in the blob list,
4524 * optionally updating a property which holds the ID of that property. It is
4525 * guaranteed to be atomic: no caller will be allowed to see intermediate
4526 * results, and either the entire operation will succeed and clean up the
4527 * previous property, or it will fail and the state will be unchanged.
4529 * If length is 0 or data is NULL, no new blob will be created, and the holding
4530 * property, if specified, will be set to 0.
4532 * Access to the replace pointer is assumed to be protected by the caller, e.g.
4533 * by holding the relevant modesetting object lock for its parent.
4535 * For example, a drm_connector has a 'PATH' property, which contains the ID
4536 * of a blob property with the value of the MST path information. Calling this
4537 * function with replace pointing to the connector's path_blob_ptr, length and
4538 * data set for the new path information, obj_holds_id set to the connector's
4539 * base object, and prop_holds_id set to the path property name, will perform
4540 * a completely atomic update. The access to path_blob_ptr is protected by the
4541 * caller holding a lock on the connector.
4543 static int drm_property_replace_global_blob(struct drm_device *dev,
4544 struct drm_property_blob **replace,
4547 struct drm_mode_object *obj_holds_id,
4548 struct drm_property *prop_holds_id)
4550 struct drm_property_blob *new_blob = NULL;
4551 struct drm_property_blob *old_blob = NULL;
4554 WARN_ON(replace == NULL);
4556 old_blob = *replace;
4558 if (length && data) {
4559 new_blob = drm_property_create_blob(dev, length, data);
4560 if (IS_ERR(new_blob))
4561 return PTR_ERR(new_blob);
4564 /* This does not need to be synchronised with blob_lock, as the
4565 * get_properties ioctl locks all modesetting objects, and
4566 * obj_holds_id must be locked before calling here, so we cannot
4567 * have its value out of sync with the list membership modified
4568 * below under blob_lock. */
4570 ret = drm_object_property_set_value(obj_holds_id,
4573 new_blob->base.id : 0);
4578 drm_property_unreference_blob(old_blob);
4579 *replace = new_blob;
4584 drm_property_unreference_blob(new_blob);
4589 * drm_mode_getblob_ioctl - get the contents of a blob property value
4592 * @file_priv: DRM file info
4594 * This function retrieves the contents of a blob property. The value stored in
4595 * an object's blob property is just a normal modeset object id.
4597 * Called by the user via ioctl.
4600 * Zero on success, negative errno on failure.
4602 int drm_mode_getblob_ioctl(struct drm_device *dev,
4603 void *data, struct drm_file *file_priv)
4605 struct drm_mode_get_blob *out_resp = data;
4606 struct drm_property_blob *blob;
4608 void __user *blob_ptr;
4610 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4613 drm_modeset_lock_all(dev);
4614 mutex_lock(&dev->mode_config.blob_lock);
4615 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4621 if (out_resp->length == blob->length) {
4622 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4623 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4628 out_resp->length = blob->length;
4631 mutex_unlock(&dev->mode_config.blob_lock);
4632 drm_modeset_unlock_all(dev);
4637 * drm_mode_createblob_ioctl - create a new blob property
4640 * @file_priv: DRM file info
4642 * This function creates a new blob property with user-defined values. In order
4643 * to give us sensible validation and checking when creating, rather than at
4644 * every potential use, we also require a type to be provided upfront.
4646 * Called by the user via ioctl.
4649 * Zero on success, negative errno on failure.
4651 int drm_mode_createblob_ioctl(struct drm_device *dev,
4652 void *data, struct drm_file *file_priv)
4654 struct drm_mode_create_blob *out_resp = data;
4655 struct drm_property_blob *blob;
4656 void __user *blob_ptr;
4659 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4662 blob = drm_property_create_blob(dev, out_resp->length, NULL);
4664 return PTR_ERR(blob);
4666 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4667 if (copy_from_user(blob->data, blob_ptr, out_resp->length)) {
4672 /* Dropping the lock between create_blob and our access here is safe
4673 * as only the same file_priv can remove the blob; at this point, it is
4674 * not associated with any file_priv. */
4675 mutex_lock(&dev->mode_config.blob_lock);
4676 out_resp->blob_id = blob->base.id;
4677 list_add_tail(&blob->head_file, &file_priv->blobs);
4678 mutex_unlock(&dev->mode_config.blob_lock);
4683 drm_property_unreference_blob(blob);
4688 * drm_mode_destroyblob_ioctl - destroy a user blob property
4691 * @file_priv: DRM file info
4693 * Destroy an existing user-defined blob property.
4695 * Called by the user via ioctl.
4698 * Zero on success, negative errno on failure.
4700 int drm_mode_destroyblob_ioctl(struct drm_device *dev,
4701 void *data, struct drm_file *file_priv)
4703 struct drm_mode_destroy_blob *out_resp = data;
4704 struct drm_property_blob *blob = NULL, *bt;
4708 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4711 mutex_lock(&dev->mode_config.blob_lock);
4712 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4718 /* Ensure the property was actually created by this user. */
4719 list_for_each_entry(bt, &file_priv->blobs, head_file) {
4731 /* We must drop head_file here, because we may not be the last
4732 * reference on the blob. */
4733 list_del_init(&blob->head_file);
4734 drm_property_unreference_blob_locked(blob);
4735 mutex_unlock(&dev->mode_config.blob_lock);
4740 mutex_unlock(&dev->mode_config.blob_lock);
4745 * drm_mode_connector_set_path_property - set tile property on connector
4746 * @connector: connector to set property on.
4747 * @path: path to use for property; must not be NULL.
4749 * This creates a property to expose to userspace to specify a
4750 * connector path. This is mainly used for DisplayPort MST where
4751 * connectors have a topology and we want to allow userspace to give
4752 * them more meaningful names.
4755 * Zero on success, negative errno on failure.
4757 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4760 struct drm_device *dev = connector->dev;
4763 ret = drm_property_replace_global_blob(dev,
4764 &connector->path_blob_ptr,
4768 dev->mode_config.path_property);
4771 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4774 * drm_mode_connector_set_tile_property - set tile property on connector
4775 * @connector: connector to set property on.
4777 * This looks up the tile information for a connector, and creates a
4778 * property for userspace to parse if it exists. The property is of
4779 * the form of 8 integers using ':' as a separator.
4782 * Zero on success, errno on failure.
4784 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4786 struct drm_device *dev = connector->dev;
4790 if (!connector->has_tile) {
4791 ret = drm_property_replace_global_blob(dev,
4792 &connector->tile_blob_ptr,
4796 dev->mode_config.tile_property);
4800 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4801 connector->tile_group->id, connector->tile_is_single_monitor,
4802 connector->num_h_tile, connector->num_v_tile,
4803 connector->tile_h_loc, connector->tile_v_loc,
4804 connector->tile_h_size, connector->tile_v_size);
4806 ret = drm_property_replace_global_blob(dev,
4807 &connector->tile_blob_ptr,
4811 dev->mode_config.tile_property);
4814 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4817 * drm_mode_connector_update_edid_property - update the edid property of a connector
4818 * @connector: drm connector
4819 * @edid: new value of the edid property
4821 * This function creates a new blob modeset object and assigns its id to the
4822 * connector's edid property.
4825 * Zero on success, negative errno on failure.
4827 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4828 const struct edid *edid)
4830 struct drm_device *dev = connector->dev;
4834 /* ignore requests to set edid when overridden */
4835 if (connector->override_edid)
4839 size = EDID_LENGTH * (1 + edid->extensions);
4841 ret = drm_property_replace_global_blob(dev,
4842 &connector->edid_blob_ptr,
4846 dev->mode_config.edid_property);
4849 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4851 /* Some properties could refer to dynamic refcnt'd objects, or things that
4852 * need special locking to handle lifetime issues (ie. to ensure the prop
4853 * value doesn't become invalid part way through the property update due to
4854 * race). The value returned by reference via 'obj' should be passed back
4855 * to drm_property_change_valid_put() after the property is set (and the
4856 * object to which the property is attached has a chance to take it's own
4859 bool drm_property_change_valid_get(struct drm_property *property,
4860 uint64_t value, struct drm_mode_object **ref)
4864 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4869 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4870 if (value < property->values[0] || value > property->values[1])
4873 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4874 int64_t svalue = U642I64(value);
4876 if (svalue < U642I64(property->values[0]) ||
4877 svalue > U642I64(property->values[1]))
4880 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4881 uint64_t valid_mask = 0;
4883 for (i = 0; i < property->num_values; i++)
4884 valid_mask |= (1ULL << property->values[i]);
4885 return !(value & ~valid_mask);
4886 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4887 struct drm_property_blob *blob;
4892 blob = drm_property_lookup_blob(property->dev, value);
4899 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4900 /* a zero value for an object property translates to null: */
4904 /* handle refcnt'd objects specially: */
4905 if (property->values[0] == DRM_MODE_OBJECT_FB) {
4906 struct drm_framebuffer *fb;
4907 fb = drm_framebuffer_lookup(property->dev, value);
4915 return _object_find(property->dev, value, property->values[0]) != NULL;
4919 for (i = 0; i < property->num_values; i++)
4920 if (property->values[i] == value)
4925 void drm_property_change_valid_put(struct drm_property *property,
4926 struct drm_mode_object *ref)
4931 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4932 if (property->values[0] == DRM_MODE_OBJECT_FB)
4933 drm_framebuffer_unreference(obj_to_fb(ref));
4934 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4935 drm_property_unreference_blob(obj_to_blob(ref));
4939 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4942 * @file_priv: DRM file info
4944 * This function sets the current value for a connectors's property. It also
4945 * calls into a driver's ->set_property callback to update the hardware state
4947 * Called by the user via ioctl.
4950 * Zero on success, negative errno on failure.
4952 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4953 void *data, struct drm_file *file_priv)
4955 struct drm_mode_connector_set_property *conn_set_prop = data;
4956 struct drm_mode_obj_set_property obj_set_prop = {
4957 .value = conn_set_prop->value,
4958 .prop_id = conn_set_prop->prop_id,
4959 .obj_id = conn_set_prop->connector_id,
4960 .obj_type = DRM_MODE_OBJECT_CONNECTOR
4963 /* It does all the locking and checking we need */
4964 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4967 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4968 struct drm_property *property,
4972 struct drm_connector *connector = obj_to_connector(obj);
4974 /* Do DPMS ourselves */
4975 if (property == connector->dev->mode_config.dpms_property) {
4977 if (connector->funcs->dpms)
4978 ret = (*connector->funcs->dpms)(connector, (int)value);
4979 } else if (connector->funcs->set_property)
4980 ret = connector->funcs->set_property(connector, property, value);
4982 /* store the property value if successful */
4984 drm_object_property_set_value(&connector->base, property, value);
4988 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4989 struct drm_property *property,
4993 struct drm_crtc *crtc = obj_to_crtc(obj);
4995 if (crtc->funcs->set_property)
4996 ret = crtc->funcs->set_property(crtc, property, value);
4998 drm_object_property_set_value(obj, property, value);
5004 * drm_mode_plane_set_obj_prop - set the value of a property
5005 * @plane: drm plane object to set property value for
5006 * @property: property to set
5007 * @value: value the property should be set to
5009 * This functions sets a given property on a given plane object. This function
5010 * calls the driver's ->set_property callback and changes the software state of
5011 * the property if the callback succeeds.
5014 * Zero on success, error code on failure.
5016 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
5017 struct drm_property *property,
5021 struct drm_mode_object *obj = &plane->base;
5023 if (plane->funcs->set_property)
5024 ret = plane->funcs->set_property(plane, property, value);
5026 drm_object_property_set_value(obj, property, value);
5030 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
5033 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
5036 * @file_priv: DRM file info
5038 * This function retrieves the current value for an object's property. Compared
5039 * to the connector specific ioctl this one is extended to also work on crtc and
5042 * Called by the user via ioctl.
5045 * Zero on success, negative errno on failure.
5047 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
5048 struct drm_file *file_priv)
5050 struct drm_mode_obj_get_properties *arg = data;
5051 struct drm_mode_object *obj;
5054 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5057 drm_modeset_lock_all(dev);
5059 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5064 if (!obj->properties) {
5069 ret = get_properties(obj, file_priv->atomic,
5070 (uint32_t __user *)(unsigned long)(arg->props_ptr),
5071 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
5075 drm_modeset_unlock_all(dev);
5080 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
5083 * @file_priv: DRM file info
5085 * This function sets the current value for an object's property. It also calls
5086 * into a driver's ->set_property callback to update the hardware state.
5087 * Compared to the connector specific ioctl this one is extended to also work on
5088 * crtc and plane objects.
5090 * Called by the user via ioctl.
5093 * Zero on success, negative errno on failure.
5095 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
5096 struct drm_file *file_priv)
5098 struct drm_mode_obj_set_property *arg = data;
5099 struct drm_mode_object *arg_obj;
5100 struct drm_mode_object *prop_obj;
5101 struct drm_property *property;
5102 int i, ret = -EINVAL;
5103 struct drm_mode_object *ref;
5105 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5108 drm_modeset_lock_all(dev);
5110 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5115 if (!arg_obj->properties)
5118 for (i = 0; i < arg_obj->properties->count; i++)
5119 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
5122 if (i == arg_obj->properties->count)
5125 prop_obj = drm_mode_object_find(dev, arg->prop_id,
5126 DRM_MODE_OBJECT_PROPERTY);
5131 property = obj_to_property(prop_obj);
5133 if (!drm_property_change_valid_get(property, arg->value, &ref))
5136 switch (arg_obj->type) {
5137 case DRM_MODE_OBJECT_CONNECTOR:
5138 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
5141 case DRM_MODE_OBJECT_CRTC:
5142 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
5144 case DRM_MODE_OBJECT_PLANE:
5145 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
5146 property, arg->value);
5150 drm_property_change_valid_put(property, ref);
5153 drm_modeset_unlock_all(dev);
5158 * drm_mode_connector_attach_encoder - attach a connector to an encoder
5159 * @connector: connector to attach
5160 * @encoder: encoder to attach @connector to
5162 * This function links up a connector to an encoder. Note that the routing
5163 * restrictions between encoders and crtcs are exposed to userspace through the
5164 * possible_clones and possible_crtcs bitmasks.
5167 * Zero on success, negative errno on failure.
5169 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
5170 struct drm_encoder *encoder)
5175 * In the past, drivers have attempted to model the static association
5176 * of connector to encoder in simple connector/encoder devices using a
5177 * direct assignment of connector->encoder = encoder. This connection
5178 * is a logical one and the responsibility of the core, so drivers are
5179 * expected not to mess with this.
5181 * Note that the error return should've been enough here, but a large
5182 * majority of drivers ignores the return value, so add in a big WARN
5183 * to get people's attention.
5185 if (WARN_ON(connector->encoder))
5188 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
5189 if (connector->encoder_ids[i] == 0) {
5190 connector->encoder_ids[i] = encoder->base.id;
5196 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
5199 * drm_mode_crtc_set_gamma_size - set the gamma table size
5200 * @crtc: CRTC to set the gamma table size for
5201 * @gamma_size: size of the gamma table
5203 * Drivers which support gamma tables should set this to the supported gamma
5204 * table size when initializing the CRTC. Currently the drm core only supports a
5205 * fixed gamma table size.
5208 * Zero on success, negative errno on failure.
5210 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
5213 crtc->gamma_size = gamma_size;
5215 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
5217 if (!crtc->gamma_store) {
5218 crtc->gamma_size = 0;
5224 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
5227 * drm_mode_gamma_set_ioctl - set the gamma table
5230 * @file_priv: DRM file info
5232 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
5233 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
5235 * Called by the user via ioctl.
5238 * Zero on success, negative errno on failure.
5240 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
5241 void *data, struct drm_file *file_priv)
5243 struct drm_mode_crtc_lut *crtc_lut = data;
5244 struct drm_crtc *crtc;
5245 void *r_base, *g_base, *b_base;
5249 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5252 drm_modeset_lock_all(dev);
5253 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5259 if (crtc->funcs->gamma_set == NULL) {
5264 /* memcpy into gamma store */
5265 if (crtc_lut->gamma_size != crtc->gamma_size) {
5270 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5271 r_base = crtc->gamma_store;
5272 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
5277 g_base = r_base + size;
5278 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
5283 b_base = g_base + size;
5284 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
5289 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
5292 drm_modeset_unlock_all(dev);
5298 * drm_mode_gamma_get_ioctl - get the gamma table
5301 * @file_priv: DRM file info
5303 * Copy the current gamma table into the storage provided. This also provides
5304 * the gamma table size the driver expects, which can be used to size the
5305 * allocated storage.
5307 * Called by the user via ioctl.
5310 * Zero on success, negative errno on failure.
5312 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
5313 void *data, struct drm_file *file_priv)
5315 struct drm_mode_crtc_lut *crtc_lut = data;
5316 struct drm_crtc *crtc;
5317 void *r_base, *g_base, *b_base;
5321 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5324 drm_modeset_lock_all(dev);
5325 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5331 /* memcpy into gamma store */
5332 if (crtc_lut->gamma_size != crtc->gamma_size) {
5337 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5338 r_base = crtc->gamma_store;
5339 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
5344 g_base = r_base + size;
5345 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
5350 b_base = g_base + size;
5351 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
5356 drm_modeset_unlock_all(dev);
5361 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
5364 * @file_priv: DRM file info
5366 * This schedules an asynchronous update on a given CRTC, called page flip.
5367 * Optionally a drm event is generated to signal the completion of the event.
5368 * Generic drivers cannot assume that a pageflip with changed framebuffer
5369 * properties (including driver specific metadata like tiling layout) will work,
5370 * but some drivers support e.g. pixel format changes through the pageflip
5373 * Called by the user via ioctl.
5376 * Zero on success, negative errno on failure.
5378 int drm_mode_page_flip_ioctl(struct drm_device *dev,
5379 void *data, struct drm_file *file_priv)
5381 struct drm_mode_crtc_page_flip *page_flip = data;
5382 struct drm_crtc *crtc;
5383 struct drm_framebuffer *fb = NULL;
5384 struct drm_pending_vblank_event *e = NULL;
5385 unsigned long flags;
5388 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5391 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
5392 page_flip->reserved != 0)
5395 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
5398 crtc = drm_crtc_find(dev, page_flip->crtc_id);
5402 drm_modeset_lock_crtc(crtc, crtc->primary);
5403 if (crtc->primary->fb == NULL) {
5404 /* The framebuffer is currently unbound, presumably
5405 * due to a hotplug event, that userspace has not
5412 if (crtc->funcs->page_flip == NULL)
5415 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
5422 const struct drm_plane_state *state = crtc->primary->state;
5424 ret = check_src_coords(state->src_x, state->src_y,
5425 state->src_w, state->src_h, fb);
5427 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
5432 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
5433 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
5438 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5440 spin_lock_irqsave(&dev->event_lock, flags);
5441 if (file_priv->event_space < sizeof(e->event)) {
5442 spin_unlock_irqrestore(&dev->event_lock, flags);
5445 file_priv->event_space -= sizeof(e->event);
5446 spin_unlock_irqrestore(&dev->event_lock, flags);
5448 e = kzalloc(sizeof(*e), GFP_KERNEL);
5450 spin_lock_irqsave(&dev->event_lock, flags);
5451 file_priv->event_space += sizeof(e->event);
5452 spin_unlock_irqrestore(&dev->event_lock, flags);
5456 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
5457 e->event.base.length = sizeof(e->event);
5458 e->event.user_data = page_flip->user_data;
5459 e->base.event = &e->event.base;
5460 e->base.file_priv = file_priv;
5462 (void (*) (struct drm_pending_event *)) kfree;
5465 crtc->primary->old_fb = crtc->primary->fb;
5466 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
5468 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5469 spin_lock_irqsave(&dev->event_lock, flags);
5470 file_priv->event_space += sizeof(e->event);
5471 spin_unlock_irqrestore(&dev->event_lock, flags);
5474 /* Keep the old fb, don't unref it. */
5475 crtc->primary->old_fb = NULL;
5477 crtc->primary->fb = fb;
5478 /* Unref only the old framebuffer. */
5484 drm_framebuffer_unreference(fb);
5485 if (crtc->primary->old_fb)
5486 drm_framebuffer_unreference(crtc->primary->old_fb);
5487 crtc->primary->old_fb = NULL;
5488 drm_modeset_unlock_crtc(crtc);
5494 * drm_mode_config_reset - call ->reset callbacks
5497 * This functions calls all the crtc's, encoder's and connector's ->reset
5498 * callback. Drivers can use this in e.g. their driver load or resume code to
5499 * reset hardware and software state.
5501 void drm_mode_config_reset(struct drm_device *dev)
5503 struct drm_crtc *crtc;
5504 struct drm_plane *plane;
5505 struct drm_encoder *encoder;
5506 struct drm_connector *connector;
5508 drm_for_each_plane(plane, dev)
5509 if (plane->funcs->reset)
5510 plane->funcs->reset(plane);
5512 drm_for_each_crtc(crtc, dev)
5513 if (crtc->funcs->reset)
5514 crtc->funcs->reset(crtc);
5516 drm_for_each_encoder(encoder, dev)
5517 if (encoder->funcs->reset)
5518 encoder->funcs->reset(encoder);
5520 mutex_lock(&dev->mode_config.mutex);
5521 drm_for_each_connector(connector, dev)
5522 if (connector->funcs->reset)
5523 connector->funcs->reset(connector);
5524 mutex_unlock(&dev->mode_config.mutex);
5526 EXPORT_SYMBOL(drm_mode_config_reset);
5529 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
5532 * @file_priv: DRM file info
5534 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
5535 * TTM or something else entirely) and returns the resulting buffer handle. This
5536 * handle can then be wrapped up into a framebuffer modeset object.
5538 * Note that userspace is not allowed to use such objects for render
5539 * acceleration - drivers must create their own private ioctls for such a use
5542 * Called by the user via ioctl.
5545 * Zero on success, negative errno on failure.
5547 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
5548 void *data, struct drm_file *file_priv)
5550 struct drm_mode_create_dumb *args = data;
5551 u32 cpp, stride, size;
5553 if (!dev->driver->dumb_create)
5555 if (!args->width || !args->height || !args->bpp)
5558 /* overflow checks for 32bit size calculations */
5559 /* NOTE: DIV_ROUND_UP() can overflow */
5560 cpp = DIV_ROUND_UP(args->bpp, 8);
5561 if (!cpp || cpp > 0xffffffffU / args->width)
5563 stride = cpp * args->width;
5564 if (args->height > 0xffffffffU / stride)
5567 /* test for wrap-around */
5568 size = args->height * stride;
5569 if (PAGE_ALIGN(size) == 0)
5573 * handle, pitch and size are output parameters. Zero them out to
5574 * prevent drivers from accidentally using uninitialized data. Since
5575 * not all existing userspace is clearing these fields properly we
5576 * cannot reject IOCTL with garbage in them.
5582 return dev->driver->dumb_create(file_priv, dev, args);
5586 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5589 * @file_priv: DRM file info
5591 * Allocate an offset in the drm device node's address space to be able to
5592 * memory map a dumb buffer.
5594 * Called by the user via ioctl.
5597 * Zero on success, negative errno on failure.
5599 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5600 void *data, struct drm_file *file_priv)
5602 struct drm_mode_map_dumb *args = data;
5604 /* call driver ioctl to get mmap offset */
5605 if (!dev->driver->dumb_map_offset)
5608 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5612 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5615 * @file_priv: DRM file info
5617 * This destroys the userspace handle for the given dumb backing storage buffer.
5618 * Since buffer objects must be reference counted in the kernel a buffer object
5619 * won't be immediately freed if a framebuffer modeset object still uses it.
5621 * Called by the user via ioctl.
5624 * Zero on success, negative errno on failure.
5626 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5627 void *data, struct drm_file *file_priv)
5629 struct drm_mode_destroy_dumb *args = data;
5631 if (!dev->driver->dumb_destroy)
5634 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5638 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5639 * @format: pixel format (DRM_FORMAT_*)
5640 * @depth: storage for the depth value
5641 * @bpp: storage for the bpp value
5643 * This only supports RGB formats here for compat with code that doesn't use
5644 * pixel formats directly yet.
5646 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5651 case DRM_FORMAT_RGB332:
5652 case DRM_FORMAT_BGR233:
5656 case DRM_FORMAT_XRGB1555:
5657 case DRM_FORMAT_XBGR1555:
5658 case DRM_FORMAT_RGBX5551:
5659 case DRM_FORMAT_BGRX5551:
5660 case DRM_FORMAT_ARGB1555:
5661 case DRM_FORMAT_ABGR1555:
5662 case DRM_FORMAT_RGBA5551:
5663 case DRM_FORMAT_BGRA5551:
5667 case DRM_FORMAT_RGB565:
5668 case DRM_FORMAT_BGR565:
5672 case DRM_FORMAT_RGB888:
5673 case DRM_FORMAT_BGR888:
5677 case DRM_FORMAT_XRGB8888:
5678 case DRM_FORMAT_XBGR8888:
5679 case DRM_FORMAT_RGBX8888:
5680 case DRM_FORMAT_BGRX8888:
5684 case DRM_FORMAT_XRGB2101010:
5685 case DRM_FORMAT_XBGR2101010:
5686 case DRM_FORMAT_RGBX1010102:
5687 case DRM_FORMAT_BGRX1010102:
5688 case DRM_FORMAT_ARGB2101010:
5689 case DRM_FORMAT_ABGR2101010:
5690 case DRM_FORMAT_RGBA1010102:
5691 case DRM_FORMAT_BGRA1010102:
5695 case DRM_FORMAT_ARGB8888:
5696 case DRM_FORMAT_ABGR8888:
5697 case DRM_FORMAT_RGBA8888:
5698 case DRM_FORMAT_BGRA8888:
5703 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5704 drm_get_format_name(format));
5710 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5713 * drm_format_num_planes - get the number of planes for format
5714 * @format: pixel format (DRM_FORMAT_*)
5717 * The number of planes used by the specified pixel format.
5719 int drm_format_num_planes(uint32_t format)
5722 case DRM_FORMAT_YUV410:
5723 case DRM_FORMAT_YVU410:
5724 case DRM_FORMAT_YUV411:
5725 case DRM_FORMAT_YVU411:
5726 case DRM_FORMAT_YUV420:
5727 case DRM_FORMAT_YVU420:
5728 case DRM_FORMAT_YUV422:
5729 case DRM_FORMAT_YVU422:
5730 case DRM_FORMAT_YUV444:
5731 case DRM_FORMAT_YVU444:
5733 case DRM_FORMAT_NV12:
5734 case DRM_FORMAT_NV21:
5735 case DRM_FORMAT_NV16:
5736 case DRM_FORMAT_NV61:
5737 case DRM_FORMAT_NV24:
5738 case DRM_FORMAT_NV42:
5739 case DRM_FORMAT_NV12_10:
5740 case DRM_FORMAT_NV21_10:
5741 case DRM_FORMAT_NV16_10:
5742 case DRM_FORMAT_NV61_10:
5743 case DRM_FORMAT_NV24_10:
5744 case DRM_FORMAT_NV42_10:
5750 EXPORT_SYMBOL(drm_format_num_planes);
5753 * drm_format_plane_bpp - get the bpp for format
5754 * @format: pixel format (DRM_FORMAT_*)
5755 * @plane: plane index
5758 * The bpp for the specified plane.
5760 int drm_format_plane_bpp(uint32_t format, int plane)
5765 if (plane >= drm_format_num_planes(format))
5769 case DRM_FORMAT_YUYV:
5770 case DRM_FORMAT_YVYU:
5771 case DRM_FORMAT_UYVY:
5772 case DRM_FORMAT_VYUY:
5774 case DRM_FORMAT_NV12_10:
5775 case DRM_FORMAT_NV21_10:
5776 case DRM_FORMAT_NV16_10:
5777 case DRM_FORMAT_NV61_10:
5778 case DRM_FORMAT_NV24_10:
5779 case DRM_FORMAT_NV42_10:
5780 return plane ? 20 : 10;
5781 case DRM_FORMAT_NV12:
5782 case DRM_FORMAT_NV21:
5783 case DRM_FORMAT_NV16:
5784 case DRM_FORMAT_NV61:
5785 case DRM_FORMAT_NV24:
5786 case DRM_FORMAT_NV42:
5787 return plane ? 16 : 8;
5788 case DRM_FORMAT_YUV410:
5789 case DRM_FORMAT_YVU410:
5790 case DRM_FORMAT_YUV411:
5791 case DRM_FORMAT_YVU411:
5792 case DRM_FORMAT_YUV420:
5793 case DRM_FORMAT_YVU420:
5794 case DRM_FORMAT_YUV422:
5795 case DRM_FORMAT_YVU422:
5796 case DRM_FORMAT_YUV444:
5797 case DRM_FORMAT_YVU444:
5800 drm_fb_get_bpp_depth(format, &depth, &bpp);
5804 EXPORT_SYMBOL(drm_format_plane_bpp);
5807 * drm_format_plane_cpp - determine the bytes per pixel value
5808 * @format: pixel format (DRM_FORMAT_*)
5809 * @plane: plane index
5812 * The bytes per pixel value for the specified plane.
5814 int drm_format_plane_cpp(uint32_t format, int plane)
5816 return drm_format_plane_bpp(format, plane) >> 3;
5818 EXPORT_SYMBOL(drm_format_plane_cpp);
5821 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5822 * @format: pixel format (DRM_FORMAT_*)
5825 * The horizontal chroma subsampling factor for the
5826 * specified pixel format.
5828 int drm_format_horz_chroma_subsampling(uint32_t format)
5831 case DRM_FORMAT_YUV411:
5832 case DRM_FORMAT_YVU411:
5833 case DRM_FORMAT_YUV410:
5834 case DRM_FORMAT_YVU410:
5836 case DRM_FORMAT_YUYV:
5837 case DRM_FORMAT_YVYU:
5838 case DRM_FORMAT_UYVY:
5839 case DRM_FORMAT_VYUY:
5840 case DRM_FORMAT_NV12:
5841 case DRM_FORMAT_NV21:
5842 case DRM_FORMAT_NV16:
5843 case DRM_FORMAT_NV61:
5844 case DRM_FORMAT_NV12_10:
5845 case DRM_FORMAT_NV21_10:
5846 case DRM_FORMAT_NV16_10:
5847 case DRM_FORMAT_NV61_10:
5848 case DRM_FORMAT_YUV422:
5849 case DRM_FORMAT_YVU422:
5850 case DRM_FORMAT_YUV420:
5851 case DRM_FORMAT_YVU420:
5857 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5860 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5861 * @format: pixel format (DRM_FORMAT_*)
5864 * The vertical chroma subsampling factor for the
5865 * specified pixel format.
5867 int drm_format_vert_chroma_subsampling(uint32_t format)
5870 case DRM_FORMAT_YUV410:
5871 case DRM_FORMAT_YVU410:
5873 case DRM_FORMAT_YUV420:
5874 case DRM_FORMAT_YVU420:
5875 case DRM_FORMAT_NV12:
5876 case DRM_FORMAT_NV12_10:
5877 case DRM_FORMAT_NV21:
5878 case DRM_FORMAT_NV21_10:
5884 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5887 * drm_rotation_simplify() - Try to simplify the rotation
5888 * @rotation: Rotation to be simplified
5889 * @supported_rotations: Supported rotations
5891 * Attempt to simplify the rotation to a form that is supported.
5892 * Eg. if the hardware supports everything except DRM_REFLECT_X
5893 * one could call this function like this:
5895 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5896 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5897 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5899 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5900 * transforms the hardware supports, this function may not
5901 * be able to produce a supported transform, so the caller should
5902 * check the result afterwards.
5904 unsigned int drm_rotation_simplify(unsigned int rotation,
5905 unsigned int supported_rotations)
5907 if (rotation & ~supported_rotations) {
5908 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5909 rotation = (rotation & DRM_REFLECT_MASK) |
5910 BIT((ffs(rotation & DRM_ROTATE_MASK) + 1) % 4);
5915 EXPORT_SYMBOL(drm_rotation_simplify);
5918 * drm_mode_config_init - initialize DRM mode_configuration structure
5921 * Initialize @dev's mode_config structure, used for tracking the graphics
5922 * configuration of @dev.
5924 * Since this initializes the modeset locks, no locking is possible. Which is no
5925 * problem, since this should happen single threaded at init time. It is the
5926 * driver's problem to ensure this guarantee.
5929 void drm_mode_config_init(struct drm_device *dev)
5931 mutex_init(&dev->mode_config.mutex);
5932 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5933 mutex_init(&dev->mode_config.idr_mutex);
5934 mutex_init(&dev->mode_config.fb_lock);
5935 mutex_init(&dev->mode_config.blob_lock);
5936 INIT_LIST_HEAD(&dev->mode_config.fb_list);
5937 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5938 INIT_LIST_HEAD(&dev->mode_config.connector_list);
5939 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5940 INIT_LIST_HEAD(&dev->mode_config.property_list);
5941 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5942 INIT_LIST_HEAD(&dev->mode_config.plane_list);
5943 idr_init(&dev->mode_config.crtc_idr);
5944 idr_init(&dev->mode_config.tile_idr);
5946 drm_modeset_lock_all(dev);
5947 drm_mode_create_standard_properties(dev);
5948 drm_modeset_unlock_all(dev);
5950 /* Just to be sure */
5951 dev->mode_config.num_fb = 0;
5952 dev->mode_config.num_connector = 0;
5953 dev->mode_config.num_crtc = 0;
5954 dev->mode_config.num_encoder = 0;
5955 dev->mode_config.num_overlay_plane = 0;
5956 dev->mode_config.num_total_plane = 0;
5958 EXPORT_SYMBOL(drm_mode_config_init);
5961 * drm_mode_config_cleanup - free up DRM mode_config info
5964 * Free up all the connectors and CRTCs associated with this DRM device, then
5965 * free up the framebuffers and associated buffer objects.
5967 * Note that since this /should/ happen single-threaded at driver/device
5968 * teardown time, no locking is required. It's the driver's job to ensure that
5969 * this guarantee actually holds true.
5971 * FIXME: cleanup any dangling user buffer objects too
5973 void drm_mode_config_cleanup(struct drm_device *dev)
5975 struct drm_connector *connector, *ot;
5976 struct drm_crtc *crtc, *ct;
5977 struct drm_encoder *encoder, *enct;
5978 struct drm_framebuffer *fb, *fbt;
5979 struct drm_property *property, *pt;
5980 struct drm_property_blob *blob, *bt;
5981 struct drm_plane *plane, *plt;
5983 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5985 encoder->funcs->destroy(encoder);
5988 list_for_each_entry_safe(connector, ot,
5989 &dev->mode_config.connector_list, head) {
5990 connector->funcs->destroy(connector);
5993 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5995 drm_property_destroy(dev, property);
5998 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
6000 drm_property_unreference_blob(blob);
6004 * Single-threaded teardown context, so it's not required to grab the
6005 * fb_lock to protect against concurrent fb_list access. Contrary, it
6006 * would actually deadlock with the drm_framebuffer_cleanup function.
6008 * Also, if there are any framebuffers left, that's a driver leak now,
6009 * so politely WARN about this.
6011 WARN_ON(!list_empty(&dev->mode_config.fb_list));
6012 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
6013 drm_framebuffer_free(&fb->refcount);
6016 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
6018 plane->funcs->destroy(plane);
6021 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
6022 crtc->funcs->destroy(crtc);
6025 idr_destroy(&dev->mode_config.tile_idr);
6026 idr_destroy(&dev->mode_config.crtc_idr);
6027 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
6029 EXPORT_SYMBOL(drm_mode_config_cleanup);
6031 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
6032 unsigned int supported_rotations)
6034 static const struct drm_prop_enum_list props[] = {
6035 { DRM_ROTATE_0, "rotate-0" },
6036 { DRM_ROTATE_90, "rotate-90" },
6037 { DRM_ROTATE_180, "rotate-180" },
6038 { DRM_ROTATE_270, "rotate-270" },
6039 { DRM_REFLECT_X, "reflect-x" },
6040 { DRM_REFLECT_Y, "reflect-y" },
6043 return drm_property_create_bitmask(dev, 0, "rotation",
6044 props, ARRAY_SIZE(props),
6045 supported_rotations);
6047 EXPORT_SYMBOL(drm_mode_create_rotation_property);
6052 * Tile groups are used to represent tiled monitors with a unique
6053 * integer identifier. Tiled monitors using DisplayID v1.3 have
6054 * a unique 8-byte handle, we store this in a tile group, so we
6055 * have a common identifier for all tiles in a monitor group.
6057 static void drm_tile_group_free(struct kref *kref)
6059 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
6060 struct drm_device *dev = tg->dev;
6061 mutex_lock(&dev->mode_config.idr_mutex);
6062 idr_remove(&dev->mode_config.tile_idr, tg->id);
6063 mutex_unlock(&dev->mode_config.idr_mutex);
6068 * drm_mode_put_tile_group - drop a reference to a tile group.
6070 * @tg: tile group to drop reference to.
6072 * drop reference to tile group and free if 0.
6074 void drm_mode_put_tile_group(struct drm_device *dev,
6075 struct drm_tile_group *tg)
6077 kref_put(&tg->refcount, drm_tile_group_free);
6081 * drm_mode_get_tile_group - get a reference to an existing tile group
6083 * @topology: 8-bytes unique per monitor.
6085 * Use the unique bytes to get a reference to an existing tile group.
6088 * tile group or NULL if not found.
6090 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
6093 struct drm_tile_group *tg;
6095 mutex_lock(&dev->mode_config.idr_mutex);
6096 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
6097 if (!memcmp(tg->group_data, topology, 8)) {
6098 if (!kref_get_unless_zero(&tg->refcount))
6100 mutex_unlock(&dev->mode_config.idr_mutex);
6104 mutex_unlock(&dev->mode_config.idr_mutex);
6107 EXPORT_SYMBOL(drm_mode_get_tile_group);
6110 * drm_mode_create_tile_group - create a tile group from a displayid description
6112 * @topology: 8-bytes unique per monitor.
6114 * Create a tile group for the unique monitor, and get a unique
6115 * identifier for the tile group.
6118 * new tile group or error.
6120 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
6123 struct drm_tile_group *tg;
6126 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
6128 return ERR_PTR(-ENOMEM);
6130 kref_init(&tg->refcount);
6131 memcpy(tg->group_data, topology, 8);
6134 mutex_lock(&dev->mode_config.idr_mutex);
6135 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
6143 mutex_unlock(&dev->mode_config.idr_mutex);
6146 EXPORT_SYMBOL(drm_mode_create_tile_group);