2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
4 * Copyright (c) 2008 Red Hat Inc.
6 * DRM core CRTC related functions
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
28 * Eric Anholt <eric@anholt.net>
29 * Dave Airlie <airlied@linux.ie>
30 * Jesse Barnes <jesse.barnes@intel.com>
32 #include <linux/ctype.h>
33 #include <linux/list.h>
34 #include <linux/slab.h>
35 #include <linux/export.h>
37 #include <drm/drm_crtc.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_fourcc.h>
40 #include <drm/drm_modeset_lock.h>
42 #include "drm_crtc_internal.h"
43 #include "drm_internal.h"
45 static struct drm_framebuffer
*add_framebuffer_internal(struct drm_device
*dev
,
46 struct drm_mode_fb_cmd2
*r
,
47 struct drm_file
*file_priv
);
49 /* Avoid boilerplate. I'm tired of typing. */
50 #define DRM_ENUM_NAME_FN(fnname, list) \
51 const char *fnname(int val) \
54 for (i = 0; i < ARRAY_SIZE(list); i++) { \
55 if (list[i].type == val) \
56 return list[i].name; \
64 static const struct drm_prop_enum_list drm_dpms_enum_list
[] = {
65 { DRM_MODE_DPMS_ON
, "On" },
66 { DRM_MODE_DPMS_STANDBY
, "Standby" },
67 { DRM_MODE_DPMS_SUSPEND
, "Suspend" },
68 { DRM_MODE_DPMS_OFF
, "Off" }
71 DRM_ENUM_NAME_FN(drm_get_dpms_name
, drm_dpms_enum_list
)
73 static const struct drm_prop_enum_list drm_plane_type_enum_list
[] = {
74 { DRM_PLANE_TYPE_OVERLAY
, "Overlay" },
75 { DRM_PLANE_TYPE_PRIMARY
, "Primary" },
76 { DRM_PLANE_TYPE_CURSOR
, "Cursor" },
82 static const struct drm_prop_enum_list drm_scaling_mode_enum_list
[] = {
83 { DRM_MODE_SCALE_NONE
, "None" },
84 { DRM_MODE_SCALE_FULLSCREEN
, "Full" },
85 { DRM_MODE_SCALE_CENTER
, "Center" },
86 { DRM_MODE_SCALE_ASPECT
, "Full aspect" },
89 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list
[] = {
90 { DRM_MODE_PICTURE_ASPECT_NONE
, "Automatic" },
91 { DRM_MODE_PICTURE_ASPECT_4_3
, "4:3" },
92 { DRM_MODE_PICTURE_ASPECT_16_9
, "16:9" },
96 * Non-global properties, but "required" for certain connectors.
98 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list
[] = {
99 { DRM_MODE_SUBCONNECTOR_Automatic
, "Automatic" }, /* DVI-I and TV-out */
100 { DRM_MODE_SUBCONNECTOR_DVID
, "DVI-D" }, /* DVI-I */
101 { DRM_MODE_SUBCONNECTOR_DVIA
, "DVI-A" }, /* DVI-I */
104 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name
, drm_dvi_i_select_enum_list
)
106 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list
[] = {
107 { DRM_MODE_SUBCONNECTOR_Unknown
, "Unknown" }, /* DVI-I and TV-out */
108 { DRM_MODE_SUBCONNECTOR_DVID
, "DVI-D" }, /* DVI-I */
109 { DRM_MODE_SUBCONNECTOR_DVIA
, "DVI-A" }, /* DVI-I */
112 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name
,
113 drm_dvi_i_subconnector_enum_list
)
115 static const struct drm_prop_enum_list drm_tv_select_enum_list
[] = {
116 { DRM_MODE_SUBCONNECTOR_Automatic
, "Automatic" }, /* DVI-I and TV-out */
117 { DRM_MODE_SUBCONNECTOR_Composite
, "Composite" }, /* TV-out */
118 { DRM_MODE_SUBCONNECTOR_SVIDEO
, "SVIDEO" }, /* TV-out */
119 { DRM_MODE_SUBCONNECTOR_Component
, "Component" }, /* TV-out */
120 { DRM_MODE_SUBCONNECTOR_SCART
, "SCART" }, /* TV-out */
123 DRM_ENUM_NAME_FN(drm_get_tv_select_name
, drm_tv_select_enum_list
)
125 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list
[] = {
126 { DRM_MODE_SUBCONNECTOR_Unknown
, "Unknown" }, /* DVI-I and TV-out */
127 { DRM_MODE_SUBCONNECTOR_Composite
, "Composite" }, /* TV-out */
128 { DRM_MODE_SUBCONNECTOR_SVIDEO
, "SVIDEO" }, /* TV-out */
129 { DRM_MODE_SUBCONNECTOR_Component
, "Component" }, /* TV-out */
130 { DRM_MODE_SUBCONNECTOR_SCART
, "SCART" }, /* TV-out */
133 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name
,
134 drm_tv_subconnector_enum_list
)
136 static const struct drm_prop_enum_list drm_dirty_info_enum_list
[] = {
137 { DRM_MODE_DIRTY_OFF
, "Off" },
138 { DRM_MODE_DIRTY_ON
, "On" },
139 { DRM_MODE_DIRTY_ANNOTATE
, "Annotate" },
142 struct drm_conn_prop_enum_list
{
149 * Connector and encoder types.
151 static struct drm_conn_prop_enum_list drm_connector_enum_list
[] = {
152 { DRM_MODE_CONNECTOR_Unknown
, "Unknown" },
153 { DRM_MODE_CONNECTOR_VGA
, "VGA" },
154 { DRM_MODE_CONNECTOR_DVII
, "DVI-I" },
155 { DRM_MODE_CONNECTOR_DVID
, "DVI-D" },
156 { DRM_MODE_CONNECTOR_DVIA
, "DVI-A" },
157 { DRM_MODE_CONNECTOR_Composite
, "Composite" },
158 { DRM_MODE_CONNECTOR_SVIDEO
, "SVIDEO" },
159 { DRM_MODE_CONNECTOR_LVDS
, "LVDS" },
160 { DRM_MODE_CONNECTOR_Component
, "Component" },
161 { DRM_MODE_CONNECTOR_9PinDIN
, "DIN" },
162 { DRM_MODE_CONNECTOR_DisplayPort
, "DP" },
163 { DRM_MODE_CONNECTOR_HDMIA
, "HDMI-A" },
164 { DRM_MODE_CONNECTOR_HDMIB
, "HDMI-B" },
165 { DRM_MODE_CONNECTOR_TV
, "TV" },
166 { DRM_MODE_CONNECTOR_eDP
, "eDP" },
167 { DRM_MODE_CONNECTOR_VIRTUAL
, "Virtual" },
168 { DRM_MODE_CONNECTOR_DSI
, "DSI" },
171 static const struct drm_prop_enum_list drm_encoder_enum_list
[] = {
172 { DRM_MODE_ENCODER_NONE
, "None" },
173 { DRM_MODE_ENCODER_DAC
, "DAC" },
174 { DRM_MODE_ENCODER_TMDS
, "TMDS" },
175 { DRM_MODE_ENCODER_LVDS
, "LVDS" },
176 { DRM_MODE_ENCODER_TVDAC
, "TV" },
177 { DRM_MODE_ENCODER_VIRTUAL
, "Virtual" },
178 { DRM_MODE_ENCODER_DSI
, "DSI" },
179 { DRM_MODE_ENCODER_DPMST
, "DP MST" },
182 static const struct drm_prop_enum_list drm_subpixel_enum_list
[] = {
183 { SubPixelUnknown
, "Unknown" },
184 { SubPixelHorizontalRGB
, "Horizontal RGB" },
185 { SubPixelHorizontalBGR
, "Horizontal BGR" },
186 { SubPixelVerticalRGB
, "Vertical RGB" },
187 { SubPixelVerticalBGR
, "Vertical BGR" },
188 { SubPixelNone
, "None" },
191 void drm_connector_ida_init(void)
195 for (i
= 0; i
< ARRAY_SIZE(drm_connector_enum_list
); i
++)
196 ida_init(&drm_connector_enum_list
[i
].ida
);
199 void drm_connector_ida_destroy(void)
203 for (i
= 0; i
< ARRAY_SIZE(drm_connector_enum_list
); i
++)
204 ida_destroy(&drm_connector_enum_list
[i
].ida
);
208 * drm_get_connector_status_name - return a string for connector status
209 * @status: connector status to compute name of
211 * In contrast to the other drm_get_*_name functions this one here returns a
212 * const pointer and hence is threadsafe.
214 const char *drm_get_connector_status_name(enum drm_connector_status status
)
216 if (status
== connector_status_connected
)
218 else if (status
== connector_status_disconnected
)
219 return "disconnected";
223 EXPORT_SYMBOL(drm_get_connector_status_name
);
226 * drm_get_subpixel_order_name - return a string for a given subpixel enum
227 * @order: enum of subpixel_order
229 * Note you could abuse this and return something out of bounds, but that
230 * would be a caller error. No unscrubbed user data should make it here.
232 const char *drm_get_subpixel_order_name(enum subpixel_order order
)
234 return drm_subpixel_enum_list
[order
].name
;
236 EXPORT_SYMBOL(drm_get_subpixel_order_name
);
238 static char printable_char(int c
)
240 return isascii(c
) && isprint(c
) ? c
: '?';
244 * drm_get_format_name - return a string for drm fourcc format
245 * @format: format to compute name of
247 * Note that the buffer used by this function is globally shared and owned by
248 * the function itself.
250 * FIXME: This isn't really multithreading safe.
252 const char *drm_get_format_name(uint32_t format
)
256 snprintf(buf
, sizeof(buf
),
257 "%c%c%c%c %s-endian (0x%08x)",
258 printable_char(format
& 0xff),
259 printable_char((format
>> 8) & 0xff),
260 printable_char((format
>> 16) & 0xff),
261 printable_char((format
>> 24) & 0x7f),
262 format
& DRM_FORMAT_BIG_ENDIAN
? "big" : "little",
267 EXPORT_SYMBOL(drm_get_format_name
);
270 * Internal function to assign a slot in the object idr and optionally
271 * register the object into the idr.
273 static int drm_mode_object_get_reg(struct drm_device
*dev
,
274 struct drm_mode_object
*obj
,
280 mutex_lock(&dev
->mode_config
.idr_mutex
);
281 ret
= idr_alloc(&dev
->mode_config
.crtc_idr
, register_obj
? obj
: NULL
, 1, 0, GFP_KERNEL
);
284 * Set up the object linking under the protection of the idr
285 * lock so that other users can't see inconsistent state.
288 obj
->type
= obj_type
;
290 mutex_unlock(&dev
->mode_config
.idr_mutex
);
292 return ret
< 0 ? ret
: 0;
296 * drm_mode_object_get - allocate a new modeset identifier
298 * @obj: object pointer, used to generate unique ID
299 * @obj_type: object type
301 * Create a unique identifier based on @ptr in @dev's identifier space. Used
302 * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
303 * modeset identifiers are _not_ reference counted. Hence don't use this for
304 * reference counted modeset objects like framebuffers.
307 * New unique (relative to other objects in @dev) integer identifier for the
310 int drm_mode_object_get(struct drm_device
*dev
,
311 struct drm_mode_object
*obj
, uint32_t obj_type
)
313 return drm_mode_object_get_reg(dev
, obj
, obj_type
, true);
316 static void drm_mode_object_register(struct drm_device
*dev
,
317 struct drm_mode_object
*obj
)
319 mutex_lock(&dev
->mode_config
.idr_mutex
);
320 idr_replace(&dev
->mode_config
.crtc_idr
, obj
, obj
->id
);
321 mutex_unlock(&dev
->mode_config
.idr_mutex
);
325 * drm_mode_object_put - free a modeset identifer
327 * @object: object to free
329 * Free @id from @dev's unique identifier pool. Note that despite the _get
330 * postfix modeset identifiers are _not_ reference counted. Hence don't use this
331 * for reference counted modeset objects like framebuffers.
333 void drm_mode_object_put(struct drm_device
*dev
,
334 struct drm_mode_object
*object
)
336 mutex_lock(&dev
->mode_config
.idr_mutex
);
337 idr_remove(&dev
->mode_config
.crtc_idr
, object
->id
);
338 mutex_unlock(&dev
->mode_config
.idr_mutex
);
341 static struct drm_mode_object
*_object_find(struct drm_device
*dev
,
342 uint32_t id
, uint32_t type
)
344 struct drm_mode_object
*obj
= NULL
;
346 mutex_lock(&dev
->mode_config
.idr_mutex
);
347 obj
= idr_find(&dev
->mode_config
.crtc_idr
, id
);
348 if (obj
&& type
!= DRM_MODE_OBJECT_ANY
&& obj
->type
!= type
)
350 if (obj
&& obj
->id
!= id
)
352 /* don't leak out unref'd fb's */
353 if (obj
&& (obj
->type
== DRM_MODE_OBJECT_FB
))
355 mutex_unlock(&dev
->mode_config
.idr_mutex
);
361 * drm_mode_object_find - look up a drm object with static lifetime
363 * @id: id of the mode object
364 * @type: type of the mode object
366 * Note that framebuffers cannot be looked up with this functions - since those
367 * are reference counted, they need special treatment. Even with
368 * DRM_MODE_OBJECT_ANY (although that will simply return NULL
369 * rather than WARN_ON()).
371 struct drm_mode_object
*drm_mode_object_find(struct drm_device
*dev
,
372 uint32_t id
, uint32_t type
)
374 struct drm_mode_object
*obj
= NULL
;
376 /* Framebuffers are reference counted and need their own lookup
378 WARN_ON(type
== DRM_MODE_OBJECT_FB
);
379 obj
= _object_find(dev
, id
, type
);
382 EXPORT_SYMBOL(drm_mode_object_find
);
385 * drm_framebuffer_init - initialize a framebuffer
387 * @fb: framebuffer to be initialized
388 * @funcs: ... with these functions
390 * Allocates an ID for the framebuffer's parent mode object, sets its mode
391 * functions & device file and adds it to the master fd list.
394 * This functions publishes the fb and makes it available for concurrent access
395 * by other users. Which means by this point the fb _must_ be fully set up -
396 * since all the fb attributes are invariant over its lifetime, no further
397 * locking but only correct reference counting is required.
400 * Zero on success, error code on failure.
402 int drm_framebuffer_init(struct drm_device
*dev
, struct drm_framebuffer
*fb
,
403 const struct drm_framebuffer_funcs
*funcs
)
407 mutex_lock(&dev
->mode_config
.fb_lock
);
408 kref_init(&fb
->refcount
);
409 INIT_LIST_HEAD(&fb
->filp_head
);
413 ret
= drm_mode_object_get(dev
, &fb
->base
, DRM_MODE_OBJECT_FB
);
417 dev
->mode_config
.num_fb
++;
418 list_add(&fb
->head
, &dev
->mode_config
.fb_list
);
420 mutex_unlock(&dev
->mode_config
.fb_lock
);
424 EXPORT_SYMBOL(drm_framebuffer_init
);
426 /* dev->mode_config.fb_lock must be held! */
427 static void __drm_framebuffer_unregister(struct drm_device
*dev
,
428 struct drm_framebuffer
*fb
)
430 mutex_lock(&dev
->mode_config
.idr_mutex
);
431 idr_remove(&dev
->mode_config
.crtc_idr
, fb
->base
.id
);
432 mutex_unlock(&dev
->mode_config
.idr_mutex
);
437 static void drm_framebuffer_free(struct kref
*kref
)
439 struct drm_framebuffer
*fb
=
440 container_of(kref
, struct drm_framebuffer
, refcount
);
441 struct drm_device
*dev
= fb
->dev
;
444 * The lookup idr holds a weak reference, which has not necessarily been
445 * removed at this point. Check for that.
447 mutex_lock(&dev
->mode_config
.fb_lock
);
449 /* Mark fb as reaped and drop idr ref. */
450 __drm_framebuffer_unregister(dev
, fb
);
452 mutex_unlock(&dev
->mode_config
.fb_lock
);
454 fb
->funcs
->destroy(fb
);
457 static struct drm_framebuffer
*__drm_framebuffer_lookup(struct drm_device
*dev
,
460 struct drm_mode_object
*obj
= NULL
;
461 struct drm_framebuffer
*fb
;
463 mutex_lock(&dev
->mode_config
.idr_mutex
);
464 obj
= idr_find(&dev
->mode_config
.crtc_idr
, id
);
465 if (!obj
|| (obj
->type
!= DRM_MODE_OBJECT_FB
) || (obj
->id
!= id
))
469 mutex_unlock(&dev
->mode_config
.idr_mutex
);
475 * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
477 * @id: id of the fb object
479 * If successful, this grabs an additional reference to the framebuffer -
480 * callers need to make sure to eventually unreference the returned framebuffer
481 * again, using @drm_framebuffer_unreference.
483 struct drm_framebuffer
*drm_framebuffer_lookup(struct drm_device
*dev
,
486 struct drm_framebuffer
*fb
;
488 mutex_lock(&dev
->mode_config
.fb_lock
);
489 fb
= __drm_framebuffer_lookup(dev
, id
);
491 if (!kref_get_unless_zero(&fb
->refcount
))
494 mutex_unlock(&dev
->mode_config
.fb_lock
);
498 EXPORT_SYMBOL(drm_framebuffer_lookup
);
501 * drm_framebuffer_unreference - unref a framebuffer
502 * @fb: framebuffer to unref
504 * This functions decrements the fb's refcount and frees it if it drops to zero.
506 void drm_framebuffer_unreference(struct drm_framebuffer
*fb
)
508 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb
, fb
->base
.id
, atomic_read(&fb
->refcount
.refcount
));
509 kref_put(&fb
->refcount
, drm_framebuffer_free
);
511 EXPORT_SYMBOL(drm_framebuffer_unreference
);
514 * drm_framebuffer_reference - incr the fb refcnt
517 * This functions increments the fb's refcount.
519 void drm_framebuffer_reference(struct drm_framebuffer
*fb
)
521 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb
, fb
->base
.id
, atomic_read(&fb
->refcount
.refcount
));
522 kref_get(&fb
->refcount
);
524 EXPORT_SYMBOL(drm_framebuffer_reference
);
526 static void drm_framebuffer_free_bug(struct kref
*kref
)
531 static void __drm_framebuffer_unreference(struct drm_framebuffer
*fb
)
533 DRM_DEBUG("%p: FB ID: %d (%d)\n", fb
, fb
->base
.id
, atomic_read(&fb
->refcount
.refcount
));
534 kref_put(&fb
->refcount
, drm_framebuffer_free_bug
);
538 * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
539 * @fb: fb to unregister
541 * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
542 * those used for fbdev. Note that the caller must hold a reference of it's own,
543 * i.e. the object may not be destroyed through this call (since it'll lead to a
544 * locking inversion).
546 void drm_framebuffer_unregister_private(struct drm_framebuffer
*fb
)
548 struct drm_device
*dev
= fb
->dev
;
550 mutex_lock(&dev
->mode_config
.fb_lock
);
551 /* Mark fb as reaped and drop idr ref. */
552 __drm_framebuffer_unregister(dev
, fb
);
553 mutex_unlock(&dev
->mode_config
.fb_lock
);
555 EXPORT_SYMBOL(drm_framebuffer_unregister_private
);
558 * drm_framebuffer_cleanup - remove a framebuffer object
559 * @fb: framebuffer to remove
561 * Cleanup framebuffer. This function is intended to be used from the drivers
562 * ->destroy callback. It can also be used to clean up driver private
563 * framebuffers embedded into a larger structure.
565 * Note that this function does not remove the fb from active usuage - if it is
566 * still used anywhere, hilarity can ensue since userspace could call getfb on
567 * the id and get back -EINVAL. Obviously no concern at driver unload time.
569 * Also, the framebuffer will not be removed from the lookup idr - for
570 * user-created framebuffers this will happen in in the rmfb ioctl. For
571 * driver-private objects (e.g. for fbdev) drivers need to explicitly call
572 * drm_framebuffer_unregister_private.
574 void drm_framebuffer_cleanup(struct drm_framebuffer
*fb
)
576 struct drm_device
*dev
= fb
->dev
;
578 mutex_lock(&dev
->mode_config
.fb_lock
);
580 dev
->mode_config
.num_fb
--;
581 mutex_unlock(&dev
->mode_config
.fb_lock
);
583 EXPORT_SYMBOL(drm_framebuffer_cleanup
);
586 * drm_framebuffer_remove - remove and unreference a framebuffer object
587 * @fb: framebuffer to remove
589 * Scans all the CRTCs and planes in @dev's mode_config. If they're
590 * using @fb, removes it, setting it to NULL. Then drops the reference to the
591 * passed-in framebuffer. Might take the modeset locks.
593 * Note that this function optimizes the cleanup away if the caller holds the
594 * last reference to the framebuffer. It is also guaranteed to not take the
595 * modeset locks in this case.
597 void drm_framebuffer_remove(struct drm_framebuffer
*fb
)
599 struct drm_device
*dev
= fb
->dev
;
600 struct drm_crtc
*crtc
;
601 struct drm_plane
*plane
;
602 struct drm_mode_set set
;
605 WARN_ON(!list_empty(&fb
->filp_head
));
608 * drm ABI mandates that we remove any deleted framebuffers from active
609 * useage. But since most sane clients only remove framebuffers they no
610 * longer need, try to optimize this away.
612 * Since we're holding a reference ourselves, observing a refcount of 1
613 * means that we're the last holder and can skip it. Also, the refcount
614 * can never increase from 1 again, so we don't need any barriers or
617 * Note that userspace could try to race with use and instate a new
618 * usage _after_ we've cleared all current ones. End result will be an
619 * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
622 if (atomic_read(&fb
->refcount
.refcount
) > 1) {
623 drm_modeset_lock_all(dev
);
624 /* remove from any CRTC */
625 list_for_each_entry(crtc
, &dev
->mode_config
.crtc_list
, head
) {
626 if (crtc
->primary
->fb
== fb
) {
627 /* should turn off the crtc */
628 memset(&set
, 0, sizeof(struct drm_mode_set
));
631 ret
= drm_mode_set_config_internal(&set
);
633 DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc
);
637 list_for_each_entry(plane
, &dev
->mode_config
.plane_list
, head
) {
639 drm_plane_force_disable(plane
);
641 drm_modeset_unlock_all(dev
);
644 drm_framebuffer_unreference(fb
);
646 EXPORT_SYMBOL(drm_framebuffer_remove
);
648 DEFINE_WW_CLASS(crtc_ww_class
);
651 * drm_crtc_init_with_planes - Initialise a new CRTC object with
652 * specified primary and cursor planes.
654 * @crtc: CRTC object to init
655 * @primary: Primary plane for CRTC
656 * @cursor: Cursor plane for CRTC
657 * @funcs: callbacks for the new CRTC
659 * Inits a new object created as base part of a driver crtc object.
662 * Zero on success, error code on failure.
664 int drm_crtc_init_with_planes(struct drm_device
*dev
, struct drm_crtc
*crtc
,
665 struct drm_plane
*primary
,
666 struct drm_plane
*cursor
,
667 const struct drm_crtc_funcs
*funcs
)
669 struct drm_mode_config
*config
= &dev
->mode_config
;
674 crtc
->invert_dimensions
= false;
676 drm_modeset_lock_init(&crtc
->mutex
);
677 ret
= drm_mode_object_get(dev
, &crtc
->base
, DRM_MODE_OBJECT_CRTC
);
681 crtc
->base
.properties
= &crtc
->properties
;
683 list_add_tail(&crtc
->head
, &config
->crtc_list
);
686 crtc
->primary
= primary
;
687 crtc
->cursor
= cursor
;
689 primary
->possible_crtcs
= 1 << drm_crtc_index(crtc
);
691 cursor
->possible_crtcs
= 1 << drm_crtc_index(crtc
);
695 EXPORT_SYMBOL(drm_crtc_init_with_planes
);
698 * drm_crtc_cleanup - Clean up the core crtc usage
699 * @crtc: CRTC to cleanup
701 * This function cleans up @crtc and removes it from the DRM mode setting
702 * core. Note that the function does *not* free the crtc structure itself,
703 * this is the responsibility of the caller.
705 void drm_crtc_cleanup(struct drm_crtc
*crtc
)
707 struct drm_device
*dev
= crtc
->dev
;
709 kfree(crtc
->gamma_store
);
710 crtc
->gamma_store
= NULL
;
712 drm_modeset_lock_fini(&crtc
->mutex
);
714 drm_mode_object_put(dev
, &crtc
->base
);
715 list_del(&crtc
->head
);
716 dev
->mode_config
.num_crtc
--;
718 WARN_ON(crtc
->state
&& !crtc
->funcs
->atomic_destroy_state
);
719 if (crtc
->state
&& crtc
->funcs
->atomic_destroy_state
)
720 crtc
->funcs
->atomic_destroy_state(crtc
, crtc
->state
);
722 memset(crtc
, 0, sizeof(*crtc
));
724 EXPORT_SYMBOL(drm_crtc_cleanup
);
727 * drm_crtc_index - find the index of a registered CRTC
728 * @crtc: CRTC to find index for
730 * Given a registered CRTC, return the index of that CRTC within a DRM
731 * device's list of CRTCs.
733 unsigned int drm_crtc_index(struct drm_crtc
*crtc
)
735 unsigned int index
= 0;
736 struct drm_crtc
*tmp
;
738 list_for_each_entry(tmp
, &crtc
->dev
->mode_config
.crtc_list
, head
) {
747 EXPORT_SYMBOL(drm_crtc_index
);
750 * drm_mode_remove - remove and free a mode
751 * @connector: connector list to modify
752 * @mode: mode to remove
754 * Remove @mode from @connector's mode list, then free it.
756 static void drm_mode_remove(struct drm_connector
*connector
,
757 struct drm_display_mode
*mode
)
759 list_del(&mode
->head
);
760 drm_mode_destroy(connector
->dev
, mode
);
764 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
765 * @connector: connector to quwery
767 * The kernel supports per-connector configration of its consoles through
768 * use of the video= parameter. This function parses that option and
769 * extracts the user's specified mode (or enable/disable status) for a
770 * particular connector. This is typically only used during the early fbdev
773 static void drm_connector_get_cmdline_mode(struct drm_connector
*connector
)
775 struct drm_cmdline_mode
*mode
= &connector
->cmdline_mode
;
778 if (fb_get_options(connector
->name
, &option
))
781 if (!drm_mode_parse_command_line_for_connector(option
,
789 switch (mode
->force
) {
793 case DRM_FORCE_ON_DIGITAL
:
802 DRM_INFO("forcing %s connector %s\n", connector
->name
, s
);
803 connector
->force
= mode
->force
;
806 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
808 mode
->xres
, mode
->yres
,
809 mode
->refresh_specified
? mode
->refresh
: 60,
810 mode
->rb
? " reduced blanking" : "",
811 mode
->margins
? " with margins" : "",
812 mode
->interlace
? " interlaced" : "");
816 * drm_connector_init - Init a preallocated connector
818 * @connector: the connector to init
819 * @funcs: callbacks for this connector
820 * @connector_type: user visible type of the connector
822 * Initialises a preallocated connector. Connectors should be
823 * subclassed as part of driver connector objects.
826 * Zero on success, error code on failure.
828 int drm_connector_init(struct drm_device
*dev
,
829 struct drm_connector
*connector
,
830 const struct drm_connector_funcs
*funcs
,
834 struct ida
*connector_ida
=
835 &drm_connector_enum_list
[connector_type
].ida
;
837 drm_modeset_lock_all(dev
);
839 ret
= drm_mode_object_get_reg(dev
, &connector
->base
, DRM_MODE_OBJECT_CONNECTOR
, false);
843 connector
->base
.properties
= &connector
->properties
;
844 connector
->dev
= dev
;
845 connector
->funcs
= funcs
;
846 connector
->connector_type
= connector_type
;
847 connector
->connector_type_id
=
848 ida_simple_get(connector_ida
, 1, 0, GFP_KERNEL
);
849 if (connector
->connector_type_id
< 0) {
850 ret
= connector
->connector_type_id
;
854 kasprintf(GFP_KERNEL
, "%s-%d",
855 drm_connector_enum_list
[connector_type
].name
,
856 connector
->connector_type_id
);
857 if (!connector
->name
) {
862 INIT_LIST_HEAD(&connector
->probed_modes
);
863 INIT_LIST_HEAD(&connector
->modes
);
864 connector
->edid_blob_ptr
= NULL
;
865 connector
->status
= connector_status_unknown
;
867 drm_connector_get_cmdline_mode(connector
);
869 /* We should add connectors at the end to avoid upsetting the connector
871 list_add_tail(&connector
->head
, &dev
->mode_config
.connector_list
);
872 dev
->mode_config
.num_connector
++;
874 if (connector_type
!= DRM_MODE_CONNECTOR_VIRTUAL
)
875 drm_object_attach_property(&connector
->base
,
876 dev
->mode_config
.edid_property
,
879 drm_object_attach_property(&connector
->base
,
880 dev
->mode_config
.dpms_property
, 0);
882 connector
->debugfs_entry
= NULL
;
886 drm_mode_object_put(dev
, &connector
->base
);
889 drm_modeset_unlock_all(dev
);
893 EXPORT_SYMBOL(drm_connector_init
);
896 * drm_connector_cleanup - cleans up an initialised connector
897 * @connector: connector to cleanup
899 * Cleans up the connector but doesn't free the object.
901 void drm_connector_cleanup(struct drm_connector
*connector
)
903 struct drm_device
*dev
= connector
->dev
;
904 struct drm_display_mode
*mode
, *t
;
906 list_for_each_entry_safe(mode
, t
, &connector
->probed_modes
, head
)
907 drm_mode_remove(connector
, mode
);
909 list_for_each_entry_safe(mode
, t
, &connector
->modes
, head
)
910 drm_mode_remove(connector
, mode
);
912 ida_remove(&drm_connector_enum_list
[connector
->connector_type
].ida
,
913 connector
->connector_type_id
);
915 drm_mode_object_put(dev
, &connector
->base
);
916 kfree(connector
->name
);
917 connector
->name
= NULL
;
918 list_del(&connector
->head
);
919 dev
->mode_config
.num_connector
--;
921 WARN_ON(connector
->state
&& !connector
->funcs
->atomic_destroy_state
);
922 if (connector
->state
&& connector
->funcs
->atomic_destroy_state
)
923 connector
->funcs
->atomic_destroy_state(connector
,
926 memset(connector
, 0, sizeof(*connector
));
928 EXPORT_SYMBOL(drm_connector_cleanup
);
931 * drm_connector_index - find the index of a registered connector
932 * @connector: connector to find index for
934 * Given a registered connector, return the index of that connector within a DRM
935 * device's list of connectors.
937 unsigned int drm_connector_index(struct drm_connector
*connector
)
939 unsigned int index
= 0;
940 struct drm_connector
*tmp
;
941 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
943 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
945 list_for_each_entry(tmp
, &connector
->dev
->mode_config
.connector_list
, head
) {
946 if (tmp
== connector
)
954 EXPORT_SYMBOL(drm_connector_index
);
957 * drm_connector_register - register a connector
958 * @connector: the connector to register
960 * Register userspace interfaces for a connector
963 * Zero on success, error code on failure.
965 int drm_connector_register(struct drm_connector
*connector
)
969 drm_mode_object_register(connector
->dev
, &connector
->base
);
971 ret
= drm_sysfs_connector_add(connector
);
975 ret
= drm_debugfs_connector_add(connector
);
977 drm_sysfs_connector_remove(connector
);
983 EXPORT_SYMBOL(drm_connector_register
);
986 * drm_connector_unregister - unregister a connector
987 * @connector: the connector to unregister
989 * Unregister userspace interfaces for a connector
991 void drm_connector_unregister(struct drm_connector
*connector
)
993 drm_sysfs_connector_remove(connector
);
994 drm_debugfs_connector_remove(connector
);
996 EXPORT_SYMBOL(drm_connector_unregister
);
1000 * drm_connector_unplug_all - unregister connector userspace interfaces
1003 * This function unregisters all connector userspace interfaces in sysfs. Should
1004 * be call when the device is disconnected, e.g. from an usb driver's
1005 * ->disconnect callback.
1007 void drm_connector_unplug_all(struct drm_device
*dev
)
1009 struct drm_connector
*connector
;
1011 /* taking the mode config mutex ends up in a clash with sysfs */
1012 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
)
1013 drm_connector_unregister(connector
);
1016 EXPORT_SYMBOL(drm_connector_unplug_all
);
1019 * drm_bridge_init - initialize a drm transcoder/bridge
1021 * @bridge: transcoder/bridge to set up
1022 * @funcs: bridge function table
1024 * Initialises a preallocated bridge. Bridges should be
1025 * subclassed as part of driver connector objects.
1028 * Zero on success, error code on failure.
1030 int drm_bridge_init(struct drm_device
*dev
, struct drm_bridge
*bridge
,
1031 const struct drm_bridge_funcs
*funcs
)
1035 drm_modeset_lock_all(dev
);
1037 ret
= drm_mode_object_get(dev
, &bridge
->base
, DRM_MODE_OBJECT_BRIDGE
);
1042 bridge
->funcs
= funcs
;
1044 list_add_tail(&bridge
->head
, &dev
->mode_config
.bridge_list
);
1045 dev
->mode_config
.num_bridge
++;
1048 drm_modeset_unlock_all(dev
);
1051 EXPORT_SYMBOL(drm_bridge_init
);
1054 * drm_bridge_cleanup - cleans up an initialised bridge
1055 * @bridge: bridge to cleanup
1057 * Cleans up the bridge but doesn't free the object.
1059 void drm_bridge_cleanup(struct drm_bridge
*bridge
)
1061 struct drm_device
*dev
= bridge
->dev
;
1063 drm_modeset_lock_all(dev
);
1064 drm_mode_object_put(dev
, &bridge
->base
);
1065 list_del(&bridge
->head
);
1066 dev
->mode_config
.num_bridge
--;
1067 drm_modeset_unlock_all(dev
);
1069 memset(bridge
, 0, sizeof(*bridge
));
1071 EXPORT_SYMBOL(drm_bridge_cleanup
);
1074 * drm_encoder_init - Init a preallocated encoder
1076 * @encoder: the encoder to init
1077 * @funcs: callbacks for this encoder
1078 * @encoder_type: user visible type of the encoder
1080 * Initialises a preallocated encoder. Encoder should be
1081 * subclassed as part of driver encoder objects.
1084 * Zero on success, error code on failure.
1086 int drm_encoder_init(struct drm_device
*dev
,
1087 struct drm_encoder
*encoder
,
1088 const struct drm_encoder_funcs
*funcs
,
1093 drm_modeset_lock_all(dev
);
1095 ret
= drm_mode_object_get(dev
, &encoder
->base
, DRM_MODE_OBJECT_ENCODER
);
1100 encoder
->encoder_type
= encoder_type
;
1101 encoder
->funcs
= funcs
;
1102 encoder
->name
= kasprintf(GFP_KERNEL
, "%s-%d",
1103 drm_encoder_enum_list
[encoder_type
].name
,
1105 if (!encoder
->name
) {
1110 list_add_tail(&encoder
->head
, &dev
->mode_config
.encoder_list
);
1111 dev
->mode_config
.num_encoder
++;
1115 drm_mode_object_put(dev
, &encoder
->base
);
1118 drm_modeset_unlock_all(dev
);
1122 EXPORT_SYMBOL(drm_encoder_init
);
1125 * drm_encoder_cleanup - cleans up an initialised encoder
1126 * @encoder: encoder to cleanup
1128 * Cleans up the encoder but doesn't free the object.
1130 void drm_encoder_cleanup(struct drm_encoder
*encoder
)
1132 struct drm_device
*dev
= encoder
->dev
;
1134 drm_modeset_lock_all(dev
);
1135 drm_mode_object_put(dev
, &encoder
->base
);
1136 kfree(encoder
->name
);
1137 list_del(&encoder
->head
);
1138 dev
->mode_config
.num_encoder
--;
1139 drm_modeset_unlock_all(dev
);
1141 memset(encoder
, 0, sizeof(*encoder
));
1143 EXPORT_SYMBOL(drm_encoder_cleanup
);
1146 * drm_universal_plane_init - Initialize a new universal plane object
1148 * @plane: plane object to init
1149 * @possible_crtcs: bitmask of possible CRTCs
1150 * @funcs: callbacks for the new plane
1151 * @formats: array of supported formats (%DRM_FORMAT_*)
1152 * @format_count: number of elements in @formats
1153 * @type: type of plane (overlay, primary, cursor)
1155 * Initializes a plane object of type @type.
1158 * Zero on success, error code on failure.
1160 int drm_universal_plane_init(struct drm_device
*dev
, struct drm_plane
*plane
,
1161 unsigned long possible_crtcs
,
1162 const struct drm_plane_funcs
*funcs
,
1163 const uint32_t *formats
, uint32_t format_count
,
1164 enum drm_plane_type type
)
1168 ret
= drm_mode_object_get(dev
, &plane
->base
, DRM_MODE_OBJECT_PLANE
);
1172 drm_modeset_lock_init(&plane
->mutex
);
1174 plane
->base
.properties
= &plane
->properties
;
1176 plane
->funcs
= funcs
;
1177 plane
->format_types
= kmalloc_array(format_count
, sizeof(uint32_t),
1179 if (!plane
->format_types
) {
1180 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1181 drm_mode_object_put(dev
, &plane
->base
);
1185 memcpy(plane
->format_types
, formats
, format_count
* sizeof(uint32_t));
1186 plane
->format_count
= format_count
;
1187 plane
->possible_crtcs
= possible_crtcs
;
1190 list_add_tail(&plane
->head
, &dev
->mode_config
.plane_list
);
1191 dev
->mode_config
.num_total_plane
++;
1192 if (plane
->type
== DRM_PLANE_TYPE_OVERLAY
)
1193 dev
->mode_config
.num_overlay_plane
++;
1195 drm_object_attach_property(&plane
->base
,
1196 dev
->mode_config
.plane_type_property
,
1201 EXPORT_SYMBOL(drm_universal_plane_init
);
1204 * drm_plane_init - Initialize a legacy plane
1206 * @plane: plane object to init
1207 * @possible_crtcs: bitmask of possible CRTCs
1208 * @funcs: callbacks for the new plane
1209 * @formats: array of supported formats (%DRM_FORMAT_*)
1210 * @format_count: number of elements in @formats
1211 * @is_primary: plane type (primary vs overlay)
1213 * Legacy API to initialize a DRM plane.
1215 * New drivers should call drm_universal_plane_init() instead.
1218 * Zero on success, error code on failure.
1220 int drm_plane_init(struct drm_device
*dev
, struct drm_plane
*plane
,
1221 unsigned long possible_crtcs
,
1222 const struct drm_plane_funcs
*funcs
,
1223 const uint32_t *formats
, uint32_t format_count
,
1226 enum drm_plane_type type
;
1228 type
= is_primary
? DRM_PLANE_TYPE_PRIMARY
: DRM_PLANE_TYPE_OVERLAY
;
1229 return drm_universal_plane_init(dev
, plane
, possible_crtcs
, funcs
,
1230 formats
, format_count
, type
);
1232 EXPORT_SYMBOL(drm_plane_init
);
1235 * drm_plane_cleanup - Clean up the core plane usage
1236 * @plane: plane to cleanup
1238 * This function cleans up @plane and removes it from the DRM mode setting
1239 * core. Note that the function does *not* free the plane structure itself,
1240 * this is the responsibility of the caller.
1242 void drm_plane_cleanup(struct drm_plane
*plane
)
1244 struct drm_device
*dev
= plane
->dev
;
1246 drm_modeset_lock_all(dev
);
1247 kfree(plane
->format_types
);
1248 drm_mode_object_put(dev
, &plane
->base
);
1250 BUG_ON(list_empty(&plane
->head
));
1252 list_del(&plane
->head
);
1253 dev
->mode_config
.num_total_plane
--;
1254 if (plane
->type
== DRM_PLANE_TYPE_OVERLAY
)
1255 dev
->mode_config
.num_overlay_plane
--;
1256 drm_modeset_unlock_all(dev
);
1258 WARN_ON(plane
->state
&& !plane
->funcs
->atomic_destroy_state
);
1259 if (plane
->state
&& plane
->funcs
->atomic_destroy_state
)
1260 plane
->funcs
->atomic_destroy_state(plane
, plane
->state
);
1262 memset(plane
, 0, sizeof(*plane
));
1264 EXPORT_SYMBOL(drm_plane_cleanup
);
1267 * drm_plane_index - find the index of a registered plane
1268 * @plane: plane to find index for
1270 * Given a registered plane, return the index of that CRTC within a DRM
1271 * device's list of planes.
1273 unsigned int drm_plane_index(struct drm_plane
*plane
)
1275 unsigned int index
= 0;
1276 struct drm_plane
*tmp
;
1278 list_for_each_entry(tmp
, &plane
->dev
->mode_config
.plane_list
, head
) {
1287 EXPORT_SYMBOL(drm_plane_index
);
1290 * drm_plane_force_disable - Forcibly disable a plane
1291 * @plane: plane to disable
1293 * Forces the plane to be disabled.
1295 * Used when the plane's current framebuffer is destroyed,
1296 * and when restoring fbdev mode.
1298 void drm_plane_force_disable(struct drm_plane
*plane
)
1305 plane
->old_fb
= plane
->fb
;
1306 ret
= plane
->funcs
->disable_plane(plane
);
1308 DRM_ERROR("failed to disable plane with busy fb\n");
1309 plane
->old_fb
= NULL
;
1312 /* disconnect the plane from the fb and crtc: */
1313 __drm_framebuffer_unreference(plane
->old_fb
);
1314 plane
->old_fb
= NULL
;
1318 EXPORT_SYMBOL(drm_plane_force_disable
);
1320 static int drm_mode_create_standard_connector_properties(struct drm_device
*dev
)
1322 struct drm_property
*edid
;
1323 struct drm_property
*dpms
;
1324 struct drm_property
*dev_path
;
1327 * Standard properties (apply to all connectors)
1329 edid
= drm_property_create(dev
, DRM_MODE_PROP_BLOB
|
1330 DRM_MODE_PROP_IMMUTABLE
,
1332 dev
->mode_config
.edid_property
= edid
;
1334 dpms
= drm_property_create_enum(dev
, 0,
1335 "DPMS", drm_dpms_enum_list
,
1336 ARRAY_SIZE(drm_dpms_enum_list
));
1337 dev
->mode_config
.dpms_property
= dpms
;
1339 dev_path
= drm_property_create(dev
,
1340 DRM_MODE_PROP_BLOB
|
1341 DRM_MODE_PROP_IMMUTABLE
,
1343 dev
->mode_config
.path_property
= dev_path
;
1348 static int drm_mode_create_standard_plane_properties(struct drm_device
*dev
)
1350 struct drm_property
*type
;
1353 * Standard properties (apply to all planes)
1355 type
= drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
1356 "type", drm_plane_type_enum_list
,
1357 ARRAY_SIZE(drm_plane_type_enum_list
));
1358 dev
->mode_config
.plane_type_property
= type
;
1364 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1367 * Called by a driver the first time a DVI-I connector is made.
1369 int drm_mode_create_dvi_i_properties(struct drm_device
*dev
)
1371 struct drm_property
*dvi_i_selector
;
1372 struct drm_property
*dvi_i_subconnector
;
1374 if (dev
->mode_config
.dvi_i_select_subconnector_property
)
1378 drm_property_create_enum(dev
, 0,
1379 "select subconnector",
1380 drm_dvi_i_select_enum_list
,
1381 ARRAY_SIZE(drm_dvi_i_select_enum_list
));
1382 dev
->mode_config
.dvi_i_select_subconnector_property
= dvi_i_selector
;
1384 dvi_i_subconnector
= drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
1386 drm_dvi_i_subconnector_enum_list
,
1387 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list
));
1388 dev
->mode_config
.dvi_i_subconnector_property
= dvi_i_subconnector
;
1392 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties
);
1395 * drm_create_tv_properties - create TV specific connector properties
1397 * @num_modes: number of different TV formats (modes) supported
1398 * @modes: array of pointers to strings containing name of each format
1400 * Called by a driver's TV initialization routine, this function creates
1401 * the TV specific connector properties for a given device. Caller is
1402 * responsible for allocating a list of format names and passing them to
1405 int drm_mode_create_tv_properties(struct drm_device
*dev
,
1406 unsigned int num_modes
,
1409 struct drm_property
*tv_selector
;
1410 struct drm_property
*tv_subconnector
;
1413 if (dev
->mode_config
.tv_select_subconnector_property
)
1417 * Basic connector properties
1419 tv_selector
= drm_property_create_enum(dev
, 0,
1420 "select subconnector",
1421 drm_tv_select_enum_list
,
1422 ARRAY_SIZE(drm_tv_select_enum_list
));
1423 dev
->mode_config
.tv_select_subconnector_property
= tv_selector
;
1426 drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
1428 drm_tv_subconnector_enum_list
,
1429 ARRAY_SIZE(drm_tv_subconnector_enum_list
));
1430 dev
->mode_config
.tv_subconnector_property
= tv_subconnector
;
1433 * Other, TV specific properties: margins & TV modes.
1435 dev
->mode_config
.tv_left_margin_property
=
1436 drm_property_create_range(dev
, 0, "left margin", 0, 100);
1438 dev
->mode_config
.tv_right_margin_property
=
1439 drm_property_create_range(dev
, 0, "right margin", 0, 100);
1441 dev
->mode_config
.tv_top_margin_property
=
1442 drm_property_create_range(dev
, 0, "top margin", 0, 100);
1444 dev
->mode_config
.tv_bottom_margin_property
=
1445 drm_property_create_range(dev
, 0, "bottom margin", 0, 100);
1447 dev
->mode_config
.tv_mode_property
=
1448 drm_property_create(dev
, DRM_MODE_PROP_ENUM
,
1450 for (i
= 0; i
< num_modes
; i
++)
1451 drm_property_add_enum(dev
->mode_config
.tv_mode_property
, i
,
1454 dev
->mode_config
.tv_brightness_property
=
1455 drm_property_create_range(dev
, 0, "brightness", 0, 100);
1457 dev
->mode_config
.tv_contrast_property
=
1458 drm_property_create_range(dev
, 0, "contrast", 0, 100);
1460 dev
->mode_config
.tv_flicker_reduction_property
=
1461 drm_property_create_range(dev
, 0, "flicker reduction", 0, 100);
1463 dev
->mode_config
.tv_overscan_property
=
1464 drm_property_create_range(dev
, 0, "overscan", 0, 100);
1466 dev
->mode_config
.tv_saturation_property
=
1467 drm_property_create_range(dev
, 0, "saturation", 0, 100);
1469 dev
->mode_config
.tv_hue_property
=
1470 drm_property_create_range(dev
, 0, "hue", 0, 100);
1474 EXPORT_SYMBOL(drm_mode_create_tv_properties
);
1477 * drm_mode_create_scaling_mode_property - create scaling mode property
1480 * Called by a driver the first time it's needed, must be attached to desired
1483 int drm_mode_create_scaling_mode_property(struct drm_device
*dev
)
1485 struct drm_property
*scaling_mode
;
1487 if (dev
->mode_config
.scaling_mode_property
)
1491 drm_property_create_enum(dev
, 0, "scaling mode",
1492 drm_scaling_mode_enum_list
,
1493 ARRAY_SIZE(drm_scaling_mode_enum_list
));
1495 dev
->mode_config
.scaling_mode_property
= scaling_mode
;
1499 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property
);
1502 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1505 * Called by a driver the first time it's needed, must be attached to desired
1509 * Zero on success, negative errno on failure.
1511 int drm_mode_create_aspect_ratio_property(struct drm_device
*dev
)
1513 if (dev
->mode_config
.aspect_ratio_property
)
1516 dev
->mode_config
.aspect_ratio_property
=
1517 drm_property_create_enum(dev
, 0, "aspect ratio",
1518 drm_aspect_ratio_enum_list
,
1519 ARRAY_SIZE(drm_aspect_ratio_enum_list
));
1521 if (dev
->mode_config
.aspect_ratio_property
== NULL
)
1526 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property
);
1529 * drm_mode_create_dirty_property - create dirty property
1532 * Called by a driver the first time it's needed, must be attached to desired
1535 int drm_mode_create_dirty_info_property(struct drm_device
*dev
)
1537 struct drm_property
*dirty_info
;
1539 if (dev
->mode_config
.dirty_info_property
)
1543 drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
1545 drm_dirty_info_enum_list
,
1546 ARRAY_SIZE(drm_dirty_info_enum_list
));
1547 dev
->mode_config
.dirty_info_property
= dirty_info
;
1551 EXPORT_SYMBOL(drm_mode_create_dirty_info_property
);
1554 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1557 * Create the the suggested x/y offset property for connectors.
1559 int drm_mode_create_suggested_offset_properties(struct drm_device
*dev
)
1561 if (dev
->mode_config
.suggested_x_property
&& dev
->mode_config
.suggested_y_property
)
1564 dev
->mode_config
.suggested_x_property
=
1565 drm_property_create_range(dev
, DRM_MODE_PROP_IMMUTABLE
, "suggested X", 0, 0xffffffff);
1567 dev
->mode_config
.suggested_y_property
=
1568 drm_property_create_range(dev
, DRM_MODE_PROP_IMMUTABLE
, "suggested Y", 0, 0xffffffff);
1570 if (dev
->mode_config
.suggested_x_property
== NULL
||
1571 dev
->mode_config
.suggested_y_property
== NULL
)
1575 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties
);
1577 static int drm_mode_group_init(struct drm_device
*dev
, struct drm_mode_group
*group
)
1579 uint32_t total_objects
= 0;
1581 total_objects
+= dev
->mode_config
.num_crtc
;
1582 total_objects
+= dev
->mode_config
.num_connector
;
1583 total_objects
+= dev
->mode_config
.num_encoder
;
1584 total_objects
+= dev
->mode_config
.num_bridge
;
1586 group
->id_list
= kcalloc(total_objects
, sizeof(uint32_t), GFP_KERNEL
);
1587 if (!group
->id_list
)
1590 group
->num_crtcs
= 0;
1591 group
->num_connectors
= 0;
1592 group
->num_encoders
= 0;
1593 group
->num_bridges
= 0;
1597 void drm_mode_group_destroy(struct drm_mode_group
*group
)
1599 kfree(group
->id_list
);
1600 group
->id_list
= NULL
;
1604 * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1605 * the drm core's responsibility to set up mode control groups.
1607 int drm_mode_group_init_legacy_group(struct drm_device
*dev
,
1608 struct drm_mode_group
*group
)
1610 struct drm_crtc
*crtc
;
1611 struct drm_encoder
*encoder
;
1612 struct drm_connector
*connector
;
1613 struct drm_bridge
*bridge
;
1616 if ((ret
= drm_mode_group_init(dev
, group
)))
1619 list_for_each_entry(crtc
, &dev
->mode_config
.crtc_list
, head
)
1620 group
->id_list
[group
->num_crtcs
++] = crtc
->base
.id
;
1622 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
)
1623 group
->id_list
[group
->num_crtcs
+ group
->num_encoders
++] =
1626 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
)
1627 group
->id_list
[group
->num_crtcs
+ group
->num_encoders
+
1628 group
->num_connectors
++] = connector
->base
.id
;
1630 list_for_each_entry(bridge
, &dev
->mode_config
.bridge_list
, head
)
1631 group
->id_list
[group
->num_crtcs
+ group
->num_encoders
+
1632 group
->num_connectors
+ group
->num_bridges
++] =
1637 EXPORT_SYMBOL(drm_mode_group_init_legacy_group
);
1639 void drm_reinit_primary_mode_group(struct drm_device
*dev
)
1641 drm_modeset_lock_all(dev
);
1642 drm_mode_group_destroy(&dev
->primary
->mode_group
);
1643 drm_mode_group_init_legacy_group(dev
, &dev
->primary
->mode_group
);
1644 drm_modeset_unlock_all(dev
);
1646 EXPORT_SYMBOL(drm_reinit_primary_mode_group
);
1649 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1650 * @out: drm_mode_modeinfo struct to return to the user
1651 * @in: drm_display_mode to use
1653 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1656 static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo
*out
,
1657 const struct drm_display_mode
*in
)
1659 WARN(in
->hdisplay
> USHRT_MAX
|| in
->hsync_start
> USHRT_MAX
||
1660 in
->hsync_end
> USHRT_MAX
|| in
->htotal
> USHRT_MAX
||
1661 in
->hskew
> USHRT_MAX
|| in
->vdisplay
> USHRT_MAX
||
1662 in
->vsync_start
> USHRT_MAX
|| in
->vsync_end
> USHRT_MAX
||
1663 in
->vtotal
> USHRT_MAX
|| in
->vscan
> USHRT_MAX
,
1664 "timing values too large for mode info\n");
1666 out
->clock
= in
->clock
;
1667 out
->hdisplay
= in
->hdisplay
;
1668 out
->hsync_start
= in
->hsync_start
;
1669 out
->hsync_end
= in
->hsync_end
;
1670 out
->htotal
= in
->htotal
;
1671 out
->hskew
= in
->hskew
;
1672 out
->vdisplay
= in
->vdisplay
;
1673 out
->vsync_start
= in
->vsync_start
;
1674 out
->vsync_end
= in
->vsync_end
;
1675 out
->vtotal
= in
->vtotal
;
1676 out
->vscan
= in
->vscan
;
1677 out
->vrefresh
= in
->vrefresh
;
1678 out
->flags
= in
->flags
;
1679 out
->type
= in
->type
;
1680 strncpy(out
->name
, in
->name
, DRM_DISPLAY_MODE_LEN
);
1681 out
->name
[DRM_DISPLAY_MODE_LEN
-1] = 0;
1685 * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1686 * @out: drm_display_mode to return to the user
1687 * @in: drm_mode_modeinfo to use
1689 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1693 * Zero on success, negative errno on failure.
1695 static int drm_crtc_convert_umode(struct drm_display_mode
*out
,
1696 const struct drm_mode_modeinfo
*in
)
1698 if (in
->clock
> INT_MAX
|| in
->vrefresh
> INT_MAX
)
1701 if ((in
->flags
& DRM_MODE_FLAG_3D_MASK
) > DRM_MODE_FLAG_3D_MAX
)
1704 out
->clock
= in
->clock
;
1705 out
->hdisplay
= in
->hdisplay
;
1706 out
->hsync_start
= in
->hsync_start
;
1707 out
->hsync_end
= in
->hsync_end
;
1708 out
->htotal
= in
->htotal
;
1709 out
->hskew
= in
->hskew
;
1710 out
->vdisplay
= in
->vdisplay
;
1711 out
->vsync_start
= in
->vsync_start
;
1712 out
->vsync_end
= in
->vsync_end
;
1713 out
->vtotal
= in
->vtotal
;
1714 out
->vscan
= in
->vscan
;
1715 out
->vrefresh
= in
->vrefresh
;
1716 out
->flags
= in
->flags
;
1717 out
->type
= in
->type
;
1718 strncpy(out
->name
, in
->name
, DRM_DISPLAY_MODE_LEN
);
1719 out
->name
[DRM_DISPLAY_MODE_LEN
-1] = 0;
1725 * drm_mode_getresources - get graphics configuration
1726 * @dev: drm device for the ioctl
1727 * @data: data pointer for the ioctl
1728 * @file_priv: drm file for the ioctl call
1730 * Construct a set of configuration description structures and return
1731 * them to the user, including CRTC, connector and framebuffer configuration.
1733 * Called by the user via ioctl.
1736 * Zero on success, negative errno on failure.
1738 int drm_mode_getresources(struct drm_device
*dev
, void *data
,
1739 struct drm_file
*file_priv
)
1741 struct drm_mode_card_res
*card_res
= data
;
1742 struct list_head
*lh
;
1743 struct drm_framebuffer
*fb
;
1744 struct drm_connector
*connector
;
1745 struct drm_crtc
*crtc
;
1746 struct drm_encoder
*encoder
;
1748 int connector_count
= 0;
1751 int encoder_count
= 0;
1753 uint32_t __user
*fb_id
;
1754 uint32_t __user
*crtc_id
;
1755 uint32_t __user
*connector_id
;
1756 uint32_t __user
*encoder_id
;
1757 struct drm_mode_group
*mode_group
;
1759 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
1763 mutex_lock(&file_priv
->fbs_lock
);
1765 * For the non-control nodes we need to limit the list of resources
1766 * by IDs in the group list for this node
1768 list_for_each(lh
, &file_priv
->fbs
)
1771 /* handle this in 4 parts */
1773 if (card_res
->count_fbs
>= fb_count
) {
1775 fb_id
= (uint32_t __user
*)(unsigned long)card_res
->fb_id_ptr
;
1776 list_for_each_entry(fb
, &file_priv
->fbs
, filp_head
) {
1777 if (put_user(fb
->base
.id
, fb_id
+ copied
)) {
1778 mutex_unlock(&file_priv
->fbs_lock
);
1784 card_res
->count_fbs
= fb_count
;
1785 mutex_unlock(&file_priv
->fbs_lock
);
1787 /* mode_config.mutex protects the connector list against e.g. DP MST
1788 * connector hot-adding. CRTC/Plane lists are invariant. */
1789 mutex_lock(&dev
->mode_config
.mutex
);
1790 if (!drm_is_primary_client(file_priv
)) {
1793 list_for_each(lh
, &dev
->mode_config
.crtc_list
)
1796 list_for_each(lh
, &dev
->mode_config
.connector_list
)
1799 list_for_each(lh
, &dev
->mode_config
.encoder_list
)
1803 mode_group
= &file_priv
->master
->minor
->mode_group
;
1804 crtc_count
= mode_group
->num_crtcs
;
1805 connector_count
= mode_group
->num_connectors
;
1806 encoder_count
= mode_group
->num_encoders
;
1809 card_res
->max_height
= dev
->mode_config
.max_height
;
1810 card_res
->min_height
= dev
->mode_config
.min_height
;
1811 card_res
->max_width
= dev
->mode_config
.max_width
;
1812 card_res
->min_width
= dev
->mode_config
.min_width
;
1815 if (card_res
->count_crtcs
>= crtc_count
) {
1817 crtc_id
= (uint32_t __user
*)(unsigned long)card_res
->crtc_id_ptr
;
1819 list_for_each_entry(crtc
, &dev
->mode_config
.crtc_list
,
1821 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc
->base
.id
);
1822 if (put_user(crtc
->base
.id
, crtc_id
+ copied
)) {
1829 for (i
= 0; i
< mode_group
->num_crtcs
; i
++) {
1830 if (put_user(mode_group
->id_list
[i
],
1831 crtc_id
+ copied
)) {
1839 card_res
->count_crtcs
= crtc_count
;
1842 if (card_res
->count_encoders
>= encoder_count
) {
1844 encoder_id
= (uint32_t __user
*)(unsigned long)card_res
->encoder_id_ptr
;
1846 list_for_each_entry(encoder
,
1847 &dev
->mode_config
.encoder_list
,
1849 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder
->base
.id
,
1851 if (put_user(encoder
->base
.id
, encoder_id
+
1859 for (i
= mode_group
->num_crtcs
; i
< mode_group
->num_crtcs
+ mode_group
->num_encoders
; i
++) {
1860 if (put_user(mode_group
->id_list
[i
],
1861 encoder_id
+ copied
)) {
1870 card_res
->count_encoders
= encoder_count
;
1873 if (card_res
->count_connectors
>= connector_count
) {
1875 connector_id
= (uint32_t __user
*)(unsigned long)card_res
->connector_id_ptr
;
1877 list_for_each_entry(connector
,
1878 &dev
->mode_config
.connector_list
,
1880 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1883 if (put_user(connector
->base
.id
,
1884 connector_id
+ copied
)) {
1891 int start
= mode_group
->num_crtcs
+
1892 mode_group
->num_encoders
;
1893 for (i
= start
; i
< start
+ mode_group
->num_connectors
; i
++) {
1894 if (put_user(mode_group
->id_list
[i
],
1895 connector_id
+ copied
)) {
1903 card_res
->count_connectors
= connector_count
;
1905 DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res
->count_crtcs
,
1906 card_res
->count_connectors
, card_res
->count_encoders
);
1909 mutex_unlock(&dev
->mode_config
.mutex
);
1914 * drm_mode_getcrtc - get CRTC configuration
1915 * @dev: drm device for the ioctl
1916 * @data: data pointer for the ioctl
1917 * @file_priv: drm file for the ioctl call
1919 * Construct a CRTC configuration structure to return to the user.
1921 * Called by the user via ioctl.
1924 * Zero on success, negative errno on failure.
1926 int drm_mode_getcrtc(struct drm_device
*dev
,
1927 void *data
, struct drm_file
*file_priv
)
1929 struct drm_mode_crtc
*crtc_resp
= data
;
1930 struct drm_crtc
*crtc
;
1932 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
1935 crtc
= drm_crtc_find(dev
, crtc_resp
->crtc_id
);
1939 drm_modeset_lock_crtc(crtc
, crtc
->primary
);
1940 crtc_resp
->x
= crtc
->x
;
1941 crtc_resp
->y
= crtc
->y
;
1942 crtc_resp
->gamma_size
= crtc
->gamma_size
;
1943 if (crtc
->primary
->fb
)
1944 crtc_resp
->fb_id
= crtc
->primary
->fb
->base
.id
;
1946 crtc_resp
->fb_id
= 0;
1948 if (crtc
->enabled
) {
1950 drm_crtc_convert_to_umode(&crtc_resp
->mode
, &crtc
->mode
);
1951 crtc_resp
->mode_valid
= 1;
1954 crtc_resp
->mode_valid
= 0;
1956 drm_modeset_unlock_crtc(crtc
);
1961 static bool drm_mode_expose_to_userspace(const struct drm_display_mode
*mode
,
1962 const struct drm_file
*file_priv
)
1965 * If user-space hasn't configured the driver to expose the stereo 3D
1966 * modes, don't expose them.
1968 if (!file_priv
->stereo_allowed
&& drm_mode_is_stereo(mode
))
1974 static struct drm_encoder
*drm_connector_get_encoder(struct drm_connector
*connector
)
1976 /* For atomic drivers only state objects are synchronously updated and
1977 * protected by modeset locks, so check those first. */
1978 if (connector
->state
)
1979 return connector
->state
->best_encoder
;
1980 return connector
->encoder
;
1984 * drm_mode_getconnector - get connector configuration
1985 * @dev: drm device for the ioctl
1986 * @data: data pointer for the ioctl
1987 * @file_priv: drm file for the ioctl call
1989 * Construct a connector configuration structure to return to the user.
1991 * Called by the user via ioctl.
1994 * Zero on success, negative errno on failure.
1996 int drm_mode_getconnector(struct drm_device
*dev
, void *data
,
1997 struct drm_file
*file_priv
)
1999 struct drm_mode_get_connector
*out_resp
= data
;
2000 struct drm_connector
*connector
;
2001 struct drm_encoder
*encoder
;
2002 struct drm_display_mode
*mode
;
2004 int props_count
= 0;
2005 int encoders_count
= 0;
2009 struct drm_mode_modeinfo u_mode
;
2010 struct drm_mode_modeinfo __user
*mode_ptr
;
2011 uint32_t __user
*prop_ptr
;
2012 uint64_t __user
*prop_values
;
2013 uint32_t __user
*encoder_ptr
;
2015 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
2018 memset(&u_mode
, 0, sizeof(struct drm_mode_modeinfo
));
2020 DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp
->connector_id
);
2022 mutex_lock(&dev
->mode_config
.mutex
);
2024 connector
= drm_connector_find(dev
, out_resp
->connector_id
);
2030 props_count
= connector
->properties
.count
;
2032 for (i
= 0; i
< DRM_CONNECTOR_MAX_ENCODER
; i
++) {
2033 if (connector
->encoder_ids
[i
] != 0) {
2038 if (out_resp
->count_modes
== 0) {
2039 connector
->funcs
->fill_modes(connector
,
2040 dev
->mode_config
.max_width
,
2041 dev
->mode_config
.max_height
);
2044 /* delayed so we get modes regardless of pre-fill_modes state */
2045 list_for_each_entry(mode
, &connector
->modes
, head
)
2046 if (drm_mode_expose_to_userspace(mode
, file_priv
))
2049 out_resp
->connector_id
= connector
->base
.id
;
2050 out_resp
->connector_type
= connector
->connector_type
;
2051 out_resp
->connector_type_id
= connector
->connector_type_id
;
2052 out_resp
->mm_width
= connector
->display_info
.width_mm
;
2053 out_resp
->mm_height
= connector
->display_info
.height_mm
;
2054 out_resp
->subpixel
= connector
->display_info
.subpixel_order
;
2055 out_resp
->connection
= connector
->status
;
2056 drm_modeset_lock(&dev
->mode_config
.connection_mutex
, NULL
);
2058 encoder
= drm_connector_get_encoder(connector
);
2060 out_resp
->encoder_id
= encoder
->base
.id
;
2062 out_resp
->encoder_id
= 0;
2063 drm_modeset_unlock(&dev
->mode_config
.connection_mutex
);
2066 * This ioctl is called twice, once to determine how much space is
2067 * needed, and the 2nd time to fill it.
2069 if ((out_resp
->count_modes
>= mode_count
) && mode_count
) {
2071 mode_ptr
= (struct drm_mode_modeinfo __user
*)(unsigned long)out_resp
->modes_ptr
;
2072 list_for_each_entry(mode
, &connector
->modes
, head
) {
2073 if (!drm_mode_expose_to_userspace(mode
, file_priv
))
2076 drm_crtc_convert_to_umode(&u_mode
, mode
);
2077 if (copy_to_user(mode_ptr
+ copied
,
2078 &u_mode
, sizeof(u_mode
))) {
2085 out_resp
->count_modes
= mode_count
;
2087 if ((out_resp
->count_props
>= props_count
) && props_count
) {
2089 prop_ptr
= (uint32_t __user
*)(unsigned long)(out_resp
->props_ptr
);
2090 prop_values
= (uint64_t __user
*)(unsigned long)(out_resp
->prop_values_ptr
);
2091 for (i
= 0; i
< connector
->properties
.count
; i
++) {
2092 if (put_user(connector
->properties
.ids
[i
],
2093 prop_ptr
+ copied
)) {
2098 if (put_user(connector
->properties
.values
[i
],
2099 prop_values
+ copied
)) {
2106 out_resp
->count_props
= props_count
;
2108 if ((out_resp
->count_encoders
>= encoders_count
) && encoders_count
) {
2110 encoder_ptr
= (uint32_t __user
*)(unsigned long)(out_resp
->encoders_ptr
);
2111 for (i
= 0; i
< DRM_CONNECTOR_MAX_ENCODER
; i
++) {
2112 if (connector
->encoder_ids
[i
] != 0) {
2113 if (put_user(connector
->encoder_ids
[i
],
2114 encoder_ptr
+ copied
)) {
2122 out_resp
->count_encoders
= encoders_count
;
2125 mutex_unlock(&dev
->mode_config
.mutex
);
2130 static struct drm_crtc
*drm_encoder_get_crtc(struct drm_encoder
*encoder
)
2132 struct drm_connector
*connector
;
2133 struct drm_device
*dev
= encoder
->dev
;
2134 bool uses_atomic
= false;
2136 /* For atomic drivers only state objects are synchronously updated and
2137 * protected by modeset locks, so check those first. */
2138 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
) {
2139 if (!connector
->state
)
2144 if (connector
->state
->best_encoder
!= encoder
)
2147 return connector
->state
->crtc
;
2150 /* Don't return stale data (e.g. pending async disable). */
2154 return encoder
->crtc
;
2158 * drm_mode_getencoder - get encoder configuration
2159 * @dev: drm device for the ioctl
2160 * @data: data pointer for the ioctl
2161 * @file_priv: drm file for the ioctl call
2163 * Construct a encoder configuration structure to return to the user.
2165 * Called by the user via ioctl.
2168 * Zero on success, negative errno on failure.
2170 int drm_mode_getencoder(struct drm_device
*dev
, void *data
,
2171 struct drm_file
*file_priv
)
2173 struct drm_mode_get_encoder
*enc_resp
= data
;
2174 struct drm_encoder
*encoder
;
2175 struct drm_crtc
*crtc
;
2177 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
2180 encoder
= drm_encoder_find(dev
, enc_resp
->encoder_id
);
2184 drm_modeset_lock(&dev
->mode_config
.connection_mutex
, NULL
);
2185 crtc
= drm_encoder_get_crtc(encoder
);
2187 enc_resp
->crtc_id
= crtc
->base
.id
;
2188 else if (encoder
->crtc
)
2189 enc_resp
->crtc_id
= encoder
->crtc
->base
.id
;
2191 enc_resp
->crtc_id
= 0;
2192 drm_modeset_unlock(&dev
->mode_config
.connection_mutex
);
2194 enc_resp
->encoder_type
= encoder
->encoder_type
;
2195 enc_resp
->encoder_id
= encoder
->base
.id
;
2196 enc_resp
->possible_crtcs
= encoder
->possible_crtcs
;
2197 enc_resp
->possible_clones
= encoder
->possible_clones
;
2203 * drm_mode_getplane_res - enumerate all plane resources
2206 * @file_priv: DRM file info
2208 * Construct a list of plane ids to return to the user.
2210 * Called by the user via ioctl.
2213 * Zero on success, negative errno on failure.
2215 int drm_mode_getplane_res(struct drm_device
*dev
, void *data
,
2216 struct drm_file
*file_priv
)
2218 struct drm_mode_get_plane_res
*plane_resp
= data
;
2219 struct drm_mode_config
*config
;
2220 struct drm_plane
*plane
;
2221 uint32_t __user
*plane_ptr
;
2223 unsigned num_planes
;
2225 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
2228 config
= &dev
->mode_config
;
2230 if (file_priv
->universal_planes
)
2231 num_planes
= config
->num_total_plane
;
2233 num_planes
= config
->num_overlay_plane
;
2236 * This ioctl is called twice, once to determine how much space is
2237 * needed, and the 2nd time to fill it.
2240 (plane_resp
->count_planes
>= num_planes
)) {
2241 plane_ptr
= (uint32_t __user
*)(unsigned long)plane_resp
->plane_id_ptr
;
2243 /* Plane lists are invariant, no locking needed. */
2244 list_for_each_entry(plane
, &config
->plane_list
, head
) {
2246 * Unless userspace set the 'universal planes'
2247 * capability bit, only advertise overlays.
2249 if (plane
->type
!= DRM_PLANE_TYPE_OVERLAY
&&
2250 !file_priv
->universal_planes
)
2253 if (put_user(plane
->base
.id
, plane_ptr
+ copied
))
2258 plane_resp
->count_planes
= num_planes
;
2264 * drm_mode_getplane - get plane configuration
2267 * @file_priv: DRM file info
2269 * Construct a plane configuration structure to return to the user.
2271 * Called by the user via ioctl.
2274 * Zero on success, negative errno on failure.
2276 int drm_mode_getplane(struct drm_device
*dev
, void *data
,
2277 struct drm_file
*file_priv
)
2279 struct drm_mode_get_plane
*plane_resp
= data
;
2280 struct drm_plane
*plane
;
2281 uint32_t __user
*format_ptr
;
2283 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
2286 plane
= drm_plane_find(dev
, plane_resp
->plane_id
);
2290 drm_modeset_lock(&plane
->mutex
, NULL
);
2292 plane_resp
->crtc_id
= plane
->crtc
->base
.id
;
2294 plane_resp
->crtc_id
= 0;
2297 plane_resp
->fb_id
= plane
->fb
->base
.id
;
2299 plane_resp
->fb_id
= 0;
2300 drm_modeset_unlock(&plane
->mutex
);
2302 plane_resp
->plane_id
= plane
->base
.id
;
2303 plane_resp
->possible_crtcs
= plane
->possible_crtcs
;
2304 plane_resp
->gamma_size
= 0;
2307 * This ioctl is called twice, once to determine how much space is
2308 * needed, and the 2nd time to fill it.
2310 if (plane
->format_count
&&
2311 (plane_resp
->count_format_types
>= plane
->format_count
)) {
2312 format_ptr
= (uint32_t __user
*)(unsigned long)plane_resp
->format_type_ptr
;
2313 if (copy_to_user(format_ptr
,
2314 plane
->format_types
,
2315 sizeof(uint32_t) * plane
->format_count
)) {
2319 plane_resp
->count_format_types
= plane
->format_count
;
2325 * setplane_internal - setplane handler for internal callers
2327 * Note that we assume an extra reference has already been taken on fb. If the
2328 * update fails, this reference will be dropped before return; if it succeeds,
2329 * the previous framebuffer (if any) will be unreferenced instead.
2331 * src_{x,y,w,h} are provided in 16.16 fixed point format
2333 static int __setplane_internal(struct drm_plane
*plane
,
2334 struct drm_crtc
*crtc
,
2335 struct drm_framebuffer
*fb
,
2336 int32_t crtc_x
, int32_t crtc_y
,
2337 uint32_t crtc_w
, uint32_t crtc_h
,
2338 /* src_{x,y,w,h} values are 16.16 fixed point */
2339 uint32_t src_x
, uint32_t src_y
,
2340 uint32_t src_w
, uint32_t src_h
)
2343 unsigned int fb_width
, fb_height
;
2346 /* No fb means shut it down */
2348 plane
->old_fb
= plane
->fb
;
2349 ret
= plane
->funcs
->disable_plane(plane
);
2354 plane
->old_fb
= NULL
;
2359 /* Check whether this plane is usable on this CRTC */
2360 if (!(plane
->possible_crtcs
& drm_crtc_mask(crtc
))) {
2361 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2366 /* Check whether this plane supports the fb pixel format. */
2367 for (i
= 0; i
< plane
->format_count
; i
++)
2368 if (fb
->pixel_format
== plane
->format_types
[i
])
2370 if (i
== plane
->format_count
) {
2371 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2372 drm_get_format_name(fb
->pixel_format
));
2377 fb_width
= fb
->width
<< 16;
2378 fb_height
= fb
->height
<< 16;
2380 /* Make sure source coordinates are inside the fb. */
2381 if (src_w
> fb_width
||
2382 src_x
> fb_width
- src_w
||
2383 src_h
> fb_height
||
2384 src_y
> fb_height
- src_h
) {
2385 DRM_DEBUG_KMS("Invalid source coordinates "
2386 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2387 src_w
>> 16, ((src_w
& 0xffff) * 15625) >> 10,
2388 src_h
>> 16, ((src_h
& 0xffff) * 15625) >> 10,
2389 src_x
>> 16, ((src_x
& 0xffff) * 15625) >> 10,
2390 src_y
>> 16, ((src_y
& 0xffff) * 15625) >> 10);
2395 plane
->old_fb
= plane
->fb
;
2396 ret
= plane
->funcs
->update_plane(plane
, crtc
, fb
,
2397 crtc_x
, crtc_y
, crtc_w
, crtc_h
,
2398 src_x
, src_y
, src_w
, src_h
);
2404 plane
->old_fb
= NULL
;
2409 drm_framebuffer_unreference(fb
);
2411 drm_framebuffer_unreference(plane
->old_fb
);
2412 plane
->old_fb
= NULL
;
2417 static int setplane_internal(struct drm_plane
*plane
,
2418 struct drm_crtc
*crtc
,
2419 struct drm_framebuffer
*fb
,
2420 int32_t crtc_x
, int32_t crtc_y
,
2421 uint32_t crtc_w
, uint32_t crtc_h
,
2422 /* src_{x,y,w,h} values are 16.16 fixed point */
2423 uint32_t src_x
, uint32_t src_y
,
2424 uint32_t src_w
, uint32_t src_h
)
2428 drm_modeset_lock_all(plane
->dev
);
2429 ret
= __setplane_internal(plane
, crtc
, fb
,
2430 crtc_x
, crtc_y
, crtc_w
, crtc_h
,
2431 src_x
, src_y
, src_w
, src_h
);
2432 drm_modeset_unlock_all(plane
->dev
);
2438 * drm_mode_setplane - configure a plane's configuration
2440 * @data: ioctl data*
2441 * @file_priv: DRM file info
2443 * Set plane configuration, including placement, fb, scaling, and other factors.
2444 * Or pass a NULL fb to disable (planes may be disabled without providing a
2448 * Zero on success, negative errno on failure.
2450 int drm_mode_setplane(struct drm_device
*dev
, void *data
,
2451 struct drm_file
*file_priv
)
2453 struct drm_mode_set_plane
*plane_req
= data
;
2454 struct drm_plane
*plane
;
2455 struct drm_crtc
*crtc
= NULL
;
2456 struct drm_framebuffer
*fb
= NULL
;
2458 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
2461 /* Give drivers some help against integer overflows */
2462 if (plane_req
->crtc_w
> INT_MAX
||
2463 plane_req
->crtc_x
> INT_MAX
- (int32_t) plane_req
->crtc_w
||
2464 plane_req
->crtc_h
> INT_MAX
||
2465 plane_req
->crtc_y
> INT_MAX
- (int32_t) plane_req
->crtc_h
) {
2466 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2467 plane_req
->crtc_w
, plane_req
->crtc_h
,
2468 plane_req
->crtc_x
, plane_req
->crtc_y
);
2473 * First, find the plane, crtc, and fb objects. If not available,
2474 * we don't bother to call the driver.
2476 plane
= drm_plane_find(dev
, plane_req
->plane_id
);
2478 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2479 plane_req
->plane_id
);
2483 if (plane_req
->fb_id
) {
2484 fb
= drm_framebuffer_lookup(dev
, plane_req
->fb_id
);
2486 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2491 crtc
= drm_crtc_find(dev
, plane_req
->crtc_id
);
2493 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2494 plane_req
->crtc_id
);
2500 * setplane_internal will take care of deref'ing either the old or new
2501 * framebuffer depending on success.
2503 return setplane_internal(plane
, crtc
, fb
,
2504 plane_req
->crtc_x
, plane_req
->crtc_y
,
2505 plane_req
->crtc_w
, plane_req
->crtc_h
,
2506 plane_req
->src_x
, plane_req
->src_y
,
2507 plane_req
->src_w
, plane_req
->src_h
);
2511 * drm_mode_set_config_internal - helper to call ->set_config
2512 * @set: modeset config to set
2514 * This is a little helper to wrap internal calls to the ->set_config driver
2515 * interface. The only thing it adds is correct refcounting dance.
2518 * Zero on success, negative errno on failure.
2520 int drm_mode_set_config_internal(struct drm_mode_set
*set
)
2522 struct drm_crtc
*crtc
= set
->crtc
;
2523 struct drm_framebuffer
*fb
;
2524 struct drm_crtc
*tmp
;
2528 * NOTE: ->set_config can also disable other crtcs (if we steal all
2529 * connectors from it), hence we need to refcount the fbs across all
2530 * crtcs. Atomic modeset will have saner semantics ...
2532 list_for_each_entry(tmp
, &crtc
->dev
->mode_config
.crtc_list
, head
)
2533 tmp
->primary
->old_fb
= tmp
->primary
->fb
;
2537 ret
= crtc
->funcs
->set_config(set
);
2539 crtc
->primary
->crtc
= crtc
;
2540 crtc
->primary
->fb
= fb
;
2543 list_for_each_entry(tmp
, &crtc
->dev
->mode_config
.crtc_list
, head
) {
2544 if (tmp
->primary
->fb
)
2545 drm_framebuffer_reference(tmp
->primary
->fb
);
2546 if (tmp
->primary
->old_fb
)
2547 drm_framebuffer_unreference(tmp
->primary
->old_fb
);
2548 tmp
->primary
->old_fb
= NULL
;
2553 EXPORT_SYMBOL(drm_mode_set_config_internal
);
2556 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2558 * @crtc: CRTC that framebuffer will be displayed on
2561 * @mode: mode that framebuffer will be displayed under
2562 * @fb: framebuffer to check size of
2564 int drm_crtc_check_viewport(const struct drm_crtc
*crtc
,
2566 const struct drm_display_mode
*mode
,
2567 const struct drm_framebuffer
*fb
)
2570 int hdisplay
, vdisplay
;
2572 hdisplay
= mode
->hdisplay
;
2573 vdisplay
= mode
->vdisplay
;
2575 if (drm_mode_is_stereo(mode
)) {
2576 struct drm_display_mode adjusted
= *mode
;
2578 drm_mode_set_crtcinfo(&adjusted
, CRTC_STEREO_DOUBLE
);
2579 hdisplay
= adjusted
.crtc_hdisplay
;
2580 vdisplay
= adjusted
.crtc_vdisplay
;
2583 if (crtc
->invert_dimensions
)
2584 swap(hdisplay
, vdisplay
);
2586 if (hdisplay
> fb
->width
||
2587 vdisplay
> fb
->height
||
2588 x
> fb
->width
- hdisplay
||
2589 y
> fb
->height
- vdisplay
) {
2590 DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2591 fb
->width
, fb
->height
, hdisplay
, vdisplay
, x
, y
,
2592 crtc
->invert_dimensions
? " (inverted)" : "");
2598 EXPORT_SYMBOL(drm_crtc_check_viewport
);
2601 * drm_mode_setcrtc - set CRTC configuration
2602 * @dev: drm device for the ioctl
2603 * @data: data pointer for the ioctl
2604 * @file_priv: drm file for the ioctl call
2606 * Build a new CRTC configuration based on user request.
2608 * Called by the user via ioctl.
2611 * Zero on success, negative errno on failure.
2613 int drm_mode_setcrtc(struct drm_device
*dev
, void *data
,
2614 struct drm_file
*file_priv
)
2616 struct drm_mode_config
*config
= &dev
->mode_config
;
2617 struct drm_mode_crtc
*crtc_req
= data
;
2618 struct drm_crtc
*crtc
;
2619 struct drm_connector
**connector_set
= NULL
, *connector
;
2620 struct drm_framebuffer
*fb
= NULL
;
2621 struct drm_display_mode
*mode
= NULL
;
2622 struct drm_mode_set set
;
2623 uint32_t __user
*set_connectors_ptr
;
2627 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
2630 /* For some reason crtc x/y offsets are signed internally. */
2631 if (crtc_req
->x
> INT_MAX
|| crtc_req
->y
> INT_MAX
)
2634 drm_modeset_lock_all(dev
);
2635 crtc
= drm_crtc_find(dev
, crtc_req
->crtc_id
);
2637 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req
->crtc_id
);
2641 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc
->base
.id
);
2643 if (crtc_req
->mode_valid
) {
2644 /* If we have a mode we need a framebuffer. */
2645 /* If we pass -1, set the mode with the currently bound fb */
2646 if (crtc_req
->fb_id
== -1) {
2647 if (!crtc
->primary
->fb
) {
2648 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2652 fb
= crtc
->primary
->fb
;
2653 /* Make refcounting symmetric with the lookup path. */
2654 drm_framebuffer_reference(fb
);
2656 fb
= drm_framebuffer_lookup(dev
, crtc_req
->fb_id
);
2658 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2665 mode
= drm_mode_create(dev
);
2671 ret
= drm_crtc_convert_umode(mode
, &crtc_req
->mode
);
2673 DRM_DEBUG_KMS("Invalid mode\n");
2677 drm_mode_set_crtcinfo(mode
, CRTC_INTERLACE_HALVE_V
);
2679 ret
= drm_crtc_check_viewport(crtc
, crtc_req
->x
, crtc_req
->y
,
2686 if (crtc_req
->count_connectors
== 0 && mode
) {
2687 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2692 if (crtc_req
->count_connectors
> 0 && (!mode
|| !fb
)) {
2693 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2694 crtc_req
->count_connectors
);
2699 if (crtc_req
->count_connectors
> 0) {
2702 /* Avoid unbounded kernel memory allocation */
2703 if (crtc_req
->count_connectors
> config
->num_connector
) {
2708 connector_set
= kmalloc_array(crtc_req
->count_connectors
,
2709 sizeof(struct drm_connector
*),
2711 if (!connector_set
) {
2716 for (i
= 0; i
< crtc_req
->count_connectors
; i
++) {
2717 set_connectors_ptr
= (uint32_t __user
*)(unsigned long)crtc_req
->set_connectors_ptr
;
2718 if (get_user(out_id
, &set_connectors_ptr
[i
])) {
2723 connector
= drm_connector_find(dev
, out_id
);
2725 DRM_DEBUG_KMS("Connector id %d unknown\n",
2730 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2734 connector_set
[i
] = connector
;
2739 set
.x
= crtc_req
->x
;
2740 set
.y
= crtc_req
->y
;
2742 set
.connectors
= connector_set
;
2743 set
.num_connectors
= crtc_req
->count_connectors
;
2745 ret
= drm_mode_set_config_internal(&set
);
2749 drm_framebuffer_unreference(fb
);
2751 kfree(connector_set
);
2752 drm_mode_destroy(dev
, mode
);
2753 drm_modeset_unlock_all(dev
);
2758 * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2759 * universal plane handler call
2760 * @crtc: crtc to update cursor for
2761 * @req: data pointer for the ioctl
2762 * @file_priv: drm file for the ioctl call
2764 * Legacy cursor ioctl's work directly with driver buffer handles. To
2765 * translate legacy ioctl calls into universal plane handler calls, we need to
2766 * wrap the native buffer handle in a drm_framebuffer.
2768 * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2769 * buffer with a pitch of 4*width; the universal plane interface should be used
2770 * directly in cases where the hardware can support other buffer settings and
2771 * userspace wants to make use of these capabilities.
2774 * Zero on success, negative errno on failure.
2776 static int drm_mode_cursor_universal(struct drm_crtc
*crtc
,
2777 struct drm_mode_cursor2
*req
,
2778 struct drm_file
*file_priv
)
2780 struct drm_device
*dev
= crtc
->dev
;
2781 struct drm_framebuffer
*fb
= NULL
;
2782 struct drm_mode_fb_cmd2 fbreq
= {
2783 .width
= req
->width
,
2784 .height
= req
->height
,
2785 .pixel_format
= DRM_FORMAT_ARGB8888
,
2786 .pitches
= { req
->width
* 4 },
2787 .handles
= { req
->handle
},
2789 int32_t crtc_x
, crtc_y
;
2790 uint32_t crtc_w
= 0, crtc_h
= 0;
2791 uint32_t src_w
= 0, src_h
= 0;
2794 BUG_ON(!crtc
->cursor
);
2795 WARN_ON(crtc
->cursor
->crtc
!= crtc
&& crtc
->cursor
->crtc
!= NULL
);
2798 * Obtain fb we'll be using (either new or existing) and take an extra
2799 * reference to it if fb != null. setplane will take care of dropping
2800 * the reference if the plane update fails.
2802 if (req
->flags
& DRM_MODE_CURSOR_BO
) {
2804 fb
= add_framebuffer_internal(dev
, &fbreq
, file_priv
);
2806 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2810 drm_framebuffer_reference(fb
);
2815 fb
= crtc
->cursor
->fb
;
2817 drm_framebuffer_reference(fb
);
2820 if (req
->flags
& DRM_MODE_CURSOR_MOVE
) {
2824 crtc_x
= crtc
->cursor_x
;
2825 crtc_y
= crtc
->cursor_y
;
2830 crtc_h
= fb
->height
;
2831 src_w
= fb
->width
<< 16;
2832 src_h
= fb
->height
<< 16;
2836 * setplane_internal will take care of deref'ing either the old or new
2837 * framebuffer depending on success.
2839 ret
= __setplane_internal(crtc
->cursor
, crtc
, fb
,
2840 crtc_x
, crtc_y
, crtc_w
, crtc_h
,
2841 0, 0, src_w
, src_h
);
2843 /* Update successful; save new cursor position, if necessary */
2844 if (ret
== 0 && req
->flags
& DRM_MODE_CURSOR_MOVE
) {
2845 crtc
->cursor_x
= req
->x
;
2846 crtc
->cursor_y
= req
->y
;
2852 static int drm_mode_cursor_common(struct drm_device
*dev
,
2853 struct drm_mode_cursor2
*req
,
2854 struct drm_file
*file_priv
)
2856 struct drm_crtc
*crtc
;
2859 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
2862 if (!req
->flags
|| (~DRM_MODE_CURSOR_FLAGS
& req
->flags
))
2865 crtc
= drm_crtc_find(dev
, req
->crtc_id
);
2867 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req
->crtc_id
);
2872 * If this crtc has a universal cursor plane, call that plane's update
2873 * handler rather than using legacy cursor handlers.
2875 drm_modeset_lock_crtc(crtc
, crtc
->cursor
);
2877 ret
= drm_mode_cursor_universal(crtc
, req
, file_priv
);
2881 if (req
->flags
& DRM_MODE_CURSOR_BO
) {
2882 if (!crtc
->funcs
->cursor_set
&& !crtc
->funcs
->cursor_set2
) {
2886 /* Turns off the cursor if handle is 0 */
2887 if (crtc
->funcs
->cursor_set2
)
2888 ret
= crtc
->funcs
->cursor_set2(crtc
, file_priv
, req
->handle
,
2889 req
->width
, req
->height
, req
->hot_x
, req
->hot_y
);
2891 ret
= crtc
->funcs
->cursor_set(crtc
, file_priv
, req
->handle
,
2892 req
->width
, req
->height
);
2895 if (req
->flags
& DRM_MODE_CURSOR_MOVE
) {
2896 if (crtc
->funcs
->cursor_move
) {
2897 ret
= crtc
->funcs
->cursor_move(crtc
, req
->x
, req
->y
);
2904 drm_modeset_unlock_crtc(crtc
);
2912 * drm_mode_cursor_ioctl - set CRTC's cursor configuration
2913 * @dev: drm device for the ioctl
2914 * @data: data pointer for the ioctl
2915 * @file_priv: drm file for the ioctl call
2917 * Set the cursor configuration based on user request.
2919 * Called by the user via ioctl.
2922 * Zero on success, negative errno on failure.
2924 int drm_mode_cursor_ioctl(struct drm_device
*dev
,
2925 void *data
, struct drm_file
*file_priv
)
2927 struct drm_mode_cursor
*req
= data
;
2928 struct drm_mode_cursor2 new_req
;
2930 memcpy(&new_req
, req
, sizeof(struct drm_mode_cursor
));
2931 new_req
.hot_x
= new_req
.hot_y
= 0;
2933 return drm_mode_cursor_common(dev
, &new_req
, file_priv
);
2937 * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
2938 * @dev: drm device for the ioctl
2939 * @data: data pointer for the ioctl
2940 * @file_priv: drm file for the ioctl call
2942 * Set the cursor configuration based on user request. This implements the 2nd
2943 * version of the cursor ioctl, which allows userspace to additionally specify
2944 * the hotspot of the pointer.
2946 * Called by the user via ioctl.
2949 * Zero on success, negative errno on failure.
2951 int drm_mode_cursor2_ioctl(struct drm_device
*dev
,
2952 void *data
, struct drm_file
*file_priv
)
2954 struct drm_mode_cursor2
*req
= data
;
2956 return drm_mode_cursor_common(dev
, req
, file_priv
);
2960 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
2961 * @bpp: bits per pixels
2962 * @depth: bit depth per pixel
2964 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
2965 * Useful in fbdev emulation code, since that deals in those values.
2967 uint32_t drm_mode_legacy_fb_format(uint32_t bpp
, uint32_t depth
)
2973 fmt
= DRM_FORMAT_C8
;
2977 fmt
= DRM_FORMAT_XRGB1555
;
2979 fmt
= DRM_FORMAT_RGB565
;
2982 fmt
= DRM_FORMAT_RGB888
;
2986 fmt
= DRM_FORMAT_XRGB8888
;
2987 else if (depth
== 30)
2988 fmt
= DRM_FORMAT_XRGB2101010
;
2990 fmt
= DRM_FORMAT_ARGB8888
;
2993 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
2994 fmt
= DRM_FORMAT_XRGB8888
;
3000 EXPORT_SYMBOL(drm_mode_legacy_fb_format
);
3003 * drm_mode_addfb - add an FB to the graphics configuration
3004 * @dev: drm device for the ioctl
3005 * @data: data pointer for the ioctl
3006 * @file_priv: drm file for the ioctl call
3008 * Add a new FB to the specified CRTC, given a user request. This is the
3009 * original addfb ioctl which only supported RGB formats.
3011 * Called by the user via ioctl.
3014 * Zero on success, negative errno on failure.
3016 int drm_mode_addfb(struct drm_device
*dev
,
3017 void *data
, struct drm_file
*file_priv
)
3019 struct drm_mode_fb_cmd
*or = data
;
3020 struct drm_mode_fb_cmd2 r
= {};
3023 /* convert to new format and call new ioctl */
3024 r
.fb_id
= or->fb_id
;
3025 r
.width
= or->width
;
3026 r
.height
= or->height
;
3027 r
.pitches
[0] = or->pitch
;
3028 r
.pixel_format
= drm_mode_legacy_fb_format(or->bpp
, or->depth
);
3029 r
.handles
[0] = or->handle
;
3031 ret
= drm_mode_addfb2(dev
, &r
, file_priv
);
3035 or->fb_id
= r
.fb_id
;
3040 static int format_check(const struct drm_mode_fb_cmd2
*r
)
3042 uint32_t format
= r
->pixel_format
& ~DRM_FORMAT_BIG_ENDIAN
;
3046 case DRM_FORMAT_RGB332
:
3047 case DRM_FORMAT_BGR233
:
3048 case DRM_FORMAT_XRGB4444
:
3049 case DRM_FORMAT_XBGR4444
:
3050 case DRM_FORMAT_RGBX4444
:
3051 case DRM_FORMAT_BGRX4444
:
3052 case DRM_FORMAT_ARGB4444
:
3053 case DRM_FORMAT_ABGR4444
:
3054 case DRM_FORMAT_RGBA4444
:
3055 case DRM_FORMAT_BGRA4444
:
3056 case DRM_FORMAT_XRGB1555
:
3057 case DRM_FORMAT_XBGR1555
:
3058 case DRM_FORMAT_RGBX5551
:
3059 case DRM_FORMAT_BGRX5551
:
3060 case DRM_FORMAT_ARGB1555
:
3061 case DRM_FORMAT_ABGR1555
:
3062 case DRM_FORMAT_RGBA5551
:
3063 case DRM_FORMAT_BGRA5551
:
3064 case DRM_FORMAT_RGB565
:
3065 case DRM_FORMAT_BGR565
:
3066 case DRM_FORMAT_RGB888
:
3067 case DRM_FORMAT_BGR888
:
3068 case DRM_FORMAT_XRGB8888
:
3069 case DRM_FORMAT_XBGR8888
:
3070 case DRM_FORMAT_RGBX8888
:
3071 case DRM_FORMAT_BGRX8888
:
3072 case DRM_FORMAT_ARGB8888
:
3073 case DRM_FORMAT_ABGR8888
:
3074 case DRM_FORMAT_RGBA8888
:
3075 case DRM_FORMAT_BGRA8888
:
3076 case DRM_FORMAT_XRGB2101010
:
3077 case DRM_FORMAT_XBGR2101010
:
3078 case DRM_FORMAT_RGBX1010102
:
3079 case DRM_FORMAT_BGRX1010102
:
3080 case DRM_FORMAT_ARGB2101010
:
3081 case DRM_FORMAT_ABGR2101010
:
3082 case DRM_FORMAT_RGBA1010102
:
3083 case DRM_FORMAT_BGRA1010102
:
3084 case DRM_FORMAT_YUYV
:
3085 case DRM_FORMAT_YVYU
:
3086 case DRM_FORMAT_UYVY
:
3087 case DRM_FORMAT_VYUY
:
3088 case DRM_FORMAT_AYUV
:
3089 case DRM_FORMAT_NV12
:
3090 case DRM_FORMAT_NV21
:
3091 case DRM_FORMAT_NV16
:
3092 case DRM_FORMAT_NV61
:
3093 case DRM_FORMAT_NV24
:
3094 case DRM_FORMAT_NV42
:
3095 case DRM_FORMAT_YUV410
:
3096 case DRM_FORMAT_YVU410
:
3097 case DRM_FORMAT_YUV411
:
3098 case DRM_FORMAT_YVU411
:
3099 case DRM_FORMAT_YUV420
:
3100 case DRM_FORMAT_YVU420
:
3101 case DRM_FORMAT_YUV422
:
3102 case DRM_FORMAT_YVU422
:
3103 case DRM_FORMAT_YUV444
:
3104 case DRM_FORMAT_YVU444
:
3107 DRM_DEBUG_KMS("invalid pixel format %s\n",
3108 drm_get_format_name(r
->pixel_format
));
3113 static int framebuffer_check(const struct drm_mode_fb_cmd2
*r
)
3115 int ret
, hsub
, vsub
, num_planes
, i
;
3117 ret
= format_check(r
);
3119 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3120 drm_get_format_name(r
->pixel_format
));
3124 hsub
= drm_format_horz_chroma_subsampling(r
->pixel_format
);
3125 vsub
= drm_format_vert_chroma_subsampling(r
->pixel_format
);
3126 num_planes
= drm_format_num_planes(r
->pixel_format
);
3128 if (r
->width
== 0 || r
->width
% hsub
) {
3129 DRM_DEBUG_KMS("bad framebuffer width %u\n", r
->width
);
3133 if (r
->height
== 0 || r
->height
% vsub
) {
3134 DRM_DEBUG_KMS("bad framebuffer height %u\n", r
->height
);
3138 for (i
= 0; i
< num_planes
; i
++) {
3139 unsigned int width
= r
->width
/ (i
!= 0 ? hsub
: 1);
3140 unsigned int height
= r
->height
/ (i
!= 0 ? vsub
: 1);
3141 unsigned int cpp
= drm_format_plane_cpp(r
->pixel_format
, i
);
3143 if (!r
->handles
[i
]) {
3144 DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i
);
3148 if ((uint64_t) width
* cpp
> UINT_MAX
)
3151 if ((uint64_t) height
* r
->pitches
[i
] + r
->offsets
[i
] > UINT_MAX
)
3154 if (r
->pitches
[i
] < width
* cpp
) {
3155 DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r
->pitches
[i
], i
);
3163 static struct drm_framebuffer
*add_framebuffer_internal(struct drm_device
*dev
,
3164 struct drm_mode_fb_cmd2
*r
,
3165 struct drm_file
*file_priv
)
3167 struct drm_mode_config
*config
= &dev
->mode_config
;
3168 struct drm_framebuffer
*fb
;
3171 if (r
->flags
& ~DRM_MODE_FB_INTERLACED
) {
3172 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r
->flags
);
3173 return ERR_PTR(-EINVAL
);
3176 if ((config
->min_width
> r
->width
) || (r
->width
> config
->max_width
)) {
3177 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3178 r
->width
, config
->min_width
, config
->max_width
);
3179 return ERR_PTR(-EINVAL
);
3181 if ((config
->min_height
> r
->height
) || (r
->height
> config
->max_height
)) {
3182 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3183 r
->height
, config
->min_height
, config
->max_height
);
3184 return ERR_PTR(-EINVAL
);
3187 ret
= framebuffer_check(r
);
3189 return ERR_PTR(ret
);
3191 fb
= dev
->mode_config
.funcs
->fb_create(dev
, file_priv
, r
);
3193 DRM_DEBUG_KMS("could not create framebuffer\n");
3197 mutex_lock(&file_priv
->fbs_lock
);
3198 r
->fb_id
= fb
->base
.id
;
3199 list_add(&fb
->filp_head
, &file_priv
->fbs
);
3200 DRM_DEBUG_KMS("[FB:%d]\n", fb
->base
.id
);
3201 mutex_unlock(&file_priv
->fbs_lock
);
3207 * drm_mode_addfb2 - add an FB to the graphics configuration
3208 * @dev: drm device for the ioctl
3209 * @data: data pointer for the ioctl
3210 * @file_priv: drm file for the ioctl call
3212 * Add a new FB to the specified CRTC, given a user request with format. This is
3213 * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3214 * and uses fourcc codes as pixel format specifiers.
3216 * Called by the user via ioctl.
3219 * Zero on success, negative errno on failure.
3221 int drm_mode_addfb2(struct drm_device
*dev
,
3222 void *data
, struct drm_file
*file_priv
)
3224 struct drm_framebuffer
*fb
;
3226 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
3229 fb
= add_framebuffer_internal(dev
, data
, file_priv
);
3237 * drm_mode_rmfb - remove an FB from the configuration
3238 * @dev: drm device for the ioctl
3239 * @data: data pointer for the ioctl
3240 * @file_priv: drm file for the ioctl call
3242 * Remove the FB specified by the user.
3244 * Called by the user via ioctl.
3247 * Zero on success, negative errno on failure.
3249 int drm_mode_rmfb(struct drm_device
*dev
,
3250 void *data
, struct drm_file
*file_priv
)
3252 struct drm_framebuffer
*fb
= NULL
;
3253 struct drm_framebuffer
*fbl
= NULL
;
3254 uint32_t *id
= data
;
3257 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
3260 mutex_lock(&file_priv
->fbs_lock
);
3261 mutex_lock(&dev
->mode_config
.fb_lock
);
3262 fb
= __drm_framebuffer_lookup(dev
, *id
);
3266 list_for_each_entry(fbl
, &file_priv
->fbs
, filp_head
)
3272 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3273 __drm_framebuffer_unregister(dev
, fb
);
3275 list_del_init(&fb
->filp_head
);
3276 mutex_unlock(&dev
->mode_config
.fb_lock
);
3277 mutex_unlock(&file_priv
->fbs_lock
);
3279 drm_framebuffer_remove(fb
);
3284 mutex_unlock(&dev
->mode_config
.fb_lock
);
3285 mutex_unlock(&file_priv
->fbs_lock
);
3291 * drm_mode_getfb - get FB info
3292 * @dev: drm device for the ioctl
3293 * @data: data pointer for the ioctl
3294 * @file_priv: drm file for the ioctl call
3296 * Lookup the FB given its ID and return info about it.
3298 * Called by the user via ioctl.
3301 * Zero on success, negative errno on failure.
3303 int drm_mode_getfb(struct drm_device
*dev
,
3304 void *data
, struct drm_file
*file_priv
)
3306 struct drm_mode_fb_cmd
*r
= data
;
3307 struct drm_framebuffer
*fb
;
3310 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
3313 fb
= drm_framebuffer_lookup(dev
, r
->fb_id
);
3317 r
->height
= fb
->height
;
3318 r
->width
= fb
->width
;
3319 r
->depth
= fb
->depth
;
3320 r
->bpp
= fb
->bits_per_pixel
;
3321 r
->pitch
= fb
->pitches
[0];
3322 if (fb
->funcs
->create_handle
) {
3323 if (file_priv
->is_master
|| capable(CAP_SYS_ADMIN
) ||
3324 drm_is_control_client(file_priv
)) {
3325 ret
= fb
->funcs
->create_handle(fb
, file_priv
,
3328 /* GET_FB() is an unprivileged ioctl so we must not
3329 * return a buffer-handle to non-master processes! For
3330 * backwards-compatibility reasons, we cannot make
3331 * GET_FB() privileged, so just return an invalid handle
3332 * for non-masters. */
3340 drm_framebuffer_unreference(fb
);
3346 * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3347 * @dev: drm device for the ioctl
3348 * @data: data pointer for the ioctl
3349 * @file_priv: drm file for the ioctl call
3351 * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3352 * rectangle list. Generic userspace which does frontbuffer rendering must call
3353 * this ioctl to flush out the changes on manual-update display outputs, e.g.
3354 * usb display-link, mipi manual update panels or edp panel self refresh modes.
3356 * Modesetting drivers which always update the frontbuffer do not need to
3357 * implement the corresponding ->dirty framebuffer callback.
3359 * Called by the user via ioctl.
3362 * Zero on success, negative errno on failure.
3364 int drm_mode_dirtyfb_ioctl(struct drm_device
*dev
,
3365 void *data
, struct drm_file
*file_priv
)
3367 struct drm_clip_rect __user
*clips_ptr
;
3368 struct drm_clip_rect
*clips
= NULL
;
3369 struct drm_mode_fb_dirty_cmd
*r
= data
;
3370 struct drm_framebuffer
*fb
;
3375 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
3378 fb
= drm_framebuffer_lookup(dev
, r
->fb_id
);
3382 num_clips
= r
->num_clips
;
3383 clips_ptr
= (struct drm_clip_rect __user
*)(unsigned long)r
->clips_ptr
;
3385 if (!num_clips
!= !clips_ptr
) {
3390 flags
= DRM_MODE_FB_DIRTY_FLAGS
& r
->flags
;
3392 /* If userspace annotates copy, clips must come in pairs */
3393 if (flags
& DRM_MODE_FB_DIRTY_ANNOTATE_COPY
&& (num_clips
% 2)) {
3398 if (num_clips
&& clips_ptr
) {
3399 if (num_clips
< 0 || num_clips
> DRM_MODE_FB_DIRTY_MAX_CLIPS
) {
3403 clips
= kcalloc(num_clips
, sizeof(*clips
), GFP_KERNEL
);
3409 ret
= copy_from_user(clips
, clips_ptr
,
3410 num_clips
* sizeof(*clips
));
3417 if (fb
->funcs
->dirty
) {
3418 ret
= fb
->funcs
->dirty(fb
, file_priv
, flags
, r
->color
,
3427 drm_framebuffer_unreference(fb
);
3434 * drm_fb_release - remove and free the FBs on this file
3435 * @priv: drm file for the ioctl
3437 * Destroy all the FBs associated with @filp.
3439 * Called by the user via ioctl.
3442 * Zero on success, negative errno on failure.
3444 void drm_fb_release(struct drm_file
*priv
)
3446 struct drm_device
*dev
= priv
->minor
->dev
;
3447 struct drm_framebuffer
*fb
, *tfb
;
3450 * When the file gets released that means no one else can access the fb
3451 * list any more, so no need to grab fpriv->fbs_lock. And we need to
3452 * avoid upsetting lockdep since the universal cursor code adds a
3453 * framebuffer while holding mutex locks.
3455 * Note that a real deadlock between fpriv->fbs_lock and the modeset
3456 * locks is impossible here since no one else but this function can get
3459 list_for_each_entry_safe(fb
, tfb
, &priv
->fbs
, filp_head
) {
3461 mutex_lock(&dev
->mode_config
.fb_lock
);
3462 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3463 __drm_framebuffer_unregister(dev
, fb
);
3464 mutex_unlock(&dev
->mode_config
.fb_lock
);
3466 list_del_init(&fb
->filp_head
);
3468 /* This will also drop the fpriv->fbs reference. */
3469 drm_framebuffer_remove(fb
);
3474 * drm_property_create - create a new property type
3476 * @flags: flags specifying the property type
3477 * @name: name of the property
3478 * @num_values: number of pre-defined values
3480 * This creates a new generic drm property which can then be attached to a drm
3481 * object with drm_object_attach_property. The returned property object must be
3482 * freed with drm_property_destroy.
3484 * Note that the DRM core keeps a per-device list of properties and that, if
3485 * drm_mode_config_cleanup() is called, it will destroy all properties created
3489 * A pointer to the newly created property on success, NULL on failure.
3491 struct drm_property
*drm_property_create(struct drm_device
*dev
, int flags
,
3492 const char *name
, int num_values
)
3494 struct drm_property
*property
= NULL
;
3497 property
= kzalloc(sizeof(struct drm_property
), GFP_KERNEL
);
3501 property
->dev
= dev
;
3504 property
->values
= kcalloc(num_values
, sizeof(uint64_t),
3506 if (!property
->values
)
3510 ret
= drm_mode_object_get(dev
, &property
->base
, DRM_MODE_OBJECT_PROPERTY
);
3514 property
->flags
= flags
;
3515 property
->num_values
= num_values
;
3516 INIT_LIST_HEAD(&property
->enum_list
);
3519 strncpy(property
->name
, name
, DRM_PROP_NAME_LEN
);
3520 property
->name
[DRM_PROP_NAME_LEN
-1] = '\0';
3523 list_add_tail(&property
->head
, &dev
->mode_config
.property_list
);
3525 WARN_ON(!drm_property_type_valid(property
));
3529 kfree(property
->values
);
3533 EXPORT_SYMBOL(drm_property_create
);
3536 * drm_property_create_enum - create a new enumeration property type
3538 * @flags: flags specifying the property type
3539 * @name: name of the property
3540 * @props: enumeration lists with property values
3541 * @num_values: number of pre-defined values
3543 * This creates a new generic drm property which can then be attached to a drm
3544 * object with drm_object_attach_property. The returned property object must be
3545 * freed with drm_property_destroy.
3547 * Userspace is only allowed to set one of the predefined values for enumeration
3551 * A pointer to the newly created property on success, NULL on failure.
3553 struct drm_property
*drm_property_create_enum(struct drm_device
*dev
, int flags
,
3555 const struct drm_prop_enum_list
*props
,
3558 struct drm_property
*property
;
3561 flags
|= DRM_MODE_PROP_ENUM
;
3563 property
= drm_property_create(dev
, flags
, name
, num_values
);
3567 for (i
= 0; i
< num_values
; i
++) {
3568 ret
= drm_property_add_enum(property
, i
,
3572 drm_property_destroy(dev
, property
);
3579 EXPORT_SYMBOL(drm_property_create_enum
);
3582 * drm_property_create_bitmask - create a new bitmask property type
3584 * @flags: flags specifying the property type
3585 * @name: name of the property
3586 * @props: enumeration lists with property bitflags
3587 * @num_props: size of the @props array
3588 * @supported_bits: bitmask of all supported enumeration values
3590 * This creates a new bitmask drm property which can then be attached to a drm
3591 * object with drm_object_attach_property. The returned property object must be
3592 * freed with drm_property_destroy.
3594 * Compared to plain enumeration properties userspace is allowed to set any
3595 * or'ed together combination of the predefined property bitflag values
3598 * A pointer to the newly created property on success, NULL on failure.
3600 struct drm_property
*drm_property_create_bitmask(struct drm_device
*dev
,
3601 int flags
, const char *name
,
3602 const struct drm_prop_enum_list
*props
,
3604 uint64_t supported_bits
)
3606 struct drm_property
*property
;
3607 int i
, ret
, index
= 0;
3608 int num_values
= hweight64(supported_bits
);
3610 flags
|= DRM_MODE_PROP_BITMASK
;
3612 property
= drm_property_create(dev
, flags
, name
, num_values
);
3615 for (i
= 0; i
< num_props
; i
++) {
3616 if (!(supported_bits
& (1ULL << props
[i
].type
)))
3619 if (WARN_ON(index
>= num_values
)) {
3620 drm_property_destroy(dev
, property
);
3624 ret
= drm_property_add_enum(property
, index
++,
3628 drm_property_destroy(dev
, property
);
3635 EXPORT_SYMBOL(drm_property_create_bitmask
);
3637 static struct drm_property
*property_create_range(struct drm_device
*dev
,
3638 int flags
, const char *name
,
3639 uint64_t min
, uint64_t max
)
3641 struct drm_property
*property
;
3643 property
= drm_property_create(dev
, flags
, name
, 2);
3647 property
->values
[0] = min
;
3648 property
->values
[1] = max
;
3654 * drm_property_create_range - create a new ranged property type
3656 * @flags: flags specifying the property type
3657 * @name: name of the property
3658 * @min: minimum value of the property
3659 * @max: maximum value of the property
3661 * This creates a new generic drm property which can then be attached to a drm
3662 * object with drm_object_attach_property. The returned property object must be
3663 * freed with drm_property_destroy.
3665 * Userspace is allowed to set any integer value in the (min, max) range
3669 * A pointer to the newly created property on success, NULL on failure.
3671 struct drm_property
*drm_property_create_range(struct drm_device
*dev
, int flags
,
3673 uint64_t min
, uint64_t max
)
3675 return property_create_range(dev
, DRM_MODE_PROP_RANGE
| flags
,
3678 EXPORT_SYMBOL(drm_property_create_range
);
3680 struct drm_property
*drm_property_create_signed_range(struct drm_device
*dev
,
3681 int flags
, const char *name
,
3682 int64_t min
, int64_t max
)
3684 return property_create_range(dev
, DRM_MODE_PROP_SIGNED_RANGE
| flags
,
3685 name
, I642U64(min
), I642U64(max
));
3687 EXPORT_SYMBOL(drm_property_create_signed_range
);
3689 struct drm_property
*drm_property_create_object(struct drm_device
*dev
,
3690 int flags
, const char *name
, uint32_t type
)
3692 struct drm_property
*property
;
3694 flags
|= DRM_MODE_PROP_OBJECT
;
3696 property
= drm_property_create(dev
, flags
, name
, 1);
3700 property
->values
[0] = type
;
3704 EXPORT_SYMBOL(drm_property_create_object
);
3707 * drm_property_add_enum - add a possible value to an enumeration property
3708 * @property: enumeration property to change
3709 * @index: index of the new enumeration
3710 * @value: value of the new enumeration
3711 * @name: symbolic name of the new enumeration
3713 * This functions adds enumerations to a property.
3715 * It's use is deprecated, drivers should use one of the more specific helpers
3716 * to directly create the property with all enumerations already attached.
3719 * Zero on success, error code on failure.
3721 int drm_property_add_enum(struct drm_property
*property
, int index
,
3722 uint64_t value
, const char *name
)
3724 struct drm_property_enum
*prop_enum
;
3726 if (!(drm_property_type_is(property
, DRM_MODE_PROP_ENUM
) ||
3727 drm_property_type_is(property
, DRM_MODE_PROP_BITMASK
)))
3731 * Bitmask enum properties have the additional constraint of values
3734 if (drm_property_type_is(property
, DRM_MODE_PROP_BITMASK
) &&
3738 if (!list_empty(&property
->enum_list
)) {
3739 list_for_each_entry(prop_enum
, &property
->enum_list
, head
) {
3740 if (prop_enum
->value
== value
) {
3741 strncpy(prop_enum
->name
, name
, DRM_PROP_NAME_LEN
);
3742 prop_enum
->name
[DRM_PROP_NAME_LEN
-1] = '\0';
3748 prop_enum
= kzalloc(sizeof(struct drm_property_enum
), GFP_KERNEL
);
3752 strncpy(prop_enum
->name
, name
, DRM_PROP_NAME_LEN
);
3753 prop_enum
->name
[DRM_PROP_NAME_LEN
-1] = '\0';
3754 prop_enum
->value
= value
;
3756 property
->values
[index
] = value
;
3757 list_add_tail(&prop_enum
->head
, &property
->enum_list
);
3760 EXPORT_SYMBOL(drm_property_add_enum
);
3763 * drm_property_destroy - destroy a drm property
3765 * @property: property to destry
3767 * This function frees a property including any attached resources like
3768 * enumeration values.
3770 void drm_property_destroy(struct drm_device
*dev
, struct drm_property
*property
)
3772 struct drm_property_enum
*prop_enum
, *pt
;
3774 list_for_each_entry_safe(prop_enum
, pt
, &property
->enum_list
, head
) {
3775 list_del(&prop_enum
->head
);
3779 if (property
->num_values
)
3780 kfree(property
->values
);
3781 drm_mode_object_put(dev
, &property
->base
);
3782 list_del(&property
->head
);
3785 EXPORT_SYMBOL(drm_property_destroy
);
3788 * drm_object_attach_property - attach a property to a modeset object
3789 * @obj: drm modeset object
3790 * @property: property to attach
3791 * @init_val: initial value of the property
3793 * This attaches the given property to the modeset object with the given initial
3794 * value. Currently this function cannot fail since the properties are stored in
3795 * a statically sized array.
3797 void drm_object_attach_property(struct drm_mode_object
*obj
,
3798 struct drm_property
*property
,
3801 int count
= obj
->properties
->count
;
3803 if (count
== DRM_OBJECT_MAX_PROPERTY
) {
3804 WARN(1, "Failed to attach object property (type: 0x%x). Please "
3805 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
3806 "you see this message on the same object type.\n",
3811 obj
->properties
->ids
[count
] = property
->base
.id
;
3812 obj
->properties
->values
[count
] = init_val
;
3813 obj
->properties
->count
++;
3815 EXPORT_SYMBOL(drm_object_attach_property
);
3818 * drm_object_property_set_value - set the value of a property
3819 * @obj: drm mode object to set property value for
3820 * @property: property to set
3821 * @val: value the property should be set to
3823 * This functions sets a given property on a given object. This function only
3824 * changes the software state of the property, it does not call into the
3825 * driver's ->set_property callback.
3828 * Zero on success, error code on failure.
3830 int drm_object_property_set_value(struct drm_mode_object
*obj
,
3831 struct drm_property
*property
, uint64_t val
)
3835 for (i
= 0; i
< obj
->properties
->count
; i
++) {
3836 if (obj
->properties
->ids
[i
] == property
->base
.id
) {
3837 obj
->properties
->values
[i
] = val
;
3844 EXPORT_SYMBOL(drm_object_property_set_value
);
3847 * drm_object_property_get_value - retrieve the value of a property
3848 * @obj: drm mode object to get property value from
3849 * @property: property to retrieve
3850 * @val: storage for the property value
3852 * This function retrieves the softare state of the given property for the given
3853 * property. Since there is no driver callback to retrieve the current property
3854 * value this might be out of sync with the hardware, depending upon the driver
3858 * Zero on success, error code on failure.
3860 int drm_object_property_get_value(struct drm_mode_object
*obj
,
3861 struct drm_property
*property
, uint64_t *val
)
3865 for (i
= 0; i
< obj
->properties
->count
; i
++) {
3866 if (obj
->properties
->ids
[i
] == property
->base
.id
) {
3867 *val
= obj
->properties
->values
[i
];
3874 EXPORT_SYMBOL(drm_object_property_get_value
);
3877 * drm_mode_getproperty_ioctl - get the property metadata
3880 * @file_priv: DRM file info
3882 * This function retrieves the metadata for a given property, like the different
3883 * possible values for an enum property or the limits for a range property.
3885 * Blob properties are special
3887 * Called by the user via ioctl.
3890 * Zero on success, negative errno on failure.
3892 int drm_mode_getproperty_ioctl(struct drm_device
*dev
,
3893 void *data
, struct drm_file
*file_priv
)
3895 struct drm_mode_get_property
*out_resp
= data
;
3896 struct drm_property
*property
;
3898 int value_count
= 0;
3901 struct drm_property_enum
*prop_enum
;
3902 struct drm_mode_property_enum __user
*enum_ptr
;
3903 uint64_t __user
*values_ptr
;
3905 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
3908 drm_modeset_lock_all(dev
);
3909 property
= drm_property_find(dev
, out_resp
->prop_id
);
3915 if (drm_property_type_is(property
, DRM_MODE_PROP_ENUM
) ||
3916 drm_property_type_is(property
, DRM_MODE_PROP_BITMASK
)) {
3917 list_for_each_entry(prop_enum
, &property
->enum_list
, head
)
3921 value_count
= property
->num_values
;
3923 strncpy(out_resp
->name
, property
->name
, DRM_PROP_NAME_LEN
);
3924 out_resp
->name
[DRM_PROP_NAME_LEN
-1] = 0;
3925 out_resp
->flags
= property
->flags
;
3927 if ((out_resp
->count_values
>= value_count
) && value_count
) {
3928 values_ptr
= (uint64_t __user
*)(unsigned long)out_resp
->values_ptr
;
3929 for (i
= 0; i
< value_count
; i
++) {
3930 if (copy_to_user(values_ptr
+ i
, &property
->values
[i
], sizeof(uint64_t))) {
3936 out_resp
->count_values
= value_count
;
3938 if (drm_property_type_is(property
, DRM_MODE_PROP_ENUM
) ||
3939 drm_property_type_is(property
, DRM_MODE_PROP_BITMASK
)) {
3940 if ((out_resp
->count_enum_blobs
>= enum_count
) && enum_count
) {
3942 enum_ptr
= (struct drm_mode_property_enum __user
*)(unsigned long)out_resp
->enum_blob_ptr
;
3943 list_for_each_entry(prop_enum
, &property
->enum_list
, head
) {
3945 if (copy_to_user(&enum_ptr
[copied
].value
, &prop_enum
->value
, sizeof(uint64_t))) {
3950 if (copy_to_user(&enum_ptr
[copied
].name
,
3951 &prop_enum
->name
, DRM_PROP_NAME_LEN
)) {
3958 out_resp
->count_enum_blobs
= enum_count
;
3962 * NOTE: The idea seems to have been to use this to read all the blob
3963 * property values. But nothing ever added them to the corresponding
3964 * list, userspace always used the special-purpose get_blob ioctl to
3965 * read the value for a blob property. It also doesn't make a lot of
3966 * sense to return values here when everything else is just metadata for
3967 * the property itself.
3969 if (drm_property_type_is(property
, DRM_MODE_PROP_BLOB
))
3970 out_resp
->count_enum_blobs
= 0;
3972 drm_modeset_unlock_all(dev
);
3976 static struct drm_property_blob
*
3977 drm_property_create_blob(struct drm_device
*dev
, size_t length
,
3980 struct drm_property_blob
*blob
;
3983 if (!length
|| !data
)
3986 blob
= kzalloc(sizeof(struct drm_property_blob
)+length
, GFP_KERNEL
);
3990 ret
= drm_mode_object_get(dev
, &blob
->base
, DRM_MODE_OBJECT_BLOB
);
3996 blob
->length
= length
;
3998 memcpy(blob
->data
, data
, length
);
4000 list_add_tail(&blob
->head
, &dev
->mode_config
.property_blob_list
);
4004 static void drm_property_destroy_blob(struct drm_device
*dev
,
4005 struct drm_property_blob
*blob
)
4007 drm_mode_object_put(dev
, &blob
->base
);
4008 list_del(&blob
->head
);
4013 * drm_mode_getblob_ioctl - get the contents of a blob property value
4016 * @file_priv: DRM file info
4018 * This function retrieves the contents of a blob property. The value stored in
4019 * an object's blob property is just a normal modeset object id.
4021 * Called by the user via ioctl.
4024 * Zero on success, negative errno on failure.
4026 int drm_mode_getblob_ioctl(struct drm_device
*dev
,
4027 void *data
, struct drm_file
*file_priv
)
4029 struct drm_mode_get_blob
*out_resp
= data
;
4030 struct drm_property_blob
*blob
;
4032 void __user
*blob_ptr
;
4034 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
4037 drm_modeset_lock_all(dev
);
4038 blob
= drm_property_blob_find(dev
, out_resp
->blob_id
);
4044 if (out_resp
->length
== blob
->length
) {
4045 blob_ptr
= (void __user
*)(unsigned long)out_resp
->data
;
4046 if (copy_to_user(blob_ptr
, blob
->data
, blob
->length
)) {
4051 out_resp
->length
= blob
->length
;
4054 drm_modeset_unlock_all(dev
);
4059 * drm_mode_connector_set_path_property - set tile property on connector
4060 * @connector: connector to set property on.
4061 * @path: path to use for property.
4063 * This creates a property to expose to userspace to specify a
4064 * connector path. This is mainly used for DisplayPort MST where
4065 * connectors have a topology and we want to allow userspace to give
4066 * them more meaningful names.
4069 * Zero on success, negative errno on failure.
4071 int drm_mode_connector_set_path_property(struct drm_connector
*connector
,
4074 struct drm_device
*dev
= connector
->dev
;
4075 size_t size
= strlen(path
) + 1;
4078 connector
->path_blob_ptr
= drm_property_create_blob(connector
->dev
,
4080 if (!connector
->path_blob_ptr
)
4083 ret
= drm_object_property_set_value(&connector
->base
,
4084 dev
->mode_config
.path_property
,
4085 connector
->path_blob_ptr
->base
.id
);
4088 EXPORT_SYMBOL(drm_mode_connector_set_path_property
);
4091 * drm_mode_connector_update_edid_property - update the edid property of a connector
4092 * @connector: drm connector
4093 * @edid: new value of the edid property
4095 * This function creates a new blob modeset object and assigns its id to the
4096 * connector's edid property.
4099 * Zero on success, negative errno on failure.
4101 int drm_mode_connector_update_edid_property(struct drm_connector
*connector
,
4102 const struct edid
*edid
)
4104 struct drm_device
*dev
= connector
->dev
;
4108 /* ignore requests to set edid when overridden */
4109 if (connector
->override_edid
)
4112 if (connector
->edid_blob_ptr
)
4113 drm_property_destroy_blob(dev
, connector
->edid_blob_ptr
);
4115 /* Delete edid, when there is none. */
4117 connector
->edid_blob_ptr
= NULL
;
4118 ret
= drm_object_property_set_value(&connector
->base
, dev
->mode_config
.edid_property
, 0);
4122 size
= EDID_LENGTH
* (1 + edid
->extensions
);
4123 connector
->edid_blob_ptr
= drm_property_create_blob(connector
->dev
,
4125 if (!connector
->edid_blob_ptr
)
4128 ret
= drm_object_property_set_value(&connector
->base
,
4129 dev
->mode_config
.edid_property
,
4130 connector
->edid_blob_ptr
->base
.id
);
4134 EXPORT_SYMBOL(drm_mode_connector_update_edid_property
);
4136 static bool drm_property_change_is_valid(struct drm_property
*property
,
4139 if (property
->flags
& DRM_MODE_PROP_IMMUTABLE
)
4142 if (drm_property_type_is(property
, DRM_MODE_PROP_RANGE
)) {
4143 if (value
< property
->values
[0] || value
> property
->values
[1])
4146 } else if (drm_property_type_is(property
, DRM_MODE_PROP_SIGNED_RANGE
)) {
4147 int64_t svalue
= U642I64(value
);
4149 if (svalue
< U642I64(property
->values
[0]) ||
4150 svalue
> U642I64(property
->values
[1]))
4153 } else if (drm_property_type_is(property
, DRM_MODE_PROP_BITMASK
)) {
4155 uint64_t valid_mask
= 0;
4157 for (i
= 0; i
< property
->num_values
; i
++)
4158 valid_mask
|= (1ULL << property
->values
[i
]);
4159 return !(value
& ~valid_mask
);
4160 } else if (drm_property_type_is(property
, DRM_MODE_PROP_BLOB
)) {
4161 /* Only the driver knows */
4163 } else if (drm_property_type_is(property
, DRM_MODE_PROP_OBJECT
)) {
4164 struct drm_mode_object
*obj
;
4166 /* a zero value for an object property translates to null: */
4170 * NOTE: use _object_find() directly to bypass restriction on
4171 * looking up refcnt'd objects (ie. fb's). For a refcnt'd
4172 * object this could race against object finalization, so it
4173 * simply tells us that the object *was* valid. Which is good
4176 obj
= _object_find(property
->dev
, value
, property
->values
[0]);
4180 for (i
= 0; i
< property
->num_values
; i
++)
4181 if (property
->values
[i
] == value
)
4188 * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4191 * @file_priv: DRM file info
4193 * This function sets the current value for a connectors's property. It also
4194 * calls into a driver's ->set_property callback to update the hardware state
4196 * Called by the user via ioctl.
4199 * Zero on success, negative errno on failure.
4201 int drm_mode_connector_property_set_ioctl(struct drm_device
*dev
,
4202 void *data
, struct drm_file
*file_priv
)
4204 struct drm_mode_connector_set_property
*conn_set_prop
= data
;
4205 struct drm_mode_obj_set_property obj_set_prop
= {
4206 .value
= conn_set_prop
->value
,
4207 .prop_id
= conn_set_prop
->prop_id
,
4208 .obj_id
= conn_set_prop
->connector_id
,
4209 .obj_type
= DRM_MODE_OBJECT_CONNECTOR
4212 /* It does all the locking and checking we need */
4213 return drm_mode_obj_set_property_ioctl(dev
, &obj_set_prop
, file_priv
);
4216 static int drm_mode_connector_set_obj_prop(struct drm_mode_object
*obj
,
4217 struct drm_property
*property
,
4221 struct drm_connector
*connector
= obj_to_connector(obj
);
4223 /* Do DPMS ourselves */
4224 if (property
== connector
->dev
->mode_config
.dpms_property
) {
4225 if (connector
->funcs
->dpms
)
4226 (*connector
->funcs
->dpms
)(connector
, (int)value
);
4228 } else if (connector
->funcs
->set_property
)
4229 ret
= connector
->funcs
->set_property(connector
, property
, value
);
4231 /* store the property value if successful */
4233 drm_object_property_set_value(&connector
->base
, property
, value
);
4237 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object
*obj
,
4238 struct drm_property
*property
,
4242 struct drm_crtc
*crtc
= obj_to_crtc(obj
);
4244 if (crtc
->funcs
->set_property
)
4245 ret
= crtc
->funcs
->set_property(crtc
, property
, value
);
4247 drm_object_property_set_value(obj
, property
, value
);
4253 * drm_mode_plane_set_obj_prop - set the value of a property
4254 * @plane: drm plane object to set property value for
4255 * @property: property to set
4256 * @value: value the property should be set to
4258 * This functions sets a given property on a given plane object. This function
4259 * calls the driver's ->set_property callback and changes the software state of
4260 * the property if the callback succeeds.
4263 * Zero on success, error code on failure.
4265 int drm_mode_plane_set_obj_prop(struct drm_plane
*plane
,
4266 struct drm_property
*property
,
4270 struct drm_mode_object
*obj
= &plane
->base
;
4272 if (plane
->funcs
->set_property
)
4273 ret
= plane
->funcs
->set_property(plane
, property
, value
);
4275 drm_object_property_set_value(obj
, property
, value
);
4279 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop
);
4282 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
4285 * @file_priv: DRM file info
4287 * This function retrieves the current value for an object's property. Compared
4288 * to the connector specific ioctl this one is extended to also work on crtc and
4291 * Called by the user via ioctl.
4294 * Zero on success, negative errno on failure.
4296 int drm_mode_obj_get_properties_ioctl(struct drm_device
*dev
, void *data
,
4297 struct drm_file
*file_priv
)
4299 struct drm_mode_obj_get_properties
*arg
= data
;
4300 struct drm_mode_object
*obj
;
4304 int props_count
= 0;
4305 uint32_t __user
*props_ptr
;
4306 uint64_t __user
*prop_values_ptr
;
4308 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
4311 drm_modeset_lock_all(dev
);
4313 obj
= drm_mode_object_find(dev
, arg
->obj_id
, arg
->obj_type
);
4318 if (!obj
->properties
) {
4323 props_count
= obj
->properties
->count
;
4325 /* This ioctl is called twice, once to determine how much space is
4326 * needed, and the 2nd time to fill it. */
4327 if ((arg
->count_props
>= props_count
) && props_count
) {
4329 props_ptr
= (uint32_t __user
*)(unsigned long)(arg
->props_ptr
);
4330 prop_values_ptr
= (uint64_t __user
*)(unsigned long)
4331 (arg
->prop_values_ptr
);
4332 for (i
= 0; i
< props_count
; i
++) {
4333 if (put_user(obj
->properties
->ids
[i
],
4334 props_ptr
+ copied
)) {
4338 if (put_user(obj
->properties
->values
[i
],
4339 prop_values_ptr
+ copied
)) {
4346 arg
->count_props
= props_count
;
4348 drm_modeset_unlock_all(dev
);
4353 * drm_mode_obj_set_property_ioctl - set the current value of an object's property
4356 * @file_priv: DRM file info
4358 * This function sets the current value for an object's property. It also calls
4359 * into a driver's ->set_property callback to update the hardware state.
4360 * Compared to the connector specific ioctl this one is extended to also work on
4361 * crtc and plane objects.
4363 * Called by the user via ioctl.
4366 * Zero on success, negative errno on failure.
4368 int drm_mode_obj_set_property_ioctl(struct drm_device
*dev
, void *data
,
4369 struct drm_file
*file_priv
)
4371 struct drm_mode_obj_set_property
*arg
= data
;
4372 struct drm_mode_object
*arg_obj
;
4373 struct drm_mode_object
*prop_obj
;
4374 struct drm_property
*property
;
4378 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
4381 drm_modeset_lock_all(dev
);
4383 arg_obj
= drm_mode_object_find(dev
, arg
->obj_id
, arg
->obj_type
);
4388 if (!arg_obj
->properties
)
4391 for (i
= 0; i
< arg_obj
->properties
->count
; i
++)
4392 if (arg_obj
->properties
->ids
[i
] == arg
->prop_id
)
4395 if (i
== arg_obj
->properties
->count
)
4398 prop_obj
= drm_mode_object_find(dev
, arg
->prop_id
,
4399 DRM_MODE_OBJECT_PROPERTY
);
4404 property
= obj_to_property(prop_obj
);
4406 if (!drm_property_change_is_valid(property
, arg
->value
))
4409 switch (arg_obj
->type
) {
4410 case DRM_MODE_OBJECT_CONNECTOR
:
4411 ret
= drm_mode_connector_set_obj_prop(arg_obj
, property
,
4414 case DRM_MODE_OBJECT_CRTC
:
4415 ret
= drm_mode_crtc_set_obj_prop(arg_obj
, property
, arg
->value
);
4417 case DRM_MODE_OBJECT_PLANE
:
4418 ret
= drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj
),
4419 property
, arg
->value
);
4424 drm_modeset_unlock_all(dev
);
4429 * drm_mode_connector_attach_encoder - attach a connector to an encoder
4430 * @connector: connector to attach
4431 * @encoder: encoder to attach @connector to
4433 * This function links up a connector to an encoder. Note that the routing
4434 * restrictions between encoders and crtcs are exposed to userspace through the
4435 * possible_clones and possible_crtcs bitmasks.
4438 * Zero on success, negative errno on failure.
4440 int drm_mode_connector_attach_encoder(struct drm_connector
*connector
,
4441 struct drm_encoder
*encoder
)
4445 for (i
= 0; i
< DRM_CONNECTOR_MAX_ENCODER
; i
++) {
4446 if (connector
->encoder_ids
[i
] == 0) {
4447 connector
->encoder_ids
[i
] = encoder
->base
.id
;
4453 EXPORT_SYMBOL(drm_mode_connector_attach_encoder
);
4456 * drm_mode_crtc_set_gamma_size - set the gamma table size
4457 * @crtc: CRTC to set the gamma table size for
4458 * @gamma_size: size of the gamma table
4460 * Drivers which support gamma tables should set this to the supported gamma
4461 * table size when initializing the CRTC. Currently the drm core only supports a
4462 * fixed gamma table size.
4465 * Zero on success, negative errno on failure.
4467 int drm_mode_crtc_set_gamma_size(struct drm_crtc
*crtc
,
4470 crtc
->gamma_size
= gamma_size
;
4472 crtc
->gamma_store
= kcalloc(gamma_size
, sizeof(uint16_t) * 3,
4474 if (!crtc
->gamma_store
) {
4475 crtc
->gamma_size
= 0;
4481 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size
);
4484 * drm_mode_gamma_set_ioctl - set the gamma table
4487 * @file_priv: DRM file info
4489 * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
4490 * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
4492 * Called by the user via ioctl.
4495 * Zero on success, negative errno on failure.
4497 int drm_mode_gamma_set_ioctl(struct drm_device
*dev
,
4498 void *data
, struct drm_file
*file_priv
)
4500 struct drm_mode_crtc_lut
*crtc_lut
= data
;
4501 struct drm_crtc
*crtc
;
4502 void *r_base
, *g_base
, *b_base
;
4506 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
4509 drm_modeset_lock_all(dev
);
4510 crtc
= drm_crtc_find(dev
, crtc_lut
->crtc_id
);
4516 if (crtc
->funcs
->gamma_set
== NULL
) {
4521 /* memcpy into gamma store */
4522 if (crtc_lut
->gamma_size
!= crtc
->gamma_size
) {
4527 size
= crtc_lut
->gamma_size
* (sizeof(uint16_t));
4528 r_base
= crtc
->gamma_store
;
4529 if (copy_from_user(r_base
, (void __user
*)(unsigned long)crtc_lut
->red
, size
)) {
4534 g_base
= r_base
+ size
;
4535 if (copy_from_user(g_base
, (void __user
*)(unsigned long)crtc_lut
->green
, size
)) {
4540 b_base
= g_base
+ size
;
4541 if (copy_from_user(b_base
, (void __user
*)(unsigned long)crtc_lut
->blue
, size
)) {
4546 crtc
->funcs
->gamma_set(crtc
, r_base
, g_base
, b_base
, 0, crtc
->gamma_size
);
4549 drm_modeset_unlock_all(dev
);
4555 * drm_mode_gamma_get_ioctl - get the gamma table
4558 * @file_priv: DRM file info
4560 * Copy the current gamma table into the storage provided. This also provides
4561 * the gamma table size the driver expects, which can be used to size the
4562 * allocated storage.
4564 * Called by the user via ioctl.
4567 * Zero on success, negative errno on failure.
4569 int drm_mode_gamma_get_ioctl(struct drm_device
*dev
,
4570 void *data
, struct drm_file
*file_priv
)
4572 struct drm_mode_crtc_lut
*crtc_lut
= data
;
4573 struct drm_crtc
*crtc
;
4574 void *r_base
, *g_base
, *b_base
;
4578 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
4581 drm_modeset_lock_all(dev
);
4582 crtc
= drm_crtc_find(dev
, crtc_lut
->crtc_id
);
4588 /* memcpy into gamma store */
4589 if (crtc_lut
->gamma_size
!= crtc
->gamma_size
) {
4594 size
= crtc_lut
->gamma_size
* (sizeof(uint16_t));
4595 r_base
= crtc
->gamma_store
;
4596 if (copy_to_user((void __user
*)(unsigned long)crtc_lut
->red
, r_base
, size
)) {
4601 g_base
= r_base
+ size
;
4602 if (copy_to_user((void __user
*)(unsigned long)crtc_lut
->green
, g_base
, size
)) {
4607 b_base
= g_base
+ size
;
4608 if (copy_to_user((void __user
*)(unsigned long)crtc_lut
->blue
, b_base
, size
)) {
4613 drm_modeset_unlock_all(dev
);
4618 * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4621 * @file_priv: DRM file info
4623 * This schedules an asynchronous update on a given CRTC, called page flip.
4624 * Optionally a drm event is generated to signal the completion of the event.
4625 * Generic drivers cannot assume that a pageflip with changed framebuffer
4626 * properties (including driver specific metadata like tiling layout) will work,
4627 * but some drivers support e.g. pixel format changes through the pageflip
4630 * Called by the user via ioctl.
4633 * Zero on success, negative errno on failure.
4635 int drm_mode_page_flip_ioctl(struct drm_device
*dev
,
4636 void *data
, struct drm_file
*file_priv
)
4638 struct drm_mode_crtc_page_flip
*page_flip
= data
;
4639 struct drm_crtc
*crtc
;
4640 struct drm_framebuffer
*fb
= NULL
;
4641 struct drm_pending_vblank_event
*e
= NULL
;
4642 unsigned long flags
;
4645 if (page_flip
->flags
& ~DRM_MODE_PAGE_FLIP_FLAGS
||
4646 page_flip
->reserved
!= 0)
4649 if ((page_flip
->flags
& DRM_MODE_PAGE_FLIP_ASYNC
) && !dev
->mode_config
.async_page_flip
)
4652 crtc
= drm_crtc_find(dev
, page_flip
->crtc_id
);
4656 drm_modeset_lock_crtc(crtc
, crtc
->primary
);
4657 if (crtc
->primary
->fb
== NULL
) {
4658 /* The framebuffer is currently unbound, presumably
4659 * due to a hotplug event, that userspace has not
4666 if (crtc
->funcs
->page_flip
== NULL
)
4669 fb
= drm_framebuffer_lookup(dev
, page_flip
->fb_id
);
4675 ret
= drm_crtc_check_viewport(crtc
, crtc
->x
, crtc
->y
, &crtc
->mode
, fb
);
4679 if (crtc
->primary
->fb
->pixel_format
!= fb
->pixel_format
) {
4680 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4685 if (page_flip
->flags
& DRM_MODE_PAGE_FLIP_EVENT
) {
4687 spin_lock_irqsave(&dev
->event_lock
, flags
);
4688 if (file_priv
->event_space
< sizeof e
->event
) {
4689 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
4692 file_priv
->event_space
-= sizeof e
->event
;
4693 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
4695 e
= kzalloc(sizeof *e
, GFP_KERNEL
);
4697 spin_lock_irqsave(&dev
->event_lock
, flags
);
4698 file_priv
->event_space
+= sizeof e
->event
;
4699 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
4703 e
->event
.base
.type
= DRM_EVENT_FLIP_COMPLETE
;
4704 e
->event
.base
.length
= sizeof e
->event
;
4705 e
->event
.user_data
= page_flip
->user_data
;
4706 e
->base
.event
= &e
->event
.base
;
4707 e
->base
.file_priv
= file_priv
;
4709 (void (*) (struct drm_pending_event
*)) kfree
;
4712 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
4713 ret
= crtc
->funcs
->page_flip(crtc
, fb
, e
, page_flip
->flags
);
4715 if (page_flip
->flags
& DRM_MODE_PAGE_FLIP_EVENT
) {
4716 spin_lock_irqsave(&dev
->event_lock
, flags
);
4717 file_priv
->event_space
+= sizeof e
->event
;
4718 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
4721 /* Keep the old fb, don't unref it. */
4722 crtc
->primary
->old_fb
= NULL
;
4725 * Warn if the driver hasn't properly updated the crtc->fb
4726 * field to reflect that the new framebuffer is now used.
4727 * Failing to do so will screw with the reference counting
4730 WARN_ON(crtc
->primary
->fb
!= fb
);
4731 /* Unref only the old framebuffer. */
4737 drm_framebuffer_unreference(fb
);
4738 if (crtc
->primary
->old_fb
)
4739 drm_framebuffer_unreference(crtc
->primary
->old_fb
);
4740 crtc
->primary
->old_fb
= NULL
;
4741 drm_modeset_unlock_crtc(crtc
);
4747 * drm_mode_config_reset - call ->reset callbacks
4750 * This functions calls all the crtc's, encoder's and connector's ->reset
4751 * callback. Drivers can use this in e.g. their driver load or resume code to
4752 * reset hardware and software state.
4754 void drm_mode_config_reset(struct drm_device
*dev
)
4756 struct drm_crtc
*crtc
;
4757 struct drm_plane
*plane
;
4758 struct drm_encoder
*encoder
;
4759 struct drm_connector
*connector
;
4761 list_for_each_entry(plane
, &dev
->mode_config
.plane_list
, head
)
4762 if (plane
->funcs
->reset
)
4763 plane
->funcs
->reset(plane
);
4765 list_for_each_entry(crtc
, &dev
->mode_config
.crtc_list
, head
)
4766 if (crtc
->funcs
->reset
)
4767 crtc
->funcs
->reset(crtc
);
4769 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
)
4770 if (encoder
->funcs
->reset
)
4771 encoder
->funcs
->reset(encoder
);
4773 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
) {
4774 connector
->status
= connector_status_unknown
;
4776 if (connector
->funcs
->reset
)
4777 connector
->funcs
->reset(connector
);
4780 EXPORT_SYMBOL(drm_mode_config_reset
);
4783 * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
4786 * @file_priv: DRM file info
4788 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
4789 * TTM or something else entirely) and returns the resulting buffer handle. This
4790 * handle can then be wrapped up into a framebuffer modeset object.
4792 * Note that userspace is not allowed to use such objects for render
4793 * acceleration - drivers must create their own private ioctls for such a use
4796 * Called by the user via ioctl.
4799 * Zero on success, negative errno on failure.
4801 int drm_mode_create_dumb_ioctl(struct drm_device
*dev
,
4802 void *data
, struct drm_file
*file_priv
)
4804 struct drm_mode_create_dumb
*args
= data
;
4805 u32 cpp
, stride
, size
;
4807 if (!dev
->driver
->dumb_create
)
4809 if (!args
->width
|| !args
->height
|| !args
->bpp
)
4812 /* overflow checks for 32bit size calculations */
4813 /* NOTE: DIV_ROUND_UP() can overflow */
4814 cpp
= DIV_ROUND_UP(args
->bpp
, 8);
4815 if (!cpp
|| cpp
> 0xffffffffU
/ args
->width
)
4817 stride
= cpp
* args
->width
;
4818 if (args
->height
> 0xffffffffU
/ stride
)
4821 /* test for wrap-around */
4822 size
= args
->height
* stride
;
4823 if (PAGE_ALIGN(size
) == 0)
4827 * handle, pitch and size are output parameters. Zero them out to
4828 * prevent drivers from accidentally using uninitialized data. Since
4829 * not all existing userspace is clearing these fields properly we
4830 * cannot reject IOCTL with garbage in them.
4836 return dev
->driver
->dumb_create(file_priv
, dev
, args
);
4840 * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
4843 * @file_priv: DRM file info
4845 * Allocate an offset in the drm device node's address space to be able to
4846 * memory map a dumb buffer.
4848 * Called by the user via ioctl.
4851 * Zero on success, negative errno on failure.
4853 int drm_mode_mmap_dumb_ioctl(struct drm_device
*dev
,
4854 void *data
, struct drm_file
*file_priv
)
4856 struct drm_mode_map_dumb
*args
= data
;
4858 /* call driver ioctl to get mmap offset */
4859 if (!dev
->driver
->dumb_map_offset
)
4862 return dev
->driver
->dumb_map_offset(file_priv
, dev
, args
->handle
, &args
->offset
);
4866 * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
4869 * @file_priv: DRM file info
4871 * This destroys the userspace handle for the given dumb backing storage buffer.
4872 * Since buffer objects must be reference counted in the kernel a buffer object
4873 * won't be immediately freed if a framebuffer modeset object still uses it.
4875 * Called by the user via ioctl.
4878 * Zero on success, negative errno on failure.
4880 int drm_mode_destroy_dumb_ioctl(struct drm_device
*dev
,
4881 void *data
, struct drm_file
*file_priv
)
4883 struct drm_mode_destroy_dumb
*args
= data
;
4885 if (!dev
->driver
->dumb_destroy
)
4888 return dev
->driver
->dumb_destroy(file_priv
, dev
, args
->handle
);
4892 * drm_fb_get_bpp_depth - get the bpp/depth values for format
4893 * @format: pixel format (DRM_FORMAT_*)
4894 * @depth: storage for the depth value
4895 * @bpp: storage for the bpp value
4897 * This only supports RGB formats here for compat with code that doesn't use
4898 * pixel formats directly yet.
4900 void drm_fb_get_bpp_depth(uint32_t format
, unsigned int *depth
,
4905 case DRM_FORMAT_RGB332
:
4906 case DRM_FORMAT_BGR233
:
4910 case DRM_FORMAT_XRGB1555
:
4911 case DRM_FORMAT_XBGR1555
:
4912 case DRM_FORMAT_RGBX5551
:
4913 case DRM_FORMAT_BGRX5551
:
4914 case DRM_FORMAT_ARGB1555
:
4915 case DRM_FORMAT_ABGR1555
:
4916 case DRM_FORMAT_RGBA5551
:
4917 case DRM_FORMAT_BGRA5551
:
4921 case DRM_FORMAT_RGB565
:
4922 case DRM_FORMAT_BGR565
:
4926 case DRM_FORMAT_RGB888
:
4927 case DRM_FORMAT_BGR888
:
4931 case DRM_FORMAT_XRGB8888
:
4932 case DRM_FORMAT_XBGR8888
:
4933 case DRM_FORMAT_RGBX8888
:
4934 case DRM_FORMAT_BGRX8888
:
4938 case DRM_FORMAT_XRGB2101010
:
4939 case DRM_FORMAT_XBGR2101010
:
4940 case DRM_FORMAT_RGBX1010102
:
4941 case DRM_FORMAT_BGRX1010102
:
4942 case DRM_FORMAT_ARGB2101010
:
4943 case DRM_FORMAT_ABGR2101010
:
4944 case DRM_FORMAT_RGBA1010102
:
4945 case DRM_FORMAT_BGRA1010102
:
4949 case DRM_FORMAT_ARGB8888
:
4950 case DRM_FORMAT_ABGR8888
:
4951 case DRM_FORMAT_RGBA8888
:
4952 case DRM_FORMAT_BGRA8888
:
4957 DRM_DEBUG_KMS("unsupported pixel format %s\n",
4958 drm_get_format_name(format
));
4964 EXPORT_SYMBOL(drm_fb_get_bpp_depth
);
4967 * drm_format_num_planes - get the number of planes for format
4968 * @format: pixel format (DRM_FORMAT_*)
4971 * The number of planes used by the specified pixel format.
4973 int drm_format_num_planes(uint32_t format
)
4976 case DRM_FORMAT_YUV410
:
4977 case DRM_FORMAT_YVU410
:
4978 case DRM_FORMAT_YUV411
:
4979 case DRM_FORMAT_YVU411
:
4980 case DRM_FORMAT_YUV420
:
4981 case DRM_FORMAT_YVU420
:
4982 case DRM_FORMAT_YUV422
:
4983 case DRM_FORMAT_YVU422
:
4984 case DRM_FORMAT_YUV444
:
4985 case DRM_FORMAT_YVU444
:
4987 case DRM_FORMAT_NV12
:
4988 case DRM_FORMAT_NV21
:
4989 case DRM_FORMAT_NV16
:
4990 case DRM_FORMAT_NV61
:
4991 case DRM_FORMAT_NV24
:
4992 case DRM_FORMAT_NV42
:
4998 EXPORT_SYMBOL(drm_format_num_planes
);
5001 * drm_format_plane_cpp - determine the bytes per pixel value
5002 * @format: pixel format (DRM_FORMAT_*)
5003 * @plane: plane index
5006 * The bytes per pixel value for the specified plane.
5008 int drm_format_plane_cpp(uint32_t format
, int plane
)
5013 if (plane
>= drm_format_num_planes(format
))
5017 case DRM_FORMAT_YUYV
:
5018 case DRM_FORMAT_YVYU
:
5019 case DRM_FORMAT_UYVY
:
5020 case DRM_FORMAT_VYUY
:
5022 case DRM_FORMAT_NV12
:
5023 case DRM_FORMAT_NV21
:
5024 case DRM_FORMAT_NV16
:
5025 case DRM_FORMAT_NV61
:
5026 case DRM_FORMAT_NV24
:
5027 case DRM_FORMAT_NV42
:
5028 return plane
? 2 : 1;
5029 case DRM_FORMAT_YUV410
:
5030 case DRM_FORMAT_YVU410
:
5031 case DRM_FORMAT_YUV411
:
5032 case DRM_FORMAT_YVU411
:
5033 case DRM_FORMAT_YUV420
:
5034 case DRM_FORMAT_YVU420
:
5035 case DRM_FORMAT_YUV422
:
5036 case DRM_FORMAT_YVU422
:
5037 case DRM_FORMAT_YUV444
:
5038 case DRM_FORMAT_YVU444
:
5041 drm_fb_get_bpp_depth(format
, &depth
, &bpp
);
5045 EXPORT_SYMBOL(drm_format_plane_cpp
);
5048 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5049 * @format: pixel format (DRM_FORMAT_*)
5052 * The horizontal chroma subsampling factor for the
5053 * specified pixel format.
5055 int drm_format_horz_chroma_subsampling(uint32_t format
)
5058 case DRM_FORMAT_YUV411
:
5059 case DRM_FORMAT_YVU411
:
5060 case DRM_FORMAT_YUV410
:
5061 case DRM_FORMAT_YVU410
:
5063 case DRM_FORMAT_YUYV
:
5064 case DRM_FORMAT_YVYU
:
5065 case DRM_FORMAT_UYVY
:
5066 case DRM_FORMAT_VYUY
:
5067 case DRM_FORMAT_NV12
:
5068 case DRM_FORMAT_NV21
:
5069 case DRM_FORMAT_NV16
:
5070 case DRM_FORMAT_NV61
:
5071 case DRM_FORMAT_YUV422
:
5072 case DRM_FORMAT_YVU422
:
5073 case DRM_FORMAT_YUV420
:
5074 case DRM_FORMAT_YVU420
:
5080 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling
);
5083 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5084 * @format: pixel format (DRM_FORMAT_*)
5087 * The vertical chroma subsampling factor for the
5088 * specified pixel format.
5090 int drm_format_vert_chroma_subsampling(uint32_t format
)
5093 case DRM_FORMAT_YUV410
:
5094 case DRM_FORMAT_YVU410
:
5096 case DRM_FORMAT_YUV420
:
5097 case DRM_FORMAT_YVU420
:
5098 case DRM_FORMAT_NV12
:
5099 case DRM_FORMAT_NV21
:
5105 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling
);
5108 * drm_rotation_simplify() - Try to simplify the rotation
5109 * @rotation: Rotation to be simplified
5110 * @supported_rotations: Supported rotations
5112 * Attempt to simplify the rotation to a form that is supported.
5113 * Eg. if the hardware supports everything except DRM_REFLECT_X
5114 * one could call this function like this:
5116 * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5117 * BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5118 * BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5120 * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5121 * transforms the hardware supports, this function may not
5122 * be able to produce a supported transform, so the caller should
5123 * check the result afterwards.
5125 unsigned int drm_rotation_simplify(unsigned int rotation
,
5126 unsigned int supported_rotations
)
5128 if (rotation
& ~supported_rotations
) {
5129 rotation
^= BIT(DRM_REFLECT_X
) | BIT(DRM_REFLECT_Y
);
5130 rotation
= (rotation
& ~0xf) | BIT((ffs(rotation
& 0xf) + 1) % 4);
5135 EXPORT_SYMBOL(drm_rotation_simplify
);
5138 * drm_mode_config_init - initialize DRM mode_configuration structure
5141 * Initialize @dev's mode_config structure, used for tracking the graphics
5142 * configuration of @dev.
5144 * Since this initializes the modeset locks, no locking is possible. Which is no
5145 * problem, since this should happen single threaded at init time. It is the
5146 * driver's problem to ensure this guarantee.
5149 void drm_mode_config_init(struct drm_device
*dev
)
5151 mutex_init(&dev
->mode_config
.mutex
);
5152 drm_modeset_lock_init(&dev
->mode_config
.connection_mutex
);
5153 mutex_init(&dev
->mode_config
.idr_mutex
);
5154 mutex_init(&dev
->mode_config
.fb_lock
);
5155 INIT_LIST_HEAD(&dev
->mode_config
.fb_list
);
5156 INIT_LIST_HEAD(&dev
->mode_config
.crtc_list
);
5157 INIT_LIST_HEAD(&dev
->mode_config
.connector_list
);
5158 INIT_LIST_HEAD(&dev
->mode_config
.bridge_list
);
5159 INIT_LIST_HEAD(&dev
->mode_config
.encoder_list
);
5160 INIT_LIST_HEAD(&dev
->mode_config
.property_list
);
5161 INIT_LIST_HEAD(&dev
->mode_config
.property_blob_list
);
5162 INIT_LIST_HEAD(&dev
->mode_config
.plane_list
);
5163 idr_init(&dev
->mode_config
.crtc_idr
);
5165 drm_modeset_lock_all(dev
);
5166 drm_mode_create_standard_connector_properties(dev
);
5167 drm_mode_create_standard_plane_properties(dev
);
5168 drm_modeset_unlock_all(dev
);
5170 /* Just to be sure */
5171 dev
->mode_config
.num_fb
= 0;
5172 dev
->mode_config
.num_connector
= 0;
5173 dev
->mode_config
.num_crtc
= 0;
5174 dev
->mode_config
.num_encoder
= 0;
5175 dev
->mode_config
.num_overlay_plane
= 0;
5176 dev
->mode_config
.num_total_plane
= 0;
5178 EXPORT_SYMBOL(drm_mode_config_init
);
5181 * drm_mode_config_cleanup - free up DRM mode_config info
5184 * Free up all the connectors and CRTCs associated with this DRM device, then
5185 * free up the framebuffers and associated buffer objects.
5187 * Note that since this /should/ happen single-threaded at driver/device
5188 * teardown time, no locking is required. It's the driver's job to ensure that
5189 * this guarantee actually holds true.
5191 * FIXME: cleanup any dangling user buffer objects too
5193 void drm_mode_config_cleanup(struct drm_device
*dev
)
5195 struct drm_connector
*connector
, *ot
;
5196 struct drm_crtc
*crtc
, *ct
;
5197 struct drm_encoder
*encoder
, *enct
;
5198 struct drm_bridge
*bridge
, *brt
;
5199 struct drm_framebuffer
*fb
, *fbt
;
5200 struct drm_property
*property
, *pt
;
5201 struct drm_property_blob
*blob
, *bt
;
5202 struct drm_plane
*plane
, *plt
;
5204 list_for_each_entry_safe(encoder
, enct
, &dev
->mode_config
.encoder_list
,
5206 encoder
->funcs
->destroy(encoder
);
5209 list_for_each_entry_safe(bridge
, brt
,
5210 &dev
->mode_config
.bridge_list
, head
) {
5211 bridge
->funcs
->destroy(bridge
);
5214 list_for_each_entry_safe(connector
, ot
,
5215 &dev
->mode_config
.connector_list
, head
) {
5216 connector
->funcs
->destroy(connector
);
5219 list_for_each_entry_safe(property
, pt
, &dev
->mode_config
.property_list
,
5221 drm_property_destroy(dev
, property
);
5224 list_for_each_entry_safe(blob
, bt
, &dev
->mode_config
.property_blob_list
,
5226 drm_property_destroy_blob(dev
, blob
);
5230 * Single-threaded teardown context, so it's not required to grab the
5231 * fb_lock to protect against concurrent fb_list access. Contrary, it
5232 * would actually deadlock with the drm_framebuffer_cleanup function.
5234 * Also, if there are any framebuffers left, that's a driver leak now,
5235 * so politely WARN about this.
5237 WARN_ON(!list_empty(&dev
->mode_config
.fb_list
));
5238 list_for_each_entry_safe(fb
, fbt
, &dev
->mode_config
.fb_list
, head
) {
5239 drm_framebuffer_remove(fb
);
5242 list_for_each_entry_safe(plane
, plt
, &dev
->mode_config
.plane_list
,
5244 plane
->funcs
->destroy(plane
);
5247 list_for_each_entry_safe(crtc
, ct
, &dev
->mode_config
.crtc_list
, head
) {
5248 crtc
->funcs
->destroy(crtc
);
5251 idr_destroy(&dev
->mode_config
.crtc_idr
);
5252 drm_modeset_lock_fini(&dev
->mode_config
.connection_mutex
);
5254 EXPORT_SYMBOL(drm_mode_config_cleanup
);
5256 struct drm_property
*drm_mode_create_rotation_property(struct drm_device
*dev
,
5257 unsigned int supported_rotations
)
5259 static const struct drm_prop_enum_list props
[] = {
5260 { DRM_ROTATE_0
, "rotate-0" },
5261 { DRM_ROTATE_90
, "rotate-90" },
5262 { DRM_ROTATE_180
, "rotate-180" },
5263 { DRM_ROTATE_270
, "rotate-270" },
5264 { DRM_REFLECT_X
, "reflect-x" },
5265 { DRM_REFLECT_Y
, "reflect-y" },
5268 return drm_property_create_bitmask(dev
, 0, "rotation",
5269 props
, ARRAY_SIZE(props
),
5270 supported_rotations
);
5272 EXPORT_SYMBOL(drm_mode_create_rotation_property
);