therm-fan-est: Add support for Tmargin to drive fan

Why?
Tmargin method of fan control allows multiple groups of
therma-fan-est devices temperatures to be considered for
the fan control algorithm/fan curve. The limitation of the
existing max temp algorithm in therm-fan-est driver is that
devices with different fan curves cannot be accomodated in
the driver. In case, there are multple fan curves, the device
which has the steepest curve wins the algoritm. Hence, taking
the temperatures as a reference from their respective critical
temperatures and using that value to drive the fan will help in
accomodating both the devices' fan curves.

How?
* Calculate the effective crit temp of all the thermal zones
  during probe.
* In the polling cycles, calculate the effective temperatures
  of the individual groups and use the tmargin formula to
  calculate the current temperature.
* Since the Tmargin temp trip values are in reverse order, we
  need to use the reverse order in the pwm-fan dt profile.
* The hysterysis is subtracted from the temp in cooling scenario
  to avoid frequent switching at trip temps. Since the tmargin
  trip values are taken in the decending order, hysterysis temps
  in dt should be given as negative values.

Bug 200627962

Change-Id: Ideba4bfdb3d3306d1b4aff15093bcfac13d7bb86
Signed-off-by: Mantravadi Karthik <mkarthik@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvidia/+/2362354
Reviewed-by: automaticguardword <automaticguardword@nvidia.com>
Reviewed-by: Rajkumar Kasirajan <rkasirajan@nvidia.com>
Reviewed-by: Bibek Basu <bbasu@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: Rajkumar Kasirajan <rkasirajan@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
GVS: Gerrit_Virtual_Submit

3 files changed, 225 insertions, 19 deletions

diff --git a/Documentation/devicetree/bindings/misc/therm_est.txt b/Documentation/devicetree/bindings/misc/therm_est.txt
index 0dbcb147a..0538981a7 100644
--- a/Documentation/devicetree/bindings/misc/therm_est.txt
+++ b/Documentation/devicetree/bindings/misc/therm_est.txt
@@ -6,6 +6,8 @@ Properties :
  - tc1 : Coefficient 1 for thermal trend calculation.
  - tc2 : Coefficient 2 for thermal trend calculation.
  - node for subdev : Node for subdevice information. Required.
+ - use_tmargin : if tmargin algorithm should be used for calculating the
+   effective temp. Refer Tmargin section for more info.
 
 Properties in subdev node : Required.
  - subdev_names : list of strings. It contains list of the name of the therm
@@ -45,3 +47,91 @@ Example:
                         };
                 };
         };
+
+Tmargin Algorithm:
+The native max temp algorithm lacks support for accomodating multiple thermal
+fan curves. Tmargin algorithm solves this by calculating the effective
+temperature as a difference from critical temperature of the therm fan est
+group. This allows us to take a union of two fan curves and satisfy the needs
+of both the therm-fan-est groups.
+The algorithm use the effective temperature(crit_temp - sensor_reading) to
+drive the cooling device.
+
+Properties rules for therm-fan-est dt entry:
+ - use_tmargin : To use the tmargin feature.
+ - profiles : New profile tmargin should be defined and chosen as default.
+        * The trip temperatures need to be given only in ascending order for the
+          thermal framework to register therm-fan-est zone. Hence, the dt values
+          for active trip temps should be given in ascending values of tmargin
+          values.
+        * Hysterysis is used only in cooling scenario. Since tmargin is
+          considered as a diff wrt crit_Temp, hysterysis values should be taken
+          as -ve values.
+
+Properties rules for fan dt entry:
+ - profiles : New profile for tmargin should be defined and chosen as default.
+        * The trip temps are considered in a ascending order of tmargin temps.
+          Hence, the pwm values should be considered in a descending order of
+          pwms.
+        * active_steps - The tmargin trip values are considered in the ascending
+          order(hence actual trip temps will be in descending order), so the
+          pwm mapping should be in the reverse order starting from 255 for
+          index 0.
+
+Example :
+
+        thermal-fan-est {
+                compatible = "thermal-fan-est";
+                name = "thermal-fan-est";
+                status = "okay";
+                num_resources = <0>;
+                shared_data = <&thermal_fan_est_shared_data>;
+                trip_length = <10>;
+                use_tmargin;
+
+                profiles {
+                        default = "tmargin";
+                        quiet {
+                                active_trip_temps = <0 50000 63000 72000 81000
+                                                140000 150000 160000 170000 180000>;
+                                active_hysteresis = <0 18000 8000 8000 8000
+                                                0 0 0 0 0>;
+                        };
+                        cool {
+                                active_trip_temps = <0 35000 53000 62000 73000
+                                                140000 150000 160000 170000 180000>;
+                                active_hysteresis = <0 9000 8000 8000 9000
+                                                0 0 0 0 0>;
+                        };
+                        tmargin {
+                                active_trip_temps = <0 10000 15000 25000 35000
+                                                45000 55000 65000 75000 105000>;
+                                active_hysteresis = <0 0 0 0 (-3000)
+                                                (-4000) (-4000) 0 0 0>;
+                        };
+                };
+        };
+
+        pwm-fan {
+                compatible = "pwm-fan";
+                status = "okay";
+                #pwm-cells = <1>;
+                pwms = <&tegra_pwm4 0 45334>;
+                shared_data = <&pwm_fan_shared_data>;
+                profiles {
+                        default = "tmargin";
+                        quiet {
+                                state_cap = <8>;
+                                active_pwm = <0 60 90 120 150 180 210 240 255 255>;
+                        };
+                        cool {
+                                state_cap = <4>;
+                                active_pwm = <0 77 120 160 255 255 255 255 255 255>;
+                        };
+                        tmargin {
+                                state_cap = <0>;
+                                active_pwm = <255 255 240 210 180 150 120 90 60 0>;
+                        };
+                };
+        };
+
diff --git a/drivers/misc/therm_fan_est.c b/drivers/misc/therm_fan_est.c
index f07a31009..e37c1130d 100644
--- a/drivers/misc/therm_fan_est.c
+++ b/drivers/misc/therm_fan_est.c
@@ -52,7 +52,8 @@ static void therm_fan_est_work_func(struct work_struct *work)
 {
         int i, j, group, index, trip_index = 0;
         int sum[MAX_SUBDEVICE_GROUP] = {0, };
-        int sum_max = 0;
+        int sum_max = INT_MIN;
+        int sum_min = INT_MAX;
         int temp = 0;
         struct delayed_work *dwork = container_of(work,
                                         struct delayed_work, work);
@@ -77,11 +78,21 @@ static void therm_fan_est_work_func(struct work_struct *work)
                 }
         }
 
+        if (est->use_tmargin) {
+                for (i = 0; i < MAX_SUBDEVICE_GROUP; i++)
+                        sum[i] = (est->crit_temp[i] * 100) - sum[i];
+        }
+
 #if !DEBUG
-        for (i = 0; i < MAX_SUBDEVICE_GROUP; i++)
+        for (i = 0; i < MAX_SUBDEVICE_GROUP; i++) {
+                sum_min = min(sum_min, sum[i]);
                 sum_max = max(sum_max, sum[i]);
+        }
 
-        est->cur_temp = sum_max / 100 + est->toffset;
+        if (est->use_tmargin)
+                est->cur_temp = sum_min / 100 + est->toffset;
+        else
+                est->cur_temp = sum_max / 100 + est->toffset;
 #else
         est->cur_temp = est->cur_temp_debug;
 #endif
@@ -95,7 +106,9 @@ static void therm_fan_est_work_func(struct work_struct *work)
         }
 
         if (est->cur_temp != est->pre_temp) {
-                if (est->cur_temp > est->pre_temp) {
+                if (est->use_tmargin ?
+                        (est->cur_temp < est->pre_temp) :
+                        (est->cur_temp > est->pre_temp)) {
                         /* temperature is rising */
                         read_lock(&est->state_lock);
                         for (trip_index = 0;
@@ -105,10 +118,16 @@ static void therm_fan_est_work_func(struct work_struct *work)
                         }
                         read_unlock(&est->state_lock);
 
-                        if (est->current_trip_level < trip_index
-                                && est->current_trip_level != (trip_index - 1))
-                                update_flag = true;
-                } else if (est->cur_temp < est->pre_temp) {
+                        if (est->use_tmargin) {
+                                if (est->current_trip_level >= trip_index
+                                        && est->current_trip_level != (trip_index - 1))
+                                        update_flag = true;
+                        } else {
+                                if (est->current_trip_level < trip_index
+                                        && est->current_trip_level != (trip_index - 1))
+                                        update_flag = true;
+                        }
+                } else {
                         /* temperature is cooling */
                         read_lock(&est->state_lock);
                         for (trip_index = 1;
@@ -119,10 +138,16 @@ static void therm_fan_est_work_func(struct work_struct *work)
                         }
                         read_unlock(&est->state_lock);
 
-                        if (est->current_trip_level >= trip_index
-                                && est->current_trip_level != (trip_index - 1)
-                                && trip_index != (MAX_ACTIVE_STATES + 1))
-                                update_flag = true;
+                        if (est->use_tmargin) {
+                                if (est->current_trip_level < trip_index
+                                        && est->current_trip_level != (trip_index - 1))
+                                        update_flag = true;
+                        } else {
+                                if (est->current_trip_level >= trip_index
+                                        && est->current_trip_level != (trip_index - 1)
+                                        && trip_index != (MAX_ACTIVE_STATES + 1))
+                                        update_flag = true;
+                        }
                 }
 
                 if (update_flag) {
@@ -317,6 +342,51 @@ static struct thermal_zone_device_ops therm_fan_est_ops = {
         .set_trip_hyst = therm_fan_est_set_trip_hyst,
 };
 
+static int fan_est_match(struct thermal_zone_device *thz, void *data)
+{
+        return (strcmp((char *)data, thz->type) == 0);
+}
+
+static int fan_est_get_crit_temp(struct therm_fan_estimator *est)
+{
+        struct thermal_zone_device *thz;
+        int crit_temp;
+        int i;
+
+        for (i = 0; i < est->ndevs; i++) {
+                thz = thermal_zone_device_find((void *)est->devs[i].dev_data,
+                        fan_est_match);
+
+                if (thz && thz->ops && thz->ops->get_crit_temp) {
+                        thz->ops->get_crit_temp(thz, &crit_temp);
+                        if (crit_temp <= 0) {
+                                pr_err("THERMAL EST: Failed to get crit temp of %s\n",
+                                        est->devs[i].dev_data);
+                                return -EINVAL;
+                        }
+                } else {
+                        pr_err("THERMAL EST: Invalid ops for %s\n",
+                                est->devs[i].dev_data);
+                        return -EINVAL;
+                }
+
+                if (crit_temp > est->crit_temp[est->devs[i].group])
+                        est->crit_temp[est->devs[i].group] = crit_temp;
+        }
+
+        for (i = 0; i < MAX_SUBDEVICE_GROUP; i++) {
+                if (est->crit_temp[i] == 0) {
+                        pr_err("THERMAL EST: Group %d has no crit temp\n", i);
+                        return -EINVAL;
+                } else {
+                        pr_info("THERMAL EST: Group %d crit temp - %ld", i,
+                                est->crit_temp[i]);
+                }
+        }
+
+        return 0;
+}
+
 static ssize_t show_coeff(struct device *dev,
                                 struct device_attribute *da,
                                 char *buf)
@@ -506,6 +576,44 @@ static ssize_t set_sleep_mode(struct device *dev,
         return count;
 }
 
+static ssize_t show_crit_temps(struct device *dev,
+        struct device_attribute *da,
+        char *buf)
+{
+        struct therm_fan_estimator *est = dev_get_drvdata(dev);
+        ssize_t len, total_len = 0;
+        int i;
+
+        for (i = 0; i < MAX_SUBDEVICE_GROUP; i++) {
+                len = snprintf(buf + total_len, PAGE_SIZE,
+                        "group[%d] - %ld", i, est->crit_temp[i]);
+                total_len += len;
+                len = snprintf(buf + total_len, PAGE_SIZE, "\n");
+                total_len += len;
+        }
+        return strlen(buf);
+}
+
+static ssize_t show_zone_map(struct device *dev,
+        struct device_attribute *da,
+        char *buf)
+{
+        struct therm_fan_estimator *est = dev_get_drvdata(dev);
+        ssize_t len, total_len = 0;
+        int i;
+
+        for (i = 0; i < est->ndevs; i++) {
+        len = snprintf(buf + total_len, PAGE_SIZE,
+                "%s - ndev[%d], group[%d]",
+                est->devs[i].dev_data, i, est->devs[i].group);
+        total_len += len;
+        len = snprintf(buf + total_len, PAGE_SIZE, "\n");
+        total_len += len;
+        }
+        return strlen(buf);
+}
+
+
 static ssize_t show_temps(struct device *dev,
                                 struct device_attribute *da,
                                 char *buf)
@@ -554,6 +662,8 @@ static struct sensor_device_attribute therm_fan_est_nodes[] = {
                                 show_fan_profile, set_fan_profile, 0),
         SENSOR_ATTR(sleep_mode, S_IRUGO | S_IWUSR,
                                 show_sleep_mode, set_sleep_mode, 0),
+        SENSOR_ATTR(zone_map, S_IRUGO, show_zone_map, 0, 0),
+        SENSOR_ATTR(crit_temps, S_IRUGO, show_crit_temps, 0, 0),
 #if DEBUG
         SENSOR_ATTR(temps, S_IRUGO | S_IWUSR, show_temps, set_temps, 0),
 #else
@@ -562,11 +672,6 @@ static struct sensor_device_attribute therm_fan_est_nodes[] = {
 };
 
 
-static int fan_est_match(struct thermal_zone_device *thz, void *data)
-{
-        return (strcmp((char *)data, thz->type) == 0);
-}
-
 static int fan_est_get_temp_func(const char *data, int *temp)
 {
         struct thermal_zone_device *thz;
@@ -579,7 +684,6 @@ static int fan_est_get_temp_func(const char *data, int *temp)
         return 0;
 }
 
-
 static int therm_fan_est_probe(struct platform_device *pdev)
 {
         int i, j;
@@ -652,6 +756,8 @@ static int therm_fan_est_probe(struct platform_device *pdev)
         est_data->num_resources = value;
         pr_info("THERMAL EST num_resources: %d\n", est_data->num_resources);
 
+        est_data->use_tmargin = of_property_read_bool(node, "use_tmargin");
+
         of_err |= of_property_read_u32(node, "trip_length", &value);
         if (of_err) {
                 pr_err("THERMAL EST: missing trip length\n");
@@ -855,6 +961,14 @@ static int therm_fan_est_probe(struct platform_device *pdev)
                         i, temp);
         }
 
+        if (est_data->use_tmargin) {
+                err = fan_est_get_crit_temp(est_data);
+                if (err) {
+                        err = -EINVAL;
+                        goto free_subdevs;
+                }
+        }
+
         of_err |= of_property_read_string(data_node, "cdev_type",
                                                 &est_data->cdev_type);
         if (of_err) {
@@ -919,7 +1033,7 @@ static int therm_fan_est_probe(struct platform_device *pdev)
 
         /* workqueue related */
         est_data->workqueue = alloc_workqueue(dev_name(&pdev->dev),
-                                    WQ_HIGHPRI | WQ_UNBOUND, 1);
+                                        WQ_HIGHPRI | WQ_UNBOUND, 1);
         if (!est_data->workqueue) {
                 err = -ENOMEM;
                 goto free_tzp;
diff --git a/include/linux/therm_est.h b/include/linux/therm_est.h
index fa1ea7ffc..8b1786ea8 100644
--- a/include/linux/therm_est.h
+++ b/include/linux/therm_est.h
@@ -235,6 +235,8 @@ struct therm_fan_estimator {
         /* allow cooling device to turn off at higher temperature if sleep */
         bool sleep_mode;
         int nonsleep_hyst;
+        bool use_tmargin;
+        long crit_temp[MAX_SUBDEVICE_GROUP];
 
         bool is_continuous_gov;
 };