]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/commitdiff
staging: iio: ad2s1200: Add kernel docs to driver state
authorDavid Veenstra <davidjulianveenstra@gmail.com>
Fri, 18 May 2018 18:21:34 +0000 (20:21 +0200)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sun, 20 May 2018 10:53:45 +0000 (11:53 +0100)
Add missing kernel docs to the ad2s1200 driver state.

Signed-off-by: David Veenstra <davidjulianveenstra@gmail.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
drivers/staging/iio/resolver/ad2s1200.c

index 9bdcf0c862179ebebacfb76b241ab99d13fbcb16..068aa86e9c11507a3e59a8b8aa1d5bf6bd742140 100644 (file)
 /* 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.
+ * @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;