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 <amit.kachhap@linaro.org>
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#ifdef CONFIG_CPU_THERMAL
32/**
33 * cpufreq_cooling_register - function to create cpufreq cooling device.
34 * @clip_cpus: cpumask of cpus where the frequency constraints will happen
35 */
36struct thermal_cooling_device *
37cpufreq_cooling_register(const struct cpumask *clip_cpus);
38
39/**
40 * of_cpufreq_cooling_register - create cpufreq cooling device based on DT.
41 * @np: a valid struct device_node to the cooling device device tree node.
42 * @clip_cpus: cpumask of cpus where the frequency constraints will happen
43 */
44#ifdef CONFIG_THERMAL_OF
45struct thermal_cooling_device *
46of_cpufreq_cooling_register(struct device_node *np,
47			    const struct cpumask *clip_cpus);
48#else
49static inline struct thermal_cooling_device *
50of_cpufreq_cooling_register(struct device_node *np,
51			    const struct cpumask *clip_cpus)
52{
53	return ERR_PTR(-ENOSYS);
54}
55#endif
56
57/**
58 * cpufreq_cooling_unregister - function to remove cpufreq cooling device.
59 * @cdev: thermal cooling device pointer.
60 */
61void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev);
62
63unsigned long cpufreq_cooling_get_level(unsigned int cpu, unsigned int freq);
64#else /* !CONFIG_CPU_THERMAL */
65static inline struct thermal_cooling_device *
66cpufreq_cooling_register(const struct cpumask *clip_cpus)
67{
68	return ERR_PTR(-ENOSYS);
69}
70static inline struct thermal_cooling_device *
71of_cpufreq_cooling_register(struct device_node *np,
72			    const struct cpumask *clip_cpus)
73{
74	return ERR_PTR(-ENOSYS);
75}
76static inline
77void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
78{
79	return;
80}
81static inline
82unsigned long cpufreq_cooling_get_level(unsigned int cpu, unsigned int freq)
83{
84	return THERMAL_CSTATE_INVALID;
85}
86#endif	/* CONFIG_CPU_THERMAL */
87
88#endif /* __CPU_COOLING_H__ */
89