2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
4 * Copyright (C) 2018 Intel Corp.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
25 * Rob Clark <robdclark@gmail.com>
26 * Daniel Vetter <daniel.vetter@ffwll.ch>
29 #include <drm/drm_atomic_uapi.h>
30 #include <drm/drm_atomic.h>
31 #include <drm/drm_print.h>
32 #include <drm/drm_drv.h>
33 #include <drm/drm_writeback.h>
34 #include <drm/drm_vblank.h>
36 #include <linux/dma-fence.h>
37 #include <linux/uaccess.h>
38 #include <linux/sync_file.h>
39 #include <linux/file.h>
41 #include "drm_crtc_internal.h"
46 * This file contains the marshalling and demarshalling glue for the atomic UAPI
47 * in all its forms: The monster ATOMIC IOCTL itself, code for GET_PROPERTY and
48 * SET_PROPERTY IOCTLs. Plus interface functions for compatibility helpers and
49 * drivers which have special needs to construct their own atomic updates, e.g.
50 * for load detect or similiar.
54 * drm_atomic_set_mode_for_crtc - set mode for CRTC
55 * @state: the CRTC whose incoming state to update
56 * @mode: kernel-internal mode to use for the CRTC, or NULL to disable
58 * Set a mode (originating from the kernel) on the desired CRTC state and update
59 * the enable property.
62 * Zero on success, error code on failure. Cannot return -EDEADLK.
64 int drm_atomic_set_mode_for_crtc(struct drm_crtc_state
*state
,
65 const struct drm_display_mode
*mode
)
67 struct drm_crtc
*crtc
= state
->crtc
;
68 struct drm_mode_modeinfo umode
;
70 /* Early return for no change. */
71 if (mode
&& memcmp(&state
->mode
, mode
, sizeof(*mode
)) == 0)
74 drm_property_blob_put(state
->mode_blob
);
75 state
->mode_blob
= NULL
;
78 drm_mode_convert_to_umode(&umode
, mode
);
80 drm_property_create_blob(state
->crtc
->dev
,
83 if (IS_ERR(state
->mode_blob
))
84 return PTR_ERR(state
->mode_blob
);
86 drm_mode_copy(&state
->mode
, mode
);
88 DRM_DEBUG_ATOMIC("Set [MODE:%s] for [CRTC:%d:%s] state %p\n",
89 mode
->name
, crtc
->base
.id
, crtc
->name
, state
);
91 memset(&state
->mode
, 0, sizeof(state
->mode
));
92 state
->enable
= false;
93 DRM_DEBUG_ATOMIC("Set [NOMODE] for [CRTC:%d:%s] state %p\n",
94 crtc
->base
.id
, crtc
->name
, state
);
99 EXPORT_SYMBOL(drm_atomic_set_mode_for_crtc
);
102 * drm_atomic_set_mode_prop_for_crtc - set mode for CRTC
103 * @state: the CRTC whose incoming state to update
104 * @blob: pointer to blob property to use for mode
106 * Set a mode (originating from a blob property) on the desired CRTC state.
107 * This function will take a reference on the blob property for the CRTC state,
108 * and release the reference held on the state's existing mode property, if any
112 * Zero on success, error code on failure. Cannot return -EDEADLK.
114 int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state
*state
,
115 struct drm_property_blob
*blob
)
117 struct drm_crtc
*crtc
= state
->crtc
;
119 if (blob
== state
->mode_blob
)
122 drm_property_blob_put(state
->mode_blob
);
123 state
->mode_blob
= NULL
;
125 memset(&state
->mode
, 0, sizeof(state
->mode
));
130 if (blob
->length
!= sizeof(struct drm_mode_modeinfo
)) {
131 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] bad mode blob length: %zu\n",
132 crtc
->base
.id
, crtc
->name
,
137 ret
= drm_mode_convert_umode(crtc
->dev
,
138 &state
->mode
, blob
->data
);
140 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] invalid mode (ret=%d, status=%s):\n",
141 crtc
->base
.id
, crtc
->name
,
142 ret
, drm_get_mode_status_name(state
->mode
.status
));
143 drm_mode_debug_printmodeline(&state
->mode
);
147 state
->mode_blob
= drm_property_blob_get(blob
);
148 state
->enable
= true;
149 DRM_DEBUG_ATOMIC("Set [MODE:%s] for [CRTC:%d:%s] state %p\n",
150 state
->mode
.name
, crtc
->base
.id
, crtc
->name
,
153 state
->enable
= false;
154 DRM_DEBUG_ATOMIC("Set [NOMODE] for [CRTC:%d:%s] state %p\n",
155 crtc
->base
.id
, crtc
->name
, state
);
160 EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc
);
163 * drm_atomic_set_crtc_for_plane - set CRTC for plane
164 * @plane_state: the plane whose incoming state to update
165 * @crtc: CRTC to use for the plane
167 * Changing the assigned CRTC for a plane requires us to grab the lock and state
168 * for the new CRTC, as needed. This function takes care of all these details
169 * besides updating the pointer in the state object itself.
172 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
173 * then the w/w mutex code has detected a deadlock and the entire atomic
174 * sequence must be restarted. All other errors are fatal.
177 drm_atomic_set_crtc_for_plane(struct drm_plane_state
*plane_state
,
178 struct drm_crtc
*crtc
)
180 struct drm_plane
*plane
= plane_state
->plane
;
181 struct drm_crtc_state
*crtc_state
;
182 /* Nothing to do for same crtc*/
183 if (plane_state
->crtc
== crtc
)
185 if (plane_state
->crtc
) {
186 crtc_state
= drm_atomic_get_crtc_state(plane_state
->state
,
188 if (WARN_ON(IS_ERR(crtc_state
)))
189 return PTR_ERR(crtc_state
);
191 crtc_state
->plane_mask
&= ~drm_plane_mask(plane
);
194 plane_state
->crtc
= crtc
;
197 crtc_state
= drm_atomic_get_crtc_state(plane_state
->state
,
199 if (IS_ERR(crtc_state
))
200 return PTR_ERR(crtc_state
);
201 crtc_state
->plane_mask
|= drm_plane_mask(plane
);
205 DRM_DEBUG_ATOMIC("Link [PLANE:%d:%s] state %p to [CRTC:%d:%s]\n",
206 plane
->base
.id
, plane
->name
, plane_state
,
207 crtc
->base
.id
, crtc
->name
);
209 DRM_DEBUG_ATOMIC("Link [PLANE:%d:%s] state %p to [NOCRTC]\n",
210 plane
->base
.id
, plane
->name
, plane_state
);
214 EXPORT_SYMBOL(drm_atomic_set_crtc_for_plane
);
217 * drm_atomic_set_fb_for_plane - set framebuffer for plane
218 * @plane_state: atomic state object for the plane
219 * @fb: fb to use for the plane
221 * Changing the assigned framebuffer for a plane requires us to grab a reference
222 * to the new fb and drop the reference to the old fb, if there is one. This
223 * function takes care of all these details besides updating the pointer in the
224 * state object itself.
227 drm_atomic_set_fb_for_plane(struct drm_plane_state
*plane_state
,
228 struct drm_framebuffer
*fb
)
230 struct drm_plane
*plane
= plane_state
->plane
;
233 DRM_DEBUG_ATOMIC("Set [FB:%d] for [PLANE:%d:%s] state %p\n",
234 fb
->base
.id
, plane
->base
.id
, plane
->name
,
237 DRM_DEBUG_ATOMIC("Set [NOFB] for [PLANE:%d:%s] state %p\n",
238 plane
->base
.id
, plane
->name
, plane_state
);
240 drm_framebuffer_assign(&plane_state
->fb
, fb
);
242 EXPORT_SYMBOL(drm_atomic_set_fb_for_plane
);
245 * drm_atomic_set_fence_for_plane - set fence for plane
246 * @plane_state: atomic state object for the plane
247 * @fence: dma_fence to use for the plane
249 * Helper to setup the plane_state fence in case it is not set yet.
250 * By using this drivers doesn't need to worry if the user choose
251 * implicit or explicit fencing.
253 * This function will not set the fence to the state if it was set
254 * via explicit fencing interfaces on the atomic ioctl. In that case it will
255 * drop the reference to the fence as we are not storing it anywhere.
256 * Otherwise, if &drm_plane_state.fence is not set this function we just set it
257 * with the received implicit fence. In both cases this function consumes a
258 * reference for @fence.
260 * This way explicit fencing can be used to overrule implicit fencing, which is
261 * important to make explicit fencing use-cases work: One example is using one
262 * buffer for 2 screens with different refresh rates. Implicit fencing will
263 * clamp rendering to the refresh rate of the slower screen, whereas explicit
264 * fence allows 2 independent render and display loops on a single buffer. If a
265 * driver allows obeys both implicit and explicit fences for plane updates, then
266 * it will break all the benefits of explicit fencing.
269 drm_atomic_set_fence_for_plane(struct drm_plane_state
*plane_state
,
270 struct dma_fence
*fence
)
272 if (plane_state
->fence
) {
273 dma_fence_put(fence
);
277 plane_state
->fence
= fence
;
279 EXPORT_SYMBOL(drm_atomic_set_fence_for_plane
);
282 * drm_atomic_set_crtc_for_connector - set CRTC for connector
283 * @conn_state: atomic state object for the connector
284 * @crtc: CRTC to use for the connector
286 * Changing the assigned CRTC for a connector requires us to grab the lock and
287 * state for the new CRTC, as needed. This function takes care of all these
288 * details besides updating the pointer in the state object itself.
291 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
292 * then the w/w mutex code has detected a deadlock and the entire atomic
293 * sequence must be restarted. All other errors are fatal.
296 drm_atomic_set_crtc_for_connector(struct drm_connector_state
*conn_state
,
297 struct drm_crtc
*crtc
)
299 struct drm_connector
*connector
= conn_state
->connector
;
300 struct drm_crtc_state
*crtc_state
;
302 if (conn_state
->crtc
== crtc
)
305 if (conn_state
->crtc
) {
306 crtc_state
= drm_atomic_get_new_crtc_state(conn_state
->state
,
309 crtc_state
->connector_mask
&=
310 ~drm_connector_mask(conn_state
->connector
);
312 drm_connector_put(conn_state
->connector
);
313 conn_state
->crtc
= NULL
;
317 crtc_state
= drm_atomic_get_crtc_state(conn_state
->state
, crtc
);
318 if (IS_ERR(crtc_state
))
319 return PTR_ERR(crtc_state
);
321 crtc_state
->connector_mask
|=
322 drm_connector_mask(conn_state
->connector
);
324 drm_connector_get(conn_state
->connector
);
325 conn_state
->crtc
= crtc
;
327 DRM_DEBUG_ATOMIC("Link [CONNECTOR:%d:%s] state %p to [CRTC:%d:%s]\n",
328 connector
->base
.id
, connector
->name
,
329 conn_state
, crtc
->base
.id
, crtc
->name
);
331 DRM_DEBUG_ATOMIC("Link [CONNECTOR:%d:%s] state %p to [NOCRTC]\n",
332 connector
->base
.id
, connector
->name
,
338 EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector
);
340 static void set_out_fence_for_crtc(struct drm_atomic_state
*state
,
341 struct drm_crtc
*crtc
, s32 __user
*fence_ptr
)
343 state
->crtcs
[drm_crtc_index(crtc
)].out_fence_ptr
= fence_ptr
;
346 static s32 __user
*get_out_fence_for_crtc(struct drm_atomic_state
*state
,
347 struct drm_crtc
*crtc
)
349 s32 __user
*fence_ptr
;
351 fence_ptr
= state
->crtcs
[drm_crtc_index(crtc
)].out_fence_ptr
;
352 state
->crtcs
[drm_crtc_index(crtc
)].out_fence_ptr
= NULL
;
357 static int set_out_fence_for_connector(struct drm_atomic_state
*state
,
358 struct drm_connector
*connector
,
359 s32 __user
*fence_ptr
)
361 unsigned int index
= drm_connector_index(connector
);
366 if (put_user(-1, fence_ptr
))
369 state
->connectors
[index
].out_fence_ptr
= fence_ptr
;
374 static s32 __user
*get_out_fence_for_connector(struct drm_atomic_state
*state
,
375 struct drm_connector
*connector
)
377 unsigned int index
= drm_connector_index(connector
);
378 s32 __user
*fence_ptr
;
380 fence_ptr
= state
->connectors
[index
].out_fence_ptr
;
381 state
->connectors
[index
].out_fence_ptr
= NULL
;
387 drm_atomic_replace_property_blob_from_id(struct drm_device
*dev
,
388 struct drm_property_blob
**blob
,
390 ssize_t expected_size
,
391 ssize_t expected_elem_size
,
394 struct drm_property_blob
*new_blob
= NULL
;
397 new_blob
= drm_property_lookup_blob(dev
, blob_id
);
398 if (new_blob
== NULL
)
401 if (expected_size
> 0 &&
402 new_blob
->length
!= expected_size
) {
403 drm_property_blob_put(new_blob
);
406 if (expected_elem_size
> 0 &&
407 new_blob
->length
% expected_elem_size
!= 0) {
408 drm_property_blob_put(new_blob
);
413 *replaced
|= drm_property_replace_blob(blob
, new_blob
);
414 drm_property_blob_put(new_blob
);
419 static int drm_atomic_crtc_set_property(struct drm_crtc
*crtc
,
420 struct drm_crtc_state
*state
, struct drm_property
*property
,
423 struct drm_device
*dev
= crtc
->dev
;
424 struct drm_mode_config
*config
= &dev
->mode_config
;
425 bool replaced
= false;
428 if (property
== config
->prop_active
)
430 else if (property
== config
->prop_mode_id
) {
431 struct drm_property_blob
*mode
=
432 drm_property_lookup_blob(dev
, val
);
433 ret
= drm_atomic_set_mode_prop_for_crtc(state
, mode
);
434 drm_property_blob_put(mode
);
436 } else if (property
== config
->prop_vrr_enabled
) {
437 state
->vrr_enabled
= val
;
438 } else if (property
== config
->degamma_lut_property
) {
439 ret
= drm_atomic_replace_property_blob_from_id(dev
,
442 -1, sizeof(struct drm_color_lut
),
444 state
->color_mgmt_changed
|= replaced
;
446 } else if (property
== config
->ctm_property
) {
447 ret
= drm_atomic_replace_property_blob_from_id(dev
,
450 sizeof(struct drm_color_ctm
), -1,
452 state
->color_mgmt_changed
|= replaced
;
454 } else if (property
== config
->gamma_lut_property
) {
455 ret
= drm_atomic_replace_property_blob_from_id(dev
,
458 -1, sizeof(struct drm_color_lut
),
460 state
->color_mgmt_changed
|= replaced
;
462 } else if (property
== config
->prop_out_fence_ptr
) {
463 s32 __user
*fence_ptr
= u64_to_user_ptr(val
);
468 if (put_user(-1, fence_ptr
))
471 set_out_fence_for_crtc(state
->state
, crtc
, fence_ptr
);
472 } else if (crtc
->funcs
->atomic_set_property
) {
473 return crtc
->funcs
->atomic_set_property(crtc
, state
, property
, val
);
475 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] unknown property [PROP:%d:%s]]\n",
476 crtc
->base
.id
, crtc
->name
,
477 property
->base
.id
, property
->name
);
485 drm_atomic_crtc_get_property(struct drm_crtc
*crtc
,
486 const struct drm_crtc_state
*state
,
487 struct drm_property
*property
, uint64_t *val
)
489 struct drm_device
*dev
= crtc
->dev
;
490 struct drm_mode_config
*config
= &dev
->mode_config
;
492 if (property
== config
->prop_active
)
493 *val
= drm_atomic_crtc_effectively_active(state
);
494 else if (property
== config
->prop_mode_id
)
495 *val
= (state
->mode_blob
) ? state
->mode_blob
->base
.id
: 0;
496 else if (property
== config
->prop_vrr_enabled
)
497 *val
= state
->vrr_enabled
;
498 else if (property
== config
->degamma_lut_property
)
499 *val
= (state
->degamma_lut
) ? state
->degamma_lut
->base
.id
: 0;
500 else if (property
== config
->ctm_property
)
501 *val
= (state
->ctm
) ? state
->ctm
->base
.id
: 0;
502 else if (property
== config
->gamma_lut_property
)
503 *val
= (state
->gamma_lut
) ? state
->gamma_lut
->base
.id
: 0;
504 else if (property
== config
->prop_out_fence_ptr
)
506 else if (crtc
->funcs
->atomic_get_property
)
507 return crtc
->funcs
->atomic_get_property(crtc
, state
, property
, val
);
514 static int drm_atomic_plane_set_property(struct drm_plane
*plane
,
515 struct drm_plane_state
*state
, struct drm_file
*file_priv
,
516 struct drm_property
*property
, uint64_t val
)
518 struct drm_device
*dev
= plane
->dev
;
519 struct drm_mode_config
*config
= &dev
->mode_config
;
520 bool replaced
= false;
523 if (property
== config
->prop_fb_id
) {
524 struct drm_framebuffer
*fb
;
525 fb
= drm_framebuffer_lookup(dev
, file_priv
, val
);
526 drm_atomic_set_fb_for_plane(state
, fb
);
528 drm_framebuffer_put(fb
);
529 } else if (property
== config
->prop_in_fence_fd
) {
533 if (U642I64(val
) == -1)
536 state
->fence
= sync_file_get_fence(val
);
540 } else if (property
== config
->prop_crtc_id
) {
541 struct drm_crtc
*crtc
= drm_crtc_find(dev
, file_priv
, val
);
544 return drm_atomic_set_crtc_for_plane(state
, crtc
);
545 } else if (property
== config
->prop_crtc_x
) {
546 state
->crtc_x
= U642I64(val
);
547 } else if (property
== config
->prop_crtc_y
) {
548 state
->crtc_y
= U642I64(val
);
549 } else if (property
== config
->prop_crtc_w
) {
551 } else if (property
== config
->prop_crtc_h
) {
553 } else if (property
== config
->prop_src_x
) {
555 } else if (property
== config
->prop_src_y
) {
557 } else if (property
== config
->prop_src_w
) {
559 } else if (property
== config
->prop_src_h
) {
561 } else if (property
== plane
->alpha_property
) {
563 } else if (property
== plane
->blend_mode_property
) {
564 state
->pixel_blend_mode
= val
;
565 } else if (property
== plane
->rotation_property
) {
566 if (!is_power_of_2(val
& DRM_MODE_ROTATE_MASK
)) {
567 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] bad rotation bitmask: 0x%llx\n",
568 plane
->base
.id
, plane
->name
, val
);
571 state
->rotation
= val
;
572 } else if (property
== plane
->zpos_property
) {
574 } else if (property
== plane
->color_encoding_property
) {
575 state
->color_encoding
= val
;
576 } else if (property
== plane
->color_range_property
) {
577 state
->color_range
= val
;
578 } else if (property
== config
->prop_fb_damage_clips
) {
579 ret
= drm_atomic_replace_property_blob_from_id(dev
,
580 &state
->fb_damage_clips
,
583 sizeof(struct drm_rect
),
586 } else if (plane
->funcs
->atomic_set_property
) {
587 return plane
->funcs
->atomic_set_property(plane
, state
,
590 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] unknown property [PROP:%d:%s]]\n",
591 plane
->base
.id
, plane
->name
,
592 property
->base
.id
, property
->name
);
600 drm_atomic_plane_get_property(struct drm_plane
*plane
,
601 const struct drm_plane_state
*state
,
602 struct drm_property
*property
, uint64_t *val
)
604 struct drm_device
*dev
= plane
->dev
;
605 struct drm_mode_config
*config
= &dev
->mode_config
;
607 if (property
== config
->prop_fb_id
) {
608 *val
= (state
->fb
) ? state
->fb
->base
.id
: 0;
609 } else if (property
== config
->prop_in_fence_fd
) {
611 } else if (property
== config
->prop_crtc_id
) {
612 *val
= (state
->crtc
) ? state
->crtc
->base
.id
: 0;
613 } else if (property
== config
->prop_crtc_x
) {
614 *val
= I642U64(state
->crtc_x
);
615 } else if (property
== config
->prop_crtc_y
) {
616 *val
= I642U64(state
->crtc_y
);
617 } else if (property
== config
->prop_crtc_w
) {
618 *val
= state
->crtc_w
;
619 } else if (property
== config
->prop_crtc_h
) {
620 *val
= state
->crtc_h
;
621 } else if (property
== config
->prop_src_x
) {
623 } else if (property
== config
->prop_src_y
) {
625 } else if (property
== config
->prop_src_w
) {
627 } else if (property
== config
->prop_src_h
) {
629 } else if (property
== plane
->alpha_property
) {
631 } else if (property
== plane
->blend_mode_property
) {
632 *val
= state
->pixel_blend_mode
;
633 } else if (property
== plane
->rotation_property
) {
634 *val
= state
->rotation
;
635 } else if (property
== plane
->zpos_property
) {
637 } else if (property
== plane
->color_encoding_property
) {
638 *val
= state
->color_encoding
;
639 } else if (property
== plane
->color_range_property
) {
640 *val
= state
->color_range
;
641 } else if (property
== config
->prop_fb_damage_clips
) {
642 *val
= (state
->fb_damage_clips
) ?
643 state
->fb_damage_clips
->base
.id
: 0;
644 } else if (plane
->funcs
->atomic_get_property
) {
645 return plane
->funcs
->atomic_get_property(plane
, state
, property
, val
);
653 static int drm_atomic_set_writeback_fb_for_connector(
654 struct drm_connector_state
*conn_state
,
655 struct drm_framebuffer
*fb
)
659 ret
= drm_writeback_set_fb(conn_state
, fb
);
664 DRM_DEBUG_ATOMIC("Set [FB:%d] for connector state %p\n",
665 fb
->base
.id
, conn_state
);
667 DRM_DEBUG_ATOMIC("Set [NOFB] for connector state %p\n",
673 static int drm_atomic_connector_set_property(struct drm_connector
*connector
,
674 struct drm_connector_state
*state
, struct drm_file
*file_priv
,
675 struct drm_property
*property
, uint64_t val
)
677 struct drm_device
*dev
= connector
->dev
;
678 struct drm_mode_config
*config
= &dev
->mode_config
;
679 bool replaced
= false;
682 if (property
== config
->prop_crtc_id
) {
683 struct drm_crtc
*crtc
= drm_crtc_find(dev
, file_priv
, val
);
686 return drm_atomic_set_crtc_for_connector(state
, crtc
);
687 } else if (property
== config
->dpms_property
) {
688 /* setting DPMS property requires special handling, which
689 * is done in legacy setprop path for us. Disallow (for
690 * now?) atomic writes to DPMS property:
693 } else if (property
== config
->tv_select_subconnector_property
) {
694 state
->tv
.subconnector
= val
;
695 } else if (property
== config
->tv_left_margin_property
) {
696 state
->tv
.margins
.left
= val
;
697 } else if (property
== config
->tv_right_margin_property
) {
698 state
->tv
.margins
.right
= val
;
699 } else if (property
== config
->tv_top_margin_property
) {
700 state
->tv
.margins
.top
= val
;
701 } else if (property
== config
->tv_bottom_margin_property
) {
702 state
->tv
.margins
.bottom
= val
;
703 } else if (property
== config
->tv_mode_property
) {
704 state
->tv
.mode
= val
;
705 } else if (property
== config
->tv_brightness_property
) {
706 state
->tv
.brightness
= val
;
707 } else if (property
== config
->tv_contrast_property
) {
708 state
->tv
.contrast
= val
;
709 } else if (property
== config
->tv_flicker_reduction_property
) {
710 state
->tv
.flicker_reduction
= val
;
711 } else if (property
== config
->tv_overscan_property
) {
712 state
->tv
.overscan
= val
;
713 } else if (property
== config
->tv_saturation_property
) {
714 state
->tv
.saturation
= val
;
715 } else if (property
== config
->tv_hue_property
) {
717 } else if (property
== config
->link_status_property
) {
718 /* Never downgrade from GOOD to BAD on userspace's request here,
719 * only hw issues can do that.
721 * For an atomic property the userspace doesn't need to be able
722 * to understand all the properties, but needs to be able to
723 * restore the state it wants on VT switch. So if the userspace
724 * tries to change the link_status from GOOD to BAD, driver
725 * silently rejects it and returns a 0. This prevents userspace
726 * from accidently breaking the display when it restores the
729 if (state
->link_status
!= DRM_LINK_STATUS_GOOD
)
730 state
->link_status
= val
;
731 } else if (property
== config
->hdr_output_metadata_property
) {
732 ret
= drm_atomic_replace_property_blob_from_id(dev
,
733 &state
->hdr_output_metadata
,
735 sizeof(struct hdr_output_metadata
), -1,
738 } else if (property
== config
->aspect_ratio_property
) {
739 state
->picture_aspect_ratio
= val
;
740 } else if (property
== config
->content_type_property
) {
741 state
->content_type
= val
;
742 } else if (property
== connector
->scaling_mode_property
) {
743 state
->scaling_mode
= val
;
744 } else if (property
== config
->content_protection_property
) {
745 if (val
== DRM_MODE_CONTENT_PROTECTION_ENABLED
) {
746 DRM_DEBUG_KMS("only drivers can set CP Enabled\n");
749 state
->content_protection
= val
;
750 } else if (property
== config
->hdcp_content_type_property
) {
751 state
->hdcp_content_type
= val
;
752 } else if (property
== connector
->colorspace_property
) {
753 state
->colorspace
= val
;
754 } else if (property
== config
->writeback_fb_id_property
) {
755 struct drm_framebuffer
*fb
;
757 fb
= drm_framebuffer_lookup(dev
, file_priv
, val
);
758 ret
= drm_atomic_set_writeback_fb_for_connector(state
, fb
);
760 drm_framebuffer_put(fb
);
762 } else if (property
== config
->writeback_out_fence_ptr_property
) {
763 s32 __user
*fence_ptr
= u64_to_user_ptr(val
);
765 return set_out_fence_for_connector(state
->state
, connector
,
767 } else if (property
== connector
->max_bpc_property
) {
768 state
->max_requested_bpc
= val
;
769 } else if (connector
->funcs
->atomic_set_property
) {
770 return connector
->funcs
->atomic_set_property(connector
,
771 state
, property
, val
);
773 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] unknown property [PROP:%d:%s]]\n",
774 connector
->base
.id
, connector
->name
,
775 property
->base
.id
, property
->name
);
783 drm_atomic_connector_get_property(struct drm_connector
*connector
,
784 const struct drm_connector_state
*state
,
785 struct drm_property
*property
, uint64_t *val
)
787 struct drm_device
*dev
= connector
->dev
;
788 struct drm_mode_config
*config
= &dev
->mode_config
;
790 if (property
== config
->prop_crtc_id
) {
791 *val
= (state
->crtc
) ? state
->crtc
->base
.id
: 0;
792 } else if (property
== config
->dpms_property
) {
793 if (state
->crtc
&& state
->crtc
->state
->self_refresh_active
)
794 *val
= DRM_MODE_DPMS_ON
;
796 *val
= connector
->dpms
;
797 } else if (property
== config
->tv_select_subconnector_property
) {
798 *val
= state
->tv
.subconnector
;
799 } else if (property
== config
->tv_left_margin_property
) {
800 *val
= state
->tv
.margins
.left
;
801 } else if (property
== config
->tv_right_margin_property
) {
802 *val
= state
->tv
.margins
.right
;
803 } else if (property
== config
->tv_top_margin_property
) {
804 *val
= state
->tv
.margins
.top
;
805 } else if (property
== config
->tv_bottom_margin_property
) {
806 *val
= state
->tv
.margins
.bottom
;
807 } else if (property
== config
->tv_mode_property
) {
808 *val
= state
->tv
.mode
;
809 } else if (property
== config
->tv_brightness_property
) {
810 *val
= state
->tv
.brightness
;
811 } else if (property
== config
->tv_contrast_property
) {
812 *val
= state
->tv
.contrast
;
813 } else if (property
== config
->tv_flicker_reduction_property
) {
814 *val
= state
->tv
.flicker_reduction
;
815 } else if (property
== config
->tv_overscan_property
) {
816 *val
= state
->tv
.overscan
;
817 } else if (property
== config
->tv_saturation_property
) {
818 *val
= state
->tv
.saturation
;
819 } else if (property
== config
->tv_hue_property
) {
820 *val
= state
->tv
.hue
;
821 } else if (property
== config
->link_status_property
) {
822 *val
= state
->link_status
;
823 } else if (property
== config
->aspect_ratio_property
) {
824 *val
= state
->picture_aspect_ratio
;
825 } else if (property
== config
->content_type_property
) {
826 *val
= state
->content_type
;
827 } else if (property
== connector
->colorspace_property
) {
828 *val
= state
->colorspace
;
829 } else if (property
== connector
->scaling_mode_property
) {
830 *val
= state
->scaling_mode
;
831 } else if (property
== config
->hdr_output_metadata_property
) {
832 *val
= state
->hdr_output_metadata
?
833 state
->hdr_output_metadata
->base
.id
: 0;
834 } else if (property
== config
->content_protection_property
) {
835 *val
= state
->content_protection
;
836 } else if (property
== config
->hdcp_content_type_property
) {
837 *val
= state
->hdcp_content_type
;
838 } else if (property
== config
->writeback_fb_id_property
) {
839 /* Writeback framebuffer is one-shot, write and forget */
841 } else if (property
== config
->writeback_out_fence_ptr_property
) {
843 } else if (property
== connector
->max_bpc_property
) {
844 *val
= state
->max_requested_bpc
;
845 } else if (connector
->funcs
->atomic_get_property
) {
846 return connector
->funcs
->atomic_get_property(connector
,
847 state
, property
, val
);
855 int drm_atomic_get_property(struct drm_mode_object
*obj
,
856 struct drm_property
*property
, uint64_t *val
)
858 struct drm_device
*dev
= property
->dev
;
862 case DRM_MODE_OBJECT_CONNECTOR
: {
863 struct drm_connector
*connector
= obj_to_connector(obj
);
864 WARN_ON(!drm_modeset_is_locked(&dev
->mode_config
.connection_mutex
));
865 ret
= drm_atomic_connector_get_property(connector
,
866 connector
->state
, property
, val
);
869 case DRM_MODE_OBJECT_CRTC
: {
870 struct drm_crtc
*crtc
= obj_to_crtc(obj
);
871 WARN_ON(!drm_modeset_is_locked(&crtc
->mutex
));
872 ret
= drm_atomic_crtc_get_property(crtc
,
873 crtc
->state
, property
, val
);
876 case DRM_MODE_OBJECT_PLANE
: {
877 struct drm_plane
*plane
= obj_to_plane(obj
);
878 WARN_ON(!drm_modeset_is_locked(&plane
->mutex
));
879 ret
= drm_atomic_plane_get_property(plane
,
880 plane
->state
, property
, val
);
892 * The big monster ioctl
895 static struct drm_pending_vblank_event
*create_vblank_event(
896 struct drm_crtc
*crtc
, uint64_t user_data
)
898 struct drm_pending_vblank_event
*e
= NULL
;
900 e
= kzalloc(sizeof *e
, GFP_KERNEL
);
904 e
->event
.base
.type
= DRM_EVENT_FLIP_COMPLETE
;
905 e
->event
.base
.length
= sizeof(e
->event
);
906 e
->event
.vbl
.crtc_id
= crtc
->base
.id
;
907 e
->event
.vbl
.user_data
= user_data
;
912 int drm_atomic_connector_commit_dpms(struct drm_atomic_state
*state
,
913 struct drm_connector
*connector
,
916 struct drm_connector
*tmp_connector
;
917 struct drm_connector_state
*new_conn_state
;
918 struct drm_crtc
*crtc
;
919 struct drm_crtc_state
*crtc_state
;
920 int i
, ret
, old_mode
= connector
->dpms
;
923 ret
= drm_modeset_lock(&state
->dev
->mode_config
.connection_mutex
,
928 if (mode
!= DRM_MODE_DPMS_ON
)
929 mode
= DRM_MODE_DPMS_OFF
;
930 connector
->dpms
= mode
;
932 crtc
= connector
->state
->crtc
;
935 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
939 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
940 if (IS_ERR(crtc_state
)) {
941 ret
= PTR_ERR(crtc_state
);
945 for_each_new_connector_in_state(state
, tmp_connector
, new_conn_state
, i
) {
946 if (new_conn_state
->crtc
!= crtc
)
948 if (tmp_connector
->dpms
== DRM_MODE_DPMS_ON
) {
954 crtc_state
->active
= active
;
955 ret
= drm_atomic_commit(state
);
958 connector
->dpms
= old_mode
;
962 int drm_atomic_set_property(struct drm_atomic_state
*state
,
963 struct drm_file
*file_priv
,
964 struct drm_mode_object
*obj
,
965 struct drm_property
*prop
,
968 struct drm_mode_object
*ref
;
971 if (!drm_property_change_valid_get(prop
, prop_value
, &ref
))
975 case DRM_MODE_OBJECT_CONNECTOR
: {
976 struct drm_connector
*connector
= obj_to_connector(obj
);
977 struct drm_connector_state
*connector_state
;
979 connector_state
= drm_atomic_get_connector_state(state
, connector
);
980 if (IS_ERR(connector_state
)) {
981 ret
= PTR_ERR(connector_state
);
985 ret
= drm_atomic_connector_set_property(connector
,
986 connector_state
, file_priv
,
990 case DRM_MODE_OBJECT_CRTC
: {
991 struct drm_crtc
*crtc
= obj_to_crtc(obj
);
992 struct drm_crtc_state
*crtc_state
;
994 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
995 if (IS_ERR(crtc_state
)) {
996 ret
= PTR_ERR(crtc_state
);
1000 ret
= drm_atomic_crtc_set_property(crtc
,
1001 crtc_state
, prop
, prop_value
);
1004 case DRM_MODE_OBJECT_PLANE
: {
1005 struct drm_plane
*plane
= obj_to_plane(obj
);
1006 struct drm_plane_state
*plane_state
;
1008 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1009 if (IS_ERR(plane_state
)) {
1010 ret
= PTR_ERR(plane_state
);
1014 ret
= drm_atomic_plane_set_property(plane
,
1015 plane_state
, file_priv
,
1024 drm_property_change_valid_put(prop
, ref
);
1029 * DOC: explicit fencing properties
1031 * Explicit fencing allows userspace to control the buffer synchronization
1032 * between devices. A Fence or a group of fences are transfered to/from
1033 * userspace using Sync File fds and there are two DRM properties for that.
1034 * IN_FENCE_FD on each DRM Plane to send fences to the kernel and
1035 * OUT_FENCE_PTR on each DRM CRTC to receive fences from the kernel.
1037 * As a contrast, with implicit fencing the kernel keeps track of any
1038 * ongoing rendering, and automatically ensures that the atomic update waits
1039 * for any pending rendering to complete. For shared buffers represented with
1040 * a &struct dma_buf this is tracked in &struct dma_resv.
1041 * Implicit syncing is how Linux traditionally worked (e.g. DRI2/3 on X.org),
1042 * whereas explicit fencing is what Android wants.
1045 * Use this property to pass a fence that DRM should wait on before
1046 * proceeding with the Atomic Commit request and show the framebuffer for
1047 * the plane on the screen. The fence can be either a normal fence or a
1048 * merged one, the sync_file framework will handle both cases and use a
1049 * fence_array if a merged fence is received. Passing -1 here means no
1050 * fences to wait on.
1052 * If the Atomic Commit request has the DRM_MODE_ATOMIC_TEST_ONLY flag
1053 * it will only check if the Sync File is a valid one.
1055 * On the driver side the fence is stored on the @fence parameter of
1056 * &struct drm_plane_state. Drivers which also support implicit fencing
1057 * should set the implicit fence using drm_atomic_set_fence_for_plane(),
1058 * to make sure there's consistent behaviour between drivers in precedence
1059 * of implicit vs. explicit fencing.
1062 * Use this property to pass a file descriptor pointer to DRM. Once the
1063 * Atomic Commit request call returns OUT_FENCE_PTR will be filled with
1064 * the file descriptor number of a Sync File. This Sync File contains the
1065 * CRTC fence that will be signaled when all framebuffers present on the
1066 * Atomic Commit * request for that given CRTC are scanned out on the
1069 * The Atomic Commit request fails if a invalid pointer is passed. If the
1070 * Atomic Commit request fails for any other reason the out fence fd
1071 * returned will be -1. On a Atomic Commit with the
1072 * DRM_MODE_ATOMIC_TEST_ONLY flag the out fence will also be set to -1.
1074 * Note that out-fences don't have a special interface to drivers and are
1075 * internally represented by a &struct drm_pending_vblank_event in struct
1076 * &drm_crtc_state, which is also used by the nonblocking atomic commit
1077 * helpers and for the DRM event handling for existing userspace.
1080 struct drm_out_fence_state
{
1081 s32 __user
*out_fence_ptr
;
1082 struct sync_file
*sync_file
;
1086 static int setup_out_fence(struct drm_out_fence_state
*fence_state
,
1087 struct dma_fence
*fence
)
1089 fence_state
->fd
= get_unused_fd_flags(O_CLOEXEC
);
1090 if (fence_state
->fd
< 0)
1091 return fence_state
->fd
;
1093 if (put_user(fence_state
->fd
, fence_state
->out_fence_ptr
))
1096 fence_state
->sync_file
= sync_file_create(fence
);
1097 if (!fence_state
->sync_file
)
1103 static int prepare_signaling(struct drm_device
*dev
,
1104 struct drm_atomic_state
*state
,
1105 struct drm_mode_atomic
*arg
,
1106 struct drm_file
*file_priv
,
1107 struct drm_out_fence_state
**fence_state
,
1108 unsigned int *num_fences
)
1110 struct drm_crtc
*crtc
;
1111 struct drm_crtc_state
*crtc_state
;
1112 struct drm_connector
*conn
;
1113 struct drm_connector_state
*conn_state
;
1116 if (arg
->flags
& DRM_MODE_ATOMIC_TEST_ONLY
)
1119 for_each_new_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1120 s32 __user
*fence_ptr
;
1122 fence_ptr
= get_out_fence_for_crtc(crtc_state
->state
, crtc
);
1124 if (arg
->flags
& DRM_MODE_PAGE_FLIP_EVENT
|| fence_ptr
) {
1125 struct drm_pending_vblank_event
*e
;
1127 e
= create_vblank_event(crtc
, arg
->user_data
);
1131 crtc_state
->event
= e
;
1134 if (arg
->flags
& DRM_MODE_PAGE_FLIP_EVENT
) {
1135 struct drm_pending_vblank_event
*e
= crtc_state
->event
;
1140 ret
= drm_event_reserve_init(dev
, file_priv
, &e
->base
,
1144 crtc_state
->event
= NULL
;
1150 struct dma_fence
*fence
;
1151 struct drm_out_fence_state
*f
;
1153 f
= krealloc(*fence_state
, sizeof(**fence_state
) *
1154 (*num_fences
+ 1), GFP_KERNEL
);
1158 memset(&f
[*num_fences
], 0, sizeof(*f
));
1160 f
[*num_fences
].out_fence_ptr
= fence_ptr
;
1163 fence
= drm_crtc_create_fence(crtc
);
1167 ret
= setup_out_fence(&f
[(*num_fences
)++], fence
);
1169 dma_fence_put(fence
);
1173 crtc_state
->event
->base
.fence
= fence
;
1179 for_each_new_connector_in_state(state
, conn
, conn_state
, i
) {
1180 struct drm_writeback_connector
*wb_conn
;
1181 struct drm_out_fence_state
*f
;
1182 struct dma_fence
*fence
;
1183 s32 __user
*fence_ptr
;
1185 if (!conn_state
->writeback_job
)
1188 fence_ptr
= get_out_fence_for_connector(state
, conn
);
1192 f
= krealloc(*fence_state
, sizeof(**fence_state
) *
1193 (*num_fences
+ 1), GFP_KERNEL
);
1197 memset(&f
[*num_fences
], 0, sizeof(*f
));
1199 f
[*num_fences
].out_fence_ptr
= fence_ptr
;
1202 wb_conn
= drm_connector_to_writeback(conn
);
1203 fence
= drm_writeback_get_out_fence(wb_conn
);
1207 ret
= setup_out_fence(&f
[(*num_fences
)++], fence
);
1209 dma_fence_put(fence
);
1213 conn_state
->writeback_job
->out_fence
= fence
;
1217 * Having this flag means user mode pends on event which will never
1218 * reach due to lack of at least one CRTC for signaling
1220 if (c
== 0 && (arg
->flags
& DRM_MODE_PAGE_FLIP_EVENT
))
1226 static void complete_signaling(struct drm_device
*dev
,
1227 struct drm_atomic_state
*state
,
1228 struct drm_out_fence_state
*fence_state
,
1229 unsigned int num_fences
,
1232 struct drm_crtc
*crtc
;
1233 struct drm_crtc_state
*crtc_state
;
1237 for (i
= 0; i
< num_fences
; i
++)
1238 fd_install(fence_state
[i
].fd
,
1239 fence_state
[i
].sync_file
->file
);
1245 for_each_new_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1246 struct drm_pending_vblank_event
*event
= crtc_state
->event
;
1248 * Free the allocated event. drm_atomic_helper_setup_commit
1249 * can allocate an event too, so only free it if it's ours
1250 * to prevent a double free in drm_atomic_state_clear.
1252 if (event
&& (event
->base
.fence
|| event
->base
.file_priv
)) {
1253 drm_event_cancel_free(dev
, &event
->base
);
1254 crtc_state
->event
= NULL
;
1261 for (i
= 0; i
< num_fences
; i
++) {
1262 if (fence_state
[i
].sync_file
)
1263 fput(fence_state
[i
].sync_file
->file
);
1264 if (fence_state
[i
].fd
>= 0)
1265 put_unused_fd(fence_state
[i
].fd
);
1267 /* If this fails log error to the user */
1268 if (fence_state
[i
].out_fence_ptr
&&
1269 put_user(-1, fence_state
[i
].out_fence_ptr
))
1270 DRM_DEBUG_ATOMIC("Couldn't clear out_fence_ptr\n");
1276 int drm_mode_atomic_ioctl(struct drm_device
*dev
,
1277 void *data
, struct drm_file
*file_priv
)
1279 struct drm_mode_atomic
*arg
= data
;
1280 uint32_t __user
*objs_ptr
= (uint32_t __user
*)(unsigned long)(arg
->objs_ptr
);
1281 uint32_t __user
*count_props_ptr
= (uint32_t __user
*)(unsigned long)(arg
->count_props_ptr
);
1282 uint32_t __user
*props_ptr
= (uint32_t __user
*)(unsigned long)(arg
->props_ptr
);
1283 uint64_t __user
*prop_values_ptr
= (uint64_t __user
*)(unsigned long)(arg
->prop_values_ptr
);
1284 unsigned int copied_objs
, copied_props
;
1285 struct drm_atomic_state
*state
;
1286 struct drm_modeset_acquire_ctx ctx
;
1287 struct drm_out_fence_state
*fence_state
;
1289 unsigned int i
, j
, num_fences
;
1291 /* disallow for drivers not supporting atomic: */
1292 if (!drm_core_check_feature(dev
, DRIVER_ATOMIC
))
1295 /* disallow for userspace that has not enabled atomic cap (even
1296 * though this may be a bit overkill, since legacy userspace
1297 * wouldn't know how to call this ioctl)
1299 if (!file_priv
->atomic
)
1302 if (arg
->flags
& ~DRM_MODE_ATOMIC_FLAGS
)
1308 if (arg
->flags
& DRM_MODE_PAGE_FLIP_ASYNC
)
1311 /* can't test and expect an event at the same time. */
1312 if ((arg
->flags
& DRM_MODE_ATOMIC_TEST_ONLY
) &&
1313 (arg
->flags
& DRM_MODE_PAGE_FLIP_EVENT
))
1316 state
= drm_atomic_state_alloc(dev
);
1320 drm_modeset_acquire_init(&ctx
, DRM_MODESET_ACQUIRE_INTERRUPTIBLE
);
1321 state
->acquire_ctx
= &ctx
;
1322 state
->allow_modeset
= !!(arg
->flags
& DRM_MODE_ATOMIC_ALLOW_MODESET
);
1330 for (i
= 0; i
< arg
->count_objs
; i
++) {
1331 uint32_t obj_id
, count_props
;
1332 struct drm_mode_object
*obj
;
1334 if (get_user(obj_id
, objs_ptr
+ copied_objs
)) {
1339 obj
= drm_mode_object_find(dev
, file_priv
, obj_id
, DRM_MODE_OBJECT_ANY
);
1345 if (!obj
->properties
) {
1346 drm_mode_object_put(obj
);
1351 if (get_user(count_props
, count_props_ptr
+ copied_objs
)) {
1352 drm_mode_object_put(obj
);
1359 for (j
= 0; j
< count_props
; j
++) {
1361 uint64_t prop_value
;
1362 struct drm_property
*prop
;
1364 if (get_user(prop_id
, props_ptr
+ copied_props
)) {
1365 drm_mode_object_put(obj
);
1370 prop
= drm_mode_obj_find_prop_id(obj
, prop_id
);
1372 drm_mode_object_put(obj
);
1377 if (copy_from_user(&prop_value
,
1378 prop_values_ptr
+ copied_props
,
1379 sizeof(prop_value
))) {
1380 drm_mode_object_put(obj
);
1385 ret
= drm_atomic_set_property(state
, file_priv
,
1386 obj
, prop
, prop_value
);
1388 drm_mode_object_put(obj
);
1395 drm_mode_object_put(obj
);
1398 ret
= prepare_signaling(dev
, state
, arg
, file_priv
, &fence_state
,
1403 if (arg
->flags
& DRM_MODE_ATOMIC_TEST_ONLY
) {
1404 ret
= drm_atomic_check_only(state
);
1405 } else if (arg
->flags
& DRM_MODE_ATOMIC_NONBLOCK
) {
1406 ret
= drm_atomic_nonblocking_commit(state
);
1408 if (drm_debug_enabled(DRM_UT_STATE
))
1409 drm_atomic_print_state(state
);
1411 ret
= drm_atomic_commit(state
);
1415 complete_signaling(dev
, state
, fence_state
, num_fences
, !ret
);
1417 if (ret
== -EDEADLK
) {
1418 drm_atomic_state_clear(state
);
1419 ret
= drm_modeset_backoff(&ctx
);
1424 drm_atomic_state_put(state
);
1426 drm_modeset_drop_locks(&ctx
);
1427 drm_modeset_acquire_fini(&ctx
);