drm/amd/display: fix kernel-doc warnings for amdgpu_display_manager

[PATCH] drm/amd/display: fix kernel-doc warnings for amdgpu_display_manager

Posted by Omokefe Emmanuel Onanaroghene 1 week, 3 days ago

scripts/kernel-doc reports missing and excess member descriptions
for struct amdgpu_display_manager:

  struct member 'power_module' not described
  struct member 'hdmi_frl_status_polling_wq' not described
  struct member 'hdmi_frl_status_polling_delay_ms' not described
  struct member 'boot_time_crc_info' not described
  Excess struct member 'dm_boot_time_crc_info' description

Add @power_module to the main struct doc, document
hdmi_frl_status_polling_wq/work/delay_ms with separate inline
comments, and rename @dm_boot_time_crc_info to @boot_time_crc_info
to match the actual member name.

Signed-off-by: Omokefe Emmanuel Onanaroghene <emmaonana18@gmail.com>
---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
index 3524931451c8..61756c089fcc 100644
--- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
+++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
@@ -330,6 +330,7 @@ struct hpd_rx_irq_offload_work {
  * @backlight_link: Link on which to control backlight
  * @backlight_caps: Capabilities of the backlight device
  * @freesync_module: Module handling freesync calculations
+ * @power_module: Module handling power calculations
  * @hdcp_workqueue: AMDGPU content protection queue
  * @fw_dmcu: Reference to DMCU firmware
  * @dmcu_fw_version: Version of the DMCU firmware
@@ -716,16 +717,26 @@ struct amdgpu_display_manager {
 		char reply_data[0x40];  // Cannot include dmub_cmd here
 	} fused_io[8];
 	/**
-	 * @hdmi_frl_status_polling_work:
+	 * @hdmi_frl_status_polling_wq:
 	 *
 	 * workqueue for 200ms frl status polling
 	 */
 	struct workqueue_struct *hdmi_frl_status_polling_wq;
+	/**
+	 * @hdmi_frl_status_polling_work:
+	 *
+	 * Delayed work for 200ms HDMI FRL status polling.
+	 */
 	struct delayed_work hdmi_frl_status_polling_work;
+	/**
+	 * @hdmi_frl_status_polling_delay_ms:
+	 *
+	 * Delay, in milliseconds, between HDMI FRL status polls.
+	 */
 	unsigned int hdmi_frl_status_polling_delay_ms;
 
 	/**
-	 * @dm_boot_time_crc_info:
+	 * @boot_time_crc_info:
 	 *
 	 * Buffer info for the boot time crc.
 	 */
-- 
2.43.0

Re: [PATCH] drm/amd/display: fix kernel-doc warnings for amdgpu_display_manager

Posted by Alex Deucher 1 week, 2 days ago

Applied.  Thanks!

Alex

On Tue, Sep 15, 2026 at 3:41 AM Omokefe Emmanuel Onanaroghene
<emmaonana18@gmail.com> wrote:
>
> scripts/kernel-doc reports missing and excess member descriptions
> for struct amdgpu_display_manager:
>
>   struct member 'power_module' not described
>   struct member 'hdmi_frl_status_polling_wq' not described
>   struct member 'hdmi_frl_status_polling_delay_ms' not described
>   struct member 'boot_time_crc_info' not described
>   Excess struct member 'dm_boot_time_crc_info' description
>
> Add @power_module to the main struct doc, document
> hdmi_frl_status_polling_wq/work/delay_ms with separate inline
> comments, and rename @dm_boot_time_crc_info to @boot_time_crc_info
> to match the actual member name.
>
> Signed-off-by: Omokefe Emmanuel Onanaroghene <emmaonana18@gmail.com>
> ---
>  drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 15 +++++++++++++--
>  1 file changed, 13 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> index 3524931451c8..61756c089fcc 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> @@ -330,6 +330,7 @@ struct hpd_rx_irq_offload_work {
>   * @backlight_link: Link on which to control backlight
>   * @backlight_caps: Capabilities of the backlight device
>   * @freesync_module: Module handling freesync calculations
> + * @power_module: Module handling power calculations
>   * @hdcp_workqueue: AMDGPU content protection queue
>   * @fw_dmcu: Reference to DMCU firmware
>   * @dmcu_fw_version: Version of the DMCU firmware
> @@ -716,16 +717,26 @@ struct amdgpu_display_manager {
>                 char reply_data[0x40];  // Cannot include dmub_cmd here
>         } fused_io[8];
>         /**
> -        * @hdmi_frl_status_polling_work:
> +        * @hdmi_frl_status_polling_wq:
>          *
>          * workqueue for 200ms frl status polling
>          */
>         struct workqueue_struct *hdmi_frl_status_polling_wq;
> +       /**
> +        * @hdmi_frl_status_polling_work:
> +        *
> +        * Delayed work for 200ms HDMI FRL status polling.
> +        */
>         struct delayed_work hdmi_frl_status_polling_work;
> +       /**
> +        * @hdmi_frl_status_polling_delay_ms:
> +        *
> +        * Delay, in milliseconds, between HDMI FRL status polls.
> +        */
>         unsigned int hdmi_frl_status_polling_delay_ms;
>
>         /**
> -        * @dm_boot_time_crc_info:
> +        * @boot_time_crc_info:
>          *
>          * Buffer info for the boot time crc.
>          */
> --
> 2.43.0
>