Commit 35c7fad9 authored Nov 12, 2020 by Lee Jones Committed by Alex Deucher Nov 13, 2020

drm/amd/amdgpu/amdgpu_ring: Fix a bunch of function misdocumentation

Fixes the following W=1 kernel build warning(s):

drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:63: warning: Excess function parameter 'adev' description in 'amdgpu_ring_alloc'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:122: warning: Excess function parameter 'adev' description in 'amdgpu_ring_commit'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:167: warning: Function parameter or member 'max_dw' not described in 'amdgpu_ring_init'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:167: warning: Function parameter or member 'irq_src' not described in 'amdgpu_ring_init'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:167: warning: Function parameter or member 'irq_type' not described in 'amdgpu_ring_init'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:167: warning: Function parameter or member 'hw_prio' not described in 'amdgpu_ring_init'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:167: warning: Excess function parameter 'max_ndw' description in 'amdgpu_ring_init'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:167: warning: Excess function parameter 'nop' description in 'amdgpu_ring_init'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:285: warning: Excess function parameter 'adev' description in 'amdgpu_ring_fini'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:325: warning: Function parameter or member 'ring' not described in 'amdgpu_ring_emit_reg_write_reg_wait_helper'
drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c:325: warning: Excess function parameter 'adev' description in 'amdgpu_ring_emit_reg_write_reg_wait_helper'

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>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>

parent 75501872

drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c

+6 −6

Original line number	Diff line number	Diff line
		@@ -52,7 +52,6 @@
		/**
		* amdgpu_ring_alloc - allocate space on the ring buffer
		*
		* @adev: amdgpu_device pointer
		* @ring: amdgpu_ring structure holding ring information
		* @ndw: number of dwords to allocate in the ring buffer
		*
		@@ -95,7 +94,8 @@ void amdgpu_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count)
		amdgpu_ring_write(ring, ring->funcs->nop);
		}

		/** amdgpu_ring_generic_pad_ib - pad IB with NOP packets
		/**
		* amdgpu_ring_generic_pad_ib - pad IB with NOP packets
		*
		* @ring: amdgpu_ring structure holding ring information
		* @ib: IB to add NOP packets to
		@@ -112,7 +112,6 @@ void amdgpu_ring_generic_pad_ib(struct amdgpu_ring ring, struct amdgpu_ib ib)
		* amdgpu_ring_commit - tell the GPU to execute the new
		* commands on the ring buffer
		*
		* @adev: amdgpu_device pointer
		* @ring: amdgpu_ring structure holding ring information
		*
		* Update the wptr (write pointer) to tell the GPU to
		@@ -156,7 +155,9 @@ void amdgpu_ring_undo(struct amdgpu_ring *ring)
		* @adev: amdgpu_device pointer
		* @ring: amdgpu_ring structure holding ring information
		* @max_ndw: maximum number of dw for ring alloc
		* @nop: nop packet for this ring
		* @irq_src: interrupt source to use for this ring
		* @irq_type: interrupt type to use for this ring
		* @hw_prio: ring priority (NORMAL/HIGH)
		*
		* Initialize the driver information for the selected ring (all asics).
		* Returns 0 on success, error on failure.
		@@ -276,7 +277,6 @@ int amdgpu_ring_init(struct amdgpu_device adev, struct amdgpu_ring ring,
		/**
		* amdgpu_ring_fini - tear down the driver ring struct.
		*
		* @adev: amdgpu_device pointer
		* @ring: amdgpu_ring structure holding ring information
		*
		* Tear down the driver information for the selected ring (all asics).
		@@ -310,7 +310,7 @@ void amdgpu_ring_fini(struct amdgpu_ring *ring)
		/**
		* amdgpu_ring_emit_reg_write_reg_wait_helper - ring helper
		*
		* @adev: amdgpu_device pointer
		* @ring: ring to write to
		* @reg0: register to write
		* @reg1: register to wait on
		* @ref: reference value to write/wait on