Re: [PATCH 1/3] iio: imu: adis: add doc-string for `adis` struct

[Jonathan Cameron <jic23@kernel.org>]

On Tue, 8 Oct 2019 11:02:37 +0300
Alexandru Ardelean <alexandru.ardelean@analog.com> wrote:

> This change adds a doc-string for the `adis` struct. It details the fields
> and their roles.
> 
> Signed-off-by: Alexandru Ardelean <alexandru.ardelean@analog.com>
> ---
>  include/linux/iio/imu/adis.h | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/include/linux/iio/imu/adis.h b/include/linux/iio/imu/adis.h
> index 48444f28b003..dbdf421d35dd 100644
> --- a/include/linux/iio/imu/adis.h
> +++ b/include/linux/iio/imu/adis.h
> @@ -54,6 +54,20 @@ struct adis_data {
>  	bool has_paging;
>  };
>  
> +/**
> + * struct adis - ADIS device instance data
> + * @spi: Reference to SPI device which owns this ADIS IIO device
> + * @trig: IIO trigger object data
> + * @data: ADIS chip variant specific data
> + * @burst: ADIS burst transfer information
> + * @state_lock: Lock used by the device to protect state
> + * @msg: SPI message object
> + * @xfer: SPI transfer objects to be used for a @msg
> + * @current_page: Some ADIS devices have registers, this selects current page
> + * @buffer: Data buffer for information read from the device
> + * @tx: Cacheline aligned TX buffer for SPI transfers
> + * @rx: Cacheline aligned RX buffer for SPI transfers
That one is ever so slightly untrue.  It's in the same cacheline as the
tx and so safe (device transfers can only cause trouble for themselves).

I'll tweak to just...
	RX buffer for SPI transfers. May share cacheline with tx.

Hope you don't mind as don't want to waste your time on a v2 for just that.

Applied to the togreg branch of iio.git and pushed out as testing for the
autobuilders to play with it.

Thanks,

Jonathan


> + */
>  struct adis {
>  	struct spi_device	*spi;
>  	struct iio_trigger	*trig;