2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
4 * Copyright (c) 2008 Red Hat Inc.
6 * DRM core CRTC related functions
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
28 * Eric Anholt <eric@anholt.net>
29 * Dave Airlie <airlied@linux.ie>
30 * Jesse Barnes <jesse.barnes@intel.com>
32 #include <linux/ctype.h>
33 #include <linux/list.h>
34 #include <linux/slab.h>
35 #include <linux/export.h>
37 #include <drm/drm_crtc.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_fourcc.h>
40 #include <drm/drm_modeset_lock.h>
41 #include <drm/drm_atomic.h>
43 #include "drm_crtc_internal.h"
44 #include "drm_internal.h"
46 static struct drm_framebuffer *
47 internal_framebuffer_create(struct drm_device *dev,
48 struct drm_mode_fb_cmd2 *r,
49 struct drm_file *file_priv);
51 /* Avoid boilerplate. I'm tired of typing. */
52 #define DRM_ENUM_NAME_FN(fnname, list) \
53 const char *fnname(int val) \
56 for (i = 0; i < ARRAY_SIZE(list); i++) { \
57 if (list[i].type == val) \
58 return list[i].name; \
66 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
67 { DRM_MODE_DPMS_ON, "On" },
68 { DRM_MODE_DPMS_STANDBY, "Standby" },
69 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
70 { DRM_MODE_DPMS_OFF, "Off" }
73 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
75 static const struct drm_prop_enum_list drm_plane_type_enum_list[] = {
76 { DRM_PLANE_TYPE_OVERLAY, "Overlay" },
77 { DRM_PLANE_TYPE_PRIMARY, "Primary" },
78 { DRM_PLANE_TYPE_CURSOR, "Cursor" },
84 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
85 { DRM_MODE_SCALE_NONE, "None" },
86 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
87 { DRM_MODE_SCALE_CENTER, "Center" },
88 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
91 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
92 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
93 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
94 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
98 * Non-global properties, but "required" for certain connectors.
100 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
101 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
102 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
103 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
106 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
108 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
109 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
110 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
111 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
114 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
115 drm_dvi_i_subconnector_enum_list)
117 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
118 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
119 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
120 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
121 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
122 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
125 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
127 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
128 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
129 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
130 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
131 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
132 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
135 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
136 drm_tv_subconnector_enum_list)
138 static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
139 { DRM_MODE_DIRTY_OFF, "Off" },
140 { DRM_MODE_DIRTY_ON, "On" },
141 { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
144 struct drm_conn_prop_enum_list {
151 * Connector and encoder types.
153 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
154 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
155 { DRM_MODE_CONNECTOR_VGA, "VGA" },
156 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
157 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
158 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
159 { DRM_MODE_CONNECTOR_Composite, "Composite" },
160 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
161 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
162 { DRM_MODE_CONNECTOR_Component, "Component" },
163 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
164 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
165 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
166 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
167 { DRM_MODE_CONNECTOR_TV, "TV" },
168 { DRM_MODE_CONNECTOR_eDP, "eDP" },
169 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
170 { DRM_MODE_CONNECTOR_DSI, "DSI" },
173 static const struct drm_prop_enum_list drm_encoder_enum_list[] = {
174 { DRM_MODE_ENCODER_NONE, "None" },
175 { DRM_MODE_ENCODER_DAC, "DAC" },
176 { DRM_MODE_ENCODER_TMDS, "TMDS" },
177 { DRM_MODE_ENCODER_LVDS, "LVDS" },
178 { DRM_MODE_ENCODER_TVDAC, "TV" },
179 { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
180 { DRM_MODE_ENCODER_DSI, "DSI" },
181 { DRM_MODE_ENCODER_DPMST, "DP MST" },
184 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
185 { SubPixelUnknown, "Unknown" },
186 { SubPixelHorizontalRGB, "Horizontal RGB" },
187 { SubPixelHorizontalBGR, "Horizontal BGR" },
188 { SubPixelVerticalRGB, "Vertical RGB" },
189 { SubPixelVerticalBGR, "Vertical BGR" },
190 { SubPixelNone, "None" },
193 void drm_connector_ida_init(void)
197 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
198 ida_init(&drm_connector_enum_list[i].ida);
201 void drm_connector_ida_destroy(void)
205 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
206 ida_destroy(&drm_connector_enum_list[i].ida);
210 * drm_get_connector_status_name - return a string for connector status
211 * @status: connector status to compute name of
213 * In contrast to the other drm_get_*_name functions this one here returns a
214 * const pointer and hence is threadsafe.
216 const char *drm_get_connector_status_name(enum drm_connector_status status)
218 if (status == connector_status_connected)
220 else if (status == connector_status_disconnected)
221 return "disconnected";
225 EXPORT_SYMBOL(drm_get_connector_status_name);
228 * drm_get_subpixel_order_name - return a string for a given subpixel enum
229 * @order: enum of subpixel_order
231 * Note you could abuse this and return something out of bounds, but that
232 * would be a caller error. No unscrubbed user data should make it here.
234 const char *drm_get_subpixel_order_name(enum subpixel_order order)
236 return drm_subpixel_enum_list[order].name;
238 EXPORT_SYMBOL(drm_get_subpixel_order_name);
240 static char printable_char(int c)
242 return isascii(c) && isprint(c) ? c : '?';
246 * drm_get_format_name - return a string for drm fourcc format
247 * @format: format to compute name of
249 * Note that the buffer used by this function is globally shared and owned by
250 * the function itself.
252 * FIXME: This isn't really multithreading safe.
254 const char *drm_get_format_name(uint32_t format)
258 snprintf(buf, sizeof(buf),
259 "%c%c%c%c %s-endian (0x%08x)",
260 printable_char(format & 0xff),
261 printable_char((format >> 8) & 0xff),
262 printable_char((format >> 16) & 0xff),
263 printable_char((format >> 24) & 0x7f),
264 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
269 EXPORT_SYMBOL(drm_get_format_name);
272 * Internal function to assign a slot in the object idr and optionally
273 * register the object into the idr.
275 static int drm_mode_object_get_reg(struct drm_device *dev,
276 struct drm_mode_object *obj,
282 mutex_lock(&dev->mode_config.idr_mutex);
283 ret = idr_alloc(&dev->mode_config.crtc_idr, register_obj ? obj : NULL, 1, 0, GFP_KERNEL);
286 * Set up the object linking under the protection of the idr
287 * lock so that other users can't see inconsistent state.
290 obj->type = obj_type;
292 mutex_unlock(&dev->mode_config.idr_mutex);
294 return ret < 0 ? ret : 0;
298 * drm_mode_object_get - allocate a new modeset identifier
300 * @obj: object pointer, used to generate unique ID
301 * @obj_type: object type
303 * Create a unique identifier based on @ptr in @dev's identifier space. Used
304 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
305 * modeset identifiers are _not_ reference counted. Hence don't use this for
306 * reference counted modeset objects like framebuffers.
309 * Zero on success, error code on failure.
311 int drm_mode_object_get(struct drm_device *dev,
312 struct drm_mode_object *obj, uint32_t obj_type)
314 return drm_mode_object_get_reg(dev, obj, obj_type, true);
317 static void drm_mode_object_register(struct drm_device *dev,
318 struct drm_mode_object *obj)
320 mutex_lock(&dev->mode_config.idr_mutex);
321 idr_replace(&dev->mode_config.crtc_idr, obj, obj->id);
322 mutex_unlock(&dev->mode_config.idr_mutex);
326 * drm_mode_object_put - free a modeset identifer
328 * @object: object to free
330 * Free @id from @dev's unique identifier pool. Note that despite the _get
331 * postfix modeset identifiers are _not_ reference counted. Hence don't use this
332 * for reference counted modeset objects like framebuffers.
334 void drm_mode_object_put(struct drm_device *dev,
335 struct drm_mode_object *object)
337 mutex_lock(&dev->mode_config.idr_mutex);
338 idr_remove(&dev->mode_config.crtc_idr, object->id);
339 mutex_unlock(&dev->mode_config.idr_mutex);
342 static struct drm_mode_object *_object_find(struct drm_device *dev,
343 uint32_t id, uint32_t type)
345 struct drm_mode_object *obj = NULL;
347 mutex_lock(&dev->mode_config.idr_mutex);
348 obj = idr_find(&dev->mode_config.crtc_idr, id);
349 if (obj && type != DRM_MODE_OBJECT_ANY && obj->type != type)
351 if (obj && obj->id != id)
353 /* don't leak out unref'd fb's */
355 (obj->type == DRM_MODE_OBJECT_FB ||
356 obj->type == DRM_MODE_OBJECT_BLOB))
358 mutex_unlock(&dev->mode_config.idr_mutex);
364 * drm_mode_object_find - look up a drm object with static lifetime
366 * @id: id of the mode object
367 * @type: type of the mode object
369 * Note that framebuffers cannot be looked up with this functions - since those
370 * are reference counted, they need special treatment. Even with
371 * DRM_MODE_OBJECT_ANY (although that will simply return NULL
372 * rather than WARN_ON()).
374 struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
375 uint32_t id, uint32_t type)
377 struct drm_mode_object *obj = NULL;
379 /* Framebuffers are reference counted and need their own lookup
381 WARN_ON(type == DRM_MODE_OBJECT_FB || type == DRM_MODE_OBJECT_BLOB);
382 obj = _object_find(dev, id, type);
385 EXPORT_SYMBOL(drm_mode_object_find);
388 * drm_framebuffer_init - initialize a framebuffer
390 * @fb: framebuffer to be initialized
391 * @funcs: ... with these functions
393 * Allocates an ID for the framebuffer's parent mode object, sets its mode
394 * functions & device file and adds it to the master fd list.
397 * This functions publishes the fb and makes it available for concurrent access
398 * by other users. Which means by this point the fb _must_ be fully set up -
399 * since all the fb attributes are invariant over its lifetime, no further
400 * locking but only correct reference counting is required.
403 * Zero on success, error code on failure.
405 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
406 const struct drm_framebuffer_funcs *funcs)
410 mutex_lock(&dev->mode_config.fb_lock);
411 kref_init(&fb->refcount);
412 INIT_LIST_HEAD(&fb->filp_head);
416 ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
420 dev->mode_config.num_fb++;
421 list_add(&fb->head, &dev->mode_config.fb_list);
423 mutex_unlock(&dev->mode_config.fb_lock);
427 EXPORT_SYMBOL(drm_framebuffer_init);
429 /* dev->mode_config.fb_lock must be held! */
430 static void __drm_framebuffer_unregister(struct drm_device *dev,
431 struct drm_framebuffer *fb)
433 mutex_lock(&dev->mode_config.idr_mutex);
434 idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
435 mutex_unlock(&dev->mode_config.idr_mutex);
440 static void drm_framebuffer_free(struct kref *kref)
442 struct drm_framebuffer *fb =
443 container_of(kref, struct drm_framebuffer, refcount);
444 struct drm_device *dev = fb->dev;
447 * The lookup idr holds a weak reference, which has not necessarily been
448 * removed at this point. Check for that.
450 mutex_lock(&dev->mode_config.fb_lock);
452 /* Mark fb as reaped and drop idr ref. */
453 __drm_framebuffer_unregister(dev, fb);
455 mutex_unlock(&dev->mode_config.fb_lock);
457 fb->funcs->destroy(fb);
460 static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
463 struct drm_mode_object *obj = NULL;
464 struct drm_framebuffer *fb;
466 mutex_lock(&dev->mode_config.idr_mutex);
467 obj = idr_find(&dev->mode_config.crtc_idr, id);
468 if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
472 mutex_unlock(&dev->mode_config.idr_mutex);
478 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
480 * @id: id of the fb object
482 * If successful, this grabs an additional reference to the framebuffer -
483 * callers need to make sure to eventually unreference the returned framebuffer
484 * again, using @drm_framebuffer_unreference.
486 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
489 struct drm_framebuffer *fb;
491 mutex_lock(&dev->mode_config.fb_lock);
492 fb = __drm_framebuffer_lookup(dev, id);
494 if (!kref_get_unless_zero(&fb->refcount))
497 mutex_unlock(&dev->mode_config.fb_lock);
501 EXPORT_SYMBOL(drm_framebuffer_lookup);
504 * drm_framebuffer_unreference - unref a framebuffer
505 * @fb: framebuffer to unref
507 * This functions decrements the fb's refcount and frees it if it drops to zero.
509 void drm_framebuffer_unreference(struct drm_framebuffer *fb)
511 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
512 kref_put(&fb->refcount, drm_framebuffer_free);
514 EXPORT_SYMBOL(drm_framebuffer_unreference);
517 * drm_framebuffer_reference - incr the fb refcnt
520 * This functions increments the fb's refcount.
522 void drm_framebuffer_reference(struct drm_framebuffer *fb)
524 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
525 kref_get(&fb->refcount);
527 EXPORT_SYMBOL(drm_framebuffer_reference);
530 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
531 * @fb: fb to unregister
533 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
534 * those used for fbdev. Note that the caller must hold a reference of it's own,
535 * i.e. the object may not be destroyed through this call (since it'll lead to a
536 * locking inversion).
538 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
540 struct drm_device *dev;
547 mutex_lock(&dev->mode_config.fb_lock);
548 /* Mark fb as reaped and drop idr ref. */
549 __drm_framebuffer_unregister(dev, fb);
550 mutex_unlock(&dev->mode_config.fb_lock);
552 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
555 * drm_framebuffer_cleanup - remove a framebuffer object
556 * @fb: framebuffer to remove
558 * Cleanup framebuffer. This function is intended to be used from the drivers
559 * ->destroy callback. It can also be used to clean up driver private
560 * framebuffers embedded into a larger structure.
562 * Note that this function does not remove the fb from active usuage - if it is
563 * still used anywhere, hilarity can ensue since userspace could call getfb on
564 * the id and get back -EINVAL. Obviously no concern at driver unload time.
566 * Also, the framebuffer will not be removed from the lookup idr - for
567 * user-created framebuffers this will happen in in the rmfb ioctl. For
568 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
569 * drm_framebuffer_unregister_private.
571 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
573 struct drm_device *dev = fb->dev;
575 mutex_lock(&dev->mode_config.fb_lock);
577 dev->mode_config.num_fb--;
578 mutex_unlock(&dev->mode_config.fb_lock);
580 EXPORT_SYMBOL(drm_framebuffer_cleanup);
583 * drm_framebuffer_remove - remove and unreference a framebuffer object
584 * @fb: framebuffer to remove
586 * Scans all the CRTCs and planes in @dev's mode_config. If they're
587 * using @fb, removes it, setting it to NULL. Then drops the reference to the
588 * passed-in framebuffer. Might take the modeset locks.
590 * Note that this function optimizes the cleanup away if the caller holds the
591 * last reference to the framebuffer. It is also guaranteed to not take the
592 * modeset locks in this case.
594 void drm_framebuffer_remove(struct drm_framebuffer *fb)
596 struct drm_device *dev;
597 struct drm_crtc *crtc;
598 struct drm_plane *plane;
599 struct drm_mode_set set;
607 WARN_ON(!list_empty(&fb->filp_head));
610 * drm ABI mandates that we remove any deleted framebuffers from active
611 * useage. But since most sane clients only remove framebuffers they no
612 * longer need, try to optimize this away.
614 * Since we're holding a reference ourselves, observing a refcount of 1
615 * means that we're the last holder and can skip it. Also, the refcount
616 * can never increase from 1 again, so we don't need any barriers or
619 * Note that userspace could try to race with use and instate a new
620 * usage _after_ we've cleared all current ones. End result will be an
621 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
624 if (atomic_read(&fb->refcount.refcount) > 1) {
625 drm_modeset_lock_all(dev);
626 /* remove from any CRTC */
627 drm_for_each_crtc(crtc, dev) {
628 if (crtc->primary->fb == fb) {
629 /* should turn off the crtc */
630 memset(&set, 0, sizeof(struct drm_mode_set));
633 ret = drm_mode_set_config_internal(&set);
635 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
639 drm_for_each_plane(plane, dev) {
641 drm_plane_force_disable(plane);
643 drm_modeset_unlock_all(dev);
646 drm_framebuffer_unreference(fb);
648 EXPORT_SYMBOL(drm_framebuffer_remove);
650 DEFINE_WW_CLASS(crtc_ww_class);
653 * drm_crtc_init_with_planes - Initialise a new CRTC object with
654 * specified primary and cursor planes.
656 * @crtc: CRTC object to init
657 * @primary: Primary plane for CRTC
658 * @cursor: Cursor plane for CRTC
659 * @funcs: callbacks for the new CRTC
660 * @name: printf style format string for the CRTC name, or NULL for default name
662 * Inits a new object created as base part of a driver crtc object.
665 * Zero on success, error code on failure.
667 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
668 struct drm_plane *primary,
669 struct drm_plane *cursor,
670 const struct drm_crtc_funcs *funcs,
671 const char *name, ...)
673 struct drm_mode_config *config = &dev->mode_config;
676 WARN_ON(primary && primary->type != DRM_PLANE_TYPE_PRIMARY);
677 WARN_ON(cursor && cursor->type != DRM_PLANE_TYPE_CURSOR);
682 drm_modeset_lock_init(&crtc->mutex);
683 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
687 crtc->base.properties = &crtc->properties;
689 list_add_tail(&crtc->head, &config->crtc_list);
692 crtc->primary = primary;
693 crtc->cursor = cursor;
695 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
697 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
699 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
700 drm_object_attach_property(&crtc->base, config->prop_active, 0);
701 drm_object_attach_property(&crtc->base, config->prop_mode_id, 0);
706 EXPORT_SYMBOL(drm_crtc_init_with_planes);
709 * drm_crtc_cleanup - Clean up the core crtc usage
710 * @crtc: CRTC to cleanup
712 * This function cleans up @crtc and removes it from the DRM mode setting
713 * core. Note that the function does *not* free the crtc structure itself,
714 * this is the responsibility of the caller.
716 void drm_crtc_cleanup(struct drm_crtc *crtc)
718 struct drm_device *dev = crtc->dev;
720 kfree(crtc->gamma_store);
721 crtc->gamma_store = NULL;
723 drm_modeset_lock_fini(&crtc->mutex);
725 drm_mode_object_put(dev, &crtc->base);
726 list_del(&crtc->head);
727 dev->mode_config.num_crtc--;
729 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
730 if (crtc->state && crtc->funcs->atomic_destroy_state)
731 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
733 memset(crtc, 0, sizeof(*crtc));
735 EXPORT_SYMBOL(drm_crtc_cleanup);
738 * drm_crtc_index - find the index of a registered CRTC
739 * @crtc: CRTC to find index for
741 * Given a registered CRTC, return the index of that CRTC within a DRM
742 * device's list of CRTCs.
744 unsigned int drm_crtc_index(struct drm_crtc *crtc)
746 unsigned int index = 0;
747 struct drm_crtc *tmp;
749 drm_for_each_crtc(tmp, crtc->dev) {
758 EXPORT_SYMBOL(drm_crtc_index);
761 * drm_mode_remove - remove and free a mode
762 * @connector: connector list to modify
763 * @mode: mode to remove
765 * Remove @mode from @connector's mode list, then free it.
767 static void drm_mode_remove(struct drm_connector *connector,
768 struct drm_display_mode *mode)
770 list_del(&mode->head);
771 drm_mode_destroy(connector->dev, mode);
775 * drm_display_info_set_bus_formats - set the supported bus formats
776 * @info: display info to store bus formats in
777 * @formats: array containing the supported bus formats
778 * @num_formats: the number of entries in the fmts array
780 * Store the supported bus formats in display info structure.
781 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
782 * a full list of available formats.
784 int drm_display_info_set_bus_formats(struct drm_display_info *info,
786 unsigned int num_formats)
790 if (!formats && num_formats)
793 if (formats && num_formats) {
794 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
800 kfree(info->bus_formats);
801 info->bus_formats = fmts;
802 info->num_bus_formats = num_formats;
806 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
809 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
810 * @connector: connector to quwery
812 * The kernel supports per-connector configration of its consoles through
813 * use of the video= parameter. This function parses that option and
814 * extracts the user's specified mode (or enable/disable status) for a
815 * particular connector. This is typically only used during the early fbdev
818 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
820 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
823 if (fb_get_options(connector->name, &option))
826 if (!drm_mode_parse_command_line_for_connector(option,
834 switch (mode->force) {
838 case DRM_FORCE_ON_DIGITAL:
847 DRM_INFO("forcing %s connector %s\n", connector->name, s);
848 connector->force = mode->force;
851 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
853 mode->xres, mode->yres,
854 mode->refresh_specified ? mode->refresh : 60,
855 mode->rb ? " reduced blanking" : "",
856 mode->margins ? " with margins" : "",
857 mode->interlace ? " interlaced" : "");
861 * drm_connector_init - Init a preallocated connector
863 * @connector: the connector to init
864 * @funcs: callbacks for this connector
865 * @connector_type: user visible type of the connector
867 * Initialises a preallocated connector. Connectors should be
868 * subclassed as part of driver connector objects.
871 * Zero on success, error code on failure.
873 int drm_connector_init(struct drm_device *dev,
874 struct drm_connector *connector,
875 const struct drm_connector_funcs *funcs,
878 struct drm_mode_config *config = &dev->mode_config;
880 struct ida *connector_ida =
881 &drm_connector_enum_list[connector_type].ida;
883 drm_modeset_lock_all(dev);
885 ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
889 connector->base.properties = &connector->properties;
890 connector->dev = dev;
891 connector->funcs = funcs;
892 connector->connector_type = connector_type;
893 connector->connector_type_id =
894 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
895 if (connector->connector_type_id < 0) {
896 ret = connector->connector_type_id;
900 kasprintf(GFP_KERNEL, "%s-%d",
901 drm_connector_enum_list[connector_type].name,
902 connector->connector_type_id);
903 if (!connector->name) {
908 INIT_LIST_HEAD(&connector->probed_modes);
909 INIT_LIST_HEAD(&connector->modes);
910 connector->edid_blob_ptr = NULL;
911 connector->status = connector_status_unknown;
913 drm_connector_get_cmdline_mode(connector);
915 /* We should add connectors at the end to avoid upsetting the connector
917 list_add_tail(&connector->head, &config->connector_list);
918 config->num_connector++;
920 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
921 drm_object_attach_property(&connector->base,
922 config->edid_property,
925 drm_object_attach_property(&connector->base,
926 config->dpms_property, 0);
928 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
929 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
932 connector->debugfs_entry = NULL;
936 drm_mode_object_put(dev, &connector->base);
939 drm_modeset_unlock_all(dev);
943 EXPORT_SYMBOL(drm_connector_init);
946 * drm_connector_cleanup - cleans up an initialised connector
947 * @connector: connector to cleanup
949 * Cleans up the connector but doesn't free the object.
951 void drm_connector_cleanup(struct drm_connector *connector)
953 struct drm_device *dev = connector->dev;
954 struct drm_display_mode *mode, *t;
956 if (connector->tile_group) {
957 drm_mode_put_tile_group(dev, connector->tile_group);
958 connector->tile_group = NULL;
961 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
962 drm_mode_remove(connector, mode);
964 list_for_each_entry_safe(mode, t, &connector->modes, head)
965 drm_mode_remove(connector, mode);
967 ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
968 connector->connector_type_id);
970 kfree(connector->display_info.bus_formats);
971 drm_mode_object_put(dev, &connector->base);
972 kfree(connector->name);
973 connector->name = NULL;
974 list_del(&connector->head);
975 dev->mode_config.num_connector--;
977 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
978 if (connector->state && connector->funcs->atomic_destroy_state)
979 connector->funcs->atomic_destroy_state(connector,
982 memset(connector, 0, sizeof(*connector));
984 EXPORT_SYMBOL(drm_connector_cleanup);
987 * drm_connector_index - find the index of a registered connector
988 * @connector: connector to find index for
990 * Given a registered connector, return the index of that connector within a DRM
991 * device's list of connectors.
993 unsigned int drm_connector_index(struct drm_connector *connector)
995 unsigned int index = 0;
996 struct drm_connector *tmp;
997 struct drm_mode_config *config = &connector->dev->mode_config;
999 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
1001 drm_for_each_connector(tmp, connector->dev) {
1002 if (tmp == connector)
1010 EXPORT_SYMBOL(drm_connector_index);
1013 * drm_connector_register - register a connector
1014 * @connector: the connector to register
1016 * Register userspace interfaces for a connector
1019 * Zero on success, error code on failure.
1021 int drm_connector_register(struct drm_connector *connector)
1025 drm_mode_object_register(connector->dev, &connector->base);
1027 ret = drm_sysfs_connector_add(connector);
1031 ret = drm_debugfs_connector_add(connector);
1036 if (connector->funcs->late_register) {
1037 ret = connector->funcs->late_register(connector);
1045 drm_debugfs_connector_remove(connector);
1047 drm_sysfs_connector_remove(connector);
1050 EXPORT_SYMBOL(drm_connector_register);
1053 * drm_connector_unregister - unregister a connector
1054 * @connector: the connector to unregister
1056 * Unregister userspace interfaces for a connector
1058 void drm_connector_unregister(struct drm_connector *connector)
1060 if (connector->funcs->early_unregister)
1061 connector->funcs->early_unregister(connector);
1063 drm_sysfs_connector_remove(connector);
1064 drm_debugfs_connector_remove(connector);
1066 EXPORT_SYMBOL(drm_connector_unregister);
1069 * drm_connector_register_all - register all connectors
1072 * This function registers all connectors in sysfs and other places so that
1073 * userspace can start to access them. drm_connector_register_all() is called
1074 * automatically from drm_dev_register() to complete the device registration,
1075 * if they don't call drm_connector_register() on each connector individually.
1077 * When a device is unplugged and should be removed from userspace access,
1078 * call drm_connector_unregister_all(), which is the inverse of this
1082 * Zero on success, error code on failure.
1084 int drm_connector_register_all(struct drm_device *dev)
1086 struct drm_connector *connector;
1089 mutex_lock(&dev->mode_config.mutex);
1091 drm_for_each_connector(connector, dev) {
1092 ret = drm_connector_register(connector);
1097 mutex_unlock(&dev->mode_config.mutex);
1102 mutex_unlock(&dev->mode_config.mutex);
1103 drm_connector_unregister_all(dev);
1106 EXPORT_SYMBOL(drm_connector_register_all);
1109 * drm_connector_unregister_all - unregister connector userspace interfaces
1112 * This functions unregisters all connectors from sysfs and other places so
1113 * that userspace can no longer access them. Drivers should call this as the
1114 * first step tearing down the device instace, or when the underlying
1115 * physical device disappeared (e.g. USB unplug), right before calling
1116 * drm_dev_unregister().
1118 void drm_connector_unregister_all(struct drm_device *dev)
1120 struct drm_connector *connector;
1122 /* FIXME: taking the mode config mutex ends up in a clash with sysfs */
1123 drm_for_each_connector(connector, dev)
1124 drm_connector_unregister(connector);
1126 EXPORT_SYMBOL(drm_connector_unregister_all);
1129 * drm_encoder_init - Init a preallocated encoder
1131 * @encoder: the encoder to init
1132 * @funcs: callbacks for this encoder
1133 * @encoder_type: user visible type of the encoder
1134 * @name: printf style format string for the encoder name, or NULL for default name
1136 * Initialises a preallocated encoder. Encoder should be
1137 * subclassed as part of driver encoder objects.
1140 * Zero on success, error code on failure.
1142 int drm_encoder_init(struct drm_device *dev,
1143 struct drm_encoder *encoder,
1144 const struct drm_encoder_funcs *funcs,
1145 int encoder_type, const char *name, ...)
1149 drm_modeset_lock_all(dev);
1151 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1156 encoder->encoder_type = encoder_type;
1157 encoder->funcs = funcs;
1158 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1159 drm_encoder_enum_list[encoder_type].name,
1161 if (!encoder->name) {
1166 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1167 dev->mode_config.num_encoder++;
1171 drm_mode_object_put(dev, &encoder->base);
1174 drm_modeset_unlock_all(dev);
1178 EXPORT_SYMBOL(drm_encoder_init);
1181 * drm_encoder_cleanup - cleans up an initialised encoder
1182 * @encoder: encoder to cleanup
1184 * Cleans up the encoder but doesn't free the object.
1186 void drm_encoder_cleanup(struct drm_encoder *encoder)
1188 struct drm_device *dev = encoder->dev;
1190 drm_modeset_lock_all(dev);
1191 drm_mode_object_put(dev, &encoder->base);
1192 kfree(encoder->name);
1193 list_del(&encoder->head);
1194 dev->mode_config.num_encoder--;
1195 drm_modeset_unlock_all(dev);
1197 memset(encoder, 0, sizeof(*encoder));
1199 EXPORT_SYMBOL(drm_encoder_cleanup);
1202 * drm_universal_plane_init - Initialize a new universal plane object
1204 * @plane: plane object to init
1205 * @possible_crtcs: bitmask of possible CRTCs
1206 * @funcs: callbacks for the new plane
1207 * @formats: array of supported formats (%DRM_FORMAT_*)
1208 * @format_count: number of elements in @formats
1209 * @type: type of plane (overlay, primary, cursor)
1210 * @name: printf style format string for the plane name, or NULL for default name
1212 * Initializes a plane object of type @type.
1215 * Zero on success, error code on failure.
1217 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1218 unsigned long possible_crtcs,
1219 const struct drm_plane_funcs *funcs,
1220 const uint32_t *formats, unsigned int format_count,
1221 enum drm_plane_type type,
1222 const char *name, ...)
1224 struct drm_mode_config *config = &dev->mode_config;
1227 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1231 drm_modeset_lock_init(&plane->mutex);
1233 plane->base.properties = &plane->properties;
1235 plane->funcs = funcs;
1236 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1238 if (!plane->format_types) {
1239 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1240 drm_mode_object_put(dev, &plane->base);
1244 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1245 plane->format_count = format_count;
1246 plane->possible_crtcs = possible_crtcs;
1249 list_add_tail(&plane->head, &config->plane_list);
1250 config->num_total_plane++;
1251 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1252 config->num_overlay_plane++;
1254 drm_object_attach_property(&plane->base,
1255 config->plane_type_property,
1258 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1259 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1260 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1261 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1262 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1263 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1264 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1265 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1266 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1267 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1268 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1273 EXPORT_SYMBOL(drm_universal_plane_init);
1276 * drm_plane_init - Initialize a legacy plane
1278 * @plane: plane object to init
1279 * @possible_crtcs: bitmask of possible CRTCs
1280 * @funcs: callbacks for the new plane
1281 * @formats: array of supported formats (%DRM_FORMAT_*)
1282 * @format_count: number of elements in @formats
1283 * @is_primary: plane type (primary vs overlay)
1285 * Legacy API to initialize a DRM plane.
1287 * New drivers should call drm_universal_plane_init() instead.
1290 * Zero on success, error code on failure.
1292 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1293 unsigned long possible_crtcs,
1294 const struct drm_plane_funcs *funcs,
1295 const uint32_t *formats, unsigned int format_count,
1298 enum drm_plane_type type;
1300 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1301 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1302 formats, format_count, type, NULL);
1304 EXPORT_SYMBOL(drm_plane_init);
1307 * drm_share_plane_init - Initialize a share plane
1309 * @plane: plane object to init
1310 * @parent: this plane share some resources with parent plane.
1311 * @possible_crtcs: bitmask of possible CRTCs
1312 * @funcs: callbacks for the new plane
1313 * @formats: array of supported formats (%DRM_FORMAT_*)
1314 * @format_count: number of elements in @formats
1315 * @type: type of plane (overlay, primary, cursor)
1317 * With this API, the plane can share hardware resources with other planes.
1319 * --------------------------------------------------
1321 * | ------------------ |
1322 * | | parent plane | |
1323 * | | active scanout | |
1324 * | | | ----------------- |
1325 * | ------------------ | share plane 1 | |
1326 * | ----------------- |active scanout | |
1327 * | | share plane 0 | | | |
1328 * | |active scanout | ----------------- |
1330 * | ----------------- |
1331 * --------------------------------------------------
1338 * The plane hardware is used when the display scanout run into plane active
1339 * scanout, that means we can reuse the plane hardware resources on plane
1340 * non-active scanout.
1342 * Because resource share, There are some limit on share plane: one group
1343 * of share planes need use same zpos, can't not overlap, etc.
1345 * Here assume share plane is a universal plane with some limit flags.
1346 * people who use the share plane need know the limit, should call the ioctl
1347 * DRM_CLIENT_CAP_SHARE_PLANES, and judge the planes limit before use it.
1350 * Zero on success, error code on failure.
1353 int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1354 struct drm_plane *parent,
1355 unsigned long possible_crtcs,
1356 const struct drm_plane_funcs *funcs,
1357 const uint32_t *formats, unsigned int format_count,
1358 enum drm_plane_type type)
1360 struct drm_mode_config *config = &dev->mode_config;
1365 * TODO: only verified on ATOMIC drm driver.
1367 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1370 ret = drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1371 formats, format_count, type, NULL);
1377 * Can't support more than two level plane share.
1379 WARN_ON(parent->parent);
1380 share_id = parent->base.id;
1381 plane->parent = parent;
1383 config->num_share_plane++;
1384 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1385 config->num_share_overlay_plane++;
1387 share_id = plane->base.id;
1390 drm_object_attach_property(&plane->base,
1391 config->prop_share_id, share_id);
1394 EXPORT_SYMBOL(drm_share_plane_init);
1397 * drm_plane_cleanup - Clean up the core plane usage
1398 * @plane: plane to cleanup
1400 * This function cleans up @plane and removes it from the DRM mode setting
1401 * core. Note that the function does *not* free the plane structure itself,
1402 * this is the responsibility of the caller.
1404 void drm_plane_cleanup(struct drm_plane *plane)
1406 struct drm_device *dev = plane->dev;
1408 drm_modeset_lock_all(dev);
1409 kfree(plane->format_types);
1410 drm_mode_object_put(dev, &plane->base);
1412 BUG_ON(list_empty(&plane->head));
1414 list_del(&plane->head);
1415 dev->mode_config.num_total_plane--;
1416 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1417 dev->mode_config.num_overlay_plane--;
1418 if (plane->parent) {
1419 dev->mode_config.num_share_plane--;
1420 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1421 dev->mode_config.num_share_overlay_plane--;
1423 drm_modeset_unlock_all(dev);
1425 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1426 if (plane->state && plane->funcs->atomic_destroy_state)
1427 plane->funcs->atomic_destroy_state(plane, plane->state);
1429 memset(plane, 0, sizeof(*plane));
1431 EXPORT_SYMBOL(drm_plane_cleanup);
1434 * drm_plane_index - find the index of a registered plane
1435 * @plane: plane to find index for
1437 * Given a registered plane, return the index of that CRTC within a DRM
1438 * device's list of planes.
1440 unsigned int drm_plane_index(struct drm_plane *plane)
1442 unsigned int index = 0;
1443 struct drm_plane *tmp;
1445 drm_for_each_plane(tmp, plane->dev) {
1454 EXPORT_SYMBOL(drm_plane_index);
1457 * drm_plane_from_index - find the registered plane at an index
1459 * @idx: index of registered plane to find for
1461 * Given a plane index, return the registered plane from DRM device's
1462 * list of planes with matching index.
1465 drm_plane_from_index(struct drm_device *dev, int idx)
1467 struct drm_plane *plane;
1470 drm_for_each_plane(plane, dev) {
1477 EXPORT_SYMBOL(drm_plane_from_index);
1480 * drm_plane_force_disable - Forcibly disable a plane
1481 * @plane: plane to disable
1483 * Forces the plane to be disabled.
1485 * Used when the plane's current framebuffer is destroyed,
1486 * and when restoring fbdev mode.
1488 void drm_plane_force_disable(struct drm_plane *plane)
1495 plane->old_fb = plane->fb;
1496 ret = plane->funcs->disable_plane(plane);
1498 DRM_ERROR("failed to disable plane with busy fb\n");
1499 plane->old_fb = NULL;
1502 /* disconnect the plane from the fb and crtc: */
1503 drm_framebuffer_unreference(plane->old_fb);
1504 plane->old_fb = NULL;
1508 EXPORT_SYMBOL(drm_plane_force_disable);
1510 static int drm_mode_create_standard_properties(struct drm_device *dev)
1512 struct drm_property *prop;
1515 * Standard properties (apply to all connectors)
1517 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1518 DRM_MODE_PROP_IMMUTABLE,
1522 dev->mode_config.edid_property = prop;
1524 prop = drm_property_create_enum(dev, 0,
1525 "DPMS", drm_dpms_enum_list,
1526 ARRAY_SIZE(drm_dpms_enum_list));
1529 dev->mode_config.dpms_property = prop;
1531 prop = drm_property_create(dev,
1532 DRM_MODE_PROP_BLOB |
1533 DRM_MODE_PROP_IMMUTABLE,
1537 dev->mode_config.path_property = prop;
1539 prop = drm_property_create(dev,
1540 DRM_MODE_PROP_BLOB |
1541 DRM_MODE_PROP_IMMUTABLE,
1545 dev->mode_config.tile_property = prop;
1547 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1548 "type", drm_plane_type_enum_list,
1549 ARRAY_SIZE(drm_plane_type_enum_list));
1552 dev->mode_config.plane_type_property = prop;
1554 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1555 "SHARE_ID", 0, UINT_MAX);
1559 dev->mode_config.prop_share_id = prop;
1560 prop = drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE,
1561 "SHARE_FLAGS", 0, UINT_MAX);
1564 dev->mode_config.prop_share_flags = prop;
1566 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1567 "SRC_X", 0, UINT_MAX);
1570 dev->mode_config.prop_src_x = prop;
1572 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1573 "SRC_Y", 0, UINT_MAX);
1576 dev->mode_config.prop_src_y = prop;
1578 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1579 "SRC_W", 0, UINT_MAX);
1582 dev->mode_config.prop_src_w = prop;
1584 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1585 "SRC_H", 0, UINT_MAX);
1588 dev->mode_config.prop_src_h = prop;
1590 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1591 "CRTC_X", INT_MIN, INT_MAX);
1594 dev->mode_config.prop_crtc_x = prop;
1596 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1597 "CRTC_Y", INT_MIN, INT_MAX);
1600 dev->mode_config.prop_crtc_y = prop;
1602 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1603 "CRTC_W", 0, INT_MAX);
1606 dev->mode_config.prop_crtc_w = prop;
1608 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1609 "CRTC_H", 0, INT_MAX);
1612 dev->mode_config.prop_crtc_h = prop;
1614 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1615 "FB_ID", DRM_MODE_OBJECT_FB);
1618 dev->mode_config.prop_fb_id = prop;
1620 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1621 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1624 dev->mode_config.prop_crtc_id = prop;
1626 prop = drm_property_create_bool(dev, DRM_MODE_PROP_ATOMIC,
1630 dev->mode_config.prop_active = prop;
1632 prop = drm_property_create(dev,
1633 DRM_MODE_PROP_ATOMIC | DRM_MODE_PROP_BLOB,
1637 dev->mode_config.prop_mode_id = prop;
1643 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1646 * Called by a driver the first time a DVI-I connector is made.
1648 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1650 struct drm_property *dvi_i_selector;
1651 struct drm_property *dvi_i_subconnector;
1653 if (dev->mode_config.dvi_i_select_subconnector_property)
1657 drm_property_create_enum(dev, 0,
1658 "select subconnector",
1659 drm_dvi_i_select_enum_list,
1660 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1661 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1663 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1665 drm_dvi_i_subconnector_enum_list,
1666 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1667 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1671 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1674 * drm_create_tv_properties - create TV specific connector properties
1676 * @num_modes: number of different TV formats (modes) supported
1677 * @modes: array of pointers to strings containing name of each format
1679 * Called by a driver's TV initialization routine, this function creates
1680 * the TV specific connector properties for a given device. Caller is
1681 * responsible for allocating a list of format names and passing them to
1684 int drm_mode_create_tv_properties(struct drm_device *dev,
1685 unsigned int num_modes,
1686 const char * const modes[])
1688 struct drm_property *tv_selector;
1689 struct drm_property *tv_subconnector;
1692 if (dev->mode_config.tv_select_subconnector_property)
1696 * Basic connector properties
1698 tv_selector = drm_property_create_enum(dev, 0,
1699 "select subconnector",
1700 drm_tv_select_enum_list,
1701 ARRAY_SIZE(drm_tv_select_enum_list));
1705 dev->mode_config.tv_select_subconnector_property = tv_selector;
1708 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1710 drm_tv_subconnector_enum_list,
1711 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1712 if (!tv_subconnector)
1714 dev->mode_config.tv_subconnector_property = tv_subconnector;
1717 * Other, TV specific properties: margins & TV modes.
1719 dev->mode_config.tv_left_margin_property =
1720 drm_property_create_range(dev, 0, "left margin", 0, 100);
1721 if (!dev->mode_config.tv_left_margin_property)
1724 dev->mode_config.tv_right_margin_property =
1725 drm_property_create_range(dev, 0, "right margin", 0, 100);
1726 if (!dev->mode_config.tv_right_margin_property)
1729 dev->mode_config.tv_top_margin_property =
1730 drm_property_create_range(dev, 0, "top margin", 0, 100);
1731 if (!dev->mode_config.tv_top_margin_property)
1734 dev->mode_config.tv_bottom_margin_property =
1735 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1736 if (!dev->mode_config.tv_bottom_margin_property)
1739 dev->mode_config.tv_mode_property =
1740 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1742 if (!dev->mode_config.tv_mode_property)
1745 for (i = 0; i < num_modes; i++)
1746 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1749 dev->mode_config.tv_brightness_property =
1750 drm_property_create_range(dev, 0, "brightness", 0, 100);
1751 if (!dev->mode_config.tv_brightness_property)
1754 dev->mode_config.tv_contrast_property =
1755 drm_property_create_range(dev, 0, "contrast", 0, 100);
1756 if (!dev->mode_config.tv_contrast_property)
1759 dev->mode_config.tv_flicker_reduction_property =
1760 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1761 if (!dev->mode_config.tv_flicker_reduction_property)
1764 dev->mode_config.tv_overscan_property =
1765 drm_property_create_range(dev, 0, "overscan", 0, 100);
1766 if (!dev->mode_config.tv_overscan_property)
1769 dev->mode_config.tv_saturation_property =
1770 drm_property_create_range(dev, 0, "saturation", 0, 100);
1771 if (!dev->mode_config.tv_saturation_property)
1774 dev->mode_config.tv_hue_property =
1775 drm_property_create_range(dev, 0, "hue", 0, 100);
1776 if (!dev->mode_config.tv_hue_property)
1783 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1786 * drm_mode_create_scaling_mode_property - create scaling mode property
1789 * Called by a driver the first time it's needed, must be attached to desired
1792 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1794 struct drm_property *scaling_mode;
1796 if (dev->mode_config.scaling_mode_property)
1800 drm_property_create_enum(dev, 0, "scaling mode",
1801 drm_scaling_mode_enum_list,
1802 ARRAY_SIZE(drm_scaling_mode_enum_list));
1804 dev->mode_config.scaling_mode_property = scaling_mode;
1808 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1811 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1814 * Called by a driver the first time it's needed, must be attached to desired
1818 * Zero on success, negative errno on failure.
1820 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1822 if (dev->mode_config.aspect_ratio_property)
1825 dev->mode_config.aspect_ratio_property =
1826 drm_property_create_enum(dev, 0, "aspect ratio",
1827 drm_aspect_ratio_enum_list,
1828 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1830 if (dev->mode_config.aspect_ratio_property == NULL)
1835 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1838 * drm_mode_create_dirty_property - create dirty property
1841 * Called by a driver the first time it's needed, must be attached to desired
1844 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1846 struct drm_property *dirty_info;
1848 if (dev->mode_config.dirty_info_property)
1852 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1854 drm_dirty_info_enum_list,
1855 ARRAY_SIZE(drm_dirty_info_enum_list));
1856 dev->mode_config.dirty_info_property = dirty_info;
1860 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1863 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1866 * Create the the suggested x/y offset property for connectors.
1868 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1870 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1873 dev->mode_config.suggested_x_property =
1874 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1876 dev->mode_config.suggested_y_property =
1877 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1879 if (dev->mode_config.suggested_x_property == NULL ||
1880 dev->mode_config.suggested_y_property == NULL)
1884 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1887 * drm_mode_getresources - get graphics configuration
1888 * @dev: drm device for the ioctl
1889 * @data: data pointer for the ioctl
1890 * @file_priv: drm file for the ioctl call
1892 * Construct a set of configuration description structures and return
1893 * them to the user, including CRTC, connector and framebuffer configuration.
1895 * Called by the user via ioctl.
1898 * Zero on success, negative errno on failure.
1900 int drm_mode_getresources(struct drm_device *dev, void *data,
1901 struct drm_file *file_priv)
1903 struct drm_mode_card_res *card_res = data;
1904 struct list_head *lh;
1905 struct drm_framebuffer *fb;
1906 struct drm_connector *connector;
1907 struct drm_crtc *crtc;
1908 struct drm_encoder *encoder;
1910 int connector_count = 0;
1913 int encoder_count = 0;
1915 uint32_t __user *fb_id;
1916 uint32_t __user *crtc_id;
1917 uint32_t __user *connector_id;
1918 uint32_t __user *encoder_id;
1920 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1924 mutex_lock(&file_priv->fbs_lock);
1926 * For the non-control nodes we need to limit the list of resources
1927 * by IDs in the group list for this node
1929 list_for_each(lh, &file_priv->fbs)
1932 /* handle this in 4 parts */
1934 if (card_res->count_fbs >= fb_count) {
1936 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1937 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1938 if (put_user(fb->base.id, fb_id + copied)) {
1939 mutex_unlock(&file_priv->fbs_lock);
1945 card_res->count_fbs = fb_count;
1946 mutex_unlock(&file_priv->fbs_lock);
1948 /* mode_config.mutex protects the connector list against e.g. DP MST
1949 * connector hot-adding. CRTC/Plane lists are invariant. */
1950 mutex_lock(&dev->mode_config.mutex);
1951 drm_for_each_crtc(crtc, dev)
1954 drm_for_each_connector(connector, dev)
1957 drm_for_each_encoder(encoder, dev)
1960 card_res->max_height = dev->mode_config.max_height;
1961 card_res->min_height = dev->mode_config.min_height;
1962 card_res->max_width = dev->mode_config.max_width;
1963 card_res->min_width = dev->mode_config.min_width;
1966 if (card_res->count_crtcs >= crtc_count) {
1968 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1969 drm_for_each_crtc(crtc, dev) {
1970 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1971 if (put_user(crtc->base.id, crtc_id + copied)) {
1978 card_res->count_crtcs = crtc_count;
1981 if (card_res->count_encoders >= encoder_count) {
1983 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1984 drm_for_each_encoder(encoder, dev) {
1985 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1987 if (put_user(encoder->base.id, encoder_id +
1995 card_res->count_encoders = encoder_count;
1998 if (card_res->count_connectors >= connector_count) {
2000 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
2001 drm_for_each_connector(connector, dev) {
2002 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2005 if (put_user(connector->base.id,
2006 connector_id + copied)) {
2013 card_res->count_connectors = connector_count;
2015 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
2016 card_res->count_connectors, card_res->count_encoders);
2019 mutex_unlock(&dev->mode_config.mutex);
2024 * drm_mode_getcrtc - get CRTC configuration
2025 * @dev: drm device for the ioctl
2026 * @data: data pointer for the ioctl
2027 * @file_priv: drm file for the ioctl call
2029 * Construct a CRTC configuration structure to return to the user.
2031 * Called by the user via ioctl.
2034 * Zero on success, negative errno on failure.
2036 int drm_mode_getcrtc(struct drm_device *dev,
2037 void *data, struct drm_file *file_priv)
2039 struct drm_mode_crtc *crtc_resp = data;
2040 struct drm_crtc *crtc;
2042 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2045 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
2049 drm_modeset_lock_crtc(crtc, crtc->primary);
2050 crtc_resp->gamma_size = crtc->gamma_size;
2051 if (crtc->primary->fb)
2052 crtc_resp->fb_id = crtc->primary->fb->base.id;
2054 crtc_resp->fb_id = 0;
2057 crtc_resp->x = crtc->primary->state->src_x >> 16;
2058 crtc_resp->y = crtc->primary->state->src_y >> 16;
2059 if (crtc->state->enable) {
2060 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
2061 crtc_resp->mode_valid = 1;
2064 crtc_resp->mode_valid = 0;
2067 crtc_resp->x = crtc->x;
2068 crtc_resp->y = crtc->y;
2069 if (crtc->enabled) {
2070 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2071 crtc_resp->mode_valid = 1;
2074 crtc_resp->mode_valid = 0;
2077 drm_modeset_unlock_crtc(crtc);
2082 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2083 const struct drm_file *file_priv)
2086 * If user-space hasn't configured the driver to expose the stereo 3D
2087 * modes, don't expose them.
2089 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2095 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2097 /* For atomic drivers only state objects are synchronously updated and
2098 * protected by modeset locks, so check those first. */
2099 if (connector->state)
2100 return connector->state->best_encoder;
2101 return connector->encoder;
2104 /* helper for getconnector and getproperties ioctls */
2105 static int get_properties(struct drm_mode_object *obj, bool atomic,
2106 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2107 uint32_t *arg_count_props)
2112 props_count = obj->properties->count;
2114 props_count -= obj->properties->atomic_count;
2116 if ((*arg_count_props >= props_count) && props_count) {
2117 for (i = 0, copied = 0; copied < props_count; i++) {
2118 struct drm_property *prop = obj->properties->properties[i];
2121 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2124 ret = drm_object_property_get_value(obj, prop, &val);
2128 if (put_user(prop->base.id, prop_ptr + copied))
2131 if (put_user(val, prop_values + copied))
2137 *arg_count_props = props_count;
2143 * drm_mode_getconnector - get connector configuration
2144 * @dev: drm device for the ioctl
2145 * @data: data pointer for the ioctl
2146 * @file_priv: drm file for the ioctl call
2148 * Construct a connector configuration structure to return to the user.
2150 * Called by the user via ioctl.
2153 * Zero on success, negative errno on failure.
2155 int drm_mode_getconnector(struct drm_device *dev, void *data,
2156 struct drm_file *file_priv)
2158 struct drm_mode_get_connector *out_resp = data;
2159 struct drm_connector *connector;
2160 struct drm_encoder *encoder;
2161 struct drm_display_mode *mode;
2163 int encoders_count = 0;
2167 struct drm_mode_modeinfo u_mode;
2168 struct drm_mode_modeinfo __user *mode_ptr;
2169 uint32_t __user *encoder_ptr;
2171 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2174 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2176 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2178 mutex_lock(&dev->mode_config.mutex);
2180 connector = drm_connector_find(dev, out_resp->connector_id);
2186 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2187 if (connector->encoder_ids[i] != 0)
2190 if (out_resp->count_modes == 0) {
2191 connector->funcs->fill_modes(connector,
2192 dev->mode_config.max_width,
2193 dev->mode_config.max_height);
2196 /* delayed so we get modes regardless of pre-fill_modes state */
2197 list_for_each_entry(mode, &connector->modes, head)
2198 if (drm_mode_expose_to_userspace(mode, file_priv))
2201 out_resp->connector_id = connector->base.id;
2202 out_resp->connector_type = connector->connector_type;
2203 out_resp->connector_type_id = connector->connector_type_id;
2204 out_resp->mm_width = connector->display_info.width_mm;
2205 out_resp->mm_height = connector->display_info.height_mm;
2206 out_resp->subpixel = connector->display_info.subpixel_order;
2207 out_resp->connection = connector->status;
2209 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2210 encoder = drm_connector_get_encoder(connector);
2212 out_resp->encoder_id = encoder->base.id;
2214 out_resp->encoder_id = 0;
2217 * This ioctl is called twice, once to determine how much space is
2218 * needed, and the 2nd time to fill it.
2220 if ((out_resp->count_modes >= mode_count) && mode_count) {
2222 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2223 list_for_each_entry(mode, &connector->modes, head) {
2224 if (!drm_mode_expose_to_userspace(mode, file_priv))
2227 drm_mode_convert_to_umode(&u_mode, mode);
2228 if (copy_to_user(mode_ptr + copied,
2229 &u_mode, sizeof(u_mode))) {
2236 out_resp->count_modes = mode_count;
2238 ret = get_properties(&connector->base, file_priv->atomic,
2239 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2240 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2241 &out_resp->count_props);
2245 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2247 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2248 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2249 if (connector->encoder_ids[i] != 0) {
2250 if (put_user(connector->encoder_ids[i],
2251 encoder_ptr + copied)) {
2259 out_resp->count_encoders = encoders_count;
2262 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2265 mutex_unlock(&dev->mode_config.mutex);
2270 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2272 struct drm_connector *connector;
2273 struct drm_device *dev = encoder->dev;
2274 bool uses_atomic = false;
2276 /* For atomic drivers only state objects are synchronously updated and
2277 * protected by modeset locks, so check those first. */
2278 drm_for_each_connector(connector, dev) {
2279 if (!connector->state)
2284 if (connector->state->best_encoder != encoder)
2287 return connector->state->crtc;
2290 /* Don't return stale data (e.g. pending async disable). */
2294 return encoder->crtc;
2298 * drm_mode_getencoder - get encoder configuration
2299 * @dev: drm device for the ioctl
2300 * @data: data pointer for the ioctl
2301 * @file_priv: drm file for the ioctl call
2303 * Construct a encoder configuration structure to return to the user.
2305 * Called by the user via ioctl.
2308 * Zero on success, negative errno on failure.
2310 int drm_mode_getencoder(struct drm_device *dev, void *data,
2311 struct drm_file *file_priv)
2313 struct drm_mode_get_encoder *enc_resp = data;
2314 struct drm_encoder *encoder;
2315 struct drm_crtc *crtc;
2317 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2320 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2324 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2325 crtc = drm_encoder_get_crtc(encoder);
2327 enc_resp->crtc_id = crtc->base.id;
2329 enc_resp->crtc_id = 0;
2330 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2332 enc_resp->encoder_type = encoder->encoder_type;
2333 enc_resp->encoder_id = encoder->base.id;
2334 enc_resp->possible_crtcs = encoder->possible_crtcs;
2335 enc_resp->possible_clones = encoder->possible_clones;
2341 * drm_mode_getplane_res - enumerate all plane resources
2344 * @file_priv: DRM file info
2346 * Construct a list of plane ids to return to the user.
2348 * Called by the user via ioctl.
2351 * Zero on success, negative errno on failure.
2353 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2354 struct drm_file *file_priv)
2356 struct drm_mode_get_plane_res *plane_resp = data;
2357 struct drm_mode_config *config;
2358 struct drm_plane *plane;
2359 uint32_t __user *plane_ptr;
2361 unsigned num_planes;
2363 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2366 config = &dev->mode_config;
2368 if (file_priv->universal_planes)
2369 num_planes = config->num_total_plane;
2371 num_planes = config->num_overlay_plane;
2372 if (!file_priv->share_planes) {
2373 if (file_priv->universal_planes)
2374 num_planes -= config->num_share_plane;
2376 num_planes -= config->num_share_overlay_plane;
2380 * This ioctl is called twice, once to determine how much space is
2381 * needed, and the 2nd time to fill it.
2384 (plane_resp->count_planes >= num_planes)) {
2385 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2387 /* Plane lists are invariant, no locking needed. */
2388 drm_for_each_plane(plane, dev) {
2390 * Unless userspace set the 'universal planes'
2391 * capability bit, only advertise overlays.
2393 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2394 !file_priv->universal_planes)
2396 if (plane->parent && !file_priv->share_planes)
2399 if (put_user(plane->base.id, plane_ptr + copied))
2404 plane_resp->count_planes = num_planes;
2410 * drm_mode_getplane - get plane configuration
2413 * @file_priv: DRM file info
2415 * Construct a plane configuration structure to return to the user.
2417 * Called by the user via ioctl.
2420 * Zero on success, negative errno on failure.
2422 int drm_mode_getplane(struct drm_device *dev, void *data,
2423 struct drm_file *file_priv)
2425 struct drm_mode_get_plane *plane_resp = data;
2426 struct drm_plane *plane;
2427 uint32_t __user *format_ptr;
2429 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2432 plane = drm_plane_find(dev, plane_resp->plane_id);
2436 drm_modeset_lock(&plane->mutex, NULL);
2438 plane_resp->crtc_id = plane->crtc->base.id;
2440 plane_resp->crtc_id = 0;
2443 plane_resp->fb_id = plane->fb->base.id;
2445 plane_resp->fb_id = 0;
2446 drm_modeset_unlock(&plane->mutex);
2448 plane_resp->plane_id = plane->base.id;
2449 plane_resp->possible_crtcs = plane->possible_crtcs;
2450 plane_resp->gamma_size = 0;
2453 * This ioctl is called twice, once to determine how much space is
2454 * needed, and the 2nd time to fill it.
2456 if (plane->format_count &&
2457 (plane_resp->count_format_types >= plane->format_count)) {
2458 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2459 if (copy_to_user(format_ptr,
2460 plane->format_types,
2461 sizeof(uint32_t) * plane->format_count)) {
2465 plane_resp->count_format_types = plane->format_count;
2471 * drm_plane_check_pixel_format - Check if the plane supports the pixel format
2472 * @plane: plane to check for format support
2473 * @format: the pixel format
2476 * Zero of @plane has @format in its list of supported pixel formats, -EINVAL
2479 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
2483 for (i = 0; i < plane->format_count; i++) {
2484 if (format == plane->format_types[i])
2491 static int check_src_coords(uint32_t src_x, uint32_t src_y,
2492 uint32_t src_w, uint32_t src_h,
2493 const struct drm_framebuffer *fb)
2495 unsigned int fb_width, fb_height;
2497 fb_width = fb->width << 16;
2498 fb_height = fb->height << 16;
2500 /* Make sure source coordinates are inside the fb. */
2501 if (src_w > fb_width ||
2502 src_x > fb_width - src_w ||
2503 src_h > fb_height ||
2504 src_y > fb_height - src_h) {
2505 DRM_DEBUG_KMS("Invalid source coordinates "
2506 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2507 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2508 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2509 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2510 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2518 * setplane_internal - setplane handler for internal callers
2520 * Note that we assume an extra reference has already been taken on fb. If the
2521 * update fails, this reference will be dropped before return; if it succeeds,
2522 * the previous framebuffer (if any) will be unreferenced instead.
2524 * src_{x,y,w,h} are provided in 16.16 fixed point format
2526 static int __setplane_internal(struct drm_plane *plane,
2527 struct drm_crtc *crtc,
2528 struct drm_framebuffer *fb,
2529 int32_t crtc_x, int32_t crtc_y,
2530 uint32_t crtc_w, uint32_t crtc_h,
2531 /* src_{x,y,w,h} values are 16.16 fixed point */
2532 uint32_t src_x, uint32_t src_y,
2533 uint32_t src_w, uint32_t src_h)
2537 /* No fb means shut it down */
2539 plane->old_fb = plane->fb;
2540 ret = plane->funcs->disable_plane(plane);
2545 plane->old_fb = NULL;
2550 /* Check whether this plane is usable on this CRTC */
2551 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2552 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2557 /* Check whether this plane supports the fb pixel format. */
2558 ret = drm_plane_check_pixel_format(plane, fb->pixel_format);
2560 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2561 drm_get_format_name(fb->pixel_format));
2565 /* Give drivers some help against integer overflows */
2566 if (crtc_w > INT_MAX ||
2567 crtc_x > INT_MAX - (int32_t) crtc_w ||
2569 crtc_y > INT_MAX - (int32_t) crtc_h) {
2570 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2571 crtc_w, crtc_h, crtc_x, crtc_y);
2576 ret = check_src_coords(src_x, src_y, src_w, src_h, fb);
2580 plane->old_fb = plane->fb;
2581 ret = plane->funcs->update_plane(plane, crtc, fb,
2582 crtc_x, crtc_y, crtc_w, crtc_h,
2583 src_x, src_y, src_w, src_h);
2589 plane->old_fb = NULL;
2594 drm_framebuffer_unreference(fb);
2596 drm_framebuffer_unreference(plane->old_fb);
2597 plane->old_fb = NULL;
2602 static int setplane_internal(struct drm_plane *plane,
2603 struct drm_crtc *crtc,
2604 struct drm_framebuffer *fb,
2605 int32_t crtc_x, int32_t crtc_y,
2606 uint32_t crtc_w, uint32_t crtc_h,
2607 /* src_{x,y,w,h} values are 16.16 fixed point */
2608 uint32_t src_x, uint32_t src_y,
2609 uint32_t src_w, uint32_t src_h)
2613 drm_modeset_lock_all(plane->dev);
2614 ret = __setplane_internal(plane, crtc, fb,
2615 crtc_x, crtc_y, crtc_w, crtc_h,
2616 src_x, src_y, src_w, src_h);
2617 drm_modeset_unlock_all(plane->dev);
2623 * drm_mode_setplane - configure a plane's configuration
2625 * @data: ioctl data*
2626 * @file_priv: DRM file info
2628 * Set plane configuration, including placement, fb, scaling, and other factors.
2629 * Or pass a NULL fb to disable (planes may be disabled without providing a
2633 * Zero on success, negative errno on failure.
2635 int drm_mode_setplane(struct drm_device *dev, void *data,
2636 struct drm_file *file_priv)
2638 struct drm_mode_set_plane *plane_req = data;
2639 struct drm_plane *plane;
2640 struct drm_crtc *crtc = NULL;
2641 struct drm_framebuffer *fb = NULL;
2643 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2647 * First, find the plane, crtc, and fb objects. If not available,
2648 * we don't bother to call the driver.
2650 plane = drm_plane_find(dev, plane_req->plane_id);
2652 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2653 plane_req->plane_id);
2657 if (plane_req->fb_id) {
2658 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2660 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2665 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2667 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2668 plane_req->crtc_id);
2674 * setplane_internal will take care of deref'ing either the old or new
2675 * framebuffer depending on success.
2677 return setplane_internal(plane, crtc, fb,
2678 plane_req->crtc_x, plane_req->crtc_y,
2679 plane_req->crtc_w, plane_req->crtc_h,
2680 plane_req->src_x, plane_req->src_y,
2681 plane_req->src_w, plane_req->src_h);
2685 * drm_mode_set_config_internal - helper to call ->set_config
2686 * @set: modeset config to set
2688 * This is a little helper to wrap internal calls to the ->set_config driver
2689 * interface. The only thing it adds is correct refcounting dance.
2692 * Zero on success, negative errno on failure.
2694 int drm_mode_set_config_internal(struct drm_mode_set *set)
2696 struct drm_crtc *crtc = set->crtc;
2697 struct drm_framebuffer *fb;
2698 struct drm_crtc *tmp;
2702 * NOTE: ->set_config can also disable other crtcs (if we steal all
2703 * connectors from it), hence we need to refcount the fbs across all
2704 * crtcs. Atomic modeset will have saner semantics ...
2706 drm_for_each_crtc(tmp, crtc->dev)
2707 tmp->primary->old_fb = tmp->primary->fb;
2711 ret = crtc->funcs->set_config(set);
2713 crtc->primary->crtc = crtc;
2714 crtc->primary->fb = fb;
2717 drm_for_each_crtc(tmp, crtc->dev) {
2718 if (tmp->primary->fb)
2719 drm_framebuffer_reference(tmp->primary->fb);
2720 if (tmp->primary->old_fb)
2721 drm_framebuffer_unreference(tmp->primary->old_fb);
2722 tmp->primary->old_fb = NULL;
2727 EXPORT_SYMBOL(drm_mode_set_config_internal);
2730 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
2731 * @mode: mode to query
2732 * @hdisplay: hdisplay value to fill in
2733 * @vdisplay: vdisplay value to fill in
2735 * The vdisplay value will be doubled if the specified mode is a stereo mode of
2736 * the appropriate layout.
2738 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
2739 int *hdisplay, int *vdisplay)
2741 struct drm_display_mode adjusted;
2743 drm_mode_copy(&adjusted, mode);
2744 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
2745 *hdisplay = adjusted.crtc_hdisplay;
2746 *vdisplay = adjusted.crtc_vdisplay;
2748 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
2751 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2753 * @crtc: CRTC that framebuffer will be displayed on
2756 * @mode: mode that framebuffer will be displayed under
2757 * @fb: framebuffer to check size of
2759 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2761 const struct drm_display_mode *mode,
2762 const struct drm_framebuffer *fb)
2765 int hdisplay, vdisplay;
2767 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
2770 crtc->primary->state->rotation & (BIT(DRM_ROTATE_90) |
2771 BIT(DRM_ROTATE_270)))
2772 swap(hdisplay, vdisplay);
2774 return check_src_coords(x << 16, y << 16,
2775 hdisplay << 16, vdisplay << 16, fb);
2777 EXPORT_SYMBOL(drm_crtc_check_viewport);
2780 * drm_mode_setcrtc - set CRTC configuration
2781 * @dev: drm device for the ioctl
2782 * @data: data pointer for the ioctl
2783 * @file_priv: drm file for the ioctl call
2785 * Build a new CRTC configuration based on user request.
2787 * Called by the user via ioctl.
2790 * Zero on success, negative errno on failure.
2792 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2793 struct drm_file *file_priv)
2795 struct drm_mode_config *config = &dev->mode_config;
2796 struct drm_mode_crtc *crtc_req = data;
2797 struct drm_crtc *crtc;
2798 struct drm_connector **connector_set = NULL, *connector;
2799 struct drm_framebuffer *fb = NULL;
2800 struct drm_display_mode *mode = NULL;
2801 struct drm_mode_set set;
2802 uint32_t __user *set_connectors_ptr;
2806 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2810 * Universal plane src offsets are only 16.16, prevent havoc for
2811 * drivers using universal plane code internally.
2813 if (crtc_req->x & 0xffff0000 || crtc_req->y & 0xffff0000)
2816 drm_modeset_lock_all(dev);
2817 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2819 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2823 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2825 if (crtc_req->mode_valid) {
2826 /* If we have a mode we need a framebuffer. */
2827 /* If we pass -1, set the mode with the currently bound fb */
2828 if (crtc_req->fb_id == -1) {
2829 if (!crtc->primary->fb) {
2830 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2834 fb = crtc->primary->fb;
2835 /* Make refcounting symmetric with the lookup path. */
2836 drm_framebuffer_reference(fb);
2838 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2840 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2847 mode = drm_mode_create(dev);
2853 ret = drm_mode_convert_umode(mode, &crtc_req->mode);
2855 DRM_DEBUG_KMS("Invalid mode\n");
2860 * Check whether the primary plane supports the fb pixel format.
2861 * Drivers not implementing the universal planes API use a
2862 * default formats list provided by the DRM core which doesn't
2863 * match real hardware capabilities. Skip the check in that
2866 if (!crtc->primary->format_default) {
2867 ret = drm_plane_check_pixel_format(crtc->primary,
2870 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2871 drm_get_format_name(fb->pixel_format));
2876 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2883 if (crtc_req->count_connectors == 0 && mode) {
2884 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2889 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2890 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2891 crtc_req->count_connectors);
2896 if (crtc_req->count_connectors > 0) {
2899 /* Avoid unbounded kernel memory allocation */
2900 if (crtc_req->count_connectors > config->num_connector) {
2905 connector_set = kmalloc_array(crtc_req->count_connectors,
2906 sizeof(struct drm_connector *),
2908 if (!connector_set) {
2913 for (i = 0; i < crtc_req->count_connectors; i++) {
2914 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2915 if (get_user(out_id, &set_connectors_ptr[i])) {
2920 connector = drm_connector_find(dev, out_id);
2922 DRM_DEBUG_KMS("Connector id %d unknown\n",
2927 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2931 connector_set[i] = connector;
2936 set.x = crtc_req->x;
2937 set.y = crtc_req->y;
2939 set.connectors = connector_set;
2940 set.num_connectors = crtc_req->count_connectors;
2942 ret = drm_mode_set_config_internal(&set);
2946 drm_framebuffer_unreference(fb);
2948 kfree(connector_set);
2949 drm_mode_destroy(dev, mode);
2950 drm_modeset_unlock_all(dev);
2955 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2956 * universal plane handler call
2957 * @crtc: crtc to update cursor for
2958 * @req: data pointer for the ioctl
2959 * @file_priv: drm file for the ioctl call
2961 * Legacy cursor ioctl's work directly with driver buffer handles. To
2962 * translate legacy ioctl calls into universal plane handler calls, we need to
2963 * wrap the native buffer handle in a drm_framebuffer.
2965 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2966 * buffer with a pitch of 4*width; the universal plane interface should be used
2967 * directly in cases where the hardware can support other buffer settings and
2968 * userspace wants to make use of these capabilities.
2971 * Zero on success, negative errno on failure.
2973 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2974 struct drm_mode_cursor2 *req,
2975 struct drm_file *file_priv)
2977 struct drm_device *dev = crtc->dev;
2978 struct drm_framebuffer *fb = NULL;
2979 struct drm_mode_fb_cmd2 fbreq = {
2980 .width = req->width,
2981 .height = req->height,
2982 .pixel_format = DRM_FORMAT_ARGB8888,
2983 .pitches = { req->width * 4 },
2984 .handles = { req->handle },
2986 int32_t crtc_x, crtc_y;
2987 uint32_t crtc_w = 0, crtc_h = 0;
2988 uint32_t src_w = 0, src_h = 0;
2991 BUG_ON(!crtc->cursor);
2992 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2995 * Obtain fb we'll be using (either new or existing) and take an extra
2996 * reference to it if fb != null. setplane will take care of dropping
2997 * the reference if the plane update fails.
2999 if (req->flags & DRM_MODE_CURSOR_BO) {
3001 fb = internal_framebuffer_create(dev, &fbreq, file_priv);
3003 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
3010 fb = crtc->cursor->fb;
3012 drm_framebuffer_reference(fb);
3015 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3019 crtc_x = crtc->cursor_x;
3020 crtc_y = crtc->cursor_y;
3025 crtc_h = fb->height;
3026 src_w = fb->width << 16;
3027 src_h = fb->height << 16;
3031 * setplane_internal will take care of deref'ing either the old or new
3032 * framebuffer depending on success.
3034 ret = __setplane_internal(crtc->cursor, crtc, fb,
3035 crtc_x, crtc_y, crtc_w, crtc_h,
3036 0, 0, src_w, src_h);
3038 /* Update successful; save new cursor position, if necessary */
3039 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
3040 crtc->cursor_x = req->x;
3041 crtc->cursor_y = req->y;
3047 static int drm_mode_cursor_common(struct drm_device *dev,
3048 struct drm_mode_cursor2 *req,
3049 struct drm_file *file_priv)
3051 struct drm_crtc *crtc;
3054 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3057 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
3060 crtc = drm_crtc_find(dev, req->crtc_id);
3062 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
3067 * If this crtc has a universal cursor plane, call that plane's update
3068 * handler rather than using legacy cursor handlers.
3070 drm_modeset_lock_crtc(crtc, crtc->cursor);
3072 ret = drm_mode_cursor_universal(crtc, req, file_priv);
3076 if (req->flags & DRM_MODE_CURSOR_BO) {
3077 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
3081 /* Turns off the cursor if handle is 0 */
3082 if (crtc->funcs->cursor_set2)
3083 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
3084 req->width, req->height, req->hot_x, req->hot_y);
3086 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
3087 req->width, req->height);
3090 if (req->flags & DRM_MODE_CURSOR_MOVE) {
3091 if (crtc->funcs->cursor_move) {
3092 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3099 drm_modeset_unlock_crtc(crtc);
3107 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3108 * @dev: drm device for the ioctl
3109 * @data: data pointer for the ioctl
3110 * @file_priv: drm file for the ioctl call
3112 * Set the cursor configuration based on user request.
3114 * Called by the user via ioctl.
3117 * Zero on success, negative errno on failure.
3119 int drm_mode_cursor_ioctl(struct drm_device *dev,
3120 void *data, struct drm_file *file_priv)
3122 struct drm_mode_cursor *req = data;
3123 struct drm_mode_cursor2 new_req;
3125 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3126 new_req.hot_x = new_req.hot_y = 0;
3128 return drm_mode_cursor_common(dev, &new_req, file_priv);
3132 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3133 * @dev: drm device for the ioctl
3134 * @data: data pointer for the ioctl
3135 * @file_priv: drm file for the ioctl call
3137 * Set the cursor configuration based on user request. This implements the 2nd
3138 * version of the cursor ioctl, which allows userspace to additionally specify
3139 * the hotspot of the pointer.
3141 * Called by the user via ioctl.
3144 * Zero on success, negative errno on failure.
3146 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3147 void *data, struct drm_file *file_priv)
3149 struct drm_mode_cursor2 *req = data;
3151 return drm_mode_cursor_common(dev, req, file_priv);
3155 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3156 * @bpp: bits per pixels
3157 * @depth: bit depth per pixel
3159 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3160 * Useful in fbdev emulation code, since that deals in those values.
3162 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3168 fmt = DRM_FORMAT_C8;
3172 fmt = DRM_FORMAT_XRGB1555;
3174 fmt = DRM_FORMAT_RGB565;
3177 fmt = DRM_FORMAT_RGB888;
3181 fmt = DRM_FORMAT_XRGB8888;
3182 else if (depth == 30)
3183 fmt = DRM_FORMAT_XRGB2101010;
3185 fmt = DRM_FORMAT_ARGB8888;
3188 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3189 fmt = DRM_FORMAT_XRGB8888;
3195 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3198 * drm_mode_addfb - add an FB to the graphics configuration
3199 * @dev: drm device for the ioctl
3200 * @data: data pointer for the ioctl
3201 * @file_priv: drm file for the ioctl call
3203 * Add a new FB to the specified CRTC, given a user request. This is the
3204 * original addfb ioctl which only supported RGB formats.
3206 * Called by the user via ioctl.
3209 * Zero on success, negative errno on failure.
3211 int drm_mode_addfb(struct drm_device *dev,
3212 void *data, struct drm_file *file_priv)
3214 struct drm_mode_fb_cmd *or = data;
3215 struct drm_mode_fb_cmd2 r = {};
3218 /* convert to new format and call new ioctl */
3219 r.fb_id = or->fb_id;
3220 r.width = or->width;
3221 r.height = or->height;
3222 r.pitches[0] = or->pitch;
3223 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3224 r.handles[0] = or->handle;
3226 ret = drm_mode_addfb2(dev, &r, file_priv);
3230 or->fb_id = r.fb_id;
3235 static int format_check(const struct drm_mode_fb_cmd2 *r)
3237 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3241 case DRM_FORMAT_RGB332:
3242 case DRM_FORMAT_BGR233:
3243 case DRM_FORMAT_XRGB4444:
3244 case DRM_FORMAT_XBGR4444:
3245 case DRM_FORMAT_RGBX4444:
3246 case DRM_FORMAT_BGRX4444:
3247 case DRM_FORMAT_ARGB4444:
3248 case DRM_FORMAT_ABGR4444:
3249 case DRM_FORMAT_RGBA4444:
3250 case DRM_FORMAT_BGRA4444:
3251 case DRM_FORMAT_XRGB1555:
3252 case DRM_FORMAT_XBGR1555:
3253 case DRM_FORMAT_RGBX5551:
3254 case DRM_FORMAT_BGRX5551:
3255 case DRM_FORMAT_ARGB1555:
3256 case DRM_FORMAT_ABGR1555:
3257 case DRM_FORMAT_RGBA5551:
3258 case DRM_FORMAT_BGRA5551:
3259 case DRM_FORMAT_RGB565:
3260 case DRM_FORMAT_BGR565:
3261 case DRM_FORMAT_RGB888:
3262 case DRM_FORMAT_BGR888:
3263 case DRM_FORMAT_XRGB8888:
3264 case DRM_FORMAT_XBGR8888:
3265 case DRM_FORMAT_RGBX8888:
3266 case DRM_FORMAT_BGRX8888:
3267 case DRM_FORMAT_ARGB8888:
3268 case DRM_FORMAT_ABGR8888:
3269 case DRM_FORMAT_RGBA8888:
3270 case DRM_FORMAT_BGRA8888:
3271 case DRM_FORMAT_XRGB2101010:
3272 case DRM_FORMAT_XBGR2101010:
3273 case DRM_FORMAT_RGBX1010102:
3274 case DRM_FORMAT_BGRX1010102:
3275 case DRM_FORMAT_ARGB2101010:
3276 case DRM_FORMAT_ABGR2101010:
3277 case DRM_FORMAT_RGBA1010102:
3278 case DRM_FORMAT_BGRA1010102:
3279 case DRM_FORMAT_YUYV:
3280 case DRM_FORMAT_YVYU:
3281 case DRM_FORMAT_UYVY:
3282 case DRM_FORMAT_VYUY:
3283 case DRM_FORMAT_AYUV:
3284 case DRM_FORMAT_NV12:
3285 case DRM_FORMAT_NV21:
3286 case DRM_FORMAT_NV16:
3287 case DRM_FORMAT_NV61:
3288 case DRM_FORMAT_NV24:
3289 case DRM_FORMAT_NV42:
3290 case DRM_FORMAT_NV12_10:
3291 case DRM_FORMAT_NV21_10:
3292 case DRM_FORMAT_NV16_10:
3293 case DRM_FORMAT_NV61_10:
3294 case DRM_FORMAT_NV24_10:
3295 case DRM_FORMAT_NV42_10:
3296 case DRM_FORMAT_YUV410:
3297 case DRM_FORMAT_YVU410:
3298 case DRM_FORMAT_YUV411:
3299 case DRM_FORMAT_YVU411:
3300 case DRM_FORMAT_YUV420:
3301 case DRM_FORMAT_YVU420:
3302 case DRM_FORMAT_YUV422:
3303 case DRM_FORMAT_YVU422:
3304 case DRM_FORMAT_YUV444:
3305 case DRM_FORMAT_YVU444:
3308 DRM_DEBUG_KMS("invalid pixel format %s\n",
3309 drm_get_format_name(r->pixel_format));
3314 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3316 int ret, hsub, vsub, num_planes, i;
3318 ret = format_check(r);
3320 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3321 drm_get_format_name(r->pixel_format));
3325 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3326 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3327 num_planes = drm_format_num_planes(r->pixel_format);
3329 if (r->width == 0 || r->width % hsub) {
3330 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3334 if (r->height == 0 || r->height % vsub) {
3335 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3339 for (i = 0; i < num_planes; i++) {
3340 unsigned int width = r->width / (i != 0 ? hsub : 1);
3341 unsigned int height = r->height / (i != 0 ? vsub : 1);
3342 unsigned int bpp = drm_format_plane_bpp(r->pixel_format, i);
3344 if (!r->handles[i]) {
3345 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3349 if ((uint64_t) width * bpp / 8 > UINT_MAX)
3352 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3355 if (r->pitches[i] < roundup(width * bpp, 8) / 8) {
3356 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3360 if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) {
3361 DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n",
3366 /* modifier specific checks: */
3367 switch (r->modifier[i]) {
3368 case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE:
3369 /* NOTE: the pitch restriction may be lifted later if it turns
3370 * out that no hw has this restriction:
3372 if (r->pixel_format != DRM_FORMAT_NV12 ||
3373 width % 128 || height % 32 ||
3374 r->pitches[i] % 128) {
3375 DRM_DEBUG_KMS("bad modifier data for plane %d\n", i);
3385 for (i = num_planes; i < 4; i++) {
3386 if (r->modifier[i]) {
3387 DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i);
3391 /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */
3392 if (!(r->flags & DRM_MODE_FB_MODIFIERS))
3395 if (r->handles[i]) {
3396 DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i);
3400 if (r->pitches[i]) {
3401 DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i);
3405 if (r->offsets[i]) {
3406 DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i);
3414 static struct drm_framebuffer *
3415 internal_framebuffer_create(struct drm_device *dev,
3416 struct drm_mode_fb_cmd2 *r,
3417 struct drm_file *file_priv)
3419 struct drm_mode_config *config = &dev->mode_config;
3420 struct drm_framebuffer *fb;
3423 if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) {
3424 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3425 return ERR_PTR(-EINVAL);
3428 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3429 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3430 r->width, config->min_width, config->max_width);
3431 return ERR_PTR(-EINVAL);
3433 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3434 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3435 r->height, config->min_height, config->max_height);
3436 return ERR_PTR(-EINVAL);
3439 if (r->flags & DRM_MODE_FB_MODIFIERS &&
3440 !dev->mode_config.allow_fb_modifiers) {
3441 DRM_DEBUG_KMS("driver does not support fb modifiers\n");
3442 return ERR_PTR(-EINVAL);
3445 ret = framebuffer_check(r);
3447 return ERR_PTR(ret);
3449 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3451 DRM_DEBUG_KMS("could not create framebuffer\n");
3459 * drm_mode_addfb2 - add an FB to the graphics configuration
3460 * @dev: drm device for the ioctl
3461 * @data: data pointer for the ioctl
3462 * @file_priv: drm file for the ioctl call
3464 * Add a new FB to the specified CRTC, given a user request with format. This is
3465 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3466 * and uses fourcc codes as pixel format specifiers.
3468 * Called by the user via ioctl.
3471 * Zero on success, negative errno on failure.
3473 int drm_mode_addfb2(struct drm_device *dev,
3474 void *data, struct drm_file *file_priv)
3476 struct drm_mode_fb_cmd2 *r = data;
3477 struct drm_framebuffer *fb;
3479 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3482 fb = internal_framebuffer_create(dev, r, file_priv);
3486 /* Transfer ownership to the filp for reaping on close */
3488 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3489 mutex_lock(&file_priv->fbs_lock);
3490 r->fb_id = fb->base.id;
3491 list_add(&fb->filp_head, &file_priv->fbs);
3492 mutex_unlock(&file_priv->fbs_lock);
3497 struct drm_mode_rmfb_work {
3498 struct work_struct work;
3499 struct list_head fbs;
3502 static void drm_mode_rmfb_work_fn(struct work_struct *w)
3504 struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work);
3506 while (!list_empty(&arg->fbs)) {
3507 struct drm_framebuffer *fb =
3508 list_first_entry(&arg->fbs, typeof(*fb), filp_head);
3510 list_del_init(&fb->filp_head);
3511 drm_framebuffer_remove(fb);
3516 * drm_mode_rmfb - remove an FB from the configuration
3517 * @dev: drm device for the ioctl
3518 * @data: data pointer for the ioctl
3519 * @file_priv: drm file for the ioctl call
3521 * Remove the FB specified by the user.
3523 * Called by the user via ioctl.
3526 * Zero on success, negative errno on failure.
3528 int drm_mode_rmfb(struct drm_device *dev,
3529 void *data, struct drm_file *file_priv)
3531 struct drm_framebuffer *fb = NULL;
3532 struct drm_framebuffer *fbl = NULL;
3533 uint32_t *id = data;
3536 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3539 mutex_lock(&file_priv->fbs_lock);
3540 mutex_lock(&dev->mode_config.fb_lock);
3541 fb = __drm_framebuffer_lookup(dev, *id);
3545 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3551 list_del_init(&fb->filp_head);
3552 mutex_unlock(&dev->mode_config.fb_lock);
3553 mutex_unlock(&file_priv->fbs_lock);
3556 * we now own the reference that was stored in the fbs list
3558 * drm_framebuffer_remove may fail with -EINTR on pending signals,
3559 * so run this in a separate stack as there's no way to correctly
3560 * handle this after the fb is already removed from the lookup table.
3562 if (atomic_read(&fb->refcount.refcount) > 1) {
3563 struct drm_mode_rmfb_work arg;
3565 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3566 INIT_LIST_HEAD(&arg.fbs);
3567 list_add_tail(&fb->filp_head, &arg.fbs);
3569 schedule_work(&arg.work);
3570 flush_work(&arg.work);
3571 destroy_work_on_stack(&arg.work);
3573 drm_framebuffer_unreference(fb);
3578 mutex_unlock(&dev->mode_config.fb_lock);
3579 mutex_unlock(&file_priv->fbs_lock);
3585 * drm_mode_getfb - get FB info
3586 * @dev: drm device for the ioctl
3587 * @data: data pointer for the ioctl
3588 * @file_priv: drm file for the ioctl call
3590 * Lookup the FB given its ID and return info about it.
3592 * Called by the user via ioctl.
3595 * Zero on success, negative errno on failure.
3597 int drm_mode_getfb(struct drm_device *dev,
3598 void *data, struct drm_file *file_priv)
3600 struct drm_mode_fb_cmd *r = data;
3601 struct drm_framebuffer *fb;
3604 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3607 fb = drm_framebuffer_lookup(dev, r->fb_id);
3611 r->height = fb->height;
3612 r->width = fb->width;
3613 r->depth = fb->depth;
3614 r->bpp = fb->bits_per_pixel;
3615 r->pitch = fb->pitches[0];
3616 if (fb->funcs->create_handle) {
3617 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3618 drm_is_control_client(file_priv)) {
3619 ret = fb->funcs->create_handle(fb, file_priv,
3622 /* GET_FB() is an unprivileged ioctl so we must not
3623 * return a buffer-handle to non-master processes! For
3624 * backwards-compatibility reasons, we cannot make
3625 * GET_FB() privileged, so just return an invalid handle
3626 * for non-masters. */
3634 drm_framebuffer_unreference(fb);
3640 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3641 * @dev: drm device for the ioctl
3642 * @data: data pointer for the ioctl
3643 * @file_priv: drm file for the ioctl call
3645 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3646 * rectangle list. Generic userspace which does frontbuffer rendering must call
3647 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3648 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3650 * Modesetting drivers which always update the frontbuffer do not need to
3651 * implement the corresponding ->dirty framebuffer callback.
3653 * Called by the user via ioctl.
3656 * Zero on success, negative errno on failure.
3658 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3659 void *data, struct drm_file *file_priv)
3661 struct drm_clip_rect __user *clips_ptr;
3662 struct drm_clip_rect *clips = NULL;
3663 struct drm_mode_fb_dirty_cmd *r = data;
3664 struct drm_framebuffer *fb;
3669 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3672 fb = drm_framebuffer_lookup(dev, r->fb_id);
3676 num_clips = r->num_clips;
3677 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3679 if (!num_clips != !clips_ptr) {
3684 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3686 /* If userspace annotates copy, clips must come in pairs */
3687 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3692 if (num_clips && clips_ptr) {
3693 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3697 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3703 ret = copy_from_user(clips, clips_ptr,
3704 num_clips * sizeof(*clips));
3711 if (fb->funcs->dirty) {
3712 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3721 drm_framebuffer_unreference(fb);
3727 * drm_fb_release - remove and free the FBs on this file
3728 * @priv: drm file for the ioctl
3730 * Destroy all the FBs associated with @filp.
3732 * Called by the user via ioctl.
3735 * Zero on success, negative errno on failure.
3737 void drm_fb_release(struct drm_file *priv)
3739 struct drm_framebuffer *fb, *tfb;
3740 struct drm_mode_rmfb_work arg;
3742 INIT_LIST_HEAD(&arg.fbs);
3745 * When the file gets released that means no one else can access the fb
3746 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3747 * avoid upsetting lockdep since the universal cursor code adds a
3748 * framebuffer while holding mutex locks.
3750 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3751 * locks is impossible here since no one else but this function can get
3754 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3755 if (atomic_read(&fb->refcount.refcount) > 1) {
3756 list_move_tail(&fb->filp_head, &arg.fbs);
3758 list_del_init(&fb->filp_head);
3760 /* This drops the fpriv->fbs reference. */
3761 drm_framebuffer_unreference(fb);
3765 if (!list_empty(&arg.fbs)) {
3766 INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn);
3768 schedule_work(&arg.work);
3769 flush_work(&arg.work);
3770 destroy_work_on_stack(&arg.work);
3775 * drm_property_create - create a new property type
3777 * @flags: flags specifying the property type
3778 * @name: name of the property
3779 * @num_values: number of pre-defined values
3781 * This creates a new generic drm property which can then be attached to a drm
3782 * object with drm_object_attach_property. The returned property object must be
3783 * freed with drm_property_destroy.
3785 * Note that the DRM core keeps a per-device list of properties and that, if
3786 * drm_mode_config_cleanup() is called, it will destroy all properties created
3790 * A pointer to the newly created property on success, NULL on failure.
3792 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3793 const char *name, int num_values)
3795 struct drm_property *property = NULL;
3798 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3802 property->dev = dev;
3805 property->values = kcalloc(num_values, sizeof(uint64_t),
3807 if (!property->values)
3811 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3815 property->flags = flags;
3816 property->num_values = num_values;
3817 INIT_LIST_HEAD(&property->enum_list);
3820 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3821 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3824 list_add_tail(&property->head, &dev->mode_config.property_list);
3826 WARN_ON(!drm_property_type_valid(property));
3830 kfree(property->values);
3834 EXPORT_SYMBOL(drm_property_create);
3837 * drm_property_create_enum - create a new enumeration property type
3839 * @flags: flags specifying the property type
3840 * @name: name of the property
3841 * @props: enumeration lists with property values
3842 * @num_values: number of pre-defined values
3844 * This creates a new generic drm property which can then be attached to a drm
3845 * object with drm_object_attach_property. The returned property object must be
3846 * freed with drm_property_destroy.
3848 * Userspace is only allowed to set one of the predefined values for enumeration
3852 * A pointer to the newly created property on success, NULL on failure.
3854 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3856 const struct drm_prop_enum_list *props,
3859 struct drm_property *property;
3862 flags |= DRM_MODE_PROP_ENUM;
3864 property = drm_property_create(dev, flags, name, num_values);
3868 for (i = 0; i < num_values; i++) {
3869 ret = drm_property_add_enum(property, i,
3873 drm_property_destroy(dev, property);
3880 EXPORT_SYMBOL(drm_property_create_enum);
3883 * drm_property_create_bitmask - create a new bitmask property type
3885 * @flags: flags specifying the property type
3886 * @name: name of the property
3887 * @props: enumeration lists with property bitflags
3888 * @num_props: size of the @props array
3889 * @supported_bits: bitmask of all supported enumeration values
3891 * This creates a new bitmask drm property which can then be attached to a drm
3892 * object with drm_object_attach_property. The returned property object must be
3893 * freed with drm_property_destroy.
3895 * Compared to plain enumeration properties userspace is allowed to set any
3896 * or'ed together combination of the predefined property bitflag values
3899 * A pointer to the newly created property on success, NULL on failure.
3901 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3902 int flags, const char *name,
3903 const struct drm_prop_enum_list *props,
3905 uint64_t supported_bits)
3907 struct drm_property *property;
3908 int i, ret, index = 0;
3909 int num_values = hweight64(supported_bits);
3911 flags |= DRM_MODE_PROP_BITMASK;
3913 property = drm_property_create(dev, flags, name, num_values);
3916 for (i = 0; i < num_props; i++) {
3917 if (!(supported_bits & (1ULL << props[i].type)))
3920 if (WARN_ON(index >= num_values)) {
3921 drm_property_destroy(dev, property);
3925 ret = drm_property_add_enum(property, index++,
3929 drm_property_destroy(dev, property);
3936 EXPORT_SYMBOL(drm_property_create_bitmask);
3938 static struct drm_property *property_create_range(struct drm_device *dev,
3939 int flags, const char *name,
3940 uint64_t min, uint64_t max)
3942 struct drm_property *property;
3944 property = drm_property_create(dev, flags, name, 2);
3948 property->values[0] = min;
3949 property->values[1] = max;
3955 * drm_property_create_range - create a new unsigned ranged property type
3957 * @flags: flags specifying the property type
3958 * @name: name of the property
3959 * @min: minimum value of the property
3960 * @max: maximum value of the property
3962 * This creates a new generic drm property which can then be attached to a drm
3963 * object with drm_object_attach_property. The returned property object must be
3964 * freed with drm_property_destroy.
3966 * Userspace is allowed to set any unsigned integer value in the (min, max)
3970 * A pointer to the newly created property on success, NULL on failure.
3972 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3974 uint64_t min, uint64_t max)
3976 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3979 EXPORT_SYMBOL(drm_property_create_range);
3982 * drm_property_create_signed_range - create a new signed ranged property type
3984 * @flags: flags specifying the property type
3985 * @name: name of the property
3986 * @min: minimum value of the property
3987 * @max: maximum value of the property
3989 * This creates a new generic drm property which can then be attached to a drm
3990 * object with drm_object_attach_property. The returned property object must be
3991 * freed with drm_property_destroy.
3993 * Userspace is allowed to set any signed integer value in the (min, max)
3997 * A pointer to the newly created property on success, NULL on failure.
3999 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
4000 int flags, const char *name,
4001 int64_t min, int64_t max)
4003 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
4004 name, I642U64(min), I642U64(max));
4006 EXPORT_SYMBOL(drm_property_create_signed_range);
4009 * drm_property_create_object - create a new object property type
4011 * @flags: flags specifying the property type
4012 * @name: name of the property
4013 * @type: object type from DRM_MODE_OBJECT_* defines
4015 * This creates a new generic drm property which can then be attached to a drm
4016 * object with drm_object_attach_property. The returned property object must be
4017 * freed with drm_property_destroy.
4019 * Userspace is only allowed to set this to any property value of the given
4020 * @type. Only useful for atomic properties, which is enforced.
4023 * A pointer to the newly created property on success, NULL on failure.
4025 struct drm_property *drm_property_create_object(struct drm_device *dev,
4026 int flags, const char *name, uint32_t type)
4028 struct drm_property *property;
4030 flags |= DRM_MODE_PROP_OBJECT;
4032 if (WARN_ON(!(flags & DRM_MODE_PROP_ATOMIC)))
4035 property = drm_property_create(dev, flags, name, 1);
4039 property->values[0] = type;
4043 EXPORT_SYMBOL(drm_property_create_object);
4046 * drm_property_create_bool - create a new boolean property type
4048 * @flags: flags specifying the property type
4049 * @name: name of the property
4051 * This creates a new generic drm property which can then be attached to a drm
4052 * object with drm_object_attach_property. The returned property object must be
4053 * freed with drm_property_destroy.
4055 * This is implemented as a ranged property with only {0, 1} as valid values.
4058 * A pointer to the newly created property on success, NULL on failure.
4060 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
4063 return drm_property_create_range(dev, flags, name, 0, 1);
4065 EXPORT_SYMBOL(drm_property_create_bool);
4068 * drm_property_add_enum - add a possible value to an enumeration property
4069 * @property: enumeration property to change
4070 * @index: index of the new enumeration
4071 * @value: value of the new enumeration
4072 * @name: symbolic name of the new enumeration
4074 * This functions adds enumerations to a property.
4076 * It's use is deprecated, drivers should use one of the more specific helpers
4077 * to directly create the property with all enumerations already attached.
4080 * Zero on success, error code on failure.
4082 int drm_property_add_enum(struct drm_property *property, int index,
4083 uint64_t value, const char *name)
4085 struct drm_property_enum *prop_enum;
4087 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4088 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
4092 * Bitmask enum properties have the additional constraint of values
4095 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
4099 if (!list_empty(&property->enum_list)) {
4100 list_for_each_entry(prop_enum, &property->enum_list, head) {
4101 if (prop_enum->value == value) {
4102 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4103 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4109 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
4113 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
4114 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
4115 prop_enum->value = value;
4117 property->values[index] = value;
4118 list_add_tail(&prop_enum->head, &property->enum_list);
4121 EXPORT_SYMBOL(drm_property_add_enum);
4124 * drm_property_destroy - destroy a drm property
4126 * @property: property to destry
4128 * This function frees a property including any attached resources like
4129 * enumeration values.
4131 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
4133 struct drm_property_enum *prop_enum, *pt;
4135 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
4136 list_del(&prop_enum->head);
4140 if (property->num_values)
4141 kfree(property->values);
4142 drm_mode_object_put(dev, &property->base);
4143 list_del(&property->head);
4146 EXPORT_SYMBOL(drm_property_destroy);
4149 * drm_object_attach_property - attach a property to a modeset object
4150 * @obj: drm modeset object
4151 * @property: property to attach
4152 * @init_val: initial value of the property
4154 * This attaches the given property to the modeset object with the given initial
4155 * value. Currently this function cannot fail since the properties are stored in
4156 * a statically sized array.
4158 void drm_object_attach_property(struct drm_mode_object *obj,
4159 struct drm_property *property,
4162 int count = obj->properties->count;
4164 if (count == DRM_OBJECT_MAX_PROPERTY) {
4165 WARN(1, "Failed to attach object property (type: 0x%x). Please "
4166 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
4167 "you see this message on the same object type.\n",
4172 obj->properties->properties[count] = property;
4173 obj->properties->values[count] = init_val;
4174 obj->properties->count++;
4175 if (property->flags & DRM_MODE_PROP_ATOMIC)
4176 obj->properties->atomic_count++;
4178 EXPORT_SYMBOL(drm_object_attach_property);
4181 * drm_object_property_set_value - set the value of a property
4182 * @obj: drm mode object to set property value for
4183 * @property: property to set
4184 * @val: value the property should be set to
4186 * This functions sets a given property on a given object. This function only
4187 * changes the software state of the property, it does not call into the
4188 * driver's ->set_property callback.
4191 * Zero on success, error code on failure.
4193 int drm_object_property_set_value(struct drm_mode_object *obj,
4194 struct drm_property *property, uint64_t val)
4198 for (i = 0; i < obj->properties->count; i++) {
4199 if (obj->properties->properties[i] == property) {
4200 obj->properties->values[i] = val;
4207 EXPORT_SYMBOL(drm_object_property_set_value);
4210 * drm_object_property_get_value - retrieve the value of a property
4211 * @obj: drm mode object to get property value from
4212 * @property: property to retrieve
4213 * @val: storage for the property value
4215 * This function retrieves the softare state of the given property for the given
4216 * property. Since there is no driver callback to retrieve the current property
4217 * value this might be out of sync with the hardware, depending upon the driver
4221 * Zero on success, error code on failure.
4223 int drm_object_property_get_value(struct drm_mode_object *obj,
4224 struct drm_property *property, uint64_t *val)
4228 /* read-only properties bypass atomic mechanism and still store
4229 * their value in obj->properties->values[].. mostly to avoid
4230 * having to deal w/ EDID and similar props in atomic paths:
4232 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
4233 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
4234 return drm_atomic_get_property(obj, property, val);
4236 for (i = 0; i < obj->properties->count; i++) {
4237 if (obj->properties->properties[i] == property) {
4238 *val = obj->properties->values[i];
4245 EXPORT_SYMBOL(drm_object_property_get_value);
4248 * drm_mode_getproperty_ioctl - get the property metadata
4251 * @file_priv: DRM file info
4253 * This function retrieves the metadata for a given property, like the different
4254 * possible values for an enum property or the limits for a range property.
4256 * Blob properties are special
4258 * Called by the user via ioctl.
4261 * Zero on success, negative errno on failure.
4263 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4264 void *data, struct drm_file *file_priv)
4266 struct drm_mode_get_property *out_resp = data;
4267 struct drm_property *property;
4269 int value_count = 0;
4272 struct drm_property_enum *prop_enum;
4273 struct drm_mode_property_enum __user *enum_ptr;
4274 uint64_t __user *values_ptr;
4276 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4279 drm_modeset_lock_all(dev);
4280 property = drm_property_find(dev, out_resp->prop_id);
4286 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4287 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4288 list_for_each_entry(prop_enum, &property->enum_list, head)
4292 value_count = property->num_values;
4294 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4295 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4296 out_resp->flags = property->flags;
4298 if ((out_resp->count_values >= value_count) && value_count) {
4299 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4300 for (i = 0; i < value_count; i++) {
4301 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4307 out_resp->count_values = value_count;
4309 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4310 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4311 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4313 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4314 list_for_each_entry(prop_enum, &property->enum_list, head) {
4316 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4321 if (copy_to_user(&enum_ptr[copied].name,
4322 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4329 out_resp->count_enum_blobs = enum_count;
4333 * NOTE: The idea seems to have been to use this to read all the blob
4334 * property values. But nothing ever added them to the corresponding
4335 * list, userspace always used the special-purpose get_blob ioctl to
4336 * read the value for a blob property. It also doesn't make a lot of
4337 * sense to return values here when everything else is just metadata for
4338 * the property itself.
4340 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4341 out_resp->count_enum_blobs = 0;
4343 drm_modeset_unlock_all(dev);
4348 * drm_property_create_blob - Create new blob property
4350 * Creates a new blob property for a specified DRM device, optionally
4353 * @dev: DRM device to create property for
4354 * @length: Length to allocate for blob data
4355 * @data: If specified, copies data into blob
4358 * New blob property with a single reference on success, or an ERR_PTR
4361 struct drm_property_blob *
4362 drm_property_create_blob(struct drm_device *dev, size_t length,
4365 struct drm_property_blob *blob;
4368 if (!length || length > ULONG_MAX - sizeof(struct drm_property_blob))
4369 return ERR_PTR(-EINVAL);
4371 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4373 return ERR_PTR(-ENOMEM);
4375 /* This must be explicitly initialised, so we can safely call list_del
4376 * on it in the removal handler, even if it isn't in a file list. */
4377 INIT_LIST_HEAD(&blob->head_file);
4378 blob->length = length;
4382 memcpy(blob->data, data, length);
4384 mutex_lock(&dev->mode_config.blob_lock);
4386 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4389 mutex_unlock(&dev->mode_config.blob_lock);
4390 return ERR_PTR(-EINVAL);
4393 kref_init(&blob->refcount);
4395 list_add_tail(&blob->head_global,
4396 &dev->mode_config.property_blob_list);
4398 mutex_unlock(&dev->mode_config.blob_lock);
4402 EXPORT_SYMBOL(drm_property_create_blob);
4405 * drm_property_free_blob - Blob property destructor
4407 * Internal free function for blob properties; must not be used directly.
4411 static void drm_property_free_blob(struct kref *kref)
4413 struct drm_property_blob *blob =
4414 container_of(kref, struct drm_property_blob, refcount);
4416 WARN_ON(!mutex_is_locked(&blob->dev->mode_config.blob_lock));
4418 list_del(&blob->head_global);
4419 list_del(&blob->head_file);
4420 drm_mode_object_put(blob->dev, &blob->base);
4426 * drm_property_unreference_blob - Unreference a blob property
4428 * Drop a reference on a blob property. May free the object.
4430 * @blob: Pointer to blob property
4432 void drm_property_unreference_blob(struct drm_property_blob *blob)
4434 struct drm_device *dev;
4441 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4443 if (kref_put_mutex(&blob->refcount, drm_property_free_blob,
4444 &dev->mode_config.blob_lock))
4445 mutex_unlock(&dev->mode_config.blob_lock);
4447 might_lock(&dev->mode_config.blob_lock);
4449 EXPORT_SYMBOL(drm_property_unreference_blob);
4452 * drm_property_unreference_blob_locked - Unreference a blob property with blob_lock held
4454 * Drop a reference on a blob property. May free the object. This must be
4455 * called with blob_lock held.
4457 * @blob: Pointer to blob property
4459 static void drm_property_unreference_blob_locked(struct drm_property_blob *blob)
4464 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4466 kref_put(&blob->refcount, drm_property_free_blob);
4470 * drm_property_destroy_user_blobs - destroy all blobs created by this client
4472 * @file_priv: destroy all blobs owned by this file handle
4474 void drm_property_destroy_user_blobs(struct drm_device *dev,
4475 struct drm_file *file_priv)
4477 struct drm_property_blob *blob, *bt;
4479 mutex_lock(&dev->mode_config.blob_lock);
4481 list_for_each_entry_safe(blob, bt, &file_priv->blobs, head_file) {
4482 list_del_init(&blob->head_file);
4483 drm_property_unreference_blob_locked(blob);
4486 mutex_unlock(&dev->mode_config.blob_lock);
4490 * drm_property_reference_blob - Take a reference on an existing property
4492 * Take a new reference on an existing blob property.
4494 * @blob: Pointer to blob property
4496 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob)
4498 DRM_DEBUG("%p: blob ID: %d (%d)\n", blob, blob->base.id, atomic_read(&blob->refcount.refcount));
4499 kref_get(&blob->refcount);
4502 EXPORT_SYMBOL(drm_property_reference_blob);
4505 * Like drm_property_lookup_blob, but does not return an additional reference.
4506 * Must be called with blob_lock held.
4508 static struct drm_property_blob *__drm_property_lookup_blob(struct drm_device *dev,
4511 struct drm_mode_object *obj = NULL;
4512 struct drm_property_blob *blob;
4514 WARN_ON(!mutex_is_locked(&dev->mode_config.blob_lock));
4516 mutex_lock(&dev->mode_config.idr_mutex);
4517 obj = idr_find(&dev->mode_config.crtc_idr, id);
4518 if (!obj || (obj->type != DRM_MODE_OBJECT_BLOB) || (obj->id != id))
4521 blob = obj_to_blob(obj);
4522 mutex_unlock(&dev->mode_config.idr_mutex);
4528 * drm_property_lookup_blob - look up a blob property and take a reference
4530 * @id: id of the blob property
4532 * If successful, this takes an additional reference to the blob property.
4533 * callers need to make sure to eventually unreference the returned property
4534 * again, using @drm_property_unreference_blob.
4536 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
4539 struct drm_property_blob *blob;
4541 mutex_lock(&dev->mode_config.blob_lock);
4542 blob = __drm_property_lookup_blob(dev, id);
4544 if (!kref_get_unless_zero(&blob->refcount))
4547 mutex_unlock(&dev->mode_config.blob_lock);
4551 EXPORT_SYMBOL(drm_property_lookup_blob);
4554 * drm_property_replace_global_blob - atomically replace existing blob property
4556 * @replace: location of blob property pointer to be replaced
4557 * @length: length of data for new blob, or 0 for no data
4558 * @data: content for new blob, or NULL for no data
4559 * @obj_holds_id: optional object for property holding blob ID
4560 * @prop_holds_id: optional property holding blob ID
4561 * @return 0 on success or error on failure
4563 * This function will atomically replace a global property in the blob list,
4564 * optionally updating a property which holds the ID of that property. It is
4565 * guaranteed to be atomic: no caller will be allowed to see intermediate
4566 * results, and either the entire operation will succeed and clean up the
4567 * previous property, or it will fail and the state will be unchanged.
4569 * If length is 0 or data is NULL, no new blob will be created, and the holding
4570 * property, if specified, will be set to 0.
4572 * Access to the replace pointer is assumed to be protected by the caller, e.g.
4573 * by holding the relevant modesetting object lock for its parent.
4575 * For example, a drm_connector has a 'PATH' property, which contains the ID
4576 * of a blob property with the value of the MST path information. Calling this
4577 * function with replace pointing to the connector's path_blob_ptr, length and
4578 * data set for the new path information, obj_holds_id set to the connector's
4579 * base object, and prop_holds_id set to the path property name, will perform
4580 * a completely atomic update. The access to path_blob_ptr is protected by the
4581 * caller holding a lock on the connector.
4583 static int drm_property_replace_global_blob(struct drm_device *dev,
4584 struct drm_property_blob **replace,
4587 struct drm_mode_object *obj_holds_id,
4588 struct drm_property *prop_holds_id)
4590 struct drm_property_blob *new_blob = NULL;
4591 struct drm_property_blob *old_blob = NULL;
4594 WARN_ON(replace == NULL);
4596 old_blob = *replace;
4598 if (length && data) {
4599 new_blob = drm_property_create_blob(dev, length, data);
4600 if (IS_ERR(new_blob))
4601 return PTR_ERR(new_blob);
4604 /* This does not need to be synchronised with blob_lock, as the
4605 * get_properties ioctl locks all modesetting objects, and
4606 * obj_holds_id must be locked before calling here, so we cannot
4607 * have its value out of sync with the list membership modified
4608 * below under blob_lock. */
4610 ret = drm_object_property_set_value(obj_holds_id,
4613 new_blob->base.id : 0);
4618 drm_property_unreference_blob(old_blob);
4619 *replace = new_blob;
4624 drm_property_unreference_blob(new_blob);
4629 * drm_mode_getblob_ioctl - get the contents of a blob property value
4632 * @file_priv: DRM file info
4634 * This function retrieves the contents of a blob property. The value stored in
4635 * an object's blob property is just a normal modeset object id.
4637 * Called by the user via ioctl.
4640 * Zero on success, negative errno on failure.
4642 int drm_mode_getblob_ioctl(struct drm_device *dev,
4643 void *data, struct drm_file *file_priv)
4645 struct drm_mode_get_blob *out_resp = data;
4646 struct drm_property_blob *blob;
4648 void __user *blob_ptr;
4650 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4653 drm_modeset_lock_all(dev);
4654 mutex_lock(&dev->mode_config.blob_lock);
4655 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4661 if (out_resp->length == blob->length) {
4662 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4663 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4668 out_resp->length = blob->length;
4671 mutex_unlock(&dev->mode_config.blob_lock);
4672 drm_modeset_unlock_all(dev);
4677 * drm_mode_createblob_ioctl - create a new blob property
4680 * @file_priv: DRM file info
4682 * This function creates a new blob property with user-defined values. In order
4683 * to give us sensible validation and checking when creating, rather than at
4684 * every potential use, we also require a type to be provided upfront.
4686 * Called by the user via ioctl.
4689 * Zero on success, negative errno on failure.
4691 int drm_mode_createblob_ioctl(struct drm_device *dev,
4692 void *data, struct drm_file *file_priv)
4694 struct drm_mode_create_blob *out_resp = data;
4695 struct drm_property_blob *blob;
4696 void __user *blob_ptr;
4699 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4702 blob = drm_property_create_blob(dev, out_resp->length, NULL);
4704 return PTR_ERR(blob);
4706 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4707 if (copy_from_user(blob->data, blob_ptr, out_resp->length)) {
4712 /* Dropping the lock between create_blob and our access here is safe
4713 * as only the same file_priv can remove the blob; at this point, it is
4714 * not associated with any file_priv. */
4715 mutex_lock(&dev->mode_config.blob_lock);
4716 out_resp->blob_id = blob->base.id;
4717 list_add_tail(&blob->head_file, &file_priv->blobs);
4718 mutex_unlock(&dev->mode_config.blob_lock);
4723 drm_property_unreference_blob(blob);
4728 * drm_mode_destroyblob_ioctl - destroy a user blob property
4731 * @file_priv: DRM file info
4733 * Destroy an existing user-defined blob property.
4735 * Called by the user via ioctl.
4738 * Zero on success, negative errno on failure.
4740 int drm_mode_destroyblob_ioctl(struct drm_device *dev,
4741 void *data, struct drm_file *file_priv)
4743 struct drm_mode_destroy_blob *out_resp = data;
4744 struct drm_property_blob *blob = NULL, *bt;
4748 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4751 mutex_lock(&dev->mode_config.blob_lock);
4752 blob = __drm_property_lookup_blob(dev, out_resp->blob_id);
4758 /* Ensure the property was actually created by this user. */
4759 list_for_each_entry(bt, &file_priv->blobs, head_file) {
4771 /* We must drop head_file here, because we may not be the last
4772 * reference on the blob. */
4773 list_del_init(&blob->head_file);
4774 drm_property_unreference_blob_locked(blob);
4775 mutex_unlock(&dev->mode_config.blob_lock);
4780 mutex_unlock(&dev->mode_config.blob_lock);
4785 * drm_mode_connector_set_path_property - set tile property on connector
4786 * @connector: connector to set property on.
4787 * @path: path to use for property; must not be NULL.
4789 * This creates a property to expose to userspace to specify a
4790 * connector path. This is mainly used for DisplayPort MST where
4791 * connectors have a topology and we want to allow userspace to give
4792 * them more meaningful names.
4795 * Zero on success, negative errno on failure.
4797 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4800 struct drm_device *dev = connector->dev;
4803 ret = drm_property_replace_global_blob(dev,
4804 &connector->path_blob_ptr,
4808 dev->mode_config.path_property);
4811 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4814 * drm_mode_connector_set_tile_property - set tile property on connector
4815 * @connector: connector to set property on.
4817 * This looks up the tile information for a connector, and creates a
4818 * property for userspace to parse if it exists. The property is of
4819 * the form of 8 integers using ':' as a separator.
4822 * Zero on success, errno on failure.
4824 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4826 struct drm_device *dev = connector->dev;
4830 if (!connector->has_tile) {
4831 ret = drm_property_replace_global_blob(dev,
4832 &connector->tile_blob_ptr,
4836 dev->mode_config.tile_property);
4840 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4841 connector->tile_group->id, connector->tile_is_single_monitor,
4842 connector->num_h_tile, connector->num_v_tile,
4843 connector->tile_h_loc, connector->tile_v_loc,
4844 connector->tile_h_size, connector->tile_v_size);
4846 ret = drm_property_replace_global_blob(dev,
4847 &connector->tile_blob_ptr,
4851 dev->mode_config.tile_property);
4854 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4857 * drm_mode_connector_update_edid_property - update the edid property of a connector
4858 * @connector: drm connector
4859 * @edid: new value of the edid property
4861 * This function creates a new blob modeset object and assigns its id to the
4862 * connector's edid property.
4865 * Zero on success, negative errno on failure.
4867 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4868 const struct edid *edid)
4870 struct drm_device *dev = connector->dev;
4874 /* ignore requests to set edid when overridden */
4875 if (connector->override_edid)
4879 size = EDID_LENGTH * (1 + edid->extensions);
4881 ret = drm_property_replace_global_blob(dev,
4882 &connector->edid_blob_ptr,
4886 dev->mode_config.edid_property);
4889 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4891 /* Some properties could refer to dynamic refcnt'd objects, or things that
4892 * need special locking to handle lifetime issues (ie. to ensure the prop
4893 * value doesn't become invalid part way through the property update due to
4894 * race). The value returned by reference via 'obj' should be passed back
4895 * to drm_property_change_valid_put() after the property is set (and the
4896 * object to which the property is attached has a chance to take it's own
4899 bool drm_property_change_valid_get(struct drm_property *property,
4900 uint64_t value, struct drm_mode_object **ref)
4904 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4909 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4910 if (value < property->values[0] || value > property->values[1])
4913 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4914 int64_t svalue = U642I64(value);
4916 if (svalue < U642I64(property->values[0]) ||
4917 svalue > U642I64(property->values[1]))
4920 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4921 uint64_t valid_mask = 0;
4923 for (i = 0; i < property->num_values; i++)
4924 valid_mask |= (1ULL << property->values[i]);
4925 return !(value & ~valid_mask);
4926 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4927 struct drm_property_blob *blob;
4932 blob = drm_property_lookup_blob(property->dev, value);
4939 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4940 /* a zero value for an object property translates to null: */
4944 /* handle refcnt'd objects specially: */
4945 if (property->values[0] == DRM_MODE_OBJECT_FB) {
4946 struct drm_framebuffer *fb;
4947 fb = drm_framebuffer_lookup(property->dev, value);
4955 return _object_find(property->dev, value, property->values[0]) != NULL;
4959 for (i = 0; i < property->num_values; i++)
4960 if (property->values[i] == value)
4965 void drm_property_change_valid_put(struct drm_property *property,
4966 struct drm_mode_object *ref)
4971 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4972 if (property->values[0] == DRM_MODE_OBJECT_FB)
4973 drm_framebuffer_unreference(obj_to_fb(ref));
4974 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4975 drm_property_unreference_blob(obj_to_blob(ref));
4979 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4982 * @file_priv: DRM file info
4984 * This function sets the current value for a connectors's property. It also
4985 * calls into a driver's ->set_property callback to update the hardware state
4987 * Called by the user via ioctl.
4990 * Zero on success, negative errno on failure.
4992 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4993 void *data, struct drm_file *file_priv)
4995 struct drm_mode_connector_set_property *conn_set_prop = data;
4996 struct drm_mode_obj_set_property obj_set_prop = {
4997 .value = conn_set_prop->value,
4998 .prop_id = conn_set_prop->prop_id,
4999 .obj_id = conn_set_prop->connector_id,
5000 .obj_type = DRM_MODE_OBJECT_CONNECTOR
5003 /* It does all the locking and checking we need */
5004 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
5007 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
5008 struct drm_property *property,
5012 struct drm_connector *connector = obj_to_connector(obj);
5014 /* Do DPMS ourselves */
5015 if (property == connector->dev->mode_config.dpms_property) {
5017 if (connector->funcs->dpms)
5018 ret = (*connector->funcs->dpms)(connector, (int)value);
5019 } else if (connector->funcs->set_property)
5020 ret = connector->funcs->set_property(connector, property, value);
5022 /* store the property value if successful */
5024 drm_object_property_set_value(&connector->base, property, value);
5028 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
5029 struct drm_property *property,
5033 struct drm_crtc *crtc = obj_to_crtc(obj);
5035 if (crtc->funcs->set_property)
5036 ret = crtc->funcs->set_property(crtc, property, value);
5038 drm_object_property_set_value(obj, property, value);
5044 * drm_mode_plane_set_obj_prop - set the value of a property
5045 * @plane: drm plane object to set property value for
5046 * @property: property to set
5047 * @value: value the property should be set to
5049 * This functions sets a given property on a given plane object. This function
5050 * calls the driver's ->set_property callback and changes the software state of
5051 * the property if the callback succeeds.
5054 * Zero on success, error code on failure.
5056 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
5057 struct drm_property *property,
5061 struct drm_mode_object *obj = &plane->base;
5063 if (plane->funcs->set_property)
5064 ret = plane->funcs->set_property(plane, property, value);
5066 drm_object_property_set_value(obj, property, value);
5070 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
5073 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
5076 * @file_priv: DRM file info
5078 * This function retrieves the current value for an object's property. Compared
5079 * to the connector specific ioctl this one is extended to also work on crtc and
5082 * Called by the user via ioctl.
5085 * Zero on success, negative errno on failure.
5087 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
5088 struct drm_file *file_priv)
5090 struct drm_mode_obj_get_properties *arg = data;
5091 struct drm_mode_object *obj;
5094 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5097 drm_modeset_lock_all(dev);
5099 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5104 if (!obj->properties) {
5109 ret = get_properties(obj, file_priv->atomic,
5110 (uint32_t __user *)(unsigned long)(arg->props_ptr),
5111 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
5115 drm_modeset_unlock_all(dev);
5120 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
5123 * @file_priv: DRM file info
5125 * This function sets the current value for an object's property. It also calls
5126 * into a driver's ->set_property callback to update the hardware state.
5127 * Compared to the connector specific ioctl this one is extended to also work on
5128 * crtc and plane objects.
5130 * Called by the user via ioctl.
5133 * Zero on success, negative errno on failure.
5135 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
5136 struct drm_file *file_priv)
5138 struct drm_mode_obj_set_property *arg = data;
5139 struct drm_mode_object *arg_obj;
5140 struct drm_mode_object *prop_obj;
5141 struct drm_property *property;
5142 int i, ret = -EINVAL;
5143 struct drm_mode_object *ref;
5145 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5148 drm_modeset_lock_all(dev);
5150 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
5155 if (!arg_obj->properties)
5158 for (i = 0; i < arg_obj->properties->count; i++)
5159 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
5162 if (i == arg_obj->properties->count)
5165 prop_obj = drm_mode_object_find(dev, arg->prop_id,
5166 DRM_MODE_OBJECT_PROPERTY);
5171 property = obj_to_property(prop_obj);
5173 if (!drm_property_change_valid_get(property, arg->value, &ref))
5176 switch (arg_obj->type) {
5177 case DRM_MODE_OBJECT_CONNECTOR:
5178 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
5181 case DRM_MODE_OBJECT_CRTC:
5182 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
5184 case DRM_MODE_OBJECT_PLANE:
5185 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
5186 property, arg->value);
5190 drm_property_change_valid_put(property, ref);
5193 drm_modeset_unlock_all(dev);
5198 * drm_mode_connector_attach_encoder - attach a connector to an encoder
5199 * @connector: connector to attach
5200 * @encoder: encoder to attach @connector to
5202 * This function links up a connector to an encoder. Note that the routing
5203 * restrictions between encoders and crtcs are exposed to userspace through the
5204 * possible_clones and possible_crtcs bitmasks.
5207 * Zero on success, negative errno on failure.
5209 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
5210 struct drm_encoder *encoder)
5215 * In the past, drivers have attempted to model the static association
5216 * of connector to encoder in simple connector/encoder devices using a
5217 * direct assignment of connector->encoder = encoder. This connection
5218 * is a logical one and the responsibility of the core, so drivers are
5219 * expected not to mess with this.
5221 * Note that the error return should've been enough here, but a large
5222 * majority of drivers ignores the return value, so add in a big WARN
5223 * to get people's attention.
5225 if (WARN_ON(connector->encoder))
5228 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
5229 if (connector->encoder_ids[i] == 0) {
5230 connector->encoder_ids[i] = encoder->base.id;
5236 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
5239 * drm_mode_crtc_set_gamma_size - set the gamma table size
5240 * @crtc: CRTC to set the gamma table size for
5241 * @gamma_size: size of the gamma table
5243 * Drivers which support gamma tables should set this to the supported gamma
5244 * table size when initializing the CRTC. Currently the drm core only supports a
5245 * fixed gamma table size.
5248 * Zero on success, negative errno on failure.
5250 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
5253 crtc->gamma_size = gamma_size;
5255 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
5257 if (!crtc->gamma_store) {
5258 crtc->gamma_size = 0;
5264 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
5267 * drm_mode_gamma_set_ioctl - set the gamma table
5270 * @file_priv: DRM file info
5272 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
5273 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
5275 * Called by the user via ioctl.
5278 * Zero on success, negative errno on failure.
5280 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
5281 void *data, struct drm_file *file_priv)
5283 struct drm_mode_crtc_lut *crtc_lut = data;
5284 struct drm_crtc *crtc;
5285 void *r_base, *g_base, *b_base;
5289 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5292 drm_modeset_lock_all(dev);
5293 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5299 if (crtc->funcs->gamma_set == NULL) {
5304 /* memcpy into gamma store */
5305 if (crtc_lut->gamma_size != crtc->gamma_size) {
5310 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5311 r_base = crtc->gamma_store;
5312 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
5317 g_base = r_base + size;
5318 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
5323 b_base = g_base + size;
5324 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
5329 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
5332 drm_modeset_unlock_all(dev);
5338 * drm_mode_gamma_get_ioctl - get the gamma table
5341 * @file_priv: DRM file info
5343 * Copy the current gamma table into the storage provided. This also provides
5344 * the gamma table size the driver expects, which can be used to size the
5345 * allocated storage.
5347 * Called by the user via ioctl.
5350 * Zero on success, negative errno on failure.
5352 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
5353 void *data, struct drm_file *file_priv)
5355 struct drm_mode_crtc_lut *crtc_lut = data;
5356 struct drm_crtc *crtc;
5357 void *r_base, *g_base, *b_base;
5361 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5364 drm_modeset_lock_all(dev);
5365 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
5371 /* memcpy into gamma store */
5372 if (crtc_lut->gamma_size != crtc->gamma_size) {
5377 size = crtc_lut->gamma_size * (sizeof(uint16_t));
5378 r_base = crtc->gamma_store;
5379 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
5384 g_base = r_base + size;
5385 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
5390 b_base = g_base + size;
5391 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
5396 drm_modeset_unlock_all(dev);
5401 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
5404 * @file_priv: DRM file info
5406 * This schedules an asynchronous update on a given CRTC, called page flip.
5407 * Optionally a drm event is generated to signal the completion of the event.
5408 * Generic drivers cannot assume that a pageflip with changed framebuffer
5409 * properties (including driver specific metadata like tiling layout) will work,
5410 * but some drivers support e.g. pixel format changes through the pageflip
5413 * Called by the user via ioctl.
5416 * Zero on success, negative errno on failure.
5418 int drm_mode_page_flip_ioctl(struct drm_device *dev,
5419 void *data, struct drm_file *file_priv)
5421 struct drm_mode_crtc_page_flip *page_flip = data;
5422 struct drm_crtc *crtc;
5423 struct drm_framebuffer *fb = NULL;
5424 struct drm_pending_vblank_event *e = NULL;
5425 unsigned long flags;
5428 if (!drm_core_check_feature(dev, DRIVER_MODESET))
5431 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
5432 page_flip->reserved != 0)
5435 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
5438 crtc = drm_crtc_find(dev, page_flip->crtc_id);
5442 drm_modeset_lock_crtc(crtc, crtc->primary);
5443 if (crtc->primary->fb == NULL) {
5444 /* The framebuffer is currently unbound, presumably
5445 * due to a hotplug event, that userspace has not
5452 if (crtc->funcs->page_flip == NULL)
5455 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
5462 const struct drm_plane_state *state = crtc->primary->state;
5464 ret = check_src_coords(state->src_x, state->src_y,
5465 state->src_w, state->src_h, fb);
5467 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
5472 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
5473 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
5478 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5480 spin_lock_irqsave(&dev->event_lock, flags);
5481 if (file_priv->event_space < sizeof(e->event)) {
5482 spin_unlock_irqrestore(&dev->event_lock, flags);
5485 file_priv->event_space -= sizeof(e->event);
5486 spin_unlock_irqrestore(&dev->event_lock, flags);
5488 e = kzalloc(sizeof(*e), GFP_KERNEL);
5490 spin_lock_irqsave(&dev->event_lock, flags);
5491 file_priv->event_space += sizeof(e->event);
5492 spin_unlock_irqrestore(&dev->event_lock, flags);
5496 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
5497 e->event.base.length = sizeof(e->event);
5498 e->event.user_data = page_flip->user_data;
5499 e->base.event = &e->event.base;
5500 e->base.file_priv = file_priv;
5502 (void (*) (struct drm_pending_event *)) kfree;
5505 crtc->primary->old_fb = crtc->primary->fb;
5506 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
5508 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
5509 spin_lock_irqsave(&dev->event_lock, flags);
5510 file_priv->event_space += sizeof(e->event);
5511 spin_unlock_irqrestore(&dev->event_lock, flags);
5514 /* Keep the old fb, don't unref it. */
5515 crtc->primary->old_fb = NULL;
5517 crtc->primary->fb = fb;
5518 /* Unref only the old framebuffer. */
5524 drm_framebuffer_unreference(fb);
5525 if (crtc->primary->old_fb)
5526 drm_framebuffer_unreference(crtc->primary->old_fb);
5527 crtc->primary->old_fb = NULL;
5528 drm_modeset_unlock_crtc(crtc);
5534 * drm_mode_config_reset - call ->reset callbacks
5537 * This functions calls all the crtc's, encoder's and connector's ->reset
5538 * callback. Drivers can use this in e.g. their driver load or resume code to
5539 * reset hardware and software state.
5541 void drm_mode_config_reset(struct drm_device *dev)
5543 struct drm_crtc *crtc;
5544 struct drm_plane *plane;
5545 struct drm_encoder *encoder;
5546 struct drm_connector *connector;
5548 drm_for_each_plane(plane, dev)
5549 if (plane->funcs->reset)
5550 plane->funcs->reset(plane);
5552 drm_for_each_crtc(crtc, dev)
5553 if (crtc->funcs->reset)
5554 crtc->funcs->reset(crtc);
5556 drm_for_each_encoder(encoder, dev)
5557 if (encoder->funcs->reset)
5558 encoder->funcs->reset(encoder);
5560 mutex_lock(&dev->mode_config.mutex);
5561 drm_for_each_connector(connector, dev)
5562 if (connector->funcs->reset)
5563 connector->funcs->reset(connector);
5564 mutex_unlock(&dev->mode_config.mutex);
5566 EXPORT_SYMBOL(drm_mode_config_reset);
5569 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
5572 * @file_priv: DRM file info
5574 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
5575 * TTM or something else entirely) and returns the resulting buffer handle. This
5576 * handle can then be wrapped up into a framebuffer modeset object.
5578 * Note that userspace is not allowed to use such objects for render
5579 * acceleration - drivers must create their own private ioctls for such a use
5582 * Called by the user via ioctl.
5585 * Zero on success, negative errno on failure.
5587 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
5588 void *data, struct drm_file *file_priv)
5590 struct drm_mode_create_dumb *args = data;
5591 u32 cpp, stride, size;
5593 if (!dev->driver->dumb_create)
5595 if (!args->width || !args->height || !args->bpp)
5598 /* overflow checks for 32bit size calculations */
5599 /* NOTE: DIV_ROUND_UP() can overflow */
5600 cpp = DIV_ROUND_UP(args->bpp, 8);
5601 if (!cpp || cpp > 0xffffffffU / args->width)
5603 stride = cpp * args->width;
5604 if (args->height > 0xffffffffU / stride)
5607 /* test for wrap-around */
5608 size = args->height * stride;
5609 if (PAGE_ALIGN(size) == 0)
5613 * handle, pitch and size are output parameters. Zero them out to
5614 * prevent drivers from accidentally using uninitialized data. Since
5615 * not all existing userspace is clearing these fields properly we
5616 * cannot reject IOCTL with garbage in them.
5622 return dev->driver->dumb_create(file_priv, dev, args);
5626 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5629 * @file_priv: DRM file info
5631 * Allocate an offset in the drm device node's address space to be able to
5632 * memory map a dumb buffer.
5634 * Called by the user via ioctl.
5637 * Zero on success, negative errno on failure.
5639 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5640 void *data, struct drm_file *file_priv)
5642 struct drm_mode_map_dumb *args = data;
5644 /* call driver ioctl to get mmap offset */
5645 if (!dev->driver->dumb_map_offset)
5648 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5652 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5655 * @file_priv: DRM file info
5657 * This destroys the userspace handle for the given dumb backing storage buffer.
5658 * Since buffer objects must be reference counted in the kernel a buffer object
5659 * won't be immediately freed if a framebuffer modeset object still uses it.
5661 * Called by the user via ioctl.
5664 * Zero on success, negative errno on failure.
5666 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5667 void *data, struct drm_file *file_priv)
5669 struct drm_mode_destroy_dumb *args = data;
5671 if (!dev->driver->dumb_destroy)
5674 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5678 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5679 * @format: pixel format (DRM_FORMAT_*)
5680 * @depth: storage for the depth value
5681 * @bpp: storage for the bpp value
5683 * This only supports RGB formats here for compat with code that doesn't use
5684 * pixel formats directly yet.
5686 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5691 case DRM_FORMAT_RGB332:
5692 case DRM_FORMAT_BGR233:
5696 case DRM_FORMAT_XRGB1555:
5697 case DRM_FORMAT_XBGR1555:
5698 case DRM_FORMAT_RGBX5551:
5699 case DRM_FORMAT_BGRX5551:
5700 case DRM_FORMAT_ARGB1555:
5701 case DRM_FORMAT_ABGR1555:
5702 case DRM_FORMAT_RGBA5551:
5703 case DRM_FORMAT_BGRA5551:
5707 case DRM_FORMAT_RGB565:
5708 case DRM_FORMAT_BGR565:
5712 case DRM_FORMAT_RGB888:
5713 case DRM_FORMAT_BGR888:
5717 case DRM_FORMAT_XRGB8888:
5718 case DRM_FORMAT_XBGR8888:
5719 case DRM_FORMAT_RGBX8888:
5720 case DRM_FORMAT_BGRX8888:
5724 case DRM_FORMAT_XRGB2101010:
5725 case DRM_FORMAT_XBGR2101010:
5726 case DRM_FORMAT_RGBX1010102:
5727 case DRM_FORMAT_BGRX1010102:
5728 case DRM_FORMAT_ARGB2101010:
5729 case DRM_FORMAT_ABGR2101010:
5730 case DRM_FORMAT_RGBA1010102:
5731 case DRM_FORMAT_BGRA1010102:
5735 case DRM_FORMAT_ARGB8888:
5736 case DRM_FORMAT_ABGR8888:
5737 case DRM_FORMAT_RGBA8888:
5738 case DRM_FORMAT_BGRA8888:
5743 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5744 drm_get_format_name(format));
5750 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5753 * drm_format_num_planes - get the number of planes for format
5754 * @format: pixel format (DRM_FORMAT_*)
5757 * The number of planes used by the specified pixel format.
5759 int drm_format_num_planes(uint32_t format)
5762 case DRM_FORMAT_YUV410:
5763 case DRM_FORMAT_YVU410:
5764 case DRM_FORMAT_YUV411:
5765 case DRM_FORMAT_YVU411:
5766 case DRM_FORMAT_YUV420:
5767 case DRM_FORMAT_YVU420:
5768 case DRM_FORMAT_YUV422:
5769 case DRM_FORMAT_YVU422:
5770 case DRM_FORMAT_YUV444:
5771 case DRM_FORMAT_YVU444:
5773 case DRM_FORMAT_NV12:
5774 case DRM_FORMAT_NV21:
5775 case DRM_FORMAT_NV16:
5776 case DRM_FORMAT_NV61:
5777 case DRM_FORMAT_NV24:
5778 case DRM_FORMAT_NV42:
5779 case DRM_FORMAT_NV12_10:
5780 case DRM_FORMAT_NV21_10:
5781 case DRM_FORMAT_NV16_10:
5782 case DRM_FORMAT_NV61_10:
5783 case DRM_FORMAT_NV24_10:
5784 case DRM_FORMAT_NV42_10:
5790 EXPORT_SYMBOL(drm_format_num_planes);
5793 * drm_format_plane_bpp - get the bpp for format
5794 * @format: pixel format (DRM_FORMAT_*)
5795 * @plane: plane index
5798 * The bpp for the specified plane.
5800 int drm_format_plane_bpp(uint32_t format, int plane)
5805 if (plane >= drm_format_num_planes(format))
5809 case DRM_FORMAT_YUYV:
5810 case DRM_FORMAT_YVYU:
5811 case DRM_FORMAT_UYVY:
5812 case DRM_FORMAT_VYUY:
5814 case DRM_FORMAT_NV12_10:
5815 case DRM_FORMAT_NV21_10:
5816 case DRM_FORMAT_NV16_10:
5817 case DRM_FORMAT_NV61_10:
5818 case DRM_FORMAT_NV24_10:
5819 case DRM_FORMAT_NV42_10:
5820 return plane ? 20 : 10;
5821 case DRM_FORMAT_NV12:
5822 case DRM_FORMAT_NV21:
5823 case DRM_FORMAT_NV16:
5824 case DRM_FORMAT_NV61:
5825 case DRM_FORMAT_NV24:
5826 case DRM_FORMAT_NV42:
5827 return plane ? 16 : 8;
5828 case DRM_FORMAT_YUV410:
5829 case DRM_FORMAT_YVU410:
5830 case DRM_FORMAT_YUV411:
5831 case DRM_FORMAT_YVU411:
5832 case DRM_FORMAT_YUV420:
5833 case DRM_FORMAT_YVU420:
5834 case DRM_FORMAT_YUV422:
5835 case DRM_FORMAT_YVU422:
5836 case DRM_FORMAT_YUV444:
5837 case DRM_FORMAT_YVU444:
5840 drm_fb_get_bpp_depth(format, &depth, &bpp);
5844 EXPORT_SYMBOL(drm_format_plane_bpp);
5847 * drm_format_plane_cpp - determine the bytes per pixel value
5848 * @format: pixel format (DRM_FORMAT_*)
5849 * @plane: plane index
5852 * The bytes per pixel value for the specified plane.
5854 int drm_format_plane_cpp(uint32_t format, int plane)
5856 return drm_format_plane_bpp(format, plane) >> 3;
5858 EXPORT_SYMBOL(drm_format_plane_cpp);
5861 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5862 * @format: pixel format (DRM_FORMAT_*)
5865 * The horizontal chroma subsampling factor for the
5866 * specified pixel format.
5868 int drm_format_horz_chroma_subsampling(uint32_t format)
5871 case DRM_FORMAT_YUV411:
5872 case DRM_FORMAT_YVU411:
5873 case DRM_FORMAT_YUV410:
5874 case DRM_FORMAT_YVU410:
5876 case DRM_FORMAT_YUYV:
5877 case DRM_FORMAT_YVYU:
5878 case DRM_FORMAT_UYVY:
5879 case DRM_FORMAT_VYUY:
5880 case DRM_FORMAT_NV12:
5881 case DRM_FORMAT_NV21:
5882 case DRM_FORMAT_NV16:
5883 case DRM_FORMAT_NV61:
5884 case DRM_FORMAT_NV12_10:
5885 case DRM_FORMAT_NV21_10:
5886 case DRM_FORMAT_NV16_10:
5887 case DRM_FORMAT_NV61_10:
5888 case DRM_FORMAT_YUV422:
5889 case DRM_FORMAT_YVU422:
5890 case DRM_FORMAT_YUV420:
5891 case DRM_FORMAT_YVU420:
5897 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5900 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5901 * @format: pixel format (DRM_FORMAT_*)
5904 * The vertical chroma subsampling factor for the
5905 * specified pixel format.
5907 int drm_format_vert_chroma_subsampling(uint32_t format)
5910 case DRM_FORMAT_YUV410:
5911 case DRM_FORMAT_YVU410:
5913 case DRM_FORMAT_YUV420:
5914 case DRM_FORMAT_YVU420:
5915 case DRM_FORMAT_NV12:
5916 case DRM_FORMAT_NV12_10:
5917 case DRM_FORMAT_NV21:
5918 case DRM_FORMAT_NV21_10:
5924 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5927 * drm_rotation_simplify() - Try to simplify the rotation
5928 * @rotation: Rotation to be simplified
5929 * @supported_rotations: Supported rotations
5931 * Attempt to simplify the rotation to a form that is supported.
5932 * Eg. if the hardware supports everything except DRM_REFLECT_X
5933 * one could call this function like this:
5935 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5936 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5937 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5939 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5940 * transforms the hardware supports, this function may not
5941 * be able to produce a supported transform, so the caller should
5942 * check the result afterwards.
5944 unsigned int drm_rotation_simplify(unsigned int rotation,
5945 unsigned int supported_rotations)
5947 if (rotation & ~supported_rotations) {
5948 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5949 rotation = (rotation & DRM_REFLECT_MASK) |
5950 BIT((ffs(rotation & DRM_ROTATE_MASK) + 1) % 4);
5955 EXPORT_SYMBOL(drm_rotation_simplify);
5958 * drm_mode_config_init - initialize DRM mode_configuration structure
5961 * Initialize @dev's mode_config structure, used for tracking the graphics
5962 * configuration of @dev.
5964 * Since this initializes the modeset locks, no locking is possible. Which is no
5965 * problem, since this should happen single threaded at init time. It is the
5966 * driver's problem to ensure this guarantee.
5969 void drm_mode_config_init(struct drm_device *dev)
5971 mutex_init(&dev->mode_config.mutex);
5972 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5973 mutex_init(&dev->mode_config.idr_mutex);
5974 mutex_init(&dev->mode_config.fb_lock);
5975 mutex_init(&dev->mode_config.blob_lock);
5976 INIT_LIST_HEAD(&dev->mode_config.fb_list);
5977 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5978 INIT_LIST_HEAD(&dev->mode_config.connector_list);
5979 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5980 INIT_LIST_HEAD(&dev->mode_config.property_list);
5981 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5982 INIT_LIST_HEAD(&dev->mode_config.plane_list);
5983 idr_init(&dev->mode_config.crtc_idr);
5984 idr_init(&dev->mode_config.tile_idr);
5986 drm_modeset_lock_all(dev);
5987 drm_mode_create_standard_properties(dev);
5988 drm_modeset_unlock_all(dev);
5990 /* Just to be sure */
5991 dev->mode_config.num_fb = 0;
5992 dev->mode_config.num_connector = 0;
5993 dev->mode_config.num_crtc = 0;
5994 dev->mode_config.num_encoder = 0;
5995 dev->mode_config.num_overlay_plane = 0;
5996 dev->mode_config.num_total_plane = 0;
5998 EXPORT_SYMBOL(drm_mode_config_init);
6001 * drm_mode_config_cleanup - free up DRM mode_config info
6004 * Free up all the connectors and CRTCs associated with this DRM device, then
6005 * free up the framebuffers and associated buffer objects.
6007 * Note that since this /should/ happen single-threaded at driver/device
6008 * teardown time, no locking is required. It's the driver's job to ensure that
6009 * this guarantee actually holds true.
6011 * FIXME: cleanup any dangling user buffer objects too
6013 void drm_mode_config_cleanup(struct drm_device *dev)
6015 struct drm_connector *connector, *ot;
6016 struct drm_crtc *crtc, *ct;
6017 struct drm_encoder *encoder, *enct;
6018 struct drm_framebuffer *fb, *fbt;
6019 struct drm_property *property, *pt;
6020 struct drm_property_blob *blob, *bt;
6021 struct drm_plane *plane, *plt;
6023 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
6025 encoder->funcs->destroy(encoder);
6028 list_for_each_entry_safe(connector, ot,
6029 &dev->mode_config.connector_list, head) {
6030 connector->funcs->destroy(connector);
6033 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
6035 drm_property_destroy(dev, property);
6038 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
6040 drm_property_unreference_blob(blob);
6044 * Single-threaded teardown context, so it's not required to grab the
6045 * fb_lock to protect against concurrent fb_list access. Contrary, it
6046 * would actually deadlock with the drm_framebuffer_cleanup function.
6048 * Also, if there are any framebuffers left, that's a driver leak now,
6049 * so politely WARN about this.
6051 WARN_ON(!list_empty(&dev->mode_config.fb_list));
6052 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
6053 drm_framebuffer_free(&fb->refcount);
6056 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
6058 plane->funcs->destroy(plane);
6061 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
6062 crtc->funcs->destroy(crtc);
6065 idr_destroy(&dev->mode_config.tile_idr);
6066 idr_destroy(&dev->mode_config.crtc_idr);
6067 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
6069 EXPORT_SYMBOL(drm_mode_config_cleanup);
6071 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
6072 unsigned int supported_rotations)
6074 static const struct drm_prop_enum_list props[] = {
6075 { DRM_ROTATE_0, "rotate-0" },
6076 { DRM_ROTATE_90, "rotate-90" },
6077 { DRM_ROTATE_180, "rotate-180" },
6078 { DRM_ROTATE_270, "rotate-270" },
6079 { DRM_REFLECT_X, "reflect-x" },
6080 { DRM_REFLECT_Y, "reflect-y" },
6083 return drm_property_create_bitmask(dev, 0, "rotation",
6084 props, ARRAY_SIZE(props),
6085 supported_rotations);
6087 EXPORT_SYMBOL(drm_mode_create_rotation_property);
6092 * Tile groups are used to represent tiled monitors with a unique
6093 * integer identifier. Tiled monitors using DisplayID v1.3 have
6094 * a unique 8-byte handle, we store this in a tile group, so we
6095 * have a common identifier for all tiles in a monitor group.
6097 static void drm_tile_group_free(struct kref *kref)
6099 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
6100 struct drm_device *dev = tg->dev;
6101 mutex_lock(&dev->mode_config.idr_mutex);
6102 idr_remove(&dev->mode_config.tile_idr, tg->id);
6103 mutex_unlock(&dev->mode_config.idr_mutex);
6108 * drm_mode_put_tile_group - drop a reference to a tile group.
6110 * @tg: tile group to drop reference to.
6112 * drop reference to tile group and free if 0.
6114 void drm_mode_put_tile_group(struct drm_device *dev,
6115 struct drm_tile_group *tg)
6117 kref_put(&tg->refcount, drm_tile_group_free);
6121 * drm_mode_get_tile_group - get a reference to an existing tile group
6123 * @topology: 8-bytes unique per monitor.
6125 * Use the unique bytes to get a reference to an existing tile group.
6128 * tile group or NULL if not found.
6130 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
6133 struct drm_tile_group *tg;
6135 mutex_lock(&dev->mode_config.idr_mutex);
6136 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
6137 if (!memcmp(tg->group_data, topology, 8)) {
6138 if (!kref_get_unless_zero(&tg->refcount))
6140 mutex_unlock(&dev->mode_config.idr_mutex);
6144 mutex_unlock(&dev->mode_config.idr_mutex);
6147 EXPORT_SYMBOL(drm_mode_get_tile_group);
6150 * drm_mode_create_tile_group - create a tile group from a displayid description
6152 * @topology: 8-bytes unique per monitor.
6154 * Create a tile group for the unique monitor, and get a unique
6155 * identifier for the tile group.
6158 * new tile group or error.
6160 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
6163 struct drm_tile_group *tg;
6166 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
6168 return ERR_PTR(-ENOMEM);
6170 kref_init(&tg->refcount);
6171 memcpy(tg->group_data, topology, 8);
6174 mutex_lock(&dev->mode_config.idr_mutex);
6175 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
6183 mutex_unlock(&dev->mode_config.idr_mutex);
6186 EXPORT_SYMBOL(drm_mode_create_tile_group);