From: Ayush <ayush37735@gmail.com>
To: amd-gfx@lists.freedesktop.org
Cc: alexander.deucher@amd.com, christian.koenig@amd.com,
airlied@gmail.com, simona@ffwll.ch,
dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org,
Ayush <ayush37735@gmail.com>
Subject: [PATCH] drm/amdgpu: fix kernel-doc in amdgpu_gfx.h
Date: Tue, 10 Nov 2026 06:42:56 +0530 [thread overview]
Message-ID: <20261110011256.157652-1-ayush37735@gmail.com> (raw)
Fix kernel-doc warnings in drivers/gpu/drm/amd/amdgpu/amdgpu_gfx.h by
adding the missing 'struct' keyword to amdgpu_rb_config, properly
formatting and aligning member documentation comments, and adding
an explicit Return: block for amdgpu_gfx_create_bitmask().
Validated with ./scripts/kernel-doc -v -none -Wall -Werror.
Signed-off-by: Ayush <ayush37735@gmail.com>
---
drivers/gpu/drm/amd/amdgpu/amdgpu_gfx.h | 31 +++++++++++--------------
1 file changed, 13 insertions(+), 18 deletions(-)
diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_gfx.h b/drivers/gpu/drm/amd/amdgpu/amdgpu_gfx.h
index 5939e1fb3..96f4e4ce2 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_gfx.h
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_gfx.h
@@ -181,7 +181,7 @@ struct amdgpu_kiq {
#define AMDGPU_GFX_MAX_SH_PER_SE 2
/**
- * amdgpu_rb_config - Configure a single Render Backend (RB)
+ * struct amdgpu_rb_config - Configure a single Render Backend (RB)
*
* Bad RBs are fused off and there is a harvest register the driver reads to
* determine which RB(s) are fused off so that the driver can configure the
@@ -191,34 +191,28 @@ struct amdgpu_kiq {
*/
struct amdgpu_rb_config {
/**
- * @rb_backend_disable:
- *
- * The value captured from register RB_BACKEND_DISABLE indicates if the
- * RB backend is disabled or not.
+ * @rb_backend_disable: The value captured from register
+ * RB_BACKEND_DISABLE indicates if the RB backend is disabled or not.
*/
uint32_t rb_backend_disable;
/**
- * @user_rb_backend_disable:
- *
- * The value captured from register USER_RB_BACKEND_DISABLE indicates
- * if the User RB backend is disabled or not.
+ * @user_rb_backend_disable: The value captured from register
+ * USER_RB_BACKEND_DISABLE indicates if the User RB backend is disabled
+ * or not.
*/
uint32_t user_rb_backend_disable;
/**
- * @raster_config:
- *
- * To set up all of the states, it is necessary to have two registers
- * to keep all of the states. This field holds the first register.
+ * @raster_config: To set up all of the states, it is necessary to have
+ * two registers to keep all of the states. This field holds the first
+ * register.
*/
uint32_t raster_config;
/**
- * @raster_config_1:
- *
- * To set up all of the states, it is necessary to have two registers
- * to keep all of the states. This field holds the second register.
+ * @raster_config_1: This field holds the second register for setting
+ * up the raster states.
*/
uint32_t raster_config_1;
};
@@ -587,7 +581,8 @@ struct amdgpu_gfx_ras_mem_id_entry {
* @bit_width: length of the mask
*
* create a variable length bit mask.
- * Returns the bitmask.
+ *
+ * Return: The generated bitmask.
*/
static inline u32 amdgpu_gfx_create_bitmask(u32 bit_width)
{
--
2.53.0
reply other threads:[~2026-11-10 1:13 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261110011256.157652-1-ayush37735@gmail.com \
--to=ayush37735@gmail.com \
--cc=airlied@gmail.com \
--cc=alexander.deucher@amd.com \
--cc=amd-gfx@lists.freedesktop.org \
--cc=christian.koenig@amd.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-kernel@vger.kernel.org \
--cc=simona@ffwll.ch \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®