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