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