Add missing kernel docs to the ad2s1200 driver state.
Signed-off-by: David Veenstra <davidjulianveenstra@xxxxxxxxx>
---
Changes in v3:
- Added more explanation to mutex lock.
drivers/staging/iio/resolver/ad2s1200.c | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/drivers/staging/iio/resolver/ad2s1200.c b/drivers/staging/iio/resolver/ad2s1200.c
index 357fe3c382b3..17d65cb437fd 100644
--- a/drivers/staging/iio/resolver/ad2s1200.c
+++ b/drivers/staging/iio/resolver/ad2s1200.c
@@ -33,6 +33,15 @@
/* clock period in nano second */
#define AD2S1200_TSCLK (1000000000 / AD2S1200_HZ)
+/**
+ * struct ad2s1200_state - driver instance specific data.
+ * @lock: protects both the GPIO pins and the rx buffer, to prevent
+ * concurrent spi transactions.
+ * @sdev: spi device.
+ * @sample: GPIO pin SAMPLE.
+ * @rdvel: GPIO pin RDVEL.
+ * @rx: buffer for spi transfers.
+ */
struct ad2s1200_state {
struct mutex lock;
struct spi_device *sdev;
--
2.16.2
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
