[PATCH] drm/amdgpu: Document parse_psp_v1_bin_descriptor
From: TAKANO Mitsuhiro
Date: Fri Nov 20 2026 - 22:02:58 EST
The kernel-doc comment of parse_psp_v1_bin_descriptor says what the
function does but names neither of its two parameters and does not
describe its return value, so kernel-doc reports:
drivers/gpu/drm/amd/amdgpu/amdgpu_psp.c:4440 function parameter 'desc' not described in 'parse_psp_v1_bin_descriptor'
drivers/gpu/drm/amd/amdgpu/amdgpu_psp.c:4440 function parameter 'hdr' not described in 'parse_psp_v1_bin_descriptor'
Describe both parameters and the return value. kernel-doc prints each of
these warnings twice, so the file goes from four warning lines to none, and
from six to none with -Wall.
Written with Hermes Agent, an LLM assistant; the author reviewed it and ran
kernel-doc on the file with and without the change.
Fixes: 581ada8f9bf3 ("drm/amdgpu: factor PSP v1.0 firmware bin descriptor parsing")
Reported-by: kernel test robot <lkp@xxxxxxxxx>
Closes: https://lore.kernel.org/oe-kbuild-all/202608210800.S15sl61g-lkp@xxxxxxxxx/
Signed-off-by: TAKANO Mitsuhiro <takano32@xxxxxxxxx>
---
drivers/gpu/drm/amd/amdgpu/amdgpu_psp.c | 3 +++
1 file changed, 3 insertions(+)
diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_psp.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_psp.c
index 82a2684dbd2e..3fd93cb1e634 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_psp.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_psp.c
@@ -4435,6 +4435,9 @@ int psp_ring_cmd_submit(struct psp_context *psp,
/**
* parse_psp_v1_bin_descriptor - Populate struct psp_bin_desc from a
* v1.0 PSP firmware header (standalone images such as ASD or TOC).
+ * @desc: the descriptor to populate
+ * @hdr: the firmware header to read
+ * Return: 0 on success, -EINVAL if either argument is NULL.
*/
static int parse_psp_v1_bin_descriptor(struct psp_bin_desc *desc,
const struct psp_firmware_header_v1_0 *hdr)
base-commit: d0f871bfb831705d9f55479f5b2b40f636ea7b16
--
2.53.0