2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
4 * Copyright (C) 2018 Intel Corp.
5 * Copyright (c) 2020, The Linux Foundation. All rights reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
30 #include <drm/drm_atomic_uapi.h>
31 #include <drm/drm_atomic.h>
32 #include <drm/drm_print.h>
33 #include <drm/drm_drv.h>
34 #include <drm/drm_writeback.h>
35 #include <drm/drm_vblank.h>
37 #include <linux/dma-fence.h>
38 #include <linux/uaccess.h>
39 #include <linux/sync_file.h>
40 #include <linux/file.h>
42 #include "drm_crtc_internal.h"
47 * This file contains the marshalling and demarshalling glue for the atomic UAPI
48 * in all its forms: The monster ATOMIC IOCTL itself, code for GET_PROPERTY and
49 * SET_PROPERTY IOCTLs. Plus interface functions for compatibility helpers and
50 * drivers which have special needs to construct their own atomic updates, e.g.
51 * for load detect or similar.
55 * drm_atomic_set_mode_for_crtc - set mode for CRTC
56 * @state: the CRTC whose incoming state to update
57 * @mode: kernel-internal mode to use for the CRTC, or NULL to disable
59 * Set a mode (originating from the kernel) on the desired CRTC state and update
60 * the enable property.
63 * Zero on success, error code on failure. Cannot return -EDEADLK.
65 int drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
66 const struct drm_display_mode *mode)
68 struct drm_crtc *crtc = state->crtc;
69 struct drm_mode_modeinfo umode;
71 /* Early return for no change. */
72 if (mode && memcmp(&state->mode, mode, sizeof(*mode)) == 0)
75 drm_property_blob_put(state->mode_blob);
76 state->mode_blob = NULL;
79 drm_mode_convert_to_umode(&umode, mode);
81 drm_property_create_blob(state->crtc->dev,
84 if (IS_ERR(state->mode_blob))
85 return PTR_ERR(state->mode_blob);
87 drm_mode_copy(&state->mode, mode);
89 drm_dbg_atomic(crtc->dev,
90 "Set [MODE:%s] for [CRTC:%d:%s] state %p\n",
91 mode->name, crtc->base.id, crtc->name, state);
93 memset(&state->mode, 0, sizeof(state->mode));
94 state->enable = false;
95 drm_dbg_atomic(crtc->dev,
96 "Set [NOMODE] for [CRTC:%d:%s] state %p\n",
97 crtc->base.id, crtc->name, state);
102 EXPORT_SYMBOL(drm_atomic_set_mode_for_crtc);
105 * drm_atomic_set_mode_prop_for_crtc - set mode for CRTC
106 * @state: the CRTC whose incoming state to update
107 * @blob: pointer to blob property to use for mode
109 * Set a mode (originating from a blob property) on the desired CRTC state.
110 * This function will take a reference on the blob property for the CRTC state,
111 * and release the reference held on the state's existing mode property, if any
115 * Zero on success, error code on failure. Cannot return -EDEADLK.
117 int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
118 struct drm_property_blob *blob)
120 struct drm_crtc *crtc = state->crtc;
122 if (blob == state->mode_blob)
125 drm_property_blob_put(state->mode_blob);
126 state->mode_blob = NULL;
128 memset(&state->mode, 0, sizeof(state->mode));
133 if (blob->length != sizeof(struct drm_mode_modeinfo)) {
134 drm_dbg_atomic(crtc->dev,
135 "[CRTC:%d:%s] bad mode blob length: %zu\n",
136 crtc->base.id, crtc->name,
141 ret = drm_mode_convert_umode(crtc->dev,
142 &state->mode, blob->data);
144 drm_dbg_atomic(crtc->dev,
145 "[CRTC:%d:%s] invalid mode (ret=%d, status=%s):\n",
146 crtc->base.id, crtc->name,
147 ret, drm_get_mode_status_name(state->mode.status));
148 drm_mode_debug_printmodeline(&state->mode);
152 state->mode_blob = drm_property_blob_get(blob);
153 state->enable = true;
154 drm_dbg_atomic(crtc->dev,
155 "Set [MODE:%s] for [CRTC:%d:%s] state %p\n",
156 state->mode.name, crtc->base.id, crtc->name,
159 state->enable = false;
160 drm_dbg_atomic(crtc->dev,
161 "Set [NOMODE] for [CRTC:%d:%s] state %p\n",
162 crtc->base.id, crtc->name, state);
167 EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc);
170 * drm_atomic_set_crtc_for_plane - set CRTC for plane
171 * @plane_state: the plane whose incoming state to update
172 * @crtc: CRTC to use for the plane
174 * Changing the assigned CRTC for a plane requires us to grab the lock and state
175 * for the new CRTC, as needed. This function takes care of all these details
176 * besides updating the pointer in the state object itself.
179 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
180 * then the w/w mutex code has detected a deadlock and the entire atomic
181 * sequence must be restarted. All other errors are fatal.
184 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
185 struct drm_crtc *crtc)
187 struct drm_plane *plane = plane_state->plane;
188 struct drm_crtc_state *crtc_state;
189 /* Nothing to do for same crtc*/
190 if (plane_state->crtc == crtc)
192 if (plane_state->crtc) {
193 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
195 if (WARN_ON(IS_ERR(crtc_state)))
196 return PTR_ERR(crtc_state);
198 crtc_state->plane_mask &= ~drm_plane_mask(plane);
201 plane_state->crtc = crtc;
204 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
206 if (IS_ERR(crtc_state))
207 return PTR_ERR(crtc_state);
208 crtc_state->plane_mask |= drm_plane_mask(plane);
212 drm_dbg_atomic(plane->dev,
213 "Link [PLANE:%d:%s] state %p to [CRTC:%d:%s]\n",
214 plane->base.id, plane->name, plane_state,
215 crtc->base.id, crtc->name);
217 drm_dbg_atomic(plane->dev,
218 "Link [PLANE:%d:%s] state %p to [NOCRTC]\n",
219 plane->base.id, plane->name, plane_state);
223 EXPORT_SYMBOL(drm_atomic_set_crtc_for_plane);
226 * drm_atomic_set_fb_for_plane - set framebuffer for plane
227 * @plane_state: atomic state object for the plane
228 * @fb: fb to use for the plane
230 * Changing the assigned framebuffer for a plane requires us to grab a reference
231 * to the new fb and drop the reference to the old fb, if there is one. This
232 * function takes care of all these details besides updating the pointer in the
233 * state object itself.
236 drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
237 struct drm_framebuffer *fb)
239 struct drm_plane *plane = plane_state->plane;
242 drm_dbg_atomic(plane->dev,
243 "Set [FB:%d] for [PLANE:%d:%s] state %p\n",
244 fb->base.id, plane->base.id, plane->name,
247 drm_dbg_atomic(plane->dev,
248 "Set [NOFB] for [PLANE:%d:%s] state %p\n",
249 plane->base.id, plane->name, plane_state);
251 drm_framebuffer_assign(&plane_state->fb, fb);
253 EXPORT_SYMBOL(drm_atomic_set_fb_for_plane);
256 * drm_atomic_set_fence_for_plane - set fence for plane
257 * @plane_state: atomic state object for the plane
258 * @fence: dma_fence to use for the plane
260 * Helper to setup the plane_state fence in case it is not set yet.
261 * By using this drivers doesn't need to worry if the user choose
262 * implicit or explicit fencing.
264 * This function will not set the fence to the state if it was set
265 * via explicit fencing interfaces on the atomic ioctl. In that case it will
266 * drop the reference to the fence as we are not storing it anywhere.
267 * Otherwise, if &drm_plane_state.fence is not set this function we just set it
268 * with the received implicit fence. In both cases this function consumes a
269 * reference for @fence.
271 * This way explicit fencing can be used to overrule implicit fencing, which is
272 * important to make explicit fencing use-cases work: One example is using one
273 * buffer for 2 screens with different refresh rates. Implicit fencing will
274 * clamp rendering to the refresh rate of the slower screen, whereas explicit
275 * fence allows 2 independent render and display loops on a single buffer. If a
276 * driver allows obeys both implicit and explicit fences for plane updates, then
277 * it will break all the benefits of explicit fencing.
280 drm_atomic_set_fence_for_plane(struct drm_plane_state *plane_state,
281 struct dma_fence *fence)
283 if (plane_state->fence) {
284 dma_fence_put(fence);
288 plane_state->fence = fence;
290 EXPORT_SYMBOL(drm_atomic_set_fence_for_plane);
293 * drm_atomic_set_crtc_for_connector - set CRTC for connector
294 * @conn_state: atomic state object for the connector
295 * @crtc: CRTC to use for the connector
297 * Changing the assigned CRTC for a connector requires us to grab the lock and
298 * state for the new CRTC, as needed. This function takes care of all these
299 * details besides updating the pointer in the state object itself.
302 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
303 * then the w/w mutex code has detected a deadlock and the entire atomic
304 * sequence must be restarted. All other errors are fatal.
307 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
308 struct drm_crtc *crtc)
310 struct drm_connector *connector = conn_state->connector;
311 struct drm_crtc_state *crtc_state;
313 if (conn_state->crtc == crtc)
316 if (conn_state->crtc) {
317 crtc_state = drm_atomic_get_new_crtc_state(conn_state->state,
320 crtc_state->connector_mask &=
321 ~drm_connector_mask(conn_state->connector);
323 drm_connector_put(conn_state->connector);
324 conn_state->crtc = NULL;
328 crtc_state = drm_atomic_get_crtc_state(conn_state->state, crtc);
329 if (IS_ERR(crtc_state))
330 return PTR_ERR(crtc_state);
332 crtc_state->connector_mask |=
333 drm_connector_mask(conn_state->connector);
335 drm_connector_get(conn_state->connector);
336 conn_state->crtc = crtc;
338 drm_dbg_atomic(connector->dev,
339 "Link [CONNECTOR:%d:%s] state %p to [CRTC:%d:%s]\n",
340 connector->base.id, connector->name,
341 conn_state, crtc->base.id, crtc->name);
343 drm_dbg_atomic(connector->dev,
344 "Link [CONNECTOR:%d:%s] state %p to [NOCRTC]\n",
345 connector->base.id, connector->name,
351 EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
353 static void set_out_fence_for_crtc(struct drm_atomic_state *state,
354 struct drm_crtc *crtc, s32 __user *fence_ptr)
356 state->crtcs[drm_crtc_index(crtc)].out_fence_ptr = fence_ptr;
359 static s32 __user *get_out_fence_for_crtc(struct drm_atomic_state *state,
360 struct drm_crtc *crtc)
362 s32 __user *fence_ptr;
364 fence_ptr = state->crtcs[drm_crtc_index(crtc)].out_fence_ptr;
365 state->crtcs[drm_crtc_index(crtc)].out_fence_ptr = NULL;
370 static int set_out_fence_for_connector(struct drm_atomic_state *state,
371 struct drm_connector *connector,
372 s32 __user *fence_ptr)
374 unsigned int index = drm_connector_index(connector);
379 if (put_user(-1, fence_ptr))
382 state->connectors[index].out_fence_ptr = fence_ptr;
387 static s32 __user *get_out_fence_for_connector(struct drm_atomic_state *state,
388 struct drm_connector *connector)
390 unsigned int index = drm_connector_index(connector);
391 s32 __user *fence_ptr;
393 fence_ptr = state->connectors[index].out_fence_ptr;
394 state->connectors[index].out_fence_ptr = NULL;
400 drm_atomic_replace_property_blob_from_id(struct drm_device *dev,
401 struct drm_property_blob **blob,
403 ssize_t expected_size,
404 ssize_t expected_elem_size,
407 struct drm_property_blob *new_blob = NULL;
410 new_blob = drm_property_lookup_blob(dev, blob_id);
411 if (new_blob == NULL)
414 if (expected_size > 0 &&
415 new_blob->length != expected_size) {
416 drm_property_blob_put(new_blob);
419 if (expected_elem_size > 0 &&
420 new_blob->length % expected_elem_size != 0) {
421 drm_property_blob_put(new_blob);
426 *replaced |= drm_property_replace_blob(blob, new_blob);
427 drm_property_blob_put(new_blob);
432 static int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
433 struct drm_crtc_state *state, struct drm_property *property,
436 struct drm_device *dev = crtc->dev;
437 struct drm_mode_config *config = &dev->mode_config;
438 bool replaced = false;
441 if (property == config->prop_active)
443 else if (property == config->prop_mode_id) {
444 struct drm_property_blob *mode =
445 drm_property_lookup_blob(dev, val);
446 ret = drm_atomic_set_mode_prop_for_crtc(state, mode);
447 drm_property_blob_put(mode);
449 } else if (property == config->prop_vrr_enabled) {
450 state->vrr_enabled = val;
451 } else if (property == config->degamma_lut_property) {
452 ret = drm_atomic_replace_property_blob_from_id(dev,
455 -1, sizeof(struct drm_color_lut),
457 state->color_mgmt_changed |= replaced;
459 } else if (property == config->ctm_property) {
460 ret = drm_atomic_replace_property_blob_from_id(dev,
463 sizeof(struct drm_color_ctm), -1,
465 state->color_mgmt_changed |= replaced;
467 } else if (property == config->gamma_lut_property) {
468 ret = drm_atomic_replace_property_blob_from_id(dev,
471 -1, sizeof(struct drm_color_lut),
473 state->color_mgmt_changed |= replaced;
475 } else if (property == config->prop_out_fence_ptr) {
476 s32 __user *fence_ptr = u64_to_user_ptr(val);
481 if (put_user(-1, fence_ptr))
484 set_out_fence_for_crtc(state->state, crtc, fence_ptr);
485 } else if (property == crtc->scaling_filter_property) {
486 state->scaling_filter = val;
487 } else if (crtc->funcs->atomic_set_property) {
488 return crtc->funcs->atomic_set_property(crtc, state, property, val);
490 drm_dbg_atomic(crtc->dev,
491 "[CRTC:%d:%s] unknown property [PROP:%d:%s]]\n",
492 crtc->base.id, crtc->name,
493 property->base.id, property->name);
501 drm_atomic_crtc_get_property(struct drm_crtc *crtc,
502 const struct drm_crtc_state *state,
503 struct drm_property *property, uint64_t *val)
505 struct drm_device *dev = crtc->dev;
506 struct drm_mode_config *config = &dev->mode_config;
508 if (property == config->prop_active)
509 *val = drm_atomic_crtc_effectively_active(state);
510 else if (property == config->prop_mode_id)
511 *val = (state->mode_blob) ? state->mode_blob->base.id : 0;
512 else if (property == config->prop_vrr_enabled)
513 *val = state->vrr_enabled;
514 else if (property == config->degamma_lut_property)
515 *val = (state->degamma_lut) ? state->degamma_lut->base.id : 0;
516 else if (property == config->ctm_property)
517 *val = (state->ctm) ? state->ctm->base.id : 0;
518 else if (property == config->gamma_lut_property)
519 *val = (state->gamma_lut) ? state->gamma_lut->base.id : 0;
520 else if (property == config->prop_out_fence_ptr)
522 else if (property == crtc->scaling_filter_property)
523 *val = state->scaling_filter;
524 else if (crtc->funcs->atomic_get_property)
525 return crtc->funcs->atomic_get_property(crtc, state, property, val);
532 static int drm_atomic_plane_set_property(struct drm_plane *plane,
533 struct drm_plane_state *state, struct drm_file *file_priv,
534 struct drm_property *property, uint64_t val)
536 struct drm_device *dev = plane->dev;
537 struct drm_mode_config *config = &dev->mode_config;
538 bool replaced = false;
541 if (property == config->prop_fb_id) {
542 struct drm_framebuffer *fb;
544 fb = drm_framebuffer_lookup(dev, file_priv, val);
545 drm_atomic_set_fb_for_plane(state, fb);
547 drm_framebuffer_put(fb);
548 } else if (property == config->prop_in_fence_fd) {
552 if (U642I64(val) == -1)
555 state->fence = sync_file_get_fence(val);
559 } else if (property == config->prop_crtc_id) {
560 struct drm_crtc *crtc = drm_crtc_find(dev, file_priv, val);
564 return drm_atomic_set_crtc_for_plane(state, crtc);
565 } else if (property == config->prop_crtc_x) {
566 state->crtc_x = U642I64(val);
567 } else if (property == config->prop_crtc_y) {
568 state->crtc_y = U642I64(val);
569 } else if (property == config->prop_crtc_w) {
571 } else if (property == config->prop_crtc_h) {
573 } else if (property == config->prop_src_x) {
575 } else if (property == config->prop_src_y) {
577 } else if (property == config->prop_src_w) {
579 } else if (property == config->prop_src_h) {
581 } else if (property == plane->alpha_property) {
583 } else if (property == plane->blend_mode_property) {
584 state->pixel_blend_mode = val;
585 } else if (property == plane->rotation_property) {
586 if (!is_power_of_2(val & DRM_MODE_ROTATE_MASK)) {
587 drm_dbg_atomic(plane->dev,
588 "[PLANE:%d:%s] bad rotation bitmask: 0x%llx\n",
589 plane->base.id, plane->name, val);
592 state->rotation = val;
593 } else if (property == plane->zpos_property) {
595 } else if (property == plane->color_encoding_property) {
596 state->color_encoding = val;
597 } else if (property == plane->color_range_property) {
598 state->color_range = val;
599 } else if (property == config->prop_fb_damage_clips) {
600 ret = drm_atomic_replace_property_blob_from_id(dev,
601 &state->fb_damage_clips,
604 sizeof(struct drm_rect),
607 } else if (property == plane->scaling_filter_property) {
608 state->scaling_filter = val;
609 } else if (plane->funcs->atomic_set_property) {
610 return plane->funcs->atomic_set_property(plane, state,
613 drm_dbg_atomic(plane->dev,
614 "[PLANE:%d:%s] unknown property [PROP:%d:%s]]\n",
615 plane->base.id, plane->name,
616 property->base.id, property->name);
624 drm_atomic_plane_get_property(struct drm_plane *plane,
625 const struct drm_plane_state *state,
626 struct drm_property *property, uint64_t *val)
628 struct drm_device *dev = plane->dev;
629 struct drm_mode_config *config = &dev->mode_config;
631 if (property == config->prop_fb_id) {
632 *val = (state->fb) ? state->fb->base.id : 0;
633 } else if (property == config->prop_in_fence_fd) {
635 } else if (property == config->prop_crtc_id) {
636 *val = (state->crtc) ? state->crtc->base.id : 0;
637 } else if (property == config->prop_crtc_x) {
638 *val = I642U64(state->crtc_x);
639 } else if (property == config->prop_crtc_y) {
640 *val = I642U64(state->crtc_y);
641 } else if (property == config->prop_crtc_w) {
642 *val = state->crtc_w;
643 } else if (property == config->prop_crtc_h) {
644 *val = state->crtc_h;
645 } else if (property == config->prop_src_x) {
647 } else if (property == config->prop_src_y) {
649 } else if (property == config->prop_src_w) {
651 } else if (property == config->prop_src_h) {
653 } else if (property == plane->alpha_property) {
655 } else if (property == plane->blend_mode_property) {
656 *val = state->pixel_blend_mode;
657 } else if (property == plane->rotation_property) {
658 *val = state->rotation;
659 } else if (property == plane->zpos_property) {
661 } else if (property == plane->color_encoding_property) {
662 *val = state->color_encoding;
663 } else if (property == plane->color_range_property) {
664 *val = state->color_range;
665 } else if (property == config->prop_fb_damage_clips) {
666 *val = (state->fb_damage_clips) ?
667 state->fb_damage_clips->base.id : 0;
668 } else if (property == plane->scaling_filter_property) {
669 *val = state->scaling_filter;
670 } else if (plane->funcs->atomic_get_property) {
671 return plane->funcs->atomic_get_property(plane, state, property, val);
679 static int drm_atomic_set_writeback_fb_for_connector(
680 struct drm_connector_state *conn_state,
681 struct drm_framebuffer *fb)
684 struct drm_connector *conn = conn_state->connector;
686 ret = drm_writeback_set_fb(conn_state, fb);
691 drm_dbg_atomic(conn->dev,
692 "Set [FB:%d] for connector state %p\n",
693 fb->base.id, conn_state);
695 drm_dbg_atomic(conn->dev,
696 "Set [NOFB] for connector state %p\n",
702 static int drm_atomic_connector_set_property(struct drm_connector *connector,
703 struct drm_connector_state *state, struct drm_file *file_priv,
704 struct drm_property *property, uint64_t val)
706 struct drm_device *dev = connector->dev;
707 struct drm_mode_config *config = &dev->mode_config;
708 bool replaced = false;
711 if (property == config->prop_crtc_id) {
712 struct drm_crtc *crtc = drm_crtc_find(dev, file_priv, val);
716 return drm_atomic_set_crtc_for_connector(state, crtc);
717 } else if (property == config->dpms_property) {
718 /* setting DPMS property requires special handling, which
719 * is done in legacy setprop path for us. Disallow (for
720 * now?) atomic writes to DPMS property:
723 } else if (property == config->tv_select_subconnector_property) {
724 state->tv.subconnector = val;
725 } else if (property == config->tv_left_margin_property) {
726 state->tv.margins.left = val;
727 } else if (property == config->tv_right_margin_property) {
728 state->tv.margins.right = val;
729 } else if (property == config->tv_top_margin_property) {
730 state->tv.margins.top = val;
731 } else if (property == config->tv_bottom_margin_property) {
732 state->tv.margins.bottom = val;
733 } else if (property == config->tv_mode_property) {
734 state->tv.mode = val;
735 } else if (property == config->tv_brightness_property) {
736 state->tv.brightness = val;
737 } else if (property == config->tv_contrast_property) {
738 state->tv.contrast = val;
739 } else if (property == config->tv_flicker_reduction_property) {
740 state->tv.flicker_reduction = val;
741 } else if (property == config->tv_overscan_property) {
742 state->tv.overscan = val;
743 } else if (property == config->tv_saturation_property) {
744 state->tv.saturation = val;
745 } else if (property == config->tv_hue_property) {
747 } else if (property == config->link_status_property) {
748 /* Never downgrade from GOOD to BAD on userspace's request here,
749 * only hw issues can do that.
751 * For an atomic property the userspace doesn't need to be able
752 * to understand all the properties, but needs to be able to
753 * restore the state it wants on VT switch. So if the userspace
754 * tries to change the link_status from GOOD to BAD, driver
755 * silently rejects it and returns a 0. This prevents userspace
756 * from accidentally breaking the display when it restores the
759 if (state->link_status != DRM_LINK_STATUS_GOOD)
760 state->link_status = val;
761 } else if (property == config->hdr_output_metadata_property) {
762 ret = drm_atomic_replace_property_blob_from_id(dev,
763 &state->hdr_output_metadata,
765 sizeof(struct hdr_output_metadata), -1,
768 } else if (property == config->aspect_ratio_property) {
769 state->picture_aspect_ratio = val;
770 } else if (property == config->content_type_property) {
771 state->content_type = val;
772 } else if (property == connector->scaling_mode_property) {
773 state->scaling_mode = val;
774 } else if (property == config->content_protection_property) {
775 if (val == DRM_MODE_CONTENT_PROTECTION_ENABLED) {
776 drm_dbg_kms(dev, "only drivers can set CP Enabled\n");
779 state->content_protection = val;
780 } else if (property == config->hdcp_content_type_property) {
781 state->hdcp_content_type = val;
782 } else if (property == connector->colorspace_property) {
783 state->colorspace = val;
784 } else if (property == config->writeback_fb_id_property) {
785 struct drm_framebuffer *fb;
788 fb = drm_framebuffer_lookup(dev, file_priv, val);
789 ret = drm_atomic_set_writeback_fb_for_connector(state, fb);
791 drm_framebuffer_put(fb);
793 } else if (property == config->writeback_out_fence_ptr_property) {
794 s32 __user *fence_ptr = u64_to_user_ptr(val);
796 return set_out_fence_for_connector(state->state, connector,
798 } else if (property == connector->max_bpc_property) {
799 state->max_requested_bpc = val;
800 } else if (property == connector->privacy_screen_sw_state_property) {
801 state->privacy_screen_sw_state = val;
802 } else if (connector->funcs->atomic_set_property) {
803 return connector->funcs->atomic_set_property(connector,
804 state, property, val);
806 drm_dbg_atomic(connector->dev,
807 "[CONNECTOR:%d:%s] unknown property [PROP:%d:%s]]\n",
808 connector->base.id, connector->name,
809 property->base.id, property->name);
817 drm_atomic_connector_get_property(struct drm_connector *connector,
818 const struct drm_connector_state *state,
819 struct drm_property *property, uint64_t *val)
821 struct drm_device *dev = connector->dev;
822 struct drm_mode_config *config = &dev->mode_config;
824 if (property == config->prop_crtc_id) {
825 *val = (state->crtc) ? state->crtc->base.id : 0;
826 } else if (property == config->dpms_property) {
827 if (state->crtc && state->crtc->state->self_refresh_active)
828 *val = DRM_MODE_DPMS_ON;
830 *val = connector->dpms;
831 } else if (property == config->tv_select_subconnector_property) {
832 *val = state->tv.subconnector;
833 } else if (property == config->tv_left_margin_property) {
834 *val = state->tv.margins.left;
835 } else if (property == config->tv_right_margin_property) {
836 *val = state->tv.margins.right;
837 } else if (property == config->tv_top_margin_property) {
838 *val = state->tv.margins.top;
839 } else if (property == config->tv_bottom_margin_property) {
840 *val = state->tv.margins.bottom;
841 } else if (property == config->tv_mode_property) {
842 *val = state->tv.mode;
843 } else if (property == config->tv_brightness_property) {
844 *val = state->tv.brightness;
845 } else if (property == config->tv_contrast_property) {
846 *val = state->tv.contrast;
847 } else if (property == config->tv_flicker_reduction_property) {
848 *val = state->tv.flicker_reduction;
849 } else if (property == config->tv_overscan_property) {
850 *val = state->tv.overscan;
851 } else if (property == config->tv_saturation_property) {
852 *val = state->tv.saturation;
853 } else if (property == config->tv_hue_property) {
854 *val = state->tv.hue;
855 } else if (property == config->link_status_property) {
856 *val = state->link_status;
857 } else if (property == config->aspect_ratio_property) {
858 *val = state->picture_aspect_ratio;
859 } else if (property == config->content_type_property) {
860 *val = state->content_type;
861 } else if (property == connector->colorspace_property) {
862 *val = state->colorspace;
863 } else if (property == connector->scaling_mode_property) {
864 *val = state->scaling_mode;
865 } else if (property == config->hdr_output_metadata_property) {
866 *val = state->hdr_output_metadata ?
867 state->hdr_output_metadata->base.id : 0;
868 } else if (property == config->content_protection_property) {
869 *val = state->content_protection;
870 } else if (property == config->hdcp_content_type_property) {
871 *val = state->hdcp_content_type;
872 } else if (property == config->writeback_fb_id_property) {
873 /* Writeback framebuffer is one-shot, write and forget */
875 } else if (property == config->writeback_out_fence_ptr_property) {
877 } else if (property == connector->max_bpc_property) {
878 *val = state->max_requested_bpc;
879 } else if (property == connector->privacy_screen_sw_state_property) {
880 *val = state->privacy_screen_sw_state;
881 } else if (connector->funcs->atomic_get_property) {
882 return connector->funcs->atomic_get_property(connector,
883 state, property, val);
891 int drm_atomic_get_property(struct drm_mode_object *obj,
892 struct drm_property *property, uint64_t *val)
894 struct drm_device *dev = property->dev;
898 case DRM_MODE_OBJECT_CONNECTOR: {
899 struct drm_connector *connector = obj_to_connector(obj);
901 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
902 ret = drm_atomic_connector_get_property(connector,
903 connector->state, property, val);
906 case DRM_MODE_OBJECT_CRTC: {
907 struct drm_crtc *crtc = obj_to_crtc(obj);
909 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
910 ret = drm_atomic_crtc_get_property(crtc,
911 crtc->state, property, val);
914 case DRM_MODE_OBJECT_PLANE: {
915 struct drm_plane *plane = obj_to_plane(obj);
917 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
918 ret = drm_atomic_plane_get_property(plane,
919 plane->state, property, val);
931 * The big monster ioctl
934 static struct drm_pending_vblank_event *create_vblank_event(
935 struct drm_crtc *crtc, uint64_t user_data)
937 struct drm_pending_vblank_event *e = NULL;
939 e = kzalloc(sizeof *e, GFP_KERNEL);
943 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
944 e->event.base.length = sizeof(e->event);
945 e->event.vbl.crtc_id = crtc->base.id;
946 e->event.vbl.user_data = user_data;
951 int drm_atomic_connector_commit_dpms(struct drm_atomic_state *state,
952 struct drm_connector *connector,
955 struct drm_connector *tmp_connector;
956 struct drm_connector_state *new_conn_state;
957 struct drm_crtc *crtc;
958 struct drm_crtc_state *crtc_state;
959 int i, ret, old_mode = connector->dpms;
962 ret = drm_modeset_lock(&state->dev->mode_config.connection_mutex,
967 if (mode != DRM_MODE_DPMS_ON)
968 mode = DRM_MODE_DPMS_OFF;
969 connector->dpms = mode;
971 crtc = connector->state->crtc;
974 ret = drm_atomic_add_affected_connectors(state, crtc);
978 crtc_state = drm_atomic_get_crtc_state(state, crtc);
979 if (IS_ERR(crtc_state)) {
980 ret = PTR_ERR(crtc_state);
984 for_each_new_connector_in_state(state, tmp_connector, new_conn_state, i) {
985 if (new_conn_state->crtc != crtc)
987 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
993 crtc_state->active = active;
994 ret = drm_atomic_commit(state);
997 connector->dpms = old_mode;
1001 int drm_atomic_set_property(struct drm_atomic_state *state,
1002 struct drm_file *file_priv,
1003 struct drm_mode_object *obj,
1004 struct drm_property *prop,
1005 uint64_t prop_value)
1007 struct drm_mode_object *ref;
1010 if (!drm_property_change_valid_get(prop, prop_value, &ref))
1013 switch (obj->type) {
1014 case DRM_MODE_OBJECT_CONNECTOR: {
1015 struct drm_connector *connector = obj_to_connector(obj);
1016 struct drm_connector_state *connector_state;
1018 connector_state = drm_atomic_get_connector_state(state, connector);
1019 if (IS_ERR(connector_state)) {
1020 ret = PTR_ERR(connector_state);
1024 ret = drm_atomic_connector_set_property(connector,
1025 connector_state, file_priv,
1029 case DRM_MODE_OBJECT_CRTC: {
1030 struct drm_crtc *crtc = obj_to_crtc(obj);
1031 struct drm_crtc_state *crtc_state;
1033 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1034 if (IS_ERR(crtc_state)) {
1035 ret = PTR_ERR(crtc_state);
1039 ret = drm_atomic_crtc_set_property(crtc,
1040 crtc_state, prop, prop_value);
1043 case DRM_MODE_OBJECT_PLANE: {
1044 struct drm_plane *plane = obj_to_plane(obj);
1045 struct drm_plane_state *plane_state;
1047 plane_state = drm_atomic_get_plane_state(state, plane);
1048 if (IS_ERR(plane_state)) {
1049 ret = PTR_ERR(plane_state);
1053 ret = drm_atomic_plane_set_property(plane,
1054 plane_state, file_priv,
1063 drm_property_change_valid_put(prop, ref);
1068 * DOC: explicit fencing properties
1070 * Explicit fencing allows userspace to control the buffer synchronization
1071 * between devices. A Fence or a group of fences are transferred to/from
1072 * userspace using Sync File fds and there are two DRM properties for that.
1073 * IN_FENCE_FD on each DRM Plane to send fences to the kernel and
1074 * OUT_FENCE_PTR on each DRM CRTC to receive fences from the kernel.
1076 * As a contrast, with implicit fencing the kernel keeps track of any
1077 * ongoing rendering, and automatically ensures that the atomic update waits
1078 * for any pending rendering to complete. For shared buffers represented with
1079 * a &struct dma_buf this is tracked in &struct dma_resv.
1080 * Implicit syncing is how Linux traditionally worked (e.g. DRI2/3 on X.org),
1081 * whereas explicit fencing is what Android wants.
1084 * Use this property to pass a fence that DRM should wait on before
1085 * proceeding with the Atomic Commit request and show the framebuffer for
1086 * the plane on the screen. The fence can be either a normal fence or a
1087 * merged one, the sync_file framework will handle both cases and use a
1088 * fence_array if a merged fence is received. Passing -1 here means no
1089 * fences to wait on.
1091 * If the Atomic Commit request has the DRM_MODE_ATOMIC_TEST_ONLY flag
1092 * it will only check if the Sync File is a valid one.
1094 * On the driver side the fence is stored on the @fence parameter of
1095 * &struct drm_plane_state. Drivers which also support implicit fencing
1096 * should set the implicit fence using drm_atomic_set_fence_for_plane(),
1097 * to make sure there's consistent behaviour between drivers in precedence
1098 * of implicit vs. explicit fencing.
1101 * Use this property to pass a file descriptor pointer to DRM. Once the
1102 * Atomic Commit request call returns OUT_FENCE_PTR will be filled with
1103 * the file descriptor number of a Sync File. This Sync File contains the
1104 * CRTC fence that will be signaled when all framebuffers present on the
1105 * Atomic Commit * request for that given CRTC are scanned out on the
1108 * The Atomic Commit request fails if a invalid pointer is passed. If the
1109 * Atomic Commit request fails for any other reason the out fence fd
1110 * returned will be -1. On a Atomic Commit with the
1111 * DRM_MODE_ATOMIC_TEST_ONLY flag the out fence will also be set to -1.
1113 * Note that out-fences don't have a special interface to drivers and are
1114 * internally represented by a &struct drm_pending_vblank_event in struct
1115 * &drm_crtc_state, which is also used by the nonblocking atomic commit
1116 * helpers and for the DRM event handling for existing userspace.
1119 struct drm_out_fence_state {
1120 s32 __user *out_fence_ptr;
1121 struct sync_file *sync_file;
1125 static int setup_out_fence(struct drm_out_fence_state *fence_state,
1126 struct dma_fence *fence)
1128 fence_state->fd = get_unused_fd_flags(O_CLOEXEC);
1129 if (fence_state->fd < 0)
1130 return fence_state->fd;
1132 if (put_user(fence_state->fd, fence_state->out_fence_ptr))
1135 fence_state->sync_file = sync_file_create(fence);
1136 if (!fence_state->sync_file)
1142 static int prepare_signaling(struct drm_device *dev,
1143 struct drm_atomic_state *state,
1144 struct drm_mode_atomic *arg,
1145 struct drm_file *file_priv,
1146 struct drm_out_fence_state **fence_state,
1147 unsigned int *num_fences)
1149 struct drm_crtc *crtc;
1150 struct drm_crtc_state *crtc_state;
1151 struct drm_connector *conn;
1152 struct drm_connector_state *conn_state;
1155 if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)
1158 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1159 s32 __user *fence_ptr;
1161 fence_ptr = get_out_fence_for_crtc(crtc_state->state, crtc);
1163 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT || fence_ptr) {
1164 struct drm_pending_vblank_event *e;
1166 e = create_vblank_event(crtc, arg->user_data);
1170 crtc_state->event = e;
1173 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1174 struct drm_pending_vblank_event *e = crtc_state->event;
1179 ret = drm_event_reserve_init(dev, file_priv, &e->base,
1183 crtc_state->event = NULL;
1189 struct dma_fence *fence;
1190 struct drm_out_fence_state *f;
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 fence = drm_crtc_create_fence(crtc);
1206 ret = setup_out_fence(&f[(*num_fences)++], fence);
1208 dma_fence_put(fence);
1212 crtc_state->event->base.fence = fence;
1218 for_each_new_connector_in_state(state, conn, conn_state, i) {
1219 struct drm_writeback_connector *wb_conn;
1220 struct drm_out_fence_state *f;
1221 struct dma_fence *fence;
1222 s32 __user *fence_ptr;
1224 if (!conn_state->writeback_job)
1227 fence_ptr = get_out_fence_for_connector(state, conn);
1231 f = krealloc(*fence_state, sizeof(**fence_state) *
1232 (*num_fences + 1), GFP_KERNEL);
1236 memset(&f[*num_fences], 0, sizeof(*f));
1238 f[*num_fences].out_fence_ptr = fence_ptr;
1241 wb_conn = drm_connector_to_writeback(conn);
1242 fence = drm_writeback_get_out_fence(wb_conn);
1246 ret = setup_out_fence(&f[(*num_fences)++], fence);
1248 dma_fence_put(fence);
1252 conn_state->writeback_job->out_fence = fence;
1256 * Having this flag means user mode pends on event which will never
1257 * reach due to lack of at least one CRTC for signaling
1259 if (c == 0 && (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
1265 static void complete_signaling(struct drm_device *dev,
1266 struct drm_atomic_state *state,
1267 struct drm_out_fence_state *fence_state,
1268 unsigned int num_fences,
1271 struct drm_crtc *crtc;
1272 struct drm_crtc_state *crtc_state;
1276 for (i = 0; i < num_fences; i++)
1277 fd_install(fence_state[i].fd,
1278 fence_state[i].sync_file->file);
1284 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1285 struct drm_pending_vblank_event *event = crtc_state->event;
1287 * Free the allocated event. drm_atomic_helper_setup_commit
1288 * can allocate an event too, so only free it if it's ours
1289 * to prevent a double free in drm_atomic_state_clear.
1291 if (event && (event->base.fence || event->base.file_priv)) {
1292 drm_event_cancel_free(dev, &event->base);
1293 crtc_state->event = NULL;
1300 for (i = 0; i < num_fences; i++) {
1301 if (fence_state[i].sync_file)
1302 fput(fence_state[i].sync_file->file);
1303 if (fence_state[i].fd >= 0)
1304 put_unused_fd(fence_state[i].fd);
1306 /* If this fails log error to the user */
1307 if (fence_state[i].out_fence_ptr &&
1308 put_user(-1, fence_state[i].out_fence_ptr))
1309 drm_dbg_atomic(dev, "Couldn't clear out_fence_ptr\n");
1315 int drm_mode_atomic_ioctl(struct drm_device *dev,
1316 void *data, struct drm_file *file_priv)
1318 struct drm_mode_atomic *arg = data;
1319 uint32_t __user *objs_ptr = (uint32_t __user *)(unsigned long)(arg->objs_ptr);
1320 uint32_t __user *count_props_ptr = (uint32_t __user *)(unsigned long)(arg->count_props_ptr);
1321 uint32_t __user *props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
1322 uint64_t __user *prop_values_ptr = (uint64_t __user *)(unsigned long)(arg->prop_values_ptr);
1323 unsigned int copied_objs, copied_props;
1324 struct drm_atomic_state *state;
1325 struct drm_modeset_acquire_ctx ctx;
1326 struct drm_out_fence_state *fence_state;
1328 unsigned int i, j, num_fences;
1329 struct drm_printer p = drm_info_printer(dev->dev);
1331 /* disallow for drivers not supporting atomic: */
1332 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1335 /* disallow for userspace that has not enabled atomic cap (even
1336 * though this may be a bit overkill, since legacy userspace
1337 * wouldn't know how to call this ioctl)
1339 if (!file_priv->atomic) {
1341 "commit failed: atomic cap not enabled\n");
1345 if (arg->flags & ~DRM_MODE_ATOMIC_FLAGS) {
1346 drm_dbg_atomic(dev, "commit failed: invalid flag\n");
1350 if (arg->reserved) {
1351 drm_dbg_atomic(dev, "commit failed: reserved field set\n");
1355 if (arg->flags & DRM_MODE_PAGE_FLIP_ASYNC) {
1357 "commit failed: invalid flag DRM_MODE_PAGE_FLIP_ASYNC\n");
1361 /* can't test and expect an event at the same time. */
1362 if ((arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) &&
1363 (arg->flags & DRM_MODE_PAGE_FLIP_EVENT)) {
1365 "commit failed: page-flip event requested with test-only commit\n");
1369 state = drm_atomic_state_alloc(dev);
1373 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1374 state->acquire_ctx = &ctx;
1375 state->allow_modeset = !!(arg->flags & DRM_MODE_ATOMIC_ALLOW_MODESET);
1383 for (i = 0; i < arg->count_objs; i++) {
1384 uint32_t obj_id, count_props;
1385 struct drm_mode_object *obj;
1387 if (get_user(obj_id, objs_ptr + copied_objs)) {
1392 obj = drm_mode_object_find(dev, file_priv, obj_id, DRM_MODE_OBJECT_ANY);
1398 if (!obj->properties) {
1399 drm_mode_object_put(obj);
1404 if (get_user(count_props, count_props_ptr + copied_objs)) {
1405 drm_mode_object_put(obj);
1412 for (j = 0; j < count_props; j++) {
1414 uint64_t prop_value;
1415 struct drm_property *prop;
1417 if (get_user(prop_id, props_ptr + copied_props)) {
1418 drm_mode_object_put(obj);
1423 prop = drm_mode_obj_find_prop_id(obj, prop_id);
1425 drm_mode_object_put(obj);
1430 if (copy_from_user(&prop_value,
1431 prop_values_ptr + copied_props,
1432 sizeof(prop_value))) {
1433 drm_mode_object_put(obj);
1438 ret = drm_atomic_set_property(state, file_priv,
1439 obj, prop, prop_value);
1441 drm_mode_object_put(obj);
1448 drm_mode_object_put(obj);
1451 ret = prepare_signaling(dev, state, arg, file_priv, &fence_state,
1456 if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) {
1457 ret = drm_atomic_check_only(state);
1458 } else if (arg->flags & DRM_MODE_ATOMIC_NONBLOCK) {
1459 ret = drm_atomic_nonblocking_commit(state);
1461 if (drm_debug_enabled(DRM_UT_STATE))
1462 drm_atomic_print_new_state(state, &p);
1464 ret = drm_atomic_commit(state);
1468 complete_signaling(dev, state, fence_state, num_fences, !ret);
1470 if (ret == -EDEADLK) {
1471 drm_atomic_state_clear(state);
1472 ret = drm_modeset_backoff(&ctx);
1477 drm_atomic_state_put(state);
1479 drm_modeset_drop_locks(&ctx);
1480 drm_modeset_acquire_fini(&ctx);