thermal/drivers/rzg2l: Fix comments
authorBiju Das <biju.das.jz@bp.renesas.com>
Mon, 18 Jul 2022 12:14:40 +0000 (13:14 +0100)
committerDaniel Lezcano <daniel.lezcano@linaro.org>
Thu, 28 Jul 2022 15:29:49 +0000 (17:29 +0200)
This patch replaces 'Capture times'->'Total number of ADC data samples' as
the former does not really explain much.

It also fixes the typo
 * caliberation->calibration

Lastly, as per the coding style /* should be on a separate line.
This patch fixes this issue.

Reported-by: Pavel Machek <pavel@denx.de>
Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
Link: https://lore.kernel.org/r/20220718121440.556408-1-biju.das.jz@bp.renesas.com
Signed-off-by: Daniel Lezcano <daniel.lezcano@linaro.org>
drivers/thermal/rzg2l_thermal.c

index be07e04..51ae80e 100644 (file)
@@ -47,7 +47,7 @@
 
 #define TS_CODE_AVE_SCALE(x)   ((x) * 1000000)
 #define MCELSIUS(temp)         ((temp) * MILLIDEGREE_PER_DEGREE)
-#define TS_CODE_CAP_TIMES      8       /* Capture  times */
+#define TS_CODE_CAP_TIMES      8       /* Total number of ADC data samples */
 
 #define RZG2L_THERMAL_GRAN     500     /* milli Celsius */
 #define RZG2L_TSU_SS_TIMEOUT_US        1000
@@ -80,7 +80,8 @@ static int rzg2l_thermal_get_temp(void *devdata, int *temp)
        int val, i;
 
        for (i = 0; i < TS_CODE_CAP_TIMES ; i++) {
-               /* TSU repeats measurement at 20 microseconds intervals and
+               /*
+                * TSU repeats measurement at 20 microseconds intervals and
                 * automatically updates the results of measurement. As per
                 * the HW manual for measuring temperature we need to read 8
                 * values consecutively and then take the average.
@@ -92,16 +93,18 @@ static int rzg2l_thermal_get_temp(void *devdata, int *temp)
 
        ts_code_ave = result / TS_CODE_CAP_TIMES;
 
-       /* Calculate actual sensor value by applying curvature correction formula
+       /*
+        * Calculate actual sensor value by applying curvature correction formula
         * dsensor = ts_code_ave / (1 + ts_code_ave * 0.000013). Here we are doing
         * integer calculation by scaling all the values by 1000000.
         */
        dsensor = TS_CODE_AVE_SCALE(ts_code_ave) /
                (TS_CODE_AVE_SCALE(1) + (ts_code_ave * CURVATURE_CORRECTION_CONST));
 
-       /* The temperature Tj is calculated by the formula
+       /*
+        * The temperature Tj is calculated by the formula
         * Tj = (dsensor − calib1) * 165/ (calib0 − calib1) − 40
-        * where calib0 and calib1 are the caliberation values.
+        * where calib0 and calib1 are the calibration values.
         */
        val = ((dsensor - priv->calib1) * (MCELSIUS(165) /
                (priv->calib0 - priv->calib1))) - MCELSIUS(40);
@@ -122,7 +125,8 @@ static int rzg2l_thermal_init(struct rzg2l_thermal_priv *priv)
        rzg2l_thermal_write(priv, TSU_SM, TSU_SM_NORMAL_MODE);
        rzg2l_thermal_write(priv, TSU_ST, 0);
 
-       /* Before setting the START bit, TSU should be in normal operating
+       /*
+        * Before setting the START bit, TSU should be in normal operating
         * mode. As per the HW manual, it will take 60 µs to place the TSU
         * into normal operating mode.
         */
@@ -217,7 +221,7 @@ static int rzg2l_thermal_probe(struct platform_device *pdev)
        if (ret)
                goto err;
 
-       dev_dbg(dev, "TSU probed with %s caliberation values",
+       dev_dbg(dev, "TSU probed with %s calibration values",
                rzg2l_thermal_read(priv, OTPTSUTRIM_REG(0)) ?  "hw" : "sw");
 
        return 0;