linux-iio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Crt Mori <cmo@melexis.com>
To: Jonathan Cameron <jic23@kernel.org>
Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
	Andy Shevchenko <andy.shevchenko@gmail.com>,
	Crt Mori <cmo@melexis.com>
Subject: [PATCH v4 3/4] iio:temperature:mlx90632: Add kerneldoc to the internal struct
Date: Sat,  8 Aug 2020 14:10:25 +0200	[thread overview]
Message-ID: <20200808121026.1300375-4-cmo@melexis.com> (raw)
In-Reply-To: <20200808121026.1300375-1-cmo@melexis.com>

Document internal/private struct for mlx90632 device.

Signed-off-by: Crt Mori <cmo@melexis.com>
---
 drivers/iio/temperature/mlx90632.c | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/drivers/iio/temperature/mlx90632.c b/drivers/iio/temperature/mlx90632.c
index 049c1217a166..4e0131705c11 100644
--- a/drivers/iio/temperature/mlx90632.c
+++ b/drivers/iio/temperature/mlx90632.c
@@ -107,12 +107,23 @@
 #define MLX90632_SLEEP_DELAY_MS 3000 /**< Autosleep delay */
 #define MLX90632_EXTENDED_LIMIT 27000 /* Extended mode raw value limit */
 
+/**
+ * struct mlx90632_data - private data for the MLX90632 device
+ * @client: I2C client of the device
+ * @lock: Internal mutex for multiple reads for single measurement
+ * @regmap: Regmap of the device
+ * @emissivity: Object emissivity from 0 to 1000 where 1000 = 1.
+ * @mtyp: Measurement type physical sensor configuration for extended range
+ *        calculations
+ * @object_ambient_temperature: Ambient temperature at object (might differ of
+ *                              the ambient temperature of sensor.
+ */
 struct mlx90632_data {
 	struct i2c_client *client;
-	struct mutex lock; /* Multiple reads for single measurement */
+	struct mutex lock;
 	struct regmap *regmap;
 	u16 emissivity;
-	u8 mtyp; /* measurement type - to enable extended range calculations */
+	u8 mtyp;
 	u32 object_ambient_temperature;
 };
 
-- 
2.25.1


  parent reply	other threads:[~2020-08-08 12:12 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-08 12:10 [PATCH v4 0/4] iio: temperature: mlx90632: Add extended calibration calculations Crt Mori
2020-08-08 12:10 ` [PATCH v4 1/4] iio:temperature:mlx90632: Reduce number of equal calulcations Crt Mori
2020-08-08 19:58   ` Andy Shevchenko
2020-08-08 12:10 ` [PATCH v4 2/4] iio:temperature:mlx90632: Adding extended calibration option Crt Mori
2020-08-08 20:03   ` Andy Shevchenko
2020-08-08 21:57     ` Crt Mori
2020-08-09 13:32       ` Jonathan Cameron
2020-08-09 21:05         ` Crt Mori
2020-08-11  7:53           ` Crt Mori
2020-08-16  9:09             ` Jonathan Cameron
2020-08-08 12:10 ` Crt Mori [this message]
2020-08-08 19:54   ` [PATCH v4 3/4] iio:temperature:mlx90632: Add kerneldoc to the internal struct Andy Shevchenko
2020-08-08 12:10 ` [PATCH v4 4/4] iio:temperature:mlx90632: Convert polling while loops to do-while Crt Mori
2020-08-08 19:56 ` [PATCH v4 0/4] iio: temperature: mlx90632: Add extended calibration calculations Andy Shevchenko
2020-08-08 20:04 ` Andy Shevchenko
2020-08-08 20:06 ` Andy Shevchenko

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=20200808121026.1300375-4-cmo@melexis.com \
    --to=cmo@melexis.com \
    --cc=andy.shevchenko@gmail.com \
    --cc=jic23@kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.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).