Re: [PATCH 17/19] gpu: drm: radeon: radeon_device: Fix a bunch of kernel-doc misdemeanours

Alex Deucher
2020-11-10T21:50:51Z

On Thu, Nov 5, 2020 at 9:52 AM Lee Jones <lee.jones@linaro.org> wrote:
>
> - Demote non-conformant headers
> - Fix misnaming issues
> - Rename labels with identical names
> - Remove incorrect descriptions
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/gpu/drm/radeon/radeon_device.c:637:6: warning: no previous prototype for ‘radeon_device_is_virtual’ [-Wmissing-prototypes]
> drivers/gpu/drm/radeon/radeon_device.c:552: warning: duplicate section name 'Note'
> drivers/gpu/drm/radeon/radeon_device.c:556: warning: duplicate section name 'Note'
> drivers/gpu/drm/radeon/radeon_device.c:561: warning: duplicate section name 'Note'
> drivers/gpu/drm/radeon/radeon_device.c:564: warning: duplicate section name 'Note'
> drivers/gpu/drm/radeon/radeon_device.c:1106: warning: Function parameter or member 'family' not described in 'radeon_gart_size_auto'
> drivers/gpu/drm/radeon/radeon_device.c:1291: warning: Function parameter or member 'ddev' not described in 'radeon_device_init'
> drivers/gpu/drm/radeon/radeon_device.c:1565: warning: Function parameter or member 'dev' not described in 'radeon_suspend_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1565: warning: Function parameter or member 'suspend' not described in 'radeon_suspend_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1565: warning: Function parameter or member 'fbcon' not described in 'radeon_suspend_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1565: warning: Function parameter or member 'freeze' not described in 'radeon_suspend_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1565: warning: Excess function parameter 'pdev' description in 'radeon_suspend_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1565: warning: Excess function parameter 'state' description in 'radeon_suspend_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1669: warning: Function parameter or member 'dev' not described in 'radeon_resume_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1669: warning: Function parameter or member 'resume' not described in 'radeon_resume_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1669: warning: Function parameter or member 'fbcon' not described in 'radeon_resume_kms'
> drivers/gpu/drm/radeon/radeon_device.c:1669: warning: Excess function parameter 'pdev' description in 'radeon_resume_kms'
>
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: "Christian König" <christian.koenig@amd.com>
> Cc: David Airlie <airlied@linux.ie>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: amd-gfx@lists.freedesktop.org
> Cc: dri-devel@lists.freedesktop.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>

Applied. Thanks!

Alex

> ---
> drivers/gpu/drm/radeon/radeon_device.c | 23 +++++++++--------------
> 1 file changed, 9 insertions(+), 14 deletions(-)
>
> diff --git a/drivers/gpu/drm/radeon/radeon_device.c b/drivers/gpu/drm/radeon/radeon_device.c
> index 266e3cbbd09bd..7f384ffe848a7 100644
> --- a/drivers/gpu/drm/radeon/radeon_device.c
> +++ b/drivers/gpu/drm/radeon/radeon_device.c
> @@ -544,21 +544,21 @@ int radeon_wb_init(struct radeon_device *rdev)
> * Note: GTT start, end, size should be initialized before calling this
> * function on AGP platform.
> *
> - * Note: We don't explicitly enforce VRAM start to be aligned on VRAM size,
> + * Note 1: We don't explicitly enforce VRAM start to be aligned on VRAM size,
> * this shouldn't be a problem as we are using the PCI aperture as a reference.
> * Otherwise this would be needed for rv280, all r3xx, and all r4xx, but
> * not IGP.
> *
> - * Note: we use mc_vram_size as on some board we need to program the mc to
> + * Note 2: we use mc_vram_size as on some board we need to program the mc to
> * cover the whole aperture even if VRAM size is inferior to aperture size
> * Novell bug 204882 + along with lots of ubuntu ones
> *
> - * Note: when limiting vram it's safe to overwritte real_vram_size because
> + * Note 3: when limiting vram it's safe to overwritte real_vram_size because
> * we are not in case where real_vram_size is inferior to mc_vram_size (ie
> * note afected by bogus hw of Novell bug 204882 + along with lots of ubuntu
> * ones)
> *
> - * Note: IGP TOM addr should be the same as the aperture addr, we don't
> + * Note 4: IGP TOM addr should be the same as the aperture addr, we don't
> * explicitly check for that thought.
> *
> * FIXME: when reducing VRAM size align new size on power of 2.
> @@ -627,7 +627,7 @@ void radeon_gtt_location(struct radeon_device *rdev, struct radeon_mc *mc)
> * GPU helpers function.
> */
>
> -/**
> +/*
> * radeon_device_is_virtual - check if we are running is a virtual environment
> *
> * Check if the asic has been passed through to a VM (all asics).
> @@ -1100,7 +1100,7 @@ static bool radeon_check_pot_argument(int arg)
> /**
> * Determine a sensible default GART size according to ASIC family.
> *
> - * @family ASIC family name
> + * @family: ASIC family name
> */
> static int radeon_gart_size_auto(enum radeon_family family)
> {
> @@ -1276,7 +1276,7 @@ static const struct vga_switcheroo_client_ops radeon_switcheroo_ops = {
> * radeon_device_init - initialize the driver
> *
> * @rdev: radeon_device pointer
> - * @pdev: drm dev pointer
> + * @ddev: drm dev pointer
> * @pdev: pci dev pointer
> * @flags: driver flags
> *
> @@ -1550,12 +1550,9 @@ void radeon_device_fini(struct radeon_device *rdev)
> /*
> * Suspend & resume.
> */
> -/**
> +/*
> * radeon_suspend_kms - initiate device suspend
> *
> - * @pdev: drm dev pointer
> - * @state: suspend state
> - *
> * Puts the hw in the suspend state (all asics).
> * Returns 0 for success or an error on failure.
> * Called at driver suspend.
> @@ -1656,11 +1653,9 @@ int radeon_suspend_kms(struct drm_device *dev, bool suspend,
> return 0;
> }
>
> -/**
> +/*
> * radeon_resume_kms - initiate device resume
> *
> - * @pdev: drm dev pointer
> - *
> * Bring the hw back to operating state (all asics).
> * Returns 0 for success or an error on failure.
> * Called at driver resume.
> --
> 2.25.1
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel