xref: /linux/drivers/thermal/thermal_core.h (revision ef69f8d2ff09518657c3ecaf2db8408c16549829)
1 /*
2  *  thermal_core.h
3  *
4  *  Copyright (C) 2012  Intel Corp
5  *  Author: Durgadoss R <durgadoss.r@intel.com>
6  *
7  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; version 2 of the License.
11  *
12  *  This program is distributed in the hope that it will be useful, but
13  *  WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License along
18  *  with this program; if not, write to the Free Software Foundation, Inc.,
19  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
20  *
21  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22  */
23 
24 #ifndef __THERMAL_CORE_H__
25 #define __THERMAL_CORE_H__
26 
27 #include <linux/device.h>
28 #include <linux/thermal.h>
29 
30 /* Initial state of a cooling device during binding */
31 #define THERMAL_NO_TARGET -1UL
32 
33 /*
34  * This structure is used to describe the behavior of
35  * a certain cooling device on a certain trip point
36  * in a certain thermal zone
37  */
38 struct thermal_instance {
39 	int id;
40 	char name[THERMAL_NAME_LENGTH];
41 	struct thermal_zone_device *tz;
42 	struct thermal_cooling_device *cdev;
43 	int trip;
44 	bool initialized;
45 	unsigned long upper;	/* Highest cooling state for this trip point */
46 	unsigned long lower;	/* Lowest cooling state for this trip point */
47 	unsigned long target;	/* expected cooling state */
48 	char attr_name[THERMAL_NAME_LENGTH];
49 	struct device_attribute attr;
50 	char weight_attr_name[THERMAL_NAME_LENGTH];
51 	struct device_attribute weight_attr;
52 	struct list_head tz_node; /* node in tz->thermal_instances */
53 	struct list_head cdev_node; /* node in cdev->thermal_instances */
54 	unsigned int weight; /* The weight of the cooling device */
55 };
56 
57 #define to_thermal_zone(_dev) \
58 	container_of(_dev, struct thermal_zone_device, device)
59 
60 #define to_cooling_device(_dev)	\
61 	container_of(_dev, struct thermal_cooling_device, device)
62 
63 int thermal_register_governor(struct thermal_governor *);
64 void thermal_unregister_governor(struct thermal_governor *);
65 void thermal_zone_device_rebind_exception(struct thermal_zone_device *,
66 					  const char *, size_t);
67 void thermal_zone_device_unbind_exception(struct thermal_zone_device *,
68 					  const char *, size_t);
69 int thermal_zone_device_set_policy(struct thermal_zone_device *, char *);
70 int thermal_build_list_of_policies(char *buf);
71 
72 /* sysfs I/F */
73 int thermal_zone_create_device_groups(struct thermal_zone_device *, int);
74 void thermal_zone_destroy_device_groups(struct thermal_zone_device *);
75 void thermal_cooling_device_setup_sysfs(struct thermal_cooling_device *);
76 /* used only at binding time */
77 ssize_t
78 thermal_cooling_device_trip_point_show(struct device *,
79 				       struct device_attribute *, char *);
80 ssize_t thermal_cooling_device_weight_show(struct device *,
81 					   struct device_attribute *, char *);
82 
83 ssize_t thermal_cooling_device_weight_store(struct device *,
84 					    struct device_attribute *,
85 					    const char *, size_t);
86 
87 #ifdef CONFIG_THERMAL_GOV_STEP_WISE
88 int thermal_gov_step_wise_register(void);
89 void thermal_gov_step_wise_unregister(void);
90 #else
91 static inline int thermal_gov_step_wise_register(void) { return 0; }
92 static inline void thermal_gov_step_wise_unregister(void) {}
93 #endif /* CONFIG_THERMAL_GOV_STEP_WISE */
94 
95 #ifdef CONFIG_THERMAL_GOV_FAIR_SHARE
96 int thermal_gov_fair_share_register(void);
97 void thermal_gov_fair_share_unregister(void);
98 #else
99 static inline int thermal_gov_fair_share_register(void) { return 0; }
100 static inline void thermal_gov_fair_share_unregister(void) {}
101 #endif /* CONFIG_THERMAL_GOV_FAIR_SHARE */
102 
103 #ifdef CONFIG_THERMAL_GOV_BANG_BANG
104 int thermal_gov_bang_bang_register(void);
105 void thermal_gov_bang_bang_unregister(void);
106 #else
107 static inline int thermal_gov_bang_bang_register(void) { return 0; }
108 static inline void thermal_gov_bang_bang_unregister(void) {}
109 #endif /* CONFIG_THERMAL_GOV_BANG_BANG */
110 
111 #ifdef CONFIG_THERMAL_GOV_USER_SPACE
112 int thermal_gov_user_space_register(void);
113 void thermal_gov_user_space_unregister(void);
114 #else
115 static inline int thermal_gov_user_space_register(void) { return 0; }
116 static inline void thermal_gov_user_space_unregister(void) {}
117 #endif /* CONFIG_THERMAL_GOV_USER_SPACE */
118 
119 #ifdef CONFIG_THERMAL_GOV_POWER_ALLOCATOR
120 int thermal_gov_power_allocator_register(void);
121 void thermal_gov_power_allocator_unregister(void);
122 #else
123 static inline int thermal_gov_power_allocator_register(void) { return 0; }
124 static inline void thermal_gov_power_allocator_unregister(void) {}
125 #endif /* CONFIG_THERMAL_GOV_POWER_ALLOCATOR */
126 
127 /* device tree support */
128 #ifdef CONFIG_THERMAL_OF
129 int of_parse_thermal_zones(void);
130 void of_thermal_destroy_zones(void);
131 int of_thermal_get_ntrips(struct thermal_zone_device *);
132 bool of_thermal_is_trip_valid(struct thermal_zone_device *, int);
133 const struct thermal_trip *
134 of_thermal_get_trip_points(struct thermal_zone_device *);
135 #else
136 static inline int of_parse_thermal_zones(void) { return 0; }
137 static inline void of_thermal_destroy_zones(void) { }
138 static inline int of_thermal_get_ntrips(struct thermal_zone_device *tz)
139 {
140 	return 0;
141 }
142 static inline bool of_thermal_is_trip_valid(struct thermal_zone_device *tz,
143 					    int trip)
144 {
145 	return false;
146 }
147 static inline const struct thermal_trip *
148 of_thermal_get_trip_points(struct thermal_zone_device *tz)
149 {
150 	return NULL;
151 }
152 #endif
153 
154 #endif /* __THERMAL_CORE_H__ */
155