xref: /linux-6.15/include/linux/cpu_cooling.h (revision ba0966da)
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 /**
45  * of_cpufreq_cooling_register - create cpufreq cooling device based on DT.
46  * @np: a valid struct device_node to the cooling device device tree node.
47  * @policy: cpufreq policy.
48  */
49 #ifdef CONFIG_THERMAL_OF
50 struct thermal_cooling_device *
51 of_cpufreq_cooling_register(struct device_node *np,
52 			    struct cpufreq_policy *policy);
53 
54 struct thermal_cooling_device *
55 of_cpufreq_power_cooling_register(struct cpufreq_policy *policy);
56 #else
57 static inline struct thermal_cooling_device *
58 of_cpufreq_cooling_register(struct device_node *np,
59 			    struct cpufreq_policy *policy)
60 {
61 	return ERR_PTR(-ENOSYS);
62 }
63 
64 static inline struct thermal_cooling_device *
65 of_cpufreq_power_cooling_register(struct cpufreq_policy *policy)
66 {
67 	return NULL;
68 }
69 #endif
70 
71 /**
72  * cpufreq_cooling_unregister - function to remove cpufreq cooling device.
73  * @cdev: thermal cooling device pointer.
74  */
75 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev);
76 
77 #else /* !CONFIG_CPU_THERMAL */
78 static inline struct thermal_cooling_device *
79 cpufreq_cooling_register(struct cpufreq_policy *policy)
80 {
81 	return ERR_PTR(-ENOSYS);
82 }
83 
84 static inline struct thermal_cooling_device *
85 of_cpufreq_cooling_register(struct device_node *np,
86 			    struct cpufreq_policy *policy)
87 {
88 	return ERR_PTR(-ENOSYS);
89 }
90 
91 static inline struct thermal_cooling_device *
92 of_cpufreq_power_cooling_register(struct cpufreq_policy *policy)
93 {
94 	return NULL;
95 }
96 
97 static inline
98 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
99 {
100 	return;
101 }
102 #endif	/* CONFIG_CPU_THERMAL */
103 
104 #endif /* __CPU_COOLING_H__ */
105