xref: /linux/drivers/gpu/drm/drm_atomic.c (revision 3f1c07fc21c68bd3bd2df9d2c9441f6485e934d9)
1 /*
2  * Copyright (C) 2014 Red Hat
3  * Copyright (C) 2014 Intel Corp.
4  * Copyright (c) 2020-2021, The Linux Foundation. All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors:
25  * Rob Clark <robdclark@gmail.com>
26  * Daniel Vetter <daniel.vetter@ffwll.ch>
27  */
28 
29 #include <linux/export.h>
30 #include <linux/sync_file.h>
31 
32 #include <drm/drm_atomic.h>
33 #include <drm/drm_atomic_uapi.h>
34 #include <drm/drm_blend.h>
35 #include <drm/drm_bridge.h>
36 #include <drm/drm_debugfs.h>
37 #include <drm/drm_device.h>
38 #include <drm/drm_drv.h>
39 #include <drm/drm_file.h>
40 #include <drm/drm_fourcc.h>
41 #include <drm/drm_framebuffer.h>
42 #include <drm/drm_mode.h>
43 #include <drm/drm_print.h>
44 #include <drm/drm_writeback.h>
45 #include <drm/drm_colorop.h>
46 
47 #include "drm_crtc_internal.h"
48 #include "drm_internal.h"
49 
__drm_crtc_commit_free(struct kref * kref)50 void __drm_crtc_commit_free(struct kref *kref)
51 {
52 	struct drm_crtc_commit *commit =
53 		container_of(kref, struct drm_crtc_commit, ref);
54 
55 	kfree(commit);
56 }
57 EXPORT_SYMBOL(__drm_crtc_commit_free);
58 
59 /**
60  * drm_crtc_commit_wait - Waits for a commit to complete
61  * @commit: &drm_crtc_commit to wait for
62  *
63  * Waits for a given &drm_crtc_commit to be programmed into the
64  * hardware and flipped to.
65  *
66  * Returns:
67  * 0 on success, a negative error code otherwise.
68  */
drm_crtc_commit_wait(struct drm_crtc_commit * commit)69 int drm_crtc_commit_wait(struct drm_crtc_commit *commit)
70 {
71 	unsigned long timeout = 10 * HZ;
72 	int ret;
73 
74 	if (!commit)
75 		return 0;
76 
77 	ret = wait_for_completion_timeout(&commit->hw_done, timeout);
78 	if (!ret) {
79 		drm_err(commit->crtc->dev, "hw_done timed out\n");
80 		return -ETIMEDOUT;
81 	}
82 
83 	/*
84 	 * Currently no support for overwriting flips, hence
85 	 * stall for previous one to execute completely.
86 	 */
87 	ret = wait_for_completion_timeout(&commit->flip_done, timeout);
88 	if (!ret) {
89 		drm_err(commit->crtc->dev, "flip_done timed out\n");
90 		return -ETIMEDOUT;
91 	}
92 
93 	return 0;
94 }
95 EXPORT_SYMBOL(drm_crtc_commit_wait);
96 
97 /**
98  * drm_atomic_state_default_release -
99  * release memory initialized by drm_atomic_state_init
100  * @state: atomic state
101  *
102  * Free all the memory allocated by drm_atomic_state_init.
103  * This should only be used by drivers which are still subclassing
104  * &drm_atomic_state and haven't switched to &drm_private_state yet.
105  */
drm_atomic_state_default_release(struct drm_atomic_state * state)106 void drm_atomic_state_default_release(struct drm_atomic_state *state)
107 {
108 	kfree(state->connectors);
109 	kfree(state->crtcs);
110 	kfree(state->planes);
111 	kfree(state->colorops);
112 	kfree(state->private_objs);
113 }
114 EXPORT_SYMBOL(drm_atomic_state_default_release);
115 
116 /**
117  * drm_atomic_state_init - init new atomic state
118  * @dev: DRM device
119  * @state: atomic state
120  *
121  * Default implementation for filling in a new atomic state.
122  * This should only be used by drivers which are still subclassing
123  * &drm_atomic_state and haven't switched to &drm_private_state yet.
124  */
125 int
drm_atomic_state_init(struct drm_device * dev,struct drm_atomic_state * state)126 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)
127 {
128 	kref_init(&state->ref);
129 
130 	/* TODO legacy paths should maybe do a better job about
131 	 * setting this appropriately?
132 	 */
133 	state->allow_modeset = true;
134 
135 	state->crtcs = kcalloc(dev->mode_config.num_crtc,
136 			       sizeof(*state->crtcs), GFP_KERNEL);
137 	if (!state->crtcs)
138 		goto fail;
139 	state->planes = kcalloc(dev->mode_config.num_total_plane,
140 				sizeof(*state->planes), GFP_KERNEL);
141 	if (!state->planes)
142 		goto fail;
143 	state->colorops = kcalloc(dev->mode_config.num_colorop,
144 				  sizeof(*state->colorops), GFP_KERNEL);
145 	if (!state->colorops)
146 		goto fail;
147 
148 	/*
149 	 * Because drm_atomic_state can be committed asynchronously we need our
150 	 * own reference and cannot rely on the on implied by drm_file in the
151 	 * ioctl call.
152 	 */
153 	drm_dev_get(dev);
154 	state->dev = dev;
155 
156 	drm_dbg_atomic(dev, "Allocated atomic state %p\n", state);
157 
158 	return 0;
159 fail:
160 	drm_atomic_state_default_release(state);
161 	return -ENOMEM;
162 }
163 EXPORT_SYMBOL(drm_atomic_state_init);
164 
165 /**
166  * drm_atomic_state_alloc - allocate atomic state
167  * @dev: DRM device
168  *
169  * This allocates an empty atomic state to track updates.
170  */
171 struct drm_atomic_state *
drm_atomic_state_alloc(struct drm_device * dev)172 drm_atomic_state_alloc(struct drm_device *dev)
173 {
174 	struct drm_mode_config *config = &dev->mode_config;
175 
176 	if (!config->funcs->atomic_state_alloc) {
177 		struct drm_atomic_state *state;
178 
179 		state = kzalloc(sizeof(*state), GFP_KERNEL);
180 		if (!state)
181 			return NULL;
182 		if (drm_atomic_state_init(dev, state) < 0) {
183 			kfree(state);
184 			return NULL;
185 		}
186 		return state;
187 	}
188 
189 	return config->funcs->atomic_state_alloc(dev);
190 }
191 EXPORT_SYMBOL(drm_atomic_state_alloc);
192 
193 /**
194  * drm_atomic_state_default_clear - clear base atomic state
195  * @state: atomic state
196  *
197  * Default implementation for clearing atomic state.
198  * This should only be used by drivers which are still subclassing
199  * &drm_atomic_state and haven't switched to &drm_private_state yet.
200  */
drm_atomic_state_default_clear(struct drm_atomic_state * state)201 void drm_atomic_state_default_clear(struct drm_atomic_state *state)
202 {
203 	struct drm_device *dev = state->dev;
204 	struct drm_mode_config *config = &dev->mode_config;
205 	int i;
206 
207 	drm_dbg_atomic(dev, "Clearing atomic state %p\n", state);
208 
209 	state->checked = false;
210 
211 	for (i = 0; i < state->num_connector; i++) {
212 		struct drm_connector *connector = state->connectors[i].ptr;
213 
214 		if (!connector)
215 			continue;
216 
217 		connector->funcs->atomic_destroy_state(connector,
218 						       state->connectors[i].state_to_destroy);
219 		state->connectors[i].ptr = NULL;
220 		state->connectors[i].state_to_destroy = NULL;
221 		state->connectors[i].old_state = NULL;
222 		state->connectors[i].new_state = NULL;
223 		drm_connector_put(connector);
224 	}
225 
226 	for (i = 0; i < config->num_crtc; i++) {
227 		struct drm_crtc *crtc = state->crtcs[i].ptr;
228 
229 		if (!crtc)
230 			continue;
231 
232 		crtc->funcs->atomic_destroy_state(crtc,
233 						  state->crtcs[i].state_to_destroy);
234 
235 		state->crtcs[i].ptr = NULL;
236 		state->crtcs[i].state_to_destroy = NULL;
237 		state->crtcs[i].old_state = NULL;
238 		state->crtcs[i].new_state = NULL;
239 
240 		if (state->crtcs[i].commit) {
241 			drm_crtc_commit_put(state->crtcs[i].commit);
242 			state->crtcs[i].commit = NULL;
243 		}
244 	}
245 
246 	for (i = 0; i < config->num_total_plane; i++) {
247 		struct drm_plane *plane = state->planes[i].ptr;
248 
249 		if (!plane)
250 			continue;
251 
252 		plane->funcs->atomic_destroy_state(plane,
253 						   state->planes[i].state_to_destroy);
254 		state->planes[i].ptr = NULL;
255 		state->planes[i].state_to_destroy = NULL;
256 		state->planes[i].old_state = NULL;
257 		state->planes[i].new_state = NULL;
258 	}
259 
260 	for (i = 0; i < config->num_colorop; i++) {
261 		struct drm_colorop *colorop = state->colorops[i].ptr;
262 
263 		if (!colorop)
264 			continue;
265 
266 		drm_colorop_atomic_destroy_state(colorop,
267 						 state->colorops[i].state);
268 		state->colorops[i].ptr = NULL;
269 		state->colorops[i].state = NULL;
270 		state->colorops[i].old_state = NULL;
271 		state->colorops[i].new_state = NULL;
272 	}
273 
274 	for (i = 0; i < state->num_private_objs; i++) {
275 		struct drm_private_obj *obj = state->private_objs[i].ptr;
276 
277 		obj->funcs->atomic_destroy_state(obj,
278 						 state->private_objs[i].state_to_destroy);
279 		state->private_objs[i].ptr = NULL;
280 		state->private_objs[i].state_to_destroy = NULL;
281 		state->private_objs[i].old_state = NULL;
282 		state->private_objs[i].new_state = NULL;
283 	}
284 	state->num_private_objs = 0;
285 
286 	if (state->fake_commit) {
287 		drm_crtc_commit_put(state->fake_commit);
288 		state->fake_commit = NULL;
289 	}
290 }
291 EXPORT_SYMBOL(drm_atomic_state_default_clear);
292 
293 /**
294  * drm_atomic_state_clear - clear state object
295  * @state: atomic state
296  *
297  * When the w/w mutex algorithm detects a deadlock we need to back off and drop
298  * all locks. So someone else could sneak in and change the current modeset
299  * configuration. Which means that all the state assembled in @state is no
300  * longer an atomic update to the current state, but to some arbitrary earlier
301  * state. Which could break assumptions the driver's
302  * &drm_mode_config_funcs.atomic_check likely relies on.
303  *
304  * Hence we must clear all cached state and completely start over, using this
305  * function.
306  */
drm_atomic_state_clear(struct drm_atomic_state * state)307 void drm_atomic_state_clear(struct drm_atomic_state *state)
308 {
309 	struct drm_device *dev = state->dev;
310 	struct drm_mode_config *config = &dev->mode_config;
311 
312 	if (config->funcs->atomic_state_clear)
313 		config->funcs->atomic_state_clear(state);
314 	else
315 		drm_atomic_state_default_clear(state);
316 }
317 EXPORT_SYMBOL(drm_atomic_state_clear);
318 
319 /**
320  * __drm_atomic_state_free - free all memory for an atomic state
321  * @ref: This atomic state to deallocate
322  *
323  * This frees all memory associated with an atomic state, including all the
324  * per-object state for planes, CRTCs and connectors.
325  */
__drm_atomic_state_free(struct kref * ref)326 void __drm_atomic_state_free(struct kref *ref)
327 {
328 	struct drm_atomic_state *state = container_of(ref, typeof(*state), ref);
329 	struct drm_device *dev = state->dev;
330 	struct drm_mode_config *config = &dev->mode_config;
331 
332 	drm_atomic_state_clear(state);
333 
334 	drm_dbg_atomic(state->dev, "Freeing atomic state %p\n", state);
335 
336 	if (config->funcs->atomic_state_free) {
337 		config->funcs->atomic_state_free(state);
338 	} else {
339 		drm_atomic_state_default_release(state);
340 		kfree(state);
341 	}
342 
343 	drm_dev_put(dev);
344 }
345 EXPORT_SYMBOL(__drm_atomic_state_free);
346 
347 /**
348  * drm_atomic_get_crtc_state - get CRTC state
349  * @state: global atomic state object
350  * @crtc: CRTC to get state object for
351  *
352  * This function returns the CRTC state for the given CRTC, allocating it if
353  * needed. It will also grab the relevant CRTC lock to make sure that the state
354  * is consistent.
355  *
356  * WARNING: Drivers may only add new CRTC states to a @state if
357  * drm_atomic_state.allow_modeset is set, or if it's a driver-internal commit
358  * not created by userspace through an IOCTL call.
359  *
360  * Returns:
361  * Either the allocated state or the error code encoded into the pointer. When
362  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
363  * entire atomic sequence must be restarted. All other errors are fatal.
364  */
365 struct drm_crtc_state *
drm_atomic_get_crtc_state(struct drm_atomic_state * state,struct drm_crtc * crtc)366 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
367 			  struct drm_crtc *crtc)
368 {
369 	int ret, index = drm_crtc_index(crtc);
370 	struct drm_crtc_state *crtc_state;
371 
372 	WARN_ON(!state->acquire_ctx);
373 	drm_WARN_ON(state->dev, state->checked);
374 
375 	crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
376 	if (crtc_state)
377 		return crtc_state;
378 
379 	ret = drm_modeset_lock(&crtc->mutex, state->acquire_ctx);
380 	if (ret)
381 		return ERR_PTR(ret);
382 
383 	crtc_state = crtc->funcs->atomic_duplicate_state(crtc);
384 	if (!crtc_state)
385 		return ERR_PTR(-ENOMEM);
386 
387 	state->crtcs[index].state_to_destroy = crtc_state;
388 	state->crtcs[index].old_state = crtc->state;
389 	state->crtcs[index].new_state = crtc_state;
390 	state->crtcs[index].ptr = crtc;
391 	crtc_state->state = state;
392 
393 	drm_dbg_atomic(state->dev, "Added [CRTC:%d:%s] %p state to %p\n",
394 		       crtc->base.id, crtc->name, crtc_state, state);
395 
396 	return crtc_state;
397 }
398 EXPORT_SYMBOL(drm_atomic_get_crtc_state);
399 
drm_atomic_crtc_check(const struct drm_crtc_state * old_crtc_state,const struct drm_crtc_state * new_crtc_state)400 static int drm_atomic_crtc_check(const struct drm_crtc_state *old_crtc_state,
401 				 const struct drm_crtc_state *new_crtc_state)
402 {
403 	struct drm_crtc *crtc = new_crtc_state->crtc;
404 
405 	/* NOTE: we explicitly don't enforce constraints such as primary
406 	 * layer covering entire screen, since that is something we want
407 	 * to allow (on hw that supports it).  For hw that does not, it
408 	 * should be checked in driver's crtc->atomic_check() vfunc.
409 	 *
410 	 * TODO: Add generic modeset state checks once we support those.
411 	 */
412 
413 	if (new_crtc_state->active && !new_crtc_state->enable) {
414 		drm_dbg_atomic(crtc->dev,
415 			       "[CRTC:%d:%s] active without enabled\n",
416 			       crtc->base.id, crtc->name);
417 		return -EINVAL;
418 	}
419 
420 	/* The state->enable vs. state->mode_blob checks can be WARN_ON,
421 	 * as this is a kernel-internal detail that userspace should never
422 	 * be able to trigger.
423 	 */
424 	if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
425 	    WARN_ON(new_crtc_state->enable && !new_crtc_state->mode_blob)) {
426 		drm_dbg_atomic(crtc->dev,
427 			       "[CRTC:%d:%s] enabled without mode blob\n",
428 			       crtc->base.id, crtc->name);
429 		return -EINVAL;
430 	}
431 
432 	if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
433 	    WARN_ON(!new_crtc_state->enable && new_crtc_state->mode_blob)) {
434 		drm_dbg_atomic(crtc->dev,
435 			       "[CRTC:%d:%s] disabled with mode blob\n",
436 			       crtc->base.id, crtc->name);
437 		return -EINVAL;
438 	}
439 
440 	/*
441 	 * Reject event generation for when a CRTC is off and stays off.
442 	 * It wouldn't be hard to implement this, but userspace has a track
443 	 * record of happily burning through 100% cpu (or worse, crash) when the
444 	 * display pipe is suspended. To avoid all that fun just reject updates
445 	 * that ask for events since likely that indicates a bug in the
446 	 * compositor's drawing loop. This is consistent with the vblank IOCTL
447 	 * and legacy page_flip IOCTL which also reject service on a disabled
448 	 * pipe.
449 	 */
450 	if (new_crtc_state->event &&
451 	    !new_crtc_state->active && !old_crtc_state->active) {
452 		drm_dbg_atomic(crtc->dev,
453 			       "[CRTC:%d:%s] requesting event but off\n",
454 			       crtc->base.id, crtc->name);
455 		return -EINVAL;
456 	}
457 
458 	return 0;
459 }
460 
drm_atomic_crtc_print_state(struct drm_printer * p,const struct drm_crtc_state * state)461 static void drm_atomic_crtc_print_state(struct drm_printer *p,
462 		const struct drm_crtc_state *state)
463 {
464 	struct drm_crtc *crtc = state->crtc;
465 
466 	drm_printf(p, "crtc[%u]: %s\n", crtc->base.id, crtc->name);
467 	drm_printf(p, "\tenable=%d\n", state->enable);
468 	drm_printf(p, "\tactive=%d\n", state->active);
469 	drm_printf(p, "\tself_refresh_active=%d\n", state->self_refresh_active);
470 	drm_printf(p, "\tplanes_changed=%d\n", state->planes_changed);
471 	drm_printf(p, "\tmode_changed=%d\n", state->mode_changed);
472 	drm_printf(p, "\tactive_changed=%d\n", state->active_changed);
473 	drm_printf(p, "\tconnectors_changed=%d\n", state->connectors_changed);
474 	drm_printf(p, "\tcolor_mgmt_changed=%d\n", state->color_mgmt_changed);
475 	drm_printf(p, "\tplane_mask=%x\n", state->plane_mask);
476 	drm_printf(p, "\tconnector_mask=%x\n", state->connector_mask);
477 	drm_printf(p, "\tencoder_mask=%x\n", state->encoder_mask);
478 	drm_printf(p, "\tmode: " DRM_MODE_FMT "\n", DRM_MODE_ARG(&state->mode));
479 
480 	if (crtc->funcs->atomic_print_state)
481 		crtc->funcs->atomic_print_state(p, state);
482 }
483 
drm_atomic_connector_check(struct drm_connector * connector,struct drm_connector_state * state)484 static int drm_atomic_connector_check(struct drm_connector *connector,
485 		struct drm_connector_state *state)
486 {
487 	struct drm_crtc_state *crtc_state;
488 	struct drm_writeback_job *writeback_job = state->writeback_job;
489 	const struct drm_display_info *info = &connector->display_info;
490 
491 	state->max_bpc = info->bpc ? info->bpc : 8;
492 	if (connector->max_bpc_property)
493 		state->max_bpc = min(state->max_bpc, state->max_requested_bpc);
494 
495 	if ((connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK) || !writeback_job)
496 		return 0;
497 
498 	if (writeback_job->fb && !state->crtc) {
499 		drm_dbg_atomic(connector->dev,
500 			       "[CONNECTOR:%d:%s] framebuffer without CRTC\n",
501 			       connector->base.id, connector->name);
502 		return -EINVAL;
503 	}
504 
505 	if (state->crtc)
506 		crtc_state = drm_atomic_get_new_crtc_state(state->state,
507 							   state->crtc);
508 
509 	if (writeback_job->fb && !crtc_state->active) {
510 		drm_dbg_atomic(connector->dev,
511 			       "[CONNECTOR:%d:%s] has framebuffer, but [CRTC:%d] is off\n",
512 			       connector->base.id, connector->name,
513 			       state->crtc->base.id);
514 		return -EINVAL;
515 	}
516 
517 	if (!writeback_job->fb) {
518 		if (writeback_job->out_fence) {
519 			drm_dbg_atomic(connector->dev,
520 				       "[CONNECTOR:%d:%s] requesting out-fence without framebuffer\n",
521 				       connector->base.id, connector->name);
522 			return -EINVAL;
523 		}
524 
525 		drm_writeback_cleanup_job(writeback_job);
526 		state->writeback_job = NULL;
527 	}
528 
529 	return 0;
530 }
531 
532 /**
533  * drm_atomic_get_plane_state - get plane state
534  * @state: global atomic state object
535  * @plane: plane to get state object for
536  *
537  * This function returns the plane state for the given plane, allocating it if
538  * needed. It will also grab the relevant plane lock to make sure that the state
539  * is consistent.
540  *
541  * Returns:
542  * Either the allocated state or the error code encoded into the pointer. When
543  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
544  * entire atomic sequence must be restarted. All other errors are fatal.
545  */
546 struct drm_plane_state *
drm_atomic_get_plane_state(struct drm_atomic_state * state,struct drm_plane * plane)547 drm_atomic_get_plane_state(struct drm_atomic_state *state,
548 			  struct drm_plane *plane)
549 {
550 	int ret, index = drm_plane_index(plane);
551 	struct drm_plane_state *plane_state;
552 
553 	WARN_ON(!state->acquire_ctx);
554 	drm_WARN_ON(state->dev, state->checked);
555 
556 	/* the legacy pointers should never be set */
557 	WARN_ON(plane->fb);
558 	WARN_ON(plane->old_fb);
559 	WARN_ON(plane->crtc);
560 
561 	plane_state = drm_atomic_get_new_plane_state(state, plane);
562 	if (plane_state)
563 		return plane_state;
564 
565 	ret = drm_modeset_lock(&plane->mutex, state->acquire_ctx);
566 	if (ret)
567 		return ERR_PTR(ret);
568 
569 	plane_state = plane->funcs->atomic_duplicate_state(plane);
570 	if (!plane_state)
571 		return ERR_PTR(-ENOMEM);
572 
573 	state->planes[index].state_to_destroy = plane_state;
574 	state->planes[index].ptr = plane;
575 	state->planes[index].old_state = plane->state;
576 	state->planes[index].new_state = plane_state;
577 	plane_state->state = state;
578 
579 	drm_dbg_atomic(plane->dev, "Added [PLANE:%d:%s] %p state to %p\n",
580 		       plane->base.id, plane->name, plane_state, state);
581 
582 	if (plane_state->crtc) {
583 		struct drm_crtc_state *crtc_state;
584 
585 		crtc_state = drm_atomic_get_crtc_state(state,
586 						       plane_state->crtc);
587 		if (IS_ERR(crtc_state))
588 			return ERR_CAST(crtc_state);
589 	}
590 
591 	return plane_state;
592 }
593 EXPORT_SYMBOL(drm_atomic_get_plane_state);
594 
595 /**
596  * drm_atomic_get_colorop_state - get colorop state
597  * @state: global atomic state object
598  * @colorop: colorop to get state object for
599  *
600  * This function returns the colorop state for the given colorop, allocating it
601  * if needed. It will also grab the relevant plane lock to make sure that the
602  * state is consistent.
603  *
604  * Returns:
605  *
606  * Either the allocated state or the error code encoded into the pointer. When
607  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
608  * entire atomic sequence must be restarted. All other errors are fatal.
609  */
610 struct drm_colorop_state *
drm_atomic_get_colorop_state(struct drm_atomic_state * state,struct drm_colorop * colorop)611 drm_atomic_get_colorop_state(struct drm_atomic_state *state,
612 			     struct drm_colorop *colorop)
613 {
614 	int ret, index = drm_colorop_index(colorop);
615 	struct drm_colorop_state *colorop_state;
616 
617 	WARN_ON(!state->acquire_ctx);
618 
619 	colorop_state = drm_atomic_get_new_colorop_state(state, colorop);
620 	if (colorop_state)
621 		return colorop_state;
622 
623 	ret = drm_modeset_lock(&colorop->plane->mutex, state->acquire_ctx);
624 	if (ret)
625 		return ERR_PTR(ret);
626 
627 	colorop_state = drm_atomic_helper_colorop_duplicate_state(colorop);
628 	if (!colorop_state)
629 		return ERR_PTR(-ENOMEM);
630 
631 	state->colorops[index].state = colorop_state;
632 	state->colorops[index].ptr = colorop;
633 	state->colorops[index].old_state = colorop->state;
634 	state->colorops[index].new_state = colorop_state;
635 	colorop_state->state = state;
636 
637 	drm_dbg_atomic(colorop->dev, "Added [COLOROP:%d:%d] %p state to %p\n",
638 		       colorop->base.id, colorop->type, colorop_state, state);
639 
640 	return colorop_state;
641 }
642 EXPORT_SYMBOL(drm_atomic_get_colorop_state);
643 
644 static bool
plane_switching_crtc(const struct drm_plane_state * old_plane_state,const struct drm_plane_state * new_plane_state)645 plane_switching_crtc(const struct drm_plane_state *old_plane_state,
646 		     const struct drm_plane_state *new_plane_state)
647 {
648 	if (!old_plane_state->crtc || !new_plane_state->crtc)
649 		return false;
650 
651 	if (old_plane_state->crtc == new_plane_state->crtc)
652 		return false;
653 
654 	/* This could be refined, but currently there's no helper or driver code
655 	 * to implement direct switching of active planes nor userspace to take
656 	 * advantage of more direct plane switching without the intermediate
657 	 * full OFF state.
658 	 */
659 	return true;
660 }
661 
662 /**
663  * drm_atomic_plane_check - check plane state
664  * @old_plane_state: old plane state to check
665  * @new_plane_state: new plane state to check
666  *
667  * Provides core sanity checks for plane state.
668  *
669  * RETURNS:
670  * Zero on success, error code on failure
671  */
drm_atomic_plane_check(const struct drm_plane_state * old_plane_state,const struct drm_plane_state * new_plane_state)672 static int drm_atomic_plane_check(const struct drm_plane_state *old_plane_state,
673 				  const struct drm_plane_state *new_plane_state)
674 {
675 	struct drm_plane *plane = new_plane_state->plane;
676 	struct drm_crtc *crtc = new_plane_state->crtc;
677 	const struct drm_framebuffer *fb = new_plane_state->fb;
678 	unsigned int fb_width, fb_height;
679 	struct drm_mode_rect *clips;
680 	uint32_t num_clips;
681 
682 	/* either *both* CRTC and FB must be set, or neither */
683 	if (crtc && !fb) {
684 		drm_dbg_atomic(plane->dev, "[PLANE:%d:%s] CRTC set but no FB\n",
685 			       plane->base.id, plane->name);
686 		return -EINVAL;
687 	} else if (fb && !crtc) {
688 		drm_dbg_atomic(plane->dev, "[PLANE:%d:%s] FB set but no CRTC\n",
689 			       plane->base.id, plane->name);
690 		return -EINVAL;
691 	}
692 
693 	/* if disabled, we don't care about the rest of the state: */
694 	if (!crtc)
695 		return 0;
696 
697 	/* Check whether this plane is usable on this CRTC */
698 	if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
699 		drm_dbg_atomic(plane->dev,
700 			       "Invalid [CRTC:%d:%s] for [PLANE:%d:%s]\n",
701 			       crtc->base.id, crtc->name,
702 			       plane->base.id, plane->name);
703 		return -EINVAL;
704 	}
705 
706 	/* Check whether this plane supports the fb pixel format. */
707 	if (!drm_plane_has_format(plane, fb->format->format, fb->modifier)) {
708 		drm_dbg_atomic(plane->dev,
709 			       "[PLANE:%d:%s] invalid pixel format %p4cc, modifier 0x%llx\n",
710 			       plane->base.id, plane->name,
711 			       &fb->format->format, fb->modifier);
712 		return -EINVAL;
713 	}
714 
715 	/* Give drivers some help against integer overflows */
716 	if (new_plane_state->crtc_w > INT_MAX ||
717 	    new_plane_state->crtc_x > INT_MAX - (int32_t) new_plane_state->crtc_w ||
718 	    new_plane_state->crtc_h > INT_MAX ||
719 	    new_plane_state->crtc_y > INT_MAX - (int32_t) new_plane_state->crtc_h) {
720 		drm_dbg_atomic(plane->dev,
721 			       "[PLANE:%d:%s] invalid CRTC coordinates %ux%u+%d+%d\n",
722 			       plane->base.id, plane->name,
723 			       new_plane_state->crtc_w, new_plane_state->crtc_h,
724 			       new_plane_state->crtc_x, new_plane_state->crtc_y);
725 		return -ERANGE;
726 	}
727 
728 	fb_width = fb->width << 16;
729 	fb_height = fb->height << 16;
730 
731 	/* Make sure source coordinates are inside the fb. */
732 	if (new_plane_state->src_w > fb_width ||
733 	    new_plane_state->src_x > fb_width - new_plane_state->src_w ||
734 	    new_plane_state->src_h > fb_height ||
735 	    new_plane_state->src_y > fb_height - new_plane_state->src_h) {
736 		drm_dbg_atomic(plane->dev,
737 			       "[PLANE:%d:%s] invalid source coordinates "
738 			       "%u.%06ux%u.%06u+%u.%06u+%u.%06u (fb %ux%u)\n",
739 			       plane->base.id, plane->name,
740 			       new_plane_state->src_w >> 16,
741 			       ((new_plane_state->src_w & 0xffff) * 15625) >> 10,
742 			       new_plane_state->src_h >> 16,
743 			       ((new_plane_state->src_h & 0xffff) * 15625) >> 10,
744 			       new_plane_state->src_x >> 16,
745 			       ((new_plane_state->src_x & 0xffff) * 15625) >> 10,
746 			       new_plane_state->src_y >> 16,
747 			       ((new_plane_state->src_y & 0xffff) * 15625) >> 10,
748 			       fb->width, fb->height);
749 		return -ENOSPC;
750 	}
751 
752 	clips = __drm_plane_get_damage_clips(new_plane_state);
753 	num_clips = drm_plane_get_damage_clips_count(new_plane_state);
754 
755 	/* Make sure damage clips are valid and inside the fb. */
756 	while (num_clips > 0) {
757 		if (clips->x1 >= clips->x2 ||
758 		    clips->y1 >= clips->y2 ||
759 		    clips->x1 < 0 ||
760 		    clips->y1 < 0 ||
761 		    clips->x2 > fb_width ||
762 		    clips->y2 > fb_height) {
763 			drm_dbg_atomic(plane->dev,
764 				       "[PLANE:%d:%s] invalid damage clip %d %d %d %d\n",
765 				       plane->base.id, plane->name, clips->x1,
766 				       clips->y1, clips->x2, clips->y2);
767 			return -EINVAL;
768 		}
769 		clips++;
770 		num_clips--;
771 	}
772 
773 	if (plane_switching_crtc(old_plane_state, new_plane_state)) {
774 		drm_dbg_atomic(plane->dev,
775 			       "[PLANE:%d:%s] switching CRTC directly\n",
776 			       plane->base.id, plane->name);
777 		return -EINVAL;
778 	}
779 
780 	return 0;
781 }
782 
drm_atomic_colorop_print_state(struct drm_printer * p,const struct drm_colorop_state * state)783 static void drm_atomic_colorop_print_state(struct drm_printer *p,
784 					   const struct drm_colorop_state *state)
785 {
786 	struct drm_colorop *colorop = state->colorop;
787 
788 	drm_printf(p, "colorop[%u]:\n", colorop->base.id);
789 	drm_printf(p, "\ttype=%s\n", drm_get_colorop_type_name(colorop->type));
790 	if (colorop->bypass_property)
791 		drm_printf(p, "\tbypass=%u\n", state->bypass);
792 
793 	switch (colorop->type) {
794 	case DRM_COLOROP_1D_CURVE:
795 		drm_printf(p, "\tcurve_1d_type=%s\n",
796 			   drm_get_colorop_curve_1d_type_name(state->curve_1d_type));
797 		break;
798 	case DRM_COLOROP_1D_LUT:
799 		drm_printf(p, "\tsize=%d\n", colorop->size);
800 		drm_printf(p, "\tinterpolation=%s\n",
801 			   drm_get_colorop_lut1d_interpolation_name(colorop->lut1d_interpolation));
802 		drm_printf(p, "\tdata blob id=%d\n", state->data ? state->data->base.id : 0);
803 		break;
804 	case DRM_COLOROP_CTM_3X4:
805 		drm_printf(p, "\tdata blob id=%d\n", state->data ? state->data->base.id : 0);
806 		break;
807 	case DRM_COLOROP_MULTIPLIER:
808 		drm_printf(p, "\tmultiplier=%llu\n", state->multiplier);
809 		break;
810 	case DRM_COLOROP_3D_LUT:
811 		drm_printf(p, "\tsize=%d\n", colorop->size);
812 		drm_printf(p, "\tinterpolation=%s\n",
813 			   drm_get_colorop_lut3d_interpolation_name(colorop->lut3d_interpolation));
814 		drm_printf(p, "\tdata blob id=%d\n", state->data ? state->data->base.id : 0);
815 		break;
816 	default:
817 		break;
818 	}
819 
820 	drm_printf(p, "\tnext=%d\n", colorop->next ? colorop->next->base.id : 0);
821 }
822 
drm_atomic_plane_print_state(struct drm_printer * p,const struct drm_plane_state * state)823 static void drm_atomic_plane_print_state(struct drm_printer *p,
824 		const struct drm_plane_state *state)
825 {
826 	struct drm_plane *plane = state->plane;
827 	struct drm_rect src  = drm_plane_state_src(state);
828 	struct drm_rect dest = drm_plane_state_dest(state);
829 
830 	drm_printf(p, "plane[%u]: %s\n", plane->base.id, plane->name);
831 	drm_printf(p, "\tcrtc=%s\n", state->crtc ? state->crtc->name : "(null)");
832 	drm_printf(p, "\tfb=%u\n", state->fb ? state->fb->base.id : 0);
833 	if (state->fb)
834 		drm_framebuffer_print_info(p, 2, state->fb);
835 	drm_printf(p, "\tcrtc-pos=" DRM_RECT_FMT "\n", DRM_RECT_ARG(&dest));
836 	drm_printf(p, "\tsrc-pos=" DRM_RECT_FP_FMT "\n", DRM_RECT_FP_ARG(&src));
837 	drm_printf(p, "\trotation=%x\n", state->rotation);
838 	drm_printf(p, "\tnormalized-zpos=%x\n", state->normalized_zpos);
839 	drm_printf(p, "\tcolor-encoding=%s\n",
840 		   drm_get_color_encoding_name(state->color_encoding));
841 	drm_printf(p, "\tcolor-range=%s\n",
842 		   drm_get_color_range_name(state->color_range));
843 	drm_printf(p, "\tcolor_mgmt_changed=%d\n", state->color_mgmt_changed);
844 	drm_printf(p, "\tcolor-pipeline=%d\n",
845 		   state->color_pipeline ? state->color_pipeline->base.id : 0);
846 	if (plane->funcs->atomic_print_state)
847 		plane->funcs->atomic_print_state(p, state);
848 }
849 
850 /**
851  * DOC: handling driver private state
852  *
853  * Very often the DRM objects exposed to userspace in the atomic modeset api
854  * (&drm_connector, &drm_crtc and &drm_plane) do not map neatly to the
855  * underlying hardware. Especially for any kind of shared resources (e.g. shared
856  * clocks, scaler units, bandwidth and fifo limits shared among a group of
857  * planes or CRTCs, and so on) it makes sense to model these as independent
858  * objects. Drivers then need to do similar state tracking and commit ordering for
859  * such private (since not exposed to userspace) objects as the atomic core and
860  * helpers already provide for connectors, planes and CRTCs.
861  *
862  * To make this easier on drivers the atomic core provides some support to track
863  * driver private state objects using struct &drm_private_obj, with the
864  * associated state struct &drm_private_state.
865  *
866  * Similar to userspace-exposed objects, private state structures can be
867  * acquired by calling drm_atomic_get_private_obj_state(). This also takes care
868  * of locking, hence drivers should not have a need to call drm_modeset_lock()
869  * directly. Sequence of the actual hardware state commit is not handled,
870  * drivers might need to keep track of struct drm_crtc_commit within subclassed
871  * structure of &drm_private_state as necessary, e.g. similar to
872  * &drm_plane_state.commit. See also &drm_atomic_state.fake_commit.
873  *
874  * All private state structures contained in a &drm_atomic_state update can be
875  * iterated using for_each_oldnew_private_obj_in_state(),
876  * for_each_new_private_obj_in_state() and for_each_old_private_obj_in_state().
877  * Drivers are recommended to wrap these for each type of driver private state
878  * object they have, filtering on &drm_private_obj.funcs using for_each_if(), at
879  * least if they want to iterate over all objects of a given type.
880  *
881  * An earlier way to handle driver private state was by subclassing struct
882  * &drm_atomic_state. But since that encourages non-standard ways to implement
883  * the check/commit split atomic requires (by using e.g. "check and rollback or
884  * commit instead" of "duplicate state, check, then either commit or release
885  * duplicated state) it is deprecated in favour of using &drm_private_state.
886  */
887 
888 /**
889  * drm_atomic_private_obj_init - initialize private object
890  * @dev: DRM device this object will be attached to
891  * @obj: private object
892  * @state: initial private object state
893  * @funcs: pointer to the struct of function pointers that identify the object
894  * type
895  *
896  * Initialize the private object, which can be embedded into any
897  * driver private object that needs its own atomic state.
898  */
899 void
drm_atomic_private_obj_init(struct drm_device * dev,struct drm_private_obj * obj,struct drm_private_state * state,const struct drm_private_state_funcs * funcs)900 drm_atomic_private_obj_init(struct drm_device *dev,
901 			    struct drm_private_obj *obj,
902 			    struct drm_private_state *state,
903 			    const struct drm_private_state_funcs *funcs)
904 {
905 	memset(obj, 0, sizeof(*obj));
906 
907 	drm_modeset_lock_init(&obj->lock);
908 
909 	obj->state = state;
910 	obj->funcs = funcs;
911 	list_add_tail(&obj->head, &dev->mode_config.privobj_list);
912 
913 	state->obj = obj;
914 }
915 EXPORT_SYMBOL(drm_atomic_private_obj_init);
916 
917 /**
918  * drm_atomic_private_obj_fini - finalize private object
919  * @obj: private object
920  *
921  * Finalize the private object.
922  */
923 void
drm_atomic_private_obj_fini(struct drm_private_obj * obj)924 drm_atomic_private_obj_fini(struct drm_private_obj *obj)
925 {
926 	list_del(&obj->head);
927 	obj->funcs->atomic_destroy_state(obj, obj->state);
928 	drm_modeset_lock_fini(&obj->lock);
929 }
930 EXPORT_SYMBOL(drm_atomic_private_obj_fini);
931 
932 /**
933  * drm_atomic_get_private_obj_state - get private object state
934  * @state: global atomic state
935  * @obj: private object to get the state for
936  *
937  * This function returns the private object state for the given private object,
938  * allocating the state if needed. It will also grab the relevant private
939  * object lock to make sure that the state is consistent.
940  *
941  * RETURNS:
942  * Either the allocated state or the error code encoded into a pointer.
943  */
944 struct drm_private_state *
drm_atomic_get_private_obj_state(struct drm_atomic_state * state,struct drm_private_obj * obj)945 drm_atomic_get_private_obj_state(struct drm_atomic_state *state,
946 				 struct drm_private_obj *obj)
947 {
948 	int index, num_objs, ret;
949 	size_t size;
950 	struct __drm_private_objs_state *arr;
951 	struct drm_private_state *obj_state;
952 
953 	WARN_ON(!state->acquire_ctx);
954 	drm_WARN_ON(state->dev, state->checked);
955 
956 	obj_state = drm_atomic_get_new_private_obj_state(state, obj);
957 	if (obj_state)
958 		return obj_state;
959 
960 	ret = drm_modeset_lock(&obj->lock, state->acquire_ctx);
961 	if (ret)
962 		return ERR_PTR(ret);
963 
964 	num_objs = state->num_private_objs + 1;
965 	size = sizeof(*state->private_objs) * num_objs;
966 	arr = krealloc(state->private_objs, size, GFP_KERNEL);
967 	if (!arr)
968 		return ERR_PTR(-ENOMEM);
969 
970 	state->private_objs = arr;
971 	index = state->num_private_objs;
972 	memset(&state->private_objs[index], 0, sizeof(*state->private_objs));
973 
974 	obj_state = obj->funcs->atomic_duplicate_state(obj);
975 	if (!obj_state)
976 		return ERR_PTR(-ENOMEM);
977 
978 	state->private_objs[index].state_to_destroy = obj_state;
979 	state->private_objs[index].old_state = obj->state;
980 	state->private_objs[index].new_state = obj_state;
981 	state->private_objs[index].ptr = obj;
982 	obj_state->state = state;
983 
984 	state->num_private_objs = num_objs;
985 
986 	drm_dbg_atomic(state->dev,
987 		       "Added new private object %p state %p to %p\n",
988 		       obj, obj_state, state);
989 
990 	return obj_state;
991 }
992 EXPORT_SYMBOL(drm_atomic_get_private_obj_state);
993 
994 /**
995  * drm_atomic_get_old_private_obj_state
996  * @state: global atomic state object
997  * @obj: private_obj to grab
998  *
999  * This function returns the old private object state for the given private_obj,
1000  * or NULL if the private_obj is not part of the global atomic state.
1001  */
1002 struct drm_private_state *
drm_atomic_get_old_private_obj_state(const struct drm_atomic_state * state,struct drm_private_obj * obj)1003 drm_atomic_get_old_private_obj_state(const struct drm_atomic_state *state,
1004 				     struct drm_private_obj *obj)
1005 {
1006 	int i;
1007 
1008 	for (i = 0; i < state->num_private_objs; i++)
1009 		if (obj == state->private_objs[i].ptr)
1010 			return state->private_objs[i].old_state;
1011 
1012 	return NULL;
1013 }
1014 EXPORT_SYMBOL(drm_atomic_get_old_private_obj_state);
1015 
1016 /**
1017  * drm_atomic_get_new_private_obj_state
1018  * @state: global atomic state object
1019  * @obj: private_obj to grab
1020  *
1021  * This function returns the new private object state for the given private_obj,
1022  * or NULL if the private_obj is not part of the global atomic state.
1023  */
1024 struct drm_private_state *
drm_atomic_get_new_private_obj_state(const struct drm_atomic_state * state,struct drm_private_obj * obj)1025 drm_atomic_get_new_private_obj_state(const struct drm_atomic_state *state,
1026 				     struct drm_private_obj *obj)
1027 {
1028 	int i;
1029 
1030 	for (i = 0; i < state->num_private_objs; i++)
1031 		if (obj == state->private_objs[i].ptr)
1032 			return state->private_objs[i].new_state;
1033 
1034 	return NULL;
1035 }
1036 EXPORT_SYMBOL(drm_atomic_get_new_private_obj_state);
1037 
1038 /**
1039  * drm_atomic_get_old_connector_for_encoder - Get old connector for an encoder
1040  * @state: Atomic state
1041  * @encoder: The encoder to fetch the connector state for
1042  *
1043  * This function finds and returns the connector that was connected to @encoder
1044  * as specified by the @state.
1045  *
1046  * If there is no connector in @state which previously had @encoder connected to
1047  * it, this function will return NULL. While this may seem like an invalid use
1048  * case, it is sometimes useful to differentiate commits which had no prior
1049  * connectors attached to @encoder vs ones that did (and to inspect their
1050  * state). This is especially true in enable hooks because the pipeline has
1051  * changed.
1052  *
1053  * If you don't have access to the atomic state, see
1054  * drm_atomic_get_connector_for_encoder().
1055  *
1056  * Returns: The old connector connected to @encoder, or NULL if the encoder is
1057  * not connected.
1058  */
1059 struct drm_connector *
drm_atomic_get_old_connector_for_encoder(const struct drm_atomic_state * state,struct drm_encoder * encoder)1060 drm_atomic_get_old_connector_for_encoder(const struct drm_atomic_state *state,
1061 					 struct drm_encoder *encoder)
1062 {
1063 	struct drm_connector_state *conn_state;
1064 	struct drm_connector *connector;
1065 	unsigned int i;
1066 
1067 	for_each_old_connector_in_state(state, connector, conn_state, i) {
1068 		if (conn_state->best_encoder == encoder)
1069 			return connector;
1070 	}
1071 
1072 	return NULL;
1073 }
1074 EXPORT_SYMBOL(drm_atomic_get_old_connector_for_encoder);
1075 
1076 /**
1077  * drm_atomic_get_new_connector_for_encoder - Get new connector for an encoder
1078  * @state: Atomic state
1079  * @encoder: The encoder to fetch the connector state for
1080  *
1081  * This function finds and returns the connector that will be connected to
1082  * @encoder as specified by the @state.
1083  *
1084  * If there is no connector in @state which will have @encoder connected to it,
1085  * this function will return NULL. While this may seem like an invalid use case,
1086  * it is sometimes useful to differentiate commits which have no connectors
1087  * attached to @encoder vs ones that do (and to inspect their state). This is
1088  * especially true in disable hooks because the pipeline will change.
1089  *
1090  * If you don't have access to the atomic state, see
1091  * drm_atomic_get_connector_for_encoder().
1092  *
1093  * Returns: The new connector connected to @encoder, or NULL if the encoder is
1094  * not connected.
1095  */
1096 struct drm_connector *
drm_atomic_get_new_connector_for_encoder(const struct drm_atomic_state * state,struct drm_encoder * encoder)1097 drm_atomic_get_new_connector_for_encoder(const struct drm_atomic_state *state,
1098 					 struct drm_encoder *encoder)
1099 {
1100 	struct drm_connector_state *conn_state;
1101 	struct drm_connector *connector;
1102 	unsigned int i;
1103 
1104 	for_each_new_connector_in_state(state, connector, conn_state, i) {
1105 		if (conn_state->best_encoder == encoder)
1106 			return connector;
1107 	}
1108 
1109 	return NULL;
1110 }
1111 EXPORT_SYMBOL(drm_atomic_get_new_connector_for_encoder);
1112 
1113 /**
1114  * drm_atomic_get_connector_for_encoder - Get connector currently assigned to an encoder
1115  * @encoder: The encoder to find the connector of
1116  * @ctx: Modeset locking context
1117  *
1118  * This function finds and returns the connector currently assigned to
1119  * an @encoder.
1120  *
1121  * It is similar to the drm_atomic_get_old_connector_for_encoder() and
1122  * drm_atomic_get_new_connector_for_encoder() helpers, but doesn't
1123  * require access to the atomic state. If you have access to it, prefer
1124  * using these. This helper is typically useful in situations where you
1125  * don't have access to the atomic state, like detect, link repair,
1126  * threaded interrupt handlers, or hooks from other frameworks (ALSA,
1127  * CEC, etc.).
1128  *
1129  * Returns:
1130  * The connector connected to @encoder, or an error pointer otherwise.
1131  * When the error is EDEADLK, a deadlock has been detected and the
1132  * sequence must be restarted.
1133  */
1134 struct drm_connector *
drm_atomic_get_connector_for_encoder(const struct drm_encoder * encoder,struct drm_modeset_acquire_ctx * ctx)1135 drm_atomic_get_connector_for_encoder(const struct drm_encoder *encoder,
1136 				     struct drm_modeset_acquire_ctx *ctx)
1137 {
1138 	struct drm_connector_list_iter conn_iter;
1139 	struct drm_connector *out_connector = ERR_PTR(-EINVAL);
1140 	struct drm_connector *connector;
1141 	struct drm_device *dev = encoder->dev;
1142 	int ret;
1143 
1144 	ret = drm_modeset_lock(&dev->mode_config.connection_mutex, ctx);
1145 	if (ret)
1146 		return ERR_PTR(ret);
1147 
1148 	drm_connector_list_iter_begin(dev, &conn_iter);
1149 	drm_for_each_connector_iter(connector, &conn_iter) {
1150 		if (!connector->state)
1151 			continue;
1152 
1153 		if (encoder == connector->state->best_encoder) {
1154 			out_connector = connector;
1155 			break;
1156 		}
1157 	}
1158 	drm_connector_list_iter_end(&conn_iter);
1159 	drm_modeset_unlock(&dev->mode_config.connection_mutex);
1160 
1161 	return out_connector;
1162 }
1163 EXPORT_SYMBOL(drm_atomic_get_connector_for_encoder);
1164 
1165 
1166 /**
1167  * drm_atomic_get_old_crtc_for_encoder - Get old crtc for an encoder
1168  * @state: Atomic state
1169  * @encoder: The encoder to fetch the crtc state for
1170  *
1171  * This function finds and returns the crtc that was connected to @encoder
1172  * as specified by the @state.
1173  *
1174  * Returns: The old crtc connected to @encoder, or NULL if the encoder is
1175  * not connected.
1176  */
1177 struct drm_crtc *
drm_atomic_get_old_crtc_for_encoder(struct drm_atomic_state * state,struct drm_encoder * encoder)1178 drm_atomic_get_old_crtc_for_encoder(struct drm_atomic_state *state,
1179 				    struct drm_encoder *encoder)
1180 {
1181 	struct drm_connector *connector;
1182 	struct drm_connector_state *conn_state;
1183 
1184 	connector = drm_atomic_get_old_connector_for_encoder(state, encoder);
1185 	if (!connector)
1186 		return NULL;
1187 
1188 	conn_state = drm_atomic_get_old_connector_state(state, connector);
1189 	if (!conn_state)
1190 		return NULL;
1191 
1192 	return conn_state->crtc;
1193 }
1194 EXPORT_SYMBOL(drm_atomic_get_old_crtc_for_encoder);
1195 
1196 /**
1197  * drm_atomic_get_new_crtc_for_encoder - Get new crtc for an encoder
1198  * @state: Atomic state
1199  * @encoder: The encoder to fetch the crtc state for
1200  *
1201  * This function finds and returns the crtc that will be connected to @encoder
1202  * as specified by the @state.
1203  *
1204  * Returns: The new crtc connected to @encoder, or NULL if the encoder is
1205  * not connected.
1206  */
1207 struct drm_crtc *
drm_atomic_get_new_crtc_for_encoder(struct drm_atomic_state * state,struct drm_encoder * encoder)1208 drm_atomic_get_new_crtc_for_encoder(struct drm_atomic_state *state,
1209 				    struct drm_encoder *encoder)
1210 {
1211 	struct drm_connector *connector;
1212 	struct drm_connector_state *conn_state;
1213 
1214 	connector = drm_atomic_get_new_connector_for_encoder(state, encoder);
1215 	if (!connector)
1216 		return NULL;
1217 
1218 	conn_state = drm_atomic_get_new_connector_state(state, connector);
1219 	if (!conn_state)
1220 		return NULL;
1221 
1222 	return conn_state->crtc;
1223 }
1224 EXPORT_SYMBOL(drm_atomic_get_new_crtc_for_encoder);
1225 
1226 /**
1227  * drm_atomic_get_connector_state - get connector state
1228  * @state: global atomic state object
1229  * @connector: connector to get state object for
1230  *
1231  * This function returns the connector state for the given connector,
1232  * allocating it if needed. It will also grab the relevant connector lock to
1233  * make sure that the state is consistent.
1234  *
1235  * Returns:
1236  * Either the allocated state or the error code encoded into the pointer. When
1237  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
1238  * entire atomic sequence must be restarted. All other errors are fatal.
1239  */
1240 struct drm_connector_state *
drm_atomic_get_connector_state(struct drm_atomic_state * state,struct drm_connector * connector)1241 drm_atomic_get_connector_state(struct drm_atomic_state *state,
1242 			  struct drm_connector *connector)
1243 {
1244 	int ret, index;
1245 	struct drm_mode_config *config = &connector->dev->mode_config;
1246 	struct drm_connector_state *connector_state;
1247 
1248 	WARN_ON(!state->acquire_ctx);
1249 	drm_WARN_ON(state->dev, state->checked);
1250 
1251 	ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1252 	if (ret)
1253 		return ERR_PTR(ret);
1254 
1255 	index = drm_connector_index(connector);
1256 
1257 	if (index >= state->num_connector) {
1258 		struct __drm_connnectors_state *c;
1259 		int alloc = max(index + 1, config->num_connector);
1260 
1261 		c = krealloc_array(state->connectors, alloc,
1262 				   sizeof(*state->connectors), GFP_KERNEL);
1263 		if (!c)
1264 			return ERR_PTR(-ENOMEM);
1265 
1266 		state->connectors = c;
1267 		memset(&state->connectors[state->num_connector], 0,
1268 		       sizeof(*state->connectors) * (alloc - state->num_connector));
1269 
1270 		state->num_connector = alloc;
1271 	}
1272 
1273 	connector_state = drm_atomic_get_new_connector_state(state, connector);
1274 	if (connector_state)
1275 		return connector_state;
1276 
1277 	connector_state = connector->funcs->atomic_duplicate_state(connector);
1278 	if (!connector_state)
1279 		return ERR_PTR(-ENOMEM);
1280 
1281 	drm_connector_get(connector);
1282 	state->connectors[index].state_to_destroy = connector_state;
1283 	state->connectors[index].old_state = connector->state;
1284 	state->connectors[index].new_state = connector_state;
1285 	state->connectors[index].ptr = connector;
1286 	connector_state->state = state;
1287 
1288 	drm_dbg_atomic(connector->dev, "Added [CONNECTOR:%d:%s] %p state to %p\n",
1289 			 connector->base.id, connector->name,
1290 			 connector_state, state);
1291 
1292 	if (connector_state->crtc) {
1293 		struct drm_crtc_state *crtc_state;
1294 
1295 		crtc_state = drm_atomic_get_crtc_state(state,
1296 						       connector_state->crtc);
1297 		if (IS_ERR(crtc_state))
1298 			return ERR_CAST(crtc_state);
1299 	}
1300 
1301 	return connector_state;
1302 }
1303 EXPORT_SYMBOL(drm_atomic_get_connector_state);
1304 
drm_atomic_connector_print_state(struct drm_printer * p,const struct drm_connector_state * state)1305 static void drm_atomic_connector_print_state(struct drm_printer *p,
1306 		const struct drm_connector_state *state)
1307 {
1308 	struct drm_connector *connector = state->connector;
1309 
1310 	drm_printf(p, "connector[%u]: %s\n", connector->base.id, connector->name);
1311 	drm_printf(p, "\tcrtc=%s\n", state->crtc ? state->crtc->name : "(null)");
1312 	drm_printf(p, "\tself_refresh_aware=%d\n", state->self_refresh_aware);
1313 	drm_printf(p, "\tinterlace_allowed=%d\n", connector->interlace_allowed);
1314 	drm_printf(p, "\tycbcr_420_allowed=%d\n", connector->ycbcr_420_allowed);
1315 	drm_printf(p, "\tmax_requested_bpc=%d\n", state->max_requested_bpc);
1316 	drm_printf(p, "\tcolorspace=%s\n", drm_get_colorspace_name(state->colorspace));
1317 
1318 	if (connector->connector_type == DRM_MODE_CONNECTOR_HDMIA ||
1319 	    connector->connector_type == DRM_MODE_CONNECTOR_HDMIB) {
1320 		drm_printf(p, "\tbroadcast_rgb=%s\n",
1321 			   drm_hdmi_connector_get_broadcast_rgb_name(state->hdmi.broadcast_rgb));
1322 		drm_printf(p, "\tis_limited_range=%c\n", state->hdmi.is_limited_range ? 'y' : 'n');
1323 		drm_printf(p, "\toutput_bpc=%u\n", state->hdmi.output_bpc);
1324 		drm_printf(p, "\toutput_format=%s\n",
1325 			   drm_hdmi_connector_get_output_format_name(state->hdmi.output_format));
1326 		drm_printf(p, "\ttmds_char_rate=%llu\n", state->hdmi.tmds_char_rate);
1327 	}
1328 
1329 	if (connector->connector_type == DRM_MODE_CONNECTOR_WRITEBACK)
1330 		if (state->writeback_job && state->writeback_job->fb)
1331 			drm_printf(p, "\tfb=%d\n", state->writeback_job->fb->base.id);
1332 
1333 	if (connector->funcs->atomic_print_state)
1334 		connector->funcs->atomic_print_state(p, state);
1335 }
1336 
1337 /**
1338  * drm_atomic_get_bridge_state - get bridge state
1339  * @state: global atomic state object
1340  * @bridge: bridge to get state object for
1341  *
1342  * This function returns the bridge state for the given bridge, allocating it
1343  * if needed. It will also grab the relevant bridge lock to make sure that the
1344  * state is consistent.
1345  *
1346  * Returns:
1347  * Either the allocated state or the error code encoded into the pointer. When
1348  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
1349  * entire atomic sequence must be restarted.
1350  */
1351 struct drm_bridge_state *
drm_atomic_get_bridge_state(struct drm_atomic_state * state,struct drm_bridge * bridge)1352 drm_atomic_get_bridge_state(struct drm_atomic_state *state,
1353 			    struct drm_bridge *bridge)
1354 {
1355 	struct drm_private_state *obj_state;
1356 
1357 	obj_state = drm_atomic_get_private_obj_state(state, &bridge->base);
1358 	if (IS_ERR(obj_state))
1359 		return ERR_CAST(obj_state);
1360 
1361 	return drm_priv_to_bridge_state(obj_state);
1362 }
1363 EXPORT_SYMBOL(drm_atomic_get_bridge_state);
1364 
1365 /**
1366  * drm_atomic_get_old_bridge_state - get old bridge state, if it exists
1367  * @state: global atomic state object
1368  * @bridge: bridge to grab
1369  *
1370  * This function returns the old bridge state for the given bridge, or NULL if
1371  * the bridge is not part of the global atomic state.
1372  */
1373 struct drm_bridge_state *
drm_atomic_get_old_bridge_state(const struct drm_atomic_state * state,struct drm_bridge * bridge)1374 drm_atomic_get_old_bridge_state(const struct drm_atomic_state *state,
1375 				struct drm_bridge *bridge)
1376 {
1377 	struct drm_private_state *obj_state;
1378 
1379 	obj_state = drm_atomic_get_old_private_obj_state(state, &bridge->base);
1380 	if (!obj_state)
1381 		return NULL;
1382 
1383 	return drm_priv_to_bridge_state(obj_state);
1384 }
1385 EXPORT_SYMBOL(drm_atomic_get_old_bridge_state);
1386 
1387 /**
1388  * drm_atomic_get_new_bridge_state - get new bridge state, if it exists
1389  * @state: global atomic state object
1390  * @bridge: bridge to grab
1391  *
1392  * This function returns the new bridge state for the given bridge, or NULL if
1393  * the bridge is not part of the global atomic state.
1394  */
1395 struct drm_bridge_state *
drm_atomic_get_new_bridge_state(const struct drm_atomic_state * state,struct drm_bridge * bridge)1396 drm_atomic_get_new_bridge_state(const struct drm_atomic_state *state,
1397 				struct drm_bridge *bridge)
1398 {
1399 	struct drm_private_state *obj_state;
1400 
1401 	obj_state = drm_atomic_get_new_private_obj_state(state, &bridge->base);
1402 	if (!obj_state)
1403 		return NULL;
1404 
1405 	return drm_priv_to_bridge_state(obj_state);
1406 }
1407 EXPORT_SYMBOL(drm_atomic_get_new_bridge_state);
1408 
1409 /**
1410  * drm_atomic_add_encoder_bridges - add bridges attached to an encoder
1411  * @state: atomic state
1412  * @encoder: DRM encoder
1413  *
1414  * This function adds all bridges attached to @encoder. This is needed to add
1415  * bridge states to @state and make them available when
1416  * &drm_bridge_funcs.atomic_check(), &drm_bridge_funcs.atomic_pre_enable(),
1417  * &drm_bridge_funcs.atomic_enable(),
1418  * &drm_bridge_funcs.atomic_disable_post_disable() are called.
1419  *
1420  * Returns:
1421  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1422  * then the w/w mutex code has detected a deadlock and the entire atomic
1423  * sequence must be restarted. All other errors are fatal.
1424  */
1425 int
drm_atomic_add_encoder_bridges(struct drm_atomic_state * state,struct drm_encoder * encoder)1426 drm_atomic_add_encoder_bridges(struct drm_atomic_state *state,
1427 			       struct drm_encoder *encoder)
1428 {
1429 	struct drm_bridge_state *bridge_state;
1430 
1431 	if (!encoder)
1432 		return 0;
1433 
1434 	drm_dbg_atomic(encoder->dev,
1435 		       "Adding all bridges for [encoder:%d:%s] to %p\n",
1436 		       encoder->base.id, encoder->name, state);
1437 
1438 	drm_for_each_bridge_in_chain_scoped(encoder, bridge) {
1439 		/* Skip bridges that don't implement the atomic state hooks. */
1440 		if (!bridge->funcs->atomic_duplicate_state)
1441 			continue;
1442 
1443 		bridge_state = drm_atomic_get_bridge_state(state, bridge);
1444 		if (IS_ERR(bridge_state))
1445 			return PTR_ERR(bridge_state);
1446 	}
1447 
1448 	return 0;
1449 }
1450 EXPORT_SYMBOL(drm_atomic_add_encoder_bridges);
1451 
1452 /**
1453  * drm_atomic_add_affected_connectors - add connectors for CRTC
1454  * @state: atomic state
1455  * @crtc: DRM CRTC
1456  *
1457  * This function walks the current configuration and adds all connectors
1458  * currently using @crtc to the atomic configuration @state. Note that this
1459  * function must acquire the connection mutex. This can potentially cause
1460  * unneeded serialization if the update is just for the planes on one CRTC. Hence
1461  * drivers and helpers should only call this when really needed (e.g. when a
1462  * full modeset needs to happen due to some change).
1463  *
1464  * Returns:
1465  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1466  * then the w/w mutex code has detected a deadlock and the entire atomic
1467  * sequence must be restarted. All other errors are fatal.
1468  */
1469 int
drm_atomic_add_affected_connectors(struct drm_atomic_state * state,struct drm_crtc * crtc)1470 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
1471 				   struct drm_crtc *crtc)
1472 {
1473 	struct drm_mode_config *config = &state->dev->mode_config;
1474 	struct drm_connector *connector;
1475 	struct drm_connector_state *conn_state;
1476 	struct drm_connector_list_iter conn_iter;
1477 	struct drm_crtc_state *crtc_state;
1478 	int ret;
1479 
1480 	crtc_state = drm_atomic_get_crtc_state(state, crtc);
1481 	if (IS_ERR(crtc_state))
1482 		return PTR_ERR(crtc_state);
1483 
1484 	ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1485 	if (ret)
1486 		return ret;
1487 
1488 	drm_dbg_atomic(crtc->dev,
1489 		       "Adding all current connectors for [CRTC:%d:%s] to %p\n",
1490 		       crtc->base.id, crtc->name, state);
1491 
1492 	/*
1493 	 * Changed connectors are already in @state, so only need to look
1494 	 * at the connector_mask in crtc_state.
1495 	 */
1496 	drm_connector_list_iter_begin(state->dev, &conn_iter);
1497 	drm_for_each_connector_iter(connector, &conn_iter) {
1498 		if (!(crtc_state->connector_mask & drm_connector_mask(connector)))
1499 			continue;
1500 
1501 		conn_state = drm_atomic_get_connector_state(state, connector);
1502 		if (IS_ERR(conn_state)) {
1503 			drm_connector_list_iter_end(&conn_iter);
1504 			return PTR_ERR(conn_state);
1505 		}
1506 	}
1507 	drm_connector_list_iter_end(&conn_iter);
1508 
1509 	return 0;
1510 }
1511 EXPORT_SYMBOL(drm_atomic_add_affected_connectors);
1512 
1513 /**
1514  * drm_atomic_add_affected_planes - add planes for CRTC
1515  * @state: atomic state
1516  * @crtc: DRM CRTC
1517  *
1518  * This function walks the current configuration and adds all planes
1519  * currently used by @crtc to the atomic configuration @state. This is useful
1520  * when an atomic commit also needs to check all currently enabled plane on
1521  * @crtc, e.g. when changing the mode. It's also useful when re-enabling a CRTC
1522  * to avoid special code to force-enable all planes.
1523  *
1524  * Since acquiring a plane state will always also acquire the w/w mutex of the
1525  * current CRTC for that plane (if there is any) adding all the plane states for
1526  * a CRTC will not reduce parallelism of atomic updates.
1527  *
1528  * Returns:
1529  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1530  * then the w/w mutex code has detected a deadlock and the entire atomic
1531  * sequence must be restarted. All other errors are fatal.
1532  */
1533 int
drm_atomic_add_affected_planes(struct drm_atomic_state * state,struct drm_crtc * crtc)1534 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
1535 			       struct drm_crtc *crtc)
1536 {
1537 	const struct drm_crtc_state *old_crtc_state =
1538 		drm_atomic_get_old_crtc_state(state, crtc);
1539 	struct drm_plane *plane;
1540 
1541 	WARN_ON(!drm_atomic_get_new_crtc_state(state, crtc));
1542 
1543 	drm_dbg_atomic(crtc->dev,
1544 		       "Adding all current planes for [CRTC:%d:%s] to %p\n",
1545 		       crtc->base.id, crtc->name, state);
1546 
1547 	drm_for_each_plane_mask(plane, state->dev, old_crtc_state->plane_mask) {
1548 		struct drm_plane_state *plane_state =
1549 			drm_atomic_get_plane_state(state, plane);
1550 
1551 		if (IS_ERR(plane_state))
1552 			return PTR_ERR(plane_state);
1553 	}
1554 	return 0;
1555 }
1556 EXPORT_SYMBOL(drm_atomic_add_affected_planes);
1557 
1558 /**
1559  * drm_atomic_add_affected_colorops - add colorops for plane
1560  * @state: atomic state
1561  * @plane: DRM plane
1562  *
1563  * This function walks the current configuration and adds all colorops
1564  * currently used by @plane to the atomic configuration @state. This is useful
1565  * when an atomic commit also needs to check all currently enabled colorop on
1566  * @plane, e.g. when changing the mode. It's also useful when re-enabling a plane
1567  * to avoid special code to force-enable all colorops.
1568  *
1569  * Since acquiring a colorop state will always also acquire the w/w mutex of the
1570  * current plane for that colorop (if there is any) adding all the colorop states for
1571  * a plane will not reduce parallelism of atomic updates.
1572  *
1573  * Returns:
1574  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1575  * then the w/w mutex code has detected a deadlock and the entire atomic
1576  * sequence must be restarted. All other errors are fatal.
1577  */
1578 int
drm_atomic_add_affected_colorops(struct drm_atomic_state * state,struct drm_plane * plane)1579 drm_atomic_add_affected_colorops(struct drm_atomic_state *state,
1580 				 struct drm_plane *plane)
1581 {
1582 	struct drm_colorop *colorop;
1583 	struct drm_colorop_state *colorop_state;
1584 
1585 	WARN_ON(!drm_atomic_get_new_plane_state(state, plane));
1586 
1587 	drm_dbg_atomic(plane->dev,
1588 		       "Adding all current colorops for [PLANE:%d:%s] to %p\n",
1589 		       plane->base.id, plane->name, state);
1590 
1591 	drm_for_each_colorop(colorop, plane->dev) {
1592 		if (colorop->plane != plane)
1593 			continue;
1594 
1595 		colorop_state = drm_atomic_get_colorop_state(state, colorop);
1596 		if (IS_ERR(colorop_state))
1597 			return PTR_ERR(colorop_state);
1598 	}
1599 
1600 	return 0;
1601 }
1602 EXPORT_SYMBOL(drm_atomic_add_affected_colorops);
1603 
1604 /**
1605  * drm_atomic_check_only - check whether a given config would work
1606  * @state: atomic configuration to check
1607  *
1608  * Note that this function can return -EDEADLK if the driver needed to acquire
1609  * more locks but encountered a deadlock. The caller must then do the usual w/w
1610  * backoff dance and restart. All other errors are fatal.
1611  *
1612  * Returns:
1613  * 0 on success, negative error code on failure.
1614  */
drm_atomic_check_only(struct drm_atomic_state * state)1615 int drm_atomic_check_only(struct drm_atomic_state *state)
1616 {
1617 	struct drm_device *dev = state->dev;
1618 	struct drm_mode_config *config = &dev->mode_config;
1619 	struct drm_plane *plane;
1620 	struct drm_plane_state *old_plane_state;
1621 	struct drm_plane_state *new_plane_state;
1622 	struct drm_crtc *crtc;
1623 	struct drm_crtc_state *old_crtc_state;
1624 	struct drm_crtc_state *new_crtc_state;
1625 	struct drm_connector *conn;
1626 	struct drm_connector_state *conn_state;
1627 	unsigned int requested_crtc = 0;
1628 	unsigned int affected_crtc = 0;
1629 	int i, ret = 0;
1630 
1631 	drm_dbg_atomic(dev, "checking %p\n", state);
1632 
1633 	for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
1634 		if (new_crtc_state->enable)
1635 			requested_crtc |= drm_crtc_mask(crtc);
1636 	}
1637 
1638 	for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
1639 		ret = drm_atomic_plane_check(old_plane_state, new_plane_state);
1640 		if (ret) {
1641 			drm_dbg_atomic(dev, "[PLANE:%d:%s] atomic core check failed\n",
1642 				       plane->base.id, plane->name);
1643 			return ret;
1644 		}
1645 	}
1646 
1647 	for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
1648 		ret = drm_atomic_crtc_check(old_crtc_state, new_crtc_state);
1649 		if (ret) {
1650 			drm_dbg_atomic(dev, "[CRTC:%d:%s] atomic core check failed\n",
1651 				       crtc->base.id, crtc->name);
1652 			return ret;
1653 		}
1654 	}
1655 
1656 	for_each_new_connector_in_state(state, conn, conn_state, i) {
1657 		ret = drm_atomic_connector_check(conn, conn_state);
1658 		if (ret) {
1659 			drm_dbg_atomic(dev, "[CONNECTOR:%d:%s] atomic core check failed\n",
1660 				       conn->base.id, conn->name);
1661 			return ret;
1662 		}
1663 	}
1664 
1665 	if (config->funcs->atomic_check) {
1666 		ret = config->funcs->atomic_check(state->dev, state);
1667 
1668 		if (ret) {
1669 			drm_dbg_atomic(dev, "atomic driver check for %p failed: %d\n",
1670 				       state, ret);
1671 			return ret;
1672 		}
1673 	}
1674 
1675 	if (!state->allow_modeset) {
1676 		for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
1677 			if (drm_atomic_crtc_needs_modeset(new_crtc_state)) {
1678 				drm_dbg_atomic(dev, "[CRTC:%d:%s] requires full modeset\n",
1679 					       crtc->base.id, crtc->name);
1680 				return -EINVAL;
1681 			}
1682 		}
1683 	}
1684 
1685 	for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
1686 		if (new_crtc_state->enable)
1687 			affected_crtc |= drm_crtc_mask(crtc);
1688 	}
1689 
1690 	/*
1691 	 * For commits that allow modesets drivers can add other CRTCs to the
1692 	 * atomic commit, e.g. when they need to reallocate global resources.
1693 	 * This can cause spurious EBUSY, which robs compositors of a very
1694 	 * effective sanity check for their drawing loop. Therefor only allow
1695 	 * drivers to add unrelated CRTC states for modeset commits.
1696 	 *
1697 	 * FIXME: Should add affected_crtc mask to the ATOMIC IOCTL as an output
1698 	 * so compositors know what's going on.
1699 	 */
1700 	if (affected_crtc != requested_crtc) {
1701 		drm_dbg_atomic(dev,
1702 			       "driver added CRTC to commit: requested 0x%x, affected 0x%0x\n",
1703 			       requested_crtc, affected_crtc);
1704 		WARN(!state->allow_modeset, "adding CRTC not allowed without modesets: requested 0x%x, affected 0x%0x\n",
1705 		     requested_crtc, affected_crtc);
1706 	}
1707 
1708 	state->checked = true;
1709 
1710 	return 0;
1711 }
1712 EXPORT_SYMBOL(drm_atomic_check_only);
1713 
1714 /**
1715  * drm_atomic_commit - commit configuration atomically
1716  * @state: atomic configuration to check
1717  *
1718  * Note that this function can return -EDEADLK if the driver needed to acquire
1719  * more locks but encountered a deadlock. The caller must then do the usual w/w
1720  * backoff dance and restart. All other errors are fatal.
1721  *
1722  * This function will take its own reference on @state.
1723  * Callers should always release their reference with drm_atomic_state_put().
1724  *
1725  * Returns:
1726  * 0 on success, negative error code on failure.
1727  */
drm_atomic_commit(struct drm_atomic_state * state)1728 int drm_atomic_commit(struct drm_atomic_state *state)
1729 {
1730 	struct drm_mode_config *config = &state->dev->mode_config;
1731 	struct drm_printer p = drm_info_printer(state->dev->dev);
1732 	int ret;
1733 
1734 	if (drm_debug_enabled(DRM_UT_STATE))
1735 		drm_atomic_print_new_state(state, &p);
1736 
1737 	ret = drm_atomic_check_only(state);
1738 	if (ret)
1739 		return ret;
1740 
1741 	drm_dbg_atomic(state->dev, "committing %p\n", state);
1742 
1743 	return config->funcs->atomic_commit(state->dev, state, false);
1744 }
1745 EXPORT_SYMBOL(drm_atomic_commit);
1746 
1747 /**
1748  * drm_atomic_nonblocking_commit - atomic nonblocking commit
1749  * @state: atomic configuration to check
1750  *
1751  * Note that this function can return -EDEADLK if the driver needed to acquire
1752  * more locks but encountered a deadlock. The caller must then do the usual w/w
1753  * backoff dance and restart. All other errors are fatal.
1754  *
1755  * This function will take its own reference on @state.
1756  * Callers should always release their reference with drm_atomic_state_put().
1757  *
1758  * Returns:
1759  * 0 on success, negative error code on failure.
1760  */
drm_atomic_nonblocking_commit(struct drm_atomic_state * state)1761 int drm_atomic_nonblocking_commit(struct drm_atomic_state *state)
1762 {
1763 	struct drm_mode_config *config = &state->dev->mode_config;
1764 	int ret;
1765 
1766 	ret = drm_atomic_check_only(state);
1767 	if (ret)
1768 		return ret;
1769 
1770 	drm_dbg_atomic(state->dev, "committing %p nonblocking\n", state);
1771 
1772 	return config->funcs->atomic_commit(state->dev, state, true);
1773 }
1774 EXPORT_SYMBOL(drm_atomic_nonblocking_commit);
1775 
1776 /* just used from drm-client and atomic-helper: */
__drm_atomic_helper_disable_plane(struct drm_plane * plane,struct drm_plane_state * plane_state)1777 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1778 				      struct drm_plane_state *plane_state)
1779 {
1780 	int ret;
1781 
1782 	ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1783 	if (ret != 0)
1784 		return ret;
1785 
1786 	drm_atomic_set_fb_for_plane(plane_state, NULL);
1787 	plane_state->crtc_x = 0;
1788 	plane_state->crtc_y = 0;
1789 	plane_state->crtc_w = 0;
1790 	plane_state->crtc_h = 0;
1791 	plane_state->src_x = 0;
1792 	plane_state->src_y = 0;
1793 	plane_state->src_w = 0;
1794 	plane_state->src_h = 0;
1795 
1796 	return 0;
1797 }
1798 EXPORT_SYMBOL(__drm_atomic_helper_disable_plane);
1799 
update_output_state(struct drm_atomic_state * state,struct drm_mode_set * set)1800 static int update_output_state(struct drm_atomic_state *state,
1801 			       struct drm_mode_set *set)
1802 {
1803 	struct drm_device *dev = set->crtc->dev;
1804 	struct drm_crtc *crtc;
1805 	struct drm_crtc_state *new_crtc_state;
1806 	struct drm_connector *connector;
1807 	struct drm_connector_state *new_conn_state;
1808 	int ret, i;
1809 
1810 	ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1811 			       state->acquire_ctx);
1812 	if (ret)
1813 		return ret;
1814 
1815 	/* First disable all connectors on the target crtc. */
1816 	ret = drm_atomic_add_affected_connectors(state, set->crtc);
1817 	if (ret)
1818 		return ret;
1819 
1820 	for_each_new_connector_in_state(state, connector, new_conn_state, i) {
1821 		if (new_conn_state->crtc == set->crtc) {
1822 			ret = drm_atomic_set_crtc_for_connector(new_conn_state,
1823 								NULL);
1824 			if (ret)
1825 				return ret;
1826 
1827 			/* Make sure legacy setCrtc always re-trains */
1828 			new_conn_state->link_status = DRM_LINK_STATUS_GOOD;
1829 		}
1830 	}
1831 
1832 	/* Then set all connectors from set->connectors on the target crtc */
1833 	for (i = 0; i < set->num_connectors; i++) {
1834 		new_conn_state = drm_atomic_get_connector_state(state,
1835 								set->connectors[i]);
1836 		if (IS_ERR(new_conn_state))
1837 			return PTR_ERR(new_conn_state);
1838 
1839 		ret = drm_atomic_set_crtc_for_connector(new_conn_state,
1840 							set->crtc);
1841 		if (ret)
1842 			return ret;
1843 	}
1844 
1845 	for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
1846 		/*
1847 		 * Don't update ->enable for the CRTC in the set_config request,
1848 		 * since a mismatch would indicate a bug in the upper layers.
1849 		 * The actual modeset code later on will catch any
1850 		 * inconsistencies here.
1851 		 */
1852 		if (crtc == set->crtc)
1853 			continue;
1854 
1855 		if (!new_crtc_state->connector_mask) {
1856 			ret = drm_atomic_set_mode_prop_for_crtc(new_crtc_state,
1857 								NULL);
1858 			if (ret < 0)
1859 				return ret;
1860 
1861 			new_crtc_state->active = false;
1862 		}
1863 	}
1864 
1865 	return 0;
1866 }
1867 
1868 /* just used from drm-client and atomic-helper: */
__drm_atomic_helper_set_config(struct drm_mode_set * set,struct drm_atomic_state * state)1869 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1870 				   struct drm_atomic_state *state)
1871 {
1872 	struct drm_crtc_state *crtc_state;
1873 	struct drm_plane_state *primary_state;
1874 	struct drm_crtc *crtc = set->crtc;
1875 	int hdisplay, vdisplay;
1876 	int ret;
1877 
1878 	crtc_state = drm_atomic_get_crtc_state(state, crtc);
1879 	if (IS_ERR(crtc_state))
1880 		return PTR_ERR(crtc_state);
1881 
1882 	primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1883 	if (IS_ERR(primary_state))
1884 		return PTR_ERR(primary_state);
1885 
1886 	if (!set->mode) {
1887 		WARN_ON(set->fb);
1888 		WARN_ON(set->num_connectors);
1889 
1890 		ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1891 		if (ret != 0)
1892 			return ret;
1893 
1894 		crtc_state->active = false;
1895 
1896 		ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1897 		if (ret != 0)
1898 			return ret;
1899 
1900 		drm_atomic_set_fb_for_plane(primary_state, NULL);
1901 
1902 		goto commit;
1903 	}
1904 
1905 	WARN_ON(!set->fb);
1906 	WARN_ON(!set->num_connectors);
1907 
1908 	ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1909 	if (ret != 0)
1910 		return ret;
1911 
1912 	crtc_state->active = true;
1913 
1914 	ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1915 	if (ret != 0)
1916 		return ret;
1917 
1918 	drm_mode_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1919 
1920 	drm_atomic_set_fb_for_plane(primary_state, set->fb);
1921 	primary_state->crtc_x = 0;
1922 	primary_state->crtc_y = 0;
1923 	primary_state->crtc_w = hdisplay;
1924 	primary_state->crtc_h = vdisplay;
1925 	primary_state->src_x = set->x << 16;
1926 	primary_state->src_y = set->y << 16;
1927 	if (drm_rotation_90_or_270(primary_state->rotation)) {
1928 		primary_state->src_w = vdisplay << 16;
1929 		primary_state->src_h = hdisplay << 16;
1930 	} else {
1931 		primary_state->src_w = hdisplay << 16;
1932 		primary_state->src_h = vdisplay << 16;
1933 	}
1934 
1935 commit:
1936 	ret = update_output_state(state, set);
1937 	if (ret)
1938 		return ret;
1939 
1940 	return 0;
1941 }
1942 EXPORT_SYMBOL(__drm_atomic_helper_set_config);
1943 
drm_atomic_private_obj_print_state(struct drm_printer * p,const struct drm_private_state * state)1944 static void drm_atomic_private_obj_print_state(struct drm_printer *p,
1945 					       const struct drm_private_state *state)
1946 {
1947 	struct drm_private_obj *obj = state->obj;
1948 
1949 	if (obj->funcs->atomic_print_state)
1950 		obj->funcs->atomic_print_state(p, state);
1951 }
1952 
1953 /**
1954  * drm_atomic_print_new_state - prints drm atomic state
1955  * @state: atomic configuration to check
1956  * @p: drm printer
1957  *
1958  * This functions prints the drm atomic state snapshot using the drm printer
1959  * which is passed to it. This snapshot can be used for debugging purposes.
1960  *
1961  * Note that this function looks into the new state objects and hence its not
1962  * safe to be used after the call to drm_atomic_helper_commit_hw_done().
1963  */
drm_atomic_print_new_state(const struct drm_atomic_state * state,struct drm_printer * p)1964 void drm_atomic_print_new_state(const struct drm_atomic_state *state,
1965 		struct drm_printer *p)
1966 {
1967 	struct drm_plane *plane;
1968 	struct drm_plane_state *plane_state;
1969 	struct drm_crtc *crtc;
1970 	struct drm_crtc_state *crtc_state;
1971 	struct drm_connector *connector;
1972 	struct drm_connector_state *connector_state;
1973 	struct drm_private_obj *obj;
1974 	struct drm_private_state *obj_state;
1975 	int i;
1976 
1977 	if (!p) {
1978 		drm_err(state->dev, "invalid drm printer\n");
1979 		return;
1980 	}
1981 
1982 	drm_dbg_atomic(state->dev, "checking %p\n", state);
1983 
1984 	for_each_new_plane_in_state(state, plane, plane_state, i)
1985 		drm_atomic_plane_print_state(p, plane_state);
1986 
1987 	for_each_new_crtc_in_state(state, crtc, crtc_state, i)
1988 		drm_atomic_crtc_print_state(p, crtc_state);
1989 
1990 	for_each_new_connector_in_state(state, connector, connector_state, i)
1991 		drm_atomic_connector_print_state(p, connector_state);
1992 
1993 	for_each_new_private_obj_in_state(state, obj, obj_state, i)
1994 		drm_atomic_private_obj_print_state(p, obj_state);
1995 }
1996 EXPORT_SYMBOL(drm_atomic_print_new_state);
1997 
__drm_state_dump(struct drm_device * dev,struct drm_printer * p,bool take_locks)1998 static void __drm_state_dump(struct drm_device *dev, struct drm_printer *p,
1999 			     bool take_locks)
2000 {
2001 	struct drm_mode_config *config = &dev->mode_config;
2002 	struct drm_colorop *colorop;
2003 	struct drm_plane *plane;
2004 	struct drm_crtc *crtc;
2005 	struct drm_connector *connector;
2006 	struct drm_connector_list_iter conn_iter;
2007 	struct drm_private_obj *obj;
2008 
2009 	if (!drm_drv_uses_atomic_modeset(dev))
2010 		return;
2011 
2012 	list_for_each_entry(colorop, &config->colorop_list, head) {
2013 		if (take_locks)
2014 			drm_modeset_lock(&colorop->plane->mutex, NULL);
2015 		drm_atomic_colorop_print_state(p, colorop->state);
2016 		if (take_locks)
2017 			drm_modeset_unlock(&colorop->plane->mutex);
2018 	}
2019 
2020 	list_for_each_entry(plane, &config->plane_list, head) {
2021 		if (take_locks)
2022 			drm_modeset_lock(&plane->mutex, NULL);
2023 		drm_atomic_plane_print_state(p, plane->state);
2024 		if (take_locks)
2025 			drm_modeset_unlock(&plane->mutex);
2026 	}
2027 
2028 	list_for_each_entry(crtc, &config->crtc_list, head) {
2029 		if (take_locks)
2030 			drm_modeset_lock(&crtc->mutex, NULL);
2031 		drm_atomic_crtc_print_state(p, crtc->state);
2032 		if (take_locks)
2033 			drm_modeset_unlock(&crtc->mutex);
2034 	}
2035 
2036 	drm_connector_list_iter_begin(dev, &conn_iter);
2037 	if (take_locks)
2038 		drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2039 	drm_for_each_connector_iter(connector, &conn_iter)
2040 		drm_atomic_connector_print_state(p, connector->state);
2041 	if (take_locks)
2042 		drm_modeset_unlock(&dev->mode_config.connection_mutex);
2043 	drm_connector_list_iter_end(&conn_iter);
2044 
2045 	list_for_each_entry(obj, &config->privobj_list, head) {
2046 		if (take_locks)
2047 			drm_modeset_lock(&obj->lock, NULL);
2048 		drm_atomic_private_obj_print_state(p, obj->state);
2049 		if (take_locks)
2050 			drm_modeset_unlock(&obj->lock);
2051 	}
2052 }
2053 
2054 /**
2055  * drm_state_dump - dump entire device atomic state
2056  * @dev: the drm device
2057  * @p: where to print the state to
2058  *
2059  * Just for debugging.  Drivers might want an option to dump state
2060  * to dmesg in case of error irq's.  (Hint, you probably want to
2061  * ratelimit this!)
2062  *
2063  * The caller must wrap this drm_modeset_lock_all_ctx() and
2064  * drm_modeset_drop_locks(). If this is called from error irq handler, it should
2065  * not be enabled by default - if you are debugging errors you might
2066  * not care that this is racey, but calling this without all modeset locks held
2067  * is inherently unsafe.
2068  */
drm_state_dump(struct drm_device * dev,struct drm_printer * p)2069 void drm_state_dump(struct drm_device *dev, struct drm_printer *p)
2070 {
2071 	__drm_state_dump(dev, p, false);
2072 }
2073 EXPORT_SYMBOL(drm_state_dump);
2074 
2075 #ifdef CONFIG_DEBUG_FS
drm_state_info(struct seq_file * m,void * data)2076 static int drm_state_info(struct seq_file *m, void *data)
2077 {
2078 	struct drm_debugfs_entry *entry = m->private;
2079 	struct drm_device *dev = entry->dev;
2080 	struct drm_printer p = drm_seq_file_printer(m);
2081 
2082 	__drm_state_dump(dev, &p, true);
2083 
2084 	return 0;
2085 }
2086 
2087 /* any use in debugfs files to dump individual planes/crtc/etc? */
2088 static const struct drm_debugfs_info drm_atomic_debugfs_list[] = {
2089 	{"state", drm_state_info, 0},
2090 };
2091 
drm_atomic_debugfs_init(struct drm_device * dev)2092 void drm_atomic_debugfs_init(struct drm_device *dev)
2093 {
2094 	drm_debugfs_add_files(dev, drm_atomic_debugfs_list,
2095 			      ARRAY_SIZE(drm_atomic_debugfs_list));
2096 }
2097 #endif
2098