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