From: Christian König <christian.koenig@amd.com>
To: Randy Dunlap <rdunlap@infradead.org>, dri-devel@lists.freedesktop.org
Cc: Alex Deucher <alexander.deucher@amd.com>,
amd-gfx@lists.freedesktop.org,
Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
Maxime Ripard <mripard@kernel.org>,
Thomas Zimmermann <tzimmermann@suse.de>,
David Airlie <airlied@gmail.com>, Simona Vetter <simona@ffwll.ch>
Subject: Re: [PATCH] drm/amdgpu: amdgpu.h: fix all kernel-doc warnings
Date: Mon, 2 Mar 2026 11:26:24 +0100 [thread overview]
Message-ID: <4c32e7c3-71e8-4ad3-a1c0-a06d42a00e50@amd.com> (raw)
In-Reply-To: <20260228071856.2664080-1-rdunlap@infradead.org>
On 2/28/26 08:18, Randy Dunlap wrote:
> Use the struct keyword for kernel-doc struct comments.
> Use the correct enum names in enum amd_reset_method.
>
> This eliminates these warnings:
I was expecting that there would be a few more.
...
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: Christian König <christian.koenig@amd.com>
> Cc: amd-gfx@lists.freedesktop.org
> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> Cc: Maxime Ripard <mripard@kernel.org>
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: David Airlie <airlied@gmail.com>
> Cc: Simona Vetter <simona@ffwll.ch>
>
> drivers/gpu/drm/amd/amdgpu/amdgpu.h | 39 ++++++++++++++------------
> 1 file changed, 21 insertions(+), 18 deletions(-)
>
> --- linux-next-20260227.orig/drivers/gpu/drm/amd/amdgpu/amdgpu.h
> +++ linux-next-20260227/drivers/gpu/drm/amd/amdgpu/amdgpu.h
> @@ -462,7 +462,7 @@ int amdgpu_file_to_fpriv(struct file *fi
> #define AMDGPU_MAX_WB 1024 /* Reserve at most 1024 WB slots for amdgpu-owned rings. */
>
> /**
> - * amdgpu_wb - This struct is used for small GPU memory allocation.
> + * struct amdgpu_wb - This struct is used for small GPU memory allocation.
> *
> * This struct is used to allocate a small amount of GPU memory that can be
> * used to shadow certain states into the memory. This is especially useful for
> @@ -540,23 +540,26 @@ struct amdgpu_allowed_register_entry {
> * enum amd_reset_method - Methods for resetting AMD GPU devices
> *
> * @AMD_RESET_METHOD_NONE: The device will not be reset.
> - * @AMD_RESET_LEGACY: Method reserved for SI, CIK and VI ASICs.
> - * @AMD_RESET_MODE0: Reset the entire ASIC. Not currently available for the
> - * any device.
> - * @AMD_RESET_MODE1: Resets all IP blocks on the ASIC (SDMA, GFX, VCN, etc.)
> - * individually. Suitable only for some discrete GPU, not
> - * available for all ASICs.
> - * @AMD_RESET_MODE2: Resets a lesser level of IPs compared to MODE1. Which IPs
> - * are reset depends on the ASIC. Notably doesn't reset IPs
> - * shared with the CPU on APUs or the memory controllers (so
> - * VRAM is not lost). Not available on all ASICs.
> - * @AMD_RESET_LINK: Triggers SW-UP link reset on other GPUs
> - * @AMD_RESET_BACO: BACO (Bus Alive, Chip Off) method powers off and on the card
> - * but without powering off the PCI bus. Suitable only for
> - * discrete GPUs.
> - * @AMD_RESET_PCI: Does a full bus reset using core Linux subsystem PCI reset
> - * and does a secondary bus reset or FLR, depending on what the
> - * underlying hardware supports.
> + * @AMD_RESET_METHOD_LEGACY: Method reserved for SI, CIK and VI ASICs.
> + * @AMD_RESET_METHOD_MODE0: Reset the entire ASIC. Not currently available
> + * for the any device.
> + * @AMD_RESET_METHOD_MODE1: Resets all IP blocks on the ASIC (SDMA, GFX, VCN,
> + * etc.) individually. Suitable only for some discrete
> + * GPU, not available for all ASICs.
> + * @AMD_RESET_METHOD_MODE2: Resets a lesser level of IPs compared to MODE1.
> + * Which IPs are reset depends on the ASIC. Notably
> + * doesn't reset IPs shared with the CPU on APUs or
> + * the memory controllers (so VRAM is not lost).
> + * Not available on all ASICs.
> + * @AMD_RESET_METHOD_LINK: Triggers SW-UP link reset on other GPUs
> + * @AMD_RESET_METHOD_BACO: BACO (Bus Alive, Chip Off) method powers off and on
> + * the card but without powering off the PCI bus.
> + * Suitable only for discrete GPUs.
> + * @AMD_RESET_METHOD_PCI: Does a full bus reset using core Linux subsystem
> + * PCI reset and does a secondary bus reset or FLR,
> + * depending on what the underlying hardware supports.
> + * @AMD_RESET_METHOD_ON_INIT: Does a device reset during the driver init
> + * sequence.
Looks like a good idea in general, but I'm really wondering why we have the define in amdgpu.h in the first place.
While at it please move the enum to amdgpu_reset.h and eventually only forward declare it in amdgpu.h
Apart from that the patch looks good to me.
Thanks,
Christian.
> *
> * Methods available for AMD GPU driver for resetting the device. Not all
> * methods are suitable for every device. User can override the method using
next prev parent reply other threads:[~2026-03-02 10:26 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-28 7:18 [PATCH] drm/amdgpu: amdgpu.h: fix all kernel-doc warnings Randy Dunlap
2026-03-02 10:26 ` Christian König [this message]
2026-03-03 4:34 ` Claude review: " Claude Code Review Bot
2026-03-03 4:34 ` Claude Code Review Bot
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=4c32e7c3-71e8-4ad3-a1c0-a06d42a00e50@amd.com \
--to=christian.koenig@amd.com \
--cc=airlied@gmail.com \
--cc=alexander.deucher@amd.com \
--cc=amd-gfx@lists.freedesktop.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=mripard@kernel.org \
--cc=rdunlap@infradead.org \
--cc=simona@ffwll.ch \
--cc=tzimmermann@suse.de \
/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