1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * thermal_core.h
4 *
5 * Copyright (C) 2012 Intel Corp
6 * Author: Durgadoss R <durgadoss.r@intel.com>
7 */
8
9 #ifndef __THERMAL_CORE_H__
10 #define __THERMAL_CORE_H__
11
12 #include <linux/device.h>
13 #include <linux/thermal.h>
14
15 #include "thermal_netlink.h"
16
17 /* Default Thermal Governor */
18 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
19 #define DEFAULT_THERMAL_GOVERNOR "step_wise"
20 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
21 #define DEFAULT_THERMAL_GOVERNOR "fair_share"
22 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
23 #define DEFAULT_THERMAL_GOVERNOR "user_space"
24 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR)
25 #define DEFAULT_THERMAL_GOVERNOR "power_allocator"
26 #endif
27
28 /* Initial state of a cooling device during binding */
29 #define THERMAL_NO_TARGET -1UL
30
31 /* Init section thermal table */
32 extern struct thermal_governor *__governor_thermal_table[];
33 extern struct thermal_governor *__governor_thermal_table_end[];
34
35 #define THERMAL_TABLE_ENTRY(table, name) \
36 static typeof(name) *__thermal_table_entry_##name \
37 __used __section("__" #table "_thermal_table") = &name
38
39 #define THERMAL_GOVERNOR_DECLARE(name) THERMAL_TABLE_ENTRY(governor, name)
40
41 #define for_each_governor_table(__governor) \
42 for (__governor = __governor_thermal_table; \
43 __governor < __governor_thermal_table_end; \
44 __governor++)
45
46 int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *),
47 void *);
48
49 int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *,
50 void *), void *);
51
52 int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *),
53 void *thermal_governor);
54
55 int __for_each_thermal_trip(struct thermal_zone_device *,
56 int (*cb)(struct thermal_trip *, void *),
57 void *);
58
59 struct thermal_zone_device *thermal_zone_get_by_id(int id);
60
61 struct thermal_attr {
62 struct device_attribute attr;
63 char name[THERMAL_NAME_LENGTH];
64 };
65
cdev_is_power_actor(struct thermal_cooling_device * cdev)66 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
67 {
68 return cdev->ops->get_requested_power && cdev->ops->state2power &&
69 cdev->ops->power2state;
70 }
71
72 void thermal_cdev_update(struct thermal_cooling_device *);
73 void __thermal_cdev_update(struct thermal_cooling_device *cdev);
74
75 int get_tz_trend(struct thermal_zone_device *tz, int trip);
76
77 struct thermal_instance *
78 get_thermal_instance(struct thermal_zone_device *tz,
79 struct thermal_cooling_device *cdev,
80 int trip);
81
82 /*
83 * This structure is used to describe the behavior of
84 * a certain cooling device on a certain trip point
85 * in a certain thermal zone
86 */
87 struct thermal_instance {
88 int id;
89 char name[THERMAL_NAME_LENGTH];
90 struct thermal_zone_device *tz;
91 struct thermal_cooling_device *cdev;
92 int trip;
93 bool initialized;
94 unsigned long upper; /* Highest cooling state for this trip point */
95 unsigned long lower; /* Lowest cooling state for this trip point */
96 unsigned long target; /* expected cooling state */
97 char attr_name[THERMAL_NAME_LENGTH];
98 struct device_attribute attr;
99 char weight_attr_name[THERMAL_NAME_LENGTH];
100 struct device_attribute weight_attr;
101 struct list_head tz_node; /* node in tz->thermal_instances */
102 struct list_head cdev_node; /* node in cdev->thermal_instances */
103 unsigned int weight; /* The weight of the cooling device */
104 };
105
106 #define to_thermal_zone(_dev) \
107 container_of(_dev, struct thermal_zone_device, device)
108
109 #define to_cooling_device(_dev) \
110 container_of(_dev, struct thermal_cooling_device, device)
111
112 int thermal_register_governor(struct thermal_governor *);
113 void thermal_unregister_governor(struct thermal_governor *);
114 int thermal_zone_device_set_policy(struct thermal_zone_device *, char *);
115 int thermal_build_list_of_policies(char *buf);
116 void __thermal_zone_device_update(struct thermal_zone_device *tz,
117 enum thermal_notify_event event);
118
119 /* Helpers */
120 void __thermal_zone_set_trips(struct thermal_zone_device *tz);
121 int __thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
122 struct thermal_trip *trip);
123 int __thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
124
125 /* sysfs I/F */
126 int thermal_zone_create_device_groups(struct thermal_zone_device *, int);
127 void thermal_zone_destroy_device_groups(struct thermal_zone_device *);
128 void thermal_cooling_device_setup_sysfs(struct thermal_cooling_device *);
129 void thermal_cooling_device_destroy_sysfs(struct thermal_cooling_device *cdev);
130 /* used only at binding time */
131 ssize_t trip_point_show(struct device *, struct device_attribute *, char *);
132 ssize_t weight_show(struct device *, struct device_attribute *, char *);
133 ssize_t weight_store(struct device *, struct device_attribute *, const char *,
134 size_t);
135
136 #ifdef CONFIG_THERMAL_STATISTICS
137 void thermal_cooling_device_stats_update(struct thermal_cooling_device *cdev,
138 unsigned long new_state);
139 #else
140 static inline void
thermal_cooling_device_stats_update(struct thermal_cooling_device * cdev,unsigned long new_state)141 thermal_cooling_device_stats_update(struct thermal_cooling_device *cdev,
142 unsigned long new_state) {}
143 #endif /* CONFIG_THERMAL_STATISTICS */
144
145 /* device tree support */
146 int thermal_zone_device_is_enabled(struct thermal_zone_device *tz);
147
148 #endif /* __THERMAL_CORE_H__ */
149