[PATCH] drm/bridge: correct DRM_BRIDGE_OP_EDID documentation

[PATCH] drm/bridge: correct DRM_BRIDGE_OP_EDID documentation

[Dmitry Baryshkov]

While the commit d807ad80d811 ("drm/bridge: add ->edid_read hook and
drm_bridge_edid_read()") and the commit 27b8f91c08d9 ("drm/bridge:
remove ->get_edid callback") replaced ->get_edid() callback with the
->edid_read(), they failed to update documentation. Fix the drm_bridge
docs to point to edid_read().

Fixes: 27b8f91c08d9 ("drm/bridge: remove ->get_edid callback")
Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
---
 include/drm/drm_bridge.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
index 3606e1a7f965..4baca0d9107b 100644
--- a/include/drm/drm_bridge.h
+++ b/include/drm/drm_bridge.h
@@ -541,7 +541,7 @@ struct drm_bridge_funcs {
 	 * The @get_modes callback is mostly intended to support non-probeable
 	 * displays such as many fixed panels. Bridges that support reading
 	 * EDID shall leave @get_modes unimplemented and implement the
-	 * &drm_bridge_funcs->get_edid callback instead.
+	 * &drm_bridge_funcs->edid_read callback instead.
 	 *
 	 * This callback is optional. Bridges that implement it shall set the
 	 * DRM_BRIDGE_OP_MODES flag in their &drm_bridge->ops.
@@ -687,7 +687,7 @@ enum drm_bridge_ops {
 	/**
 	 * @DRM_BRIDGE_OP_EDID: The bridge can retrieve the EDID of the display
 	 * connected to its output. Bridges that set this flag shall implement
-	 * the &drm_bridge_funcs->get_edid callback.
+	 * the &drm_bridge_funcs->edid_read callback.
 	 */
 	DRM_BRIDGE_OP_EDID = BIT(1),
 	/**

---
base-commit: 1843e16d2df9d98427ef8045589571749d627cf7
change-id: 20240310-drm-bridge-fix-docs-0fd12bc6a041

Best regards,
-- 
Dmitry Baryshkov <dmitry.baryshkov@linaro.org>

Re: [PATCH] drm/bridge: correct DRM_BRIDGE_OP_EDID documentation

[Neil Armstrong]

On 10/03/2024 00:38, Dmitry Baryshkov wrote:
> While the commit d807ad80d811 ("drm/bridge: add ->edid_read hook and
> drm_bridge_edid_read()") and the commit 27b8f91c08d9 ("drm/bridge:
> remove ->get_edid callback") replaced ->get_edid() callback with the
> ->edid_read(), they failed to update documentation. Fix the drm_bridge
> docs to point to edid_read().
> 
> Fixes: 27b8f91c08d9 ("drm/bridge: remove ->get_edid callback")
> Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
> ---
>   include/drm/drm_bridge.h | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
> index 3606e1a7f965..4baca0d9107b 100644
> --- a/include/drm/drm_bridge.h
> +++ b/include/drm/drm_bridge.h
> @@ -541,7 +541,7 @@ struct drm_bridge_funcs {
>   	 * The @get_modes callback is mostly intended to support non-probeable
>   	 * displays such as many fixed panels. Bridges that support reading
>   	 * EDID shall leave @get_modes unimplemented and implement the
> -	 * &drm_bridge_funcs->get_edid callback instead.
> +	 * &drm_bridge_funcs->edid_read callback instead.
>   	 *
>   	 * This callback is optional. Bridges that implement it shall set the
>   	 * DRM_BRIDGE_OP_MODES flag in their &drm_bridge->ops.
> @@ -687,7 +687,7 @@ enum drm_bridge_ops {
>   	/**
>   	 * @DRM_BRIDGE_OP_EDID: The bridge can retrieve the EDID of the display
>   	 * connected to its output. Bridges that set this flag shall implement
> -	 * the &drm_bridge_funcs->get_edid callback.
> +	 * the &drm_bridge_funcs->edid_read callback.
>   	 */
>   	DRM_BRIDGE_OP_EDID = BIT(1),
>   	/**
> 
> ---
> base-commit: 1843e16d2df9d98427ef8045589571749d627cf7
> change-id: 20240310-drm-bridge-fix-docs-0fd12bc6a041
> 
> Best regards,

Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org>

Re: [PATCH] drm/bridge: correct DRM_BRIDGE_OP_EDID documentation

[Jani Nikula]

On Sun, 10 Mar 2024, Dmitry Baryshkov <dmitry.baryshkov@linaro.org> wrote:
> While the commit d807ad80d811 ("drm/bridge: add ->edid_read hook and
> drm_bridge_edid_read()") and the commit 27b8f91c08d9 ("drm/bridge:
> remove ->get_edid callback") replaced ->get_edid() callback with the
> ->edid_read(), they failed to update documentation. Fix the drm_bridge
> docs to point to edid_read().
>
> Fixes: 27b8f91c08d9 ("drm/bridge: remove ->get_edid callback")
> Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>

My bad, thanks for fixing it!

Reviewed-by: Jani Nikula <jani.nikula@intel.com>

> ---
>  include/drm/drm_bridge.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
> index 3606e1a7f965..4baca0d9107b 100644
> --- a/include/drm/drm_bridge.h
> +++ b/include/drm/drm_bridge.h
> @@ -541,7 +541,7 @@ struct drm_bridge_funcs {
>  	 * The @get_modes callback is mostly intended to support non-probeable
>  	 * displays such as many fixed panels. Bridges that support reading
>  	 * EDID shall leave @get_modes unimplemented and implement the
> -	 * &drm_bridge_funcs->get_edid callback instead.
> +	 * &drm_bridge_funcs->edid_read callback instead.
>  	 *
>  	 * This callback is optional. Bridges that implement it shall set the
>  	 * DRM_BRIDGE_OP_MODES flag in their &drm_bridge->ops.
> @@ -687,7 +687,7 @@ enum drm_bridge_ops {
>  	/**
>  	 * @DRM_BRIDGE_OP_EDID: The bridge can retrieve the EDID of the display
>  	 * connected to its output. Bridges that set this flag shall implement
> -	 * the &drm_bridge_funcs->get_edid callback.
> +	 * the &drm_bridge_funcs->edid_read callback.
>  	 */
>  	DRM_BRIDGE_OP_EDID = BIT(1),
>  	/**
>
> ---
> base-commit: 1843e16d2df9d98427ef8045589571749d627cf7
> change-id: 20240310-drm-bridge-fix-docs-0fd12bc6a041
>
> Best regards,

-- 
Jani Nikula, Intel