2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
30 #include <drm/drm_atomic.h>
31 #include <drm/drm_mode.h>
32 #include <drm/drm_plane_helper.h>
33 #include <drm/drm_print.h>
34 #include <linux/sync_file.h>
36 #include "drm_crtc_internal.h"
38 void __drm_crtc_commit_free(struct kref *kref)
40 struct drm_crtc_commit *commit =
41 container_of(kref, struct drm_crtc_commit, ref);
45 EXPORT_SYMBOL(__drm_crtc_commit_free);
48 * drm_atomic_state_default_release -
49 * release memory initialized by drm_atomic_state_init
50 * @state: atomic state
52 * Free all the memory allocated by drm_atomic_state_init.
53 * This is useful for drivers that subclass the atomic state.
55 void drm_atomic_state_default_release(struct drm_atomic_state *state)
57 kfree(state->connectors);
61 EXPORT_SYMBOL(drm_atomic_state_default_release);
64 * drm_atomic_state_init - init new atomic state
66 * @state: atomic state
68 * Default implementation for filling in a new atomic state.
69 * This is useful for drivers that subclass the atomic state.
72 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)
74 kref_init(&state->ref);
76 /* TODO legacy paths should maybe do a better job about
77 * setting this appropriately?
79 state->allow_modeset = true;
81 state->crtcs = kcalloc(dev->mode_config.num_crtc,
82 sizeof(*state->crtcs), GFP_KERNEL);
85 state->planes = kcalloc(dev->mode_config.num_total_plane,
86 sizeof(*state->planes), GFP_KERNEL);
92 DRM_DEBUG_ATOMIC("Allocated atomic state %p\n", state);
96 drm_atomic_state_default_release(state);
99 EXPORT_SYMBOL(drm_atomic_state_init);
102 * drm_atomic_state_alloc - allocate atomic state
105 * This allocates an empty atomic state to track updates.
107 struct drm_atomic_state *
108 drm_atomic_state_alloc(struct drm_device *dev)
110 struct drm_mode_config *config = &dev->mode_config;
111 struct drm_atomic_state *state;
113 if (!config->funcs->atomic_state_alloc) {
114 state = kzalloc(sizeof(*state), GFP_KERNEL);
117 if (drm_atomic_state_init(dev, state) < 0) {
124 return config->funcs->atomic_state_alloc(dev);
126 EXPORT_SYMBOL(drm_atomic_state_alloc);
129 * drm_atomic_state_default_clear - clear base atomic state
130 * @state: atomic state
132 * Default implementation for clearing atomic state.
133 * This is useful for drivers that subclass the atomic state.
135 void drm_atomic_state_default_clear(struct drm_atomic_state *state)
137 struct drm_device *dev = state->dev;
138 struct drm_mode_config *config = &dev->mode_config;
141 DRM_DEBUG_ATOMIC("Clearing atomic state %p\n", state);
143 for (i = 0; i < state->num_connector; i++) {
144 struct drm_connector *connector = state->connectors[i].ptr;
149 connector->funcs->atomic_destroy_state(connector,
150 state->connectors[i].state);
151 state->connectors[i].ptr = NULL;
152 state->connectors[i].state = NULL;
153 drm_connector_unreference(connector);
156 for (i = 0; i < config->num_crtc; i++) {
157 struct drm_crtc *crtc = state->crtcs[i].ptr;
162 crtc->funcs->atomic_destroy_state(crtc,
163 state->crtcs[i].state);
165 if (state->crtcs[i].commit) {
166 kfree(state->crtcs[i].commit->event);
167 state->crtcs[i].commit->event = NULL;
168 drm_crtc_commit_put(state->crtcs[i].commit);
171 state->crtcs[i].commit = NULL;
172 state->crtcs[i].ptr = NULL;
173 state->crtcs[i].state = NULL;
176 for (i = 0; i < config->num_total_plane; i++) {
177 struct drm_plane *plane = state->planes[i].ptr;
182 plane->funcs->atomic_destroy_state(plane,
183 state->planes[i].state);
184 state->planes[i].ptr = NULL;
185 state->planes[i].state = NULL;
188 EXPORT_SYMBOL(drm_atomic_state_default_clear);
191 * drm_atomic_state_clear - clear state object
192 * @state: atomic state
194 * When the w/w mutex algorithm detects a deadlock we need to back off and drop
195 * all locks. So someone else could sneak in and change the current modeset
196 * configuration. Which means that all the state assembled in @state is no
197 * longer an atomic update to the current state, but to some arbitrary earlier
198 * state. Which could break assumptions the driver's
199 * &drm_mode_config_funcs.atomic_check likely relies on.
201 * Hence we must clear all cached state and completely start over, using this
204 void drm_atomic_state_clear(struct drm_atomic_state *state)
206 struct drm_device *dev = state->dev;
207 struct drm_mode_config *config = &dev->mode_config;
209 if (config->funcs->atomic_state_clear)
210 config->funcs->atomic_state_clear(state);
212 drm_atomic_state_default_clear(state);
214 EXPORT_SYMBOL(drm_atomic_state_clear);
217 * __drm_atomic_state_free - free all memory for an atomic state
218 * @ref: This atomic state to deallocate
220 * This frees all memory associated with an atomic state, including all the
221 * per-object state for planes, crtcs and connectors.
223 void __drm_atomic_state_free(struct kref *ref)
225 struct drm_atomic_state *state = container_of(ref, typeof(*state), ref);
226 struct drm_mode_config *config = &state->dev->mode_config;
228 drm_atomic_state_clear(state);
230 DRM_DEBUG_ATOMIC("Freeing atomic state %p\n", state);
232 if (config->funcs->atomic_state_free) {
233 config->funcs->atomic_state_free(state);
235 drm_atomic_state_default_release(state);
239 EXPORT_SYMBOL(__drm_atomic_state_free);
242 * drm_atomic_get_crtc_state - get crtc state
243 * @state: global atomic state object
244 * @crtc: crtc to get state object for
246 * This function returns the crtc state for the given crtc, allocating it if
247 * needed. It will also grab the relevant crtc lock to make sure that the state
252 * Either the allocated state or the error code encoded into the pointer. When
253 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
254 * entire atomic sequence must be restarted. All other errors are fatal.
256 struct drm_crtc_state *
257 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
258 struct drm_crtc *crtc)
260 int ret, index = drm_crtc_index(crtc);
261 struct drm_crtc_state *crtc_state;
263 WARN_ON(!state->acquire_ctx);
265 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
269 ret = drm_modeset_lock(&crtc->mutex, state->acquire_ctx);
273 crtc_state = crtc->funcs->atomic_duplicate_state(crtc);
275 return ERR_PTR(-ENOMEM);
277 state->crtcs[index].state = crtc_state;
278 state->crtcs[index].old_state = crtc->state;
279 state->crtcs[index].new_state = crtc_state;
280 state->crtcs[index].ptr = crtc;
281 crtc_state->state = state;
283 DRM_DEBUG_ATOMIC("Added [CRTC:%d:%s] %p state to %p\n",
284 crtc->base.id, crtc->name, crtc_state, state);
288 EXPORT_SYMBOL(drm_atomic_get_crtc_state);
290 static void set_out_fence_for_crtc(struct drm_atomic_state *state,
291 struct drm_crtc *crtc, s64 __user *fence_ptr)
293 state->crtcs[drm_crtc_index(crtc)].out_fence_ptr = fence_ptr;
296 static s64 __user *get_out_fence_for_crtc(struct drm_atomic_state *state,
297 struct drm_crtc *crtc)
299 s64 __user *fence_ptr;
301 fence_ptr = state->crtcs[drm_crtc_index(crtc)].out_fence_ptr;
302 state->crtcs[drm_crtc_index(crtc)].out_fence_ptr = NULL;
308 * drm_atomic_set_mode_for_crtc - set mode for CRTC
309 * @state: the CRTC whose incoming state to update
310 * @mode: kernel-internal mode to use for the CRTC, or NULL to disable
312 * Set a mode (originating from the kernel) on the desired CRTC state and update
313 * the enable property.
316 * Zero on success, error code on failure. Cannot return -EDEADLK.
318 int drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
319 struct drm_display_mode *mode)
321 struct drm_mode_modeinfo umode;
323 /* Early return for no change. */
324 if (mode && memcmp(&state->mode, mode, sizeof(*mode)) == 0)
327 drm_property_unreference_blob(state->mode_blob);
328 state->mode_blob = NULL;
331 drm_mode_convert_to_umode(&umode, mode);
333 drm_property_create_blob(state->crtc->dev,
336 if (IS_ERR(state->mode_blob))
337 return PTR_ERR(state->mode_blob);
339 drm_mode_copy(&state->mode, mode);
340 state->enable = true;
341 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
344 memset(&state->mode, 0, sizeof(state->mode));
345 state->enable = false;
346 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
352 EXPORT_SYMBOL(drm_atomic_set_mode_for_crtc);
355 * drm_atomic_set_mode_prop_for_crtc - set mode for CRTC
356 * @state: the CRTC whose incoming state to update
357 * @blob: pointer to blob property to use for mode
359 * Set a mode (originating from a blob property) on the desired CRTC state.
360 * This function will take a reference on the blob property for the CRTC state,
361 * and release the reference held on the state's existing mode property, if any
365 * Zero on success, error code on failure. Cannot return -EDEADLK.
367 int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
368 struct drm_property_blob *blob)
370 if (blob == state->mode_blob)
373 drm_property_unreference_blob(state->mode_blob);
374 state->mode_blob = NULL;
376 memset(&state->mode, 0, sizeof(state->mode));
379 if (blob->length != sizeof(struct drm_mode_modeinfo) ||
380 drm_mode_convert_umode(&state->mode,
381 (const struct drm_mode_modeinfo *)
385 state->mode_blob = drm_property_reference_blob(blob);
386 state->enable = true;
387 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
388 state->mode.name, state);
390 state->enable = false;
391 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
397 EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc);
400 * drm_atomic_replace_property_blob - replace a blob property
401 * @blob: a pointer to the member blob to be replaced
402 * @new_blob: the new blob to replace with
403 * @replaced: whether the blob has been replaced
406 * Zero on success, error code on failure
409 drm_atomic_replace_property_blob(struct drm_property_blob **blob,
410 struct drm_property_blob *new_blob,
413 struct drm_property_blob *old_blob = *blob;
415 if (old_blob == new_blob)
418 drm_property_unreference_blob(old_blob);
420 drm_property_reference_blob(new_blob);
428 drm_atomic_replace_property_blob_from_id(struct drm_crtc *crtc,
429 struct drm_property_blob **blob,
431 ssize_t expected_size,
434 struct drm_property_blob *new_blob = NULL;
437 new_blob = drm_property_lookup_blob(crtc->dev, blob_id);
438 if (new_blob == NULL)
441 if (expected_size > 0 && expected_size != new_blob->length) {
442 drm_property_unreference_blob(new_blob);
447 drm_atomic_replace_property_blob(blob, new_blob, replaced);
448 drm_property_unreference_blob(new_blob);
454 * drm_atomic_crtc_set_property - set property on CRTC
455 * @crtc: the drm CRTC to set a property on
456 * @state: the state object to update with the new property value
457 * @property: the property to set
458 * @val: the new property value
460 * This function handles generic/core properties and calls out to driver's
461 * &drm_crtc_funcs.atomic_set_property for driver properties. To ensure
462 * consistent behavior you must call this function rather than the driver hook
466 * Zero on success, error code on failure
468 int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
469 struct drm_crtc_state *state, struct drm_property *property,
472 struct drm_device *dev = crtc->dev;
473 struct drm_mode_config *config = &dev->mode_config;
474 bool replaced = false;
477 if (property == config->prop_active)
479 else if (property == config->prop_mode_id) {
480 struct drm_property_blob *mode =
481 drm_property_lookup_blob(dev, val);
482 ret = drm_atomic_set_mode_prop_for_crtc(state, mode);
483 drm_property_unreference_blob(mode);
485 } else if (property == config->degamma_lut_property) {
486 ret = drm_atomic_replace_property_blob_from_id(crtc,
491 state->color_mgmt_changed |= replaced;
493 } else if (property == config->ctm_property) {
494 ret = drm_atomic_replace_property_blob_from_id(crtc,
497 sizeof(struct drm_color_ctm),
499 state->color_mgmt_changed |= replaced;
501 } else if (property == config->gamma_lut_property) {
502 ret = drm_atomic_replace_property_blob_from_id(crtc,
507 state->color_mgmt_changed |= replaced;
509 } else if (property == config->prop_out_fence_ptr) {
510 s64 __user *fence_ptr = u64_to_user_ptr(val);
515 if (put_user(-1, fence_ptr))
518 set_out_fence_for_crtc(state->state, crtc, fence_ptr);
519 } else if (crtc->funcs->atomic_set_property)
520 return crtc->funcs->atomic_set_property(crtc, state, property, val);
526 EXPORT_SYMBOL(drm_atomic_crtc_set_property);
529 * drm_atomic_crtc_get_property - get property value from CRTC state
530 * @crtc: the drm CRTC to set a property on
531 * @state: the state object to get the property value from
532 * @property: the property to set
533 * @val: return location for the property value
535 * This function handles generic/core properties and calls out to driver's
536 * &drm_crtc_funcs.atomic_get_property for driver properties. To ensure
537 * consistent behavior you must call this function rather than the driver hook
541 * Zero on success, error code on failure
544 drm_atomic_crtc_get_property(struct drm_crtc *crtc,
545 const struct drm_crtc_state *state,
546 struct drm_property *property, uint64_t *val)
548 struct drm_device *dev = crtc->dev;
549 struct drm_mode_config *config = &dev->mode_config;
551 if (property == config->prop_active)
552 *val = state->active;
553 else if (property == config->prop_mode_id)
554 *val = (state->mode_blob) ? state->mode_blob->base.id : 0;
555 else if (property == config->degamma_lut_property)
556 *val = (state->degamma_lut) ? state->degamma_lut->base.id : 0;
557 else if (property == config->ctm_property)
558 *val = (state->ctm) ? state->ctm->base.id : 0;
559 else if (property == config->gamma_lut_property)
560 *val = (state->gamma_lut) ? state->gamma_lut->base.id : 0;
561 else if (property == config->prop_out_fence_ptr)
563 else if (crtc->funcs->atomic_get_property)
564 return crtc->funcs->atomic_get_property(crtc, state, property, val);
572 * drm_atomic_crtc_check - check crtc state
573 * @crtc: crtc to check
574 * @state: crtc state to check
576 * Provides core sanity checks for crtc state.
579 * Zero on success, error code on failure
581 static int drm_atomic_crtc_check(struct drm_crtc *crtc,
582 struct drm_crtc_state *state)
584 /* NOTE: we explicitly don't enforce constraints such as primary
585 * layer covering entire screen, since that is something we want
586 * to allow (on hw that supports it). For hw that does not, it
587 * should be checked in driver's crtc->atomic_check() vfunc.
589 * TODO: Add generic modeset state checks once we support those.
592 if (state->active && !state->enable) {
593 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active without enabled\n",
594 crtc->base.id, crtc->name);
598 /* The state->enable vs. state->mode_blob checks can be WARN_ON,
599 * as this is a kernel-internal detail that userspace should never
600 * be able to trigger. */
601 if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
602 WARN_ON(state->enable && !state->mode_blob)) {
603 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled without mode blob\n",
604 crtc->base.id, crtc->name);
608 if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
609 WARN_ON(!state->enable && state->mode_blob)) {
610 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled with mode blob\n",
611 crtc->base.id, crtc->name);
616 * Reject event generation for when a CRTC is off and stays off.
617 * It wouldn't be hard to implement this, but userspace has a track
618 * record of happily burning through 100% cpu (or worse, crash) when the
619 * display pipe is suspended. To avoid all that fun just reject updates
620 * that ask for events since likely that indicates a bug in the
621 * compositor's drawing loop. This is consistent with the vblank IOCTL
622 * and legacy page_flip IOCTL which also reject service on a disabled
625 if (state->event && !state->active && !crtc->state->active) {
626 DRM_DEBUG_ATOMIC("[CRTC:%d] requesting event but off\n",
634 static void drm_atomic_crtc_print_state(struct drm_printer *p,
635 const struct drm_crtc_state *state)
637 struct drm_crtc *crtc = state->crtc;
639 drm_printf(p, "crtc[%u]: %s\n", crtc->base.id, crtc->name);
640 drm_printf(p, "\tenable=%d\n", state->enable);
641 drm_printf(p, "\tactive=%d\n", state->active);
642 drm_printf(p, "\tplanes_changed=%d\n", state->planes_changed);
643 drm_printf(p, "\tmode_changed=%d\n", state->mode_changed);
644 drm_printf(p, "\tactive_changed=%d\n", state->active_changed);
645 drm_printf(p, "\tconnectors_changed=%d\n", state->connectors_changed);
646 drm_printf(p, "\tcolor_mgmt_changed=%d\n", state->color_mgmt_changed);
647 drm_printf(p, "\tplane_mask=%x\n", state->plane_mask);
648 drm_printf(p, "\tconnector_mask=%x\n", state->connector_mask);
649 drm_printf(p, "\tencoder_mask=%x\n", state->encoder_mask);
650 drm_printf(p, "\tmode: " DRM_MODE_FMT "\n", DRM_MODE_ARG(&state->mode));
652 if (crtc->funcs->atomic_print_state)
653 crtc->funcs->atomic_print_state(p, state);
657 * drm_atomic_get_plane_state - get plane state
658 * @state: global atomic state object
659 * @plane: plane to get state object for
661 * This function returns the plane state for the given plane, allocating it if
662 * needed. It will also grab the relevant plane lock to make sure that the state
667 * Either the allocated state or the error code encoded into the pointer. When
668 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
669 * entire atomic sequence must be restarted. All other errors are fatal.
671 struct drm_plane_state *
672 drm_atomic_get_plane_state(struct drm_atomic_state *state,
673 struct drm_plane *plane)
675 int ret, index = drm_plane_index(plane);
676 struct drm_plane_state *plane_state;
678 WARN_ON(!state->acquire_ctx);
680 plane_state = drm_atomic_get_existing_plane_state(state, plane);
684 ret = drm_modeset_lock(&plane->mutex, state->acquire_ctx);
688 plane_state = plane->funcs->atomic_duplicate_state(plane);
690 return ERR_PTR(-ENOMEM);
692 state->planes[index].state = plane_state;
693 state->planes[index].ptr = plane;
694 state->planes[index].old_state = plane->state;
695 state->planes[index].new_state = plane_state;
696 plane_state->state = state;
698 DRM_DEBUG_ATOMIC("Added [PLANE:%d:%s] %p state to %p\n",
699 plane->base.id, plane->name, plane_state, state);
701 if (plane_state->crtc) {
702 struct drm_crtc_state *crtc_state;
704 crtc_state = drm_atomic_get_crtc_state(state,
706 if (IS_ERR(crtc_state))
707 return ERR_CAST(crtc_state);
712 EXPORT_SYMBOL(drm_atomic_get_plane_state);
715 * drm_atomic_plane_set_property - set property on plane
716 * @plane: the drm plane to set a property on
717 * @state: the state object to update with the new property value
718 * @property: the property to set
719 * @val: the new property value
721 * This function handles generic/core properties and calls out to driver's
722 * &drm_plane_funcs.atomic_set_property for driver properties. To ensure
723 * consistent behavior you must call this function rather than the driver hook
727 * Zero on success, error code on failure
729 int drm_atomic_plane_set_property(struct drm_plane *plane,
730 struct drm_plane_state *state, struct drm_property *property,
733 struct drm_device *dev = plane->dev;
734 struct drm_mode_config *config = &dev->mode_config;
736 if (property == config->prop_fb_id) {
737 struct drm_framebuffer *fb = drm_framebuffer_lookup(dev, val);
738 drm_atomic_set_fb_for_plane(state, fb);
740 drm_framebuffer_unreference(fb);
741 } else if (property == config->prop_in_fence_fd) {
745 if (U642I64(val) == -1)
748 state->fence = sync_file_get_fence(val);
752 } else if (property == config->prop_crtc_id) {
753 struct drm_crtc *crtc = drm_crtc_find(dev, val);
754 return drm_atomic_set_crtc_for_plane(state, crtc);
755 } else if (property == config->prop_crtc_x) {
756 state->crtc_x = U642I64(val);
757 } else if (property == config->prop_crtc_y) {
758 state->crtc_y = U642I64(val);
759 } else if (property == config->prop_crtc_w) {
761 } else if (property == config->prop_crtc_h) {
763 } else if (property == config->prop_src_x) {
765 } else if (property == config->prop_src_y) {
767 } else if (property == config->prop_src_w) {
769 } else if (property == config->prop_src_h) {
771 } else if (property == plane->rotation_property) {
772 if (!is_power_of_2(val & DRM_ROTATE_MASK))
774 state->rotation = val;
775 } else if (property == plane->zpos_property) {
777 } else if (plane->funcs->atomic_set_property) {
778 return plane->funcs->atomic_set_property(plane, state,
786 EXPORT_SYMBOL(drm_atomic_plane_set_property);
789 * drm_atomic_plane_get_property - get property value from plane state
790 * @plane: the drm plane to set a property on
791 * @state: the state object to get the property value from
792 * @property: the property to set
793 * @val: return location for the property value
795 * This function handles generic/core properties and calls out to driver's
796 * &drm_plane_funcs.atomic_get_property for driver properties. To ensure
797 * consistent behavior you must call this function rather than the driver hook
801 * Zero on success, error code on failure
804 drm_atomic_plane_get_property(struct drm_plane *plane,
805 const struct drm_plane_state *state,
806 struct drm_property *property, uint64_t *val)
808 struct drm_device *dev = plane->dev;
809 struct drm_mode_config *config = &dev->mode_config;
811 if (property == config->prop_fb_id) {
812 *val = (state->fb) ? state->fb->base.id : 0;
813 } else if (property == config->prop_in_fence_fd) {
815 } else if (property == config->prop_crtc_id) {
816 *val = (state->crtc) ? state->crtc->base.id : 0;
817 } else if (property == config->prop_crtc_x) {
818 *val = I642U64(state->crtc_x);
819 } else if (property == config->prop_crtc_y) {
820 *val = I642U64(state->crtc_y);
821 } else if (property == config->prop_crtc_w) {
822 *val = state->crtc_w;
823 } else if (property == config->prop_crtc_h) {
824 *val = state->crtc_h;
825 } else if (property == config->prop_src_x) {
827 } else if (property == config->prop_src_y) {
829 } else if (property == config->prop_src_w) {
831 } else if (property == config->prop_src_h) {
833 } else if (property == plane->rotation_property) {
834 *val = state->rotation;
835 } else if (property == plane->zpos_property) {
837 } else if (plane->funcs->atomic_get_property) {
838 return plane->funcs->atomic_get_property(plane, state, property, val);
847 plane_switching_crtc(struct drm_atomic_state *state,
848 struct drm_plane *plane,
849 struct drm_plane_state *plane_state)
851 if (!plane->state->crtc || !plane_state->crtc)
854 if (plane->state->crtc == plane_state->crtc)
857 /* This could be refined, but currently there's no helper or driver code
858 * to implement direct switching of active planes nor userspace to take
859 * advantage of more direct plane switching without the intermediate
866 * drm_atomic_plane_check - check plane state
867 * @plane: plane to check
868 * @state: plane state to check
870 * Provides core sanity checks for plane state.
873 * Zero on success, error code on failure
875 static int drm_atomic_plane_check(struct drm_plane *plane,
876 struct drm_plane_state *state)
878 unsigned int fb_width, fb_height;
881 /* either *both* CRTC and FB must be set, or neither */
882 if (WARN_ON(state->crtc && !state->fb)) {
883 DRM_DEBUG_ATOMIC("CRTC set but no FB\n");
885 } else if (WARN_ON(state->fb && !state->crtc)) {
886 DRM_DEBUG_ATOMIC("FB set but no CRTC\n");
890 /* if disabled, we don't care about the rest of the state: */
894 /* Check whether this plane is usable on this CRTC */
895 if (!(plane->possible_crtcs & drm_crtc_mask(state->crtc))) {
896 DRM_DEBUG_ATOMIC("Invalid crtc for plane\n");
900 /* Check whether this plane supports the fb pixel format. */
901 ret = drm_plane_check_pixel_format(plane, state->fb->format->format);
903 struct drm_format_name_buf format_name;
904 DRM_DEBUG_ATOMIC("Invalid pixel format %s\n",
905 drm_get_format_name(state->fb->format->format,
910 /* Give drivers some help against integer overflows */
911 if (state->crtc_w > INT_MAX ||
912 state->crtc_x > INT_MAX - (int32_t) state->crtc_w ||
913 state->crtc_h > INT_MAX ||
914 state->crtc_y > INT_MAX - (int32_t) state->crtc_h) {
915 DRM_DEBUG_ATOMIC("Invalid CRTC coordinates %ux%u+%d+%d\n",
916 state->crtc_w, state->crtc_h,
917 state->crtc_x, state->crtc_y);
921 fb_width = state->fb->width << 16;
922 fb_height = state->fb->height << 16;
924 /* Make sure source coordinates are inside the fb. */
925 if (state->src_w > fb_width ||
926 state->src_x > fb_width - state->src_w ||
927 state->src_h > fb_height ||
928 state->src_y > fb_height - state->src_h) {
929 DRM_DEBUG_ATOMIC("Invalid source coordinates "
930 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
931 state->src_w >> 16, ((state->src_w & 0xffff) * 15625) >> 10,
932 state->src_h >> 16, ((state->src_h & 0xffff) * 15625) >> 10,
933 state->src_x >> 16, ((state->src_x & 0xffff) * 15625) >> 10,
934 state->src_y >> 16, ((state->src_y & 0xffff) * 15625) >> 10);
938 if (plane_switching_crtc(state->state, plane, state)) {
939 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] switching CRTC directly\n",
940 plane->base.id, plane->name);
947 static void drm_atomic_plane_print_state(struct drm_printer *p,
948 const struct drm_plane_state *state)
950 struct drm_plane *plane = state->plane;
951 struct drm_rect src = drm_plane_state_src(state);
952 struct drm_rect dest = drm_plane_state_dest(state);
954 drm_printf(p, "plane[%u]: %s\n", plane->base.id, plane->name);
955 drm_printf(p, "\tcrtc=%s\n", state->crtc ? state->crtc->name : "(null)");
956 drm_printf(p, "\tfb=%u\n", state->fb ? state->fb->base.id : 0);
958 struct drm_framebuffer *fb = state->fb;
959 int i, n = fb->format->num_planes;
960 struct drm_format_name_buf format_name;
962 drm_printf(p, "\t\tformat=%s\n",
963 drm_get_format_name(fb->format->format, &format_name));
964 drm_printf(p, "\t\t\tmodifier=0x%llx\n", fb->modifier);
965 drm_printf(p, "\t\tsize=%dx%d\n", fb->width, fb->height);
966 drm_printf(p, "\t\tlayers:\n");
967 for (i = 0; i < n; i++) {
968 drm_printf(p, "\t\t\tpitch[%d]=%u\n", i, fb->pitches[i]);
969 drm_printf(p, "\t\t\toffset[%d]=%u\n", i, fb->offsets[i]);
972 drm_printf(p, "\tcrtc-pos=" DRM_RECT_FMT "\n", DRM_RECT_ARG(&dest));
973 drm_printf(p, "\tsrc-pos=" DRM_RECT_FP_FMT "\n", DRM_RECT_FP_ARG(&src));
974 drm_printf(p, "\trotation=%x\n", state->rotation);
976 if (plane->funcs->atomic_print_state)
977 plane->funcs->atomic_print_state(p, state);
981 * drm_atomic_get_connector_state - get connector state
982 * @state: global atomic state object
983 * @connector: connector to get state object for
985 * This function returns the connector state for the given connector,
986 * allocating it if needed. It will also grab the relevant connector lock to
987 * make sure that the state is consistent.
991 * Either the allocated state or the error code encoded into the pointer. When
992 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
993 * entire atomic sequence must be restarted. All other errors are fatal.
995 struct drm_connector_state *
996 drm_atomic_get_connector_state(struct drm_atomic_state *state,
997 struct drm_connector *connector)
1000 struct drm_mode_config *config = &connector->dev->mode_config;
1001 struct drm_connector_state *connector_state;
1003 WARN_ON(!state->acquire_ctx);
1005 ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1007 return ERR_PTR(ret);
1009 index = drm_connector_index(connector);
1011 if (index >= state->num_connector) {
1012 struct __drm_connnectors_state *c;
1013 int alloc = max(index + 1, config->num_connector);
1015 c = krealloc(state->connectors, alloc * sizeof(*state->connectors), GFP_KERNEL);
1017 return ERR_PTR(-ENOMEM);
1019 state->connectors = c;
1020 memset(&state->connectors[state->num_connector], 0,
1021 sizeof(*state->connectors) * (alloc - state->num_connector));
1023 state->num_connector = alloc;
1026 if (state->connectors[index].state)
1027 return state->connectors[index].state;
1029 connector_state = connector->funcs->atomic_duplicate_state(connector);
1030 if (!connector_state)
1031 return ERR_PTR(-ENOMEM);
1033 drm_connector_reference(connector);
1034 state->connectors[index].state = connector_state;
1035 state->connectors[index].old_state = connector->state;
1036 state->connectors[index].new_state = connector_state;
1037 state->connectors[index].ptr = connector;
1038 connector_state->state = state;
1040 DRM_DEBUG_ATOMIC("Added [CONNECTOR:%d] %p state to %p\n",
1041 connector->base.id, connector_state, state);
1043 if (connector_state->crtc) {
1044 struct drm_crtc_state *crtc_state;
1046 crtc_state = drm_atomic_get_crtc_state(state,
1047 connector_state->crtc);
1048 if (IS_ERR(crtc_state))
1049 return ERR_CAST(crtc_state);
1052 return connector_state;
1054 EXPORT_SYMBOL(drm_atomic_get_connector_state);
1057 * drm_atomic_connector_set_property - set property on connector.
1058 * @connector: the drm connector to set a property on
1059 * @state: the state object to update with the new property value
1060 * @property: the property to set
1061 * @val: the new property value
1063 * This function handles generic/core properties and calls out to driver's
1064 * &drm_connector_funcs.atomic_set_property for driver properties. To ensure
1065 * consistent behavior you must call this function rather than the driver hook
1069 * Zero on success, error code on failure
1071 int drm_atomic_connector_set_property(struct drm_connector *connector,
1072 struct drm_connector_state *state, struct drm_property *property,
1075 struct drm_device *dev = connector->dev;
1076 struct drm_mode_config *config = &dev->mode_config;
1078 if (property == config->prop_crtc_id) {
1079 struct drm_crtc *crtc = drm_crtc_find(dev, val);
1080 return drm_atomic_set_crtc_for_connector(state, crtc);
1081 } else if (property == config->dpms_property) {
1082 /* setting DPMS property requires special handling, which
1083 * is done in legacy setprop path for us. Disallow (for
1084 * now?) atomic writes to DPMS property:
1087 } else if (property == config->tv_select_subconnector_property) {
1088 state->tv.subconnector = val;
1089 } else if (property == config->tv_left_margin_property) {
1090 state->tv.margins.left = val;
1091 } else if (property == config->tv_right_margin_property) {
1092 state->tv.margins.right = val;
1093 } else if (property == config->tv_top_margin_property) {
1094 state->tv.margins.top = val;
1095 } else if (property == config->tv_bottom_margin_property) {
1096 state->tv.margins.bottom = val;
1097 } else if (property == config->tv_mode_property) {
1098 state->tv.mode = val;
1099 } else if (property == config->tv_brightness_property) {
1100 state->tv.brightness = val;
1101 } else if (property == config->tv_contrast_property) {
1102 state->tv.contrast = val;
1103 } else if (property == config->tv_flicker_reduction_property) {
1104 state->tv.flicker_reduction = val;
1105 } else if (property == config->tv_overscan_property) {
1106 state->tv.overscan = val;
1107 } else if (property == config->tv_saturation_property) {
1108 state->tv.saturation = val;
1109 } else if (property == config->tv_hue_property) {
1110 state->tv.hue = val;
1111 } else if (connector->funcs->atomic_set_property) {
1112 return connector->funcs->atomic_set_property(connector,
1113 state, property, val);
1120 EXPORT_SYMBOL(drm_atomic_connector_set_property);
1122 static void drm_atomic_connector_print_state(struct drm_printer *p,
1123 const struct drm_connector_state *state)
1125 struct drm_connector *connector = state->connector;
1127 drm_printf(p, "connector[%u]: %s\n", connector->base.id, connector->name);
1128 drm_printf(p, "\tcrtc=%s\n", state->crtc ? state->crtc->name : "(null)");
1130 if (connector->funcs->atomic_print_state)
1131 connector->funcs->atomic_print_state(p, state);
1135 * drm_atomic_connector_get_property - get property value from connector state
1136 * @connector: the drm connector to set a property on
1137 * @state: the state object to get the property value from
1138 * @property: the property to set
1139 * @val: return location for the property value
1141 * This function handles generic/core properties and calls out to driver's
1142 * &drm_connector_funcs.atomic_get_property for driver properties. To ensure
1143 * consistent behavior you must call this function rather than the driver hook
1147 * Zero on success, error code on failure
1150 drm_atomic_connector_get_property(struct drm_connector *connector,
1151 const struct drm_connector_state *state,
1152 struct drm_property *property, uint64_t *val)
1154 struct drm_device *dev = connector->dev;
1155 struct drm_mode_config *config = &dev->mode_config;
1157 if (property == config->prop_crtc_id) {
1158 *val = (state->crtc) ? state->crtc->base.id : 0;
1159 } else if (property == config->dpms_property) {
1160 *val = connector->dpms;
1161 } else if (property == config->tv_select_subconnector_property) {
1162 *val = state->tv.subconnector;
1163 } else if (property == config->tv_left_margin_property) {
1164 *val = state->tv.margins.left;
1165 } else if (property == config->tv_right_margin_property) {
1166 *val = state->tv.margins.right;
1167 } else if (property == config->tv_top_margin_property) {
1168 *val = state->tv.margins.top;
1169 } else if (property == config->tv_bottom_margin_property) {
1170 *val = state->tv.margins.bottom;
1171 } else if (property == config->tv_mode_property) {
1172 *val = state->tv.mode;
1173 } else if (property == config->tv_brightness_property) {
1174 *val = state->tv.brightness;
1175 } else if (property == config->tv_contrast_property) {
1176 *val = state->tv.contrast;
1177 } else if (property == config->tv_flicker_reduction_property) {
1178 *val = state->tv.flicker_reduction;
1179 } else if (property == config->tv_overscan_property) {
1180 *val = state->tv.overscan;
1181 } else if (property == config->tv_saturation_property) {
1182 *val = state->tv.saturation;
1183 } else if (property == config->tv_hue_property) {
1184 *val = state->tv.hue;
1185 } else if (connector->funcs->atomic_get_property) {
1186 return connector->funcs->atomic_get_property(connector,
1187 state, property, val);
1195 int drm_atomic_get_property(struct drm_mode_object *obj,
1196 struct drm_property *property, uint64_t *val)
1198 struct drm_device *dev = property->dev;
1201 switch (obj->type) {
1202 case DRM_MODE_OBJECT_CONNECTOR: {
1203 struct drm_connector *connector = obj_to_connector(obj);
1204 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
1205 ret = drm_atomic_connector_get_property(connector,
1206 connector->state, property, val);
1209 case DRM_MODE_OBJECT_CRTC: {
1210 struct drm_crtc *crtc = obj_to_crtc(obj);
1211 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
1212 ret = drm_atomic_crtc_get_property(crtc,
1213 crtc->state, property, val);
1216 case DRM_MODE_OBJECT_PLANE: {
1217 struct drm_plane *plane = obj_to_plane(obj);
1218 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
1219 ret = drm_atomic_plane_get_property(plane,
1220 plane->state, property, val);
1232 * drm_atomic_set_crtc_for_plane - set crtc for plane
1233 * @plane_state: the plane whose incoming state to update
1234 * @crtc: crtc to use for the plane
1236 * Changing the assigned crtc for a plane requires us to grab the lock and state
1237 * for the new crtc, as needed. This function takes care of all these details
1238 * besides updating the pointer in the state object itself.
1241 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1242 * then the w/w mutex code has detected a deadlock and the entire atomic
1243 * sequence must be restarted. All other errors are fatal.
1246 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
1247 struct drm_crtc *crtc)
1249 struct drm_plane *plane = plane_state->plane;
1250 struct drm_crtc_state *crtc_state;
1252 if (plane_state->crtc) {
1253 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1255 if (WARN_ON(IS_ERR(crtc_state)))
1256 return PTR_ERR(crtc_state);
1258 crtc_state->plane_mask &= ~(1 << drm_plane_index(plane));
1261 plane_state->crtc = crtc;
1264 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1266 if (IS_ERR(crtc_state))
1267 return PTR_ERR(crtc_state);
1268 crtc_state->plane_mask |= (1 << drm_plane_index(plane));
1272 DRM_DEBUG_ATOMIC("Link plane state %p to [CRTC:%d:%s]\n",
1273 plane_state, crtc->base.id, crtc->name);
1275 DRM_DEBUG_ATOMIC("Link plane state %p to [NOCRTC]\n",
1280 EXPORT_SYMBOL(drm_atomic_set_crtc_for_plane);
1283 * drm_atomic_set_fb_for_plane - set framebuffer for plane
1284 * @plane_state: atomic state object for the plane
1285 * @fb: fb to use for the plane
1287 * Changing the assigned framebuffer for a plane requires us to grab a reference
1288 * to the new fb and drop the reference to the old fb, if there is one. This
1289 * function takes care of all these details besides updating the pointer in the
1290 * state object itself.
1293 drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
1294 struct drm_framebuffer *fb)
1297 DRM_DEBUG_ATOMIC("Set [FB:%d] for plane state %p\n",
1298 fb->base.id, plane_state);
1300 DRM_DEBUG_ATOMIC("Set [NOFB] for plane state %p\n",
1303 drm_framebuffer_assign(&plane_state->fb, fb);
1305 EXPORT_SYMBOL(drm_atomic_set_fb_for_plane);
1308 * drm_atomic_set_fence_for_plane - set fence for plane
1309 * @plane_state: atomic state object for the plane
1310 * @fence: dma_fence to use for the plane
1312 * Helper to setup the plane_state fence in case it is not set yet.
1313 * By using this drivers doesn't need to worry if the user choose
1314 * implicit or explicit fencing.
1316 * This function will not set the fence to the state if it was set
1317 * via explicit fencing interfaces on the atomic ioctl. In that case it will
1318 * drop the reference to the fence as we are not storing it anywhere.
1319 * Otherwise, if &drm_plane_state.fence is not set this function we just set it
1320 * with the received implicit fence. In both cases this function consumes a
1321 * reference for @fence.
1324 drm_atomic_set_fence_for_plane(struct drm_plane_state *plane_state,
1325 struct dma_fence *fence)
1327 if (plane_state->fence) {
1328 dma_fence_put(fence);
1332 plane_state->fence = fence;
1334 EXPORT_SYMBOL(drm_atomic_set_fence_for_plane);
1337 * drm_atomic_set_crtc_for_connector - set crtc for connector
1338 * @conn_state: atomic state object for the connector
1339 * @crtc: crtc to use for the connector
1341 * Changing the assigned crtc for a connector requires us to grab the lock and
1342 * state for the new crtc, as needed. This function takes care of all these
1343 * details besides updating the pointer in the state object itself.
1346 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1347 * then the w/w mutex code has detected a deadlock and the entire atomic
1348 * sequence must be restarted. All other errors are fatal.
1351 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
1352 struct drm_crtc *crtc)
1354 struct drm_crtc_state *crtc_state;
1356 if (conn_state->crtc == crtc)
1359 if (conn_state->crtc) {
1360 crtc_state = drm_atomic_get_existing_crtc_state(conn_state->state,
1363 crtc_state->connector_mask &=
1364 ~(1 << drm_connector_index(conn_state->connector));
1366 drm_connector_unreference(conn_state->connector);
1367 conn_state->crtc = NULL;
1371 crtc_state = drm_atomic_get_crtc_state(conn_state->state, crtc);
1372 if (IS_ERR(crtc_state))
1373 return PTR_ERR(crtc_state);
1375 crtc_state->connector_mask |=
1376 1 << drm_connector_index(conn_state->connector);
1378 drm_connector_reference(conn_state->connector);
1379 conn_state->crtc = crtc;
1381 DRM_DEBUG_ATOMIC("Link connector state %p to [CRTC:%d:%s]\n",
1382 conn_state, crtc->base.id, crtc->name);
1384 DRM_DEBUG_ATOMIC("Link connector state %p to [NOCRTC]\n",
1390 EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
1393 * drm_atomic_add_affected_connectors - add connectors for crtc
1394 * @state: atomic state
1397 * This function walks the current configuration and adds all connectors
1398 * currently using @crtc to the atomic configuration @state. Note that this
1399 * function must acquire the connection mutex. This can potentially cause
1400 * unneeded seralization if the update is just for the planes on one crtc. Hence
1401 * drivers and helpers should only call this when really needed (e.g. when a
1402 * full modeset needs to happen due to some change).
1405 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1406 * then the w/w mutex code has detected a deadlock and the entire atomic
1407 * sequence must be restarted. All other errors are fatal.
1410 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
1411 struct drm_crtc *crtc)
1413 struct drm_mode_config *config = &state->dev->mode_config;
1414 struct drm_connector *connector;
1415 struct drm_connector_state *conn_state;
1416 struct drm_connector_list_iter conn_iter;
1417 struct drm_crtc_state *crtc_state;
1420 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1421 if (IS_ERR(crtc_state))
1422 return PTR_ERR(crtc_state);
1424 ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1428 DRM_DEBUG_ATOMIC("Adding all current connectors for [CRTC:%d:%s] to %p\n",
1429 crtc->base.id, crtc->name, state);
1432 * Changed connectors are already in @state, so only need to look
1433 * at the connector_mask in crtc_state.
1435 drm_connector_list_iter_get(state->dev, &conn_iter);
1436 drm_for_each_connector_iter(connector, &conn_iter) {
1437 if (!(crtc_state->connector_mask & (1 << drm_connector_index(connector))))
1440 conn_state = drm_atomic_get_connector_state(state, connector);
1441 if (IS_ERR(conn_state)) {
1442 drm_connector_list_iter_put(&conn_iter);
1443 return PTR_ERR(conn_state);
1446 drm_connector_list_iter_put(&conn_iter);
1450 EXPORT_SYMBOL(drm_atomic_add_affected_connectors);
1453 * drm_atomic_add_affected_planes - add planes for crtc
1454 * @state: atomic state
1457 * This function walks the current configuration and adds all planes
1458 * currently used by @crtc to the atomic configuration @state. This is useful
1459 * when an atomic commit also needs to check all currently enabled plane on
1460 * @crtc, e.g. when changing the mode. It's also useful when re-enabling a CRTC
1461 * to avoid special code to force-enable all planes.
1463 * Since acquiring a plane state will always also acquire the w/w mutex of the
1464 * current CRTC for that plane (if there is any) adding all the plane states for
1465 * a CRTC will not reduce parallism of atomic updates.
1468 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1469 * then the w/w mutex code has detected a deadlock and the entire atomic
1470 * sequence must be restarted. All other errors are fatal.
1473 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
1474 struct drm_crtc *crtc)
1476 struct drm_plane *plane;
1478 WARN_ON(!drm_atomic_get_existing_crtc_state(state, crtc));
1480 drm_for_each_plane_mask(plane, state->dev, crtc->state->plane_mask) {
1481 struct drm_plane_state *plane_state =
1482 drm_atomic_get_plane_state(state, plane);
1484 if (IS_ERR(plane_state))
1485 return PTR_ERR(plane_state);
1489 EXPORT_SYMBOL(drm_atomic_add_affected_planes);
1492 * drm_atomic_legacy_backoff - locking backoff for legacy ioctls
1493 * @state: atomic state
1495 * This function should be used by legacy entry points which don't understand
1496 * -EDEADLK semantics. For simplicity this one will grab all modeset locks after
1497 * the slowpath completed.
1499 void drm_atomic_legacy_backoff(struct drm_atomic_state *state)
1501 struct drm_device *dev = state->dev;
1502 unsigned crtc_mask = 0;
1503 struct drm_crtc *crtc;
1505 bool global = false;
1507 drm_for_each_crtc(crtc, dev) {
1508 if (crtc->acquire_ctx != state->acquire_ctx)
1511 crtc_mask |= drm_crtc_mask(crtc);
1512 crtc->acquire_ctx = NULL;
1515 if (WARN_ON(dev->mode_config.acquire_ctx == state->acquire_ctx)) {
1518 dev->mode_config.acquire_ctx = NULL;
1522 drm_modeset_backoff(state->acquire_ctx);
1524 ret = drm_modeset_lock_all_ctx(dev, state->acquire_ctx);
1528 drm_for_each_crtc(crtc, dev)
1529 if (drm_crtc_mask(crtc) & crtc_mask)
1530 crtc->acquire_ctx = state->acquire_ctx;
1533 dev->mode_config.acquire_ctx = state->acquire_ctx;
1535 EXPORT_SYMBOL(drm_atomic_legacy_backoff);
1538 * drm_atomic_check_only - check whether a given config would work
1539 * @state: atomic configuration to check
1541 * Note that this function can return -EDEADLK if the driver needed to acquire
1542 * more locks but encountered a deadlock. The caller must then do the usual w/w
1543 * backoff dance and restart. All other errors are fatal.
1546 * 0 on success, negative error code on failure.
1548 int drm_atomic_check_only(struct drm_atomic_state *state)
1550 struct drm_device *dev = state->dev;
1551 struct drm_mode_config *config = &dev->mode_config;
1552 struct drm_plane *plane;
1553 struct drm_plane_state *plane_state;
1554 struct drm_crtc *crtc;
1555 struct drm_crtc_state *crtc_state;
1558 DRM_DEBUG_ATOMIC("checking %p\n", state);
1560 for_each_new_plane_in_state(state, plane, plane_state, i) {
1561 ret = drm_atomic_plane_check(plane, plane_state);
1563 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic core check failed\n",
1564 plane->base.id, plane->name);
1569 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1570 ret = drm_atomic_crtc_check(crtc, crtc_state);
1572 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic core check failed\n",
1573 crtc->base.id, crtc->name);
1578 if (config->funcs->atomic_check)
1579 ret = config->funcs->atomic_check(state->dev, state);
1581 if (!state->allow_modeset) {
1582 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1583 if (drm_atomic_crtc_needs_modeset(crtc_state)) {
1584 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] requires full modeset\n",
1585 crtc->base.id, crtc->name);
1593 EXPORT_SYMBOL(drm_atomic_check_only);
1596 * drm_atomic_commit - commit configuration atomically
1597 * @state: atomic configuration to check
1599 * Note that this function can return -EDEADLK if the driver needed to acquire
1600 * more locks but encountered a deadlock. The caller must then do the usual w/w
1601 * backoff dance and restart. All other errors are fatal.
1603 * This function will take its own reference on @state.
1604 * Callers should always release their reference with drm_atomic_state_put().
1607 * 0 on success, negative error code on failure.
1609 int drm_atomic_commit(struct drm_atomic_state *state)
1611 struct drm_mode_config *config = &state->dev->mode_config;
1614 ret = drm_atomic_check_only(state);
1618 DRM_DEBUG_ATOMIC("commiting %p\n", state);
1620 return config->funcs->atomic_commit(state->dev, state, false);
1622 EXPORT_SYMBOL(drm_atomic_commit);
1625 * drm_atomic_nonblocking_commit - atomic nonblocking commit
1626 * @state: atomic configuration to check
1628 * Note that this function can return -EDEADLK if the driver needed to acquire
1629 * more locks but encountered a deadlock. The caller must then do the usual w/w
1630 * backoff dance and restart. All other errors are fatal.
1632 * This function will take its own reference on @state.
1633 * Callers should always release their reference with drm_atomic_state_put().
1636 * 0 on success, negative error code on failure.
1638 int drm_atomic_nonblocking_commit(struct drm_atomic_state *state)
1640 struct drm_mode_config *config = &state->dev->mode_config;
1643 ret = drm_atomic_check_only(state);
1647 DRM_DEBUG_ATOMIC("commiting %p nonblocking\n", state);
1649 return config->funcs->atomic_commit(state->dev, state, true);
1651 EXPORT_SYMBOL(drm_atomic_nonblocking_commit);
1653 static void drm_atomic_print_state(const struct drm_atomic_state *state)
1655 struct drm_printer p = drm_info_printer(state->dev->dev);
1656 struct drm_plane *plane;
1657 struct drm_plane_state *plane_state;
1658 struct drm_crtc *crtc;
1659 struct drm_crtc_state *crtc_state;
1660 struct drm_connector *connector;
1661 struct drm_connector_state *connector_state;
1664 DRM_DEBUG_ATOMIC("checking %p\n", state);
1666 for_each_new_plane_in_state(state, plane, plane_state, i)
1667 drm_atomic_plane_print_state(&p, plane_state);
1669 for_each_new_crtc_in_state(state, crtc, crtc_state, i)
1670 drm_atomic_crtc_print_state(&p, crtc_state);
1672 for_each_new_connector_in_state(state, connector, connector_state, i)
1673 drm_atomic_connector_print_state(&p, connector_state);
1677 * drm_state_dump - dump entire device atomic state
1678 * @dev: the drm device
1679 * @p: where to print the state to
1681 * Just for debugging. Drivers might want an option to dump state
1682 * to dmesg in case of error irq's. (Hint, you probably want to
1685 * The caller must drm_modeset_lock_all(), or if this is called
1686 * from error irq handler, it should not be enabled by default.
1687 * (Ie. if you are debugging errors you might not care that this
1688 * is racey. But calling this without all modeset locks held is
1689 * not inherently safe.)
1691 void drm_state_dump(struct drm_device *dev, struct drm_printer *p)
1693 struct drm_mode_config *config = &dev->mode_config;
1694 struct drm_plane *plane;
1695 struct drm_crtc *crtc;
1696 struct drm_connector *connector;
1697 struct drm_connector_list_iter conn_iter;
1699 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1702 list_for_each_entry(plane, &config->plane_list, head)
1703 drm_atomic_plane_print_state(p, plane->state);
1705 list_for_each_entry(crtc, &config->crtc_list, head)
1706 drm_atomic_crtc_print_state(p, crtc->state);
1708 drm_connector_list_iter_get(dev, &conn_iter);
1709 drm_for_each_connector_iter(connector, &conn_iter)
1710 drm_atomic_connector_print_state(p, connector->state);
1711 drm_connector_list_iter_put(&conn_iter);
1713 EXPORT_SYMBOL(drm_state_dump);
1715 #ifdef CONFIG_DEBUG_FS
1716 static int drm_state_info(struct seq_file *m, void *data)
1718 struct drm_info_node *node = (struct drm_info_node *) m->private;
1719 struct drm_device *dev = node->minor->dev;
1720 struct drm_printer p = drm_seq_file_printer(m);
1722 drm_modeset_lock_all(dev);
1723 drm_state_dump(dev, &p);
1724 drm_modeset_unlock_all(dev);
1729 /* any use in debugfs files to dump individual planes/crtc/etc? */
1730 static const struct drm_info_list drm_atomic_debugfs_list[] = {
1731 {"state", drm_state_info, 0},
1734 int drm_atomic_debugfs_init(struct drm_minor *minor)
1736 return drm_debugfs_create_files(drm_atomic_debugfs_list,
1737 ARRAY_SIZE(drm_atomic_debugfs_list),
1738 minor->debugfs_root, minor);
1743 * The big monstor ioctl
1746 static struct drm_pending_vblank_event *create_vblank_event(
1747 struct drm_device *dev, uint64_t user_data)
1749 struct drm_pending_vblank_event *e = NULL;
1751 e = kzalloc(sizeof *e, GFP_KERNEL);
1755 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1756 e->event.base.length = sizeof(e->event);
1757 e->event.user_data = user_data;
1762 static int atomic_set_prop(struct drm_atomic_state *state,
1763 struct drm_mode_object *obj, struct drm_property *prop,
1764 uint64_t prop_value)
1766 struct drm_mode_object *ref;
1769 if (!drm_property_change_valid_get(prop, prop_value, &ref))
1772 switch (obj->type) {
1773 case DRM_MODE_OBJECT_CONNECTOR: {
1774 struct drm_connector *connector = obj_to_connector(obj);
1775 struct drm_connector_state *connector_state;
1777 connector_state = drm_atomic_get_connector_state(state, connector);
1778 if (IS_ERR(connector_state)) {
1779 ret = PTR_ERR(connector_state);
1783 ret = drm_atomic_connector_set_property(connector,
1784 connector_state, prop, prop_value);
1787 case DRM_MODE_OBJECT_CRTC: {
1788 struct drm_crtc *crtc = obj_to_crtc(obj);
1789 struct drm_crtc_state *crtc_state;
1791 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1792 if (IS_ERR(crtc_state)) {
1793 ret = PTR_ERR(crtc_state);
1797 ret = drm_atomic_crtc_set_property(crtc,
1798 crtc_state, prop, prop_value);
1801 case DRM_MODE_OBJECT_PLANE: {
1802 struct drm_plane *plane = obj_to_plane(obj);
1803 struct drm_plane_state *plane_state;
1805 plane_state = drm_atomic_get_plane_state(state, plane);
1806 if (IS_ERR(plane_state)) {
1807 ret = PTR_ERR(plane_state);
1811 ret = drm_atomic_plane_set_property(plane,
1812 plane_state, prop, prop_value);
1820 drm_property_change_valid_put(prop, ref);
1825 * drm_atomic_clean_old_fb -- Unset old_fb pointers and set plane->fb pointers.
1827 * @dev: drm device to check.
1828 * @plane_mask: plane mask for planes that were updated.
1829 * @ret: return value, can be -EDEADLK for a retry.
1831 * Before doing an update &drm_plane.old_fb is set to &drm_plane.fb, but before
1832 * dropping the locks old_fb needs to be set to NULL and plane->fb updated. This
1833 * is a common operation for each atomic update, so this call is split off as a
1836 void drm_atomic_clean_old_fb(struct drm_device *dev,
1837 unsigned plane_mask,
1840 struct drm_plane *plane;
1842 /* if succeeded, fixup legacy plane crtc/fb ptrs before dropping
1843 * locks (ie. while it is still safe to deref plane->state). We
1844 * need to do this here because the driver entry points cannot
1845 * distinguish between legacy and atomic ioctls.
1847 drm_for_each_plane_mask(plane, dev, plane_mask) {
1849 struct drm_framebuffer *new_fb = plane->state->fb;
1851 drm_framebuffer_reference(new_fb);
1853 plane->crtc = plane->state->crtc;
1856 drm_framebuffer_unreference(plane->old_fb);
1858 plane->old_fb = NULL;
1861 EXPORT_SYMBOL(drm_atomic_clean_old_fb);
1864 * DOC: explicit fencing properties
1866 * Explicit fencing allows userspace to control the buffer synchronization
1867 * between devices. A Fence or a group of fences are transfered to/from
1868 * userspace using Sync File fds and there are two DRM properties for that.
1869 * IN_FENCE_FD on each DRM Plane to send fences to the kernel and
1870 * OUT_FENCE_PTR on each DRM CRTC to receive fences from the kernel.
1872 * As a contrast, with implicit fencing the kernel keeps track of any
1873 * ongoing rendering, and automatically ensures that the atomic update waits
1874 * for any pending rendering to complete. For shared buffers represented with
1875 * a &struct dma_buf this is tracked in &struct reservation_object.
1876 * Implicit syncing is how Linux traditionally worked (e.g. DRI2/3 on X.org),
1877 * whereas explicit fencing is what Android wants.
1880 * Use this property to pass a fence that DRM should wait on before
1881 * proceeding with the Atomic Commit request and show the framebuffer for
1882 * the plane on the screen. The fence can be either a normal fence or a
1883 * merged one, the sync_file framework will handle both cases and use a
1884 * fence_array if a merged fence is received. Passing -1 here means no
1885 * fences to wait on.
1887 * If the Atomic Commit request has the DRM_MODE_ATOMIC_TEST_ONLY flag
1888 * it will only check if the Sync File is a valid one.
1890 * On the driver side the fence is stored on the @fence parameter of
1891 * &struct drm_plane_state. Drivers which also support implicit fencing
1892 * should set the implicit fence using drm_atomic_set_fence_for_plane(),
1893 * to make sure there's consistent behaviour between drivers in precedence
1894 * of implicit vs. explicit fencing.
1897 * Use this property to pass a file descriptor pointer to DRM. Once the
1898 * Atomic Commit request call returns OUT_FENCE_PTR will be filled with
1899 * the file descriptor number of a Sync File. This Sync File contains the
1900 * CRTC fence that will be signaled when all framebuffers present on the
1901 * Atomic Commit * request for that given CRTC are scanned out on the
1904 * The Atomic Commit request fails if a invalid pointer is passed. If the
1905 * Atomic Commit request fails for any other reason the out fence fd
1906 * returned will be -1. On a Atomic Commit with the
1907 * DRM_MODE_ATOMIC_TEST_ONLY flag the out fence will also be set to -1.
1909 * Note that out-fences don't have a special interface to drivers and are
1910 * internally represented by a &struct drm_pending_vblank_event in struct
1911 * &drm_crtc_state, which is also used by the nonblocking atomic commit
1912 * helpers and for the DRM event handling for existing userspace.
1915 struct drm_out_fence_state {
1916 s64 __user *out_fence_ptr;
1917 struct sync_file *sync_file;
1921 static int setup_out_fence(struct drm_out_fence_state *fence_state,
1922 struct dma_fence *fence)
1924 fence_state->fd = get_unused_fd_flags(O_CLOEXEC);
1925 if (fence_state->fd < 0)
1926 return fence_state->fd;
1928 if (put_user(fence_state->fd, fence_state->out_fence_ptr))
1931 fence_state->sync_file = sync_file_create(fence);
1932 if (!fence_state->sync_file)
1938 static int prepare_crtc_signaling(struct drm_device *dev,
1939 struct drm_atomic_state *state,
1940 struct drm_mode_atomic *arg,
1941 struct drm_file *file_priv,
1942 struct drm_out_fence_state **fence_state,
1943 unsigned int *num_fences)
1945 struct drm_crtc *crtc;
1946 struct drm_crtc_state *crtc_state;
1949 if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)
1952 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1953 u64 __user *fence_ptr;
1955 fence_ptr = get_out_fence_for_crtc(crtc_state->state, crtc);
1957 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT || fence_ptr) {
1958 struct drm_pending_vblank_event *e;
1960 e = create_vblank_event(dev, arg->user_data);
1964 crtc_state->event = e;
1967 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1968 struct drm_pending_vblank_event *e = crtc_state->event;
1973 ret = drm_event_reserve_init(dev, file_priv, &e->base,
1977 crtc_state->event = NULL;
1983 struct dma_fence *fence;
1984 struct drm_out_fence_state *f;
1986 f = krealloc(*fence_state, sizeof(**fence_state) *
1987 (*num_fences + 1), GFP_KERNEL);
1991 memset(&f[*num_fences], 0, sizeof(*f));
1993 f[*num_fences].out_fence_ptr = fence_ptr;
1996 fence = drm_crtc_create_fence(crtc);
2000 ret = setup_out_fence(&f[(*num_fences)++], fence);
2002 dma_fence_put(fence);
2006 crtc_state->event->base.fence = fence;
2013 static void complete_crtc_signaling(struct drm_device *dev,
2014 struct drm_atomic_state *state,
2015 struct drm_out_fence_state *fence_state,
2016 unsigned int num_fences,
2019 struct drm_crtc *crtc;
2020 struct drm_crtc_state *crtc_state;
2024 for (i = 0; i < num_fences; i++)
2025 fd_install(fence_state[i].fd,
2026 fence_state[i].sync_file->file);
2032 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
2034 * TEST_ONLY and PAGE_FLIP_EVENT are mutually
2035 * exclusive, if they weren't, this code should be
2036 * called on success for TEST_ONLY too.
2038 if (crtc_state->event)
2039 drm_event_cancel_free(dev, &crtc_state->event->base);
2045 for (i = 0; i < num_fences; i++) {
2046 if (fence_state[i].sync_file)
2047 fput(fence_state[i].sync_file->file);
2048 if (fence_state[i].fd >= 0)
2049 put_unused_fd(fence_state[i].fd);
2051 /* If this fails log error to the user */
2052 if (fence_state[i].out_fence_ptr &&
2053 put_user(-1, fence_state[i].out_fence_ptr))
2054 DRM_DEBUG_ATOMIC("Couldn't clear out_fence_ptr\n");
2060 int drm_mode_atomic_ioctl(struct drm_device *dev,
2061 void *data, struct drm_file *file_priv)
2063 struct drm_mode_atomic *arg = data;
2064 uint32_t __user *objs_ptr = (uint32_t __user *)(unsigned long)(arg->objs_ptr);
2065 uint32_t __user *count_props_ptr = (uint32_t __user *)(unsigned long)(arg->count_props_ptr);
2066 uint32_t __user *props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
2067 uint64_t __user *prop_values_ptr = (uint64_t __user *)(unsigned long)(arg->prop_values_ptr);
2068 unsigned int copied_objs, copied_props;
2069 struct drm_atomic_state *state;
2070 struct drm_modeset_acquire_ctx ctx;
2071 struct drm_plane *plane;
2072 struct drm_out_fence_state *fence_state = NULL;
2073 unsigned plane_mask;
2075 unsigned int i, j, num_fences = 0;
2077 /* disallow for drivers not supporting atomic: */
2078 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
2081 /* disallow for userspace that has not enabled atomic cap (even
2082 * though this may be a bit overkill, since legacy userspace
2083 * wouldn't know how to call this ioctl)
2085 if (!file_priv->atomic)
2088 if (arg->flags & ~DRM_MODE_ATOMIC_FLAGS)
2094 if ((arg->flags & DRM_MODE_PAGE_FLIP_ASYNC) &&
2095 !dev->mode_config.async_page_flip)
2098 /* can't test and expect an event at the same time. */
2099 if ((arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) &&
2100 (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
2103 drm_modeset_acquire_init(&ctx, 0);
2105 state = drm_atomic_state_alloc(dev);
2109 state->acquire_ctx = &ctx;
2110 state->allow_modeset = !!(arg->flags & DRM_MODE_ATOMIC_ALLOW_MODESET);
2117 for (i = 0; i < arg->count_objs; i++) {
2118 uint32_t obj_id, count_props;
2119 struct drm_mode_object *obj;
2121 if (get_user(obj_id, objs_ptr + copied_objs)) {
2126 obj = drm_mode_object_find(dev, obj_id, DRM_MODE_OBJECT_ANY);
2132 if (!obj->properties) {
2133 drm_mode_object_unreference(obj);
2138 if (get_user(count_props, count_props_ptr + copied_objs)) {
2139 drm_mode_object_unreference(obj);
2146 for (j = 0; j < count_props; j++) {
2148 uint64_t prop_value;
2149 struct drm_property *prop;
2151 if (get_user(prop_id, props_ptr + copied_props)) {
2152 drm_mode_object_unreference(obj);
2157 prop = drm_mode_obj_find_prop_id(obj, prop_id);
2159 drm_mode_object_unreference(obj);
2164 if (copy_from_user(&prop_value,
2165 prop_values_ptr + copied_props,
2166 sizeof(prop_value))) {
2167 drm_mode_object_unreference(obj);
2172 ret = atomic_set_prop(state, obj, prop, prop_value);
2174 drm_mode_object_unreference(obj);
2181 if (obj->type == DRM_MODE_OBJECT_PLANE && count_props &&
2182 !(arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)) {
2183 plane = obj_to_plane(obj);
2184 plane_mask |= (1 << drm_plane_index(plane));
2185 plane->old_fb = plane->fb;
2187 drm_mode_object_unreference(obj);
2190 ret = prepare_crtc_signaling(dev, state, arg, file_priv, &fence_state,
2195 if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) {
2196 ret = drm_atomic_check_only(state);
2197 } else if (arg->flags & DRM_MODE_ATOMIC_NONBLOCK) {
2198 ret = drm_atomic_nonblocking_commit(state);
2200 if (unlikely(drm_debug & DRM_UT_STATE))
2201 drm_atomic_print_state(state);
2203 ret = drm_atomic_commit(state);
2207 drm_atomic_clean_old_fb(dev, plane_mask, ret);
2209 complete_crtc_signaling(dev, state, fence_state, num_fences, !ret);
2211 if (ret == -EDEADLK) {
2212 drm_atomic_state_clear(state);
2213 drm_modeset_backoff(&ctx);
2217 drm_atomic_state_put(state);
2219 drm_modeset_drop_locks(&ctx);
2220 drm_modeset_acquire_fini(&ctx);