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);
652 static int drm_crtc_register_all(struct drm_device *dev)
654 struct drm_crtc *crtc;
657 drm_for_each_crtc(crtc, dev) {
658 if (crtc->funcs->late_register)
659 ret = crtc->funcs->late_register(crtc);
667 static void drm_crtc_unregister_all(struct drm_device *dev)
669 struct drm_crtc *crtc;
671 drm_for_each_crtc(crtc, dev) {
672 if (crtc->funcs->early_unregister)
673 crtc->funcs->early_unregister(crtc);
678 * drm_crtc_init_with_planes - Initialise a new CRTC object with
679 * specified primary and cursor planes.
681 * @crtc: CRTC object to init
682 * @primary: Primary plane for CRTC
683 * @cursor: Cursor plane for CRTC
684 * @funcs: callbacks for the new CRTC
685 * @name: printf style format string for the CRTC name, or NULL for default name
687 * Inits a new object created as base part of a driver crtc object.
690 * Zero on success, error code on failure.
692 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
693 struct drm_plane *primary,
694 struct drm_plane *cursor,
695 const struct drm_crtc_funcs *funcs,
696 const char *name, ...)
698 struct drm_mode_config *config = &dev->mode_config;
701 WARN_ON(primary && primary->type != DRM_PLANE_TYPE_PRIMARY);
702 WARN_ON(cursor && cursor->type != DRM_PLANE_TYPE_CURSOR);
707 drm_modeset_lock_init(&crtc->mutex);
708 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
712 crtc->base.properties = &crtc->properties;
714 list_add_tail(&crtc->head, &config->crtc_list);
717 crtc->primary = primary;
718 crtc->cursor = cursor;
720 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
722 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
724 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
725 drm_object_attach_property(&crtc->base, config->prop_active, 0);
726 drm_object_attach_property(&crtc->base, config->prop_mode_id, 0);
731 EXPORT_SYMBOL(drm_crtc_init_with_planes);
734 * drm_crtc_cleanup - Clean up the core crtc usage
735 * @crtc: CRTC to cleanup
737 * This function cleans up @crtc and removes it from the DRM mode setting
738 * core. Note that the function does *not* free the crtc structure itself,
739 * this is the responsibility of the caller.
741 void drm_crtc_cleanup(struct drm_crtc *crtc)
743 struct drm_device *dev = crtc->dev;
745 kfree(crtc->gamma_store);
746 crtc->gamma_store = NULL;
748 drm_modeset_lock_fini(&crtc->mutex);
750 drm_mode_object_put(dev, &crtc->base);
751 list_del(&crtc->head);
752 dev->mode_config.num_crtc--;
754 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
755 if (crtc->state && crtc->funcs->atomic_destroy_state)
756 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
758 memset(crtc, 0, sizeof(*crtc));
760 EXPORT_SYMBOL(drm_crtc_cleanup);
763 * drm_crtc_index - find the index of a registered CRTC
764 * @crtc: CRTC to find index for
766 * Given a registered CRTC, return the index of that CRTC within a DRM
767 * device's list of CRTCs.
769 unsigned int drm_crtc_index(struct drm_crtc *crtc)
771 unsigned int index = 0;
772 struct drm_crtc *tmp;
774 drm_for_each_crtc(tmp, crtc->dev) {
783 EXPORT_SYMBOL(drm_crtc_index);
786 * drm_mode_remove - remove and free a mode
787 * @connector: connector list to modify
788 * @mode: mode to remove
790 * Remove @mode from @connector's mode list, then free it.
792 static void drm_mode_remove(struct drm_connector *connector,
793 struct drm_display_mode *mode)
795 list_del(&mode->head);
796 drm_mode_destroy(connector->dev, mode);
800 * drm_display_info_set_bus_formats - set the supported bus formats
801 * @info: display info to store bus formats in
802 * @formats: array containing the supported bus formats
803 * @num_formats: the number of entries in the fmts array
805 * Store the supported bus formats in display info structure.
806 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
807 * a full list of available formats.
809 int drm_display_info_set_bus_formats(struct drm_display_info *info,
811 unsigned int num_formats)
815 if (!formats && num_formats)
818 if (formats && num_formats) {
819 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
825 kfree(info->bus_formats);
826 info->bus_formats = fmts;
827 info->num_bus_formats = num_formats;
831 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
834 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
835 * @connector: connector to quwery
837 * The kernel supports per-connector configration of its consoles through
838 * use of the video= parameter. This function parses that option and
839 * extracts the user's specified mode (or enable/disable status) for a
840 * particular connector. This is typically only used during the early fbdev
843 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
845 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
848 if (fb_get_options(connector->name, &option))
851 if (!drm_mode_parse_command_line_for_connector(option,
859 switch (mode->force) {
863 case DRM_FORCE_ON_DIGITAL:
872 DRM_INFO("forcing %s connector %s\n", connector->name, s);
873 connector->force = mode->force;
876 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
878 mode->xres, mode->yres,
879 mode->refresh_specified ? mode->refresh : 60,
880 mode->rb ? " reduced blanking" : "",
881 mode->margins ? " with margins" : "",
882 mode->interlace ? " interlaced" : "");
886 * drm_connector_init - Init a preallocated connector
888 * @connector: the connector to init
889 * @funcs: callbacks for this connector
890 * @connector_type: user visible type of the connector
892 * Initialises a preallocated connector. Connectors should be
893 * subclassed as part of driver connector objects.
896 * Zero on success, error code on failure.
898 int drm_connector_init(struct drm_device *dev,
899 struct drm_connector *connector,
900 const struct drm_connector_funcs *funcs,
903 struct drm_mode_config *config = &dev->mode_config;
905 struct ida *connector_ida =
906 &drm_connector_enum_list[connector_type].ida;
908 drm_modeset_lock_all(dev);
910 ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
914 connector->base.properties = &connector->properties;
915 connector->dev = dev;
916 connector->funcs = funcs;
917 connector->connector_type = connector_type;
918 connector->connector_type_id =
919 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
920 if (connector->connector_type_id < 0) {
921 ret = connector->connector_type_id;
925 kasprintf(GFP_KERNEL, "%s-%d",
926 drm_connector_enum_list[connector_type].name,
927 connector->connector_type_id);
928 if (!connector->name) {
933 INIT_LIST_HEAD(&connector->probed_modes);
934 INIT_LIST_HEAD(&connector->modes);
935 connector->edid_blob_ptr = NULL;
936 connector->status = connector_status_unknown;
938 drm_connector_get_cmdline_mode(connector);
940 /* We should add connectors at the end to avoid upsetting the connector
942 list_add_tail(&connector->head, &config->connector_list);
943 config->num_connector++;
945 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
946 drm_object_attach_property(&connector->base,
947 config->edid_property,
950 drm_object_attach_property(&connector->base,
951 config->dpms_property, 0);
953 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
954 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
957 connector->debugfs_entry = NULL;
961 drm_mode_object_put(dev, &connector->base);
964 drm_modeset_unlock_all(dev);
968 EXPORT_SYMBOL(drm_connector_init);
971 * drm_connector_cleanup - cleans up an initialised connector
972 * @connector: connector to cleanup
974 * Cleans up the connector but doesn't free the object.
976 void drm_connector_cleanup(struct drm_connector *connector)
978 struct drm_device *dev = connector->dev;
979 struct drm_display_mode *mode, *t;
981 if (connector->tile_group) {
982 drm_mode_put_tile_group(dev, connector->tile_group);
983 connector->tile_group = NULL;
986 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
987 drm_mode_remove(connector, mode);
989 list_for_each_entry_safe(mode, t, &connector->modes, head)
990 drm_mode_remove(connector, mode);
992 ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
993 connector->connector_type_id);
995 kfree(connector->display_info.bus_formats);
996 drm_mode_object_put(dev, &connector->base);
997 kfree(connector->name);
998 connector->name = NULL;
999 list_del(&connector->head);
1000 dev->mode_config.num_connector--;
1002 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
1003 if (connector->state && connector->funcs->atomic_destroy_state)
1004 connector->funcs->atomic_destroy_state(connector,
1007 memset(connector, 0, sizeof(*connector));
1009 EXPORT_SYMBOL(drm_connector_cleanup);
1012 * drm_connector_index - find the index of a registered connector
1013 * @connector: connector to find index for
1015 * Given a registered connector, return the index of that connector within a DRM
1016 * device's list of connectors.
1018 unsigned int drm_connector_index(struct drm_connector *connector)
1020 unsigned int index = 0;
1021 struct drm_connector *tmp;
1022 struct drm_mode_config *config = &connector->dev->mode_config;
1024 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
1026 drm_for_each_connector(tmp, connector->dev) {
1027 if (tmp == connector)
1035 EXPORT_SYMBOL(drm_connector_index);
1038 * drm_connector_register - register a connector
1039 * @connector: the connector to register
1041 * Register userspace interfaces for a connector
1044 * Zero on success, error code on failure.
1046 int drm_connector_register(struct drm_connector *connector)
1050 drm_mode_object_register(connector->dev, &connector->base);
1052 ret = drm_sysfs_connector_add(connector);
1056 ret = drm_debugfs_connector_add(connector);
1061 if (connector->funcs->late_register) {
1062 ret = connector->funcs->late_register(connector);
1070 drm_debugfs_connector_remove(connector);
1072 drm_sysfs_connector_remove(connector);
1075 EXPORT_SYMBOL(drm_connector_register);
1078 * drm_connector_unregister - unregister a connector
1079 * @connector: the connector to unregister
1081 * Unregister userspace interfaces for a connector
1083 void drm_connector_unregister(struct drm_connector *connector)
1085 if (connector->funcs->early_unregister)
1086 connector->funcs->early_unregister(connector);
1088 drm_sysfs_connector_remove(connector);
1089 drm_debugfs_connector_remove(connector);
1091 EXPORT_SYMBOL(drm_connector_unregister);
1094 * drm_connector_register_all - register all connectors
1097 * This function registers all connectors in sysfs and other places so that
1098 * userspace can start to access them. drm_connector_register_all() is called
1099 * automatically from drm_dev_register() to complete the device registration,
1100 * if they don't call drm_connector_register() on each connector individually.
1102 * When a device is unplugged and should be removed from userspace access,
1103 * call drm_connector_unregister_all(), which is the inverse of this
1107 * Zero on success, error code on failure.
1109 int drm_connector_register_all(struct drm_device *dev)
1111 struct drm_connector *connector;
1114 /* FIXME: taking the mode config mutex ends up in a clash with
1115 * fbcon/backlight registration */
1116 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
1117 ret = drm_connector_register(connector);
1125 mutex_unlock(&dev->mode_config.mutex);
1126 drm_connector_unregister_all(dev);
1129 EXPORT_SYMBOL(drm_connector_register_all);
1132 * drm_connector_unregister_all - unregister connector userspace interfaces
1135 * This functions unregisters all connectors from sysfs and other places so
1136 * that userspace can no longer access them. Drivers should call this as the
1137 * first step tearing down the device instace, or when the underlying
1138 * physical device disappeared (e.g. USB unplug), right before calling
1139 * drm_dev_unregister().
1141 void drm_connector_unregister_all(struct drm_device *dev)
1143 struct drm_connector *connector;
1145 /* FIXME: taking the mode config mutex ends up in a clash with sysfs */
1146 drm_for_each_connector(connector, dev)
1147 drm_connector_unregister(connector);
1149 EXPORT_SYMBOL(drm_connector_unregister_all);
1151 static int drm_encoder_register_all(struct drm_device *dev)
1153 struct drm_encoder *encoder;
1156 drm_for_each_encoder(encoder, dev) {
1157 if (encoder->funcs->late_register)
1158 ret = encoder->funcs->late_register(encoder);
1166 static void drm_encoder_unregister_all(struct drm_device *dev)
1168 struct drm_encoder *encoder;
1170 drm_for_each_encoder(encoder, dev) {
1171 if (encoder->funcs->early_unregister)
1172 encoder->funcs->early_unregister(encoder);
1177 * drm_encoder_init - Init a preallocated encoder
1179 * @encoder: the encoder to init
1180 * @funcs: callbacks for this encoder
1181 * @encoder_type: user visible type of the encoder
1182 * @name: printf style format string for the encoder name, or NULL for default name
1184 * Initialises a preallocated encoder. Encoder should be
1185 * subclassed as part of driver encoder objects.
1188 * Zero on success, error code on failure.
1190 int drm_encoder_init(struct drm_device *dev,
1191 struct drm_encoder *encoder,
1192 const struct drm_encoder_funcs *funcs,
1193 int encoder_type, const char *name, ...)
1197 drm_modeset_lock_all(dev);
1199 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1204 encoder->encoder_type = encoder_type;
1205 encoder->funcs = funcs;
1206 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1207 drm_encoder_enum_list[encoder_type].name,
1209 if (!encoder->name) {
1214 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1215 dev->mode_config.num_encoder++;
1219 drm_mode_object_put(dev, &encoder->base);
1222 drm_modeset_unlock_all(dev);
1226 EXPORT_SYMBOL(drm_encoder_init);
1229 * drm_encoder_cleanup - cleans up an initialised encoder
1230 * @encoder: encoder to cleanup
1232 * Cleans up the encoder but doesn't free the object.
1234 void drm_encoder_cleanup(struct drm_encoder *encoder)
1236 struct drm_device *dev = encoder->dev;
1238 drm_modeset_lock_all(dev);
1239 drm_mode_object_put(dev, &encoder->base);
1240 kfree(encoder->name);
1241 list_del(&encoder->head);
1242 dev->mode_config.num_encoder--;
1243 drm_modeset_unlock_all(dev);
1245 memset(encoder, 0, sizeof(*encoder));
1247 EXPORT_SYMBOL(drm_encoder_cleanup);
1250 * drm_universal_plane_init - Initialize a new universal plane object
1252 * @plane: plane object to init
1253 * @possible_crtcs: bitmask of possible CRTCs
1254 * @funcs: callbacks for the new plane
1255 * @formats: array of supported formats (%DRM_FORMAT_*)
1256 * @format_count: number of elements in @formats
1257 * @type: type of plane (overlay, primary, cursor)
1258 * @name: printf style format string for the plane name, or NULL for default name
1260 * Initializes a plane object of type @type.
1263 * Zero on success, error code on failure.
1265 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1266 unsigned long possible_crtcs,
1267 const struct drm_plane_funcs *funcs,
1268 const uint32_t *formats, unsigned int format_count,
1269 enum drm_plane_type type,
1270 const char *name, ...)
1272 struct drm_mode_config *config = &dev->mode_config;
1275 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1279 drm_modeset_lock_init(&plane->mutex);
1281 plane->base.properties = &plane->properties;
1283 plane->funcs = funcs;
1284 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1286 if (!plane->format_types) {
1287 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1288 drm_mode_object_put(dev, &plane->base);
1292 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1293 plane->format_count = format_count;
1294 plane->possible_crtcs = possible_crtcs;
1297 list_add_tail(&plane->head, &config->plane_list);
1298 config->num_total_plane++;
1299 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1300 config->num_overlay_plane++;
1302 drm_object_attach_property(&plane->base,
1303 config->plane_type_property,
1306 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1307 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1308 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1309 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1310 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1311 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1312 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1313 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1314 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1315 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1316 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1321 EXPORT_SYMBOL(drm_universal_plane_init);
1323 static int drm_plane_register_all(struct drm_device *dev)
1325 struct drm_plane *plane;
1328 drm_for_each_plane(plane, dev) {
1329 if (plane->funcs->late_register)
1330 ret = plane->funcs->late_register(plane);
1338 static void drm_plane_unregister_all(struct drm_device *dev)
1340 struct drm_plane *plane;
1342 drm_for_each_plane(plane, dev) {
1343 if (plane->funcs->early_unregister)
1344 plane->funcs->early_unregister(plane);
1349 * drm_plane_init - Initialize a legacy plane
1351 * @plane: plane object to init
1352 * @possible_crtcs: bitmask of possible CRTCs
1353 * @funcs: callbacks for the new plane
1354 * @formats: array of supported formats (%DRM_FORMAT_*)
1355 * @format_count: number of elements in @formats
1356 * @is_primary: plane type (primary vs overlay)
1358 * Legacy API to initialize a DRM plane.
1360 * New drivers should call drm_universal_plane_init() instead.
1363 * Zero on success, error code on failure.
1365 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1366 unsigned long possible_crtcs,
1367 const struct drm_plane_funcs *funcs,
1368 const uint32_t *formats, unsigned int format_count,
1371 enum drm_plane_type type;
1373 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1374 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1375 formats, format_count, type, NULL);
1377 EXPORT_SYMBOL(drm_plane_init);
1380 * drm_share_plane_init - Initialize a share plane
1382 * @plane: plane object to init
1383 * @parent: this plane share some resources with parent plane.
1384 * @possible_crtcs: bitmask of possible CRTCs
1385 * @funcs: callbacks for the new plane
1386 * @formats: array of supported formats (%DRM_FORMAT_*)
1387 * @format_count: number of elements in @formats
1388 * @type: type of plane (overlay, primary, cursor)
1390 * With this API, the plane can share hardware resources with other planes.
1392 * --------------------------------------------------
1394 * | ------------------ |
1395 * | | parent plane | |
1396 * | | active scanout | |
1397 * | | | ----------------- |
1398 * | ------------------ | share plane 1 | |
1399 * | ----------------- |active scanout | |
1400 * | | share plane 0 | | | |
1401 * | |active scanout | ----------------- |
1403 * | ----------------- |
1404 * --------------------------------------------------
1411 * The plane hardware is used when the display scanout run into plane active
1412 * scanout, that means we can reuse the plane hardware resources on plane
1413 * non-active scanout.
1415 * Because resource share, There are some limit on share plane: one group
1416 * of share planes need use same zpos, can't not overlap, etc.
1418 * Here assume share plane is a universal plane with some limit flags.
1419 * people who use the share plane need know the limit, should call the ioctl
1420 * DRM_CLIENT_CAP_SHARE_PLANES, and judge the planes limit before use it.
1423 * Zero on success, error code on failure.
1426 int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1427 struct drm_plane *parent,
1428 unsigned long possible_crtcs,
1429 const struct drm_plane_funcs *funcs,
1430 const uint32_t *formats, unsigned int format_count,
1431 enum drm_plane_type type)
1433 struct drm_mode_config *config = &dev->mode_config;
1438 * TODO: only verified on ATOMIC drm driver.
1440 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1443 ret = drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1444 formats, format_count, type, NULL);
1450 * Can't support more than two level plane share.
1452 WARN_ON(parent->parent);
1453 share_id = parent->base.id;
1454 plane->parent = parent;
1456 config->num_share_plane++;
1457 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1458 config->num_share_overlay_plane++;
1460 share_id = plane->base.id;
1463 drm_object_attach_property(&plane->base,
1464 config->prop_share_id, share_id);
1467 EXPORT_SYMBOL(drm_share_plane_init);
1470 * drm_plane_cleanup - Clean up the core plane usage
1471 * @plane: plane to cleanup
1473 * This function cleans up @plane and removes it from the DRM mode setting
1474 * core. Note that the function does *not* free the plane structure itself,
1475 * this is the responsibility of the caller.
1477 void drm_plane_cleanup(struct drm_plane *plane)
1479 struct drm_device *dev = plane->dev;
1481 drm_modeset_lock_all(dev);
1482 kfree(plane->format_types);
1483 drm_mode_object_put(dev, &plane->base);
1485 BUG_ON(list_empty(&plane->head));
1487 list_del(&plane->head);
1488 dev->mode_config.num_total_plane--;
1489 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1490 dev->mode_config.num_overlay_plane--;
1491 if (plane->parent) {
1492 dev->mode_config.num_share_plane--;
1493 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1494 dev->mode_config.num_share_overlay_plane--;
1496 drm_modeset_unlock_all(dev);
1498 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1499 if (plane->state && plane->funcs->atomic_destroy_state)
1500 plane->funcs->atomic_destroy_state(plane, plane->state);
1502 memset(plane, 0, sizeof(*plane));
1504 EXPORT_SYMBOL(drm_plane_cleanup);
1507 * drm_plane_index - find the index of a registered plane
1508 * @plane: plane to find index for
1510 * Given a registered plane, return the index of that CRTC within a DRM
1511 * device's list of planes.
1513 unsigned int drm_plane_index(struct drm_plane *plane)
1515 unsigned int index = 0;
1516 struct drm_plane *tmp;
1518 drm_for_each_plane(tmp, plane->dev) {
1527 EXPORT_SYMBOL(drm_plane_index);
1530 * drm_plane_from_index - find the registered plane at an index
1532 * @idx: index of registered plane to find for
1534 * Given a plane index, return the registered plane from DRM device's
1535 * list of planes with matching index.
1538 drm_plane_from_index(struct drm_device *dev, int idx)
1540 struct drm_plane *plane;
1543 drm_for_each_plane(plane, dev) {
1550 EXPORT_SYMBOL(drm_plane_from_index);
1553 * drm_plane_force_disable - Forcibly disable a plane
1554 * @plane: plane to disable
1556 * Forces the plane to be disabled.
1558 * Used when the plane's current framebuffer is destroyed,
1559 * and when restoring fbdev mode.
1561 void drm_plane_force_disable(struct drm_plane *plane)
1568 plane->old_fb = plane->fb;
1569 ret = plane->funcs->disable_plane(plane);
1571 DRM_ERROR("failed to disable plane with busy fb\n");
1572 plane->old_fb = NULL;
1575 /* disconnect the plane from the fb and crtc: */
1576 drm_framebuffer_unreference(plane->old_fb);
1577 plane->old_fb = NULL;
1581 EXPORT_SYMBOL(drm_plane_force_disable);
1583 int drm_modeset_register_all(struct drm_device *dev)
1587 ret = drm_plane_register_all(dev);
1591 ret = drm_crtc_register_all(dev);
1595 ret = drm_encoder_register_all(dev);
1599 ret = drm_connector_register_all(dev);
1606 drm_encoder_unregister_all(dev);
1608 drm_crtc_unregister_all(dev);
1610 drm_plane_unregister_all(dev);
1615 void drm_modeset_unregister_all(struct drm_device *dev)
1617 drm_connector_unregister_all(dev);
1618 drm_encoder_unregister_all(dev);
1619 drm_crtc_unregister_all(dev);
1620 drm_plane_unregister_all(dev);
1623 static int drm_mode_create_standard_properties(struct drm_device *dev)
1625 struct drm_property *prop;
1628 * Standard properties (apply to all connectors)
1630 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1631 DRM_MODE_PROP_IMMUTABLE,
1635 dev->mode_config.edid_property = prop;
1637 prop = drm_property_create_enum(dev, 0,
1638 "DPMS", drm_dpms_enum_list,
1639 ARRAY_SIZE(drm_dpms_enum_list));
1642 dev->mode_config.dpms_property = prop;
1644 prop = drm_property_create(dev,
1645 DRM_MODE_PROP_BLOB |
1646 DRM_MODE_PROP_IMMUTABLE,
1650 dev->mode_config.path_property = prop;
1652 prop = drm_property_create(dev,
1653 DRM_MODE_PROP_BLOB |
1654 DRM_MODE_PROP_IMMUTABLE,
1658 dev->mode_config.tile_property = prop;
1660 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1661 "type", drm_plane_type_enum_list,
1662 ARRAY_SIZE(drm_plane_type_enum_list));
1665 dev->mode_config.plane_type_property = prop;
1667 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1668 "SHARE_ID", 0, UINT_MAX);
1672 dev->mode_config.prop_share_id = prop;
1673 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1674 "SHARE_FLAGS", 0, UINT_MAX);
1677 dev->mode_config.prop_share_flags = prop;
1679 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1680 "SRC_X", 0, UINT_MAX);
1683 dev->mode_config.prop_src_x = prop;
1685 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1686 "SRC_Y", 0, UINT_MAX);
1689 dev->mode_config.prop_src_y = prop;
1691 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1692 "SRC_W", 0, UINT_MAX);
1695 dev->mode_config.prop_src_w = prop;
1697 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1698 "SRC_H", 0, UINT_MAX);
1701 dev->mode_config.prop_src_h = prop;
1703 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1704 "CRTC_X", INT_MIN, INT_MAX);
1707 dev->mode_config.prop_crtc_x = prop;
1709 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1710 "CRTC_Y", INT_MIN, INT_MAX);
1713 dev->mode_config.prop_crtc_y = prop;
1715 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1716 "CRTC_W", 0, INT_MAX);
1719 dev->mode_config.prop_crtc_w = prop;
1721 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1722 "CRTC_H", 0, INT_MAX);
1725 dev->mode_config.prop_crtc_h = prop;
1727 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1728 "FB_ID", DRM_MODE_OBJECT_FB);
1731 dev->mode_config.prop_fb_id = prop;
1733 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1734 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1737 dev->mode_config.prop_crtc_id = prop;
1739 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
1743 dev->mode_config.prop_active = prop;
1745 prop = drm_property_create(dev,
1746 DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
1750 dev->mode_config.prop_mode_id = prop;
1756 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1759 * Called by a driver the first time a DVI-I connector is made.
1761 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1763 struct drm_property *dvi_i_selector;
1764 struct drm_property *dvi_i_subconnector;
1766 if (dev->mode_config.dvi_i_select_subconnector_property)
1770 drm_property_create_enum(dev, 0,
1771 "select subconnector",
1772 drm_dvi_i_select_enum_list,
1773 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1774 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1776 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1778 drm_dvi_i_subconnector_enum_list,
1779 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1780 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1784 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1787 * drm_create_tv_properties - create TV specific connector properties
1789 * @num_modes: number of different TV formats (modes) supported
1790 * @modes: array of pointers to strings containing name of each format
1792 * Called by a driver's TV initialization routine, this function creates
1793 * the TV specific connector properties for a given device. Caller is
1794 * responsible for allocating a list of format names and passing them to
1797 int drm_mode_create_tv_properties(struct drm_device *dev,
1798 unsigned int num_modes,
1799 const char * const modes[])
1801 struct drm_property *tv_selector;
1802 struct drm_property *tv_subconnector;
1805 if (dev->mode_config.tv_select_subconnector_property)
1809 * Basic connector properties
1811 tv_selector = drm_property_create_enum(dev, 0,
1812 "select subconnector",
1813 drm_tv_select_enum_list,
1814 ARRAY_SIZE(drm_tv_select_enum_list));
1818 dev->mode_config.tv_select_subconnector_property = tv_selector;
1821 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1823 drm_tv_subconnector_enum_list,
1824 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1825 if (!tv_subconnector)
1827 dev->mode_config.tv_subconnector_property = tv_subconnector;
1830 * Other, TV specific properties: margins & TV modes.
1832 dev->mode_config.tv_left_margin_property =
1833 drm_property_create_range(dev, 0, "left margin", 0, 100);
1834 if (!dev->mode_config.tv_left_margin_property)
1837 dev->mode_config.tv_right_margin_property =
1838 drm_property_create_range(dev, 0, "right margin", 0, 100);
1839 if (!dev->mode_config.tv_right_margin_property)
1842 dev->mode_config.tv_top_margin_property =
1843 drm_property_create_range(dev, 0, "top margin", 0, 100);
1844 if (!dev->mode_config.tv_top_margin_property)
1847 dev->mode_config.tv_bottom_margin_property =
1848 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1849 if (!dev->mode_config.tv_bottom_margin_property)
1852 dev->mode_config.tv_mode_property =
1853 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1855 if (!dev->mode_config.tv_mode_property)
1858 for (i = 0; i < num_modes; i++)
1859 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1862 dev->mode_config.tv_brightness_property =
1863 drm_property_create_range(dev, 0, "brightness", 0, 100);
1864 if (!dev->mode_config.tv_brightness_property)
1867 dev->mode_config.tv_contrast_property =
1868 drm_property_create_range(dev, 0, "contrast", 0, 100);
1869 if (!dev->mode_config.tv_contrast_property)
1872 dev->mode_config.tv_flicker_reduction_property =
1873 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1874 if (!dev->mode_config.tv_flicker_reduction_property)
1877 dev->mode_config.tv_overscan_property =
1878 drm_property_create_range(dev, 0, "overscan", 0, 100);
1879 if (!dev->mode_config.tv_overscan_property)
1882 dev->mode_config.tv_saturation_property =
1883 drm_property_create_range(dev, 0, "saturation", 0, 100);
1884 if (!dev->mode_config.tv_saturation_property)
1887 dev->mode_config.tv_hue_property =
1888 drm_property_create_range(dev, 0, "hue", 0, 100);
1889 if (!dev->mode_config.tv_hue_property)
1896 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1899 * drm_mode_create_scaling_mode_property - create scaling mode property
1902 * Called by a driver the first time it's needed, must be attached to desired
1905 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1907 struct drm_property *scaling_mode;
1909 if (dev->mode_config.scaling_mode_property)
1913 drm_property_create_enum(dev, 0, "scaling mode",
1914 drm_scaling_mode_enum_list,
1915 ARRAY_SIZE(drm_scaling_mode_enum_list));
1917 dev->mode_config.scaling_mode_property = scaling_mode;
1921 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1924 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1927 * Called by a driver the first time it's needed, must be attached to desired
1931 * Zero on success, negative errno on failure.
1933 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1935 if (dev->mode_config.aspect_ratio_property)
1938 dev->mode_config.aspect_ratio_property =
1939 drm_property_create_enum(dev, 0, "aspect ratio",
1940 drm_aspect_ratio_enum_list,
1941 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1943 if (dev->mode_config.aspect_ratio_property == NULL)
1948 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1951 * drm_mode_create_dirty_property - create dirty property
1954 * Called by a driver the first time it's needed, must be attached to desired
1957 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1959 struct drm_property *dirty_info;
1961 if (dev->mode_config.dirty_info_property)
1965 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1967 drm_dirty_info_enum_list,
1968 ARRAY_SIZE(drm_dirty_info_enum_list));
1969 dev->mode_config.dirty_info_property = dirty_info;
1973 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1976 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1979 * Create the the suggested x/y offset property for connectors.
1981 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1983 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1986 dev->mode_config.suggested_x_property =
1987 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1989 dev->mode_config.suggested_y_property =
1990 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1992 if (dev->mode_config.suggested_x_property == NULL ||
1993 dev->mode_config.suggested_y_property == NULL)
1997 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
2000 * drm_mode_getresources - get graphics configuration
2001 * @dev: drm device for the ioctl
2002 * @data: data pointer for the ioctl
2003 * @file_priv: drm file for the ioctl call
2005 * Construct a set of configuration description structures and return
2006 * them to the user, including CRTC, connector and framebuffer configuration.
2008 * Called by the user via ioctl.
2011 * Zero on success, negative errno on failure.
2013 int drm_mode_getresources(struct drm_device *dev, void *data,
2014 struct drm_file *file_priv)
2016 struct drm_mode_card_res *card_res = data;
2017 struct list_head *lh;
2018 struct drm_framebuffer *fb;
2019 struct drm_connector *connector;
2020 struct drm_crtc *crtc;
2021 struct drm_encoder *encoder;
2023 int connector_count = 0;
2026 int encoder_count = 0;
2028 uint32_t __user *fb_id;
2029 uint32_t __user *crtc_id;
2030 uint32_t __user *connector_id;
2031 uint32_t __user *encoder_id;
2033 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2037 mutex_lock(&file_priv->fbs_lock);
2039 * For the non-control nodes we need to limit the list of resources
2040 * by IDs in the group list for this node
2042 list_for_each(lh, &file_priv->fbs)
2045 /* handle this in 4 parts */
2047 if (card_res->count_fbs >= fb_count) {
2049 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
2050 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
2051 if (put_user(fb->base.id, fb_id + copied)) {
2052 mutex_unlock(&file_priv->fbs_lock);
2058 card_res->count_fbs = fb_count;
2059 mutex_unlock(&file_priv->fbs_lock);
2061 /* mode_config.mutex protects the connector list against e.g. DP MST
2062 * connector hot-adding. CRTC/Plane lists are invariant. */
2063 mutex_lock(&dev->mode_config.mutex);
2064 drm_for_each_crtc(crtc, dev)
2067 drm_for_each_connector(connector, dev)
2070 drm_for_each_encoder(encoder, dev)
2073 card_res->max_height = dev->mode_config.max_height;
2074 card_res->min_height = dev->mode_config.min_height;
2075 card_res->max_width = dev->mode_config.max_width;
2076 card_res->min_width = dev->mode_config.min_width;
2079 if (card_res->count_crtcs >= crtc_count) {
2081 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
2082 drm_for_each_crtc(crtc, dev) {
2083 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2084 if (put_user(crtc->base.id, crtc_id + copied)) {
2091 card_res->count_crtcs = crtc_count;
2094 if (card_res->count_encoders >= encoder_count) {
2096 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
2097 drm_for_each_encoder(encoder, dev) {
2098 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
2100 if (put_user(encoder->base.id, encoder_id +
2108 card_res->count_encoders = encoder_count;
2111 if (card_res->count_connectors >= connector_count) {
2113 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
2114 drm_for_each_connector(connector, dev) {
2115 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2118 if (put_user(connector->base.id,
2119 connector_id + copied)) {
2126 card_res->count_connectors = connector_count;
2128 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
2129 card_res->count_connectors, card_res->count_encoders);
2132 mutex_unlock(&dev->mode_config.mutex);
2137 * drm_mode_getcrtc - get CRTC configuration
2138 * @dev: drm device for the ioctl
2139 * @data: data pointer for the ioctl
2140 * @file_priv: drm file for the ioctl call
2142 * Construct a CRTC configuration structure to return to the user.
2144 * Called by the user via ioctl.
2147 * Zero on success, negative errno on failure.
2149 int drm_mode_getcrtc(struct drm_device *dev,
2150 void *data, struct drm_file *file_priv)
2152 struct drm_mode_crtc *crtc_resp = data;
2153 struct drm_crtc *crtc;
2155 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2158 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
2162 drm_modeset_lock_crtc(crtc, crtc->primary);
2163 crtc_resp->gamma_size = crtc->gamma_size;
2164 if (crtc->primary->fb)
2165 crtc_resp->fb_id = crtc->primary->fb->base.id;
2167 crtc_resp->fb_id = 0;
2170 crtc_resp->x = crtc->primary->state->src_x >> 16;
2171 crtc_resp->y = crtc->primary->state->src_y >> 16;
2172 if (crtc->state->enable) {
2173 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
2174 crtc_resp->mode_valid = 1;
2177 crtc_resp->mode_valid = 0;
2180 crtc_resp->x = crtc->x;
2181 crtc_resp->y = crtc->y;
2182 if (crtc->enabled) {
2183 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2184 crtc_resp->mode_valid = 1;
2187 crtc_resp->mode_valid = 0;
2190 drm_modeset_unlock_crtc(crtc);
2195 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2196 const struct drm_file *file_priv)
2199 * If user-space hasn't configured the driver to expose the stereo 3D
2200 * modes, don't expose them.
2202 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2208 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2210 /* For atomic drivers only state objects are synchronously updated and
2211 * protected by modeset locks, so check those first. */
2212 if (connector->state)
2213 return connector->state->best_encoder;
2214 return connector->encoder;
2217 /* helper for getconnector and getproperties ioctls */
2218 static int get_properties(struct drm_mode_object *obj, bool atomic,
2219 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2220 uint32_t *arg_count_props)
2225 props_count = obj->properties->count;
2227 props_count -= obj->properties->atomic_count;
2229 if ((*arg_count_props >= props_count) && props_count) {
2230 for (i = 0, copied = 0; copied < props_count; i++) {
2231 struct drm_property *prop = obj->properties->properties[i];
2234 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2237 ret = drm_object_property_get_value(obj, prop, &val);
2241 if (put_user(prop->base.id, prop_ptr + copied))
2244 if (put_user(val, prop_values + copied))
2250 *arg_count_props = props_count;
2256 * drm_mode_getconnector - get connector configuration
2257 * @dev: drm device for the ioctl
2258 * @data: data pointer for the ioctl
2259 * @file_priv: drm file for the ioctl call
2261 * Construct a connector configuration structure to return to the user.
2263 * Called by the user via ioctl.
2266 * Zero on success, negative errno on failure.
2268 int drm_mode_getconnector(struct drm_device *dev, void *data,
2269 struct drm_file *file_priv)
2271 struct drm_mode_get_connector *out_resp = data;
2272 struct drm_connector *connector;
2273 struct drm_encoder *encoder;
2274 struct drm_display_mode *mode;
2276 int encoders_count = 0;
2280 struct drm_mode_modeinfo u_mode;
2281 struct drm_mode_modeinfo __user *mode_ptr;
2282 uint32_t __user *encoder_ptr;
2284 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2287 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2289 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2291 mutex_lock(&dev->mode_config.mutex);
2293 connector = drm_connector_find(dev, out_resp->connector_id);
2299 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2300 if (connector->encoder_ids[i] != 0)
2303 if (out_resp->count_modes == 0) {
2304 connector->funcs->fill_modes(connector,
2305 dev->mode_config.max_width,
2306 dev->mode_config.max_height);
2309 /* delayed so we get modes regardless of pre-fill_modes state */
2310 list_for_each_entry(mode, &connector->modes, head)
2311 if (drm_mode_expose_to_userspace(mode, file_priv))
2314 out_resp->connector_id = connector->base.id;
2315 out_resp->connector_type = connector->connector_type;
2316 out_resp->connector_type_id = connector->connector_type_id;
2317 out_resp->mm_width = connector->display_info.width_mm;
2318 out_resp->mm_height = connector->display_info.height_mm;
2319 out_resp->subpixel = connector->display_info.subpixel_order;
2320 out_resp->connection = connector->status;
2322 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2323 encoder = drm_connector_get_encoder(connector);
2325 out_resp->encoder_id = encoder->base.id;
2327 out_resp->encoder_id = 0;
2330 * This ioctl is called twice, once to determine how much space is
2331 * needed, and the 2nd time to fill it.
2333 if ((out_resp->count_modes >= mode_count) && mode_count) {
2335 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2336 list_for_each_entry(mode, &connector->modes, head) {
2337 if (!drm_mode_expose_to_userspace(mode, file_priv))
2340 drm_mode_convert_to_umode(&u_mode, mode);
2341 if (copy_to_user(mode_ptr + copied,
2342 &u_mode, sizeof(u_mode))) {
2349 out_resp->count_modes = mode_count;
2351 ret = get_properties(&connector->base, file_priv->atomic,
2352 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2353 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2354 &out_resp->count_props);
2358 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2360 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2361 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2362 if (connector->encoder_ids[i] != 0) {
2363 if (put_user(connector->encoder_ids[i],
2364 encoder_ptr + copied)) {
2372 out_resp->count_encoders = encoders_count;
2375 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2378 mutex_unlock(&dev->mode_config.mutex);
2383 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2385 struct drm_connector *connector;
2386 struct drm_device *dev = encoder->dev;
2387 bool uses_atomic = false;
2389 /* For atomic drivers only state objects are synchronously updated and
2390 * protected by modeset locks, so check those first. */
2391 drm_for_each_connector(connector, dev) {
2392 if (!connector->state)
2397 if (connector->state->best_encoder != encoder)
2400 return connector->state->crtc;
2403 /* Don't return stale data (e.g. pending async disable). */
2407 return encoder->crtc;
2411 * drm_mode_getencoder - get encoder configuration
2412 * @dev: drm device for the ioctl
2413 * @data: data pointer for the ioctl
2414 * @file_priv: drm file for the ioctl call
2416 * Construct a encoder configuration structure to return to the user.
2418 * Called by the user via ioctl.
2421 * Zero on success, negative errno on failure.
2423 int drm_mode_getencoder(struct drm_device *dev, void *data,
2424 struct drm_file *file_priv)
2426 struct drm_mode_get_encoder *enc_resp = data;
2427 struct drm_encoder *encoder;
2428 struct drm_crtc *crtc;
2430 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2433 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2437 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2438 crtc = drm_encoder_get_crtc(encoder);
2440 enc_resp->crtc_id = crtc->base.id;
2442 enc_resp->crtc_id = 0;
2443 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2445 enc_resp->encoder_type = encoder->encoder_type;
2446 enc_resp->encoder_id = encoder->base.id;
2447 enc_resp->possible_crtcs = encoder->possible_crtcs;
2448 enc_resp->possible_clones = encoder->possible_clones;
2454 * drm_mode_getplane_res - enumerate all plane resources
2457 * @file_priv: DRM file info
2459 * Construct a list of plane ids to return to the user.
2461 * Called by the user via ioctl.
2464 * Zero on success, negative errno on failure.
2466 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2467 struct drm_file *file_priv)
2469 struct drm_mode_get_plane_res *plane_resp = data;
2470 struct drm_mode_config *config;
2471 struct drm_plane *plane;
2472 uint32_t __user *plane_ptr;
2474 unsigned num_planes;
2476 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2479 config = &dev->mode_config;
2481 if (file_priv->universal_planes)
2482 num_planes = config->num_total_plane;
2484 num_planes = config->num_overlay_plane;
2485 if (!file_priv->share_planes) {
2486 if (file_priv->universal_planes)
2487 num_planes -= config->num_share_plane;
2489 num_planes -= config->num_share_overlay_plane;
2493 * This ioctl is called twice, once to determine how much space is
2494 * needed, and the 2nd time to fill it.
2497 (plane_resp->count_planes >= num_planes)) {
2498 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2500 /* Plane lists are invariant, no locking needed. */
2501 drm_for_each_plane(plane, dev) {
2503 * Unless userspace set the 'universal planes'
2504 * capability bit, only advertise overlays.
2506 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2507 !file_priv->universal_planes)
2509 if (plane->parent && !file_priv->share_planes)
2512 if (put_user(plane->base.id, plane_ptr + copied))
2517 plane_resp->count_planes = num_planes;
2523 * drm_mode_getplane - get plane configuration
2526 * @file_priv: DRM file info
2528 * Construct a plane configuration structure to return to the user.
2530 * Called by the user via ioctl.
2533 * Zero on success, negative errno on failure.
2535 int drm_mode_getplane(struct drm_device *dev, void *data,
2536 struct drm_file *file_priv)
2538 struct drm_mode_get_plane *plane_resp = data;
2539 struct drm_plane *plane;
2540 uint32_t __user *format_ptr;
2542 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2545 plane = drm_plane_find(dev, plane_resp->plane_id);
2549 drm_modeset_lock(&plane->mutex, NULL);
2551 plane_resp->crtc_id = plane->crtc->base.id;
2553 plane_resp->crtc_id = 0;
2556 plane_resp->fb_id = plane->fb->base.id;
2558 plane_resp->fb_id = 0;
2559 drm_modeset_unlock(&plane->mutex);
2561 plane_resp->plane_id = plane->base.id;
2562 plane_resp->possible_crtcs = plane->possible_crtcs;
2563 plane_resp->gamma_size = 0;
2566 * This ioctl is called twice, once to determine how much space is
2567 * needed, and the 2nd time to fill it.
2569 if (plane->format_count &&
2570 (plane_resp->count_format_types >= plane->format_count)) {
2571 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2572 if (copy_to_user(format_ptr,
2573 plane->format_types,
2574 sizeof(uint32_t) * plane->format_count)) {
2578 plane_resp->count_format_types = plane->format_count;
2584 * drm_plane_check_pixel_format - Check if the plane supports the pixel format
2585 * @plane: plane to check for format support
2586 * @format: the pixel format
2589 * Zero of @plane has @format in its list of supported pixel formats, -EINVAL
2592 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
2596 for (i = 0; i < plane->format_count; i++) {
2597 if (format == plane->format_types[i])
2604 static int check_src_coords(uint32_t src_x, uint32_t src_y,
2605 uint32_t src_w, uint32_t src_h,
2606 const struct drm_framebuffer *fb)
2608 unsigned int fb_width, fb_height;
2610 fb_width = fb->width << 16;
2611 fb_height = fb->height << 16;
2613 /* Make sure source coordinates are inside the fb. */
2614 if (src_w > fb_width ||
2615 src_x > fb_width - src_w ||
2616 src_h > fb_height ||
2617 src_y > fb_height - src_h) {
2618 DRM_DEBUG_KMS("Invalid source coordinates "
2619 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2620 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2621 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2622 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2623 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2631 * setplane_internal - setplane handler for internal callers
2633 * Note that we assume an extra reference has already been taken on fb. If the
2634 * update fails, this reference will be dropped before return; if it succeeds,
2635 * the previous framebuffer (if any) will be unreferenced instead.
2637 * src_{x,y,w,h} are provided in 16.16 fixed point format
2639 static int __setplane_internal(struct drm_plane *plane,
2640 struct drm_crtc *crtc,
2641 struct drm_framebuffer *fb,
2642 int32_t crtc_x, int32_t crtc_y,
2643 uint32_t crtc_w, uint32_t crtc_h,
2644 /* src_{x,y,w,h} values are 16.16 fixed point */
2645 uint32_t src_x, uint32_t src_y,
2646 uint32_t src_w, uint32_t src_h)
2650 /* No fb means shut it down */
2652 plane->old_fb = plane->fb;
2653 ret = plane->funcs->disable_plane(plane);
2658 plane->old_fb = NULL;
2663 /* Check whether this plane is usable on this CRTC */
2664 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2665 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2670 /* Check whether this plane supports the fb pixel format. */
2671 ret = drm_plane_check_pixel_format(plane, fb->pixel_format);
2673 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2674 drm_get_format_name(fb->pixel_format));
2678 /* Give drivers some help against integer overflows */
2679 if (crtc_w > INT_MAX ||
2680 crtc_x > INT_MAX - (int32_t) crtc_w ||
2682 crtc_y > INT_MAX - (int32_t) crtc_h) {
2683 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2684 crtc_w, crtc_h, crtc_x, crtc_y);
2689 ret = check_src_coords(src_x, src_y, src_w, src_h, fb);
2693 plane->old_fb = plane->fb;
2694 ret = plane->funcs->update_plane(plane, crtc, fb,
2695 crtc_x, crtc_y, crtc_w, crtc_h,
2696 src_x, src_y, src_w, src_h);
2702 plane->old_fb = NULL;
2707 drm_framebuffer_unreference(fb);
2709 drm_framebuffer_unreference(plane->old_fb);
2710 plane->old_fb = NULL;
2715 static int setplane_internal(struct drm_plane *plane,
2716 struct drm_crtc *crtc,
2717 struct drm_framebuffer *fb,
2718 int32_t crtc_x, int32_t crtc_y,
2719 uint32_t crtc_w, uint32_t crtc_h,
2720 /* src_{x,y,w,h} values are 16.16 fixed point */
2721 uint32_t src_x, uint32_t src_y,
2722 uint32_t src_w, uint32_t src_h)
2726 drm_modeset_lock_all(plane->dev);
2727 ret = __setplane_internal(plane, crtc, fb,
2728 crtc_x, crtc_y, crtc_w, crtc_h,
2729 src_x, src_y, src_w, src_h);
2730 drm_modeset_unlock_all(plane->dev);
2736 * drm_mode_setplane - configure a plane's configuration
2738 * @data: ioctl data*
2739 * @file_priv: DRM file info
2741 * Set plane configuration, including placement, fb, scaling, and other factors.
2742 * Or pass a NULL fb to disable (planes may be disabled without providing a
2746 * Zero on success, negative errno on failure.
2748 int drm_mode_setplane(struct drm_device *dev, void *data,
2749 struct drm_file *file_priv)
2751 struct drm_mode_set_plane *plane_req = data;
2752 struct drm_plane *plane;
2753 struct drm_crtc *crtc = NULL;
2754 struct drm_framebuffer *fb = NULL;
2756 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2760 * First, find the plane, crtc, and fb objects. If not available,
2761 * we don't bother to call the driver.
2763 plane = drm_plane_find(dev, plane_req->plane_id);
2765 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2766 plane_req->plane_id);
2770 if (plane_req->fb_id) {
2771 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2773 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2778 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2780 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2781 plane_req->crtc_id);
2787 * setplane_internal will take care of deref'ing either the old or new
2788 * framebuffer depending on success.
2790 return setplane_internal(plane, crtc, fb,
2791 plane_req->crtc_x, plane_req->crtc_y,
2792 plane_req->crtc_w, plane_req->crtc_h,
2793 plane_req->src_x, plane_req->src_y,
2794 plane_req->src_w, plane_req->src_h);
2798 * drm_mode_set_config_internal - helper to call ->set_config
2799 * @set: modeset config to set
2801 * This is a little helper to wrap internal calls to the ->set_config driver
2802 * interface. The only thing it adds is correct refcounting dance.
2805 * Zero on success, negative errno on failure.
2807 int drm_mode_set_config_internal(struct drm_mode_set *set)
2809 struct drm_crtc *crtc = set->crtc;
2810 struct drm_framebuffer *fb;
2811 struct drm_crtc *tmp;
2815 * NOTE: ->set_config can also disable other crtcs (if we steal all
2816 * connectors from it), hence we need to refcount the fbs across all
2817 * crtcs. Atomic modeset will have saner semantics ...
2819 drm_for_each_crtc(tmp, crtc->dev)
2820 tmp->primary->old_fb = tmp->primary->fb;
2824 ret = crtc->funcs->set_config(set);
2826 crtc->primary->crtc = crtc;
2827 crtc->primary->fb = fb;
2830 drm_for_each_crtc(tmp, crtc->dev) {
2831 if (tmp->primary->fb)
2832 drm_framebuffer_reference(tmp->primary->fb);
2833 if (tmp->primary->old_fb)
2834 drm_framebuffer_unreference(tmp->primary->old_fb);
2835 tmp->primary->old_fb = NULL;
2840 EXPORT_SYMBOL(drm_mode_set_config_internal);
2843 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
2844 * @mode: mode to query
2845 * @hdisplay: hdisplay value to fill in
2846 * @vdisplay: vdisplay value to fill in
2848 * The vdisplay value will be doubled if the specified mode is a stereo mode of
2849 * the appropriate layout.
2851 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2852 int *hdisplay, int *vdisplay)
2854 struct drm_display_mode adjusted;
2856 drm_mode_copy(&adjusted, mode);
2857 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
2858 *hdisplay = adjusted.crtc_hdisplay;
2859 *vdisplay = adjusted.crtc_vdisplay;
2861 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
2864 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2866 * @crtc: CRTC that framebuffer will be displayed on
2869 * @mode: mode that framebuffer will be displayed under
2870 * @fb: framebuffer to check size of
2872 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2874 const struct drm_display_mode *mode,
2875 const struct drm_framebuffer *fb)
2878 int hdisplay, vdisplay;
2880 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
2883 crtc->primary->state->rotation & (BIT(DRM_ROTATE_90) |
2884 BIT(DRM_ROTATE_270)))
2885 swap(hdisplay, vdisplay);
2887 return check_src_coords(x << 16, y << 16,
2888 hdisplay << 16, vdisplay << 16, fb);
2890 EXPORT_SYMBOL(drm_crtc_check_viewport);
2893 * drm_mode_setcrtc - set CRTC configuration
2894 * @dev: drm device for the ioctl
2895 * @data: data pointer for the ioctl
2896 * @file_priv: drm file for the ioctl call
2898 * Build a new CRTC configuration based on user request.
2900 * Called by the user via ioctl.
2903 * Zero on success, negative errno on failure.
2905 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2906 struct drm_file *file_priv)
2908 struct drm_mode_config *config = &dev->mode_config;
2909 struct drm_mode_crtc *crtc_req = data;
2910 struct drm_crtc *crtc;
2911 struct drm_connector **connector_set = NULL, *connector;
2912 struct drm_framebuffer *fb = NULL;
2913 struct drm_display_mode *mode = NULL;
2914 struct drm_mode_set set;
2915 uint32_t __user *set_connectors_ptr;
2919 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2923 * Universal plane src offsets are only 16.16, prevent havoc for
2924 * drivers using universal plane code internally.
2926 if (crtc_req->x & 0xffff0000 || crtc_req->y & 0xffff0000)
2929 drm_modeset_lock_all(dev);
2930 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2932 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2936 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2938 if (crtc_req->mode_valid) {
2939 /* If we have a mode we need a framebuffer. */
2940 /* If we pass -1, set the mode with the currently bound fb */
2941 if (crtc_req->fb_id == -1) {
2942 if (!crtc->primary->fb) {
2943 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2947 fb = crtc->primary->fb;
2948 /* Make refcounting symmetric with the lookup path. */
2949 drm_framebuffer_reference(fb);
2951 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2953 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2960 mode = drm_mode_create(dev);
2966 ret = drm_mode_convert_umode(mode, &crtc_req->mode);
2968 DRM_DEBUG_KMS("Invalid mode\n");
2973 * Check whether the primary plane supports the fb pixel format.
2974 * Drivers not implementing the universal planes API use a
2975 * default formats list provided by the DRM core which doesn't
2976 * match real hardware capabilities. Skip the check in that
2979 if (!crtc->primary->format_default) {
2980 ret = drm_plane_check_pixel_format(crtc->primary,
2983 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2984 drm_get_format_name(fb->pixel_format));
2989 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2996 if (crtc_req->count_connectors == 0 && mode) {
2997 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
3002 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
3003 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
3004 crtc_req->count_connectors);
3009 if (crtc_req->count_connectors > 0) {
3012 /* Avoid unbounded kernel memory allocation */
3013 if (crtc_req->count_connectors > config->num_connector) {
3018 connector_set = kmalloc_array(crtc_req->count_connectors,
3019 sizeof(struct drm_connector *),
3021 if (!connector_set) {
3026 for (i = 0; i < crtc_req->count_connectors; i++) {
3027 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
3028 if (get_user(out_id, &set_connectors_ptr[i])) {
3033 connector = drm_connector_find(dev, out_id);
3035 DRM_DEBUG_KMS("Connector id %d unknown\n",
3040 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
3044 connector_set[i] = connector;
3049 set.x = crtc_req->x;
3050 set.y = crtc_req->y;
3052 set.connectors = connector_set;
3053 set.num_connectors = crtc_req->count_connectors;
3055 ret = drm_mode_set_config_internal(&set);
3059 drm_framebuffer_unreference(fb);
3061 kfree(connector_set);
3062 drm_mode_destroy(dev, mode);
3063 drm_modeset_unlock_all(dev);
3068 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
3069 * universal plane handler call
3070 * @crtc: crtc to update cursor for
3071 * @req: data pointer for the ioctl
3072 * @file_priv: drm file for the ioctl call
3074 * Legacy cursor ioctl's work directly with driver buffer handles. To
3075 * translate legacy ioctl calls into universal plane handler calls, we need to
3076 * wrap the native buffer handle in a drm_framebuffer.
3078 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
3079 * buffer with a pitch of 4*width; the universal plane interface should be used
3080 * directly in cases where the hardware can support other buffer settings and
3081 * userspace wants to make use of these capabilities.
3084 * Zero on success, negative errno on failure.
3086 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
3087 struct drm_mode_cursor2 *req,
3088 struct drm_file *file_priv)
3090 struct drm_device *dev = crtc->dev;
3091 struct drm_framebuffer *fb = NULL;
3092 struct drm_mode_fb_cmd2 fbreq = {
3093 .width = req->width,
3094 .height = req->height,
3095 .pixel_format = DRM_FORMAT_ARGB8888,
3096 .pitches = { req->width * 4 },
3097 .handles = { req->handle },
3099 int32_t crtc_x, crtc_y;
3100 uint32_t crtc_w = 0, crtc_h = 0;
3101 uint32_t src_w = 0, src_h = 0;
3104 BUG_ON(!crtc->cursor);
3105 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
3108 * Obtain fb we'll be using (either new or existing) and take an extra
3109 * reference to it if fb != null. setplane will take care of dropping
3110 * the reference if the plane update fails.
3112 if (req->flags & DRM_MODE_CURSOR_BO) {
3114 fb = internal_framebuffer_create(dev, &fbreq, file_priv);
3116 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
3123 fb = crtc->cursor->fb;
3125 drm_framebuffer_reference(fb);
3128 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3132 crtc_x = crtc->cursor_x;
3133 crtc_y = crtc->cursor_y;
3138 crtc_h = fb->height;
3139 src_w = fb->width << 16;
3140 src_h = fb->height << 16;
3144 * setplane_internal will take care of deref'ing either the old or new
3145 * framebuffer depending on success.
3147 ret = __setplane_internal(crtc->cursor, crtc, fb,
3148 crtc_x, crtc_y, crtc_w, crtc_h,
3149 0, 0, src_w, src_h);
3151 /* Update successful; save new cursor position, if necessary */
3152 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
3153 crtc->cursor_x = req->x;
3154 crtc->cursor_y = req->y;
3160 static int drm_mode_cursor_common(struct drm_device *dev,
3161 struct drm_mode_cursor2 *req,
3162 struct drm_file *file_priv)
3164 struct drm_crtc *crtc;
3167 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3170 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
3173 crtc = drm_crtc_find(dev, req->crtc_id);
3175 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
3180 * If this crtc has a universal cursor plane, call that plane's update
3181 * handler rather than using legacy cursor handlers.
3183 drm_modeset_lock_crtc(crtc, crtc->cursor);
3185 ret = drm_mode_cursor_universal(crtc, req, file_priv);
3189 if (req->flags & DRM_MODE_CURSOR_BO) {
3190 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
3194 /* Turns off the cursor if handle is 0 */
3195 if (crtc->funcs->cursor_set2)
3196 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
3197 req->width, req->height, req->hot_x, req->hot_y);
3199 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
3200 req->width, req->height);
3203 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3204 if (crtc->funcs->cursor_move) {
3205 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3212 drm_modeset_unlock_crtc(crtc);
3220 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3221 * @dev: drm device for the ioctl
3222 * @data: data pointer for the ioctl
3223 * @file_priv: drm file for the ioctl call
3225 * Set the cursor configuration based on user request.
3227 * Called by the user via ioctl.
3230 * Zero on success, negative errno on failure.
3232 int drm_mode_cursor_ioctl(struct drm_device *dev,
3233 void *data, struct drm_file *file_priv)
3235 struct drm_mode_cursor *req = data;
3236 struct drm_mode_cursor2 new_req;
3238 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3239 new_req.hot_x = new_req.hot_y = 0;
3241 return drm_mode_cursor_common(dev, &new_req, file_priv);
3245 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3246 * @dev: drm device for the ioctl
3247 * @data: data pointer for the ioctl
3248 * @file_priv: drm file for the ioctl call
3250 * Set the cursor configuration based on user request. This implements the 2nd
3251 * version of the cursor ioctl, which allows userspace to additionally specify
3252 * the hotspot of the pointer.
3254 * Called by the user via ioctl.
3257 * Zero on success, negative errno on failure.
3259 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3260 void *data, struct drm_file *file_priv)
3262 struct drm_mode_cursor2 *req = data;
3264 return drm_mode_cursor_common(dev, req, file_priv);
3268 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3269 * @bpp: bits per pixels
3270 * @depth: bit depth per pixel
3272 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3273 * Useful in fbdev emulation code, since that deals in those values.
3275 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3281 fmt = DRM_FORMAT_C8;
3285 fmt = DRM_FORMAT_XRGB1555;
3287 fmt = DRM_FORMAT_RGB565;
3290 fmt = DRM_FORMAT_RGB888;
3294 fmt = DRM_FORMAT_XRGB8888;
3295 else if (depth == 30)
3296 fmt = DRM_FORMAT_XRGB2101010;
3298 fmt = DRM_FORMAT_ARGB8888;
3301 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3302 fmt = DRM_FORMAT_XRGB8888;
3308 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3311 * drm_mode_addfb - add an FB to the graphics configuration
3312 * @dev: drm device for the ioctl
3313 * @data: data pointer for the ioctl
3314 * @file_priv: drm file for the ioctl call
3316 * Add a new FB to the specified CRTC, given a user request. This is the
3317 * original addfb ioctl which only supported RGB formats.
3319 * Called by the user via ioctl.
3322 * Zero on success, negative errno on failure.
3324 int drm_mode_addfb(struct drm_device *dev,
3325 void *data, struct drm_file *file_priv)
3327 struct drm_mode_fb_cmd *or = data;
3328 struct drm_mode_fb_cmd2 r = {};
3331 /* convert to new format and call new ioctl */
3332 r.fb_id = or->fb_id;
3333 r.width = or->width;
3334 r.height = or->height;
3335 r.pitches[0] = or->pitch;
3336 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3337 r.handles[0] = or->handle;
3339 ret = drm_mode_addfb2(dev, &r, file_priv);
3343 or->fb_id = r.fb_id;
3348 static int format_check(const struct drm_mode_fb_cmd2 *r)
3350 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3354 case DRM_FORMAT_RGB332:
3355 case DRM_FORMAT_BGR233:
3356 case DRM_FORMAT_XRGB4444:
3357 case DRM_FORMAT_XBGR4444:
3358 case DRM_FORMAT_RGBX4444:
3359 case DRM_FORMAT_BGRX4444:
3360 case DRM_FORMAT_ARGB4444:
3361 case DRM_FORMAT_ABGR4444:
3362 case DRM_FORMAT_RGBA4444:
3363 case DRM_FORMAT_BGRA4444:
3364 case DRM_FORMAT_XRGB1555:
3365 case DRM_FORMAT_XBGR1555:
3366 case DRM_FORMAT_RGBX5551:
3367 case DRM_FORMAT_BGRX5551:
3368 case DRM_FORMAT_ARGB1555:
3369 case DRM_FORMAT_ABGR1555:
3370 case DRM_FORMAT_RGBA5551:
3371 case DRM_FORMAT_BGRA5551:
3372 case DRM_FORMAT_RGB565:
3373 case DRM_FORMAT_BGR565:
3374 case DRM_FORMAT_RGB888:
3375 case DRM_FORMAT_BGR888:
3376 case DRM_FORMAT_XRGB8888:
3377 case DRM_FORMAT_XBGR8888:
3378 case DRM_FORMAT_RGBX8888:
3379 case DRM_FORMAT_BGRX8888:
3380 case DRM_FORMAT_ARGB8888:
3381 case DRM_FORMAT_ABGR8888:
3382 case DRM_FORMAT_RGBA8888:
3383 case DRM_FORMAT_BGRA8888:
3384 case DRM_FORMAT_XRGB2101010:
3385 case DRM_FORMAT_XBGR2101010:
3386 case DRM_FORMAT_RGBX1010102:
3387 case DRM_FORMAT_BGRX1010102:
3388 case DRM_FORMAT_ARGB2101010:
3389 case DRM_FORMAT_ABGR2101010:
3390 case DRM_FORMAT_RGBA1010102:
3391 case DRM_FORMAT_BGRA1010102:
3392 case DRM_FORMAT_YUYV:
3393 case DRM_FORMAT_YVYU:
3394 case DRM_FORMAT_UYVY:
3395 case DRM_FORMAT_VYUY:
3396 case DRM_FORMAT_AYUV:
3397 case DRM_FORMAT_NV12:
3398 case DRM_FORMAT_NV21:
3399 case DRM_FORMAT_NV16:
3400 case DRM_FORMAT_NV61:
3401 case DRM_FORMAT_NV24:
3402 case DRM_FORMAT_NV42:
3403 case DRM_FORMAT_NV12_10:
3404 case DRM_FORMAT_NV21_10:
3405 case DRM_FORMAT_NV16_10:
3406 case DRM_FORMAT_NV61_10:
3407 case DRM_FORMAT_NV24_10:
3408 case DRM_FORMAT_NV42_10:
3409 case DRM_FORMAT_YUV410:
3410 case DRM_FORMAT_YVU410:
3411 case DRM_FORMAT_YUV411:
3412 case DRM_FORMAT_YVU411:
3413 case DRM_FORMAT_YUV420:
3414 case DRM_FORMAT_YVU420:
3415 case DRM_FORMAT_YUV422:
3416 case DRM_FORMAT_YVU422:
3417 case DRM_FORMAT_YUV444:
3418 case DRM_FORMAT_YVU444:
3421 DRM_DEBUG_KMS("invalid pixel format %s\n",
3422 drm_get_format_name(r->pixel_format));
3427 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3429 int ret, hsub, vsub, num_planes, i;
3431 ret = format_check(r);
3433 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3434 drm_get_format_name(r->pixel_format));
3438 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3439 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3440 num_planes = drm_format_num_planes(r->pixel_format);
3442 if (r->width == 0 || r->width % hsub) {
3443 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3447 if (r->height == 0 || r->height % vsub) {
3448 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3452 for (i = 0; i < num_planes; i++) {
3453 unsigned int width = r->width / (i != 0 ? hsub : 1);
3454 unsigned int height = r->height / (i != 0 ? vsub : 1);
3455 unsigned int bpp = drm_format_plane_bpp(r->pixel_format, i);
3457 if (!r->handles[i]) {
3458 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3462 if ((uint64_t) width * bpp / 8 > UINT_MAX)
3465 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3468 if (r->pitches[i] < roundup(width * bpp, 8) / 8) {
3469 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3473 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
3474 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
3479 /* modifier specific checks: */
3480 switch (r->modifier[i]) {
3481 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
3482 /* NOTE: the pitch restriction may be lifted later if it turns
3483 * out that no hw has this restriction:
3485 if (r->pixel_format != DRM_FORMAT_NV12 ||
3486 width % 128 || height % 32 ||
3487 r->pitches[i] % 128) {
3488 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
3498 for (i = num_planes; i < 4; i++) {
3499 if (r->modifier[i]) {
3500 DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
3504 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
3505 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
3508 if (r->handles[i]) {
3509 DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
3513 if (r->pitches[i]) {
3514 DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
3518 if (r->offsets[i]) {
3519 DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
3527 static struct drm_framebuffer *
3528 internal_framebuffer_create(struct drm_device *dev,
3529 struct drm_mode_fb_cmd2 *r,
3530 struct drm_file *file_priv)
3532 struct drm_mode_config *config = &dev->mode_config;
3533 struct drm_framebuffer *fb;
3536 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
3537 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3538 return ERR_PTR(-EINVAL);
3541 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3542 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3543 r->width, config->min_width, config->max_width);
3544 return ERR_PTR(-EINVAL);
3546 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3547 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3548 r->height, config->min_height, config->max_height);
3549 return ERR_PTR(-EINVAL);
3552 if (r->flags & DRM_MODE_FB_MODIFIERS &&
3553 !dev->mode_config.allow_fb_modifiers) {
3554 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
3555 return ERR_PTR(-EINVAL);
3558 ret = framebuffer_check(r);
3560 return ERR_PTR(ret);
3562 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3564 DRM_DEBUG_KMS("could not create framebuffer\n");
3572 * drm_mode_addfb2 - add an FB to the graphics configuration
3573 * @dev: drm device for the ioctl
3574 * @data: data pointer for the ioctl
3575 * @file_priv: drm file for the ioctl call
3577 * Add a new FB to the specified CRTC, given a user request with format. This is
3578 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3579 * and uses fourcc codes as pixel format specifiers.
3581 * Called by the user via ioctl.
3584 * Zero on success, negative errno on failure.
3586 int drm_mode_addfb2(struct drm_device *dev,
3587 void *data, struct drm_file *file_priv)
3589 struct drm_mode_fb_cmd2 *r = data;
3590 struct drm_framebuffer *fb;
3592 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3595 fb = internal_framebuffer_create(dev, r, file_priv);
3599 /* Transfer ownership to the filp for reaping on close */
3601 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3602 mutex_lock(&file_priv->fbs_lock);
3603 r->fb_id = fb->base.id;
3604 list_add(&fb->filp_head, &file_priv->fbs);
3605 mutex_unlock(&file_priv->fbs_lock);
3610 struct drm_mode_rmfb_work {
3611 struct work_struct work;
3612 struct list_head fbs;
3615 static void drm_mode_rmfb_work_fn(struct work_struct *w)
3617 struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
3619 while (!list_empty(&arg->fbs)) {
3620 struct drm_framebuffer *fb =
3621 list_first_entry(&arg->fbs, typeof(*fb), filp_head);
3623 list_del_init(&fb->filp_head);
3624 drm_framebuffer_remove(fb);
3629 * drm_mode_rmfb - remove an FB from the configuration
3630 * @dev: drm device for the ioctl
3631 * @data: data pointer for the ioctl
3632 * @file_priv: drm file for the ioctl call
3634 * Remove the FB specified by the user.
3636 * Called by the user via ioctl.
3639 * Zero on success, negative errno on failure.
3641 int drm_mode_rmfb(struct drm_device *dev,
3642 void *data, struct drm_file *file_priv)
3644 struct drm_framebuffer *fb = NULL;
3645 struct drm_framebuffer *fbl = NULL;
3646 uint32_t *id = data;
3649 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3652 mutex_lock(&file_priv->fbs_lock);
3653 mutex_lock(&dev->mode_config.fb_lock);
3654 fb = __drm_framebuffer_lookup(dev, *id);
3658 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3664 list_del_init(&fb->filp_head);
3665 mutex_unlock(&dev->mode_config.fb_lock);
3666 mutex_unlock(&file_priv->fbs_lock);
3669 * we now own the reference that was stored in the fbs list
3671 * drm_framebuffer_remove may fail with -EINTR on pending signals,
3672 * so run this in a separate stack as there's no way to correctly
3673 * handle this after the fb is already removed from the lookup table.
3675 if (atomic_read(&fb->refcount.refcount) > 1) {
3676 struct drm_mode_rmfb_work arg;
3678 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3679 INIT_LIST_HEAD(&arg.fbs);
3680 list_add_tail(&fb->filp_head, &arg.fbs);
3682 schedule_work(&arg.work);
3683 flush_work(&arg.work);
3684 destroy_work_on_stack(&arg.work);
3686 drm_framebuffer_unreference(fb);
3691 mutex_unlock(&dev->mode_config.fb_lock);
3692 mutex_unlock(&file_priv->fbs_lock);
3698 * drm_mode_getfb - get FB info
3699 * @dev: drm device for the ioctl
3700 * @data: data pointer for the ioctl
3701 * @file_priv: drm file for the ioctl call
3703 * Lookup the FB given its ID and return info about it.
3705 * Called by the user via ioctl.
3708 * Zero on success, negative errno on failure.
3710 int drm_mode_getfb(struct drm_device *dev,
3711 void *data, struct drm_file *file_priv)
3713 struct drm_mode_fb_cmd *r = data;
3714 struct drm_framebuffer *fb;
3717 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3720 fb = drm_framebuffer_lookup(dev, r->fb_id);
3724 r->height = fb->height;
3725 r->width = fb->width;
3726 r->depth = fb->depth;
3727 r->bpp = fb->bits_per_pixel;
3728 r->pitch = fb->pitches[0];
3729 if (fb->funcs->create_handle) {
3730 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3731 drm_is_control_client(file_priv)) {
3732 ret = fb->funcs->create_handle(fb, file_priv,
3735 /* GET_FB() is an unprivileged ioctl so we must not
3736 * return a buffer-handle to non-master processes! For
3737 * backwards-compatibility reasons, we cannot make
3738 * GET_FB() privileged, so just return an invalid handle
3739 * for non-masters. */
3747 drm_framebuffer_unreference(fb);
3753 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3754 * @dev: drm device for the ioctl
3755 * @data: data pointer for the ioctl
3756 * @file_priv: drm file for the ioctl call
3758 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3759 * rectangle list. Generic userspace which does frontbuffer rendering must call
3760 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3761 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3763 * Modesetting drivers which always update the frontbuffer do not need to
3764 * implement the corresponding ->dirty framebuffer callback.
3766 * Called by the user via ioctl.
3769 * Zero on success, negative errno on failure.
3771 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3772 void *data, struct drm_file *file_priv)
3774 struct drm_clip_rect __user *clips_ptr;
3775 struct drm_clip_rect *clips = NULL;
3776 struct drm_mode_fb_dirty_cmd *r = data;
3777 struct drm_framebuffer *fb;
3782 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3785 fb = drm_framebuffer_lookup(dev, r->fb_id);
3789 num_clips = r->num_clips;
3790 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3792 if (!num_clips != !clips_ptr) {
3797 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3799 /* If userspace annotates copy, clips must come in pairs */
3800 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3805 if (num_clips && clips_ptr) {
3806 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3810 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3816 ret = copy_from_user(clips, clips_ptr,
3817 num_clips * sizeof(*clips));
3824 if (fb->funcs->dirty) {
3825 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3834 drm_framebuffer_unreference(fb);
3840 * drm_fb_release - remove and free the FBs on this file
3841 * @priv: drm file for the ioctl
3843 * Destroy all the FBs associated with @filp.
3845 * Called by the user via ioctl.
3848 * Zero on success, negative errno on failure.
3850 void drm_fb_release(struct drm_file *priv)
3852 struct drm_framebuffer *fb, *tfb;
3853 struct drm_mode_rmfb_work arg;
3855 INIT_LIST_HEAD(&arg.fbs);
3858 * When the file gets released that means no one else can access the fb
3859 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3860 * avoid upsetting lockdep since the universal cursor code adds a
3861 * framebuffer while holding mutex locks.
3863 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3864 * locks is impossible here since no one else but this function can get
3867 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3868 if (atomic_read(&fb->refcount.refcount) > 1) {
3869 list_move_tail(&fb->filp_head, &arg.fbs);
3871 list_del_init(&fb->filp_head);
3873 /* This drops the fpriv->fbs reference. */
3874 drm_framebuffer_unreference(fb);
3878 if (!list_empty(&arg.fbs)) {
3879 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3881 schedule_work(&arg.work);
3882 flush_work(&arg.work);
3883 destroy_work_on_stack(&arg.work);
3888 * drm_property_create - create a new property type
3890 * @flags: flags specifying the property type
3891 * @name: name of the property
3892 * @num_values: number of pre-defined values
3894 * This creates a new generic drm property which can then be attached to a drm
3895 * object with drm_object_attach_property. The returned property object must be
3896 * freed with drm_property_destroy.
3898 * Note that the DRM core keeps a per-device list of properties and that, if
3899 * drm_mode_config_cleanup() is called, it will destroy all properties created
3903 * A pointer to the newly created property on success, NULL on failure.
3905 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3906 const char *name, int num_values)
3908 struct drm_property *property = NULL;
3911 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3915 property->dev = dev;
3918 property->values = kcalloc(num_values, sizeof(uint64_t),
3920 if (!property->values)
3924 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3928 property->flags = flags;
3929 property->num_values = num_values;
3930 INIT_LIST_HEAD(&property->enum_list);
3933 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3934 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3937 list_add_tail(&property->head, &dev->mode_config.property_list);
3939 WARN_ON(!drm_property_type_valid(property));
3943 kfree(property->values);
3947 EXPORT_SYMBOL(drm_property_create);
3950 * drm_property_create_enum - create a new enumeration property type
3952 * @flags: flags specifying the property type
3953 * @name: name of the property
3954 * @props: enumeration lists with property values
3955 * @num_values: number of pre-defined values
3957 * This creates a new generic drm property which can then be attached to a drm
3958 * object with drm_object_attach_property. The returned property object must be
3959 * freed with drm_property_destroy.
3961 * Userspace is only allowed to set one of the predefined values for enumeration
3965 * A pointer to the newly created property on success, NULL on failure.
3967 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3969 const struct drm_prop_enum_list *props,
3972 struct drm_property *property;
3975 flags |= DRM_MODE_PROP_ENUM;
3977 property = drm_property_create(dev, flags, name, num_values);
3981 for (i = 0; i < num_values; i++) {
3982 ret = drm_property_add_enum(property, i,
3986 drm_property_destroy(dev, property);
3993 EXPORT_SYMBOL(drm_property_create_enum);
3996 * drm_property_create_bitmask - create a new bitmask property type
3998 * @flags: flags specifying the property type
3999 * @name: name of the property
4000 * @props: enumeration lists with property bitflags
4001 * @num_props: size of the @props array
4002 * @supported_bits: bitmask of all supported enumeration values
4004 * This creates a new bitmask drm property which can then be attached to a drm
4005 * object with drm_object_attach_property. The returned property object must be
4006 * freed with drm_property_destroy.
4008 * Compared to plain enumeration properties userspace is allowed to set any
4009 * or'ed together combination of the predefined property bitflag values
4012 * A pointer to the newly created property on success, NULL on failure.
4014 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
4015 int flags, const char *name,
4016 const struct drm_prop_enum_list *props,
4018 uint64_t supported_bits)
4020 struct drm_property *property;
4021 int i, ret, index = 0;
4022 int num_values = hweight64(supported_bits);
4024 flags |= DRM_MODE_PROP_BITMASK;
4026 property = drm_property_create(dev, flags, name, num_values);
4029 for (i = 0; i < num_props; i++) {
4030 if (!(supported_bits & (1ULL << props[i].type)))
4033 if (WARN_ON(index >= num_values)) {
4034 drm_property_destroy(dev, property);
4038 ret = drm_property_add_enum(property, index++,
4042 drm_property_destroy(dev, property);
4049 EXPORT_SYMBOL(drm_property_create_bitmask);
4051 static struct drm_property *property_create_range(struct drm_device *dev,
4052 int flags, const char *name,
4053 uint64_t min, uint64_t max)
4055 struct drm_property *property;
4057 property = drm_property_create(dev, flags, name, 2);
4061 property->values[0] = min;
4062 property->values[1] = max;
4068 * drm_property_create_range - create a new unsigned ranged property type
4070 * @flags: flags specifying the property type
4071 * @name: name of the property
4072 * @min: minimum value of the property
4073 * @max: maximum value of the property
4075 * This creates a new generic drm property which can then be attached to a drm
4076 * object with drm_object_attach_property. The returned property object must be
4077 * freed with drm_property_destroy.
4079 * Userspace is allowed to set any unsigned integer value in the (min, max)
4083 * A pointer to the newly created property on success, NULL on failure.
4085 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
4087 uint64_t min, uint64_t max)
4089 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
4092 EXPORT_SYMBOL(drm_property_create_range);
4095 * drm_property_create_signed_range - create a new signed ranged property type
4097 * @flags: flags specifying the property type
4098 * @name: name of the property
4099 * @min: minimum value of the property
4100 * @max: maximum value of the property
4102 * This creates a new generic drm property which can then be attached to a drm
4103 * object with drm_object_attach_property. The returned property object must be
4104 * freed with drm_property_destroy.
4106 * Userspace is allowed to set any signed integer value in the (min, max)
4110 * A pointer to the newly created property on success, NULL on failure.
4112 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
4113 int flags, const char *name,
4114 int64_t min, int64_t max)
4116 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
4117 name, I642U64(min), I642U64(max));
4119 EXPORT_SYMBOL(drm_property_create_signed_range);
4122 * drm_property_create_object - create a new object property type
4124 * @flags: flags specifying the property type
4125 * @name: name of the property
4126 * @type: object type from DRM_MODE_OBJECT_* defines
4128 * This creates a new generic drm property which can then be attached to a drm
4129 * object with drm_object_attach_property. The returned property object must be
4130 * freed with drm_property_destroy.
4132 * Userspace is only allowed to set this to any property value of the given
4133 * @type. Only useful for atomic properties, which is enforced.
4136 * A pointer to the newly created property on success, NULL on failure.
4138 struct drm_property *drm_property_create_object(struct drm_device *dev,
4139 int flags, const char *name, uint32_t type)
4141 struct drm_property *property;
4143 flags |= DRM_MODE_PROP_OBJECT;
4145 if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
4148 property = drm_property_create(dev, flags, name, 1);
4152 property->values[0] = type;
4156 EXPORT_SYMBOL(drm_property_create_object);
4159 * drm_property_create_bool - create a new boolean property type
4161 * @flags: flags specifying the property type
4162 * @name: name of the property
4164 * This creates a new generic drm property which can then be attached to a drm
4165 * object with drm_object_attach_property. The returned property object must be
4166 * freed with drm_property_destroy.
4168 * This is implemented as a ranged property with only {0, 1} as valid values.
4171 * A pointer to the newly created property on success, NULL on failure.
4173 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
4176 return drm_property_create_range(dev, flags, name, 0, 1);
4178 EXPORT_SYMBOL(drm_property_create_bool);
4181 * drm_property_add_enum - add a possible value to an enumeration property
4182 * @property: enumeration property to change
4183 * @index: index of the new enumeration
4184 * @value: value of the new enumeration
4185 * @name: symbolic name of the new enumeration
4187 * This functions adds enumerations to a property.
4189 * It's use is deprecated, drivers should use one of the more specific helpers
4190 * to directly create the property with all enumerations already attached.
4193 * Zero on success, error code on failure.
4195 int drm_property_add_enum(struct drm_property *property, int index,
4196 uint64_t value, const char *name)
4198 struct drm_property_enum *prop_enum;
4200 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4201 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
4205 * Bitmask enum properties have the additional constraint of values
4208 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
4212 if (!list_empty(&property->enum_list)) {
4213 list_for_each_entry(prop_enum, &property->enum_list, head) {
4214 if (prop_enum->value == value) {
4215 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4216 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4222 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
4226 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4227 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4228 prop_enum->value = value;
4230 property->values[index] = value;
4231 list_add_tail(&prop_enum->head, &property->enum_list);
4234 EXPORT_SYMBOL(drm_property_add_enum);
4237 * drm_property_destroy - destroy a drm property
4239 * @property: property to destry
4241 * This function frees a property including any attached resources like
4242 * enumeration values.
4244 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
4246 struct drm_property_enum *prop_enum, *pt;
4248 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
4249 list_del(&prop_enum->head);
4253 if (property->num_values)
4254 kfree(property->values);
4255 drm_mode_object_put(dev, &property->base);
4256 list_del(&property->head);
4259 EXPORT_SYMBOL(drm_property_destroy);
4262 * drm_object_attach_property - attach a property to a modeset object
4263 * @obj: drm modeset object
4264 * @property: property to attach
4265 * @init_val: initial value of the property
4267 * This attaches the given property to the modeset object with the given initial
4268 * value. Currently this function cannot fail since the properties are stored in
4269 * a statically sized array.
4271 void drm_object_attach_property(struct drm_mode_object *obj,
4272 struct drm_property *property,
4275 int count = obj->properties->count;
4277 if (count == DRM_OBJECT_MAX_PROPERTY) {
4278 WARN(1, "Failed to attach object property (type: 0x%x). Please "
4279 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
4280 "you see this message on the same object type.\n",
4285 obj->properties->properties[count] = property;
4286 obj->properties->values[count] = init_val;
4287 obj->properties->count++;
4288 if (property->flags & DRM_MODE_PROP_ATOMIC)
4289 obj->properties->atomic_count++;
4291 EXPORT_SYMBOL(drm_object_attach_property);
4294 * drm_object_property_set_value - set the value of a property
4295 * @obj: drm mode object to set property value for
4296 * @property: property to set
4297 * @val: value the property should be set to
4299 * This functions sets a given property on a given object. This function only
4300 * changes the software state of the property, it does not call into the
4301 * driver's ->set_property callback.
4304 * Zero on success, error code on failure.
4306 int drm_object_property_set_value(struct drm_mode_object *obj,
4307 struct drm_property *property, uint64_t val)
4311 for (i = 0; i < obj->properties->count; i++) {
4312 if (obj->properties->properties[i] == property) {
4313 obj->properties->values[i] = val;
4320 EXPORT_SYMBOL(drm_object_property_set_value);
4323 * drm_object_property_get_value - retrieve the value of a property
4324 * @obj: drm mode object to get property value from
4325 * @property: property to retrieve
4326 * @val: storage for the property value
4328 * This function retrieves the softare state of the given property for the given
4329 * property. Since there is no driver callback to retrieve the current property
4330 * value this might be out of sync with the hardware, depending upon the driver
4334 * Zero on success, error code on failure.
4336 int drm_object_property_get_value(struct drm_mode_object *obj,
4337 struct drm_property *property, uint64_t *val)
4341 /* read-only properties bypass atomic mechanism and still store
4342 * their value in obj->properties->values[].. mostly to avoid
4343 * having to deal w/ EDID and similar props in atomic paths:
4345 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
4346 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
4347 return drm_atomic_get_property(obj, property, val);
4349 for (i = 0; i < obj->properties->count; i++) {
4350 if (obj->properties->properties[i] == property) {
4351 *val = obj->properties->values[i];
4358 EXPORT_SYMBOL(drm_object_property_get_value);
4361 * drm_mode_getproperty_ioctl - get the property metadata
4364 * @file_priv: DRM file info
4366 * This function retrieves the metadata for a given property, like the different
4367 * possible values for an enum property or the limits for a range property.
4369 * Blob properties are special
4371 * Called by the user via ioctl.
4374 * Zero on success, negative errno on failure.
4376 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4377 void *data, struct drm_file *file_priv)
4379 struct drm_mode_get_property *out_resp = data;
4380 struct drm_property *property;
4382 int value_count = 0;
4385 struct drm_property_enum *prop_enum;
4386 struct drm_mode_property_enum __user *enum_ptr;
4387 uint64_t __user *values_ptr;
4389 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4392 drm_modeset_lock_all(dev);
4393 property = drm_property_find(dev, out_resp->prop_id);
4399 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4400 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4401 list_for_each_entry(prop_enum, &property->enum_list, head)
4405 value_count = property->num_values;
4407 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4408 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4409 out_resp->flags = property->flags;
4411 if ((out_resp->count_values >= value_count) && value_count) {
4412 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4413 for (i = 0; i < value_count; i++) {
4414 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4420 out_resp->count_values = value_count;
4422 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4423 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4424 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4426 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4427 list_for_each_entry(prop_enum, &property->enum_list, head) {
4429 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4434 if (copy_to_user(&enum_ptr[copied].name,
4435 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4442 out_resp->count_enum_blobs = enum_count;
4446 * NOTE: The idea seems to have been to use this to read all the blob
4447 * property values. But nothing ever added them to the corresponding
4448 * list, userspace always used the special-purpose get_blob ioctl to
4449 * read the value for a blob property. It also doesn't make a lot of
4450 * sense to return values here when everything else is just metadata for
4451 * the property itself.
4453 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4454 out_resp->count_enum_blobs = 0;
4456 drm_modeset_unlock_all(dev);
4461 * drm_property_create_blob - Create new blob property
4463 * Creates a new blob property for a specified DRM device, optionally
4466 * @dev: DRM device to create property for
4467 * @length: Length to allocate for blob data
4468 * @data: If specified, copies data into blob
4471 * New blob property with a single reference on success, or an ERR_PTR
4474 struct drm_property_blob *
4475 drm_property_create_blob(struct drm_device *dev, size_t length,
4478 struct drm_property_blob *blob;
4481 if (!length || length > ULONG_MAX - sizeof(struct drm_property_blob))
4482 return ERR_PTR(-EINVAL);
4484 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4486 return ERR_PTR(-ENOMEM);
4488 /* This must be explicitly initialised, so we can safely call list_del
4489 * on it in the removal handler, even if it isn't in a file list. */
4490 INIT_LIST_HEAD(&blob->head_file);
4491 blob->length = length;
4495 memcpy(blob->data, data, length);
4497 mutex_lock(&dev->mode_config.blob_lock);
4499 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4502 mutex_unlock(&dev->mode_config.blob_lock);
4503 return ERR_PTR(-EINVAL);
4506 kref_init(&blob->refcount);
4508 list_add_tail(&blob->head_global,
4509 &dev->mode_config.property_blob_list);
4511 mutex_unlock(&dev->mode_config.blob_lock);
4515 EXPORT_SYMBOL(drm_property_create_blob);
4518 * drm_property_free_blob - Blob property destructor
4520 * Internal free function for blob properties; must not be used directly.
4524 static void drm_property_free_blob(struct kref *kref)
4526 struct drm_property_blob *blob =
4527 container_of(kref, struct drm_property_blob, refcount);
4529 WARN_ON(!mutex_is_locked(&blob->dev->mode_config.blob_lock));
4531 list_del(&blob->head_global);
4532 list_del(&blob->head_file);
4533 drm_mode_object_put(blob->dev, &blob->base);
4539 * drm_property_unreference_blob - Unreference a blob property
4541 * Drop a reference on a blob property. May free the object.
4543 * @blob: Pointer to blob property
4545 void drm_property_unreference_blob(struct drm_property_blob *blob)
4547 struct drm_device *dev;
4554 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4556 if (kref_put_mutex(&blob->refcount, drm_property_free_blob,
4557 &dev->mode_config.blob_lock))
4558 mutex_unlock(&dev->mode_config.blob_lock);
4560 might_lock(&dev->mode_config.blob_lock);
4562 EXPORT_SYMBOL(drm_property_unreference_blob);
4565 * drm_property_unreference_blob_locked - Unreference a blob property with blob_lock held
4567 * Drop a reference on a blob property. May free the object. This must be
4568 * called with blob_lock held.
4570 * @blob: Pointer to blob property
4572 static void drm_property_unreference_blob_locked(struct drm_property_blob *blob)
4577 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4579 kref_put(&blob->refcount, drm_property_free_blob);
4583 * drm_property_destroy_user_blobs - destroy all blobs created by this client
4585 * @file_priv: destroy all blobs owned by this file handle
4587 void drm_property_destroy_user_blobs(struct drm_device *dev,
4588 struct drm_file *file_priv)
4590 struct drm_property_blob *blob, *bt;
4592 mutex_lock(&dev->mode_config.blob_lock);
4594 list_for_each_entry_safe(blob, bt, &file_priv->blobs, head_file) {
4595 list_del_init(&blob->head_file);
4596 drm_property_unreference_blob_locked(blob);
4599 mutex_unlock(&dev->mode_config.blob_lock);
4603 * drm_property_reference_blob - Take a reference on an existing property
4605 * Take a new reference on an existing blob property.
4607 * @blob: Pointer to blob property
4609 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob)
4611 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4612 kref_get(&blob->refcount);
4615 EXPORT_SYMBOL(drm_property_reference_blob);
4618 * Like drm_property_lookup_blob, but does not return an additional reference.
4619 * Must be called with blob_lock held.
4621 static struct drm_property_blob *__drm_property_lookup_blob(struct drm_device *dev,
4624 struct drm_mode_object *obj = NULL;
4625 struct drm_property_blob *blob;
4627 WARN_ON(!mutex_is_locked(&dev->mode_config.blob_lock));
4629 mutex_lock(&dev->mode_config.idr_mutex);
4630 obj = idr_find(&dev->mode_config.crtc_idr, id);
4631 if (!obj || (obj->type != DRM_MODE_OBJECT_BLOB) || (obj->id != id))
4634 blob = obj_to_blob(obj);
4635 mutex_unlock(&dev->mode_config.idr_mutex);
4641 * drm_property_lookup_blob - look up a blob property and take a reference
4643 * @id: id of the blob property
4645 * If successful, this takes an additional reference to the blob property.
4646 * callers need to make sure to eventually unreference the returned property
4647 * again, using @drm_property_unreference_blob.
4649 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
4652 struct drm_property_blob *blob;
4654 mutex_lock(&dev->mode_config.blob_lock);
4655 blob = __drm_property_lookup_blob(dev, id);
4657 if (!kref_get_unless_zero(&blob->refcount))
4660 mutex_unlock(&dev->mode_config.blob_lock);
4664 EXPORT_SYMBOL(drm_property_lookup_blob);
4667 * drm_property_replace_global_blob - atomically replace existing blob property
4669 * @replace: location of blob property pointer to be replaced
4670 * @length: length of data for new blob, or 0 for no data
4671 * @data: content for new blob, or NULL for no data
4672 * @obj_holds_id: optional object for property holding blob ID
4673 * @prop_holds_id: optional property holding blob ID
4674 * @return 0 on success or error on failure
4676 * This function will atomically replace a global property in the blob list,
4677 * optionally updating a property which holds the ID of that property. It is
4678 * guaranteed to be atomic: no caller will be allowed to see intermediate
4679 * results, and either the entire operation will succeed and clean up the
4680 * previous property, or it will fail and the state will be unchanged.
4682 * If length is 0 or data is NULL, no new blob will be created, and the holding
4683 * property, if specified, will be set to 0.
4685 * Access to the replace pointer is assumed to be protected by the caller, e.g.
4686 * by holding the relevant modesetting object lock for its parent.
4688 * For example, a drm_connector has a 'PATH' property, which contains the ID
4689 * of a blob property with the value of the MST path information. Calling this
4690 * function with replace pointing to the connector's path_blob_ptr, length and
4691 * data set for the new path information, obj_holds_id set to the connector's
4692 * base object, and prop_holds_id set to the path property name, will perform
4693 * a completely atomic update. The access to path_blob_ptr is protected by the
4694 * caller holding a lock on the connector.
4696 static int drm_property_replace_global_blob(struct drm_device *dev,
4697 struct drm_property_blob **replace,
4700 struct drm_mode_object *obj_holds_id,
4701 struct drm_property *prop_holds_id)
4703 struct drm_property_blob *new_blob = NULL;
4704 struct drm_property_blob *old_blob = NULL;
4707 WARN_ON(replace == NULL);
4709 old_blob = *replace;
4711 if (length && data) {
4712 new_blob = drm_property_create_blob(dev, length, data);
4713 if (IS_ERR(new_blob))
4714 return PTR_ERR(new_blob);
4717 /* This does not need to be synchronised with blob_lock, as the
4718 * get_properties ioctl locks all modesetting objects, and
4719 * obj_holds_id must be locked before calling here, so we cannot
4720 * have its value out of sync with the list membership modified
4721 * below under blob_lock. */
4723 ret = drm_object_property_set_value(obj_holds_id,
4726 new_blob->base.id : 0);
4731 drm_property_unreference_blob(old_blob);
4732 *replace = new_blob;
4737 drm_property_unreference_blob(new_blob);
4742 * drm_mode_getblob_ioctl - get the contents of a blob property value
4745 * @file_priv: DRM file info
4747 * This function retrieves the contents of a blob property. The value stored in
4748 * an object's blob property is just a normal modeset object id.
4750 * Called by the user via ioctl.
4753 * Zero on success, negative errno on failure.
4755 int drm_mode_getblob_ioctl(struct drm_device *dev,
4756 void *data, struct drm_file *file_priv)
4758 struct drm_mode_get_blob *out_resp = data;
4759 struct drm_property_blob *blob;
4761 void __user *blob_ptr;
4763 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4766 drm_modeset_lock_all(dev);
4767 mutex_lock(&dev->mode_config.blob_lock);
4768 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4774 if (out_resp->length == blob->length) {
4775 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4776 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4781 out_resp->length = blob->length;
4784 mutex_unlock(&dev->mode_config.blob_lock);
4785 drm_modeset_unlock_all(dev);
4790 * drm_mode_createblob_ioctl - create a new blob property
4793 * @file_priv: DRM file info
4795 * This function creates a new blob property with user-defined values. In order
4796 * to give us sensible validation and checking when creating, rather than at
4797 * every potential use, we also require a type to be provided upfront.
4799 * Called by the user via ioctl.
4802 * Zero on success, negative errno on failure.
4804 int drm_mode_createblob_ioctl(struct drm_device *dev,
4805 void *data, struct drm_file *file_priv)
4807 struct drm_mode_create_blob *out_resp = data;
4808 struct drm_property_blob *blob;
4809 void __user *blob_ptr;
4812 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4815 blob = drm_property_create_blob(dev, out_resp->length, NULL);
4817 return PTR_ERR(blob);
4819 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4820 if (copy_from_user(blob->data, blob_ptr, out_resp->length)) {
4825 /* Dropping the lock between create_blob and our access here is safe
4826 * as only the same file_priv can remove the blob; at this point, it is
4827 * not associated with any file_priv. */
4828 mutex_lock(&dev->mode_config.blob_lock);
4829 out_resp->blob_id = blob->base.id;
4830 list_add_tail(&blob->head_file, &file_priv->blobs);
4831 mutex_unlock(&dev->mode_config.blob_lock);
4836 drm_property_unreference_blob(blob);
4841 * drm_mode_destroyblob_ioctl - destroy a user blob property
4844 * @file_priv: DRM file info
4846 * Destroy an existing user-defined blob property.
4848 * Called by the user via ioctl.
4851 * Zero on success, negative errno on failure.
4853 int drm_mode_destroyblob_ioctl(struct drm_device *dev,
4854 void *data, struct drm_file *file_priv)
4856 struct drm_mode_destroy_blob *out_resp = data;
4857 struct drm_property_blob *blob = NULL, *bt;
4861 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4864 mutex_lock(&dev->mode_config.blob_lock);
4865 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4871 /* Ensure the property was actually created by this user. */
4872 list_for_each_entry(bt, &file_priv->blobs, head_file) {
4884 /* We must drop head_file here, because we may not be the last
4885 * reference on the blob. */
4886 list_del_init(&blob->head_file);
4887 drm_property_unreference_blob_locked(blob);
4888 mutex_unlock(&dev->mode_config.blob_lock);
4893 mutex_unlock(&dev->mode_config.blob_lock);
4898 * drm_mode_connector_set_path_property - set tile property on connector
4899 * @connector: connector to set property on.
4900 * @path: path to use for property; must not be NULL.
4902 * This creates a property to expose to userspace to specify a
4903 * connector path. This is mainly used for DisplayPort MST where
4904 * connectors have a topology and we want to allow userspace to give
4905 * them more meaningful names.
4908 * Zero on success, negative errno on failure.
4910 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4913 struct drm_device *dev = connector->dev;
4916 ret = drm_property_replace_global_blob(dev,
4917 &connector->path_blob_ptr,
4921 dev->mode_config.path_property);
4924 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4927 * drm_mode_connector_set_tile_property - set tile property on connector
4928 * @connector: connector to set property on.
4930 * This looks up the tile information for a connector, and creates a
4931 * property for userspace to parse if it exists. The property is of
4932 * the form of 8 integers using ':' as a separator.
4935 * Zero on success, errno on failure.
4937 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4939 struct drm_device *dev = connector->dev;
4943 if (!connector->has_tile) {
4944 ret = drm_property_replace_global_blob(dev,
4945 &connector->tile_blob_ptr,
4949 dev->mode_config.tile_property);
4953 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4954 connector->tile_group->id, connector->tile_is_single_monitor,
4955 connector->num_h_tile, connector->num_v_tile,
4956 connector->tile_h_loc, connector->tile_v_loc,
4957 connector->tile_h_size, connector->tile_v_size);
4959 ret = drm_property_replace_global_blob(dev,
4960 &connector->tile_blob_ptr,
4964 dev->mode_config.tile_property);
4967 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4970 * drm_mode_connector_update_edid_property - update the edid property of a connector
4971 * @connector: drm connector
4972 * @edid: new value of the edid property
4974 * This function creates a new blob modeset object and assigns its id to the
4975 * connector's edid property.
4978 * Zero on success, negative errno on failure.
4980 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4981 const struct edid *edid)
4983 struct drm_device *dev = connector->dev;
4987 /* ignore requests to set edid when overridden */
4988 if (connector->override_edid)
4992 size = EDID_LENGTH * (1 + edid->extensions);
4994 ret = drm_property_replace_global_blob(dev,
4995 &connector->edid_blob_ptr,
4999 dev->mode_config.edid_property);
5002 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
5004 /* Some properties could refer to dynamic refcnt'd objects, or things that
5005 * need special locking to handle lifetime issues (ie. to ensure the prop
5006 * value doesn't become invalid part way through the property update due to
5007 * race). The value returned by reference via 'obj' should be passed back
5008 * to drm_property_change_valid_put() after the property is set (and the
5009 * object to which the property is attached has a chance to take it's own
5012 bool drm_property_change_valid_get(struct drm_property *property,
5013 uint64_t value, struct drm_mode_object **ref)
5017 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
5022 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
5023 if (value < property->values[0] || value > property->values[1])
5026 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
5027 int64_t svalue = U642I64(value);
5029 if (svalue < U642I64(property->values[0]) ||
5030 svalue > U642I64(property->values[1]))
5033 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
5034 uint64_t valid_mask = 0;
5036 for (i = 0; i < property->num_values; i++)
5037 valid_mask |= (1ULL << property->values[i]);
5038 return !(value & ~valid_mask);
5039 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
5040 struct drm_property_blob *blob;
5045 blob = drm_property_lookup_blob(property->dev, value);
5052 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
5053 /* a zero value for an object property translates to null: */
5057 /* handle refcnt'd objects specially: */
5058 if (property->values[0] == DRM_MODE_OBJECT_FB) {
5059 struct drm_framebuffer *fb;
5060 fb = drm_framebuffer_lookup(property->dev, value);
5068 return _object_find(property->dev, value, property->values[0]) != NULL;
5072 for (i = 0; i < property->num_values; i++)
5073 if (property->values[i] == value)
5078 void drm_property_change_valid_put(struct drm_property *property,
5079 struct drm_mode_object *ref)
5084 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
5085 if (property->values[0] == DRM_MODE_OBJECT_FB)
5086 drm_framebuffer_unreference(obj_to_fb(ref));
5087 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
5088 drm_property_unreference_blob(obj_to_blob(ref));
5092 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
5095 * @file_priv: DRM file info
5097 * This function sets the current value for a connectors's property. It also
5098 * calls into a driver's ->set_property callback to update the hardware state
5100 * Called by the user via ioctl.
5103 * Zero on success, negative errno on failure.
5105 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
5106 void *data, struct drm_file *file_priv)
5108 struct drm_mode_connector_set_property *conn_set_prop = data;
5109 struct drm_mode_obj_set_property obj_set_prop = {
5110 .value = conn_set_prop->value,
5111 .prop_id = conn_set_prop->prop_id,
5112 .obj_id = conn_set_prop->connector_id,
5113 .obj_type = DRM_MODE_OBJECT_CONNECTOR
5116 /* It does all the locking and checking we need */
5117 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
5120 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
5121 struct drm_property *property,
5125 struct drm_connector *connector = obj_to_connector(obj);
5127 /* Do DPMS ourselves */
5128 if (property == connector->dev->mode_config.dpms_property) {
5130 if (connector->funcs->dpms)
5131 ret = (*connector->funcs->dpms)(connector, (int)value);
5132 } else if (connector->funcs->set_property)
5133 ret = connector->funcs->set_property(connector, property, value);
5135 /* store the property value if successful */
5137 drm_object_property_set_value(&connector->base, property, value);
5141 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
5142 struct drm_property *property,
5146 struct drm_crtc *crtc = obj_to_crtc(obj);
5148 if (crtc->funcs->set_property)
5149 ret = crtc->funcs->set_property(crtc, property, value);
5151 drm_object_property_set_value(obj, property, value);
5157 * drm_mode_plane_set_obj_prop - set the value of a property
5158 * @plane: drm plane object to set property value for
5159 * @property: property to set
5160 * @value: value the property should be set to
5162 * This functions sets a given property on a given plane object. This function
5163 * calls the driver's ->set_property callback and changes the software state of
5164 * the property if the callback succeeds.
5167 * Zero on success, error code on failure.
5169 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
5170 struct drm_property *property,
5174 struct drm_mode_object *obj = &plane->base;
5176 if (plane->funcs->set_property)
5177 ret = plane->funcs->set_property(plane, property, value);
5179 drm_object_property_set_value(obj, property, value);
5183 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
5186 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
5189 * @file_priv: DRM file info
5191 * This function retrieves the current value for an object's property. Compared
5192 * to the connector specific ioctl this one is extended to also work on crtc and
5195 * Called by the user via ioctl.
5198 * Zero on success, negative errno on failure.
5200 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
5201 struct drm_file *file_priv)
5203 struct drm_mode_obj_get_properties *arg = data;
5204 struct drm_mode_object *obj;
5207 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5210 drm_modeset_lock_all(dev);
5212 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5217 if (!obj->properties) {
5222 ret = get_properties(obj, file_priv->atomic,
5223 (uint32_t __user *)(unsigned long)(arg->props_ptr),
5224 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
5228 drm_modeset_unlock_all(dev);
5233 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
5236 * @file_priv: DRM file info
5238 * This function sets the current value for an object's property. It also calls
5239 * into a driver's ->set_property callback to update the hardware state.
5240 * Compared to the connector specific ioctl this one is extended to also work on
5241 * crtc and plane objects.
5243 * Called by the user via ioctl.
5246 * Zero on success, negative errno on failure.
5248 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
5249 struct drm_file *file_priv)
5251 struct drm_mode_obj_set_property *arg = data;
5252 struct drm_mode_object *arg_obj;
5253 struct drm_mode_object *prop_obj;
5254 struct drm_property *property;
5255 int i, ret = -EINVAL;
5256 struct drm_mode_object *ref;
5258 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5261 drm_modeset_lock_all(dev);
5263 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5268 if (!arg_obj->properties)
5271 for (i = 0; i < arg_obj->properties->count; i++)
5272 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
5275 if (i == arg_obj->properties->count)
5278 prop_obj = drm_mode_object_find(dev, arg->prop_id,
5279 DRM_MODE_OBJECT_PROPERTY);
5284 property = obj_to_property(prop_obj);
5286 if (!drm_property_change_valid_get(property, arg->value, &ref))
5289 switch (arg_obj->type) {
5290 case DRM_MODE_OBJECT_CONNECTOR:
5291 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
5294 case DRM_MODE_OBJECT_CRTC:
5295 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
5297 case DRM_MODE_OBJECT_PLANE:
5298 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
5299 property, arg->value);
5303 drm_property_change_valid_put(property, ref);
5306 drm_modeset_unlock_all(dev);
5311 * drm_mode_connector_attach_encoder - attach a connector to an encoder
5312 * @connector: connector to attach
5313 * @encoder: encoder to attach @connector to
5315 * This function links up a connector to an encoder. Note that the routing
5316 * restrictions between encoders and crtcs are exposed to userspace through the
5317 * possible_clones and possible_crtcs bitmasks.
5320 * Zero on success, negative errno on failure.
5322 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
5323 struct drm_encoder *encoder)
5328 * In the past, drivers have attempted to model the static association
5329 * of connector to encoder in simple connector/encoder devices using a
5330 * direct assignment of connector->encoder = encoder. This connection
5331 * is a logical one and the responsibility of the core, so drivers are
5332 * expected not to mess with this.
5334 * Note that the error return should've been enough here, but a large
5335 * majority of drivers ignores the return value, so add in a big WARN
5336 * to get people's attention.
5338 if (WARN_ON(connector->encoder))
5341 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
5342 if (connector->encoder_ids[i] == 0) {
5343 connector->encoder_ids[i] = encoder->base.id;
5349 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
5352 * drm_mode_crtc_set_gamma_size - set the gamma table size
5353 * @crtc: CRTC to set the gamma table size for
5354 * @gamma_size: size of the gamma table
5356 * Drivers which support gamma tables should set this to the supported gamma
5357 * table size when initializing the CRTC. Currently the drm core only supports a
5358 * fixed gamma table size.
5361 * Zero on success, negative errno on failure.
5363 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
5366 crtc->gamma_size = gamma_size;
5368 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
5370 if (!crtc->gamma_store) {
5371 crtc->gamma_size = 0;
5377 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
5380 * drm_mode_gamma_set_ioctl - set the gamma table
5383 * @file_priv: DRM file info
5385 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
5386 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
5388 * Called by the user via ioctl.
5391 * Zero on success, negative errno on failure.
5393 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
5394 void *data, struct drm_file *file_priv)
5396 struct drm_mode_crtc_lut *crtc_lut = data;
5397 struct drm_crtc *crtc;
5398 void *r_base, *g_base, *b_base;
5402 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5405 drm_modeset_lock_all(dev);
5406 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5412 if (crtc->funcs->gamma_set == NULL) {
5417 /* memcpy into gamma store */
5418 if (crtc_lut->gamma_size != crtc->gamma_size) {
5423 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5424 r_base = crtc->gamma_store;
5425 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
5430 g_base = r_base + size;
5431 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
5436 b_base = g_base + size;
5437 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
5442 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
5445 drm_modeset_unlock_all(dev);
5451 * drm_mode_gamma_get_ioctl - get the gamma table
5454 * @file_priv: DRM file info
5456 * Copy the current gamma table into the storage provided. This also provides
5457 * the gamma table size the driver expects, which can be used to size the
5458 * allocated storage.
5460 * Called by the user via ioctl.
5463 * Zero on success, negative errno on failure.
5465 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
5466 void *data, struct drm_file *file_priv)
5468 struct drm_mode_crtc_lut *crtc_lut = data;
5469 struct drm_crtc *crtc;
5470 void *r_base, *g_base, *b_base;
5474 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5477 drm_modeset_lock_all(dev);
5478 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5484 /* memcpy into gamma store */
5485 if (crtc_lut->gamma_size != crtc->gamma_size) {
5490 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5491 r_base = crtc->gamma_store;
5492 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
5497 g_base = r_base + size;
5498 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
5503 b_base = g_base + size;
5504 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
5509 drm_modeset_unlock_all(dev);
5514 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
5517 * @file_priv: DRM file info
5519 * This schedules an asynchronous update on a given CRTC, called page flip.
5520 * Optionally a drm event is generated to signal the completion of the event.
5521 * Generic drivers cannot assume that a pageflip with changed framebuffer
5522 * properties (including driver specific metadata like tiling layout) will work,
5523 * but some drivers support e.g. pixel format changes through the pageflip
5526 * Called by the user via ioctl.
5529 * Zero on success, negative errno on failure.
5531 int drm_mode_page_flip_ioctl(struct drm_device *dev,
5532 void *data, struct drm_file *file_priv)
5534 struct drm_mode_crtc_page_flip *page_flip = data;
5535 struct drm_crtc *crtc;
5536 struct drm_framebuffer *fb = NULL;
5537 struct drm_pending_vblank_event *e = NULL;
5538 unsigned long flags;
5541 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5544 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
5545 page_flip->reserved != 0)
5548 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
5551 crtc = drm_crtc_find(dev, page_flip->crtc_id);
5555 drm_modeset_lock_crtc(crtc, crtc->primary);
5556 if (crtc->primary->fb == NULL) {
5557 /* The framebuffer is currently unbound, presumably
5558 * due to a hotplug event, that userspace has not
5565 if (crtc->funcs->page_flip == NULL)
5568 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
5575 const struct drm_plane_state *state = crtc->primary->state;
5577 ret = check_src_coords(state->src_x, state->src_y,
5578 state->src_w, state->src_h, fb);
5580 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
5585 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
5586 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
5591 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5593 spin_lock_irqsave(&dev->event_lock, flags);
5594 if (file_priv->event_space < sizeof(e->event)) {
5595 spin_unlock_irqrestore(&dev->event_lock, flags);
5598 file_priv->event_space -= sizeof(e->event);
5599 spin_unlock_irqrestore(&dev->event_lock, flags);
5601 e = kzalloc(sizeof(*e), GFP_KERNEL);
5603 spin_lock_irqsave(&dev->event_lock, flags);
5604 file_priv->event_space += sizeof(e->event);
5605 spin_unlock_irqrestore(&dev->event_lock, flags);
5609 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
5610 e->event.base.length = sizeof(e->event);
5611 e->event.user_data = page_flip->user_data;
5612 e->base.event = &e->event.base;
5613 e->base.file_priv = file_priv;
5615 (void (*) (struct drm_pending_event *)) kfree;
5618 crtc->primary->old_fb = crtc->primary->fb;
5619 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
5621 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5622 spin_lock_irqsave(&dev->event_lock, flags);
5623 file_priv->event_space += sizeof(e->event);
5624 spin_unlock_irqrestore(&dev->event_lock, flags);
5627 /* Keep the old fb, don't unref it. */
5628 crtc->primary->old_fb = NULL;
5630 crtc->primary->fb = fb;
5631 /* Unref only the old framebuffer. */
5637 drm_framebuffer_unreference(fb);
5638 if (crtc->primary->old_fb)
5639 drm_framebuffer_unreference(crtc->primary->old_fb);
5640 crtc->primary->old_fb = NULL;
5641 drm_modeset_unlock_crtc(crtc);
5647 * drm_mode_config_reset - call ->reset callbacks
5650 * This functions calls all the crtc's, encoder's and connector's ->reset
5651 * callback. Drivers can use this in e.g. their driver load or resume code to
5652 * reset hardware and software state.
5654 void drm_mode_config_reset(struct drm_device *dev)
5656 struct drm_crtc *crtc;
5657 struct drm_plane *plane;
5658 struct drm_encoder *encoder;
5659 struct drm_connector *connector;
5661 drm_for_each_plane(plane, dev)
5662 if (plane->funcs->reset)
5663 plane->funcs->reset(plane);
5665 drm_for_each_crtc(crtc, dev)
5666 if (crtc->funcs->reset)
5667 crtc->funcs->reset(crtc);
5669 drm_for_each_encoder(encoder, dev)
5670 if (encoder->funcs->reset)
5671 encoder->funcs->reset(encoder);
5673 mutex_lock(&dev->mode_config.mutex);
5674 drm_for_each_connector(connector, dev)
5675 if (connector->funcs->reset)
5676 connector->funcs->reset(connector);
5677 mutex_unlock(&dev->mode_config.mutex);
5679 EXPORT_SYMBOL(drm_mode_config_reset);
5682 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
5685 * @file_priv: DRM file info
5687 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
5688 * TTM or something else entirely) and returns the resulting buffer handle. This
5689 * handle can then be wrapped up into a framebuffer modeset object.
5691 * Note that userspace is not allowed to use such objects for render
5692 * acceleration - drivers must create their own private ioctls for such a use
5695 * Called by the user via ioctl.
5698 * Zero on success, negative errno on failure.
5700 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
5701 void *data, struct drm_file *file_priv)
5703 struct drm_mode_create_dumb *args = data;
5704 u32 cpp, stride, size;
5706 if (!dev->driver->dumb_create)
5708 if (!args->width || !args->height || !args->bpp)
5711 /* overflow checks for 32bit size calculations */
5712 /* NOTE: DIV_ROUND_UP() can overflow */
5713 cpp = DIV_ROUND_UP(args->bpp, 8);
5714 if (!cpp || cpp > 0xffffffffU / args->width)
5716 stride = cpp * args->width;
5717 if (args->height > 0xffffffffU / stride)
5720 /* test for wrap-around */
5721 size = args->height * stride;
5722 if (PAGE_ALIGN(size) == 0)
5726 * handle, pitch and size are output parameters. Zero them out to
5727 * prevent drivers from accidentally using uninitialized data. Since
5728 * not all existing userspace is clearing these fields properly we
5729 * cannot reject IOCTL with garbage in them.
5735 return dev->driver->dumb_create(file_priv, dev, args);
5739 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5742 * @file_priv: DRM file info
5744 * Allocate an offset in the drm device node's address space to be able to
5745 * memory map a dumb buffer.
5747 * Called by the user via ioctl.
5750 * Zero on success, negative errno on failure.
5752 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5753 void *data, struct drm_file *file_priv)
5755 struct drm_mode_map_dumb *args = data;
5757 /* call driver ioctl to get mmap offset */
5758 if (!dev->driver->dumb_map_offset)
5761 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5765 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5768 * @file_priv: DRM file info
5770 * This destroys the userspace handle for the given dumb backing storage buffer.
5771 * Since buffer objects must be reference counted in the kernel a buffer object
5772 * won't be immediately freed if a framebuffer modeset object still uses it.
5774 * Called by the user via ioctl.
5777 * Zero on success, negative errno on failure.
5779 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5780 void *data, struct drm_file *file_priv)
5782 struct drm_mode_destroy_dumb *args = data;
5784 if (!dev->driver->dumb_destroy)
5787 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5791 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5792 * @format: pixel format (DRM_FORMAT_*)
5793 * @depth: storage for the depth value
5794 * @bpp: storage for the bpp value
5796 * This only supports RGB formats here for compat with code that doesn't use
5797 * pixel formats directly yet.
5799 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5804 case DRM_FORMAT_RGB332:
5805 case DRM_FORMAT_BGR233:
5809 case DRM_FORMAT_XRGB1555:
5810 case DRM_FORMAT_XBGR1555:
5811 case DRM_FORMAT_RGBX5551:
5812 case DRM_FORMAT_BGRX5551:
5813 case DRM_FORMAT_ARGB1555:
5814 case DRM_FORMAT_ABGR1555:
5815 case DRM_FORMAT_RGBA5551:
5816 case DRM_FORMAT_BGRA5551:
5820 case DRM_FORMAT_RGB565:
5821 case DRM_FORMAT_BGR565:
5825 case DRM_FORMAT_RGB888:
5826 case DRM_FORMAT_BGR888:
5830 case DRM_FORMAT_XRGB8888:
5831 case DRM_FORMAT_XBGR8888:
5832 case DRM_FORMAT_RGBX8888:
5833 case DRM_FORMAT_BGRX8888:
5837 case DRM_FORMAT_XRGB2101010:
5838 case DRM_FORMAT_XBGR2101010:
5839 case DRM_FORMAT_RGBX1010102:
5840 case DRM_FORMAT_BGRX1010102:
5841 case DRM_FORMAT_ARGB2101010:
5842 case DRM_FORMAT_ABGR2101010:
5843 case DRM_FORMAT_RGBA1010102:
5844 case DRM_FORMAT_BGRA1010102:
5848 case DRM_FORMAT_ARGB8888:
5849 case DRM_FORMAT_ABGR8888:
5850 case DRM_FORMAT_RGBA8888:
5851 case DRM_FORMAT_BGRA8888:
5856 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5857 drm_get_format_name(format));
5863 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5866 * drm_format_num_planes - get the number of planes for format
5867 * @format: pixel format (DRM_FORMAT_*)
5870 * The number of planes used by the specified pixel format.
5872 int drm_format_num_planes(uint32_t format)
5875 case DRM_FORMAT_YUV410:
5876 case DRM_FORMAT_YVU410:
5877 case DRM_FORMAT_YUV411:
5878 case DRM_FORMAT_YVU411:
5879 case DRM_FORMAT_YUV420:
5880 case DRM_FORMAT_YVU420:
5881 case DRM_FORMAT_YUV422:
5882 case DRM_FORMAT_YVU422:
5883 case DRM_FORMAT_YUV444:
5884 case DRM_FORMAT_YVU444:
5886 case DRM_FORMAT_NV12:
5887 case DRM_FORMAT_NV21:
5888 case DRM_FORMAT_NV16:
5889 case DRM_FORMAT_NV61:
5890 case DRM_FORMAT_NV24:
5891 case DRM_FORMAT_NV42:
5892 case DRM_FORMAT_NV12_10:
5893 case DRM_FORMAT_NV21_10:
5894 case DRM_FORMAT_NV16_10:
5895 case DRM_FORMAT_NV61_10:
5896 case DRM_FORMAT_NV24_10:
5897 case DRM_FORMAT_NV42_10:
5903 EXPORT_SYMBOL(drm_format_num_planes);
5906 * drm_format_plane_bpp - get the bpp for format
5907 * @format: pixel format (DRM_FORMAT_*)
5908 * @plane: plane index
5911 * The bpp for the specified plane.
5913 int drm_format_plane_bpp(uint32_t format, int plane)
5918 if (plane >= drm_format_num_planes(format))
5922 case DRM_FORMAT_YUYV:
5923 case DRM_FORMAT_YVYU:
5924 case DRM_FORMAT_UYVY:
5925 case DRM_FORMAT_VYUY:
5927 case DRM_FORMAT_NV12_10:
5928 case DRM_FORMAT_NV21_10:
5929 case DRM_FORMAT_NV16_10:
5930 case DRM_FORMAT_NV61_10:
5931 case DRM_FORMAT_NV24_10:
5932 case DRM_FORMAT_NV42_10:
5933 return plane ? 20 : 10;
5934 case DRM_FORMAT_NV12:
5935 case DRM_FORMAT_NV21:
5936 case DRM_FORMAT_NV16:
5937 case DRM_FORMAT_NV61:
5938 case DRM_FORMAT_NV24:
5939 case DRM_FORMAT_NV42:
5940 return plane ? 16 : 8;
5941 case DRM_FORMAT_YUV410:
5942 case DRM_FORMAT_YVU410:
5943 case DRM_FORMAT_YUV411:
5944 case DRM_FORMAT_YVU411:
5945 case DRM_FORMAT_YUV420:
5946 case DRM_FORMAT_YVU420:
5947 case DRM_FORMAT_YUV422:
5948 case DRM_FORMAT_YVU422:
5949 case DRM_FORMAT_YUV444:
5950 case DRM_FORMAT_YVU444:
5953 drm_fb_get_bpp_depth(format, &depth, &bpp);
5957 EXPORT_SYMBOL(drm_format_plane_bpp);
5960 * drm_format_plane_cpp - determine the bytes per pixel value
5961 * @format: pixel format (DRM_FORMAT_*)
5962 * @plane: plane index
5965 * The bytes per pixel value for the specified plane.
5967 int drm_format_plane_cpp(uint32_t format, int plane)
5969 return drm_format_plane_bpp(format, plane) >> 3;
5971 EXPORT_SYMBOL(drm_format_plane_cpp);
5974 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5975 * @format: pixel format (DRM_FORMAT_*)
5978 * The horizontal chroma subsampling factor for the
5979 * specified pixel format.
5981 int drm_format_horz_chroma_subsampling(uint32_t format)
5984 case DRM_FORMAT_YUV411:
5985 case DRM_FORMAT_YVU411:
5986 case DRM_FORMAT_YUV410:
5987 case DRM_FORMAT_YVU410:
5989 case DRM_FORMAT_YUYV:
5990 case DRM_FORMAT_YVYU:
5991 case DRM_FORMAT_UYVY:
5992 case DRM_FORMAT_VYUY:
5993 case DRM_FORMAT_NV12:
5994 case DRM_FORMAT_NV21:
5995 case DRM_FORMAT_NV16:
5996 case DRM_FORMAT_NV61:
5997 case DRM_FORMAT_NV12_10:
5998 case DRM_FORMAT_NV21_10:
5999 case DRM_FORMAT_NV16_10:
6000 case DRM_FORMAT_NV61_10:
6001 case DRM_FORMAT_YUV422:
6002 case DRM_FORMAT_YVU422:
6003 case DRM_FORMAT_YUV420:
6004 case DRM_FORMAT_YVU420:
6010 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
6013 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
6014 * @format: pixel format (DRM_FORMAT_*)
6017 * The vertical chroma subsampling factor for the
6018 * specified pixel format.
6020 int drm_format_vert_chroma_subsampling(uint32_t format)
6023 case DRM_FORMAT_YUV410:
6024 case DRM_FORMAT_YVU410:
6026 case DRM_FORMAT_YUV420:
6027 case DRM_FORMAT_YVU420:
6028 case DRM_FORMAT_NV12:
6029 case DRM_FORMAT_NV12_10:
6030 case DRM_FORMAT_NV21:
6031 case DRM_FORMAT_NV21_10:
6037 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
6040 * drm_rotation_simplify() - Try to simplify the rotation
6041 * @rotation: Rotation to be simplified
6042 * @supported_rotations: Supported rotations
6044 * Attempt to simplify the rotation to a form that is supported.
6045 * Eg. if the hardware supports everything except DRM_REFLECT_X
6046 * one could call this function like this:
6048 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
6049 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
6050 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
6052 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
6053 * transforms the hardware supports, this function may not
6054 * be able to produce a supported transform, so the caller should
6055 * check the result afterwards.
6057 unsigned int drm_rotation_simplify(unsigned int rotation,
6058 unsigned int supported_rotations)
6060 if (rotation & ~supported_rotations) {
6061 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
6062 rotation = (rotation & DRM_REFLECT_MASK) |
6063 BIT((ffs(rotation & DRM_ROTATE_MASK) + 1) % 4);
6068 EXPORT_SYMBOL(drm_rotation_simplify);
6071 * drm_mode_config_init - initialize DRM mode_configuration structure
6074 * Initialize @dev's mode_config structure, used for tracking the graphics
6075 * configuration of @dev.
6077 * Since this initializes the modeset locks, no locking is possible. Which is no
6078 * problem, since this should happen single threaded at init time. It is the
6079 * driver's problem to ensure this guarantee.
6082 void drm_mode_config_init(struct drm_device *dev)
6084 mutex_init(&dev->mode_config.mutex);
6085 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
6086 mutex_init(&dev->mode_config.idr_mutex);
6087 mutex_init(&dev->mode_config.fb_lock);
6088 mutex_init(&dev->mode_config.blob_lock);
6089 INIT_LIST_HEAD(&dev->mode_config.fb_list);
6090 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
6091 INIT_LIST_HEAD(&dev->mode_config.connector_list);
6092 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
6093 INIT_LIST_HEAD(&dev->mode_config.property_list);
6094 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
6095 INIT_LIST_HEAD(&dev->mode_config.plane_list);
6096 idr_init(&dev->mode_config.crtc_idr);
6097 idr_init(&dev->mode_config.tile_idr);
6099 drm_modeset_lock_all(dev);
6100 drm_mode_create_standard_properties(dev);
6101 drm_modeset_unlock_all(dev);
6103 /* Just to be sure */
6104 dev->mode_config.num_fb = 0;
6105 dev->mode_config.num_connector = 0;
6106 dev->mode_config.num_crtc = 0;
6107 dev->mode_config.num_encoder = 0;
6108 dev->mode_config.num_overlay_plane = 0;
6109 dev->mode_config.num_total_plane = 0;
6111 EXPORT_SYMBOL(drm_mode_config_init);
6114 * drm_mode_config_cleanup - free up DRM mode_config info
6117 * Free up all the connectors and CRTCs associated with this DRM device, then
6118 * free up the framebuffers and associated buffer objects.
6120 * Note that since this /should/ happen single-threaded at driver/device
6121 * teardown time, no locking is required. It's the driver's job to ensure that
6122 * this guarantee actually holds true.
6124 * FIXME: cleanup any dangling user buffer objects too
6126 void drm_mode_config_cleanup(struct drm_device *dev)
6128 struct drm_connector *connector, *ot;
6129 struct drm_crtc *crtc, *ct;
6130 struct drm_encoder *encoder, *enct;
6131 struct drm_framebuffer *fb, *fbt;
6132 struct drm_property *property, *pt;
6133 struct drm_property_blob *blob, *bt;
6134 struct drm_plane *plane, *plt;
6136 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
6138 encoder->funcs->destroy(encoder);
6141 list_for_each_entry_safe(connector, ot,
6142 &dev->mode_config.connector_list, head) {
6143 connector->funcs->destroy(connector);
6146 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
6148 drm_property_destroy(dev, property);
6151 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
6153 drm_property_unreference_blob(blob);
6157 * Single-threaded teardown context, so it's not required to grab the
6158 * fb_lock to protect against concurrent fb_list access. Contrary, it
6159 * would actually deadlock with the drm_framebuffer_cleanup function.
6161 * Also, if there are any framebuffers left, that's a driver leak now,
6162 * so politely WARN about this.
6164 WARN_ON(!list_empty(&dev->mode_config.fb_list));
6165 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
6166 drm_framebuffer_free(&fb->refcount);
6169 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
6171 plane->funcs->destroy(plane);
6174 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
6175 crtc->funcs->destroy(crtc);
6178 idr_destroy(&dev->mode_config.tile_idr);
6179 idr_destroy(&dev->mode_config.crtc_idr);
6180 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
6182 EXPORT_SYMBOL(drm_mode_config_cleanup);
6184 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
6185 unsigned int supported_rotations)
6187 static const struct drm_prop_enum_list props[] = {
6188 { DRM_ROTATE_0, "rotate-0" },
6189 { DRM_ROTATE_90, "rotate-90" },
6190 { DRM_ROTATE_180, "rotate-180" },
6191 { DRM_ROTATE_270, "rotate-270" },
6192 { DRM_REFLECT_X, "reflect-x" },
6193 { DRM_REFLECT_Y, "reflect-y" },
6196 return drm_property_create_bitmask(dev, 0, "rotation",
6197 props, ARRAY_SIZE(props),
6198 supported_rotations);
6200 EXPORT_SYMBOL(drm_mode_create_rotation_property);
6205 * Tile groups are used to represent tiled monitors with a unique
6206 * integer identifier. Tiled monitors using DisplayID v1.3 have
6207 * a unique 8-byte handle, we store this in a tile group, so we
6208 * have a common identifier for all tiles in a monitor group.
6210 static void drm_tile_group_free(struct kref *kref)
6212 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
6213 struct drm_device *dev = tg->dev;
6214 mutex_lock(&dev->mode_config.idr_mutex);
6215 idr_remove(&dev->mode_config.tile_idr, tg->id);
6216 mutex_unlock(&dev->mode_config.idr_mutex);
6221 * drm_mode_put_tile_group - drop a reference to a tile group.
6223 * @tg: tile group to drop reference to.
6225 * drop reference to tile group and free if 0.
6227 void drm_mode_put_tile_group(struct drm_device *dev,
6228 struct drm_tile_group *tg)
6230 kref_put(&tg->refcount, drm_tile_group_free);
6234 * drm_mode_get_tile_group - get a reference to an existing tile group
6236 * @topology: 8-bytes unique per monitor.
6238 * Use the unique bytes to get a reference to an existing tile group.
6241 * tile group or NULL if not found.
6243 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
6246 struct drm_tile_group *tg;
6248 mutex_lock(&dev->mode_config.idr_mutex);
6249 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
6250 if (!memcmp(tg->group_data, topology, 8)) {
6251 if (!kref_get_unless_zero(&tg->refcount))
6253 mutex_unlock(&dev->mode_config.idr_mutex);
6257 mutex_unlock(&dev->mode_config.idr_mutex);
6260 EXPORT_SYMBOL(drm_mode_get_tile_group);
6263 * drm_mode_create_tile_group - create a tile group from a displayid description
6265 * @topology: 8-bytes unique per monitor.
6267 * Create a tile group for the unique monitor, and get a unique
6268 * identifier for the tile group.
6271 * new tile group or error.
6273 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
6276 struct drm_tile_group *tg;
6279 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
6281 return ERR_PTR(-ENOMEM);
6283 kref_init(&tg->refcount);
6284 memcpy(tg->group_data, topology, 8);
6287 mutex_lock(&dev->mode_config.idr_mutex);
6288 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
6296 mutex_unlock(&dev->mode_config.idr_mutex);
6299 EXPORT_SYMBOL(drm_mode_create_tile_group);