[PATCH v2 07/13] drm/i915/psr: Add some documentation of variables used in psr code

[Manna, Animesh]

> -----Original Message-----
> From: Intel-gfx <intel-gfx-bounces at lists.freedesktop.org> On Behalf Of Jouni
> Högander
> Sent: Wednesday, January 10, 2024 6:43 PM
> To: intel-gfx at lists.freedesktop.org
> Subject: [PATCH v2 07/13] drm/i915/psr: Add some documentation of
> variables used in psr code
> 
> We are adding more boolean variable into intel_psr and intel_crtc_state
> structs. Add some documentation about these for sake of clarity.
> 
> Signed-off-by: Jouni Högander <jouni.hogander at intel.com>

Reviewed-by: Animesh Manna <animesh.manna at intel.com>

> ---
>  drivers/gpu/drm/i915/display/intel_psr.c | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 
> diff --git a/drivers/gpu/drm/i915/display/intel_psr.c
> b/drivers/gpu/drm/i915/display/intel_psr.c
> index cde95cc9925a..be8b1b7a8025 100644
> --- a/drivers/gpu/drm/i915/display/intel_psr.c
> +++ b/drivers/gpu/drm/i915/display/intel_psr.c
> @@ -171,6 +171,22 @@
>   *
>   * The rest of the bits are more self-explanatory and/or
>   * irrelevant for normal operation.
> + *
> + * Description of intel_crtc_state variables. has_psr, has_panel_replay
> + and
> + * has_sel_update:
> + *
> + *  has_psr (alone):			PSR1
> + *  has_psr + has_sel_update:		PSR2
> + *  has_panel_replay:			Panel Replay
> + *  has_panel_replay + has_sel_update:	Panel Replay Selective Update
> + *
> + * Description of some intel_psr enabled, panel_replay_enabled,
> + * sel_update_enabled
> + *
> + *  enabled (alone):						PSR1
> + *  enabled + sel_update_enabled:				PSR2
> + *  enabled + panel_replay_enabled:				Panel Replay
> + *  enabled + panel_replay_enabled + sel_update_enabled:	Panel Replay
> SU
>   */
> 
>  bool intel_encoder_can_psr(struct intel_encoder *encoder)
> --
> 2.34.1