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>
42 #include "drm_crtc_internal.h"
43 #include "drm_internal.h"
45 static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
46 struct drm_mode_fb_cmd2 *r,
47 struct drm_file *file_priv);
49 /* Avoid boilerplate. I'm tired of typing. */
50 #define DRM_ENUM_NAME_FN(fnname, list) \
51 const char *fnname(int val) \
54 for (i = 0; i < ARRAY_SIZE(list); i++) { \
55 if (list[i].type == val) \
56 return list[i].name; \
64 static const struct drm_prop_enum_list drm_dpms_enum_list[] =
65 { { DRM_MODE_DPMS_ON, "On" },
66 { DRM_MODE_DPMS_STANDBY, "Standby" },
67 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
68 { DRM_MODE_DPMS_OFF, "Off" }
71 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
73 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[] =
85 { DRM_MODE_SCALE_NONE, "None" },
86 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
87 { DRM_MODE_SCALE_CENTER, "Center" },
88 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
91 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
92 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
93 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
94 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
98 * Non-global properties, but "required" for certain connectors.
100 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] =
102 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
103 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
104 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
107 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
109 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] =
111 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
112 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
113 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
116 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
117 drm_dvi_i_subconnector_enum_list)
119 static const struct drm_prop_enum_list drm_tv_select_enum_list[] =
121 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
122 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
123 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
124 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
125 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
128 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
130 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] =
132 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
133 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
134 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
135 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
136 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
139 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
140 drm_tv_subconnector_enum_list)
142 static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
143 { DRM_MODE_DIRTY_OFF, "Off" },
144 { DRM_MODE_DIRTY_ON, "On" },
145 { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
148 struct drm_conn_prop_enum_list {
155 * Connector and encoder types.
157 static struct drm_conn_prop_enum_list drm_connector_enum_list[] =
158 { { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
159 { DRM_MODE_CONNECTOR_VGA, "VGA" },
160 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
161 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
162 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
163 { DRM_MODE_CONNECTOR_Composite, "Composite" },
164 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
165 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
166 { DRM_MODE_CONNECTOR_Component, "Component" },
167 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
168 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
169 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
170 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
171 { DRM_MODE_CONNECTOR_TV, "TV" },
172 { DRM_MODE_CONNECTOR_eDP, "eDP" },
173 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
174 { DRM_MODE_CONNECTOR_DSI, "DSI" },
177 static const struct drm_prop_enum_list drm_encoder_enum_list[] =
178 { { DRM_MODE_ENCODER_NONE, "None" },
179 { DRM_MODE_ENCODER_DAC, "DAC" },
180 { DRM_MODE_ENCODER_TMDS, "TMDS" },
181 { DRM_MODE_ENCODER_LVDS, "LVDS" },
182 { DRM_MODE_ENCODER_TVDAC, "TV" },
183 { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
184 { DRM_MODE_ENCODER_DSI, "DSI" },
185 { DRM_MODE_ENCODER_DPMST, "DP MST" },
188 static const struct drm_prop_enum_list drm_subpixel_enum_list[] =
190 { SubPixelUnknown, "Unknown" },
191 { SubPixelHorizontalRGB, "Horizontal RGB" },
192 { SubPixelHorizontalBGR, "Horizontal BGR" },
193 { SubPixelVerticalRGB, "Vertical RGB" },
194 { SubPixelVerticalBGR, "Vertical BGR" },
195 { SubPixelNone, "None" },
198 void drm_connector_ida_init(void)
202 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
203 ida_init(&drm_connector_enum_list[i].ida);
206 void drm_connector_ida_destroy(void)
210 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
211 ida_destroy(&drm_connector_enum_list[i].ida);
215 * drm_get_connector_status_name - return a string for connector status
216 * @status: connector status to compute name of
218 * In contrast to the other drm_get_*_name functions this one here returns a
219 * const pointer and hence is threadsafe.
221 const char *drm_get_connector_status_name(enum drm_connector_status status)
223 if (status == connector_status_connected)
225 else if (status == connector_status_disconnected)
226 return "disconnected";
230 EXPORT_SYMBOL(drm_get_connector_status_name);
233 * drm_get_subpixel_order_name - return a string for a given subpixel enum
234 * @order: enum of subpixel_order
236 * Note you could abuse this and return something out of bounds, but that
237 * would be a caller error. No unscrubbed user data should make it here.
239 const char *drm_get_subpixel_order_name(enum subpixel_order order)
241 return drm_subpixel_enum_list[order].name;
243 EXPORT_SYMBOL(drm_get_subpixel_order_name);
245 static char printable_char(int c)
247 return isascii(c) && isprint(c) ? c : '?';
251 * drm_get_format_name - return a string for drm fourcc format
252 * @format: format to compute name of
254 * Note that the buffer used by this function is globally shared and owned by
255 * the function itself.
257 * FIXME: This isn't really multithreading safe.
259 const char *drm_get_format_name(uint32_t format)
263 snprintf(buf, sizeof(buf),
264 "%c%c%c%c %s-endian (0x%08x)",
265 printable_char(format & 0xff),
266 printable_char((format >> 8) & 0xff),
267 printable_char((format >> 16) & 0xff),
268 printable_char((format >> 24) & 0x7f),
269 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
274 EXPORT_SYMBOL(drm_get_format_name);
277 * Internal function to assign a slot in the object idr and optionally
278 * register the object into the idr.
280 static int drm_mode_object_get_reg(struct drm_device *dev,
281 struct drm_mode_object *obj,
287 mutex_lock(&dev->mode_config.idr_mutex);
288 ret = idr_alloc(&dev->mode_config.crtc_idr, register_obj ? obj : NULL, 1, 0, GFP_KERNEL);
291 * Set up the object linking under the protection of the idr
292 * lock so that other users can't see inconsistent state.
295 obj->type = obj_type;
297 mutex_unlock(&dev->mode_config.idr_mutex);
299 return ret < 0 ? ret : 0;
303 * drm_mode_object_get - allocate a new modeset identifier
305 * @obj: object pointer, used to generate unique ID
306 * @obj_type: object type
308 * Create a unique identifier based on @ptr in @dev's identifier space. Used
309 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
310 * modeset identifiers are _not_ reference counted. Hence don't use this for
311 * reference counted modeset objects like framebuffers.
314 * New unique (relative to other objects in @dev) integer identifier for the
317 int drm_mode_object_get(struct drm_device *dev,
318 struct drm_mode_object *obj, uint32_t obj_type)
320 return drm_mode_object_get_reg(dev, obj, obj_type, true);
323 static void drm_mode_object_register(struct drm_device *dev,
324 struct drm_mode_object *obj)
326 mutex_lock(&dev->mode_config.idr_mutex);
327 idr_replace(&dev->mode_config.crtc_idr, obj, obj->id);
328 mutex_unlock(&dev->mode_config.idr_mutex);
332 * drm_mode_object_put - free a modeset identifer
334 * @object: object to free
336 * Free @id from @dev's unique identifier pool. Note that despite the _get
337 * postfix modeset identifiers are _not_ reference counted. Hence don't use this
338 * for reference counted modeset objects like framebuffers.
340 void drm_mode_object_put(struct drm_device *dev,
341 struct drm_mode_object *object)
343 mutex_lock(&dev->mode_config.idr_mutex);
344 idr_remove(&dev->mode_config.crtc_idr, object->id);
345 mutex_unlock(&dev->mode_config.idr_mutex);
348 static struct drm_mode_object *_object_find(struct drm_device *dev,
349 uint32_t id, uint32_t type)
351 struct drm_mode_object *obj = NULL;
353 mutex_lock(&dev->mode_config.idr_mutex);
354 obj = idr_find(&dev->mode_config.crtc_idr, id);
355 if (obj && type != DRM_MODE_OBJECT_ANY && obj->type != type)
357 if (obj && obj->id != id)
359 /* don't leak out unref'd fb's */
360 if (obj && (obj->type == DRM_MODE_OBJECT_FB))
362 mutex_unlock(&dev->mode_config.idr_mutex);
368 * drm_mode_object_find - look up a drm object with static lifetime
370 * @id: id of the mode object
371 * @type: type of the mode object
373 * Note that framebuffers cannot be looked up with this functions - since those
374 * are reference counted, they need special treatment. Even with
375 * DRM_MODE_OBJECT_ANY (although that will simply return NULL
376 * rather than WARN_ON()).
378 struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
379 uint32_t id, uint32_t type)
381 struct drm_mode_object *obj = NULL;
383 /* Framebuffers are reference counted and need their own lookup
385 WARN_ON(type == DRM_MODE_OBJECT_FB);
386 obj = _object_find(dev, id, type);
389 EXPORT_SYMBOL(drm_mode_object_find);
392 * drm_framebuffer_init - initialize a framebuffer
394 * @fb: framebuffer to be initialized
395 * @funcs: ... with these functions
397 * Allocates an ID for the framebuffer's parent mode object, sets its mode
398 * functions & device file and adds it to the master fd list.
401 * This functions publishes the fb and makes it available for concurrent access
402 * by other users. Which means by this point the fb _must_ be fully set up -
403 * since all the fb attributes are invariant over its lifetime, no further
404 * locking but only correct reference counting is required.
407 * Zero on success, error code on failure.
409 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
410 const struct drm_framebuffer_funcs *funcs)
414 mutex_lock(&dev->mode_config.fb_lock);
415 kref_init(&fb->refcount);
416 INIT_LIST_HEAD(&fb->filp_head);
420 ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
424 dev->mode_config.num_fb++;
425 list_add(&fb->head, &dev->mode_config.fb_list);
427 mutex_unlock(&dev->mode_config.fb_lock);
431 EXPORT_SYMBOL(drm_framebuffer_init);
433 /* dev->mode_config.fb_lock must be held! */
434 static void __drm_framebuffer_unregister(struct drm_device *dev,
435 struct drm_framebuffer *fb)
437 mutex_lock(&dev->mode_config.idr_mutex);
438 idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
439 mutex_unlock(&dev->mode_config.idr_mutex);
444 static void drm_framebuffer_free(struct kref *kref)
446 struct drm_framebuffer *fb =
447 container_of(kref, struct drm_framebuffer, refcount);
448 struct drm_device *dev = fb->dev;
451 * The lookup idr holds a weak reference, which has not necessarily been
452 * removed at this point. Check for that.
454 mutex_lock(&dev->mode_config.fb_lock);
456 /* Mark fb as reaped and drop idr ref. */
457 __drm_framebuffer_unregister(dev, fb);
459 mutex_unlock(&dev->mode_config.fb_lock);
461 fb->funcs->destroy(fb);
464 static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
467 struct drm_mode_object *obj = NULL;
468 struct drm_framebuffer *fb;
470 mutex_lock(&dev->mode_config.idr_mutex);
471 obj = idr_find(&dev->mode_config.crtc_idr, id);
472 if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
476 mutex_unlock(&dev->mode_config.idr_mutex);
482 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
484 * @id: id of the fb object
486 * If successful, this grabs an additional reference to the framebuffer -
487 * callers need to make sure to eventually unreference the returned framebuffer
488 * again, using @drm_framebuffer_unreference.
490 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
493 struct drm_framebuffer *fb;
495 mutex_lock(&dev->mode_config.fb_lock);
496 fb = __drm_framebuffer_lookup(dev, id);
498 if (!kref_get_unless_zero(&fb->refcount))
501 mutex_unlock(&dev->mode_config.fb_lock);
505 EXPORT_SYMBOL(drm_framebuffer_lookup);
508 * drm_framebuffer_unreference - unref a framebuffer
509 * @fb: framebuffer to unref
511 * This functions decrements the fb's refcount and frees it if it drops to zero.
513 void drm_framebuffer_unreference(struct drm_framebuffer *fb)
515 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
516 kref_put(&fb->refcount, drm_framebuffer_free);
518 EXPORT_SYMBOL(drm_framebuffer_unreference);
521 * drm_framebuffer_reference - incr the fb refcnt
524 * This functions increments the fb's refcount.
526 void drm_framebuffer_reference(struct drm_framebuffer *fb)
528 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
529 kref_get(&fb->refcount);
531 EXPORT_SYMBOL(drm_framebuffer_reference);
533 static void drm_framebuffer_free_bug(struct kref *kref)
538 static void __drm_framebuffer_unreference(struct drm_framebuffer *fb)
540 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
541 kref_put(&fb->refcount, drm_framebuffer_free_bug);
545 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
546 * @fb: fb to unregister
548 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
549 * those used for fbdev. Note that the caller must hold a reference of it's own,
550 * i.e. the object may not be destroyed through this call (since it'll lead to a
551 * locking inversion).
553 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
555 struct drm_device *dev = fb->dev;
557 mutex_lock(&dev->mode_config.fb_lock);
558 /* Mark fb as reaped and drop idr ref. */
559 __drm_framebuffer_unregister(dev, fb);
560 mutex_unlock(&dev->mode_config.fb_lock);
562 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
565 * drm_framebuffer_cleanup - remove a framebuffer object
566 * @fb: framebuffer to remove
568 * Cleanup framebuffer. This function is intended to be used from the drivers
569 * ->destroy callback. It can also be used to clean up driver private
570 * framebuffers embedded into a larger structure.
572 * Note that this function does not remove the fb from active usuage - if it is
573 * still used anywhere, hilarity can ensue since userspace could call getfb on
574 * the id and get back -EINVAL. Obviously no concern at driver unload time.
576 * Also, the framebuffer will not be removed from the lookup idr - for
577 * user-created framebuffers this will happen in in the rmfb ioctl. For
578 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
579 * drm_framebuffer_unregister_private.
581 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
583 struct drm_device *dev = fb->dev;
585 mutex_lock(&dev->mode_config.fb_lock);
587 dev->mode_config.num_fb--;
588 mutex_unlock(&dev->mode_config.fb_lock);
590 EXPORT_SYMBOL(drm_framebuffer_cleanup);
593 * drm_framebuffer_remove - remove and unreference a framebuffer object
594 * @fb: framebuffer to remove
596 * Scans all the CRTCs and planes in @dev's mode_config. If they're
597 * using @fb, removes it, setting it to NULL. Then drops the reference to the
598 * passed-in framebuffer. Might take the modeset locks.
600 * Note that this function optimizes the cleanup away if the caller holds the
601 * last reference to the framebuffer. It is also guaranteed to not take the
602 * modeset locks in this case.
604 void drm_framebuffer_remove(struct drm_framebuffer *fb)
606 struct drm_device *dev = fb->dev;
607 struct drm_crtc *crtc;
608 struct drm_plane *plane;
609 struct drm_mode_set set;
612 WARN_ON(!list_empty(&fb->filp_head));
615 * drm ABI mandates that we remove any deleted framebuffers from active
616 * useage. But since most sane clients only remove framebuffers they no
617 * longer need, try to optimize this away.
619 * Since we're holding a reference ourselves, observing a refcount of 1
620 * means that we're the last holder and can skip it. Also, the refcount
621 * can never increase from 1 again, so we don't need any barriers or
624 * Note that userspace could try to race with use and instate a new
625 * usage _after_ we've cleared all current ones. End result will be an
626 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
629 if (atomic_read(&fb->refcount.refcount) > 1) {
630 drm_modeset_lock_all(dev);
631 /* remove from any CRTC */
632 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
633 if (crtc->primary->fb == fb) {
634 /* should turn off the crtc */
635 memset(&set, 0, sizeof(struct drm_mode_set));
638 ret = drm_mode_set_config_internal(&set);
640 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
644 list_for_each_entry(plane, &dev->mode_config.plane_list, head) {
646 drm_plane_force_disable(plane);
648 drm_modeset_unlock_all(dev);
651 drm_framebuffer_unreference(fb);
653 EXPORT_SYMBOL(drm_framebuffer_remove);
655 DEFINE_WW_CLASS(crtc_ww_class);
658 * drm_crtc_init_with_planes - Initialise a new CRTC object with
659 * specified primary and cursor planes.
661 * @crtc: CRTC object to init
662 * @primary: Primary plane for CRTC
663 * @cursor: Cursor plane for CRTC
664 * @funcs: callbacks for the new CRTC
666 * Inits a new object created as base part of a driver crtc object.
669 * Zero on success, error code on failure.
671 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
672 struct drm_plane *primary,
673 struct drm_plane *cursor,
674 const struct drm_crtc_funcs *funcs)
676 struct drm_mode_config *config = &dev->mode_config;
681 crtc->invert_dimensions = false;
683 drm_modeset_lock_init(&crtc->mutex);
684 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
688 crtc->base.properties = &crtc->properties;
690 list_add_tail(&crtc->head, &config->crtc_list);
693 crtc->primary = primary;
694 crtc->cursor = cursor;
696 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
698 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
702 EXPORT_SYMBOL(drm_crtc_init_with_planes);
705 * drm_crtc_cleanup - Clean up the core crtc usage
706 * @crtc: CRTC to cleanup
708 * This function cleans up @crtc and removes it from the DRM mode setting
709 * core. Note that the function does *not* free the crtc structure itself,
710 * this is the responsibility of the caller.
712 void drm_crtc_cleanup(struct drm_crtc *crtc)
714 struct drm_device *dev = crtc->dev;
716 kfree(crtc->gamma_store);
717 crtc->gamma_store = NULL;
719 drm_modeset_lock_fini(&crtc->mutex);
721 drm_mode_object_put(dev, &crtc->base);
722 list_del(&crtc->head);
723 dev->mode_config.num_crtc--;
725 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
726 if (crtc->state && crtc->funcs->atomic_destroy_state)
727 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
729 EXPORT_SYMBOL(drm_crtc_cleanup);
732 * drm_crtc_index - find the index of a registered CRTC
733 * @crtc: CRTC to find index for
735 * Given a registered CRTC, return the index of that CRTC within a DRM
736 * device's list of CRTCs.
738 unsigned int drm_crtc_index(struct drm_crtc *crtc)
740 unsigned int index = 0;
741 struct drm_crtc *tmp;
743 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
752 EXPORT_SYMBOL(drm_crtc_index);
755 * drm_mode_remove - remove and free a mode
756 * @connector: connector list to modify
757 * @mode: mode to remove
759 * Remove @mode from @connector's mode list, then free it.
761 static void drm_mode_remove(struct drm_connector *connector,
762 struct drm_display_mode *mode)
764 list_del(&mode->head);
765 drm_mode_destroy(connector->dev, mode);
769 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
770 * @connector: connector to quwery
772 * The kernel supports per-connector configration of its consoles through
773 * use of the video= parameter. This function parses that option and
774 * extracts the user's specified mode (or enable/disable status) for a
775 * particular connector. This is typically only used during the early fbdev
778 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
780 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
783 if (fb_get_options(connector->name, &option))
786 if (!drm_mode_parse_command_line_for_connector(option,
794 switch (mode->force) {
798 case DRM_FORCE_ON_DIGITAL:
807 DRM_INFO("forcing %s connector %s\n", connector->name, s);
808 connector->force = mode->force;
811 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
813 mode->xres, mode->yres,
814 mode->refresh_specified ? mode->refresh : 60,
815 mode->rb ? " reduced blanking" : "",
816 mode->margins ? " with margins" : "",
817 mode->interlace ? " interlaced" : "");
821 * drm_connector_init - Init a preallocated connector
823 * @connector: the connector to init
824 * @funcs: callbacks for this connector
825 * @connector_type: user visible type of the connector
827 * Initialises a preallocated connector. Connectors should be
828 * subclassed as part of driver connector objects.
831 * Zero on success, error code on failure.
833 int drm_connector_init(struct drm_device *dev,
834 struct drm_connector *connector,
835 const struct drm_connector_funcs *funcs,
839 struct ida *connector_ida =
840 &drm_connector_enum_list[connector_type].ida;
842 drm_modeset_lock_all(dev);
844 ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
848 connector->base.properties = &connector->properties;
849 connector->dev = dev;
850 connector->funcs = funcs;
851 connector->connector_type = connector_type;
852 connector->connector_type_id =
853 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
854 if (connector->connector_type_id < 0) {
855 ret = connector->connector_type_id;
859 kasprintf(GFP_KERNEL, "%s-%d",
860 drm_connector_enum_list[connector_type].name,
861 connector->connector_type_id);
862 if (!connector->name) {
867 INIT_LIST_HEAD(&connector->probed_modes);
868 INIT_LIST_HEAD(&connector->modes);
869 connector->edid_blob_ptr = NULL;
870 connector->status = connector_status_unknown;
872 drm_connector_get_cmdline_mode(connector);
874 /* We should add connectors at the end to avoid upsetting the connector
876 list_add_tail(&connector->head, &dev->mode_config.connector_list);
877 dev->mode_config.num_connector++;
879 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
880 drm_object_attach_property(&connector->base,
881 dev->mode_config.edid_property,
884 drm_object_attach_property(&connector->base,
885 dev->mode_config.dpms_property, 0);
887 connector->debugfs_entry = NULL;
891 drm_mode_object_put(dev, &connector->base);
894 drm_modeset_unlock_all(dev);
898 EXPORT_SYMBOL(drm_connector_init);
901 * drm_connector_cleanup - cleans up an initialised connector
902 * @connector: connector to cleanup
904 * Cleans up the connector but doesn't free the object.
906 void drm_connector_cleanup(struct drm_connector *connector)
908 struct drm_device *dev = connector->dev;
909 struct drm_display_mode *mode, *t;
911 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
912 drm_mode_remove(connector, mode);
914 list_for_each_entry_safe(mode, t, &connector->modes, head)
915 drm_mode_remove(connector, mode);
917 ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
918 connector->connector_type_id);
920 drm_mode_object_put(dev, &connector->base);
921 kfree(connector->name);
922 connector->name = NULL;
923 list_del(&connector->head);
924 dev->mode_config.num_connector--;
926 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
927 if (connector->state && connector->funcs->atomic_destroy_state)
928 connector->funcs->atomic_destroy_state(connector,
931 EXPORT_SYMBOL(drm_connector_cleanup);
934 * drm_connector_index - find the index of a registered connector
935 * @connector: connector to find index for
937 * Given a registered connector, return the index of that connector within a DRM
938 * device's list of connectors.
940 unsigned int drm_connector_index(struct drm_connector *connector)
942 unsigned int index = 0;
943 struct drm_connector *tmp;
944 struct drm_mode_config *config = &connector->dev->mode_config;
946 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
948 list_for_each_entry(tmp, &connector->dev->mode_config.connector_list, head) {
949 if (tmp == connector)
957 EXPORT_SYMBOL(drm_connector_index);
960 * drm_connector_register - register a connector
961 * @connector: the connector to register
963 * Register userspace interfaces for a connector
966 * Zero on success, error code on failure.
968 int drm_connector_register(struct drm_connector *connector)
972 drm_mode_object_register(connector->dev, &connector->base);
974 ret = drm_sysfs_connector_add(connector);
978 ret = drm_debugfs_connector_add(connector);
980 drm_sysfs_connector_remove(connector);
986 EXPORT_SYMBOL(drm_connector_register);
989 * drm_connector_unregister - unregister a connector
990 * @connector: the connector to unregister
992 * Unregister userspace interfaces for a connector
994 void drm_connector_unregister(struct drm_connector *connector)
996 drm_sysfs_connector_remove(connector);
997 drm_debugfs_connector_remove(connector);
999 EXPORT_SYMBOL(drm_connector_unregister);
1003 * drm_connector_unplug_all - unregister connector userspace interfaces
1006 * This function unregisters all connector userspace interfaces in sysfs. Should
1007 * be call when the device is disconnected, e.g. from an usb driver's
1008 * ->disconnect callback.
1010 void drm_connector_unplug_all(struct drm_device *dev)
1012 struct drm_connector *connector;
1014 /* taking the mode config mutex ends up in a clash with sysfs */
1015 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1016 drm_connector_unregister(connector);
1019 EXPORT_SYMBOL(drm_connector_unplug_all);
1022 * drm_bridge_init - initialize a drm transcoder/bridge
1024 * @bridge: transcoder/bridge to set up
1025 * @funcs: bridge function table
1027 * Initialises a preallocated bridge. Bridges should be
1028 * subclassed as part of driver connector objects.
1031 * Zero on success, error code on failure.
1033 int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
1034 const struct drm_bridge_funcs *funcs)
1038 drm_modeset_lock_all(dev);
1040 ret = drm_mode_object_get(dev, &bridge->base, DRM_MODE_OBJECT_BRIDGE);
1045 bridge->funcs = funcs;
1047 list_add_tail(&bridge->head, &dev->mode_config.bridge_list);
1048 dev->mode_config.num_bridge++;
1051 drm_modeset_unlock_all(dev);
1054 EXPORT_SYMBOL(drm_bridge_init);
1057 * drm_bridge_cleanup - cleans up an initialised bridge
1058 * @bridge: bridge to cleanup
1060 * Cleans up the bridge but doesn't free the object.
1062 void drm_bridge_cleanup(struct drm_bridge *bridge)
1064 struct drm_device *dev = bridge->dev;
1066 drm_modeset_lock_all(dev);
1067 drm_mode_object_put(dev, &bridge->base);
1068 list_del(&bridge->head);
1069 dev->mode_config.num_bridge--;
1070 drm_modeset_unlock_all(dev);
1072 EXPORT_SYMBOL(drm_bridge_cleanup);
1075 * drm_encoder_init - Init a preallocated encoder
1077 * @encoder: the encoder to init
1078 * @funcs: callbacks for this encoder
1079 * @encoder_type: user visible type of the encoder
1081 * Initialises a preallocated encoder. Encoder should be
1082 * subclassed as part of driver encoder objects.
1085 * Zero on success, error code on failure.
1087 int drm_encoder_init(struct drm_device *dev,
1088 struct drm_encoder *encoder,
1089 const struct drm_encoder_funcs *funcs,
1094 drm_modeset_lock_all(dev);
1096 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1101 encoder->encoder_type = encoder_type;
1102 encoder->funcs = funcs;
1103 encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1104 drm_encoder_enum_list[encoder_type].name,
1106 if (!encoder->name) {
1111 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1112 dev->mode_config.num_encoder++;
1116 drm_mode_object_put(dev, &encoder->base);
1119 drm_modeset_unlock_all(dev);
1123 EXPORT_SYMBOL(drm_encoder_init);
1126 * drm_encoder_cleanup - cleans up an initialised encoder
1127 * @encoder: encoder to cleanup
1129 * Cleans up the encoder but doesn't free the object.
1131 void drm_encoder_cleanup(struct drm_encoder *encoder)
1133 struct drm_device *dev = encoder->dev;
1134 drm_modeset_lock_all(dev);
1135 drm_mode_object_put(dev, &encoder->base);
1136 kfree(encoder->name);
1137 encoder->name = NULL;
1138 list_del(&encoder->head);
1139 dev->mode_config.num_encoder--;
1140 drm_modeset_unlock_all(dev);
1142 EXPORT_SYMBOL(drm_encoder_cleanup);
1145 * drm_universal_plane_init - Initialize a new universal plane object
1147 * @plane: plane object to init
1148 * @possible_crtcs: bitmask of possible CRTCs
1149 * @funcs: callbacks for the new plane
1150 * @formats: array of supported formats (%DRM_FORMAT_*)
1151 * @format_count: number of elements in @formats
1152 * @type: type of plane (overlay, primary, cursor)
1154 * Initializes a plane object of type @type.
1157 * Zero on success, error code on failure.
1159 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1160 unsigned long possible_crtcs,
1161 const struct drm_plane_funcs *funcs,
1162 const uint32_t *formats, uint32_t format_count,
1163 enum drm_plane_type type)
1167 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1171 drm_modeset_lock_init(&plane->mutex);
1173 plane->base.properties = &plane->properties;
1175 plane->funcs = funcs;
1176 plane->format_types = kmalloc(sizeof(uint32_t) * format_count,
1178 if (!plane->format_types) {
1179 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1180 drm_mode_object_put(dev, &plane->base);
1184 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1185 plane->format_count = format_count;
1186 plane->possible_crtcs = possible_crtcs;
1189 list_add_tail(&plane->head, &dev->mode_config.plane_list);
1190 dev->mode_config.num_total_plane++;
1191 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1192 dev->mode_config.num_overlay_plane++;
1194 drm_object_attach_property(&plane->base,
1195 dev->mode_config.plane_type_property,
1200 EXPORT_SYMBOL(drm_universal_plane_init);
1203 * drm_plane_init - Initialize a legacy plane
1205 * @plane: plane object to init
1206 * @possible_crtcs: bitmask of possible CRTCs
1207 * @funcs: callbacks for the new plane
1208 * @formats: array of supported formats (%DRM_FORMAT_*)
1209 * @format_count: number of elements in @formats
1210 * @is_primary: plane type (primary vs overlay)
1212 * Legacy API to initialize a DRM plane.
1214 * New drivers should call drm_universal_plane_init() instead.
1217 * Zero on success, error code on failure.
1219 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1220 unsigned long possible_crtcs,
1221 const struct drm_plane_funcs *funcs,
1222 const uint32_t *formats, uint32_t format_count,
1225 enum drm_plane_type type;
1227 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1228 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1229 formats, format_count, type);
1231 EXPORT_SYMBOL(drm_plane_init);
1234 * drm_plane_cleanup - Clean up the core plane usage
1235 * @plane: plane to cleanup
1237 * This function cleans up @plane and removes it from the DRM mode setting
1238 * core. Note that the function does *not* free the plane structure itself,
1239 * this is the responsibility of the caller.
1241 void drm_plane_cleanup(struct drm_plane *plane)
1243 struct drm_device *dev = plane->dev;
1245 drm_modeset_lock_all(dev);
1246 kfree(plane->format_types);
1247 drm_mode_object_put(dev, &plane->base);
1249 BUG_ON(list_empty(&plane->head));
1251 list_del(&plane->head);
1252 dev->mode_config.num_total_plane--;
1253 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1254 dev->mode_config.num_overlay_plane--;
1255 drm_modeset_unlock_all(dev);
1257 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1258 if (plane->state && plane->funcs->atomic_destroy_state)
1259 plane->funcs->atomic_destroy_state(plane, plane->state);
1261 EXPORT_SYMBOL(drm_plane_cleanup);
1264 * drm_plane_index - find the index of a registered plane
1265 * @plane: plane to find index for
1267 * Given a registered plane, return the index of that CRTC within a DRM
1268 * device's list of planes.
1270 unsigned int drm_plane_index(struct drm_plane *plane)
1272 unsigned int index = 0;
1273 struct drm_plane *tmp;
1275 list_for_each_entry(tmp, &plane->dev->mode_config.plane_list, head) {
1284 EXPORT_SYMBOL(drm_plane_index);
1287 * drm_plane_force_disable - Forcibly disable a plane
1288 * @plane: plane to disable
1290 * Forces the plane to be disabled.
1292 * Used when the plane's current framebuffer is destroyed,
1293 * and when restoring fbdev mode.
1295 void drm_plane_force_disable(struct drm_plane *plane)
1302 plane->old_fb = plane->fb;
1303 ret = plane->funcs->disable_plane(plane);
1305 DRM_ERROR("failed to disable plane with busy fb\n");
1306 plane->old_fb = NULL;
1309 /* disconnect the plane from the fb and crtc: */
1310 __drm_framebuffer_unreference(plane->old_fb);
1311 plane->old_fb = NULL;
1315 EXPORT_SYMBOL(drm_plane_force_disable);
1317 static int drm_mode_create_standard_connector_properties(struct drm_device *dev)
1319 struct drm_property *edid;
1320 struct drm_property *dpms;
1321 struct drm_property *dev_path;
1324 * Standard properties (apply to all connectors)
1326 edid = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1327 DRM_MODE_PROP_IMMUTABLE,
1329 dev->mode_config.edid_property = edid;
1331 dpms = drm_property_create_enum(dev, 0,
1332 "DPMS", drm_dpms_enum_list,
1333 ARRAY_SIZE(drm_dpms_enum_list));
1334 dev->mode_config.dpms_property = dpms;
1336 dev_path = drm_property_create(dev,
1337 DRM_MODE_PROP_BLOB |
1338 DRM_MODE_PROP_IMMUTABLE,
1340 dev->mode_config.path_property = dev_path;
1345 static int drm_mode_create_standard_plane_properties(struct drm_device *dev)
1347 struct drm_property *type;
1350 * Standard properties (apply to all planes)
1352 type = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1353 "type", drm_plane_type_enum_list,
1354 ARRAY_SIZE(drm_plane_type_enum_list));
1355 dev->mode_config.plane_type_property = type;
1361 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1364 * Called by a driver the first time a DVI-I connector is made.
1366 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1368 struct drm_property *dvi_i_selector;
1369 struct drm_property *dvi_i_subconnector;
1371 if (dev->mode_config.dvi_i_select_subconnector_property)
1375 drm_property_create_enum(dev, 0,
1376 "select subconnector",
1377 drm_dvi_i_select_enum_list,
1378 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1379 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1381 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1383 drm_dvi_i_subconnector_enum_list,
1384 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1385 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1389 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1392 * drm_create_tv_properties - create TV specific connector properties
1394 * @num_modes: number of different TV formats (modes) supported
1395 * @modes: array of pointers to strings containing name of each format
1397 * Called by a driver's TV initialization routine, this function creates
1398 * the TV specific connector properties for a given device. Caller is
1399 * responsible for allocating a list of format names and passing them to
1402 int drm_mode_create_tv_properties(struct drm_device *dev,
1403 unsigned int num_modes,
1406 struct drm_property *tv_selector;
1407 struct drm_property *tv_subconnector;
1410 if (dev->mode_config.tv_select_subconnector_property)
1414 * Basic connector properties
1416 tv_selector = drm_property_create_enum(dev, 0,
1417 "select subconnector",
1418 drm_tv_select_enum_list,
1419 ARRAY_SIZE(drm_tv_select_enum_list));
1420 dev->mode_config.tv_select_subconnector_property = tv_selector;
1423 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1425 drm_tv_subconnector_enum_list,
1426 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1427 dev->mode_config.tv_subconnector_property = tv_subconnector;
1430 * Other, TV specific properties: margins & TV modes.
1432 dev->mode_config.tv_left_margin_property =
1433 drm_property_create_range(dev, 0, "left margin", 0, 100);
1435 dev->mode_config.tv_right_margin_property =
1436 drm_property_create_range(dev, 0, "right margin", 0, 100);
1438 dev->mode_config.tv_top_margin_property =
1439 drm_property_create_range(dev, 0, "top margin", 0, 100);
1441 dev->mode_config.tv_bottom_margin_property =
1442 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1444 dev->mode_config.tv_mode_property =
1445 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1447 for (i = 0; i < num_modes; i++)
1448 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1451 dev->mode_config.tv_brightness_property =
1452 drm_property_create_range(dev, 0, "brightness", 0, 100);
1454 dev->mode_config.tv_contrast_property =
1455 drm_property_create_range(dev, 0, "contrast", 0, 100);
1457 dev->mode_config.tv_flicker_reduction_property =
1458 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1460 dev->mode_config.tv_overscan_property =
1461 drm_property_create_range(dev, 0, "overscan", 0, 100);
1463 dev->mode_config.tv_saturation_property =
1464 drm_property_create_range(dev, 0, "saturation", 0, 100);
1466 dev->mode_config.tv_hue_property =
1467 drm_property_create_range(dev, 0, "hue", 0, 100);
1471 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1474 * drm_mode_create_scaling_mode_property - create scaling mode property
1477 * Called by a driver the first time it's needed, must be attached to desired
1480 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1482 struct drm_property *scaling_mode;
1484 if (dev->mode_config.scaling_mode_property)
1488 drm_property_create_enum(dev, 0, "scaling mode",
1489 drm_scaling_mode_enum_list,
1490 ARRAY_SIZE(drm_scaling_mode_enum_list));
1492 dev->mode_config.scaling_mode_property = scaling_mode;
1496 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1499 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1502 * Called by a driver the first time it's needed, must be attached to desired
1506 * Zero on success, negative errno on failure.
1508 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1510 if (dev->mode_config.aspect_ratio_property)
1513 dev->mode_config.aspect_ratio_property =
1514 drm_property_create_enum(dev, 0, "aspect ratio",
1515 drm_aspect_ratio_enum_list,
1516 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1518 if (dev->mode_config.aspect_ratio_property == NULL)
1523 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1526 * drm_mode_create_dirty_property - create dirty property
1529 * Called by a driver the first time it's needed, must be attached to desired
1532 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1534 struct drm_property *dirty_info;
1536 if (dev->mode_config.dirty_info_property)
1540 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1542 drm_dirty_info_enum_list,
1543 ARRAY_SIZE(drm_dirty_info_enum_list));
1544 dev->mode_config.dirty_info_property = dirty_info;
1548 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1551 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1554 * Create the the suggested x/y offset property for connectors.
1556 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1558 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1561 dev->mode_config.suggested_x_property =
1562 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1564 dev->mode_config.suggested_y_property =
1565 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1567 if (dev->mode_config.suggested_x_property == NULL ||
1568 dev->mode_config.suggested_y_property == NULL)
1572 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1574 static int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
1576 uint32_t total_objects = 0;
1578 total_objects += dev->mode_config.num_crtc;
1579 total_objects += dev->mode_config.num_connector;
1580 total_objects += dev->mode_config.num_encoder;
1581 total_objects += dev->mode_config.num_bridge;
1583 group->id_list = kzalloc(total_objects * sizeof(uint32_t), GFP_KERNEL);
1584 if (!group->id_list)
1587 group->num_crtcs = 0;
1588 group->num_connectors = 0;
1589 group->num_encoders = 0;
1590 group->num_bridges = 0;
1594 void drm_mode_group_destroy(struct drm_mode_group *group)
1596 kfree(group->id_list);
1597 group->id_list = NULL;
1601 * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1602 * the drm core's responsibility to set up mode control groups.
1604 int drm_mode_group_init_legacy_group(struct drm_device *dev,
1605 struct drm_mode_group *group)
1607 struct drm_crtc *crtc;
1608 struct drm_encoder *encoder;
1609 struct drm_connector *connector;
1610 struct drm_bridge *bridge;
1613 if ((ret = drm_mode_group_init(dev, group)))
1616 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
1617 group->id_list[group->num_crtcs++] = crtc->base.id;
1619 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
1620 group->id_list[group->num_crtcs + group->num_encoders++] =
1623 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1624 group->id_list[group->num_crtcs + group->num_encoders +
1625 group->num_connectors++] = connector->base.id;
1627 list_for_each_entry(bridge, &dev->mode_config.bridge_list, head)
1628 group->id_list[group->num_crtcs + group->num_encoders +
1629 group->num_connectors + group->num_bridges++] =
1634 EXPORT_SYMBOL(drm_mode_group_init_legacy_group);
1636 void drm_reinit_primary_mode_group(struct drm_device *dev)
1638 drm_modeset_lock_all(dev);
1639 drm_mode_group_destroy(&dev->primary->mode_group);
1640 drm_mode_group_init_legacy_group(dev, &dev->primary->mode_group);
1641 drm_modeset_unlock_all(dev);
1643 EXPORT_SYMBOL(drm_reinit_primary_mode_group);
1646 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1647 * @out: drm_mode_modeinfo struct to return to the user
1648 * @in: drm_display_mode to use
1650 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1653 static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
1654 const struct drm_display_mode *in)
1656 WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1657 in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1658 in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1659 in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1660 in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1661 "timing values too large for mode info\n");
1663 out->clock = in->clock;
1664 out->hdisplay = in->hdisplay;
1665 out->hsync_start = in->hsync_start;
1666 out->hsync_end = in->hsync_end;
1667 out->htotal = in->htotal;
1668 out->hskew = in->hskew;
1669 out->vdisplay = in->vdisplay;
1670 out->vsync_start = in->vsync_start;
1671 out->vsync_end = in->vsync_end;
1672 out->vtotal = in->vtotal;
1673 out->vscan = in->vscan;
1674 out->vrefresh = in->vrefresh;
1675 out->flags = in->flags;
1676 out->type = in->type;
1677 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1678 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1682 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1683 * @out: drm_display_mode to return to the user
1684 * @in: drm_mode_modeinfo to use
1686 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1690 * Zero on success, negative errno on failure.
1692 static int drm_crtc_convert_umode(struct drm_display_mode *out,
1693 const struct drm_mode_modeinfo *in)
1695 if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1698 if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1701 out->clock = in->clock;
1702 out->hdisplay = in->hdisplay;
1703 out->hsync_start = in->hsync_start;
1704 out->hsync_end = in->hsync_end;
1705 out->htotal = in->htotal;
1706 out->hskew = in->hskew;
1707 out->vdisplay = in->vdisplay;
1708 out->vsync_start = in->vsync_start;
1709 out->vsync_end = in->vsync_end;
1710 out->vtotal = in->vtotal;
1711 out->vscan = in->vscan;
1712 out->vrefresh = in->vrefresh;
1713 out->flags = in->flags;
1714 out->type = in->type;
1715 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1716 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1722 * drm_mode_getresources - get graphics configuration
1723 * @dev: drm device for the ioctl
1724 * @data: data pointer for the ioctl
1725 * @file_priv: drm file for the ioctl call
1727 * Construct a set of configuration description structures and return
1728 * them to the user, including CRTC, connector and framebuffer configuration.
1730 * Called by the user via ioctl.
1733 * Zero on success, negative errno on failure.
1735 int drm_mode_getresources(struct drm_device *dev, void *data,
1736 struct drm_file *file_priv)
1738 struct drm_mode_card_res *card_res = data;
1739 struct list_head *lh;
1740 struct drm_framebuffer *fb;
1741 struct drm_connector *connector;
1742 struct drm_crtc *crtc;
1743 struct drm_encoder *encoder;
1745 int connector_count = 0;
1748 int encoder_count = 0;
1750 uint32_t __user *fb_id;
1751 uint32_t __user *crtc_id;
1752 uint32_t __user *connector_id;
1753 uint32_t __user *encoder_id;
1754 struct drm_mode_group *mode_group;
1756 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1760 mutex_lock(&file_priv->fbs_lock);
1762 * For the non-control nodes we need to limit the list of resources
1763 * by IDs in the group list for this node
1765 list_for_each(lh, &file_priv->fbs)
1768 /* handle this in 4 parts */
1770 if (card_res->count_fbs >= fb_count) {
1772 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1773 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1774 if (put_user(fb->base.id, fb_id + copied)) {
1775 mutex_unlock(&file_priv->fbs_lock);
1781 card_res->count_fbs = fb_count;
1782 mutex_unlock(&file_priv->fbs_lock);
1784 /* mode_config.mutex protects the connector list against e.g. DP MST
1785 * connector hot-adding. CRTC/Plane lists are invariant. */
1786 mutex_lock(&dev->mode_config.mutex);
1787 if (!drm_is_primary_client(file_priv)) {
1790 list_for_each(lh, &dev->mode_config.crtc_list)
1793 list_for_each(lh, &dev->mode_config.connector_list)
1796 list_for_each(lh, &dev->mode_config.encoder_list)
1800 mode_group = &file_priv->master->minor->mode_group;
1801 crtc_count = mode_group->num_crtcs;
1802 connector_count = mode_group->num_connectors;
1803 encoder_count = mode_group->num_encoders;
1806 card_res->max_height = dev->mode_config.max_height;
1807 card_res->min_height = dev->mode_config.min_height;
1808 card_res->max_width = dev->mode_config.max_width;
1809 card_res->min_width = dev->mode_config.min_width;
1812 if (card_res->count_crtcs >= crtc_count) {
1814 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1816 list_for_each_entry(crtc, &dev->mode_config.crtc_list,
1818 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1819 if (put_user(crtc->base.id, crtc_id + copied)) {
1826 for (i = 0; i < mode_group->num_crtcs; i++) {
1827 if (put_user(mode_group->id_list[i],
1828 crtc_id + copied)) {
1836 card_res->count_crtcs = crtc_count;
1839 if (card_res->count_encoders >= encoder_count) {
1841 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1843 list_for_each_entry(encoder,
1844 &dev->mode_config.encoder_list,
1846 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1848 if (put_user(encoder->base.id, encoder_id +
1856 for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
1857 if (put_user(mode_group->id_list[i],
1858 encoder_id + copied)) {
1867 card_res->count_encoders = encoder_count;
1870 if (card_res->count_connectors >= connector_count) {
1872 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1874 list_for_each_entry(connector,
1875 &dev->mode_config.connector_list,
1877 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1880 if (put_user(connector->base.id,
1881 connector_id + copied)) {
1888 int start = mode_group->num_crtcs +
1889 mode_group->num_encoders;
1890 for (i = start; i < start + mode_group->num_connectors; i++) {
1891 if (put_user(mode_group->id_list[i],
1892 connector_id + copied)) {
1900 card_res->count_connectors = connector_count;
1902 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1903 card_res->count_connectors, card_res->count_encoders);
1906 mutex_unlock(&dev->mode_config.mutex);
1911 * drm_mode_getcrtc - get CRTC configuration
1912 * @dev: drm device for the ioctl
1913 * @data: data pointer for the ioctl
1914 * @file_priv: drm file for the ioctl call
1916 * Construct a CRTC configuration structure to return to the user.
1918 * Called by the user via ioctl.
1921 * Zero on success, negative errno on failure.
1923 int drm_mode_getcrtc(struct drm_device *dev,
1924 void *data, struct drm_file *file_priv)
1926 struct drm_mode_crtc *crtc_resp = data;
1927 struct drm_crtc *crtc;
1929 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1932 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
1936 drm_modeset_lock_crtc(crtc, crtc->primary);
1937 crtc_resp->x = crtc->x;
1938 crtc_resp->y = crtc->y;
1939 crtc_resp->gamma_size = crtc->gamma_size;
1940 if (crtc->primary->fb)
1941 crtc_resp->fb_id = crtc->primary->fb->base.id;
1943 crtc_resp->fb_id = 0;
1945 if (crtc->enabled) {
1947 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
1948 crtc_resp->mode_valid = 1;
1951 crtc_resp->mode_valid = 0;
1953 drm_modeset_unlock_crtc(crtc);
1958 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
1959 const struct drm_file *file_priv)
1962 * If user-space hasn't configured the driver to expose the stereo 3D
1963 * modes, don't expose them.
1965 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
1972 * drm_mode_getconnector - get connector configuration
1973 * @dev: drm device for the ioctl
1974 * @data: data pointer for the ioctl
1975 * @file_priv: drm file for the ioctl call
1977 * Construct a connector configuration structure to return to the user.
1979 * Called by the user via ioctl.
1982 * Zero on success, negative errno on failure.
1984 int drm_mode_getconnector(struct drm_device *dev, void *data,
1985 struct drm_file *file_priv)
1987 struct drm_mode_get_connector *out_resp = data;
1988 struct drm_connector *connector;
1989 struct drm_display_mode *mode;
1991 int props_count = 0;
1992 int encoders_count = 0;
1996 struct drm_mode_modeinfo u_mode;
1997 struct drm_mode_modeinfo __user *mode_ptr;
1998 uint32_t __user *prop_ptr;
1999 uint64_t __user *prop_values;
2000 uint32_t __user *encoder_ptr;
2002 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2005 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2007 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2009 mutex_lock(&dev->mode_config.mutex);
2011 connector = drm_connector_find(dev, out_resp->connector_id);
2017 props_count = connector->properties.count;
2019 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2020 if (connector->encoder_ids[i] != 0) {
2025 if (out_resp->count_modes == 0) {
2026 connector->funcs->fill_modes(connector,
2027 dev->mode_config.max_width,
2028 dev->mode_config.max_height);
2031 /* delayed so we get modes regardless of pre-fill_modes state */
2032 list_for_each_entry(mode, &connector->modes, head)
2033 if (drm_mode_expose_to_userspace(mode, file_priv))
2036 out_resp->connector_id = connector->base.id;
2037 out_resp->connector_type = connector->connector_type;
2038 out_resp->connector_type_id = connector->connector_type_id;
2039 out_resp->mm_width = connector->display_info.width_mm;
2040 out_resp->mm_height = connector->display_info.height_mm;
2041 out_resp->subpixel = connector->display_info.subpixel_order;
2042 out_resp->connection = connector->status;
2043 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2044 if (connector->encoder)
2045 out_resp->encoder_id = connector->encoder->base.id;
2047 out_resp->encoder_id = 0;
2048 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2051 * This ioctl is called twice, once to determine how much space is
2052 * needed, and the 2nd time to fill it.
2054 if ((out_resp->count_modes >= mode_count) && mode_count) {
2056 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2057 list_for_each_entry(mode, &connector->modes, head) {
2058 if (!drm_mode_expose_to_userspace(mode, file_priv))
2061 drm_crtc_convert_to_umode(&u_mode, mode);
2062 if (copy_to_user(mode_ptr + copied,
2063 &u_mode, sizeof(u_mode))) {
2070 out_resp->count_modes = mode_count;
2072 if ((out_resp->count_props >= props_count) && props_count) {
2074 prop_ptr = (uint32_t __user *)(unsigned long)(out_resp->props_ptr);
2075 prop_values = (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr);
2076 for (i = 0; i < connector->properties.count; i++) {
2077 if (put_user(connector->properties.ids[i],
2078 prop_ptr + copied)) {
2083 if (put_user(connector->properties.values[i],
2084 prop_values + copied)) {
2091 out_resp->count_props = props_count;
2093 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2095 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2096 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2097 if (connector->encoder_ids[i] != 0) {
2098 if (put_user(connector->encoder_ids[i],
2099 encoder_ptr + copied)) {
2107 out_resp->count_encoders = encoders_count;
2110 mutex_unlock(&dev->mode_config.mutex);
2116 * drm_mode_getencoder - get encoder configuration
2117 * @dev: drm device for the ioctl
2118 * @data: data pointer for the ioctl
2119 * @file_priv: drm file for the ioctl call
2121 * Construct a encoder configuration structure to return to the user.
2123 * Called by the user via ioctl.
2126 * Zero on success, negative errno on failure.
2128 int drm_mode_getencoder(struct drm_device *dev, void *data,
2129 struct drm_file *file_priv)
2131 struct drm_mode_get_encoder *enc_resp = data;
2132 struct drm_encoder *encoder;
2134 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2137 encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2141 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2143 enc_resp->crtc_id = encoder->crtc->base.id;
2145 enc_resp->crtc_id = 0;
2146 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2148 enc_resp->encoder_type = encoder->encoder_type;
2149 enc_resp->encoder_id = encoder->base.id;
2150 enc_resp->possible_crtcs = encoder->possible_crtcs;
2151 enc_resp->possible_clones = encoder->possible_clones;
2157 * drm_mode_getplane_res - enumerate all plane resources
2160 * @file_priv: DRM file info
2162 * Construct a list of plane ids to return to the user.
2164 * Called by the user via ioctl.
2167 * Zero on success, negative errno on failure.
2169 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2170 struct drm_file *file_priv)
2172 struct drm_mode_get_plane_res *plane_resp = data;
2173 struct drm_mode_config *config;
2174 struct drm_plane *plane;
2175 uint32_t __user *plane_ptr;
2177 unsigned num_planes;
2179 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2182 config = &dev->mode_config;
2184 if (file_priv->universal_planes)
2185 num_planes = config->num_total_plane;
2187 num_planes = config->num_overlay_plane;
2190 * This ioctl is called twice, once to determine how much space is
2191 * needed, and the 2nd time to fill it.
2194 (plane_resp->count_planes >= num_planes)) {
2195 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2197 /* Plane lists are invariant, no locking needed. */
2198 list_for_each_entry(plane, &config->plane_list, head) {
2200 * Unless userspace set the 'universal planes'
2201 * capability bit, only advertise overlays.
2203 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2204 !file_priv->universal_planes)
2207 if (put_user(plane->base.id, plane_ptr + copied))
2212 plane_resp->count_planes = num_planes;
2218 * drm_mode_getplane - get plane configuration
2221 * @file_priv: DRM file info
2223 * Construct a plane configuration structure to return to the user.
2225 * Called by the user via ioctl.
2228 * Zero on success, negative errno on failure.
2230 int drm_mode_getplane(struct drm_device *dev, void *data,
2231 struct drm_file *file_priv)
2233 struct drm_mode_get_plane *plane_resp = data;
2234 struct drm_plane *plane;
2235 uint32_t __user *format_ptr;
2237 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2240 plane = drm_plane_find(dev, plane_resp->plane_id);
2244 drm_modeset_lock(&plane->mutex, NULL);
2246 plane_resp->crtc_id = plane->crtc->base.id;
2248 plane_resp->crtc_id = 0;
2251 plane_resp->fb_id = plane->fb->base.id;
2253 plane_resp->fb_id = 0;
2254 drm_modeset_unlock(&plane->mutex);
2256 plane_resp->plane_id = plane->base.id;
2257 plane_resp->possible_crtcs = plane->possible_crtcs;
2258 plane_resp->gamma_size = 0;
2261 * This ioctl is called twice, once to determine how much space is
2262 * needed, and the 2nd time to fill it.
2264 if (plane->format_count &&
2265 (plane_resp->count_format_types >= plane->format_count)) {
2266 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2267 if (copy_to_user(format_ptr,
2268 plane->format_types,
2269 sizeof(uint32_t) * plane->format_count)) {
2273 plane_resp->count_format_types = plane->format_count;
2279 * setplane_internal - setplane handler for internal callers
2281 * Note that we assume an extra reference has already been taken on fb. If the
2282 * update fails, this reference will be dropped before return; if it succeeds,
2283 * the previous framebuffer (if any) will be unreferenced instead.
2285 * src_{x,y,w,h} are provided in 16.16 fixed point format
2287 static int __setplane_internal(struct drm_plane *plane,
2288 struct drm_crtc *crtc,
2289 struct drm_framebuffer *fb,
2290 int32_t crtc_x, int32_t crtc_y,
2291 uint32_t crtc_w, uint32_t crtc_h,
2292 /* src_{x,y,w,h} values are 16.16 fixed point */
2293 uint32_t src_x, uint32_t src_y,
2294 uint32_t src_w, uint32_t src_h)
2297 unsigned int fb_width, fb_height;
2300 /* No fb means shut it down */
2302 plane->old_fb = plane->fb;
2303 ret = plane->funcs->disable_plane(plane);
2308 plane->old_fb = NULL;
2313 /* Check whether this plane is usable on this CRTC */
2314 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2315 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2320 /* Check whether this plane supports the fb pixel format. */
2321 for (i = 0; i < plane->format_count; i++)
2322 if (fb->pixel_format == plane->format_types[i])
2324 if (i == plane->format_count) {
2325 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2326 drm_get_format_name(fb->pixel_format));
2331 fb_width = fb->width << 16;
2332 fb_height = fb->height << 16;
2334 /* Make sure source coordinates are inside the fb. */
2335 if (src_w > fb_width ||
2336 src_x > fb_width - src_w ||
2337 src_h > fb_height ||
2338 src_y > fb_height - src_h) {
2339 DRM_DEBUG_KMS("Invalid source coordinates "
2340 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2341 src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2342 src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2343 src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2344 src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2349 plane->old_fb = plane->fb;
2350 ret = plane->funcs->update_plane(plane, crtc, fb,
2351 crtc_x, crtc_y, crtc_w, crtc_h,
2352 src_x, src_y, src_w, src_h);
2358 plane->old_fb = NULL;
2363 drm_framebuffer_unreference(fb);
2365 drm_framebuffer_unreference(plane->old_fb);
2366 plane->old_fb = NULL;
2371 static int setplane_internal(struct drm_plane *plane,
2372 struct drm_crtc *crtc,
2373 struct drm_framebuffer *fb,
2374 int32_t crtc_x, int32_t crtc_y,
2375 uint32_t crtc_w, uint32_t crtc_h,
2376 /* src_{x,y,w,h} values are 16.16 fixed point */
2377 uint32_t src_x, uint32_t src_y,
2378 uint32_t src_w, uint32_t src_h)
2382 drm_modeset_lock_all(plane->dev);
2383 ret = __setplane_internal(plane, crtc, fb,
2384 crtc_x, crtc_y, crtc_w, crtc_h,
2385 src_x, src_y, src_w, src_h);
2386 drm_modeset_unlock_all(plane->dev);
2392 * drm_mode_setplane - configure a plane's configuration
2394 * @data: ioctl data*
2395 * @file_priv: DRM file info
2397 * Set plane configuration, including placement, fb, scaling, and other factors.
2398 * Or pass a NULL fb to disable (planes may be disabled without providing a
2402 * Zero on success, negative errno on failure.
2404 int drm_mode_setplane(struct drm_device *dev, void *data,
2405 struct drm_file *file_priv)
2407 struct drm_mode_set_plane *plane_req = data;
2408 struct drm_mode_object *obj;
2409 struct drm_plane *plane;
2410 struct drm_crtc *crtc = NULL;
2411 struct drm_framebuffer *fb = NULL;
2413 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2416 /* Give drivers some help against integer overflows */
2417 if (plane_req->crtc_w > INT_MAX ||
2418 plane_req->crtc_x > INT_MAX - (int32_t) plane_req->crtc_w ||
2419 plane_req->crtc_h > INT_MAX ||
2420 plane_req->crtc_y > INT_MAX - (int32_t) plane_req->crtc_h) {
2421 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2422 plane_req->crtc_w, plane_req->crtc_h,
2423 plane_req->crtc_x, plane_req->crtc_y);
2428 * First, find the plane, crtc, and fb objects. If not available,
2429 * we don't bother to call the driver.
2431 obj = drm_mode_object_find(dev, plane_req->plane_id,
2432 DRM_MODE_OBJECT_PLANE);
2434 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2435 plane_req->plane_id);
2438 plane = obj_to_plane(obj);
2440 if (plane_req->fb_id) {
2441 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2443 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2448 obj = drm_mode_object_find(dev, plane_req->crtc_id,
2449 DRM_MODE_OBJECT_CRTC);
2451 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2452 plane_req->crtc_id);
2455 crtc = obj_to_crtc(obj);
2459 * setplane_internal will take care of deref'ing either the old or new
2460 * framebuffer depending on success.
2462 return setplane_internal(plane, crtc, fb,
2463 plane_req->crtc_x, plane_req->crtc_y,
2464 plane_req->crtc_w, plane_req->crtc_h,
2465 plane_req->src_x, plane_req->src_y,
2466 plane_req->src_w, plane_req->src_h);
2470 * drm_mode_set_config_internal - helper to call ->set_config
2471 * @set: modeset config to set
2473 * This is a little helper to wrap internal calls to the ->set_config driver
2474 * interface. The only thing it adds is correct refcounting dance.
2477 * Zero on success, negative errno on failure.
2479 int drm_mode_set_config_internal(struct drm_mode_set *set)
2481 struct drm_crtc *crtc = set->crtc;
2482 struct drm_framebuffer *fb;
2483 struct drm_crtc *tmp;
2487 * NOTE: ->set_config can also disable other crtcs (if we steal all
2488 * connectors from it), hence we need to refcount the fbs across all
2489 * crtcs. Atomic modeset will have saner semantics ...
2491 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head)
2492 tmp->primary->old_fb = tmp->primary->fb;
2496 ret = crtc->funcs->set_config(set);
2498 crtc->primary->crtc = crtc;
2499 crtc->primary->fb = fb;
2502 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
2503 if (tmp->primary->fb)
2504 drm_framebuffer_reference(tmp->primary->fb);
2505 if (tmp->primary->old_fb)
2506 drm_framebuffer_unreference(tmp->primary->old_fb);
2507 tmp->primary->old_fb = NULL;
2512 EXPORT_SYMBOL(drm_mode_set_config_internal);
2515 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2517 * @crtc: CRTC that framebuffer will be displayed on
2520 * @mode: mode that framebuffer will be displayed under
2521 * @fb: framebuffer to check size of
2523 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2525 const struct drm_display_mode *mode,
2526 const struct drm_framebuffer *fb)
2529 int hdisplay, vdisplay;
2531 hdisplay = mode->hdisplay;
2532 vdisplay = mode->vdisplay;
2534 if (drm_mode_is_stereo(mode)) {
2535 struct drm_display_mode adjusted = *mode;
2537 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE);
2538 hdisplay = adjusted.crtc_hdisplay;
2539 vdisplay = adjusted.crtc_vdisplay;
2542 if (crtc->invert_dimensions)
2543 swap(hdisplay, vdisplay);
2545 if (hdisplay > fb->width ||
2546 vdisplay > fb->height ||
2547 x > fb->width - hdisplay ||
2548 y > fb->height - vdisplay) {
2549 DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2550 fb->width, fb->height, hdisplay, vdisplay, x, y,
2551 crtc->invert_dimensions ? " (inverted)" : "");
2557 EXPORT_SYMBOL(drm_crtc_check_viewport);
2560 * drm_mode_setcrtc - set CRTC configuration
2561 * @dev: drm device for the ioctl
2562 * @data: data pointer for the ioctl
2563 * @file_priv: drm file for the ioctl call
2565 * Build a new CRTC configuration based on user request.
2567 * Called by the user via ioctl.
2570 * Zero on success, negative errno on failure.
2572 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2573 struct drm_file *file_priv)
2575 struct drm_mode_config *config = &dev->mode_config;
2576 struct drm_mode_crtc *crtc_req = data;
2577 struct drm_crtc *crtc;
2578 struct drm_connector **connector_set = NULL, *connector;
2579 struct drm_framebuffer *fb = NULL;
2580 struct drm_display_mode *mode = NULL;
2581 struct drm_mode_set set;
2582 uint32_t __user *set_connectors_ptr;
2586 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2589 /* For some reason crtc x/y offsets are signed internally. */
2590 if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
2593 drm_modeset_lock_all(dev);
2594 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2596 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2600 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2602 if (crtc_req->mode_valid) {
2603 /* If we have a mode we need a framebuffer. */
2604 /* If we pass -1, set the mode with the currently bound fb */
2605 if (crtc_req->fb_id == -1) {
2606 if (!crtc->primary->fb) {
2607 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2611 fb = crtc->primary->fb;
2612 /* Make refcounting symmetric with the lookup path. */
2613 drm_framebuffer_reference(fb);
2615 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2617 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2624 mode = drm_mode_create(dev);
2630 ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
2632 DRM_DEBUG_KMS("Invalid mode\n");
2636 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2638 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2645 if (crtc_req->count_connectors == 0 && mode) {
2646 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2651 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2652 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2653 crtc_req->count_connectors);
2658 if (crtc_req->count_connectors > 0) {
2661 /* Avoid unbounded kernel memory allocation */
2662 if (crtc_req->count_connectors > config->num_connector) {
2667 connector_set = kmalloc(crtc_req->count_connectors *
2668 sizeof(struct drm_connector *),
2670 if (!connector_set) {
2675 for (i = 0; i < crtc_req->count_connectors; i++) {
2676 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2677 if (get_user(out_id, &set_connectors_ptr[i])) {
2682 connector = drm_connector_find(dev, out_id);
2684 DRM_DEBUG_KMS("Connector id %d unknown\n",
2689 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2693 connector_set[i] = connector;
2698 set.x = crtc_req->x;
2699 set.y = crtc_req->y;
2701 set.connectors = connector_set;
2702 set.num_connectors = crtc_req->count_connectors;
2704 ret = drm_mode_set_config_internal(&set);
2708 drm_framebuffer_unreference(fb);
2710 kfree(connector_set);
2711 drm_mode_destroy(dev, mode);
2712 drm_modeset_unlock_all(dev);
2717 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2718 * universal plane handler call
2719 * @crtc: crtc to update cursor for
2720 * @req: data pointer for the ioctl
2721 * @file_priv: drm file for the ioctl call
2723 * Legacy cursor ioctl's work directly with driver buffer handles. To
2724 * translate legacy ioctl calls into universal plane handler calls, we need to
2725 * wrap the native buffer handle in a drm_framebuffer.
2727 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2728 * buffer with a pitch of 4*width; the universal plane interface should be used
2729 * directly in cases where the hardware can support other buffer settings and
2730 * userspace wants to make use of these capabilities.
2733 * Zero on success, negative errno on failure.
2735 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2736 struct drm_mode_cursor2 *req,
2737 struct drm_file *file_priv)
2739 struct drm_device *dev = crtc->dev;
2740 struct drm_framebuffer *fb = NULL;
2741 struct drm_mode_fb_cmd2 fbreq = {
2742 .width = req->width,
2743 .height = req->height,
2744 .pixel_format = DRM_FORMAT_ARGB8888,
2745 .pitches = { req->width * 4 },
2746 .handles = { req->handle },
2748 int32_t crtc_x, crtc_y;
2749 uint32_t crtc_w = 0, crtc_h = 0;
2750 uint32_t src_w = 0, src_h = 0;
2753 BUG_ON(!crtc->cursor);
2754 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2757 * Obtain fb we'll be using (either new or existing) and take an extra
2758 * reference to it if fb != null. setplane will take care of dropping
2759 * the reference if the plane update fails.
2761 if (req->flags & DRM_MODE_CURSOR_BO) {
2763 fb = add_framebuffer_internal(dev, &fbreq, file_priv);
2765 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2769 drm_framebuffer_reference(fb);
2774 fb = crtc->cursor->fb;
2776 drm_framebuffer_reference(fb);
2779 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2783 crtc_x = crtc->cursor_x;
2784 crtc_y = crtc->cursor_y;
2789 crtc_h = fb->height;
2790 src_w = fb->width << 16;
2791 src_h = fb->height << 16;
2795 * setplane_internal will take care of deref'ing either the old or new
2796 * framebuffer depending on success.
2798 ret = __setplane_internal(crtc->cursor, crtc, fb,
2799 crtc_x, crtc_y, crtc_w, crtc_h,
2800 0, 0, src_w, src_h);
2802 /* Update successful; save new cursor position, if necessary */
2803 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
2804 crtc->cursor_x = req->x;
2805 crtc->cursor_y = req->y;
2811 static int drm_mode_cursor_common(struct drm_device *dev,
2812 struct drm_mode_cursor2 *req,
2813 struct drm_file *file_priv)
2815 struct drm_crtc *crtc;
2818 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2821 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
2824 crtc = drm_crtc_find(dev, req->crtc_id);
2826 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
2831 * If this crtc has a universal cursor plane, call that plane's update
2832 * handler rather than using legacy cursor handlers.
2834 drm_modeset_lock_crtc(crtc, crtc->cursor);
2836 ret = drm_mode_cursor_universal(crtc, req, file_priv);
2840 if (req->flags & DRM_MODE_CURSOR_BO) {
2841 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
2845 /* Turns off the cursor if handle is 0 */
2846 if (crtc->funcs->cursor_set2)
2847 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
2848 req->width, req->height, req->hot_x, req->hot_y);
2850 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
2851 req->width, req->height);
2854 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2855 if (crtc->funcs->cursor_move) {
2856 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
2863 drm_modeset_unlock_crtc(crtc);
2871 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
2872 * @dev: drm device for the ioctl
2873 * @data: data pointer for the ioctl
2874 * @file_priv: drm file for the ioctl call
2876 * Set the cursor configuration based on user request.
2878 * Called by the user via ioctl.
2881 * Zero on success, negative errno on failure.
2883 int drm_mode_cursor_ioctl(struct drm_device *dev,
2884 void *data, struct drm_file *file_priv)
2886 struct drm_mode_cursor *req = data;
2887 struct drm_mode_cursor2 new_req;
2889 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
2890 new_req.hot_x = new_req.hot_y = 0;
2892 return drm_mode_cursor_common(dev, &new_req, file_priv);
2896 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
2897 * @dev: drm device for the ioctl
2898 * @data: data pointer for the ioctl
2899 * @file_priv: drm file for the ioctl call
2901 * Set the cursor configuration based on user request. This implements the 2nd
2902 * version of the cursor ioctl, which allows userspace to additionally specify
2903 * the hotspot of the pointer.
2905 * Called by the user via ioctl.
2908 * Zero on success, negative errno on failure.
2910 int drm_mode_cursor2_ioctl(struct drm_device *dev,
2911 void *data, struct drm_file *file_priv)
2913 struct drm_mode_cursor2 *req = data;
2914 return drm_mode_cursor_common(dev, req, file_priv);
2918 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
2919 * @bpp: bits per pixels
2920 * @depth: bit depth per pixel
2922 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
2923 * Useful in fbdev emulation code, since that deals in those values.
2925 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
2931 fmt = DRM_FORMAT_C8;
2935 fmt = DRM_FORMAT_XRGB1555;
2937 fmt = DRM_FORMAT_RGB565;
2940 fmt = DRM_FORMAT_RGB888;
2944 fmt = DRM_FORMAT_XRGB8888;
2945 else if (depth == 30)
2946 fmt = DRM_FORMAT_XRGB2101010;
2948 fmt = DRM_FORMAT_ARGB8888;
2951 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
2952 fmt = DRM_FORMAT_XRGB8888;
2958 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
2961 * drm_mode_addfb - add an FB to the graphics configuration
2962 * @dev: drm device for the ioctl
2963 * @data: data pointer for the ioctl
2964 * @file_priv: drm file for the ioctl call
2966 * Add a new FB to the specified CRTC, given a user request. This is the
2967 * original addfb ioctl which only supported RGB formats.
2969 * Called by the user via ioctl.
2972 * Zero on success, negative errno on failure.
2974 int drm_mode_addfb(struct drm_device *dev,
2975 void *data, struct drm_file *file_priv)
2977 struct drm_mode_fb_cmd *or = data;
2978 struct drm_mode_fb_cmd2 r = {};
2981 /* convert to new format and call new ioctl */
2982 r.fb_id = or->fb_id;
2983 r.width = or->width;
2984 r.height = or->height;
2985 r.pitches[0] = or->pitch;
2986 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
2987 r.handles[0] = or->handle;
2989 ret = drm_mode_addfb2(dev, &r, file_priv);
2993 or->fb_id = r.fb_id;
2998 static int format_check(const struct drm_mode_fb_cmd2 *r)
3000 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3004 case DRM_FORMAT_RGB332:
3005 case DRM_FORMAT_BGR233:
3006 case DRM_FORMAT_XRGB4444:
3007 case DRM_FORMAT_XBGR4444:
3008 case DRM_FORMAT_RGBX4444:
3009 case DRM_FORMAT_BGRX4444:
3010 case DRM_FORMAT_ARGB4444:
3011 case DRM_FORMAT_ABGR4444:
3012 case DRM_FORMAT_RGBA4444:
3013 case DRM_FORMAT_BGRA4444:
3014 case DRM_FORMAT_XRGB1555:
3015 case DRM_FORMAT_XBGR1555:
3016 case DRM_FORMAT_RGBX5551:
3017 case DRM_FORMAT_BGRX5551:
3018 case DRM_FORMAT_ARGB1555:
3019 case DRM_FORMAT_ABGR1555:
3020 case DRM_FORMAT_RGBA5551:
3021 case DRM_FORMAT_BGRA5551:
3022 case DRM_FORMAT_RGB565:
3023 case DRM_FORMAT_BGR565:
3024 case DRM_FORMAT_RGB888:
3025 case DRM_FORMAT_BGR888:
3026 case DRM_FORMAT_XRGB8888:
3027 case DRM_FORMAT_XBGR8888:
3028 case DRM_FORMAT_RGBX8888:
3029 case DRM_FORMAT_BGRX8888:
3030 case DRM_FORMAT_ARGB8888:
3031 case DRM_FORMAT_ABGR8888:
3032 case DRM_FORMAT_RGBA8888:
3033 case DRM_FORMAT_BGRA8888:
3034 case DRM_FORMAT_XRGB2101010:
3035 case DRM_FORMAT_XBGR2101010:
3036 case DRM_FORMAT_RGBX1010102:
3037 case DRM_FORMAT_BGRX1010102:
3038 case DRM_FORMAT_ARGB2101010:
3039 case DRM_FORMAT_ABGR2101010:
3040 case DRM_FORMAT_RGBA1010102:
3041 case DRM_FORMAT_BGRA1010102:
3042 case DRM_FORMAT_YUYV:
3043 case DRM_FORMAT_YVYU:
3044 case DRM_FORMAT_UYVY:
3045 case DRM_FORMAT_VYUY:
3046 case DRM_FORMAT_AYUV:
3047 case DRM_FORMAT_NV12:
3048 case DRM_FORMAT_NV21:
3049 case DRM_FORMAT_NV16:
3050 case DRM_FORMAT_NV61:
3051 case DRM_FORMAT_NV24:
3052 case DRM_FORMAT_NV42:
3053 case DRM_FORMAT_YUV410:
3054 case DRM_FORMAT_YVU410:
3055 case DRM_FORMAT_YUV411:
3056 case DRM_FORMAT_YVU411:
3057 case DRM_FORMAT_YUV420:
3058 case DRM_FORMAT_YVU420:
3059 case DRM_FORMAT_YUV422:
3060 case DRM_FORMAT_YVU422:
3061 case DRM_FORMAT_YUV444:
3062 case DRM_FORMAT_YVU444:
3065 DRM_DEBUG_KMS("invalid pixel format %s\n",
3066 drm_get_format_name(r->pixel_format));
3071 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3073 int ret, hsub, vsub, num_planes, i;
3075 ret = format_check(r);
3077 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3078 drm_get_format_name(r->pixel_format));
3082 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3083 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3084 num_planes = drm_format_num_planes(r->pixel_format);
3086 if (r->width == 0 || r->width % hsub) {
3087 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3091 if (r->height == 0 || r->height % vsub) {
3092 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3096 for (i = 0; i < num_planes; i++) {
3097 unsigned int width = r->width / (i != 0 ? hsub : 1);
3098 unsigned int height = r->height / (i != 0 ? vsub : 1);
3099 unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);
3101 if (!r->handles[i]) {
3102 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3106 if ((uint64_t) width * cpp > UINT_MAX)
3109 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3112 if (r->pitches[i] < width * cpp) {
3113 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3121 static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
3122 struct drm_mode_fb_cmd2 *r,
3123 struct drm_file *file_priv)
3125 struct drm_mode_config *config = &dev->mode_config;
3126 struct drm_framebuffer *fb;
3129 if (r->flags & ~DRM_MODE_FB_INTERLACED) {
3130 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3131 return ERR_PTR(-EINVAL);
3134 if ((config->min_width > r->width) || (r->width > config->max_width)) {
3135 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3136 r->width, config->min_width, config->max_width);
3137 return ERR_PTR(-EINVAL);
3139 if ((config->min_height > r->height) || (r->height > config->max_height)) {
3140 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3141 r->height, config->min_height, config->max_height);
3142 return ERR_PTR(-EINVAL);
3145 ret = framebuffer_check(r);
3147 return ERR_PTR(ret);
3149 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3151 DRM_DEBUG_KMS("could not create framebuffer\n");
3155 mutex_lock(&file_priv->fbs_lock);
3156 r->fb_id = fb->base.id;
3157 list_add(&fb->filp_head, &file_priv->fbs);
3158 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3159 mutex_unlock(&file_priv->fbs_lock);
3165 * drm_mode_addfb2 - add an FB to the graphics configuration
3166 * @dev: drm device for the ioctl
3167 * @data: data pointer for the ioctl
3168 * @file_priv: drm file for the ioctl call
3170 * Add a new FB to the specified CRTC, given a user request with format. This is
3171 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3172 * and uses fourcc codes as pixel format specifiers.
3174 * Called by the user via ioctl.
3177 * Zero on success, negative errno on failure.
3179 int drm_mode_addfb2(struct drm_device *dev,
3180 void *data, struct drm_file *file_priv)
3182 struct drm_framebuffer *fb;
3184 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3187 fb = add_framebuffer_internal(dev, data, file_priv);
3195 * drm_mode_rmfb - remove an FB from the configuration
3196 * @dev: drm device for the ioctl
3197 * @data: data pointer for the ioctl
3198 * @file_priv: drm file for the ioctl call
3200 * Remove the FB specified by the user.
3202 * Called by the user via ioctl.
3205 * Zero on success, negative errno on failure.
3207 int drm_mode_rmfb(struct drm_device *dev,
3208 void *data, struct drm_file *file_priv)
3210 struct drm_framebuffer *fb = NULL;
3211 struct drm_framebuffer *fbl = NULL;
3212 uint32_t *id = data;
3215 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3218 mutex_lock(&file_priv->fbs_lock);
3219 mutex_lock(&dev->mode_config.fb_lock);
3220 fb = __drm_framebuffer_lookup(dev, *id);
3224 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3230 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3231 __drm_framebuffer_unregister(dev, fb);
3233 list_del_init(&fb->filp_head);
3234 mutex_unlock(&dev->mode_config.fb_lock);
3235 mutex_unlock(&file_priv->fbs_lock);
3237 drm_framebuffer_remove(fb);
3242 mutex_unlock(&dev->mode_config.fb_lock);
3243 mutex_unlock(&file_priv->fbs_lock);
3249 * drm_mode_getfb - get FB info
3250 * @dev: drm device for the ioctl
3251 * @data: data pointer for the ioctl
3252 * @file_priv: drm file for the ioctl call
3254 * Lookup the FB given its ID and return info about it.
3256 * Called by the user via ioctl.
3259 * Zero on success, negative errno on failure.
3261 int drm_mode_getfb(struct drm_device *dev,
3262 void *data, struct drm_file *file_priv)
3264 struct drm_mode_fb_cmd *r = data;
3265 struct drm_framebuffer *fb;
3268 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3271 fb = drm_framebuffer_lookup(dev, r->fb_id);
3275 r->height = fb->height;
3276 r->width = fb->width;
3277 r->depth = fb->depth;
3278 r->bpp = fb->bits_per_pixel;
3279 r->pitch = fb->pitches[0];
3280 if (fb->funcs->create_handle) {
3281 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3282 drm_is_control_client(file_priv)) {
3283 ret = fb->funcs->create_handle(fb, file_priv,
3286 /* GET_FB() is an unprivileged ioctl so we must not
3287 * return a buffer-handle to non-master processes! For
3288 * backwards-compatibility reasons, we cannot make
3289 * GET_FB() privileged, so just return an invalid handle
3290 * for non-masters. */
3298 drm_framebuffer_unreference(fb);
3304 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3305 * @dev: drm device for the ioctl
3306 * @data: data pointer for the ioctl
3307 * @file_priv: drm file for the ioctl call
3309 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3310 * rectangle list. Generic userspace which does frontbuffer rendering must call
3311 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3312 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3314 * Modesetting drivers which always update the frontbuffer do not need to
3315 * implement the corresponding ->dirty framebuffer callback.
3317 * Called by the user via ioctl.
3320 * Zero on success, negative errno on failure.
3322 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3323 void *data, struct drm_file *file_priv)
3325 struct drm_clip_rect __user *clips_ptr;
3326 struct drm_clip_rect *clips = NULL;
3327 struct drm_mode_fb_dirty_cmd *r = data;
3328 struct drm_framebuffer *fb;
3333 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3336 fb = drm_framebuffer_lookup(dev, r->fb_id);
3340 num_clips = r->num_clips;
3341 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3343 if (!num_clips != !clips_ptr) {
3348 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3350 /* If userspace annotates copy, clips must come in pairs */
3351 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3356 if (num_clips && clips_ptr) {
3357 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3361 clips = kzalloc(num_clips * sizeof(*clips), GFP_KERNEL);
3367 ret = copy_from_user(clips, clips_ptr,
3368 num_clips * sizeof(*clips));
3375 if (fb->funcs->dirty) {
3376 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3385 drm_framebuffer_unreference(fb);
3392 * drm_fb_release - remove and free the FBs on this file
3393 * @priv: drm file for the ioctl
3395 * Destroy all the FBs associated with @filp.
3397 * Called by the user via ioctl.
3400 * Zero on success, negative errno on failure.
3402 void drm_fb_release(struct drm_file *priv)
3404 struct drm_device *dev = priv->minor->dev;
3405 struct drm_framebuffer *fb, *tfb;
3408 * When the file gets released that means no one else can access the fb
3409 * list any more, so no need to grab fpriv->fbs_lock. And we need to to
3410 * avoid upsetting lockdep since the universal cursor code adds a
3411 * framebuffer while holding mutex locks.
3413 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3414 * locks is impossible here since no one else but this function can get
3417 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3419 mutex_lock(&dev->mode_config.fb_lock);
3420 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3421 __drm_framebuffer_unregister(dev, fb);
3422 mutex_unlock(&dev->mode_config.fb_lock);
3424 list_del_init(&fb->filp_head);
3426 /* This will also drop the fpriv->fbs reference. */
3427 drm_framebuffer_remove(fb);
3432 * drm_property_create - create a new property type
3434 * @flags: flags specifying the property type
3435 * @name: name of the property
3436 * @num_values: number of pre-defined values
3438 * This creates a new generic drm property which can then be attached to a drm
3439 * object with drm_object_attach_property. The returned property object must be
3440 * freed with drm_property_destroy.
3442 * Note that the DRM core keeps a per-device list of properties and that, if
3443 * drm_mode_config_cleanup() is called, it will destroy all properties created
3447 * A pointer to the newly created property on success, NULL on failure.
3449 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3450 const char *name, int num_values)
3452 struct drm_property *property = NULL;
3455 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3459 property->dev = dev;
3462 property->values = kzalloc(sizeof(uint64_t)*num_values, GFP_KERNEL);
3463 if (!property->values)
3467 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3471 property->flags = flags;
3472 property->num_values = num_values;
3473 INIT_LIST_HEAD(&property->enum_list);
3476 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3477 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3480 list_add_tail(&property->head, &dev->mode_config.property_list);
3482 WARN_ON(!drm_property_type_valid(property));
3486 kfree(property->values);
3490 EXPORT_SYMBOL(drm_property_create);
3493 * drm_property_create_enum - create a new enumeration property type
3495 * @flags: flags specifying the property type
3496 * @name: name of the property
3497 * @props: enumeration lists with property values
3498 * @num_values: number of pre-defined values
3500 * This creates a new generic drm property which can then be attached to a drm
3501 * object with drm_object_attach_property. The returned property object must be
3502 * freed with drm_property_destroy.
3504 * Userspace is only allowed to set one of the predefined values for enumeration
3508 * A pointer to the newly created property on success, NULL on failure.
3510 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3512 const struct drm_prop_enum_list *props,
3515 struct drm_property *property;
3518 flags |= DRM_MODE_PROP_ENUM;
3520 property = drm_property_create(dev, flags, name, num_values);
3524 for (i = 0; i < num_values; i++) {
3525 ret = drm_property_add_enum(property, i,
3529 drm_property_destroy(dev, property);
3536 EXPORT_SYMBOL(drm_property_create_enum);
3539 * drm_property_create_bitmask - create a new bitmask property type
3541 * @flags: flags specifying the property type
3542 * @name: name of the property
3543 * @props: enumeration lists with property bitflags
3544 * @num_props: size of the @props array
3545 * @supported_bits: bitmask of all supported enumeration values
3547 * This creates a new bitmask drm property which can then be attached to a drm
3548 * object with drm_object_attach_property. The returned property object must be
3549 * freed with drm_property_destroy.
3551 * Compared to plain enumeration properties userspace is allowed to set any
3552 * or'ed together combination of the predefined property bitflag values
3555 * A pointer to the newly created property on success, NULL on failure.
3557 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3558 int flags, const char *name,
3559 const struct drm_prop_enum_list *props,
3561 uint64_t supported_bits)
3563 struct drm_property *property;
3564 int i, ret, index = 0;
3565 int num_values = hweight64(supported_bits);
3567 flags |= DRM_MODE_PROP_BITMASK;
3569 property = drm_property_create(dev, flags, name, num_values);
3572 for (i = 0; i < num_props; i++) {
3573 if (!(supported_bits & (1ULL << props[i].type)))
3576 if (WARN_ON(index >= num_values)) {
3577 drm_property_destroy(dev, property);
3581 ret = drm_property_add_enum(property, index++,
3585 drm_property_destroy(dev, property);
3592 EXPORT_SYMBOL(drm_property_create_bitmask);
3594 static struct drm_property *property_create_range(struct drm_device *dev,
3595 int flags, const char *name,
3596 uint64_t min, uint64_t max)
3598 struct drm_property *property;
3600 property = drm_property_create(dev, flags, name, 2);
3604 property->values[0] = min;
3605 property->values[1] = max;
3611 * drm_property_create_range - create a new ranged property type
3613 * @flags: flags specifying the property type
3614 * @name: name of the property
3615 * @min: minimum value of the property
3616 * @max: maximum value of the property
3618 * This creates a new generic drm property which can then be attached to a drm
3619 * object with drm_object_attach_property. The returned property object must be
3620 * freed with drm_property_destroy.
3622 * Userspace is allowed to set any integer value in the (min, max) range
3626 * A pointer to the newly created property on success, NULL on failure.
3628 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3630 uint64_t min, uint64_t max)
3632 return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3635 EXPORT_SYMBOL(drm_property_create_range);
3637 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3638 int flags, const char *name,
3639 int64_t min, int64_t max)
3641 return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3642 name, I642U64(min), I642U64(max));
3644 EXPORT_SYMBOL(drm_property_create_signed_range);
3646 struct drm_property *drm_property_create_object(struct drm_device *dev,
3647 int flags, const char *name, uint32_t type)
3649 struct drm_property *property;
3651 flags |= DRM_MODE_PROP_OBJECT;
3653 property = drm_property_create(dev, flags, name, 1);
3657 property->values[0] = type;
3661 EXPORT_SYMBOL(drm_property_create_object);
3664 * drm_property_add_enum - add a possible value to an enumeration property
3665 * @property: enumeration property to change
3666 * @index: index of the new enumeration
3667 * @value: value of the new enumeration
3668 * @name: symbolic name of the new enumeration
3670 * This functions adds enumerations to a property.
3672 * It's use is deprecated, drivers should use one of the more specific helpers
3673 * to directly create the property with all enumerations already attached.
3676 * Zero on success, error code on failure.
3678 int drm_property_add_enum(struct drm_property *property, int index,
3679 uint64_t value, const char *name)
3681 struct drm_property_enum *prop_enum;
3683 if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3684 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
3688 * Bitmask enum properties have the additional constraint of values
3691 if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
3695 if (!list_empty(&property->enum_list)) {
3696 list_for_each_entry(prop_enum, &property->enum_list, head) {
3697 if (prop_enum->value == value) {
3698 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3699 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3705 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
3709 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3710 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3711 prop_enum->value = value;
3713 property->values[index] = value;
3714 list_add_tail(&prop_enum->head, &property->enum_list);
3717 EXPORT_SYMBOL(drm_property_add_enum);
3720 * drm_property_destroy - destroy a drm property
3722 * @property: property to destry
3724 * This function frees a property including any attached resources like
3725 * enumeration values.
3727 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
3729 struct drm_property_enum *prop_enum, *pt;
3731 list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
3732 list_del(&prop_enum->head);
3736 if (property->num_values)
3737 kfree(property->values);
3738 drm_mode_object_put(dev, &property->base);
3739 list_del(&property->head);
3742 EXPORT_SYMBOL(drm_property_destroy);
3745 * drm_object_attach_property - attach a property to a modeset object
3746 * @obj: drm modeset object
3747 * @property: property to attach
3748 * @init_val: initial value of the property
3750 * This attaches the given property to the modeset object with the given initial
3751 * value. Currently this function cannot fail since the properties are stored in
3752 * a statically sized array.
3754 void drm_object_attach_property(struct drm_mode_object *obj,
3755 struct drm_property *property,
3758 int count = obj->properties->count;
3760 if (count == DRM_OBJECT_MAX_PROPERTY) {
3761 WARN(1, "Failed to attach object property (type: 0x%x). Please "
3762 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
3763 "you see this message on the same object type.\n",
3768 obj->properties->ids[count] = property->base.id;
3769 obj->properties->values[count] = init_val;
3770 obj->properties->count++;
3772 EXPORT_SYMBOL(drm_object_attach_property);
3775 * drm_object_property_set_value - set the value of a property
3776 * @obj: drm mode object to set property value for
3777 * @property: property to set
3778 * @val: value the property should be set to
3780 * This functions sets a given property on a given object. This function only
3781 * changes the software state of the property, it does not call into the
3782 * driver's ->set_property callback.
3785 * Zero on success, error code on failure.
3787 int drm_object_property_set_value(struct drm_mode_object *obj,
3788 struct drm_property *property, uint64_t val)
3792 for (i = 0; i < obj->properties->count; i++) {
3793 if (obj->properties->ids[i] == property->base.id) {
3794 obj->properties->values[i] = val;
3801 EXPORT_SYMBOL(drm_object_property_set_value);
3804 * drm_object_property_get_value - retrieve the value of a property
3805 * @obj: drm mode object to get property value from
3806 * @property: property to retrieve
3807 * @val: storage for the property value
3809 * This function retrieves the softare state of the given property for the given
3810 * property. Since there is no driver callback to retrieve the current property
3811 * value this might be out of sync with the hardware, depending upon the driver
3815 * Zero on success, error code on failure.
3817 int drm_object_property_get_value(struct drm_mode_object *obj,
3818 struct drm_property *property, uint64_t *val)
3822 for (i = 0; i < obj->properties->count; i++) {
3823 if (obj->properties->ids[i] == property->base.id) {
3824 *val = obj->properties->values[i];
3831 EXPORT_SYMBOL(drm_object_property_get_value);
3834 * drm_mode_getproperty_ioctl - get the property metadata
3837 * @file_priv: DRM file info
3839 * This function retrieves the metadata for a given property, like the different
3840 * possible values for an enum property or the limits for a range property.
3842 * Blob properties are special
3844 * Called by the user via ioctl.
3847 * Zero on success, negative errno on failure.
3849 int drm_mode_getproperty_ioctl(struct drm_device *dev,
3850 void *data, struct drm_file *file_priv)
3852 struct drm_mode_get_property *out_resp = data;
3853 struct drm_property *property;
3855 int value_count = 0;
3858 struct drm_property_enum *prop_enum;
3859 struct drm_mode_property_enum __user *enum_ptr;
3860 uint64_t __user *values_ptr;
3862 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3865 drm_modeset_lock_all(dev);
3866 property = drm_property_find(dev, out_resp->prop_id);
3872 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3873 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
3874 list_for_each_entry(prop_enum, &property->enum_list, head)
3878 value_count = property->num_values;
3880 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
3881 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
3882 out_resp->flags = property->flags;
3884 if ((out_resp->count_values >= value_count) && value_count) {
3885 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
3886 for (i = 0; i < value_count; i++) {
3887 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
3893 out_resp->count_values = value_count;
3895 if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3896 drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
3897 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
3899 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
3900 list_for_each_entry(prop_enum, &property->enum_list, head) {
3902 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
3907 if (copy_to_user(&enum_ptr[copied].name,
3908 &prop_enum->name, DRM_PROP_NAME_LEN)) {
3915 out_resp->count_enum_blobs = enum_count;
3919 * NOTE: The idea seems to have been to use this to read all the blob
3920 * property values. But nothing ever added them to the corresponding
3921 * list, userspace always used the special-purpose get_blob ioctl to
3922 * read the value for a blob property. It also doesn't make a lot of
3923 * sense to return values here when everything else is just metadata for
3924 * the property itself.
3926 if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
3927 out_resp->count_enum_blobs = 0;
3929 drm_modeset_unlock_all(dev);
3933 static struct drm_property_blob *
3934 drm_property_create_blob(struct drm_device *dev, size_t length,
3937 struct drm_property_blob *blob;
3940 if (!length || !data)
3943 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
3947 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
3953 blob->length = length;
3955 memcpy(blob->data, data, length);
3957 list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
3961 static void drm_property_destroy_blob(struct drm_device *dev,
3962 struct drm_property_blob *blob)
3964 drm_mode_object_put(dev, &blob->base);
3965 list_del(&blob->head);
3970 * drm_mode_getblob_ioctl - get the contents of a blob property value
3973 * @file_priv: DRM file info
3975 * This function retrieves the contents of a blob property. The value stored in
3976 * an object's blob property is just a normal modeset object id.
3978 * Called by the user via ioctl.
3981 * Zero on success, negative errno on failure.
3983 int drm_mode_getblob_ioctl(struct drm_device *dev,
3984 void *data, struct drm_file *file_priv)
3986 struct drm_mode_get_blob *out_resp = data;
3987 struct drm_property_blob *blob;
3989 void __user *blob_ptr;
3991 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3994 drm_modeset_lock_all(dev);
3995 blob = drm_property_blob_find(dev, out_resp->blob_id);
4001 if (out_resp->length == blob->length) {
4002 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4003 if (copy_to_user(blob_ptr, blob->data, blob->length)){
4008 out_resp->length = blob->length;
4011 drm_modeset_unlock_all(dev);
4016 * drm_mode_connector_set_path_property - set tile property on connector
4017 * @connector: connector to set property on.
4018 * @path: path to use for property.
4020 * This creates a property to expose to userspace to specify a
4021 * connector path. This is mainly used for DisplayPort MST where
4022 * connectors have a topology and we want to allow userspace to give
4023 * them more meaningful names.
4026 * Zero on success, negative errno on failure.
4028 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4031 struct drm_device *dev = connector->dev;
4032 size_t size = strlen(path) + 1;
4035 connector->path_blob_ptr = drm_property_create_blob(connector->dev,
4037 if (!connector->path_blob_ptr)
4040 ret = drm_object_property_set_value(&connector->base,
4041 dev->mode_config.path_property,
4042 connector->path_blob_ptr->base.id);
4045 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4048 * drm_mode_connector_update_edid_property - update the edid property of a connector
4049 * @connector: drm connector
4050 * @edid: new value of the edid property
4052 * This function creates a new blob modeset object and assigns its id to the
4053 * connector's edid property.
4056 * Zero on success, negative errno on failure.
4058 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4059 const struct edid *edid)
4061 struct drm_device *dev = connector->dev;
4065 /* ignore requests to set edid when overridden */
4066 if (connector->override_edid)
4069 if (connector->edid_blob_ptr)
4070 drm_property_destroy_blob(dev, connector->edid_blob_ptr);
4072 /* Delete edid, when there is none. */
4074 connector->edid_blob_ptr = NULL;
4075 ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
4079 size = EDID_LENGTH * (1 + edid->extensions);
4080 connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
4082 if (!connector->edid_blob_ptr)
4085 ret = drm_object_property_set_value(&connector->base,
4086 dev->mode_config.edid_property,
4087 connector->edid_blob_ptr->base.id);
4091 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4093 static bool drm_property_change_is_valid(struct drm_property *property,
4096 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4099 if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4100 if (value < property->values[0] || value > property->values[1])
4103 } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4104 int64_t svalue = U642I64(value);
4105 if (svalue < U642I64(property->values[0]) ||
4106 svalue > U642I64(property->values[1]))
4109 } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4111 uint64_t valid_mask = 0;
4112 for (i = 0; i < property->num_values; i++)
4113 valid_mask |= (1ULL << property->values[i]);
4114 return !(value & ~valid_mask);
4115 } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4116 /* Only the driver knows */
4118 } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4119 struct drm_mode_object *obj;
4120 /* a zero value for an object property translates to null: */
4124 * NOTE: use _object_find() directly to bypass restriction on
4125 * looking up refcnt'd objects (ie. fb's). For a refcnt'd
4126 * object this could race against object finalization, so it
4127 * simply tells us that the object *was* valid. Which is good
4130 obj = _object_find(property->dev, value, property->values[0]);
4134 for (i = 0; i < property->num_values; i++)
4135 if (property->values[i] == value)
4142 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4145 * @file_priv: DRM file info
4147 * This function sets the current value for a connectors's property. It also
4148 * calls into a driver's ->set_property callback to update the hardware state
4150 * Called by the user via ioctl.
4153 * Zero on success, negative errno on failure.
4155 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4156 void *data, struct drm_file *file_priv)
4158 struct drm_mode_connector_set_property *conn_set_prop = data;
4159 struct drm_mode_obj_set_property obj_set_prop = {
4160 .value = conn_set_prop->value,
4161 .prop_id = conn_set_prop->prop_id,
4162 .obj_id = conn_set_prop->connector_id,
4163 .obj_type = DRM_MODE_OBJECT_CONNECTOR
4166 /* It does all the locking and checking we need */
4167 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4170 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4171 struct drm_property *property,
4175 struct drm_connector *connector = obj_to_connector(obj);
4177 /* Do DPMS ourselves */
4178 if (property == connector->dev->mode_config.dpms_property) {
4179 if (connector->funcs->dpms)
4180 (*connector->funcs->dpms)(connector, (int)value);
4182 } else if (connector->funcs->set_property)
4183 ret = connector->funcs->set_property(connector, property, value);
4185 /* store the property value if successful */
4187 drm_object_property_set_value(&connector->base, property, value);
4191 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4192 struct drm_property *property,
4196 struct drm_crtc *crtc = obj_to_crtc(obj);
4198 if (crtc->funcs->set_property)
4199 ret = crtc->funcs->set_property(crtc, property, value);
4201 drm_object_property_set_value(obj, property, value);
4207 * drm_mode_plane_set_obj_prop - set the value of a property
4208 * @plane: drm plane object to set property value for
4209 * @property: property to set
4210 * @value: value the property should be set to
4212 * This functions sets a given property on a given plane object. This function
4213 * calls the driver's ->set_property callback and changes the software state of
4214 * the property if the callback succeeds.
4217 * Zero on success, error code on failure.
4219 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
4220 struct drm_property *property,
4224 struct drm_mode_object *obj = &plane->base;
4226 if (plane->funcs->set_property)
4227 ret = plane->funcs->set_property(plane, property, value);
4229 drm_object_property_set_value(obj, property, value);
4233 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
4236 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
4239 * @file_priv: DRM file info
4241 * This function retrieves the current value for an object's property. Compared
4242 * to the connector specific ioctl this one is extended to also work on crtc and
4245 * Called by the user via ioctl.
4248 * Zero on success, negative errno on failure.
4250 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
4251 struct drm_file *file_priv)
4253 struct drm_mode_obj_get_properties *arg = data;
4254 struct drm_mode_object *obj;
4258 int props_count = 0;
4259 uint32_t __user *props_ptr;
4260 uint64_t __user *prop_values_ptr;
4262 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4265 drm_modeset_lock_all(dev);
4267 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4272 if (!obj->properties) {
4277 props_count = obj->properties->count;
4279 /* This ioctl is called twice, once to determine how much space is
4280 * needed, and the 2nd time to fill it. */
4281 if ((arg->count_props >= props_count) && props_count) {
4283 props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
4284 prop_values_ptr = (uint64_t __user *)(unsigned long)
4285 (arg->prop_values_ptr);
4286 for (i = 0; i < props_count; i++) {
4287 if (put_user(obj->properties->ids[i],
4288 props_ptr + copied)) {
4292 if (put_user(obj->properties->values[i],
4293 prop_values_ptr + copied)) {
4300 arg->count_props = props_count;
4302 drm_modeset_unlock_all(dev);
4307 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
4310 * @file_priv: DRM file info
4312 * This function sets the current value for an object's property. It also calls
4313 * into a driver's ->set_property callback to update the hardware state.
4314 * Compared to the connector specific ioctl this one is extended to also work on
4315 * crtc and plane objects.
4317 * Called by the user via ioctl.
4320 * Zero on success, negative errno on failure.
4322 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
4323 struct drm_file *file_priv)
4325 struct drm_mode_obj_set_property *arg = data;
4326 struct drm_mode_object *arg_obj;
4327 struct drm_mode_object *prop_obj;
4328 struct drm_property *property;
4332 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4335 drm_modeset_lock_all(dev);
4337 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4342 if (!arg_obj->properties)
4345 for (i = 0; i < arg_obj->properties->count; i++)
4346 if (arg_obj->properties->ids[i] == arg->prop_id)
4349 if (i == arg_obj->properties->count)
4352 prop_obj = drm_mode_object_find(dev, arg->prop_id,
4353 DRM_MODE_OBJECT_PROPERTY);
4358 property = obj_to_property(prop_obj);
4360 if (!drm_property_change_is_valid(property, arg->value))
4363 switch (arg_obj->type) {
4364 case DRM_MODE_OBJECT_CONNECTOR:
4365 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
4368 case DRM_MODE_OBJECT_CRTC:
4369 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
4371 case DRM_MODE_OBJECT_PLANE:
4372 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
4373 property, arg->value);
4378 drm_modeset_unlock_all(dev);
4383 * drm_mode_connector_attach_encoder - attach a connector to an encoder
4384 * @connector: connector to attach
4385 * @encoder: encoder to attach @connector to
4387 * This function links up a connector to an encoder. Note that the routing
4388 * restrictions between encoders and crtcs are exposed to userspace through the
4389 * possible_clones and possible_crtcs bitmasks.
4392 * Zero on success, negative errno on failure.
4394 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
4395 struct drm_encoder *encoder)
4399 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
4400 if (connector->encoder_ids[i] == 0) {
4401 connector->encoder_ids[i] = encoder->base.id;
4407 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
4410 * drm_mode_crtc_set_gamma_size - set the gamma table size
4411 * @crtc: CRTC to set the gamma table size for
4412 * @gamma_size: size of the gamma table
4414 * Drivers which support gamma tables should set this to the supported gamma
4415 * table size when initializing the CRTC. Currently the drm core only supports a
4416 * fixed gamma table size.
4419 * Zero on success, negative errno on failure.
4421 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
4424 crtc->gamma_size = gamma_size;
4426 crtc->gamma_store = kzalloc(gamma_size * sizeof(uint16_t) * 3, GFP_KERNEL);
4427 if (!crtc->gamma_store) {
4428 crtc->gamma_size = 0;
4434 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
4437 * drm_mode_gamma_set_ioctl - set the gamma table
4440 * @file_priv: DRM file info
4442 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
4443 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
4445 * Called by the user via ioctl.
4448 * Zero on success, negative errno on failure.
4450 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
4451 void *data, struct drm_file *file_priv)
4453 struct drm_mode_crtc_lut *crtc_lut = data;
4454 struct drm_crtc *crtc;
4455 void *r_base, *g_base, *b_base;
4459 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4462 drm_modeset_lock_all(dev);
4463 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4469 if (crtc->funcs->gamma_set == NULL) {
4474 /* memcpy into gamma store */
4475 if (crtc_lut->gamma_size != crtc->gamma_size) {
4480 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4481 r_base = crtc->gamma_store;
4482 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
4487 g_base = r_base + size;
4488 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
4493 b_base = g_base + size;
4494 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
4499 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
4502 drm_modeset_unlock_all(dev);
4508 * drm_mode_gamma_get_ioctl - get the gamma table
4511 * @file_priv: DRM file info
4513 * Copy the current gamma table into the storage provided. This also provides
4514 * the gamma table size the driver expects, which can be used to size the
4515 * allocated storage.
4517 * Called by the user via ioctl.
4520 * Zero on success, negative errno on failure.
4522 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
4523 void *data, struct drm_file *file_priv)
4525 struct drm_mode_crtc_lut *crtc_lut = data;
4526 struct drm_crtc *crtc;
4527 void *r_base, *g_base, *b_base;
4531 if (!drm_core_check_feature(dev, DRIVER_MODESET))
4534 drm_modeset_lock_all(dev);
4535 crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4541 /* memcpy into gamma store */
4542 if (crtc_lut->gamma_size != crtc->gamma_size) {
4547 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4548 r_base = crtc->gamma_store;
4549 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
4554 g_base = r_base + size;
4555 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
4560 b_base = g_base + size;
4561 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
4566 drm_modeset_unlock_all(dev);
4571 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4574 * @file_priv: DRM file info
4576 * This schedules an asynchronous update on a given CRTC, called page flip.
4577 * Optionally a drm event is generated to signal the completion of the event.
4578 * Generic drivers cannot assume that a pageflip with changed framebuffer
4579 * properties (including driver specific metadata like tiling layout) will work,
4580 * but some drivers support e.g. pixel format changes through the pageflip
4583 * Called by the user via ioctl.
4586 * Zero on success, negative errno on failure.
4588 int drm_mode_page_flip_ioctl(struct drm_device *dev,
4589 void *data, struct drm_file *file_priv)
4591 struct drm_mode_crtc_page_flip *page_flip = data;
4592 struct drm_crtc *crtc;
4593 struct drm_framebuffer *fb = NULL;
4594 struct drm_pending_vblank_event *e = NULL;
4595 unsigned long flags;
4598 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
4599 page_flip->reserved != 0)
4602 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
4605 crtc = drm_crtc_find(dev, page_flip->crtc_id);
4609 drm_modeset_lock_crtc(crtc, crtc->primary);
4610 if (crtc->primary->fb == NULL) {
4611 /* The framebuffer is currently unbound, presumably
4612 * due to a hotplug event, that userspace has not
4619 if (crtc->funcs->page_flip == NULL)
4622 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
4628 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
4632 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
4633 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4638 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4640 spin_lock_irqsave(&dev->event_lock, flags);
4641 if (file_priv->event_space < sizeof e->event) {
4642 spin_unlock_irqrestore(&dev->event_lock, flags);
4645 file_priv->event_space -= sizeof e->event;
4646 spin_unlock_irqrestore(&dev->event_lock, flags);
4648 e = kzalloc(sizeof *e, GFP_KERNEL);
4650 spin_lock_irqsave(&dev->event_lock, flags);
4651 file_priv->event_space += sizeof e->event;
4652 spin_unlock_irqrestore(&dev->event_lock, flags);
4656 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
4657 e->event.base.length = sizeof e->event;
4658 e->event.user_data = page_flip->user_data;
4659 e->base.event = &e->event.base;
4660 e->base.file_priv = file_priv;
4662 (void (*) (struct drm_pending_event *)) kfree;
4665 crtc->primary->old_fb = crtc->primary->fb;
4666 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
4668 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4669 spin_lock_irqsave(&dev->event_lock, flags);
4670 file_priv->event_space += sizeof e->event;
4671 spin_unlock_irqrestore(&dev->event_lock, flags);
4674 /* Keep the old fb, don't unref it. */
4675 crtc->primary->old_fb = NULL;
4678 * Warn if the driver hasn't properly updated the crtc->fb
4679 * field to reflect that the new framebuffer is now used.
4680 * Failing to do so will screw with the reference counting
4683 WARN_ON(crtc->primary->fb != fb);
4684 /* Unref only the old framebuffer. */
4690 drm_framebuffer_unreference(fb);
4691 if (crtc->primary->old_fb)
4692 drm_framebuffer_unreference(crtc->primary->old_fb);
4693 crtc->primary->old_fb = NULL;
4694 drm_modeset_unlock_crtc(crtc);
4700 * drm_mode_config_reset - call ->reset callbacks
4703 * This functions calls all the crtc's, encoder's and connector's ->reset
4704 * callback. Drivers can use this in e.g. their driver load or resume code to
4705 * reset hardware and software state.
4707 void drm_mode_config_reset(struct drm_device *dev)
4709 struct drm_crtc *crtc;
4710 struct drm_plane *plane;
4711 struct drm_encoder *encoder;
4712 struct drm_connector *connector;
4714 list_for_each_entry(plane, &dev->mode_config.plane_list, head)
4715 if (plane->funcs->reset)
4716 plane->funcs->reset(plane);
4718 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
4719 if (crtc->funcs->reset)
4720 crtc->funcs->reset(crtc);
4722 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
4723 if (encoder->funcs->reset)
4724 encoder->funcs->reset(encoder);
4726 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
4727 connector->status = connector_status_unknown;
4729 if (connector->funcs->reset)
4730 connector->funcs->reset(connector);
4733 EXPORT_SYMBOL(drm_mode_config_reset);
4736 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
4739 * @file_priv: DRM file info
4741 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
4742 * TTM or something else entirely) and returns the resulting buffer handle. This
4743 * handle can then be wrapped up into a framebuffer modeset object.
4745 * Note that userspace is not allowed to use such objects for render
4746 * acceleration - drivers must create their own private ioctls for such a use
4749 * Called by the user via ioctl.
4752 * Zero on success, negative errno on failure.
4754 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
4755 void *data, struct drm_file *file_priv)
4757 struct drm_mode_create_dumb *args = data;
4758 u32 cpp, stride, size;
4760 if (!dev->driver->dumb_create)
4762 if (!args->width || !args->height || !args->bpp)
4765 /* overflow checks for 32bit size calculations */
4766 /* NOTE: DIV_ROUND_UP() can overflow */
4767 cpp = DIV_ROUND_UP(args->bpp, 8);
4768 if (!cpp || cpp > 0xffffffffU / args->width)
4770 stride = cpp * args->width;
4771 if (args->height > 0xffffffffU / stride)
4774 /* test for wrap-around */
4775 size = args->height * stride;
4776 if (PAGE_ALIGN(size) == 0)
4780 * handle, pitch and size are output parameters. Zero them out to
4781 * prevent drivers from accidentally using uninitialized data. Since
4782 * not all existing userspace is clearing these fields properly we
4783 * cannot reject IOCTL with garbage in them.
4789 return dev->driver->dumb_create(file_priv, dev, args);
4793 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
4796 * @file_priv: DRM file info
4798 * Allocate an offset in the drm device node's address space to be able to
4799 * memory map a dumb buffer.
4801 * Called by the user via ioctl.
4804 * Zero on success, negative errno on failure.
4806 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
4807 void *data, struct drm_file *file_priv)
4809 struct drm_mode_map_dumb *args = data;
4811 /* call driver ioctl to get mmap offset */
4812 if (!dev->driver->dumb_map_offset)
4815 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
4819 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
4822 * @file_priv: DRM file info
4824 * This destroys the userspace handle for the given dumb backing storage buffer.
4825 * Since buffer objects must be reference counted in the kernel a buffer object
4826 * won't be immediately freed if a framebuffer modeset object still uses it.
4828 * Called by the user via ioctl.
4831 * Zero on success, negative errno on failure.
4833 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
4834 void *data, struct drm_file *file_priv)
4836 struct drm_mode_destroy_dumb *args = data;
4838 if (!dev->driver->dumb_destroy)
4841 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
4845 * drm_fb_get_bpp_depth - get the bpp/depth values for format
4846 * @format: pixel format (DRM_FORMAT_*)
4847 * @depth: storage for the depth value
4848 * @bpp: storage for the bpp value
4850 * This only supports RGB formats here for compat with code that doesn't use
4851 * pixel formats directly yet.
4853 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
4858 case DRM_FORMAT_RGB332:
4859 case DRM_FORMAT_BGR233:
4863 case DRM_FORMAT_XRGB1555:
4864 case DRM_FORMAT_XBGR1555:
4865 case DRM_FORMAT_RGBX5551:
4866 case DRM_FORMAT_BGRX5551:
4867 case DRM_FORMAT_ARGB1555:
4868 case DRM_FORMAT_ABGR1555:
4869 case DRM_FORMAT_RGBA5551:
4870 case DRM_FORMAT_BGRA5551:
4874 case DRM_FORMAT_RGB565:
4875 case DRM_FORMAT_BGR565:
4879 case DRM_FORMAT_RGB888:
4880 case DRM_FORMAT_BGR888:
4884 case DRM_FORMAT_XRGB8888:
4885 case DRM_FORMAT_XBGR8888:
4886 case DRM_FORMAT_RGBX8888:
4887 case DRM_FORMAT_BGRX8888:
4891 case DRM_FORMAT_XRGB2101010:
4892 case DRM_FORMAT_XBGR2101010:
4893 case DRM_FORMAT_RGBX1010102:
4894 case DRM_FORMAT_BGRX1010102:
4895 case DRM_FORMAT_ARGB2101010:
4896 case DRM_FORMAT_ABGR2101010:
4897 case DRM_FORMAT_RGBA1010102:
4898 case DRM_FORMAT_BGRA1010102:
4902 case DRM_FORMAT_ARGB8888:
4903 case DRM_FORMAT_ABGR8888:
4904 case DRM_FORMAT_RGBA8888:
4905 case DRM_FORMAT_BGRA8888:
4910 DRM_DEBUG_KMS("unsupported pixel format %s\n",
4911 drm_get_format_name(format));
4917 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
4920 * drm_format_num_planes - get the number of planes for format
4921 * @format: pixel format (DRM_FORMAT_*)
4924 * The number of planes used by the specified pixel format.
4926 int drm_format_num_planes(uint32_t format)
4929 case DRM_FORMAT_YUV410:
4930 case DRM_FORMAT_YVU410:
4931 case DRM_FORMAT_YUV411:
4932 case DRM_FORMAT_YVU411:
4933 case DRM_FORMAT_YUV420:
4934 case DRM_FORMAT_YVU420:
4935 case DRM_FORMAT_YUV422:
4936 case DRM_FORMAT_YVU422:
4937 case DRM_FORMAT_YUV444:
4938 case DRM_FORMAT_YVU444:
4940 case DRM_FORMAT_NV12:
4941 case DRM_FORMAT_NV21:
4942 case DRM_FORMAT_NV16:
4943 case DRM_FORMAT_NV61:
4944 case DRM_FORMAT_NV24:
4945 case DRM_FORMAT_NV42:
4951 EXPORT_SYMBOL(drm_format_num_planes);
4954 * drm_format_plane_cpp - determine the bytes per pixel value
4955 * @format: pixel format (DRM_FORMAT_*)
4956 * @plane: plane index
4959 * The bytes per pixel value for the specified plane.
4961 int drm_format_plane_cpp(uint32_t format, int plane)
4966 if (plane >= drm_format_num_planes(format))
4970 case DRM_FORMAT_YUYV:
4971 case DRM_FORMAT_YVYU:
4972 case DRM_FORMAT_UYVY:
4973 case DRM_FORMAT_VYUY:
4975 case DRM_FORMAT_NV12:
4976 case DRM_FORMAT_NV21:
4977 case DRM_FORMAT_NV16:
4978 case DRM_FORMAT_NV61:
4979 case DRM_FORMAT_NV24:
4980 case DRM_FORMAT_NV42:
4981 return plane ? 2 : 1;
4982 case DRM_FORMAT_YUV410:
4983 case DRM_FORMAT_YVU410:
4984 case DRM_FORMAT_YUV411:
4985 case DRM_FORMAT_YVU411:
4986 case DRM_FORMAT_YUV420:
4987 case DRM_FORMAT_YVU420:
4988 case DRM_FORMAT_YUV422:
4989 case DRM_FORMAT_YVU422:
4990 case DRM_FORMAT_YUV444:
4991 case DRM_FORMAT_YVU444:
4994 drm_fb_get_bpp_depth(format, &depth, &bpp);
4998 EXPORT_SYMBOL(drm_format_plane_cpp);
5001 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5002 * @format: pixel format (DRM_FORMAT_*)
5005 * The horizontal chroma subsampling factor for the
5006 * specified pixel format.
5008 int drm_format_horz_chroma_subsampling(uint32_t format)
5011 case DRM_FORMAT_YUV411:
5012 case DRM_FORMAT_YVU411:
5013 case DRM_FORMAT_YUV410:
5014 case DRM_FORMAT_YVU410:
5016 case DRM_FORMAT_YUYV:
5017 case DRM_FORMAT_YVYU:
5018 case DRM_FORMAT_UYVY:
5019 case DRM_FORMAT_VYUY:
5020 case DRM_FORMAT_NV12:
5021 case DRM_FORMAT_NV21:
5022 case DRM_FORMAT_NV16:
5023 case DRM_FORMAT_NV61:
5024 case DRM_FORMAT_YUV422:
5025 case DRM_FORMAT_YVU422:
5026 case DRM_FORMAT_YUV420:
5027 case DRM_FORMAT_YVU420:
5033 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5036 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5037 * @format: pixel format (DRM_FORMAT_*)
5040 * The vertical chroma subsampling factor for the
5041 * specified pixel format.
5043 int drm_format_vert_chroma_subsampling(uint32_t format)
5046 case DRM_FORMAT_YUV410:
5047 case DRM_FORMAT_YVU410:
5049 case DRM_FORMAT_YUV420:
5050 case DRM_FORMAT_YVU420:
5051 case DRM_FORMAT_NV12:
5052 case DRM_FORMAT_NV21:
5058 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5061 * drm_rotation_simplify() - Try to simplify the rotation
5062 * @rotation: Rotation to be simplified
5063 * @supported_rotations: Supported rotations
5065 * Attempt to simplify the rotation to a form that is supported.
5066 * Eg. if the hardware supports everything except DRM_REFLECT_X
5067 * one could call this function like this:
5069 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5070 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5071 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5073 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5074 * transforms the hardware supports, this function may not
5075 * be able to produce a supported transform, so the caller should
5076 * check the result afterwards.
5078 unsigned int drm_rotation_simplify(unsigned int rotation,
5079 unsigned int supported_rotations)
5081 if (rotation & ~supported_rotations) {
5082 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5083 rotation = (rotation & ~0xf) | BIT((ffs(rotation & 0xf) + 1) % 4);
5088 EXPORT_SYMBOL(drm_rotation_simplify);
5091 * drm_mode_config_init - initialize DRM mode_configuration structure
5094 * Initialize @dev's mode_config structure, used for tracking the graphics
5095 * configuration of @dev.
5097 * Since this initializes the modeset locks, no locking is possible. Which is no
5098 * problem, since this should happen single threaded at init time. It is the
5099 * driver's problem to ensure this guarantee.
5102 void drm_mode_config_init(struct drm_device *dev)
5104 mutex_init(&dev->mode_config.mutex);
5105 drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5106 mutex_init(&dev->mode_config.idr_mutex);
5107 mutex_init(&dev->mode_config.fb_lock);
5108 INIT_LIST_HEAD(&dev->mode_config.fb_list);
5109 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5110 INIT_LIST_HEAD(&dev->mode_config.connector_list);
5111 INIT_LIST_HEAD(&dev->mode_config.bridge_list);
5112 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5113 INIT_LIST_HEAD(&dev->mode_config.property_list);
5114 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5115 INIT_LIST_HEAD(&dev->mode_config.plane_list);
5116 idr_init(&dev->mode_config.crtc_idr);
5118 drm_modeset_lock_all(dev);
5119 drm_mode_create_standard_connector_properties(dev);
5120 drm_mode_create_standard_plane_properties(dev);
5121 drm_modeset_unlock_all(dev);
5123 /* Just to be sure */
5124 dev->mode_config.num_fb = 0;
5125 dev->mode_config.num_connector = 0;
5126 dev->mode_config.num_crtc = 0;
5127 dev->mode_config.num_encoder = 0;
5128 dev->mode_config.num_overlay_plane = 0;
5129 dev->mode_config.num_total_plane = 0;
5131 EXPORT_SYMBOL(drm_mode_config_init);
5134 * drm_mode_config_cleanup - free up DRM mode_config info
5137 * Free up all the connectors and CRTCs associated with this DRM device, then
5138 * free up the framebuffers and associated buffer objects.
5140 * Note that since this /should/ happen single-threaded at driver/device
5141 * teardown time, no locking is required. It's the driver's job to ensure that
5142 * this guarantee actually holds true.
5144 * FIXME: cleanup any dangling user buffer objects too
5146 void drm_mode_config_cleanup(struct drm_device *dev)
5148 struct drm_connector *connector, *ot;
5149 struct drm_crtc *crtc, *ct;
5150 struct drm_encoder *encoder, *enct;
5151 struct drm_bridge *bridge, *brt;
5152 struct drm_framebuffer *fb, *fbt;
5153 struct drm_property *property, *pt;
5154 struct drm_property_blob *blob, *bt;
5155 struct drm_plane *plane, *plt;
5157 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5159 encoder->funcs->destroy(encoder);
5162 list_for_each_entry_safe(bridge, brt,
5163 &dev->mode_config.bridge_list, head) {
5164 bridge->funcs->destroy(bridge);
5167 list_for_each_entry_safe(connector, ot,
5168 &dev->mode_config.connector_list, head) {
5169 connector->funcs->destroy(connector);
5172 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5174 drm_property_destroy(dev, property);
5177 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
5179 drm_property_destroy_blob(dev, blob);
5183 * Single-threaded teardown context, so it's not required to grab the
5184 * fb_lock to protect against concurrent fb_list access. Contrary, it
5185 * would actually deadlock with the drm_framebuffer_cleanup function.
5187 * Also, if there are any framebuffers left, that's a driver leak now,
5188 * so politely WARN about this.
5190 WARN_ON(!list_empty(&dev->mode_config.fb_list));
5191 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
5192 drm_framebuffer_remove(fb);
5195 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
5197 plane->funcs->destroy(plane);
5200 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
5201 crtc->funcs->destroy(crtc);
5204 idr_destroy(&dev->mode_config.crtc_idr);
5205 drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
5207 EXPORT_SYMBOL(drm_mode_config_cleanup);
5209 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
5210 unsigned int supported_rotations)
5212 static const struct drm_prop_enum_list props[] = {
5213 { DRM_ROTATE_0, "rotate-0" },
5214 { DRM_ROTATE_90, "rotate-90" },
5215 { DRM_ROTATE_180, "rotate-180" },
5216 { DRM_ROTATE_270, "rotate-270" },
5217 { DRM_REFLECT_X, "reflect-x" },
5218 { DRM_REFLECT_Y, "reflect-y" },
5221 return drm_property_create_bitmask(dev, 0, "rotation",
5222 props, ARRAY_SIZE(props),
5223 supported_rotations);
5225 EXPORT_SYMBOL(drm_mode_create_rotation_property);