thermal: Add comment explaining test for critical temperature

saschahauer · zhang-rui · commit 934c93b8c193 · 2015-08-03T23:15:51.000+08:00
The code testing if a temperature should be emulated or not is
not obvious. Add a comment explaining why this test is done.

Signed-off-by: Sascha Hauer &lt;s.hauer@pengutronix.de&gt;
Reviewed-by: Mikko Perttunen &lt;mperttunen@nvidia.com&gt;
Signed-off-by: Zhang Rui &lt;rui.zhang@intel.com&gt;
diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
@@ -498,6 +498,11 @@ int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp)
 			}
 		}
 
+		/*
+		 * Only allow emulating a temperature when the real temperature
+		 * is below the critical temperature so that the emulation code
+		 * cannot hide critical conditions.
+		 */
 		if (!ret && *temp < crit_temp)
 			*temp = tz->emul_temperature;
 	}

Original file line number	Diff line number	Diff line change
`@@ -498,6 +498,11 @@ int thermal_zone_get_temp(struct thermal_zone_device tz, int temp)`
`498`	`498`	`}`
`499`	`499`	`}`
`500`	`500`
	`501`	`+ /*`
	`502`	`+ * Only allow emulating a temperature when the real temperature`
	`503`	`+ * is below the critical temperature so that the emulation code`
	`504`	`+ * cannot hide critical conditions.`
	`505`	`+ */`
`501`	`506`	`if (!ret && *temp < crit_temp)`
`502`	`507`	`*temp = tz->emul_temperature;`
`503`	`508`	`}`