Commit f15f720b authored by Lee Jones's avatar Lee Jones Committed by Vinod Koul

dmaengine: altera-msgdma: Fix struct documentation blocks

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'
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Cc: Stefan Roese <sr@denx.de>
Link: https://lore.kernel.org/r/20200714111546.1755231-8-lee.jones@linaro.orgSigned-off-by: default avatarVinod Koul <vkoul@kernel.org>
parent 0b851134
...@@ -153,7 +153,8 @@ struct msgdma_extended_desc { ...@@ -153,7 +153,8 @@ struct msgdma_extended_desc {
* struct msgdma_sw_desc - implements a sw descriptor * struct msgdma_sw_desc - implements a sw descriptor
* @async_tx: support for the async_tx api * @async_tx: support for the async_tx api
* @hw_desc: assosiated HW descriptor * @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 msgdma_sw_desc {
struct dma_async_tx_descriptor async_tx; struct dma_async_tx_descriptor async_tx;
...@@ -162,7 +163,7 @@ struct msgdma_sw_desc { ...@@ -162,7 +163,7 @@ struct msgdma_sw_desc {
struct list_head tx_list; struct list_head tx_list;
}; };
/** /*
* struct msgdma_device - DMA device structure * struct msgdma_device - DMA device structure
*/ */
struct msgdma_device { struct msgdma_device {
...@@ -258,6 +259,7 @@ static void msgdma_free_desc_list(struct msgdma_device *mdev, ...@@ -258,6 +259,7 @@ static void msgdma_free_desc_list(struct msgdma_device *mdev,
* @dst: Destination buffer address * @dst: Destination buffer address
* @src: Source buffer address * @src: Source buffer address
* @len: Transfer length * @len: Transfer length
* @stride: Read/write stride value to set
*/ */
static void msgdma_desc_config(struct msgdma_extended_desc *desc, static void msgdma_desc_config(struct msgdma_extended_desc *desc,
dma_addr_t dst, dma_addr_t src, size_t len, dma_addr_t dst, dma_addr_t src, size_t len,
......
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