[v4,3/4] iio:temperature:mlx90632: Add kerneldoc to the internal struct

Commit Message

Crt Mori Aug. 8, 2020, 12:10 p.m. UTC

Document internal/private struct for mlx90632 device.

Signed-off-by: Crt Mori <[e-mail]>
---
 drivers/iio/temperature/mlx90632.c | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

Comments

Andy Shevchenko Aug. 8, 2020, 7:54 p.m. UTC | #1

On Sat, Aug 8, 2020 at 3:11 PM Crt Mori <[e-mail]> wrote:
>
> Document internal/private struct for mlx90632 device.

Thanks. The only issue with it is that it should go before the one
that adds member(s) to the struct.

Patch

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;
 };