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 *add_framebuffer_internal(struct drm_device *dev,
47 struct drm_mode_fb_cmd2 *r,
48 struct drm_file *file_priv);
50 /* Avoid boilerplate. I'm tired of typing. */
51 #define DRM_ENUM_NAME_FN(fnname, list) \
52 const char *fnname(int val) \
55 for (i = 0; i < ARRAY_SIZE(list); i++) { \
56 if (list[i].type == val) \
57 return list[i].name; \
65 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
66 { DRM_MODE_DPMS_ON, "On" },
67 { DRM_MODE_DPMS_STANDBY, "Standby" },
68 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
69 { DRM_MODE_DPMS_OFF, "Off" }
72 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
74 static const struct drm_prop_enum_list drm_plane_type_enum_list[] = {
75 { DRM_PLANE_TYPE_OVERLAY, "Overlay" },
76 { DRM_PLANE_TYPE_PRIMARY, "Primary" },
77 { DRM_PLANE_TYPE_CURSOR, "Cursor" },
83 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
84 { DRM_MODE_SCALE_NONE, "None" },
85 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
86 { DRM_MODE_SCALE_CENTER, "Center" },
87 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
90 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
91 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
92 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
93 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
97 * Non-global properties, but "required" for certain connectors.
99 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
100 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
101 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
102 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
105 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
107 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
108 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
109 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
110 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
113 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
114 drm_dvi_i_subconnector_enum_list)
116 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
117 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
118 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
119 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
120 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
121 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
124 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
126 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
127 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
128 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
129 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
130 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
131 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
134 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
135 drm_tv_subconnector_enum_list)
137 static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
138 { DRM_MODE_DIRTY_OFF, "Off" },
139 { DRM_MODE_DIRTY_ON, "On" },
140 { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
143 struct drm_conn_prop_enum_list {
150 * Connector and encoder types.
152 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
153 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
154 { DRM_MODE_CONNECTOR_VGA, "VGA" },
155 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
156 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
157 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
158 { DRM_MODE_CONNECTOR_Composite, "Composite" },
159 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
160 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
161 { DRM_MODE_CONNECTOR_Component, "Component" },
162 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
163 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
164 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
165 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
166 { DRM_MODE_CONNECTOR_TV, "TV" },
167 { DRM_MODE_CONNECTOR_eDP, "eDP" },
168 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
169 { DRM_MODE_CONNECTOR_DSI, "DSI" },
172 static const struct drm_prop_enum_list drm_encoder_enum_list[] = {
173 { DRM_MODE_ENCODER_NONE, "None" },
174 { DRM_MODE_ENCODER_DAC, "DAC" },
175 { DRM_MODE_ENCODER_TMDS, "TMDS" },
176 { DRM_MODE_ENCODER_LVDS, "LVDS" },
177 { DRM_MODE_ENCODER_TVDAC, "TV" },
178 { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
179 { DRM_MODE_ENCODER_DSI, "DSI" },
180 { DRM_MODE_ENCODER_DPMST, "DP MST" },
183 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
184 { SubPixelUnknown, "Unknown" },
185 { SubPixelHorizontalRGB, "Horizontal RGB" },
186 { SubPixelHorizontalBGR, "Horizontal BGR" },
187 { SubPixelVerticalRGB, "Vertical RGB" },
188 { SubPixelVerticalBGR, "Vertical BGR" },
189 { SubPixelNone, "None" },
192 void drm_connector_ida_init(void)
196 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
197 ida_init(&drm_connector_enum_list[i].ida);
200 void drm_connector_ida_destroy(void)
204 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
205 ida_destroy(&drm_connector_enum_list[i].ida);
209 * drm_get_connector_status_name - return a string for connector status
210 * @status: connector status to compute name of
212 * In contrast to the other drm_get_*_name functions this one here returns a
213 * const pointer and hence is threadsafe.
215 const char *drm_get_connector_status_name(enum drm_connector_status status)
217 if (status == connector_status_connected)
219 else if (status == connector_status_disconnected)
220 return "disconnected";
224 EXPORT_SYMBOL(drm_get_connector_status_name);
227 * drm_get_subpixel_order_name - return a string for a given subpixel enum
228 * @order: enum of subpixel_order
230 * Note you could abuse this and return something out of bounds, but that
231 * would be a caller error. No unscrubbed user data should make it here.
233 const char *drm_get_subpixel_order_name(enum subpixel_order order)
235 return drm_subpixel_enum_list[order].name;
237 EXPORT_SYMBOL(drm_get_subpixel_order_name);
239 static char printable_char(int c)
241 return isascii(c) && isprint(c) ? c : '?';
245 * drm_get_format_name - return a string for drm fourcc format
246 * @format: format to compute name of
248 * Note that the buffer used by this function is globally shared and owned by
249 * the function itself.
251 * FIXME: This isn't really multithreading safe.
253 const char *drm_get_format_name(uint32_t format)
257 snprintf(buf, sizeof(buf),
258 "%c%c%c%c %s-endian (0x%08x)",
259 printable_char(format & 0xff),
260 printable_char((format >> 8) & 0xff),
261 printable_char((format >> 16) & 0xff),
262 printable_char((format >> 24) & 0x7f),
263 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
268 EXPORT_SYMBOL(drm_get_format_name);
271 * Internal function to assign a slot in the object idr and optionally
272 * register the object into the idr.
274 static int drm_mode_object_get_reg(struct drm_device *dev,
275 struct drm_mode_object *obj,
281 mutex_lock(&dev->mode_config.idr_mutex);
282 ret = idr_alloc(&dev->mode_config.crtc_idr, register_obj ? obj : NULL, 1, 0, GFP_KERNEL);
285 * Set up the object linking under the protection of the idr
286 * lock so that other users can't see inconsistent state.
289 obj->type = obj_type;
291 mutex_unlock(&dev->mode_config.idr_mutex);
293 return ret < 0 ? ret : 0;
297 * drm_mode_object_get - allocate a new modeset identifier
299 * @obj: object pointer, used to generate unique ID
300 * @obj_type: object type
302 * Create a unique identifier based on @ptr in @dev's identifier space. Used
303 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
304 * modeset identifiers are _not_ reference counted. Hence don't use this for
305 * reference counted modeset objects like framebuffers.
308 * New unique (relative to other objects in @dev) integer identifier for the
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 */
354 if (obj && (obj->type == DRM_MODE_OBJECT_FB))
356 mutex_unlock(&dev->mode_config.idr_mutex);
362 * drm_mode_object_find - look up a drm object with static lifetime
364 * @id: id of the mode object
365 * @type: type of the mode object
367 * Note that framebuffers cannot be looked up with this functions - since those
368 * are reference counted, they need special treatment. Even with
369 * DRM_MODE_OBJECT_ANY (although that will simply return NULL
370 * rather than WARN_ON()).
372 struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
373 uint32_t id, uint32_t type)
375 struct drm_mode_object *obj = NULL;
377 /* Framebuffers are reference counted and need their own lookup
379 WARN_ON(type == DRM_MODE_OBJECT_FB);
380 obj = _object_find(dev, id, type);
383 EXPORT_SYMBOL(drm_mode_object_find);
386 * drm_framebuffer_init - initialize a framebuffer
388 * @fb: framebuffer to be initialized
389 * @funcs: ... with these functions
391 * Allocates an ID for the framebuffer's parent mode object, sets its mode
392 * functions & device file and adds it to the master fd list.
395 * This functions publishes the fb and makes it available for concurrent access
396 * by other users. Which means by this point the fb _must_ be fully set up -
397 * since all the fb attributes are invariant over its lifetime, no further
398 * locking but only correct reference counting is required.
401 * Zero on success, error code on failure.
403 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
404 const struct drm_framebuffer_funcs *funcs)
408 mutex_lock(&dev->mode_config.fb_lock);
409 kref_init(&fb->refcount);
410 INIT_LIST_HEAD(&fb->filp_head);
414 ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
418 dev->mode_config.num_fb++;
419 list_add(&fb->head, &dev->mode_config.fb_list);
421 mutex_unlock(&dev->mode_config.fb_lock);
425 EXPORT_SYMBOL(drm_framebuffer_init);
427 /* dev->mode_config.fb_lock must be held! */
428 static void __drm_framebuffer_unregister(struct drm_device *dev,
429 struct drm_framebuffer *fb)
431 mutex_lock(&dev->mode_config.idr_mutex);
432 idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
433 mutex_unlock(&dev->mode_config.idr_mutex);
438 static void drm_framebuffer_free(struct kref *kref)
440 struct drm_framebuffer *fb =
441 container_of(kref, struct drm_framebuffer, refcount);
442 struct drm_device *dev = fb->dev;
445 * The lookup idr holds a weak reference, which has not necessarily been
446 * removed at this point. Check for that.
448 mutex_lock(&dev->mode_config.fb_lock);
450 /* Mark fb as reaped and drop idr ref. */
451 __drm_framebuffer_unregister(dev, fb);
453 mutex_unlock(&dev->mode_config.fb_lock);
455 fb->funcs->destroy(fb);
458 static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
461 struct drm_mode_object *obj = NULL;
462 struct drm_framebuffer *fb;
464 mutex_lock(&dev->mode_config.idr_mutex);
465 obj = idr_find(&dev->mode_config.crtc_idr, id);
466 if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
470 mutex_unlock(&dev->mode_config.idr_mutex);
476 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
478 * @id: id of the fb object
480 * If successful, this grabs an additional reference to the framebuffer -
481 * callers need to make sure to eventually unreference the returned framebuffer
482 * again, using @drm_framebuffer_unreference.
484 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
487 struct drm_framebuffer *fb;
489 mutex_lock(&dev->mode_config.fb_lock);
490 fb = __drm_framebuffer_lookup(dev, id);
492 if (!kref_get_unless_zero(&fb->refcount))
495 mutex_unlock(&dev->mode_config.fb_lock);
499 EXPORT_SYMBOL(drm_framebuffer_lookup);
502 * drm_framebuffer_unreference - unref a framebuffer
503 * @fb: framebuffer to unref
505 * This functions decrements the fb's refcount and frees it if it drops to zero.
507 void drm_framebuffer_unreference(struct drm_framebuffer *fb)
509 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
510 kref_put(&fb->refcount, drm_framebuffer_free);
512 EXPORT_SYMBOL(drm_framebuffer_unreference);
515 * drm_framebuffer_reference - incr the fb refcnt
518 * This functions increments the fb's refcount.
520 void drm_framebuffer_reference(struct drm_framebuffer *fb)
522 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
523 kref_get(&fb->refcount);
525 EXPORT_SYMBOL(drm_framebuffer_reference);
527 static void drm_framebuffer_free_bug(struct kref *kref)
532 static void __drm_framebuffer_unreference(struct drm_framebuffer *fb)
534 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
535 kref_put(&fb->refcount, drm_framebuffer_free_bug);
539 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
540 * @fb: fb to unregister
542 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
543 * those used for fbdev. Note that the caller must hold a reference of it's own,
544 * i.e. the object may not be destroyed through this call (since it'll lead to a
545 * locking inversion).
547 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
549 struct drm_device *dev = fb->dev;
551 mutex_lock(&dev->mode_config.fb_lock);
552 /* Mark fb as reaped and drop idr ref. */
553 __drm_framebuffer_unregister(dev, fb);
554 mutex_unlock(&dev->mode_config.fb_lock);
556 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
559 * drm_framebuffer_cleanup - remove a framebuffer object
560 * @fb: framebuffer to remove
562 * Cleanup framebuffer. This function is intended to be used from the drivers
563 * ->destroy callback. It can also be used to clean up driver private
564 * framebuffers embedded into a larger structure.
566 * Note that this function does not remove the fb from active usuage - if it is
567 * still used anywhere, hilarity can ensue since userspace could call getfb on
568 * the id and get back -EINVAL. Obviously no concern at driver unload time.
570 * Also, the framebuffer will not be removed from the lookup idr - for
571 * user-created framebuffers this will happen in in the rmfb ioctl. For
572 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
573 * drm_framebuffer_unregister_private.
575 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
577 struct drm_device *dev = fb->dev;
579 mutex_lock(&dev->mode_config.fb_lock);
581 dev->mode_config.num_fb--;
582 mutex_unlock(&dev->mode_config.fb_lock);
584 EXPORT_SYMBOL(drm_framebuffer_cleanup);
587 * drm_framebuffer_remove - remove and unreference a framebuffer object
588 * @fb: framebuffer to remove
590 * Scans all the CRTCs and planes in @dev's mode_config. If they're
591 * using @fb, removes it, setting it to NULL. Then drops the reference to the
592 * passed-in framebuffer. Might take the modeset locks.
594 * Note that this function optimizes the cleanup away if the caller holds the
595 * last reference to the framebuffer. It is also guaranteed to not take the
596 * modeset locks in this case.
598 void drm_framebuffer_remove(struct drm_framebuffer *fb)
600 struct drm_device *dev = fb->dev;
601 struct drm_crtc *crtc;
602 struct drm_plane *plane;
603 struct drm_mode_set set;
606 WARN_ON(!list_empty(&fb->filp_head));
609 * drm ABI mandates that we remove any deleted framebuffers from active
610 * useage. But since most sane clients only remove framebuffers they no
611 * longer need, try to optimize this away.
613 * Since we're holding a reference ourselves, observing a refcount of 1
614 * means that we're the last holder and can skip it. Also, the refcount
615 * can never increase from 1 again, so we don't need any barriers or
618 * Note that userspace could try to race with use and instate a new
619 * usage _after_ we've cleared all current ones. End result will be an
620 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
623 if (atomic_read(&fb->refcount.refcount) > 1) {
624 drm_modeset_lock_all(dev);
625 /* remove from any CRTC */
626 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
627 if (crtc->primary->fb == fb) {
628 /* should turn off the crtc */
629 memset(&set, 0, sizeof(struct drm_mode_set));
632 ret = drm_mode_set_config_internal(&set);
634 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
638 list_for_each_entry(plane, &dev->mode_config.plane_list, head) {
640 drm_plane_force_disable(plane);
642 drm_modeset_unlock_all(dev);
645 drm_framebuffer_unreference(fb);
647 EXPORT_SYMBOL(drm_framebuffer_remove);
649 DEFINE_WW_CLASS(crtc_ww_class);
652 * drm_crtc_init_with_planes - Initialise a new CRTC object with
653 * specified primary and cursor planes.
655 * @crtc: CRTC object to init
656 * @primary: Primary plane for CRTC
657 * @cursor: Cursor plane for CRTC
658 * @funcs: callbacks for the new CRTC
660 * Inits a new object created as base part of a driver crtc object.
663 * Zero on success, error code on failure.
665 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
666 struct drm_plane *primary,
667 struct drm_plane *cursor,
668 const struct drm_crtc_funcs *funcs)
670 struct drm_mode_config *config = &dev->mode_config;
675 crtc->invert_dimensions = false;
677 drm_modeset_lock_init(&crtc->mutex);
678 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
682 crtc->base.properties = &crtc->properties;
684 list_add_tail(&crtc->head, &config->crtc_list);
687 crtc->primary = primary;
688 crtc->cursor = cursor;
690 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
692 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
696 EXPORT_SYMBOL(drm_crtc_init_with_planes);
699 * drm_crtc_cleanup - Clean up the core crtc usage
700 * @crtc: CRTC to cleanup
702 * This function cleans up @crtc and removes it from the DRM mode setting
703 * core. Note that the function does *not* free the crtc structure itself,
704 * this is the responsibility of the caller.
706 void drm_crtc_cleanup(struct drm_crtc *crtc)
708 struct drm_device *dev = crtc->dev;
710 kfree(crtc->gamma_store);
711 crtc->gamma_store = NULL;
713 drm_modeset_lock_fini(&crtc->mutex);
715 drm_mode_object_put(dev, &crtc->base);
716 list_del(&crtc->head);
717 dev->mode_config.num_crtc--;
719 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
720 if (crtc->state && crtc->funcs->atomic_destroy_state)
721 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
723 memset(crtc, 0, sizeof(*crtc));
725 EXPORT_SYMBOL(drm_crtc_cleanup);
728 * drm_crtc_index - find the index of a registered CRTC
729 * @crtc: CRTC to find index for
731 * Given a registered CRTC, return the index of that CRTC within a DRM
732 * device's list of CRTCs.
734 unsigned int drm_crtc_index(struct drm_crtc *crtc)
736 unsigned int index = 0;
737 struct drm_crtc *tmp;
739 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
748 EXPORT_SYMBOL(drm_crtc_index);
751 * drm_mode_remove - remove and free a mode
752 * @connector: connector list to modify
753 * @mode: mode to remove
755 * Remove @mode from @connector's mode list, then free it.
757 static void drm_mode_remove(struct drm_connector *connector,
758 struct drm_display_mode *mode)
760 list_del(&mode->head);
761 drm_mode_destroy(connector->dev, mode);
765 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
766 * @connector: connector to quwery
768 * The kernel supports per-connector configration of its consoles through
769 * use of the video= parameter. This function parses that option and
770 * extracts the user's specified mode (or enable/disable status) for a
771 * particular connector. This is typically only used during the early fbdev
774 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
776 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
779 if (fb_get_options(connector->name, &option))
782 if (!drm_mode_parse_command_line_for_connector(option,
790 switch (mode->force) {
794 case DRM_FORCE_ON_DIGITAL:
803 DRM_INFO("forcing %s connector %s\n", connector->name, s);
804 connector->force = mode->force;
807 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
809 mode->xres, mode->yres,
810 mode->refresh_specified ? mode->refresh : 60,
811 mode->rb ? " reduced blanking" : "",
812 mode->margins ? " with margins" : "",
813 mode->interlace ? " interlaced" : "");
817 * drm_connector_init - Init a preallocated connector
819 * @connector: the connector to init
820 * @funcs: callbacks for this connector
821 * @connector_type: user visible type of the connector
823 * Initialises a preallocated connector. Connectors should be
824 * subclassed as part of driver connector objects.
827 * Zero on success, error code on failure.
829 int drm_connector_init(struct drm_device *dev,
830 struct drm_connector *connector,
831 const struct drm_connector_funcs *funcs,
835 struct ida *connector_ida =
836 &drm_connector_enum_list[connector_type].ida;
838 drm_modeset_lock_all(dev);
840 ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
844 connector->base.properties = &connector->properties;
845 connector->dev = dev;
846 connector->funcs = funcs;
847 connector->connector_type = connector_type;
848 connector->connector_type_id =
849 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
850 if (connector->connector_type_id < 0) {
851 ret = connector->connector_type_id;
855 kasprintf(GFP_KERNEL, "%s-%d",
856 drm_connector_enum_list[connector_type].name,
857 connector->connector_type_id);
858 if (!connector->name) {
863 INIT_LIST_HEAD(&connector->probed_modes);
864 INIT_LIST_HEAD(&connector->modes);
865 connector->edid_blob_ptr = NULL;
866 connector->status = connector_status_unknown;
868 drm_connector_get_cmdline_mode(connector);
870 /* We should add connectors at the end to avoid upsetting the connector
872 list_add_tail(&connector->head, &dev->mode_config.connector_list);
873 dev->mode_config.num_connector++;
875 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
876 drm_object_attach_property(&connector->base,
877 dev->mode_config.edid_property,
880 drm_object_attach_property(&connector->base,
881 dev->mode_config.dpms_property, 0);
883 connector->debugfs_entry = NULL;
887 drm_mode_object_put(dev, &connector->base);
890 drm_modeset_unlock_all(dev);
894 EXPORT_SYMBOL(drm_connector_init);
897 * drm_connector_cleanup - cleans up an initialised connector
898 * @connector: connector to cleanup
900 * Cleans up the connector but doesn't free the object.
902 void drm_connector_cleanup(struct drm_connector *connector)
904 struct drm_device *dev = connector->dev;
905 struct drm_display_mode *mode, *t;
907 if (connector->tile_group) {
908 drm_mode_put_tile_group(dev, connector->tile_group);
909 connector->tile_group = NULL;
912 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
913 drm_mode_remove(connector, mode);
915 list_for_each_entry_safe(mode, t, &connector->modes, head)
916 drm_mode_remove(connector, mode);
918 ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
919 connector->connector_type_id);
921 drm_mode_object_put(dev, &connector->base);
922 kfree(connector->name);
923 connector->name = NULL;
924 list_del(&connector->head);
925 dev->mode_config.num_connector--;
927 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
928 if (connector->state && connector->funcs->atomic_destroy_state)
929 connector->funcs->atomic_destroy_state(connector,
932 memset(connector, 0, sizeof(*connector));
934 EXPORT_SYMBOL(drm_connector_cleanup);
937 * drm_connector_index - find the index of a registered connector
938 * @connector: connector to find index for
940 * Given a registered connector, return the index of that connector within a DRM
941 * device's list of connectors.
943 unsigned int drm_connector_index(struct drm_connector *connector)
945 unsigned int index = 0;
946 struct drm_connector *tmp;
947 struct drm_mode_config *config = &connector->dev->mode_config;
949 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
951 list_for_each_entry(tmp, &connector->dev->mode_config.connector_list, head) {
952 if (tmp == connector)
960 EXPORT_SYMBOL(drm_connector_index);
963 * drm_connector_register - register a connector
964 * @connector: the connector to register
966 * Register userspace interfaces for a connector
969 * Zero on success, error code on failure.
971 int drm_connector_register(struct drm_connector *connector)
975 drm_mode_object_register(connector->dev, &connector->base);
977 ret = drm_sysfs_connector_add(connector);
981 ret = drm_debugfs_connector_add(connector);
983 drm_sysfs_connector_remove(connector);
989 EXPORT_SYMBOL(drm_connector_register);
992 * drm_connector_unregister - unregister a connector
993 * @connector: the connector to unregister
995 * Unregister userspace interfaces for a connector
997 void drm_connector_unregister(struct drm_connector *connector)
999 drm_sysfs_connector_remove(connector);
1000 drm_debugfs_connector_remove(connector);
1002 EXPORT_SYMBOL(drm_connector_unregister);
1006 * drm_connector_unplug_all - unregister connector userspace interfaces
1009 * This function unregisters all connector userspace interfaces in sysfs. Should
1010 * be call when the device is disconnected, e.g. from an usb driver's
1011 * ->disconnect callback.
1013 void drm_connector_unplug_all(struct drm_device *dev)
1015 struct drm_connector *connector;
1017 /* taking the mode config mutex ends up in a clash with sysfs */
1018 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1019 drm_connector_unregister(connector);
1022 EXPORT_SYMBOL(drm_connector_unplug_all);
1025 * drm_bridge_init - initialize a drm transcoder/bridge
1027 * @bridge: transcoder/bridge to set up
1028 * @funcs: bridge function table
1030 * Initialises a preallocated bridge. Bridges should be
1031 * subclassed as part of driver connector objects.
1034 * Zero on success, error code on failure.
1036 int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
1037 const struct drm_bridge_funcs *funcs)
1041 drm_modeset_lock_all(dev);
1043 ret = drm_mode_object_get(dev, &bridge->base, DRM_MODE_OBJECT_BRIDGE);
1048 bridge->funcs = funcs;
1050 list_add_tail(&bridge->head, &dev->mode_config.bridge_list);
1051 dev->mode_config.num_bridge++;
1054 drm_modeset_unlock_all(dev);
1057 EXPORT_SYMBOL(drm_bridge_init);
1060 * drm_bridge_cleanup - cleans up an initialised bridge
1061 * @bridge: bridge to cleanup
1063 * Cleans up the bridge but doesn't free the object.
1065 void drm_bridge_cleanup(struct drm_bridge *bridge)
1067 struct drm_device *dev = bridge->dev;
1069 drm_modeset_lock_all(dev);
1070 drm_mode_object_put(dev, &bridge->base);
1071 list_del(&bridge->head);
1072 dev->mode_config.num_bridge--;
1073 drm_modeset_unlock_all(dev);
1075 memset(bridge, 0, sizeof(*bridge));
1077 EXPORT_SYMBOL(drm_bridge_cleanup);
1080 * drm_encoder_init - Init a preallocated encoder
1082 * @encoder: the encoder to init
1083 * @funcs: callbacks for this encoder
1084 * @encoder_type: user visible type of the encoder
1086 * Initialises a preallocated encoder. Encoder should be
1087 * subclassed as part of driver encoder objects.
1090 * Zero on success, error code on failure.
1092 int drm_encoder_init(struct drm_device *dev,
1093 struct drm_encoder *encoder,
1094 const struct drm_encoder_funcs *funcs,
1099 drm_modeset_lock_all(dev);
1101 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1106 encoder->encoder_type = encoder_type;
1107 encoder->funcs = funcs;
1108 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1109 drm_encoder_enum_list[encoder_type].name,
1111 if (!encoder->name) {
1116 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1117 dev->mode_config.num_encoder++;
1121 drm_mode_object_put(dev, &encoder->base);
1124 drm_modeset_unlock_all(dev);
1128 EXPORT_SYMBOL(drm_encoder_init);
1131 * drm_encoder_cleanup - cleans up an initialised encoder
1132 * @encoder: encoder to cleanup
1134 * Cleans up the encoder but doesn't free the object.
1136 void drm_encoder_cleanup(struct drm_encoder *encoder)
1138 struct drm_device *dev = encoder->dev;
1140 drm_modeset_lock_all(dev);
1141 drm_mode_object_put(dev, &encoder->base);
1142 kfree(encoder->name);
1143 list_del(&encoder->head);
1144 dev->mode_config.num_encoder--;
1145 drm_modeset_unlock_all(dev);
1147 memset(encoder, 0, sizeof(*encoder));
1149 EXPORT_SYMBOL(drm_encoder_cleanup);
1152 * drm_universal_plane_init - Initialize a new universal plane object
1154 * @plane: plane object to init
1155 * @possible_crtcs: bitmask of possible CRTCs
1156 * @funcs: callbacks for the new plane
1157 * @formats: array of supported formats (%DRM_FORMAT_*)
1158 * @format_count: number of elements in @formats
1159 * @type: type of plane (overlay, primary, cursor)
1161 * Initializes a plane object of type @type.
1164 * Zero on success, error code on failure.
1166 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1167 unsigned long possible_crtcs,
1168 const struct drm_plane_funcs *funcs,
1169 const uint32_t *formats, uint32_t format_count,
1170 enum drm_plane_type type)
1172 struct drm_mode_config *config = &dev->mode_config;
1175 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1179 drm_modeset_lock_init(&plane->mutex);
1181 plane->base.properties = &plane->properties;
1183 plane->funcs = funcs;
1184 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
1186 if (!plane->format_types) {
1187 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1188 drm_mode_object_put(dev, &plane->base);
1192 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1193 plane->format_count = format_count;
1194 plane->possible_crtcs = possible_crtcs;
1197 list_add_tail(&plane->head, &config->plane_list);
1198 config->num_total_plane++;
1199 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1200 config->num_overlay_plane++;
1202 drm_object_attach_property(&plane->base,
1203 config->plane_type_property,
1206 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
1207 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
1208 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
1209 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
1210 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
1211 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
1212 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
1213 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
1214 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
1215 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
1216 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
1221 EXPORT_SYMBOL(drm_universal_plane_init);
1224 * drm_plane_init - Initialize a legacy plane
1226 * @plane: plane object to init
1227 * @possible_crtcs: bitmask of possible CRTCs
1228 * @funcs: callbacks for the new plane
1229 * @formats: array of supported formats (%DRM_FORMAT_*)
1230 * @format_count: number of elements in @formats
1231 * @is_primary: plane type (primary vs overlay)
1233 * Legacy API to initialize a DRM plane.
1235 * New drivers should call drm_universal_plane_init() instead.
1238 * Zero on success, error code on failure.
1240 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1241 unsigned long possible_crtcs,
1242 const struct drm_plane_funcs *funcs,
1243 const uint32_t *formats, uint32_t format_count,
1246 enum drm_plane_type type;
1248 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1249 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1250 formats, format_count, type);
1252 EXPORT_SYMBOL(drm_plane_init);
1255 * drm_plane_cleanup - Clean up the core plane usage
1256 * @plane: plane to cleanup
1258 * This function cleans up @plane and removes it from the DRM mode setting
1259 * core. Note that the function does *not* free the plane structure itself,
1260 * this is the responsibility of the caller.
1262 void drm_plane_cleanup(struct drm_plane *plane)
1264 struct drm_device *dev = plane->dev;
1266 drm_modeset_lock_all(dev);
1267 kfree(plane->format_types);
1268 drm_mode_object_put(dev, &plane->base);
1270 BUG_ON(list_empty(&plane->head));
1272 list_del(&plane->head);
1273 dev->mode_config.num_total_plane--;
1274 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1275 dev->mode_config.num_overlay_plane--;
1276 drm_modeset_unlock_all(dev);
1278 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1279 if (plane->state && plane->funcs->atomic_destroy_state)
1280 plane->funcs->atomic_destroy_state(plane, plane->state);
1282 memset(plane, 0, sizeof(*plane));
1284 EXPORT_SYMBOL(drm_plane_cleanup);
1287 * drm_plane_index - find the index of a registered plane
1288 * @plane: plane to find index for
1290 * Given a registered plane, return the index of that CRTC within a DRM
1291 * device's list of planes.
1293 unsigned int drm_plane_index(struct drm_plane *plane)
1295 unsigned int index = 0;
1296 struct drm_plane *tmp;
1298 list_for_each_entry(tmp, &plane->dev->mode_config.plane_list, head) {
1307 EXPORT_SYMBOL(drm_plane_index);
1310 * drm_plane_force_disable - Forcibly disable a plane
1311 * @plane: plane to disable
1313 * Forces the plane to be disabled.
1315 * Used when the plane's current framebuffer is destroyed,
1316 * and when restoring fbdev mode.
1318 void drm_plane_force_disable(struct drm_plane *plane)
1325 plane->old_fb = plane->fb;
1326 ret = plane->funcs->disable_plane(plane);
1328 DRM_ERROR("failed to disable plane with busy fb\n");
1329 plane->old_fb = NULL;
1332 /* disconnect the plane from the fb and crtc: */
1333 __drm_framebuffer_unreference(plane->old_fb);
1334 plane->old_fb = NULL;
1338 EXPORT_SYMBOL(drm_plane_force_disable);
1340 static int drm_mode_create_standard_properties(struct drm_device *dev)
1342 struct drm_property *prop;
1345 * Standard properties (apply to all connectors)
1347 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1348 DRM_MODE_PROP_IMMUTABLE,
1352 dev->mode_config.edid_property = prop;
1354 prop = drm_property_create_enum(dev, 0,
1355 "DPMS", drm_dpms_enum_list,
1356 ARRAY_SIZE(drm_dpms_enum_list));
1359 dev->mode_config.dpms_property = prop;
1361 prop = drm_property_create(dev,
1362 DRM_MODE_PROP_BLOB |
1363 DRM_MODE_PROP_IMMUTABLE,
1367 dev->mode_config.path_property = prop;
1369 prop = drm_property_create(dev,
1370 DRM_MODE_PROP_BLOB |
1371 DRM_MODE_PROP_IMMUTABLE,
1375 dev->mode_config.tile_property = prop;
1377 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1378 "type", drm_plane_type_enum_list,
1379 ARRAY_SIZE(drm_plane_type_enum_list));
1382 dev->mode_config.plane_type_property = prop;
1384 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1385 "SRC_X", 0, UINT_MAX);
1388 dev->mode_config.prop_src_x = prop;
1390 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1391 "SRC_Y", 0, UINT_MAX);
1394 dev->mode_config.prop_src_y = prop;
1396 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1397 "SRC_W", 0, UINT_MAX);
1400 dev->mode_config.prop_src_w = prop;
1402 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1403 "SRC_H", 0, UINT_MAX);
1406 dev->mode_config.prop_src_h = prop;
1408 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1409 "CRTC_X", INT_MIN, INT_MAX);
1412 dev->mode_config.prop_crtc_x = prop;
1414 prop = drm_property_create_signed_range(dev, DRM_MODE_PROP_ATOMIC,
1415 "CRTC_Y", INT_MIN, INT_MAX);
1418 dev->mode_config.prop_crtc_y = prop;
1420 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1421 "CRTC_W", 0, INT_MAX);
1424 dev->mode_config.prop_crtc_w = prop;
1426 prop = drm_property_create_range(dev, DRM_MODE_PROP_ATOMIC,
1427 "CRTC_H", 0, INT_MAX);
1430 dev->mode_config.prop_crtc_h = prop;
1432 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1433 "FB_ID", DRM_MODE_OBJECT_FB);
1436 dev->mode_config.prop_fb_id = prop;
1438 prop = drm_property_create_object(dev, DRM_MODE_PROP_ATOMIC,
1439 "CRTC_ID", DRM_MODE_OBJECT_CRTC);
1442 dev->mode_config.prop_crtc_id = prop;
1448 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1451 * Called by a driver the first time a DVI-I connector is made.
1453 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1455 struct drm_property *dvi_i_selector;
1456 struct drm_property *dvi_i_subconnector;
1458 if (dev->mode_config.dvi_i_select_subconnector_property)
1462 drm_property_create_enum(dev, 0,
1463 "select subconnector",
1464 drm_dvi_i_select_enum_list,
1465 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1466 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1468 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1470 drm_dvi_i_subconnector_enum_list,
1471 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1472 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1476 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1479 * drm_create_tv_properties - create TV specific connector properties
1481 * @num_modes: number of different TV formats (modes) supported
1482 * @modes: array of pointers to strings containing name of each format
1484 * Called by a driver's TV initialization routine, this function creates
1485 * the TV specific connector properties for a given device. Caller is
1486 * responsible for allocating a list of format names and passing them to
1489 int drm_mode_create_tv_properties(struct drm_device *dev,
1490 unsigned int num_modes,
1493 struct drm_property *tv_selector;
1494 struct drm_property *tv_subconnector;
1497 if (dev->mode_config.tv_select_subconnector_property)
1501 * Basic connector properties
1503 tv_selector = drm_property_create_enum(dev, 0,
1504 "select subconnector",
1505 drm_tv_select_enum_list,
1506 ARRAY_SIZE(drm_tv_select_enum_list));
1507 dev->mode_config.tv_select_subconnector_property = tv_selector;
1510 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1512 drm_tv_subconnector_enum_list,
1513 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1514 dev->mode_config.tv_subconnector_property = tv_subconnector;
1517 * Other, TV specific properties: margins & TV modes.
1519 dev->mode_config.tv_left_margin_property =
1520 drm_property_create_range(dev, 0, "left margin", 0, 100);
1522 dev->mode_config.tv_right_margin_property =
1523 drm_property_create_range(dev, 0, "right margin", 0, 100);
1525 dev->mode_config.tv_top_margin_property =
1526 drm_property_create_range(dev, 0, "top margin", 0, 100);
1528 dev->mode_config.tv_bottom_margin_property =
1529 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1531 dev->mode_config.tv_mode_property =
1532 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1534 for (i = 0; i < num_modes; i++)
1535 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1538 dev->mode_config.tv_brightness_property =
1539 drm_property_create_range(dev, 0, "brightness", 0, 100);
1541 dev->mode_config.tv_contrast_property =
1542 drm_property_create_range(dev, 0, "contrast", 0, 100);
1544 dev->mode_config.tv_flicker_reduction_property =
1545 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1547 dev->mode_config.tv_overscan_property =
1548 drm_property_create_range(dev, 0, "overscan", 0, 100);
1550 dev->mode_config.tv_saturation_property =
1551 drm_property_create_range(dev, 0, "saturation", 0, 100);
1553 dev->mode_config.tv_hue_property =
1554 drm_property_create_range(dev, 0, "hue", 0, 100);
1558 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1561 * drm_mode_create_scaling_mode_property - create scaling mode property
1564 * Called by a driver the first time it's needed, must be attached to desired
1567 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1569 struct drm_property *scaling_mode;
1571 if (dev->mode_config.scaling_mode_property)
1575 drm_property_create_enum(dev, 0, "scaling mode",
1576 drm_scaling_mode_enum_list,
1577 ARRAY_SIZE(drm_scaling_mode_enum_list));
1579 dev->mode_config.scaling_mode_property = scaling_mode;
1583 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1586 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1589 * Called by a driver the first time it's needed, must be attached to desired
1593 * Zero on success, negative errno on failure.
1595 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1597 if (dev->mode_config.aspect_ratio_property)
1600 dev->mode_config.aspect_ratio_property =
1601 drm_property_create_enum(dev, 0, "aspect ratio",
1602 drm_aspect_ratio_enum_list,
1603 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1605 if (dev->mode_config.aspect_ratio_property == NULL)
1610 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1613 * drm_mode_create_dirty_property - create dirty property
1616 * Called by a driver the first time it's needed, must be attached to desired
1619 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1621 struct drm_property *dirty_info;
1623 if (dev->mode_config.dirty_info_property)
1627 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1629 drm_dirty_info_enum_list,
1630 ARRAY_SIZE(drm_dirty_info_enum_list));
1631 dev->mode_config.dirty_info_property = dirty_info;
1635 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1638 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1641 * Create the the suggested x/y offset property for connectors.
1643 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1645 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1648 dev->mode_config.suggested_x_property =
1649 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1651 dev->mode_config.suggested_y_property =
1652 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1654 if (dev->mode_config.suggested_x_property == NULL ||
1655 dev->mode_config.suggested_y_property == NULL)
1659 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1661 static int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
1663 uint32_t total_objects = 0;
1665 total_objects += dev->mode_config.num_crtc;
1666 total_objects += dev->mode_config.num_connector;
1667 total_objects += dev->mode_config.num_encoder;
1668 total_objects += dev->mode_config.num_bridge;
1670 group->id_list = kcalloc(total_objects, sizeof(uint32_t), GFP_KERNEL);
1671 if (!group->id_list)
1674 group->num_crtcs = 0;
1675 group->num_connectors = 0;
1676 group->num_encoders = 0;
1677 group->num_bridges = 0;
1681 void drm_mode_group_destroy(struct drm_mode_group *group)
1683 kfree(group->id_list);
1684 group->id_list = NULL;
1688 * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1689 * the drm core's responsibility to set up mode control groups.
1691 int drm_mode_group_init_legacy_group(struct drm_device *dev,
1692 struct drm_mode_group *group)
1694 struct drm_crtc *crtc;
1695 struct drm_encoder *encoder;
1696 struct drm_connector *connector;
1697 struct drm_bridge *bridge;
1700 ret = drm_mode_group_init(dev, group);
1704 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
1705 group->id_list[group->num_crtcs++] = crtc->base.id;
1707 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
1708 group->id_list[group->num_crtcs + group->num_encoders++] =
1711 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1712 group->id_list[group->num_crtcs + group->num_encoders +
1713 group->num_connectors++] = connector->base.id;
1715 list_for_each_entry(bridge, &dev->mode_config.bridge_list, head)
1716 group->id_list[group->num_crtcs + group->num_encoders +
1717 group->num_connectors + group->num_bridges++] =
1722 EXPORT_SYMBOL(drm_mode_group_init_legacy_group);
1724 void drm_reinit_primary_mode_group(struct drm_device *dev)
1726 drm_modeset_lock_all(dev);
1727 drm_mode_group_destroy(&dev->primary->mode_group);
1728 drm_mode_group_init_legacy_group(dev, &dev->primary->mode_group);
1729 drm_modeset_unlock_all(dev);
1731 EXPORT_SYMBOL(drm_reinit_primary_mode_group);
1734 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1735 * @out: drm_mode_modeinfo struct to return to the user
1736 * @in: drm_display_mode to use
1738 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1741 static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
1742 const struct drm_display_mode *in)
1744 WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1745 in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1746 in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1747 in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1748 in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1749 "timing values too large for mode info\n");
1751 out->clock = in->clock;
1752 out->hdisplay = in->hdisplay;
1753 out->hsync_start = in->hsync_start;
1754 out->hsync_end = in->hsync_end;
1755 out->htotal = in->htotal;
1756 out->hskew = in->hskew;
1757 out->vdisplay = in->vdisplay;
1758 out->vsync_start = in->vsync_start;
1759 out->vsync_end = in->vsync_end;
1760 out->vtotal = in->vtotal;
1761 out->vscan = in->vscan;
1762 out->vrefresh = in->vrefresh;
1763 out->flags = in->flags;
1764 out->type = in->type;
1765 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1766 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1770 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1771 * @out: drm_display_mode to return to the user
1772 * @in: drm_mode_modeinfo to use
1774 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1778 * Zero on success, negative errno on failure.
1780 static int drm_crtc_convert_umode(struct drm_display_mode *out,
1781 const struct drm_mode_modeinfo *in)
1783 if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1786 if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1789 out->clock = in->clock;
1790 out->hdisplay = in->hdisplay;
1791 out->hsync_start = in->hsync_start;
1792 out->hsync_end = in->hsync_end;
1793 out->htotal = in->htotal;
1794 out->hskew = in->hskew;
1795 out->vdisplay = in->vdisplay;
1796 out->vsync_start = in->vsync_start;
1797 out->vsync_end = in->vsync_end;
1798 out->vtotal = in->vtotal;
1799 out->vscan = in->vscan;
1800 out->vrefresh = in->vrefresh;
1801 out->flags = in->flags;
1802 out->type = in->type;
1803 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1804 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1810 * drm_mode_getresources - get graphics configuration
1811 * @dev: drm device for the ioctl
1812 * @data: data pointer for the ioctl
1813 * @file_priv: drm file for the ioctl call
1815 * Construct a set of configuration description structures and return
1816 * them to the user, including CRTC, connector and framebuffer configuration.
1818 * Called by the user via ioctl.
1821 * Zero on success, negative errno on failure.
1823 int drm_mode_getresources(struct drm_device *dev, void *data,
1824 struct drm_file *file_priv)
1826 struct drm_mode_card_res *card_res = data;
1827 struct list_head *lh;
1828 struct drm_framebuffer *fb;
1829 struct drm_connector *connector;
1830 struct drm_crtc *crtc;
1831 struct drm_encoder *encoder;
1833 int connector_count = 0;
1836 int encoder_count = 0;
1838 uint32_t __user *fb_id;
1839 uint32_t __user *crtc_id;
1840 uint32_t __user *connector_id;
1841 uint32_t __user *encoder_id;
1842 struct drm_mode_group *mode_group;
1844 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1848 mutex_lock(&file_priv->fbs_lock);
1850 * For the non-control nodes we need to limit the list of resources
1851 * by IDs in the group list for this node
1853 list_for_each(lh, &file_priv->fbs)
1856 /* handle this in 4 parts */
1858 if (card_res->count_fbs >= fb_count) {
1860 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1861 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1862 if (put_user(fb->base.id, fb_id + copied)) {
1863 mutex_unlock(&file_priv->fbs_lock);
1869 card_res->count_fbs = fb_count;
1870 mutex_unlock(&file_priv->fbs_lock);
1872 /* mode_config.mutex protects the connector list against e.g. DP MST
1873 * connector hot-adding. CRTC/Plane lists are invariant. */
1874 mutex_lock(&dev->mode_config.mutex);
1875 if (!drm_is_primary_client(file_priv)) {
1878 list_for_each(lh, &dev->mode_config.crtc_list)
1881 list_for_each(lh, &dev->mode_config.connector_list)
1884 list_for_each(lh, &dev->mode_config.encoder_list)
1888 mode_group = &file_priv->master->minor->mode_group;
1889 crtc_count = mode_group->num_crtcs;
1890 connector_count = mode_group->num_connectors;
1891 encoder_count = mode_group->num_encoders;
1894 card_res->max_height = dev->mode_config.max_height;
1895 card_res->min_height = dev->mode_config.min_height;
1896 card_res->max_width = dev->mode_config.max_width;
1897 card_res->min_width = dev->mode_config.min_width;
1900 if (card_res->count_crtcs >= crtc_count) {
1902 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1904 list_for_each_entry(crtc, &dev->mode_config.crtc_list,
1906 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1907 if (put_user(crtc->base.id, crtc_id + copied)) {
1914 for (i = 0; i < mode_group->num_crtcs; i++) {
1915 if (put_user(mode_group->id_list[i],
1916 crtc_id + copied)) {
1924 card_res->count_crtcs = crtc_count;
1927 if (card_res->count_encoders >= encoder_count) {
1929 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1931 list_for_each_entry(encoder,
1932 &dev->mode_config.encoder_list,
1934 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1936 if (put_user(encoder->base.id, encoder_id +
1944 for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
1945 if (put_user(mode_group->id_list[i],
1946 encoder_id + copied)) {
1955 card_res->count_encoders = encoder_count;
1958 if (card_res->count_connectors >= connector_count) {
1960 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1962 list_for_each_entry(connector,
1963 &dev->mode_config.connector_list,
1965 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1968 if (put_user(connector->base.id,
1969 connector_id + copied)) {
1976 int start = mode_group->num_crtcs +
1977 mode_group->num_encoders;
1978 for (i = start; i < start + mode_group->num_connectors; i++) {
1979 if (put_user(mode_group->id_list[i],
1980 connector_id + copied)) {
1988 card_res->count_connectors = connector_count;
1990 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1991 card_res->count_connectors, card_res->count_encoders);
1994 mutex_unlock(&dev->mode_config.mutex);
1999 * drm_mode_getcrtc - get CRTC configuration
2000 * @dev: drm device for the ioctl
2001 * @data: data pointer for the ioctl
2002 * @file_priv: drm file for the ioctl call
2004 * Construct a CRTC configuration structure to return to the user.
2006 * Called by the user via ioctl.
2009 * Zero on success, negative errno on failure.
2011 int drm_mode_getcrtc(struct drm_device *dev,
2012 void *data, struct drm_file *file_priv)
2014 struct drm_mode_crtc *crtc_resp = data;
2015 struct drm_crtc *crtc;
2017 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2020 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
2024 drm_modeset_lock_crtc(crtc, crtc->primary);
2025 crtc_resp->x = crtc->x;
2026 crtc_resp->y = crtc->y;
2027 crtc_resp->gamma_size = crtc->gamma_size;
2028 if (crtc->primary->fb)
2029 crtc_resp->fb_id = crtc->primary->fb->base.id;
2031 crtc_resp->fb_id = 0;
2033 if (crtc->enabled) {
2035 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
2036 crtc_resp->mode_valid = 1;
2039 crtc_resp->mode_valid = 0;
2041 drm_modeset_unlock_crtc(crtc);
2046 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2047 const struct drm_file *file_priv)
2050 * If user-space hasn't configured the driver to expose the stereo 3D
2051 * modes, don't expose them.
2053 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2059 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2061 /* For atomic drivers only state objects are synchronously updated and
2062 * protected by modeset locks, so check those first. */
2063 if (connector->state)
2064 return connector->state->best_encoder;
2065 return connector->encoder;
2068 /* helper for getconnector and getproperties ioctls */
2069 static int get_properties(struct drm_mode_object *obj, bool atomic,
2070 uint32_t __user *prop_ptr, uint64_t __user *prop_values,
2071 uint32_t *arg_count_props)
2076 props_count = obj->properties->count;
2078 props_count -= obj->properties->atomic_count;
2080 if ((*arg_count_props >= props_count) && props_count) {
2081 for (i = 0, copied = 0; copied < props_count; i++) {
2082 struct drm_property *prop = obj->properties->properties[i];
2085 if ((prop->flags & DRM_MODE_PROP_ATOMIC) && !atomic)
2088 ret = drm_object_property_get_value(obj, prop, &val);
2092 if (put_user(prop->base.id, prop_ptr + copied))
2095 if (put_user(val, prop_values + copied))
2101 *arg_count_props = props_count;
2107 * drm_mode_getconnector - get connector configuration
2108 * @dev: drm device for the ioctl
2109 * @data: data pointer for the ioctl
2110 * @file_priv: drm file for the ioctl call
2112 * Construct a connector configuration structure to return to the user.
2114 * Called by the user via ioctl.
2117 * Zero on success, negative errno on failure.
2119 int drm_mode_getconnector(struct drm_device *dev, void *data,
2120 struct drm_file *file_priv)
2122 struct drm_mode_get_connector *out_resp = data;
2123 struct drm_connector *connector;
2124 struct drm_encoder *encoder;
2125 struct drm_display_mode *mode;
2127 int encoders_count = 0;
2131 struct drm_mode_modeinfo u_mode;
2132 struct drm_mode_modeinfo __user *mode_ptr;
2133 uint32_t __user *encoder_ptr;
2135 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2138 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2140 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2142 mutex_lock(&dev->mode_config.mutex);
2143 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2145 connector = drm_connector_find(dev, out_resp->connector_id);
2151 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++)
2152 if (connector->encoder_ids[i] != 0)
2155 if (out_resp->count_modes == 0) {
2156 connector->funcs->fill_modes(connector,
2157 dev->mode_config.max_width,
2158 dev->mode_config.max_height);
2161 /* delayed so we get modes regardless of pre-fill_modes state */
2162 list_for_each_entry(mode, &connector->modes, head)
2163 if (drm_mode_expose_to_userspace(mode, file_priv))
2166 out_resp->connector_id = connector->base.id;
2167 out_resp->connector_type = connector->connector_type;
2168 out_resp->connector_type_id = connector->connector_type_id;
2169 out_resp->mm_width = connector->display_info.width_mm;
2170 out_resp->mm_height = connector->display_info.height_mm;
2171 out_resp->subpixel = connector->display_info.subpixel_order;
2172 out_resp->connection = connector->status;
2173 encoder = drm_connector_get_encoder(connector);
2175 out_resp->encoder_id = encoder->base.id;
2177 out_resp->encoder_id = 0;
2180 * This ioctl is called twice, once to determine how much space is
2181 * needed, and the 2nd time to fill it.
2183 if ((out_resp->count_modes >= mode_count) && mode_count) {
2185 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2186 list_for_each_entry(mode, &connector->modes, head) {
2187 if (!drm_mode_expose_to_userspace(mode, file_priv))
2190 drm_crtc_convert_to_umode(&u_mode, mode);
2191 if (copy_to_user(mode_ptr + copied,
2192 &u_mode, sizeof(u_mode))) {
2199 out_resp->count_modes = mode_count;
2201 ret = get_properties(&connector->base, file_priv->atomic,
2202 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2203 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2204 &out_resp->count_props);
2208 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2210 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2211 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2212 if (connector->encoder_ids[i] != 0) {
2213 if (put_user(connector->encoder_ids[i],
2214 encoder_ptr + copied)) {
2222 out_resp->count_encoders = encoders_count;
2225 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2226 mutex_unlock(&dev->mode_config.mutex);
2231 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2233 struct drm_connector *connector;
2234 struct drm_device *dev = encoder->dev;
2235 bool uses_atomic = false;
2237 /* For atomic drivers only state objects are synchronously updated and
2238 * protected by modeset locks, so check those first. */
2239 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
2240 if (!connector->state)
2245 if (connector->state->best_encoder != encoder)
2248 return connector->state->crtc;
2251 /* Don't return stale data (e.g. pending async disable). */
2255 return encoder->crtc;
2259 * drm_mode_getencoder - get encoder configuration
2260 * @dev: drm device for the ioctl
2261 * @data: data pointer for the ioctl
2262 * @file_priv: drm file for the ioctl call
2264 * Construct a encoder configuration structure to return to the user.
2266 * Called by the user via ioctl.
2269 * Zero on success, negative errno on failure.
2271 int drm_mode_getencoder(struct drm_device *dev, void *data,
2272 struct drm_file *file_priv)
2274 struct drm_mode_get_encoder *enc_resp = data;
2275 struct drm_encoder *encoder;
2276 struct drm_crtc *crtc;
2278 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2281 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2285 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2286 crtc = drm_encoder_get_crtc(encoder);
2288 enc_resp->crtc_id = crtc->base.id;
2289 else if (encoder->crtc)
2290 enc_resp->crtc_id = encoder->crtc->base.id;
2292 enc_resp->crtc_id = 0;
2293 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2295 enc_resp->encoder_type = encoder->encoder_type;
2296 enc_resp->encoder_id = encoder->base.id;
2297 enc_resp->possible_crtcs = encoder->possible_crtcs;
2298 enc_resp->possible_clones = encoder->possible_clones;
2304 * drm_mode_getplane_res - enumerate all plane resources
2307 * @file_priv: DRM file info
2309 * Construct a list of plane ids to return to the user.
2311 * Called by the user via ioctl.
2314 * Zero on success, negative errno on failure.
2316 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2317 struct drm_file *file_priv)
2319 struct drm_mode_get_plane_res *plane_resp = data;
2320 struct drm_mode_config *config;
2321 struct drm_plane *plane;
2322 uint32_t __user *plane_ptr;
2324 unsigned num_planes;
2326 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2329 config = &dev->mode_config;
2331 if (file_priv->universal_planes)
2332 num_planes = config->num_total_plane;
2334 num_planes = config->num_overlay_plane;
2337 * This ioctl is called twice, once to determine how much space is
2338 * needed, and the 2nd time to fill it.
2341 (plane_resp->count_planes >= num_planes)) {
2342 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2344 /* Plane lists are invariant, no locking needed. */
2345 list_for_each_entry(plane, &config->plane_list, head) {
2347 * Unless userspace set the 'universal planes'
2348 * capability bit, only advertise overlays.
2350 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2351 !file_priv->universal_planes)
2354 if (put_user(plane->base.id, plane_ptr + copied))
2359 plane_resp->count_planes = num_planes;
2365 * drm_mode_getplane - get plane configuration
2368 * @file_priv: DRM file info
2370 * Construct a plane configuration structure to return to the user.
2372 * Called by the user via ioctl.
2375 * Zero on success, negative errno on failure.
2377 int drm_mode_getplane(struct drm_device *dev, void *data,
2378 struct drm_file *file_priv)
2380 struct drm_mode_get_plane *plane_resp = data;
2381 struct drm_plane *plane;
2382 uint32_t __user *format_ptr;
2384 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2387 plane = drm_plane_find(dev, plane_resp->plane_id);
2391 drm_modeset_lock(&plane->mutex, NULL);
2393 plane_resp->crtc_id = plane->crtc->base.id;
2395 plane_resp->crtc_id = 0;
2398 plane_resp->fb_id = plane->fb->base.id;
2400 plane_resp->fb_id = 0;
2401 drm_modeset_unlock(&plane->mutex);
2403 plane_resp->plane_id = plane->base.id;
2404 plane_resp->possible_crtcs = plane->possible_crtcs;
2405 plane_resp->gamma_size = 0;
2408 * This ioctl is called twice, once to determine how much space is
2409 * needed, and the 2nd time to fill it.
2411 if (plane->format_count &&
2412 (plane_resp->count_format_types >= plane->format_count)) {
2413 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2414 if (copy_to_user(format_ptr,
2415 plane->format_types,
2416 sizeof(uint32_t) * plane->format_count)) {
2420 plane_resp->count_format_types = plane->format_count;
2426 * setplane_internal - setplane handler for internal callers
2428 * Note that we assume an extra reference has already been taken on fb. If the
2429 * update fails, this reference will be dropped before return; if it succeeds,
2430 * the previous framebuffer (if any) will be unreferenced instead.
2432 * src_{x,y,w,h} are provided in 16.16 fixed point format
2434 static int __setplane_internal(struct drm_plane *plane,
2435 struct drm_crtc *crtc,
2436 struct drm_framebuffer *fb,
2437 int32_t crtc_x, int32_t crtc_y,
2438 uint32_t crtc_w, uint32_t crtc_h,
2439 /* src_{x,y,w,h} values are 16.16 fixed point */
2440 uint32_t src_x, uint32_t src_y,
2441 uint32_t src_w, uint32_t src_h)
2444 unsigned int fb_width, fb_height;
2447 /* No fb means shut it down */
2449 plane->old_fb = plane->fb;
2450 ret = plane->funcs->disable_plane(plane);
2455 plane->old_fb = NULL;
2460 /* Check whether this plane is usable on this CRTC */
2461 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2462 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2467 /* Check whether this plane supports the fb pixel format. */
2468 for (i = 0; i < plane->format_count; i++)
2469 if (fb->pixel_format == plane->format_types[i])
2471 if (i == plane->format_count) {
2472 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2473 drm_get_format_name(fb->pixel_format));
2478 fb_width = fb->width << 16;
2479 fb_height = fb->height << 16;
2481 /* Make sure source coordinates are inside the fb. */
2482 if (src_w > fb_width ||
2483 src_x > fb_width - src_w ||
2484 src_h > fb_height ||
2485 src_y > fb_height - src_h) {
2486 DRM_DEBUG_KMS("Invalid source coordinates "
2487 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2488 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2489 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2490 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2491 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2496 plane->old_fb = plane->fb;
2497 ret = plane->funcs->update_plane(plane, crtc, fb,
2498 crtc_x, crtc_y, crtc_w, crtc_h,
2499 src_x, src_y, src_w, src_h);
2505 plane->old_fb = NULL;
2510 drm_framebuffer_unreference(fb);
2512 drm_framebuffer_unreference(plane->old_fb);
2513 plane->old_fb = NULL;
2518 static int setplane_internal(struct drm_plane *plane,
2519 struct drm_crtc *crtc,
2520 struct drm_framebuffer *fb,
2521 int32_t crtc_x, int32_t crtc_y,
2522 uint32_t crtc_w, uint32_t crtc_h,
2523 /* src_{x,y,w,h} values are 16.16 fixed point */
2524 uint32_t src_x, uint32_t src_y,
2525 uint32_t src_w, uint32_t src_h)
2529 drm_modeset_lock_all(plane->dev);
2530 ret = __setplane_internal(plane, crtc, fb,
2531 crtc_x, crtc_y, crtc_w, crtc_h,
2532 src_x, src_y, src_w, src_h);
2533 drm_modeset_unlock_all(plane->dev);
2539 * drm_mode_setplane - configure a plane's configuration
2541 * @data: ioctl data*
2542 * @file_priv: DRM file info
2544 * Set plane configuration, including placement, fb, scaling, and other factors.
2545 * Or pass a NULL fb to disable (planes may be disabled without providing a
2549 * Zero on success, negative errno on failure.
2551 int drm_mode_setplane(struct drm_device *dev, void *data,
2552 struct drm_file *file_priv)
2554 struct drm_mode_set_plane *plane_req = data;
2555 struct drm_plane *plane;
2556 struct drm_crtc *crtc = NULL;
2557 struct drm_framebuffer *fb = NULL;
2559 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2562 /* Give drivers some help against integer overflows */
2563 if (plane_req->crtc_w > INT_MAX ||
2564 plane_req->crtc_x > INT_MAX - (int32_t) plane_req->crtc_w ||
2565 plane_req->crtc_h > INT_MAX ||
2566 plane_req->crtc_y > INT_MAX - (int32_t) plane_req->crtc_h) {
2567 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2568 plane_req->crtc_w, plane_req->crtc_h,
2569 plane_req->crtc_x, plane_req->crtc_y);
2574 * First, find the plane, crtc, and fb objects. If not available,
2575 * we don't bother to call the driver.
2577 plane = drm_plane_find(dev, plane_req->plane_id);
2579 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2580 plane_req->plane_id);
2584 if (plane_req->fb_id) {
2585 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2587 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2592 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2594 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2595 plane_req->crtc_id);
2601 * setplane_internal will take care of deref'ing either the old or new
2602 * framebuffer depending on success.
2604 return setplane_internal(plane, crtc, fb,
2605 plane_req->crtc_x, plane_req->crtc_y,
2606 plane_req->crtc_w, plane_req->crtc_h,
2607 plane_req->src_x, plane_req->src_y,
2608 plane_req->src_w, plane_req->src_h);
2612 * drm_mode_set_config_internal - helper to call ->set_config
2613 * @set: modeset config to set
2615 * This is a little helper to wrap internal calls to the ->set_config driver
2616 * interface. The only thing it adds is correct refcounting dance.
2619 * Zero on success, negative errno on failure.
2621 int drm_mode_set_config_internal(struct drm_mode_set *set)
2623 struct drm_crtc *crtc = set->crtc;
2624 struct drm_framebuffer *fb;
2625 struct drm_crtc *tmp;
2629 * NOTE: ->set_config can also disable other crtcs (if we steal all
2630 * connectors from it), hence we need to refcount the fbs across all
2631 * crtcs. Atomic modeset will have saner semantics ...
2633 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head)
2634 tmp->primary->old_fb = tmp->primary->fb;
2638 ret = crtc->funcs->set_config(set);
2640 crtc->primary->crtc = crtc;
2641 crtc->primary->fb = fb;
2644 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
2645 if (tmp->primary->fb)
2646 drm_framebuffer_reference(tmp->primary->fb);
2647 if (tmp->primary->old_fb)
2648 drm_framebuffer_unreference(tmp->primary->old_fb);
2649 tmp->primary->old_fb = NULL;
2654 EXPORT_SYMBOL(drm_mode_set_config_internal);
2657 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2659 * @crtc: CRTC that framebuffer will be displayed on
2662 * @mode: mode that framebuffer will be displayed under
2663 * @fb: framebuffer to check size of
2665 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2667 const struct drm_display_mode *mode,
2668 const struct drm_framebuffer *fb)
2671 int hdisplay, vdisplay;
2673 hdisplay = mode->hdisplay;
2674 vdisplay = mode->vdisplay;
2676 if (drm_mode_is_stereo(mode)) {
2677 struct drm_display_mode adjusted = *mode;
2679 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE);
2680 hdisplay = adjusted.crtc_hdisplay;
2681 vdisplay = adjusted.crtc_vdisplay;
2684 if (crtc->invert_dimensions)
2685 swap(hdisplay, vdisplay);
2687 if (hdisplay > fb->width ||
2688 vdisplay > fb->height ||
2689 x > fb->width - hdisplay ||
2690 y > fb->height - vdisplay) {
2691 DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2692 fb->width, fb->height, hdisplay, vdisplay, x, y,
2693 crtc->invert_dimensions ? " (inverted)" : "");
2699 EXPORT_SYMBOL(drm_crtc_check_viewport);
2702 * drm_mode_setcrtc - set CRTC configuration
2703 * @dev: drm device for the ioctl
2704 * @data: data pointer for the ioctl
2705 * @file_priv: drm file for the ioctl call
2707 * Build a new CRTC configuration based on user request.
2709 * Called by the user via ioctl.
2712 * Zero on success, negative errno on failure.
2714 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2715 struct drm_file *file_priv)
2717 struct drm_mode_config *config = &dev->mode_config;
2718 struct drm_mode_crtc *crtc_req = data;
2719 struct drm_crtc *crtc;
2720 struct drm_connector **connector_set = NULL, *connector;
2721 struct drm_framebuffer *fb = NULL;
2722 struct drm_display_mode *mode = NULL;
2723 struct drm_mode_set set;
2724 uint32_t __user *set_connectors_ptr;
2728 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2731 /* For some reason crtc x/y offsets are signed internally. */
2732 if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
2735 drm_modeset_lock_all(dev);
2736 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2738 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2742 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2744 if (crtc_req->mode_valid) {
2745 /* If we have a mode we need a framebuffer. */
2746 /* If we pass -1, set the mode with the currently bound fb */
2747 if (crtc_req->fb_id == -1) {
2748 if (!crtc->primary->fb) {
2749 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2753 fb = crtc->primary->fb;
2754 /* Make refcounting symmetric with the lookup path. */
2755 drm_framebuffer_reference(fb);
2757 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2759 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2766 mode = drm_mode_create(dev);
2772 ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
2774 DRM_DEBUG_KMS("Invalid mode\n");
2778 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2780 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2787 if (crtc_req->count_connectors == 0 && mode) {
2788 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2793 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2794 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2795 crtc_req->count_connectors);
2800 if (crtc_req->count_connectors > 0) {
2803 /* Avoid unbounded kernel memory allocation */
2804 if (crtc_req->count_connectors > config->num_connector) {
2809 connector_set = kmalloc_array(crtc_req->count_connectors,
2810 sizeof(struct drm_connector *),
2812 if (!connector_set) {
2817 for (i = 0; i < crtc_req->count_connectors; i++) {
2818 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2819 if (get_user(out_id, &set_connectors_ptr[i])) {
2824 connector = drm_connector_find(dev, out_id);
2826 DRM_DEBUG_KMS("Connector id %d unknown\n",
2831 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2835 connector_set[i] = connector;
2840 set.x = crtc_req->x;
2841 set.y = crtc_req->y;
2843 set.connectors = connector_set;
2844 set.num_connectors = crtc_req->count_connectors;
2846 ret = drm_mode_set_config_internal(&set);
2850 drm_framebuffer_unreference(fb);
2852 kfree(connector_set);
2853 drm_mode_destroy(dev, mode);
2854 drm_modeset_unlock_all(dev);
2859 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2860 * universal plane handler call
2861 * @crtc: crtc to update cursor for
2862 * @req: data pointer for the ioctl
2863 * @file_priv: drm file for the ioctl call
2865 * Legacy cursor ioctl's work directly with driver buffer handles. To
2866 * translate legacy ioctl calls into universal plane handler calls, we need to
2867 * wrap the native buffer handle in a drm_framebuffer.
2869 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2870 * buffer with a pitch of 4*width; the universal plane interface should be used
2871 * directly in cases where the hardware can support other buffer settings and
2872 * userspace wants to make use of these capabilities.
2875 * Zero on success, negative errno on failure.
2877 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2878 struct drm_mode_cursor2 *req,
2879 struct drm_file *file_priv)
2881 struct drm_device *dev = crtc->dev;
2882 struct drm_framebuffer *fb = NULL;
2883 struct drm_mode_fb_cmd2 fbreq = {
2884 .width = req->width,
2885 .height = req->height,
2886 .pixel_format = DRM_FORMAT_ARGB8888,
2887 .pitches = { req->width * 4 },
2888 .handles = { req->handle },
2890 int32_t crtc_x, crtc_y;
2891 uint32_t crtc_w = 0, crtc_h = 0;
2892 uint32_t src_w = 0, src_h = 0;
2895 BUG_ON(!crtc->cursor);
2896 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2899 * Obtain fb we'll be using (either new or existing) and take an extra
2900 * reference to it if fb != null. setplane will take care of dropping
2901 * the reference if the plane update fails.
2903 if (req->flags & DRM_MODE_CURSOR_BO) {
2905 fb = add_framebuffer_internal(dev, &fbreq, file_priv);
2907 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2911 drm_framebuffer_reference(fb);
2916 fb = crtc->cursor->fb;
2918 drm_framebuffer_reference(fb);
2921 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2925 crtc_x = crtc->cursor_x;
2926 crtc_y = crtc->cursor_y;
2931 crtc_h = fb->height;
2932 src_w = fb->width << 16;
2933 src_h = fb->height << 16;
2937 * setplane_internal will take care of deref'ing either the old or new
2938 * framebuffer depending on success.
2940 ret = __setplane_internal(crtc->cursor, crtc, fb,
2941 crtc_x, crtc_y, crtc_w, crtc_h,
2942 0, 0, src_w, src_h);
2944 /* Update successful; save new cursor position, if necessary */
2945 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
2946 crtc->cursor_x = req->x;
2947 crtc->cursor_y = req->y;
2953 static int drm_mode_cursor_common(struct drm_device *dev,
2954 struct drm_mode_cursor2 *req,
2955 struct drm_file *file_priv)
2957 struct drm_crtc *crtc;
2960 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2963 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
2966 crtc = drm_crtc_find(dev, req->crtc_id);
2968 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
2973 * If this crtc has a universal cursor plane, call that plane's update
2974 * handler rather than using legacy cursor handlers.
2976 drm_modeset_lock_crtc(crtc, crtc->cursor);
2978 ret = drm_mode_cursor_universal(crtc, req, file_priv);
2982 if (req->flags & DRM_MODE_CURSOR_BO) {
2983 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
2987 /* Turns off the cursor if handle is 0 */
2988 if (crtc->funcs->cursor_set2)
2989 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
2990 req->width, req->height, req->hot_x, req->hot_y);
2992 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
2993 req->width, req->height);
2996 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2997 if (crtc->funcs->cursor_move) {
2998 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
3005 drm_modeset_unlock_crtc(crtc);
3013 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
3014 * @dev: drm device for the ioctl
3015 * @data: data pointer for the ioctl
3016 * @file_priv: drm file for the ioctl call
3018 * Set the cursor configuration based on user request.
3020 * Called by the user via ioctl.
3023 * Zero on success, negative errno on failure.
3025 int drm_mode_cursor_ioctl(struct drm_device *dev,
3026 void *data, struct drm_file *file_priv)
3028 struct drm_mode_cursor *req = data;
3029 struct drm_mode_cursor2 new_req;
3031 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
3032 new_req.hot_x = new_req.hot_y = 0;
3034 return drm_mode_cursor_common(dev, &new_req, file_priv);
3038 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
3039 * @dev: drm device for the ioctl
3040 * @data: data pointer for the ioctl
3041 * @file_priv: drm file for the ioctl call
3043 * Set the cursor configuration based on user request. This implements the 2nd
3044 * version of the cursor ioctl, which allows userspace to additionally specify
3045 * the hotspot of the pointer.
3047 * Called by the user via ioctl.
3050 * Zero on success, negative errno on failure.
3052 int drm_mode_cursor2_ioctl(struct drm_device *dev,
3053 void *data, struct drm_file *file_priv)
3055 struct drm_mode_cursor2 *req = data;
3057 return drm_mode_cursor_common(dev, req, file_priv);
3061 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
3062 * @bpp: bits per pixels
3063 * @depth: bit depth per pixel
3065 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
3066 * Useful in fbdev emulation code, since that deals in those values.
3068 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
3074 fmt = DRM_FORMAT_C8;
3078 fmt = DRM_FORMAT_XRGB1555;
3080 fmt = DRM_FORMAT_RGB565;
3083 fmt = DRM_FORMAT_RGB888;
3087 fmt = DRM_FORMAT_XRGB8888;
3088 else if (depth == 30)
3089 fmt = DRM_FORMAT_XRGB2101010;
3091 fmt = DRM_FORMAT_ARGB8888;
3094 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3095 fmt = DRM_FORMAT_XRGB8888;
3101 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3104 * drm_mode_addfb - add an FB to the graphics configuration
3105 * @dev: drm device for the ioctl
3106 * @data: data pointer for the ioctl
3107 * @file_priv: drm file for the ioctl call
3109 * Add a new FB to the specified CRTC, given a user request. This is the
3110 * original addfb ioctl which only supported RGB formats.
3112 * Called by the user via ioctl.
3115 * Zero on success, negative errno on failure.
3117 int drm_mode_addfb(struct drm_device *dev,
3118 void *data, struct drm_file *file_priv)
3120 struct drm_mode_fb_cmd *or = data;
3121 struct drm_mode_fb_cmd2 r = {};
3124 /* convert to new format and call new ioctl */
3125 r.fb_id = or->fb_id;
3126 r.width = or->width;
3127 r.height = or->height;
3128 r.pitches[0] = or->pitch;
3129 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3130 r.handles[0] = or->handle;
3132 ret = drm_mode_addfb2(dev, &r, file_priv);
3136 or->fb_id = r.fb_id;
3141 static int format_check(const struct drm_mode_fb_cmd2 *r)
3143 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3147 case DRM_FORMAT_RGB332:
3148 case DRM_FORMAT_BGR233:
3149 case DRM_FORMAT_XRGB4444:
3150 case DRM_FORMAT_XBGR4444:
3151 case DRM_FORMAT_RGBX4444:
3152 case DRM_FORMAT_BGRX4444:
3153 case DRM_FORMAT_ARGB4444:
3154 case DRM_FORMAT_ABGR4444:
3155 case DRM_FORMAT_RGBA4444:
3156 case DRM_FORMAT_BGRA4444:
3157 case DRM_FORMAT_XRGB1555:
3158 case DRM_FORMAT_XBGR1555:
3159 case DRM_FORMAT_RGBX5551:
3160 case DRM_FORMAT_BGRX5551:
3161 case DRM_FORMAT_ARGB1555:
3162 case DRM_FORMAT_ABGR1555:
3163 case DRM_FORMAT_RGBA5551:
3164 case DRM_FORMAT_BGRA5551:
3165 case DRM_FORMAT_RGB565:
3166 case DRM_FORMAT_BGR565:
3167 case DRM_FORMAT_RGB888:
3168 case DRM_FORMAT_BGR888:
3169 case DRM_FORMAT_XRGB8888:
3170 case DRM_FORMAT_XBGR8888:
3171 case DRM_FORMAT_RGBX8888:
3172 case DRM_FORMAT_BGRX8888:
3173 case DRM_FORMAT_ARGB8888:
3174 case DRM_FORMAT_ABGR8888:
3175 case DRM_FORMAT_RGBA8888:
3176 case DRM_FORMAT_BGRA8888:
3177 case DRM_FORMAT_XRGB2101010:
3178 case DRM_FORMAT_XBGR2101010:
3179 case DRM_FORMAT_RGBX1010102:
3180 case DRM_FORMAT_BGRX1010102:
3181 case DRM_FORMAT_ARGB2101010:
3182 case DRM_FORMAT_ABGR2101010:
3183 case DRM_FORMAT_RGBA1010102:
3184 case DRM_FORMAT_BGRA1010102:
3185 case DRM_FORMAT_YUYV:
3186 case DRM_FORMAT_YVYU:
3187 case DRM_FORMAT_UYVY:
3188 case DRM_FORMAT_VYUY:
3189 case DRM_FORMAT_AYUV:
3190 case DRM_FORMAT_NV12:
3191 case DRM_FORMAT_NV21:
3192 case DRM_FORMAT_NV16:
3193 case DRM_FORMAT_NV61:
3194 case DRM_FORMAT_NV24:
3195 case DRM_FORMAT_NV42:
3196 case DRM_FORMAT_YUV410:
3197 case DRM_FORMAT_YVU410:
3198 case DRM_FORMAT_YUV411:
3199 case DRM_FORMAT_YVU411:
3200 case DRM_FORMAT_YUV420:
3201 case DRM_FORMAT_YVU420:
3202 case DRM_FORMAT_YUV422:
3203 case DRM_FORMAT_YVU422:
3204 case DRM_FORMAT_YUV444:
3205 case DRM_FORMAT_YVU444:
3208 DRM_DEBUG_KMS("invalid pixel format %s\n",
3209 drm_get_format_name(r->pixel_format));
3214 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3216 int ret, hsub, vsub, num_planes, i;
3218 ret = format_check(r);
3220 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3221 drm_get_format_name(r->pixel_format));
3225 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3226 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3227 num_planes = drm_format_num_planes(r->pixel_format);
3229 if (r->width == 0 || r->width % hsub) {
3230 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3234 if (r->height == 0 || r->height % vsub) {
3235 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3239 for (i = 0; i < num_planes; i++) {
3240 unsigned int width = r->width / (i != 0 ? hsub : 1);
3241 unsigned int height = r->height / (i != 0 ? vsub : 1);
3242 unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);
3244 if (!r->handles[i]) {
3245 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3249 if ((uint64_t) width * cpp > UINT_MAX)
3252 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3255 if (r->pitches[i] < width * cpp) {
3256 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3264 static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
3265 struct drm_mode_fb_cmd2 *r,
3266 struct drm_file *file_priv)
3268 struct drm_mode_config *config = &dev->mode_config;
3269 struct drm_framebuffer *fb;
3272 if (r->flags & ~DRM_MODE_FB_INTERLACED) {
3273 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3274 return ERR_PTR(-EINVAL);
3277 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3278 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3279 r->width, config->min_width, config->max_width);
3280 return ERR_PTR(-EINVAL);
3282 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3283 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3284 r->height, config->min_height, config->max_height);
3285 return ERR_PTR(-EINVAL);
3288 ret = framebuffer_check(r);
3290 return ERR_PTR(ret);
3292 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3294 DRM_DEBUG_KMS("could not create framebuffer\n");
3298 mutex_lock(&file_priv->fbs_lock);
3299 r->fb_id = fb->base.id;
3300 list_add(&fb->filp_head, &file_priv->fbs);
3301 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3302 mutex_unlock(&file_priv->fbs_lock);
3308 * drm_mode_addfb2 - add an FB to the graphics configuration
3309 * @dev: drm device for the ioctl
3310 * @data: data pointer for the ioctl
3311 * @file_priv: drm file for the ioctl call
3313 * Add a new FB to the specified CRTC, given a user request with format. This is
3314 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3315 * and uses fourcc codes as pixel format specifiers.
3317 * Called by the user via ioctl.
3320 * Zero on success, negative errno on failure.
3322 int drm_mode_addfb2(struct drm_device *dev,
3323 void *data, struct drm_file *file_priv)
3325 struct drm_framebuffer *fb;
3327 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3330 fb = add_framebuffer_internal(dev, data, file_priv);
3338 * drm_mode_rmfb - remove an FB from the configuration
3339 * @dev: drm device for the ioctl
3340 * @data: data pointer for the ioctl
3341 * @file_priv: drm file for the ioctl call
3343 * Remove the FB specified by the user.
3345 * Called by the user via ioctl.
3348 * Zero on success, negative errno on failure.
3350 int drm_mode_rmfb(struct drm_device *dev,
3351 void *data, struct drm_file *file_priv)
3353 struct drm_framebuffer *fb = NULL;
3354 struct drm_framebuffer *fbl = NULL;
3355 uint32_t *id = data;
3358 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3361 mutex_lock(&file_priv->fbs_lock);
3362 mutex_lock(&dev->mode_config.fb_lock);
3363 fb = __drm_framebuffer_lookup(dev, *id);
3367 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3373 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3374 __drm_framebuffer_unregister(dev, fb);
3376 list_del_init(&fb->filp_head);
3377 mutex_unlock(&dev->mode_config.fb_lock);
3378 mutex_unlock(&file_priv->fbs_lock);
3380 drm_framebuffer_remove(fb);
3385 mutex_unlock(&dev->mode_config.fb_lock);
3386 mutex_unlock(&file_priv->fbs_lock);
3392 * drm_mode_getfb - get FB info
3393 * @dev: drm device for the ioctl
3394 * @data: data pointer for the ioctl
3395 * @file_priv: drm file for the ioctl call
3397 * Lookup the FB given its ID and return info about it.
3399 * Called by the user via ioctl.
3402 * Zero on success, negative errno on failure.
3404 int drm_mode_getfb(struct drm_device *dev,
3405 void *data, struct drm_file *file_priv)
3407 struct drm_mode_fb_cmd *r = data;
3408 struct drm_framebuffer *fb;
3411 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3414 fb = drm_framebuffer_lookup(dev, r->fb_id);
3418 r->height = fb->height;
3419 r->width = fb->width;
3420 r->depth = fb->depth;
3421 r->bpp = fb->bits_per_pixel;
3422 r->pitch = fb->pitches[0];
3423 if (fb->funcs->create_handle) {
3424 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3425 drm_is_control_client(file_priv)) {
3426 ret = fb->funcs->create_handle(fb, file_priv,
3429 /* GET_FB() is an unprivileged ioctl so we must not
3430 * return a buffer-handle to non-master processes! For
3431 * backwards-compatibility reasons, we cannot make
3432 * GET_FB() privileged, so just return an invalid handle
3433 * for non-masters. */
3441 drm_framebuffer_unreference(fb);
3447 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3448 * @dev: drm device for the ioctl
3449 * @data: data pointer for the ioctl
3450 * @file_priv: drm file for the ioctl call
3452 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3453 * rectangle list. Generic userspace which does frontbuffer rendering must call
3454 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3455 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3457 * Modesetting drivers which always update the frontbuffer do not need to
3458 * implement the corresponding ->dirty framebuffer callback.
3460 * Called by the user via ioctl.
3463 * Zero on success, negative errno on failure.
3465 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3466 void *data, struct drm_file *file_priv)
3468 struct drm_clip_rect __user *clips_ptr;
3469 struct drm_clip_rect *clips = NULL;
3470 struct drm_mode_fb_dirty_cmd *r = data;
3471 struct drm_framebuffer *fb;
3476 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3479 fb = drm_framebuffer_lookup(dev, r->fb_id);
3483 num_clips = r->num_clips;
3484 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3486 if (!num_clips != !clips_ptr) {
3491 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3493 /* If userspace annotates copy, clips must come in pairs */
3494 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3499 if (num_clips && clips_ptr) {
3500 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3504 clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL);
3510 ret = copy_from_user(clips, clips_ptr,
3511 num_clips * sizeof(*clips));
3518 if (fb->funcs->dirty) {
3519 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3528 drm_framebuffer_unreference(fb);
3535 * drm_fb_release - remove and free the FBs on this file
3536 * @priv: drm file for the ioctl
3538 * Destroy all the FBs associated with @filp.
3540 * Called by the user via ioctl.
3543 * Zero on success, negative errno on failure.
3545 void drm_fb_release(struct drm_file *priv)
3547 struct drm_device *dev = priv->minor->dev;
3548 struct drm_framebuffer *fb, *tfb;
3551 * When the file gets released that means no one else can access the fb
3552 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3553 * avoid upsetting lockdep since the universal cursor code adds a
3554 * framebuffer while holding mutex locks.
3556 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3557 * locks is impossible here since no one else but this function can get
3560 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3562 mutex_lock(&dev->mode_config.fb_lock);
3563 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3564 __drm_framebuffer_unregister(dev, fb);
3565 mutex_unlock(&dev->mode_config.fb_lock);
3567 list_del_init(&fb->filp_head);
3569 /* This will also drop the fpriv->fbs reference. */
3570 drm_framebuffer_remove(fb);
3575 * drm_property_create - create a new property type
3577 * @flags: flags specifying the property type
3578 * @name: name of the property
3579 * @num_values: number of pre-defined values
3581 * This creates a new generic drm property which can then be attached to a drm
3582 * object with drm_object_attach_property. The returned property object must be
3583 * freed with drm_property_destroy.
3585 * Note that the DRM core keeps a per-device list of properties and that, if
3586 * drm_mode_config_cleanup() is called, it will destroy all properties created
3590 * A pointer to the newly created property on success, NULL on failure.
3592 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3593 const char *name, int num_values)
3595 struct drm_property *property = NULL;
3598 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3602 property->dev = dev;
3605 property->values = kcalloc(num_values, sizeof(uint64_t),
3607 if (!property->values)
3611 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3615 property->flags = flags;
3616 property->num_values = num_values;
3617 INIT_LIST_HEAD(&property->enum_list);
3620 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3621 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3624 list_add_tail(&property->head, &dev->mode_config.property_list);
3626 WARN_ON(!drm_property_type_valid(property));
3630 kfree(property->values);
3634 EXPORT_SYMBOL(drm_property_create);
3637 * drm_property_create_enum - create a new enumeration property type
3639 * @flags: flags specifying the property type
3640 * @name: name of the property
3641 * @props: enumeration lists with property values
3642 * @num_values: number of pre-defined values
3644 * This creates a new generic drm property which can then be attached to a drm
3645 * object with drm_object_attach_property. The returned property object must be
3646 * freed with drm_property_destroy.
3648 * Userspace is only allowed to set one of the predefined values for enumeration
3652 * A pointer to the newly created property on success, NULL on failure.
3654 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3656 const struct drm_prop_enum_list *props,
3659 struct drm_property *property;
3662 flags |= DRM_MODE_PROP_ENUM;
3664 property = drm_property_create(dev, flags, name, num_values);
3668 for (i = 0; i < num_values; i++) {
3669 ret = drm_property_add_enum(property, i,
3673 drm_property_destroy(dev, property);
3680 EXPORT_SYMBOL(drm_property_create_enum);
3683 * drm_property_create_bitmask - create a new bitmask property type
3685 * @flags: flags specifying the property type
3686 * @name: name of the property
3687 * @props: enumeration lists with property bitflags
3688 * @num_props: size of the @props array
3689 * @supported_bits: bitmask of all supported enumeration values
3691 * This creates a new bitmask drm property which can then be attached to a drm
3692 * object with drm_object_attach_property. The returned property object must be
3693 * freed with drm_property_destroy.
3695 * Compared to plain enumeration properties userspace is allowed to set any
3696 * or'ed together combination of the predefined property bitflag values
3699 * A pointer to the newly created property on success, NULL on failure.
3701 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3702 int flags, const char *name,
3703 const struct drm_prop_enum_list *props,
3705 uint64_t supported_bits)
3707 struct drm_property *property;
3708 int i, ret, index = 0;
3709 int num_values = hweight64(supported_bits);
3711 flags |= DRM_MODE_PROP_BITMASK;
3713 property = drm_property_create(dev, flags, name, num_values);
3716 for (i = 0; i < num_props; i++) {
3717 if (!(supported_bits & (1ULL << props[i].type)))
3720 if (WARN_ON(index >= num_values)) {
3721 drm_property_destroy(dev, property);
3725 ret = drm_property_add_enum(property, index++,
3729 drm_property_destroy(dev, property);
3736 EXPORT_SYMBOL(drm_property_create_bitmask);
3738 static struct drm_property *property_create_range(struct drm_device *dev,
3739 int flags, const char *name,
3740 uint64_t min, uint64_t max)
3742 struct drm_property *property;
3744 property = drm_property_create(dev, flags, name, 2);
3748 property->values[0] = min;
3749 property->values[1] = max;
3755 * drm_property_create_range - create a new ranged property type
3757 * @flags: flags specifying the property type
3758 * @name: name of the property
3759 * @min: minimum value of the property
3760 * @max: maximum value of the property
3762 * This creates a new generic drm property which can then be attached to a drm
3763 * object with drm_object_attach_property. The returned property object must be
3764 * freed with drm_property_destroy.
3766 * Userspace is allowed to set any integer value in the (min, max) range
3770 * A pointer to the newly created property on success, NULL on failure.
3772 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3774 uint64_t min, uint64_t max)
3776 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3779 EXPORT_SYMBOL(drm_property_create_range);
3781 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3782 int flags, const char *name,
3783 int64_t min, int64_t max)
3785 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3786 name, I642U64(min), I642U64(max));
3788 EXPORT_SYMBOL(drm_property_create_signed_range);
3790 struct drm_property *drm_property_create_object(struct drm_device *dev,
3791 int flags, const char *name, uint32_t type)
3793 struct drm_property *property;
3795 flags |= DRM_MODE_PROP_OBJECT;
3797 property = drm_property_create(dev, flags, name, 1);
3801 property->values[0] = type;
3805 EXPORT_SYMBOL(drm_property_create_object);
3808 * drm_property_add_enum - add a possible value to an enumeration property
3809 * @property: enumeration property to change
3810 * @index: index of the new enumeration
3811 * @value: value of the new enumeration
3812 * @name: symbolic name of the new enumeration
3814 * This functions adds enumerations to a property.
3816 * It's use is deprecated, drivers should use one of the more specific helpers
3817 * to directly create the property with all enumerations already attached.
3820 * Zero on success, error code on failure.
3822 int drm_property_add_enum(struct drm_property *property, int index,
3823 uint64_t value, const char *name)
3825 struct drm_property_enum *prop_enum;
3827 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3828 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
3832 * Bitmask enum properties have the additional constraint of values
3835 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
3839 if (!list_empty(&property->enum_list)) {
3840 list_for_each_entry(prop_enum, &property->enum_list, head) {
3841 if (prop_enum->value == value) {
3842 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3843 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3849 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
3853 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3854 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3855 prop_enum->value = value;
3857 property->values[index] = value;
3858 list_add_tail(&prop_enum->head, &property->enum_list);
3861 EXPORT_SYMBOL(drm_property_add_enum);
3864 * drm_property_destroy - destroy a drm property
3866 * @property: property to destry
3868 * This function frees a property including any attached resources like
3869 * enumeration values.
3871 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
3873 struct drm_property_enum *prop_enum, *pt;
3875 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
3876 list_del(&prop_enum->head);
3880 if (property->num_values)
3881 kfree(property->values);
3882 drm_mode_object_put(dev, &property->base);
3883 list_del(&property->head);
3886 EXPORT_SYMBOL(drm_property_destroy);
3889 * drm_object_attach_property - attach a property to a modeset object
3890 * @obj: drm modeset object
3891 * @property: property to attach
3892 * @init_val: initial value of the property
3894 * This attaches the given property to the modeset object with the given initial
3895 * value. Currently this function cannot fail since the properties are stored in
3896 * a statically sized array.
3898 void drm_object_attach_property(struct drm_mode_object *obj,
3899 struct drm_property *property,
3902 int count = obj->properties->count;
3904 if (count == DRM_OBJECT_MAX_PROPERTY) {
3905 WARN(1, "Failed to attach object property (type: 0x%x). Please "
3906 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
3907 "you see this message on the same object type.\n",
3912 obj->properties->properties[count] = property;
3913 obj->properties->values[count] = init_val;
3914 obj->properties->count++;
3915 if (property->flags & DRM_MODE_PROP_ATOMIC)
3916 obj->properties->atomic_count++;
3918 EXPORT_SYMBOL(drm_object_attach_property);
3921 * drm_object_property_set_value - set the value of a property
3922 * @obj: drm mode object to set property value for
3923 * @property: property to set
3924 * @val: value the property should be set to
3926 * This functions sets a given property on a given object. This function only
3927 * changes the software state of the property, it does not call into the
3928 * driver's ->set_property callback.
3931 * Zero on success, error code on failure.
3933 int drm_object_property_set_value(struct drm_mode_object *obj,
3934 struct drm_property *property, uint64_t val)
3938 for (i = 0; i < obj->properties->count; i++) {
3939 if (obj->properties->properties[i] == property) {
3940 obj->properties->values[i] = val;
3947 EXPORT_SYMBOL(drm_object_property_set_value);
3950 * drm_object_property_get_value - retrieve the value of a property
3951 * @obj: drm mode object to get property value from
3952 * @property: property to retrieve
3953 * @val: storage for the property value
3955 * This function retrieves the softare state of the given property for the given
3956 * property. Since there is no driver callback to retrieve the current property
3957 * value this might be out of sync with the hardware, depending upon the driver
3961 * Zero on success, error code on failure.
3963 int drm_object_property_get_value(struct drm_mode_object *obj,
3964 struct drm_property *property, uint64_t *val)
3968 /* read-only properties bypass atomic mechanism and still store
3969 * their value in obj->properties->values[].. mostly to avoid
3970 * having to deal w/ EDID and similar props in atomic paths:
3972 if (drm_core_check_feature(property->dev, DRIVER_ATOMIC) &&
3973 !(property->flags & DRM_MODE_PROP_IMMUTABLE))
3974 return drm_atomic_get_property(obj, property, val);
3976 for (i = 0; i < obj->properties->count; i++) {
3977 if (obj->properties->properties[i] == property) {
3978 *val = obj->properties->values[i];
3985 EXPORT_SYMBOL(drm_object_property_get_value);
3988 * drm_mode_getproperty_ioctl - get the property metadata
3991 * @file_priv: DRM file info
3993 * This function retrieves the metadata for a given property, like the different
3994 * possible values for an enum property or the limits for a range property.
3996 * Blob properties are special
3998 * Called by the user via ioctl.
4001 * Zero on success, negative errno on failure.
4003 int drm_mode_getproperty_ioctl(struct drm_device *dev,
4004 void *data, struct drm_file *file_priv)
4006 struct drm_mode_get_property *out_resp = data;
4007 struct drm_property *property;
4009 int value_count = 0;
4012 struct drm_property_enum *prop_enum;
4013 struct drm_mode_property_enum __user *enum_ptr;
4014 uint64_t __user *values_ptr;
4016 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4019 drm_modeset_lock_all(dev);
4020 property = drm_property_find(dev, out_resp->prop_id);
4026 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4027 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4028 list_for_each_entry(prop_enum, &property->enum_list, head)
4032 value_count = property->num_values;
4034 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
4035 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
4036 out_resp->flags = property->flags;
4038 if ((out_resp->count_values >= value_count) && value_count) {
4039 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
4040 for (i = 0; i < value_count; i++) {
4041 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
4047 out_resp->count_values = value_count;
4049 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
4050 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4051 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
4053 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
4054 list_for_each_entry(prop_enum, &property->enum_list, head) {
4056 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
4061 if (copy_to_user(&enum_ptr[copied].name,
4062 &prop_enum->name, DRM_PROP_NAME_LEN)) {
4069 out_resp->count_enum_blobs = enum_count;
4073 * NOTE: The idea seems to have been to use this to read all the blob
4074 * property values. But nothing ever added them to the corresponding
4075 * list, userspace always used the special-purpose get_blob ioctl to
4076 * read the value for a blob property. It also doesn't make a lot of
4077 * sense to return values here when everything else is just metadata for
4078 * the property itself.
4080 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
4081 out_resp->count_enum_blobs = 0;
4083 drm_modeset_unlock_all(dev);
4087 static struct drm_property_blob *
4088 drm_property_create_blob(struct drm_device *dev, size_t length,
4091 struct drm_property_blob *blob;
4094 if (!length || !data)
4097 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4101 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4107 blob->length = length;
4109 memcpy(blob->data, data, length);
4111 list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
4115 static void drm_property_destroy_blob(struct drm_device *dev,
4116 struct drm_property_blob *blob)
4118 drm_mode_object_put(dev, &blob->base);
4119 list_del(&blob->head);
4124 * drm_mode_getblob_ioctl - get the contents of a blob property value
4127 * @file_priv: DRM file info
4129 * This function retrieves the contents of a blob property. The value stored in
4130 * an object's blob property is just a normal modeset object id.
4132 * Called by the user via ioctl.
4135 * Zero on success, negative errno on failure.
4137 int drm_mode_getblob_ioctl(struct drm_device *dev,
4138 void *data, struct drm_file *file_priv)
4140 struct drm_mode_get_blob *out_resp = data;
4141 struct drm_property_blob *blob;
4143 void __user *blob_ptr;
4145 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4148 drm_modeset_lock_all(dev);
4149 blob = drm_property_blob_find(dev, out_resp->blob_id);
4155 if (out_resp->length == blob->length) {
4156 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4157 if (copy_to_user(blob_ptr, blob->data, blob->length)) {
4162 out_resp->length = blob->length;
4165 drm_modeset_unlock_all(dev);
4170 * drm_mode_connector_set_path_property - set tile property on connector
4171 * @connector: connector to set property on.
4172 * @path: path to use for property.
4174 * This creates a property to expose to userspace to specify a
4175 * connector path. This is mainly used for DisplayPort MST where
4176 * connectors have a topology and we want to allow userspace to give
4177 * them more meaningful names.
4180 * Zero on success, negative errno on failure.
4182 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4185 struct drm_device *dev = connector->dev;
4186 size_t size = strlen(path) + 1;
4189 connector->path_blob_ptr = drm_property_create_blob(connector->dev,
4191 if (!connector->path_blob_ptr)
4194 ret = drm_object_property_set_value(&connector->base,
4195 dev->mode_config.path_property,
4196 connector->path_blob_ptr->base.id);
4199 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4202 * drm_mode_connector_set_tile_property - set tile property on connector
4203 * @connector: connector to set property on.
4205 * This looks up the tile information for a connector, and creates a
4206 * property for userspace to parse if it exists. The property is of
4207 * the form of 8 integers using ':' as a separator.
4210 * Zero on success, errno on failure.
4212 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4214 struct drm_device *dev = connector->dev;
4218 if (connector->tile_blob_ptr)
4219 drm_property_destroy_blob(dev, connector->tile_blob_ptr);
4221 if (!connector->has_tile) {
4222 connector->tile_blob_ptr = NULL;
4223 ret = drm_object_property_set_value(&connector->base,
4224 dev->mode_config.tile_property, 0);
4228 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4229 connector->tile_group->id, connector->tile_is_single_monitor,
4230 connector->num_h_tile, connector->num_v_tile,
4231 connector->tile_h_loc, connector->tile_v_loc,
4232 connector->tile_h_size, connector->tile_v_size);
4233 size = strlen(tile) + 1;
4235 connector->tile_blob_ptr = drm_property_create_blob(connector->dev,
4237 if (!connector->tile_blob_ptr)
4240 ret = drm_object_property_set_value(&connector->base,
4241 dev->mode_config.tile_property,
4242 connector->tile_blob_ptr->base.id);
4245 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4248 * drm_mode_connector_update_edid_property - update the edid property of a connector
4249 * @connector: drm connector
4250 * @edid: new value of the edid property
4252 * This function creates a new blob modeset object and assigns its id to the
4253 * connector's edid property.
4256 * Zero on success, negative errno on failure.
4258 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4259 const struct edid *edid)
4261 struct drm_device *dev = connector->dev;
4265 /* ignore requests to set edid when overridden */
4266 if (connector->override_edid)
4269 if (connector->edid_blob_ptr)
4270 drm_property_destroy_blob(dev, connector->edid_blob_ptr);
4272 /* Delete edid, when there is none. */
4274 connector->edid_blob_ptr = NULL;
4275 ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
4279 size = EDID_LENGTH * (1 + edid->extensions);
4280 connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
4282 if (!connector->edid_blob_ptr)
4285 ret = drm_object_property_set_value(&connector->base,
4286 dev->mode_config.edid_property,
4287 connector->edid_blob_ptr->base.id);
4291 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4293 /* Some properties could refer to dynamic refcnt'd objects, or things that
4294 * need special locking to handle lifetime issues (ie. to ensure the prop
4295 * value doesn't become invalid part way through the property update due to
4296 * race). The value returned by reference via 'obj' should be passed back
4297 * to drm_property_change_valid_put() after the property is set (and the
4298 * object to which the property is attached has a chance to take it's own
4301 static bool drm_property_change_valid_get(struct drm_property *property,
4302 uint64_t value, struct drm_mode_object **ref)
4306 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4311 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4312 if (value < property->values[0] || value > property->values[1])
4315 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4316 int64_t svalue = U642I64(value);
4318 if (svalue < U642I64(property->values[0]) ||
4319 svalue > U642I64(property->values[1]))
4322 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4323 uint64_t valid_mask = 0;
4325 for (i = 0; i < property->num_values; i++)
4326 valid_mask |= (1ULL << property->values[i]);
4327 return !(value & ~valid_mask);
4328 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4329 /* Only the driver knows */
4331 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4332 /* a zero value for an object property translates to null: */
4336 /* handle refcnt'd objects specially: */
4337 if (property->values[0] == DRM_MODE_OBJECT_FB) {
4338 struct drm_framebuffer *fb;
4339 fb = drm_framebuffer_lookup(property->dev, value);
4347 return _object_find(property->dev, value, property->values[0]) != NULL;
4351 for (i = 0; i < property->num_values; i++)
4352 if (property->values[i] == value)
4357 for (i = 0; i < property->num_values; i++)
4358 if (property->values[i] == value)
4363 static void drm_property_change_valid_put(struct drm_property *property,
4364 struct drm_mode_object *ref)
4369 if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4370 if (property->values[0] == DRM_MODE_OBJECT_FB)
4371 drm_framebuffer_unreference(obj_to_fb(ref));
4376 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4379 * @file_priv: DRM file info
4381 * This function sets the current value for a connectors's property. It also
4382 * calls into a driver's ->set_property callback to update the hardware state
4384 * Called by the user via ioctl.
4387 * Zero on success, negative errno on failure.
4389 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4390 void *data, struct drm_file *file_priv)
4392 struct drm_mode_connector_set_property *conn_set_prop = data;
4393 struct drm_mode_obj_set_property obj_set_prop = {
4394 .value = conn_set_prop->value,
4395 .prop_id = conn_set_prop->prop_id,
4396 .obj_id = conn_set_prop->connector_id,
4397 .obj_type = DRM_MODE_OBJECT_CONNECTOR
4400 /* It does all the locking and checking we need */
4401 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4404 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4405 struct drm_property *property,
4409 struct drm_connector *connector = obj_to_connector(obj);
4411 /* Do DPMS ourselves */
4412 if (property == connector->dev->mode_config.dpms_property) {
4413 if (connector->funcs->dpms)
4414 (*connector->funcs->dpms)(connector, (int)value);
4416 } else if (connector->funcs->set_property)
4417 ret = connector->funcs->set_property(connector, property, value);
4419 /* store the property value if successful */
4421 drm_object_property_set_value(&connector->base, property, value);
4425 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4426 struct drm_property *property,
4430 struct drm_crtc *crtc = obj_to_crtc(obj);
4432 if (crtc->funcs->set_property)
4433 ret = crtc->funcs->set_property(crtc, property, value);
4435 drm_object_property_set_value(obj, property, value);
4441 * drm_mode_plane_set_obj_prop - set the value of a property
4442 * @plane: drm plane object to set property value for
4443 * @property: property to set
4444 * @value: value the property should be set to
4446 * This functions sets a given property on a given plane object. This function
4447 * calls the driver's ->set_property callback and changes the software state of
4448 * the property if the callback succeeds.
4451 * Zero on success, error code on failure.
4453 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
4454 struct drm_property *property,
4458 struct drm_mode_object *obj = &plane->base;
4460 if (plane->funcs->set_property)
4461 ret = plane->funcs->set_property(plane, property, value);
4463 drm_object_property_set_value(obj, property, value);
4467 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
4470 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
4473 * @file_priv: DRM file info
4475 * This function retrieves the current value for an object's property. Compared
4476 * to the connector specific ioctl this one is extended to also work on crtc and
4479 * Called by the user via ioctl.
4482 * Zero on success, negative errno on failure.
4484 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
4485 struct drm_file *file_priv)
4487 struct drm_mode_obj_get_properties *arg = data;
4488 struct drm_mode_object *obj;
4491 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4494 drm_modeset_lock_all(dev);
4496 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4501 if (!obj->properties) {
4506 ret = get_properties(obj, file_priv->atomic,
4507 (uint32_t __user *)(unsigned long)(arg->props_ptr),
4508 (uint64_t __user *)(unsigned long)(arg->prop_values_ptr),
4512 drm_modeset_unlock_all(dev);
4517 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
4520 * @file_priv: DRM file info
4522 * This function sets the current value for an object's property. It also calls
4523 * into a driver's ->set_property callback to update the hardware state.
4524 * Compared to the connector specific ioctl this one is extended to also work on
4525 * crtc and plane objects.
4527 * Called by the user via ioctl.
4530 * Zero on success, negative errno on failure.
4532 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
4533 struct drm_file *file_priv)
4535 struct drm_mode_obj_set_property *arg = data;
4536 struct drm_mode_object *arg_obj;
4537 struct drm_mode_object *prop_obj;
4538 struct drm_property *property;
4539 int i, ret = -EINVAL;
4540 struct drm_mode_object *ref;
4542 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4545 drm_modeset_lock_all(dev);
4547 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4552 if (!arg_obj->properties)
4555 for (i = 0; i < arg_obj->properties->count; i++)
4556 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
4559 if (i == arg_obj->properties->count)
4562 prop_obj = drm_mode_object_find(dev, arg->prop_id,
4563 DRM_MODE_OBJECT_PROPERTY);
4568 property = obj_to_property(prop_obj);
4570 if (!drm_property_change_valid_get(property, arg->value, &ref))
4573 switch (arg_obj->type) {
4574 case DRM_MODE_OBJECT_CONNECTOR:
4575 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
4578 case DRM_MODE_OBJECT_CRTC:
4579 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
4581 case DRM_MODE_OBJECT_PLANE:
4582 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
4583 property, arg->value);
4587 drm_property_change_valid_put(property, ref);
4590 drm_modeset_unlock_all(dev);
4595 * drm_mode_connector_attach_encoder - attach a connector to an encoder
4596 * @connector: connector to attach
4597 * @encoder: encoder to attach @connector to
4599 * This function links up a connector to an encoder. Note that the routing
4600 * restrictions between encoders and crtcs are exposed to userspace through the
4601 * possible_clones and possible_crtcs bitmasks.
4604 * Zero on success, negative errno on failure.
4606 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
4607 struct drm_encoder *encoder)
4611 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
4612 if (connector->encoder_ids[i] == 0) {
4613 connector->encoder_ids[i] = encoder->base.id;
4619 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
4622 * drm_mode_crtc_set_gamma_size - set the gamma table size
4623 * @crtc: CRTC to set the gamma table size for
4624 * @gamma_size: size of the gamma table
4626 * Drivers which support gamma tables should set this to the supported gamma
4627 * table size when initializing the CRTC. Currently the drm core only supports a
4628 * fixed gamma table size.
4631 * Zero on success, negative errno on failure.
4633 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
4636 crtc->gamma_size = gamma_size;
4638 crtc->gamma_store = kcalloc(gamma_size, sizeof(uint16_t) * 3,
4640 if (!crtc->gamma_store) {
4641 crtc->gamma_size = 0;
4647 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
4650 * drm_mode_gamma_set_ioctl - set the gamma table
4653 * @file_priv: DRM file info
4655 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
4656 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
4658 * Called by the user via ioctl.
4661 * Zero on success, negative errno on failure.
4663 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
4664 void *data, struct drm_file *file_priv)
4666 struct drm_mode_crtc_lut *crtc_lut = data;
4667 struct drm_crtc *crtc;
4668 void *r_base, *g_base, *b_base;
4672 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4675 drm_modeset_lock_all(dev);
4676 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4682 if (crtc->funcs->gamma_set == NULL) {
4687 /* memcpy into gamma store */
4688 if (crtc_lut->gamma_size != crtc->gamma_size) {
4693 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4694 r_base = crtc->gamma_store;
4695 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
4700 g_base = r_base + size;
4701 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
4706 b_base = g_base + size;
4707 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
4712 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
4715 drm_modeset_unlock_all(dev);
4721 * drm_mode_gamma_get_ioctl - get the gamma table
4724 * @file_priv: DRM file info
4726 * Copy the current gamma table into the storage provided. This also provides
4727 * the gamma table size the driver expects, which can be used to size the
4728 * allocated storage.
4730 * Called by the user via ioctl.
4733 * Zero on success, negative errno on failure.
4735 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
4736 void *data, struct drm_file *file_priv)
4738 struct drm_mode_crtc_lut *crtc_lut = data;
4739 struct drm_crtc *crtc;
4740 void *r_base, *g_base, *b_base;
4744 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4747 drm_modeset_lock_all(dev);
4748 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4754 /* memcpy into gamma store */
4755 if (crtc_lut->gamma_size != crtc->gamma_size) {
4760 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4761 r_base = crtc->gamma_store;
4762 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
4767 g_base = r_base + size;
4768 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
4773 b_base = g_base + size;
4774 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
4779 drm_modeset_unlock_all(dev);
4784 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4787 * @file_priv: DRM file info
4789 * This schedules an asynchronous update on a given CRTC, called page flip.
4790 * Optionally a drm event is generated to signal the completion of the event.
4791 * Generic drivers cannot assume that a pageflip with changed framebuffer
4792 * properties (including driver specific metadata like tiling layout) will work,
4793 * but some drivers support e.g. pixel format changes through the pageflip
4796 * Called by the user via ioctl.
4799 * Zero on success, negative errno on failure.
4801 int drm_mode_page_flip_ioctl(struct drm_device *dev,
4802 void *data, struct drm_file *file_priv)
4804 struct drm_mode_crtc_page_flip *page_flip = data;
4805 struct drm_crtc *crtc;
4806 struct drm_framebuffer *fb = NULL;
4807 struct drm_pending_vblank_event *e = NULL;
4808 unsigned long flags;
4811 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
4812 page_flip->reserved != 0)
4815 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
4818 crtc = drm_crtc_find(dev, page_flip->crtc_id);
4822 drm_modeset_lock_crtc(crtc, crtc->primary);
4823 if (crtc->primary->fb == NULL) {
4824 /* The framebuffer is currently unbound, presumably
4825 * due to a hotplug event, that userspace has not
4832 if (crtc->funcs->page_flip == NULL)
4835 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
4841 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
4845 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
4846 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4851 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4853 spin_lock_irqsave(&dev->event_lock, flags);
4854 if (file_priv->event_space < sizeof(e->event)) {
4855 spin_unlock_irqrestore(&dev->event_lock, flags);
4858 file_priv->event_space -= sizeof(e->event);
4859 spin_unlock_irqrestore(&dev->event_lock, flags);
4861 e = kzalloc(sizeof(*e), GFP_KERNEL);
4863 spin_lock_irqsave(&dev->event_lock, flags);
4864 file_priv->event_space += sizeof(e->event);
4865 spin_unlock_irqrestore(&dev->event_lock, flags);
4869 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
4870 e->event.base.length = sizeof(e->event);
4871 e->event.user_data = page_flip->user_data;
4872 e->base.event = &e->event.base;
4873 e->base.file_priv = file_priv;
4875 (void (*) (struct drm_pending_event *)) kfree;
4878 crtc->primary->old_fb = crtc->primary->fb;
4879 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
4881 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4882 spin_lock_irqsave(&dev->event_lock, flags);
4883 file_priv->event_space += sizeof(e->event);
4884 spin_unlock_irqrestore(&dev->event_lock, flags);
4887 /* Keep the old fb, don't unref it. */
4888 crtc->primary->old_fb = NULL;
4891 * Warn if the driver hasn't properly updated the crtc->fb
4892 * field to reflect that the new framebuffer is now used.
4893 * Failing to do so will screw with the reference counting
4896 WARN_ON(crtc->primary->fb != fb);
4897 /* Unref only the old framebuffer. */
4903 drm_framebuffer_unreference(fb);
4904 if (crtc->primary->old_fb)
4905 drm_framebuffer_unreference(crtc->primary->old_fb);
4906 crtc->primary->old_fb = NULL;
4907 drm_modeset_unlock_crtc(crtc);
4913 * drm_mode_config_reset - call ->reset callbacks
4916 * This functions calls all the crtc's, encoder's and connector's ->reset
4917 * callback. Drivers can use this in e.g. their driver load or resume code to
4918 * reset hardware and software state.
4920 void drm_mode_config_reset(struct drm_device *dev)
4922 struct drm_crtc *crtc;
4923 struct drm_plane *plane;
4924 struct drm_encoder *encoder;
4925 struct drm_connector *connector;
4927 list_for_each_entry(plane, &dev->mode_config.plane_list, head)
4928 if (plane->funcs->reset)
4929 plane->funcs->reset(plane);
4931 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
4932 if (crtc->funcs->reset)
4933 crtc->funcs->reset(crtc);
4935 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
4936 if (encoder->funcs->reset)
4937 encoder->funcs->reset(encoder);
4939 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
4940 connector->status = connector_status_unknown;
4942 if (connector->funcs->reset)
4943 connector->funcs->reset(connector);
4946 EXPORT_SYMBOL(drm_mode_config_reset);
4949 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
4952 * @file_priv: DRM file info
4954 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
4955 * TTM or something else entirely) and returns the resulting buffer handle. This
4956 * handle can then be wrapped up into a framebuffer modeset object.
4958 * Note that userspace is not allowed to use such objects for render
4959 * acceleration - drivers must create their own private ioctls for such a use
4962 * Called by the user via ioctl.
4965 * Zero on success, negative errno on failure.
4967 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
4968 void *data, struct drm_file *file_priv)
4970 struct drm_mode_create_dumb *args = data;
4971 u32 cpp, stride, size;
4973 if (!dev->driver->dumb_create)
4975 if (!args->width || !args->height || !args->bpp)
4978 /* overflow checks for 32bit size calculations */
4979 /* NOTE: DIV_ROUND_UP() can overflow */
4980 cpp = DIV_ROUND_UP(args->bpp, 8);
4981 if (!cpp || cpp > 0xffffffffU / args->width)
4983 stride = cpp * args->width;
4984 if (args->height > 0xffffffffU / stride)
4987 /* test for wrap-around */
4988 size = args->height * stride;
4989 if (PAGE_ALIGN(size) == 0)
4993 * handle, pitch and size are output parameters. Zero them out to
4994 * prevent drivers from accidentally using uninitialized data. Since
4995 * not all existing userspace is clearing these fields properly we
4996 * cannot reject IOCTL with garbage in them.
5002 return dev->driver->dumb_create(file_priv, dev, args);
5006 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
5009 * @file_priv: DRM file info
5011 * Allocate an offset in the drm device node's address space to be able to
5012 * memory map a dumb buffer.
5014 * Called by the user via ioctl.
5017 * Zero on success, negative errno on failure.
5019 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
5020 void *data, struct drm_file *file_priv)
5022 struct drm_mode_map_dumb *args = data;
5024 /* call driver ioctl to get mmap offset */
5025 if (!dev->driver->dumb_map_offset)
5028 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
5032 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
5035 * @file_priv: DRM file info
5037 * This destroys the userspace handle for the given dumb backing storage buffer.
5038 * Since buffer objects must be reference counted in the kernel a buffer object
5039 * won't be immediately freed if a framebuffer modeset object still uses it.
5041 * Called by the user via ioctl.
5044 * Zero on success, negative errno on failure.
5046 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
5047 void *data, struct drm_file *file_priv)
5049 struct drm_mode_destroy_dumb *args = data;
5051 if (!dev->driver->dumb_destroy)
5054 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
5058 * drm_fb_get_bpp_depth - get the bpp/depth values for format
5059 * @format: pixel format (DRM_FORMAT_*)
5060 * @depth: storage for the depth value
5061 * @bpp: storage for the bpp value
5063 * This only supports RGB formats here for compat with code that doesn't use
5064 * pixel formats directly yet.
5066 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
5071 case DRM_FORMAT_RGB332:
5072 case DRM_FORMAT_BGR233:
5076 case DRM_FORMAT_XRGB1555:
5077 case DRM_FORMAT_XBGR1555:
5078 case DRM_FORMAT_RGBX5551:
5079 case DRM_FORMAT_BGRX5551:
5080 case DRM_FORMAT_ARGB1555:
5081 case DRM_FORMAT_ABGR1555:
5082 case DRM_FORMAT_RGBA5551:
5083 case DRM_FORMAT_BGRA5551:
5087 case DRM_FORMAT_RGB565:
5088 case DRM_FORMAT_BGR565:
5092 case DRM_FORMAT_RGB888:
5093 case DRM_FORMAT_BGR888:
5097 case DRM_FORMAT_XRGB8888:
5098 case DRM_FORMAT_XBGR8888:
5099 case DRM_FORMAT_RGBX8888:
5100 case DRM_FORMAT_BGRX8888:
5104 case DRM_FORMAT_XRGB2101010:
5105 case DRM_FORMAT_XBGR2101010:
5106 case DRM_FORMAT_RGBX1010102:
5107 case DRM_FORMAT_BGRX1010102:
5108 case DRM_FORMAT_ARGB2101010:
5109 case DRM_FORMAT_ABGR2101010:
5110 case DRM_FORMAT_RGBA1010102:
5111 case DRM_FORMAT_BGRA1010102:
5115 case DRM_FORMAT_ARGB8888:
5116 case DRM_FORMAT_ABGR8888:
5117 case DRM_FORMAT_RGBA8888:
5118 case DRM_FORMAT_BGRA8888:
5123 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5124 drm_get_format_name(format));
5130 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5133 * drm_format_num_planes - get the number of planes for format
5134 * @format: pixel format (DRM_FORMAT_*)
5137 * The number of planes used by the specified pixel format.
5139 int drm_format_num_planes(uint32_t format)
5142 case DRM_FORMAT_YUV410:
5143 case DRM_FORMAT_YVU410:
5144 case DRM_FORMAT_YUV411:
5145 case DRM_FORMAT_YVU411:
5146 case DRM_FORMAT_YUV420:
5147 case DRM_FORMAT_YVU420:
5148 case DRM_FORMAT_YUV422:
5149 case DRM_FORMAT_YVU422:
5150 case DRM_FORMAT_YUV444:
5151 case DRM_FORMAT_YVU444:
5153 case DRM_FORMAT_NV12:
5154 case DRM_FORMAT_NV21:
5155 case DRM_FORMAT_NV16:
5156 case DRM_FORMAT_NV61:
5157 case DRM_FORMAT_NV24:
5158 case DRM_FORMAT_NV42:
5164 EXPORT_SYMBOL(drm_format_num_planes);
5167 * drm_format_plane_cpp - determine the bytes per pixel value
5168 * @format: pixel format (DRM_FORMAT_*)
5169 * @plane: plane index
5172 * The bytes per pixel value for the specified plane.
5174 int drm_format_plane_cpp(uint32_t format, int plane)
5179 if (plane >= drm_format_num_planes(format))
5183 case DRM_FORMAT_YUYV:
5184 case DRM_FORMAT_YVYU:
5185 case DRM_FORMAT_UYVY:
5186 case DRM_FORMAT_VYUY:
5188 case DRM_FORMAT_NV12:
5189 case DRM_FORMAT_NV21:
5190 case DRM_FORMAT_NV16:
5191 case DRM_FORMAT_NV61:
5192 case DRM_FORMAT_NV24:
5193 case DRM_FORMAT_NV42:
5194 return plane ? 2 : 1;
5195 case DRM_FORMAT_YUV410:
5196 case DRM_FORMAT_YVU410:
5197 case DRM_FORMAT_YUV411:
5198 case DRM_FORMAT_YVU411:
5199 case DRM_FORMAT_YUV420:
5200 case DRM_FORMAT_YVU420:
5201 case DRM_FORMAT_YUV422:
5202 case DRM_FORMAT_YVU422:
5203 case DRM_FORMAT_YUV444:
5204 case DRM_FORMAT_YVU444:
5207 drm_fb_get_bpp_depth(format, &depth, &bpp);
5211 EXPORT_SYMBOL(drm_format_plane_cpp);
5214 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5215 * @format: pixel format (DRM_FORMAT_*)
5218 * The horizontal chroma subsampling factor for the
5219 * specified pixel format.
5221 int drm_format_horz_chroma_subsampling(uint32_t format)
5224 case DRM_FORMAT_YUV411:
5225 case DRM_FORMAT_YVU411:
5226 case DRM_FORMAT_YUV410:
5227 case DRM_FORMAT_YVU410:
5229 case DRM_FORMAT_YUYV:
5230 case DRM_FORMAT_YVYU:
5231 case DRM_FORMAT_UYVY:
5232 case DRM_FORMAT_VYUY:
5233 case DRM_FORMAT_NV12:
5234 case DRM_FORMAT_NV21:
5235 case DRM_FORMAT_NV16:
5236 case DRM_FORMAT_NV61:
5237 case DRM_FORMAT_YUV422:
5238 case DRM_FORMAT_YVU422:
5239 case DRM_FORMAT_YUV420:
5240 case DRM_FORMAT_YVU420:
5246 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5249 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5250 * @format: pixel format (DRM_FORMAT_*)
5253 * The vertical chroma subsampling factor for the
5254 * specified pixel format.
5256 int drm_format_vert_chroma_subsampling(uint32_t format)
5259 case DRM_FORMAT_YUV410:
5260 case DRM_FORMAT_YVU410:
5262 case DRM_FORMAT_YUV420:
5263 case DRM_FORMAT_YVU420:
5264 case DRM_FORMAT_NV12:
5265 case DRM_FORMAT_NV21:
5271 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5274 * drm_rotation_simplify() - Try to simplify the rotation
5275 * @rotation: Rotation to be simplified
5276 * @supported_rotations: Supported rotations
5278 * Attempt to simplify the rotation to a form that is supported.
5279 * Eg. if the hardware supports everything except DRM_REFLECT_X
5280 * one could call this function like this:
5282 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5283 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5284 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5286 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5287 * transforms the hardware supports, this function may not
5288 * be able to produce a supported transform, so the caller should
5289 * check the result afterwards.
5291 unsigned int drm_rotation_simplify(unsigned int rotation,
5292 unsigned int supported_rotations)
5294 if (rotation & ~supported_rotations) {
5295 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5296 rotation = (rotation & ~0xf) | BIT((ffs(rotation & 0xf) + 1) % 4);
5301 EXPORT_SYMBOL(drm_rotation_simplify);
5304 * drm_mode_config_init - initialize DRM mode_configuration structure
5307 * Initialize @dev's mode_config structure, used for tracking the graphics
5308 * configuration of @dev.
5310 * Since this initializes the modeset locks, no locking is possible. Which is no
5311 * problem, since this should happen single threaded at init time. It is the
5312 * driver's problem to ensure this guarantee.
5315 void drm_mode_config_init(struct drm_device *dev)
5317 mutex_init(&dev->mode_config.mutex);
5318 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5319 mutex_init(&dev->mode_config.idr_mutex);
5320 mutex_init(&dev->mode_config.fb_lock);
5321 INIT_LIST_HEAD(&dev->mode_config.fb_list);
5322 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5323 INIT_LIST_HEAD(&dev->mode_config.connector_list);
5324 INIT_LIST_HEAD(&dev->mode_config.bridge_list);
5325 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5326 INIT_LIST_HEAD(&dev->mode_config.property_list);
5327 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5328 INIT_LIST_HEAD(&dev->mode_config.plane_list);
5329 idr_init(&dev->mode_config.crtc_idr);
5330 idr_init(&dev->mode_config.tile_idr);
5332 drm_modeset_lock_all(dev);
5333 drm_mode_create_standard_properties(dev);
5334 drm_modeset_unlock_all(dev);
5336 /* Just to be sure */
5337 dev->mode_config.num_fb = 0;
5338 dev->mode_config.num_connector = 0;
5339 dev->mode_config.num_crtc = 0;
5340 dev->mode_config.num_encoder = 0;
5341 dev->mode_config.num_overlay_plane = 0;
5342 dev->mode_config.num_total_plane = 0;
5344 EXPORT_SYMBOL(drm_mode_config_init);
5347 * drm_mode_config_cleanup - free up DRM mode_config info
5350 * Free up all the connectors and CRTCs associated with this DRM device, then
5351 * free up the framebuffers and associated buffer objects.
5353 * Note that since this /should/ happen single-threaded at driver/device
5354 * teardown time, no locking is required. It's the driver's job to ensure that
5355 * this guarantee actually holds true.
5357 * FIXME: cleanup any dangling user buffer objects too
5359 void drm_mode_config_cleanup(struct drm_device *dev)
5361 struct drm_connector *connector, *ot;
5362 struct drm_crtc *crtc, *ct;
5363 struct drm_encoder *encoder, *enct;
5364 struct drm_bridge *bridge, *brt;
5365 struct drm_framebuffer *fb, *fbt;
5366 struct drm_property *property, *pt;
5367 struct drm_property_blob *blob, *bt;
5368 struct drm_plane *plane, *plt;
5370 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5372 encoder->funcs->destroy(encoder);
5375 list_for_each_entry_safe(bridge, brt,
5376 &dev->mode_config.bridge_list, head) {
5377 bridge->funcs->destroy(bridge);
5380 list_for_each_entry_safe(connector, ot,
5381 &dev->mode_config.connector_list, head) {
5382 connector->funcs->destroy(connector);
5385 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5387 drm_property_destroy(dev, property);
5390 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
5392 drm_property_destroy_blob(dev, blob);
5396 * Single-threaded teardown context, so it's not required to grab the
5397 * fb_lock to protect against concurrent fb_list access. Contrary, it
5398 * would actually deadlock with the drm_framebuffer_cleanup function.
5400 * Also, if there are any framebuffers left, that's a driver leak now,
5401 * so politely WARN about this.
5403 WARN_ON(!list_empty(&dev->mode_config.fb_list));
5404 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
5405 drm_framebuffer_remove(fb);
5408 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
5410 plane->funcs->destroy(plane);
5413 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
5414 crtc->funcs->destroy(crtc);
5417 idr_destroy(&dev->mode_config.tile_idr);
5418 idr_destroy(&dev->mode_config.crtc_idr);
5419 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
5421 EXPORT_SYMBOL(drm_mode_config_cleanup);
5423 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
5424 unsigned int supported_rotations)
5426 static const struct drm_prop_enum_list props[] = {
5427 { DRM_ROTATE_0, "rotate-0" },
5428 { DRM_ROTATE_90, "rotate-90" },
5429 { DRM_ROTATE_180, "rotate-180" },
5430 { DRM_ROTATE_270, "rotate-270" },
5431 { DRM_REFLECT_X, "reflect-x" },
5432 { DRM_REFLECT_Y, "reflect-y" },
5435 return drm_property_create_bitmask(dev, 0, "rotation",
5436 props, ARRAY_SIZE(props),
5437 supported_rotations);
5439 EXPORT_SYMBOL(drm_mode_create_rotation_property);
5444 * Tile groups are used to represent tiled monitors with a unique
5445 * integer identifier. Tiled monitors using DisplayID v1.3 have
5446 * a unique 8-byte handle, we store this in a tile group, so we
5447 * have a common identifier for all tiles in a monitor group.
5449 static void drm_tile_group_free(struct kref *kref)
5451 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
5452 struct drm_device *dev = tg->dev;
5453 mutex_lock(&dev->mode_config.idr_mutex);
5454 idr_remove(&dev->mode_config.tile_idr, tg->id);
5455 mutex_unlock(&dev->mode_config.idr_mutex);
5460 * drm_mode_put_tile_group - drop a reference to a tile group.
5462 * @tg: tile group to drop reference to.
5464 * drop reference to tile group and free if 0.
5466 void drm_mode_put_tile_group(struct drm_device *dev,
5467 struct drm_tile_group *tg)
5469 kref_put(&tg->refcount, drm_tile_group_free);
5473 * drm_mode_get_tile_group - get a reference to an existing tile group
5475 * @topology: 8-bytes unique per monitor.
5477 * Use the unique bytes to get a reference to an existing tile group.
5480 * tile group or NULL if not found.
5482 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
5485 struct drm_tile_group *tg;
5487 mutex_lock(&dev->mode_config.idr_mutex);
5488 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
5489 if (!memcmp(tg->group_data, topology, 8)) {
5490 if (!kref_get_unless_zero(&tg->refcount))
5492 mutex_unlock(&dev->mode_config.idr_mutex);
5496 mutex_unlock(&dev->mode_config.idr_mutex);
5501 * drm_mode_create_tile_group - create a tile group from a displayid description
5503 * @topology: 8-bytes unique per monitor.
5505 * Create a tile group for the unique monitor, and get a unique
5506 * identifier for the tile group.
5509 * new tile group or error.
5511 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
5514 struct drm_tile_group *tg;
5517 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
5519 return ERR_PTR(-ENOMEM);
5521 kref_init(&tg->refcount);
5522 memcpy(tg->group_data, topology, 8);
5525 mutex_lock(&dev->mode_config.idr_mutex);
5526 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
5534 mutex_unlock(&dev->mode_config.idr_mutex);