2 * Copyright (c) 2016 Intel Corporation
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
23 #include <linux/export.h>
25 #include <drm/drm_mode_object.h>
26 #include <drm/drm_atomic.h>
28 #include "drm_crtc_internal.h"
31 * Internal function to assign a slot in the object idr and optionally
32 * register the object into the idr.
34 int __drm_mode_object_add(struct drm_device
*dev
, struct drm_mode_object
*obj
,
35 uint32_t obj_type
, bool register_obj
,
36 void (*obj_free_cb
)(struct kref
*kref
))
40 mutex_lock(&dev
->mode_config
.idr_mutex
);
41 ret
= idr_alloc(&dev
->mode_config
.crtc_idr
, register_obj
? obj
: NULL
, 1, 0, GFP_KERNEL
);
44 * Set up the object linking under the protection of the idr
45 * lock so that other users can't see inconsistent state.
50 obj
->free_cb
= obj_free_cb
;
51 kref_init(&obj
->refcount
);
54 mutex_unlock(&dev
->mode_config
.idr_mutex
);
56 return ret
< 0 ? ret
: 0;
60 * drm_mode_object_add - allocate a new modeset identifier
62 * @obj: object pointer, used to generate unique ID
63 * @obj_type: object type
65 * Create a unique identifier based on @ptr in @dev's identifier space. Used
66 * for tracking modes, CRTCs and connectors.
69 * Zero on success, error code on failure.
71 int drm_mode_object_add(struct drm_device
*dev
,
72 struct drm_mode_object
*obj
, uint32_t obj_type
)
74 return __drm_mode_object_add(dev
, obj
, obj_type
, true, NULL
);
77 void drm_mode_object_register(struct drm_device
*dev
,
78 struct drm_mode_object
*obj
)
80 mutex_lock(&dev
->mode_config
.idr_mutex
);
81 idr_replace(&dev
->mode_config
.crtc_idr
, obj
, obj
->id
);
82 mutex_unlock(&dev
->mode_config
.idr_mutex
);
86 * drm_mode_object_unregister - free a modeset identifer
88 * @object: object to free
90 * Free @id from @dev's unique identifier pool.
91 * This function can be called multiple times, and guards against
93 * These modeset identifiers are _not_ reference counted. Hence don't use this
94 * for reference counted modeset objects like framebuffers.
96 void drm_mode_object_unregister(struct drm_device
*dev
,
97 struct drm_mode_object
*object
)
99 mutex_lock(&dev
->mode_config
.idr_mutex
);
101 idr_remove(&dev
->mode_config
.crtc_idr
, object
->id
);
104 mutex_unlock(&dev
->mode_config
.idr_mutex
);
108 * drm_lease_required - check types which must be leased to be used
109 * @type: type of object
111 * Returns whether the provided type of drm_mode_object must
112 * be owned or leased to be used by a process.
114 bool drm_mode_object_lease_required(uint32_t type
)
117 case DRM_MODE_OBJECT_CRTC
:
118 case DRM_MODE_OBJECT_CONNECTOR
:
119 case DRM_MODE_OBJECT_PLANE
:
126 struct drm_mode_object
*__drm_mode_object_find(struct drm_device
*dev
,
127 struct drm_file
*file_priv
,
128 uint32_t id
, uint32_t type
)
130 struct drm_mode_object
*obj
= NULL
;
132 mutex_lock(&dev
->mode_config
.idr_mutex
);
133 obj
= idr_find(&dev
->mode_config
.crtc_idr
, id
);
134 if (obj
&& type
!= DRM_MODE_OBJECT_ANY
&& obj
->type
!= type
)
136 if (obj
&& obj
->id
!= id
)
140 if (obj
&& drm_mode_object_lease_required(obj
->type
) &&
141 !_drm_lease_held(file_priv
, obj
->id
))
145 if (obj
&& obj
->free_cb
) {
146 if (!kref_get_unless_zero(&obj
->refcount
))
149 mutex_unlock(&dev
->mode_config
.idr_mutex
);
155 * drm_mode_object_find - look up a drm object with static lifetime
157 * @file_priv: drm file
158 * @id: id of the mode object
159 * @type: type of the mode object
161 * This function is used to look up a modeset object. It will acquire a
162 * reference for reference counted objects. This reference must be dropped again
163 * by callind drm_mode_object_put().
165 struct drm_mode_object
*drm_mode_object_find(struct drm_device
*dev
,
166 struct drm_file
*file_priv
,
167 uint32_t id
, uint32_t type
)
169 struct drm_mode_object
*obj
= NULL
;
171 obj
= __drm_mode_object_find(dev
, file_priv
, id
, type
);
174 EXPORT_SYMBOL(drm_mode_object_find
);
177 * drm_mode_object_put - release a mode object reference
178 * @obj: DRM mode object
180 * This function decrements the object's refcount if it is a refcounted modeset
181 * object. It is a no-op on any other object. This is used to drop references
182 * acquired with drm_mode_object_get().
184 void drm_mode_object_put(struct drm_mode_object
*obj
)
187 DRM_DEBUG("OBJ ID: %d (%d)\n", obj
->id
, kref_read(&obj
->refcount
));
188 kref_put(&obj
->refcount
, obj
->free_cb
);
191 EXPORT_SYMBOL(drm_mode_object_put
);
194 * drm_mode_object_get - acquire a mode object reference
195 * @obj: DRM mode object
197 * This function increments the object's refcount if it is a refcounted modeset
198 * object. It is a no-op on any other object. References should be dropped again
199 * by calling drm_mode_object_put().
201 void drm_mode_object_get(struct drm_mode_object
*obj
)
204 DRM_DEBUG("OBJ ID: %d (%d)\n", obj
->id
, kref_read(&obj
->refcount
));
205 kref_get(&obj
->refcount
);
208 EXPORT_SYMBOL(drm_mode_object_get
);
211 * drm_object_attach_property - attach a property to a modeset object
212 * @obj: drm modeset object
213 * @property: property to attach
214 * @init_val: initial value of the property
216 * This attaches the given property to the modeset object with the given initial
217 * value. Currently this function cannot fail since the properties are stored in
218 * a statically sized array.
220 void drm_object_attach_property(struct drm_mode_object
*obj
,
221 struct drm_property
*property
,
224 int count
= obj
->properties
->count
;
226 if (count
== DRM_OBJECT_MAX_PROPERTY
) {
227 WARN(1, "Failed to attach object property (type: 0x%x). Please "
228 "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
229 "you see this message on the same object type.\n",
234 obj
->properties
->properties
[count
] = property
;
235 obj
->properties
->values
[count
] = init_val
;
236 obj
->properties
->count
++;
238 EXPORT_SYMBOL(drm_object_attach_property
);
241 * drm_object_property_set_value - set the value of a property
242 * @obj: drm mode object to set property value for
243 * @property: property to set
244 * @val: value the property should be set to
246 * This function sets a given property on a given object. This function only
247 * changes the software state of the property, it does not call into the
248 * driver's ->set_property callback.
250 * Note that atomic drivers should not have any need to call this, the core will
251 * ensure consistency of values reported back to userspace through the
252 * appropriate ->atomic_get_property callback. Only legacy drivers should call
253 * this function to update the tracked value (after clamping and other
254 * restrictions have been applied).
257 * Zero on success, error code on failure.
259 int drm_object_property_set_value(struct drm_mode_object
*obj
,
260 struct drm_property
*property
, uint64_t val
)
264 WARN_ON(drm_drv_uses_atomic_modeset(property
->dev
) &&
265 !(property
->flags
& DRM_MODE_PROP_IMMUTABLE
));
267 for (i
= 0; i
< obj
->properties
->count
; i
++) {
268 if (obj
->properties
->properties
[i
] == property
) {
269 obj
->properties
->values
[i
] = val
;
276 EXPORT_SYMBOL(drm_object_property_set_value
);
278 static int __drm_object_property_get_value(struct drm_mode_object
*obj
,
279 struct drm_property
*property
,
284 /* read-only properties bypass atomic mechanism and still store
285 * their value in obj->properties->values[].. mostly to avoid
286 * having to deal w/ EDID and similar props in atomic paths:
288 if (drm_drv_uses_atomic_modeset(property
->dev
) &&
289 !(property
->flags
& DRM_MODE_PROP_IMMUTABLE
))
290 return drm_atomic_get_property(obj
, property
, val
);
292 for (i
= 0; i
< obj
->properties
->count
; i
++) {
293 if (obj
->properties
->properties
[i
] == property
) {
294 *val
= obj
->properties
->values
[i
];
304 * drm_object_property_get_value - retrieve the value of a property
305 * @obj: drm mode object to get property value from
306 * @property: property to retrieve
307 * @val: storage for the property value
309 * This function retrieves the softare state of the given property for the given
310 * property. Since there is no driver callback to retrieve the current property
311 * value this might be out of sync with the hardware, depending upon the driver
314 * Atomic drivers should never call this function directly, the core will read
315 * out property values through the various ->atomic_get_property callbacks.
318 * Zero on success, error code on failure.
320 int drm_object_property_get_value(struct drm_mode_object
*obj
,
321 struct drm_property
*property
, uint64_t *val
)
323 WARN_ON(drm_drv_uses_atomic_modeset(property
->dev
));
325 return __drm_object_property_get_value(obj
, property
, val
);
327 EXPORT_SYMBOL(drm_object_property_get_value
);
329 /* helper for getconnector and getproperties ioctls */
330 int drm_mode_object_get_properties(struct drm_mode_object
*obj
, bool atomic
,
331 uint32_t __user
*prop_ptr
,
332 uint64_t __user
*prop_values
,
333 uint32_t *arg_count_props
)
337 for (i
= 0, count
= 0; i
< obj
->properties
->count
; i
++) {
338 struct drm_property
*prop
= obj
->properties
->properties
[i
];
341 if ((prop
->flags
& DRM_MODE_PROP_ATOMIC
) && !atomic
)
344 if (*arg_count_props
> count
) {
345 ret
= __drm_object_property_get_value(obj
, prop
, &val
);
349 if (put_user(prop
->base
.id
, prop_ptr
+ count
))
352 if (put_user(val
, prop_values
+ count
))
358 *arg_count_props
= count
;
364 * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
367 * @file_priv: DRM file info
369 * This function retrieves the current value for an object's property. Compared
370 * to the connector specific ioctl this one is extended to also work on crtc and
373 * Called by the user via ioctl.
376 * Zero on success, negative errno on failure.
378 int drm_mode_obj_get_properties_ioctl(struct drm_device
*dev
, void *data
,
379 struct drm_file
*file_priv
)
381 struct drm_mode_obj_get_properties
*arg
= data
;
382 struct drm_mode_object
*obj
;
385 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
388 drm_modeset_lock_all(dev
);
390 obj
= drm_mode_object_find(dev
, file_priv
, arg
->obj_id
, arg
->obj_type
);
395 if (!obj
->properties
) {
400 ret
= drm_mode_object_get_properties(obj
, file_priv
->atomic
,
401 (uint32_t __user
*)(unsigned long)(arg
->props_ptr
),
402 (uint64_t __user
*)(unsigned long)(arg
->prop_values_ptr
),
406 drm_mode_object_put(obj
);
408 drm_modeset_unlock_all(dev
);
412 struct drm_property
*drm_mode_obj_find_prop_id(struct drm_mode_object
*obj
,
417 for (i
= 0; i
< obj
->properties
->count
; i
++)
418 if (obj
->properties
->properties
[i
]->base
.id
== prop_id
)
419 return obj
->properties
->properties
[i
];
424 static int set_property_legacy(struct drm_mode_object
*obj
,
425 struct drm_property
*prop
,
428 struct drm_device
*dev
= prop
->dev
;
429 struct drm_mode_object
*ref
;
432 if (!drm_property_change_valid_get(prop
, prop_value
, &ref
))
435 drm_modeset_lock_all(dev
);
437 case DRM_MODE_OBJECT_CONNECTOR
:
438 ret
= drm_mode_connector_set_obj_prop(obj
, prop
,
441 case DRM_MODE_OBJECT_CRTC
:
442 ret
= drm_mode_crtc_set_obj_prop(obj
, prop
, prop_value
);
444 case DRM_MODE_OBJECT_PLANE
:
445 ret
= drm_mode_plane_set_obj_prop(obj_to_plane(obj
),
449 drm_property_change_valid_put(prop
, ref
);
450 drm_modeset_unlock_all(dev
);
455 static int set_property_atomic(struct drm_mode_object
*obj
,
456 struct drm_property
*prop
,
459 struct drm_device
*dev
= prop
->dev
;
460 struct drm_atomic_state
*state
;
461 struct drm_modeset_acquire_ctx ctx
;
464 drm_modeset_acquire_init(&ctx
, 0);
466 state
= drm_atomic_state_alloc(dev
);
469 state
->acquire_ctx
= &ctx
;
471 if (prop
== state
->dev
->mode_config
.dpms_property
) {
472 if (obj
->type
!= DRM_MODE_OBJECT_CONNECTOR
) {
477 ret
= drm_atomic_connector_commit_dpms(state
,
478 obj_to_connector(obj
),
481 ret
= drm_atomic_set_property(state
, obj
, prop
, prop_value
);
484 ret
= drm_atomic_commit(state
);
487 if (ret
== -EDEADLK
) {
488 drm_atomic_state_clear(state
);
489 drm_modeset_backoff(&ctx
);
493 drm_atomic_state_put(state
);
495 drm_modeset_drop_locks(&ctx
);
496 drm_modeset_acquire_fini(&ctx
);
501 int drm_mode_obj_set_property_ioctl(struct drm_device
*dev
, void *data
,
502 struct drm_file
*file_priv
)
504 struct drm_mode_obj_set_property
*arg
= data
;
505 struct drm_mode_object
*arg_obj
;
506 struct drm_property
*property
;
509 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
512 arg_obj
= drm_mode_object_find(dev
, file_priv
, arg
->obj_id
, arg
->obj_type
);
516 if (!arg_obj
->properties
)
519 property
= drm_mode_obj_find_prop_id(arg_obj
, arg
->prop_id
);
523 if (drm_drv_uses_atomic_modeset(property
->dev
))
524 ret
= set_property_atomic(arg_obj
, property
, arg
->value
);
526 ret
= set_property_legacy(arg_obj
, property
, arg
->value
);
529 drm_mode_object_put(arg_obj
);