blob: c35778960a9cb40b52abed3ddfc9c8dae758cd88 [file] [log] [blame]
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301/*
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
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040027#include <linux/of.h>
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053028#include <linux/thermal.h>
Eduardo Valentin198f38f2013-04-24 23:10:28 +080029#include <linux/cpumask.h>
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053030
Viresh Kumar4d753aa2017-04-25 15:57:14 +053031struct cpufreq_policy;
32
Javi Merinoc36cf072015-02-26 19:00:29 +000033typedef int (*get_static_t)(cpumask_t *cpumask, int interval,
34 unsigned long voltage, u32 *power);
35
Zhang Ruibbf7fc82013-03-26 23:57:01 +080036#ifdef CONFIG_CPU_THERMAL
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053037/**
38 * cpufreq_cooling_register - function to create cpufreq cooling device.
Viresh Kumar4d753aa2017-04-25 15:57:14 +053039 * @policy: cpufreq policy.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053040 */
Eduardo Valentind44ada52013-04-17 17:12:23 +000041struct thermal_cooling_device *
Viresh Kumar4d753aa2017-04-25 15:57:14 +053042cpufreq_cooling_register(struct cpufreq_policy *policy);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053043
44/**
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040045 * 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.
Viresh Kumar4d753aa2017-04-25 15:57:14 +053047 * @policy: cpufreq policy.
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040048 */
49#ifdef CONFIG_THERMAL_OF
50struct thermal_cooling_device *
51of_cpufreq_cooling_register(struct device_node *np,
Viresh Kumar4d753aa2017-04-25 15:57:14 +053052 struct cpufreq_policy *policy);
Javi Merinoc36cf072015-02-26 19:00:29 +000053
54struct thermal_cooling_device *
Viresh Kumarf5f263f2017-12-05 11:02:43 +053055of_cpufreq_power_cooling_register(struct cpufreq_policy *policy);
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040056#else
57static inline struct thermal_cooling_device *
58of_cpufreq_cooling_register(struct device_node *np,
Viresh Kumar4d753aa2017-04-25 15:57:14 +053059 struct cpufreq_policy *policy)
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040060{
Javi Merino503ccc3f2014-12-17 11:11:24 +000061 return ERR_PTR(-ENOSYS);
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040062}
Javi Merinoc36cf072015-02-26 19:00:29 +000063
64static inline struct thermal_cooling_device *
Viresh Kumarf5f263f2017-12-05 11:02:43 +053065of_cpufreq_power_cooling_register(struct cpufreq_policy *policy)
Javi Merinoc36cf072015-02-26 19:00:29 +000066{
67 return NULL;
68}
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040069#endif
70
71/**
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053072 * cpufreq_cooling_unregister - function to remove cpufreq cooling device.
73 * @cdev: thermal cooling device pointer.
74 */
75void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev);
Zhang Rui57df8102013-02-08 14:52:06 +080076
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053077#else /* !CONFIG_CPU_THERMAL */
Eduardo Valentind44ada52013-04-17 17:12:23 +000078static inline struct thermal_cooling_device *
Viresh Kumar4d753aa2017-04-25 15:57:14 +053079cpufreq_cooling_register(struct cpufreq_policy *policy)
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053080{
Javi Merino503ccc3f2014-12-17 11:11:24 +000081 return ERR_PTR(-ENOSYS);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053082}
Javi Merinoc36cf072015-02-26 19:00:29 +000083
84static inline struct thermal_cooling_device *
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040085of_cpufreq_cooling_register(struct device_node *np,
Viresh Kumar4d753aa2017-04-25 15:57:14 +053086 struct cpufreq_policy *policy)
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040087{
Javi Merino503ccc3f2014-12-17 11:11:24 +000088 return ERR_PTR(-ENOSYS);
Eduardo Valentin39d99cf2013-09-12 19:26:45 -040089}
Javi Merinoc36cf072015-02-26 19:00:29 +000090
91static inline struct thermal_cooling_device *
Viresh Kumarf5f263f2017-12-05 11:02:43 +053092of_cpufreq_power_cooling_register(struct cpufreq_policy *policy)
Javi Merinoc36cf072015-02-26 19:00:29 +000093{
94 return NULL;
95}
96
Eduardo Valentind44ada52013-04-17 17:12:23 +000097static inline
98void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053099{
100 return;
101}
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530102#endif /* CONFIG_CPU_THERMAL */
103
104#endif /* __CPU_COOLING_H__ */