[PATCH 07/17] dma: altera-msgdma: Fix struct documentation blocks

[Stefan Roese]

On 14.07.20 13:15, Lee Jones wrote:
> Fix some misspelling/description issues, demote non-kerneldoc header
> to standard comment block and provide a new description for
> msgdma_desc_config()'s 'stride' parameter.
> 
> Fixes the following W=1 kernel build warning(s):
> 
>   drivers/dma/altera-msgdma.c:163: warning: Function parameter or member 'node' not described in 'msgdma_sw_desc'
>   drivers/dma/altera-msgdma.c:163: warning: Function parameter or member 'tx_list' not described in 'msgdma_sw_desc'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'lock' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'dev' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'irq_tasklet' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'pending_list' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'free_list' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'active_list' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'done_list' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'desc_free_cnt' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'idle' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'dmadev' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'dmachan' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'hw_desq' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'sw_desq' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'npendings' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'slave_cfg' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'irq' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'csr' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'desc' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'resp' not described in 'msgdma_device'
>   drivers/dma/altera-msgdma.c:265: warning: Function parameter or member 'stride' not described in 'msgdma_desc_config'
> 
> Cc: Stefan Roese <sr at denx.de>
> Signed-off-by: Lee Jones <lee.jones at linaro.org>

Reviewed-by: Stefan Roese <sr at denx.de>

Thanks,
Stefan

> ---
>   drivers/dma/altera-msgdma.c | 6 ++++--
>   1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/dma/altera-msgdma.c b/drivers/dma/altera-msgdma.c
> index 539e785039cac..321ac3a7aa418 100644
> --- a/drivers/dma/altera-msgdma.c
> +++ b/drivers/dma/altera-msgdma.c
> @@ -153,7 +153,8 @@ struct msgdma_extended_desc {
>    * struct msgdma_sw_desc - implements a sw descriptor
>    * @async_tx: support for the async_tx api
>    * @hw_desc: assosiated HW descriptor
> - * @free_list: node of the free SW descriprots list
> + * @node: node to move from the free list to the tx list
> + * @tx_list: transmit list node
>    */
>   struct msgdma_sw_desc {
>   	struct dma_async_tx_descriptor async_tx;
> @@ -162,7 +163,7 @@ struct msgdma_sw_desc {
>   	struct list_head tx_list;
>   };
>   
> -/**
> +/*
>    * struct msgdma_device - DMA device structure
>    */
>   struct msgdma_device {
> @@ -258,6 +259,7 @@ static void msgdma_free_desc_list(struct msgdma_device *mdev,
>    * @dst: Destination buffer address
>    * @src: Source buffer address
>    * @len: Transfer length
> + * @stride: Read/write stride value to set
>    */
>   static void msgdma_desc_config(struct msgdma_extended_desc *desc,
>   			       dma_addr_t dst, dma_addr_t src, size_t len,
> 


Viele Grüße,
Stefan

-- 
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: sr at denx.de