[PATCH 12/20] drm/radeon/radeon_cs: Fix a bunch of doc-rot issues

[Alex Deucher]

On Mon, Nov 9, 2020 at 4:19 PM Lee Jones <lee.jones at linaro.org> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/gpu/drm/radeon/radeon_cs.c:416: warning: Function parameter or member 'backoff' not described in 'radeon_cs_parser_fini'
>  drivers/gpu/drm/radeon/radeon_cs.c:735: warning: Function parameter or member 'p' not described in 'radeon_cs_packet_parse'
>  drivers/gpu/drm/radeon/radeon_cs.c:735: warning: Function parameter or member 'idx' not described in 'radeon_cs_packet_parse'
>  drivers/gpu/drm/radeon/radeon_cs.c:735: warning: Excess function parameter 'parser' description in 'radeon_cs_packet_parse'
>  drivers/gpu/drm/radeon/radeon_cs.c:844: warning: Function parameter or member 'p' not described in 'radeon_cs_packet_next_reloc'
>  drivers/gpu/drm/radeon/radeon_cs.c:844: warning: Function parameter or member 'cs_reloc' not described in 'radeon_cs_packet_next_reloc'
>  drivers/gpu/drm/radeon/radeon_cs.c:844: warning: Function parameter or member 'nomm' not described in 'radeon_cs_packet_next_reloc'
>  drivers/gpu/drm/radeon/radeon_cs.c:844: warning: Excess function parameter 'parser' description in 'radeon_cs_packet_next_reloc'
>  drivers/gpu/drm/radeon/radeon_cs.c:844: warning: Excess function parameter 'data' description in 'radeon_cs_packet_next_reloc'
>  drivers/gpu/drm/radeon/radeon_cs.c:844: warning: Excess function parameter 'offset_start' description in 'radeon_cs_packet_next_reloc'
>  drivers/gpu/drm/radeon/radeon_cs.c:844: warning: Excess function parameter 'offset_mask' description in 'radeon_cs_packet_next_reloc'
>  drivers/gpu/drm/radeon/radeon_cs.c:844: warning: Excess function parameter 'reloc' description in 'radeon_cs_packet_next_reloc'
>
> Cc: Alex Deucher <alexander.deucher at amd.com>
> Cc: "Christian König" <christian.koenig at amd.com>
> Cc: David Airlie <airlied at linux.ie>
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Cc: Sumit Semwal <sumit.semwal at linaro.org>
> Cc: Jerome Glisse <glisse at freedesktop.org>
> Cc: amd-gfx at lists.freedesktop.org
> Cc: dri-devel at lists.freedesktop.org
> Cc: linux-media at vger.kernel.org
> Cc: linaro-mm-sig at lists.linaro.org
> Signed-off-by: Lee Jones <lee.jones at linaro.org>

Applied with some minor fixups.

Thanks!

Alex

> ---
>  drivers/gpu/drm/radeon/radeon_cs.c | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/gpu/drm/radeon/radeon_cs.c b/drivers/gpu/drm/radeon/radeon_cs.c
> index 21ce2f9502c09..729939df29cc5 100644
> --- a/drivers/gpu/drm/radeon/radeon_cs.c
> +++ b/drivers/gpu/drm/radeon/radeon_cs.c
> @@ -408,6 +408,7 @@ static int cmp_size_smaller_first(void *priv, struct list_head *a,
>   * cs_parser_fini() - clean parser states
>   * @parser:    parser structure holding parsing context.
>   * @error:     error number
> + * @backoff:   indicator to backoff the reservation
>   *
>   * If error is set than unvalidate buffer, otherwise just free memory
>   * used by parsing context.
> @@ -723,8 +724,9 @@ int radeon_cs_ioctl(struct drm_device *dev, void *data, struct drm_file *filp)
>
>  /**
>   * radeon_cs_packet_parse() - parse cp packet and point ib index to next packet
> - * @parser:    parser structure holding parsing context.
> + * @p:         parser structure holding parsing context.
>   * @pkt:       where to store packet information
> + * @idx:       packet index
>   *
>   * Assume that chunk_ib_index is properly set. Will return -EINVAL
>   * if packet is bigger than remaining ib size. or if packets is unknown.
> @@ -829,11 +831,9 @@ void radeon_cs_dump_packet(struct radeon_cs_parser *p,
>
>  /**
>   * radeon_cs_packet_next_reloc() - parse next (should be reloc) packet
> - * @parser:            parser structure holding parsing context.
> - * @data:              pointer to relocation data
> - * @offset_start:      starting offset
> - * @offset_mask:       offset mask (to align start offset on)
> - * @reloc:             reloc informations
> + * @p:                 parser structure holding parsing context.
> + * @cs_reloc:          reloc informations
> + * @nomm:              never actually used
>   *
>   * Check if next packet is relocation packet3, do bo validation and compute
>   * GPU offset using the provided start.
> --
> 2.25.1
>
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel