Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ee0a89cf authored by Daniel Vetter's avatar Daniel Vetter
Browse files

drm/atomic-helpers: Saner encoder/crtc callbacks 



For historical reasons going all the way back to how the Xrandr code
was implemented the semantics of the callbacks used to enable/disable
crtcs and encoders are ... interesting.

But with atomic helpers all that complexity has been binned, with only
a well-defined on/off action left. Unfortunately the names stuck.

Let's fix that by adding enable/disable hooks every, make them the
preferred variant for atomic and update documentations.

Later on we add debug warnings when drivers have deprecated hooks. But
while everything is in-flight with lots of drivers converting to
atomic that's a bit too much - better wait for things to settle a bit
first.

v2: Fix kerneldoc, reported by Wu Fengguang.

Reviewed-by: default avatarThierry Reding <treding@nvidia.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
parent f02ad907

drivers/gpu/drm/drm_atomic_helper.c

+12 −5
Original line number Original line Diff line number Diff line
@@ -599,7 +599,7 @@ disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state) 
			encoder->bridge->funcs->disable(encoder->bridge);

			encoder->bridge->funcs->disable(encoder->bridge);





		/* Right function depends upon target state. */

		/* Right function depends upon target state. */

		if (connector->state->crtc)

		if (connector->state->crtc && funcs->prepare)

			funcs->prepare(encoder);

			funcs->prepare(encoder);

		else if (funcs->disable)

		else if (funcs->disable)

			funcs->disable(encoder);

			funcs->disable(encoder);
@@ -628,7 +628,7 @@ disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state) 
		funcs = crtc->helper_private;

		funcs = crtc->helper_private;





		/* Right function depends upon target state. */

		/* Right function depends upon target state. */

		if (crtc->state->enable)

		if (crtc->state->enable && funcs->prepare)

			funcs->prepare(crtc);

			funcs->prepare(crtc);

		else if (funcs->disable)

		else if (funcs->disable)

			funcs->disable(crtc);

			funcs->disable(crtc);
@@ -792,9 +792,13 @@ void drm_atomic_helper_commit_post_planes(struct drm_device *dev, 




		funcs = crtc->helper_private;

		funcs = crtc->helper_private;





		if (crtc->state->enable)

		if (crtc->state->enable) {

			if (funcs->enable)

				funcs->enable(crtc);

			else

				funcs->commit(crtc);

				funcs->commit(crtc);

		}

		}

	}





	for (i = 0; i < old_state->num_connector; i++) {

	for (i = 0; i < old_state->num_connector; i++) {

		struct drm_connector *connector;

		struct drm_connector *connector;
@@ -819,6 +823,9 @@ void drm_atomic_helper_commit_post_planes(struct drm_device *dev, 
		if (encoder->bridge)

		if (encoder->bridge)

			encoder->bridge->funcs->pre_enable(encoder->bridge);

			encoder->bridge->funcs->pre_enable(encoder->bridge);





		if (funcs->enable)

			funcs->enable(encoder);

		else

			funcs->commit(encoder);

			funcs->commit(encoder);





		if (encoder->bridge)

		if (encoder->bridge)

include/drm/drm_crtc_helper.h

+18 −2
Original line number Original line Diff line number Diff line
@@ -58,11 +58,19 @@ enum mode_set_atomic { 
 * @mode_set_base_atomic: non-blocking mode set (used for kgdb support)

 * @mode_set_base_atomic: non-blocking mode set (used for kgdb support)

 * @load_lut: load color palette

 * @load_lut: load color palette

 * @disable: disable CRTC when no longer in use

 * @disable: disable CRTC when no longer in use

 * @enable: enable CRTC

 * @atomic_check: check for validity of an atomic state

 * @atomic_check: check for validity of an atomic state

 * @atomic_begin: begin atomic update

 * @atomic_begin: begin atomic update

 * @atomic_flush: flush atomic update

 * @atomic_flush: flush atomic update

 *

 *

 * The helper operations are called by the mid-layer CRTC helper.

 * The helper operations are called by the mid-layer CRTC helper.

 *

 * Note that with atomic helpers @dpms, @prepare and @commit hooks are

 * deprecated. Used @enable and @disable instead exclusively.

 *

 * With legacy crtc helpers there's a big semantic difference between @disable

 * and the other hooks: @disable also needs to release any resources acquired in

 * @mode_set (like shared PLLs).

 */

 */

struct drm_crtc_helper_funcs {

struct drm_crtc_helper_funcs {

	/*

	/*
@@ -93,8 +101,8 @@ struct drm_crtc_helper_funcs { 
	/* reload the current crtc LUT */

	/* reload the current crtc LUT */

	void (*load_lut)(struct drm_crtc *crtc);

	void (*load_lut)(struct drm_crtc *crtc);





	/* disable crtc when not in use - more explicit than dpms off */

	void (*disable)(struct drm_crtc *crtc);

	void (*disable)(struct drm_crtc *crtc);

	void (*enable)(struct drm_crtc *crtc);





	/* atomic helpers */

	/* atomic helpers */

	int (*atomic_check)(struct drm_crtc *crtc,

	int (*atomic_check)(struct drm_crtc *crtc,
@@ -115,8 +123,16 @@ struct drm_crtc_helper_funcs { 
 * @get_crtc: return CRTC that the encoder is currently attached to

 * @get_crtc: return CRTC that the encoder is currently attached to

 * @detect: connection status detection

 * @detect: connection status detection

 * @disable: disable encoder when not in use (overrides DPMS off)

 * @disable: disable encoder when not in use (overrides DPMS off)

 * @enable: enable encoder

 *

 *

 * The helper operations are called by the mid-layer CRTC helper.

 * The helper operations are called by the mid-layer CRTC helper.

 *

 * Note that with atomic helpers @dpms, @prepare and @commit hooks are

 * deprecated. Used @enable and @disable instead exclusively.

 *

 * With legacy crtc helpers there's a big semantic difference between @disable

 * and the other hooks: @disable also needs to release any resources acquired in

 * @mode_set (like shared PLLs).

 */

 */

struct drm_encoder_helper_funcs {

struct drm_encoder_helper_funcs {

	void (*dpms)(struct drm_encoder *encoder, int mode);

	void (*dpms)(struct drm_encoder *encoder, int mode);
@@ -135,8 +151,8 @@ struct drm_encoder_helper_funcs { 
	/* detect for DAC style encoders */

	/* detect for DAC style encoders */

	enum drm_connector_status (*detect)(struct drm_encoder *encoder,

	enum drm_connector_status (*detect)(struct drm_encoder *encoder,

					    struct drm_connector *connector);

					    struct drm_connector *connector);

	/* disable encoder when not in use - more explicit than dpms off */

	void (*disable)(struct drm_encoder *encoder);

	void (*disable)(struct drm_encoder *encoder);

	void (*enable)(struct drm_encoder *encoder);

};

};





/**

/**