From mboxrd@z Thu Jan 1 00:00:00 1970 From: David Julian Veenstra Subject: Re: [PATCH v2 05/13] staging: iio: ad2s1200: Add kernel docs to driver state Date: Sun, 22 Apr 2018 16:26:39 +0200 Message-ID: <87po2rmi5c.fsf@gmail.com> References: <2e083c69b1d249fe05badc94250c39db24d523e0.1524247563.git.davidjulianveenstra@gmail.com> <20180421174952.1e3b5ee0@archlinux> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: In-reply-to: <20180421174952.1e3b5ee0@archlinux> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: driverdev-devel-bounces@linuxdriverproject.org Sender: "devel" To: Jonathan Cameron Cc: devel@driverdev.osuosl.org, devicetree@vger.kernel.org, lars@metafoo.de, Michael.Hennerich@analog.com, linux-iio@vger.kernel.org, robh+dt@kernel.org, pmeerw@pmeerw.net, knaack.h@gmx.de, daniel.baluta@nxp.com List-Id: devicetree@vger.kernel.org On 21, April 2018 18:49, Jonathan Cameron wrote: > On Fri, 20 Apr 2018 21:30:03 +0200 > David Veenstra wrote: > >> Add missing kernel docs to the ad2s1200 driver state. >> >> Signed-off-by: David Veenstra >> --- >> 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;