This patch adds documentation for the structure
thermal_zone_params, and also shows an example of
how to populate them.
Signed-off-by: Durgadoss R <durgadoss.r@xxxxxxxxx>
---
Documentation/thermal/sysfs-api.txt | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/Documentation/thermal/sysfs-api.txt b/Documentation/thermal/sysfs-api.txt
index ca1a1a3..669720c 100644
--- a/Documentation/thermal/sysfs-api.txt
+++ b/Documentation/thermal/sysfs-api.txt
@@ -112,6 +112,36 @@ temperature) and throttle appropriate devices.
trip: indicates which trip point the cooling devices is associated with
in this thermal zone.
+1.4 Thermal Zone Parameters
+1.4.1 struct thermal_zone_params
+ This structure defines the platform level parameters for a thermal zone.
+ This data, for each thermal zone should come from the platform layer.
+ This is an optional feature where some platforms can choose not to
+ provide this data.
+1.4.2 struct thermal_zone_params attributes
+ .thermal_zone_name: Name of the thermal zone, for which these parameters
+ are being defined.
+ .num_cdevs: Number of cooling devices associated with this
+ thermal zone.
+ .cdevs_name: Names of the cooling devices associated with this
+ thermal zone.
+ .weights: This parameter defines the 'influence' of a particular cooling
+ device on this thermal zone, on a percentage scale. The sum of
+ all these weights cannot exceed 100. The order of values in
+ this array should match with that of the cdevs_name.
+ .trip_mask: This is a bit mask that gives the binding relation between
+ this thermal zone and cdev, for a particular trip point.
+ If nth bit is set, then the cdev and thermal zone are bound
+ for trip point n.
+1.4.3 An example thermal_zone_params structure
+ struct thermal_zone_params tzp = {
+ .thermal_zone_name = "CPU",
+ .num_cdevs = 2,
+ .cdevs_name = {"CPU", "Memory"},
+ .weights = {70, 30},
+ .trip_mask = {0x0F, 0x08},
+ };
+
2. sysfs attributes structure
RO read only value
--
1.7.9.5
--
To unsubscribe from this list: send the line "unsubscribe linux-acpi" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
