diff mbox

dmaengine: qcom: bam_dma: fix some doc warnings.

Message ID 20180517095916.11362-1-srinivas.kandagatla@linaro.org (mailing list archive)
State New, archived
Headers show

Commit Message

Srinivas Kandagatla May 17, 2018, 9:59 a.m. UTC
Building kernel with W=1 throws up below warnings:
bam_dma.c:459: warning: Function parameter or member 'dir'
	not described in 'bam_chan_init_hw'
bam_dma.c:697: warning: Function parameter or member 'chan'
	not described in 'bam_dma_terminate_all'
bam_dma.c:697: warning: Excess function parameter 'bchan'
	description in 'bam_dma_terminate_all'
bam_dma.c:964: warning: Function parameter or member 'bchan'
	not described in 'bam_start_dma'

Fix these!.

Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
---
 drivers/dma/qcom/bam_dma.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Vinod Koul May 17, 2018, 10:50 a.m. UTC | #1
On 17-05-18, 10:59, Srinivas Kandagatla wrote:
> diff --git a/drivers/dma/qcom/bam_dma.c b/drivers/dma/qcom/bam_dma.c
> index 4a828c18099a..a05fff8a1447 100644
> --- a/drivers/dma/qcom/bam_dma.c
> +++ b/drivers/dma/qcom/bam_dma.c
> @@ -451,7 +451,7 @@ static void bam_reset_channel(struct bam_chan *bchan)
>  /**
>   * bam_chan_init_hw - Initialize channel hardware
>   * @bchan: bam channel
> - *
> + * @dir: DMA transfer direction

Do you want to add an empty line here?

>   * This function resets and initializes the BAM channel
Srinivas Kandagatla May 17, 2018, 10:53 a.m. UTC | #2
On 17/05/18 11:50, Vinod Koul wrote:
> On 17-05-18, 10:59, Srinivas Kandagatla wrote:
>> diff --git a/drivers/dma/qcom/bam_dma.c b/drivers/dma/qcom/bam_dma.c
>> index 4a828c18099a..a05fff8a1447 100644
>> --- a/drivers/dma/qcom/bam_dma.c
>> +++ b/drivers/dma/qcom/bam_dma.c
>> @@ -451,7 +451,7 @@ static void bam_reset_channel(struct bam_chan *bchan)
>>   /**
>>    * bam_chan_init_hw - Initialize channel hardware
>>    * @bchan: bam channel
>> - *
>> + * @dir: DMA transfer direction
> 
> Do you want to add an empty line here?
> 
TBH, Am not 100% sure it it adds any value.

Most of the function docs in the file have this same issue.. :-)

let me know if you still want an empty line, I can respin.

--srini

>>    * This function resets and initializes the BAM channel
Vinod Koul May 17, 2018, 10:55 a.m. UTC | #3
On 17-05-18, 11:53, Srinivas Kandagatla wrote:
> 
> 
> On 17/05/18 11:50, Vinod Koul wrote:
> > On 17-05-18, 10:59, Srinivas Kandagatla wrote:
> > > diff --git a/drivers/dma/qcom/bam_dma.c b/drivers/dma/qcom/bam_dma.c
> > > index 4a828c18099a..a05fff8a1447 100644
> > > --- a/drivers/dma/qcom/bam_dma.c
> > > +++ b/drivers/dma/qcom/bam_dma.c
> > > @@ -451,7 +451,7 @@ static void bam_reset_channel(struct bam_chan *bchan)
> > >   /**
> > >    * bam_chan_init_hw - Initialize channel hardware
> > >    * @bchan: bam channel
> > > - *
> > > + * @dir: DMA transfer direction
> > 
> > Do you want to add an empty line here?
> > 
> TBH, Am not 100% sure it it adds any value.
> 
> Most of the function docs in the file have this same issue.. :-)
> 
> let me know if you still want an empty line, I can respin.

Yeah that's why asked, I can edit while applying so no issues
Srinivas Kandagatla May 17, 2018, 10:56 a.m. UTC | #4
On 17/05/18 11:55, Vinod wrote:
>> let me know if you still want an empty line, I can respin.
> Yeah that's why asked, I can edit while applying so no issues
Thanks, that will work!

--srini
Vinod Koul May 17, 2018, 10:59 a.m. UTC | #5
On 17-05-18, 10:59, Srinivas Kandagatla wrote:
> Building kernel with W=1 throws up below warnings:
> bam_dma.c:459: warning: Function parameter or member 'dir'
> 	not described in 'bam_chan_init_hw'
> bam_dma.c:697: warning: Function parameter or member 'chan'
> 	not described in 'bam_dma_terminate_all'
> bam_dma.c:697: warning: Excess function parameter 'bchan'
> 	description in 'bam_dma_terminate_all'
> bam_dma.c:964: warning: Function parameter or member 'bchan'
> 	not described in 'bam_start_dma'
> 
> Fix these!.

Applied both, thanks
diff mbox

Patch

diff --git a/drivers/dma/qcom/bam_dma.c b/drivers/dma/qcom/bam_dma.c
index 4a828c18099a..a05fff8a1447 100644
--- a/drivers/dma/qcom/bam_dma.c
+++ b/drivers/dma/qcom/bam_dma.c
@@ -451,7 +451,7 @@  static void bam_reset_channel(struct bam_chan *bchan)
 /**
  * bam_chan_init_hw - Initialize channel hardware
  * @bchan: bam channel
- *
+ * @dir: DMA transfer direction
  * This function resets and initializes the BAM channel
  */
 static void bam_chan_init_hw(struct bam_chan *bchan,
@@ -687,7 +687,7 @@  static struct dma_async_tx_descriptor *bam_prep_slave_sg(struct dma_chan *chan,
 
 /**
  * bam_dma_terminate_all - terminate all transactions on a channel
- * @bchan: bam dma channel
+ * @chan: bam dma channel
  *
  * Dequeues and frees all transactions
  * No callbacks are done
@@ -958,7 +958,7 @@  static void bam_apply_new_config(struct bam_chan *bchan,
 
 /**
  * bam_start_dma - start next transaction
- * @bchan - bam dma channel
+ * @bchan: bam dma channel
  */
 static void bam_start_dma(struct bam_chan *bchan)
 {