| Message ID | 20200225103319.20751-1-alexandru.ardelean@analog.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2,1/3] iio: imu: adis: add doc-string for 'adis' struct | expand |
On Tue, 25 Feb 2020 12:33:17 +0200 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> Applied to the togreg branch of iio.git and pushed out as testing for the autobuilders to poke at it. Thanks, Jonathan > --- > > Changelog v1 -> v2: > * changed tx/rx descriptions to > ``` > @tx: DMA safe TX buffer for SPI transfers > @rx: DMA safe RX buffer for SPI transfers > ``` > > 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 ac7cfd073804..63e456aa5c8a 100644 > --- a/include/linux/iio/imu/adis.h > +++ b/include/linux/iio/imu/adis.h > @@ -73,6 +73,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: DMA safe TX buffer for SPI transfers > + * @rx: DMA safe RX buffer for SPI transfers > + */ > struct adis { > struct spi_device *spi; > struct iio_trigger *trig;
diff --git a/include/linux/iio/imu/adis.h b/include/linux/iio/imu/adis.h index ac7cfd073804..63e456aa5c8a 100644 --- a/include/linux/iio/imu/adis.h +++ b/include/linux/iio/imu/adis.h @@ -73,6 +73,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: DMA safe TX buffer for SPI transfers + * @rx: DMA safe RX buffer for SPI transfers + */ struct adis { struct spi_device *spi; struct iio_trigger *trig;
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> --- Changelog v1 -> v2: * changed tx/rx descriptions to ``` @tx: DMA safe TX buffer for SPI transfers @rx: DMA safe RX buffer for SPI transfers ``` include/linux/iio/imu/adis.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+)