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 mutex_lock(&dev->mode_config.mutex);
1116 drm_for_each_connector(connector, dev) {
1117 ret = drm_connector_register(connector);
1122 mutex_unlock(&dev->mode_config.mutex);
1127 mutex_unlock(&dev->mode_config.mutex);
1128 drm_connector_unregister_all(dev);
1131 EXPORT_SYMBOL(drm_connector_register_all);
1134 * drm_connector_unregister_all - unregister connector userspace interfaces
1137 * This functions unregisters all connectors from sysfs and other places so
1138 * that userspace can no longer access them. Drivers should call this as the
1139 * first step tearing down the device instace, or when the underlying
1140 * physical device disappeared (e.g. USB unplug), right before calling
1141 * drm_dev_unregister().
1143 void drm_connector_unregister_all(struct drm_device *dev)
1145 struct drm_connector *connector;
1147 /* FIXME: taking the mode config mutex ends up in a clash with sysfs */
1148 drm_for_each_connector(connector, dev)
1149 drm_connector_unregister(connector);
1151 EXPORT_SYMBOL(drm_connector_unregister_all);
1153 static int drm_encoder_register_all(struct drm_device *dev)
1155 struct drm_encoder *encoder;
1158 drm_for_each_encoder(encoder, dev) {
1159 if (encoder->funcs->late_register)
1160 ret = encoder->funcs->late_register(encoder);
1168 static void drm_encoder_unregister_all(struct drm_device *dev)
1170 struct drm_encoder *encoder;
1172 drm_for_each_encoder(encoder, dev) {
1173 if (encoder->funcs->early_unregister)
1174 encoder->funcs->early_unregister(encoder);
1179 * drm_encoder_init - Init a preallocated encoder
1181 * @encoder: the encoder to init
1182 * @funcs: callbacks for this encoder
1183 * @encoder_type: user visible type of the encoder
1184 * @name: printf style format string for the encoder name, or NULL for default name
1186 * Initialises a preallocated encoder. Encoder should be
1187 * subclassed as part of driver encoder objects.
1190 * Zero on success, error code on failure.
1192 int drm_encoder_init(struct drm_device *dev,
1193 struct drm_encoder *encoder,
1194 const struct drm_encoder_funcs *funcs,
1195 int encoder_type, const char *name, ...)
1199 drm_modeset_lock_all(dev);
1201 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1206 encoder->encoder_type = encoder_type;
1207 encoder->funcs = funcs;
1208 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1209 drm_encoder_enum_list[encoder_type].name,
1211 if (!encoder->name) {
1216 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1217 dev->mode_config.num_encoder++;
1221 drm_mode_object_put(dev, &encoder->base);
1224 drm_modeset_unlock_all(dev);
1228 EXPORT_SYMBOL(drm_encoder_init);
1231 * drm_encoder_cleanup - cleans up an initialised encoder
1232 * @encoder: encoder to cleanup
1234 * Cleans up the encoder but doesn't free the object.
1236 void drm_encoder_cleanup(struct drm_encoder *encoder)
1238 struct drm_device *dev = encoder->dev;
1240 drm_modeset_lock_all(dev);
1241 drm_mode_object_put(dev, &encoder->base);
1242 kfree(encoder->name);
1243 list_del(&encoder->head);
1244 dev->mode_config.num_encoder--;
1245 drm_modeset_unlock_all(dev);
1247 memset(encoder, 0, sizeof(*encoder));
1249 EXPORT_SYMBOL(drm_encoder_cleanup);
1252 * drm_universal_plane_init - Initialize a new universal plane object
1254 * @plane: plane object to init
1255 * @possible_crtcs: bitmask of possible CRTCs
1256 * @funcs: callbacks for the new plane
1257 * @formats: array of supported formats (%DRM_FORMAT_*)
1258 * @format_count: number of elements in @formats
1259 * @type: type of plane (overlay, primary, cursor)
1260 * @name: printf style format string for the plane name, or NULL for default name
1262 * Initializes a plane object of type @type.
1265 * Zero on success, error code on failure.
1267 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1268 unsigned long possible_crtcs,
1269 const struct drm_plane_funcs *funcs,
1270 const uint32_t *formats, unsigned int format_count,
1271 enum drm_plane_type type,
1272 const char *name, ...)
1274 struct drm_mode_config *config = &dev->mode_config;
1277 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1281 drm_modeset_lock_init(&plane->mutex);
1283 plane->base.properties = &plane->properties;
1285 plane->funcs = funcs;
1286 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1288 if (!plane->format_types) {
1289 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1290 drm_mode_object_put(dev, &plane->base);
1294 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1295 plane->format_count = format_count;
1296 plane->possible_crtcs = possible_crtcs;
1299 list_add_tail(&plane->head, &config->plane_list);
1300 config->num_total_plane++;
1301 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1302 config->num_overlay_plane++;
1304 drm_object_attach_property(&plane->base,
1305 config->plane_type_property,
1308 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1309 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1310 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1311 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1312 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1313 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1314 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1315 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1316 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1317 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1318 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1323 EXPORT_SYMBOL(drm_universal_plane_init);
1325 static int drm_plane_register_all(struct drm_device *dev)
1327 struct drm_plane *plane;
1330 drm_for_each_plane(plane, dev) {
1331 if (plane->funcs->late_register)
1332 ret = plane->funcs->late_register(plane);
1340 static void drm_plane_unregister_all(struct drm_device *dev)
1342 struct drm_plane *plane;
1344 drm_for_each_plane(plane, dev) {
1345 if (plane->funcs->early_unregister)
1346 plane->funcs->early_unregister(plane);
1351 * drm_plane_init - Initialize a legacy plane
1353 * @plane: plane object to init
1354 * @possible_crtcs: bitmask of possible CRTCs
1355 * @funcs: callbacks for the new plane
1356 * @formats: array of supported formats (%DRM_FORMAT_*)
1357 * @format_count: number of elements in @formats
1358 * @is_primary: plane type (primary vs overlay)
1360 * Legacy API to initialize a DRM plane.
1362 * New drivers should call drm_universal_plane_init() instead.
1365 * Zero on success, error code on failure.
1367 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1368 unsigned long possible_crtcs,
1369 const struct drm_plane_funcs *funcs,
1370 const uint32_t *formats, unsigned int format_count,
1373 enum drm_plane_type type;
1375 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1376 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1377 formats, format_count, type, NULL);
1379 EXPORT_SYMBOL(drm_plane_init);
1382 * drm_share_plane_init - Initialize a share plane
1384 * @plane: plane object to init
1385 * @parent: this plane share some resources with parent plane.
1386 * @possible_crtcs: bitmask of possible CRTCs
1387 * @funcs: callbacks for the new plane
1388 * @formats: array of supported formats (%DRM_FORMAT_*)
1389 * @format_count: number of elements in @formats
1390 * @type: type of plane (overlay, primary, cursor)
1392 * With this API, the plane can share hardware resources with other planes.
1394 * --------------------------------------------------
1396 * | ------------------ |
1397 * | | parent plane | |
1398 * | | active scanout | |
1399 * | | | ----------------- |
1400 * | ------------------ | share plane 1 | |
1401 * | ----------------- |active scanout | |
1402 * | | share plane 0 | | | |
1403 * | |active scanout | ----------------- |
1405 * | ----------------- |
1406 * --------------------------------------------------
1413 * The plane hardware is used when the display scanout run into plane active
1414 * scanout, that means we can reuse the plane hardware resources on plane
1415 * non-active scanout.
1417 * Because resource share, There are some limit on share plane: one group
1418 * of share planes need use same zpos, can't not overlap, etc.
1420 * Here assume share plane is a universal plane with some limit flags.
1421 * people who use the share plane need know the limit, should call the ioctl
1422 * DRM_CLIENT_CAP_SHARE_PLANES, and judge the planes limit before use it.
1425 * Zero on success, error code on failure.
1428 int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1429 struct drm_plane *parent,
1430 unsigned long possible_crtcs,
1431 const struct drm_plane_funcs *funcs,
1432 const uint32_t *formats, unsigned int format_count,
1433 enum drm_plane_type type)
1435 struct drm_mode_config *config = &dev->mode_config;
1440 * TODO: only verified on ATOMIC drm driver.
1442 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1445 ret = drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1446 formats, format_count, type, NULL);
1452 * Can't support more than two level plane share.
1454 WARN_ON(parent->parent);
1455 share_id = parent->base.id;
1456 plane->parent = parent;
1458 config->num_share_plane++;
1459 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1460 config->num_share_overlay_plane++;
1462 share_id = plane->base.id;
1465 drm_object_attach_property(&plane->base,
1466 config->prop_share_id, share_id);
1469 EXPORT_SYMBOL(drm_share_plane_init);
1472 * drm_plane_cleanup - Clean up the core plane usage
1473 * @plane: plane to cleanup
1475 * This function cleans up @plane and removes it from the DRM mode setting
1476 * core. Note that the function does *not* free the plane structure itself,
1477 * this is the responsibility of the caller.
1479 void drm_plane_cleanup(struct drm_plane *plane)
1481 struct drm_device *dev = plane->dev;
1483 drm_modeset_lock_all(dev);
1484 kfree(plane->format_types);
1485 drm_mode_object_put(dev, &plane->base);
1487 BUG_ON(list_empty(&plane->head));
1489 list_del(&plane->head);
1490 dev->mode_config.num_total_plane--;
1491 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1492 dev->mode_config.num_overlay_plane--;
1493 if (plane->parent) {
1494 dev->mode_config.num_share_plane--;
1495 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1496 dev->mode_config.num_share_overlay_plane--;
1498 drm_modeset_unlock_all(dev);
1500 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1501 if (plane->state && plane->funcs->atomic_destroy_state)
1502 plane->funcs->atomic_destroy_state(plane, plane->state);
1504 memset(plane, 0, sizeof(*plane));
1506 EXPORT_SYMBOL(drm_plane_cleanup);
1509 * drm_plane_index - find the index of a registered plane
1510 * @plane: plane to find index for
1512 * Given a registered plane, return the index of that CRTC within a DRM
1513 * device's list of planes.
1515 unsigned int drm_plane_index(struct drm_plane *plane)
1517 unsigned int index = 0;
1518 struct drm_plane *tmp;
1520 drm_for_each_plane(tmp, plane->dev) {
1529 EXPORT_SYMBOL(drm_plane_index);
1532 * drm_plane_from_index - find the registered plane at an index
1534 * @idx: index of registered plane to find for
1536 * Given a plane index, return the registered plane from DRM device's
1537 * list of planes with matching index.
1540 drm_plane_from_index(struct drm_device *dev, int idx)
1542 struct drm_plane *plane;
1545 drm_for_each_plane(plane, dev) {
1552 EXPORT_SYMBOL(drm_plane_from_index);
1555 * drm_plane_force_disable - Forcibly disable a plane
1556 * @plane: plane to disable
1558 * Forces the plane to be disabled.
1560 * Used when the plane's current framebuffer is destroyed,
1561 * and when restoring fbdev mode.
1563 void drm_plane_force_disable(struct drm_plane *plane)
1570 plane->old_fb = plane->fb;
1571 ret = plane->funcs->disable_plane(plane);
1573 DRM_ERROR("failed to disable plane with busy fb\n");
1574 plane->old_fb = NULL;
1577 /* disconnect the plane from the fb and crtc: */
1578 drm_framebuffer_unreference(plane->old_fb);
1579 plane->old_fb = NULL;
1583 EXPORT_SYMBOL(drm_plane_force_disable);
1585 int drm_modeset_register_all(struct drm_device *dev)
1589 ret = drm_plane_register_all(dev);
1593 ret = drm_crtc_register_all(dev);
1597 ret = drm_encoder_register_all(dev);
1601 ret = drm_connector_register_all(dev);
1608 drm_encoder_unregister_all(dev);
1610 drm_crtc_unregister_all(dev);
1612 drm_plane_unregister_all(dev);
1617 void drm_modeset_unregister_all(struct drm_device *dev)
1619 drm_connector_unregister_all(dev);
1620 drm_encoder_unregister_all(dev);
1621 drm_crtc_unregister_all(dev);
1622 drm_plane_unregister_all(dev);
1625 static int drm_mode_create_standard_properties(struct drm_device *dev)
1627 struct drm_property *prop;
1630 * Standard properties (apply to all connectors)
1632 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1633 DRM_MODE_PROP_IMMUTABLE,
1637 dev->mode_config.edid_property = prop;
1639 prop = drm_property_create_enum(dev, 0,
1640 "DPMS", drm_dpms_enum_list,
1641 ARRAY_SIZE(drm_dpms_enum_list));
1644 dev->mode_config.dpms_property = prop;
1646 prop = drm_property_create(dev,
1647 DRM_MODE_PROP_BLOB |
1648 DRM_MODE_PROP_IMMUTABLE,
1652 dev->mode_config.path_property = prop;
1654 prop = drm_property_create(dev,
1655 DRM_MODE_PROP_BLOB |
1656 DRM_MODE_PROP_IMMUTABLE,
1660 dev->mode_config.tile_property = prop;
1662 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1663 "type", drm_plane_type_enum_list,
1664 ARRAY_SIZE(drm_plane_type_enum_list));
1667 dev->mode_config.plane_type_property = prop;
1669 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1670 "SHARE_ID", 0, UINT_MAX);
1674 dev->mode_config.prop_share_id = prop;
1675 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1676 "SHARE_FLAGS", 0, UINT_MAX);
1679 dev->mode_config.prop_share_flags = prop;
1681 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1682 "SRC_X", 0, UINT_MAX);
1685 dev->mode_config.prop_src_x = prop;
1687 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1688 "SRC_Y", 0, UINT_MAX);
1691 dev->mode_config.prop_src_y = prop;
1693 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1694 "SRC_W", 0, UINT_MAX);
1697 dev->mode_config.prop_src_w = prop;
1699 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1700 "SRC_H", 0, UINT_MAX);
1703 dev->mode_config.prop_src_h = prop;
1705 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1706 "CRTC_X", INT_MIN, INT_MAX);
1709 dev->mode_config.prop_crtc_x = prop;
1711 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1712 "CRTC_Y", INT_MIN, INT_MAX);
1715 dev->mode_config.prop_crtc_y = prop;
1717 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1718 "CRTC_W", 0, INT_MAX);
1721 dev->mode_config.prop_crtc_w = prop;
1723 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1724 "CRTC_H", 0, INT_MAX);
1727 dev->mode_config.prop_crtc_h = prop;
1729 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1730 "FB_ID", DRM_MODE_OBJECT_FB);
1733 dev->mode_config.prop_fb_id = prop;
1735 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1736 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1739 dev->mode_config.prop_crtc_id = prop;
1741 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
1745 dev->mode_config.prop_active = prop;
1747 prop = drm_property_create(dev,
1748 DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
1752 dev->mode_config.prop_mode_id = prop;
1758 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1761 * Called by a driver the first time a DVI-I connector is made.
1763 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1765 struct drm_property *dvi_i_selector;
1766 struct drm_property *dvi_i_subconnector;
1768 if (dev->mode_config.dvi_i_select_subconnector_property)
1772 drm_property_create_enum(dev, 0,
1773 "select subconnector",
1774 drm_dvi_i_select_enum_list,
1775 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1776 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1778 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1780 drm_dvi_i_subconnector_enum_list,
1781 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1782 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1786 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1789 * drm_create_tv_properties - create TV specific connector properties
1791 * @num_modes: number of different TV formats (modes) supported
1792 * @modes: array of pointers to strings containing name of each format
1794 * Called by a driver's TV initialization routine, this function creates
1795 * the TV specific connector properties for a given device. Caller is
1796 * responsible for allocating a list of format names and passing them to
1799 int drm_mode_create_tv_properties(struct drm_device *dev,
1800 unsigned int num_modes,
1801 const char * const modes[])
1803 struct drm_property *tv_selector;
1804 struct drm_property *tv_subconnector;
1807 if (dev->mode_config.tv_select_subconnector_property)
1811 * Basic connector properties
1813 tv_selector = drm_property_create_enum(dev, 0,
1814 "select subconnector",
1815 drm_tv_select_enum_list,
1816 ARRAY_SIZE(drm_tv_select_enum_list));
1820 dev->mode_config.tv_select_subconnector_property = tv_selector;
1823 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1825 drm_tv_subconnector_enum_list,
1826 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1827 if (!tv_subconnector)
1829 dev->mode_config.tv_subconnector_property = tv_subconnector;
1832 * Other, TV specific properties: margins & TV modes.
1834 dev->mode_config.tv_left_margin_property =
1835 drm_property_create_range(dev, 0, "left margin", 0, 100);
1836 if (!dev->mode_config.tv_left_margin_property)
1839 dev->mode_config.tv_right_margin_property =
1840 drm_property_create_range(dev, 0, "right margin", 0, 100);
1841 if (!dev->mode_config.tv_right_margin_property)
1844 dev->mode_config.tv_top_margin_property =
1845 drm_property_create_range(dev, 0, "top margin", 0, 100);
1846 if (!dev->mode_config.tv_top_margin_property)
1849 dev->mode_config.tv_bottom_margin_property =
1850 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1851 if (!dev->mode_config.tv_bottom_margin_property)
1854 dev->mode_config.tv_mode_property =
1855 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1857 if (!dev->mode_config.tv_mode_property)
1860 for (i = 0; i < num_modes; i++)
1861 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1864 dev->mode_config.tv_brightness_property =
1865 drm_property_create_range(dev, 0, "brightness", 0, 100);
1866 if (!dev->mode_config.tv_brightness_property)
1869 dev->mode_config.tv_contrast_property =
1870 drm_property_create_range(dev, 0, "contrast", 0, 100);
1871 if (!dev->mode_config.tv_contrast_property)
1874 dev->mode_config.tv_flicker_reduction_property =
1875 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1876 if (!dev->mode_config.tv_flicker_reduction_property)
1879 dev->mode_config.tv_overscan_property =
1880 drm_property_create_range(dev, 0, "overscan", 0, 100);
1881 if (!dev->mode_config.tv_overscan_property)
1884 dev->mode_config.tv_saturation_property =
1885 drm_property_create_range(dev, 0, "saturation", 0, 100);
1886 if (!dev->mode_config.tv_saturation_property)
1889 dev->mode_config.tv_hue_property =
1890 drm_property_create_range(dev, 0, "hue", 0, 100);
1891 if (!dev->mode_config.tv_hue_property)
1898 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1901 * drm_mode_create_scaling_mode_property - create scaling mode property
1904 * Called by a driver the first time it's needed, must be attached to desired
1907 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1909 struct drm_property *scaling_mode;
1911 if (dev->mode_config.scaling_mode_property)
1915 drm_property_create_enum(dev, 0, "scaling mode",
1916 drm_scaling_mode_enum_list,
1917 ARRAY_SIZE(drm_scaling_mode_enum_list));
1919 dev->mode_config.scaling_mode_property = scaling_mode;
1923 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1926 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1929 * Called by a driver the first time it's needed, must be attached to desired
1933 * Zero on success, negative errno on failure.
1935 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1937 if (dev->mode_config.aspect_ratio_property)
1940 dev->mode_config.aspect_ratio_property =
1941 drm_property_create_enum(dev, 0, "aspect ratio",
1942 drm_aspect_ratio_enum_list,
1943 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1945 if (dev->mode_config.aspect_ratio_property == NULL)
1950 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1953 * drm_mode_create_dirty_property - create dirty property
1956 * Called by a driver the first time it's needed, must be attached to desired
1959 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1961 struct drm_property *dirty_info;
1963 if (dev->mode_config.dirty_info_property)
1967 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1969 drm_dirty_info_enum_list,
1970 ARRAY_SIZE(drm_dirty_info_enum_list));
1971 dev->mode_config.dirty_info_property = dirty_info;
1975 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1978 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1981 * Create the the suggested x/y offset property for connectors.
1983 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1985 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1988 dev->mode_config.suggested_x_property =
1989 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1991 dev->mode_config.suggested_y_property =
1992 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1994 if (dev->mode_config.suggested_x_property == NULL ||
1995 dev->mode_config.suggested_y_property == NULL)
1999 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
2002 * drm_mode_getresources - get graphics configuration
2003 * @dev: drm device for the ioctl
2004 * @data: data pointer for the ioctl
2005 * @file_priv: drm file for the ioctl call
2007 * Construct a set of configuration description structures and return
2008 * them to the user, including CRTC, connector and framebuffer configuration.
2010 * Called by the user via ioctl.
2013 * Zero on success, negative errno on failure.
2015 int drm_mode_getresources(struct drm_device *dev, void *data,
2016 struct drm_file *file_priv)
2018 struct drm_mode_card_res *card_res = data;
2019 struct list_head *lh;
2020 struct drm_framebuffer *fb;
2021 struct drm_connector *connector;
2022 struct drm_crtc *crtc;
2023 struct drm_encoder *encoder;
2025 int connector_count = 0;
2028 int encoder_count = 0;
2030 uint32_t __user *fb_id;
2031 uint32_t __user *crtc_id;
2032 uint32_t __user *connector_id;
2033 uint32_t __user *encoder_id;
2035 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2039 mutex_lock(&file_priv->fbs_lock);
2041 * For the non-control nodes we need to limit the list of resources
2042 * by IDs in the group list for this node
2044 list_for_each(lh, &file_priv->fbs)
2047 /* handle this in 4 parts */
2049 if (card_res->count_fbs >= fb_count) {
2051 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
2052 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
2053 if (put_user(fb->base.id, fb_id + copied)) {
2054 mutex_unlock(&file_priv->fbs_lock);
2060 card_res->count_fbs = fb_count;
2061 mutex_unlock(&file_priv->fbs_lock);
2063 /* mode_config.mutex protects the connector list against e.g. DP MST
2064 * connector hot-adding. CRTC/Plane lists are invariant. */
2065 mutex_lock(&dev->mode_config.mutex);
2066 drm_for_each_crtc(crtc, dev)
2069 drm_for_each_connector(connector, dev)
2072 drm_for_each_encoder(encoder, dev)
2075 card_res->max_height = dev->mode_config.max_height;
2076 card_res->min_height = dev->mode_config.min_height;
2077 card_res->max_width = dev->mode_config.max_width;
2078 card_res->min_width = dev->mode_config.min_width;
2081 if (card_res->count_crtcs >= crtc_count) {
2083 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
2084 drm_for_each_crtc(crtc, dev) {
2085 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2086 if (put_user(crtc->base.id, crtc_id + copied)) {
2093 card_res->count_crtcs = crtc_count;
2096 if (card_res->count_encoders >= encoder_count) {
2098 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
2099 drm_for_each_encoder(encoder, dev) {
2100 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
2102 if (put_user(encoder->base.id, encoder_id +
2110 card_res->count_encoders = encoder_count;
2113 if (card_res->count_connectors >= connector_count) {
2115 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
2116 drm_for_each_connector(connector, dev) {
2117 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2120 if (put_user(connector->base.id,
2121 connector_id + copied)) {
2128 card_res->count_connectors = connector_count;
2130 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
2131 card_res->count_connectors, card_res->count_encoders);
2134 mutex_unlock(&dev->mode_config.mutex);
2139 * drm_mode_getcrtc - get CRTC configuration
2140 * @dev: drm device for the ioctl
2141 * @data: data pointer for the ioctl
2142 * @file_priv: drm file for the ioctl call
2144 * Construct a CRTC configuration structure to return to the user.
2146 * Called by the user via ioctl.
2149 * Zero on success, negative errno on failure.
2151 int drm_mode_getcrtc(struct drm_device *dev,
2152 void *data, struct drm_file *file_priv)
2154 struct drm_mode_crtc *crtc_resp = data;
2155 struct drm_crtc *crtc;
2157 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2160 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
2164 drm_modeset_lock_crtc(crtc, crtc->primary);
2165 crtc_resp->gamma_size = crtc->gamma_size;
2166 if (crtc->primary->fb)
2167 crtc_resp->fb_id = crtc->primary->fb->base.id;
2169 crtc_resp->fb_id = 0;
2172 crtc_resp->x = crtc->primary->state->src_x >> 16;
2173 crtc_resp->y = crtc->primary->state->src_y >> 16;
2174 if (crtc->state->enable) {
2175 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
2176 crtc_resp->mode_valid = 1;
2179 crtc_resp->mode_valid = 0;
2182 crtc_resp->x = crtc->x;
2183 crtc_resp->y = crtc->y;
2184 if (crtc->enabled) {
2185 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2186 crtc_resp->mode_valid = 1;
2189 crtc_resp->mode_valid = 0;
2192 drm_modeset_unlock_crtc(crtc);
2197 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2198 const struct drm_file *file_priv)
2201 * If user-space hasn't configured the driver to expose the stereo 3D
2202 * modes, don't expose them.
2204 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2210 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2212 /* For atomic drivers only state objects are synchronously updated and
2213 * protected by modeset locks, so check those first. */
2214 if (connector->state)
2215 return connector->state->best_encoder;
2216 return connector->encoder;
2219 /* helper for getconnector and getproperties ioctls */
2220 static int get_properties(struct drm_mode_object *obj, bool atomic,
2221 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2222 uint32_t *arg_count_props)
2227 props_count = obj->properties->count;
2229 props_count -= obj->properties->atomic_count;
2231 if ((*arg_count_props >= props_count) && props_count) {
2232 for (i = 0, copied = 0; copied < props_count; i++) {
2233 struct drm_property *prop = obj->properties->properties[i];
2236 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2239 ret = drm_object_property_get_value(obj, prop, &val);
2243 if (put_user(prop->base.id, prop_ptr + copied))
2246 if (put_user(val, prop_values + copied))
2252 *arg_count_props = props_count;
2258 * drm_mode_getconnector - get connector configuration
2259 * @dev: drm device for the ioctl
2260 * @data: data pointer for the ioctl
2261 * @file_priv: drm file for the ioctl call
2263 * Construct a connector configuration structure to return to the user.
2265 * Called by the user via ioctl.
2268 * Zero on success, negative errno on failure.
2270 int drm_mode_getconnector(struct drm_device *dev, void *data,
2271 struct drm_file *file_priv)
2273 struct drm_mode_get_connector *out_resp = data;
2274 struct drm_connector *connector;
2275 struct drm_encoder *encoder;
2276 struct drm_display_mode *mode;
2278 int encoders_count = 0;
2282 struct drm_mode_modeinfo u_mode;
2283 struct drm_mode_modeinfo __user *mode_ptr;
2284 uint32_t __user *encoder_ptr;
2286 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2289 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2291 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2293 mutex_lock(&dev->mode_config.mutex);
2295 connector = drm_connector_find(dev, out_resp->connector_id);
2301 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2302 if (connector->encoder_ids[i] != 0)
2305 if (out_resp->count_modes == 0) {
2306 connector->funcs->fill_modes(connector,
2307 dev->mode_config.max_width,
2308 dev->mode_config.max_height);
2311 /* delayed so we get modes regardless of pre-fill_modes state */
2312 list_for_each_entry(mode, &connector->modes, head)
2313 if (drm_mode_expose_to_userspace(mode, file_priv))
2316 out_resp->connector_id = connector->base.id;
2317 out_resp->connector_type = connector->connector_type;
2318 out_resp->connector_type_id = connector->connector_type_id;
2319 out_resp->mm_width = connector->display_info.width_mm;
2320 out_resp->mm_height = connector->display_info.height_mm;
2321 out_resp->subpixel = connector->display_info.subpixel_order;
2322 out_resp->connection = connector->status;
2324 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2325 encoder = drm_connector_get_encoder(connector);
2327 out_resp->encoder_id = encoder->base.id;
2329 out_resp->encoder_id = 0;
2332 * This ioctl is called twice, once to determine how much space is
2333 * needed, and the 2nd time to fill it.
2335 if ((out_resp->count_modes >= mode_count) && mode_count) {
2337 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2338 list_for_each_entry(mode, &connector->modes, head) {
2339 if (!drm_mode_expose_to_userspace(mode, file_priv))
2342 drm_mode_convert_to_umode(&u_mode, mode);
2343 if (copy_to_user(mode_ptr + copied,
2344 &u_mode, sizeof(u_mode))) {
2351 out_resp->count_modes = mode_count;
2353 ret = get_properties(&connector->base, file_priv->atomic,
2354 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2355 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2356 &out_resp->count_props);
2360 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2362 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2363 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2364 if (connector->encoder_ids[i] != 0) {
2365 if (put_user(connector->encoder_ids[i],
2366 encoder_ptr + copied)) {
2374 out_resp->count_encoders = encoders_count;
2377 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2380 mutex_unlock(&dev->mode_config.mutex);
2385 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2387 struct drm_connector *connector;
2388 struct drm_device *dev = encoder->dev;
2389 bool uses_atomic = false;
2391 /* For atomic drivers only state objects are synchronously updated and
2392 * protected by modeset locks, so check those first. */
2393 drm_for_each_connector(connector, dev) {
2394 if (!connector->state)
2399 if (connector->state->best_encoder != encoder)
2402 return connector->state->crtc;
2405 /* Don't return stale data (e.g. pending async disable). */
2409 return encoder->crtc;
2413 * drm_mode_getencoder - get encoder configuration
2414 * @dev: drm device for the ioctl
2415 * @data: data pointer for the ioctl
2416 * @file_priv: drm file for the ioctl call
2418 * Construct a encoder configuration structure to return to the user.
2420 * Called by the user via ioctl.
2423 * Zero on success, negative errno on failure.
2425 int drm_mode_getencoder(struct drm_device *dev, void *data,
2426 struct drm_file *file_priv)
2428 struct drm_mode_get_encoder *enc_resp = data;
2429 struct drm_encoder *encoder;
2430 struct drm_crtc *crtc;
2432 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2435 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2439 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2440 crtc = drm_encoder_get_crtc(encoder);
2442 enc_resp->crtc_id = crtc->base.id;
2444 enc_resp->crtc_id = 0;
2445 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2447 enc_resp->encoder_type = encoder->encoder_type;
2448 enc_resp->encoder_id = encoder->base.id;
2449 enc_resp->possible_crtcs = encoder->possible_crtcs;
2450 enc_resp->possible_clones = encoder->possible_clones;
2456 * drm_mode_getplane_res - enumerate all plane resources
2459 * @file_priv: DRM file info
2461 * Construct a list of plane ids to return to the user.
2463 * Called by the user via ioctl.
2466 * Zero on success, negative errno on failure.
2468 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2469 struct drm_file *file_priv)
2471 struct drm_mode_get_plane_res *plane_resp = data;
2472 struct drm_mode_config *config;
2473 struct drm_plane *plane;
2474 uint32_t __user *plane_ptr;
2476 unsigned num_planes;
2478 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2481 config = &dev->mode_config;
2483 if (file_priv->universal_planes)
2484 num_planes = config->num_total_plane;
2486 num_planes = config->num_overlay_plane;
2487 if (!file_priv->share_planes) {
2488 if (file_priv->universal_planes)
2489 num_planes -= config->num_share_plane;
2491 num_planes -= config->num_share_overlay_plane;
2495 * This ioctl is called twice, once to determine how much space is
2496 * needed, and the 2nd time to fill it.
2499 (plane_resp->count_planes >= num_planes)) {
2500 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2502 /* Plane lists are invariant, no locking needed. */
2503 drm_for_each_plane(plane, dev) {
2505 * Unless userspace set the 'universal planes'
2506 * capability bit, only advertise overlays.
2508 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2509 !file_priv->universal_planes)
2511 if (plane->parent && !file_priv->share_planes)
2514 if (put_user(plane->base.id, plane_ptr + copied))
2519 plane_resp->count_planes = num_planes;
2525 * drm_mode_getplane - get plane configuration
2528 * @file_priv: DRM file info
2530 * Construct a plane configuration structure to return to the user.
2532 * Called by the user via ioctl.
2535 * Zero on success, negative errno on failure.
2537 int drm_mode_getplane(struct drm_device *dev, void *data,
2538 struct drm_file *file_priv)
2540 struct drm_mode_get_plane *plane_resp = data;
2541 struct drm_plane *plane;
2542 uint32_t __user *format_ptr;
2544 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2547 plane = drm_plane_find(dev, plane_resp->plane_id);
2551 drm_modeset_lock(&plane->mutex, NULL);
2553 plane_resp->crtc_id = plane->crtc->base.id;
2555 plane_resp->crtc_id = 0;
2558 plane_resp->fb_id = plane->fb->base.id;
2560 plane_resp->fb_id = 0;
2561 drm_modeset_unlock(&plane->mutex);
2563 plane_resp->plane_id = plane->base.id;
2564 plane_resp->possible_crtcs = plane->possible_crtcs;
2565 plane_resp->gamma_size = 0;
2568 * This ioctl is called twice, once to determine how much space is
2569 * needed, and the 2nd time to fill it.
2571 if (plane->format_count &&
2572 (plane_resp->count_format_types >= plane->format_count)) {
2573 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2574 if (copy_to_user(format_ptr,
2575 plane->format_types,
2576 sizeof(uint32_t) * plane->format_count)) {
2580 plane_resp->count_format_types = plane->format_count;
2586 * drm_plane_check_pixel_format - Check if the plane supports the pixel format
2587 * @plane: plane to check for format support
2588 * @format: the pixel format
2591 * Zero of @plane has @format in its list of supported pixel formats, -EINVAL
2594 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
2598 for (i = 0; i < plane->format_count; i++) {
2599 if (format == plane->format_types[i])
2606 static int check_src_coords(uint32_t src_x, uint32_t src_y,
2607 uint32_t src_w, uint32_t src_h,
2608 const struct drm_framebuffer *fb)
2610 unsigned int fb_width, fb_height;
2612 fb_width = fb->width << 16;
2613 fb_height = fb->height << 16;
2615 /* Make sure source coordinates are inside the fb. */
2616 if (src_w > fb_width ||
2617 src_x > fb_width - src_w ||
2618 src_h > fb_height ||
2619 src_y > fb_height - src_h) {
2620 DRM_DEBUG_KMS("Invalid source coordinates "
2621 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2622 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2623 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2624 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2625 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2633 * setplane_internal - setplane handler for internal callers
2635 * Note that we assume an extra reference has already been taken on fb. If the
2636 * update fails, this reference will be dropped before return; if it succeeds,
2637 * the previous framebuffer (if any) will be unreferenced instead.
2639 * src_{x,y,w,h} are provided in 16.16 fixed point format
2641 static int __setplane_internal(struct drm_plane *plane,
2642 struct drm_crtc *crtc,
2643 struct drm_framebuffer *fb,
2644 int32_t crtc_x, int32_t crtc_y,
2645 uint32_t crtc_w, uint32_t crtc_h,
2646 /* src_{x,y,w,h} values are 16.16 fixed point */
2647 uint32_t src_x, uint32_t src_y,
2648 uint32_t src_w, uint32_t src_h)
2652 /* No fb means shut it down */
2654 plane->old_fb = plane->fb;
2655 ret = plane->funcs->disable_plane(plane);
2660 plane->old_fb = NULL;
2665 /* Check whether this plane is usable on this CRTC */
2666 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2667 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2672 /* Check whether this plane supports the fb pixel format. */
2673 ret = drm_plane_check_pixel_format(plane, fb->pixel_format);
2675 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2676 drm_get_format_name(fb->pixel_format));
2680 /* Give drivers some help against integer overflows */
2681 if (crtc_w > INT_MAX ||
2682 crtc_x > INT_MAX - (int32_t) crtc_w ||
2684 crtc_y > INT_MAX - (int32_t) crtc_h) {
2685 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2686 crtc_w, crtc_h, crtc_x, crtc_y);
2691 ret = check_src_coords(src_x, src_y, src_w, src_h, fb);
2695 plane->old_fb = plane->fb;
2696 ret = plane->funcs->update_plane(plane, crtc, fb,
2697 crtc_x, crtc_y, crtc_w, crtc_h,
2698 src_x, src_y, src_w, src_h);
2704 plane->old_fb = NULL;
2709 drm_framebuffer_unreference(fb);
2711 drm_framebuffer_unreference(plane->old_fb);
2712 plane->old_fb = NULL;
2717 static int setplane_internal(struct drm_plane *plane,
2718 struct drm_crtc *crtc,
2719 struct drm_framebuffer *fb,
2720 int32_t crtc_x, int32_t crtc_y,
2721 uint32_t crtc_w, uint32_t crtc_h,
2722 /* src_{x,y,w,h} values are 16.16 fixed point */
2723 uint32_t src_x, uint32_t src_y,
2724 uint32_t src_w, uint32_t src_h)
2728 drm_modeset_lock_all(plane->dev);
2729 ret = __setplane_internal(plane, crtc, fb,
2730 crtc_x, crtc_y, crtc_w, crtc_h,
2731 src_x, src_y, src_w, src_h);
2732 drm_modeset_unlock_all(plane->dev);
2738 * drm_mode_setplane - configure a plane's configuration
2740 * @data: ioctl data*
2741 * @file_priv: DRM file info
2743 * Set plane configuration, including placement, fb, scaling, and other factors.
2744 * Or pass a NULL fb to disable (planes may be disabled without providing a
2748 * Zero on success, negative errno on failure.
2750 int drm_mode_setplane(struct drm_device *dev, void *data,
2751 struct drm_file *file_priv)
2753 struct drm_mode_set_plane *plane_req = data;
2754 struct drm_plane *plane;
2755 struct drm_crtc *crtc = NULL;
2756 struct drm_framebuffer *fb = NULL;
2758 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2762 * First, find the plane, crtc, and fb objects. If not available,
2763 * we don't bother to call the driver.
2765 plane = drm_plane_find(dev, plane_req->plane_id);
2767 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2768 plane_req->plane_id);
2772 if (plane_req->fb_id) {
2773 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2775 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2780 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2782 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2783 plane_req->crtc_id);
2789 * setplane_internal will take care of deref'ing either the old or new
2790 * framebuffer depending on success.
2792 return setplane_internal(plane, crtc, fb,
2793 plane_req->crtc_x, plane_req->crtc_y,
2794 plane_req->crtc_w, plane_req->crtc_h,
2795 plane_req->src_x, plane_req->src_y,
2796 plane_req->src_w, plane_req->src_h);
2800 * drm_mode_set_config_internal - helper to call ->set_config
2801 * @set: modeset config to set
2803 * This is a little helper to wrap internal calls to the ->set_config driver
2804 * interface. The only thing it adds is correct refcounting dance.
2807 * Zero on success, negative errno on failure.
2809 int drm_mode_set_config_internal(struct drm_mode_set *set)
2811 struct drm_crtc *crtc = set->crtc;
2812 struct drm_framebuffer *fb;
2813 struct drm_crtc *tmp;
2817 * NOTE: ->set_config can also disable other crtcs (if we steal all
2818 * connectors from it), hence we need to refcount the fbs across all
2819 * crtcs. Atomic modeset will have saner semantics ...
2821 drm_for_each_crtc(tmp, crtc->dev)
2822 tmp->primary->old_fb = tmp->primary->fb;
2826 ret = crtc->funcs->set_config(set);
2828 crtc->primary->crtc = crtc;
2829 crtc->primary->fb = fb;
2832 drm_for_each_crtc(tmp, crtc->dev) {
2833 if (tmp->primary->fb)
2834 drm_framebuffer_reference(tmp->primary->fb);
2835 if (tmp->primary->old_fb)
2836 drm_framebuffer_unreference(tmp->primary->old_fb);
2837 tmp->primary->old_fb = NULL;
2842 EXPORT_SYMBOL(drm_mode_set_config_internal);
2845 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
2846 * @mode: mode to query
2847 * @hdisplay: hdisplay value to fill in
2848 * @vdisplay: vdisplay value to fill in
2850 * The vdisplay value will be doubled if the specified mode is a stereo mode of
2851 * the appropriate layout.
2853 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2854 int *hdisplay, int *vdisplay)
2856 struct drm_display_mode adjusted;
2858 drm_mode_copy(&adjusted, mode);
2859 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
2860 *hdisplay = adjusted.crtc_hdisplay;
2861 *vdisplay = adjusted.crtc_vdisplay;
2863 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
2866 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2868 * @crtc: CRTC that framebuffer will be displayed on
2871 * @mode: mode that framebuffer will be displayed under
2872 * @fb: framebuffer to check size of
2874 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2876 const struct drm_display_mode *mode,
2877 const struct drm_framebuffer *fb)
2880 int hdisplay, vdisplay;
2882 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
2885 crtc->primary->state->rotation & (BIT(DRM_ROTATE_90) |
2886 BIT(DRM_ROTATE_270)))
2887 swap(hdisplay, vdisplay);
2889 return check_src_coords(x << 16, y << 16,
2890 hdisplay << 16, vdisplay << 16, fb);
2892 EXPORT_SYMBOL(drm_crtc_check_viewport);
2895 * drm_mode_setcrtc - set CRTC configuration
2896 * @dev: drm device for the ioctl
2897 * @data: data pointer for the ioctl
2898 * @file_priv: drm file for the ioctl call
2900 * Build a new CRTC configuration based on user request.
2902 * Called by the user via ioctl.
2905 * Zero on success, negative errno on failure.
2907 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2908 struct drm_file *file_priv)
2910 struct drm_mode_config *config = &dev->mode_config;
2911 struct drm_mode_crtc *crtc_req = data;
2912 struct drm_crtc *crtc;
2913 struct drm_connector **connector_set = NULL, *connector;
2914 struct drm_framebuffer *fb = NULL;
2915 struct drm_display_mode *mode = NULL;
2916 struct drm_mode_set set;
2917 uint32_t __user *set_connectors_ptr;
2921 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2925 * Universal plane src offsets are only 16.16, prevent havoc for
2926 * drivers using universal plane code internally.
2928 if (crtc_req->x & 0xffff0000 || crtc_req->y & 0xffff0000)
2931 drm_modeset_lock_all(dev);
2932 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2934 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2938 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2940 if (crtc_req->mode_valid) {
2941 /* If we have a mode we need a framebuffer. */
2942 /* If we pass -1, set the mode with the currently bound fb */
2943 if (crtc_req->fb_id == -1) {
2944 if (!crtc->primary->fb) {
2945 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2949 fb = crtc->primary->fb;
2950 /* Make refcounting symmetric with the lookup path. */
2951 drm_framebuffer_reference(fb);
2953 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2955 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2962 mode = drm_mode_create(dev);
2968 ret = drm_mode_convert_umode(mode, &crtc_req->mode);
2970 DRM_DEBUG_KMS("Invalid mode\n");
2975 * Check whether the primary plane supports the fb pixel format.
2976 * Drivers not implementing the universal planes API use a
2977 * default formats list provided by the DRM core which doesn't
2978 * match real hardware capabilities. Skip the check in that
2981 if (!crtc->primary->format_default) {
2982 ret = drm_plane_check_pixel_format(crtc->primary,
2985 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2986 drm_get_format_name(fb->pixel_format));
2991 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2998 if (crtc_req->count_connectors == 0 && mode) {
2999 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
3004 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
3005 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
3006 crtc_req->count_connectors);
3011 if (crtc_req->count_connectors > 0) {
3014 /* Avoid unbounded kernel memory allocation */
3015 if (crtc_req->count_connectors > config->num_connector) {
3020 connector_set = kmalloc_array(crtc_req->count_connectors,
3021 sizeof(struct drm_connector *),
3023 if (!connector_set) {
3028 for (i = 0; i < crtc_req->count_connectors; i++) {
3029 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
3030 if (get_user(out_id, &set_connectors_ptr[i])) {
3035 connector = drm_connector_find(dev, out_id);
3037 DRM_DEBUG_KMS("Connector id %d unknown\n",
3042 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
3046 connector_set[i] = connector;
3051 set.x = crtc_req->x;
3052 set.y = crtc_req->y;
3054 set.connectors = connector_set;
3055 set.num_connectors = crtc_req->count_connectors;
3057 ret = drm_mode_set_config_internal(&set);
3061 drm_framebuffer_unreference(fb);
3063 kfree(connector_set);
3064 drm_mode_destroy(dev, mode);
3065 drm_modeset_unlock_all(dev);
3070 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
3071 * universal plane handler call
3072 * @crtc: crtc to update cursor for
3073 * @req: data pointer for the ioctl
3074 * @file_priv: drm file for the ioctl call
3076 * Legacy cursor ioctl's work directly with driver buffer handles. To
3077 * translate legacy ioctl calls into universal plane handler calls, we need to
3078 * wrap the native buffer handle in a drm_framebuffer.
3080 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
3081 * buffer with a pitch of 4*width; the universal plane interface should be used
3082 * directly in cases where the hardware can support other buffer settings and
3083 * userspace wants to make use of these capabilities.
3086 * Zero on success, negative errno on failure.
3088 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
3089 struct drm_mode_cursor2 *req,
3090 struct drm_file *file_priv)
3092 struct drm_device *dev = crtc->dev;
3093 struct drm_framebuffer *fb = NULL;
3094 struct drm_mode_fb_cmd2 fbreq = {
3095 .width = req->width,
3096 .height = req->height,
3097 .pixel_format = DRM_FORMAT_ARGB8888,
3098 .pitches = { req->width * 4 },
3099 .handles = { req->handle },
3101 int32_t crtc_x, crtc_y;
3102 uint32_t crtc_w = 0, crtc_h = 0;
3103 uint32_t src_w = 0, src_h = 0;
3106 BUG_ON(!crtc->cursor);
3107 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
3110 * Obtain fb we'll be using (either new or existing) and take an extra
3111 * reference to it if fb != null. setplane will take care of dropping
3112 * the reference if the plane update fails.
3114 if (req->flags & DRM_MODE_CURSOR_BO) {
3116 fb = internal_framebuffer_create(dev, &fbreq, file_priv);
3118 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
3125 fb = crtc->cursor->fb;
3127 drm_framebuffer_reference(fb);
3130 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3134 crtc_x = crtc->cursor_x;
3135 crtc_y = crtc->cursor_y;
3140 crtc_h = fb->height;
3141 src_w = fb->width << 16;
3142 src_h = fb->height << 16;
3146 * setplane_internal will take care of deref'ing either the old or new
3147 * framebuffer depending on success.
3149 ret = __setplane_internal(crtc->cursor, crtc, fb,
3150 crtc_x, crtc_y, crtc_w, crtc_h,
3151 0, 0, src_w, src_h);
3153 /* Update successful; save new cursor position, if necessary */
3154 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
3155 crtc->cursor_x = req->x;
3156 crtc->cursor_y = req->y;
3162 static int drm_mode_cursor_common(struct drm_device *dev,
3163 struct drm_mode_cursor2 *req,
3164 struct drm_file *file_priv)
3166 struct drm_crtc *crtc;
3169 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3172 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
3175 crtc = drm_crtc_find(dev, req->crtc_id);
3177 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
3182 * If this crtc has a universal cursor plane, call that plane's update
3183 * handler rather than using legacy cursor handlers.
3185 drm_modeset_lock_crtc(crtc, crtc->cursor);
3187 ret = drm_mode_cursor_universal(crtc, req, file_priv);
3191 if (req->flags & DRM_MODE_CURSOR_BO) {
3192 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
3196 /* Turns off the cursor if handle is 0 */
3197 if (crtc->funcs->cursor_set2)
3198 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
3199 req->width, req->height, req->hot_x, req->hot_y);
3201 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
3202 req->width, req->height);
3205 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3206 if (crtc->funcs->cursor_move) {
3207 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3214 drm_modeset_unlock_crtc(crtc);
3222 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3223 * @dev: drm device for the ioctl
3224 * @data: data pointer for the ioctl
3225 * @file_priv: drm file for the ioctl call
3227 * Set the cursor configuration based on user request.
3229 * Called by the user via ioctl.
3232 * Zero on success, negative errno on failure.
3234 int drm_mode_cursor_ioctl(struct drm_device *dev,
3235 void *data, struct drm_file *file_priv)
3237 struct drm_mode_cursor *req = data;
3238 struct drm_mode_cursor2 new_req;
3240 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3241 new_req.hot_x = new_req.hot_y = 0;
3243 return drm_mode_cursor_common(dev, &new_req, file_priv);
3247 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3248 * @dev: drm device for the ioctl
3249 * @data: data pointer for the ioctl
3250 * @file_priv: drm file for the ioctl call
3252 * Set the cursor configuration based on user request. This implements the 2nd
3253 * version of the cursor ioctl, which allows userspace to additionally specify
3254 * the hotspot of the pointer.
3256 * Called by the user via ioctl.
3259 * Zero on success, negative errno on failure.
3261 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3262 void *data, struct drm_file *file_priv)
3264 struct drm_mode_cursor2 *req = data;
3266 return drm_mode_cursor_common(dev, req, file_priv);
3270 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3271 * @bpp: bits per pixels
3272 * @depth: bit depth per pixel
3274 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3275 * Useful in fbdev emulation code, since that deals in those values.
3277 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3283 fmt = DRM_FORMAT_C8;
3287 fmt = DRM_FORMAT_XRGB1555;
3289 fmt = DRM_FORMAT_RGB565;
3292 fmt = DRM_FORMAT_RGB888;
3296 fmt = DRM_FORMAT_XRGB8888;
3297 else if (depth == 30)
3298 fmt = DRM_FORMAT_XRGB2101010;
3300 fmt = DRM_FORMAT_ARGB8888;
3303 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3304 fmt = DRM_FORMAT_XRGB8888;
3310 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3313 * drm_mode_addfb - add an FB to the graphics configuration
3314 * @dev: drm device for the ioctl
3315 * @data: data pointer for the ioctl
3316 * @file_priv: drm file for the ioctl call
3318 * Add a new FB to the specified CRTC, given a user request. This is the
3319 * original addfb ioctl which only supported RGB formats.
3321 * Called by the user via ioctl.
3324 * Zero on success, negative errno on failure.
3326 int drm_mode_addfb(struct drm_device *dev,
3327 void *data, struct drm_file *file_priv)
3329 struct drm_mode_fb_cmd *or = data;
3330 struct drm_mode_fb_cmd2 r = {};
3333 /* convert to new format and call new ioctl */
3334 r.fb_id = or->fb_id;
3335 r.width = or->width;
3336 r.height = or->height;
3337 r.pitches[0] = or->pitch;
3338 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3339 r.handles[0] = or->handle;
3341 ret = drm_mode_addfb2(dev, &r, file_priv);
3345 or->fb_id = r.fb_id;
3350 static int format_check(const struct drm_mode_fb_cmd2 *r)
3352 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3356 case DRM_FORMAT_RGB332:
3357 case DRM_FORMAT_BGR233:
3358 case DRM_FORMAT_XRGB4444:
3359 case DRM_FORMAT_XBGR4444:
3360 case DRM_FORMAT_RGBX4444:
3361 case DRM_FORMAT_BGRX4444:
3362 case DRM_FORMAT_ARGB4444:
3363 case DRM_FORMAT_ABGR4444:
3364 case DRM_FORMAT_RGBA4444:
3365 case DRM_FORMAT_BGRA4444:
3366 case DRM_FORMAT_XRGB1555:
3367 case DRM_FORMAT_XBGR1555:
3368 case DRM_FORMAT_RGBX5551:
3369 case DRM_FORMAT_BGRX5551:
3370 case DRM_FORMAT_ARGB1555:
3371 case DRM_FORMAT_ABGR1555:
3372 case DRM_FORMAT_RGBA5551:
3373 case DRM_FORMAT_BGRA5551:
3374 case DRM_FORMAT_RGB565:
3375 case DRM_FORMAT_BGR565:
3376 case DRM_FORMAT_RGB888:
3377 case DRM_FORMAT_BGR888:
3378 case DRM_FORMAT_XRGB8888:
3379 case DRM_FORMAT_XBGR8888:
3380 case DRM_FORMAT_RGBX8888:
3381 case DRM_FORMAT_BGRX8888:
3382 case DRM_FORMAT_ARGB8888:
3383 case DRM_FORMAT_ABGR8888:
3384 case DRM_FORMAT_RGBA8888:
3385 case DRM_FORMAT_BGRA8888:
3386 case DRM_FORMAT_XRGB2101010:
3387 case DRM_FORMAT_XBGR2101010:
3388 case DRM_FORMAT_RGBX1010102:
3389 case DRM_FORMAT_BGRX1010102:
3390 case DRM_FORMAT_ARGB2101010:
3391 case DRM_FORMAT_ABGR2101010:
3392 case DRM_FORMAT_RGBA1010102:
3393 case DRM_FORMAT_BGRA1010102:
3394 case DRM_FORMAT_YUYV:
3395 case DRM_FORMAT_YVYU:
3396 case DRM_FORMAT_UYVY:
3397 case DRM_FORMAT_VYUY:
3398 case DRM_FORMAT_AYUV:
3399 case DRM_FORMAT_NV12:
3400 case DRM_FORMAT_NV21:
3401 case DRM_FORMAT_NV16:
3402 case DRM_FORMAT_NV61:
3403 case DRM_FORMAT_NV24:
3404 case DRM_FORMAT_NV42:
3405 case DRM_FORMAT_NV12_10:
3406 case DRM_FORMAT_NV21_10:
3407 case DRM_FORMAT_NV16_10:
3408 case DRM_FORMAT_NV61_10:
3409 case DRM_FORMAT_NV24_10:
3410 case DRM_FORMAT_NV42_10:
3411 case DRM_FORMAT_YUV410:
3412 case DRM_FORMAT_YVU410:
3413 case DRM_FORMAT_YUV411:
3414 case DRM_FORMAT_YVU411:
3415 case DRM_FORMAT_YUV420:
3416 case DRM_FORMAT_YVU420:
3417 case DRM_FORMAT_YUV422:
3418 case DRM_FORMAT_YVU422:
3419 case DRM_FORMAT_YUV444:
3420 case DRM_FORMAT_YVU444:
3423 DRM_DEBUG_KMS("invalid pixel format %s\n",
3424 drm_get_format_name(r->pixel_format));
3429 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3431 int ret, hsub, vsub, num_planes, i;
3433 ret = format_check(r);
3435 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3436 drm_get_format_name(r->pixel_format));
3440 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3441 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3442 num_planes = drm_format_num_planes(r->pixel_format);
3444 if (r->width == 0 || r->width % hsub) {
3445 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3449 if (r->height == 0 || r->height % vsub) {
3450 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3454 for (i = 0; i < num_planes; i++) {
3455 unsigned int width = r->width / (i != 0 ? hsub : 1);
3456 unsigned int height = r->height / (i != 0 ? vsub : 1);
3457 unsigned int bpp = drm_format_plane_bpp(r->pixel_format, i);
3459 if (!r->handles[i]) {
3460 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3464 if ((uint64_t) width * bpp / 8 > UINT_MAX)
3467 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3470 if (r->pitches[i] < roundup(width * bpp, 8) / 8) {
3471 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3475 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
3476 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
3481 /* modifier specific checks: */
3482 switch (r->modifier[i]) {
3483 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
3484 /* NOTE: the pitch restriction may be lifted later if it turns
3485 * out that no hw has this restriction:
3487 if (r->pixel_format != DRM_FORMAT_NV12 ||
3488 width % 128 || height % 32 ||
3489 r->pitches[i] % 128) {
3490 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
3500 for (i = num_planes; i < 4; i++) {
3501 if (r->modifier[i]) {
3502 DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
3506 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
3507 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
3510 if (r->handles[i]) {
3511 DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
3515 if (r->pitches[i]) {
3516 DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
3520 if (r->offsets[i]) {
3521 DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
3529 static struct drm_framebuffer *
3530 internal_framebuffer_create(struct drm_device *dev,
3531 struct drm_mode_fb_cmd2 *r,
3532 struct drm_file *file_priv)
3534 struct drm_mode_config *config = &dev->mode_config;
3535 struct drm_framebuffer *fb;
3538 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
3539 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3540 return ERR_PTR(-EINVAL);
3543 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3544 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3545 r->width, config->min_width, config->max_width);
3546 return ERR_PTR(-EINVAL);
3548 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3549 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3550 r->height, config->min_height, config->max_height);
3551 return ERR_PTR(-EINVAL);
3554 if (r->flags & DRM_MODE_FB_MODIFIERS &&
3555 !dev->mode_config.allow_fb_modifiers) {
3556 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
3557 return ERR_PTR(-EINVAL);
3560 ret = framebuffer_check(r);
3562 return ERR_PTR(ret);
3564 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3566 DRM_DEBUG_KMS("could not create framebuffer\n");
3574 * drm_mode_addfb2 - add an FB to the graphics configuration
3575 * @dev: drm device for the ioctl
3576 * @data: data pointer for the ioctl
3577 * @file_priv: drm file for the ioctl call
3579 * Add a new FB to the specified CRTC, given a user request with format. This is
3580 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3581 * and uses fourcc codes as pixel format specifiers.
3583 * Called by the user via ioctl.
3586 * Zero on success, negative errno on failure.
3588 int drm_mode_addfb2(struct drm_device *dev,
3589 void *data, struct drm_file *file_priv)
3591 struct drm_mode_fb_cmd2 *r = data;
3592 struct drm_framebuffer *fb;
3594 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3597 fb = internal_framebuffer_create(dev, r, file_priv);
3601 /* Transfer ownership to the filp for reaping on close */
3603 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3604 mutex_lock(&file_priv->fbs_lock);
3605 r->fb_id = fb->base.id;
3606 list_add(&fb->filp_head, &file_priv->fbs);
3607 mutex_unlock(&file_priv->fbs_lock);
3612 struct drm_mode_rmfb_work {
3613 struct work_struct work;
3614 struct list_head fbs;
3617 static void drm_mode_rmfb_work_fn(struct work_struct *w)
3619 struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
3621 while (!list_empty(&arg->fbs)) {
3622 struct drm_framebuffer *fb =
3623 list_first_entry(&arg->fbs, typeof(*fb), filp_head);
3625 list_del_init(&fb->filp_head);
3626 drm_framebuffer_remove(fb);
3631 * drm_mode_rmfb - remove an FB from the configuration
3632 * @dev: drm device for the ioctl
3633 * @data: data pointer for the ioctl
3634 * @file_priv: drm file for the ioctl call
3636 * Remove the FB specified by the user.
3638 * Called by the user via ioctl.
3641 * Zero on success, negative errno on failure.
3643 int drm_mode_rmfb(struct drm_device *dev,
3644 void *data, struct drm_file *file_priv)
3646 struct drm_framebuffer *fb = NULL;
3647 struct drm_framebuffer *fbl = NULL;
3648 uint32_t *id = data;
3651 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3654 mutex_lock(&file_priv->fbs_lock);
3655 mutex_lock(&dev->mode_config.fb_lock);
3656 fb = __drm_framebuffer_lookup(dev, *id);
3660 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3666 list_del_init(&fb->filp_head);
3667 mutex_unlock(&dev->mode_config.fb_lock);
3668 mutex_unlock(&file_priv->fbs_lock);
3671 * we now own the reference that was stored in the fbs list
3673 * drm_framebuffer_remove may fail with -EINTR on pending signals,
3674 * so run this in a separate stack as there's no way to correctly
3675 * handle this after the fb is already removed from the lookup table.
3677 if (atomic_read(&fb->refcount.refcount) > 1) {
3678 struct drm_mode_rmfb_work arg;
3680 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3681 INIT_LIST_HEAD(&arg.fbs);
3682 list_add_tail(&fb->filp_head, &arg.fbs);
3684 schedule_work(&arg.work);
3685 flush_work(&arg.work);
3686 destroy_work_on_stack(&arg.work);
3688 drm_framebuffer_unreference(fb);
3693 mutex_unlock(&dev->mode_config.fb_lock);
3694 mutex_unlock(&file_priv->fbs_lock);
3700 * drm_mode_getfb - get FB info
3701 * @dev: drm device for the ioctl
3702 * @data: data pointer for the ioctl
3703 * @file_priv: drm file for the ioctl call
3705 * Lookup the FB given its ID and return info about it.
3707 * Called by the user via ioctl.
3710 * Zero on success, negative errno on failure.
3712 int drm_mode_getfb(struct drm_device *dev,
3713 void *data, struct drm_file *file_priv)
3715 struct drm_mode_fb_cmd *r = data;
3716 struct drm_framebuffer *fb;
3719 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3722 fb = drm_framebuffer_lookup(dev, r->fb_id);
3726 r->height = fb->height;
3727 r->width = fb->width;
3728 r->depth = fb->depth;
3729 r->bpp = fb->bits_per_pixel;
3730 r->pitch = fb->pitches[0];
3731 if (fb->funcs->create_handle) {
3732 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3733 drm_is_control_client(file_priv)) {
3734 ret = fb->funcs->create_handle(fb, file_priv,
3737 /* GET_FB() is an unprivileged ioctl so we must not
3738 * return a buffer-handle to non-master processes! For
3739 * backwards-compatibility reasons, we cannot make
3740 * GET_FB() privileged, so just return an invalid handle
3741 * for non-masters. */
3749 drm_framebuffer_unreference(fb);
3755 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3756 * @dev: drm device for the ioctl
3757 * @data: data pointer for the ioctl
3758 * @file_priv: drm file for the ioctl call
3760 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3761 * rectangle list. Generic userspace which does frontbuffer rendering must call
3762 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3763 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3765 * Modesetting drivers which always update the frontbuffer do not need to
3766 * implement the corresponding ->dirty framebuffer callback.
3768 * Called by the user via ioctl.
3771 * Zero on success, negative errno on failure.
3773 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3774 void *data, struct drm_file *file_priv)
3776 struct drm_clip_rect __user *clips_ptr;
3777 struct drm_clip_rect *clips = NULL;
3778 struct drm_mode_fb_dirty_cmd *r = data;
3779 struct drm_framebuffer *fb;
3784 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3787 fb = drm_framebuffer_lookup(dev, r->fb_id);
3791 num_clips = r->num_clips;
3792 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3794 if (!num_clips != !clips_ptr) {
3799 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3801 /* If userspace annotates copy, clips must come in pairs */
3802 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3807 if (num_clips && clips_ptr) {
3808 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3812 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3818 ret = copy_from_user(clips, clips_ptr,
3819 num_clips * sizeof(*clips));
3826 if (fb->funcs->dirty) {
3827 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3836 drm_framebuffer_unreference(fb);
3842 * drm_fb_release - remove and free the FBs on this file
3843 * @priv: drm file for the ioctl
3845 * Destroy all the FBs associated with @filp.
3847 * Called by the user via ioctl.
3850 * Zero on success, negative errno on failure.
3852 void drm_fb_release(struct drm_file *priv)
3854 struct drm_framebuffer *fb, *tfb;
3855 struct drm_mode_rmfb_work arg;
3857 INIT_LIST_HEAD(&arg.fbs);
3860 * When the file gets released that means no one else can access the fb
3861 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3862 * avoid upsetting lockdep since the universal cursor code adds a
3863 * framebuffer while holding mutex locks.
3865 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3866 * locks is impossible here since no one else but this function can get
3869 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3870 if (atomic_read(&fb->refcount.refcount) > 1) {
3871 list_move_tail(&fb->filp_head, &arg.fbs);
3873 list_del_init(&fb->filp_head);
3875 /* This drops the fpriv->fbs reference. */
3876 drm_framebuffer_unreference(fb);
3880 if (!list_empty(&arg.fbs)) {
3881 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3883 schedule_work(&arg.work);
3884 flush_work(&arg.work);
3885 destroy_work_on_stack(&arg.work);
3890 * drm_property_create - create a new property type
3892 * @flags: flags specifying the property type
3893 * @name: name of the property
3894 * @num_values: number of pre-defined values
3896 * This creates a new generic drm property which can then be attached to a drm
3897 * object with drm_object_attach_property. The returned property object must be
3898 * freed with drm_property_destroy.
3900 * Note that the DRM core keeps a per-device list of properties and that, if
3901 * drm_mode_config_cleanup() is called, it will destroy all properties created
3905 * A pointer to the newly created property on success, NULL on failure.
3907 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3908 const char *name, int num_values)
3910 struct drm_property *property = NULL;
3913 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3917 property->dev = dev;
3920 property->values = kcalloc(num_values, sizeof(uint64_t),
3922 if (!property->values)
3926 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3930 property->flags = flags;
3931 property->num_values = num_values;
3932 INIT_LIST_HEAD(&property->enum_list);
3935 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3936 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3939 list_add_tail(&property->head, &dev->mode_config.property_list);
3941 WARN_ON(!drm_property_type_valid(property));
3945 kfree(property->values);
3949 EXPORT_SYMBOL(drm_property_create);
3952 * drm_property_create_enum - create a new enumeration property type
3954 * @flags: flags specifying the property type
3955 * @name: name of the property
3956 * @props: enumeration lists with property values
3957 * @num_values: number of pre-defined values
3959 * This creates a new generic drm property which can then be attached to a drm
3960 * object with drm_object_attach_property. The returned property object must be
3961 * freed with drm_property_destroy.
3963 * Userspace is only allowed to set one of the predefined values for enumeration
3967 * A pointer to the newly created property on success, NULL on failure.
3969 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3971 const struct drm_prop_enum_list *props,
3974 struct drm_property *property;
3977 flags |= DRM_MODE_PROP_ENUM;
3979 property = drm_property_create(dev, flags, name, num_values);
3983 for (i = 0; i < num_values; i++) {
3984 ret = drm_property_add_enum(property, i,
3988 drm_property_destroy(dev, property);
3995 EXPORT_SYMBOL(drm_property_create_enum);
3998 * drm_property_create_bitmask - create a new bitmask property type
4000 * @flags: flags specifying the property type
4001 * @name: name of the property
4002 * @props: enumeration lists with property bitflags
4003 * @num_props: size of the @props array
4004 * @supported_bits: bitmask of all supported enumeration values
4006 * This creates a new bitmask drm property which can then be attached to a drm
4007 * object with drm_object_attach_property. The returned property object must be
4008 * freed with drm_property_destroy.
4010 * Compared to plain enumeration properties userspace is allowed to set any
4011 * or'ed together combination of the predefined property bitflag values
4014 * A pointer to the newly created property on success, NULL on failure.
4016 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
4017 int flags, const char *name,
4018 const struct drm_prop_enum_list *props,
4020 uint64_t supported_bits)
4022 struct drm_property *property;
4023 int i, ret, index = 0;
4024 int num_values = hweight64(supported_bits);
4026 flags |= DRM_MODE_PROP_BITMASK;
4028 property = drm_property_create(dev, flags, name, num_values);
4031 for (i = 0; i < num_props; i++) {
4032 if (!(supported_bits & (1ULL << props[i].type)))
4035 if (WARN_ON(index >= num_values)) {
4036 drm_property_destroy(dev, property);
4040 ret = drm_property_add_enum(property, index++,
4044 drm_property_destroy(dev, property);
4051 EXPORT_SYMBOL(drm_property_create_bitmask);
4053 static struct drm_property *property_create_range(struct drm_device *dev,
4054 int flags, const char *name,
4055 uint64_t min, uint64_t max)
4057 struct drm_property *property;
4059 property = drm_property_create(dev, flags, name, 2);
4063 property->values[0] = min;
4064 property->values[1] = max;
4070 * drm_property_create_range - create a new unsigned ranged property type
4072 * @flags: flags specifying the property type
4073 * @name: name of the property
4074 * @min: minimum value of the property
4075 * @max: maximum value of the property
4077 * This creates a new generic drm property which can then be attached to a drm
4078 * object with drm_object_attach_property. The returned property object must be
4079 * freed with drm_property_destroy.
4081 * Userspace is allowed to set any unsigned integer value in the (min, max)
4085 * A pointer to the newly created property on success, NULL on failure.
4087 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
4089 uint64_t min, uint64_t max)
4091 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
4094 EXPORT_SYMBOL(drm_property_create_range);
4097 * drm_property_create_signed_range - create a new signed ranged property type
4099 * @flags: flags specifying the property type
4100 * @name: name of the property
4101 * @min: minimum value of the property
4102 * @max: maximum value of the property
4104 * This creates a new generic drm property which can then be attached to a drm
4105 * object with drm_object_attach_property. The returned property object must be
4106 * freed with drm_property_destroy.
4108 * Userspace is allowed to set any signed integer value in the (min, max)
4112 * A pointer to the newly created property on success, NULL on failure.
4114 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
4115 int flags, const char *name,
4116 int64_t min, int64_t max)
4118 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
4119 name, I642U64(min), I642U64(max));
4121 EXPORT_SYMBOL(drm_property_create_signed_range);
4124 * drm_property_create_object - create a new object property type
4126 * @flags: flags specifying the property type
4127 * @name: name of the property
4128 * @type: object type from DRM_MODE_OBJECT_* defines
4130 * This creates a new generic drm property which can then be attached to a drm
4131 * object with drm_object_attach_property. The returned property object must be
4132 * freed with drm_property_destroy.
4134 * Userspace is only allowed to set this to any property value of the given
4135 * @type. Only useful for atomic properties, which is enforced.
4138 * A pointer to the newly created property on success, NULL on failure.
4140 struct drm_property *drm_property_create_object(struct drm_device *dev,
4141 int flags, const char *name, uint32_t type)
4143 struct drm_property *property;
4145 flags |= DRM_MODE_PROP_OBJECT;
4147 if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
4150 property = drm_property_create(dev, flags, name, 1);
4154 property->values[0] = type;
4158 EXPORT_SYMBOL(drm_property_create_object);
4161 * drm_property_create_bool - create a new boolean property type
4163 * @flags: flags specifying the property type
4164 * @name: name of the property
4166 * This creates a new generic drm property which can then be attached to a drm
4167 * object with drm_object_attach_property. The returned property object must be
4168 * freed with drm_property_destroy.
4170 * This is implemented as a ranged property with only {0, 1} as valid values.
4173 * A pointer to the newly created property on success, NULL on failure.
4175 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
4178 return drm_property_create_range(dev, flags, name, 0, 1);
4180 EXPORT_SYMBOL(drm_property_create_bool);
4183 * drm_property_add_enum - add a possible value to an enumeration property
4184 * @property: enumeration property to change
4185 * @index: index of the new enumeration
4186 * @value: value of the new enumeration
4187 * @name: symbolic name of the new enumeration
4189 * This functions adds enumerations to a property.
4191 * It's use is deprecated, drivers should use one of the more specific helpers
4192 * to directly create the property with all enumerations already attached.
4195 * Zero on success, error code on failure.
4197 int drm_property_add_enum(struct drm_property *property, int index,
4198 uint64_t value, const char *name)
4200 struct drm_property_enum *prop_enum;
4202 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4203 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
4207 * Bitmask enum properties have the additional constraint of values
4210 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
4214 if (!list_empty(&property->enum_list)) {
4215 list_for_each_entry(prop_enum, &property->enum_list, head) {
4216 if (prop_enum->value == value) {
4217 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4218 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4224 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
4228 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4229 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4230 prop_enum->value = value;
4232 property->values[index] = value;
4233 list_add_tail(&prop_enum->head, &property->enum_list);
4236 EXPORT_SYMBOL(drm_property_add_enum);
4239 * drm_property_destroy - destroy a drm property
4241 * @property: property to destry
4243 * This function frees a property including any attached resources like
4244 * enumeration values.
4246 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
4248 struct drm_property_enum *prop_enum, *pt;
4250 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
4251 list_del(&prop_enum->head);
4255 if (property->num_values)
4256 kfree(property->values);
4257 drm_mode_object_put(dev, &property->base);
4258 list_del(&property->head);
4261 EXPORT_SYMBOL(drm_property_destroy);
4264 * drm_object_attach_property - attach a property to a modeset object
4265 * @obj: drm modeset object
4266 * @property: property to attach
4267 * @init_val: initial value of the property
4269 * This attaches the given property to the modeset object with the given initial
4270 * value. Currently this function cannot fail since the properties are stored in
4271 * a statically sized array.
4273 void drm_object_attach_property(struct drm_mode_object *obj,
4274 struct drm_property *property,
4277 int count = obj->properties->count;
4279 if (count == DRM_OBJECT_MAX_PROPERTY) {
4280 WARN(1, "Failed to attach object property (type: 0x%x). Please "
4281 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
4282 "you see this message on the same object type.\n",
4287 obj->properties->properties[count] = property;
4288 obj->properties->values[count] = init_val;
4289 obj->properties->count++;
4290 if (property->flags & DRM_MODE_PROP_ATOMIC)
4291 obj->properties->atomic_count++;
4293 EXPORT_SYMBOL(drm_object_attach_property);
4296 * drm_object_property_set_value - set the value of a property
4297 * @obj: drm mode object to set property value for
4298 * @property: property to set
4299 * @val: value the property should be set to
4301 * This functions sets a given property on a given object. This function only
4302 * changes the software state of the property, it does not call into the
4303 * driver's ->set_property callback.
4306 * Zero on success, error code on failure.
4308 int drm_object_property_set_value(struct drm_mode_object *obj,
4309 struct drm_property *property, uint64_t val)
4313 for (i = 0; i < obj->properties->count; i++) {
4314 if (obj->properties->properties[i] == property) {
4315 obj->properties->values[i] = val;
4322 EXPORT_SYMBOL(drm_object_property_set_value);
4325 * drm_object_property_get_value - retrieve the value of a property
4326 * @obj: drm mode object to get property value from
4327 * @property: property to retrieve
4328 * @val: storage for the property value
4330 * This function retrieves the softare state of the given property for the given
4331 * property. Since there is no driver callback to retrieve the current property
4332 * value this might be out of sync with the hardware, depending upon the driver
4336 * Zero on success, error code on failure.
4338 int drm_object_property_get_value(struct drm_mode_object *obj,
4339 struct drm_property *property, uint64_t *val)
4343 /* read-only properties bypass atomic mechanism and still store
4344 * their value in obj->properties->values[].. mostly to avoid
4345 * having to deal w/ EDID and similar props in atomic paths:
4347 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
4348 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
4349 return drm_atomic_get_property(obj, property, val);
4351 for (i = 0; i < obj->properties->count; i++) {
4352 if (obj->properties->properties[i] == property) {
4353 *val = obj->properties->values[i];
4360 EXPORT_SYMBOL(drm_object_property_get_value);
4363 * drm_mode_getproperty_ioctl - get the property metadata
4366 * @file_priv: DRM file info
4368 * This function retrieves the metadata for a given property, like the different
4369 * possible values for an enum property or the limits for a range property.
4371 * Blob properties are special
4373 * Called by the user via ioctl.
4376 * Zero on success, negative errno on failure.
4378 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4379 void *data, struct drm_file *file_priv)
4381 struct drm_mode_get_property *out_resp = data;
4382 struct drm_property *property;
4384 int value_count = 0;
4387 struct drm_property_enum *prop_enum;
4388 struct drm_mode_property_enum __user *enum_ptr;
4389 uint64_t __user *values_ptr;
4391 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4394 drm_modeset_lock_all(dev);
4395 property = drm_property_find(dev, out_resp->prop_id);
4401 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4402 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4403 list_for_each_entry(prop_enum, &property->enum_list, head)
4407 value_count = property->num_values;
4409 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4410 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4411 out_resp->flags = property->flags;
4413 if ((out_resp->count_values >= value_count) && value_count) {
4414 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4415 for (i = 0; i < value_count; i++) {
4416 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4422 out_resp->count_values = value_count;
4424 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4425 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4426 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4428 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4429 list_for_each_entry(prop_enum, &property->enum_list, head) {
4431 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4436 if (copy_to_user(&enum_ptr[copied].name,
4437 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4444 out_resp->count_enum_blobs = enum_count;
4448 * NOTE: The idea seems to have been to use this to read all the blob
4449 * property values. But nothing ever added them to the corresponding
4450 * list, userspace always used the special-purpose get_blob ioctl to
4451 * read the value for a blob property. It also doesn't make a lot of
4452 * sense to return values here when everything else is just metadata for
4453 * the property itself.
4455 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4456 out_resp->count_enum_blobs = 0;
4458 drm_modeset_unlock_all(dev);
4463 * drm_property_create_blob - Create new blob property
4465 * Creates a new blob property for a specified DRM device, optionally
4468 * @dev: DRM device to create property for
4469 * @length: Length to allocate for blob data
4470 * @data: If specified, copies data into blob
4473 * New blob property with a single reference on success, or an ERR_PTR
4476 struct drm_property_blob *
4477 drm_property_create_blob(struct drm_device *dev, size_t length,
4480 struct drm_property_blob *blob;
4483 if (!length || length > ULONG_MAX - sizeof(struct drm_property_blob))
4484 return ERR_PTR(-EINVAL);
4486 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4488 return ERR_PTR(-ENOMEM);
4490 /* This must be explicitly initialised, so we can safely call list_del
4491 * on it in the removal handler, even if it isn't in a file list. */
4492 INIT_LIST_HEAD(&blob->head_file);
4493 blob->length = length;
4497 memcpy(blob->data, data, length);
4499 mutex_lock(&dev->mode_config.blob_lock);
4501 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4504 mutex_unlock(&dev->mode_config.blob_lock);
4505 return ERR_PTR(-EINVAL);
4508 kref_init(&blob->refcount);
4510 list_add_tail(&blob->head_global,
4511 &dev->mode_config.property_blob_list);
4513 mutex_unlock(&dev->mode_config.blob_lock);
4517 EXPORT_SYMBOL(drm_property_create_blob);
4520 * drm_property_free_blob - Blob property destructor
4522 * Internal free function for blob properties; must not be used directly.
4526 static void drm_property_free_blob(struct kref *kref)
4528 struct drm_property_blob *blob =
4529 container_of(kref, struct drm_property_blob, refcount);
4531 WARN_ON(!mutex_is_locked(&blob->dev->mode_config.blob_lock));
4533 list_del(&blob->head_global);
4534 list_del(&blob->head_file);
4535 drm_mode_object_put(blob->dev, &blob->base);
4541 * drm_property_unreference_blob - Unreference a blob property
4543 * Drop a reference on a blob property. May free the object.
4545 * @blob: Pointer to blob property
4547 void drm_property_unreference_blob(struct drm_property_blob *blob)
4549 struct drm_device *dev;
4556 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4558 if (kref_put_mutex(&blob->refcount, drm_property_free_blob,
4559 &dev->mode_config.blob_lock))
4560 mutex_unlock(&dev->mode_config.blob_lock);
4562 might_lock(&dev->mode_config.blob_lock);
4564 EXPORT_SYMBOL(drm_property_unreference_blob);
4567 * drm_property_unreference_blob_locked - Unreference a blob property with blob_lock held
4569 * Drop a reference on a blob property. May free the object. This must be
4570 * called with blob_lock held.
4572 * @blob: Pointer to blob property
4574 static void drm_property_unreference_blob_locked(struct drm_property_blob *blob)
4579 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4581 kref_put(&blob->refcount, drm_property_free_blob);
4585 * drm_property_destroy_user_blobs - destroy all blobs created by this client
4587 * @file_priv: destroy all blobs owned by this file handle
4589 void drm_property_destroy_user_blobs(struct drm_device *dev,
4590 struct drm_file *file_priv)
4592 struct drm_property_blob *blob, *bt;
4594 mutex_lock(&dev->mode_config.blob_lock);
4596 list_for_each_entry_safe(blob, bt, &file_priv->blobs, head_file) {
4597 list_del_init(&blob->head_file);
4598 drm_property_unreference_blob_locked(blob);
4601 mutex_unlock(&dev->mode_config.blob_lock);
4605 * drm_property_reference_blob - Take a reference on an existing property
4607 * Take a new reference on an existing blob property.
4609 * @blob: Pointer to blob property
4611 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob)
4613 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4614 kref_get(&blob->refcount);
4617 EXPORT_SYMBOL(drm_property_reference_blob);
4620 * Like drm_property_lookup_blob, but does not return an additional reference.
4621 * Must be called with blob_lock held.
4623 static struct drm_property_blob *__drm_property_lookup_blob(struct drm_device *dev,
4626 struct drm_mode_object *obj = NULL;
4627 struct drm_property_blob *blob;
4629 WARN_ON(!mutex_is_locked(&dev->mode_config.blob_lock));
4631 mutex_lock(&dev->mode_config.idr_mutex);
4632 obj = idr_find(&dev->mode_config.crtc_idr, id);
4633 if (!obj || (obj->type != DRM_MODE_OBJECT_BLOB) || (obj->id != id))
4636 blob = obj_to_blob(obj);
4637 mutex_unlock(&dev->mode_config.idr_mutex);
4643 * drm_property_lookup_blob - look up a blob property and take a reference
4645 * @id: id of the blob property
4647 * If successful, this takes an additional reference to the blob property.
4648 * callers need to make sure to eventually unreference the returned property
4649 * again, using @drm_property_unreference_blob.
4651 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
4654 struct drm_property_blob *blob;
4656 mutex_lock(&dev->mode_config.blob_lock);
4657 blob = __drm_property_lookup_blob(dev, id);
4659 if (!kref_get_unless_zero(&blob->refcount))
4662 mutex_unlock(&dev->mode_config.blob_lock);
4666 EXPORT_SYMBOL(drm_property_lookup_blob);
4669 * drm_property_replace_global_blob - atomically replace existing blob property
4671 * @replace: location of blob property pointer to be replaced
4672 * @length: length of data for new blob, or 0 for no data
4673 * @data: content for new blob, or NULL for no data
4674 * @obj_holds_id: optional object for property holding blob ID
4675 * @prop_holds_id: optional property holding blob ID
4676 * @return 0 on success or error on failure
4678 * This function will atomically replace a global property in the blob list,
4679 * optionally updating a property which holds the ID of that property. It is
4680 * guaranteed to be atomic: no caller will be allowed to see intermediate
4681 * results, and either the entire operation will succeed and clean up the
4682 * previous property, or it will fail and the state will be unchanged.
4684 * If length is 0 or data is NULL, no new blob will be created, and the holding
4685 * property, if specified, will be set to 0.
4687 * Access to the replace pointer is assumed to be protected by the caller, e.g.
4688 * by holding the relevant modesetting object lock for its parent.
4690 * For example, a drm_connector has a 'PATH' property, which contains the ID
4691 * of a blob property with the value of the MST path information. Calling this
4692 * function with replace pointing to the connector's path_blob_ptr, length and
4693 * data set for the new path information, obj_holds_id set to the connector's
4694 * base object, and prop_holds_id set to the path property name, will perform
4695 * a completely atomic update. The access to path_blob_ptr is protected by the
4696 * caller holding a lock on the connector.
4698 static int drm_property_replace_global_blob(struct drm_device *dev,
4699 struct drm_property_blob **replace,
4702 struct drm_mode_object *obj_holds_id,
4703 struct drm_property *prop_holds_id)
4705 struct drm_property_blob *new_blob = NULL;
4706 struct drm_property_blob *old_blob = NULL;
4709 WARN_ON(replace == NULL);
4711 old_blob = *replace;
4713 if (length && data) {
4714 new_blob = drm_property_create_blob(dev, length, data);
4715 if (IS_ERR(new_blob))
4716 return PTR_ERR(new_blob);
4719 /* This does not need to be synchronised with blob_lock, as the
4720 * get_properties ioctl locks all modesetting objects, and
4721 * obj_holds_id must be locked before calling here, so we cannot
4722 * have its value out of sync with the list membership modified
4723 * below under blob_lock. */
4725 ret = drm_object_property_set_value(obj_holds_id,
4728 new_blob->base.id : 0);
4733 drm_property_unreference_blob(old_blob);
4734 *replace = new_blob;
4739 drm_property_unreference_blob(new_blob);
4744 * drm_mode_getblob_ioctl - get the contents of a blob property value
4747 * @file_priv: DRM file info
4749 * This function retrieves the contents of a blob property. The value stored in
4750 * an object's blob property is just a normal modeset object id.
4752 * Called by the user via ioctl.
4755 * Zero on success, negative errno on failure.
4757 int drm_mode_getblob_ioctl(struct drm_device *dev,
4758 void *data, struct drm_file *file_priv)
4760 struct drm_mode_get_blob *out_resp = data;
4761 struct drm_property_blob *blob;
4763 void __user *blob_ptr;
4765 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4768 drm_modeset_lock_all(dev);
4769 mutex_lock(&dev->mode_config.blob_lock);
4770 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4776 if (out_resp->length == blob->length) {
4777 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4778 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4783 out_resp->length = blob->length;
4786 mutex_unlock(&dev->mode_config.blob_lock);
4787 drm_modeset_unlock_all(dev);
4792 * drm_mode_createblob_ioctl - create a new blob property
4795 * @file_priv: DRM file info
4797 * This function creates a new blob property with user-defined values. In order
4798 * to give us sensible validation and checking when creating, rather than at
4799 * every potential use, we also require a type to be provided upfront.
4801 * Called by the user via ioctl.
4804 * Zero on success, negative errno on failure.
4806 int drm_mode_createblob_ioctl(struct drm_device *dev,
4807 void *data, struct drm_file *file_priv)
4809 struct drm_mode_create_blob *out_resp = data;
4810 struct drm_property_blob *blob;
4811 void __user *blob_ptr;
4814 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4817 blob = drm_property_create_blob(dev, out_resp->length, NULL);
4819 return PTR_ERR(blob);
4821 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4822 if (copy_from_user(blob->data, blob_ptr, out_resp->length)) {
4827 /* Dropping the lock between create_blob and our access here is safe
4828 * as only the same file_priv can remove the blob; at this point, it is
4829 * not associated with any file_priv. */
4830 mutex_lock(&dev->mode_config.blob_lock);
4831 out_resp->blob_id = blob->base.id;
4832 list_add_tail(&blob->head_file, &file_priv->blobs);
4833 mutex_unlock(&dev->mode_config.blob_lock);
4838 drm_property_unreference_blob(blob);
4843 * drm_mode_destroyblob_ioctl - destroy a user blob property
4846 * @file_priv: DRM file info
4848 * Destroy an existing user-defined blob property.
4850 * Called by the user via ioctl.
4853 * Zero on success, negative errno on failure.
4855 int drm_mode_destroyblob_ioctl(struct drm_device *dev,
4856 void *data, struct drm_file *file_priv)
4858 struct drm_mode_destroy_blob *out_resp = data;
4859 struct drm_property_blob *blob = NULL, *bt;
4863 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4866 mutex_lock(&dev->mode_config.blob_lock);
4867 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4873 /* Ensure the property was actually created by this user. */
4874 list_for_each_entry(bt, &file_priv->blobs, head_file) {
4886 /* We must drop head_file here, because we may not be the last
4887 * reference on the blob. */
4888 list_del_init(&blob->head_file);
4889 drm_property_unreference_blob_locked(blob);
4890 mutex_unlock(&dev->mode_config.blob_lock);
4895 mutex_unlock(&dev->mode_config.blob_lock);
4900 * drm_mode_connector_set_path_property - set tile property on connector
4901 * @connector: connector to set property on.
4902 * @path: path to use for property; must not be NULL.
4904 * This creates a property to expose to userspace to specify a
4905 * connector path. This is mainly used for DisplayPort MST where
4906 * connectors have a topology and we want to allow userspace to give
4907 * them more meaningful names.
4910 * Zero on success, negative errno on failure.
4912 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4915 struct drm_device *dev = connector->dev;
4918 ret = drm_property_replace_global_blob(dev,
4919 &connector->path_blob_ptr,
4923 dev->mode_config.path_property);
4926 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4929 * drm_mode_connector_set_tile_property - set tile property on connector
4930 * @connector: connector to set property on.
4932 * This looks up the tile information for a connector, and creates a
4933 * property for userspace to parse if it exists. The property is of
4934 * the form of 8 integers using ':' as a separator.
4937 * Zero on success, errno on failure.
4939 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4941 struct drm_device *dev = connector->dev;
4945 if (!connector->has_tile) {
4946 ret = drm_property_replace_global_blob(dev,
4947 &connector->tile_blob_ptr,
4951 dev->mode_config.tile_property);
4955 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4956 connector->tile_group->id, connector->tile_is_single_monitor,
4957 connector->num_h_tile, connector->num_v_tile,
4958 connector->tile_h_loc, connector->tile_v_loc,
4959 connector->tile_h_size, connector->tile_v_size);
4961 ret = drm_property_replace_global_blob(dev,
4962 &connector->tile_blob_ptr,
4966 dev->mode_config.tile_property);
4969 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4972 * drm_mode_connector_update_edid_property - update the edid property of a connector
4973 * @connector: drm connector
4974 * @edid: new value of the edid property
4976 * This function creates a new blob modeset object and assigns its id to the
4977 * connector's edid property.
4980 * Zero on success, negative errno on failure.
4982 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4983 const struct edid *edid)
4985 struct drm_device *dev = connector->dev;
4989 /* ignore requests to set edid when overridden */
4990 if (connector->override_edid)
4994 size = EDID_LENGTH * (1 + edid->extensions);
4996 ret = drm_property_replace_global_blob(dev,
4997 &connector->edid_blob_ptr,
5001 dev->mode_config.edid_property);
5004 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
5006 /* Some properties could refer to dynamic refcnt'd objects, or things that
5007 * need special locking to handle lifetime issues (ie. to ensure the prop
5008 * value doesn't become invalid part way through the property update due to
5009 * race). The value returned by reference via 'obj' should be passed back
5010 * to drm_property_change_valid_put() after the property is set (and the
5011 * object to which the property is attached has a chance to take it's own
5014 bool drm_property_change_valid_get(struct drm_property *property,
5015 uint64_t value, struct drm_mode_object **ref)
5019 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
5024 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
5025 if (value < property->values[0] || value > property->values[1])
5028 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
5029 int64_t svalue = U642I64(value);
5031 if (svalue < U642I64(property->values[0]) ||
5032 svalue > U642I64(property->values[1]))
5035 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
5036 uint64_t valid_mask = 0;
5038 for (i = 0; i < property->num_values; i++)
5039 valid_mask |= (1ULL << property->values[i]);
5040 return !(value & ~valid_mask);
5041 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
5042 struct drm_property_blob *blob;
5047 blob = drm_property_lookup_blob(property->dev, value);
5054 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
5055 /* a zero value for an object property translates to null: */
5059 /* handle refcnt'd objects specially: */
5060 if (property->values[0] == DRM_MODE_OBJECT_FB) {
5061 struct drm_framebuffer *fb;
5062 fb = drm_framebuffer_lookup(property->dev, value);
5070 return _object_find(property->dev, value, property->values[0]) != NULL;
5074 for (i = 0; i < property->num_values; i++)
5075 if (property->values[i] == value)
5080 void drm_property_change_valid_put(struct drm_property *property,
5081 struct drm_mode_object *ref)
5086 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
5087 if (property->values[0] == DRM_MODE_OBJECT_FB)
5088 drm_framebuffer_unreference(obj_to_fb(ref));
5089 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
5090 drm_property_unreference_blob(obj_to_blob(ref));
5094 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
5097 * @file_priv: DRM file info
5099 * This function sets the current value for a connectors's property. It also
5100 * calls into a driver's ->set_property callback to update the hardware state
5102 * Called by the user via ioctl.
5105 * Zero on success, negative errno on failure.
5107 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
5108 void *data, struct drm_file *file_priv)
5110 struct drm_mode_connector_set_property *conn_set_prop = data;
5111 struct drm_mode_obj_set_property obj_set_prop = {
5112 .value = conn_set_prop->value,
5113 .prop_id = conn_set_prop->prop_id,
5114 .obj_id = conn_set_prop->connector_id,
5115 .obj_type = DRM_MODE_OBJECT_CONNECTOR
5118 /* It does all the locking and checking we need */
5119 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
5122 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
5123 struct drm_property *property,
5127 struct drm_connector *connector = obj_to_connector(obj);
5129 /* Do DPMS ourselves */
5130 if (property == connector->dev->mode_config.dpms_property) {
5132 if (connector->funcs->dpms)
5133 ret = (*connector->funcs->dpms)(connector, (int)value);
5134 } else if (connector->funcs->set_property)
5135 ret = connector->funcs->set_property(connector, property, value);
5137 /* store the property value if successful */
5139 drm_object_property_set_value(&connector->base, property, value);
5143 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
5144 struct drm_property *property,
5148 struct drm_crtc *crtc = obj_to_crtc(obj);
5150 if (crtc->funcs->set_property)
5151 ret = crtc->funcs->set_property(crtc, property, value);
5153 drm_object_property_set_value(obj, property, value);
5159 * drm_mode_plane_set_obj_prop - set the value of a property
5160 * @plane: drm plane object to set property value for
5161 * @property: property to set
5162 * @value: value the property should be set to
5164 * This functions sets a given property on a given plane object. This function
5165 * calls the driver's ->set_property callback and changes the software state of
5166 * the property if the callback succeeds.
5169 * Zero on success, error code on failure.
5171 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
5172 struct drm_property *property,
5176 struct drm_mode_object *obj = &plane->base;
5178 if (plane->funcs->set_property)
5179 ret = plane->funcs->set_property(plane, property, value);
5181 drm_object_property_set_value(obj, property, value);
5185 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
5188 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
5191 * @file_priv: DRM file info
5193 * This function retrieves the current value for an object's property. Compared
5194 * to the connector specific ioctl this one is extended to also work on crtc and
5197 * Called by the user via ioctl.
5200 * Zero on success, negative errno on failure.
5202 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
5203 struct drm_file *file_priv)
5205 struct drm_mode_obj_get_properties *arg = data;
5206 struct drm_mode_object *obj;
5209 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5212 drm_modeset_lock_all(dev);
5214 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5219 if (!obj->properties) {
5224 ret = get_properties(obj, file_priv->atomic,
5225 (uint32_t __user *)(unsigned long)(arg->props_ptr),
5226 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
5230 drm_modeset_unlock_all(dev);
5235 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
5238 * @file_priv: DRM file info
5240 * This function sets the current value for an object's property. It also calls
5241 * into a driver's ->set_property callback to update the hardware state.
5242 * Compared to the connector specific ioctl this one is extended to also work on
5243 * crtc and plane objects.
5245 * Called by the user via ioctl.
5248 * Zero on success, negative errno on failure.
5250 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
5251 struct drm_file *file_priv)
5253 struct drm_mode_obj_set_property *arg = data;
5254 struct drm_mode_object *arg_obj;
5255 struct drm_mode_object *prop_obj;
5256 struct drm_property *property;
5257 int i, ret = -EINVAL;
5258 struct drm_mode_object *ref;
5260 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5263 drm_modeset_lock_all(dev);
5265 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5270 if (!arg_obj->properties)
5273 for (i = 0; i < arg_obj->properties->count; i++)
5274 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
5277 if (i == arg_obj->properties->count)
5280 prop_obj = drm_mode_object_find(dev, arg->prop_id,
5281 DRM_MODE_OBJECT_PROPERTY);
5286 property = obj_to_property(prop_obj);
5288 if (!drm_property_change_valid_get(property, arg->value, &ref))
5291 switch (arg_obj->type) {
5292 case DRM_MODE_OBJECT_CONNECTOR:
5293 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
5296 case DRM_MODE_OBJECT_CRTC:
5297 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
5299 case DRM_MODE_OBJECT_PLANE:
5300 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
5301 property, arg->value);
5305 drm_property_change_valid_put(property, ref);
5308 drm_modeset_unlock_all(dev);
5313 * drm_mode_connector_attach_encoder - attach a connector to an encoder
5314 * @connector: connector to attach
5315 * @encoder: encoder to attach @connector to
5317 * This function links up a connector to an encoder. Note that the routing
5318 * restrictions between encoders and crtcs are exposed to userspace through the
5319 * possible_clones and possible_crtcs bitmasks.
5322 * Zero on success, negative errno on failure.
5324 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
5325 struct drm_encoder *encoder)
5330 * In the past, drivers have attempted to model the static association
5331 * of connector to encoder in simple connector/encoder devices using a
5332 * direct assignment of connector->encoder = encoder. This connection
5333 * is a logical one and the responsibility of the core, so drivers are
5334 * expected not to mess with this.
5336 * Note that the error return should've been enough here, but a large
5337 * majority of drivers ignores the return value, so add in a big WARN
5338 * to get people's attention.
5340 if (WARN_ON(connector->encoder))
5343 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
5344 if (connector->encoder_ids[i] == 0) {
5345 connector->encoder_ids[i] = encoder->base.id;
5351 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
5354 * drm_mode_crtc_set_gamma_size - set the gamma table size
5355 * @crtc: CRTC to set the gamma table size for
5356 * @gamma_size: size of the gamma table
5358 * Drivers which support gamma tables should set this to the supported gamma
5359 * table size when initializing the CRTC. Currently the drm core only supports a
5360 * fixed gamma table size.
5363 * Zero on success, negative errno on failure.
5365 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
5368 crtc->gamma_size = gamma_size;
5370 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
5372 if (!crtc->gamma_store) {
5373 crtc->gamma_size = 0;
5379 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
5382 * drm_mode_gamma_set_ioctl - set the gamma table
5385 * @file_priv: DRM file info
5387 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
5388 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
5390 * Called by the user via ioctl.
5393 * Zero on success, negative errno on failure.
5395 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
5396 void *data, struct drm_file *file_priv)
5398 struct drm_mode_crtc_lut *crtc_lut = data;
5399 struct drm_crtc *crtc;
5400 void *r_base, *g_base, *b_base;
5404 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5407 drm_modeset_lock_all(dev);
5408 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5414 if (crtc->funcs->gamma_set == NULL) {
5419 /* memcpy into gamma store */
5420 if (crtc_lut->gamma_size != crtc->gamma_size) {
5425 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5426 r_base = crtc->gamma_store;
5427 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
5432 g_base = r_base + size;
5433 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
5438 b_base = g_base + size;
5439 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
5444 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
5447 drm_modeset_unlock_all(dev);
5453 * drm_mode_gamma_get_ioctl - get the gamma table
5456 * @file_priv: DRM file info
5458 * Copy the current gamma table into the storage provided. This also provides
5459 * the gamma table size the driver expects, which can be used to size the
5460 * allocated storage.
5462 * Called by the user via ioctl.
5465 * Zero on success, negative errno on failure.
5467 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
5468 void *data, struct drm_file *file_priv)
5470 struct drm_mode_crtc_lut *crtc_lut = data;
5471 struct drm_crtc *crtc;
5472 void *r_base, *g_base, *b_base;
5476 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5479 drm_modeset_lock_all(dev);
5480 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5486 /* memcpy into gamma store */
5487 if (crtc_lut->gamma_size != crtc->gamma_size) {
5492 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5493 r_base = crtc->gamma_store;
5494 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
5499 g_base = r_base + size;
5500 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
5505 b_base = g_base + size;
5506 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
5511 drm_modeset_unlock_all(dev);
5516 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
5519 * @file_priv: DRM file info
5521 * This schedules an asynchronous update on a given CRTC, called page flip.
5522 * Optionally a drm event is generated to signal the completion of the event.
5523 * Generic drivers cannot assume that a pageflip with changed framebuffer
5524 * properties (including driver specific metadata like tiling layout) will work,
5525 * but some drivers support e.g. pixel format changes through the pageflip
5528 * Called by the user via ioctl.
5531 * Zero on success, negative errno on failure.
5533 int drm_mode_page_flip_ioctl(struct drm_device *dev,
5534 void *data, struct drm_file *file_priv)
5536 struct drm_mode_crtc_page_flip *page_flip = data;
5537 struct drm_crtc *crtc;
5538 struct drm_framebuffer *fb = NULL;
5539 struct drm_pending_vblank_event *e = NULL;
5540 unsigned long flags;
5543 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5546 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
5547 page_flip->reserved != 0)
5550 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
5553 crtc = drm_crtc_find(dev, page_flip->crtc_id);
5557 drm_modeset_lock_crtc(crtc, crtc->primary);
5558 if (crtc->primary->fb == NULL) {
5559 /* The framebuffer is currently unbound, presumably
5560 * due to a hotplug event, that userspace has not
5567 if (crtc->funcs->page_flip == NULL)
5570 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
5577 const struct drm_plane_state *state = crtc->primary->state;
5579 ret = check_src_coords(state->src_x, state->src_y,
5580 state->src_w, state->src_h, fb);
5582 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
5587 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
5588 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
5593 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5595 spin_lock_irqsave(&dev->event_lock, flags);
5596 if (file_priv->event_space < sizeof(e->event)) {
5597 spin_unlock_irqrestore(&dev->event_lock, flags);
5600 file_priv->event_space -= sizeof(e->event);
5601 spin_unlock_irqrestore(&dev->event_lock, flags);
5603 e = kzalloc(sizeof(*e), GFP_KERNEL);
5605 spin_lock_irqsave(&dev->event_lock, flags);
5606 file_priv->event_space += sizeof(e->event);
5607 spin_unlock_irqrestore(&dev->event_lock, flags);
5611 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
5612 e->event.base.length = sizeof(e->event);
5613 e->event.user_data = page_flip->user_data;
5614 e->base.event = &e->event.base;
5615 e->base.file_priv = file_priv;
5617 (void (*) (struct drm_pending_event *)) kfree;
5620 crtc->primary->old_fb = crtc->primary->fb;
5621 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
5623 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5624 spin_lock_irqsave(&dev->event_lock, flags);
5625 file_priv->event_space += sizeof(e->event);
5626 spin_unlock_irqrestore(&dev->event_lock, flags);
5629 /* Keep the old fb, don't unref it. */
5630 crtc->primary->old_fb = NULL;
5632 crtc->primary->fb = fb;
5633 /* Unref only the old framebuffer. */
5639 drm_framebuffer_unreference(fb);
5640 if (crtc->primary->old_fb)
5641 drm_framebuffer_unreference(crtc->primary->old_fb);
5642 crtc->primary->old_fb = NULL;
5643 drm_modeset_unlock_crtc(crtc);
5649 * drm_mode_config_reset - call ->reset callbacks
5652 * This functions calls all the crtc's, encoder's and connector's ->reset
5653 * callback. Drivers can use this in e.g. their driver load or resume code to
5654 * reset hardware and software state.
5656 void drm_mode_config_reset(struct drm_device *dev)
5658 struct drm_crtc *crtc;
5659 struct drm_plane *plane;
5660 struct drm_encoder *encoder;
5661 struct drm_connector *connector;
5663 drm_for_each_plane(plane, dev)
5664 if (plane->funcs->reset)
5665 plane->funcs->reset(plane);
5667 drm_for_each_crtc(crtc, dev)
5668 if (crtc->funcs->reset)
5669 crtc->funcs->reset(crtc);
5671 drm_for_each_encoder(encoder, dev)
5672 if (encoder->funcs->reset)
5673 encoder->funcs->reset(encoder);
5675 mutex_lock(&dev->mode_config.mutex);
5676 drm_for_each_connector(connector, dev)
5677 if (connector->funcs->reset)
5678 connector->funcs->reset(connector);
5679 mutex_unlock(&dev->mode_config.mutex);
5681 EXPORT_SYMBOL(drm_mode_config_reset);
5684 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
5687 * @file_priv: DRM file info
5689 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
5690 * TTM or something else entirely) and returns the resulting buffer handle. This
5691 * handle can then be wrapped up into a framebuffer modeset object.
5693 * Note that userspace is not allowed to use such objects for render
5694 * acceleration - drivers must create their own private ioctls for such a use
5697 * Called by the user via ioctl.
5700 * Zero on success, negative errno on failure.
5702 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
5703 void *data, struct drm_file *file_priv)
5705 struct drm_mode_create_dumb *args = data;
5706 u32 cpp, stride, size;
5708 if (!dev->driver->dumb_create)
5710 if (!args->width || !args->height || !args->bpp)
5713 /* overflow checks for 32bit size calculations */
5714 /* NOTE: DIV_ROUND_UP() can overflow */
5715 cpp = DIV_ROUND_UP(args->bpp, 8);
5716 if (!cpp || cpp > 0xffffffffU / args->width)
5718 stride = cpp * args->width;
5719 if (args->height > 0xffffffffU / stride)
5722 /* test for wrap-around */
5723 size = args->height * stride;
5724 if (PAGE_ALIGN(size) == 0)
5728 * handle, pitch and size are output parameters. Zero them out to
5729 * prevent drivers from accidentally using uninitialized data. Since
5730 * not all existing userspace is clearing these fields properly we
5731 * cannot reject IOCTL with garbage in them.
5737 return dev->driver->dumb_create(file_priv, dev, args);
5741 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5744 * @file_priv: DRM file info
5746 * Allocate an offset in the drm device node's address space to be able to
5747 * memory map a dumb buffer.
5749 * Called by the user via ioctl.
5752 * Zero on success, negative errno on failure.
5754 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5755 void *data, struct drm_file *file_priv)
5757 struct drm_mode_map_dumb *args = data;
5759 /* call driver ioctl to get mmap offset */
5760 if (!dev->driver->dumb_map_offset)
5763 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5767 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5770 * @file_priv: DRM file info
5772 * This destroys the userspace handle for the given dumb backing storage buffer.
5773 * Since buffer objects must be reference counted in the kernel a buffer object
5774 * won't be immediately freed if a framebuffer modeset object still uses it.
5776 * Called by the user via ioctl.
5779 * Zero on success, negative errno on failure.
5781 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5782 void *data, struct drm_file *file_priv)
5784 struct drm_mode_destroy_dumb *args = data;
5786 if (!dev->driver->dumb_destroy)
5789 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5793 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5794 * @format: pixel format (DRM_FORMAT_*)
5795 * @depth: storage for the depth value
5796 * @bpp: storage for the bpp value
5798 * This only supports RGB formats here for compat with code that doesn't use
5799 * pixel formats directly yet.
5801 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5806 case DRM_FORMAT_RGB332:
5807 case DRM_FORMAT_BGR233:
5811 case DRM_FORMAT_XRGB1555:
5812 case DRM_FORMAT_XBGR1555:
5813 case DRM_FORMAT_RGBX5551:
5814 case DRM_FORMAT_BGRX5551:
5815 case DRM_FORMAT_ARGB1555:
5816 case DRM_FORMAT_ABGR1555:
5817 case DRM_FORMAT_RGBA5551:
5818 case DRM_FORMAT_BGRA5551:
5822 case DRM_FORMAT_RGB565:
5823 case DRM_FORMAT_BGR565:
5827 case DRM_FORMAT_RGB888:
5828 case DRM_FORMAT_BGR888:
5832 case DRM_FORMAT_XRGB8888:
5833 case DRM_FORMAT_XBGR8888:
5834 case DRM_FORMAT_RGBX8888:
5835 case DRM_FORMAT_BGRX8888:
5839 case DRM_FORMAT_XRGB2101010:
5840 case DRM_FORMAT_XBGR2101010:
5841 case DRM_FORMAT_RGBX1010102:
5842 case DRM_FORMAT_BGRX1010102:
5843 case DRM_FORMAT_ARGB2101010:
5844 case DRM_FORMAT_ABGR2101010:
5845 case DRM_FORMAT_RGBA1010102:
5846 case DRM_FORMAT_BGRA1010102:
5850 case DRM_FORMAT_ARGB8888:
5851 case DRM_FORMAT_ABGR8888:
5852 case DRM_FORMAT_RGBA8888:
5853 case DRM_FORMAT_BGRA8888:
5858 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5859 drm_get_format_name(format));
5865 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5868 * drm_format_num_planes - get the number of planes for format
5869 * @format: pixel format (DRM_FORMAT_*)
5872 * The number of planes used by the specified pixel format.
5874 int drm_format_num_planes(uint32_t format)
5877 case DRM_FORMAT_YUV410:
5878 case DRM_FORMAT_YVU410:
5879 case DRM_FORMAT_YUV411:
5880 case DRM_FORMAT_YVU411:
5881 case DRM_FORMAT_YUV420:
5882 case DRM_FORMAT_YVU420:
5883 case DRM_FORMAT_YUV422:
5884 case DRM_FORMAT_YVU422:
5885 case DRM_FORMAT_YUV444:
5886 case DRM_FORMAT_YVU444:
5888 case DRM_FORMAT_NV12:
5889 case DRM_FORMAT_NV21:
5890 case DRM_FORMAT_NV16:
5891 case DRM_FORMAT_NV61:
5892 case DRM_FORMAT_NV24:
5893 case DRM_FORMAT_NV42:
5894 case DRM_FORMAT_NV12_10:
5895 case DRM_FORMAT_NV21_10:
5896 case DRM_FORMAT_NV16_10:
5897 case DRM_FORMAT_NV61_10:
5898 case DRM_FORMAT_NV24_10:
5899 case DRM_FORMAT_NV42_10:
5905 EXPORT_SYMBOL(drm_format_num_planes);
5908 * drm_format_plane_bpp - get the bpp for format
5909 * @format: pixel format (DRM_FORMAT_*)
5910 * @plane: plane index
5913 * The bpp for the specified plane.
5915 int drm_format_plane_bpp(uint32_t format, int plane)
5920 if (plane >= drm_format_num_planes(format))
5924 case DRM_FORMAT_YUYV:
5925 case DRM_FORMAT_YVYU:
5926 case DRM_FORMAT_UYVY:
5927 case DRM_FORMAT_VYUY:
5929 case DRM_FORMAT_NV12_10:
5930 case DRM_FORMAT_NV21_10:
5931 case DRM_FORMAT_NV16_10:
5932 case DRM_FORMAT_NV61_10:
5933 case DRM_FORMAT_NV24_10:
5934 case DRM_FORMAT_NV42_10:
5935 return plane ? 20 : 10;
5936 case DRM_FORMAT_NV12:
5937 case DRM_FORMAT_NV21:
5938 case DRM_FORMAT_NV16:
5939 case DRM_FORMAT_NV61:
5940 case DRM_FORMAT_NV24:
5941 case DRM_FORMAT_NV42:
5942 return plane ? 16 : 8;
5943 case DRM_FORMAT_YUV410:
5944 case DRM_FORMAT_YVU410:
5945 case DRM_FORMAT_YUV411:
5946 case DRM_FORMAT_YVU411:
5947 case DRM_FORMAT_YUV420:
5948 case DRM_FORMAT_YVU420:
5949 case DRM_FORMAT_YUV422:
5950 case DRM_FORMAT_YVU422:
5951 case DRM_FORMAT_YUV444:
5952 case DRM_FORMAT_YVU444:
5955 drm_fb_get_bpp_depth(format, &depth, &bpp);
5959 EXPORT_SYMBOL(drm_format_plane_bpp);
5962 * drm_format_plane_cpp - determine the bytes per pixel value
5963 * @format: pixel format (DRM_FORMAT_*)
5964 * @plane: plane index
5967 * The bytes per pixel value for the specified plane.
5969 int drm_format_plane_cpp(uint32_t format, int plane)
5971 return drm_format_plane_bpp(format, plane) >> 3;
5973 EXPORT_SYMBOL(drm_format_plane_cpp);
5976 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5977 * @format: pixel format (DRM_FORMAT_*)
5980 * The horizontal chroma subsampling factor for the
5981 * specified pixel format.
5983 int drm_format_horz_chroma_subsampling(uint32_t format)
5986 case DRM_FORMAT_YUV411:
5987 case DRM_FORMAT_YVU411:
5988 case DRM_FORMAT_YUV410:
5989 case DRM_FORMAT_YVU410:
5991 case DRM_FORMAT_YUYV:
5992 case DRM_FORMAT_YVYU:
5993 case DRM_FORMAT_UYVY:
5994 case DRM_FORMAT_VYUY:
5995 case DRM_FORMAT_NV12:
5996 case DRM_FORMAT_NV21:
5997 case DRM_FORMAT_NV16:
5998 case DRM_FORMAT_NV61:
5999 case DRM_FORMAT_NV12_10:
6000 case DRM_FORMAT_NV21_10:
6001 case DRM_FORMAT_NV16_10:
6002 case DRM_FORMAT_NV61_10:
6003 case DRM_FORMAT_YUV422:
6004 case DRM_FORMAT_YVU422:
6005 case DRM_FORMAT_YUV420:
6006 case DRM_FORMAT_YVU420:
6012 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
6015 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
6016 * @format: pixel format (DRM_FORMAT_*)
6019 * The vertical chroma subsampling factor for the
6020 * specified pixel format.
6022 int drm_format_vert_chroma_subsampling(uint32_t format)
6025 case DRM_FORMAT_YUV410:
6026 case DRM_FORMAT_YVU410:
6028 case DRM_FORMAT_YUV420:
6029 case DRM_FORMAT_YVU420:
6030 case DRM_FORMAT_NV12:
6031 case DRM_FORMAT_NV12_10:
6032 case DRM_FORMAT_NV21:
6033 case DRM_FORMAT_NV21_10:
6039 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
6042 * drm_rotation_simplify() - Try to simplify the rotation
6043 * @rotation: Rotation to be simplified
6044 * @supported_rotations: Supported rotations
6046 * Attempt to simplify the rotation to a form that is supported.
6047 * Eg. if the hardware supports everything except DRM_REFLECT_X
6048 * one could call this function like this:
6050 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
6051 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
6052 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
6054 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
6055 * transforms the hardware supports, this function may not
6056 * be able to produce a supported transform, so the caller should
6057 * check the result afterwards.
6059 unsigned int drm_rotation_simplify(unsigned int rotation,
6060 unsigned int supported_rotations)
6062 if (rotation & ~supported_rotations) {
6063 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
6064 rotation = (rotation & DRM_REFLECT_MASK) |
6065 BIT((ffs(rotation & DRM_ROTATE_MASK) + 1) % 4);
6070 EXPORT_SYMBOL(drm_rotation_simplify);
6073 * drm_mode_config_init - initialize DRM mode_configuration structure
6076 * Initialize @dev's mode_config structure, used for tracking the graphics
6077 * configuration of @dev.
6079 * Since this initializes the modeset locks, no locking is possible. Which is no
6080 * problem, since this should happen single threaded at init time. It is the
6081 * driver's problem to ensure this guarantee.
6084 void drm_mode_config_init(struct drm_device *dev)
6086 mutex_init(&dev->mode_config.mutex);
6087 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
6088 mutex_init(&dev->mode_config.idr_mutex);
6089 mutex_init(&dev->mode_config.fb_lock);
6090 mutex_init(&dev->mode_config.blob_lock);
6091 INIT_LIST_HEAD(&dev->mode_config.fb_list);
6092 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
6093 INIT_LIST_HEAD(&dev->mode_config.connector_list);
6094 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
6095 INIT_LIST_HEAD(&dev->mode_config.property_list);
6096 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
6097 INIT_LIST_HEAD(&dev->mode_config.plane_list);
6098 idr_init(&dev->mode_config.crtc_idr);
6099 idr_init(&dev->mode_config.tile_idr);
6101 drm_modeset_lock_all(dev);
6102 drm_mode_create_standard_properties(dev);
6103 drm_modeset_unlock_all(dev);
6105 /* Just to be sure */
6106 dev->mode_config.num_fb = 0;
6107 dev->mode_config.num_connector = 0;
6108 dev->mode_config.num_crtc = 0;
6109 dev->mode_config.num_encoder = 0;
6110 dev->mode_config.num_overlay_plane = 0;
6111 dev->mode_config.num_total_plane = 0;
6113 EXPORT_SYMBOL(drm_mode_config_init);
6116 * drm_mode_config_cleanup - free up DRM mode_config info
6119 * Free up all the connectors and CRTCs associated with this DRM device, then
6120 * free up the framebuffers and associated buffer objects.
6122 * Note that since this /should/ happen single-threaded at driver/device
6123 * teardown time, no locking is required. It's the driver's job to ensure that
6124 * this guarantee actually holds true.
6126 * FIXME: cleanup any dangling user buffer objects too
6128 void drm_mode_config_cleanup(struct drm_device *dev)
6130 struct drm_connector *connector, *ot;
6131 struct drm_crtc *crtc, *ct;
6132 struct drm_encoder *encoder, *enct;
6133 struct drm_framebuffer *fb, *fbt;
6134 struct drm_property *property, *pt;
6135 struct drm_property_blob *blob, *bt;
6136 struct drm_plane *plane, *plt;
6138 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
6140 encoder->funcs->destroy(encoder);
6143 list_for_each_entry_safe(connector, ot,
6144 &dev->mode_config.connector_list, head) {
6145 connector->funcs->destroy(connector);
6148 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
6150 drm_property_destroy(dev, property);
6153 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
6155 drm_property_unreference_blob(blob);
6159 * Single-threaded teardown context, so it's not required to grab the
6160 * fb_lock to protect against concurrent fb_list access. Contrary, it
6161 * would actually deadlock with the drm_framebuffer_cleanup function.
6163 * Also, if there are any framebuffers left, that's a driver leak now,
6164 * so politely WARN about this.
6166 WARN_ON(!list_empty(&dev->mode_config.fb_list));
6167 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
6168 drm_framebuffer_free(&fb->refcount);
6171 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
6173 plane->funcs->destroy(plane);
6176 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
6177 crtc->funcs->destroy(crtc);
6180 idr_destroy(&dev->mode_config.tile_idr);
6181 idr_destroy(&dev->mode_config.crtc_idr);
6182 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
6184 EXPORT_SYMBOL(drm_mode_config_cleanup);
6186 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
6187 unsigned int supported_rotations)
6189 static const struct drm_prop_enum_list props[] = {
6190 { DRM_ROTATE_0, "rotate-0" },
6191 { DRM_ROTATE_90, "rotate-90" },
6192 { DRM_ROTATE_180, "rotate-180" },
6193 { DRM_ROTATE_270, "rotate-270" },
6194 { DRM_REFLECT_X, "reflect-x" },
6195 { DRM_REFLECT_Y, "reflect-y" },
6198 return drm_property_create_bitmask(dev, 0, "rotation",
6199 props, ARRAY_SIZE(props),
6200 supported_rotations);
6202 EXPORT_SYMBOL(drm_mode_create_rotation_property);
6207 * Tile groups are used to represent tiled monitors with a unique
6208 * integer identifier. Tiled monitors using DisplayID v1.3 have
6209 * a unique 8-byte handle, we store this in a tile group, so we
6210 * have a common identifier for all tiles in a monitor group.
6212 static void drm_tile_group_free(struct kref *kref)
6214 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
6215 struct drm_device *dev = tg->dev;
6216 mutex_lock(&dev->mode_config.idr_mutex);
6217 idr_remove(&dev->mode_config.tile_idr, tg->id);
6218 mutex_unlock(&dev->mode_config.idr_mutex);
6223 * drm_mode_put_tile_group - drop a reference to a tile group.
6225 * @tg: tile group to drop reference to.
6227 * drop reference to tile group and free if 0.
6229 void drm_mode_put_tile_group(struct drm_device *dev,
6230 struct drm_tile_group *tg)
6232 kref_put(&tg->refcount, drm_tile_group_free);
6236 * drm_mode_get_tile_group - get a reference to an existing tile group
6238 * @topology: 8-bytes unique per monitor.
6240 * Use the unique bytes to get a reference to an existing tile group.
6243 * tile group or NULL if not found.
6245 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
6248 struct drm_tile_group *tg;
6250 mutex_lock(&dev->mode_config.idr_mutex);
6251 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
6252 if (!memcmp(tg->group_data, topology, 8)) {
6253 if (!kref_get_unless_zero(&tg->refcount))
6255 mutex_unlock(&dev->mode_config.idr_mutex);
6259 mutex_unlock(&dev->mode_config.idr_mutex);
6262 EXPORT_SYMBOL(drm_mode_get_tile_group);
6265 * drm_mode_create_tile_group - create a tile group from a displayid description
6267 * @topology: 8-bytes unique per monitor.
6269 * Create a tile group for the unique monitor, and get a unique
6270 * identifier for the tile group.
6273 * new tile group or error.
6275 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
6278 struct drm_tile_group *tg;
6281 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
6283 return ERR_PTR(-ENOMEM);
6285 kref_init(&tg->refcount);
6286 memcpy(tg->group_data, topology, 8);
6289 mutex_lock(&dev->mode_config.idr_mutex);
6290 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
6298 mutex_unlock(&dev->mode_config.idr_mutex);
6301 EXPORT_SYMBOL(drm_mode_create_tile_group);