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

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

[Randy Dunlap]

Add a kernel-doc comment for @power_module and use the correct name
for @boot_time_crc_info to eliminate kernel-doc warnings:

WARNING: ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:715 struct
 member 'power_module' not described in 'amdgpu_display_manager'
WARNING: ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:715 struct
 member 'boot_time_crc_info' not described in 'amdgpu_display_manager'
WARNING: ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:715 Excess
 struct member 'dm_boot_time_crc_info' description in 'amdgpu_display_manager'

Fixes: b034c5b0d831 ("drm/amd/display: Add a buffer for boot time crc")
Fixes: 3c108046e1d6 ("drm/amd/display: Add power module on Linux")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Tom Chung <chiahsuan.chung@amd.com>
Cc: Chuanyu Tseng <chuanyu.tseng@amd.com>
Cc: Ray Wu <ray.wu@amd.com>
Cc: Leo Li <sunpeng.li@amd.com>
Cc: Chenyu Chen <chen-yu.chen@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: amd-gfx@lists.freedesktop.org

 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20260520.orig/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
+++ linux-next-20260520/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: Manages replay, PSR, and backlight control functionality
  * @hdcp_workqueue: AMDGPU content protection queue
  * @fw_dmcu: Reference to DMCU firmware
  * @dmcu_fw_version: Version of the DMCU firmware
@@ -708,7 +709,7 @@ struct amdgpu_display_manager {
 	} fused_io[8];
 
 	/**
-	 * @dm_boot_time_crc_info:
+	 * @boot_time_crc_info:
 	 *
 	 * Buffer info for the boot time crc.
 	 */

Claude review: drm/amd/display: fix kernel-doc warnings

[Claude Code Review Bot]

Overall Series Review

Subject: drm/amd/display: fix kernel-doc warnings
Author: Randy Dunlap <rdunlap@infradead.org>
Patches: 1
Reviewed: 2026-05-25T21:16:18.456880

---

This is a single, straightforward kernel-doc fix patch from Randy Dunlap. It addresses two kernel-doc warnings in the `amdgpu_display_manager` struct documentation in `amdgpu_dm.h`:

1. **Missing doc for `power_module`** — adds a new `@power_module` entry to the struct's kernel-doc comment block.
2. **Wrong name for `boot_time_crc_info`** — the kernel-doc tag said `@dm_boot_time_crc_info` but the actual struct member is `boot_time_crc_info`. The patch corrects the tag.

The patch is correct, minimal, and well-formed. The `Fixes:` tags reference the commits that introduced the undocumented/misdocumented members. No functional code is changed — only comments.

**Verdict: Looks good. No issues found.**

---

---
Generated by Claude Code Patch Reviewer

Claude review: drm/amd/display: fix kernel-doc warnings

[Claude Code Review Bot]

Patch Review

**Status: Clean / Reviewed-by worthy**

**Change 1 — Add `@power_module` doc (line 333 in the patched file):**

```c
 * @freesync_module: Module handling freesync calculations
 * @power_module: Manages replay, PSR, and backlight control functionality
 * @hdcp_workqueue: AMDGPU content protection queue
```

Verified: The struct member `struct mod_power *power_module;` exists at line 579 of the patched file, and the new doc comment is placed in the correct position matching the declaration order (after `freesync_module`, before `hdcp_workqueue`). The description is accurate — `mod_power` handles PSR, replay, and backlight. Correct.

**Change 2 — Rename `@dm_boot_time_crc_info` to `@boot_time_crc_info` (line 712 in the patched file):**

```c
	/**
	 * @boot_time_crc_info:
	 *
	 * Buffer info for the boot time crc.
	 */
	struct dm_boot_time_crc_info boot_time_crc_info;
```

Verified: The struct member is `boot_time_crc_info` (line 716), not `dm_boot_time_crc_info`. The old doc tag `@dm_boot_time_crc_info` was a copy-paste error from the type name `struct dm_boot_time_crc_info`. The fix correctly makes the kernel-doc tag match the member name. Correct.

**No issues. No nits.** The commit message clearly explains the problem (with the actual warning text), the `Fixes:` tags are appropriate, and the Cc list covers the relevant maintainers.

---
Generated by Claude Code Patch Reviewer