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