Re: [PATCH v2] dmaengine: imx-sdma: add missing structure description
On 04-07-18, 18:06, Robin Gong wrote: > Some member description or colons missing cause build warning with > 'W=1' as below: > > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'vd' not > described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'num_bd' > not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'bd_phys' > not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_tail' > not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_ptail' > not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member > 'period_len' not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member > 'chn_real_count' not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'chn_count' > not described in 'sdma_desc Applied, thanks -- ~Vinod
Re: [PATCH v2] dmaengine: imx-sdma: add missing structure description
On 04-07-18, 18:06, Robin Gong wrote: > Some member description or colons missing cause build warning with > 'W=1' as below: > > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'vd' not > described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'num_bd' > not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'bd_phys' > not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_tail' > not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_ptail' > not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member > 'period_len' not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member > 'chn_real_count' not described in 'sdma_desc' > drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'chn_count' > not described in 'sdma_desc Applied, thanks -- ~Vinod
[PATCH v2] dmaengine: imx-sdma: add missing structure description
Some member description or colons missing cause build warning with
'W=1' as below:
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'vd' not
described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'num_bd' not
described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'bd_phys' not
described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_tail'
not described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_ptail'
not described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'period_len'
not described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member
'chn_real_count' not described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'chn_count'
not described in 'sdma_desc
Signed-off-by: Robin Gong
Reported-by: Vinod Koul
---
drivers/dma/imx-sdma.c | 85 +-
1 file changed, 57 insertions(+), 28 deletions(-)
diff --git a/drivers/dma/imx-sdma.c b/drivers/dma/imx-sdma.c
index 3de3281..c24baf9 100644
--- a/drivers/dma/imx-sdma.c
+++ b/drivers/dma/imx-sdma.c
@@ -202,9 +202,9 @@ struct sdma_buffer_descriptor {
/**
* struct sdma_channel_control - Channel control Block
*
- * @current_bd_ptr current buffer descriptor processed
- * @base_bd_ptrfirst element of buffer descriptor array
- * @unused padding. The SDMA engine expects an array of 128 byte
+ * @current_bd_ptr:current buffer descriptor processed
+ * @base_bd_ptr: first element of buffer descriptor array
+ * @unused:padding. The SDMA engine expects an array of 128 byte
* control blocks
*/
struct sdma_channel_control {
@@ -217,10 +217,13 @@ struct sdma_channel_control {
* struct sdma_state_registers - SDMA context for a channel
*
* @pc:program counter
+ * @unused1: unused
* @t: test bit: status of arithmetic & test instruction
* @rpc: return program counter
+ * @unused0: unused
* @sf:source fault while loading data
* @spc: loop start program counter
+ * @unused2: unused
* @df:destination fault while storing data
* @epc: loop end program counter
* @lm:loop mode
@@ -258,6 +261,14 @@ struct sdma_state_registers {
* @dsa: dedicated core source address register
* @ds:dedicated core status register
* @dd:dedicated core data register
+ * @scratch0: 1st word of dedicated ram for context switch
+ * @scratch1: 2nd word of dedicated ram for context switch
+ * @scratch2: 3rd word of dedicated ram for context switch
+ * @scratch3: 4th word of dedicated ram for context switch
+ * @scratch4: 5th word of dedicated ram for context switch
+ * @scratch5: 6th word of dedicated ram for context switch
+ * @scratch6: 7th word of dedicated ram for context switch
+ * @scratch7: 8th word of dedicated ram for context switch
*/
struct sdma_context_data {
struct sdma_state_registers channel_state;
@@ -291,15 +302,16 @@ struct sdma_engine;
/**
* struct sdma_desc - descriptor structor for one transfer
- * @vd descriptor for virt dma
- * @num_bd max NUM_BD. number of descriptors currently handling
- * @buf_tail ID of the buffer that was processed
- * @buf_ptail ID of the previous buffer that was processed
- * @period_len period length, used in cyclic.
- * @chn_real_count the real count updated from bd->mode.count
- * @chn_count the transfer count set
- * @sdmac sdma_channel pointer
- * @bd pointer of allocate bd
+ * @vd:descriptor for virt dma
+ * @num_bd:number of descriptors currently handling
+ * @bd_phys: physical address of bd
+ * @buf_tail: ID of the buffer that was processed
+ * @buf_ptail: ID of the previous buffer that was processed
+ * @period_len:period length, used in cyclic.
+ * @chn_real_count:the real count updated from bd->mode.count
+ * @chn_count: the transfer count set
+ * @sdmac: sdma_channel pointer
+ * @bd:pointer of allocate bd
*/
struct sdma_desc {
struct virt_dma_descvd;
@@ -317,13 +329,30 @@ struct sdma_desc {
/**
* struct sdma_channel - housekeeping for a SDMA channel
*
- * @sdma pointer to the SDMA engine for this channel
- * @channelthe channel number, matches dmaengine chan_id + 1
- * @direction transfer type. Needed for setting SDMA script
- * @peripheral_typePeripheral type. Needed for setting SDMA script
- * @event_id0
[PATCH v2] dmaengine: imx-sdma: add missing structure description
Some member description or colons missing cause build warning with
'W=1' as below:
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'vd' not
described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'num_bd' not
described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'bd_phys' not
described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_tail'
not described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_ptail'
not described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'period_len'
not described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member
'chn_real_count' not described in 'sdma_desc'
drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'chn_count'
not described in 'sdma_desc
Signed-off-by: Robin Gong
Reported-by: Vinod Koul
---
drivers/dma/imx-sdma.c | 85 +-
1 file changed, 57 insertions(+), 28 deletions(-)
diff --git a/drivers/dma/imx-sdma.c b/drivers/dma/imx-sdma.c
index 3de3281..c24baf9 100644
--- a/drivers/dma/imx-sdma.c
+++ b/drivers/dma/imx-sdma.c
@@ -202,9 +202,9 @@ struct sdma_buffer_descriptor {
/**
* struct sdma_channel_control - Channel control Block
*
- * @current_bd_ptr current buffer descriptor processed
- * @base_bd_ptrfirst element of buffer descriptor array
- * @unused padding. The SDMA engine expects an array of 128 byte
+ * @current_bd_ptr:current buffer descriptor processed
+ * @base_bd_ptr: first element of buffer descriptor array
+ * @unused:padding. The SDMA engine expects an array of 128 byte
* control blocks
*/
struct sdma_channel_control {
@@ -217,10 +217,13 @@ struct sdma_channel_control {
* struct sdma_state_registers - SDMA context for a channel
*
* @pc:program counter
+ * @unused1: unused
* @t: test bit: status of arithmetic & test instruction
* @rpc: return program counter
+ * @unused0: unused
* @sf:source fault while loading data
* @spc: loop start program counter
+ * @unused2: unused
* @df:destination fault while storing data
* @epc: loop end program counter
* @lm:loop mode
@@ -258,6 +261,14 @@ struct sdma_state_registers {
* @dsa: dedicated core source address register
* @ds:dedicated core status register
* @dd:dedicated core data register
+ * @scratch0: 1st word of dedicated ram for context switch
+ * @scratch1: 2nd word of dedicated ram for context switch
+ * @scratch2: 3rd word of dedicated ram for context switch
+ * @scratch3: 4th word of dedicated ram for context switch
+ * @scratch4: 5th word of dedicated ram for context switch
+ * @scratch5: 6th word of dedicated ram for context switch
+ * @scratch6: 7th word of dedicated ram for context switch
+ * @scratch7: 8th word of dedicated ram for context switch
*/
struct sdma_context_data {
struct sdma_state_registers channel_state;
@@ -291,15 +302,16 @@ struct sdma_engine;
/**
* struct sdma_desc - descriptor structor for one transfer
- * @vd descriptor for virt dma
- * @num_bd max NUM_BD. number of descriptors currently handling
- * @buf_tail ID of the buffer that was processed
- * @buf_ptail ID of the previous buffer that was processed
- * @period_len period length, used in cyclic.
- * @chn_real_count the real count updated from bd->mode.count
- * @chn_count the transfer count set
- * @sdmac sdma_channel pointer
- * @bd pointer of allocate bd
+ * @vd:descriptor for virt dma
+ * @num_bd:number of descriptors currently handling
+ * @bd_phys: physical address of bd
+ * @buf_tail: ID of the buffer that was processed
+ * @buf_ptail: ID of the previous buffer that was processed
+ * @period_len:period length, used in cyclic.
+ * @chn_real_count:the real count updated from bd->mode.count
+ * @chn_count: the transfer count set
+ * @sdmac: sdma_channel pointer
+ * @bd:pointer of allocate bd
*/
struct sdma_desc {
struct virt_dma_descvd;
@@ -317,13 +329,30 @@ struct sdma_desc {
/**
* struct sdma_channel - housekeeping for a SDMA channel
*
- * @sdma pointer to the SDMA engine for this channel
- * @channelthe channel number, matches dmaengine chan_id + 1
- * @direction transfer type. Needed for setting SDMA script
- * @peripheral_typePeripheral type. Needed for setting SDMA script
- * @event_id0
