| Message ID | 2e083c69b1d249fe05badc94250c39db24d523e0.1524247563.git.davidjulianveenstra@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Fri, 20 Apr 2018 21:30:03 +0200 David Veenstra <davidjulianveenstra@gmail.com> wrote: > Add missing kernel docs to the ad2s1200 driver state. > > Signed-off-by: David Veenstra <davidjulianveenstra@gmail.com> > --- > drivers/staging/iio/resolver/ad2s1200.c | 8 ++++++++ > 1 file changed, 8 insertions(+) > > diff --git a/drivers/staging/iio/resolver/ad2s1200.c b/drivers/staging/iio/resolver/ad2s1200.c > index 357fe3c382b3..f07aab7e7a35 100644 > --- a/drivers/staging/iio/resolver/ad2s1200.c > +++ b/drivers/staging/iio/resolver/ad2s1200.c > @@ -33,6 +33,14 @@ > /* clock period in nano second */ > #define AD2S1200_TSCLK (1000000000 / AD2S1200_HZ) > > +/** > + * struct ad2s1200_state - driver instance specific data > + * @lock: protect driver state This doc for locks needs to be more specific. From a quick glance I think it does two things. 1) Ensures that we don't have concurrent accesses changing the gpio control lines. 2) Protects the rx buffer against concurrent accesses. It doesn't have anything much to do with the rest of this state structure. > + * @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; -- To unsubscribe from this list: send the line "unsubscribe linux-iio" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
On 21, April 2018 18:49, Jonathan Cameron wrote: > On Fri, 20 Apr 2018 21:30:03 +0200 > David Veenstra <davidjulianveenstra@gmail.com> wrote: > >> Add missing kernel docs to the ad2s1200 driver state. >> >> Signed-off-by: David Veenstra <davidjulianveenstra@gmail.com> >> --- >> drivers/staging/iio/resolver/ad2s1200.c | 8 ++++++++ >> 1 file changed, 8 insertions(+) >> >> diff --git a/drivers/staging/iio/resolver/ad2s1200.c b/drivers/staging/iio/resolver/ad2s1200.c >> index 357fe3c382b3..f07aab7e7a35 100644 >> --- a/drivers/staging/iio/resolver/ad2s1200.c >> +++ b/drivers/staging/iio/resolver/ad2s1200.c >> @@ -33,6 +33,14 @@ >> /* clock period in nano second */ >> #define AD2S1200_TSCLK (1000000000 / AD2S1200_HZ) >> >> +/** >> + * struct ad2s1200_state - driver instance specific data >> + * @lock: protect driver state > > This doc for locks needs to be more specific. From a quick > glance I think it does two things. > 1) Ensures that we don't have concurrent accesses changing the > gpio control lines. > 2) Protects the rx buffer against concurrent accesses. > > It doesn't have anything much to do with the rest of this state > structure. You're right. The lock is to prevent concurrent spi reads. I'll add additional explanation in v3. Best regards, David Veenstra > >> + * @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; -- To unsubscribe from this list: send the line "unsubscribe linux-iio" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
diff --git a/drivers/staging/iio/resolver/ad2s1200.c b/drivers/staging/iio/resolver/ad2s1200.c index 357fe3c382b3..f07aab7e7a35 100644 --- a/drivers/staging/iio/resolver/ad2s1200.c +++ b/drivers/staging/iio/resolver/ad2s1200.c @@ -33,6 +33,14 @@ /* clock period in nano second */ #define AD2S1200_TSCLK (1000000000 / AD2S1200_HZ) +/** + * struct ad2s1200_state - driver instance specific data + * @lock: protect driver state + * @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;
Add missing kernel docs to the ad2s1200 driver state. Signed-off-by: David Veenstra <davidjulianveenstra@gmail.com> --- drivers/staging/iio/resolver/ad2s1200.c | 8 ++++++++ 1 file changed, 8 insertions(+)