Subject: Re: [PATCH] iio: adc: stm32-adc: fix kernel-doc warnings

From: Jonathan Cameron <[email-masked]>
Date: Tue, 22 Oct 2019 12:56:01 +0100

On Sat, 21 Sep 2019 19:03:57 +0100
Jonathan Cameron <[email-masked]> wrote:

> On Fri, 20 Sep 2019 13:50:06 +0200
> Fabrice Gasnier <[email-masked]> wrote:
> 
> > Fix the following warnings when documentation is built:
> > drivers/iio/adc/stm32-adc-core.c:62: warning: cannot understand function
> >  prototype: 'struct stm32_adc_common_regs '
> > drivers/iio/adc/stm32-adc-core.c:78: warning: cannot understand function
> >  prototype: 'struct stm32_adc_priv_cfg '
> > drivers/iio/adc/stm32-adc-core.c:123: warning: Function parameter or
> >  member 'pdev' not described in 'stm32f4_adc_clk_sel'
> > drivers/iio/adc/stm32-adc.c:219: warning: cannot understand function
> >  prototype: 'struct stm32_adc_regs '
> > drivers/iio/adc/stm32-adc.c:237: warning: cannot understand function
> >  prototype: 'struct stm32_adc_regspec '
> > drivers/iio/adc/stm32-adc.c:264: warning: cannot understand function
> >  prototype: 'struct stm32_adc_cfg '
> > drivers/iio/adc/stm32-adc.c:323: warning: Function parameter or member
> >  'difsel' not described in 'N'
> > drivers/iio/adc/stm32-adc.c:323: warning: Function parameter or member
> >  'pcsel' not described in 'stm32_adc'
> > drivers/iio/adc/stm32-adc.c:371: warning: cannot understand function
> >  prototype: 'const struct stm32_adc_regs stm32f4_sq[STM32_ADC_MAX_SQ + 1]
> > drivers/iio/adc/stm32-adc.c:417: warning: cannot understand function
> >  prototype: 'const struct stm32_adc_regs stm32f4_smp_bits[] = '
> > drivers/iio/adc/stm32-adc.c:508: warning: cannot understand function
> >  prototype: 'const struct stm32_adc_regs stm32h7_smp_bits[] = '
> > drivers/iio/adc/stm32-adc.c:1112: warning: Function parameter or member
> >  'indio_dev' not described in 'stm32_adc_get_trig_extsel'
> > drivers/iio/adc/stm32-adc.c:1420: warning: Function parameter or member
> >  'indio_dev' not described in 'stm32_adc_debugfs_reg_access'
> > drivers/iio/adc/stm32-adc.c:1420: warning: Function parameter or member
> >  'reg' not described in 'stm32_adc_debugfs_reg_access'
> > drivers/iio/adc/stm32-adc.c:1420: warning: Function parameter or member
> >  'writeval' not described in 'stm32_adc_debugfs_reg_access'
> > drivers/iio/adc/stm32-adc.c:1420: warning: Function parameter or member
> >  'readval' not described in 'stm32_adc_debugfs_reg_access'
> > 
> > Signed-off-by: Fabrice Gasnier <[email-masked]>  
> 
> As I don't think we build these particular docs by default, I'm not going
> to take this as a fix.  Hence it'll have to wait for the below to be
> upstream of my togreg branch.
> 
> Give me a poke if that's true and I seem to have missed it.
Applied to the togreg branch of iio.git and pushed out as testing
for the autobuilders to play with it.

Thanks,

Jonathan

> 
> Thanks,
> 
> Jonathan
> 
> > ---
> > Note: this applies on top of "iio: adc: stm32-adc: fix a race when using
> > several adcs with dma and irq"
> > ---
> >  drivers/iio/adc/stm32-adc-core.c | 11 ++++++-----
> >  drivers/iio/adc/stm32-adc.c      | 21 +++++++++++++--------
> >  2 files changed, 19 insertions(+), 13 deletions(-)
> > 
> > diff --git a/drivers/iio/adc/stm32-adc-core.c b/drivers/iio/adc/stm32-adc-core.c
> > index 93a096a..20c626c 100644
> > --- a/drivers/iio/adc/stm32-adc-core.c
> > +++ b/drivers/iio/adc/stm32-adc-core.c
> > @@ -38,12 +38,12 @@
> >  #define HAS_ANASWVDD		BIT(1)
> >  
> >  /**
> > - * stm32_adc_common_regs - stm32 common registers, compatible dependent data
> > + * struct stm32_adc_common_regs - stm32 common registers
> >   * @csr:	common status register offset
> >   * @ccr:	common control register offset
> > - * @eoc1:	adc1 end of conversion flag in @csr
> > - * @eoc2:	adc2 end of conversion flag in @csr
> > - * @eoc3:	adc3 end of conversion flag in @csr
> > + * @eoc1_msk:	adc1 end of conversion flag in @csr
> > + * @eoc2_msk:	adc2 end of conversion flag in @csr
> > + * @eoc3_msk:	adc3 end of conversion flag in @csr
> >   * @ier:	interrupt enable register offset for each adc
> >   * @eocie_msk:	end of conversion interrupt enable mask in @ier
> >   */
> > @@ -60,7 +60,7 @@ struct stm32_adc_common_regs {
> >  struct stm32_adc_priv;
> >  
> >  /**
> > - * stm32_adc_priv_cfg - stm32 core compatible configuration data
> > + * struct stm32_adc_priv_cfg - stm32 core compatible configuration data
> >   * @regs:	common registers for all instances
> >   * @clk_sel:	clock selection routine
> >   * @max_clk_rate_hz: maximum analog clock rate (Hz, from datasheet)
> > @@ -117,6 +117,7 @@ static int stm32f4_pclk_div[] = {2, 4, 6, 8};
> >  
> >  /**
> >   * stm32f4_adc_clk_sel() - Select stm32f4 ADC common clock prescaler
> > + * @pdev: platform device
> >   * @priv: stm32 ADC core private data
> >   * Select clock prescaler used for analog conversions, before using ADC.
> >   */
> > diff --git a/drivers/iio/adc/stm32-adc.c b/drivers/iio/adc/stm32-adc.c
> > index 663f8a5..76a247b 100644
> > --- a/drivers/iio/adc/stm32-adc.c
> > +++ b/drivers/iio/adc/stm32-adc.c
> > @@ -102,7 +102,7 @@ struct stm32_adc_calib {
> >  };
> >  
> >  /**
> > - * stm32_adc_regs - stm32 ADC misc registers & bitfield desc
> > + * struct stm32_adc_regs - stm32 ADC misc registers & bitfield desc
> >   * @reg:		register offset
> >   * @mask:		bitfield mask
> >   * @shift:		left shift
> > @@ -114,7 +114,7 @@ struct stm32_adc_regs {
> >  };
> >  
> >  /**
> > - * stm32_adc_regspec - stm32 registers definition, compatible dependent data
> > + * struct stm32_adc_regspec - stm32 registers definition
> >   * @dr:			data register offset
> >   * @ier_eoc:		interrupt enable register & eocie bitfield
> >   * @isr_eoc:		interrupt status register & eoc bitfield
> > @@ -140,7 +140,7 @@ struct stm32_adc_regspec {
> >  struct stm32_adc;
> >  
> >  /**
> > - * stm32_adc_cfg - stm32 compatible configuration data
> > + * struct stm32_adc_cfg - stm32 compatible configuration data
> >   * @regs:		registers descriptions
> >   * @adc_info:		per instance input channels definitions
> >   * @trigs:		external trigger sources
> > @@ -183,8 +183,8 @@ struct stm32_adc_cfg {
> >   * @rx_buf:		dma rx buffer cpu address
> >   * @rx_dma_buf:		dma rx buffer bus address
> >   * @rx_buf_sz:		dma rx buffer size
> > - * @difsel		bitmask to set single-ended/differential channel
> > - * @pcsel		bitmask to preselect channels on some devices
> > + * @difsel:		bitmask to set single-ended/differential channel
> > + * @pcsel:		bitmask to preselect channels on some devices
> >   * @smpr_val:		sampling time settings (e.g. smpr1 / smpr2)
> >   * @cal:		optional calibration data on some devices
> >   * @chan_name:		channel name array
> > @@ -254,7 +254,7 @@ static const struct stm32_adc_info stm32h7_adc_info = {
> >  	.num_res = ARRAY_SIZE(stm32h7_adc_resolutions),
> >  };
> >  
> > -/**
> > +/*
> >   * stm32f4_sq - describe regular sequence registers
> >   * - L: sequence len (register & bit field)
> >   * - SQ1..SQ16: sequence entries (register & bit field)
> > @@ -301,7 +301,7 @@ static struct stm32_adc_trig_info stm32f4_adc_trigs[] = {
> >  	{}, /* sentinel */
> >  };
> >  
> > -/**
> > +/*
> >   * stm32f4_smp_bits[] - describe sampling time register index & bit fields
> >   * Sorted so it can be indexed by channel number.
> >   */
> > @@ -392,7 +392,7 @@ static struct stm32_adc_trig_info stm32h7_adc_trigs[] = {
> >  	{},
> >  };
> >  
> > -/**
> > +/*
> >   * stm32h7_smp_bits - describe sampling time register index & bit fields
> >   * Sorted so it can be indexed by channel number.
> >   */
> > @@ -994,6 +994,7 @@ static int stm32_adc_conf_scan_seq(struct iio_dev *indio_dev,
> >  
> >  /**
> >   * stm32_adc_get_trig_extsel() - Get external trigger selection
> > + * @indio_dev: IIO device structure
> >   * @trig: trigger
> >   *
> >   * Returns trigger extsel value, if trig matches, -EINVAL otherwise.
> > @@ -1297,6 +1298,10 @@ static int stm32_adc_of_xlate(struct iio_dev *indio_dev,
> >  
> >  /**
> >   * stm32_adc_debugfs_reg_access - read or write register value
> > + * @indio_dev: IIO device structure
> > + * @reg: register offset
> > + * @writeval: value to write
> > + * @readval: value to read
> >   *
> >   * To read a value from an ADC register:
> >   *   echo [ADC reg offset] > direct_reg_access  
> 

_______________________________________________
linux-arm-kernel mailing list
[email-masked]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel