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>
41 #include "drm_crtc_internal.h"
44 * drm_modeset_lock_all - take all modeset locks
47 * This function takes all modeset locks, suitable where a more fine-grained
48 * scheme isn't (yet) implemented. Locks must be dropped with
49 * drm_modeset_unlock_all.
51 void drm_modeset_lock_all(struct drm_device *dev)
53 struct drm_crtc *crtc;
55 mutex_lock(&dev->mode_config.mutex);
57 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
58 mutex_lock_nest_lock(&crtc->mutex, &dev->mode_config.mutex);
60 EXPORT_SYMBOL(drm_modeset_lock_all);
63 * drm_modeset_unlock_all - drop all modeset locks
66 * This function drop all modeset locks taken by drm_modeset_lock_all.
68 void drm_modeset_unlock_all(struct drm_device *dev)
70 struct drm_crtc *crtc;
72 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
73 mutex_unlock(&crtc->mutex);
75 mutex_unlock(&dev->mode_config.mutex);
77 EXPORT_SYMBOL(drm_modeset_unlock_all);
80 * drm_warn_on_modeset_not_all_locked - check that all modeset locks are locked
83 * Useful as a debug assert.
85 void drm_warn_on_modeset_not_all_locked(struct drm_device *dev)
87 struct drm_crtc *crtc;
89 /* Locking is currently fubar in the panic handler. */
93 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
94 WARN_ON(!mutex_is_locked(&crtc->mutex));
96 WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
98 EXPORT_SYMBOL(drm_warn_on_modeset_not_all_locked);
100 /* Avoid boilerplate. I'm tired of typing. */
101 #define DRM_ENUM_NAME_FN(fnname, list) \
102 const char *fnname(int val) \
105 for (i = 0; i < ARRAY_SIZE(list); i++) { \
106 if (list[i].type == val) \
107 return list[i].name; \
109 return "(unknown)"; \
115 static const struct drm_prop_enum_list drm_dpms_enum_list[] =
116 { { DRM_MODE_DPMS_ON, "On" },
117 { DRM_MODE_DPMS_STANDBY, "Standby" },
118 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
119 { DRM_MODE_DPMS_OFF, "Off" }
122 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
125 * Optional properties
127 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] =
129 { DRM_MODE_SCALE_NONE, "None" },
130 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
131 { DRM_MODE_SCALE_CENTER, "Center" },
132 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
136 * Non-global properties, but "required" for certain connectors.
138 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] =
140 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
141 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
142 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
145 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
147 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] =
149 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
150 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
151 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
154 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
155 drm_dvi_i_subconnector_enum_list)
157 static const struct drm_prop_enum_list drm_tv_select_enum_list[] =
159 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
160 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
161 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
162 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
163 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
166 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
168 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] =
170 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
171 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
172 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
173 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
174 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
177 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
178 drm_tv_subconnector_enum_list)
180 static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
181 { DRM_MODE_DIRTY_OFF, "Off" },
182 { DRM_MODE_DIRTY_ON, "On" },
183 { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
186 struct drm_conn_prop_enum_list {
193 * Connector and encoder types.
195 static struct drm_conn_prop_enum_list drm_connector_enum_list[] =
196 { { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
197 { DRM_MODE_CONNECTOR_VGA, "VGA" },
198 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
199 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
200 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
201 { DRM_MODE_CONNECTOR_Composite, "Composite" },
202 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
203 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
204 { DRM_MODE_CONNECTOR_Component, "Component" },
205 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
206 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
207 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
208 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
209 { DRM_MODE_CONNECTOR_TV, "TV" },
210 { DRM_MODE_CONNECTOR_eDP, "eDP" },
211 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
212 { DRM_MODE_CONNECTOR_DSI, "DSI" },
215 static const struct drm_prop_enum_list drm_encoder_enum_list[] =
216 { { DRM_MODE_ENCODER_NONE, "None" },
217 { DRM_MODE_ENCODER_DAC, "DAC" },
218 { DRM_MODE_ENCODER_TMDS, "TMDS" },
219 { DRM_MODE_ENCODER_LVDS, "LVDS" },
220 { DRM_MODE_ENCODER_TVDAC, "TV" },
221 { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
222 { DRM_MODE_ENCODER_DSI, "DSI" },
225 static const struct drm_prop_enum_list drm_subpixel_enum_list[] =
227 { SubPixelUnknown, "Unknown" },
228 { SubPixelHorizontalRGB, "Horizontal RGB" },
229 { SubPixelHorizontalBGR, "Horizontal BGR" },
230 { SubPixelVerticalRGB, "Vertical RGB" },
231 { SubPixelVerticalBGR, "Vertical BGR" },
232 { SubPixelNone, "None" },
235 void drm_connector_ida_init(void)
239 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
240 ida_init(&drm_connector_enum_list[i].ida);
243 void drm_connector_ida_destroy(void)
247 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
248 ida_destroy(&drm_connector_enum_list[i].ida);
252 * drm_get_encoder_name - return a string for encoder
253 * @encoder: encoder to compute name of
255 * Note that the buffer used by this function is globally shared and owned by
256 * the function itself.
258 * FIXME: This isn't really multithreading safe.
260 const char *drm_get_encoder_name(const struct drm_encoder *encoder)
264 snprintf(buf, 32, "%s-%d",
265 drm_encoder_enum_list[encoder->encoder_type].name,
269 EXPORT_SYMBOL(drm_get_encoder_name);
272 * drm_get_connector_name - return a string for connector
273 * @connector: connector to compute name of
275 * Note that the buffer used by this function is globally shared and owned by
276 * the function itself.
278 * FIXME: This isn't really multithreading safe.
280 const char *drm_get_connector_name(const struct drm_connector *connector)
284 snprintf(buf, 32, "%s-%d",
285 drm_connector_enum_list[connector->connector_type].name,
286 connector->connector_type_id);
289 EXPORT_SYMBOL(drm_get_connector_name);
292 * drm_get_connector_status_name - return a string for connector status
293 * @status: connector status to compute name of
295 * In contrast to the other drm_get_*_name functions this one here returns a
296 * const pointer and hence is threadsafe.
298 const char *drm_get_connector_status_name(enum drm_connector_status status)
300 if (status == connector_status_connected)
302 else if (status == connector_status_disconnected)
303 return "disconnected";
307 EXPORT_SYMBOL(drm_get_connector_status_name);
310 * drm_get_subpixel_order_name - return a string for a given subpixel enum
311 * @order: enum of subpixel_order
313 * Note you could abuse this and return something out of bounds, but that
314 * would be a caller error. No unscrubbed user data should make it here.
316 const char *drm_get_subpixel_order_name(enum subpixel_order order)
318 return drm_subpixel_enum_list[order].name;
320 EXPORT_SYMBOL(drm_get_subpixel_order_name);
322 static char printable_char(int c)
324 return isascii(c) && isprint(c) ? c : '?';
328 * drm_get_format_name - return a string for drm fourcc format
329 * @format: format to compute name of
331 * Note that the buffer used by this function is globally shared and owned by
332 * the function itself.
334 * FIXME: This isn't really multithreading safe.
336 const char *drm_get_format_name(uint32_t format)
340 snprintf(buf, sizeof(buf),
341 "%c%c%c%c %s-endian (0x%08x)",
342 printable_char(format & 0xff),
343 printable_char((format >> 8) & 0xff),
344 printable_char((format >> 16) & 0xff),
345 printable_char((format >> 24) & 0x7f),
346 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
351 EXPORT_SYMBOL(drm_get_format_name);
354 * drm_mode_object_get - allocate a new modeset identifier
356 * @obj: object pointer, used to generate unique ID
357 * @obj_type: object type
359 * Create a unique identifier based on @ptr in @dev's identifier space. Used
360 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
361 * modeset identifiers are _not_ reference counted. Hence don't use this for
362 * reference counted modeset objects like framebuffers.
365 * New unique (relative to other objects in @dev) integer identifier for the
368 int drm_mode_object_get(struct drm_device *dev,
369 struct drm_mode_object *obj, uint32_t obj_type)
373 mutex_lock(&dev->mode_config.idr_mutex);
374 ret = idr_alloc(&dev->mode_config.crtc_idr, obj, 1, 0, GFP_KERNEL);
377 * Set up the object linking under the protection of the idr
378 * lock so that other users can't see inconsistent state.
381 obj->type = obj_type;
383 mutex_unlock(&dev->mode_config.idr_mutex);
385 return ret < 0 ? ret : 0;
389 * drm_mode_object_put - free a modeset identifer
391 * @object: object to free
393 * Free @id from @dev's unique identifier pool. Note that despite the _get
394 * postfix modeset identifiers are _not_ reference counted. Hence don't use this
395 * for reference counted modeset objects like framebuffers.
397 void drm_mode_object_put(struct drm_device *dev,
398 struct drm_mode_object *object)
400 mutex_lock(&dev->mode_config.idr_mutex);
401 idr_remove(&dev->mode_config.crtc_idr, object->id);
402 mutex_unlock(&dev->mode_config.idr_mutex);
406 * drm_mode_object_find - look up a drm object with static lifetime
408 * @id: id of the mode object
409 * @type: type of the mode object
411 * Note that framebuffers cannot be looked up with this functions - since those
412 * are reference counted, they need special treatment.
414 struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
415 uint32_t id, uint32_t type)
417 struct drm_mode_object *obj = NULL;
419 /* Framebuffers are reference counted and need their own lookup
421 WARN_ON(type == DRM_MODE_OBJECT_FB);
423 mutex_lock(&dev->mode_config.idr_mutex);
424 obj = idr_find(&dev->mode_config.crtc_idr, id);
425 if (!obj || (obj->type != type) || (obj->id != id))
427 mutex_unlock(&dev->mode_config.idr_mutex);
431 EXPORT_SYMBOL(drm_mode_object_find);
434 * drm_framebuffer_init - initialize a framebuffer
436 * @fb: framebuffer to be initialized
437 * @funcs: ... with these functions
439 * Allocates an ID for the framebuffer's parent mode object, sets its mode
440 * functions & device file and adds it to the master fd list.
443 * This functions publishes the fb and makes it available for concurrent access
444 * by other users. Which means by this point the fb _must_ be fully set up -
445 * since all the fb attributes are invariant over its lifetime, no further
446 * locking but only correct reference counting is required.
449 * Zero on success, error code on failure.
451 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
452 const struct drm_framebuffer_funcs *funcs)
456 mutex_lock(&dev->mode_config.fb_lock);
457 kref_init(&fb->refcount);
458 INIT_LIST_HEAD(&fb->filp_head);
462 ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
466 /* Grab the idr reference. */
467 drm_framebuffer_reference(fb);
469 dev->mode_config.num_fb++;
470 list_add(&fb->head, &dev->mode_config.fb_list);
472 mutex_unlock(&dev->mode_config.fb_lock);
476 EXPORT_SYMBOL(drm_framebuffer_init);
478 static void drm_framebuffer_free(struct kref *kref)
480 struct drm_framebuffer *fb =
481 container_of(kref, struct drm_framebuffer, refcount);
482 fb->funcs->destroy(fb);
485 static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
488 struct drm_mode_object *obj = NULL;
489 struct drm_framebuffer *fb;
491 mutex_lock(&dev->mode_config.idr_mutex);
492 obj = idr_find(&dev->mode_config.crtc_idr, id);
493 if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
497 mutex_unlock(&dev->mode_config.idr_mutex);
503 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
505 * @id: id of the fb object
507 * If successful, this grabs an additional reference to the framebuffer -
508 * callers need to make sure to eventually unreference the returned framebuffer
509 * again, using @drm_framebuffer_unreference.
511 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
514 struct drm_framebuffer *fb;
516 mutex_lock(&dev->mode_config.fb_lock);
517 fb = __drm_framebuffer_lookup(dev, id);
519 drm_framebuffer_reference(fb);
520 mutex_unlock(&dev->mode_config.fb_lock);
524 EXPORT_SYMBOL(drm_framebuffer_lookup);
527 * drm_framebuffer_unreference - unref a framebuffer
528 * @fb: framebuffer to unref
530 * This functions decrements the fb's refcount and frees it if it drops to zero.
532 void drm_framebuffer_unreference(struct drm_framebuffer *fb)
534 DRM_DEBUG("FB ID: %d\n", fb->base.id);
535 kref_put(&fb->refcount, drm_framebuffer_free);
537 EXPORT_SYMBOL(drm_framebuffer_unreference);
540 * drm_framebuffer_reference - incr the fb refcnt
543 * This functions increments the fb's refcount.
545 void drm_framebuffer_reference(struct drm_framebuffer *fb)
547 DRM_DEBUG("FB ID: %d\n", fb->base.id);
548 kref_get(&fb->refcount);
550 EXPORT_SYMBOL(drm_framebuffer_reference);
552 static void drm_framebuffer_free_bug(struct kref *kref)
557 static void __drm_framebuffer_unreference(struct drm_framebuffer *fb)
559 DRM_DEBUG("FB ID: %d\n", fb->base.id);
560 kref_put(&fb->refcount, drm_framebuffer_free_bug);
563 /* dev->mode_config.fb_lock must be held! */
564 static void __drm_framebuffer_unregister(struct drm_device *dev,
565 struct drm_framebuffer *fb)
567 mutex_lock(&dev->mode_config.idr_mutex);
568 idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
569 mutex_unlock(&dev->mode_config.idr_mutex);
573 __drm_framebuffer_unreference(fb);
577 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
578 * @fb: fb to unregister
580 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
581 * those used for fbdev. Note that the caller must hold a reference of it's own,
582 * i.e. the object may not be destroyed through this call (since it'll lead to a
583 * locking inversion).
585 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
587 struct drm_device *dev = fb->dev;
589 mutex_lock(&dev->mode_config.fb_lock);
590 /* Mark fb as reaped and drop idr ref. */
591 __drm_framebuffer_unregister(dev, fb);
592 mutex_unlock(&dev->mode_config.fb_lock);
594 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
597 * drm_framebuffer_cleanup - remove a framebuffer object
598 * @fb: framebuffer to remove
600 * Cleanup framebuffer. This function is intended to be used from the drivers
601 * ->destroy callback. It can also be used to clean up driver private
602 * framebuffers embedded into a larger structure.
604 * Note that this function does not remove the fb from active usuage - if it is
605 * still used anywhere, hilarity can ensue since userspace could call getfb on
606 * the id and get back -EINVAL. Obviously no concern at driver unload time.
608 * Also, the framebuffer will not be removed from the lookup idr - for
609 * user-created framebuffers this will happen in in the rmfb ioctl. For
610 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
611 * drm_framebuffer_unregister_private.
613 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
615 struct drm_device *dev = fb->dev;
617 mutex_lock(&dev->mode_config.fb_lock);
619 dev->mode_config.num_fb--;
620 mutex_unlock(&dev->mode_config.fb_lock);
622 EXPORT_SYMBOL(drm_framebuffer_cleanup);
625 * drm_framebuffer_remove - remove and unreference a framebuffer object
626 * @fb: framebuffer to remove
628 * Scans all the CRTCs and planes in @dev's mode_config. If they're
629 * using @fb, removes it, setting it to NULL. Then drops the reference to the
630 * passed-in framebuffer. Might take the modeset locks.
632 * Note that this function optimizes the cleanup away if the caller holds the
633 * last reference to the framebuffer. It is also guaranteed to not take the
634 * modeset locks in this case.
636 void drm_framebuffer_remove(struct drm_framebuffer *fb)
638 struct drm_device *dev = fb->dev;
639 struct drm_crtc *crtc;
640 struct drm_plane *plane;
641 struct drm_mode_set set;
644 WARN_ON(!list_empty(&fb->filp_head));
647 * drm ABI mandates that we remove any deleted framebuffers from active
648 * useage. But since most sane clients only remove framebuffers they no
649 * longer need, try to optimize this away.
651 * Since we're holding a reference ourselves, observing a refcount of 1
652 * means that we're the last holder and can skip it. Also, the refcount
653 * can never increase from 1 again, so we don't need any barriers or
656 * Note that userspace could try to race with use and instate a new
657 * usage _after_ we've cleared all current ones. End result will be an
658 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
661 if (atomic_read(&fb->refcount.refcount) > 1) {
662 drm_modeset_lock_all(dev);
663 /* remove from any CRTC */
664 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
665 if (crtc->fb == fb) {
666 /* should turn off the crtc */
667 memset(&set, 0, sizeof(struct drm_mode_set));
670 ret = drm_mode_set_config_internal(&set);
672 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
676 list_for_each_entry(plane, &dev->mode_config.plane_list, head) {
678 drm_plane_force_disable(plane);
680 drm_modeset_unlock_all(dev);
683 drm_framebuffer_unreference(fb);
685 EXPORT_SYMBOL(drm_framebuffer_remove);
688 * drm_crtc_init - Initialise a new CRTC object
690 * @crtc: CRTC object to init
691 * @funcs: callbacks for the new CRTC
693 * Inits a new object created as base part of a driver crtc object.
696 * Zero on success, error code on failure.
698 int drm_crtc_init(struct drm_device *dev, struct drm_crtc *crtc,
699 const struct drm_crtc_funcs *funcs)
705 crtc->invert_dimensions = false;
707 drm_modeset_lock_all(dev);
708 mutex_init(&crtc->mutex);
709 mutex_lock_nest_lock(&crtc->mutex, &dev->mode_config.mutex);
711 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
715 crtc->base.properties = &crtc->properties;
717 list_add_tail(&crtc->head, &dev->mode_config.crtc_list);
718 dev->mode_config.num_crtc++;
721 drm_modeset_unlock_all(dev);
725 EXPORT_SYMBOL(drm_crtc_init);
728 * drm_crtc_cleanup - Clean up the core crtc usage
729 * @crtc: CRTC to cleanup
731 * This function cleans up @crtc and removes it from the DRM mode setting
732 * core. Note that the function does *not* free the crtc structure itself,
733 * this is the responsibility of the caller.
735 void drm_crtc_cleanup(struct drm_crtc *crtc)
737 struct drm_device *dev = crtc->dev;
739 kfree(crtc->gamma_store);
740 crtc->gamma_store = NULL;
742 drm_mode_object_put(dev, &crtc->base);
743 list_del(&crtc->head);
744 dev->mode_config.num_crtc--;
746 EXPORT_SYMBOL(drm_crtc_cleanup);
749 * drm_crtc_index - find the index of a registered CRTC
750 * @crtc: CRTC to find index for
752 * Given a registered CRTC, return the index of that CRTC within a DRM
753 * device's list of CRTCs.
755 unsigned int drm_crtc_index(struct drm_crtc *crtc)
757 unsigned int index = 0;
758 struct drm_crtc *tmp;
760 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
769 EXPORT_SYMBOL(drm_crtc_index);
772 * drm_mode_remove - remove and free a mode
773 * @connector: connector list to modify
774 * @mode: mode to remove
776 * Remove @mode from @connector's mode list, then free it.
778 static void drm_mode_remove(struct drm_connector *connector,
779 struct drm_display_mode *mode)
781 list_del(&mode->head);
782 drm_mode_destroy(connector->dev, mode);
786 * drm_connector_init - Init a preallocated connector
788 * @connector: the connector to init
789 * @funcs: callbacks for this connector
790 * @connector_type: user visible type of the connector
792 * Initialises a preallocated connector. Connectors should be
793 * subclassed as part of driver connector objects.
796 * Zero on success, error code on failure.
798 int drm_connector_init(struct drm_device *dev,
799 struct drm_connector *connector,
800 const struct drm_connector_funcs *funcs,
804 struct ida *connector_ida =
805 &drm_connector_enum_list[connector_type].ida;
807 drm_modeset_lock_all(dev);
809 ret = drm_mode_object_get(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR);
813 connector->base.properties = &connector->properties;
814 connector->dev = dev;
815 connector->funcs = funcs;
816 connector->connector_type = connector_type;
817 connector->connector_type_id =
818 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
819 if (connector->connector_type_id < 0) {
820 ret = connector->connector_type_id;
821 drm_mode_object_put(dev, &connector->base);
824 INIT_LIST_HEAD(&connector->probed_modes);
825 INIT_LIST_HEAD(&connector->modes);
826 connector->edid_blob_ptr = NULL;
827 connector->status = connector_status_unknown;
829 list_add_tail(&connector->head, &dev->mode_config.connector_list);
830 dev->mode_config.num_connector++;
832 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
833 drm_object_attach_property(&connector->base,
834 dev->mode_config.edid_property,
837 drm_object_attach_property(&connector->base,
838 dev->mode_config.dpms_property, 0);
841 drm_modeset_unlock_all(dev);
845 EXPORT_SYMBOL(drm_connector_init);
848 * drm_connector_cleanup - cleans up an initialised connector
849 * @connector: connector to cleanup
851 * Cleans up the connector but doesn't free the object.
853 void drm_connector_cleanup(struct drm_connector *connector)
855 struct drm_device *dev = connector->dev;
856 struct drm_display_mode *mode, *t;
858 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
859 drm_mode_remove(connector, mode);
861 list_for_each_entry_safe(mode, t, &connector->modes, head)
862 drm_mode_remove(connector, mode);
864 ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
865 connector->connector_type_id);
867 drm_mode_object_put(dev, &connector->base);
868 list_del(&connector->head);
869 dev->mode_config.num_connector--;
871 EXPORT_SYMBOL(drm_connector_cleanup);
874 * drm_connector_unplug_all - unregister connector userspace interfaces
877 * This function unregisters all connector userspace interfaces in sysfs. Should
878 * be call when the device is disconnected, e.g. from an usb driver's
879 * ->disconnect callback.
881 void drm_connector_unplug_all(struct drm_device *dev)
883 struct drm_connector *connector;
885 /* taking the mode config mutex ends up in a clash with sysfs */
886 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
887 drm_sysfs_connector_remove(connector);
890 EXPORT_SYMBOL(drm_connector_unplug_all);
893 * drm_bridge_init - initialize a drm transcoder/bridge
895 * @bridge: transcoder/bridge to set up
896 * @funcs: bridge function table
898 * Initialises a preallocated bridge. Bridges should be
899 * subclassed as part of driver connector objects.
902 * Zero on success, error code on failure.
904 int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
905 const struct drm_bridge_funcs *funcs)
909 drm_modeset_lock_all(dev);
911 ret = drm_mode_object_get(dev, &bridge->base, DRM_MODE_OBJECT_BRIDGE);
916 bridge->funcs = funcs;
918 list_add_tail(&bridge->head, &dev->mode_config.bridge_list);
919 dev->mode_config.num_bridge++;
922 drm_modeset_unlock_all(dev);
925 EXPORT_SYMBOL(drm_bridge_init);
928 * drm_bridge_cleanup - cleans up an initialised bridge
929 * @bridge: bridge to cleanup
931 * Cleans up the bridge but doesn't free the object.
933 void drm_bridge_cleanup(struct drm_bridge *bridge)
935 struct drm_device *dev = bridge->dev;
937 drm_modeset_lock_all(dev);
938 drm_mode_object_put(dev, &bridge->base);
939 list_del(&bridge->head);
940 dev->mode_config.num_bridge--;
941 drm_modeset_unlock_all(dev);
943 EXPORT_SYMBOL(drm_bridge_cleanup);
946 * drm_encoder_init - Init a preallocated encoder
948 * @encoder: the encoder to init
949 * @funcs: callbacks for this encoder
950 * @encoder_type: user visible type of the encoder
952 * Initialises a preallocated encoder. Encoder should be
953 * subclassed as part of driver encoder objects.
956 * Zero on success, error code on failure.
958 int drm_encoder_init(struct drm_device *dev,
959 struct drm_encoder *encoder,
960 const struct drm_encoder_funcs *funcs,
965 drm_modeset_lock_all(dev);
967 ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
972 encoder->encoder_type = encoder_type;
973 encoder->funcs = funcs;
975 list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
976 dev->mode_config.num_encoder++;
979 drm_modeset_unlock_all(dev);
983 EXPORT_SYMBOL(drm_encoder_init);
986 * drm_encoder_cleanup - cleans up an initialised encoder
987 * @encoder: encoder to cleanup
989 * Cleans up the encoder but doesn't free the object.
991 void drm_encoder_cleanup(struct drm_encoder *encoder)
993 struct drm_device *dev = encoder->dev;
994 drm_modeset_lock_all(dev);
995 drm_mode_object_put(dev, &encoder->base);
996 list_del(&encoder->head);
997 dev->mode_config.num_encoder--;
998 drm_modeset_unlock_all(dev);
1000 EXPORT_SYMBOL(drm_encoder_cleanup);
1003 * drm_plane_init - Initialise a new plane object
1005 * @plane: plane object to init
1006 * @possible_crtcs: bitmask of possible CRTCs
1007 * @funcs: callbacks for the new plane
1008 * @formats: array of supported formats (%DRM_FORMAT_*)
1009 * @format_count: number of elements in @formats
1010 * @priv: plane is private (hidden from userspace)?
1012 * Inits a preallocate plane object created as base part of a driver plane
1016 * Zero on success, error code on failure.
1018 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1019 unsigned long possible_crtcs,
1020 const struct drm_plane_funcs *funcs,
1021 const uint32_t *formats, uint32_t format_count,
1026 drm_modeset_lock_all(dev);
1028 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1032 plane->base.properties = &plane->properties;
1034 plane->funcs = funcs;
1035 plane->format_types = kmalloc(sizeof(uint32_t) * format_count,
1037 if (!plane->format_types) {
1038 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1039 drm_mode_object_put(dev, &plane->base);
1044 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1045 plane->format_count = format_count;
1046 plane->possible_crtcs = possible_crtcs;
1048 /* private planes are not exposed to userspace, but depending on
1049 * display hardware, might be convenient to allow sharing programming
1050 * for the scanout engine with the crtc implementation.
1053 list_add_tail(&plane->head, &dev->mode_config.plane_list);
1054 dev->mode_config.num_plane++;
1056 INIT_LIST_HEAD(&plane->head);
1060 drm_modeset_unlock_all(dev);
1064 EXPORT_SYMBOL(drm_plane_init);
1067 * drm_plane_cleanup - Clean up the core plane usage
1068 * @plane: plane to cleanup
1070 * This function cleans up @plane and removes it from the DRM mode setting
1071 * core. Note that the function does *not* free the plane structure itself,
1072 * this is the responsibility of the caller.
1074 void drm_plane_cleanup(struct drm_plane *plane)
1076 struct drm_device *dev = plane->dev;
1078 drm_modeset_lock_all(dev);
1079 kfree(plane->format_types);
1080 drm_mode_object_put(dev, &plane->base);
1081 /* if not added to a list, it must be a private plane */
1082 if (!list_empty(&plane->head)) {
1083 list_del(&plane->head);
1084 dev->mode_config.num_plane--;
1086 drm_modeset_unlock_all(dev);
1088 EXPORT_SYMBOL(drm_plane_cleanup);
1091 * drm_plane_force_disable - Forcibly disable a plane
1092 * @plane: plane to disable
1094 * Forces the plane to be disabled.
1096 * Used when the plane's current framebuffer is destroyed,
1097 * and when restoring fbdev mode.
1099 void drm_plane_force_disable(struct drm_plane *plane)
1106 ret = plane->funcs->disable_plane(plane);
1108 DRM_ERROR("failed to disable plane with busy fb\n");
1109 /* disconnect the plane from the fb and crtc: */
1110 __drm_framebuffer_unreference(plane->fb);
1114 EXPORT_SYMBOL(drm_plane_force_disable);
1116 static int drm_mode_create_standard_connector_properties(struct drm_device *dev)
1118 struct drm_property *edid;
1119 struct drm_property *dpms;
1122 * Standard properties (apply to all connectors)
1124 edid = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1125 DRM_MODE_PROP_IMMUTABLE,
1127 dev->mode_config.edid_property = edid;
1129 dpms = drm_property_create_enum(dev, 0,
1130 "DPMS", drm_dpms_enum_list,
1131 ARRAY_SIZE(drm_dpms_enum_list));
1132 dev->mode_config.dpms_property = dpms;
1138 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1141 * Called by a driver the first time a DVI-I connector is made.
1143 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1145 struct drm_property *dvi_i_selector;
1146 struct drm_property *dvi_i_subconnector;
1148 if (dev->mode_config.dvi_i_select_subconnector_property)
1152 drm_property_create_enum(dev, 0,
1153 "select subconnector",
1154 drm_dvi_i_select_enum_list,
1155 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1156 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1158 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1160 drm_dvi_i_subconnector_enum_list,
1161 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1162 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1166 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1169 * drm_create_tv_properties - create TV specific connector properties
1171 * @num_modes: number of different TV formats (modes) supported
1172 * @modes: array of pointers to strings containing name of each format
1174 * Called by a driver's TV initialization routine, this function creates
1175 * the TV specific connector properties for a given device. Caller is
1176 * responsible for allocating a list of format names and passing them to
1179 int drm_mode_create_tv_properties(struct drm_device *dev, int num_modes,
1182 struct drm_property *tv_selector;
1183 struct drm_property *tv_subconnector;
1186 if (dev->mode_config.tv_select_subconnector_property)
1190 * Basic connector properties
1192 tv_selector = drm_property_create_enum(dev, 0,
1193 "select subconnector",
1194 drm_tv_select_enum_list,
1195 ARRAY_SIZE(drm_tv_select_enum_list));
1196 dev->mode_config.tv_select_subconnector_property = tv_selector;
1199 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1201 drm_tv_subconnector_enum_list,
1202 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1203 dev->mode_config.tv_subconnector_property = tv_subconnector;
1206 * Other, TV specific properties: margins & TV modes.
1208 dev->mode_config.tv_left_margin_property =
1209 drm_property_create_range(dev, 0, "left margin", 0, 100);
1211 dev->mode_config.tv_right_margin_property =
1212 drm_property_create_range(dev, 0, "right margin", 0, 100);
1214 dev->mode_config.tv_top_margin_property =
1215 drm_property_create_range(dev, 0, "top margin", 0, 100);
1217 dev->mode_config.tv_bottom_margin_property =
1218 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1220 dev->mode_config.tv_mode_property =
1221 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1223 for (i = 0; i < num_modes; i++)
1224 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1227 dev->mode_config.tv_brightness_property =
1228 drm_property_create_range(dev, 0, "brightness", 0, 100);
1230 dev->mode_config.tv_contrast_property =
1231 drm_property_create_range(dev, 0, "contrast", 0, 100);
1233 dev->mode_config.tv_flicker_reduction_property =
1234 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1236 dev->mode_config.tv_overscan_property =
1237 drm_property_create_range(dev, 0, "overscan", 0, 100);
1239 dev->mode_config.tv_saturation_property =
1240 drm_property_create_range(dev, 0, "saturation", 0, 100);
1242 dev->mode_config.tv_hue_property =
1243 drm_property_create_range(dev, 0, "hue", 0, 100);
1247 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1250 * drm_mode_create_scaling_mode_property - create scaling mode property
1253 * Called by a driver the first time it's needed, must be attached to desired
1256 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1258 struct drm_property *scaling_mode;
1260 if (dev->mode_config.scaling_mode_property)
1264 drm_property_create_enum(dev, 0, "scaling mode",
1265 drm_scaling_mode_enum_list,
1266 ARRAY_SIZE(drm_scaling_mode_enum_list));
1268 dev->mode_config.scaling_mode_property = scaling_mode;
1272 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1275 * drm_mode_create_dirty_property - create dirty property
1278 * Called by a driver the first time it's needed, must be attached to desired
1281 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1283 struct drm_property *dirty_info;
1285 if (dev->mode_config.dirty_info_property)
1289 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1291 drm_dirty_info_enum_list,
1292 ARRAY_SIZE(drm_dirty_info_enum_list));
1293 dev->mode_config.dirty_info_property = dirty_info;
1297 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1299 static int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
1301 uint32_t total_objects = 0;
1303 total_objects += dev->mode_config.num_crtc;
1304 total_objects += dev->mode_config.num_connector;
1305 total_objects += dev->mode_config.num_encoder;
1306 total_objects += dev->mode_config.num_bridge;
1308 group->id_list = kzalloc(total_objects * sizeof(uint32_t), GFP_KERNEL);
1309 if (!group->id_list)
1312 group->num_crtcs = 0;
1313 group->num_connectors = 0;
1314 group->num_encoders = 0;
1315 group->num_bridges = 0;
1320 * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1321 * the drm core's responsibility to set up mode control groups.
1323 int drm_mode_group_init_legacy_group(struct drm_device *dev,
1324 struct drm_mode_group *group)
1326 struct drm_crtc *crtc;
1327 struct drm_encoder *encoder;
1328 struct drm_connector *connector;
1329 struct drm_bridge *bridge;
1332 if ((ret = drm_mode_group_init(dev, group)))
1335 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
1336 group->id_list[group->num_crtcs++] = crtc->base.id;
1338 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
1339 group->id_list[group->num_crtcs + group->num_encoders++] =
1342 list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1343 group->id_list[group->num_crtcs + group->num_encoders +
1344 group->num_connectors++] = connector->base.id;
1346 list_for_each_entry(bridge, &dev->mode_config.bridge_list, head)
1347 group->id_list[group->num_crtcs + group->num_encoders +
1348 group->num_connectors + group->num_bridges++] =
1353 EXPORT_SYMBOL(drm_mode_group_init_legacy_group);
1356 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1357 * @out: drm_mode_modeinfo struct to return to the user
1358 * @in: drm_display_mode to use
1360 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1363 static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
1364 const struct drm_display_mode *in)
1366 WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1367 in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1368 in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1369 in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1370 in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1371 "timing values too large for mode info\n");
1373 out->clock = in->clock;
1374 out->hdisplay = in->hdisplay;
1375 out->hsync_start = in->hsync_start;
1376 out->hsync_end = in->hsync_end;
1377 out->htotal = in->htotal;
1378 out->hskew = in->hskew;
1379 out->vdisplay = in->vdisplay;
1380 out->vsync_start = in->vsync_start;
1381 out->vsync_end = in->vsync_end;
1382 out->vtotal = in->vtotal;
1383 out->vscan = in->vscan;
1384 out->vrefresh = in->vrefresh;
1385 out->flags = in->flags;
1386 out->type = in->type;
1387 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1388 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1392 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1393 * @out: drm_display_mode to return to the user
1394 * @in: drm_mode_modeinfo to use
1396 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1400 * Zero on success, errno on failure.
1402 static int drm_crtc_convert_umode(struct drm_display_mode *out,
1403 const struct drm_mode_modeinfo *in)
1405 if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1408 if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1411 out->clock = in->clock;
1412 out->hdisplay = in->hdisplay;
1413 out->hsync_start = in->hsync_start;
1414 out->hsync_end = in->hsync_end;
1415 out->htotal = in->htotal;
1416 out->hskew = in->hskew;
1417 out->vdisplay = in->vdisplay;
1418 out->vsync_start = in->vsync_start;
1419 out->vsync_end = in->vsync_end;
1420 out->vtotal = in->vtotal;
1421 out->vscan = in->vscan;
1422 out->vrefresh = in->vrefresh;
1423 out->flags = in->flags;
1424 out->type = in->type;
1425 strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1426 out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1432 * drm_mode_getresources - get graphics configuration
1433 * @dev: drm device for the ioctl
1434 * @data: data pointer for the ioctl
1435 * @file_priv: drm file for the ioctl call
1437 * Construct a set of configuration description structures and return
1438 * them to the user, including CRTC, connector and framebuffer configuration.
1440 * Called by the user via ioctl.
1443 * Zero on success, errno on failure.
1445 int drm_mode_getresources(struct drm_device *dev, void *data,
1446 struct drm_file *file_priv)
1448 struct drm_mode_card_res *card_res = data;
1449 struct list_head *lh;
1450 struct drm_framebuffer *fb;
1451 struct drm_connector *connector;
1452 struct drm_crtc *crtc;
1453 struct drm_encoder *encoder;
1455 int connector_count = 0;
1458 int encoder_count = 0;
1460 uint32_t __user *fb_id;
1461 uint32_t __user *crtc_id;
1462 uint32_t __user *connector_id;
1463 uint32_t __user *encoder_id;
1464 struct drm_mode_group *mode_group;
1466 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1470 mutex_lock(&file_priv->fbs_lock);
1472 * For the non-control nodes we need to limit the list of resources
1473 * by IDs in the group list for this node
1475 list_for_each(lh, &file_priv->fbs)
1478 /* handle this in 4 parts */
1480 if (card_res->count_fbs >= fb_count) {
1482 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1483 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1484 if (put_user(fb->base.id, fb_id + copied)) {
1485 mutex_unlock(&file_priv->fbs_lock);
1491 card_res->count_fbs = fb_count;
1492 mutex_unlock(&file_priv->fbs_lock);
1494 drm_modeset_lock_all(dev);
1495 mode_group = &file_priv->master->minor->mode_group;
1496 if (file_priv->master->minor->type == DRM_MINOR_CONTROL) {
1498 list_for_each(lh, &dev->mode_config.crtc_list)
1501 list_for_each(lh, &dev->mode_config.connector_list)
1504 list_for_each(lh, &dev->mode_config.encoder_list)
1508 crtc_count = mode_group->num_crtcs;
1509 connector_count = mode_group->num_connectors;
1510 encoder_count = mode_group->num_encoders;
1513 card_res->max_height = dev->mode_config.max_height;
1514 card_res->min_height = dev->mode_config.min_height;
1515 card_res->max_width = dev->mode_config.max_width;
1516 card_res->min_width = dev->mode_config.min_width;
1519 if (card_res->count_crtcs >= crtc_count) {
1521 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1522 if (file_priv->master->minor->type == DRM_MINOR_CONTROL) {
1523 list_for_each_entry(crtc, &dev->mode_config.crtc_list,
1525 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1526 if (put_user(crtc->base.id, crtc_id + copied)) {
1533 for (i = 0; i < mode_group->num_crtcs; i++) {
1534 if (put_user(mode_group->id_list[i],
1535 crtc_id + copied)) {
1543 card_res->count_crtcs = crtc_count;
1546 if (card_res->count_encoders >= encoder_count) {
1548 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1549 if (file_priv->master->minor->type == DRM_MINOR_CONTROL) {
1550 list_for_each_entry(encoder,
1551 &dev->mode_config.encoder_list,
1553 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1554 drm_get_encoder_name(encoder));
1555 if (put_user(encoder->base.id, encoder_id +
1563 for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
1564 if (put_user(mode_group->id_list[i],
1565 encoder_id + copied)) {
1574 card_res->count_encoders = encoder_count;
1577 if (card_res->count_connectors >= connector_count) {
1579 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1580 if (file_priv->master->minor->type == DRM_MINOR_CONTROL) {
1581 list_for_each_entry(connector,
1582 &dev->mode_config.connector_list,
1584 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1586 drm_get_connector_name(connector));
1587 if (put_user(connector->base.id,
1588 connector_id + copied)) {
1595 int start = mode_group->num_crtcs +
1596 mode_group->num_encoders;
1597 for (i = start; i < start + mode_group->num_connectors; i++) {
1598 if (put_user(mode_group->id_list[i],
1599 connector_id + copied)) {
1607 card_res->count_connectors = connector_count;
1609 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1610 card_res->count_connectors, card_res->count_encoders);
1613 drm_modeset_unlock_all(dev);
1618 * drm_mode_getcrtc - get CRTC configuration
1619 * @dev: drm device for the ioctl
1620 * @data: data pointer for the ioctl
1621 * @file_priv: drm file for the ioctl call
1623 * Construct a CRTC configuration structure to return to the user.
1625 * Called by the user via ioctl.
1628 * Zero on success, errno on failure.
1630 int drm_mode_getcrtc(struct drm_device *dev,
1631 void *data, struct drm_file *file_priv)
1633 struct drm_mode_crtc *crtc_resp = data;
1634 struct drm_crtc *crtc;
1635 struct drm_mode_object *obj;
1638 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1641 drm_modeset_lock_all(dev);
1643 obj = drm_mode_object_find(dev, crtc_resp->crtc_id,
1644 DRM_MODE_OBJECT_CRTC);
1649 crtc = obj_to_crtc(obj);
1651 crtc_resp->x = crtc->x;
1652 crtc_resp->y = crtc->y;
1653 crtc_resp->gamma_size = crtc->gamma_size;
1655 crtc_resp->fb_id = crtc->fb->base.id;
1657 crtc_resp->fb_id = 0;
1659 if (crtc->enabled) {
1661 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
1662 crtc_resp->mode_valid = 1;
1665 crtc_resp->mode_valid = 0;
1669 drm_modeset_unlock_all(dev);
1673 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
1674 const struct drm_file *file_priv)
1677 * If user-space hasn't configured the driver to expose the stereo 3D
1678 * modes, don't expose them.
1680 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
1687 * drm_mode_getconnector - get connector configuration
1688 * @dev: drm device for the ioctl
1689 * @data: data pointer for the ioctl
1690 * @file_priv: drm file for the ioctl call
1692 * Construct a connector configuration structure to return to the user.
1694 * Called by the user via ioctl.
1697 * Zero on success, errno on failure.
1699 int drm_mode_getconnector(struct drm_device *dev, void *data,
1700 struct drm_file *file_priv)
1702 struct drm_mode_get_connector *out_resp = data;
1703 struct drm_mode_object *obj;
1704 struct drm_connector *connector;
1705 struct drm_display_mode *mode;
1707 int props_count = 0;
1708 int encoders_count = 0;
1712 struct drm_mode_modeinfo u_mode;
1713 struct drm_mode_modeinfo __user *mode_ptr;
1714 uint32_t __user *prop_ptr;
1715 uint64_t __user *prop_values;
1716 uint32_t __user *encoder_ptr;
1718 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1721 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
1723 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
1725 mutex_lock(&dev->mode_config.mutex);
1727 obj = drm_mode_object_find(dev, out_resp->connector_id,
1728 DRM_MODE_OBJECT_CONNECTOR);
1733 connector = obj_to_connector(obj);
1735 props_count = connector->properties.count;
1737 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
1738 if (connector->encoder_ids[i] != 0) {
1743 if (out_resp->count_modes == 0) {
1744 connector->funcs->fill_modes(connector,
1745 dev->mode_config.max_width,
1746 dev->mode_config.max_height);
1749 /* delayed so we get modes regardless of pre-fill_modes state */
1750 list_for_each_entry(mode, &connector->modes, head)
1751 if (drm_mode_expose_to_userspace(mode, file_priv))
1754 out_resp->connector_id = connector->base.id;
1755 out_resp->connector_type = connector->connector_type;
1756 out_resp->connector_type_id = connector->connector_type_id;
1757 out_resp->mm_width = connector->display_info.width_mm;
1758 out_resp->mm_height = connector->display_info.height_mm;
1759 out_resp->subpixel = connector->display_info.subpixel_order;
1760 out_resp->connection = connector->status;
1761 if (connector->encoder)
1762 out_resp->encoder_id = connector->encoder->base.id;
1764 out_resp->encoder_id = 0;
1767 * This ioctl is called twice, once to determine how much space is
1768 * needed, and the 2nd time to fill it.
1770 if ((out_resp->count_modes >= mode_count) && mode_count) {
1772 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
1773 list_for_each_entry(mode, &connector->modes, head) {
1774 if (!drm_mode_expose_to_userspace(mode, file_priv))
1777 drm_crtc_convert_to_umode(&u_mode, mode);
1778 if (copy_to_user(mode_ptr + copied,
1779 &u_mode, sizeof(u_mode))) {
1786 out_resp->count_modes = mode_count;
1788 if ((out_resp->count_props >= props_count) && props_count) {
1790 prop_ptr = (uint32_t __user *)(unsigned long)(out_resp->props_ptr);
1791 prop_values = (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr);
1792 for (i = 0; i < connector->properties.count; i++) {
1793 if (put_user(connector->properties.ids[i],
1794 prop_ptr + copied)) {
1799 if (put_user(connector->properties.values[i],
1800 prop_values + copied)) {
1807 out_resp->count_props = props_count;
1809 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
1811 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
1812 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
1813 if (connector->encoder_ids[i] != 0) {
1814 if (put_user(connector->encoder_ids[i],
1815 encoder_ptr + copied)) {
1823 out_resp->count_encoders = encoders_count;
1826 mutex_unlock(&dev->mode_config.mutex);
1832 * drm_mode_getencoder - get encoder configuration
1833 * @dev: drm device for the ioctl
1834 * @data: data pointer for the ioctl
1835 * @file_priv: drm file for the ioctl call
1837 * Construct a encoder configuration structure to return to the user.
1839 * Called by the user via ioctl.
1842 * Zero on success, errno on failure.
1844 int drm_mode_getencoder(struct drm_device *dev, void *data,
1845 struct drm_file *file_priv)
1847 struct drm_mode_get_encoder *enc_resp = data;
1848 struct drm_mode_object *obj;
1849 struct drm_encoder *encoder;
1852 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1855 drm_modeset_lock_all(dev);
1856 obj = drm_mode_object_find(dev, enc_resp->encoder_id,
1857 DRM_MODE_OBJECT_ENCODER);
1862 encoder = obj_to_encoder(obj);
1865 enc_resp->crtc_id = encoder->crtc->base.id;
1867 enc_resp->crtc_id = 0;
1868 enc_resp->encoder_type = encoder->encoder_type;
1869 enc_resp->encoder_id = encoder->base.id;
1870 enc_resp->possible_crtcs = encoder->possible_crtcs;
1871 enc_resp->possible_clones = encoder->possible_clones;
1874 drm_modeset_unlock_all(dev);
1879 * drm_mode_getplane_res - enumerate all plane resources
1882 * @file_priv: DRM file info
1884 * Construct a list of plane ids to return to the user.
1886 * Called by the user via ioctl.
1889 * Zero on success, errno on failure.
1891 int drm_mode_getplane_res(struct drm_device *dev, void *data,
1892 struct drm_file *file_priv)
1894 struct drm_mode_get_plane_res *plane_resp = data;
1895 struct drm_mode_config *config;
1896 struct drm_plane *plane;
1897 uint32_t __user *plane_ptr;
1898 int copied = 0, ret = 0;
1900 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1903 drm_modeset_lock_all(dev);
1904 config = &dev->mode_config;
1907 * This ioctl is called twice, once to determine how much space is
1908 * needed, and the 2nd time to fill it.
1910 if (config->num_plane &&
1911 (plane_resp->count_planes >= config->num_plane)) {
1912 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
1914 list_for_each_entry(plane, &config->plane_list, head) {
1915 if (put_user(plane->base.id, plane_ptr + copied)) {
1922 plane_resp->count_planes = config->num_plane;
1925 drm_modeset_unlock_all(dev);
1930 * drm_mode_getplane - get plane configuration
1933 * @file_priv: DRM file info
1935 * Construct a plane configuration structure to return to the user.
1937 * Called by the user via ioctl.
1940 * Zero on success, errno on failure.
1942 int drm_mode_getplane(struct drm_device *dev, void *data,
1943 struct drm_file *file_priv)
1945 struct drm_mode_get_plane *plane_resp = data;
1946 struct drm_mode_object *obj;
1947 struct drm_plane *plane;
1948 uint32_t __user *format_ptr;
1951 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1954 drm_modeset_lock_all(dev);
1955 obj = drm_mode_object_find(dev, plane_resp->plane_id,
1956 DRM_MODE_OBJECT_PLANE);
1961 plane = obj_to_plane(obj);
1964 plane_resp->crtc_id = plane->crtc->base.id;
1966 plane_resp->crtc_id = 0;
1969 plane_resp->fb_id = plane->fb->base.id;
1971 plane_resp->fb_id = 0;
1973 plane_resp->plane_id = plane->base.id;
1974 plane_resp->possible_crtcs = plane->possible_crtcs;
1975 plane_resp->gamma_size = 0;
1978 * This ioctl is called twice, once to determine how much space is
1979 * needed, and the 2nd time to fill it.
1981 if (plane->format_count &&
1982 (plane_resp->count_format_types >= plane->format_count)) {
1983 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
1984 if (copy_to_user(format_ptr,
1985 plane->format_types,
1986 sizeof(uint32_t) * plane->format_count)) {
1991 plane_resp->count_format_types = plane->format_count;
1994 drm_modeset_unlock_all(dev);
1999 * drm_mode_setplane - configure a plane's configuration
2001 * @data: ioctl data*
2002 * @file_priv: DRM file info
2004 * Set plane configuration, including placement, fb, scaling, and other factors.
2005 * Or pass a NULL fb to disable.
2008 * Zero on success, errno on failure.
2010 int drm_mode_setplane(struct drm_device *dev, void *data,
2011 struct drm_file *file_priv)
2013 struct drm_mode_set_plane *plane_req = data;
2014 struct drm_mode_object *obj;
2015 struct drm_plane *plane;
2016 struct drm_crtc *crtc;
2017 struct drm_framebuffer *fb = NULL, *old_fb = NULL;
2019 unsigned int fb_width, fb_height;
2022 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2026 * First, find the plane, crtc, and fb objects. If not available,
2027 * we don't bother to call the driver.
2029 obj = drm_mode_object_find(dev, plane_req->plane_id,
2030 DRM_MODE_OBJECT_PLANE);
2032 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2033 plane_req->plane_id);
2036 plane = obj_to_plane(obj);
2038 /* No fb means shut it down */
2039 if (!plane_req->fb_id) {
2040 drm_modeset_lock_all(dev);
2042 plane->funcs->disable_plane(plane);
2045 drm_modeset_unlock_all(dev);
2049 obj = drm_mode_object_find(dev, plane_req->crtc_id,
2050 DRM_MODE_OBJECT_CRTC);
2052 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2053 plane_req->crtc_id);
2057 crtc = obj_to_crtc(obj);
2059 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2061 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2067 /* Check whether this plane supports the fb pixel format. */
2068 for (i = 0; i < plane->format_count; i++)
2069 if (fb->pixel_format == plane->format_types[i])
2071 if (i == plane->format_count) {
2072 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2073 drm_get_format_name(fb->pixel_format));
2078 fb_width = fb->width << 16;
2079 fb_height = fb->height << 16;
2081 /* Make sure source coordinates are inside the fb. */
2082 if (plane_req->src_w > fb_width ||
2083 plane_req->src_x > fb_width - plane_req->src_w ||
2084 plane_req->src_h > fb_height ||
2085 plane_req->src_y > fb_height - plane_req->src_h) {
2086 DRM_DEBUG_KMS("Invalid source coordinates "
2087 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2088 plane_req->src_w >> 16,
2089 ((plane_req->src_w & 0xffff) * 15625) >> 10,
2090 plane_req->src_h >> 16,
2091 ((plane_req->src_h & 0xffff) * 15625) >> 10,
2092 plane_req->src_x >> 16,
2093 ((plane_req->src_x & 0xffff) * 15625) >> 10,
2094 plane_req->src_y >> 16,
2095 ((plane_req->src_y & 0xffff) * 15625) >> 10);
2100 /* Give drivers some help against integer overflows */
2101 if (plane_req->crtc_w > INT_MAX ||
2102 plane_req->crtc_x > INT_MAX - (int32_t) plane_req->crtc_w ||
2103 plane_req->crtc_h > INT_MAX ||
2104 plane_req->crtc_y > INT_MAX - (int32_t) plane_req->crtc_h) {
2105 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2106 plane_req->crtc_w, plane_req->crtc_h,
2107 plane_req->crtc_x, plane_req->crtc_y);
2112 drm_modeset_lock_all(dev);
2113 ret = plane->funcs->update_plane(plane, crtc, fb,
2114 plane_req->crtc_x, plane_req->crtc_y,
2115 plane_req->crtc_w, plane_req->crtc_h,
2116 plane_req->src_x, plane_req->src_y,
2117 plane_req->src_w, plane_req->src_h);
2124 drm_modeset_unlock_all(dev);
2128 drm_framebuffer_unreference(fb);
2130 drm_framebuffer_unreference(old_fb);
2136 * drm_mode_set_config_internal - helper to call ->set_config
2137 * @set: modeset config to set
2139 * This is a little helper to wrap internal calls to the ->set_config driver
2140 * interface. The only thing it adds is correct refcounting dance.
2143 * Zero on success, errno on failure.
2145 int drm_mode_set_config_internal(struct drm_mode_set *set)
2147 struct drm_crtc *crtc = set->crtc;
2148 struct drm_framebuffer *fb;
2149 struct drm_crtc *tmp;
2153 * NOTE: ->set_config can also disable other crtcs (if we steal all
2154 * connectors from it), hence we need to refcount the fbs across all
2155 * crtcs. Atomic modeset will have saner semantics ...
2157 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head)
2158 tmp->old_fb = tmp->fb;
2162 ret = crtc->funcs->set_config(set);
2164 /* crtc->fb must be updated by ->set_config, enforces this. */
2165 WARN_ON(fb != crtc->fb);
2168 list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
2170 drm_framebuffer_reference(tmp->fb);
2172 drm_framebuffer_unreference(tmp->old_fb);
2177 EXPORT_SYMBOL(drm_mode_set_config_internal);
2180 * Checks that the framebuffer is big enough for the CRTC viewport
2181 * (x, y, hdisplay, vdisplay)
2183 static int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2185 const struct drm_display_mode *mode,
2186 const struct drm_framebuffer *fb)
2189 int hdisplay, vdisplay;
2191 hdisplay = mode->hdisplay;
2192 vdisplay = mode->vdisplay;
2194 if (drm_mode_is_stereo(mode)) {
2195 struct drm_display_mode adjusted = *mode;
2197 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE);
2198 hdisplay = adjusted.crtc_hdisplay;
2199 vdisplay = adjusted.crtc_vdisplay;
2202 if (crtc->invert_dimensions)
2203 swap(hdisplay, vdisplay);
2205 if (hdisplay > fb->width ||
2206 vdisplay > fb->height ||
2207 x > fb->width - hdisplay ||
2208 y > fb->height - vdisplay) {
2209 DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2210 fb->width, fb->height, hdisplay, vdisplay, x, y,
2211 crtc->invert_dimensions ? " (inverted)" : "");
2219 * drm_mode_setcrtc - set CRTC configuration
2220 * @dev: drm device for the ioctl
2221 * @data: data pointer for the ioctl
2222 * @file_priv: drm file for the ioctl call
2224 * Build a new CRTC configuration based on user request.
2226 * Called by the user via ioctl.
2229 * Zero on success, errno on failure.
2231 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2232 struct drm_file *file_priv)
2234 struct drm_mode_config *config = &dev->mode_config;
2235 struct drm_mode_crtc *crtc_req = data;
2236 struct drm_mode_object *obj;
2237 struct drm_crtc *crtc;
2238 struct drm_connector **connector_set = NULL, *connector;
2239 struct drm_framebuffer *fb = NULL;
2240 struct drm_display_mode *mode = NULL;
2241 struct drm_mode_set set;
2242 uint32_t __user *set_connectors_ptr;
2246 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2249 /* For some reason crtc x/y offsets are signed internally. */
2250 if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
2253 drm_modeset_lock_all(dev);
2254 obj = drm_mode_object_find(dev, crtc_req->crtc_id,
2255 DRM_MODE_OBJECT_CRTC);
2257 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2261 crtc = obj_to_crtc(obj);
2262 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2264 if (crtc_req->mode_valid) {
2265 /* If we have a mode we need a framebuffer. */
2266 /* If we pass -1, set the mode with the currently bound fb */
2267 if (crtc_req->fb_id == -1) {
2269 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2274 /* Make refcounting symmetric with the lookup path. */
2275 drm_framebuffer_reference(fb);
2277 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2279 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2286 mode = drm_mode_create(dev);
2292 ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
2294 DRM_DEBUG_KMS("Invalid mode\n");
2298 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2300 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2307 if (crtc_req->count_connectors == 0 && mode) {
2308 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2313 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2314 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2315 crtc_req->count_connectors);
2320 if (crtc_req->count_connectors > 0) {
2323 /* Avoid unbounded kernel memory allocation */
2324 if (crtc_req->count_connectors > config->num_connector) {
2329 connector_set = kmalloc(crtc_req->count_connectors *
2330 sizeof(struct drm_connector *),
2332 if (!connector_set) {
2337 for (i = 0; i < crtc_req->count_connectors; i++) {
2338 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2339 if (get_user(out_id, &set_connectors_ptr[i])) {
2344 obj = drm_mode_object_find(dev, out_id,
2345 DRM_MODE_OBJECT_CONNECTOR);
2347 DRM_DEBUG_KMS("Connector id %d unknown\n",
2352 connector = obj_to_connector(obj);
2353 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2355 drm_get_connector_name(connector));
2357 connector_set[i] = connector;
2362 set.x = crtc_req->x;
2363 set.y = crtc_req->y;
2365 set.connectors = connector_set;
2366 set.num_connectors = crtc_req->count_connectors;
2368 ret = drm_mode_set_config_internal(&set);
2372 drm_framebuffer_unreference(fb);
2374 kfree(connector_set);
2375 drm_mode_destroy(dev, mode);
2376 drm_modeset_unlock_all(dev);
2380 static int drm_mode_cursor_common(struct drm_device *dev,
2381 struct drm_mode_cursor2 *req,
2382 struct drm_file *file_priv)
2384 struct drm_mode_object *obj;
2385 struct drm_crtc *crtc;
2388 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2391 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
2394 obj = drm_mode_object_find(dev, req->crtc_id, DRM_MODE_OBJECT_CRTC);
2396 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
2399 crtc = obj_to_crtc(obj);
2401 mutex_lock(&crtc->mutex);
2402 if (req->flags & DRM_MODE_CURSOR_BO) {
2403 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
2407 /* Turns off the cursor if handle is 0 */
2408 if (crtc->funcs->cursor_set2)
2409 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
2410 req->width, req->height, req->hot_x, req->hot_y);
2412 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
2413 req->width, req->height);
2416 if (req->flags & DRM_MODE_CURSOR_MOVE) {
2417 if (crtc->funcs->cursor_move) {
2418 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
2425 mutex_unlock(&crtc->mutex);
2433 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
2434 * @dev: drm device for the ioctl
2435 * @data: data pointer for the ioctl
2436 * @file_priv: drm file for the ioctl call
2438 * Set the cursor configuration based on user request.
2440 * Called by the user via ioctl.
2443 * Zero on success, errno on failure.
2445 int drm_mode_cursor_ioctl(struct drm_device *dev,
2446 void *data, struct drm_file *file_priv)
2448 struct drm_mode_cursor *req = data;
2449 struct drm_mode_cursor2 new_req;
2451 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
2452 new_req.hot_x = new_req.hot_y = 0;
2454 return drm_mode_cursor_common(dev, &new_req, file_priv);
2458 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
2459 * @dev: drm device for the ioctl
2460 * @data: data pointer for the ioctl
2461 * @file_priv: drm file for the ioctl call
2463 * Set the cursor configuration based on user request. This implements the 2nd
2464 * version of the cursor ioctl, which allows userspace to additionally specify
2465 * the hotspot of the pointer.
2467 * Called by the user via ioctl.
2470 * Zero on success, errno on failure.
2472 int drm_mode_cursor2_ioctl(struct drm_device *dev,
2473 void *data, struct drm_file *file_priv)
2475 struct drm_mode_cursor2 *req = data;
2476 return drm_mode_cursor_common(dev, req, file_priv);
2480 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
2481 * @bpp: bits per pixels
2482 * @depth: bit depth per pixel
2484 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
2485 * Useful in fbdev emulation code, since that deals in those values.
2487 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
2493 fmt = DRM_FORMAT_C8;
2497 fmt = DRM_FORMAT_XRGB1555;
2499 fmt = DRM_FORMAT_RGB565;
2502 fmt = DRM_FORMAT_RGB888;
2506 fmt = DRM_FORMAT_XRGB8888;
2507 else if (depth == 30)
2508 fmt = DRM_FORMAT_XRGB2101010;
2510 fmt = DRM_FORMAT_ARGB8888;
2513 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
2514 fmt = DRM_FORMAT_XRGB8888;
2520 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
2523 * drm_mode_addfb - add an FB to the graphics configuration
2524 * @dev: drm device for the ioctl
2525 * @data: data pointer for the ioctl
2526 * @file_priv: drm file for the ioctl call
2528 * Add a new FB to the specified CRTC, given a user request. This is the
2529 * original addfb ioclt which only supported RGB formats.
2531 * Called by the user via ioctl.
2534 * Zero on success, errno on failure.
2536 int drm_mode_addfb(struct drm_device *dev,
2537 void *data, struct drm_file *file_priv)
2539 struct drm_mode_fb_cmd *or = data;
2540 struct drm_mode_fb_cmd2 r = {};
2541 struct drm_mode_config *config = &dev->mode_config;
2542 struct drm_framebuffer *fb;
2545 /* Use new struct with format internally */
2546 r.fb_id = or->fb_id;
2547 r.width = or->width;
2548 r.height = or->height;
2549 r.pitches[0] = or->pitch;
2550 r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
2551 r.handles[0] = or->handle;
2553 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2556 if ((config->min_width > r.width) || (r.width > config->max_width))
2559 if ((config->min_height > r.height) || (r.height > config->max_height))
2562 fb = dev->mode_config.funcs->fb_create(dev, file_priv, &r);
2564 DRM_DEBUG_KMS("could not create framebuffer\n");
2568 mutex_lock(&file_priv->fbs_lock);
2569 or->fb_id = fb->base.id;
2570 list_add(&fb->filp_head, &file_priv->fbs);
2571 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
2572 mutex_unlock(&file_priv->fbs_lock);
2577 static int format_check(const struct drm_mode_fb_cmd2 *r)
2579 uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
2583 case DRM_FORMAT_RGB332:
2584 case DRM_FORMAT_BGR233:
2585 case DRM_FORMAT_XRGB4444:
2586 case DRM_FORMAT_XBGR4444:
2587 case DRM_FORMAT_RGBX4444:
2588 case DRM_FORMAT_BGRX4444:
2589 case DRM_FORMAT_ARGB4444:
2590 case DRM_FORMAT_ABGR4444:
2591 case DRM_FORMAT_RGBA4444:
2592 case DRM_FORMAT_BGRA4444:
2593 case DRM_FORMAT_XRGB1555:
2594 case DRM_FORMAT_XBGR1555:
2595 case DRM_FORMAT_RGBX5551:
2596 case DRM_FORMAT_BGRX5551:
2597 case DRM_FORMAT_ARGB1555:
2598 case DRM_FORMAT_ABGR1555:
2599 case DRM_FORMAT_RGBA5551:
2600 case DRM_FORMAT_BGRA5551:
2601 case DRM_FORMAT_RGB565:
2602 case DRM_FORMAT_BGR565:
2603 case DRM_FORMAT_RGB888:
2604 case DRM_FORMAT_BGR888:
2605 case DRM_FORMAT_XRGB8888:
2606 case DRM_FORMAT_XBGR8888:
2607 case DRM_FORMAT_RGBX8888:
2608 case DRM_FORMAT_BGRX8888:
2609 case DRM_FORMAT_ARGB8888:
2610 case DRM_FORMAT_ABGR8888:
2611 case DRM_FORMAT_RGBA8888:
2612 case DRM_FORMAT_BGRA8888:
2613 case DRM_FORMAT_XRGB2101010:
2614 case DRM_FORMAT_XBGR2101010:
2615 case DRM_FORMAT_RGBX1010102:
2616 case DRM_FORMAT_BGRX1010102:
2617 case DRM_FORMAT_ARGB2101010:
2618 case DRM_FORMAT_ABGR2101010:
2619 case DRM_FORMAT_RGBA1010102:
2620 case DRM_FORMAT_BGRA1010102:
2621 case DRM_FORMAT_YUYV:
2622 case DRM_FORMAT_YVYU:
2623 case DRM_FORMAT_UYVY:
2624 case DRM_FORMAT_VYUY:
2625 case DRM_FORMAT_AYUV:
2626 case DRM_FORMAT_NV12:
2627 case DRM_FORMAT_NV21:
2628 case DRM_FORMAT_NV16:
2629 case DRM_FORMAT_NV61:
2630 case DRM_FORMAT_NV24:
2631 case DRM_FORMAT_NV42:
2632 case DRM_FORMAT_YUV410:
2633 case DRM_FORMAT_YVU410:
2634 case DRM_FORMAT_YUV411:
2635 case DRM_FORMAT_YVU411:
2636 case DRM_FORMAT_YUV420:
2637 case DRM_FORMAT_YVU420:
2638 case DRM_FORMAT_YUV422:
2639 case DRM_FORMAT_YVU422:
2640 case DRM_FORMAT_YUV444:
2641 case DRM_FORMAT_YVU444:
2644 DRM_DEBUG_KMS("invalid pixel format %s\n",
2645 drm_get_format_name(r->pixel_format));
2650 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
2652 int ret, hsub, vsub, num_planes, i;
2654 ret = format_check(r);
2656 DRM_DEBUG_KMS("bad framebuffer format %s\n",
2657 drm_get_format_name(r->pixel_format));
2661 hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
2662 vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
2663 num_planes = drm_format_num_planes(r->pixel_format);
2665 if (r->width == 0 || r->width % hsub) {
2666 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->height);
2670 if (r->height == 0 || r->height % vsub) {
2671 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
2675 for (i = 0; i < num_planes; i++) {
2676 unsigned int width = r->width / (i != 0 ? hsub : 1);
2677 unsigned int height = r->height / (i != 0 ? vsub : 1);
2678 unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);
2680 if (!r->handles[i]) {
2681 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
2685 if ((uint64_t) width * cpp > UINT_MAX)
2688 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
2691 if (r->pitches[i] < width * cpp) {
2692 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
2701 * drm_mode_addfb2 - add an FB to the graphics configuration
2702 * @dev: drm device for the ioctl
2703 * @data: data pointer for the ioctl
2704 * @file_priv: drm file for the ioctl call
2706 * Add a new FB to the specified CRTC, given a user request with format. This is
2707 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
2708 * and uses fourcc codes as pixel format specifiers.
2710 * Called by the user via ioctl.
2713 * Zero on success, errno on failure.
2715 int drm_mode_addfb2(struct drm_device *dev,
2716 void *data, struct drm_file *file_priv)
2718 struct drm_mode_fb_cmd2 *r = data;
2719 struct drm_mode_config *config = &dev->mode_config;
2720 struct drm_framebuffer *fb;
2723 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2726 if (r->flags & ~DRM_MODE_FB_INTERLACED) {
2727 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
2731 if ((config->min_width > r->width) || (r->width > config->max_width)) {
2732 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
2733 r->width, config->min_width, config->max_width);
2736 if ((config->min_height > r->height) || (r->height > config->max_height)) {
2737 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
2738 r->height, config->min_height, config->max_height);
2742 ret = framebuffer_check(r);
2746 fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
2748 DRM_DEBUG_KMS("could not create framebuffer\n");
2752 mutex_lock(&file_priv->fbs_lock);
2753 r->fb_id = fb->base.id;
2754 list_add(&fb->filp_head, &file_priv->fbs);
2755 DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
2756 mutex_unlock(&file_priv->fbs_lock);
2763 * drm_mode_rmfb - remove an FB from the configuration
2764 * @dev: drm device for the ioctl
2765 * @data: data pointer for the ioctl
2766 * @file_priv: drm file for the ioctl call
2768 * Remove the FB specified by the user.
2770 * Called by the user via ioctl.
2773 * Zero on success, errno on failure.
2775 int drm_mode_rmfb(struct drm_device *dev,
2776 void *data, struct drm_file *file_priv)
2778 struct drm_framebuffer *fb = NULL;
2779 struct drm_framebuffer *fbl = NULL;
2780 uint32_t *id = data;
2783 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2786 mutex_lock(&file_priv->fbs_lock);
2787 mutex_lock(&dev->mode_config.fb_lock);
2788 fb = __drm_framebuffer_lookup(dev, *id);
2792 list_for_each_entry(fbl, &file_priv->fbs, filp_head)
2798 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
2799 __drm_framebuffer_unregister(dev, fb);
2801 list_del_init(&fb->filp_head);
2802 mutex_unlock(&dev->mode_config.fb_lock);
2803 mutex_unlock(&file_priv->fbs_lock);
2805 drm_framebuffer_remove(fb);
2810 mutex_unlock(&dev->mode_config.fb_lock);
2811 mutex_unlock(&file_priv->fbs_lock);
2817 * drm_mode_getfb - get FB info
2818 * @dev: drm device for the ioctl
2819 * @data: data pointer for the ioctl
2820 * @file_priv: drm file for the ioctl call
2822 * Lookup the FB given its ID and return info about it.
2824 * Called by the user via ioctl.
2827 * Zero on success, errno on failure.
2829 int drm_mode_getfb(struct drm_device *dev,
2830 void *data, struct drm_file *file_priv)
2832 struct drm_mode_fb_cmd *r = data;
2833 struct drm_framebuffer *fb;
2836 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2839 fb = drm_framebuffer_lookup(dev, r->fb_id);
2843 r->height = fb->height;
2844 r->width = fb->width;
2845 r->depth = fb->depth;
2846 r->bpp = fb->bits_per_pixel;
2847 r->pitch = fb->pitches[0];
2848 if (fb->funcs->create_handle) {
2849 if (file_priv->is_master || capable(CAP_SYS_ADMIN)) {
2850 ret = fb->funcs->create_handle(fb, file_priv,
2853 /* GET_FB() is an unprivileged ioctl so we must not
2854 * return a buffer-handle to non-master processes! For
2855 * backwards-compatibility reasons, we cannot make
2856 * GET_FB() privileged, so just return an invalid handle
2857 * for non-masters. */
2865 drm_framebuffer_unreference(fb);
2871 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
2872 * @dev: drm device for the ioctl
2873 * @data: data pointer for the ioctl
2874 * @file_priv: drm file for the ioctl call
2876 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
2877 * rectangle list. Generic userspace which does frontbuffer rendering must call
2878 * this ioctl to flush out the changes on manual-update display outputs, e.g.
2879 * usb display-link, mipi manual update panels or edp panel self refresh modes.
2881 * Modesetting drivers which always update the frontbuffer do not need to
2882 * implement the corresponding ->dirty framebuffer callback.
2884 * Called by the user via ioctl.
2887 * Zero on success, errno on failure.
2889 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
2890 void *data, struct drm_file *file_priv)
2892 struct drm_clip_rect __user *clips_ptr;
2893 struct drm_clip_rect *clips = NULL;
2894 struct drm_mode_fb_dirty_cmd *r = data;
2895 struct drm_framebuffer *fb;
2900 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2903 fb = drm_framebuffer_lookup(dev, r->fb_id);
2907 num_clips = r->num_clips;
2908 clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
2910 if (!num_clips != !clips_ptr) {
2915 flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
2917 /* If userspace annotates copy, clips must come in pairs */
2918 if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
2923 if (num_clips && clips_ptr) {
2924 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
2928 clips = kzalloc(num_clips * sizeof(*clips), GFP_KERNEL);
2934 ret = copy_from_user(clips, clips_ptr,
2935 num_clips * sizeof(*clips));
2942 if (fb->funcs->dirty) {
2943 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
2952 drm_framebuffer_unreference(fb);
2959 * drm_fb_release - remove and free the FBs on this file
2960 * @priv: drm file for the ioctl
2962 * Destroy all the FBs associated with @filp.
2964 * Called by the user via ioctl.
2967 * Zero on success, errno on failure.
2969 void drm_fb_release(struct drm_file *priv)
2971 struct drm_device *dev = priv->minor->dev;
2972 struct drm_framebuffer *fb, *tfb;
2974 mutex_lock(&priv->fbs_lock);
2975 list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
2977 mutex_lock(&dev->mode_config.fb_lock);
2978 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
2979 __drm_framebuffer_unregister(dev, fb);
2980 mutex_unlock(&dev->mode_config.fb_lock);
2982 list_del_init(&fb->filp_head);
2984 /* This will also drop the fpriv->fbs reference. */
2985 drm_framebuffer_remove(fb);
2987 mutex_unlock(&priv->fbs_lock);
2991 * drm_property_create - create a new property type
2993 * @flags: flags specifying the property type
2994 * @name: name of the property
2995 * @num_values: number of pre-defined values
2997 * This creates a new generic drm property which can then be attached to a drm
2998 * object with drm_object_attach_property. The returned property object must be
2999 * freed with drm_property_destroy.
3002 * A pointer to the newly created property on success, NULL on failure.
3004 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3005 const char *name, int num_values)
3007 struct drm_property *property = NULL;
3010 property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3015 property->values = kzalloc(sizeof(uint64_t)*num_values, GFP_KERNEL);
3016 if (!property->values)
3020 ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3024 property->flags = flags;
3025 property->num_values = num_values;
3026 INIT_LIST_HEAD(&property->enum_blob_list);
3029 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3030 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3033 list_add_tail(&property->head, &dev->mode_config.property_list);
3036 kfree(property->values);
3040 EXPORT_SYMBOL(drm_property_create);
3043 * drm_property_create - create a new enumeration property type
3045 * @flags: flags specifying the property type
3046 * @name: name of the property
3047 * @props: enumeration lists with property values
3048 * @num_values: number of pre-defined values
3050 * This creates a new generic drm property which can then be attached to a drm
3051 * object with drm_object_attach_property. The returned property object must be
3052 * freed with drm_property_destroy.
3054 * Userspace is only allowed to set one of the predefined values for enumeration
3058 * A pointer to the newly created property on success, NULL on failure.
3060 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3062 const struct drm_prop_enum_list *props,
3065 struct drm_property *property;
3068 flags |= DRM_MODE_PROP_ENUM;
3070 property = drm_property_create(dev, flags, name, num_values);
3074 for (i = 0; i < num_values; i++) {
3075 ret = drm_property_add_enum(property, i,
3079 drm_property_destroy(dev, property);
3086 EXPORT_SYMBOL(drm_property_create_enum);
3089 * drm_property_create - create a new bitmask property type
3091 * @flags: flags specifying the property type
3092 * @name: name of the property
3093 * @props: enumeration lists with property bitflags
3094 * @num_values: number of pre-defined values
3096 * This creates a new generic drm property which can then be attached to a drm
3097 * object with drm_object_attach_property. The returned property object must be
3098 * freed with drm_property_destroy.
3100 * Compared to plain enumeration properties userspace is allowed to set any
3101 * or'ed together combination of the predefined property bitflag values
3104 * A pointer to the newly created property on success, NULL on failure.
3106 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3107 int flags, const char *name,
3108 const struct drm_prop_enum_list *props,
3111 struct drm_property *property;
3114 flags |= DRM_MODE_PROP_BITMASK;
3116 property = drm_property_create(dev, flags, name, num_values);
3120 for (i = 0; i < num_values; i++) {
3121 ret = drm_property_add_enum(property, i,
3125 drm_property_destroy(dev, property);
3132 EXPORT_SYMBOL(drm_property_create_bitmask);
3135 * drm_property_create - create a new ranged property type
3137 * @flags: flags specifying the property type
3138 * @name: name of the property
3139 * @min: minimum value of the property
3140 * @max: maximum value of the property
3142 * This creates a new generic drm property which can then be attached to a drm
3143 * object with drm_object_attach_property. The returned property object must be
3144 * freed with drm_property_destroy.
3146 * Userspace is allowed to set any interger value in the (min, max) range
3150 * A pointer to the newly created property on success, NULL on failure.
3152 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3154 uint64_t min, uint64_t max)
3156 struct drm_property *property;
3158 flags |= DRM_MODE_PROP_RANGE;
3160 property = drm_property_create(dev, flags, name, 2);
3164 property->values[0] = min;
3165 property->values[1] = max;
3169 EXPORT_SYMBOL(drm_property_create_range);
3172 * drm_property_add_enum - add a possible value to an enumeration property
3173 * @property: enumeration property to change
3174 * @index: index of the new enumeration
3175 * @value: value of the new enumeration
3176 * @name: symbolic name of the new enumeration
3178 * This functions adds enumerations to a property.
3180 * It's use is deprecated, drivers should use one of the more specific helpers
3181 * to directly create the property with all enumerations already attached.
3184 * Zero on success, error code on failure.
3186 int drm_property_add_enum(struct drm_property *property, int index,
3187 uint64_t value, const char *name)
3189 struct drm_property_enum *prop_enum;
3191 if (!(property->flags & (DRM_MODE_PROP_ENUM | DRM_MODE_PROP_BITMASK)))
3195 * Bitmask enum properties have the additional constraint of values
3198 if ((property->flags & DRM_MODE_PROP_BITMASK) && (value > 63))
3201 if (!list_empty(&property->enum_blob_list)) {
3202 list_for_each_entry(prop_enum, &property->enum_blob_list, head) {
3203 if (prop_enum->value == value) {
3204 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3205 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3211 prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
3215 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3216 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3217 prop_enum->value = value;
3219 property->values[index] = value;
3220 list_add_tail(&prop_enum->head, &property->enum_blob_list);
3223 EXPORT_SYMBOL(drm_property_add_enum);
3226 * drm_property_destroy - destroy a drm property
3228 * @property: property to destry
3230 * This function frees a property including any attached resources like
3231 * enumeration values.
3233 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
3235 struct drm_property_enum *prop_enum, *pt;
3237 list_for_each_entry_safe(prop_enum, pt, &property->enum_blob_list, head) {
3238 list_del(&prop_enum->head);
3242 if (property->num_values)
3243 kfree(property->values);
3244 drm_mode_object_put(dev, &property->base);
3245 list_del(&property->head);
3248 EXPORT_SYMBOL(drm_property_destroy);
3251 * drm_object_attach_property - attach a property to a modeset object
3252 * @obj: drm modeset object
3253 * @property: property to attach
3254 * @init_val: initial value of the property
3256 * This attaches the given property to the modeset object with the given initial
3257 * value. Currently this function cannot fail since the properties are stored in
3258 * a statically sized array.
3260 void drm_object_attach_property(struct drm_mode_object *obj,
3261 struct drm_property *property,
3264 int count = obj->properties->count;
3266 if (count == DRM_OBJECT_MAX_PROPERTY) {
3267 WARN(1, "Failed to attach object property (type: 0x%x). Please "
3268 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
3269 "you see this message on the same object type.\n",
3274 obj->properties->ids[count] = property->base.id;
3275 obj->properties->values[count] = init_val;
3276 obj->properties->count++;
3278 EXPORT_SYMBOL(drm_object_attach_property);
3281 * drm_object_property_set_value - set the value of a property
3282 * @obj: drm mode object to set property value for
3283 * @property: property to set
3284 * @val: value the property should be set to
3286 * This functions sets a given property on a given object. This function only
3287 * changes the software state of the property, it does not call into the
3288 * driver's ->set_property callback.
3291 * Zero on success, error code on failure.
3293 int drm_object_property_set_value(struct drm_mode_object *obj,
3294 struct drm_property *property, uint64_t val)
3298 for (i = 0; i < obj->properties->count; i++) {
3299 if (obj->properties->ids[i] == property->base.id) {
3300 obj->properties->values[i] = val;
3307 EXPORT_SYMBOL(drm_object_property_set_value);
3310 * drm_object_property_get_value - retrieve the value of a property
3311 * @obj: drm mode object to get property value from
3312 * @property: property to retrieve
3313 * @val: storage for the property value
3315 * This function retrieves the softare state of the given property for the given
3316 * property. Since there is no driver callback to retrieve the current property
3317 * value this might be out of sync with the hardware, depending upon the driver
3321 * Zero on success, error code on failure.
3323 int drm_object_property_get_value(struct drm_mode_object *obj,
3324 struct drm_property *property, uint64_t *val)
3328 for (i = 0; i < obj->properties->count; i++) {
3329 if (obj->properties->ids[i] == property->base.id) {
3330 *val = obj->properties->values[i];
3337 EXPORT_SYMBOL(drm_object_property_get_value);
3340 * drm_mode_getproperty_ioctl - get the current value of a connector's property
3343 * @file_priv: DRM file info
3345 * This function retrieves the current value for an connectors's property.
3347 * Called by the user via ioctl.
3350 * Zero on success, errno on failure.
3352 int drm_mode_getproperty_ioctl(struct drm_device *dev,
3353 void *data, struct drm_file *file_priv)
3355 struct drm_mode_object *obj;
3356 struct drm_mode_get_property *out_resp = data;
3357 struct drm_property *property;
3360 int value_count = 0;
3363 struct drm_property_enum *prop_enum;
3364 struct drm_mode_property_enum __user *enum_ptr;
3365 struct drm_property_blob *prop_blob;
3366 uint32_t __user *blob_id_ptr;
3367 uint64_t __user *values_ptr;
3368 uint32_t __user *blob_length_ptr;
3370 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3373 drm_modeset_lock_all(dev);
3374 obj = drm_mode_object_find(dev, out_resp->prop_id, DRM_MODE_OBJECT_PROPERTY);
3379 property = obj_to_property(obj);
3381 if (property->flags & (DRM_MODE_PROP_ENUM | DRM_MODE_PROP_BITMASK)) {
3382 list_for_each_entry(prop_enum, &property->enum_blob_list, head)
3384 } else if (property->flags & DRM_MODE_PROP_BLOB) {
3385 list_for_each_entry(prop_blob, &property->enum_blob_list, head)
3389 value_count = property->num_values;
3391 strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
3392 out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
3393 out_resp->flags = property->flags;
3395 if ((out_resp->count_values >= value_count) && value_count) {
3396 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
3397 for (i = 0; i < value_count; i++) {
3398 if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
3404 out_resp->count_values = value_count;
3406 if (property->flags & (DRM_MODE_PROP_ENUM | DRM_MODE_PROP_BITMASK)) {
3407 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
3409 enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
3410 list_for_each_entry(prop_enum, &property->enum_blob_list, head) {
3412 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
3417 if (copy_to_user(&enum_ptr[copied].name,
3418 &prop_enum->name, DRM_PROP_NAME_LEN)) {
3425 out_resp->count_enum_blobs = enum_count;
3428 if (property->flags & DRM_MODE_PROP_BLOB) {
3429 if ((out_resp->count_enum_blobs >= blob_count) && blob_count) {
3431 blob_id_ptr = (uint32_t __user *)(unsigned long)out_resp->enum_blob_ptr;
3432 blob_length_ptr = (uint32_t __user *)(unsigned long)out_resp->values_ptr;
3434 list_for_each_entry(prop_blob, &property->enum_blob_list, head) {
3435 if (put_user(prop_blob->base.id, blob_id_ptr + copied)) {
3440 if (put_user(prop_blob->length, blob_length_ptr + copied)) {
3448 out_resp->count_enum_blobs = blob_count;
3451 drm_modeset_unlock_all(dev);
3455 static struct drm_property_blob *drm_property_create_blob(struct drm_device *dev, int length,
3458 struct drm_property_blob *blob;
3461 if (!length || !data)
3464 blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
3468 ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
3474 blob->length = length;
3476 memcpy(blob->data, data, length);
3478 list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
3482 static void drm_property_destroy_blob(struct drm_device *dev,
3483 struct drm_property_blob *blob)
3485 drm_mode_object_put(dev, &blob->base);
3486 list_del(&blob->head);
3491 * drm_mode_getblob_ioctl - get the contents of a blob property value
3494 * @file_priv: DRM file info
3496 * This function retrieves the contents of a blob property. The value stored in
3497 * an object's blob property is just a normal modeset object id.
3499 * Called by the user via ioctl.
3502 * Zero on success, errno on failure.
3504 int drm_mode_getblob_ioctl(struct drm_device *dev,
3505 void *data, struct drm_file *file_priv)
3507 struct drm_mode_object *obj;
3508 struct drm_mode_get_blob *out_resp = data;
3509 struct drm_property_blob *blob;
3511 void __user *blob_ptr;
3513 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3516 drm_modeset_lock_all(dev);
3517 obj = drm_mode_object_find(dev, out_resp->blob_id, DRM_MODE_OBJECT_BLOB);
3522 blob = obj_to_blob(obj);
3524 if (out_resp->length == blob->length) {
3525 blob_ptr = (void __user *)(unsigned long)out_resp->data;
3526 if (copy_to_user(blob_ptr, blob->data, blob->length)){
3531 out_resp->length = blob->length;
3534 drm_modeset_unlock_all(dev);
3539 * drm_mode_connector_update_edid_property - update the edid property of a connector
3540 * @connector: drm connector
3541 * @edid: new value of the edid property
3543 * This function creates a new blob modeset object and assigns its id to the
3544 * connector's edid property.
3547 * Zero on success, errno on failure.
3549 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
3552 struct drm_device *dev = connector->dev;
3555 if (connector->edid_blob_ptr)
3556 drm_property_destroy_blob(dev, connector->edid_blob_ptr);
3558 /* Delete edid, when there is none. */
3560 connector->edid_blob_ptr = NULL;
3561 ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
3565 size = EDID_LENGTH * (1 + edid->extensions);
3566 connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
3568 if (!connector->edid_blob_ptr)
3571 ret = drm_object_property_set_value(&connector->base,
3572 dev->mode_config.edid_property,
3573 connector->edid_blob_ptr->base.id);
3577 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
3579 static bool drm_property_change_is_valid(struct drm_property *property,
3582 if (property->flags & DRM_MODE_PROP_IMMUTABLE)
3584 if (property->flags & DRM_MODE_PROP_RANGE) {
3585 if (value < property->values[0] || value > property->values[1])
3588 } else if (property->flags & DRM_MODE_PROP_BITMASK) {
3590 uint64_t valid_mask = 0;
3591 for (i = 0; i < property->num_values; i++)
3592 valid_mask |= (1ULL << property->values[i]);
3593 return !(value & ~valid_mask);
3594 } else if (property->flags & DRM_MODE_PROP_BLOB) {
3595 /* Only the driver knows */
3599 for (i = 0; i < property->num_values; i++)
3600 if (property->values[i] == value)
3607 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
3610 * @file_priv: DRM file info
3612 * This function sets the current value for a connectors's property. It also
3613 * calls into a driver's ->set_property callback to update the hardware state
3615 * Called by the user via ioctl.
3618 * Zero on success, errno on failure.
3620 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
3621 void *data, struct drm_file *file_priv)
3623 struct drm_mode_connector_set_property *conn_set_prop = data;
3624 struct drm_mode_obj_set_property obj_set_prop = {
3625 .value = conn_set_prop->value,
3626 .prop_id = conn_set_prop->prop_id,
3627 .obj_id = conn_set_prop->connector_id,
3628 .obj_type = DRM_MODE_OBJECT_CONNECTOR
3631 /* It does all the locking and checking we need */
3632 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
3635 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
3636 struct drm_property *property,
3640 struct drm_connector *connector = obj_to_connector(obj);
3642 /* Do DPMS ourselves */
3643 if (property == connector->dev->mode_config.dpms_property) {
3644 if (connector->funcs->dpms)
3645 (*connector->funcs->dpms)(connector, (int)value);
3647 } else if (connector->funcs->set_property)
3648 ret = connector->funcs->set_property(connector, property, value);
3650 /* store the property value if successful */
3652 drm_object_property_set_value(&connector->base, property, value);
3656 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
3657 struct drm_property *property,
3661 struct drm_crtc *crtc = obj_to_crtc(obj);
3663 if (crtc->funcs->set_property)
3664 ret = crtc->funcs->set_property(crtc, property, value);
3666 drm_object_property_set_value(obj, property, value);
3671 static int drm_mode_plane_set_obj_prop(struct drm_mode_object *obj,
3672 struct drm_property *property,
3676 struct drm_plane *plane = obj_to_plane(obj);
3678 if (plane->funcs->set_property)
3679 ret = plane->funcs->set_property(plane, property, value);
3681 drm_object_property_set_value(obj, property, value);
3687 * drm_mode_getproperty_ioctl - get the current value of a object's property
3690 * @file_priv: DRM file info
3692 * This function retrieves the current value for an object's property. Compared
3693 * to the connector specific ioctl this one is extended to also work on crtc and
3696 * Called by the user via ioctl.
3699 * Zero on success, errno on failure.
3701 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
3702 struct drm_file *file_priv)
3704 struct drm_mode_obj_get_properties *arg = data;
3705 struct drm_mode_object *obj;
3709 int props_count = 0;
3710 uint32_t __user *props_ptr;
3711 uint64_t __user *prop_values_ptr;
3713 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3716 drm_modeset_lock_all(dev);
3718 obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
3723 if (!obj->properties) {
3728 props_count = obj->properties->count;
3730 /* This ioctl is called twice, once to determine how much space is
3731 * needed, and the 2nd time to fill it. */
3732 if ((arg->count_props >= props_count) && props_count) {
3734 props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
3735 prop_values_ptr = (uint64_t __user *)(unsigned long)
3736 (arg->prop_values_ptr);
3737 for (i = 0; i < props_count; i++) {
3738 if (put_user(obj->properties->ids[i],
3739 props_ptr + copied)) {
3743 if (put_user(obj->properties->values[i],
3744 prop_values_ptr + copied)) {
3751 arg->count_props = props_count;
3753 drm_modeset_unlock_all(dev);
3758 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
3761 * @file_priv: DRM file info
3763 * This function sets the current value for an object's property. It also calls
3764 * into a driver's ->set_property callback to update the hardware state.
3765 * Compared to the connector specific ioctl this one is extended to also work on
3766 * crtc and plane objects.
3768 * Called by the user via ioctl.
3771 * Zero on success, errno on failure.
3773 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
3774 struct drm_file *file_priv)
3776 struct drm_mode_obj_set_property *arg = data;
3777 struct drm_mode_object *arg_obj;
3778 struct drm_mode_object *prop_obj;
3779 struct drm_property *property;
3783 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3786 drm_modeset_lock_all(dev);
3788 arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
3793 if (!arg_obj->properties)
3796 for (i = 0; i < arg_obj->properties->count; i++)
3797 if (arg_obj->properties->ids[i] == arg->prop_id)
3800 if (i == arg_obj->properties->count)
3803 prop_obj = drm_mode_object_find(dev, arg->prop_id,
3804 DRM_MODE_OBJECT_PROPERTY);
3809 property = obj_to_property(prop_obj);
3811 if (!drm_property_change_is_valid(property, arg->value))
3814 switch (arg_obj->type) {
3815 case DRM_MODE_OBJECT_CONNECTOR:
3816 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
3819 case DRM_MODE_OBJECT_CRTC:
3820 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
3822 case DRM_MODE_OBJECT_PLANE:
3823 ret = drm_mode_plane_set_obj_prop(arg_obj, property, arg->value);
3828 drm_modeset_unlock_all(dev);
3833 * drm_mode_connector_attach_encoder - attach a connector to an encoder
3834 * @connector: connector to attach
3835 * @encoder: encoder to attach @connector to
3837 * This function links up a connector to an encoder. Note that the routing
3838 * restrictions between encoders and crtcs are exposed to userspace through the
3839 * possible_clones and possible_crtcs bitmasks.
3842 * Zero on success, errno on failure.
3844 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
3845 struct drm_encoder *encoder)
3849 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
3850 if (connector->encoder_ids[i] == 0) {
3851 connector->encoder_ids[i] = encoder->base.id;
3857 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
3860 * drm_mode_crtc_set_gamma_size - set the gamma table size
3861 * @crtc: CRTC to set the gamma table size for
3862 * @gamma_size: size of the gamma table
3864 * Drivers which support gamma tables should set this to the supported gamma
3865 * table size when initializing the CRTC. Currently the drm core only supports a
3866 * fixed gamma table size.
3869 * Zero on success, errno on failure.
3871 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
3874 crtc->gamma_size = gamma_size;
3876 crtc->gamma_store = kzalloc(gamma_size * sizeof(uint16_t) * 3, GFP_KERNEL);
3877 if (!crtc->gamma_store) {
3878 crtc->gamma_size = 0;
3884 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
3887 * drm_mode_gamma_set_ioctl - set the gamma table
3890 * @file_priv: DRM file info
3892 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
3893 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
3895 * Called by the user via ioctl.
3898 * Zero on success, errno on failure.
3900 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
3901 void *data, struct drm_file *file_priv)
3903 struct drm_mode_crtc_lut *crtc_lut = data;
3904 struct drm_mode_object *obj;
3905 struct drm_crtc *crtc;
3906 void *r_base, *g_base, *b_base;
3910 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3913 drm_modeset_lock_all(dev);
3914 obj = drm_mode_object_find(dev, crtc_lut->crtc_id, DRM_MODE_OBJECT_CRTC);
3919 crtc = obj_to_crtc(obj);
3921 if (crtc->funcs->gamma_set == NULL) {
3926 /* memcpy into gamma store */
3927 if (crtc_lut->gamma_size != crtc->gamma_size) {
3932 size = crtc_lut->gamma_size * (sizeof(uint16_t));
3933 r_base = crtc->gamma_store;
3934 if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
3939 g_base = r_base + size;
3940 if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
3945 b_base = g_base + size;
3946 if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
3951 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
3954 drm_modeset_unlock_all(dev);
3960 * drm_mode_gamma_get_ioctl - get the gamma table
3963 * @file_priv: DRM file info
3965 * Copy the current gamma table into the storage provided. This also provides
3966 * the gamma table size the driver expects, which can be used to size the
3967 * allocated storage.
3969 * Called by the user via ioctl.
3972 * Zero on success, errno on failure.
3974 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
3975 void *data, struct drm_file *file_priv)
3977 struct drm_mode_crtc_lut *crtc_lut = data;
3978 struct drm_mode_object *obj;
3979 struct drm_crtc *crtc;
3980 void *r_base, *g_base, *b_base;
3984 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3987 drm_modeset_lock_all(dev);
3988 obj = drm_mode_object_find(dev, crtc_lut->crtc_id, DRM_MODE_OBJECT_CRTC);
3993 crtc = obj_to_crtc(obj);
3995 /* memcpy into gamma store */
3996 if (crtc_lut->gamma_size != crtc->gamma_size) {
4001 size = crtc_lut->gamma_size * (sizeof(uint16_t));
4002 r_base = crtc->gamma_store;
4003 if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
4008 g_base = r_base + size;
4009 if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
4014 b_base = g_base + size;
4015 if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
4020 drm_modeset_unlock_all(dev);
4025 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4028 * @file_priv: DRM file info
4030 * This schedules an asynchronous update on a given CRTC, called page flip.
4031 * Optionally a drm event is generated to signal the completion of the event.
4032 * Generic drivers cannot assume that a pageflip with changed framebuffer
4033 * properties (including driver specific metadata like tiling layout) will work,
4034 * but some drivers support e.g. pixel format changes through the pageflip
4037 * Called by the user via ioctl.
4040 * Zero on success, errno on failure.
4042 int drm_mode_page_flip_ioctl(struct drm_device *dev,
4043 void *data, struct drm_file *file_priv)
4045 struct drm_mode_crtc_page_flip *page_flip = data;
4046 struct drm_mode_object *obj;
4047 struct drm_crtc *crtc;
4048 struct drm_framebuffer *fb = NULL, *old_fb = NULL;
4049 struct drm_pending_vblank_event *e = NULL;
4050 unsigned long flags;
4053 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
4054 page_flip->reserved != 0)
4057 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
4060 obj = drm_mode_object_find(dev, page_flip->crtc_id, DRM_MODE_OBJECT_CRTC);
4063 crtc = obj_to_crtc(obj);
4065 mutex_lock(&crtc->mutex);
4066 if (crtc->fb == NULL) {
4067 /* The framebuffer is currently unbound, presumably
4068 * due to a hotplug event, that userspace has not
4075 if (crtc->funcs->page_flip == NULL)
4078 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
4084 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
4088 if (crtc->fb->pixel_format != fb->pixel_format) {
4089 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4094 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4096 spin_lock_irqsave(&dev->event_lock, flags);
4097 if (file_priv->event_space < sizeof e->event) {
4098 spin_unlock_irqrestore(&dev->event_lock, flags);
4101 file_priv->event_space -= sizeof e->event;
4102 spin_unlock_irqrestore(&dev->event_lock, flags);
4104 e = kzalloc(sizeof *e, GFP_KERNEL);
4106 spin_lock_irqsave(&dev->event_lock, flags);
4107 file_priv->event_space += sizeof e->event;
4108 spin_unlock_irqrestore(&dev->event_lock, flags);
4112 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
4113 e->event.base.length = sizeof e->event;
4114 e->event.user_data = page_flip->user_data;
4115 e->base.event = &e->event.base;
4116 e->base.file_priv = file_priv;
4118 (void (*) (struct drm_pending_event *)) kfree;
4122 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
4124 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4125 spin_lock_irqsave(&dev->event_lock, flags);
4126 file_priv->event_space += sizeof e->event;
4127 spin_unlock_irqrestore(&dev->event_lock, flags);
4130 /* Keep the old fb, don't unref it. */
4134 * Warn if the driver hasn't properly updated the crtc->fb
4135 * field to reflect that the new framebuffer is now used.
4136 * Failing to do so will screw with the reference counting
4139 WARN_ON(crtc->fb != fb);
4140 /* Unref only the old framebuffer. */
4146 drm_framebuffer_unreference(fb);
4148 drm_framebuffer_unreference(old_fb);
4149 mutex_unlock(&crtc->mutex);
4155 * drm_mode_config_reset - call ->reset callbacks
4158 * This functions calls all the crtc's, encoder's and connector's ->reset
4159 * callback. Drivers can use this in e.g. their driver load or resume code to
4160 * reset hardware and software state.
4162 void drm_mode_config_reset(struct drm_device *dev)
4164 struct drm_crtc *crtc;
4165 struct drm_encoder *encoder;
4166 struct drm_connector *connector;
4168 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
4169 if (crtc->funcs->reset)
4170 crtc->funcs->reset(crtc);
4172 list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
4173 if (encoder->funcs->reset)
4174 encoder->funcs->reset(encoder);
4176 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
4177 connector->status = connector_status_unknown;
4179 if (connector->funcs->reset)
4180 connector->funcs->reset(connector);
4183 EXPORT_SYMBOL(drm_mode_config_reset);
4186 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
4189 * @file_priv: DRM file info
4191 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
4192 * TTM or something else entirely) and returns the resulting buffer handle. This
4193 * handle can then be wrapped up into a framebuffer modeset object.
4195 * Note that userspace is not allowed to use such objects for render
4196 * acceleration - drivers must create their own private ioctls for such a use
4199 * Called by the user via ioctl.
4202 * Zero on success, errno on failure.
4204 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
4205 void *data, struct drm_file *file_priv)
4207 struct drm_mode_create_dumb *args = data;
4208 u32 cpp, stride, size;
4210 if (!dev->driver->dumb_create)
4212 if (!args->width || !args->height || !args->bpp)
4215 /* overflow checks for 32bit size calculations */
4216 cpp = DIV_ROUND_UP(args->bpp, 8);
4217 if (cpp > 0xffffffffU / args->width)
4219 stride = cpp * args->width;
4220 if (args->height > 0xffffffffU / stride)
4223 /* test for wrap-around */
4224 size = args->height * stride;
4225 if (PAGE_ALIGN(size) == 0)
4228 return dev->driver->dumb_create(file_priv, dev, args);
4232 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
4235 * @file_priv: DRM file info
4237 * Allocate an offset in the drm device node's address space to be able to
4238 * memory map a dumb buffer.
4240 * Called by the user via ioctl.
4243 * Zero on success, errno on failure.
4245 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
4246 void *data, struct drm_file *file_priv)
4248 struct drm_mode_map_dumb *args = data;
4250 /* call driver ioctl to get mmap offset */
4251 if (!dev->driver->dumb_map_offset)
4254 return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
4258 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
4261 * @file_priv: DRM file info
4263 * This destroys the userspace handle for the given dumb backing storage buffer.
4264 * Since buffer objects must be reference counted in the kernel a buffer object
4265 * won't be immediately freed if a framebuffer modeset object still uses it.
4267 * Called by the user via ioctl.
4270 * Zero on success, errno on failure.
4272 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
4273 void *data, struct drm_file *file_priv)
4275 struct drm_mode_destroy_dumb *args = data;
4277 if (!dev->driver->dumb_destroy)
4280 return dev->driver->dumb_destroy(file_priv, dev, args->handle);
4284 * drm_fb_get_bpp_depth - get the bpp/depth values for format
4285 * @format: pixel format (DRM_FORMAT_*)
4286 * @depth: storage for the depth value
4287 * @bpp: storage for the bpp value
4289 * This only supports RGB formats here for compat with code that doesn't use
4290 * pixel formats directly yet.
4292 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
4297 case DRM_FORMAT_RGB332:
4298 case DRM_FORMAT_BGR233:
4302 case DRM_FORMAT_XRGB1555:
4303 case DRM_FORMAT_XBGR1555:
4304 case DRM_FORMAT_RGBX5551:
4305 case DRM_FORMAT_BGRX5551:
4306 case DRM_FORMAT_ARGB1555:
4307 case DRM_FORMAT_ABGR1555:
4308 case DRM_FORMAT_RGBA5551:
4309 case DRM_FORMAT_BGRA5551:
4313 case DRM_FORMAT_RGB565:
4314 case DRM_FORMAT_BGR565:
4318 case DRM_FORMAT_RGB888:
4319 case DRM_FORMAT_BGR888:
4323 case DRM_FORMAT_XRGB8888:
4324 case DRM_FORMAT_XBGR8888:
4325 case DRM_FORMAT_RGBX8888:
4326 case DRM_FORMAT_BGRX8888:
4330 case DRM_FORMAT_XRGB2101010:
4331 case DRM_FORMAT_XBGR2101010:
4332 case DRM_FORMAT_RGBX1010102:
4333 case DRM_FORMAT_BGRX1010102:
4334 case DRM_FORMAT_ARGB2101010:
4335 case DRM_FORMAT_ABGR2101010:
4336 case DRM_FORMAT_RGBA1010102:
4337 case DRM_FORMAT_BGRA1010102:
4341 case DRM_FORMAT_ARGB8888:
4342 case DRM_FORMAT_ABGR8888:
4343 case DRM_FORMAT_RGBA8888:
4344 case DRM_FORMAT_BGRA8888:
4349 DRM_DEBUG_KMS("unsupported pixel format %s\n",
4350 drm_get_format_name(format));
4356 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
4359 * drm_format_num_planes - get the number of planes for format
4360 * @format: pixel format (DRM_FORMAT_*)
4363 * The number of planes used by the specified pixel format.
4365 int drm_format_num_planes(uint32_t format)
4368 case DRM_FORMAT_YUV410:
4369 case DRM_FORMAT_YVU410:
4370 case DRM_FORMAT_YUV411:
4371 case DRM_FORMAT_YVU411:
4372 case DRM_FORMAT_YUV420:
4373 case DRM_FORMAT_YVU420:
4374 case DRM_FORMAT_YUV422:
4375 case DRM_FORMAT_YVU422:
4376 case DRM_FORMAT_YUV444:
4377 case DRM_FORMAT_YVU444:
4379 case DRM_FORMAT_NV12:
4380 case DRM_FORMAT_NV21:
4381 case DRM_FORMAT_NV16:
4382 case DRM_FORMAT_NV61:
4383 case DRM_FORMAT_NV24:
4384 case DRM_FORMAT_NV42:
4390 EXPORT_SYMBOL(drm_format_num_planes);
4393 * drm_format_plane_cpp - determine the bytes per pixel value
4394 * @format: pixel format (DRM_FORMAT_*)
4395 * @plane: plane index
4398 * The bytes per pixel value for the specified plane.
4400 int drm_format_plane_cpp(uint32_t format, int plane)
4405 if (plane >= drm_format_num_planes(format))
4409 case DRM_FORMAT_YUYV:
4410 case DRM_FORMAT_YVYU:
4411 case DRM_FORMAT_UYVY:
4412 case DRM_FORMAT_VYUY:
4414 case DRM_FORMAT_NV12:
4415 case DRM_FORMAT_NV21:
4416 case DRM_FORMAT_NV16:
4417 case DRM_FORMAT_NV61:
4418 case DRM_FORMAT_NV24:
4419 case DRM_FORMAT_NV42:
4420 return plane ? 2 : 1;
4421 case DRM_FORMAT_YUV410:
4422 case DRM_FORMAT_YVU410:
4423 case DRM_FORMAT_YUV411:
4424 case DRM_FORMAT_YVU411:
4425 case DRM_FORMAT_YUV420:
4426 case DRM_FORMAT_YVU420:
4427 case DRM_FORMAT_YUV422:
4428 case DRM_FORMAT_YVU422:
4429 case DRM_FORMAT_YUV444:
4430 case DRM_FORMAT_YVU444:
4433 drm_fb_get_bpp_depth(format, &depth, &bpp);
4437 EXPORT_SYMBOL(drm_format_plane_cpp);
4440 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
4441 * @format: pixel format (DRM_FORMAT_*)
4444 * The horizontal chroma subsampling factor for the
4445 * specified pixel format.
4447 int drm_format_horz_chroma_subsampling(uint32_t format)
4450 case DRM_FORMAT_YUV411:
4451 case DRM_FORMAT_YVU411:
4452 case DRM_FORMAT_YUV410:
4453 case DRM_FORMAT_YVU410:
4455 case DRM_FORMAT_YUYV:
4456 case DRM_FORMAT_YVYU:
4457 case DRM_FORMAT_UYVY:
4458 case DRM_FORMAT_VYUY:
4459 case DRM_FORMAT_NV12:
4460 case DRM_FORMAT_NV21:
4461 case DRM_FORMAT_NV16:
4462 case DRM_FORMAT_NV61:
4463 case DRM_FORMAT_YUV422:
4464 case DRM_FORMAT_YVU422:
4465 case DRM_FORMAT_YUV420:
4466 case DRM_FORMAT_YVU420:
4472 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
4475 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
4476 * @format: pixel format (DRM_FORMAT_*)
4479 * The vertical chroma subsampling factor for the
4480 * specified pixel format.
4482 int drm_format_vert_chroma_subsampling(uint32_t format)
4485 case DRM_FORMAT_YUV410:
4486 case DRM_FORMAT_YVU410:
4488 case DRM_FORMAT_YUV420:
4489 case DRM_FORMAT_YVU420:
4490 case DRM_FORMAT_NV12:
4491 case DRM_FORMAT_NV21:
4497 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
4500 * drm_mode_config_init - initialize DRM mode_configuration structure
4503 * Initialize @dev's mode_config structure, used for tracking the graphics
4504 * configuration of @dev.
4506 * Since this initializes the modeset locks, no locking is possible. Which is no
4507 * problem, since this should happen single threaded at init time. It is the
4508 * driver's problem to ensure this guarantee.
4511 void drm_mode_config_init(struct drm_device *dev)
4513 mutex_init(&dev->mode_config.mutex);
4514 mutex_init(&dev->mode_config.idr_mutex);
4515 mutex_init(&dev->mode_config.fb_lock);
4516 INIT_LIST_HEAD(&dev->mode_config.fb_list);
4517 INIT_LIST_HEAD(&dev->mode_config.crtc_list);
4518 INIT_LIST_HEAD(&dev->mode_config.connector_list);
4519 INIT_LIST_HEAD(&dev->mode_config.bridge_list);
4520 INIT_LIST_HEAD(&dev->mode_config.encoder_list);
4521 INIT_LIST_HEAD(&dev->mode_config.property_list);
4522 INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
4523 INIT_LIST_HEAD(&dev->mode_config.plane_list);
4524 idr_init(&dev->mode_config.crtc_idr);
4526 drm_modeset_lock_all(dev);
4527 drm_mode_create_standard_connector_properties(dev);
4528 drm_modeset_unlock_all(dev);
4530 /* Just to be sure */
4531 dev->mode_config.num_fb = 0;
4532 dev->mode_config.num_connector = 0;
4533 dev->mode_config.num_crtc = 0;
4534 dev->mode_config.num_encoder = 0;
4536 EXPORT_SYMBOL(drm_mode_config_init);
4539 * drm_mode_config_cleanup - free up DRM mode_config info
4542 * Free up all the connectors and CRTCs associated with this DRM device, then
4543 * free up the framebuffers and associated buffer objects.
4545 * Note that since this /should/ happen single-threaded at driver/device
4546 * teardown time, no locking is required. It's the driver's job to ensure that
4547 * this guarantee actually holds true.
4549 * FIXME: cleanup any dangling user buffer objects too
4551 void drm_mode_config_cleanup(struct drm_device *dev)
4553 struct drm_connector *connector, *ot;
4554 struct drm_crtc *crtc, *ct;
4555 struct drm_encoder *encoder, *enct;
4556 struct drm_bridge *bridge, *brt;
4557 struct drm_framebuffer *fb, *fbt;
4558 struct drm_property *property, *pt;
4559 struct drm_property_blob *blob, *bt;
4560 struct drm_plane *plane, *plt;
4562 list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
4564 encoder->funcs->destroy(encoder);
4567 list_for_each_entry_safe(bridge, brt,
4568 &dev->mode_config.bridge_list, head) {
4569 bridge->funcs->destroy(bridge);
4572 list_for_each_entry_safe(connector, ot,
4573 &dev->mode_config.connector_list, head) {
4574 connector->funcs->destroy(connector);
4577 list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
4579 drm_property_destroy(dev, property);
4582 list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
4584 drm_property_destroy_blob(dev, blob);
4588 * Single-threaded teardown context, so it's not required to grab the
4589 * fb_lock to protect against concurrent fb_list access. Contrary, it
4590 * would actually deadlock with the drm_framebuffer_cleanup function.
4592 * Also, if there are any framebuffers left, that's a driver leak now,
4593 * so politely WARN about this.
4595 WARN_ON(!list_empty(&dev->mode_config.fb_list));
4596 list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
4597 drm_framebuffer_remove(fb);
4600 list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
4602 plane->funcs->destroy(plane);
4605 list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
4606 crtc->funcs->destroy(crtc);
4609 idr_destroy(&dev->mode_config.crtc_idr);
4611 EXPORT_SYMBOL(drm_mode_config_cleanup);