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.
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 = state->active;
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;
680 if (property == config->prop_crtc_id) {
681 struct drm_crtc *crtc = drm_crtc_find(dev, file_priv, val);
684 return drm_atomic_set_crtc_for_connector(state, crtc);
685 } else if (property == config->dpms_property) {
686 /* setting DPMS property requires special handling, which
687 * is done in legacy setprop path for us. Disallow (for
688 * now?) atomic writes to DPMS property:
691 } else if (property == config->tv_select_subconnector_property) {
692 state->tv.subconnector = val;
693 } else if (property == config->tv_left_margin_property) {
694 state->tv.margins.left = val;
695 } else if (property == config->tv_right_margin_property) {
696 state->tv.margins.right = val;
697 } else if (property == config->tv_top_margin_property) {
698 state->tv.margins.top = val;
699 } else if (property == config->tv_bottom_margin_property) {
700 state->tv.margins.bottom = val;
701 } else if (property == config->tv_mode_property) {
702 state->tv.mode = val;
703 } else if (property == config->tv_brightness_property) {
704 state->tv.brightness = val;
705 } else if (property == config->tv_contrast_property) {
706 state->tv.contrast = val;
707 } else if (property == config->tv_flicker_reduction_property) {
708 state->tv.flicker_reduction = val;
709 } else if (property == config->tv_overscan_property) {
710 state->tv.overscan = val;
711 } else if (property == config->tv_saturation_property) {
712 state->tv.saturation = val;
713 } else if (property == config->tv_hue_property) {
715 } else if (property == config->link_status_property) {
716 /* Never downgrade from GOOD to BAD on userspace's request here,
717 * only hw issues can do that.
719 * For an atomic property the userspace doesn't need to be able
720 * to understand all the properties, but needs to be able to
721 * restore the state it wants on VT switch. So if the userspace
722 * tries to change the link_status from GOOD to BAD, driver
723 * silently rejects it and returns a 0. This prevents userspace
724 * from accidently breaking the display when it restores the
727 if (state->link_status != DRM_LINK_STATUS_GOOD)
728 state->link_status = val;
729 } else if (property == config->aspect_ratio_property) {
730 state->picture_aspect_ratio = val;
731 } else if (property == config->content_type_property) {
732 state->content_type = val;
733 } else if (property == connector->scaling_mode_property) {
734 state->scaling_mode = val;
735 } else if (property == connector->content_protection_property) {
736 if (val == DRM_MODE_CONTENT_PROTECTION_ENABLED) {
737 DRM_DEBUG_KMS("only drivers can set CP Enabled\n");
740 state->content_protection = val;
741 } else if (property == connector->colorspace_property) {
742 state->colorspace = val;
743 } else if (property == config->writeback_fb_id_property) {
744 struct drm_framebuffer *fb;
746 fb = drm_framebuffer_lookup(dev, file_priv, val);
747 ret = drm_atomic_set_writeback_fb_for_connector(state, fb);
749 drm_framebuffer_put(fb);
751 } else if (property == config->writeback_out_fence_ptr_property) {
752 s32 __user *fence_ptr = u64_to_user_ptr(val);
754 return set_out_fence_for_connector(state->state, connector,
756 } else if (property == connector->max_bpc_property) {
757 state->max_requested_bpc = val;
758 } else if (connector->funcs->atomic_set_property) {
759 return connector->funcs->atomic_set_property(connector,
760 state, property, val);
762 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] unknown property [PROP:%d:%s]]\n",
763 connector->base.id, connector->name,
764 property->base.id, property->name);
772 drm_atomic_connector_get_property(struct drm_connector *connector,
773 const struct drm_connector_state *state,
774 struct drm_property *property, uint64_t *val)
776 struct drm_device *dev = connector->dev;
777 struct drm_mode_config *config = &dev->mode_config;
779 if (property == config->prop_crtc_id) {
780 *val = (state->crtc) ? state->crtc->base.id : 0;
781 } else if (property == config->dpms_property) {
782 *val = connector->dpms;
783 } else if (property == config->tv_select_subconnector_property) {
784 *val = state->tv.subconnector;
785 } else if (property == config->tv_left_margin_property) {
786 *val = state->tv.margins.left;
787 } else if (property == config->tv_right_margin_property) {
788 *val = state->tv.margins.right;
789 } else if (property == config->tv_top_margin_property) {
790 *val = state->tv.margins.top;
791 } else if (property == config->tv_bottom_margin_property) {
792 *val = state->tv.margins.bottom;
793 } else if (property == config->tv_mode_property) {
794 *val = state->tv.mode;
795 } else if (property == config->tv_brightness_property) {
796 *val = state->tv.brightness;
797 } else if (property == config->tv_contrast_property) {
798 *val = state->tv.contrast;
799 } else if (property == config->tv_flicker_reduction_property) {
800 *val = state->tv.flicker_reduction;
801 } else if (property == config->tv_overscan_property) {
802 *val = state->tv.overscan;
803 } else if (property == config->tv_saturation_property) {
804 *val = state->tv.saturation;
805 } else if (property == config->tv_hue_property) {
806 *val = state->tv.hue;
807 } else if (property == config->link_status_property) {
808 *val = state->link_status;
809 } else if (property == config->aspect_ratio_property) {
810 *val = state->picture_aspect_ratio;
811 } else if (property == config->content_type_property) {
812 *val = state->content_type;
813 } else if (property == connector->colorspace_property) {
814 *val = state->colorspace;
815 } else if (property == connector->scaling_mode_property) {
816 *val = state->scaling_mode;
817 } else if (property == connector->content_protection_property) {
818 *val = state->content_protection;
819 } else if (property == config->writeback_fb_id_property) {
820 /* Writeback framebuffer is one-shot, write and forget */
822 } else if (property == config->writeback_out_fence_ptr_property) {
824 } else if (property == connector->max_bpc_property) {
825 *val = state->max_requested_bpc;
826 } else if (connector->funcs->atomic_get_property) {
827 return connector->funcs->atomic_get_property(connector,
828 state, property, val);
836 int drm_atomic_get_property(struct drm_mode_object *obj,
837 struct drm_property *property, uint64_t *val)
839 struct drm_device *dev = property->dev;
843 case DRM_MODE_OBJECT_CONNECTOR: {
844 struct drm_connector *connector = obj_to_connector(obj);
845 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
846 ret = drm_atomic_connector_get_property(connector,
847 connector->state, property, val);
850 case DRM_MODE_OBJECT_CRTC: {
851 struct drm_crtc *crtc = obj_to_crtc(obj);
852 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
853 ret = drm_atomic_crtc_get_property(crtc,
854 crtc->state, property, val);
857 case DRM_MODE_OBJECT_PLANE: {
858 struct drm_plane *plane = obj_to_plane(obj);
859 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
860 ret = drm_atomic_plane_get_property(plane,
861 plane->state, property, val);
873 * The big monster ioctl
876 static struct drm_pending_vblank_event *create_vblank_event(
877 struct drm_crtc *crtc, uint64_t user_data)
879 struct drm_pending_vblank_event *e = NULL;
881 e = kzalloc(sizeof *e, GFP_KERNEL);
885 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
886 e->event.base.length = sizeof(e->event);
887 e->event.vbl.crtc_id = crtc->base.id;
888 e->event.vbl.user_data = user_data;
893 int drm_atomic_connector_commit_dpms(struct drm_atomic_state *state,
894 struct drm_connector *connector,
897 struct drm_connector *tmp_connector;
898 struct drm_connector_state *new_conn_state;
899 struct drm_crtc *crtc;
900 struct drm_crtc_state *crtc_state;
901 int i, ret, old_mode = connector->dpms;
904 ret = drm_modeset_lock(&state->dev->mode_config.connection_mutex,
909 if (mode != DRM_MODE_DPMS_ON)
910 mode = DRM_MODE_DPMS_OFF;
911 connector->dpms = mode;
913 crtc = connector->state->crtc;
916 ret = drm_atomic_add_affected_connectors(state, crtc);
920 crtc_state = drm_atomic_get_crtc_state(state, crtc);
921 if (IS_ERR(crtc_state)) {
922 ret = PTR_ERR(crtc_state);
926 for_each_new_connector_in_state(state, tmp_connector, new_conn_state, i) {
927 if (new_conn_state->crtc != crtc)
929 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
935 crtc_state->active = active;
936 ret = drm_atomic_commit(state);
939 connector->dpms = old_mode;
943 int drm_atomic_set_property(struct drm_atomic_state *state,
944 struct drm_file *file_priv,
945 struct drm_mode_object *obj,
946 struct drm_property *prop,
949 struct drm_mode_object *ref;
952 if (!drm_property_change_valid_get(prop, prop_value, &ref))
956 case DRM_MODE_OBJECT_CONNECTOR: {
957 struct drm_connector *connector = obj_to_connector(obj);
958 struct drm_connector_state *connector_state;
960 connector_state = drm_atomic_get_connector_state(state, connector);
961 if (IS_ERR(connector_state)) {
962 ret = PTR_ERR(connector_state);
966 ret = drm_atomic_connector_set_property(connector,
967 connector_state, file_priv,
971 case DRM_MODE_OBJECT_CRTC: {
972 struct drm_crtc *crtc = obj_to_crtc(obj);
973 struct drm_crtc_state *crtc_state;
975 crtc_state = drm_atomic_get_crtc_state(state, crtc);
976 if (IS_ERR(crtc_state)) {
977 ret = PTR_ERR(crtc_state);
981 ret = drm_atomic_crtc_set_property(crtc,
982 crtc_state, prop, prop_value);
985 case DRM_MODE_OBJECT_PLANE: {
986 struct drm_plane *plane = obj_to_plane(obj);
987 struct drm_plane_state *plane_state;
989 plane_state = drm_atomic_get_plane_state(state, plane);
990 if (IS_ERR(plane_state)) {
991 ret = PTR_ERR(plane_state);
995 ret = drm_atomic_plane_set_property(plane,
996 plane_state, file_priv,
1005 drm_property_change_valid_put(prop, ref);
1010 * DOC: explicit fencing properties
1012 * Explicit fencing allows userspace to control the buffer synchronization
1013 * between devices. A Fence or a group of fences are transfered to/from
1014 * userspace using Sync File fds and there are two DRM properties for that.
1015 * IN_FENCE_FD on each DRM Plane to send fences to the kernel and
1016 * OUT_FENCE_PTR on each DRM CRTC to receive fences from the kernel.
1018 * As a contrast, with implicit fencing the kernel keeps track of any
1019 * ongoing rendering, and automatically ensures that the atomic update waits
1020 * for any pending rendering to complete. For shared buffers represented with
1021 * a &struct dma_buf this is tracked in &struct reservation_object.
1022 * Implicit syncing is how Linux traditionally worked (e.g. DRI2/3 on X.org),
1023 * whereas explicit fencing is what Android wants.
1026 * Use this property to pass a fence that DRM should wait on before
1027 * proceeding with the Atomic Commit request and show the framebuffer for
1028 * the plane on the screen. The fence can be either a normal fence or a
1029 * merged one, the sync_file framework will handle both cases and use a
1030 * fence_array if a merged fence is received. Passing -1 here means no
1031 * fences to wait on.
1033 * If the Atomic Commit request has the DRM_MODE_ATOMIC_TEST_ONLY flag
1034 * it will only check if the Sync File is a valid one.
1036 * On the driver side the fence is stored on the @fence parameter of
1037 * &struct drm_plane_state. Drivers which also support implicit fencing
1038 * should set the implicit fence using drm_atomic_set_fence_for_plane(),
1039 * to make sure there's consistent behaviour between drivers in precedence
1040 * of implicit vs. explicit fencing.
1043 * Use this property to pass a file descriptor pointer to DRM. Once the
1044 * Atomic Commit request call returns OUT_FENCE_PTR will be filled with
1045 * the file descriptor number of a Sync File. This Sync File contains the
1046 * CRTC fence that will be signaled when all framebuffers present on the
1047 * Atomic Commit * request for that given CRTC are scanned out on the
1050 * The Atomic Commit request fails if a invalid pointer is passed. If the
1051 * Atomic Commit request fails for any other reason the out fence fd
1052 * returned will be -1. On a Atomic Commit with the
1053 * DRM_MODE_ATOMIC_TEST_ONLY flag the out fence will also be set to -1.
1055 * Note that out-fences don't have a special interface to drivers and are
1056 * internally represented by a &struct drm_pending_vblank_event in struct
1057 * &drm_crtc_state, which is also used by the nonblocking atomic commit
1058 * helpers and for the DRM event handling for existing userspace.
1061 struct drm_out_fence_state {
1062 s32 __user *out_fence_ptr;
1063 struct sync_file *sync_file;
1067 static int setup_out_fence(struct drm_out_fence_state *fence_state,
1068 struct dma_fence *fence)
1070 fence_state->fd = get_unused_fd_flags(O_CLOEXEC);
1071 if (fence_state->fd < 0)
1072 return fence_state->fd;
1074 if (put_user(fence_state->fd, fence_state->out_fence_ptr))
1077 fence_state->sync_file = sync_file_create(fence);
1078 if (!fence_state->sync_file)
1084 static int prepare_signaling(struct drm_device *dev,
1085 struct drm_atomic_state *state,
1086 struct drm_mode_atomic *arg,
1087 struct drm_file *file_priv,
1088 struct drm_out_fence_state **fence_state,
1089 unsigned int *num_fences)
1091 struct drm_crtc *crtc;
1092 struct drm_crtc_state *crtc_state;
1093 struct drm_connector *conn;
1094 struct drm_connector_state *conn_state;
1097 if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)
1100 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1101 s32 __user *fence_ptr;
1103 fence_ptr = get_out_fence_for_crtc(crtc_state->state, crtc);
1105 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT || fence_ptr) {
1106 struct drm_pending_vblank_event *e;
1108 e = create_vblank_event(crtc, arg->user_data);
1112 crtc_state->event = e;
1115 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1116 struct drm_pending_vblank_event *e = crtc_state->event;
1121 ret = drm_event_reserve_init(dev, file_priv, &e->base,
1125 crtc_state->event = NULL;
1131 struct dma_fence *fence;
1132 struct drm_out_fence_state *f;
1134 f = krealloc(*fence_state, sizeof(**fence_state) *
1135 (*num_fences + 1), GFP_KERNEL);
1139 memset(&f[*num_fences], 0, sizeof(*f));
1141 f[*num_fences].out_fence_ptr = fence_ptr;
1144 fence = drm_crtc_create_fence(crtc);
1148 ret = setup_out_fence(&f[(*num_fences)++], fence);
1150 dma_fence_put(fence);
1154 crtc_state->event->base.fence = fence;
1160 for_each_new_connector_in_state(state, conn, conn_state, i) {
1161 struct drm_writeback_connector *wb_conn;
1162 struct drm_out_fence_state *f;
1163 struct dma_fence *fence;
1164 s32 __user *fence_ptr;
1166 if (!conn_state->writeback_job)
1169 fence_ptr = get_out_fence_for_connector(state, conn);
1173 f = krealloc(*fence_state, sizeof(**fence_state) *
1174 (*num_fences + 1), GFP_KERNEL);
1178 memset(&f[*num_fences], 0, sizeof(*f));
1180 f[*num_fences].out_fence_ptr = fence_ptr;
1183 wb_conn = drm_connector_to_writeback(conn);
1184 fence = drm_writeback_get_out_fence(wb_conn);
1188 ret = setup_out_fence(&f[(*num_fences)++], fence);
1190 dma_fence_put(fence);
1194 conn_state->writeback_job->out_fence = fence;
1198 * Having this flag means user mode pends on event which will never
1199 * reach due to lack of at least one CRTC for signaling
1201 if (c == 0 && (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
1207 static void complete_signaling(struct drm_device *dev,
1208 struct drm_atomic_state *state,
1209 struct drm_out_fence_state *fence_state,
1210 unsigned int num_fences,
1213 struct drm_crtc *crtc;
1214 struct drm_crtc_state *crtc_state;
1218 for (i = 0; i < num_fences; i++)
1219 fd_install(fence_state[i].fd,
1220 fence_state[i].sync_file->file);
1226 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1227 struct drm_pending_vblank_event *event = crtc_state->event;
1229 * Free the allocated event. drm_atomic_helper_setup_commit
1230 * can allocate an event too, so only free it if it's ours
1231 * to prevent a double free in drm_atomic_state_clear.
1233 if (event && (event->base.fence || event->base.file_priv)) {
1234 drm_event_cancel_free(dev, &event->base);
1235 crtc_state->event = NULL;
1242 for (i = 0; i < num_fences; i++) {
1243 if (fence_state[i].sync_file)
1244 fput(fence_state[i].sync_file->file);
1245 if (fence_state[i].fd >= 0)
1246 put_unused_fd(fence_state[i].fd);
1248 /* If this fails log error to the user */
1249 if (fence_state[i].out_fence_ptr &&
1250 put_user(-1, fence_state[i].out_fence_ptr))
1251 DRM_DEBUG_ATOMIC("Couldn't clear out_fence_ptr\n");
1257 int drm_mode_atomic_ioctl(struct drm_device *dev,
1258 void *data, struct drm_file *file_priv)
1260 struct drm_mode_atomic *arg = data;
1261 uint32_t __user *objs_ptr = (uint32_t __user *)(unsigned long)(arg->objs_ptr);
1262 uint32_t __user *count_props_ptr = (uint32_t __user *)(unsigned long)(arg->count_props_ptr);
1263 uint32_t __user *props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
1264 uint64_t __user *prop_values_ptr = (uint64_t __user *)(unsigned long)(arg->prop_values_ptr);
1265 unsigned int copied_objs, copied_props;
1266 struct drm_atomic_state *state;
1267 struct drm_modeset_acquire_ctx ctx;
1268 struct drm_out_fence_state *fence_state;
1270 unsigned int i, j, num_fences;
1272 /* disallow for drivers not supporting atomic: */
1273 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1276 /* disallow for userspace that has not enabled atomic cap (even
1277 * though this may be a bit overkill, since legacy userspace
1278 * wouldn't know how to call this ioctl)
1280 if (!file_priv->atomic)
1283 if (arg->flags & ~DRM_MODE_ATOMIC_FLAGS)
1289 if ((arg->flags & DRM_MODE_PAGE_FLIP_ASYNC) &&
1290 !dev->mode_config.async_page_flip)
1293 /* can't test and expect an event at the same time. */
1294 if ((arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) &&
1295 (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
1298 state = drm_atomic_state_alloc(dev);
1302 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1303 state->acquire_ctx = &ctx;
1304 state->allow_modeset = !!(arg->flags & DRM_MODE_ATOMIC_ALLOW_MODESET);
1312 for (i = 0; i < arg->count_objs; i++) {
1313 uint32_t obj_id, count_props;
1314 struct drm_mode_object *obj;
1316 if (get_user(obj_id, objs_ptr + copied_objs)) {
1321 obj = drm_mode_object_find(dev, file_priv, obj_id, DRM_MODE_OBJECT_ANY);
1327 if (!obj->properties) {
1328 drm_mode_object_put(obj);
1333 if (get_user(count_props, count_props_ptr + copied_objs)) {
1334 drm_mode_object_put(obj);
1341 for (j = 0; j < count_props; j++) {
1343 uint64_t prop_value;
1344 struct drm_property *prop;
1346 if (get_user(prop_id, props_ptr + copied_props)) {
1347 drm_mode_object_put(obj);
1352 prop = drm_mode_obj_find_prop_id(obj, prop_id);
1354 drm_mode_object_put(obj);
1359 if (copy_from_user(&prop_value,
1360 prop_values_ptr + copied_props,
1361 sizeof(prop_value))) {
1362 drm_mode_object_put(obj);
1367 ret = drm_atomic_set_property(state, file_priv,
1368 obj, prop, prop_value);
1370 drm_mode_object_put(obj);
1377 drm_mode_object_put(obj);
1380 ret = prepare_signaling(dev, state, arg, file_priv, &fence_state,
1385 if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) {
1386 ret = drm_atomic_check_only(state);
1387 } else if (arg->flags & DRM_MODE_ATOMIC_NONBLOCK) {
1388 ret = drm_atomic_nonblocking_commit(state);
1390 if (unlikely(drm_debug & DRM_UT_STATE))
1391 drm_atomic_print_state(state);
1393 ret = drm_atomic_commit(state);
1397 complete_signaling(dev, state, fence_state, num_fences, !ret);
1399 if (ret == -EDEADLK) {
1400 drm_atomic_state_clear(state);
1401 ret = drm_modeset_backoff(&ctx);
1406 drm_atomic_state_put(state);
1408 drm_modeset_drop_locks(&ctx);
1409 drm_modeset_acquire_fini(&ctx);