staging: iio: tsl2583: fixed ordering of comments
authorBrian Masney <masneyb@onstation.org>
Thu, 3 Nov 2016 12:56:14 +0000 (08:56 -0400)
committerJonathan Cameron <jic23@kernel.org>
Sun, 6 Nov 2016 11:48:52 +0000 (11:48 +0000)
in taos_defaults()

The comments in taos_defaults() appear after the line of code
that they apply to. This patch moves the comments so that they appear
before the code. Some of the comments were updated to be more
informative.

Signed-off-by: Brian Masney <masneyb@onstation.org>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
drivers/staging/iio/light/tsl2583.c

index 388440b..709f446 100644 (file)
@@ -143,16 +143,23 @@ static const struct gainadj gainadj[] = {
  */
 static void taos_defaults(struct tsl2583_chip *chip)
 {
-       /* Operational parameters */
+       /*
+        * The integration time must be a multiple of 50ms and within the
+        * range [50, 600] ms.
+        */
        chip->taos_settings.als_time = 100;
-       /* must be a multiple of 50mS */
+
+       /*
+        * This is an index into the gainadj table. Assume clear glass as the
+        * default.
+        */
        chip->taos_settings.als_gain = 0;
-       /* this is actually an index into the gain table */
-       /* assume clear glass as default */
+
+       /* Default gain trim to account for aperture effects */
        chip->taos_settings.als_gain_trim = 1000;
-       /* default gain trim to account for aperture effects */
-       chip->taos_settings.als_cal_target = 130;
+
        /* Known external ALS reading used for calibration */
+       chip->taos_settings.als_cal_target = 130;
 }
 
 /*