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 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_BANG_BANG)
27 #define DEFAULT_THERMAL_GOVERNOR       "bang_bang"
28 #endif
29 
30 /* Initial state of a cooling device during binding */
31 #define THERMAL_NO_TARGET -1UL
32 
33 /* Init section thermal table */
34 extern struct thermal_governor *__governor_thermal_table[];
35 extern struct thermal_governor *__governor_thermal_table_end[];
36 
37 #define THERMAL_TABLE_ENTRY(table, name)			\
38 	static typeof(name) *__thermal_table_entry_##name	\
39 	__used __section("__" #table "_thermal_table") = &name
40 
41 #define THERMAL_GOVERNOR_DECLARE(name)	THERMAL_TABLE_ENTRY(governor, name)
42 
43 #define for_each_governor_table(__governor)		\
44 	for (__governor = __governor_thermal_table;	\
45 	     __governor < __governor_thermal_table_end;	\
46 	     __governor++)
47 
48 int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *),
49 			  void *);
50 
51 int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *,
52 					      void *), void *);
53 
54 int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *),
55 			      void *thermal_governor);
56 
57 struct thermal_zone_device *thermal_zone_get_by_id(int id);
58 
59 struct thermal_attr {
60 	struct device_attribute attr;
61 	char name[THERMAL_NAME_LENGTH];
62 };
63 
64 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
65 {
66 	return cdev->ops->get_requested_power && cdev->ops->state2power &&
67 		cdev->ops->power2state;
68 }
69 
70 void thermal_cdev_update(struct thermal_cooling_device *);
71 void __thermal_cdev_update(struct thermal_cooling_device *cdev);
72 
73 int get_tz_trend(struct thermal_zone_device *tz, int trip_index);
74 
75 struct thermal_instance *
76 get_thermal_instance(struct thermal_zone_device *tz,
77 		     struct thermal_cooling_device *cdev,
78 		     int trip);
79 
80 /*
81  * This structure is used to describe the behavior of
82  * a certain cooling device on a certain trip point
83  * in a certain thermal zone
84  */
85 struct thermal_instance {
86 	int id;
87 	char name[THERMAL_NAME_LENGTH];
88 	struct thermal_zone_device *tz;
89 	struct thermal_cooling_device *cdev;
90 	int trip;
91 	bool initialized;
92 	unsigned long upper;	/* Highest cooling state for this trip point */
93 	unsigned long lower;	/* Lowest cooling state for this trip point */
94 	unsigned long target;	/* expected cooling state */
95 	char attr_name[THERMAL_NAME_LENGTH];
96 	struct device_attribute attr;
97 	char weight_attr_name[THERMAL_NAME_LENGTH];
98 	struct device_attribute weight_attr;
99 	struct list_head tz_node; /* node in tz->thermal_instances */
100 	struct list_head cdev_node; /* node in cdev->thermal_instances */
101 	unsigned int weight; /* The weight of the cooling device */
102 	bool upper_no_limit;
103 };
104 
105 #define to_thermal_zone(_dev) \
106 	container_of(_dev, struct thermal_zone_device, device)
107 
108 #define to_cooling_device(_dev)	\
109 	container_of(_dev, struct thermal_cooling_device, device)
110 
111 int thermal_register_governor(struct thermal_governor *);
112 void thermal_unregister_governor(struct thermal_governor *);
113 int thermal_zone_device_set_policy(struct thermal_zone_device *, char *);
114 int thermal_build_list_of_policies(char *buf);
115 void __thermal_zone_device_update(struct thermal_zone_device *tz,
116 				  enum thermal_notify_event event);
117 
118 /* Helpers */
119 void __thermal_zone_set_trips(struct thermal_zone_device *tz);
120 int __thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
121 			    struct thermal_trip *trip);
122 int __thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
123 
124 /* sysfs I/F */
125 int thermal_zone_create_device_groups(struct thermal_zone_device *, int);
126 void thermal_zone_destroy_device_groups(struct thermal_zone_device *);
127 void thermal_cooling_device_setup_sysfs(struct thermal_cooling_device *);
128 void thermal_cooling_device_destroy_sysfs(struct thermal_cooling_device *cdev);
129 void thermal_cooling_device_stats_reinit(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
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