From: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
To: Aradhya Bhatia <aradhya.bhatia@linux.dev>,
Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>,
Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
Andrzej Hajda <andrzej.hajda@intel.com>,
Neil Armstrong <neil.armstrong@linaro.org>,
Robert Foss <rfoss@kernel.org>, Jonas Karlman <jonas@kwiboo.se>,
Jernej Skrabec <jernej.skrabec@gmail.com>,
Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
Maxime Ripard <mripard@kernel.org>,
Thomas Zimmermann <tzimmermann@suse.de>,
David Airlie <airlied@gmail.com>, Simona Vetter <simona@ffwll.ch>
Cc: Nishanth Menon <nm@ti.com>, Vignesh Raghavendra <vigneshr@ti.com>,
Devarsh Thakkar <devarsht@ti.com>,
Praneeth Bajjuri <praneeth@ti.com>, Udit Kumar <u-kumar1@ti.com>,
Jayesh Choudhary <j-choudhary@ti.com>,
Alexander Sverdlin <alexander.sverdlin@siemens.com>,
Dominik Haller <d.haller@phytec.de>,
DRI Development List <dri-devel@lists.freedesktop.org>,
Linux Kernel List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v11 13/14] drm/bridge: Update the bridge enable/disable doc
Date: Thu, 3 Apr 2025 12:49:20 +0300 [thread overview]
Message-ID: <931a519e-605e-4f53-9a03-43b8d53ed987@ideasonboard.com> (raw)
In-Reply-To: <20250329115333.72614-3-aradhya.bhatia@linux.dev>
Hi,
On 29/03/2025 13:53, Aradhya Bhatia wrote:
> Now that the bridges get pre-enabled before the CRTC is enabled, and get
> post-disabled after the CRTC is disabled, update the function
> descriptions to accurately reflect the updated scenario.
>
> The enable sequence for the display pipeline looks like:
>
> bridge[n]_pre_enable
> ...
> bridge[1]_pre_enable
>
> crtc_enable
> encoder_enable
>
> bridge[1]_enable
> ...
> bridge[n]_enable
>
> And, the disable sequence for the display pipeline looks like:
>
> bridge[n]_disable
> ...
> bridge[1]_disable
>
> encoder_disable
> crtc_disable
>
> bridge[1]_post_disable
> ...
> bridge[n]_post_disable
>
> Signed-off-by: Aradhya Bhatia <aradhya.bhatia@linux.dev>
> ---
> include/drm/drm_bridge.h | 216 +++++++++++++++++++++++++++------------
> 1 file changed, 150 insertions(+), 66 deletions(-)
>
> diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
> index cdad3b78a195..fc126562733c 100644
> --- a/include/drm/drm_bridge.h
> +++ b/include/drm/drm_bridge.h
> @@ -164,17 +164,28 @@ struct drm_bridge_funcs {
> /**
> * @disable:
> *
> - * This callback should disable the bridge. It is called right before
> - * the preceding element in the display pipe is disabled. If the
> - * preceding element is a bridge this means it's called before that
> - * bridge's @disable vfunc. If the preceding element is a &drm_encoder
> - * it's called right before the &drm_encoder_helper_funcs.disable,
> - * &drm_encoder_helper_funcs.prepare or &drm_encoder_helper_funcs.dpms
> - * hook.
> + * The @disable callback should disable the bridge.
> *
> * The bridge can assume that the display pipe (i.e. clocks and timing
> * signals) feeding it is still running when this callback is called.
> *
> + * It is called right before the preceding element in the display pipe
> + * is disabled. If the preceding element is a &drm_bridge, then it's
> + * called before that bridge is disabled.
> + *
> + * If the preceding element of the bridge is a display controller, which
> + * has under it a &drm_crtc and a &drm_encoder, then this callback is
> + * called right before the encoder and the CRTC are disabled via the
> + * following hooks.
> + * &drm_encoder_helper_funcs.atomic_disable, or
> + * &drm_encoder_helper_funcs.prepare, or
> + * &drm_encoder_helper_funcs.disable, or &drm_encoder_helper_funcs.dpms
> + * hook for the encoder, and
> + * &drm_crtc_helper_funcs.prepare, or
> + * &drm_crtc_helper_funcs.atomic_disable, or
> + * &drm_crtc_helper_funcs.disable, or &drm_crtc_helper_funcs.dpms hook
> + * for the CRTC.
> + *
This is quite difficult to read. Maybe something like:
It is called right before the preceding element in the display pipe is
disabled.
If the preceding element is a &drm_bridge, then this is called before
that bridge is disabled via one of:
- &drm_bridge_funcs.disable
- &drm_bridge_funcs.atomic_disable
If the preceding element of the bridge is a display controller, then
this callback is called right before the encoder is disabled via one of:
- &drm_encoder_helper_funcs.atomic_disable
- &drm_encoder_helper_funcs.prepare
- &drm_encoder_helper_funcs.disable
- &drm_encoder_helper_funcs.dpms
and the CRTC are disabled via one of:
- &drm_crtc_helper_funcs.atomic_disable
- &drm_crtc_helper_funcs.prepare
- &drm_crtc_helper_funcs.disable
- &drm_crtc_helper_funcs.dpms hook
Tomi
> * The @disable callback is optional.
> *
> * NOTE:
> @@ -187,17 +198,30 @@ struct drm_bridge_funcs {
> /**
> * @post_disable:
> *
> - * This callback should disable the bridge. It is called right after the
> - * preceding element in the display pipe is disabled. If the preceding
> - * element is a bridge this means it's called after that bridge's
> - * @post_disable function. If the preceding element is a &drm_encoder
> - * it's called right after the encoder's
> - * &drm_encoder_helper_funcs.disable, &drm_encoder_helper_funcs.prepare
> - * or &drm_encoder_helper_funcs.dpms hook.
> - *
> * The bridge must assume that the display pipe (i.e. clocks and timing
> - * signals) feeding it is no longer running when this callback is
> - * called.
> + * signals) feeding this bridge is no longer running when the
> + * @post_disable is called.
> + *
> + * This callback should perform all the actions required by the hardware
> + * after it has stopped receiving signals from the preceding element.
> + *
> + * It is called right after the preceding element is post-disabled, and
> + * right before the following element gets post-disabled (given that the
> + * preceding and following elements are &drm_bridges), unless marked
> + * otherwise by the @pre_enable_prev_first flag.
> + *
> + * If the preceding element of the bridge is a display controller, which
> + * has under it a &drm_crtc and a &drm_encoder, then this callback is
> + * called right after the encoder and the CRTC are disabled via the
> + * following hooks.
> + * &drm_encoder_helper_funcs.atomic_disable, or
> + * &drm_encoder_helper_funcs.prepare, or
> + * &drm_encoder_helper_funcs.disable, or &drm_encoder_helper_funcs.dpms
> + * hook for the encoder, and
> + * &drm_crtc_helper_funcs.prepare, or
> + * &drm_crtc_helper_funcs.atomic_disable, or
> + * &drm_crtc_helper_funcs.disable, or &drm_crtc_helper_funcs.dpms hook
> + * for the CRTC.
> *
> * The @post_disable callback is optional.
> *
> @@ -240,18 +264,26 @@ struct drm_bridge_funcs {
> /**
> * @pre_enable:
> *
> - * This callback should enable the bridge. It is called right before
> - * the preceding element in the display pipe is enabled. If the
> - * preceding element is a bridge this means it's called before that
> - * bridge's @pre_enable function. If the preceding element is a
> - * &drm_encoder it's called right before the encoder's
> - * &drm_encoder_helper_funcs.enable, &drm_encoder_helper_funcs.commit or
> - * &drm_encoder_helper_funcs.dpms hook.
> - *
> * The display pipe (i.e. clocks and timing signals) feeding this bridge
> - * will not yet be running when this callback is called. The bridge must
> - * not enable the display link feeding the next bridge in the chain (if
> - * there is one) when this callback is called.
> + * will not yet be running when the @pre_enable is called.
> + *
> + * This callback should perform all the necessary actions to prepare the
> + * bridge to accept signals from the preceding element.
> + *
> + * It is called right after the following element is pre-enabled, and
> + * right before the preceding element gets pre-enabled (given that the
> + * following and preceding elements are &drm_bridges), unless marked
> + * otherwise by @pre_enable_prev_first flag.
> + *
> + * If the preceding element of the bridge is a display controller, which
> + * has under it a &drm_crtc and a &drm_encoder, then this callback is
> + * called right before the CRTC and the encoder are enabled via these
> + * hooks.
> + * &drm_crtc_helper_funcs.atomic_enable, or
> + * &drm_crtc_helper_funcs.commit hook for the CRTC, and
> + * &drm_encoder_helper_funcs.atomic_enable, or
> + * &drm_encoder_helper_funcs.enable, or &drm_encoder_helper_funcs.commit
> + * hook for the encoder.
> *
> * The @pre_enable callback is optional.
> *
> @@ -265,19 +297,27 @@ struct drm_bridge_funcs {
> /**
> * @enable:
> *
> - * This callback should enable the bridge. It is called right after
> - * the preceding element in the display pipe is enabled. If the
> - * preceding element is a bridge this means it's called after that
> - * bridge's @enable function. If the preceding element is a
> - * &drm_encoder it's called right after the encoder's
> - * &drm_encoder_helper_funcs.enable, &drm_encoder_helper_funcs.commit or
> - * &drm_encoder_helper_funcs.dpms hook.
> + * The @enable callback should enable the bridge.
> *
> * The bridge can assume that the display pipe (i.e. clocks and timing
> * signals) feeding it is running when this callback is called. This
> * callback must enable the display link feeding the next bridge in the
> * chain if there is one.
> *
> + * It is called right after the preceding element in the display pipe is
> + * enabled. If the preceding element is a &drm_bridge, then it's called
> + * after that bridge is enabled.
> + *
> + * If the preceding element of the bridge is a display controller, which
> + * has under it a &drm_crtc and a &drm_encoder, then this callback is
> + * called right after the CRTC and the encoder are enabled via these
> + * hooks.
> + * &drm_crtc_helper_funcs.atomic_enable, or
> + * &drm_crtc_helper_funcs.commit hook for the CRTC, and
> + * &drm_encoder_helper_funcs.atomic_enable, or
> + * &drm_encoder_helper_funcs.enable, or &drm_encoder_helper_funcs.commit
> + * hook for the encoder.
> + *
> * The @enable callback is optional.
> *
> * NOTE:
> @@ -290,17 +330,26 @@ struct drm_bridge_funcs {
> /**
> * @atomic_pre_enable:
> *
> - * This callback should enable the bridge. It is called right before
> - * the preceding element in the display pipe is enabled. If the
> - * preceding element is a bridge this means it's called before that
> - * bridge's @atomic_pre_enable or @pre_enable function. If the preceding
> - * element is a &drm_encoder it's called right before the encoder's
> - * &drm_encoder_helper_funcs.atomic_enable hook.
> - *
> * The display pipe (i.e. clocks and timing signals) feeding this bridge
> - * will not yet be running when this callback is called. The bridge must
> - * not enable the display link feeding the next bridge in the chain (if
> - * there is one) when this callback is called.
> + * will not yet be running when the @atomic_pre_enable is called.
> + *
> + * This callback should perform all the necessary actions to prepare the
> + * bridge to accept signals from the preceding element.
> + *
> + * It is called right after the following element is pre-enabled, and
> + * right before the preceding element gets pre-enabled (given that the
> + * following and preceding elements are &drm_bridges), unless marked
> + * otherwise by @pre_enable_prev_first flag.
> + *
> + * If the preceding element of the bridge is a display controller, which
> + * has under it a &drm_crtc and a &drm_encoder, then this callback is
> + * called right before the CRTC and the encoder are enabled via these
> + * hooks.
> + * &drm_crtc_helper_funcs.atomic_enable, or
> + * &drm_crtc_helper_funcs.commit hook for the CRTC, and
> + * &drm_encoder_helper_funcs.atomic_enable, or
> + * &drm_encoder_helper_funcs.enable, or &drm_encoder_helper_funcs.commit
> + * hook for the encoder.
> *
> * The @atomic_pre_enable callback is optional.
> */
> @@ -310,18 +359,27 @@ struct drm_bridge_funcs {
> /**
> * @atomic_enable:
> *
> - * This callback should enable the bridge. It is called right after
> - * the preceding element in the display pipe is enabled. If the
> - * preceding element is a bridge this means it's called after that
> - * bridge's @atomic_enable or @enable function. If the preceding element
> - * is a &drm_encoder it's called right after the encoder's
> - * &drm_encoder_helper_funcs.atomic_enable hook.
> + * The @atomic_enable callback should enable the bridge.
> *
> * The bridge can assume that the display pipe (i.e. clocks and timing
> * signals) feeding it is running when this callback is called. This
> * callback must enable the display link feeding the next bridge in the
> * chain if there is one.
> *
> + * It is called right after the preceding element in the display pipe is
> + * enabled. If the preceding element is a &drm_bridge, then it's called
> + * after that bridge is enabled.
> + *
> + * If the preceding element of the bridge is a display controller, which
> + * has under it a &drm_crtc and a &drm_encoder, then this callback is
> + * called right after the CRTC and the encoder are enabled via these
> + * hooks.
> + * &drm_crtc_helper_funcs.atomic_enable, or
> + * &drm_crtc_helper_funcs.commit hook for the CRTC, and
> + * &drm_encoder_helper_funcs.atomic_enable, or
> + * &drm_encoder_helper_funcs.enable, or &drm_encoder_helper_funcs.commit
> + * hook for the encoder.
> + *
> * The @atomic_enable callback is optional.
> */
> void (*atomic_enable)(struct drm_bridge *bridge,
> @@ -329,16 +387,28 @@ struct drm_bridge_funcs {
> /**
> * @atomic_disable:
> *
> - * This callback should disable the bridge. It is called right before
> - * the preceding element in the display pipe is disabled. If the
> - * preceding element is a bridge this means it's called before that
> - * bridge's @atomic_disable or @disable vfunc. If the preceding element
> - * is a &drm_encoder it's called right before the
> - * &drm_encoder_helper_funcs.atomic_disable hook.
> + * The @atomic_disable callback should disable the bridge.
> *
> * The bridge can assume that the display pipe (i.e. clocks and timing
> * signals) feeding it is still running when this callback is called.
> *
> + * It is called right before the preceding element in the display pipe
> + * is disabled. If the preceding element is a &drm_bridge, then it's
> + * called before that bridge is disabled.
> + *
> + * If the preceding element of the bridge is a display controller, which
> + * has under it a &drm_crtc and a &drm_encoder, then this callback is
> + * called right before the encoder and the CRTC are disabled via the
> + * following hooks.
> + * &drm_encoder_helper_funcs.atomic_disable, or
> + * &drm_encoder_helper_funcs.prepare, or
> + * &drm_encoder_helper_funcs.disable, or &drm_encoder_helper_funcs.dpms
> + * hook for the encoder, and
> + * &drm_crtc_helper_funcs.prepare, or
> + * &drm_crtc_helper_funcs.atomic_disable, or
> + * &drm_crtc_helper_funcs.disable, or &drm_crtc_helper_funcs.dpms hook
> + * for the CRTC.
> + *
> * The @atomic_disable callback is optional.
> */
> void (*atomic_disable)(struct drm_bridge *bridge,
> @@ -347,16 +417,30 @@ struct drm_bridge_funcs {
> /**
> * @atomic_post_disable:
> *
> - * This callback should disable the bridge. It is called right after the
> - * preceding element in the display pipe is disabled. If the preceding
> - * element is a bridge this means it's called after that bridge's
> - * @atomic_post_disable or @post_disable function. If the preceding
> - * element is a &drm_encoder it's called right after the encoder's
> - * &drm_encoder_helper_funcs.atomic_disable hook.
> - *
> * The bridge must assume that the display pipe (i.e. clocks and timing
> - * signals) feeding it is no longer running when this callback is
> - * called.
> + * signals) feeding this bridge is no longer running when the
> + * @atomic_post_disable is called.
> + *
> + * This callback should perform all the actions required by the hardware
> + * after it has stopped receiving signals from the preceding element.
> + *
> + * It is called right after the preceding element is post-disabled, and
> + * right before the following element gets post-disabled (given that the
> + * preceding and following elements are &drm_bridges), unless marked
> + * otherwise by the @pre_enable_prev_first flag.
> + *
> + * If the preceding element of the bridge is a display controller, which
> + * has under it a &drm_crtc and a &drm_encoder, then this callback is
> + * called right after the encoder and the CRTC are disabled via the
> + * following hooks.
> + * &drm_encoder_helper_funcs.atomic_disable, or
> + * &drm_encoder_helper_funcs.prepare, or
> + * &drm_encoder_helper_funcs.disable, or &drm_encoder_helper_funcs.dpms
> + * hook for the encoder, and
> + * &drm_crtc_helper_funcs.prepare, or
> + * &drm_crtc_helper_funcs.atomic_disable, or
> + * &drm_crtc_helper_funcs.disable, or &drm_crtc_helper_funcs.dpms hook
> + * for the CRTC.
> *
> * The @atomic_post_disable callback is optional.
> */
next prev parent reply other threads:[~2025-04-03 9:49 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-29 11:39 [PATCH v11 00/14] drm/bridge: cdns-dsi: Fix the color-shift issue Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 01/14] drm/bridge: cdns-dsi: Fix connecting to next bridge Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 02/14] drm/bridge: cdns-dsi: Fix phy de-init and flag it so Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 03/14] drm/bridge: cdns-dsi: Fix the clock variable for mode_valid() Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 04/14] drm/bridge: cdns-dsi: Check return value when getting default PHY config Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 05/14] drm/bridge: cdns-dsi: Wait for Clk and Data Lanes to be ready Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 06/14] drm/bridge: cdns-dsi: Move to devm_drm_of_get_bridge() Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 07/14] drm/mipi-dsi: Add helper to find input format Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 08/14] drm/bridge: cdns-dsi: Add input format negotiation Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 09/14] drm/bridge: cdns-dsi: Move DSI mode check to _atomic_check() Aradhya Bhatia
2025-03-29 11:39 ` [PATCH v11 10/14] drm/atomic-helper: Refactor crtc & encoder-bridge op loops into separate functions Aradhya Bhatia
2025-03-29 11:53 ` [PATCH v11 11/14] drm/atomic-helper: Separate out bridge pre_enable/post_disable from enable/disable Aradhya Bhatia
2025-03-29 11:53 ` [PATCH v11 12/14] drm/atomic-helper: Re-order bridge chain pre-enable and post-disable Aradhya Bhatia
2025-03-29 11:53 ` [PATCH v11 13/14] drm/bridge: Update the bridge enable/disable doc Aradhya Bhatia
2025-04-03 9:49 ` Tomi Valkeinen [this message]
2025-03-29 11:53 ` [PATCH v11 14/14] drm/bridge: cdns-dsi: Use pre_enable/post_disable to enable/disable Aradhya Bhatia
2025-03-30 16:55 ` (subset) [PATCH v11 00/14] drm/bridge: cdns-dsi: Fix the color-shift issue Dmitry Baryshkov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=931a519e-605e-4f53-9a03-43b8d53ed987@ideasonboard.com \
--to=tomi.valkeinen@ideasonboard.com \
--cc=airlied@gmail.com \
--cc=alexander.sverdlin@siemens.com \
--cc=andrzej.hajda@intel.com \
--cc=aradhya.bhatia@linux.dev \
--cc=d.haller@phytec.de \
--cc=devarsht@ti.com \
--cc=dmitry.baryshkov@oss.qualcomm.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=j-choudhary@ti.com \
--cc=jernej.skrabec@gmail.com \
--cc=jonas@kwiboo.se \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-kernel@vger.kernel.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=mripard@kernel.org \
--cc=neil.armstrong@linaro.org \
--cc=nm@ti.com \
--cc=praneeth@ti.com \
--cc=rfoss@kernel.org \
--cc=simona@ffwll.ch \
--cc=tzimmermann@suse.de \
--cc=u-kumar1@ti.com \
--cc=vigneshr@ti.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®