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#include <linux/dma-fence.h>
  29#include <linux/ktime.h>
  30
  31#include <drm/drm_atomic.h>
  32#include <drm/drm_atomic_helper.h>
  33#include <drm/drm_atomic_uapi.h>
  34#include <drm/drm_bridge.h>
  35#include <drm/drm_damage_helper.h>
  36#include <drm/drm_device.h>
  37#include <drm/drm_drv.h>
  38#include <drm/drm_plane_helper.h>
  39#include <drm/drm_print.h>
  40#include <drm/drm_self_refresh_helper.h>
  41#include <drm/drm_vblank.h>
  42#include <drm/drm_writeback.h>
  43
  44#include "drm_crtc_helper_internal.h"
  45#include "drm_crtc_internal.h"
  46
  47/**
  48 * DOC: overview
  49 *
  50 * This helper library provides implementations of check and commit functions on
  51 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
  52 * also provides convenience implementations for the atomic state handling
  53 * callbacks for drivers which don't need to subclass the drm core structures to
  54 * add their own additional internal state.
  55 *
  56 * This library also provides default implementations for the check callback in
  57 * drm_atomic_helper_check() and for the commit callback with
  58 * drm_atomic_helper_commit(). But the individual stages and callbacks are
  59 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
  60 * together with a driver private modeset implementation.
  61 *
  62 * This library also provides implementations for all the legacy driver
  63 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
  64 * drm_atomic_helper_disable_plane(), and the various functions to implement
  65 * set_property callbacks. New drivers must not implement these functions
  66 * themselves but must use the provided helpers.
  67 *
  68 * The atomic helper uses the same function table structures as all other
  69 * modesetting helpers. See the documentation for &struct drm_crtc_helper_funcs,
  70 * struct &drm_encoder_helper_funcs and &struct drm_connector_helper_funcs. It
  71 * also shares the &struct drm_plane_helper_funcs function table with the plane
  72 * helpers.
  73 */
  74static void
  75drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
  76				struct drm_plane_state *old_plane_state,
  77				struct drm_plane_state *plane_state,
  78				struct drm_plane *plane)
  79{
  80	struct drm_crtc_state *crtc_state;
  81
  82	if (old_plane_state->crtc) {
  83		crtc_state = drm_atomic_get_new_crtc_state(state,
  84							   old_plane_state->crtc);
  85
  86		if (WARN_ON(!crtc_state))
  87			return;
  88
  89		crtc_state->planes_changed = true;
  90	}
  91
  92	if (plane_state->crtc) {
  93		crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
  94
  95		if (WARN_ON(!crtc_state))
  96			return;
  97
  98		crtc_state->planes_changed = true;
  99	}
 100}
 101
 102static int handle_conflicting_encoders(struct drm_atomic_state *state,
 103				       bool disable_conflicting_encoders)
 104{
 105	struct drm_connector_state *new_conn_state;
 106	struct drm_connector *connector;
 107	struct drm_connector_list_iter conn_iter;
 108	struct drm_encoder *encoder;
 109	unsigned int encoder_mask = 0;
 110	int i, ret = 0;
 111
 112	/*
 113	 * First loop, find all newly assigned encoders from the connectors
 114	 * part of the state. If the same encoder is assigned to multiple
 115	 * connectors bail out.
 116	 */
 117	for_each_new_connector_in_state(state, connector, new_conn_state, i) {
 118		const struct drm_connector_helper_funcs *funcs = connector->helper_private;
 119		struct drm_encoder *new_encoder;
 120
 121		if (!new_conn_state->crtc)
 122			continue;
 123
 124		if (funcs->atomic_best_encoder)
 125			new_encoder = funcs->atomic_best_encoder(connector,
 126								 state);
 127		else if (funcs->best_encoder)
 128			new_encoder = funcs->best_encoder(connector);
 129		else
 130			new_encoder = drm_connector_get_single_encoder(connector);
 131
 132		if (new_encoder) {
 133			if (encoder_mask & drm_encoder_mask(new_encoder)) {
 134				DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
 135					new_encoder->base.id, new_encoder->name,
 136					connector->base.id, connector->name);
 137
 138				return -EINVAL;
 139			}
 140
 141			encoder_mask |= drm_encoder_mask(new_encoder);
 142		}
 143	}
 144
 145	if (!encoder_mask)
 146		return 0;
 147
 148	/*
 149	 * Second loop, iterate over all connectors not part of the state.
 150	 *
 151	 * If a conflicting encoder is found and disable_conflicting_encoders
 152	 * is not set, an error is returned. Userspace can provide a solution
 153	 * through the atomic ioctl.
 154	 *
 155	 * If the flag is set conflicting connectors are removed from the CRTC
 156	 * and the CRTC is disabled if no encoder is left. This preserves
 157	 * compatibility with the legacy set_config behavior.
 158	 */
 159	drm_connector_list_iter_begin(state->dev, &conn_iter);
 160	drm_for_each_connector_iter(connector, &conn_iter) {
 161		struct drm_crtc_state *crtc_state;
 162
 163		if (drm_atomic_get_new_connector_state(state, connector))
 164			continue;
 165
 166		encoder = connector->state->best_encoder;
 167		if (!encoder || !(encoder_mask & drm_encoder_mask(encoder)))
 168			continue;
 169
 170		if (!disable_conflicting_encoders) {
 171			DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
 172					 encoder->base.id, encoder->name,
 173					 connector->state->crtc->base.id,
 174					 connector->state->crtc->name,
 175					 connector->base.id, connector->name);
 176			ret = -EINVAL;
 177			goto out;
 178		}
 179
 180		new_conn_state = drm_atomic_get_connector_state(state, connector);
 181		if (IS_ERR(new_conn_state)) {
 182			ret = PTR_ERR(new_conn_state);
 183			goto out;
 184		}
 185
 186		DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
 187				 encoder->base.id, encoder->name,
 188				 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
 189				 connector->base.id, connector->name);
 190
 191		crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
 192
 193		ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
 194		if (ret)
 195			goto out;
 196
 197		if (!crtc_state->connector_mask) {
 198			ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
 199								NULL);
 200			if (ret < 0)
 201				goto out;
 202
 203			crtc_state->active = false;
 204		}
 205	}
 206out:
 207	drm_connector_list_iter_end(&conn_iter);
 208
 209	return ret;
 210}
 211
 212static void
 213set_best_encoder(struct drm_atomic_state *state,
 214		 struct drm_connector_state *conn_state,
 215		 struct drm_encoder *encoder)
 216{
 217	struct drm_crtc_state *crtc_state;
 218	struct drm_crtc *crtc;
 219
 220	if (conn_state->best_encoder) {
 221		/* Unset the encoder_mask in the old crtc state. */
 222		crtc = conn_state->connector->state->crtc;
 223
 224		/* A NULL crtc is an error here because we should have
 225		 * duplicated a NULL best_encoder when crtc was NULL.
 226		 * As an exception restoring duplicated atomic state
 227		 * during resume is allowed, so don't warn when
 228		 * best_encoder is equal to encoder we intend to set.
 229		 */
 230		WARN_ON(!crtc && encoder != conn_state->best_encoder);
 231		if (crtc) {
 232			crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
 233
 234			crtc_state->encoder_mask &=
 235				~drm_encoder_mask(conn_state->best_encoder);
 236		}
 237	}
 238
 239	if (encoder) {
 240		crtc = conn_state->crtc;
 241		WARN_ON(!crtc);
 242		if (crtc) {
 243			crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
 244
 245			crtc_state->encoder_mask |=
 246				drm_encoder_mask(encoder);
 247		}
 248	}
 249
 250	conn_state->best_encoder = encoder;
 251}
 252
 253static void
 254steal_encoder(struct drm_atomic_state *state,
 255	      struct drm_encoder *encoder)
 256{
 257	struct drm_crtc_state *crtc_state;
 258	struct drm_connector *connector;
 259	struct drm_connector_state *old_connector_state, *new_connector_state;
 260	int i;
 261
 262	for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
 263		struct drm_crtc *encoder_crtc;
 264
 265		if (new_connector_state->best_encoder != encoder)
 266			continue;
 267
 268		encoder_crtc = old_connector_state->crtc;
 269
 270		DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
 271				 encoder->base.id, encoder->name,
 272				 encoder_crtc->base.id, encoder_crtc->name);
 273
 274		set_best_encoder(state, new_connector_state, NULL);
 275
 276		crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
 277		crtc_state->connectors_changed = true;
 278
 279		return;
 280	}
 281}
 282
 283static int
 284update_connector_routing(struct drm_atomic_state *state,
 285			 struct drm_connector *connector,
 286			 struct drm_connector_state *old_connector_state,
 287			 struct drm_connector_state *new_connector_state)
 288{
 289	const struct drm_connector_helper_funcs *funcs;
 290	struct drm_encoder *new_encoder;
 291	struct drm_crtc_state *crtc_state;
 292
 293	DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
 294			 connector->base.id,
 295			 connector->name);
 296
 297	if (old_connector_state->crtc != new_connector_state->crtc) {
 298		if (old_connector_state->crtc) {
 299			crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
 300			crtc_state->connectors_changed = true;
 301		}
 302
 303		if (new_connector_state->crtc) {
 304			crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
 305			crtc_state->connectors_changed = true;
 306		}
 307	}
 308
 309	if (!new_connector_state->crtc) {
 310		DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
 311				connector->base.id,
 312				connector->name);
 313
 314		set_best_encoder(state, new_connector_state, NULL);
 315
 316		return 0;
 317	}
 318
 319	crtc_state = drm_atomic_get_new_crtc_state(state,
 320						   new_connector_state->crtc);
 321	/*
 322	 * For compatibility with legacy users, we want to make sure that
 323	 * we allow DPMS On->Off modesets on unregistered connectors. Modesets
 324	 * which would result in anything else must be considered invalid, to
 325	 * avoid turning on new displays on dead connectors.
 326	 *
 327	 * Since the connector can be unregistered at any point during an
 328	 * atomic check or commit, this is racy. But that's OK: all we care
 329	 * about is ensuring that userspace can't do anything but shut off the
 330	 * display on a connector that was destroyed after it's been notified,
 331	 * not before.
 332	 *
 333	 * Additionally, we also want to ignore connector registration when
 334	 * we're trying to restore an atomic state during system resume since
 335	 * there's a chance the connector may have been destroyed during the
 336	 * process, but it's better to ignore that then cause
 337	 * drm_atomic_helper_resume() to fail.
 338	 */
 339	if (!state->duplicated && drm_connector_is_unregistered(connector) &&
 340	    crtc_state->active) {
 341		DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] is not registered\n",
 342				 connector->base.id, connector->name);
 343		return -EINVAL;
 344	}
 345
 346	funcs = connector->helper_private;
 347
 348	if (funcs->atomic_best_encoder)
 349		new_encoder = funcs->atomic_best_encoder(connector, state);
 350	else if (funcs->best_encoder)
 351		new_encoder = funcs->best_encoder(connector);
 352	else
 353		new_encoder = drm_connector_get_single_encoder(connector);
 354
 355	if (!new_encoder) {
 356		DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
 357				 connector->base.id,
 358				 connector->name);
 359		return -EINVAL;
 360	}
 361
 362	if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
 363		DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
 364				 new_encoder->base.id,
 365				 new_encoder->name,
 366				 new_connector_state->crtc->base.id,
 367				 new_connector_state->crtc->name);
 368		return -EINVAL;
 369	}
 370
 371	if (new_encoder == new_connector_state->best_encoder) {
 372		set_best_encoder(state, new_connector_state, new_encoder);
 373
 374		DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
 375				 connector->base.id,
 376				 connector->name,
 377				 new_encoder->base.id,
 378				 new_encoder->name,
 379				 new_connector_state->crtc->base.id,
 380				 new_connector_state->crtc->name);
 381
 382		return 0;
 383	}
 384
 385	steal_encoder(state, new_encoder);
 386
 387	set_best_encoder(state, new_connector_state, new_encoder);
 388
 389	crtc_state->connectors_changed = true;
 390
 391	DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
 392			 connector->base.id,
 393			 connector->name,
 394			 new_encoder->base.id,
 395			 new_encoder->name,
 396			 new_connector_state->crtc->base.id,
 397			 new_connector_state->crtc->name);
 398
 399	return 0;
 400}
 401
 402static int
 403mode_fixup(struct drm_atomic_state *state)
 404{
 405	struct drm_crtc *crtc;
 406	struct drm_crtc_state *new_crtc_state;
 407	struct drm_connector *connector;
 408	struct drm_connector_state *new_conn_state;
 409	int i;
 410	int ret;
 411
 412	for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
 413		if (!new_crtc_state->mode_changed &&
 414		    !new_crtc_state->connectors_changed)
 415			continue;
 416
 417		drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
 418	}
 419
 420	for_each_new_connector_in_state(state, connector, new_conn_state, i) {
 421		const struct drm_encoder_helper_funcs *funcs;
 422		struct drm_encoder *encoder;
 423		struct drm_bridge *bridge;
 424
 425		WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
 426
 427		if (!new_conn_state->crtc || !new_conn_state->best_encoder)
 428			continue;
 429
 430		new_crtc_state =
 431			drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
 432
 433		/*
 434		 * Each encoder has at most one connector (since we always steal
 435		 * it away), so we won't call ->mode_fixup twice.
 436		 */
 437		encoder = new_conn_state->best_encoder;
 438		funcs = encoder->helper_private;
 439
 440		bridge = drm_bridge_chain_get_first_bridge(encoder);
 441		ret = drm_atomic_bridge_chain_check(bridge,
 442						    new_crtc_state,
 443						    new_conn_state);
 444		if (ret) {
 445			DRM_DEBUG_ATOMIC("Bridge atomic check failed\n");
 446			return ret;
 447		}
 448
 449		if (funcs && funcs->atomic_check) {
 450			ret = funcs->atomic_check(encoder, new_crtc_state,
 451						  new_conn_state);
 452			if (ret) {
 453				DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
 454						 encoder->base.id, encoder->name);
 455				return ret;
 456			}
 457		} else if (funcs && funcs->mode_fixup) {
 458			ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
 459						&new_crtc_state->adjusted_mode);
 460			if (!ret) {
 461				DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
 462						 encoder->base.id, encoder->name);
 463				return -EINVAL;
 464			}
 465		}
 466	}
 467
 468	for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
 469		const struct drm_crtc_helper_funcs *funcs;
 470
 471		if (!new_crtc_state->enable)
 472			continue;
 473
 474		if (!new_crtc_state->mode_changed &&
 475		    !new_crtc_state->connectors_changed)
 476			continue;
 477
 478		funcs = crtc->helper_private;
 479		if (!funcs || !funcs->mode_fixup)
 480			continue;
 481
 482		ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
 483					&new_crtc_state->adjusted_mode);
 484		if (!ret) {
 485			DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
 486					 crtc->base.id, crtc->name);
 487			return -EINVAL;
 488		}
 489	}
 490
 491	return 0;
 492}
 493
 494static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
 495					    struct drm_encoder *encoder,
 496					    struct drm_crtc *crtc,
 497					    const struct drm_display_mode *mode)
 498{
 499	struct drm_bridge *bridge;
 500	enum drm_mode_status ret;
 501
 502	ret = drm_encoder_mode_valid(encoder, mode);
 503	if (ret != MODE_OK) {
 504		DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
 505				encoder->base.id, encoder->name);
 506		return ret;
 507	}
 508
 509	bridge = drm_bridge_chain_get_first_bridge(encoder);
 510	ret = drm_bridge_chain_mode_valid(bridge, &connector->display_info,
 511					  mode);
 512	if (ret != MODE_OK) {
 513		DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
 514		return ret;
 515	}
 516
 517	ret = drm_crtc_mode_valid(crtc, mode);
 518	if (ret != MODE_OK) {
 519		DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
 520				crtc->base.id, crtc->name);
 521		return ret;
 522	}
 523
 524	return ret;
 525}
 526
 527static int
 528mode_valid(struct drm_atomic_state *state)
 529{
 530	struct drm_connector_state *conn_state;
 531	struct drm_connector *connector;
 532	int i;
 533
 534	for_each_new_connector_in_state(state, connector, conn_state, i) {
 535		struct drm_encoder *encoder = conn_state->best_encoder;
 536		struct drm_crtc *crtc = conn_state->crtc;
 537		struct drm_crtc_state *crtc_state;
 538		enum drm_mode_status mode_status;
 539		const struct drm_display_mode *mode;
 540
 541		if (!crtc || !encoder)
 542			continue;
 543
 544		crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
 545		if (!crtc_state)
 546			continue;
 547		if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
 548			continue;
 549
 550		mode = &crtc_state->mode;
 551
 552		mode_status = mode_valid_path(connector, encoder, crtc, mode);
 553		if (mode_status != MODE_OK)
 554			return -EINVAL;
 555	}
 556
 557	return 0;
 558}
 559
 560/**
 561 * drm_atomic_helper_check_modeset - validate state object for modeset changes
 562 * @dev: DRM device
 563 * @state: the driver state object
 564 *
 565 * Check the state object to see if the requested state is physically possible.
 566 * This does all the CRTC and connector related computations for an atomic
 567 * update and adds any additional connectors needed for full modesets. It calls
 568 * the various per-object callbacks in the follow order:
 569 *
 570 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
 571 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
 572 * 3. If it's determined a modeset is needed then all connectors on the affected
 573 *    CRTC are added and &drm_connector_helper_funcs.atomic_check is run on them.
 574 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
 575 *    &drm_crtc_helper_funcs.mode_valid are called on the affected components.
 576 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
 577 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
 578 *    This function is only called when the encoder will be part of a configured CRTC,
 579 *    it must not be used for implementing connector property validation.
 580 *    If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
 581 *    instead.
 582 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with CRTC constraints.
 583 *
 584 * &drm_crtc_state.mode_changed is set when the input mode is changed.
 585 * &drm_crtc_state.connectors_changed is set when a connector is added or
 586 * removed from the CRTC.  &drm_crtc_state.active_changed is set when
 587 * &drm_crtc_state.active changes, which is used for DPMS.
 588 * &drm_crtc_state.no_vblank is set from the result of drm_dev_has_vblank().
 589 * See also: drm_atomic_crtc_needs_modeset()
 590 *
 591 * IMPORTANT:
 592 *
 593 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
 594 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
 595 * without a full modeset) _must_ call this function after that change. It is
 596 * permitted to call this function multiple times for the same update, e.g.
 597 * when the &drm_crtc_helper_funcs.atomic_check functions depend upon the
 598 * adjusted dotclock for fifo space allocation and watermark computation.
 599 *
 600 * RETURNS:
 601 * Zero for success or -errno
 602 */
 603int
 604drm_atomic_helper_check_modeset(struct drm_device *dev,
 605				struct drm_atomic_state *state)
 606{
 607	struct drm_crtc *crtc;
 608	struct drm_crtc_state *old_crtc_state, *new_crtc_state;
 609	struct drm_connector *connector;
 610	struct drm_connector_state *old_connector_state, *new_connector_state;
 611	int i, ret;
 612	unsigned int connectors_mask = 0;
 613
 614	for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
 615		bool has_connectors =
 616			!!new_crtc_state->connector_mask;
 617
 618		WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
 619
 620		if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
 621			DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
 622					 crtc->base.id, crtc->name);
 623			new_crtc_state->mode_changed = true;
 624		}
 625
 626		if (old_crtc_state->enable != new_crtc_state->enable) {
 627			DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
 628					 crtc->base.id, crtc->name);
 629
 630			/*
 631			 * For clarity this assignment is done here, but
 632			 * enable == 0 is only true when there are no
 633			 * connectors and a NULL mode.
 634			 *
 635			 * The other way around is true as well. enable != 0
 636			 * iff connectors are attached and a mode is set.
 637			 */
 638			new_crtc_state->mode_changed = true;
 639			new_crtc_state->connectors_changed = true;
 640		}
 641
 642		if (old_crtc_state->active != new_crtc_state->active) {
 643			DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
 644					 crtc->base.id, crtc->name);
 645			new_crtc_state->active_changed = true;
 646		}
 647
 648		if (new_crtc_state->enable != has_connectors) {
 649			DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
 650					 crtc->base.id, crtc->name);
 651
 652			return -EINVAL;
 653		}
 654
 655		if (drm_dev_has_vblank(dev))
 656			new_crtc_state->no_vblank = false;
 657		else
 658			new_crtc_state->no_vblank = true;
 659	}
 660
 661	ret = handle_conflicting_encoders(state, false);
 662	if (ret)
 663		return ret;
 664
 665	for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
 666		const struct drm_connector_helper_funcs *funcs = connector->helper_private;
 667
 668		WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
 669
 670		/*
 671		 * This only sets crtc->connectors_changed for routing changes,
 672		 * drivers must set crtc->connectors_changed themselves when
 673		 * connector properties need to be updated.
 674		 */
 675		ret = update_connector_routing(state, connector,
 676					       old_connector_state,
 677					       new_connector_state);
 678		if (ret)
 679			return ret;
 680		if (old_connector_state->crtc) {
 681			new_crtc_state = drm_atomic_get_new_crtc_state(state,
 682								       old_connector_state->crtc);
 683			if (old_connector_state->link_status !=
 684			    new_connector_state->link_status)
 685				new_crtc_state->connectors_changed = true;
 686
 687			if (old_connector_state->max_requested_bpc !=
 688			    new_connector_state->max_requested_bpc)
 689				new_crtc_state->connectors_changed = true;
 690		}
 691
 692		if (funcs->atomic_check)
 693			ret = funcs->atomic_check(connector, state);
 694		if (ret)
 695			return ret;
 696
 697		connectors_mask |= BIT(i);
 698	}
 699
 700	/*
 701	 * After all the routing has been prepared we need to add in any
 702	 * connector which is itself unchanged, but whose CRTC changes its
 703	 * configuration. This must be done before calling mode_fixup in case a
 704	 * crtc only changed its mode but has the same set of connectors.
 705	 */
 706	for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
 707		if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
 708			continue;
 709
 710		DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
 711				 crtc->base.id, crtc->name,
 712				 new_crtc_state->enable ? 'y' : 'n',
 713				 new_crtc_state->active ? 'y' : 'n');
 714
 715		ret = drm_atomic_add_affected_connectors(state, crtc);
 716		if (ret != 0)
 717			return ret;
 718
 719		ret = drm_atomic_add_affected_planes(state, crtc);
 720		if (ret != 0)
 721			return ret;
 722	}
 723
 724	/*
 725	 * Iterate over all connectors again, to make sure atomic_check()
 726	 * has been called on them when a modeset is forced.
 727	 */
 728	for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
 729		const struct drm_connector_helper_funcs *funcs = connector->helper_private;
 730
 731		if (connectors_mask & BIT(i))
 732			continue;
 733
 734		if (funcs->atomic_check)
 735			ret = funcs->atomic_check(connector, state);
 736		if (ret)
 737			return ret;
 738	}
 739
 740	/*
 741	 * Iterate over all connectors again, and add all affected bridges to
 742	 * the state.
 743	 */
 744	for_each_oldnew_connector_in_state(state, connector,
 745					   old_connector_state,
 746					   new_connector_state, i) {
 747		struct drm_encoder *encoder;
 748
 749		encoder = old_connector_state->best_encoder;
 750		ret = drm_atomic_add_encoder_bridges(state, encoder);
 751		if (ret)
 752			return ret;
 753
 754		encoder = new_connector_state->best_encoder;
 755		ret = drm_atomic_add_encoder_bridges(state, encoder);
 756		if (ret)
 757			return ret;
 758	}
 759
 760	ret = mode_valid(state);
 761	if (ret)
 762		return ret;
 763
 764	return mode_fixup(state);
 765}
 766EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
 767
 768/**
 769 * drm_atomic_helper_check_plane_state() - Check plane state for validity
 770 * @plane_state: plane state to check
 771 * @crtc_state: CRTC state to check
 772 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
 773 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
 774 * @can_position: is it legal to position the plane such that it
 775 *                doesn't cover the entire CRTC?  This will generally
 776 *                only be false for primary planes.
 777 * @can_update_disabled: can the plane be updated while the CRTC
 778 *                       is disabled?
 779 *
 780 * Checks that a desired plane update is valid, and updates various
 781 * bits of derived state (clipped coordinates etc.). Drivers that provide
 782 * their own plane handling rather than helper-provided implementations may
 783 * still wish to call this function to avoid duplication of error checking
 784 * code.
 785 *
 786 * RETURNS:
 787 * Zero if update appears valid, error code on failure
 788 */
 789int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
 790					const struct drm_crtc_state *crtc_state,
 791					int min_scale,
 792					int max_scale,
 793					bool can_position,
 794					bool can_update_disabled)
 795{
 796	struct drm_framebuffer *fb = plane_state->fb;
 797	struct drm_rect *src = &plane_state->src;
 798	struct drm_rect *dst = &plane_state->dst;
 799	unsigned int rotation = plane_state->rotation;
 800	struct drm_rect clip = {};
 801	int hscale, vscale;
 802
 803	WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
 804
 805	*src = drm_plane_state_src(plane_state);
 806	*dst = drm_plane_state_dest(plane_state);
 807
 808	if (!fb) {
 809		plane_state->visible = false;
 810		return 0;
 811	}
 812
 813	/* crtc should only be NULL when disabling (i.e., !fb) */
 814	if (WARN_ON(!plane_state->crtc)) {
 815		plane_state->visible = false;
 816		return 0;
 817	}
 818
 819	if (!crtc_state->enable && !can_update_disabled) {
 820		DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
 821		return -EINVAL;
 822	}
 823
 824	drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
 825
 826	/* Check scaling */
 827	hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
 828	vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
 829	if (hscale < 0 || vscale < 0) {
 830		DRM_DEBUG_KMS("Invalid scaling of plane\n");
 831		drm_rect_debug_print("src: ", &plane_state->src, true);
 832		drm_rect_debug_print("dst: ", &plane_state->dst, false);
 833		return -ERANGE;
 834	}
 835
 836	if (crtc_state->enable)
 837		drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
 838
 839	plane_state->visible = drm_rect_clip_scaled(src, dst, &clip);
 840
 841	drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
 842
 843	if (!plane_state->visible)
 844		/*
 845		 * Plane isn't visible; some drivers can handle this
 846		 * so we just return success here.  Drivers that can't
 847		 * (including those that use the primary plane helper's
 848		 * update function) will return an error from their
 849		 * update_plane handler.
 850		 */
 851		return 0;
 852
 853	if (!can_position && !drm_rect_equals(dst, &clip)) {
 854		DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
 855		drm_rect_debug_print("dst: ", dst, false);
 856		drm_rect_debug_print("clip: ", &clip, false);
 857		return -EINVAL;
 858	}
 859
 860	return 0;
 861}
 862EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
 863
 864/**
 865 * drm_atomic_helper_check_planes - validate state object for planes changes
 866 * @dev: DRM device
 867 * @state: the driver state object
 868 *
 869 * Check the state object to see if the requested state is physically possible.
 870 * This does all the plane update related checks using by calling into the
 871 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
 872 * hooks provided by the driver.
 873 *
 874 * It also sets &drm_crtc_state.planes_changed to indicate that a CRTC has
 875 * updated planes.
 876 *
 877 * RETURNS:
 878 * Zero for success or -errno
 879 */
 880int
 881drm_atomic_helper_check_planes(struct drm_device *dev,
 882			       struct drm_atomic_state *state)
 883{
 884	struct drm_crtc *crtc;
 885	struct drm_crtc_state *new_crtc_state;
 886	struct drm_plane *plane;
 887	struct drm_plane_state *new_plane_state, *old_plane_state;
 888	int i, ret = 0;
 889
 890	for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
 891		const struct drm_plane_helper_funcs *funcs;
 892
 893		WARN_ON(!drm_modeset_is_locked(&plane->mutex));
 894
 895		funcs = plane->helper_private;
 896
 897		drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
 898
 899		drm_atomic_helper_check_plane_damage(state, new_plane_state);
 900
 901		if (!funcs || !funcs->atomic_check)
 902			continue;
 903
 904		ret = funcs->atomic_check(plane, state);
 905		if (ret) {
 906			DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
 907					 plane->base.id, plane->name);
 908			return ret;
 909		}
 910	}
 911
 912	for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
 913		const struct drm_crtc_helper_funcs *funcs;
 914
 915		funcs = crtc->helper_private;
 916
 917		if (!funcs || !funcs->atomic_check)
 918			continue;
 919
 920		ret = funcs->atomic_check(crtc, state);
 921		if (ret) {
 922			DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
 923					 crtc->base.id, crtc->name);
 924			return ret;
 925		}
 926	}
 927
 928	return ret;
 929}
 930EXPORT_SYMBOL(drm_atomic_helper_check_planes);
 931
 932/**
 933 * drm_atomic_helper_check - validate state object
 934 * @dev: DRM device
 935 * @state: the driver state object
 936 *
 937 * Check the state object to see if the requested state is physically possible.
 938 * Only CRTCs and planes have check callbacks, so for any additional (global)
 939 * checking that a driver needs it can simply wrap that around this function.
 940 * Drivers without such needs can directly use this as their
 941 * &drm_mode_config_funcs.atomic_check callback.
 942 *
 943 * This just wraps the two parts of the state checking for planes and modeset
 944 * state in the default order: First it calls drm_atomic_helper_check_modeset()
 945 * and then drm_atomic_helper_check_planes(). The assumption is that the
 946 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
 947 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
 948 * watermarks.
 949 *
 950 * Note that zpos normalization will add all enable planes to the state which
 951 * might not desired for some drivers.
 952 * For example enable/disable of a cursor plane which have fixed zpos value
 953 * would trigger all other enabled planes to be forced to the state change.
 954 *
 955 * RETURNS:
 956 * Zero for success or -errno
 957 */
 958int drm_atomic_helper_check(struct drm_device *dev,
 959			    struct drm_atomic_state *state)
 960{
 961	int ret;
 962
 963	ret = drm_atomic_helper_check_modeset(dev, state);
 964	if (ret)
 965		return ret;
 966
 967	if (dev->mode_config.normalize_zpos) {
 968		ret = drm_atomic_normalize_zpos(dev, state);
 969		if (ret)
 970			return ret;
 971	}
 972
 973	ret = drm_atomic_helper_check_planes(dev, state);
 974	if (ret)
 975		return ret;
 976
 977	if (state->legacy_cursor_update)
 978		state->async_update = !drm_atomic_helper_async_check(dev, state);
 979
 980	drm_self_refresh_helper_alter_state(state);
 981
 982	return ret;
 983}
 984EXPORT_SYMBOL(drm_atomic_helper_check);
 985
 986static bool
 987crtc_needs_disable(struct drm_crtc_state *old_state,
 988		   struct drm_crtc_state *new_state)
 989{
 990	/*
 991	 * No new_state means the CRTC is off, so the only criteria is whether
 992	 * it's currently active or in self refresh mode.
 993	 */
 994	if (!new_state)
 995		return drm_atomic_crtc_effectively_active(old_state);
 996
 997	/*
 998	 * We need to run through the crtc_funcs->disable() function if the CRTC
 999	 * is currently on, if it's transitioning to self refresh mode, or if
1000	 * it's in self refresh mode and needs to be fully disabled.
1001	 */
1002	return old_state->active ||
1003	       (old_state->self_refresh_active && !new_state->enable) ||
1004	       new_state->self_refresh_active;
1005}
1006
1007static void
1008disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
1009{
1010	struct drm_connector *connector;
1011	struct drm_connector_state *old_conn_state, *new_conn_state;
1012	struct drm_crtc *crtc;
1013	struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1014	int i;
1015
1016	for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1017		const struct drm_encoder_helper_funcs *funcs;
1018		struct drm_encoder *encoder;
1019		struct drm_bridge *bridge;
1020
1021		/*
1022		 * Shut down everything that's in the changeset and currently
1023		 * still on. So need to check the old, saved state.
1024		 */
1025		if (!old_conn_state->crtc)
1026			continue;
1027
1028		old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
1029
1030		if (new_conn_state->crtc)
1031			new_crtc_state = drm_atomic_get_new_crtc_state(
1032						old_state,
1033						new_conn_state->crtc);
1034		else
1035			new_crtc_state = NULL;
1036
1037		if (!crtc_needs_disable(old_crtc_state, new_crtc_state) ||
1038		    !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
1039			continue;
1040
1041		encoder = old_conn_state->best_encoder;
1042
1043		/* We shouldn't get this far if we didn't previously have
1044		 * an encoder.. but WARN_ON() rather than explode.
1045		 */
1046		if (WARN_ON(!encoder))
1047			continue;
1048
1049		funcs = encoder->helper_private;
1050
1051		DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
1052				 encoder->base.id, encoder->name);
1053
1054		/*
1055		 * Each encoder has at most one connector (since we always steal
1056		 * it away), so we won't call disable hooks twice.
1057		 */
1058		bridge = drm_bridge_chain_get_first_bridge(encoder);
1059		drm_atomic_bridge_chain_disable(bridge, old_state);
1060
1061		/* Right function depends upon target state. */
1062		if (funcs) {
1063			if (funcs->atomic_disable)
1064				funcs->atomic_disable(encoder, old_state);
1065			else if (new_conn_state->crtc && funcs->prepare)
1066				funcs->prepare(encoder);
1067			else if (funcs->disable)
1068				funcs->disable(encoder);
1069			else if (funcs->dpms)
1070				funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
1071		}
1072
1073		drm_atomic_bridge_chain_post_disable(bridge, old_state);
1074	}
1075
1076	for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1077		const struct drm_crtc_helper_funcs *funcs;
1078		int ret;
1079
1080		/* Shut down everything that needs a full modeset. */
1081		if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1082			continue;
1083
1084		if (!crtc_needs_disable(old_crtc_state, new_crtc_state))
1085			continue;
1086
1087		funcs = crtc->helper_private;
1088
1089		DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
1090				 crtc->base.id, crtc->name);
1091
1092
1093		/* Right function depends upon target state. */
1094		if (new_crtc_state->enable && funcs->prepare)
1095			funcs->prepare(crtc);
1096		else if (funcs->atomic_disable)
1097			funcs->atomic_disable(crtc, old_state);
1098		else if (funcs->disable)
1099			funcs->disable(crtc);
1100		else if (funcs->dpms)
1101			funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
1102
1103		if (!drm_dev_has_vblank(dev))
1104			continue;
1105
1106		ret = drm_crtc_vblank_get(crtc);
1107		WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
1108		if (ret == 0)
1109			drm_crtc_vblank_put(crtc);
1110	}
1111}
1112
1113/**
1114 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
1115 * @dev: DRM device
1116 * @old_state: atomic state object with old state structures
1117 *
1118 * This function updates all the various legacy modeset state pointers in
1119 * connectors, encoders and CRTCs.
1120 *
1121 * Drivers can use this for building their own atomic commit if they don't have
1122 * a pure helper-based modeset implementation.
1123 *
1124 * Since these updates are not synchronized with lockings, only code paths
1125 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1126 * legacy state filled out by this helper. Defacto this means this helper and
1127 * the legacy state pointers are only really useful for transitioning an
1128 * existing driver to the atomic world.
1129 */
1130void
1131drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1132					      struct drm_atomic_state *old_state)
1133{
1134	struct drm_connector *connector;
1135	struct drm_connector_state *old_conn_state, *new_conn_state;
1136	struct drm_crtc *crtc;
1137	struct drm_crtc_state *new_crtc_state;
1138	int i;
1139
1140	/* clear out existing links and update dpms */
1141	for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1142		if (connector->encoder) {
1143			WARN_ON(!connector->encoder->crtc);
1144
1145			connector->encoder->crtc = NULL;
1146			connector->encoder = NULL;
1147		}
1148
1149		crtc = new_conn_state->crtc;
1150		if ((!crtc && old_conn_state->crtc) ||
1151		    (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1152			int mode = DRM_MODE_DPMS_OFF;
1153
1154			if (crtc && crtc->state->active)
1155				mode = DRM_MODE_DPMS_ON;
1156
1157			connector->dpms = mode;
1158		}
1159	}
1160
1161	/* set new links */
1162	for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1163		if (!new_conn_state->crtc)
1164			continue;
1165
1166		if (WARN_ON(!new_conn_state->best_encoder))
1167			continue;
1168
1169		connector->encoder = new_conn_state->best_encoder;
1170		connector->encoder->crtc = new_conn_state->crtc;
1171	}
1172
1173	/* set legacy state in the crtc structure */
1174	for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1175		struct drm_plane *primary = crtc->primary;
1176		struct drm_plane_state *new_plane_state;
1177
1178		crtc->mode = new_crtc_state->mode;
1179		crtc->enabled = new_crtc_state->enable;
1180
1181		new_plane_state =
1182			drm_atomic_get_new_plane_state(old_state, primary);
1183
1184		if (new_plane_state && new_plane_state->crtc == crtc) {
1185			crtc->x = new_plane_state->src_x >> 16;
1186			crtc->y = new_plane_state->src_y >> 16;
1187		}
1188	}
1189}
1190EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1191
1192/**
1193 * drm_atomic_helper_calc_timestamping_constants - update vblank timestamping constants
1194 * @state: atomic state object
1195 *
1196 * Updates the timestamping constants used for precise vblank timestamps
1197 * by calling drm_calc_timestamping_constants() for all enabled crtcs in @state.
1198 */
1199void drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state)
1200{
1201	struct drm_crtc_state *new_crtc_state;
1202	struct drm_crtc *crtc;
1203	int i;
1204
1205	for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
1206		if (new_crtc_state->enable)
1207			drm_calc_timestamping_constants(crtc,
1208							&new_crtc_state->adjusted_mode);
1209	}
1210}
1211EXPORT_SYMBOL(drm_atomic_helper_calc_timestamping_constants);
1212
1213static void
1214crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1215{
1216	struct drm_crtc *crtc;
1217	struct drm_crtc_state *new_crtc_state;
1218	struct drm_connector *connector;
1219	struct drm_connector_state *new_conn_state;
1220	int i;
1221
1222	for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1223		const struct drm_crtc_helper_funcs *funcs;
1224
1225		if (!new_crtc_state->mode_changed)
1226			continue;
1227
1228		funcs = crtc->helper_private;
1229
1230		if (new_crtc_state->enable && funcs->mode_set_nofb) {
1231			DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1232					 crtc->base.id, crtc->name);
1233
1234			funcs->mode_set_nofb(crtc);
1235		}
1236	}
1237
1238	for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1239		const struct drm_encoder_helper_funcs *funcs;
1240		struct drm_encoder *encoder;
1241		struct drm_display_mode *mode, *adjusted_mode;
1242		struct drm_bridge *bridge;
1243
1244		if (!new_conn_state->best_encoder)
1245			continue;
1246
1247		encoder = new_conn_state->best_encoder;
1248		funcs = encoder->helper_private;
1249		new_crtc_state = new_conn_state->crtc->state;
1250		mode = &new_crtc_state->mode;
1251		adjusted_mode = &new_crtc_state->adjusted_mode;
1252
1253		if (!new_crtc_state->mode_changed)
1254			continue;
1255
1256		DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1257				 encoder->base.id, encoder->name);
1258
1259		/*
1260		 * Each encoder has at most one connector (since we always steal
1261		 * it away), so we won't call mode_set hooks twice.
1262		 */
1263		if (funcs && funcs->atomic_mode_set) {
1264			funcs->atomic_mode_set(encoder, new_crtc_state,
1265					       new_conn_state);
1266		} else if (funcs && funcs->mode_set) {
1267			funcs->mode_set(encoder, mode, adjusted_mode);
1268		}
1269
1270		bridge = drm_bridge_chain_get_first_bridge(encoder);
1271		drm_bridge_chain_mode_set(bridge, mode, adjusted_mode);
1272	}
1273}
1274
1275/**
1276 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1277 * @dev: DRM device
1278 * @old_state: atomic state object with old state structures
1279 *
1280 * This function shuts down all the outputs that need to be shut down and
1281 * prepares them (if required) with the new mode.
1282 *
1283 * For compatibility with legacy CRTC helpers this should be called before
1284 * drm_atomic_helper_commit_planes(), which is what the default commit function
1285 * does. But drivers with different needs can group the modeset commits together
1286 * and do the plane commits at the end. This is useful for drivers doing runtime
1287 * PM since planes updates then only happen when the CRTC is actually enabled.
1288 */
1289void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1290					       struct drm_atomic_state *old_state)
1291{
1292	disable_outputs(dev, old_state);
1293
1294	drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1295	drm_atomic_helper_calc_timestamping_constants(old_state);
1296
1297	crtc_set_mode(dev, old_state);
1298}
1299EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1300
1301static void drm_atomic_helper_commit_writebacks(struct drm_device *dev,
1302						struct drm_atomic_state *old_state)
1303{
1304	struct drm_connector *connector;
1305	struct drm_connector_state *new_conn_state;
1306	int i;
1307
1308	for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1309		const struct drm_connector_helper_funcs *funcs;
1310
1311		funcs = connector->helper_private;
1312		if (!funcs->atomic_commit)
1313			continue;
1314
1315		if (new_conn_state->writeback_job && new_conn_state->writeback_job->fb) {
1316			WARN_ON(connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK);
1317			funcs->atomic_commit(connector, old_state);
1318		}
1319	}
1320}
1321
1322/**
1323 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1324 * @dev: DRM device
1325 * @old_state: atomic state object with old state structures
1326 *
1327 * This function enables all the outputs with the new configuration which had to
1328 * be turned off for the update.
1329 *
1330 * For compatibility with legacy CRTC helpers this should be called after
1331 * drm_atomic_helper_commit_planes(), which is what the default commit function
1332 * does. But drivers with different needs can group the modeset commits together
1333 * and do the plane commits at the end. This is useful for drivers doing runtime
1334 * PM since planes updates then only happen when the CRTC is actually enabled.
1335 */
1336void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1337					      struct drm_atomic_state *old_state)
1338{
1339	struct drm_crtc *crtc;
1340	struct drm_crtc_state *old_crtc_state;
1341	struct drm_crtc_state *new_crtc_state;
1342	struct drm_connector *connector;
1343	struct drm_connector_state *new_conn_state;
1344	int i;
1345
1346	for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1347		const struct drm_crtc_helper_funcs *funcs;
1348
1349		/* Need to filter out CRTCs where only planes change. */
1350		if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1351			continue;
1352
1353		if (!new_crtc_state->active)
1354			continue;
1355
1356		funcs = crtc->helper_private;
1357
1358		if (new_crtc_state->enable) {
1359			DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1360					 crtc->base.id, crtc->name);
1361			if (funcs->atomic_enable)
1362				funcs->atomic_enable(crtc, old_state);
1363			else if (funcs->commit)
1364				funcs->commit(crtc);
1365		}
1366	}
1367
1368	for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1369		const struct drm_encoder_helper_funcs *funcs;
1370		struct drm_encoder *encoder;
1371		struct drm_bridge *bridge;
1372
1373		if (!new_conn_state->best_encoder)
1374			continue;
1375
1376		if (!new_conn_state->crtc->state->active ||
1377		    !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1378			continue;
1379
1380		encoder = new_conn_state->best_encoder;
1381		funcs = encoder->helper_private;
1382
1383		DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1384				 encoder->base.id, encoder->name);
1385
1386		/*
1387		 * Each encoder has at most one connector (since we always steal
1388		 * it away), so we won't call enable hooks twice.
1389		 */
1390		bridge = drm_bridge_chain_get_first_bridge(encoder);
1391		drm_atomic_bridge_chain_pre_enable(bridge, old_state);
1392
1393		if (funcs) {
1394			if (funcs->atomic_enable)
1395				funcs->atomic_enable(encoder, old_state);
1396			else if (funcs->enable)
1397				funcs->enable(encoder);
1398			else if (funcs->commit)
1399				funcs->commit(encoder);
1400		}
1401
1402		drm_atomic_bridge_chain_enable(bridge, old_state);
1403	}
1404
1405	drm_atomic_helper_commit_writebacks(dev, old_state);
1406}
1407EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1408
1409/**
1410 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1411 * @dev: DRM device
1412 * @state: atomic state object with old state structures
1413 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1414 *	Otherwise @state is the old state.
1415 *
1416 * For implicit sync, driver should fish the exclusive fence out from the
1417 * incoming fb's and stash it in the drm_plane_state.  This is called after
1418 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1419 * just uses the atomic state to find the changed planes)
1420 *
1421 * Note that @pre_swap is needed since the point where we block for fences moves
1422 * around depending upon whether an atomic commit is blocking or
1423 * non-blocking. For non-blocking commit all waiting needs to happen after
1424 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1425 * to wait **before** we do anything that can't be easily rolled back. That is
1426 * before we call drm_atomic_helper_swap_state().
1427 *
1428 * Returns zero if success or < 0 if dma_fence_wait() fails.
1429 */
1430int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1431				      struct drm_atomic_state *state,
1432				      bool pre_swap)
1433{
1434	struct drm_plane *plane;
1435	struct drm_plane_state *new_plane_state;
1436	int i, ret;
1437
1438	for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1439		if (!new_plane_state->fence)
1440			continue;
1441
1442		WARN_ON(!new_plane_state->fb);
1443
1444		/*
1445		 * If waiting for fences pre-swap (ie: nonblock), userspace can
1446		 * still interrupt the operation. Instead of blocking until the
1447		 * timer expires, make the wait interruptible.
1448		 */
1449		ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1450		if (ret)
1451			return ret;
1452
1453		dma_fence_put(new_plane_state->fence);
1454		new_plane_state->fence = NULL;
1455	}
1456
1457	return 0;
1458}
1459EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1460
1461/**
1462 * drm_atomic_helper_wait_for_vblanks - wait for vblank on CRTCs
1463 * @dev: DRM device
1464 * @old_state: atomic state object with old state structures
1465 *
1466 * Helper to, after atomic commit, wait for vblanks on all affected
1467 * CRTCs (ie. before cleaning up old framebuffers using
1468 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1469 * framebuffers have actually changed to optimize for the legacy cursor and
1470 * plane update use-case.
1471 *
1472 * Drivers using the nonblocking commit tracking support initialized by calling
1473 * drm_atomic_helper_setup_commit() should look at
1474 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1475 */
1476void
1477drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1478		struct drm_atomic_state *old_state)
1479{
1480	struct drm_crtc *crtc;
1481	struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1482	int i, ret;
1483	unsigned int crtc_mask = 0;
1484
1485	 /*
1486	  * Legacy cursor ioctls are completely unsynced, and userspace
1487	  * relies on that (by doing tons of cursor updates).
1488	  */
1489	if (old_state->legacy_cursor_update)
1490		return;
1491
1492	for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1493		if (!new_crtc_state->active)
1494			continue;
1495
1496		ret = drm_crtc_vblank_get(crtc);
1497		if (ret != 0)
1498			continue;
1499
1500		crtc_mask |= drm_crtc_mask(crtc);
1501		old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1502	}
1503
1504	for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1505		if (!(crtc_mask & drm_crtc_mask(crtc)))
1506			continue;
1507
1508		ret = wait_event_timeout(dev->vblank[i].queue,
1509				old_state->crtcs[i].last_vblank_count !=
1510					drm_crtc_vblank_count(crtc),
1511				msecs_to_jiffies(100));
1512
1513		WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1514		     crtc->base.id, crtc->name);
1515
1516		drm_crtc_vblank_put(crtc);
1517	}
1518}
1519EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1520
1521/**
1522 * drm_atomic_helper_wait_for_flip_done - wait for all page flips to be done
1523 * @dev: DRM device
1524 * @old_state: atomic state object with old state structures
1525 *
1526 * Helper to, after atomic commit, wait for page flips on all affected
1527 * crtcs (ie. before cleaning up old framebuffers using
1528 * drm_atomic_helper_cleanup_planes()). Compared to
1529 * drm_atomic_helper_wait_for_vblanks() this waits for the completion on all
1530 * CRTCs, assuming that cursors-only updates are signalling their completion
1531 * immediately (or using a different path).
1532 *
1533 * This requires that drivers use the nonblocking commit tracking support
1534 * initialized using drm_atomic_helper_setup_commit().
1535 */
1536void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
1537					  struct drm_atomic_state *old_state)
1538{
1539	struct drm_crtc *crtc;
1540	int i;
1541
1542	for (i = 0; i < dev->mode_config.num_crtc; i++) {
1543		struct drm_crtc_commit *commit = old_state->crtcs[i].commit;
1544		int ret;
1545
1546		crtc = old_state->crtcs[i].ptr;
1547
1548		if (!crtc || !commit)
1549			continue;
1550
1551		ret = wait_for_completion_timeout(&commit->flip_done, 10 * HZ);
1552		if (ret == 0)
1553			DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1554				  crtc->base.id, crtc->name);
1555	}
1556
1557	if (old_state->fake_commit)
1558		complete_all(&old_state->fake_commit->flip_done);
1559}
1560EXPORT_SYMBOL(drm_atomic_helper_wait_for_flip_done);
1561
1562/**
1563 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1564 * @old_state: atomic state object with old state structures
1565 *
1566 * This is the default implementation for the
1567 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1568 * that do not support runtime_pm or do not need the CRTC to be
1569 * enabled to perform a commit. Otherwise, see
1570 * drm_atomic_helper_commit_tail_rpm().
1571 *
1572 * Note that the default ordering of how the various stages are called is to
1573 * match the legacy modeset helper library closest.
1574 */
1575void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1576{
1577	struct drm_device *dev = old_state->dev;
1578
1579	drm_atomic_helper_commit_modeset_disables(dev, old_state);
1580
1581	drm_atomic_helper_commit_planes(dev, old_state, 0);
1582
1583	drm_atomic_helper_commit_modeset_enables(dev, old_state);
1584
1585	drm_atomic_helper_fake_vblank(old_state);
1586
1587	drm_atomic_helper_commit_hw_done(old_state);
1588
1589	drm_atomic_helper_wait_for_vblanks(dev, old_state);
1590
1591	drm_atomic_helper_cleanup_planes(dev, old_state);
1592}
1593EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1594
1595/**
1596 * drm_atomic_helper_commit_tail_rpm - commit atomic update to hardware
1597 * @old_state: new modeset state to be committed
1598 *
1599 * This is an alternative implementation for the
1600 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1601 * that support runtime_pm or need the CRTC to be enabled to perform a
1602 * commit. Otherwise, one should use the default implementation
1603 * drm_atomic_helper_commit_tail().
1604 */
1605void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *old_state)
1606{
1607	struct drm_device *dev = old_state->dev;
1608
1609	drm_atomic_helper_commit_modeset_disables(dev, old_state);
1610
1611	drm_atomic_helper_commit_modeset_enables(dev, old_state);
1612
1613	drm_atomic_helper_commit_planes(dev, old_state,
1614					DRM_PLANE_COMMIT_ACTIVE_ONLY);
1615
1616	drm_atomic_helper_fake_vblank(old_state);
1617
1618	drm_atomic_helper_commit_hw_done(old_state);
1619
1620	drm_atomic_helper_wait_for_vblanks(dev, old_state);
1621
1622	drm_atomic_helper_cleanup_planes(dev, old_state);
1623}
1624EXPORT_SYMBOL(drm_atomic_helper_commit_tail_rpm);
1625
1626static void commit_tail(struct drm_atomic_state *old_state)
1627{
1628	struct drm_device *dev = old_state->dev;
1629	const struct drm_mode_config_helper_funcs *funcs;
1630	struct drm_crtc_state *new_crtc_state;
1631	struct drm_crtc *crtc;
1632	ktime_t start;
1633	s64 commit_time_ms;
1634	unsigned int i, new_self_refresh_mask = 0;
1635
1636	funcs = dev->mode_config.helper_private;
1637
1638	/*
1639	 * We're measuring the _entire_ commit, so the time will vary depending
1640	 * on how many fences and objects are involved. For the purposes of self
1641	 * refresh, this is desirable since it'll give us an idea of how
1642	 * congested things are. This will inform our decision on how often we
1643	 * should enter self refresh after idle.
1644	 *
1645	 * These times will be averaged out in the self refresh helpers to avoid
1646	 * overreacting over one outlier frame
1647	 */
1648	start = ktime_get();
1649
1650	drm_atomic_helper_wait_for_fences(dev, old_state, false);
1651
1652	drm_atomic_helper_wait_for_dependencies(old_state);
1653
1654	/*
1655	 * We cannot safely access new_crtc_state after
1656	 * drm_atomic_helper_commit_hw_done() so figure out which crtc's have
1657	 * self-refresh active beforehand:
1658	 */
1659	for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i)
1660		if (new_crtc_state->self_refresh_active)
1661			new_self_refresh_mask |= BIT(i);
1662
1663	if (funcs && funcs->atomic_commit_tail)
1664		funcs->atomic_commit_tail(old_state);
1665	else
1666		drm_atomic_helper_commit_tail(old_state);
1667
1668	commit_time_ms = ktime_ms_delta(ktime_get(), start);
1669	if (commit_time_ms > 0)
1670		drm_self_refresh_helper_update_avg_times(old_state,
1671						 (unsigned long)commit_time_ms,
1672						 new_self_refresh_mask);
1673
1674	drm_atomic_helper_commit_cleanup_done(old_state);
1675
1676	drm_atomic_state_put(old_state);
1677}
1678
1679static void commit_work(struct work_struct *work)
1680{
1681	struct drm_atomic_state *state = container_of(work,
1682						      struct drm_atomic_state,
1683						      commit_work);
1684	commit_tail(state);
1685}
1686
1687/**
1688 * drm_atomic_helper_async_check - check if state can be commited asynchronously
1689 * @dev: DRM device
1690 * @state: the driver state object
1691 *
1692 * This helper will check if it is possible to commit the state asynchronously.
1693 * Async commits are not supposed to swap the states like normal sync commits
1694 * but just do in-place changes on the current state.
1695 *
1696 * It will return 0 if the commit can happen in an asynchronous fashion or error
1697 * if not. Note that error just mean it can't be commited asynchronously, if it
1698 * fails the commit should be treated like a normal synchronous commit.
1699 */
1700int drm_atomic_helper_async_check(struct drm_device *dev,
1701				   struct drm_atomic_state *state)
1702{
1703	struct drm_crtc *crtc;
1704	struct drm_crtc_state *crtc_state;
1705	struct drm_plane *plane = NULL;
1706	struct drm_plane_state *old_plane_state = NULL;
1707	struct drm_plane_state *new_plane_state = NULL;
1708	const struct drm_plane_helper_funcs *funcs;
1709	int i, n_planes = 0;
1710
1711	for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1712		if (drm_atomic_crtc_needs_modeset(crtc_state))
1713			return -EINVAL;
1714	}
1715
1716	for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i)
1717		n_planes++;
1718
1719	/* FIXME: we support only single plane updates for now */
1720	if (n_planes != 1)
1721		return -EINVAL;
1722
1723	if (!new_plane_state->crtc ||
1724	    old_plane_state->crtc != new_plane_state->crtc)
1725		return -EINVAL;
1726
1727	funcs = plane->helper_private;
1728	if (!funcs->atomic_async_update)
1729		return -EINVAL;
1730
1731	if (new_plane_state->fence)
1732		return -EINVAL;
1733
1734	/*
1735	 * Don't do an async update if there is an outstanding commit modifying
1736	 * the plane.  This prevents our async update's changes from getting
1737	 * overridden by a previous synchronous update's state.
1738	 */
1739	if (old_plane_state->commit &&
1740	    !try_wait_for_completion(&old_plane_state->commit->hw_done)) {
1741		DRM_DEBUG_ATOMIC("[PLANE:%d:%s] inflight previous commit preventing async commit\n",
1742			plane->base.id, plane->name);
1743		return -EBUSY;
1744	}
1745
1746	return funcs->atomic_async_check(plane, state);
1747}
1748EXPORT_SYMBOL(drm_atomic_helper_async_check);
1749
1750/**
1751 * drm_atomic_helper_async_commit - commit state asynchronously
1752 * @dev: DRM device
1753 * @state: the driver state object
1754 *
1755 * This function commits a state asynchronously, i.e., not vblank
1756 * synchronized. It should be used on a state only when
1757 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1758 * the states like normal sync commits, but just do in-place changes on the
1759 * current state.
1760 *
1761 * TODO: Implement full swap instead of doing in-place changes.
1762 */
1763void drm_atomic_helper_async_commit(struct drm_device *dev,
1764				    struct drm_atomic_state *state)
1765{
1766	struct drm_plane *plane;
1767	struct drm_plane_state *plane_state;
1768	const struct drm_plane_helper_funcs *funcs;
1769	int i;
1770
1771	for_each_new_plane_in_state(state, plane, plane_state, i) {
1772		struct drm_framebuffer *new_fb = plane_state->fb;
1773		struct drm_framebuffer *old_fb = plane->state->fb;
1774
1775		funcs = plane->helper_private;
1776		funcs->atomic_async_update(plane, state);
1777
1778		/*
1779		 * ->atomic_async_update() is supposed to update the
1780		 * plane->state in-place, make sure at least common
1781		 * properties have been properly updated.
1782		 */
1783		WARN_ON_ONCE(plane->state->fb != new_fb);
1784		WARN_ON_ONCE(plane->state->crtc_x != plane_state->crtc_x);
1785		WARN_ON_ONCE(plane->state->crtc_y != plane_state->crtc_y);
1786		WARN_ON_ONCE(plane->state->src_x != plane_state->src_x);
1787		WARN_ON_ONCE(plane->state->src_y != plane_state->src_y);
1788
1789		/*
1790		 * Make sure the FBs have been swapped so that cleanups in the
1791		 * new_state performs a cleanup in the old FB.
1792		 */
1793		WARN_ON_ONCE(plane_state->fb != old_fb);
1794	}
1795}
1796EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1797
1798/**
1799 * drm_atomic_helper_commit - commit validated state object
1800 * @dev: DRM device
1801 * @state: the driver state object
1802 * @nonblock: whether nonblocking behavior is requested.
1803 *
1804 * This function commits a with drm_atomic_helper_check() pre-validated state
1805 * object. This can still fail when e.g. the framebuffer reservation fails. This
1806 * function implements nonblocking commits, using
1807 * drm_atomic_helper_setup_commit() and related functions.
1808 *
1809 * Committing the actual hardware state is done through the
1810 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or its default
1811 * implementation drm_atomic_helper_commit_tail().
1812 *
1813 * RETURNS:
1814 * Zero for success or -errno.
1815 */
1816int drm_atomic_helper_commit(struct drm_device *dev,
1817			     struct drm_atomic_state *state,
1818			     bool nonblock)
1819{
1820	int ret;
1821
1822	if (state->async_update) {
1823		ret = drm_atomic_helper_prepare_planes(dev, state);
1824		if (ret)
1825			return ret;
1826
1827		drm_atomic_helper_async_commit(dev, state);
1828		drm_atomic_helper_cleanup_planes(dev, state);
1829
1830		return 0;
1831	}
1832
1833	ret = drm_atomic_helper_setup_commit(state, nonblock);
1834	if (ret)
1835		return ret;
1836
1837	INIT_WORK(&state->commit_work, commit_work);
1838
1839	ret = drm_atomic_helper_prepare_planes(dev, state);
1840	if (ret)
1841		return ret;
1842
1843	if (!nonblock) {
1844		ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1845		if (ret)
1846			goto err;
1847	}
1848
1849	/*
1850	 * This is the point of no return - everything below never fails except
1851	 * when the hw goes bonghits. Which means we can commit the new state on
1852	 * the software side now.
1853	 */
1854
1855	ret = drm_atomic_helper_swap_state(state, true);
1856	if (ret)
1857		goto err;
1858
1859	/*
1860	 * Everything below can be run asynchronously without the need to grab
1861	 * any modeset locks at all under one condition: It must be guaranteed
1862	 * that the asynchronous work has either been cancelled (if the driver
1863	 * supports it, which at least requires that the framebuffers get
1864	 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1865	 * before the new state gets committed on the software side with
1866	 * drm_atomic_helper_swap_state().
1867	 *
1868	 * This scheme allows new atomic state updates to be prepared and
1869	 * checked in parallel to the asynchronous completion of the previous
1870	 * update. Which is important since compositors need to figure out the
1871	 * composition of the next frame right after having submitted the
1872	 * current layout.
1873	 *
1874	 * NOTE: Commit work has multiple phases, first hardware commit, then
1875	 * cleanup. We want them to overlap, hence need system_unbound_wq to
1876	 * make sure work items don't artificially stall on each another.
1877	 */
1878
1879	drm_atomic_state_get(state);
1880	if (nonblock)
1881		queue_work(system_unbound_wq, &state->commit_work);
1882	else
1883		commit_tail(state);
1884
1885	return 0;
1886
1887err:
1888	drm_atomic_helper_cleanup_planes(dev, state);
1889	return ret;
1890}
1891EXPORT_SYMBOL(drm_atomic_helper_commit);
1892
1893/**
1894 * DOC: implementing nonblocking commit
1895 *
1896 * Nonblocking atomic commits should use struct &drm_crtc_commit to sequence
1897 * different operations against each another. Locks, especially struct
1898 * &drm_modeset_lock, should not be held in worker threads or any other
1899 * asynchronous context used to commit the hardware state.
1900 *
1901 * drm_atomic_helper_commit() implements the recommended sequence for
1902 * nonblocking commits, using drm_atomic_helper_setup_commit() internally:
1903 *
1904 * 1. Run drm_atomic_helper_prepare_planes(). Since this can fail and we
1905 * need to propagate out of memory/VRAM errors to userspace, it must be called
1906 * synchronously.
1907 *
1908 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1909 * might be affected by the new state update. This is handled by
1910 * drm_atomic_helper_setup_commit().
1911 *
1912 * Asynchronous workers need to have sufficient parallelism to be able to run
1913 * different atomic commits on different CRTCs in parallel. The simplest way to
1914 * achieve this is by running them on the &system_unbound_wq work queue. Note
1915 * that drivers are not required to split up atomic commits and run an
1916 * individual commit in parallel - userspace is supposed to do that if it cares.
1917 * But it might be beneficial to do that for modesets, since those necessarily
1918 * must be done as one global operation, and enabling or disabling a CRTC can
1919 * take a long time. But even that is not required.
1920 *
1921 * IMPORTANT: A &drm_atomic_state update for multiple CRTCs is sequenced
1922 * against all CRTCs therein. Therefore for atomic state updates which only flip
1923 * planes the driver must not get the struct &drm_crtc_state of unrelated CRTCs
1924 * in its atomic check code: This would prevent committing of atomic updates to
1925 * multiple CRTCs in parallel. In general, adding additional state structures
1926 * should be avoided as much as possible, because this reduces parallelism in
1927 * (nonblocking) commits, both due to locking and due to commit sequencing
1928 * requirements.
1929 *
1930 * 3. The software state is updated synchronously with
1931 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1932 * locks means concurrent callers never see inconsistent state. Note that commit
1933 * workers do not hold any locks; their access is only coordinated through
1934 * ordering. If workers would access state only through the pointers in the
1935 * free-standing state objects (currently not the case for any driver) then even
1936 * multiple pending commits could be in-flight at the same time.
1937 *
1938 * 4. Schedule a work item to do all subsequent steps, using the split-out
1939 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1940 * then cleaning up the framebuffers after the old framebuffer is no longer
1941 * being displayed. The scheduled work should synchronize against other workers
1942 * using the &drm_crtc_commit infrastructure as needed. See
1943 * drm_atomic_helper_setup_commit() for more details.
1944 */
1945
1946static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1947{
1948	struct drm_crtc_commit *commit, *stall_commit = NULL;
1949	bool completed = true;
1950	int i;
1951	long ret = 0;
1952
1953	spin_lock(&crtc->commit_lock);
1954	i = 0;
1955	list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1956		if (i == 0) {
1957			completed = try_wait_for_completion(&commit->flip_done);
1958			/*
1959			 * Userspace is not allowed to get ahead of the previous
1960			 * commit with nonblocking ones.
1961			 */
1962			if (!completed && nonblock) {
1963				spin_unlock(&crtc->commit_lock);
1964				DRM_DEBUG_ATOMIC("[CRTC:%d:%s] busy with a previous commit\n",
1965					crtc->base.id, crtc->name);
1966
1967				return -EBUSY;
1968			}
1969		} else if (i == 1) {
1970			stall_commit = drm_crtc_commit_get(commit);
1971			break;
1972		}
1973
1974		i++;
1975	}
1976	spin_unlock(&crtc->commit_lock);
1977
1978	if (!stall_commit)
1979		return 0;
1980
1981	/* We don't want to let commits get ahead of cleanup work too much,
1982	 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1983	 */
1984	ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1985							10*HZ);
1986	if (ret == 0)
1987		DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1988			  crtc->base.id, crtc->name);
1989
1990	drm_crtc_commit_put(stall_commit);
1991
1992	return ret < 0 ? ret : 0;
1993}
1994
1995static void release_crtc_commit(struct completion *completion)
1996{
1997	struct drm_crtc_commit *commit = container_of(completion,
1998						      typeof(*commit),
1999						      flip_done);
2000
2001	drm_crtc_commit_put(commit);
2002}
2003
2004static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
2005{
2006	init_completion(&commit->flip_done);
2007	init_completion(&commit->hw_done);
2008	init_completion(&commit->cleanup_done);
2009	INIT_LIST_HEAD(&commit->commit_entry);
2010	kref_init(&commit->ref);
2011	commit->crtc = crtc;
2012}
2013
2014static struct drm_crtc_commit *
2015crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
2016{
2017	if (crtc) {
2018		struct drm_crtc_state *new_crtc_state;
2019
2020		new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
2021
2022		return new_crtc_state->commit;
2023	}
2024
2025	if (!state->fake_commit) {
2026		state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
2027		if (!state->fake_commit)
2028			return NULL;
2029
2030		init_commit(state->fake_commit, NULL);
2031	}
2032
2033	return state->fake_commit;
2034}
2035
2036/**
2037 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
2038 * @state: new modeset state to be committed
2039 * @nonblock: whether nonblocking behavior is requested.
2040 *
2041 * This function prepares @state to be used by the atomic helper's support for
2042 * nonblocking commits. Drivers using the nonblocking commit infrastructure
2043 * should always call this function from their
2044 * &drm_mode_config_funcs.atomic_commit hook.
2045 *
2046 * Drivers that need to extend the commit setup to private objects can use the
2047 * &drm_mode_config_helper_funcs.atomic_commit_setup hook.
2048 *
2049 * To be able to use this support drivers need to use a few more helper
2050 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
2051 * actually committing the hardware state, and for nonblocking commits this call
2052 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
2053 * and its stall parameter, for when a driver's commit hooks look at the
2054 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
2055 *
2056 * Completion of the hardware commit step must be signalled using
2057 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
2058 * to read or change any permanent software or hardware modeset state. The only
2059 * exception is state protected by other means than &drm_modeset_lock locks.
2060 * Only the free standing @state with pointers to the old state structures can
2061 * be inspected, e.g. to clean up old buffers using
2062 * drm_atomic_helper_cleanup_planes().
2063 *
2064 * At the very end, before cleaning up @state drivers must call
2065 * drm_atomic_helper_commit_cleanup_done().
2066 *
2067 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
2068 * complete and easy-to-use default implementation of the atomic_commit() hook.
2069 *
2070 * The tracking of asynchronously executed and still pending commits is done
2071 * using the core structure &drm_crtc_commit.
2072 *
2073 * By default there's no need to clean up resources allocated by this function
2074 * explicitly: drm_atomic_state_default_clear() will take care of that
2075 * automatically.
2076 *
2077 * Returns:
2078 *
2079 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
2080 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
2081 */
2082int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
2083				   bool nonblock)
2084{
2085	struct drm_crtc *crtc;
2086	struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2087	struct drm_connector *conn;
2088	struct drm_connector_state *old_conn_state, *new_conn_state;
2089	struct drm_plane *plane;
2090	struct drm_plane_state *old_plane_state, *new_plane_state;
2091	struct drm_crtc_commit *commit;
2092	const struct drm_mode_config_helper_funcs *funcs;
2093	int i, ret;
2094
2095	funcs = state->dev->mode_config.helper_private;
2096
2097	for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2098		commit = kzalloc(sizeof(*commit), GFP_KERNEL);
2099		if (!commit)
2100			return -ENOMEM;
2101
2102		init_commit(commit, crtc);
2103
2104		new_crtc_state->commit = commit;
2105
2106		ret = stall_checks(crtc, nonblock);
2107		if (ret)
2108			return ret;
2109
2110		/*
2111		 * Drivers only send out events when at least either current or
2112		 * new CRTC state is active. Complete right away if everything
2113		 * stays off.
2114		 */
2115		if (!old_crtc_state->active && !new_crtc_state->active) {
2116			complete_all(&commit->flip_done);
2117			continue;
2118		}
2119
2120		/* Legacy cursor updates are fully unsynced. */
2121		if (state->legacy_cursor_update) {
2122			complete_all(&commit->flip_done);
2123			continue;
2124		}
2125
2126		if (!new_crtc_state->event) {
2127			commit->event = kzalloc(sizeof(*commit->event),
2128						GFP_KERNEL);
2129			if (!commit->event)
2130				return -ENOMEM;
2131
2132			new_crtc_state->event = commit->event;
2133		}
2134
2135		new_crtc_state->event->base.completion = &commit->flip_done;
2136		new_crtc_state->event->base.completion_release = release_crtc_commit;
2137		drm_crtc_commit_get(commit);
2138
2139		commit->abort_completion = true;
2140
2141		state->crtcs[i].commit = commit;
2142		drm_crtc_commit_get(commit);
2143	}
2144
2145	for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
2146		/*
2147		 * Userspace is not allowed to get ahead of the previous
2148		 * commit with nonblocking ones.
2149		 */
2150		if (nonblock && old_conn_state->commit &&
2151		    !try_wait_for_completion(&old_conn_state->commit->flip_done)) {
2152			DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] busy with a previous commit\n",
2153				conn->base.id, conn->name);
2154
2155			return -EBUSY;
2156		}
2157
2158		/* Always track connectors explicitly for e.g. link retraining. */
2159		commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
2160		if (!commit)
2161			return -ENOMEM;
2162
2163		new_conn_state->commit = drm_crtc_commit_get(commit);
2164	}
2165
2166	for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2167		/*
2168		 * Userspace is not allowed to get ahead of the previous
2169		 * commit with nonblocking ones.
2170		 */
2171		if (nonblock && old_plane_state->commit &&
2172		    !try_wait_for_completion(&old_plane_state->commit->flip_done)) {
2173			DRM_DEBUG_ATOMIC("[PLANE:%d:%s] busy with a previous commit\n",
2174				plane->base.id, plane->name);
2175
2176			return -EBUSY;
2177		}
2178
2179		/* Always track planes explicitly for async pageflip support. */
2180		commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
2181		if (!commit)
2182			return -ENOMEM;
2183
2184		new_plane_state->commit = drm_crtc_commit_get(commit);
2185	}
2186
2187	if (funcs && funcs->atomic_commit_setup)
2188		return funcs->atomic_commit_setup(state);
2189
2190	return 0;
2191}
2192EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
2193
2194/**
2195 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
2196 * @old_state: atomic state object with old state structures
2197 *
2198 * This function waits for all preceeding commits that touch the same CRTC as
2199 * @old_state to both be committed to the hardware (as signalled by
2200 * drm_atomic_helper_commit_hw_done()) and executed by the hardware (as signalled
2201 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
2202 *
2203 * This is part of the atomic helper support for nonblocking commits, see
2204 * drm_atomic_helper_setup_commit() for an overview.
2205 */
2206void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
2207{
2208	struct drm_crtc *crtc;
2209	struct drm_crtc_state *old_crtc_state;
2210	struct drm_plane *plane;
2211	struct drm_plane_state *old_plane_state;
2212	struct drm_connector *conn;
2213	struct drm_connector_state *old_conn_state;
2214	int i;
2215	long ret;
2216
2217	for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2218		ret = drm_crtc_commit_wait(old_crtc_state->commit);
2219		if (ret)
2220			DRM_ERROR("[CRTC:%d:%s] commit wait timed out\n",
2221				  crtc->base.id, crtc->name);
2222	}
2223
2224	for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
2225		ret = drm_crtc_commit_wait(old_conn_state->commit);
2226		if (ret)
2227			DRM_ERROR("[CONNECTOR:%d:%s] commit wait timed out\n",
2228				  conn->base.id, conn->name);
2229	}
2230
2231	for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
2232		ret = drm_crtc_commit_wait(old_plane_state->commit);
2233		if (ret)
2234			DRM_ERROR("[PLANE:%d:%s] commit wait timed out\n",
2235				  plane->base.id, plane->name);
2236	}
2237}
2238EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2239
2240/**
2241 * drm_atomic_helper_fake_vblank - fake VBLANK events if needed
2242 * @old_state: atomic state object with old state structures
2243 *
2244 * This function walks all CRTCs and fakes VBLANK events on those with
2245 * &drm_crtc_state.no_vblank set to true and &drm_crtc_state.event != NULL.
2246 * The primary use of this function is writeback connectors working in oneshot
2247 * mode and faking VBLANK events. In this case they only fake the VBLANK event
2248 * when a job is queued, and any change to the pipeline that does not touch the
2249 * connector is leading to timeouts when calling
2250 * drm_atomic_helper_wait_for_vblanks() or
2251 * drm_atomic_helper_wait_for_flip_done(). In addition to writeback
2252 * connectors, this function can also fake VBLANK events for CRTCs without
2253 * VBLANK interrupt.
2254 *
2255 * This is part of the atomic helper support for nonblocking commits, see
2256 * drm_atomic_helper_setup_commit() for an overview.
2257 */
2258void drm_atomic_helper_fake_vblank(struct drm_atomic_state *old_state)
2259{
2260	struct drm_crtc_state *new_crtc_state;
2261	struct drm_crtc *crtc;
2262	int i;
2263
2264	for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
2265		unsigned long flags;
2266
2267		if (!new_crtc_state->no_vblank)
2268			continue;
2269
2270		spin_lock_irqsave(&old_state->dev->event_lock, flags);
2271		if (new_crtc_state->event) {
2272			drm_crtc_send_vblank_event(crtc,
2273						   new_crtc_state->event);
2274			new_crtc_state->event = NULL;
2275		}
2276		spin_unlock_irqrestore(&old_state->dev->event_lock, flags);
2277	}
2278}
2279EXPORT_SYMBOL(drm_atomic_helper_fake_vblank);
2280
2281/**
2282 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2283 * @old_state: atomic state object with old state structures
2284 *
2285 * This function is used to signal completion of the hardware commit step. After
2286 * this step the driver is not allowed to read or change any permanent software
2287 * or hardware modeset state. The only exception is state protected by other
2288 * means than &drm_modeset_lock locks.
2289 *
2290 * Drivers should try to postpone any expensive or delayed cleanup work after
2291 * this function is called.
2292 *
2293 * This is part of the atomic helper support for nonblocking commits, see
2294 * drm_atomic_helper_setup_commit() for an overview.
2295 */
2296void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2297{
2298	struct drm_crtc *crtc;
2299	struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2300	struct drm_crtc_commit *commit;
2301	int i;
2302
2303	for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2304		commit = new_crtc_state->commit;
2305		if (!commit)
2306			continue;
2307
2308		/*
2309		 * copy new_crtc_state->commit to old_crtc_state->commit,
2310		 * it's unsafe to touch new_crtc_state after hw_done,
2311		 * but we still need to do so in cleanup_done().
2312		 */
2313		if (old_crtc_state->commit)
2314			drm_crtc_commit_put(old_crtc_state->commit);
2315
2316		old_crtc_state->commit = drm_crtc_commit_get(commit);
2317
2318		/* backend must have consumed any event by now */
2319		WARN_ON(new_crtc_state->event);
2320		complete_all(&commit->hw_done);
2321	}
2322
2323	if (old_state->fake_commit) {
2324		complete_all(&old_state->fake_commit->hw_done);
2325		complete_all(&old_state->fake_commit->flip_done);
2326	}
2327}
2328EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2329
2330/**
2331 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2332 * @old_state: atomic state object with old state structures
2333 *
2334 * This signals completion of the atomic update @old_state, including any
2335 * cleanup work. If used, it must be called right before calling
2336 * drm_atomic_state_put().
2337 *
2338 * This is part of the atomic helper support for nonblocking commits, see
2339 * drm_atomic_helper_setup_commit() for an overview.
2340 */
2341void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2342{
2343	struct drm_crtc *crtc;
2344	struct drm_crtc_state *old_crtc_state;
2345	struct drm_crtc_commit *commit;
2346	int i;
2347
2348	for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2349		commit = old_crtc_state->commit;
2350		if (WARN_ON(!commit))
2351			continue;
2352
2353		complete_all(&commit->cleanup_done);
2354		WARN_ON(!try_wait_for_completion(&commit->hw_done));
2355
2356		spin_lock(&crtc->commit_lock);
2357		list_del(&commit->commit_entry);
2358		spin_unlock(&crtc->commit_lock);
2359	}
2360
2361	if (old_state->fake_commit) {
2362		complete_all(&old_state->fake_commit->cleanup_done);
2363		WARN_ON(!try_wait_for_completion(&old_state->fake_commit->hw_done));
2364	}
2365}
2366EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2367
2368/**
2369 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2370 * @dev: DRM device
2371 * @state: atomic state object with new state structures
2372 *
2373 * This function prepares plane state, specifically framebuffers, for the new
2374 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2375 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2376 * any already successfully prepared framebuffer.
2377 *
2378 * Returns:
2379 * 0 on success, negative error code on failure.
2380 */
2381int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2382				     struct drm_atomic_state *state)
2383{
2384	struct drm_connector *connector;
2385	struct drm_connector_state *new_conn_state;
2386	struct drm_plane *plane;
2387	struct drm_plane_state *new_plane_state;
2388	int ret, i, j;
2389
2390	for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2391		if (!new_conn_state->writeback_job)
2392			continue;
2393
2394		ret = drm_writeback_prepare_job(new_conn_state->writeback_job);
2395		if (ret < 0)
2396			return ret;
2397	}
2398
2399	for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2400		const struct drm_plane_helper_funcs *funcs;
2401
2402		funcs = plane->helper_private;
2403
2404		if (funcs->prepare_fb) {
2405			ret = funcs->prepare_fb(plane, new_plane_state);
2406			if (ret)
2407				goto fail;
2408		}
2409	}
2410
2411	return 0;
2412
2413fail:
2414	for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2415		const struct drm_plane_helper_funcs *funcs;
2416
2417		if (j >= i)
2418			continue;
2419
2420		funcs = plane->helper_private;
2421
2422		if (funcs->cleanup_fb)
2423			funcs->cleanup_fb(plane, new_plane_state);
2424	}
2425
2426	return ret;
2427}
2428EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2429
2430static bool plane_crtc_active(const struct drm_plane_state *state)
2431{
2432	return state->crtc && state->crtc->state->active;
2433}
2434
2435/**
2436 * drm_atomic_helper_commit_planes - commit plane state
2437 * @dev: DRM device
2438 * @old_state: atomic state object with old state structures
2439 * @flags: flags for committing plane state
2440 *
2441 * This function commits the new plane state using the plane and atomic helper
2442 * functions for planes and CRTCs. It assumes that the atomic state has already
2443 * been pushed into the relevant object state pointers, since this step can no
2444 * longer fail.
2445 *
2446 * It still requires the global state object @old_state to know which planes and
2447 * crtcs need to be updated though.
2448 *
2449 * Note that this function does all plane updates across all CRTCs in one step.
2450 * If the hardware can't support this approach look at
2451 * drm_atomic_helper_commit_planes_on_crtc() instead.
2452 *
2453 * Plane parameters can be updated by applications while the associated CRTC is
2454 * disabled. The DRM/KMS core will store the parameters in the plane state,
2455 * which will be available to the driver when the CRTC is turned on. As a result
2456 * most drivers don't need to be immediately notified of plane updates for a
2457 * disabled CRTC.
2458 *
2459 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2460 * @flags in order not to receive plane update notifications related to a
2461 * disabled CRTC. This avoids the need to manually ignore plane updates in
2462 * driver code when the driver and/or hardware can't or just don't need to deal
2463 * with updates on disabled CRTCs, for example when supporting runtime PM.
2464 *
2465 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2466 * display controllers require to disable a CRTC's planes when the CRTC is
2467 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2468 * call for a plane if the CRTC of the old plane state needs a modesetting
2469 * operation. Of course, the drivers need to disable the planes in their CRTC
2470 * disable callbacks since no one else would do that.
2471 *
2472 * The drm_atomic_helper_commit() default implementation doesn't set the
2473 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2474 * This should not be copied blindly by drivers.
2475 */
2476void drm_atomic_helper_commit_planes(struct drm_device *dev,
2477				     struct drm_atomic_state *old_state,
2478				     uint32_t flags)
2479{
2480	struct drm_crtc *crtc;
2481	struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2482	struct drm_plane *plane;
2483	struct drm_plane_state *old_plane_state, *new_plane_state;
2484	int i;
2485	bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2486	bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2487
2488	for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2489		const struct drm_crtc_helper_funcs *funcs;
2490
2491		funcs = crtc->helper_private;
2492
2493		if (!funcs || !funcs->atomic_begin)
2494			continue;
2495
2496		if (active_only && !new_crtc_state->active)
2497			continue;
2498
2499		funcs->atomic_begin(crtc, old_state);
2500	}
2501
2502	for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2503		const struct drm_plane_helper_funcs *funcs;
2504		bool disabling;
2505
2506		funcs = plane->helper_private;
2507
2508		if (!funcs)
2509			continue;
2510
2511		disabling = drm_atomic_plane_disabling(old_plane_state,
2512						       new_plane_state);
2513
2514		if (active_only) {
2515			/*
2516			 * Skip planes related to inactive CRTCs. If the plane
2517			 * is enabled use the state of the current CRTC. If the
2518			 * plane is being disabled use the state of the old
2519			 * CRTC to avoid skipping planes being disabled on an
2520			 * active CRTC.
2521			 */
2522			if (!disabling && !plane_crtc_active(new_plane_state))
2523				continue;
2524			if (disabling && !plane_crtc_active(old_plane_state))
2525				continue;
2526		}
2527
2528		/*
2529		 * Special-case disabling the plane if drivers support it.
2530		 */
2531		if (disabling && funcs->atomic_disable) {
2532			struct drm_crtc_state *crtc_state;
2533
2534			crtc_state = old_plane_state->crtc->state;
2535
2536			if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2537			    no_disable)
2538				continue;
2539
2540			funcs->atomic_disable(plane, old_state);
2541		} else if (new_plane_state->crtc || disabling) {
2542			funcs->atomic_update(plane, old_state);
2543		}
2544	}
2545
2546	for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2547		const struct drm_crtc_helper_funcs *funcs;
2548
2549		funcs = crtc->helper_private;
2550
2551		if (!funcs || !funcs->atomic_flush)
2552			continue;
2553
2554		if (active_only && !new_crtc_state->active)
2555			continue;
2556
2557		funcs->atomic_flush(crtc, old_state);
2558	}
2559}
2560EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2561
2562/**
2563 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a CRTC
2564 * @old_crtc_state: atomic state object with the old CRTC state
2565 *
2566 * This function commits the new plane state using the plane and atomic helper
2567 * functions for planes on the specific CRTC. It assumes that the atomic state
2568 * has already been pushed into the relevant object state pointers, since this
2569 * step can no longer fail.
2570 *
2571 * This function is useful when plane updates should be done CRTC-by-CRTC
2572 * instead of one global step like drm_atomic_helper_commit_planes() does.
2573 *
2574 * This function can only be savely used when planes are not allowed to move
2575 * between different CRTCs because this function doesn't handle inter-CRTC
2576 * depencies. Callers need to ensure that either no such depencies exist,
2577 * resolve them through ordering of commit calls or through some other means.
2578 */
2579void
2580drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2581{
2582	const struct drm_crtc_helper_funcs *crtc_funcs;
2583	struct drm_crtc *crtc = old_crtc_state->crtc;
2584	struct drm_atomic_state *old_state = old_crtc_state->state;
2585	struct drm_crtc_state *new_crtc_state =
2586		drm_atomic_get_new_crtc_state(old_state, crtc);
2587	struct drm_plane *plane;
2588	unsigned int plane_mask;
2589
2590	plane_mask = old_crtc_state->plane_mask;
2591	plane_mask |= new_crtc_state->plane_mask;
2592
2593	crtc_funcs = crtc->helper_private;
2594	if (crtc_funcs && crtc_funcs->atomic_begin)
2595		crtc_funcs->atomic_begin(crtc, old_state);
2596
2597	drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2598		struct drm_plane_state *old_plane_state =
2599			drm_atomic_get_old_plane_state(old_state, plane);
2600		struct drm_plane_state *new_plane_state =
2601			drm_atomic_get_new_plane_state(old_state, plane);
2602		const struct drm_plane_helper_funcs *plane_funcs;
2603
2604		plane_funcs = plane->helper_private;
2605
2606		if (!old_plane_state || !plane_funcs)
2607			continue;
2608
2609		WARN_ON(new_plane_state->crtc &&
2610			new_plane_state->crtc != crtc);
2611
2612		if (drm_atomic_plane_disabling(old_plane_state, new_plane_state) &&
2613		    plane_funcs->atomic_disable)
2614			plane_funcs->atomic_disable(plane, old_state);
2615		else if (new_plane_state->crtc ||
2616			 drm_atomic_plane_disabling(old_plane_state, new_plane_state))
2617			plane_funcs->atomic_update(plane, old_state);
2618	}
2619
2620	if (crtc_funcs && crtc_funcs->atomic_flush)
2621		crtc_funcs->atomic_flush(crtc, old_state);
2622}
2623EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2624
2625/**
2626 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2627 * @old_crtc_state: atomic state object with the old CRTC state
2628 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2629 *
2630 * Disables all planes associated with the given CRTC. This can be
2631 * used for instance in the CRTC helper atomic_disable callback to disable
2632 * all planes.
2633 *
2634 * If the atomic-parameter is set the function calls the CRTC's
2635 * atomic_begin hook before and atomic_flush hook after disabling the
2636 * planes.
2637 *
2638 * It is a bug to call this function without having implemented the
2639 * &drm_plane_helper_funcs.atomic_disable plane hook.
2640 */
2641void
2642drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2643					 bool atomic)
2644{
2645	struct drm_crtc *crtc = old_crtc_state->crtc;
2646	const struct drm_crtc_helper_funcs *crtc_funcs =
2647		crtc->helper_private;
2648	struct drm_plane *plane;
2649
2650	if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2651		crtc_funcs->atomic_begin(crtc, NULL);
2652
2653	drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2654		const struct drm_plane_helper_funcs *plane_funcs =
2655			plane->helper_private;
2656
2657		if (!plane_funcs)
2658			continue;
2659
2660		WARN_ON(!plane_funcs->atomic_disable);
2661		if (plane_funcs->atomic_disable)
2662			plane_funcs->atomic_disable(plane, NULL);
2663	}
2664
2665	if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2666		crtc_funcs->atomic_flush(crtc, NULL);
2667}
2668EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2669
2670/**
2671 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2672 * @dev: DRM device
2673 * @old_state: atomic state object with old state structures
2674 *
2675 * This function cleans up plane state, specifically framebuffers, from the old
2676 * configuration. Hence the old configuration must be perserved in @old_state to
2677 * be able to call this function.
2678 *
2679 * This function must also be called on the new state when the atomic update
2680 * fails at any point after calling drm_atomic_helper_prepare_planes().
2681 */
2682void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2683				      struct drm_atomic_state *old_state)
2684{
2685	struct drm_plane *plane;
2686	struct drm_plane_state *old_plane_state, *new_plane_state;
2687	int i;
2688
2689	for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2690		const struct drm_plane_helper_funcs *funcs;
2691		struct drm_plane_state *plane_state;
2692
2693		/*
2694		 * This might be called before swapping when commit is aborted,
2695		 * in which case we have to cleanup the new state.
2696		 */
2697		if (old_plane_state == plane->state)
2698			plane_state = new_plane_state;
2699		else
2700			plane_state = old_plane_state;
2701
2702		funcs = plane->helper_private;
2703
2704		if (funcs->cleanup_fb)
2705			funcs->cleanup_fb(plane, plane_state);
2706	}
2707}
2708EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2709
2710/**
2711 * drm_atomic_helper_swap_state - store atomic state into current sw state
2712 * @state: atomic state
2713 * @stall: stall for preceeding commits
2714 *
2715 * This function stores the atomic state into the current state pointers in all
2716 * driver objects. It should be called after all failing steps have been done
2717 * and succeeded, but before the actual hardware state is committed.
2718 *
2719 * For cleanup and error recovery the current state for all changed objects will
2720 * be swapped into @state.
2721 *
2722 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2723 *
2724 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2725 *
2726 * 2. Do any other steps that might fail.
2727 *
2728 * 3. Put the staged state into the current state pointers with this function.
2729 *
2730 * 4. Actually commit the hardware state.
2731 *
2732 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2733 * contains the old state. Also do any other cleanup required with that state.
2734 *
2735 * @stall must be set when nonblocking commits for this driver directly access
2736 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2737 * the current atomic helpers this is almost always the case, since the helpers
2738 * don't pass the right state structures to the callbacks.
2739 *
2740 * Returns:
2741 *
2742 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2743 * waiting for the previous commits has been interrupted.
2744 */
2745int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2746				  bool stall)
2747{
2748	int i, ret;
2749	struct drm_connector *connector;
2750	struct drm_connector_state *old_conn_state, *new_conn_state;
2751	struct drm_crtc *crtc;
2752	struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2753	struct drm_plane *plane;
2754	struct drm_plane_state *old_plane_state, *new_plane_state;
2755	struct drm_crtc_commit *commit;
2756	struct drm_private_obj *obj;
2757	struct drm_private_state *old_obj_state, *new_obj_state;
2758
2759	if (stall) {
2760		/*
2761		 * We have to stall for hw_done here before
2762		 * drm_atomic_helper_wait_for_dependencies() because flip
2763		 * depth > 1 is not yet supported by all drivers. As long as
2764		 * obj->state is directly dereferenced anywhere in the drivers
2765		 * atomic_commit_tail function, then it's unsafe to swap state
2766		 * before drm_atomic_helper_commit_hw_done() is called.
2767		 */
2768
2769		for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2770			commit = old_crtc_state->commit;
2771
2772			if (!commit)
2773				continue;
2774
2775			ret = wait_for_completion_interruptible(&commit->hw_done);
2776			if (ret)
2777				return ret;
2778		}
2779
2780		for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2781			commit = old_conn_state->commit;
2782
2783			if (!commit)
2784				continue;
2785
2786			ret = wait_for_completion_interruptible(&commit->hw_done);
2787			if (ret)
2788				return ret;
2789		}
2790
2791		for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2792			commit = old_plane_state->commit;
2793
2794			if (!commit)
2795				continue;
2796
2797			ret = wait_for_completion_interruptible(&commit->hw_done);
2798			if (ret)
2799				return ret;
2800		}
2801	}
2802
2803	for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2804		WARN_ON(connector->state != old_conn_state);
2805
2806		old_conn_state->state = state;
2807		new_conn_state->state = NULL;
2808
2809		state->connectors[i].state = old_conn_state;
2810		connector->state = new_conn_state;
2811	}
2812
2813	for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2814		WARN_ON(crtc->state != old_crtc_state);
2815
2816		old_crtc_state->state = state;
2817		new_crtc_state->state = NULL;
2818
2819		state->crtcs[i].state = old_crtc_state;
2820		crtc->state = new_crtc_state;
2821
2822		if (new_crtc_state->commit) {
2823			spin_lock(&crtc->commit_lock);
2824			list_add(&new_crtc_state->commit->commit_entry,
2825				 &crtc->commit_list);
2826			spin_unlock(&crtc->commit_lock);
2827
2828			new_crtc_state->commit->event = NULL;
2829		}
2830	}
2831
2832	for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2833		WARN_ON(plane->state != old_plane_state);
2834
2835		old_plane_state->state = state;
2836		new_plane_state->state = NULL;
2837
2838		state->planes[i].state = old_plane_state;
2839		plane->state = new_plane_state;
2840	}
2841
2842	for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2843		WARN_ON(obj->state != old_obj_state);
2844
2845		old_obj_state->state = state;
2846		new_obj_state->state = NULL;
2847
2848		state->private_objs[i].state = old_obj_state;
2849		obj->state = new_obj_state;
2850	}
2851
2852	return 0;
2853}
2854EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2855
2856/**
2857 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2858 * @plane: plane object to update
2859 * @crtc: owning CRTC of owning plane
2860 * @fb: framebuffer to flip onto plane
2861 * @crtc_x: x offset of primary plane on @crtc
2862 * @crtc_y: y offset of primary plane on @crtc
2863 * @crtc_w: width of primary plane rectangle on @crtc
2864 * @crtc_h: height of primary plane rectangle on @crtc
2865 * @src_x: x offset of @fb for panning
2866 * @src_y: y offset of @fb for panning
2867 * @src_w: width of source rectangle in @fb
2868 * @src_h: height of source rectangle in @fb
2869 * @ctx: lock acquire context
2870 *
2871 * Provides a default plane update handler using the atomic driver interface.
2872 *
2873 * RETURNS:
2874 * Zero on success, error code on failure
2875 */
2876int drm_atomic_helper_update_plane(struct drm_plane *plane,
2877				   struct drm_crtc *crtc,
2878				   struct drm_framebuffer *fb,
2879				   int crtc_x, int crtc_y,
2880				   unsigned int crtc_w, unsigned int crtc_h,
2881				   uint32_t src_x, uint32_t src_y,
2882				   uint32_t src_w, uint32_t src_h,
2883				   struct drm_modeset_acquire_ctx *ctx)
2884{
2885	struct drm_atomic_state *state;
2886	struct drm_plane_state *plane_state;
2887	int ret = 0;
2888
2889	state = drm_atomic_state_alloc(plane->dev);
2890	if (!state)
2891		return -ENOMEM;
2892
2893	state->acquire_ctx = ctx;
2894	plane_state = drm_atomic_get_plane_state(state, plane);
2895	if (IS_ERR(plane_state)) {
2896		ret = PTR_ERR(plane_state);
2897		goto fail;
2898	}
2899
2900	ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2901	if (ret != 0)
2902		goto fail;
2903	drm_atomic_set_fb_for_plane(plane_state, fb);
2904	plane_state->crtc_x = crtc_x;
2905	plane_state->crtc_y = crtc_y;
2906	plane_state->crtc_w = crtc_w;
2907	plane_state->crtc_h = crtc_h;
2908	plane_state->src_x = src_x;
2909	plane_state->src_y = src_y;
2910	plane_state->src_w = src_w;
2911	plane_state->src_h = src_h;
2912
2913	if (plane == crtc->cursor)
2914		state->legacy_cursor_update = true;
2915
2916	ret = drm_atomic_commit(state);
2917fail:
2918	drm_atomic_state_put(state);
2919	return ret;
2920}
2921EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2922
2923/**
2924 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2925 * @plane: plane to disable
2926 * @ctx: lock acquire context
2927 *
2928 * Provides a default plane disable handler using the atomic driver interface.
2929 *
2930 * RETURNS:
2931 * Zero on success, error code on failure
2932 */
2933int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2934				    struct drm_modeset_acquire_ctx *ctx)
2935{
2936	struct drm_atomic_state *state;
2937	struct drm_plane_state *plane_state;
2938	int ret = 0;
2939
2940	state = drm_atomic_state_alloc(plane->dev);
2941	if (!state)
2942		return -ENOMEM;
2943
2944	state->acquire_ctx = ctx;
2945	plane_state = drm_atomic_get_plane_state(state, plane);
2946	if (IS_ERR(plane_state)) {
2947		ret = PTR_ERR(plane_state);
2948		goto fail;
2949	}
2950
2951	if (plane_state->crtc && plane_state->crtc->cursor == plane)
2952		plane_state->state->legacy_cursor_update = true;
2953
2954	ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2955	if (ret != 0)
2956		goto fail;
2957
2958	ret = drm_atomic_commit(state);
2959fail:
2960	drm_atomic_state_put(state);
2961	return ret;
2962}
2963EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2964
2965/**
2966 * drm_atomic_helper_set_config - set a new config from userspace
2967 * @set: mode set configuration
2968 * @ctx: lock acquisition context
2969 *
2970 * Provides a default CRTC set_config handler using the atomic driver interface.
2971 *
2972 * NOTE: For backwards compatibility with old userspace this automatically
2973 * resets the "link-status" property to GOOD, to force any link
2974 * re-training. The SETCRTC ioctl does not define whether an update does
2975 * need a full modeset or just a plane update, hence we're allowed to do
2976 * that. See also drm_connector_set_link_status_property().
2977 *
2978 * Returns:
2979 * Returns 0 on success, negative errno numbers on failure.
2980 */
2981int drm_atomic_helper_set_config(struct drm_mode_set *set,
2982				 struct drm_modeset_acquire_ctx *ctx)
2983{
2984	struct drm_atomic_state *state;
2985	struct drm_crtc *crtc = set->crtc;
2986	int ret = 0;
2987
2988	state = drm_atomic_state_alloc(crtc->dev);
2989	if (!state)
2990		return -ENOMEM;
2991
2992	state->acquire_ctx = ctx;
2993	ret = __drm_atomic_helper_set_config(set, state);
2994	if (ret != 0)
2995		goto fail;
2996
2997	ret = handle_conflicting_encoders(state, true);
2998	if (ret)
2999		goto fail;
3000
3001	ret = drm_atomic_commit(state);
3002
3003fail:
3004	drm_atomic_state_put(state);
3005	return ret;
3006}
3007EXPORT_SYMBOL(drm_atomic_helper_set_config);
3008
3009/**
3010 * drm_atomic_helper_disable_all - disable all currently active outputs
3011 * @dev: DRM device
3012 * @ctx: lock acquisition context
3013 *
3014 * Loops through all connectors, finding those that aren't turned off and then
3015 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
3016 * that they are connected to.
3017 *
3018 * This is used for example in suspend/resume to disable all currently active
3019 * functions when suspending. If you just want to shut down everything at e.g.
3020 * driver unload, look at drm_atomic_helper_shutdown().
3021 *
3022 * Note that if callers haven't already acquired all modeset locks this might
3023 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3024 *
3025 * Returns:
3026 * 0 on success or a negative error code on failure.
3027 *
3028 * See also:
3029 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
3030 * drm_atomic_helper_shutdown().
3031 */
3032int drm_atomic_helper_disable_all(struct drm_device *dev,
3033				  struct drm_modeset_acquire_ctx *ctx)
3034{
3035	struct drm_atomic_state *state;
3036	struct drm_connector_state *conn_state;
3037	struct drm_connector *conn;
3038	struct drm_plane_state *plane_state;
3039	struct drm_plane *plane;
3040	struct drm_crtc_state *crtc_state;
3041	struct drm_crtc *crtc;
3042	int ret, i;
3043
3044	state = drm_atomic_state_alloc(dev);
3045	if (!state)
3046		return -ENOMEM;
3047
3048	state->acquire_ctx = ctx;
3049
3050	drm_for_each_crtc(crtc, dev) {
3051		crtc_state = drm_atomic_get_crtc_state(state, crtc);
3052		if (IS_ERR(crtc_state)) {
3053			ret = PTR_ERR(crtc_state);
3054			goto free;
3055		}
3056
3057		crtc_state->active = false;
3058
3059		ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
3060		if (ret < 0)
3061			goto free;
3062
3063		ret = drm_atomic_add_affected_planes(state, crtc);
3064		if (ret < 0)
3065			goto free;
3066
3067		ret = drm_atomic_add_affected_connectors(state, crtc);
3068		if (ret < 0)
3069			goto free;
3070	}
3071
3072	for_each_new_connector_in_state(state, conn, conn_state, i) {
3073		ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
3074		if (ret < 0)
3075			goto free;
3076	}
3077
3078	for_each_new_plane_in_state(state, plane, plane_state, i) {
3079		ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
3080		if (ret < 0)
3081			goto free;
3082
3083		drm_atomic_set_fb_for_plane(plane_state, NULL);
3084	}
3085
3086	ret = drm_atomic_commit(state);
3087free:
3088	drm_atomic_state_put(state);
3089	return ret;
3090}
3091EXPORT_SYMBOL(drm_atomic_helper_disable_all);
3092
3093/**
3094 * drm_atomic_helper_shutdown - shutdown all CRTC
3095 * @dev: DRM device
3096 *
3097 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
3098 * suspend should instead be handled with drm_atomic_helper_suspend(), since
3099 * that also takes a snapshot of the modeset state to be restored on resume.
3100 *
3101 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
3102 * and it is the atomic version of drm_crtc_force_disable_all().
3103 */
3104void drm_atomic_helper_shutdown(struct drm_device *dev)
3105{
3106	struct drm_modeset_acquire_ctx ctx;
3107	int ret;
3108
3109	DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
3110
3111	ret = drm_atomic_helper_disable_all(dev, &ctx);
3112	if (ret)
3113		DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3114
3115	DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);
3116}
3117EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3118
3119/**
3120 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3121 * @dev: DRM device
3122 * @ctx: lock acquisition context
3123 *
3124 * Makes a copy of the current atomic state by looping over all objects and
3125 * duplicating their respective states. This is used for example by suspend/
3126 * resume support code to save the state prior to suspend such that it can
3127 * be restored upon resume.
3128 *
3129 * Note that this treats atomic state as persistent between save and restore.
3130 * Drivers must make sure that this is possible and won't result in confusion
3131 * or erroneous behaviour.
3132 *
3133 * Note that if callers haven't already acquired all modeset locks this might
3134 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3135 *
3136 * Returns:
3137 * A pointer to the copy of the atomic state object on success or an
3138 * ERR_PTR()-encoded error code on failure.
3139 *
3140 * See also:
3141 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3142 */
3143struct drm_atomic_state *
3144drm_atomic_helper_duplicate_state(struct drm_device *dev,
3145				  struct drm_modeset_acquire_ctx *ctx)
3146{
3147	struct drm_atomic_state *state;
3148	struct drm_connector *conn;
3149	struct drm_connector_list_iter conn_iter;
3150	struct drm_plane *plane;
3151	struct drm_crtc *crtc;
3152	int err = 0;
3153
3154	state = drm_atomic_state_alloc(dev);
3155	if (!state)
3156		return ERR_PTR(-ENOMEM);
3157
3158	state->acquire_ctx = ctx;
3159	state->duplicated = true;
3160
3161	drm_for_each_crtc(crtc, dev) {
3162		struct drm_crtc_state *crtc_state;
3163
3164		crtc_state = drm_atomic_get_crtc_state(state, crtc);
3165		if (IS_ERR(crtc_state)) {
3166			err = PTR_ERR(crtc_state);
3167			goto free;
3168		}
3169	}
3170
3171	drm_for_each_plane(plane, dev) {
3172		struct drm_plane_state *plane_state;
3173
3174		plane_state = drm_atomic_get_plane_state(state, plane);
3175		if (IS_ERR(plane_state)) {
3176			err = PTR_ERR(plane_state);
3177			goto free;
3178		}
3179	}
3180
3181	drm_connector_list_iter_begin(dev, &conn_iter);
3182	drm_for_each_connector_iter(conn, &conn_iter) {
3183		struct drm_connector_state *conn_state;
3184
3185		conn_state = drm_atomic_get_connector_state(state, conn);
3186		if (IS_ERR(conn_state)) {
3187			err = PTR_ERR(conn_state);
3188			drm_connector_list_iter_end(&conn_iter);
3189			goto free;
3190		}
3191	}
3192	drm_connector_list_iter_end(&conn_iter);
3193
3194	/* clear the acquire context so that it isn't accidentally reused */
3195	state->acquire_ctx = NULL;
3196
3197free:
3198	if (err < 0) {
3199		drm_atomic_state_put(state);
3200		state = ERR_PTR(err);
3201	}
3202
3203	return state;
3204}
3205EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3206
3207/**
3208 * drm_atomic_helper_suspend - subsystem-level suspend helper
3209 * @dev: DRM device
3210 *
3211 * Duplicates the current atomic state, disables all active outputs and then
3212 * returns a pointer to the original atomic state to the caller. Drivers can
3213 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3214 * restore the output configuration that was active at the time the system
3215 * entered suspend.
3216 *
3217 * Note that it is potentially unsafe to use this. The atomic state object
3218 * returned by this function is assumed to be persistent. Drivers must ensure
3219 * that this holds true. Before calling this function, drivers must make sure
3220 * to suspend fbdev emulation so that nothing can be using the device.
3221 *
3222 * Returns:
3223 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3224 * encoded error code on failure. Drivers should store the returned atomic
3225 * state object and pass it to the drm_atomic_helper_resume() helper upon
3226 * resume.
3227 *
3228 * See also:
3229 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3230 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3231 */
3232struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3233{
3234	struct drm_modeset_acquire_ctx ctx;
3235	struct drm_atomic_state *state;
3236	int err;
3237
3238	/* This can never be returned, but it makes the compiler happy */
3239	state = ERR_PTR(-EINVAL);
3240
3241	DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3242
3243	state = drm_atomic_helper_duplicate_state(dev, &ctx);
3244	if (IS_ERR(state))
3245		goto unlock;
3246
3247	err = drm_atomic_helper_disable_all(dev, &ctx);
3248	if (err < 0) {
3249		drm_atomic_state_put(state);
3250		state = ERR_PTR(err);
3251		goto unlock;
3252	}
3253
3254unlock:
3255	DRM_MODESET_LOCK_ALL_END(dev, ctx, err);
3256	if (err)
3257		return ERR_PTR(err);
3258
3259	return state;
3260}
3261EXPORT_SYMBOL(drm_atomic_helper_suspend);
3262
3263/**
3264 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3265 * @state: duplicated atomic state to commit
3266 * @ctx: pointer to acquire_ctx to use for commit.
3267 *
3268 * The state returned by drm_atomic_helper_duplicate_state() and
3269 * drm_atomic_helper_suspend() is partially invalid, and needs to
3270 * be fixed up before commit.
3271 *
3272 * Returns:
3273 * 0 on success or a negative error code on failure.
3274 *
3275 * See also:
3276 * drm_atomic_helper_suspend()
3277 */
3278int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3279					      struct drm_modeset_acquire_ctx *ctx)
3280{
3281	int i, ret;
3282	struct drm_plane *plane;
3283	struct drm_plane_state *new_plane_state;
3284	struct drm_connector *connector;
3285	struct drm_connector_state *new_conn_state;
3286	struct drm_crtc *crtc;
3287	struct drm_crtc_state *new_crtc_state;
3288
3289	state->acquire_ctx = ctx;
3290
3291	for_each_new_plane_in_state(state, plane, new_plane_state, i)
3292		state->planes[i].old_state = plane->state;
3293
3294	for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3295		state->crtcs[i].old_state = crtc->state;
3296
3297	for_each_new_connector_in_state(state, connector, new_conn_state, i)
3298		state->connectors[i].old_state = connector->state;
3299
3300	ret = drm_atomic_commit(state);
3301
3302	state->acquire_ctx = NULL;
3303
3304	return ret;
3305}
3306EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3307
3308/**
3309 * drm_atomic_helper_resume - subsystem-level resume helper
3310 * @dev: DRM device
3311 * @state: atomic state to resume to
3312 *
3313 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3314 * grabs all modeset locks and commits the atomic state object. This can be
3315 * used in conjunction with the drm_atomic_helper_suspend() helper to
3316 * implement suspend/resume for drivers that support atomic mode-setting.
3317 *
3318 * Returns:
3319 * 0 on success or a negative error code on failure.
3320 *
3321 * See also:
3322 * drm_atomic_helper_suspend()
3323 */
3324int drm_atomic_helper_resume(struct drm_device *dev,
3325			     struct drm_atomic_state *state)
3326{
3327	struct drm_modeset_acquire_ctx ctx;
3328	int err;
3329
3330	drm_mode_config_reset(dev);
3331
3332	DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3333
3334	err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3335
3336	DRM_MODESET_LOCK_ALL_END(dev, ctx, err);
3337	drm_atomic_state_put(state);
3338
3339	return err;
3340}
3341EXPORT_SYMBOL(drm_atomic_helper_resume);
3342
3343static int page_flip_common(struct drm_atomic_state *state,
3344			    struct drm_crtc *crtc,
3345			    struct drm_framebuffer *fb,
3346			    struct drm_pending_vblank_event *event,
3347			    uint32_t flags)
3348{
3349	struct drm_plane *plane = crtc->primary;
3350	struct drm_plane_state *plane_state;
3351	struct drm_crtc_state *crtc_state;
3352	int ret = 0;
3353
3354	crtc_state = drm_atomic_get_crtc_state(state, crtc);
3355	if (IS_ERR(crtc_state))
3356		return PTR_ERR(crtc_state);
3357
3358	crtc_state->event = event;
3359	crtc_state->async_flip = flags & DRM_MODE_PAGE_FLIP_ASYNC;
3360
3361	plane_state = drm_atomic_get_plane_state(state, plane);
3362	if (IS_ERR(plane_state))
3363		return PTR_ERR(plane_state);
3364
3365	ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3366	if (ret != 0)
3367		return ret;
3368	drm_atomic_set_fb_for_plane(plane_state, fb);
3369
3370	/* Make sure we don't accidentally do a full modeset. */
3371	state->allow_modeset = false;
3372	if (!crtc_state->active) {
3373		DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3374				 crtc->base.id, crtc->name);
3375		return -EINVAL;
3376	}
3377
3378	return ret;
3379}
3380
3381/**
3382 * drm_atomic_helper_page_flip - execute a legacy page flip
3383 * @crtc: DRM CRTC
3384 * @fb: DRM framebuffer
3385 * @event: optional DRM event to signal upon completion
3386 * @flags: flip flags for non-vblank sync'ed updates
3387 * @ctx: lock acquisition context
3388 *
3389 * Provides a default &drm_crtc_funcs.page_flip implementation
3390 * using the atomic driver interface.
3391 *
3392 * Returns:
3393 * Returns 0 on success, negative errno numbers on failure.
3394 *
3395 * See also:
3396 * drm_atomic_helper_page_flip_target()
3397 */
3398int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3399				struct drm_framebuffer *fb,
3400				struct drm_pending_vblank_event *event,
3401				uint32_t flags,
3402				struct drm_modeset_acquire_ctx *ctx)
3403{
3404	struct drm_plane *plane = crtc->primary;
3405	struct drm_atomic_state *state;
3406	int ret = 0;
3407
3408	state = drm_atomic_state_alloc(plane->dev);
3409	if (!state)
3410		return -ENOMEM;
3411
3412	state->acquire_ctx = ctx;
3413
3414	ret = page_flip_common(state, crtc, fb, event, flags);
3415	if (ret != 0)
3416		goto fail;
3417
3418	ret = drm_atomic_nonblocking_commit(state);
3419fail:
3420	drm_atomic_state_put(state);
3421	return ret;
3422}
3423EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3424
3425/**
3426 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3427 * @crtc: DRM CRTC
3428 * @fb: DRM framebuffer
3429 * @event: optional DRM event to signal upon completion
3430 * @flags: flip flags for non-vblank sync'ed updates
3431 * @target: specifying the target vblank period when the flip to take effect
3432 * @ctx: lock acquisition context
3433 *
3434 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3435 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3436 * target vblank period to flip.
3437 *
3438 * Returns:
3439 * Returns 0 on success, negative errno numbers on failure.
3440 */
3441int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3442				       struct drm_framebuffer *fb,
3443				       struct drm_pending_vblank_event *event,
3444				       uint32_t flags,
3445				       uint32_t target,
3446				       struct drm_modeset_acquire_ctx *ctx)
3447{
3448	struct drm_plane *plane = crtc->primary;
3449	struct drm_atomic_state *state;
3450	struct drm_crtc_state *crtc_state;
3451	int ret = 0;
3452
3453	state = drm_atomic_state_alloc(plane->dev);
3454	if (!state)
3455		return -ENOMEM;
3456
3457	state->acquire_ctx = ctx;
3458
3459	ret = page_flip_common(state, crtc, fb, event, flags);
3460	if (ret != 0)
3461		goto fail;
3462
3463	crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3464	if (WARN_ON(!crtc_state)) {
3465		ret = -EINVAL;
3466		goto fail;
3467	}
3468	crtc_state->target_vblank = target;
3469
3470	ret = drm_atomic_nonblocking_commit(state);
3471fail:
3472	drm_atomic_state_put(state);
3473	return ret;
3474}
3475EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
3476
3477/**
3478 * drm_atomic_helper_bridge_propagate_bus_fmt() - Propagate output format to
3479 *						  the input end of a bridge
3480 * @bridge: bridge control structure
3481 * @bridge_state: new bridge state
3482 * @crtc_state: new CRTC state
3483 * @conn_state: new connector state
3484 * @output_fmt: tested output bus format
3485 * @num_input_fmts: will contain the size of the returned array
3486 *
3487 * This helper is a pluggable implementation of the
3488 * &drm_bridge_funcs.atomic_get_input_bus_fmts operation for bridges that don't
3489 * modify the bus configuration between their input and their output. It
3490 * returns an array of input formats with a single element set to @output_fmt.
3491 *
3492 * RETURNS:
3493 * a valid format array of size @num_input_fmts, or NULL if the allocation
3494 * failed
3495 */
3496u32 *
3497drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,
3498					struct drm_bridge_state *bridge_state,
3499					struct drm_crtc_state *crtc_state,
3500					struct drm_connector_state *conn_state,
3501					u32 output_fmt,
3502					unsigned int *num_input_fmts)
3503{
3504	u32 *input_fmts;
3505
3506	input_fmts = kzalloc(sizeof(*input_fmts), GFP_KERNEL);
3507	if (!input_fmts) {
3508		*num_input_fmts = 0;
3509		return NULL;
3510	}
3511
3512	*num_input_fmts = 1;
3513	input_fmts[0] = output_fmt;
3514	return input_fmts;
3515}
3516EXPORT_SYMBOL(drm_atomic_helper_bridge_propagate_bus_fmt);