Linux IIO development
 help / color / mirror / Atom feed
From: Rodrigo Alencar via B4 Relay <devnull+rodrigo.alencar.analog.com@kernel.org>
To: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
	 Stefan Popa <stefan.popa@analog.com>,
	Jonathan Cameron <jic23@cam.ac.uk>,
	 Greg Kroah-Hartman <gregkh@suse.de>,
	 Michael Auchter <michael.auchter@ni.com>,
	 Jonathan Cameron <jic23@kernel.org>
Cc: Lars-Peter Clausen <lars@metafoo.de>,
	 Michael Hennerich <Michael.Hennerich@analog.com>,
	 Jonathan Cameron <jic23@kernel.org>,
	David Lechner <dlechner@baylibre.com>,
	 Andy Shevchenko <andy@kernel.org>,
	 Rodrigo Alencar <rodrigo.alencar@analog.com>,
	 Andy Shevchenko <andriy.shevchenko@intel.com>
Subject: [PATCH v5 11/12] iio: dac: ad5686: cleanup doc header of local structs
Date: Fri, 01 May 2026 10:15:04 +0100	[thread overview]
Message-ID: <20260501-ad5686-fixes-v5-11-0b2f45488418@analog.com> (raw)
In-Reply-To: <20260501-ad5686-fixes-v5-0-0b2f45488418@analog.com>

From: Rodrigo Alencar <rodrigo.alencar@analog.com>

Review documentation comment header for ad5686_chip_info and ad5686_state.
Update variable names and description and remove unnecessary blank line
between comment and struct declaration.

Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
Signed-off-by: Rodrigo Alencar <rodrigo.alencar@analog.com>
---
 drivers/iio/dac/ad5686.h | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/drivers/iio/dac/ad5686.h b/drivers/iio/dac/ad5686.h
index dc1961b8c15e..4c38dd43d4bb 100644
--- a/drivers/iio/dac/ad5686.h
+++ b/drivers/iio/dac/ad5686.h
@@ -71,12 +71,11 @@ typedef int (*ad5686_read_func)(struct ad5686_state *st, u8 addr);
 
 /**
  * struct ad5686_chip_info - chip specific information
- * @int_vref_mv:	AD5620/40/60: the internal reference voltage
+ * @int_vref_mv:	the internal reference voltage
  * @num_channels:	number of channels
  * @channel:		channel specification
  * @regmap_type:	register map layout variant
  */
-
 struct ad5686_chip_info {
 	u16				int_vref_mv;
 	unsigned int			num_channels;
@@ -114,16 +113,16 @@ extern const struct ad5686_chip_info ad5679r_chip_info;
 
 /**
  * struct ad5686_state - driver instance specific data
- * @spi:		spi_device
+ * @dev:		device instance
  * @chip_info:		chip model specific constants, available modes etc
  * @vref_mv:		actual reference voltage used
  * @pwr_down_mask:	power down mask
  * @pwr_down_mode:	current power down mode
  * @use_internal_vref:	set to true if the internal reference voltage is used
- * @lock		lock to protect the data buffer during regmap ops
- * @data:		spi transfer buffers
+ * @lock:		lock to protect access to state fields, which includes
+ *			the data buffer during regmap ops
+ * @data:		transfer buffers
  */
-
 struct ad5686_state {
 	struct device			*dev;
 	const struct ad5686_chip_info	*chip_info;

-- 
2.43.0



  parent reply	other threads:[~2026-05-01  9:15 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-01  9:14 [PATCH v5 00/12] Fixes and cleanups for the AD5686 IIO driver Rodrigo Alencar via B4 Relay
2026-05-01  9:14 ` [PATCH v5 01/12] iio: dac: ad5686: fix ref bit initialization for single-channel parts Rodrigo Alencar via B4 Relay
2026-05-05 11:06   ` Jonathan Cameron
2026-05-01  9:14 ` [PATCH v5 02/12] iio: dac: ad5686: fix input raw value check Rodrigo Alencar via B4 Relay
2026-05-05 11:08   ` Jonathan Cameron
2026-05-01  9:14 ` [PATCH v5 03/12] iio: dac: ad5686: acquire lock when doing powerdown control Rodrigo Alencar via B4 Relay
2026-05-05 11:05   ` Jonathan Cameron
2026-05-05 11:16     ` Rodrigo Alencar
2026-05-05 12:09       ` Jonathan Cameron
2026-05-01  9:14 ` [PATCH v5 04/12] iio: dac: ad5686: fix powerdown control on dual-channel devices Rodrigo Alencar via B4 Relay
2026-05-05 11:16   ` Jonathan Cameron
2026-05-01  9:14 ` [PATCH v5 05/12] iio: dac: ad5686: refactor include headers Rodrigo Alencar via B4 Relay
2026-05-01  9:14 ` [PATCH v5 06/12] iio: dac: ad5686: remove redundant register definition Rodrigo Alencar via B4 Relay
2026-05-01  9:15 ` [PATCH v5 07/12] iio: dac: ad5686: drop enum id Rodrigo Alencar via B4 Relay
2026-05-01  9:15 ` [PATCH v5 08/12] iio: dac: ad5686: add of_match table to the spi driver Rodrigo Alencar via B4 Relay
2026-05-01  9:15 ` [PATCH v5 09/12] iio: dac: ad5686: add helpers to handle powerdown masks Rodrigo Alencar via B4 Relay
2026-05-04  8:25   ` Andy Shevchenko
2026-05-01  9:15 ` [PATCH v5 10/12] iio: dac: ad5686: add control_sync() for single-channel devices Rodrigo Alencar via B4 Relay
2026-05-04  8:29   ` Andy Shevchenko
2026-05-01  9:15 ` Rodrigo Alencar via B4 Relay [this message]
2026-05-01  9:15 ` [PATCH v5 12/12] iio: dac: ad5686: create bus ops struct Rodrigo Alencar via B4 Relay
2026-05-05 12:06   ` Jonathan Cameron

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260501-ad5686-fixes-v5-11-0b2f45488418@analog.com \
    --to=devnull+rodrigo.alencar.analog.com@kernel.org \
    --cc=Michael.Hennerich@analog.com \
    --cc=andriy.shevchenko@intel.com \
    --cc=andy@kernel.org \
    --cc=dlechner@baylibre.com \
    --cc=gregkh@suse.de \
    --cc=jic23@cam.ac.uk \
    --cc=jic23@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=michael.auchter@ni.com \
    --cc=rodrigo.alencar@analog.com \
    --cc=stefan.popa@analog.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox