Re: [Linaro-mm-sig] [PATCH 21/40] drm/amd/amdgpu/sdma_v4_0: Repair a bunch of kernel-doc problems - Linaro-mm-sig

30 Nov 2020

On Tue, Nov 24, 2020 at 2:45 PM Lee Jones lee.jones@linaro.org wrote:
...
Fixes the following W=1 kernel build warning(s):
drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:848: warning: Function parameter or member 'job' not described in 'sdma_v4_0_ring_emit_ib'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:848: warning: Function parameter or member 'flags' not described in 'sdma_v4_0_ring_emit_ib'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:923: warning: Function parameter or member 'addr' not described in 'sdma_v4_0_ring_emit_fence'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:923: warning: Function parameter or member 'seq' not described in 'sdma_v4_0_ring_emit_fence'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:923: warning: Function parameter or member 'flags' not described in 'sdma_v4_0_ring_emit_fence'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:923: warning: Excess function parameter 'fence' description in 'sdma_v4_0_ring_emit_fence'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1117: warning: Function parameter or member 'ring' not described in 'sdma_v4_0_rb_cntl'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1117: warning: Function parameter or member 'rb_cntl' not described in 'sdma_v4_0_rb_cntl'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1581: warning: Function parameter or member 'timeout' not described in 'sdma_v4_0_ring_test_ib'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1682: warning: Function parameter or member 'value' not described in 'sdma_v4_0_vm_write_pte'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1682: warning: Excess function parameter 'addr' description in 'sdma_v4_0_vm_write_pte'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1682: warning: Excess function parameter 'flags' description in 'sdma_v4_0_vm_write_pte'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1734: warning: Function parameter or member 'ring' not described in 'sdma_v4_0_ring_pad_ib'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1782: warning: Function parameter or member 'vmid' not described in 'sdma_v4_0_ring_emit_vm_flush'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1782: warning: Function parameter or member 'pd_addr' not described in 'sdma_v4_0_ring_emit_vm_flush'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:1782: warning: Excess function parameter 'vm' description in 'sdma_v4_0_ring_emit_vm_flush'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:2508: warning: Function parameter or member 'ib' not described in 'sdma_v4_0_emit_copy_buffer'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:2508: warning: Function parameter or member 'tmz' not described in 'sdma_v4_0_emit_copy_buffer'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:2508: warning: Excess function parameter 'ring' description in 'sdma_v4_0_emit_copy_buffer'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:2534: warning: Function parameter or member 'ib' not described in 'sdma_v4_0_emit_fill_buffer'
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c:2534: warning: Excess function parameter 'ring' description in 'sdma_v4_0_emit_fill_buffer'
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: Sumit Semwal sumit.semwal@linaro.org
Cc: amd-gfx@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org
Cc: linux-media@vger.kernel.org
Cc: linaro-mm-sig@lists.linaro.org
Signed-off-by: Lee Jones lee.jones@linaro.org
Applied with minor fixes.  Thanks!
Alex
...

drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c b/drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c
index dc74ca2aa8926..512efb31cc9fe 100644
--- a/drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c
+++ b/drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c
@@ -837,7 +837,9 @@ static void sdma_v4_0_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count)

sdma_v4_0_ring_emit_ib - Schedule an IB on the DMA engine

@ring: amdgpu ring pointer



@job: job to retrive vmid from
@ib: IB object to schedule



@flags: unused

Schedule an IB in the DMA ring (VEGA10).

*/

@@ -912,7 +914,9 @@ static void sdma_v4_0_ring_emit_hdp_flush(struct amdgpu_ring *ring)

sdma_v4_0_ring_emit_fence - emit a fence on the DMA ring

@ring: amdgpu ring pointer



@fence: amdgpu fence object





@addr: address



@seq: sequence number



@flags: fence related flags

Add a DMA fence packet to the ring to write
the fence seq number and DMA trap packet to generate



@@ -1110,7 +1114,7 @@ static void sdma_v4_0_enable(struct amdgpu_device *adev, bool enable)
        }
 }
-/**
+/*

sdma_v4_0_rb_cntl - get parameters for rb_cntl

*/
 static uint32_t sdma_v4_0_rb_cntl(struct amdgpu_ring *ring, uint32_t rb_cntl)
@@ -1573,6 +1577,7 @@ static int sdma_v4_0_ring_test_ring(struct amdgpu_ring *ring)

sdma_v4_0_ring_test_ib - test an IB on the DMA engine

@ring: amdgpu_ring structure holding ring information



@timeout: timeout value in jiffies, or MAX_SCHEDULE_TIMEOUT

Test a simple IB in the DMA ring (VEGA10).
Returns 0 on success, error on failure.



@@ -1669,10 +1674,9 @@ static void sdma_v4_0_vm_copy_pte(struct amdgpu_ib *ib,


@ib: indirect buffer to fill with commands
@pe: addr of the page entry



@addr: dst addr to write into pe





@value: dst addr to write into pe
@count: number of page entries to update
@incr: increase next addr by incr bytes





@flags: access flags

Update PTEs by writing them manually using sDMA (VEGA10).

*/

@@ -1727,8 +1731,8 @@ static void sdma_v4_0_vm_set_pte_pde(struct amdgpu_ib *ib,
 /**

sdma_v4_0_ring_pad_ib - pad the IB to the required number of dw




@ring: amdgpu_ring structure holding ring information
@ib: indirect buffer to fill with padding







*/

static void sdma_v4_0_ring_pad_ib(struct amdgpu_ring *ring, struct amdgpu_ib *ib)
 {
@@ -1772,7 +1776,8 @@ static void sdma_v4_0_ring_emit_pipeline_sync(struct amdgpu_ring *ring)

sdma_v4_0_ring_emit_vm_flush - vm flush using sDMA

@ring: amdgpu_ring pointer



@vm: amdgpu_vm pointer





@vmid: vmid number to use



@pd_addr: address

Update the page table base and flush the VM TLB
using sDMA (VEGA10).



@@ -2491,10 +2496,11 @@ static void sdma_v4_0_set_irq_funcs(struct amdgpu_device *adev)
 /**

sdma_v4_0_emit_copy_buffer - copy buffer using the sDMA engine




@ring: amdgpu_ring structure holding ring information





@ib: indirect buffer to copy to
@src_offset: src GPU address
@dst_offset: dst GPU address
@byte_count: number of bytes to xfer



@tmz: if a secure copy should be used

Copy GPU buffers using the DMA engine (VEGA10/12).
Used by the amdgpu ttm implementation to move pages if



@@ -2520,7 +2526,7 @@ static void sdma_v4_0_emit_copy_buffer(struct amdgpu_ib *ib,
 /**

sdma_v4_0_emit_fill_buffer - fill buffer using the sDMA engine




@ring: amdgpu_ring structure holding ring information





@ib: indirect buffer to copy to
@src_data: value to write to buffer
@dst_offset: dst GPU address
@byte_count: number of bytes to xfer



--
2.25.1

dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

    