xref: /linux-6.15/include/linux/cpu_cooling.h (revision 198f38f7)
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/thermal.h>
28 #include <linux/cpumask.h>
29 
30 #define CPUFREQ_COOLING_START		0
31 #define CPUFREQ_COOLING_STOP		1
32 
33 #ifdef CONFIG_CPU_THERMAL
34 /**
35  * cpufreq_cooling_register - function to create cpufreq cooling device.
36  * @clip_cpus: cpumask of cpus where the frequency constraints will happen
37  */
38 struct thermal_cooling_device *cpufreq_cooling_register(
39 		const struct cpumask *clip_cpus);
40 
41 /**
42  * cpufreq_cooling_unregister - function to remove cpufreq cooling device.
43  * @cdev: thermal cooling device pointer.
44  */
45 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev);
46 
47 unsigned long cpufreq_cooling_get_level(unsigned int, unsigned int);
48 #else /* !CONFIG_CPU_THERMAL */
49 static inline struct thermal_cooling_device *cpufreq_cooling_register(
50 	const struct cpumask *clip_cpus)
51 {
52 	return NULL;
53 }
54 static inline void cpufreq_cooling_unregister(
55 		struct thermal_cooling_device *cdev)
56 {
57 	return;
58 }
59 static inline unsigned long cpufreq_cooling_get_level(unsigned int,
60 						 unsigned int)
61 {
62 	return THERMAL_CSTATE_INVALID;
63 }
64 #endif	/* CONFIG_CPU_THERMAL */
65 
66 #endif /* __CPU_COOLING_H__ */
67