[PATCH] drm/amdgpu: Fix kernel-doc comments for some LUT properties

Cristian Ciocaltea posted 1 patch 1 month, 1 week ago
drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
[PATCH] drm/amdgpu: Fix kernel-doc comments for some LUT properties
Posted by Cristian Ciocaltea 1 month, 1 week ago
The following members of struct amdgpu_mode_info do not have valid
references in the related kernel-doc sections:

 - plane_shaper_lut_property
 - plane_shaper_lut_size_property,
 - plane_lut3d_size_property

Correct all affected comment blocks.

Fixes: f545d82479b4 ("drm/amd/display: add plane shaper LUT and TF driver-specific properties")
Fixes: 671994e3bf33 ("drm/amd/display: add plane 3D LUT driver-specific properties")
Signed-off-by: Cristian Ciocaltea <cristian.ciocaltea@collabora.com>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h b/drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h
index 6da4f946cac008ac865cd6d8a06fb0bd84d646d5..c3ad371658065388c10b7cfc45377b0465bd24ca 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h
@@ -366,15 +366,15 @@ struct amdgpu_mode_info {
 
 	struct drm_property *plane_ctm_property;
 	/**
-	 * @shaper_lut_property: Plane property to set pre-blending shaper LUT
-	 * that converts color content before 3D LUT. If
-	 * plane_shaper_tf_property != Identity TF, AMD color module will
+	 * @plane_shaper_lut_property: Plane property to set pre-blending
+	 * shaper LUT that converts color content before 3D LUT.
+	 * If plane_shaper_tf_property != Identity TF, AMD color module will
 	 * combine the user LUT values with pre-defined TF into the LUT
 	 * parameters to be programmed.
 	 */
 	struct drm_property *plane_shaper_lut_property;
 	/**
-	 * @shaper_lut_size_property: Plane property for the size of
+	 * @plane_shaper_lut_size_property: Plane property for the size of
 	 * pre-blending shaper LUT as supported by the driver (read-only).
 	 */
 	struct drm_property *plane_shaper_lut_size_property;
@@ -398,10 +398,10 @@ struct amdgpu_mode_info {
 	 */
 	struct drm_property *plane_lut3d_property;
 	/**
-	 * @plane_degamma_lut_size_property: Plane property to define the max
-	 * size of 3D LUT as supported by the driver (read-only). The max size
-	 * is the max size of one dimension and, therefore, the max number of
-	 * entries for 3D LUT array is the 3D LUT size cubed;
+	 * @plane_lut3d_size_property: Plane property to define the max size
+	 * of 3D LUT as supported by the driver (read-only). The max size is
+	 * the max size of one dimension and, therefore, the max number of
+	 * entries for 3D LUT array is the 3D LUT size cubed.
 	 */
 	struct drm_property *plane_lut3d_size_property;
 	/**

---
base-commit: 0f4c93f7eb861acab537dbe94441817a270537bf
change-id: 20250823-amdgpu-fix-kdoc-lut-357db8b57fee
Re: [PATCH] drm/amdgpu: Fix kernel-doc comments for some LUT properties
Posted by Melissa Wen 1 month, 1 week ago

On 22/08/2025 18:11, Cristian Ciocaltea wrote:
> The following members of struct amdgpu_mode_info do not have valid
> references in the related kernel-doc sections:
>
>   - plane_shaper_lut_property
>   - plane_shaper_lut_size_property,
>   - plane_lut3d_size_property
>
> Correct all affected comment blocks.
>
> Fixes: f545d82479b4 ("drm/amd/display: add plane shaper LUT and TF driver-specific properties")
> Fixes: 671994e3bf33 ("drm/amd/display: add plane 3D LUT driver-specific properties")
> Signed-off-by: Cristian Ciocaltea <cristian.ciocaltea@collabora.com>
Nice catch. Thanks for reviewing docs and fixing them.

Reviewed-by: Melissa Wen <mwen@igalia.com>

> ---
>   drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h | 16 ++++++++--------
>   1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h b/drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h
> index 6da4f946cac008ac865cd6d8a06fb0bd84d646d5..c3ad371658065388c10b7cfc45377b0465bd24ca 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_mode.h
> @@ -366,15 +366,15 @@ struct amdgpu_mode_info {
>   
>   	struct drm_property *plane_ctm_property;
>   	/**
> -	 * @shaper_lut_property: Plane property to set pre-blending shaper LUT
> -	 * that converts color content before 3D LUT. If
> -	 * plane_shaper_tf_property != Identity TF, AMD color module will
> +	 * @plane_shaper_lut_property: Plane property to set pre-blending
> +	 * shaper LUT that converts color content before 3D LUT.
> +	 * If plane_shaper_tf_property != Identity TF, AMD color module will
>   	 * combine the user LUT values with pre-defined TF into the LUT
>   	 * parameters to be programmed.
>   	 */
>   	struct drm_property *plane_shaper_lut_property;
>   	/**
> -	 * @shaper_lut_size_property: Plane property for the size of
> +	 * @plane_shaper_lut_size_property: Plane property for the size of
>   	 * pre-blending shaper LUT as supported by the driver (read-only).
>   	 */
>   	struct drm_property *plane_shaper_lut_size_property;
> @@ -398,10 +398,10 @@ struct amdgpu_mode_info {
>   	 */
>   	struct drm_property *plane_lut3d_property;
>   	/**
> -	 * @plane_degamma_lut_size_property: Plane property to define the max
> -	 * size of 3D LUT as supported by the driver (read-only). The max size
> -	 * is the max size of one dimension and, therefore, the max number of
> -	 * entries for 3D LUT array is the 3D LUT size cubed;
> +	 * @plane_lut3d_size_property: Plane property to define the max size
> +	 * of 3D LUT as supported by the driver (read-only). The max size is
> +	 * the max size of one dimension and, therefore, the max number of
> +	 * entries for 3D LUT array is the 3D LUT size cubed.
>   	 */
>   	struct drm_property *plane_lut3d_size_property;
>   	/**
>
> ---
> base-commit: 0f4c93f7eb861acab537dbe94441817a270537bf
> change-id: 20250823-amdgpu-fix-kdoc-lut-357db8b57fee
>