]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/gpu/drm/drm_atomic.c
drm: Add drm_rotation_90_or_270()
[mirror_ubuntu-artful-kernel.git] / drivers / gpu / drm / drm_atomic.c
CommitLineData
cc4ceb48
DV
1/*
2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
4 *
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:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
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.
22 *
23 * Authors:
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
26 */
27
28
29#include <drm/drmP.h>
30#include <drm/drm_atomic.h>
5488dc16 31#include <drm/drm_mode.h>
cc4ceb48
DV
32#include <drm/drm_plane_helper.h>
33
be35f94f
TR
34#include "drm_crtc_internal.h"
35
3b24f7d6
DV
36static void crtc_commit_free(struct kref *kref)
37{
38 struct drm_crtc_commit *commit =
39 container_of(kref, struct drm_crtc_commit, ref);
40
41 kfree(commit);
42}
43
44void drm_crtc_commit_put(struct drm_crtc_commit *commit)
45{
46 kref_put(&commit->ref, crtc_commit_free);
47}
48EXPORT_SYMBOL(drm_crtc_commit_put);
49
036ef573
ML
50/**
51 * drm_atomic_state_default_release -
52 * release memory initialized by drm_atomic_state_init
53 * @state: atomic state
54 *
55 * Free all the memory allocated by drm_atomic_state_init.
56 * This is useful for drivers that subclass the atomic state.
57 */
58void drm_atomic_state_default_release(struct drm_atomic_state *state)
cc4ceb48
DV
59{
60 kfree(state->connectors);
cc4ceb48 61 kfree(state->crtcs);
cc4ceb48 62 kfree(state->planes);
cc4ceb48 63}
036ef573 64EXPORT_SYMBOL(drm_atomic_state_default_release);
cc4ceb48
DV
65
66/**
036ef573 67 * drm_atomic_state_init - init new atomic state
cc4ceb48 68 * @dev: DRM device
036ef573 69 * @state: atomic state
cc4ceb48 70 *
036ef573
ML
71 * Default implementation for filling in a new atomic state.
72 * This is useful for drivers that subclass the atomic state.
cc4ceb48 73 */
036ef573
ML
74int
75drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)
cc4ceb48 76{
0853695c
CW
77 kref_init(&state->ref);
78
d34f20d6
RC
79 /* TODO legacy paths should maybe do a better job about
80 * setting this appropriately?
81 */
82 state->allow_modeset = true;
83
cc4ceb48
DV
84 state->crtcs = kcalloc(dev->mode_config.num_crtc,
85 sizeof(*state->crtcs), GFP_KERNEL);
86 if (!state->crtcs)
87 goto fail;
cc4ceb48
DV
88 state->planes = kcalloc(dev->mode_config.num_total_plane,
89 sizeof(*state->planes), GFP_KERNEL);
90 if (!state->planes)
91 goto fail;
cc4ceb48
DV
92
93 state->dev = dev;
94
036ef573 95 DRM_DEBUG_ATOMIC("Allocated atomic state %p\n", state);
cc4ceb48 96
036ef573 97 return 0;
cc4ceb48 98fail:
036ef573
ML
99 drm_atomic_state_default_release(state);
100 return -ENOMEM;
101}
102EXPORT_SYMBOL(drm_atomic_state_init);
103
104/**
105 * drm_atomic_state_alloc - allocate atomic state
106 * @dev: DRM device
107 *
108 * This allocates an empty atomic state to track updates.
109 */
110struct drm_atomic_state *
111drm_atomic_state_alloc(struct drm_device *dev)
112{
113 struct drm_mode_config *config = &dev->mode_config;
114 struct drm_atomic_state *state;
115
116 if (!config->funcs->atomic_state_alloc) {
117 state = kzalloc(sizeof(*state), GFP_KERNEL);
118 if (!state)
119 return NULL;
120 if (drm_atomic_state_init(dev, state) < 0) {
121 kfree(state);
122 return NULL;
123 }
124 return state;
125 }
cc4ceb48 126
036ef573 127 return config->funcs->atomic_state_alloc(dev);
cc4ceb48
DV
128}
129EXPORT_SYMBOL(drm_atomic_state_alloc);
130
131/**
036ef573 132 * drm_atomic_state_default_clear - clear base atomic state
cc4ceb48
DV
133 * @state: atomic state
134 *
036ef573
ML
135 * Default implementation for clearing atomic state.
136 * This is useful for drivers that subclass the atomic state.
cc4ceb48 137 */
036ef573 138void drm_atomic_state_default_clear(struct drm_atomic_state *state)
cc4ceb48
DV
139{
140 struct drm_device *dev = state->dev;
6f75cea6 141 struct drm_mode_config *config = &dev->mode_config;
cc4ceb48
DV
142 int i;
143
17a38d9c 144 DRM_DEBUG_ATOMIC("Clearing atomic state %p\n", state);
cc4ceb48 145
f52b69f1 146 for (i = 0; i < state->num_connector; i++) {
63e83c1d 147 struct drm_connector *connector = state->connectors[i].ptr;
cc4ceb48
DV
148
149 if (!connector)
150 continue;
151
d2307dea 152 connector->funcs->atomic_destroy_state(connector,
63e83c1d
DV
153 state->connectors[i].state);
154 state->connectors[i].ptr = NULL;
155 state->connectors[i].state = NULL;
b164d31f 156 drm_connector_unreference(connector);
cc4ceb48
DV
157 }
158
6f75cea6 159 for (i = 0; i < config->num_crtc; i++) {
5d943aa6 160 struct drm_crtc *crtc = state->crtcs[i].ptr;
cc4ceb48
DV
161
162 if (!crtc)
163 continue;
164
165 crtc->funcs->atomic_destroy_state(crtc,
5d943aa6 166 state->crtcs[i].state);
3b24f7d6
DV
167
168 if (state->crtcs[i].commit) {
169 kfree(state->crtcs[i].commit->event);
170 state->crtcs[i].commit->event = NULL;
171 drm_crtc_commit_put(state->crtcs[i].commit);
172 }
173
174 state->crtcs[i].commit = NULL;
5d943aa6
DV
175 state->crtcs[i].ptr = NULL;
176 state->crtcs[i].state = NULL;
cc4ceb48
DV
177 }
178
6f75cea6 179 for (i = 0; i < config->num_total_plane; i++) {
b8b5342b 180 struct drm_plane *plane = state->planes[i].ptr;
cc4ceb48
DV
181
182 if (!plane)
183 continue;
184
185 plane->funcs->atomic_destroy_state(plane,
b8b5342b
DV
186 state->planes[i].state);
187 state->planes[i].ptr = NULL;
188 state->planes[i].state = NULL;
cc4ceb48
DV
189 }
190}
036ef573
ML
191EXPORT_SYMBOL(drm_atomic_state_default_clear);
192
193/**
194 * drm_atomic_state_clear - clear state object
195 * @state: atomic state
196 *
197 * When the w/w mutex algorithm detects a deadlock we need to back off and drop
198 * all locks. So someone else could sneak in and change the current modeset
199 * configuration. Which means that all the state assembled in @state is no
200 * longer an atomic update to the current state, but to some arbitrary earlier
201 * state. Which could break assumptions the driver's ->atomic_check likely
202 * relies on.
203 *
204 * Hence we must clear all cached state and completely start over, using this
205 * function.
206 */
207void drm_atomic_state_clear(struct drm_atomic_state *state)
208{
209 struct drm_device *dev = state->dev;
210 struct drm_mode_config *config = &dev->mode_config;
211
212 if (config->funcs->atomic_state_clear)
213 config->funcs->atomic_state_clear(state);
214 else
215 drm_atomic_state_default_clear(state);
216}
cc4ceb48
DV
217EXPORT_SYMBOL(drm_atomic_state_clear);
218
219/**
0853695c
CW
220 * __drm_atomic_state_free - free all memory for an atomic state
221 * @ref: This atomic state to deallocate
cc4ceb48
DV
222 *
223 * This frees all memory associated with an atomic state, including all the
224 * per-object state for planes, crtcs and connectors.
225 */
0853695c 226void __drm_atomic_state_free(struct kref *ref)
cc4ceb48 227{
0853695c
CW
228 struct drm_atomic_state *state = container_of(ref, typeof(*state), ref);
229 struct drm_mode_config *config = &state->dev->mode_config;
036ef573 230
cc4ceb48
DV
231 drm_atomic_state_clear(state);
232
17a38d9c 233 DRM_DEBUG_ATOMIC("Freeing atomic state %p\n", state);
cc4ceb48 234
036ef573
ML
235 if (config->funcs->atomic_state_free) {
236 config->funcs->atomic_state_free(state);
237 } else {
238 drm_atomic_state_default_release(state);
239 kfree(state);
240 }
cc4ceb48 241}
0853695c 242EXPORT_SYMBOL(__drm_atomic_state_free);
cc4ceb48
DV
243
244/**
245 * drm_atomic_get_crtc_state - get crtc state
246 * @state: global atomic state object
247 * @crtc: crtc to get state object for
248 *
249 * This function returns the crtc state for the given crtc, allocating it if
250 * needed. It will also grab the relevant crtc lock to make sure that the state
251 * is consistent.
252 *
253 * Returns:
254 *
255 * Either the allocated state or the error code encoded into the pointer. When
256 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
257 * entire atomic sequence must be restarted. All other errors are fatal.
258 */
259struct drm_crtc_state *
260drm_atomic_get_crtc_state(struct drm_atomic_state *state,
261 struct drm_crtc *crtc)
262{
1b26a5e1 263 int ret, index = drm_crtc_index(crtc);
cc4ceb48
DV
264 struct drm_crtc_state *crtc_state;
265
7f4eaa89
ML
266 WARN_ON(!state->acquire_ctx);
267
1b26a5e1
ML
268 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
269 if (crtc_state)
270 return crtc_state;
cc4ceb48
DV
271
272 ret = drm_modeset_lock(&crtc->mutex, state->acquire_ctx);
273 if (ret)
274 return ERR_PTR(ret);
275
276 crtc_state = crtc->funcs->atomic_duplicate_state(crtc);
277 if (!crtc_state)
278 return ERR_PTR(-ENOMEM);
279
5d943aa6
DV
280 state->crtcs[index].state = crtc_state;
281 state->crtcs[index].ptr = crtc;
cc4ceb48
DV
282 crtc_state->state = state;
283
fa3ab4c2
VS
284 DRM_DEBUG_ATOMIC("Added [CRTC:%d:%s] %p state to %p\n",
285 crtc->base.id, crtc->name, crtc_state, state);
cc4ceb48
DV
286
287 return crtc_state;
288}
289EXPORT_SYMBOL(drm_atomic_get_crtc_state);
290
819364da
DS
291/**
292 * drm_atomic_set_mode_for_crtc - set mode for CRTC
293 * @state: the CRTC whose incoming state to update
294 * @mode: kernel-internal mode to use for the CRTC, or NULL to disable
295 *
296 * Set a mode (originating from the kernel) on the desired CRTC state. Does
297 * not change any other state properties, including enable, active, or
298 * mode_changed.
299 *
300 * RETURNS:
301 * Zero on success, error code on failure. Cannot return -EDEADLK.
302 */
303int drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
304 struct drm_display_mode *mode)
305{
99cf4a29
DS
306 struct drm_mode_modeinfo umode;
307
819364da
DS
308 /* Early return for no change. */
309 if (mode && memcmp(&state->mode, mode, sizeof(*mode)) == 0)
310 return 0;
311
5f911905 312 drm_property_unreference_blob(state->mode_blob);
99cf4a29
DS
313 state->mode_blob = NULL;
314
819364da 315 if (mode) {
99cf4a29
DS
316 drm_mode_convert_to_umode(&umode, mode);
317 state->mode_blob =
318 drm_property_create_blob(state->crtc->dev,
319 sizeof(umode),
320 &umode);
321 if (IS_ERR(state->mode_blob))
322 return PTR_ERR(state->mode_blob);
323
819364da
DS
324 drm_mode_copy(&state->mode, mode);
325 state->enable = true;
326 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
327 mode->name, state);
328 } else {
329 memset(&state->mode, 0, sizeof(state->mode));
330 state->enable = false;
331 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
332 state);
333 }
334
335 return 0;
336}
337EXPORT_SYMBOL(drm_atomic_set_mode_for_crtc);
338
955f3c33
DS
339/**
340 * drm_atomic_set_mode_prop_for_crtc - set mode for CRTC
341 * @state: the CRTC whose incoming state to update
342 * @blob: pointer to blob property to use for mode
343 *
344 * Set a mode (originating from a blob property) on the desired CRTC state.
345 * This function will take a reference on the blob property for the CRTC state,
346 * and release the reference held on the state's existing mode property, if any
347 * was set.
348 *
349 * RETURNS:
350 * Zero on success, error code on failure. Cannot return -EDEADLK.
351 */
352int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
353 struct drm_property_blob *blob)
354{
355 if (blob == state->mode_blob)
356 return 0;
357
5f911905 358 drm_property_unreference_blob(state->mode_blob);
955f3c33
DS
359 state->mode_blob = NULL;
360
6709887c
TV
361 memset(&state->mode, 0, sizeof(state->mode));
362
955f3c33
DS
363 if (blob) {
364 if (blob->length != sizeof(struct drm_mode_modeinfo) ||
365 drm_mode_convert_umode(&state->mode,
366 (const struct drm_mode_modeinfo *)
367 blob->data))
368 return -EINVAL;
369
370 state->mode_blob = drm_property_reference_blob(blob);
371 state->enable = true;
372 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
373 state->mode.name, state);
374 } else {
955f3c33
DS
375 state->enable = false;
376 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
377 state);
378 }
379
380 return 0;
381}
382EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc);
383
5488dc16
LL
384/**
385 * drm_atomic_replace_property_blob - replace a blob property
386 * @blob: a pointer to the member blob to be replaced
387 * @new_blob: the new blob to replace with
5488dc16
LL
388 * @replaced: whether the blob has been replaced
389 *
390 * RETURNS:
391 * Zero on success, error code on failure
392 */
393static void
394drm_atomic_replace_property_blob(struct drm_property_blob **blob,
395 struct drm_property_blob *new_blob,
396 bool *replaced)
397{
398 struct drm_property_blob *old_blob = *blob;
399
400 if (old_blob == new_blob)
401 return;
402
f35cbe6a 403 drm_property_unreference_blob(old_blob);
5488dc16
LL
404 if (new_blob)
405 drm_property_reference_blob(new_blob);
406 *blob = new_blob;
407 *replaced = true;
408
409 return;
410}
411
412static int
413drm_atomic_replace_property_blob_from_id(struct drm_crtc *crtc,
414 struct drm_property_blob **blob,
415 uint64_t blob_id,
416 ssize_t expected_size,
417 bool *replaced)
418{
419 struct drm_device *dev = crtc->dev;
420 struct drm_property_blob *new_blob = NULL;
421
422 if (blob_id != 0) {
423 new_blob = drm_property_lookup_blob(dev, blob_id);
424 if (new_blob == NULL)
425 return -EINVAL;
426 if (expected_size > 0 && expected_size != new_blob->length)
427 return -EINVAL;
428 }
429
430 drm_atomic_replace_property_blob(blob, new_blob, replaced);
431
432 return 0;
433}
434
40ecc694
RC
435/**
436 * drm_atomic_crtc_set_property - set property on CRTC
437 * @crtc: the drm CRTC to set a property on
438 * @state: the state object to update with the new property value
439 * @property: the property to set
440 * @val: the new property value
441 *
442 * Use this instead of calling crtc->atomic_set_property directly.
443 * This function handles generic/core properties and calls out to
444 * driver's ->atomic_set_property() for driver properties. To ensure
445 * consistent behavior you must call this function rather than the
446 * driver hook directly.
447 *
448 * RETURNS:
449 * Zero on success, error code on failure
450 */
451int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
452 struct drm_crtc_state *state, struct drm_property *property,
453 uint64_t val)
454{
eab3bbef
DV
455 struct drm_device *dev = crtc->dev;
456 struct drm_mode_config *config = &dev->mode_config;
5488dc16 457 bool replaced = false;
955f3c33 458 int ret;
eab3bbef 459
27798365 460 if (property == config->prop_active)
eab3bbef 461 state->active = val;
955f3c33
DS
462 else if (property == config->prop_mode_id) {
463 struct drm_property_blob *mode =
464 drm_property_lookup_blob(dev, val);
465 ret = drm_atomic_set_mode_prop_for_crtc(state, mode);
5f911905 466 drm_property_unreference_blob(mode);
955f3c33 467 return ret;
5488dc16
LL
468 } else if (property == config->degamma_lut_property) {
469 ret = drm_atomic_replace_property_blob_from_id(crtc,
470 &state->degamma_lut,
471 val,
472 -1,
473 &replaced);
add1fa75 474 state->color_mgmt_changed |= replaced;
5488dc16
LL
475 return ret;
476 } else if (property == config->ctm_property) {
477 ret = drm_atomic_replace_property_blob_from_id(crtc,
478 &state->ctm,
479 val,
480 sizeof(struct drm_color_ctm),
481 &replaced);
add1fa75 482 state->color_mgmt_changed |= replaced;
5488dc16
LL
483 return ret;
484 } else if (property == config->gamma_lut_property) {
485 ret = drm_atomic_replace_property_blob_from_id(crtc,
486 &state->gamma_lut,
487 val,
488 -1,
489 &replaced);
add1fa75 490 state->color_mgmt_changed |= replaced;
5488dc16
LL
491 return ret;
492 } else if (crtc->funcs->atomic_set_property)
40ecc694 493 return crtc->funcs->atomic_set_property(crtc, state, property, val);
27798365
DS
494 else
495 return -EINVAL;
496
497 return 0;
40ecc694
RC
498}
499EXPORT_SYMBOL(drm_atomic_crtc_set_property);
500
c0714fc9
DV
501/**
502 * drm_atomic_crtc_get_property - get property value from CRTC state
503 * @crtc: the drm CRTC to set a property on
504 * @state: the state object to get the property value from
505 * @property: the property to set
506 * @val: return location for the property value
507 *
ac9c9256
RC
508 * This function handles generic/core properties and calls out to
509 * driver's ->atomic_get_property() for driver properties. To ensure
510 * consistent behavior you must call this function rather than the
511 * driver hook directly.
c0714fc9
DV
512 *
513 * RETURNS:
514 * Zero on success, error code on failure
ac9c9256 515 */
bf22f3be
GT
516static int
517drm_atomic_crtc_get_property(struct drm_crtc *crtc,
ac9c9256
RC
518 const struct drm_crtc_state *state,
519 struct drm_property *property, uint64_t *val)
520{
8f164ce4
DS
521 struct drm_device *dev = crtc->dev;
522 struct drm_mode_config *config = &dev->mode_config;
523
524 if (property == config->prop_active)
525 *val = state->active;
955f3c33
DS
526 else if (property == config->prop_mode_id)
527 *val = (state->mode_blob) ? state->mode_blob->base.id : 0;
5488dc16
LL
528 else if (property == config->degamma_lut_property)
529 *val = (state->degamma_lut) ? state->degamma_lut->base.id : 0;
530 else if (property == config->ctm_property)
531 *val = (state->ctm) ? state->ctm->base.id : 0;
532 else if (property == config->gamma_lut_property)
533 *val = (state->gamma_lut) ? state->gamma_lut->base.id : 0;
8f164ce4 534 else if (crtc->funcs->atomic_get_property)
ac9c9256 535 return crtc->funcs->atomic_get_property(crtc, state, property, val);
8f164ce4
DS
536 else
537 return -EINVAL;
538
539 return 0;
ac9c9256 540}
ac9c9256 541
5e743737
RC
542/**
543 * drm_atomic_crtc_check - check crtc state
544 * @crtc: crtc to check
545 * @state: crtc state to check
546 *
547 * Provides core sanity checks for crtc state.
548 *
549 * RETURNS:
550 * Zero on success, error code on failure
551 */
552static int drm_atomic_crtc_check(struct drm_crtc *crtc,
553 struct drm_crtc_state *state)
554{
555 /* NOTE: we explicitly don't enforce constraints such as primary
556 * layer covering entire screen, since that is something we want
557 * to allow (on hw that supports it). For hw that does not, it
558 * should be checked in driver's crtc->atomic_check() vfunc.
559 *
560 * TODO: Add generic modeset state checks once we support those.
561 */
eab3bbef
DV
562
563 if (state->active && !state->enable) {
fa3ab4c2
VS
564 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active without enabled\n",
565 crtc->base.id, crtc->name);
eab3bbef
DV
566 return -EINVAL;
567 }
568
99cf4a29
DS
569 /* The state->enable vs. state->mode_blob checks can be WARN_ON,
570 * as this is a kernel-internal detail that userspace should never
571 * be able to trigger. */
572 if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
573 WARN_ON(state->enable && !state->mode_blob)) {
fa3ab4c2
VS
574 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled without mode blob\n",
575 crtc->base.id, crtc->name);
99cf4a29
DS
576 return -EINVAL;
577 }
578
579 if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
580 WARN_ON(!state->enable && state->mode_blob)) {
fa3ab4c2
VS
581 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled with mode blob\n",
582 crtc->base.id, crtc->name);
99cf4a29
DS
583 return -EINVAL;
584 }
585
4cba6850
DV
586 /*
587 * Reject event generation for when a CRTC is off and stays off.
588 * It wouldn't be hard to implement this, but userspace has a track
589 * record of happily burning through 100% cpu (or worse, crash) when the
590 * display pipe is suspended. To avoid all that fun just reject updates
591 * that ask for events since likely that indicates a bug in the
592 * compositor's drawing loop. This is consistent with the vblank IOCTL
593 * and legacy page_flip IOCTL which also reject service on a disabled
594 * pipe.
595 */
596 if (state->event && !state->active && !crtc->state->active) {
597 DRM_DEBUG_ATOMIC("[CRTC:%d] requesting event but off\n",
598 crtc->base.id);
599 return -EINVAL;
600 }
601
5e743737
RC
602 return 0;
603}
604
cc4ceb48
DV
605/**
606 * drm_atomic_get_plane_state - get plane state
607 * @state: global atomic state object
608 * @plane: plane to get state object for
609 *
610 * This function returns the plane state for the given plane, allocating it if
611 * needed. It will also grab the relevant plane lock to make sure that the state
612 * is consistent.
613 *
614 * Returns:
615 *
616 * Either the allocated state or the error code encoded into the pointer. When
617 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
618 * entire atomic sequence must be restarted. All other errors are fatal.
619 */
620struct drm_plane_state *
621drm_atomic_get_plane_state(struct drm_atomic_state *state,
622 struct drm_plane *plane)
623{
1b26a5e1 624 int ret, index = drm_plane_index(plane);
cc4ceb48
DV
625 struct drm_plane_state *plane_state;
626
7f4eaa89
ML
627 WARN_ON(!state->acquire_ctx);
628
1b26a5e1
ML
629 plane_state = drm_atomic_get_existing_plane_state(state, plane);
630 if (plane_state)
631 return plane_state;
cc4ceb48 632
4d02e2de 633 ret = drm_modeset_lock(&plane->mutex, state->acquire_ctx);
cc4ceb48
DV
634 if (ret)
635 return ERR_PTR(ret);
636
637 plane_state = plane->funcs->atomic_duplicate_state(plane);
638 if (!plane_state)
639 return ERR_PTR(-ENOMEM);
640
b8b5342b
DV
641 state->planes[index].state = plane_state;
642 state->planes[index].ptr = plane;
cc4ceb48
DV
643 plane_state->state = state;
644
9f4c97a2
VS
645 DRM_DEBUG_ATOMIC("Added [PLANE:%d:%s] %p state to %p\n",
646 plane->base.id, plane->name, plane_state, state);
cc4ceb48
DV
647
648 if (plane_state->crtc) {
649 struct drm_crtc_state *crtc_state;
650
651 crtc_state = drm_atomic_get_crtc_state(state,
652 plane_state->crtc);
653 if (IS_ERR(crtc_state))
654 return ERR_CAST(crtc_state);
655 }
656
657 return plane_state;
658}
659EXPORT_SYMBOL(drm_atomic_get_plane_state);
660
40ecc694
RC
661/**
662 * drm_atomic_plane_set_property - set property on plane
663 * @plane: the drm plane to set a property on
664 * @state: the state object to update with the new property value
665 * @property: the property to set
666 * @val: the new property value
667 *
668 * Use this instead of calling plane->atomic_set_property directly.
669 * This function handles generic/core properties and calls out to
670 * driver's ->atomic_set_property() for driver properties. To ensure
671 * consistent behavior you must call this function rather than the
672 * driver hook directly.
673 *
674 * RETURNS:
675 * Zero on success, error code on failure
676 */
677int drm_atomic_plane_set_property(struct drm_plane *plane,
678 struct drm_plane_state *state, struct drm_property *property,
679 uint64_t val)
680{
6b4959f4
RC
681 struct drm_device *dev = plane->dev;
682 struct drm_mode_config *config = &dev->mode_config;
683
684 if (property == config->prop_fb_id) {
685 struct drm_framebuffer *fb = drm_framebuffer_lookup(dev, val);
686 drm_atomic_set_fb_for_plane(state, fb);
687 if (fb)
688 drm_framebuffer_unreference(fb);
689 } else if (property == config->prop_crtc_id) {
690 struct drm_crtc *crtc = drm_crtc_find(dev, val);
691 return drm_atomic_set_crtc_for_plane(state, crtc);
692 } else if (property == config->prop_crtc_x) {
693 state->crtc_x = U642I64(val);
694 } else if (property == config->prop_crtc_y) {
695 state->crtc_y = U642I64(val);
696 } else if (property == config->prop_crtc_w) {
697 state->crtc_w = val;
698 } else if (property == config->prop_crtc_h) {
699 state->crtc_h = val;
700 } else if (property == config->prop_src_x) {
701 state->src_x = val;
702 } else if (property == config->prop_src_y) {
703 state->src_y = val;
704 } else if (property == config->prop_src_w) {
705 state->src_w = val;
706 } else if (property == config->prop_src_h) {
707 state->src_h = val;
1da30627
MR
708 } else if (property == config->rotation_property) {
709 state->rotation = val;
44d1240d
MS
710 } else if (property == plane->zpos_property) {
711 state->zpos = val;
6b4959f4
RC
712 } else if (plane->funcs->atomic_set_property) {
713 return plane->funcs->atomic_set_property(plane, state,
714 property, val);
715 } else {
716 return -EINVAL;
717 }
718
719 return 0;
40ecc694
RC
720}
721EXPORT_SYMBOL(drm_atomic_plane_set_property);
722
c0714fc9
DV
723/**
724 * drm_atomic_plane_get_property - get property value from plane state
725 * @plane: the drm plane to set a property on
726 * @state: the state object to get the property value from
727 * @property: the property to set
728 * @val: return location for the property value
729 *
ac9c9256
RC
730 * This function handles generic/core properties and calls out to
731 * driver's ->atomic_get_property() for driver properties. To ensure
732 * consistent behavior you must call this function rather than the
733 * driver hook directly.
c0714fc9
DV
734 *
735 * RETURNS:
736 * Zero on success, error code on failure
ac9c9256 737 */
a97df1cc
DV
738static int
739drm_atomic_plane_get_property(struct drm_plane *plane,
ac9c9256
RC
740 const struct drm_plane_state *state,
741 struct drm_property *property, uint64_t *val)
742{
6b4959f4
RC
743 struct drm_device *dev = plane->dev;
744 struct drm_mode_config *config = &dev->mode_config;
745
746 if (property == config->prop_fb_id) {
747 *val = (state->fb) ? state->fb->base.id : 0;
748 } else if (property == config->prop_crtc_id) {
749 *val = (state->crtc) ? state->crtc->base.id : 0;
750 } else if (property == config->prop_crtc_x) {
751 *val = I642U64(state->crtc_x);
752 } else if (property == config->prop_crtc_y) {
753 *val = I642U64(state->crtc_y);
754 } else if (property == config->prop_crtc_w) {
755 *val = state->crtc_w;
756 } else if (property == config->prop_crtc_h) {
757 *val = state->crtc_h;
758 } else if (property == config->prop_src_x) {
759 *val = state->src_x;
760 } else if (property == config->prop_src_y) {
761 *val = state->src_y;
762 } else if (property == config->prop_src_w) {
763 *val = state->src_w;
764 } else if (property == config->prop_src_h) {
765 *val = state->src_h;
4cda09ca
TU
766 } else if (property == config->rotation_property) {
767 *val = state->rotation;
44d1240d
MS
768 } else if (property == plane->zpos_property) {
769 *val = state->zpos;
6b4959f4 770 } else if (plane->funcs->atomic_get_property) {
ac9c9256 771 return plane->funcs->atomic_get_property(plane, state, property, val);
6b4959f4
RC
772 } else {
773 return -EINVAL;
774 }
775
776 return 0;
ac9c9256 777}
ac9c9256 778
f8aeb41c
DV
779static bool
780plane_switching_crtc(struct drm_atomic_state *state,
781 struct drm_plane *plane,
782 struct drm_plane_state *plane_state)
783{
784 if (!plane->state->crtc || !plane_state->crtc)
785 return false;
786
787 if (plane->state->crtc == plane_state->crtc)
788 return false;
789
790 /* This could be refined, but currently there's no helper or driver code
791 * to implement direct switching of active planes nor userspace to take
792 * advantage of more direct plane switching without the intermediate
793 * full OFF state.
794 */
795 return true;
796}
797
5e743737
RC
798/**
799 * drm_atomic_plane_check - check plane state
800 * @plane: plane to check
801 * @state: plane state to check
802 *
803 * Provides core sanity checks for plane state.
804 *
805 * RETURNS:
806 * Zero on success, error code on failure
807 */
808static int drm_atomic_plane_check(struct drm_plane *plane,
809 struct drm_plane_state *state)
810{
811 unsigned int fb_width, fb_height;
ead8610d 812 int ret;
5e743737
RC
813
814 /* either *both* CRTC and FB must be set, or neither */
815 if (WARN_ON(state->crtc && !state->fb)) {
17a38d9c 816 DRM_DEBUG_ATOMIC("CRTC set but no FB\n");
5e743737
RC
817 return -EINVAL;
818 } else if (WARN_ON(state->fb && !state->crtc)) {
17a38d9c 819 DRM_DEBUG_ATOMIC("FB set but no CRTC\n");
5e743737
RC
820 return -EINVAL;
821 }
822
823 /* if disabled, we don't care about the rest of the state: */
824 if (!state->crtc)
825 return 0;
826
827 /* Check whether this plane is usable on this CRTC */
828 if (!(plane->possible_crtcs & drm_crtc_mask(state->crtc))) {
17a38d9c 829 DRM_DEBUG_ATOMIC("Invalid crtc for plane\n");
5e743737
RC
830 return -EINVAL;
831 }
832
833 /* Check whether this plane supports the fb pixel format. */
ead8610d
LP
834 ret = drm_plane_check_pixel_format(plane, state->fb->pixel_format);
835 if (ret) {
d3828147 836 char *format_name = drm_get_format_name(state->fb->pixel_format);
90844f00
EE
837 DRM_DEBUG_ATOMIC("Invalid pixel format %s\n", format_name);
838 kfree(format_name);
ead8610d 839 return ret;
5e743737
RC
840 }
841
842 /* Give drivers some help against integer overflows */
843 if (state->crtc_w > INT_MAX ||
844 state->crtc_x > INT_MAX - (int32_t) state->crtc_w ||
845 state->crtc_h > INT_MAX ||
846 state->crtc_y > INT_MAX - (int32_t) state->crtc_h) {
17a38d9c
DV
847 DRM_DEBUG_ATOMIC("Invalid CRTC coordinates %ux%u+%d+%d\n",
848 state->crtc_w, state->crtc_h,
849 state->crtc_x, state->crtc_y);
5e743737
RC
850 return -ERANGE;
851 }
852
853 fb_width = state->fb->width << 16;
854 fb_height = state->fb->height << 16;
855
856 /* Make sure source coordinates are inside the fb. */
857 if (state->src_w > fb_width ||
858 state->src_x > fb_width - state->src_w ||
859 state->src_h > fb_height ||
860 state->src_y > fb_height - state->src_h) {
17a38d9c
DV
861 DRM_DEBUG_ATOMIC("Invalid source coordinates "
862 "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
863 state->src_w >> 16, ((state->src_w & 0xffff) * 15625) >> 10,
864 state->src_h >> 16, ((state->src_h & 0xffff) * 15625) >> 10,
865 state->src_x >> 16, ((state->src_x & 0xffff) * 15625) >> 10,
866 state->src_y >> 16, ((state->src_y & 0xffff) * 15625) >> 10);
5e743737
RC
867 return -ENOSPC;
868 }
869
f8aeb41c 870 if (plane_switching_crtc(state->state, plane, state)) {
9f4c97a2
VS
871 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] switching CRTC directly\n",
872 plane->base.id, plane->name);
f8aeb41c
DV
873 return -EINVAL;
874 }
875
5e743737
RC
876 return 0;
877}
878
cc4ceb48
DV
879/**
880 * drm_atomic_get_connector_state - get connector state
881 * @state: global atomic state object
882 * @connector: connector to get state object for
883 *
884 * This function returns the connector state for the given connector,
885 * allocating it if needed. It will also grab the relevant connector lock to
886 * make sure that the state is consistent.
887 *
888 * Returns:
889 *
890 * Either the allocated state or the error code encoded into the pointer. When
891 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
892 * entire atomic sequence must be restarted. All other errors are fatal.
893 */
894struct drm_connector_state *
895drm_atomic_get_connector_state(struct drm_atomic_state *state,
896 struct drm_connector *connector)
897{
898 int ret, index;
899 struct drm_mode_config *config = &connector->dev->mode_config;
900 struct drm_connector_state *connector_state;
901
7f4eaa89
ML
902 WARN_ON(!state->acquire_ctx);
903
c7eb76f4
DV
904 ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
905 if (ret)
906 return ERR_PTR(ret);
907
cc4ceb48
DV
908 index = drm_connector_index(connector);
909
f52b69f1 910 if (index >= state->num_connector) {
63e83c1d 911 struct __drm_connnectors_state *c;
5fff80bb
ML
912 int alloc = max(index + 1, config->num_connector);
913
914 c = krealloc(state->connectors, alloc * sizeof(*state->connectors), GFP_KERNEL);
915 if (!c)
916 return ERR_PTR(-ENOMEM);
917
918 state->connectors = c;
919 memset(&state->connectors[state->num_connector], 0,
920 sizeof(*state->connectors) * (alloc - state->num_connector));
921
5fff80bb 922 state->num_connector = alloc;
f52b69f1
DV
923 }
924
63e83c1d
DV
925 if (state->connectors[index].state)
926 return state->connectors[index].state;
cc4ceb48 927
cc4ceb48
DV
928 connector_state = connector->funcs->atomic_duplicate_state(connector);
929 if (!connector_state)
930 return ERR_PTR(-ENOMEM);
931
b164d31f 932 drm_connector_reference(connector);
63e83c1d
DV
933 state->connectors[index].state = connector_state;
934 state->connectors[index].ptr = connector;
cc4ceb48
DV
935 connector_state->state = state;
936
17a38d9c
DV
937 DRM_DEBUG_ATOMIC("Added [CONNECTOR:%d] %p state to %p\n",
938 connector->base.id, connector_state, state);
cc4ceb48
DV
939
940 if (connector_state->crtc) {
941 struct drm_crtc_state *crtc_state;
942
943 crtc_state = drm_atomic_get_crtc_state(state,
944 connector_state->crtc);
945 if (IS_ERR(crtc_state))
946 return ERR_CAST(crtc_state);
947 }
948
949 return connector_state;
950}
951EXPORT_SYMBOL(drm_atomic_get_connector_state);
952
40ecc694
RC
953/**
954 * drm_atomic_connector_set_property - set property on connector.
955 * @connector: the drm connector to set a property on
956 * @state: the state object to update with the new property value
957 * @property: the property to set
958 * @val: the new property value
959 *
960 * Use this instead of calling connector->atomic_set_property directly.
961 * This function handles generic/core properties and calls out to
962 * driver's ->atomic_set_property() for driver properties. To ensure
963 * consistent behavior you must call this function rather than the
964 * driver hook directly.
965 *
966 * RETURNS:
967 * Zero on success, error code on failure
968 */
969int drm_atomic_connector_set_property(struct drm_connector *connector,
970 struct drm_connector_state *state, struct drm_property *property,
971 uint64_t val)
972{
973 struct drm_device *dev = connector->dev;
974 struct drm_mode_config *config = &dev->mode_config;
975
ae16c597
RC
976 if (property == config->prop_crtc_id) {
977 struct drm_crtc *crtc = drm_crtc_find(dev, val);
978 return drm_atomic_set_crtc_for_connector(state, crtc);
979 } else if (property == config->dpms_property) {
40ecc694
RC
980 /* setting DPMS property requires special handling, which
981 * is done in legacy setprop path for us. Disallow (for
982 * now?) atomic writes to DPMS property:
983 */
984 return -EINVAL;
985 } else if (connector->funcs->atomic_set_property) {
986 return connector->funcs->atomic_set_property(connector,
987 state, property, val);
988 } else {
989 return -EINVAL;
990 }
991}
992EXPORT_SYMBOL(drm_atomic_connector_set_property);
993
c0714fc9
DV
994/**
995 * drm_atomic_connector_get_property - get property value from connector state
996 * @connector: the drm connector to set a property on
997 * @state: the state object to get the property value from
998 * @property: the property to set
999 * @val: return location for the property value
1000 *
ac9c9256
RC
1001 * This function handles generic/core properties and calls out to
1002 * driver's ->atomic_get_property() for driver properties. To ensure
1003 * consistent behavior you must call this function rather than the
1004 * driver hook directly.
c0714fc9
DV
1005 *
1006 * RETURNS:
1007 * Zero on success, error code on failure
ac9c9256 1008 */
a97df1cc
DV
1009static int
1010drm_atomic_connector_get_property(struct drm_connector *connector,
ac9c9256
RC
1011 const struct drm_connector_state *state,
1012 struct drm_property *property, uint64_t *val)
1013{
1014 struct drm_device *dev = connector->dev;
1015 struct drm_mode_config *config = &dev->mode_config;
1016
ae16c597
RC
1017 if (property == config->prop_crtc_id) {
1018 *val = (state->crtc) ? state->crtc->base.id : 0;
1019 } else if (property == config->dpms_property) {
ac9c9256
RC
1020 *val = connector->dpms;
1021 } else if (connector->funcs->atomic_get_property) {
1022 return connector->funcs->atomic_get_property(connector,
1023 state, property, val);
1024 } else {
1025 return -EINVAL;
1026 }
1027
1028 return 0;
1029}
ac9c9256 1030
88a48e29
RC
1031int drm_atomic_get_property(struct drm_mode_object *obj,
1032 struct drm_property *property, uint64_t *val)
1033{
1034 struct drm_device *dev = property->dev;
1035 int ret;
1036
1037 switch (obj->type) {
1038 case DRM_MODE_OBJECT_CONNECTOR: {
1039 struct drm_connector *connector = obj_to_connector(obj);
1040 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
1041 ret = drm_atomic_connector_get_property(connector,
1042 connector->state, property, val);
1043 break;
1044 }
1045 case DRM_MODE_OBJECT_CRTC: {
1046 struct drm_crtc *crtc = obj_to_crtc(obj);
1047 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
1048 ret = drm_atomic_crtc_get_property(crtc,
1049 crtc->state, property, val);
1050 break;
1051 }
1052 case DRM_MODE_OBJECT_PLANE: {
1053 struct drm_plane *plane = obj_to_plane(obj);
1054 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
1055 ret = drm_atomic_plane_get_property(plane,
1056 plane->state, property, val);
1057 break;
1058 }
1059 default:
1060 ret = -EINVAL;
1061 break;
1062 }
1063
1064 return ret;
1065}
1066
cc4ceb48
DV
1067/**
1068 * drm_atomic_set_crtc_for_plane - set crtc for plane
07cc0ef6 1069 * @plane_state: the plane whose incoming state to update
cc4ceb48
DV
1070 * @crtc: crtc to use for the plane
1071 *
1072 * Changing the assigned crtc for a plane requires us to grab the lock and state
1073 * for the new crtc, as needed. This function takes care of all these details
1074 * besides updating the pointer in the state object itself.
1075 *
1076 * Returns:
1077 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1078 * then the w/w mutex code has detected a deadlock and the entire atomic
1079 * sequence must be restarted. All other errors are fatal.
1080 */
1081int
07cc0ef6
DV
1082drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
1083 struct drm_crtc *crtc)
cc4ceb48 1084{
07cc0ef6 1085 struct drm_plane *plane = plane_state->plane;
cc4ceb48
DV
1086 struct drm_crtc_state *crtc_state;
1087
6ddd388a
RC
1088 if (plane_state->crtc) {
1089 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1090 plane_state->crtc);
1091 if (WARN_ON(IS_ERR(crtc_state)))
1092 return PTR_ERR(crtc_state);
1093
1094 crtc_state->plane_mask &= ~(1 << drm_plane_index(plane));
1095 }
1096
1097 plane_state->crtc = crtc;
1098
cc4ceb48
DV
1099 if (crtc) {
1100 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1101 crtc);
1102 if (IS_ERR(crtc_state))
1103 return PTR_ERR(crtc_state);
6ddd388a 1104 crtc_state->plane_mask |= (1 << drm_plane_index(plane));
cc4ceb48
DV
1105 }
1106
cc4ceb48 1107 if (crtc)
fa3ab4c2
VS
1108 DRM_DEBUG_ATOMIC("Link plane state %p to [CRTC:%d:%s]\n",
1109 plane_state, crtc->base.id, crtc->name);
cc4ceb48 1110 else
17a38d9c
DV
1111 DRM_DEBUG_ATOMIC("Link plane state %p to [NOCRTC]\n",
1112 plane_state);
cc4ceb48
DV
1113
1114 return 0;
1115}
1116EXPORT_SYMBOL(drm_atomic_set_crtc_for_plane);
1117
321ebf04 1118/**
16d78bc2 1119 * drm_atomic_set_fb_for_plane - set framebuffer for plane
321ebf04
DV
1120 * @plane_state: atomic state object for the plane
1121 * @fb: fb to use for the plane
1122 *
1123 * Changing the assigned framebuffer for a plane requires us to grab a reference
1124 * to the new fb and drop the reference to the old fb, if there is one. This
1125 * function takes care of all these details besides updating the pointer in the
1126 * state object itself.
1127 */
1128void
1129drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
1130 struct drm_framebuffer *fb)
1131{
1132 if (plane_state->fb)
1133 drm_framebuffer_unreference(plane_state->fb);
1134 if (fb)
1135 drm_framebuffer_reference(fb);
1136 plane_state->fb = fb;
1137
1138 if (fb)
17a38d9c
DV
1139 DRM_DEBUG_ATOMIC("Set [FB:%d] for plane state %p\n",
1140 fb->base.id, plane_state);
321ebf04 1141 else
17a38d9c
DV
1142 DRM_DEBUG_ATOMIC("Set [NOFB] for plane state %p\n",
1143 plane_state);
321ebf04
DV
1144}
1145EXPORT_SYMBOL(drm_atomic_set_fb_for_plane);
1146
cc4ceb48
DV
1147/**
1148 * drm_atomic_set_crtc_for_connector - set crtc for connector
1149 * @conn_state: atomic state object for the connector
1150 * @crtc: crtc to use for the connector
1151 *
1152 * Changing the assigned crtc for a connector requires us to grab the lock and
1153 * state for the new crtc, as needed. This function takes care of all these
1154 * details besides updating the pointer in the state object itself.
1155 *
1156 * Returns:
1157 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1158 * then the w/w mutex code has detected a deadlock and the entire atomic
1159 * sequence must be restarted. All other errors are fatal.
1160 */
1161int
1162drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
1163 struct drm_crtc *crtc)
1164{
1165 struct drm_crtc_state *crtc_state;
1166
e2d800a3
CW
1167 if (conn_state->crtc == crtc)
1168 return 0;
1169
1170 if (conn_state->crtc) {
4cd9fa52
ML
1171 crtc_state = drm_atomic_get_existing_crtc_state(conn_state->state,
1172 conn_state->crtc);
1173
1174 crtc_state->connector_mask &=
1175 ~(1 << drm_connector_index(conn_state->connector));
e2d800a3
CW
1176
1177 drm_connector_unreference(conn_state->connector);
1178 conn_state->crtc = NULL;
4cd9fa52
ML
1179 }
1180
cc4ceb48
DV
1181 if (crtc) {
1182 crtc_state = drm_atomic_get_crtc_state(conn_state->state, crtc);
1183 if (IS_ERR(crtc_state))
1184 return PTR_ERR(crtc_state);
4cd9fa52
ML
1185
1186 crtc_state->connector_mask |=
1187 1 << drm_connector_index(conn_state->connector);
cc4ceb48 1188
e2d800a3
CW
1189 drm_connector_reference(conn_state->connector);
1190 conn_state->crtc = crtc;
cc4ceb48 1191
fa3ab4c2
VS
1192 DRM_DEBUG_ATOMIC("Link connector state %p to [CRTC:%d:%s]\n",
1193 conn_state, crtc->base.id, crtc->name);
e2d800a3 1194 } else {
17a38d9c
DV
1195 DRM_DEBUG_ATOMIC("Link connector state %p to [NOCRTC]\n",
1196 conn_state);
e2d800a3 1197 }
cc4ceb48
DV
1198
1199 return 0;
1200}
1201EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
1202
1203/**
1204 * drm_atomic_add_affected_connectors - add connectors for crtc
1205 * @state: atomic state
1206 * @crtc: DRM crtc
1207 *
1208 * This function walks the current configuration and adds all connectors
1209 * currently using @crtc to the atomic configuration @state. Note that this
1210 * function must acquire the connection mutex. This can potentially cause
1211 * unneeded seralization if the update is just for the planes on one crtc. Hence
1212 * drivers and helpers should only call this when really needed (e.g. when a
1213 * full modeset needs to happen due to some change).
1214 *
1215 * Returns:
1216 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1217 * then the w/w mutex code has detected a deadlock and the entire atomic
1218 * sequence must be restarted. All other errors are fatal.
1219 */
1220int
1221drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
1222 struct drm_crtc *crtc)
1223{
1224 struct drm_mode_config *config = &state->dev->mode_config;
1225 struct drm_connector *connector;
1226 struct drm_connector_state *conn_state;
1227 int ret;
1228
1229 ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1230 if (ret)
1231 return ret;
1232
fa3ab4c2
VS
1233 DRM_DEBUG_ATOMIC("Adding all current connectors for [CRTC:%d:%s] to %p\n",
1234 crtc->base.id, crtc->name, state);
cc4ceb48
DV
1235
1236 /*
1237 * Changed connectors are already in @state, so only need to look at the
1238 * current configuration.
1239 */
9a9f5ce8 1240 drm_for_each_connector(connector, state->dev) {
cc4ceb48
DV
1241 if (connector->state->crtc != crtc)
1242 continue;
1243
1244 conn_state = drm_atomic_get_connector_state(state, connector);
1245 if (IS_ERR(conn_state))
1246 return PTR_ERR(conn_state);
1247 }
1248
1249 return 0;
1250}
1251EXPORT_SYMBOL(drm_atomic_add_affected_connectors);
1252
e01e9f75
ML
1253/**
1254 * drm_atomic_add_affected_planes - add planes for crtc
1255 * @state: atomic state
1256 * @crtc: DRM crtc
1257 *
1258 * This function walks the current configuration and adds all planes
1259 * currently used by @crtc to the atomic configuration @state. This is useful
1260 * when an atomic commit also needs to check all currently enabled plane on
1261 * @crtc, e.g. when changing the mode. It's also useful when re-enabling a CRTC
1262 * to avoid special code to force-enable all planes.
1263 *
1264 * Since acquiring a plane state will always also acquire the w/w mutex of the
1265 * current CRTC for that plane (if there is any) adding all the plane states for
1266 * a CRTC will not reduce parallism of atomic updates.
1267 *
1268 * Returns:
1269 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1270 * then the w/w mutex code has detected a deadlock and the entire atomic
1271 * sequence must be restarted. All other errors are fatal.
1272 */
1273int
1274drm_atomic_add_affected_planes(struct drm_atomic_state *state,
1275 struct drm_crtc *crtc)
1276{
1277 struct drm_plane *plane;
1278
1279 WARN_ON(!drm_atomic_get_existing_crtc_state(state, crtc));
1280
1281 drm_for_each_plane_mask(plane, state->dev, crtc->state->plane_mask) {
1282 struct drm_plane_state *plane_state =
1283 drm_atomic_get_plane_state(state, plane);
1284
1285 if (IS_ERR(plane_state))
1286 return PTR_ERR(plane_state);
1287 }
1288 return 0;
1289}
1290EXPORT_SYMBOL(drm_atomic_add_affected_planes);
1291
cc4ceb48
DV
1292/**
1293 * drm_atomic_legacy_backoff - locking backoff for legacy ioctls
1294 * @state: atomic state
1295 *
1296 * This function should be used by legacy entry points which don't understand
1297 * -EDEADLK semantics. For simplicity this one will grab all modeset locks after
16d78bc2 1298 * the slowpath completed.
cc4ceb48
DV
1299 */
1300void drm_atomic_legacy_backoff(struct drm_atomic_state *state)
1301{
81e257e9
ML
1302 struct drm_device *dev = state->dev;
1303 unsigned crtc_mask = 0;
1304 struct drm_crtc *crtc;
cc4ceb48 1305 int ret;
81e257e9
ML
1306 bool global = false;
1307
1308 drm_for_each_crtc(crtc, dev) {
1309 if (crtc->acquire_ctx != state->acquire_ctx)
1310 continue;
1311
1312 crtc_mask |= drm_crtc_mask(crtc);
1313 crtc->acquire_ctx = NULL;
1314 }
1315
1316 if (WARN_ON(dev->mode_config.acquire_ctx == state->acquire_ctx)) {
1317 global = true;
1318
1319 dev->mode_config.acquire_ctx = NULL;
1320 }
cc4ceb48
DV
1321
1322retry:
1323 drm_modeset_backoff(state->acquire_ctx);
1324
81e257e9 1325 ret = drm_modeset_lock_all_ctx(dev, state->acquire_ctx);
cc4ceb48
DV
1326 if (ret)
1327 goto retry;
81e257e9
ML
1328
1329 drm_for_each_crtc(crtc, dev)
1330 if (drm_crtc_mask(crtc) & crtc_mask)
1331 crtc->acquire_ctx = state->acquire_ctx;
1332
1333 if (global)
1334 dev->mode_config.acquire_ctx = state->acquire_ctx;
cc4ceb48
DV
1335}
1336EXPORT_SYMBOL(drm_atomic_legacy_backoff);
1337
1338/**
1339 * drm_atomic_check_only - check whether a given config would work
1340 * @state: atomic configuration to check
1341 *
1342 * Note that this function can return -EDEADLK if the driver needed to acquire
1343 * more locks but encountered a deadlock. The caller must then do the usual w/w
1344 * backoff dance and restart. All other errors are fatal.
1345 *
1346 * Returns:
1347 * 0 on success, negative error code on failure.
1348 */
1349int drm_atomic_check_only(struct drm_atomic_state *state)
1350{
5e743737
RC
1351 struct drm_device *dev = state->dev;
1352 struct drm_mode_config *config = &dev->mode_config;
df63b999
ACO
1353 struct drm_plane *plane;
1354 struct drm_plane_state *plane_state;
1355 struct drm_crtc *crtc;
1356 struct drm_crtc_state *crtc_state;
5e743737 1357 int i, ret = 0;
cc4ceb48 1358
17a38d9c 1359 DRM_DEBUG_ATOMIC("checking %p\n", state);
cc4ceb48 1360
df63b999
ACO
1361 for_each_plane_in_state(state, plane, plane_state, i) {
1362 ret = drm_atomic_plane_check(plane, plane_state);
5e743737 1363 if (ret) {
9f4c97a2
VS
1364 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic core check failed\n",
1365 plane->base.id, plane->name);
5e743737
RC
1366 return ret;
1367 }
1368 }
1369
df63b999
ACO
1370 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1371 ret = drm_atomic_crtc_check(crtc, crtc_state);
5e743737 1372 if (ret) {
fa3ab4c2
VS
1373 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic core check failed\n",
1374 crtc->base.id, crtc->name);
5e743737
RC
1375 return ret;
1376 }
1377 }
1378
cc4ceb48 1379 if (config->funcs->atomic_check)
5e743737
RC
1380 ret = config->funcs->atomic_check(state->dev, state);
1381
d34f20d6 1382 if (!state->allow_modeset) {
df63b999 1383 for_each_crtc_in_state(state, crtc, crtc_state, i) {
2465ff62 1384 if (drm_atomic_crtc_needs_modeset(crtc_state)) {
fa3ab4c2
VS
1385 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] requires full modeset\n",
1386 crtc->base.id, crtc->name);
d34f20d6
RC
1387 return -EINVAL;
1388 }
1389 }
1390 }
1391
5e743737 1392 return ret;
cc4ceb48
DV
1393}
1394EXPORT_SYMBOL(drm_atomic_check_only);
1395
1396/**
1397 * drm_atomic_commit - commit configuration atomically
1398 * @state: atomic configuration to check
1399 *
1400 * Note that this function can return -EDEADLK if the driver needed to acquire
1401 * more locks but encountered a deadlock. The caller must then do the usual w/w
1402 * backoff dance and restart. All other errors are fatal.
1403 *
1404 * Also note that on successful execution ownership of @state is transferred
1405 * from the caller of this function to the function itself. The caller must not
1406 * free or in any other way access @state. If the function fails then the caller
1407 * must clean up @state itself.
1408 *
1409 * Returns:
1410 * 0 on success, negative error code on failure.
1411 */
1412int drm_atomic_commit(struct drm_atomic_state *state)
1413{
1414 struct drm_mode_config *config = &state->dev->mode_config;
1415 int ret;
1416
1417 ret = drm_atomic_check_only(state);
1418 if (ret)
1419 return ret;
1420
17a38d9c 1421 DRM_DEBUG_ATOMIC("commiting %p\n", state);
cc4ceb48
DV
1422
1423 return config->funcs->atomic_commit(state->dev, state, false);
1424}
1425EXPORT_SYMBOL(drm_atomic_commit);
1426
1427/**
b837ba0a 1428 * drm_atomic_nonblocking_commit - atomic&nonblocking configuration commit
cc4ceb48
DV
1429 * @state: atomic configuration to check
1430 *
1431 * Note that this function can return -EDEADLK if the driver needed to acquire
1432 * more locks but encountered a deadlock. The caller must then do the usual w/w
1433 * backoff dance and restart. All other errors are fatal.
1434 *
1435 * Also note that on successful execution ownership of @state is transferred
1436 * from the caller of this function to the function itself. The caller must not
1437 * free or in any other way access @state. If the function fails then the caller
1438 * must clean up @state itself.
1439 *
1440 * Returns:
1441 * 0 on success, negative error code on failure.
1442 */
b837ba0a 1443int drm_atomic_nonblocking_commit(struct drm_atomic_state *state)
cc4ceb48
DV
1444{
1445 struct drm_mode_config *config = &state->dev->mode_config;
1446 int ret;
1447
1448 ret = drm_atomic_check_only(state);
1449 if (ret)
1450 return ret;
1451
b837ba0a 1452 DRM_DEBUG_ATOMIC("commiting %p nonblocking\n", state);
cc4ceb48
DV
1453
1454 return config->funcs->atomic_commit(state->dev, state, true);
1455}
b837ba0a 1456EXPORT_SYMBOL(drm_atomic_nonblocking_commit);
d34f20d6
RC
1457
1458/*
1459 * The big monstor ioctl
1460 */
1461
1462static struct drm_pending_vblank_event *create_vblank_event(
1b47aaf9
GP
1463 struct drm_device *dev, struct drm_file *file_priv,
1464 struct fence *fence, uint64_t user_data)
d34f20d6
RC
1465{
1466 struct drm_pending_vblank_event *e = NULL;
2dd500f1 1467 int ret;
d34f20d6
RC
1468
1469 e = kzalloc(sizeof *e, GFP_KERNEL);
2dd500f1
DV
1470 if (!e)
1471 return NULL;
d34f20d6
RC
1472
1473 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
2dd500f1 1474 e->event.base.length = sizeof(e->event);
d34f20d6 1475 e->event.user_data = user_data;
d34f20d6 1476
1b47aaf9
GP
1477 if (file_priv) {
1478 ret = drm_event_reserve_init(dev, file_priv, &e->base,
1479 &e->event.base);
1480 if (ret) {
1481 kfree(e);
1482 return NULL;
1483 }
2dd500f1 1484 }
d34f20d6 1485
1b47aaf9
GP
1486 e->base.fence = fence;
1487
2dd500f1 1488 return e;
d34f20d6
RC
1489}
1490
1491static int atomic_set_prop(struct drm_atomic_state *state,
1492 struct drm_mode_object *obj, struct drm_property *prop,
1493 uint64_t prop_value)
1494{
1495 struct drm_mode_object *ref;
1496 int ret;
1497
1498 if (!drm_property_change_valid_get(prop, prop_value, &ref))
1499 return -EINVAL;
1500
1501 switch (obj->type) {
1502 case DRM_MODE_OBJECT_CONNECTOR: {
1503 struct drm_connector *connector = obj_to_connector(obj);
1504 struct drm_connector_state *connector_state;
1505
1506 connector_state = drm_atomic_get_connector_state(state, connector);
1507 if (IS_ERR(connector_state)) {
1508 ret = PTR_ERR(connector_state);
1509 break;
1510 }
1511
1512 ret = drm_atomic_connector_set_property(connector,
1513 connector_state, prop, prop_value);
1514 break;
1515 }
1516 case DRM_MODE_OBJECT_CRTC: {
1517 struct drm_crtc *crtc = obj_to_crtc(obj);
1518 struct drm_crtc_state *crtc_state;
1519
1520 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1521 if (IS_ERR(crtc_state)) {
1522 ret = PTR_ERR(crtc_state);
1523 break;
1524 }
1525
1526 ret = drm_atomic_crtc_set_property(crtc,
1527 crtc_state, prop, prop_value);
1528 break;
1529 }
1530 case DRM_MODE_OBJECT_PLANE: {
1531 struct drm_plane *plane = obj_to_plane(obj);
1532 struct drm_plane_state *plane_state;
1533
1534 plane_state = drm_atomic_get_plane_state(state, plane);
1535 if (IS_ERR(plane_state)) {
1536 ret = PTR_ERR(plane_state);
1537 break;
1538 }
1539
1540 ret = drm_atomic_plane_set_property(plane,
1541 plane_state, prop, prop_value);
1542 break;
1543 }
1544 default:
1545 ret = -EINVAL;
1546 break;
1547 }
1548
1549 drm_property_change_valid_put(prop, ref);
1550 return ret;
1551}
1552
0f45c26f 1553/**
9744bf41 1554 * drm_atomic_clean_old_fb -- Unset old_fb pointers and set plane->fb pointers.
0f45c26f
ML
1555 *
1556 * @dev: drm device to check.
1557 * @plane_mask: plane mask for planes that were updated.
1558 * @ret: return value, can be -EDEADLK for a retry.
1559 *
1560 * Before doing an update plane->old_fb is set to plane->fb,
1561 * but before dropping the locks old_fb needs to be set to NULL
1562 * and plane->fb updated. This is a common operation for each
1563 * atomic update, so this call is split off as a helper.
1564 */
1565void drm_atomic_clean_old_fb(struct drm_device *dev,
1566 unsigned plane_mask,
1567 int ret)
1568{
1569 struct drm_plane *plane;
1570
1571 /* if succeeded, fixup legacy plane crtc/fb ptrs before dropping
1572 * locks (ie. while it is still safe to deref plane->state). We
1573 * need to do this here because the driver entry points cannot
1574 * distinguish between legacy and atomic ioctls.
1575 */
1576 drm_for_each_plane_mask(plane, dev, plane_mask) {
1577 if (ret == 0) {
1578 struct drm_framebuffer *new_fb = plane->state->fb;
1579 if (new_fb)
1580 drm_framebuffer_reference(new_fb);
1581 plane->fb = new_fb;
1582 plane->crtc = plane->state->crtc;
1583
1584 if (plane->old_fb)
1585 drm_framebuffer_unreference(plane->old_fb);
1586 }
1587 plane->old_fb = NULL;
1588 }
1589}
1590EXPORT_SYMBOL(drm_atomic_clean_old_fb);
1591
d34f20d6
RC
1592int drm_mode_atomic_ioctl(struct drm_device *dev,
1593 void *data, struct drm_file *file_priv)
1594{
1595 struct drm_mode_atomic *arg = data;
1596 uint32_t __user *objs_ptr = (uint32_t __user *)(unsigned long)(arg->objs_ptr);
1597 uint32_t __user *count_props_ptr = (uint32_t __user *)(unsigned long)(arg->count_props_ptr);
1598 uint32_t __user *props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
1599 uint64_t __user *prop_values_ptr = (uint64_t __user *)(unsigned long)(arg->prop_values_ptr);
1600 unsigned int copied_objs, copied_props;
1601 struct drm_atomic_state *state;
1602 struct drm_modeset_acquire_ctx ctx;
1603 struct drm_plane *plane;
df63b999
ACO
1604 struct drm_crtc *crtc;
1605 struct drm_crtc_state *crtc_state;
45723728 1606 unsigned plane_mask;
d34f20d6 1607 int ret = 0;
f92f053b 1608 unsigned int i, j;
d34f20d6
RC
1609
1610 /* disallow for drivers not supporting atomic: */
1611 if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1612 return -EINVAL;
1613
1614 /* disallow for userspace that has not enabled atomic cap (even
1615 * though this may be a bit overkill, since legacy userspace
1616 * wouldn't know how to call this ioctl)
1617 */
1618 if (!file_priv->atomic)
1619 return -EINVAL;
1620
1621 if (arg->flags & ~DRM_MODE_ATOMIC_FLAGS)
1622 return -EINVAL;
1623
1624 if (arg->reserved)
1625 return -EINVAL;
1626
1627 if ((arg->flags & DRM_MODE_PAGE_FLIP_ASYNC) &&
1628 !dev->mode_config.async_page_flip)
1629 return -EINVAL;
1630
1631 /* can't test and expect an event at the same time. */
1632 if ((arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) &&
1633 (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
1634 return -EINVAL;
1635
1636 drm_modeset_acquire_init(&ctx, 0);
1637
1638 state = drm_atomic_state_alloc(dev);
1639 if (!state)
1640 return -ENOMEM;
1641
1642 state->acquire_ctx = &ctx;
1643 state->allow_modeset = !!(arg->flags & DRM_MODE_ATOMIC_ALLOW_MODESET);
1644
1645retry:
45723728 1646 plane_mask = 0;
d34f20d6
RC
1647 copied_objs = 0;
1648 copied_props = 0;
1649
1650 for (i = 0; i < arg->count_objs; i++) {
1651 uint32_t obj_id, count_props;
1652 struct drm_mode_object *obj;
1653
1654 if (get_user(obj_id, objs_ptr + copied_objs)) {
1655 ret = -EFAULT;
ec9f932e 1656 goto out;
d34f20d6
RC
1657 }
1658
1659 obj = drm_mode_object_find(dev, obj_id, DRM_MODE_OBJECT_ANY);
b164d31f
DA
1660 if (!obj) {
1661 ret = -ENOENT;
1662 goto out;
1663 }
1664
1665 if (!obj->properties) {
1666 drm_mode_object_unreference(obj);
d34f20d6 1667 ret = -ENOENT;
ec9f932e 1668 goto out;
d34f20d6
RC
1669 }
1670
d34f20d6 1671 if (get_user(count_props, count_props_ptr + copied_objs)) {
b164d31f 1672 drm_mode_object_unreference(obj);
d34f20d6 1673 ret = -EFAULT;
ec9f932e 1674 goto out;
d34f20d6
RC
1675 }
1676
1677 copied_objs++;
1678
1679 for (j = 0; j < count_props; j++) {
1680 uint32_t prop_id;
1681 uint64_t prop_value;
1682 struct drm_property *prop;
1683
1684 if (get_user(prop_id, props_ptr + copied_props)) {
b164d31f 1685 drm_mode_object_unreference(obj);
d34f20d6 1686 ret = -EFAULT;
ec9f932e 1687 goto out;
d34f20d6
RC
1688 }
1689
f92f053b 1690 prop = drm_mode_obj_find_prop_id(obj, prop_id);
d34f20d6 1691 if (!prop) {
b164d31f 1692 drm_mode_object_unreference(obj);
d34f20d6 1693 ret = -ENOENT;
ec9f932e 1694 goto out;
d34f20d6
RC
1695 }
1696
42c5814c
GR
1697 if (copy_from_user(&prop_value,
1698 prop_values_ptr + copied_props,
1699 sizeof(prop_value))) {
b164d31f 1700 drm_mode_object_unreference(obj);
d34f20d6 1701 ret = -EFAULT;
ec9f932e 1702 goto out;
d34f20d6
RC
1703 }
1704
1705 ret = atomic_set_prop(state, obj, prop, prop_value);
b164d31f
DA
1706 if (ret) {
1707 drm_mode_object_unreference(obj);
ec9f932e 1708 goto out;
b164d31f 1709 }
d34f20d6
RC
1710
1711 copied_props++;
1712 }
a9cc54ee 1713
c4749c9a
ML
1714 if (obj->type == DRM_MODE_OBJECT_PLANE && count_props &&
1715 !(arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)) {
a9cc54ee
ML
1716 plane = obj_to_plane(obj);
1717 plane_mask |= (1 << drm_plane_index(plane));
1718 plane->old_fb = plane->fb;
1719 }
b164d31f 1720 drm_mode_object_unreference(obj);
d34f20d6
RC
1721 }
1722
1723 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
df63b999 1724 for_each_crtc_in_state(state, crtc, crtc_state, i) {
d34f20d6
RC
1725 struct drm_pending_vblank_event *e;
1726
1b47aaf9
GP
1727 e = create_vblank_event(dev, file_priv, NULL,
1728 arg->user_data);
d34f20d6
RC
1729 if (!e) {
1730 ret = -ENOMEM;
ec9f932e 1731 goto out;
d34f20d6
RC
1732 }
1733
1734 crtc_state->event = e;
1735 }
1736 }
1737
1738 if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) {
c4749c9a
ML
1739 /*
1740 * Unlike commit, check_only does not clean up state.
0853695c 1741 * Below we call drm_atomic_state_put for it.
c4749c9a 1742 */
d34f20d6 1743 ret = drm_atomic_check_only(state);
d34f20d6 1744 } else if (arg->flags & DRM_MODE_ATOMIC_NONBLOCK) {
b837ba0a 1745 ret = drm_atomic_nonblocking_commit(state);
d34f20d6
RC
1746 } else {
1747 ret = drm_atomic_commit(state);
1748 }
1749
ec9f932e 1750out:
0f45c26f 1751 drm_atomic_clean_old_fb(dev, plane_mask, ret);
d34f20d6 1752
c4749c9a
ML
1753 if (ret && arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1754 /*
1755 * TEST_ONLY and PAGE_FLIP_EVENT are mutually exclusive,
1756 * if they weren't, this code should be called on success
1757 * for TEST_ONLY too.
1758 */
1759
1760 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1761 if (!crtc_state->event)
1762 continue;
1763
2dd500f1 1764 drm_event_cancel_free(dev, &crtc_state->event->base);
c4749c9a
ML
1765 }
1766 }
1767
ec9f932e
ML
1768 if (ret == -EDEADLK) {
1769 drm_atomic_state_clear(state);
1770 drm_modeset_backoff(&ctx);
1771 goto retry;
1772 }
d34f20d6 1773
0853695c 1774 drm_atomic_state_put(state);
d34f20d6
RC
1775
1776 drm_modeset_drop_locks(&ctx);
1777 drm_modeset_acquire_fini(&ctx);
1778
1779 return ret;
d34f20d6 1780}