Commit 982a820b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Alex Deucher

drm: amdgpu: kernel-doc: update some adev parameters

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent 86b6624a
...@@ -709,7 +709,7 @@ void amdgpu_device_indirect_wreg64(struct amdgpu_device *adev, ...@@ -709,7 +709,7 @@ void amdgpu_device_indirect_wreg64(struct amdgpu_device *adev,
/** /**
* amdgpu_invalid_rreg - dummy reg read function * amdgpu_invalid_rreg - dummy reg read function
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* @reg: offset of register * @reg: offset of register
* *
* Dummy register read function. Used for register blocks * Dummy register read function. Used for register blocks
...@@ -726,7 +726,7 @@ static uint32_t amdgpu_invalid_rreg(struct amdgpu_device *adev, uint32_t reg) ...@@ -726,7 +726,7 @@ static uint32_t amdgpu_invalid_rreg(struct amdgpu_device *adev, uint32_t reg)
/** /**
* amdgpu_invalid_wreg - dummy reg write function * amdgpu_invalid_wreg - dummy reg write function
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* @reg: offset of register * @reg: offset of register
* @v: value to write to the register * @v: value to write to the register
* *
...@@ -743,7 +743,7 @@ static void amdgpu_invalid_wreg(struct amdgpu_device *adev, uint32_t reg, uint32 ...@@ -743,7 +743,7 @@ static void amdgpu_invalid_wreg(struct amdgpu_device *adev, uint32_t reg, uint32
/** /**
* amdgpu_invalid_rreg64 - dummy 64 bit reg read function * amdgpu_invalid_rreg64 - dummy 64 bit reg read function
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* @reg: offset of register * @reg: offset of register
* *
* Dummy register read function. Used for register blocks * Dummy register read function. Used for register blocks
...@@ -760,7 +760,7 @@ static uint64_t amdgpu_invalid_rreg64(struct amdgpu_device *adev, uint32_t reg) ...@@ -760,7 +760,7 @@ static uint64_t amdgpu_invalid_rreg64(struct amdgpu_device *adev, uint32_t reg)
/** /**
* amdgpu_invalid_wreg64 - dummy reg write function * amdgpu_invalid_wreg64 - dummy reg write function
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* @reg: offset of register * @reg: offset of register
* @v: value to write to the register * @v: value to write to the register
* *
...@@ -777,7 +777,7 @@ static void amdgpu_invalid_wreg64(struct amdgpu_device *adev, uint32_t reg, uint ...@@ -777,7 +777,7 @@ static void amdgpu_invalid_wreg64(struct amdgpu_device *adev, uint32_t reg, uint
/** /**
* amdgpu_block_invalid_rreg - dummy reg read function * amdgpu_block_invalid_rreg - dummy reg read function
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* @block: offset of instance * @block: offset of instance
* @reg: offset of register * @reg: offset of register
* *
...@@ -797,7 +797,7 @@ static uint32_t amdgpu_block_invalid_rreg(struct amdgpu_device *adev, ...@@ -797,7 +797,7 @@ static uint32_t amdgpu_block_invalid_rreg(struct amdgpu_device *adev,
/** /**
* amdgpu_block_invalid_wreg - dummy reg write function * amdgpu_block_invalid_wreg - dummy reg write function
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* @block: offset of instance * @block: offset of instance
* @reg: offset of register * @reg: offset of register
* @v: value to write to the register * @v: value to write to the register
...@@ -817,7 +817,7 @@ static void amdgpu_block_invalid_wreg(struct amdgpu_device *adev, ...@@ -817,7 +817,7 @@ static void amdgpu_block_invalid_wreg(struct amdgpu_device *adev,
/** /**
* amdgpu_device_asic_init - Wrapper for atom asic_init * 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. * Does any asic specific work and then calls atom asic init.
*/ */
...@@ -831,7 +831,7 @@ static int amdgpu_device_asic_init(struct amdgpu_device *adev) ...@@ -831,7 +831,7 @@ static int amdgpu_device_asic_init(struct amdgpu_device *adev)
/** /**
* amdgpu_device_vram_scratch_init - allocate the VRAM scratch page * 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 * Allocates a scratch page of VRAM for use by various things in the
* driver. * driver.
...@@ -848,7 +848,7 @@ static int amdgpu_device_vram_scratch_init(struct amdgpu_device *adev) ...@@ -848,7 +848,7 @@ static int amdgpu_device_vram_scratch_init(struct amdgpu_device *adev)
/** /**
* amdgpu_device_vram_scratch_fini - Free the VRAM scratch page * amdgpu_device_vram_scratch_fini - Free the VRAM scratch page
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* *
* Frees the VRAM scratch page. * Frees the VRAM scratch page.
*/ */
...@@ -3022,7 +3022,7 @@ bool amdgpu_device_asic_has_dc_support(enum amd_asic_type asic_type) ...@@ -3022,7 +3022,7 @@ bool amdgpu_device_asic_has_dc_support(enum amd_asic_type asic_type)
/** /**
* amdgpu_device_has_dc_support - check if dc is supported * 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 * Returns true for supported, false for not supported
*/ */
...@@ -4056,7 +4056,7 @@ static int amdgpu_device_recover_vram(struct amdgpu_device *adev) ...@@ -4056,7 +4056,7 @@ static int amdgpu_device_recover_vram(struct amdgpu_device *adev)
/** /**
* amdgpu_device_reset_sriov - reset ASIC for SR-IOV vf * amdgpu_device_reset_sriov - reset ASIC for SR-IOV vf
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* @from_hypervisor: request from hypervisor * @from_hypervisor: request from hypervisor
* *
* do VF FLR and reinitialize Asic * do VF FLR and reinitialize Asic
...@@ -4111,7 +4111,7 @@ static int amdgpu_device_reset_sriov(struct amdgpu_device *adev, ...@@ -4111,7 +4111,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 * 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 * check if there is any job in mirror list
*/ */
...@@ -4139,7 +4139,7 @@ bool amdgpu_device_has_job_running(struct amdgpu_device *adev) ...@@ -4139,7 +4139,7 @@ bool amdgpu_device_has_job_running(struct amdgpu_device *adev)
/** /**
* amdgpu_device_should_recover_gpu - check if we should try GPU recovery * 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 * Check amdgpu_gpu_recovery and SRIOV status to see if we should try to recover
* a hung GPU. * a hung GPU.
...@@ -4488,7 +4488,7 @@ static int amdgpu_device_suspend_display_audio(struct amdgpu_device *adev) ...@@ -4488,7 +4488,7 @@ static int amdgpu_device_suspend_display_audio(struct amdgpu_device *adev)
/** /**
* amdgpu_device_gpu_recover - reset the asic and recover scheduler * amdgpu_device_gpu_recover - reset the asic and recover scheduler
* *
* @adev: amdgpu device pointer * @adev: amdgpu_device pointer
* @job: which job trigger hang * @job: which job trigger hang
* *
* Attempt to reset the GPU if it has hung (all asics). * Attempt to reset the GPU if it has hung (all asics).
......
...@@ -81,8 +81,8 @@ static const struct ttm_resource_manager_func amdgpu_gtt_mgr_func; ...@@ -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 * amdgpu_gtt_mgr_init - init GTT manager and DRM MM
* *
* @man: TTM memory type manager * @adev: amdgpu_device pointer
* @p_size: maximum size of GTT * @gtt_size: maximum size of GTT
* *
* Allocate and initialize the GTT manager. * Allocate and initialize the GTT manager.
*/ */
...@@ -125,7 +125,7 @@ int amdgpu_gtt_mgr_init(struct amdgpu_device *adev, uint64_t gtt_size) ...@@ -125,7 +125,7 @@ int amdgpu_gtt_mgr_init(struct amdgpu_device *adev, uint64_t gtt_size)
/** /**
* amdgpu_gtt_mgr_fini - free and destroy GTT manager * 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 * Destroy and free the GTT manager, returns -EBUSY if ranges are still
* allocated inside it. * allocated inside it.
......
...@@ -168,8 +168,7 @@ static const struct ttm_resource_manager_func amdgpu_vram_mgr_func; ...@@ -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 * amdgpu_vram_mgr_init - init VRAM manager and DRM MM
* *
* @man: TTM memory type manager * @adev: amdgpu_device pointer
* @p_size: maximum size of VRAM
* *
* Allocate and initialize the VRAM manager. * Allocate and initialize the VRAM manager.
*/ */
...@@ -202,7 +201,7 @@ int amdgpu_vram_mgr_init(struct amdgpu_device *adev) ...@@ -202,7 +201,7 @@ int amdgpu_vram_mgr_init(struct amdgpu_device *adev)
/** /**
* amdgpu_vram_mgr_fini - free and destroy VRAM manager * 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 * Destroy and free the VRAM manager, returns -EBUSY if ranges are still
* allocated inside it. * allocated inside it.
...@@ -232,7 +231,7 @@ void amdgpu_vram_mgr_fini(struct amdgpu_device *adev) ...@@ -232,7 +231,7 @@ void amdgpu_vram_mgr_fini(struct amdgpu_device *adev)
/** /**
* amdgpu_vram_mgr_vis_size - Calculate visible node size * amdgpu_vram_mgr_vis_size - Calculate visible node size
* *
* @adev: amdgpu device structure * @adev: amdgpu_device pointer
* @node: MM node structure * @node: MM node structure
* *
* Calculate how many bytes of the MM node are inside visible VRAM * Calculate how many bytes of the MM node are inside visible VRAM
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment