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