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 int thermal_register_governor(struct thermal_governor *);
58 void thermal_unregister_governor(struct thermal_governor *);
59
60 #ifdef CONFIG_THERMAL_GOV_STEP_WISE
61 int thermal_gov_step_wise_register(void);
62 void thermal_gov_step_wise_unregister(void);
63 #else
thermal_gov_step_wise_register(void)64 static inline int thermal_gov_step_wise_register(void) { return 0; }
thermal_gov_step_wise_unregister(void)65 static inline void thermal_gov_step_wise_unregister(void) {}
66 #endif /* CONFIG_THERMAL_GOV_STEP_WISE */
67
68 #ifdef CONFIG_THERMAL_GOV_FAIR_SHARE
69 int thermal_gov_fair_share_register(void);
70 void thermal_gov_fair_share_unregister(void);
71 #else
thermal_gov_fair_share_register(void)72 static inline int thermal_gov_fair_share_register(void) { return 0; }
thermal_gov_fair_share_unregister(void)73 static inline void thermal_gov_fair_share_unregister(void) {}
74 #endif /* CONFIG_THERMAL_GOV_FAIR_SHARE */
75
76 #ifdef CONFIG_THERMAL_GOV_BANG_BANG
77 int thermal_gov_bang_bang_register(void);
78 void thermal_gov_bang_bang_unregister(void);
79 #else
thermal_gov_bang_bang_register(void)80 static inline int thermal_gov_bang_bang_register(void) { return 0; }
thermal_gov_bang_bang_unregister(void)81 static inline void thermal_gov_bang_bang_unregister(void) {}
82 #endif /* CONFIG_THERMAL_GOV_BANG_BANG */
83
84 #ifdef CONFIG_THERMAL_GOV_USER_SPACE
85 int thermal_gov_user_space_register(void);
86 void thermal_gov_user_space_unregister(void);
87 #else
thermal_gov_user_space_register(void)88 static inline int thermal_gov_user_space_register(void) { return 0; }
thermal_gov_user_space_unregister(void)89 static inline void thermal_gov_user_space_unregister(void) {}
90 #endif /* CONFIG_THERMAL_GOV_USER_SPACE */
91
92 #ifdef CONFIG_THERMAL_GOV_POWER_ALLOCATOR
93 int thermal_gov_power_allocator_register(void);
94 void thermal_gov_power_allocator_unregister(void);
95 #else
thermal_gov_power_allocator_register(void)96 static inline int thermal_gov_power_allocator_register(void) { return 0; }
thermal_gov_power_allocator_unregister(void)97 static inline void thermal_gov_power_allocator_unregister(void) {}
98 #endif /* CONFIG_THERMAL_GOV_POWER_ALLOCATOR */
99
100 /* device tree support */
101 #ifdef CONFIG_THERMAL_OF
102 int of_parse_thermal_zones(void);
103 void of_thermal_destroy_zones(void);
104 int of_thermal_get_ntrips(struct thermal_zone_device *);
105 bool of_thermal_is_trip_valid(struct thermal_zone_device *, int);
106 const struct thermal_trip *
107 of_thermal_get_trip_points(struct thermal_zone_device *);
108 #else
of_parse_thermal_zones(void)109 static inline int of_parse_thermal_zones(void) { return 0; }
of_thermal_destroy_zones(void)110 static inline void of_thermal_destroy_zones(void) { }
of_thermal_get_ntrips(struct thermal_zone_device * tz)111 static inline int of_thermal_get_ntrips(struct thermal_zone_device *tz)
112 {
113 return 0;
114 }
of_thermal_is_trip_valid(struct thermal_zone_device * tz,int trip)115 static inline bool of_thermal_is_trip_valid(struct thermal_zone_device *tz,
116 int trip)
117 {
118 return false;
119 }
120 static inline const struct thermal_trip *
of_thermal_get_trip_points(struct thermal_zone_device * tz)121 of_thermal_get_trip_points(struct thermal_zone_device *tz)
122 {
123 return NULL;
124 }
125 #endif
126
127 #endif /* __THERMAL_CORE_H__ */
128