devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: David Veenstra <davidjulianveenstra@gmail.com>
To: jic23@kernel.org, lars@metafoo.de, pmeerw@pmeerw.net, robh+dt@kernel.org
Cc: linux-iio@vger.kernel.org, devel@driverdev.osuosl.org,
	devicetree@vger.kernel.org, Michael.Hennerich@analog.com,
	knaack.h@gmx.de
Subject: [PATCH v4 03/12] staging: iio: ad2s1200: Add kernel docs to driver state
Date: Fri, 18 May 2018 20:21:34 +0200	[thread overview]
Message-ID: <38a9e24e5cdbc98afbf4d06f9848c55c26ce37ff.1526667118.git.davidjulianveenstra@gmail.com> (raw)
In-Reply-To: <cover.1526667118.git.davidjulianveenstra@gmail.com>

Add missing kernel docs to the ad2s1200 driver state.

Signed-off-by: David Veenstra <davidjulianveenstra@gmail.com>
---
Changes in v4:
 - Simplified explanation of lock.

 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 9bdcf0c86217..068aa86e9c11 100644
--- a/drivers/staging/iio/resolver/ad2s1200.c
+++ b/drivers/staging/iio/resolver/ad2s1200.c
@@ -32,6 +32,14 @@
 /* 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;
-- 
2.17.0

  parent reply	other threads:[~2018-05-18 18:21 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-18 18:20 [PATCH v4 00/12] iio: ad2s1200: Driver clean up David Veenstra
2018-05-18 18:21 ` [PATCH v4 01/12] staging: iio: ad2s1200: Remove unneeded newline in license David Veenstra
2018-05-20 10:52   ` Jonathan Cameron
2018-05-18 18:21 ` [PATCH v4 02/12] staging: iio: ad2s1200: Remove unneeded initializations David Veenstra
2018-05-20 10:53   ` Jonathan Cameron
2018-05-18 18:21 ` David Veenstra [this message]
2018-05-20 10:53   ` [PATCH v4 03/12] staging: iio: ad2s1200: Add kernel docs to driver state Jonathan Cameron
2018-05-18 18:21 ` [PATCH v4 04/12] staging: iio: ad2s1200: Setup spi before iio device register David Veenstra
2018-05-20 10:55   ` Jonathan Cameron
2018-05-18 18:21 ` [PATCH v4 05/12] staging: iio: ad2s1200: Replace legacy gpio API with modern API David Veenstra
2018-05-20 11:04   ` Jonathan Cameron
2018-05-18 18:22 ` [PATCH v4 06/12] staging: iio: ad2s1200: Replace platform data with dt bindings David Veenstra
2018-05-20 11:01   ` Jonathan Cameron
2018-05-18 18:22 ` [PATCH v4 07/12] staging: iio: ad2s1200: Add dt table David Veenstra
2018-05-20 11:02   ` Jonathan Cameron
2018-05-18 18:22 ` [PATCH v4 08/12] dt-bindings: iio: resolver: Document AD2S1200 bindings David Veenstra
2018-05-20 11:05   ` Jonathan Cameron
2018-05-18 18:23 ` [PATCH v4 09/12] staging: iio: ad2s1200: Add scaling factor for angular velocity channel David Veenstra
2018-05-20 11:09   ` Jonathan Cameron
2018-05-18 18:23 ` [PATCH v4 10/12] staging: iio: ad2s1200: Add scaling factor for angle channel David Veenstra
2018-05-20 11:10   ` Jonathan Cameron
2018-05-18 18:23 ` [PATCH v4 11/12] staging: iio: ad2s1200: Add copyright David Veenstra
2018-05-20 11:11   ` Jonathan Cameron
2018-05-18 18:23 ` [PATCH v4 12/12] staging: iio: ad2s1200: Move driver out of staging David Veenstra
2018-05-20 11:17   ` Jonathan Cameron

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=38a9e24e5cdbc98afbf4d06f9848c55c26ce37ff.1526667118.git.davidjulianveenstra@gmail.com \
    --to=davidjulianveenstra@gmail.com \
    --cc=Michael.Hennerich@analog.com \
    --cc=devel@driverdev.osuosl.org \
    --cc=devicetree@vger.kernel.org \
    --cc=jic23@kernel.org \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=pmeerw@pmeerw.net \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).