[PATCH 0/8] iio: kernel-doc fixups

[PATCH 0/8] iio: kernel-doc fixups

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

A bunch of totally trivial kernel-doc fixes from W=1 builds.

Note I've not touched staging drivers as those are a good activity for
anyone who wants to get started working with IIO drivers. I'll post
a specific email about that in a few minutes.

Jonathan Cameron (8):
  iio: pressure: zpa2326: kernel-doc fixes
  iio: adc: ti-adc084s021: kernel-doc fixes, missing function names
  iio: dac: ad5770r: kernel-doc fix case of letter R wrong in structure
    name
  iio: dac: ad5504: fix wrong part number in kernel-doc structure name.
  iio: adc: cpcap-adc: kernel-doc fix - that should be _ in structure
    name
  iio: adc: adi-axi-adc: Drop false marking for kernel-doc
  iio: accel: sca3000: kernel-doc fixes. Missing - and wrong function
    names.
  iio: buffer: kfifo_buf: kernel-doc, typo in function name.

 drivers/iio/accel/sca3000.c     | 8 ++++----
 drivers/iio/adc/adi-axi-adc.c   | 2 +-
 drivers/iio/adc/cpcap-adc.c     | 2 +-
 drivers/iio/adc/ti-adc084s021.c | 4 ++--
 drivers/iio/buffer/kfifo_buf.c  | 2 +-
 drivers/iio/dac/ad5504.c        | 2 +-
 drivers/iio/dac/ad5770r.c       | 2 +-
 drivers/iio/pressure/zpa2326.c  | 4 ++--
 8 files changed, 13 insertions(+), 13 deletions(-)

-- 
2.30.2

[PATCH 1/8] iio: pressure: zpa2326: kernel-doc fixes

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Two comment blocks had wrong naming for function/structures that they
referred to.  Results in warnings when doing a W=1 build.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
---
 drivers/iio/pressure/zpa2326.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/iio/pressure/zpa2326.c b/drivers/iio/pressure/zpa2326.c
index 70adff62cd20..a93411216aee 100644
--- a/drivers/iio/pressure/zpa2326.c
+++ b/drivers/iio/pressure/zpa2326.c
@@ -103,7 +103,7 @@ static const struct zpa2326_frequency *zpa2326_highest_frequency(void)
 }
 
 /**
- * struct zpa_private - Per-device internal private state
+ * struct zpa2326_private - Per-device internal private state
  * @timestamp:  Buffered samples ready datum.
  * @regmap:     Underlying I2C / SPI bus adapter used to abstract slave register
  *              accesses.
@@ -1382,7 +1382,7 @@ static const struct iio_trigger_ops zpa2326_trigger_ops = {
 };
 
 /**
- * zpa2326_init_trigger() - Create an interrupt driven / hardware trigger
+ * zpa2326_init_managed_trigger() - Create interrupt driven / hardware trigger
  *                          allowing to notify external devices a new sample is
  *                          ready.
  * @parent:    Hardware sampling device @indio_dev is a child of.
-- 
2.30.2

Re: [PATCH 1/8] iio: pressure: zpa2326: kernel-doc fixes

[Alexandru Ardelean]

On Sun, Mar 14, 2021 at 6:53 PM Jonathan Cameron <jic23@kernel.org> wrote:
>
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> Two comment blocks had wrong naming for function/structures that they
> referred to.  Results in warnings when doing a W=1 build.
>

Reviewed-by: Alexandru Ardelean <ardeleanalex@gmail.com>

> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> ---
>  drivers/iio/pressure/zpa2326.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/iio/pressure/zpa2326.c b/drivers/iio/pressure/zpa2326.c
> index 70adff62cd20..a93411216aee 100644
> --- a/drivers/iio/pressure/zpa2326.c
> +++ b/drivers/iio/pressure/zpa2326.c
> @@ -103,7 +103,7 @@ static const struct zpa2326_frequency *zpa2326_highest_frequency(void)
>  }
>
>  /**
> - * struct zpa_private - Per-device internal private state
> + * struct zpa2326_private - Per-device internal private state
>   * @timestamp:  Buffered samples ready datum.
>   * @regmap:     Underlying I2C / SPI bus adapter used to abstract slave register
>   *              accesses.
> @@ -1382,7 +1382,7 @@ static const struct iio_trigger_ops zpa2326_trigger_ops = {
>  };
>
>  /**
> - * zpa2326_init_trigger() - Create an interrupt driven / hardware trigger
> + * zpa2326_init_managed_trigger() - Create interrupt driven / hardware trigger
>   *                          allowing to notify external devices a new sample is
>   *                          ready.
>   * @parent:    Hardware sampling device @indio_dev is a child of.
> --
> 2.30.2
>

[PATCH 2/8] iio: adc: ti-adc084s021: kernel-doc fixes, missing function names

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

The documentation in this driver was nearly kernel-doc and was marked
as such. Unfortunately the format was wrong and function names were
missing. This patch puts them in with minor edits to keep the resulting
line short.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Gwendal Grignou <gwendal@chromium.org>
Cc: Mårten Lindahl <martenli@axis.com>
---
 drivers/iio/adc/ti-adc084s021.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/iio/adc/ti-adc084s021.c b/drivers/iio/adc/ti-adc084s021.c
index d6e1bf3de755..33aea961d850 100644
--- a/drivers/iio/adc/ti-adc084s021.c
+++ b/drivers/iio/adc/ti-adc084s021.c
@@ -65,7 +65,7 @@ static const struct iio_chan_spec adc084s021_channels[] = {
 };
 
 /**
- * Read an ADC channel and return its value.
+ * adc084s021_adc_conversion() - Read an ADC channel and return its value.
  *
  * @adc: The ADC SPI data.
  * @data: Buffer for converted data.
@@ -136,7 +136,7 @@ static int adc084s021_read_raw(struct iio_dev *indio_dev,
 }
 
 /**
- * Read enabled ADC channels and push data to the buffer.
+ * adc084s021_buffer_trigger_handler() - Read ADC channels and push to buffer.
  *
  * @irq: The interrupt number (not used).
  * @pollfunc: Pointer to the poll func.
-- 
2.30.2

[PATCH 3/8] iio: dac: ad5770r: kernel-doc fix case of letter R wrong in structure name

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Nothing useful to add beyond this causing a warning with W=1

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
---
 drivers/iio/dac/ad5770r.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/iio/dac/ad5770r.c b/drivers/iio/dac/ad5770r.c
index 84dcf149261f..4e7a8ed83cc1 100644
--- a/drivers/iio/dac/ad5770r.c
+++ b/drivers/iio/dac/ad5770r.c
@@ -118,7 +118,7 @@ struct ad5770r_out_range {
 };
 
 /**
- * struct ad5770R_state - driver instance specific data
+ * struct ad5770r_state - driver instance specific data
  * @spi:		spi_device
  * @regmap:		regmap
  * @vref_reg:		fixed regulator for reference configuration
-- 
2.30.2

Re: [PATCH 3/8] iio: dac: ad5770r: kernel-doc fix case of letter R wrong in structure name

[Alexandru Ardelean]

On Sun, Mar 14, 2021 at 6:49 PM Jonathan Cameron <jic23@kernel.org> wrote:
>
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> Nothing useful to add beyond this causing a warning with W=1
>

Acked-by: Alexandru Ardelean <ardeleanalex@gmail.com>

> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
> ---
>  drivers/iio/dac/ad5770r.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/iio/dac/ad5770r.c b/drivers/iio/dac/ad5770r.c
> index 84dcf149261f..4e7a8ed83cc1 100644
> --- a/drivers/iio/dac/ad5770r.c
> +++ b/drivers/iio/dac/ad5770r.c
> @@ -118,7 +118,7 @@ struct ad5770r_out_range {
>  };
>
>  /**
> - * struct ad5770R_state - driver instance specific data
> + * struct ad5770r_state - driver instance specific data
>   * @spi:               spi_device
>   * @regmap:            regmap
>   * @vref_reg:          fixed regulator for reference configuration
> --
> 2.30.2
>

[PATCH 4/8] iio: dac: ad5504: fix wrong part number in kernel-doc structure name.

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Probably a bit of cut and paste where someone forgot to change the
part number.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Lars-Peter Clausen <lars@metafoo.de>
---
 drivers/iio/dac/ad5504.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/iio/dac/ad5504.c b/drivers/iio/dac/ad5504.c
index e9297c25d4ef..f383bdcdc121 100644
--- a/drivers/iio/dac/ad5504.c
+++ b/drivers/iio/dac/ad5504.c
@@ -39,7 +39,7 @@
 #define AD5504_DAC_PWRDN_3STATE		1
 
 /**
- * struct ad5446_state - driver instance specific data
+ * struct ad5504_state - driver instance specific data
  * @spi:			spi_device
  * @reg:		supply regulator
  * @vref_mv:		actual reference voltage used
-- 
2.30.2

[PATCH 5/8] iio: adc: cpcap-adc: kernel-doc fix - that should be _ in structure name

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Fixes a W=1 warning.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Tony Lindgren <tony@atomide.com>
---
 drivers/iio/adc/cpcap-adc.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/iio/adc/cpcap-adc.c b/drivers/iio/adc/cpcap-adc.c
index f19c9aa93f17..40e59f4c95bc 100644
--- a/drivers/iio/adc/cpcap-adc.c
+++ b/drivers/iio/adc/cpcap-adc.c
@@ -100,7 +100,7 @@ struct cpcap_adc_ato {
 };
 
 /**
- * struct cpcap-adc - cpcap adc device driver data
+ * struct cpcap_adc - cpcap adc device driver data
  * @reg: cpcap regmap
  * @dev: struct device
  * @vendor: cpcap vendor
-- 
2.30.2

Re: [PATCH 5/8] iio: adc: cpcap-adc: kernel-doc fix - that should be _ in structure name

[Tony Lindgren]

* Jonathan Cameron <jic23@kernel.org> [210314 16:50]:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> Fixes a W=1 warning.

Reviewed-by: Tony Lindgren <tony@atomide.com>

Thanks,

Tony

[PATCH 6/8] iio: adc: adi-axi-adc: Drop false marking for kernel-doc

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

This comment block isn't in kernel-doc format so drop the /** marking.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Nuno Sá <nuno.sa@analog.com>
---
 drivers/iio/adc/adi-axi-adc.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/iio/adc/adi-axi-adc.c b/drivers/iio/adc/adi-axi-adc.c
index 2e84623f732e..d5f6ffc5b5bc 100644
--- a/drivers/iio/adc/adi-axi-adc.c
+++ b/drivers/iio/adc/adi-axi-adc.c
@@ -23,7 +23,7 @@
 #include <linux/fpga/adi-axi-common.h>
 #include <linux/iio/adc/adi-axi-adc.h>
 
-/**
+/*
  * Register definitions:
  *   https://wiki.analog.com/resources/fpga/docs/axi_adc_ip#register_map
  */
-- 
2.30.2

Re: [PATCH 6/8] iio: adc: adi-axi-adc: Drop false marking for kernel-doc

[Alexandru Ardelean]

On Sun, Mar 14, 2021 at 6:54 PM Jonathan Cameron <jic23@kernel.org> wrote:
>
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> This comment block isn't in kernel-doc format so drop the /** marking.
>

Reviewed-by: Alexandru Ardelean <ardeleanalex@gmail.com>

> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Nuno Sá <nuno.sa@analog.com>
> ---
>  drivers/iio/adc/adi-axi-adc.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/iio/adc/adi-axi-adc.c b/drivers/iio/adc/adi-axi-adc.c
> index 2e84623f732e..d5f6ffc5b5bc 100644
> --- a/drivers/iio/adc/adi-axi-adc.c
> +++ b/drivers/iio/adc/adi-axi-adc.c
> @@ -23,7 +23,7 @@
>  #include <linux/fpga/adi-axi-common.h>
>  #include <linux/iio/adc/adi-axi-adc.h>
>
> -/**
> +/*
>   * Register definitions:
>   *   https://wiki.analog.com/resources/fpga/docs/axi_adc_ip#register_map
>   */
> --
> 2.30.2
>

[PATCH 7/8] iio: accel: sca3000: kernel-doc fixes. Missing - and wrong function names.

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

All extremely obvious so nothing to add to patch title.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
---
 drivers/iio/accel/sca3000.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/iio/accel/sca3000.c b/drivers/iio/accel/sca3000.c
index 467b5fcb81db..cb753a43533c 100644
--- a/drivers/iio/accel/sca3000.c
+++ b/drivers/iio/accel/sca3000.c
@@ -351,7 +351,7 @@ static int __sca3000_unlock_reg_lock(struct sca3000_state *st)
 }
 
 /**
- * sca3000_write_ctrl_reg() write to a lock protect ctrl register
+ * sca3000_write_ctrl_reg() - write to a lock protect ctrl register
  * @st: Driver specific device instance data.
  * @sel: selects which registers we wish to write to
  * @val: the value to be written
@@ -389,7 +389,7 @@ static int sca3000_write_ctrl_reg(struct sca3000_state *st,
 }
 
 /**
- * sca3000_read_ctrl_reg() read from lock protected control register.
+ * sca3000_read_ctrl_reg() - read from lock protected control register.
  * @st: Driver specific device instance data.
  * @ctrl_reg: Which ctrl register do we want to read.
  *
@@ -421,7 +421,7 @@ static int sca3000_read_ctrl_reg(struct sca3000_state *st,
 }
 
 /**
- * sca3000_show_rev() - sysfs interface to read the chip revision number
+ * sca3000_print_rev() - sysfs interface to read the chip revision number
  * @indio_dev: Device instance specific generic IIO data.
  * Driver specific device instance data can be obtained via
  * via iio_priv(indio_dev)
@@ -902,7 +902,7 @@ static int sca3000_read_event_value(struct iio_dev *indio_dev,
 }
 
 /**
- * sca3000_write_value() - control of threshold and period
+ * sca3000_write_event_value() - control of threshold and period
  * @indio_dev: Device instance specific IIO information.
  * @chan: Description of the channel for which the event is being
  * configured.
-- 
2.30.2

Re: [PATCH 7/8] iio: accel: sca3000: kernel-doc fixes. Missing - and wrong function names.

[Alexandru Ardelean]

On Sun, Mar 14, 2021 at 6:54 PM Jonathan Cameron <jic23@kernel.org> wrote:
>
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> All extremely obvious so nothing to add to patch title.
>

Reviewed-by: Alexandru Ardelean <ardeleanalex@gmail.com>

> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> ---
>  drivers/iio/accel/sca3000.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/iio/accel/sca3000.c b/drivers/iio/accel/sca3000.c
> index 467b5fcb81db..cb753a43533c 100644
> --- a/drivers/iio/accel/sca3000.c
> +++ b/drivers/iio/accel/sca3000.c
> @@ -351,7 +351,7 @@ static int __sca3000_unlock_reg_lock(struct sca3000_state *st)
>  }
>
>  /**
> - * sca3000_write_ctrl_reg() write to a lock protect ctrl register
> + * sca3000_write_ctrl_reg() - write to a lock protect ctrl register
>   * @st: Driver specific device instance data.
>   * @sel: selects which registers we wish to write to
>   * @val: the value to be written
> @@ -389,7 +389,7 @@ static int sca3000_write_ctrl_reg(struct sca3000_state *st,
>  }
>
>  /**
> - * sca3000_read_ctrl_reg() read from lock protected control register.
> + * sca3000_read_ctrl_reg() - read from lock protected control register.
>   * @st: Driver specific device instance data.
>   * @ctrl_reg: Which ctrl register do we want to read.
>   *
> @@ -421,7 +421,7 @@ static int sca3000_read_ctrl_reg(struct sca3000_state *st,
>  }
>
>  /**
> - * sca3000_show_rev() - sysfs interface to read the chip revision number
> + * sca3000_print_rev() - sysfs interface to read the chip revision number
>   * @indio_dev: Device instance specific generic IIO data.
>   * Driver specific device instance data can be obtained via
>   * via iio_priv(indio_dev)
> @@ -902,7 +902,7 @@ static int sca3000_read_event_value(struct iio_dev *indio_dev,
>  }
>
>  /**
> - * sca3000_write_value() - control of threshold and period
> + * sca3000_write_event_value() - control of threshold and period
>   * @indio_dev: Device instance specific IIO information.
>   * @chan: Description of the channel for which the event is being
>   * configured.
> --
> 2.30.2
>

[PATCH 8/8] iio: buffer: kfifo_buf: kernel-doc, typo in function name.

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Should have been _kfifo_ and was _fifo_

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
---
 drivers/iio/buffer/kfifo_buf.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/iio/buffer/kfifo_buf.c b/drivers/iio/buffer/kfifo_buf.c
index 4ecfa0ec3016..d72cfb354be6 100644
--- a/drivers/iio/buffer/kfifo_buf.c
+++ b/drivers/iio/buffer/kfifo_buf.c
@@ -180,7 +180,7 @@ static void devm_iio_kfifo_release(struct device *dev, void *res)
 }
 
 /**
- * devm_iio_fifo_allocate - Resource-managed iio_kfifo_allocate()
+ * devm_iio_kfifo_allocate - Resource-managed iio_kfifo_allocate()
  * @dev:		Device to allocate kfifo buffer for
  *
  * RETURNS:
-- 
2.30.2

Re: [PATCH 8/8] iio: buffer: kfifo_buf: kernel-doc, typo in function name.

[Alexandru Ardelean]

On Sun, Mar 14, 2021 at 6:49 PM Jonathan Cameron <jic23@kernel.org> wrote:
>
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> Should have been _kfifo_ and was _fifo_

oops

Acked-by: Alexandru Ardelean <ardeleanalex@gmail.com>

>
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
> ---
>  drivers/iio/buffer/kfifo_buf.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/iio/buffer/kfifo_buf.c b/drivers/iio/buffer/kfifo_buf.c
> index 4ecfa0ec3016..d72cfb354be6 100644
> --- a/drivers/iio/buffer/kfifo_buf.c
> +++ b/drivers/iio/buffer/kfifo_buf.c
> @@ -180,7 +180,7 @@ static void devm_iio_kfifo_release(struct device *dev, void *res)
>  }
>
>  /**
> - * devm_iio_fifo_allocate - Resource-managed iio_kfifo_allocate()
> + * devm_iio_kfifo_allocate - Resource-managed iio_kfifo_allocate()
>   * @dev:               Device to allocate kfifo buffer for
>   *
>   * RETURNS:
> --
> 2.30.2
>

Re: [PATCH 0/8] iio: kernel-doc fixups

[Lars-Peter Clausen]

On 3/14/21 5:46 PM, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> A bunch of totally trivial kernel-doc fixes from W=1 builds.
>
> Note I've not touched staging drivers as those are a good activity for
> anyone who wants to get started working with IIO drivers. I'll post
> a specific email about that in a few minutes.

All obviously correct.

Reviewed-by: Lars-Peter Clausen <lars@metafoo.de>

Re: [PATCH 0/8] iio: kernel-doc fixups

[Jonathan Cameron]

On Sun, 14 Mar 2021 18:32:17 +0100
Lars-Peter Clausen <lars@metafoo.de> wrote:

> On 3/14/21 5:46 PM, Jonathan Cameron wrote:
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> >
> > A bunch of totally trivial kernel-doc fixes from W=1 builds.
> >
> > Note I've not touched staging drivers as those are a good activity for
> > anyone who wants to get started working with IIO drivers. I'll post
> > a specific email about that in a few minutes.  
> 
> All obviously correct.
> 
> Reviewed-by: Lars-Peter Clausen <lars@metafoo.de>
Thanks,

Series applied to the togreg branch of iio.git and pushed out as testing
for all the normal reasons.

Transitioning to a new laptop, so if anything looks odd let me know.

Jonathan