Input: xpad - add support for Xbox1 PDP Camo series gamepad
[linux/fpc-iii.git] / drivers / gpu / drm / drm_atomic.c
blobdd6fff1c98d6e92c5fe89cd099532a760a20ff0d
1 /*
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.
23 * Authors:
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
29 #include <drm/drmP.h>
30 #include <drm/drm_atomic.h>
31 #include <drm/drm_mode.h>
32 #include <drm/drm_plane_helper.h>
34 #include "drm_crtc_internal.h"
36 static void crtc_commit_free(struct kref *kref)
38 struct drm_crtc_commit *commit =
39 container_of(kref, struct drm_crtc_commit, ref);
41 kfree(commit);
44 void drm_crtc_commit_put(struct drm_crtc_commit *commit)
46 kref_put(&commit->ref, crtc_commit_free);
48 EXPORT_SYMBOL(drm_crtc_commit_put);
50 /**
51 * drm_atomic_state_default_release -
52 * release memory initialized by drm_atomic_state_init
53 * @state: atomic state
55 * Free all the memory allocated by drm_atomic_state_init.
56 * This is useful for drivers that subclass the atomic state.
58 void drm_atomic_state_default_release(struct drm_atomic_state *state)
60 kfree(state->connectors);
61 kfree(state->crtcs);
62 kfree(state->planes);
64 EXPORT_SYMBOL(drm_atomic_state_default_release);
66 /**
67 * drm_atomic_state_init - init new atomic state
68 * @dev: DRM device
69 * @state: atomic state
71 * Default implementation for filling in a new atomic state.
72 * This is useful for drivers that subclass the atomic state.
74 int
75 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)
77 /* TODO legacy paths should maybe do a better job about
78 * setting this appropriately?
80 state->allow_modeset = true;
82 state->crtcs = kcalloc(dev->mode_config.num_crtc,
83 sizeof(*state->crtcs), GFP_KERNEL);
84 if (!state->crtcs)
85 goto fail;
86 state->planes = kcalloc(dev->mode_config.num_total_plane,
87 sizeof(*state->planes), GFP_KERNEL);
88 if (!state->planes)
89 goto fail;
91 state->dev = dev;
93 DRM_DEBUG_ATOMIC("Allocated atomic state %p\n", state);
95 return 0;
96 fail:
97 drm_atomic_state_default_release(state);
98 return -ENOMEM;
100 EXPORT_SYMBOL(drm_atomic_state_init);
103 * drm_atomic_state_alloc - allocate atomic state
104 * @dev: DRM device
106 * This allocates an empty atomic state to track updates.
108 struct drm_atomic_state *
109 drm_atomic_state_alloc(struct drm_device *dev)
111 struct drm_mode_config *config = &dev->mode_config;
112 struct drm_atomic_state *state;
114 if (!config->funcs->atomic_state_alloc) {
115 state = kzalloc(sizeof(*state), GFP_KERNEL);
116 if (!state)
117 return NULL;
118 if (drm_atomic_state_init(dev, state) < 0) {
119 kfree(state);
120 return NULL;
122 return state;
125 return config->funcs->atomic_state_alloc(dev);
127 EXPORT_SYMBOL(drm_atomic_state_alloc);
130 * drm_atomic_state_default_clear - clear base atomic state
131 * @state: atomic state
133 * Default implementation for clearing atomic state.
134 * This is useful for drivers that subclass the atomic state.
136 void drm_atomic_state_default_clear(struct drm_atomic_state *state)
138 struct drm_device *dev = state->dev;
139 struct drm_mode_config *config = &dev->mode_config;
140 int i;
142 DRM_DEBUG_ATOMIC("Clearing atomic state %p\n", state);
144 for (i = 0; i < state->num_connector; i++) {
145 struct drm_connector *connector = state->connectors[i].ptr;
147 if (!connector)
148 continue;
150 connector->funcs->atomic_destroy_state(connector,
151 state->connectors[i].state);
152 state->connectors[i].ptr = NULL;
153 state->connectors[i].state = NULL;
154 drm_connector_unreference(connector);
157 for (i = 0; i < config->num_crtc; i++) {
158 struct drm_crtc *crtc = state->crtcs[i].ptr;
160 if (!crtc)
161 continue;
163 crtc->funcs->atomic_destroy_state(crtc,
164 state->crtcs[i].state);
166 if (state->crtcs[i].commit) {
167 kfree(state->crtcs[i].commit->event);
168 state->crtcs[i].commit->event = NULL;
169 drm_crtc_commit_put(state->crtcs[i].commit);
172 state->crtcs[i].commit = NULL;
173 state->crtcs[i].ptr = NULL;
174 state->crtcs[i].state = NULL;
177 for (i = 0; i < config->num_total_plane; i++) {
178 struct drm_plane *plane = state->planes[i].ptr;
180 if (!plane)
181 continue;
183 plane->funcs->atomic_destroy_state(plane,
184 state->planes[i].state);
185 state->planes[i].ptr = NULL;
186 state->planes[i].state = NULL;
189 EXPORT_SYMBOL(drm_atomic_state_default_clear);
192 * drm_atomic_state_clear - clear state object
193 * @state: atomic state
195 * When the w/w mutex algorithm detects a deadlock we need to back off and drop
196 * all locks. So someone else could sneak in and change the current modeset
197 * configuration. Which means that all the state assembled in @state is no
198 * longer an atomic update to the current state, but to some arbitrary earlier
199 * state. Which could break assumptions the driver's ->atomic_check likely
200 * relies on.
202 * Hence we must clear all cached state and completely start over, using this
203 * function.
205 void drm_atomic_state_clear(struct drm_atomic_state *state)
207 struct drm_device *dev = state->dev;
208 struct drm_mode_config *config = &dev->mode_config;
210 if (config->funcs->atomic_state_clear)
211 config->funcs->atomic_state_clear(state);
212 else
213 drm_atomic_state_default_clear(state);
215 EXPORT_SYMBOL(drm_atomic_state_clear);
218 * drm_atomic_state_free - free all memory for an atomic state
219 * @state: atomic state to deallocate
221 * This frees all memory associated with an atomic state, including all the
222 * per-object state for planes, crtcs and connectors.
224 void drm_atomic_state_free(struct drm_atomic_state *state)
226 struct drm_device *dev;
227 struct drm_mode_config *config;
229 if (!state)
230 return;
232 dev = state->dev;
233 config = &dev->mode_config;
235 drm_atomic_state_clear(state);
237 DRM_DEBUG_ATOMIC("Freeing atomic state %p\n", state);
239 if (config->funcs->atomic_state_free) {
240 config->funcs->atomic_state_free(state);
241 } else {
242 drm_atomic_state_default_release(state);
243 kfree(state);
246 EXPORT_SYMBOL(drm_atomic_state_free);
249 * drm_atomic_get_crtc_state - get crtc state
250 * @state: global atomic state object
251 * @crtc: crtc to get state object for
253 * This function returns the crtc state for the given crtc, allocating it if
254 * needed. It will also grab the relevant crtc lock to make sure that the state
255 * is consistent.
257 * Returns:
259 * Either the allocated state or the error code encoded into the pointer. When
260 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
261 * entire atomic sequence must be restarted. All other errors are fatal.
263 struct drm_crtc_state *
264 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
265 struct drm_crtc *crtc)
267 int ret, index = drm_crtc_index(crtc);
268 struct drm_crtc_state *crtc_state;
270 WARN_ON(!state->acquire_ctx);
272 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
273 if (crtc_state)
274 return crtc_state;
276 ret = drm_modeset_lock(&crtc->mutex, state->acquire_ctx);
277 if (ret)
278 return ERR_PTR(ret);
280 crtc_state = crtc->funcs->atomic_duplicate_state(crtc);
281 if (!crtc_state)
282 return ERR_PTR(-ENOMEM);
284 state->crtcs[index].state = crtc_state;
285 state->crtcs[index].ptr = crtc;
286 crtc_state->state = state;
288 DRM_DEBUG_ATOMIC("Added [CRTC:%d:%s] %p state to %p\n",
289 crtc->base.id, crtc->name, crtc_state, state);
291 return crtc_state;
293 EXPORT_SYMBOL(drm_atomic_get_crtc_state);
296 * drm_atomic_set_mode_for_crtc - set mode for CRTC
297 * @state: the CRTC whose incoming state to update
298 * @mode: kernel-internal mode to use for the CRTC, or NULL to disable
300 * Set a mode (originating from the kernel) on the desired CRTC state. Does
301 * not change any other state properties, including enable, active, or
302 * mode_changed.
304 * RETURNS:
305 * Zero on success, error code on failure. Cannot return -EDEADLK.
307 int drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
308 struct drm_display_mode *mode)
310 struct drm_mode_modeinfo umode;
312 /* Early return for no change. */
313 if (mode && memcmp(&state->mode, mode, sizeof(*mode)) == 0)
314 return 0;
316 drm_property_unreference_blob(state->mode_blob);
317 state->mode_blob = NULL;
319 if (mode) {
320 drm_mode_convert_to_umode(&umode, mode);
321 state->mode_blob =
322 drm_property_create_blob(state->crtc->dev,
323 sizeof(umode),
324 &umode);
325 if (IS_ERR(state->mode_blob))
326 return PTR_ERR(state->mode_blob);
328 drm_mode_copy(&state->mode, mode);
329 state->enable = true;
330 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
331 mode->name, state);
332 } else {
333 memset(&state->mode, 0, sizeof(state->mode));
334 state->enable = false;
335 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
336 state);
339 return 0;
341 EXPORT_SYMBOL(drm_atomic_set_mode_for_crtc);
344 * drm_atomic_set_mode_prop_for_crtc - set mode for CRTC
345 * @state: the CRTC whose incoming state to update
346 * @blob: pointer to blob property to use for mode
348 * Set a mode (originating from a blob property) on the desired CRTC state.
349 * This function will take a reference on the blob property for the CRTC state,
350 * and release the reference held on the state's existing mode property, if any
351 * was set.
353 * RETURNS:
354 * Zero on success, error code on failure. Cannot return -EDEADLK.
356 int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
357 struct drm_property_blob *blob)
359 if (blob == state->mode_blob)
360 return 0;
362 drm_property_unreference_blob(state->mode_blob);
363 state->mode_blob = NULL;
365 memset(&state->mode, 0, sizeof(state->mode));
367 if (blob) {
368 if (blob->length != sizeof(struct drm_mode_modeinfo) ||
369 drm_mode_convert_umode(&state->mode,
370 (const struct drm_mode_modeinfo *)
371 blob->data))
372 return -EINVAL;
374 state->mode_blob = drm_property_reference_blob(blob);
375 state->enable = true;
376 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
377 state->mode.name, state);
378 } else {
379 state->enable = false;
380 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
381 state);
384 return 0;
386 EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc);
389 * drm_atomic_replace_property_blob - replace a blob property
390 * @blob: a pointer to the member blob to be replaced
391 * @new_blob: the new blob to replace with
392 * @replaced: whether the blob has been replaced
394 * RETURNS:
395 * Zero on success, error code on failure
397 static void
398 drm_atomic_replace_property_blob(struct drm_property_blob **blob,
399 struct drm_property_blob *new_blob,
400 bool *replaced)
402 struct drm_property_blob *old_blob = *blob;
404 if (old_blob == new_blob)
405 return;
407 drm_property_unreference_blob(old_blob);
408 if (new_blob)
409 drm_property_reference_blob(new_blob);
410 *blob = new_blob;
411 *replaced = true;
413 return;
416 static int
417 drm_atomic_replace_property_blob_from_id(struct drm_crtc *crtc,
418 struct drm_property_blob **blob,
419 uint64_t blob_id,
420 ssize_t expected_size,
421 bool *replaced)
423 struct drm_property_blob *new_blob = NULL;
425 if (blob_id != 0) {
426 new_blob = drm_property_lookup_blob(crtc->dev, blob_id);
427 if (new_blob == NULL)
428 return -EINVAL;
430 if (expected_size > 0 && expected_size != new_blob->length) {
431 drm_property_unreference_blob(new_blob);
432 return -EINVAL;
436 drm_atomic_replace_property_blob(blob, new_blob, replaced);
437 drm_property_unreference_blob(new_blob);
439 return 0;
443 * drm_atomic_crtc_set_property - set property on CRTC
444 * @crtc: the drm CRTC to set a property on
445 * @state: the state object to update with the new property value
446 * @property: the property to set
447 * @val: the new property value
449 * Use this instead of calling crtc->atomic_set_property directly.
450 * This function handles generic/core properties and calls out to
451 * driver's ->atomic_set_property() for driver properties. To ensure
452 * consistent behavior you must call this function rather than the
453 * driver hook directly.
455 * RETURNS:
456 * Zero on success, error code on failure
458 int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
459 struct drm_crtc_state *state, struct drm_property *property,
460 uint64_t val)
462 struct drm_device *dev = crtc->dev;
463 struct drm_mode_config *config = &dev->mode_config;
464 bool replaced = false;
465 int ret;
467 if (property == config->prop_active)
468 state->active = val;
469 else if (property == config->prop_mode_id) {
470 struct drm_property_blob *mode =
471 drm_property_lookup_blob(dev, val);
472 ret = drm_atomic_set_mode_prop_for_crtc(state, mode);
473 drm_property_unreference_blob(mode);
474 return ret;
475 } else if (property == config->degamma_lut_property) {
476 ret = drm_atomic_replace_property_blob_from_id(crtc,
477 &state->degamma_lut,
478 val,
480 &replaced);
481 state->color_mgmt_changed |= replaced;
482 return ret;
483 } else if (property == config->ctm_property) {
484 ret = drm_atomic_replace_property_blob_from_id(crtc,
485 &state->ctm,
486 val,
487 sizeof(struct drm_color_ctm),
488 &replaced);
489 state->color_mgmt_changed |= replaced;
490 return ret;
491 } else if (property == config->gamma_lut_property) {
492 ret = drm_atomic_replace_property_blob_from_id(crtc,
493 &state->gamma_lut,
494 val,
496 &replaced);
497 state->color_mgmt_changed |= replaced;
498 return ret;
499 } else if (crtc->funcs->atomic_set_property)
500 return crtc->funcs->atomic_set_property(crtc, state, property, val);
501 else
502 return -EINVAL;
504 return 0;
506 EXPORT_SYMBOL(drm_atomic_crtc_set_property);
509 * drm_atomic_crtc_get_property - get property value from CRTC state
510 * @crtc: the drm CRTC to set a property on
511 * @state: the state object to get the property value from
512 * @property: the property to set
513 * @val: return location for the property value
515 * This function handles generic/core properties and calls out to
516 * driver's ->atomic_get_property() for driver properties. To ensure
517 * consistent behavior you must call this function rather than the
518 * driver hook directly.
520 * RETURNS:
521 * Zero on success, error code on failure
523 static int
524 drm_atomic_crtc_get_property(struct drm_crtc *crtc,
525 const struct drm_crtc_state *state,
526 struct drm_property *property, uint64_t *val)
528 struct drm_device *dev = crtc->dev;
529 struct drm_mode_config *config = &dev->mode_config;
531 if (property == config->prop_active)
532 *val = state->active;
533 else if (property == config->prop_mode_id)
534 *val = (state->mode_blob) ? state->mode_blob->base.id : 0;
535 else if (property == config->degamma_lut_property)
536 *val = (state->degamma_lut) ? state->degamma_lut->base.id : 0;
537 else if (property == config->ctm_property)
538 *val = (state->ctm) ? state->ctm->base.id : 0;
539 else if (property == config->gamma_lut_property)
540 *val = (state->gamma_lut) ? state->gamma_lut->base.id : 0;
541 else if (crtc->funcs->atomic_get_property)
542 return crtc->funcs->atomic_get_property(crtc, state, property, val);
543 else
544 return -EINVAL;
546 return 0;
550 * drm_atomic_crtc_check - check crtc state
551 * @crtc: crtc to check
552 * @state: crtc state to check
554 * Provides core sanity checks for crtc state.
556 * RETURNS:
557 * Zero on success, error code on failure
559 static int drm_atomic_crtc_check(struct drm_crtc *crtc,
560 struct drm_crtc_state *state)
562 /* NOTE: we explicitly don't enforce constraints such as primary
563 * layer covering entire screen, since that is something we want
564 * to allow (on hw that supports it). For hw that does not, it
565 * should be checked in driver's crtc->atomic_check() vfunc.
567 * TODO: Add generic modeset state checks once we support those.
570 if (state->active && !state->enable) {
571 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active without enabled\n",
572 crtc->base.id, crtc->name);
573 return -EINVAL;
576 /* The state->enable vs. state->mode_blob checks can be WARN_ON,
577 * as this is a kernel-internal detail that userspace should never
578 * be able to trigger. */
579 if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
580 WARN_ON(state->enable && !state->mode_blob)) {
581 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled without mode blob\n",
582 crtc->base.id, crtc->name);
583 return -EINVAL;
586 if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
587 WARN_ON(!state->enable && state->mode_blob)) {
588 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled with mode blob\n",
589 crtc->base.id, crtc->name);
590 return -EINVAL;
594 * Reject event generation for when a CRTC is off and stays off.
595 * It wouldn't be hard to implement this, but userspace has a track
596 * record of happily burning through 100% cpu (or worse, crash) when the
597 * display pipe is suspended. To avoid all that fun just reject updates
598 * that ask for events since likely that indicates a bug in the
599 * compositor's drawing loop. This is consistent with the vblank IOCTL
600 * and legacy page_flip IOCTL which also reject service on a disabled
601 * pipe.
603 if (state->event && !state->active && !crtc->state->active) {
604 DRM_DEBUG_ATOMIC("[CRTC:%d] requesting event but off\n",
605 crtc->base.id);
606 return -EINVAL;
609 return 0;
613 * drm_atomic_get_plane_state - get plane state
614 * @state: global atomic state object
615 * @plane: plane to get state object for
617 * This function returns the plane state for the given plane, allocating it if
618 * needed. It will also grab the relevant plane lock to make sure that the state
619 * is consistent.
621 * Returns:
623 * Either the allocated state or the error code encoded into the pointer. When
624 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
625 * entire atomic sequence must be restarted. All other errors are fatal.
627 struct drm_plane_state *
628 drm_atomic_get_plane_state(struct drm_atomic_state *state,
629 struct drm_plane *plane)
631 int ret, index = drm_plane_index(plane);
632 struct drm_plane_state *plane_state;
634 WARN_ON(!state->acquire_ctx);
636 plane_state = drm_atomic_get_existing_plane_state(state, plane);
637 if (plane_state)
638 return plane_state;
640 ret = drm_modeset_lock(&plane->mutex, state->acquire_ctx);
641 if (ret)
642 return ERR_PTR(ret);
644 plane_state = plane->funcs->atomic_duplicate_state(plane);
645 if (!plane_state)
646 return ERR_PTR(-ENOMEM);
648 state->planes[index].state = plane_state;
649 state->planes[index].ptr = plane;
650 plane_state->state = state;
652 DRM_DEBUG_ATOMIC("Added [PLANE:%d:%s] %p state to %p\n",
653 plane->base.id, plane->name, plane_state, state);
655 if (plane_state->crtc) {
656 struct drm_crtc_state *crtc_state;
658 crtc_state = drm_atomic_get_crtc_state(state,
659 plane_state->crtc);
660 if (IS_ERR(crtc_state))
661 return ERR_CAST(crtc_state);
664 return plane_state;
666 EXPORT_SYMBOL(drm_atomic_get_plane_state);
669 * drm_atomic_plane_set_property - set property on plane
670 * @plane: the drm plane to set a property on
671 * @state: the state object to update with the new property value
672 * @property: the property to set
673 * @val: the new property value
675 * Use this instead of calling plane->atomic_set_property directly.
676 * This function handles generic/core properties and calls out to
677 * driver's ->atomic_set_property() for driver properties. To ensure
678 * consistent behavior you must call this function rather than the
679 * driver hook directly.
681 * RETURNS:
682 * Zero on success, error code on failure
684 int drm_atomic_plane_set_property(struct drm_plane *plane,
685 struct drm_plane_state *state, struct drm_property *property,
686 uint64_t val)
688 struct drm_device *dev = plane->dev;
689 struct drm_mode_config *config = &dev->mode_config;
691 if (property == config->prop_fb_id) {
692 struct drm_framebuffer *fb = drm_framebuffer_lookup(dev, val);
693 drm_atomic_set_fb_for_plane(state, fb);
694 if (fb)
695 drm_framebuffer_unreference(fb);
696 } else if (property == config->prop_crtc_id) {
697 struct drm_crtc *crtc = drm_crtc_find(dev, val);
698 return drm_atomic_set_crtc_for_plane(state, crtc);
699 } else if (property == config->prop_crtc_x) {
700 state->crtc_x = U642I64(val);
701 } else if (property == config->prop_crtc_y) {
702 state->crtc_y = U642I64(val);
703 } else if (property == config->prop_crtc_w) {
704 state->crtc_w = val;
705 } else if (property == config->prop_crtc_h) {
706 state->crtc_h = val;
707 } else if (property == config->prop_src_x) {
708 state->src_x = val;
709 } else if (property == config->prop_src_y) {
710 state->src_y = val;
711 } else if (property == config->prop_src_w) {
712 state->src_w = val;
713 } else if (property == config->prop_src_h) {
714 state->src_h = val;
715 } else if (property == config->rotation_property) {
716 state->rotation = val;
717 } else if (property == plane->zpos_property) {
718 state->zpos = val;
719 } else if (plane->funcs->atomic_set_property) {
720 return plane->funcs->atomic_set_property(plane, state,
721 property, val);
722 } else {
723 return -EINVAL;
726 return 0;
728 EXPORT_SYMBOL(drm_atomic_plane_set_property);
731 * drm_atomic_plane_get_property - get property value from plane state
732 * @plane: the drm plane to set a property on
733 * @state: the state object to get the property value from
734 * @property: the property to set
735 * @val: return location for the property value
737 * This function handles generic/core properties and calls out to
738 * driver's ->atomic_get_property() for driver properties. To ensure
739 * consistent behavior you must call this function rather than the
740 * driver hook directly.
742 * RETURNS:
743 * Zero on success, error code on failure
745 static int
746 drm_atomic_plane_get_property(struct drm_plane *plane,
747 const struct drm_plane_state *state,
748 struct drm_property *property, uint64_t *val)
750 struct drm_device *dev = plane->dev;
751 struct drm_mode_config *config = &dev->mode_config;
753 if (property == config->prop_fb_id) {
754 *val = (state->fb) ? state->fb->base.id : 0;
755 } else if (property == config->prop_crtc_id) {
756 *val = (state->crtc) ? state->crtc->base.id : 0;
757 } else if (property == config->prop_crtc_x) {
758 *val = I642U64(state->crtc_x);
759 } else if (property == config->prop_crtc_y) {
760 *val = I642U64(state->crtc_y);
761 } else if (property == config->prop_crtc_w) {
762 *val = state->crtc_w;
763 } else if (property == config->prop_crtc_h) {
764 *val = state->crtc_h;
765 } else if (property == config->prop_src_x) {
766 *val = state->src_x;
767 } else if (property == config->prop_src_y) {
768 *val = state->src_y;
769 } else if (property == config->prop_src_w) {
770 *val = state->src_w;
771 } else if (property == config->prop_src_h) {
772 *val = state->src_h;
773 } else if (property == config->rotation_property) {
774 *val = state->rotation;
775 } else if (property == plane->zpos_property) {
776 *val = state->zpos;
777 } else if (plane->funcs->atomic_get_property) {
778 return plane->funcs->atomic_get_property(plane, state, property, val);
779 } else {
780 return -EINVAL;
783 return 0;
786 static bool
787 plane_switching_crtc(struct drm_atomic_state *state,
788 struct drm_plane *plane,
789 struct drm_plane_state *plane_state)
791 if (!plane->state->crtc || !plane_state->crtc)
792 return false;
794 if (plane->state->crtc == plane_state->crtc)
795 return false;
797 /* This could be refined, but currently there's no helper or driver code
798 * to implement direct switching of active planes nor userspace to take
799 * advantage of more direct plane switching without the intermediate
800 * full OFF state.
802 return true;
806 * drm_atomic_plane_check - check plane state
807 * @plane: plane to check
808 * @state: plane state to check
810 * Provides core sanity checks for plane state.
812 * RETURNS:
813 * Zero on success, error code on failure
815 static int drm_atomic_plane_check(struct drm_plane *plane,
816 struct drm_plane_state *state)
818 unsigned int fb_width, fb_height;
819 int ret;
821 /* either *both* CRTC and FB must be set, or neither */
822 if (WARN_ON(state->crtc && !state->fb)) {
823 DRM_DEBUG_ATOMIC("CRTC set but no FB\n");
824 return -EINVAL;
825 } else if (WARN_ON(state->fb && !state->crtc)) {
826 DRM_DEBUG_ATOMIC("FB set but no CRTC\n");
827 return -EINVAL;
830 /* if disabled, we don't care about the rest of the state: */
831 if (!state->crtc)
832 return 0;
834 /* Check whether this plane is usable on this CRTC */
835 if (!(plane->possible_crtcs & drm_crtc_mask(state->crtc))) {
836 DRM_DEBUG_ATOMIC("Invalid crtc for plane\n");
837 return -EINVAL;
840 /* Check whether this plane supports the fb pixel format. */
841 ret = drm_plane_check_pixel_format(plane, state->fb->pixel_format);
842 if (ret) {
843 char *format_name = drm_get_format_name(state->fb->pixel_format);
844 DRM_DEBUG_ATOMIC("Invalid pixel format %s\n", format_name);
845 kfree(format_name);
846 return ret;
849 /* Give drivers some help against integer overflows */
850 if (state->crtc_w > INT_MAX ||
851 state->crtc_x > INT_MAX - (int32_t) state->crtc_w ||
852 state->crtc_h > INT_MAX ||
853 state->crtc_y > INT_MAX - (int32_t) state->crtc_h) {
854 DRM_DEBUG_ATOMIC("Invalid CRTC coordinates %ux%u+%d+%d\n",
855 state->crtc_w, state->crtc_h,
856 state->crtc_x, state->crtc_y);
857 return -ERANGE;
860 fb_width = state->fb->width << 16;
861 fb_height = state->fb->height << 16;
863 /* Make sure source coordinates are inside the fb. */
864 if (state->src_w > fb_width ||
865 state->src_x > fb_width - state->src_w ||
866 state->src_h > fb_height ||
867 state->src_y > fb_height - state->src_h) {
868 DRM_DEBUG_ATOMIC("Invalid source coordinates "
869 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
870 state->src_w >> 16, ((state->src_w & 0xffff) * 15625) >> 10,
871 state->src_h >> 16, ((state->src_h & 0xffff) * 15625) >> 10,
872 state->src_x >> 16, ((state->src_x & 0xffff) * 15625) >> 10,
873 state->src_y >> 16, ((state->src_y & 0xffff) * 15625) >> 10);
874 return -ENOSPC;
877 if (plane_switching_crtc(state->state, plane, state)) {
878 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] switching CRTC directly\n",
879 plane->base.id, plane->name);
880 return -EINVAL;
883 return 0;
887 * drm_atomic_get_connector_state - get connector state
888 * @state: global atomic state object
889 * @connector: connector to get state object for
891 * This function returns the connector state for the given connector,
892 * allocating it if needed. It will also grab the relevant connector lock to
893 * make sure that the state is consistent.
895 * Returns:
897 * Either the allocated state or the error code encoded into the pointer. When
898 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
899 * entire atomic sequence must be restarted. All other errors are fatal.
901 struct drm_connector_state *
902 drm_atomic_get_connector_state(struct drm_atomic_state *state,
903 struct drm_connector *connector)
905 int ret, index;
906 struct drm_mode_config *config = &connector->dev->mode_config;
907 struct drm_connector_state *connector_state;
909 WARN_ON(!state->acquire_ctx);
911 ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
912 if (ret)
913 return ERR_PTR(ret);
915 index = drm_connector_index(connector);
917 if (index >= state->num_connector) {
918 struct __drm_connnectors_state *c;
919 int alloc = max(index + 1, config->num_connector);
921 c = krealloc(state->connectors, alloc * sizeof(*state->connectors), GFP_KERNEL);
922 if (!c)
923 return ERR_PTR(-ENOMEM);
925 state->connectors = c;
926 memset(&state->connectors[state->num_connector], 0,
927 sizeof(*state->connectors) * (alloc - state->num_connector));
929 state->num_connector = alloc;
932 if (state->connectors[index].state)
933 return state->connectors[index].state;
935 connector_state = connector->funcs->atomic_duplicate_state(connector);
936 if (!connector_state)
937 return ERR_PTR(-ENOMEM);
939 drm_connector_reference(connector);
940 state->connectors[index].state = connector_state;
941 state->connectors[index].ptr = connector;
942 connector_state->state = state;
944 DRM_DEBUG_ATOMIC("Added [CONNECTOR:%d] %p state to %p\n",
945 connector->base.id, connector_state, state);
947 if (connector_state->crtc) {
948 struct drm_crtc_state *crtc_state;
950 crtc_state = drm_atomic_get_crtc_state(state,
951 connector_state->crtc);
952 if (IS_ERR(crtc_state))
953 return ERR_CAST(crtc_state);
956 return connector_state;
958 EXPORT_SYMBOL(drm_atomic_get_connector_state);
961 * drm_atomic_connector_set_property - set property on connector.
962 * @connector: the drm connector to set a property on
963 * @state: the state object to update with the new property value
964 * @property: the property to set
965 * @val: the new property value
967 * Use this instead of calling connector->atomic_set_property directly.
968 * This function handles generic/core properties and calls out to
969 * driver's ->atomic_set_property() for driver properties. To ensure
970 * consistent behavior you must call this function rather than the
971 * driver hook directly.
973 * RETURNS:
974 * Zero on success, error code on failure
976 int drm_atomic_connector_set_property(struct drm_connector *connector,
977 struct drm_connector_state *state, struct drm_property *property,
978 uint64_t val)
980 struct drm_device *dev = connector->dev;
981 struct drm_mode_config *config = &dev->mode_config;
983 if (property == config->prop_crtc_id) {
984 struct drm_crtc *crtc = drm_crtc_find(dev, val);
985 return drm_atomic_set_crtc_for_connector(state, crtc);
986 } else if (property == config->dpms_property) {
987 /* setting DPMS property requires special handling, which
988 * is done in legacy setprop path for us. Disallow (for
989 * now?) atomic writes to DPMS property:
991 return -EINVAL;
992 } else if (connector->funcs->atomic_set_property) {
993 return connector->funcs->atomic_set_property(connector,
994 state, property, val);
995 } else {
996 return -EINVAL;
999 EXPORT_SYMBOL(drm_atomic_connector_set_property);
1002 * drm_atomic_connector_get_property - get property value from connector state
1003 * @connector: the drm connector to set a property on
1004 * @state: the state object to get the property value from
1005 * @property: the property to set
1006 * @val: return location for the property value
1008 * This function handles generic/core properties and calls out to
1009 * driver's ->atomic_get_property() for driver properties. To ensure
1010 * consistent behavior you must call this function rather than the
1011 * driver hook directly.
1013 * RETURNS:
1014 * Zero on success, error code on failure
1016 static int
1017 drm_atomic_connector_get_property(struct drm_connector *connector,
1018 const struct drm_connector_state *state,
1019 struct drm_property *property, uint64_t *val)
1021 struct drm_device *dev = connector->dev;
1022 struct drm_mode_config *config = &dev->mode_config;
1024 if (property == config->prop_crtc_id) {
1025 *val = (state->crtc) ? state->crtc->base.id : 0;
1026 } else if (property == config->dpms_property) {
1027 *val = connector->dpms;
1028 } else if (connector->funcs->atomic_get_property) {
1029 return connector->funcs->atomic_get_property(connector,
1030 state, property, val);
1031 } else {
1032 return -EINVAL;
1035 return 0;
1038 int drm_atomic_get_property(struct drm_mode_object *obj,
1039 struct drm_property *property, uint64_t *val)
1041 struct drm_device *dev = property->dev;
1042 int ret;
1044 switch (obj->type) {
1045 case DRM_MODE_OBJECT_CONNECTOR: {
1046 struct drm_connector *connector = obj_to_connector(obj);
1047 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
1048 ret = drm_atomic_connector_get_property(connector,
1049 connector->state, property, val);
1050 break;
1052 case DRM_MODE_OBJECT_CRTC: {
1053 struct drm_crtc *crtc = obj_to_crtc(obj);
1054 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
1055 ret = drm_atomic_crtc_get_property(crtc,
1056 crtc->state, property, val);
1057 break;
1059 case DRM_MODE_OBJECT_PLANE: {
1060 struct drm_plane *plane = obj_to_plane(obj);
1061 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
1062 ret = drm_atomic_plane_get_property(plane,
1063 plane->state, property, val);
1064 break;
1066 default:
1067 ret = -EINVAL;
1068 break;
1071 return ret;
1075 * drm_atomic_set_crtc_for_plane - set crtc for plane
1076 * @plane_state: the plane whose incoming state to update
1077 * @crtc: crtc to use for the plane
1079 * Changing the assigned crtc for a plane requires us to grab the lock and state
1080 * for the new crtc, as needed. This function takes care of all these details
1081 * besides updating the pointer in the state object itself.
1083 * Returns:
1084 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1085 * then the w/w mutex code has detected a deadlock and the entire atomic
1086 * sequence must be restarted. All other errors are fatal.
1089 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
1090 struct drm_crtc *crtc)
1092 struct drm_plane *plane = plane_state->plane;
1093 struct drm_crtc_state *crtc_state;
1094 /* Nothing to do for same crtc*/
1095 if (plane_state->crtc == crtc)
1096 return 0;
1097 if (plane_state->crtc) {
1098 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1099 plane_state->crtc);
1100 if (WARN_ON(IS_ERR(crtc_state)))
1101 return PTR_ERR(crtc_state);
1103 crtc_state->plane_mask &= ~(1 << drm_plane_index(plane));
1106 plane_state->crtc = crtc;
1108 if (crtc) {
1109 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1110 crtc);
1111 if (IS_ERR(crtc_state))
1112 return PTR_ERR(crtc_state);
1113 crtc_state->plane_mask |= (1 << drm_plane_index(plane));
1116 if (crtc)
1117 DRM_DEBUG_ATOMIC("Link plane state %p to [CRTC:%d:%s]\n",
1118 plane_state, crtc->base.id, crtc->name);
1119 else
1120 DRM_DEBUG_ATOMIC("Link plane state %p to [NOCRTC]\n",
1121 plane_state);
1123 return 0;
1125 EXPORT_SYMBOL(drm_atomic_set_crtc_for_plane);
1128 * drm_atomic_set_fb_for_plane - set framebuffer for plane
1129 * @plane_state: atomic state object for the plane
1130 * @fb: fb to use for the plane
1132 * Changing the assigned framebuffer for a plane requires us to grab a reference
1133 * to the new fb and drop the reference to the old fb, if there is one. This
1134 * function takes care of all these details besides updating the pointer in the
1135 * state object itself.
1137 void
1138 drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
1139 struct drm_framebuffer *fb)
1141 if (plane_state->fb)
1142 drm_framebuffer_unreference(plane_state->fb);
1143 if (fb)
1144 drm_framebuffer_reference(fb);
1145 plane_state->fb = fb;
1147 if (fb)
1148 DRM_DEBUG_ATOMIC("Set [FB:%d] for plane state %p\n",
1149 fb->base.id, plane_state);
1150 else
1151 DRM_DEBUG_ATOMIC("Set [NOFB] for plane state %p\n",
1152 plane_state);
1154 EXPORT_SYMBOL(drm_atomic_set_fb_for_plane);
1157 * drm_atomic_set_crtc_for_connector - set crtc for connector
1158 * @conn_state: atomic state object for the connector
1159 * @crtc: crtc to use for the connector
1161 * Changing the assigned crtc for a connector requires us to grab the lock and
1162 * state for the new crtc, as needed. This function takes care of all these
1163 * details besides updating the pointer in the state object itself.
1165 * Returns:
1166 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1167 * then the w/w mutex code has detected a deadlock and the entire atomic
1168 * sequence must be restarted. All other errors are fatal.
1171 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
1172 struct drm_crtc *crtc)
1174 struct drm_crtc_state *crtc_state;
1176 if (conn_state->crtc == crtc)
1177 return 0;
1179 if (conn_state->crtc) {
1180 crtc_state = drm_atomic_get_existing_crtc_state(conn_state->state,
1181 conn_state->crtc);
1183 crtc_state->connector_mask &=
1184 ~(1 << drm_connector_index(conn_state->connector));
1186 drm_connector_unreference(conn_state->connector);
1187 conn_state->crtc = NULL;
1190 if (crtc) {
1191 crtc_state = drm_atomic_get_crtc_state(conn_state->state, crtc);
1192 if (IS_ERR(crtc_state))
1193 return PTR_ERR(crtc_state);
1195 crtc_state->connector_mask |=
1196 1 << drm_connector_index(conn_state->connector);
1198 drm_connector_reference(conn_state->connector);
1199 conn_state->crtc = crtc;
1201 DRM_DEBUG_ATOMIC("Link connector state %p to [CRTC:%d:%s]\n",
1202 conn_state, crtc->base.id, crtc->name);
1203 } else {
1204 DRM_DEBUG_ATOMIC("Link connector state %p to [NOCRTC]\n",
1205 conn_state);
1208 return 0;
1210 EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
1213 * drm_atomic_add_affected_connectors - add connectors for crtc
1214 * @state: atomic state
1215 * @crtc: DRM crtc
1217 * This function walks the current configuration and adds all connectors
1218 * currently using @crtc to the atomic configuration @state. Note that this
1219 * function must acquire the connection mutex. This can potentially cause
1220 * unneeded seralization if the update is just for the planes on one crtc. Hence
1221 * drivers and helpers should only call this when really needed (e.g. when a
1222 * full modeset needs to happen due to some change).
1224 * Returns:
1225 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1226 * then the w/w mutex code has detected a deadlock and the entire atomic
1227 * sequence must be restarted. All other errors are fatal.
1230 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
1231 struct drm_crtc *crtc)
1233 struct drm_mode_config *config = &state->dev->mode_config;
1234 struct drm_connector *connector;
1235 struct drm_connector_state *conn_state;
1236 int ret;
1238 ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1239 if (ret)
1240 return ret;
1242 DRM_DEBUG_ATOMIC("Adding all current connectors for [CRTC:%d:%s] to %p\n",
1243 crtc->base.id, crtc->name, state);
1246 * Changed connectors are already in @state, so only need to look at the
1247 * current configuration.
1249 drm_for_each_connector(connector, state->dev) {
1250 if (connector->state->crtc != crtc)
1251 continue;
1253 conn_state = drm_atomic_get_connector_state(state, connector);
1254 if (IS_ERR(conn_state))
1255 return PTR_ERR(conn_state);
1258 return 0;
1260 EXPORT_SYMBOL(drm_atomic_add_affected_connectors);
1263 * drm_atomic_add_affected_planes - add planes for crtc
1264 * @state: atomic state
1265 * @crtc: DRM crtc
1267 * This function walks the current configuration and adds all planes
1268 * currently used by @crtc to the atomic configuration @state. This is useful
1269 * when an atomic commit also needs to check all currently enabled plane on
1270 * @crtc, e.g. when changing the mode. It's also useful when re-enabling a CRTC
1271 * to avoid special code to force-enable all planes.
1273 * Since acquiring a plane state will always also acquire the w/w mutex of the
1274 * current CRTC for that plane (if there is any) adding all the plane states for
1275 * a CRTC will not reduce parallism of atomic updates.
1277 * Returns:
1278 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1279 * then the w/w mutex code has detected a deadlock and the entire atomic
1280 * sequence must be restarted. All other errors are fatal.
1283 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
1284 struct drm_crtc *crtc)
1286 struct drm_plane *plane;
1288 WARN_ON(!drm_atomic_get_existing_crtc_state(state, crtc));
1290 drm_for_each_plane_mask(plane, state->dev, crtc->state->plane_mask) {
1291 struct drm_plane_state *plane_state =
1292 drm_atomic_get_plane_state(state, plane);
1294 if (IS_ERR(plane_state))
1295 return PTR_ERR(plane_state);
1297 return 0;
1299 EXPORT_SYMBOL(drm_atomic_add_affected_planes);
1302 * drm_atomic_legacy_backoff - locking backoff for legacy ioctls
1303 * @state: atomic state
1305 * This function should be used by legacy entry points which don't understand
1306 * -EDEADLK semantics. For simplicity this one will grab all modeset locks after
1307 * the slowpath completed.
1309 void drm_atomic_legacy_backoff(struct drm_atomic_state *state)
1311 struct drm_device *dev = state->dev;
1312 unsigned crtc_mask = 0;
1313 struct drm_crtc *crtc;
1314 int ret;
1315 bool global = false;
1317 drm_for_each_crtc(crtc, dev) {
1318 if (crtc->acquire_ctx != state->acquire_ctx)
1319 continue;
1321 crtc_mask |= drm_crtc_mask(crtc);
1322 crtc->acquire_ctx = NULL;
1325 if (WARN_ON(dev->mode_config.acquire_ctx == state->acquire_ctx)) {
1326 global = true;
1328 dev->mode_config.acquire_ctx = NULL;
1331 retry:
1332 drm_modeset_backoff(state->acquire_ctx);
1334 ret = drm_modeset_lock_all_ctx(dev, state->acquire_ctx);
1335 if (ret)
1336 goto retry;
1338 drm_for_each_crtc(crtc, dev)
1339 if (drm_crtc_mask(crtc) & crtc_mask)
1340 crtc->acquire_ctx = state->acquire_ctx;
1342 if (global)
1343 dev->mode_config.acquire_ctx = state->acquire_ctx;
1345 EXPORT_SYMBOL(drm_atomic_legacy_backoff);
1348 * drm_atomic_check_only - check whether a given config would work
1349 * @state: atomic configuration to check
1351 * Note that this function can return -EDEADLK if the driver needed to acquire
1352 * more locks but encountered a deadlock. The caller must then do the usual w/w
1353 * backoff dance and restart. All other errors are fatal.
1355 * Returns:
1356 * 0 on success, negative error code on failure.
1358 int drm_atomic_check_only(struct drm_atomic_state *state)
1360 struct drm_device *dev = state->dev;
1361 struct drm_mode_config *config = &dev->mode_config;
1362 struct drm_plane *plane;
1363 struct drm_plane_state *plane_state;
1364 struct drm_crtc *crtc;
1365 struct drm_crtc_state *crtc_state;
1366 int i, ret = 0;
1368 DRM_DEBUG_ATOMIC("checking %p\n", state);
1370 for_each_plane_in_state(state, plane, plane_state, i) {
1371 ret = drm_atomic_plane_check(plane, plane_state);
1372 if (ret) {
1373 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic core check failed\n",
1374 plane->base.id, plane->name);
1375 return ret;
1379 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1380 ret = drm_atomic_crtc_check(crtc, crtc_state);
1381 if (ret) {
1382 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic core check failed\n",
1383 crtc->base.id, crtc->name);
1384 return ret;
1388 if (config->funcs->atomic_check)
1389 ret = config->funcs->atomic_check(state->dev, state);
1391 if (ret)
1392 return ret;
1394 if (!state->allow_modeset) {
1395 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1396 if (drm_atomic_crtc_needs_modeset(crtc_state)) {
1397 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] requires full modeset\n",
1398 crtc->base.id, crtc->name);
1399 return -EINVAL;
1404 return 0;
1406 EXPORT_SYMBOL(drm_atomic_check_only);
1409 * drm_atomic_commit - commit configuration atomically
1410 * @state: atomic configuration to check
1412 * Note that this function can return -EDEADLK if the driver needed to acquire
1413 * more locks but encountered a deadlock. The caller must then do the usual w/w
1414 * backoff dance and restart. All other errors are fatal.
1416 * Also note that on successful execution ownership of @state is transferred
1417 * from the caller of this function to the function itself. The caller must not
1418 * free or in any other way access @state. If the function fails then the caller
1419 * must clean up @state itself.
1421 * Returns:
1422 * 0 on success, negative error code on failure.
1424 int drm_atomic_commit(struct drm_atomic_state *state)
1426 struct drm_mode_config *config = &state->dev->mode_config;
1427 int ret;
1429 ret = drm_atomic_check_only(state);
1430 if (ret)
1431 return ret;
1433 DRM_DEBUG_ATOMIC("commiting %p\n", state);
1435 return config->funcs->atomic_commit(state->dev, state, false);
1437 EXPORT_SYMBOL(drm_atomic_commit);
1440 * drm_atomic_nonblocking_commit - atomic&nonblocking configuration commit
1441 * @state: atomic configuration to check
1443 * Note that this function can return -EDEADLK if the driver needed to acquire
1444 * more locks but encountered a deadlock. The caller must then do the usual w/w
1445 * backoff dance and restart. All other errors are fatal.
1447 * Also note that on successful execution ownership of @state is transferred
1448 * from the caller of this function to the function itself. The caller must not
1449 * free or in any other way access @state. If the function fails then the caller
1450 * must clean up @state itself.
1452 * Returns:
1453 * 0 on success, negative error code on failure.
1455 int drm_atomic_nonblocking_commit(struct drm_atomic_state *state)
1457 struct drm_mode_config *config = &state->dev->mode_config;
1458 int ret;
1460 ret = drm_atomic_check_only(state);
1461 if (ret)
1462 return ret;
1464 DRM_DEBUG_ATOMIC("commiting %p nonblocking\n", state);
1466 return config->funcs->atomic_commit(state->dev, state, true);
1468 EXPORT_SYMBOL(drm_atomic_nonblocking_commit);
1471 * The big monstor ioctl
1474 static struct drm_pending_vblank_event *create_vblank_event(
1475 struct drm_device *dev, struct drm_file *file_priv,
1476 struct fence *fence, uint64_t user_data)
1478 struct drm_pending_vblank_event *e = NULL;
1479 int ret;
1481 e = kzalloc(sizeof *e, GFP_KERNEL);
1482 if (!e)
1483 return NULL;
1485 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1486 e->event.base.length = sizeof(e->event);
1487 e->event.user_data = user_data;
1489 if (file_priv) {
1490 ret = drm_event_reserve_init(dev, file_priv, &e->base,
1491 &e->event.base);
1492 if (ret) {
1493 kfree(e);
1494 return NULL;
1498 e->base.fence = fence;
1500 return e;
1503 static int atomic_set_prop(struct drm_atomic_state *state,
1504 struct drm_mode_object *obj, struct drm_property *prop,
1505 uint64_t prop_value)
1507 struct drm_mode_object *ref;
1508 int ret;
1510 if (!drm_property_change_valid_get(prop, prop_value, &ref))
1511 return -EINVAL;
1513 switch (obj->type) {
1514 case DRM_MODE_OBJECT_CONNECTOR: {
1515 struct drm_connector *connector = obj_to_connector(obj);
1516 struct drm_connector_state *connector_state;
1518 connector_state = drm_atomic_get_connector_state(state, connector);
1519 if (IS_ERR(connector_state)) {
1520 ret = PTR_ERR(connector_state);
1521 break;
1524 ret = drm_atomic_connector_set_property(connector,
1525 connector_state, prop, prop_value);
1526 break;
1528 case DRM_MODE_OBJECT_CRTC: {
1529 struct drm_crtc *crtc = obj_to_crtc(obj);
1530 struct drm_crtc_state *crtc_state;
1532 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1533 if (IS_ERR(crtc_state)) {
1534 ret = PTR_ERR(crtc_state);
1535 break;
1538 ret = drm_atomic_crtc_set_property(crtc,
1539 crtc_state, prop, prop_value);
1540 break;
1542 case DRM_MODE_OBJECT_PLANE: {
1543 struct drm_plane *plane = obj_to_plane(obj);
1544 struct drm_plane_state *plane_state;
1546 plane_state = drm_atomic_get_plane_state(state, plane);
1547 if (IS_ERR(plane_state)) {
1548 ret = PTR_ERR(plane_state);
1549 break;
1552 ret = drm_atomic_plane_set_property(plane,
1553 plane_state, prop, prop_value);
1554 break;
1556 default:
1557 ret = -EINVAL;
1558 break;
1561 drm_property_change_valid_put(prop, ref);
1562 return ret;
1566 * drm_atomic_clean_old_fb -- Unset old_fb pointers and set plane->fb pointers.
1568 * @dev: drm device to check.
1569 * @plane_mask: plane mask for planes that were updated.
1570 * @ret: return value, can be -EDEADLK for a retry.
1572 * Before doing an update plane->old_fb is set to plane->fb,
1573 * but before dropping the locks old_fb needs to be set to NULL
1574 * and plane->fb updated. This is a common operation for each
1575 * atomic update, so this call is split off as a helper.
1577 void drm_atomic_clean_old_fb(struct drm_device *dev,
1578 unsigned plane_mask,
1579 int ret)
1581 struct drm_plane *plane;
1583 /* if succeeded, fixup legacy plane crtc/fb ptrs before dropping
1584 * locks (ie. while it is still safe to deref plane->state). We
1585 * need to do this here because the driver entry points cannot
1586 * distinguish between legacy and atomic ioctls.
1588 drm_for_each_plane_mask(plane, dev, plane_mask) {
1589 if (ret == 0) {
1590 struct drm_framebuffer *new_fb = plane->state->fb;
1591 if (new_fb)
1592 drm_framebuffer_reference(new_fb);
1593 plane->fb = new_fb;
1594 plane->crtc = plane->state->crtc;
1596 if (plane->old_fb)
1597 drm_framebuffer_unreference(plane->old_fb);
1599 plane->old_fb = NULL;
1602 EXPORT_SYMBOL(drm_atomic_clean_old_fb);
1604 int drm_mode_atomic_ioctl(struct drm_device *dev,
1605 void *data, struct drm_file *file_priv)
1607 struct drm_mode_atomic *arg = data;
1608 uint32_t __user *objs_ptr = (uint32_t __user *)(unsigned long)(arg->objs_ptr);
1609 uint32_t __user *count_props_ptr = (uint32_t __user *)(unsigned long)(arg->count_props_ptr);
1610 uint32_t __user *props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
1611 uint64_t __user *prop_values_ptr = (uint64_t __user *)(unsigned long)(arg->prop_values_ptr);
1612 unsigned int copied_objs, copied_props;
1613 struct drm_atomic_state *state;
1614 struct drm_modeset_acquire_ctx ctx;
1615 struct drm_plane *plane;
1616 struct drm_crtc *crtc;
1617 struct drm_crtc_state *crtc_state;
1618 unsigned plane_mask;
1619 int ret = 0;
1620 unsigned int i, j;
1622 /* disallow for drivers not supporting atomic: */
1623 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1624 return -EINVAL;
1626 /* disallow for userspace that has not enabled atomic cap (even
1627 * though this may be a bit overkill, since legacy userspace
1628 * wouldn't know how to call this ioctl)
1630 if (!file_priv->atomic)
1631 return -EINVAL;
1633 if (arg->flags & ~DRM_MODE_ATOMIC_FLAGS)
1634 return -EINVAL;
1636 if (arg->reserved)
1637 return -EINVAL;
1639 if ((arg->flags & DRM_MODE_PAGE_FLIP_ASYNC) &&
1640 !dev->mode_config.async_page_flip)
1641 return -EINVAL;
1643 /* can't test and expect an event at the same time. */
1644 if ((arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) &&
1645 (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
1646 return -EINVAL;
1648 drm_modeset_acquire_init(&ctx, 0);
1650 state = drm_atomic_state_alloc(dev);
1651 if (!state)
1652 return -ENOMEM;
1654 state->acquire_ctx = &ctx;
1655 state->allow_modeset = !!(arg->flags & DRM_MODE_ATOMIC_ALLOW_MODESET);
1657 retry:
1658 plane_mask = 0;
1659 copied_objs = 0;
1660 copied_props = 0;
1662 for (i = 0; i < arg->count_objs; i++) {
1663 uint32_t obj_id, count_props;
1664 struct drm_mode_object *obj;
1666 if (get_user(obj_id, objs_ptr + copied_objs)) {
1667 ret = -EFAULT;
1668 goto out;
1671 obj = drm_mode_object_find(dev, obj_id, DRM_MODE_OBJECT_ANY);
1672 if (!obj) {
1673 ret = -ENOENT;
1674 goto out;
1677 if (!obj->properties) {
1678 drm_mode_object_unreference(obj);
1679 ret = -ENOENT;
1680 goto out;
1683 if (get_user(count_props, count_props_ptr + copied_objs)) {
1684 drm_mode_object_unreference(obj);
1685 ret = -EFAULT;
1686 goto out;
1689 copied_objs++;
1691 for (j = 0; j < count_props; j++) {
1692 uint32_t prop_id;
1693 uint64_t prop_value;
1694 struct drm_property *prop;
1696 if (get_user(prop_id, props_ptr + copied_props)) {
1697 drm_mode_object_unreference(obj);
1698 ret = -EFAULT;
1699 goto out;
1702 prop = drm_mode_obj_find_prop_id(obj, prop_id);
1703 if (!prop) {
1704 drm_mode_object_unreference(obj);
1705 ret = -ENOENT;
1706 goto out;
1709 if (copy_from_user(&prop_value,
1710 prop_values_ptr + copied_props,
1711 sizeof(prop_value))) {
1712 drm_mode_object_unreference(obj);
1713 ret = -EFAULT;
1714 goto out;
1717 ret = atomic_set_prop(state, obj, prop, prop_value);
1718 if (ret) {
1719 drm_mode_object_unreference(obj);
1720 goto out;
1723 copied_props++;
1726 if (obj->type == DRM_MODE_OBJECT_PLANE && count_props &&
1727 !(arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)) {
1728 plane = obj_to_plane(obj);
1729 plane_mask |= (1 << drm_plane_index(plane));
1730 plane->old_fb = plane->fb;
1732 drm_mode_object_unreference(obj);
1735 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1736 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1737 struct drm_pending_vblank_event *e;
1739 e = create_vblank_event(dev, file_priv, NULL,
1740 arg->user_data);
1741 if (!e) {
1742 ret = -ENOMEM;
1743 goto out;
1746 crtc_state->event = e;
1750 if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) {
1752 * Unlike commit, check_only does not clean up state.
1753 * Below we call drm_atomic_state_free for it.
1755 ret = drm_atomic_check_only(state);
1756 } else if (arg->flags & DRM_MODE_ATOMIC_NONBLOCK) {
1757 ret = drm_atomic_nonblocking_commit(state);
1758 } else {
1759 ret = drm_atomic_commit(state);
1762 out:
1763 drm_atomic_clean_old_fb(dev, plane_mask, ret);
1765 if (ret && arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1767 * Free the allocated event. drm_atomic_helper_setup_commit
1768 * can allocate an event too, so only free it if it's ours
1769 * to prevent a double free in drm_atomic_state_clear.
1771 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1772 struct drm_pending_vblank_event *event = crtc_state->event;
1773 if (event && (event->base.fence || event->base.file_priv)) {
1774 drm_event_cancel_free(dev, &event->base);
1775 crtc_state->event = NULL;
1780 if (ret == -EDEADLK) {
1781 drm_atomic_state_clear(state);
1782 drm_modeset_backoff(&ctx);
1783 goto retry;
1786 if (ret || arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)
1787 drm_atomic_state_free(state);
1789 drm_modeset_drop_locks(&ctx);
1790 drm_modeset_acquire_fini(&ctx);
1792 return ret;