Re: [PATCH v3 1/6] drm: amdgpu: kernel-doc: update some adev parameters

From: Alex Deucher
Date: Wed Oct 21 2020 - 14:37:16 EST

Next message: Edgecombe, Rick P: "Re: [RFCv2 09/16] KVM: mm: Introduce VM_KVM_PROTECTED"
Previous message: Joe Perches: "Re: GCC section alignment, and GCC-4.9 being a weird one"
In reply to: Mauro Carvalho Chehab: "[PATCH v3 1/6] drm: amdgpu: kernel-doc: update some adev parameters"
Next in thread: Mauro Carvalho Chehab: "[PATCH v3 3/6] locking/refcount: move kernel-doc markups to the proper place"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

Applied. Thanks!

Alex

On Wed, Oct 21, 2020 at 8:17 AM Mauro Carvalho Chehab
<mchehab+huawei@xxxxxxxxxx> wrote:
>
> Running "make htmldocs: produce lots of warnings on those files:
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'p_size' description in 'amdgpu_vram_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:211: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_fini'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'p_size' description in 'amdgpu_vram_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:211: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_fini'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'p_size' description in 'amdgpu_vram_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:211: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_fini'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:177: warning: Excess function parameter 'p_size' description in 'amdgpu_vram_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c:211: warning: Excess function parameter 'man' description in 'amdgpu_vram_mgr_fini'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:90: warning: Excess function parameter 'man' description in 'amdgpu_gtt_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:90: warning: Excess function parameter 'p_size' description in 'amdgpu_gtt_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:134: warning: Excess function parameter 'man' description in 'amdgpu_gtt_mgr_fini'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:90: warning: Excess function parameter 'man' description in 'amdgpu_gtt_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:90: warning: Excess function parameter 'p_size' description in 'amdgpu_gtt_mgr_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c:134: warning: Excess function parameter 'man' description in 'amdgpu_gtt_mgr_fini'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:675: warning: Excess function parameter 'dev' description in 'amdgpu_device_asic_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:675: warning: Excess function parameter 'dev' description in 'amdgpu_device_asic_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:675: warning: Excess function parameter 'dev' description in 'amdgpu_device_asic_init'
> ./drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:675: warning: Excess function parameter 'dev' description in 'amdgpu_device_asic_init'
>
> They're related to the repacement of some parameters by adev,
> and due to a few renamed parameters.
>
> While here, uniform the name of the parameter for it to be
> the same on all functions using a pointer to struct amdgpu_device.
>
> Update the kernel-doc documentation accordingly.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> ---
> drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 28 ++++++++++----------
> drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c | 6 ++---
> drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c | 7 +++--
> 3 files changed, 20 insertions(+), 21 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> index e8b41756c9f9..f8785bdec79c 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> @@ -705,7 +705,7 @@ void amdgpu_device_indirect_wreg64(struct amdgpu_device *adev,
> /**
> * amdgpu_invalid_rreg - dummy reg read function
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> * @reg: offset of register
> *
> * Dummy register read function. Used for register blocks
> @@ -722,7 +722,7 @@ static uint32_t amdgpu_invalid_rreg(struct amdgpu_device *adev, uint32_t reg)
> /**
> * amdgpu_invalid_wreg - dummy reg write function
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> * @reg: offset of register
> * @v: value to write to the register
> *
> @@ -739,7 +739,7 @@ static void amdgpu_invalid_wreg(struct amdgpu_device *adev, uint32_t reg, uint32
> /**
> * amdgpu_invalid_rreg64 - dummy 64 bit reg read function
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> * @reg: offset of register
> *
> * Dummy register read function. Used for register blocks
> @@ -756,7 +756,7 @@ static uint64_t amdgpu_invalid_rreg64(struct amdgpu_device *adev, uint32_t reg)
> /**
> * amdgpu_invalid_wreg64 - dummy reg write function
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> * @reg: offset of register
> * @v: value to write to the register
> *
> @@ -773,7 +773,7 @@ static void amdgpu_invalid_wreg64(struct amdgpu_device *adev, uint32_t reg, uint
> /**
> * amdgpu_block_invalid_rreg - dummy reg read function
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> * @block: offset of instance
> * @reg: offset of register
> *
> @@ -793,7 +793,7 @@ static uint32_t amdgpu_block_invalid_rreg(struct amdgpu_device *adev,
> /**
> * amdgpu_block_invalid_wreg - dummy reg write function
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> * @block: offset of instance
> * @reg: offset of register
> * @v: value to write to the register
> @@ -813,7 +813,7 @@ static void amdgpu_block_invalid_wreg(struct amdgpu_device *adev,
> /**
> * amdgpu_device_asic_init - Wrapper for atom asic_init
> *
> - * @dev: drm_device pointer
> + * @adev: amdgpu_device pointer
> *
> * Does any asic specific work and then calls atom asic init.
> */
> @@ -827,7 +827,7 @@ static int amdgpu_device_asic_init(struct amdgpu_device *adev)
> /**
> * amdgpu_device_vram_scratch_init - allocate the VRAM scratch page
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> *
> * Allocates a scratch page of VRAM for use by various things in the
> * driver.
> @@ -844,7 +844,7 @@ static int amdgpu_device_vram_scratch_init(struct amdgpu_device *adev)
> /**
> * amdgpu_device_vram_scratch_fini - Free the VRAM scratch page
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> *
> * Frees the VRAM scratch page.
> */
> @@ -3011,7 +3011,7 @@ bool amdgpu_device_asic_has_dc_support(enum amd_asic_type asic_type)
> /**
> * amdgpu_device_has_dc_support - check if dc is supported
> *
> - * @adev: amdgpu_device_pointer
> + * @adev: amdgpu_device pointer
> *
> * Returns true for supported, false for not supported
> */
> @@ -4045,7 +4045,7 @@ static int amdgpu_device_recover_vram(struct amdgpu_device *adev)
> /**
> * amdgpu_device_reset_sriov - reset ASIC for SR-IOV vf
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> * @from_hypervisor: request from hypervisor
> *
> * do VF FLR and reinitialize Asic
> @@ -4100,7 +4100,7 @@ static int amdgpu_device_reset_sriov(struct amdgpu_device *adev,
> /**
> * amdgpu_device_has_job_running - check if there is any job in mirror list
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> *
> * check if there is any job in mirror list
> */
> @@ -4128,7 +4128,7 @@ bool amdgpu_device_has_job_running(struct amdgpu_device *adev)
> /**
> * amdgpu_device_should_recover_gpu - check if we should try GPU recovery
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> *
> * Check amdgpu_gpu_recovery and SRIOV status to see if we should try to recover
> * a hung GPU.
> @@ -4477,7 +4477,7 @@ static int amdgpu_device_suspend_display_audio(struct amdgpu_device *adev)
> /**
> * amdgpu_device_gpu_recover - reset the asic and recover scheduler
> *
> - * @adev: amdgpu device pointer
> + * @adev: amdgpu_device pointer
> * @job: which job trigger hang
> *
> * Attempt to reset the GPU if it has hung (all asics).
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c
> index f203e4a6a3f2..731f3aa2e6ba 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c
> @@ -81,8 +81,8 @@ static const struct ttm_resource_manager_func amdgpu_gtt_mgr_func;
> /**
> * amdgpu_gtt_mgr_init - init GTT manager and DRM MM
> *
> - * @man: TTM memory type manager
> - * @p_size: maximum size of GTT
> + * @adev: amdgpu_device pointer
> + * @gtt_size: maximum size of GTT
> *
> * Allocate and initialize the GTT manager.
> */
> @@ -123,7 +123,7 @@ int amdgpu_gtt_mgr_init(struct amdgpu_device *adev, uint64_t gtt_size)
> /**
> * amdgpu_gtt_mgr_fini - free and destroy GTT manager
> *
> - * @man: TTM memory type manager
> + * @adev: amdgpu_device pointer
> *
> * Destroy and free the GTT manager, returns -EBUSY if ranges are still
> * allocated inside it.
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
> index 01c1171afbe0..0c6b7c5ecfec 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
> @@ -168,8 +168,7 @@ static const struct ttm_resource_manager_func amdgpu_vram_mgr_func;
> /**
> * amdgpu_vram_mgr_init - init VRAM manager and DRM MM
> *
> - * @man: TTM memory type manager
> - * @p_size: maximum size of VRAM
> + * @adev: amdgpu_device pointer
> *
> * Allocate and initialize the VRAM manager.
> */
> @@ -199,7 +198,7 @@ int amdgpu_vram_mgr_init(struct amdgpu_device *adev)
> /**
> * amdgpu_vram_mgr_fini - free and destroy VRAM manager
> *
> - * @man: TTM memory type manager
> + * @adev: amdgpu_device pointer
> *
> * Destroy and free the VRAM manager, returns -EBUSY if ranges are still
> * allocated inside it.
> @@ -229,7 +228,7 @@ void amdgpu_vram_mgr_fini(struct amdgpu_device *adev)
> /**
> * amdgpu_vram_mgr_vis_size - Calculate visible node size
> *
> - * @adev: amdgpu device structure
> + * @adev: amdgpu_device pointer
> * @node: MM node structure
> *
> * Calculate how many bytes of the MM node are inside visible VRAM
> --
> 2.26.2
>
> _______________________________________________
> amd-gfx mailing list
> amd-gfx@xxxxxxxxxxxxxxxxxxxxx
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx

Next message: Edgecombe, Rick P: "Re: [RFCv2 09/16] KVM: mm: Introduce VM_KVM_PROTECTED"
Previous message: Joe Perches: "Re: GCC section alignment, and GCC-4.9 being a weird one"
In reply to: Mauro Carvalho Chehab: "[PATCH v3 1/6] drm: amdgpu: kernel-doc: update some adev parameters"
Next in thread: Mauro Carvalho Chehab: "[PATCH v3 3/6] locking/refcount: move kernel-doc markups to the proper place"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]