xref: /linux-6.15/include/linux/cpu_cooling.h (revision f5f263fe)
1 /*
2  *  linux/include/linux/cpu_cooling.h
3  *
4  *  Copyright (C) 2012	Samsung Electronics Co., Ltd(http://www.samsung.com)
5  *  Copyright (C) 2012  Amit Daniel <[email protected]>
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 __CPU_COOLING_H__
25 #define __CPU_COOLING_H__
26 
27 #include <linux/of.h>
28 #include <linux/thermal.h>
29 #include <linux/cpumask.h>
30 
31 struct cpufreq_policy;
32 
33 typedef int (*get_static_t)(cpumask_t *cpumask, int interval,
34 			    unsigned long voltage, u32 *power);
35 
36 #ifdef CONFIG_CPU_THERMAL
37 /**
38  * cpufreq_cooling_register - function to create cpufreq cooling device.
39  * @policy: cpufreq policy.
40  */
41 struct thermal_cooling_device *
42 cpufreq_cooling_register(struct cpufreq_policy *policy);
43 
44 struct thermal_cooling_device *
45 cpufreq_power_cooling_register(struct cpufreq_policy *policy,
46 			       u32 capacitance, get_static_t plat_static_func);
47 
48 /**
49  * of_cpufreq_cooling_register - create cpufreq cooling device based on DT.
50  * @np: a valid struct device_node to the cooling device device tree node.
51  * @policy: cpufreq policy.
52  */
53 #ifdef CONFIG_THERMAL_OF
54 struct thermal_cooling_device *
55 of_cpufreq_cooling_register(struct device_node *np,
56 			    struct cpufreq_policy *policy);
57 
58 struct thermal_cooling_device *
59 of_cpufreq_power_cooling_register(struct cpufreq_policy *policy);
60 #else
61 static inline struct thermal_cooling_device *
62 of_cpufreq_cooling_register(struct device_node *np,
63 			    struct cpufreq_policy *policy)
64 {
65 	return ERR_PTR(-ENOSYS);
66 }
67 
68 static inline struct thermal_cooling_device *
69 of_cpufreq_power_cooling_register(struct cpufreq_policy *policy)
70 {
71 	return NULL;
72 }
73 #endif
74 
75 /**
76  * cpufreq_cooling_unregister - function to remove cpufreq cooling device.
77  * @cdev: thermal cooling device pointer.
78  */
79 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev);
80 
81 #else /* !CONFIG_CPU_THERMAL */
82 static inline struct thermal_cooling_device *
83 cpufreq_cooling_register(struct cpufreq_policy *policy)
84 {
85 	return ERR_PTR(-ENOSYS);
86 }
87 static inline struct thermal_cooling_device *
88 cpufreq_power_cooling_register(struct cpufreq_policy *policy,
89 			       u32 capacitance, get_static_t plat_static_func)
90 {
91 	return NULL;
92 }
93 
94 static inline struct thermal_cooling_device *
95 of_cpufreq_cooling_register(struct device_node *np,
96 			    struct cpufreq_policy *policy)
97 {
98 	return ERR_PTR(-ENOSYS);
99 }
100 
101 static inline struct thermal_cooling_device *
102 of_cpufreq_power_cooling_register(struct cpufreq_policy *policy)
103 {
104 	return NULL;
105 }
106 
107 static inline
108 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
109 {
110 	return;
111 }
112 #endif	/* CONFIG_CPU_THERMAL */
113 
114 #endif /* __CPU_COOLING_H__ */
115