1 /* SPDX-License-Identifier: GPL-2.0 */ <<
2 /* 1 /*
3 * devfreq_cooling: Thermal cooling device imp 2 * devfreq_cooling: Thermal cooling device implementation for devices using
4 * devfreq 3 * devfreq
5 * 4 *
6 * Copyright (C) 2014-2015 ARM Limited 5 * Copyright (C) 2014-2015 ARM Limited
7 * 6 *
>> 7 * This program is free software; you can redistribute it and/or modify
>> 8 * it under the terms of the GNU General Public License version 2 as
>> 9 * published by the Free Software Foundation.
>> 10 *
>> 11 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
>> 12 * kind, whether express or implied; without even the implied warranty
>> 13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> 14 * GNU General Public License for more details.
8 */ 15 */
9 16
10 #ifndef __DEVFREQ_COOLING_H__ 17 #ifndef __DEVFREQ_COOLING_H__
11 #define __DEVFREQ_COOLING_H__ 18 #define __DEVFREQ_COOLING_H__
12 19
13 #include <linux/devfreq.h> 20 #include <linux/devfreq.h>
14 #include <linux/thermal.h> 21 #include <linux/thermal.h>
15 22
16 23
17 /** 24 /**
18 * struct devfreq_cooling_power - Devfreq cool 25 * struct devfreq_cooling_power - Devfreq cooling power ops
>> 26 * @get_static_power: Take voltage, in mV, and return the static power
>> 27 * in mW. If NULL, the static power is assumed
>> 28 * to be 0.
>> 29 * @get_dynamic_power: Take voltage, in mV, and frequency, in HZ, and
>> 30 * return the dynamic power draw in mW. If NULL,
>> 31 * a simple power model is used.
>> 32 * @dyn_power_coeff: Coefficient for the simple dynamic power model in
>> 33 * mW/(MHz mV mV).
>> 34 * If get_dynamic_power() is NULL, then the
>> 35 * dynamic power is calculated as
>> 36 * @dyn_power_coeff * frequency * voltage^2
19 * @get_real_power: When this is set, the 37 * @get_real_power: When this is set, the framework uses it to ask the
20 * device driver for the 38 * device driver for the actual power.
21 * Some devices have more 39 * Some devices have more sophisticated methods
22 * (like power counters) 40 * (like power counters) to approximate the actual power
23 * that they use. 41 * that they use.
24 * This function provides 42 * This function provides more accurate data to the
25 * thermal governor. When 43 * thermal governor. When the driver does not provide
26 * such function, framewo 44 * such function, framework just uses pre-calculated
27 * table and scale the po 45 * table and scale the power by 'utilization'
28 * (based on 'busy_time' 46 * (based on 'busy_time' and 'total_time' taken from
29 * devfreq 'last_status') 47 * devfreq 'last_status').
30 * The value returned by 48 * The value returned by this function must be lower
31 * or equal than the maxi 49 * or equal than the maximum power value
32 * for the current state 50 * for the current state
33 * (which can be found in 51 * (which can be found in power_table[state]).
34 * When this interface is 52 * When this interface is used, the power_table holds
35 * max total (static + dy 53 * max total (static + dynamic) power value for each OPP.
36 */ 54 */
37 struct devfreq_cooling_power { 55 struct devfreq_cooling_power {
>> 56 unsigned long (*get_static_power)(struct devfreq *devfreq,
>> 57 unsigned long voltage);
>> 58 unsigned long (*get_dynamic_power)(struct devfreq *devfreq,
>> 59 unsigned long freq,
>> 60 unsigned long voltage);
38 int (*get_real_power)(struct devfreq * 61 int (*get_real_power)(struct devfreq *df, u32 *power,
39 unsigned long fr 62 unsigned long freq, unsigned long voltage);
>> 63 unsigned long dyn_power_coeff;
40 }; 64 };
41 65
42 #ifdef CONFIG_DEVFREQ_THERMAL 66 #ifdef CONFIG_DEVFREQ_THERMAL
43 67
44 struct thermal_cooling_device * 68 struct thermal_cooling_device *
45 of_devfreq_cooling_register_power(struct devic 69 of_devfreq_cooling_register_power(struct device_node *np, struct devfreq *df,
46 struct devfr 70 struct devfreq_cooling_power *dfc_power);
47 struct thermal_cooling_device * 71 struct thermal_cooling_device *
48 of_devfreq_cooling_register(struct device_node 72 of_devfreq_cooling_register(struct device_node *np, struct devfreq *df);
49 struct thermal_cooling_device *devfreq_cooling 73 struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df);
50 void devfreq_cooling_unregister(struct thermal 74 void devfreq_cooling_unregister(struct thermal_cooling_device *dfc);
51 struct thermal_cooling_device * <<
52 devfreq_cooling_em_register(struct devfreq *df <<
53 struct devfreq_coo <<
54 75
55 #else /* !CONFIG_DEVFREQ_THERMAL */ 76 #else /* !CONFIG_DEVFREQ_THERMAL */
56 77
57 static inline struct thermal_cooling_device * 78 static inline struct thermal_cooling_device *
58 of_devfreq_cooling_register_power(struct devic 79 of_devfreq_cooling_register_power(struct device_node *np, struct devfreq *df,
59 struct devfr 80 struct devfreq_cooling_power *dfc_power)
60 { 81 {
61 return ERR_PTR(-EINVAL); 82 return ERR_PTR(-EINVAL);
62 } 83 }
63 84
64 static inline struct thermal_cooling_device * 85 static inline struct thermal_cooling_device *
65 of_devfreq_cooling_register(struct device_node 86 of_devfreq_cooling_register(struct device_node *np, struct devfreq *df)
66 { 87 {
67 return ERR_PTR(-EINVAL); 88 return ERR_PTR(-EINVAL);
68 } 89 }
69 90
70 static inline struct thermal_cooling_device * 91 static inline struct thermal_cooling_device *
71 devfreq_cooling_register(struct devfreq *df) 92 devfreq_cooling_register(struct devfreq *df)
72 { <<
73 return ERR_PTR(-EINVAL); <<
74 } <<
75 <<
76 static inline struct thermal_cooling_device * <<
77 devfreq_cooling_em_register(struct devfreq *df <<
78 struct devfreq_coo <<
79 { 93 {
80 return ERR_PTR(-EINVAL); 94 return ERR_PTR(-EINVAL);
81 } 95 }
82 96
83 static inline void 97 static inline void
84 devfreq_cooling_unregister(struct thermal_cool 98 devfreq_cooling_unregister(struct thermal_cooling_device *dfc)
85 { 99 {
86 } 100 }
87 101
88 #endif /* CONFIG_DEVFREQ_THERMAL */ 102 #endif /* CONFIG_DEVFREQ_THERMAL */
89 #endif /* __DEVFREQ_COOLING_H__ */ 103 #endif /* __DEVFREQ_COOLING_H__ */
90 104
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.