blob: a386a1cbb6e1c912667ef7433ea608a003832940 [file] [log] [blame]
Zhang Rui203d3d42008-01-17 15:51:08 +08001/*
2 * thermal.h ($Revision: 0 $)
3 *
4 * Copyright (C) 2008 Intel Corp
5 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
6 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
7 *
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; version 2 of the License.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
21 *
22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23 */
24
25#ifndef __THERMAL_H__
26#define __THERMAL_H__
27
28#include <linux/idr.h>
29#include <linux/device.h>
Matthew Garrettb1569e92008-12-03 17:55:32 +000030#include <linux/workqueue.h>
Zhang Rui203d3d42008-01-17 15:51:08 +080031
Durgadoss R23064082012-09-18 11:04:52 +053032#define THERMAL_TRIPS_NONE -1
33#define THERMAL_MAX_TRIPS 12
34#define THERMAL_NAME_LENGTH 20
35
Zhang Rui57df8102013-02-08 14:52:06 +080036/* invalid cooling state */
37#define THERMAL_CSTATE_INVALID -1UL
38
Durgadoss R23064082012-09-18 11:04:52 +053039/* No upper/lower limit requirement */
Zhang Rui57df8102013-02-08 14:52:06 +080040#define THERMAL_NO_LIMIT THERMAL_CSTATE_INVALID
Durgadoss R23064082012-09-18 11:04:52 +053041
42/* Unit conversion macros */
43#define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \
44 ((long)t-2732+5)/10 : ((long)t-2732-5)/10)
45#define CELSIUS_TO_KELVIN(t) ((t)*10+2732)
46
47/* Adding event notification support elements */
48#define THERMAL_GENL_FAMILY_NAME "thermal_event"
49#define THERMAL_GENL_VERSION 0x01
Masatake YAMATO73214f52013-03-19 01:47:28 +000050#define THERMAL_GENL_MCAST_GROUP_NAME "thermal_mc_grp"
Durgadoss R23064082012-09-18 11:04:52 +053051
Zhang Rui1f53ef12012-12-12 15:31:37 +080052/* Default Thermal Governor */
53#if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
54#define DEFAULT_THERMAL_GOVERNOR "step_wise"
55#elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
56#define DEFAULT_THERMAL_GOVERNOR "fair_share"
57#elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
58#define DEFAULT_THERMAL_GOVERNOR "user_space"
59#endif
Durgadoss Ra4a15482012-09-18 11:04:57 +053060
Zhang Rui203d3d42008-01-17 15:51:08 +080061struct thermal_zone_device;
62struct thermal_cooling_device;
63
Matthew Garrett6503e5d2008-11-27 17:48:13 +000064enum thermal_device_mode {
65 THERMAL_DEVICE_DISABLED = 0,
66 THERMAL_DEVICE_ENABLED,
67};
68
69enum thermal_trip_type {
70 THERMAL_TRIP_ACTIVE = 0,
71 THERMAL_TRIP_PASSIVE,
72 THERMAL_TRIP_HOT,
73 THERMAL_TRIP_CRITICAL,
74};
75
Zhang Rui601f3d42012-06-27 09:54:33 +080076enum thermal_trend {
77 THERMAL_TREND_STABLE, /* temperature is stable */
78 THERMAL_TREND_RAISING, /* temperature is raising */
79 THERMAL_TREND_DROPPING, /* temperature is dropping */
Zhang Ruid069015e2012-11-19 15:33:51 +080080 THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
81 THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
Zhang Rui601f3d42012-06-27 09:54:33 +080082};
83
Durgadoss R23064082012-09-18 11:04:52 +053084/* Events supported by Thermal Netlink */
85enum events {
86 THERMAL_AUX0,
87 THERMAL_AUX1,
88 THERMAL_CRITICAL,
89 THERMAL_DEV_FAULT,
90};
91
92/* attributes of thermal_genl_family */
93enum {
94 THERMAL_GENL_ATTR_UNSPEC,
95 THERMAL_GENL_ATTR_EVENT,
96 __THERMAL_GENL_ATTR_MAX,
97};
98#define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
99
100/* commands supported by the thermal_genl_family */
101enum {
102 THERMAL_GENL_CMD_UNSPEC,
103 THERMAL_GENL_CMD_EVENT,
104 __THERMAL_GENL_CMD_MAX,
105};
106#define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
107
Zhang Rui203d3d42008-01-17 15:51:08 +0800108struct thermal_zone_device_ops {
109 int (*bind) (struct thermal_zone_device *,
110 struct thermal_cooling_device *);
111 int (*unbind) (struct thermal_zone_device *,
112 struct thermal_cooling_device *);
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000113 int (*get_temp) (struct thermal_zone_device *, unsigned long *);
114 int (*get_mode) (struct thermal_zone_device *,
115 enum thermal_device_mode *);
116 int (*set_mode) (struct thermal_zone_device *,
117 enum thermal_device_mode);
118 int (*get_trip_type) (struct thermal_zone_device *, int,
119 enum thermal_trip_type *);
120 int (*get_trip_temp) (struct thermal_zone_device *, int,
121 unsigned long *);
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800122 int (*set_trip_temp) (struct thermal_zone_device *, int,
123 unsigned long);
Durgadoss R27365a62012-07-25 10:10:59 +0800124 int (*get_trip_hyst) (struct thermal_zone_device *, int,
125 unsigned long *);
126 int (*set_trip_hyst) (struct thermal_zone_device *, int,
127 unsigned long);
Zhang, Rui9ec732f2008-04-10 16:13:10 +0800128 int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
Amit Daniel Kachhape6e238c2013-02-04 00:30:15 +0000129 int (*set_emul_temp) (struct thermal_zone_device *, unsigned long);
Zhang Rui601f3d42012-06-27 09:54:33 +0800130 int (*get_trend) (struct thermal_zone_device *, int,
131 enum thermal_trend *);
Matthew Garrettb1569e92008-12-03 17:55:32 +0000132 int (*notify) (struct thermal_zone_device *, int,
133 enum thermal_trip_type);
Zhang Rui203d3d42008-01-17 15:51:08 +0800134};
135
136struct thermal_cooling_device_ops {
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000137 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
138 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
139 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
Zhang Rui203d3d42008-01-17 15:51:08 +0800140};
141
Zhang Rui203d3d42008-01-17 15:51:08 +0800142struct thermal_cooling_device {
143 int id;
144 char type[THERMAL_NAME_LENGTH];
145 struct device device;
146 void *devdata;
Alan Cox5b275ce2010-11-11 15:27:29 +0000147 const struct thermal_cooling_device_ops *ops;
Zhang Ruice119f82012-06-27 14:13:04 +0800148 bool updated; /* true if the cooling device does not need update */
Zhang Ruif4a821c2012-07-24 16:56:21 +0800149 struct mutex lock; /* protect thermal_instances list */
Zhang Ruib5e4ae62012-06-27 14:11:52 +0800150 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800151 struct list_head node;
152};
153
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800154struct thermal_attr {
155 struct device_attribute attr;
156 char name[THERMAL_NAME_LENGTH];
157};
158
Zhang Rui203d3d42008-01-17 15:51:08 +0800159struct thermal_zone_device {
160 int id;
161 char type[THERMAL_NAME_LENGTH];
162 struct device device;
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800163 struct thermal_attr *trip_temp_attrs;
164 struct thermal_attr *trip_type_attrs;
Durgadoss R27365a62012-07-25 10:10:59 +0800165 struct thermal_attr *trip_hyst_attrs;
Zhang Rui203d3d42008-01-17 15:51:08 +0800166 void *devdata;
167 int trips;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000168 int passive_delay;
169 int polling_delay;
Zhang Rui601f3d42012-06-27 09:54:33 +0800170 int temperature;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000171 int last_temperature;
Amit Daniel Kachhape6e238c2013-02-04 00:30:15 +0000172 int emul_temperature;
Zhang Rui908b9fb2012-06-27 14:14:05 +0800173 int passive;
Matthew Garrett03a971a2008-12-03 18:00:38 +0000174 unsigned int forced_passive;
Alan Cox5b275ce2010-11-11 15:27:29 +0000175 const struct thermal_zone_device_ops *ops;
Durgadoss Ref873942012-09-18 11:04:55 +0530176 const struct thermal_zone_params *tzp;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530177 struct thermal_governor *governor;
Zhang Rui2d374132012-06-27 10:09:00 +0800178 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800179 struct idr idr;
Zhang Rui2d374132012-06-27 10:09:00 +0800180 struct mutex lock; /* protect thermal_instances list */
Zhang Rui203d3d42008-01-17 15:51:08 +0800181 struct list_head node;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000182 struct delayed_work poll_queue;
Zhang Rui203d3d42008-01-17 15:51:08 +0800183};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530184
Durgadoss Ra4a15482012-09-18 11:04:57 +0530185/* Structure that holds thermal governor information */
186struct thermal_governor {
187 char name[THERMAL_NAME_LENGTH];
188 int (*throttle)(struct thermal_zone_device *tz, int trip);
189 struct list_head governor_list;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530190};
191
Durgadoss Ref873942012-09-18 11:04:55 +0530192/* Structure that holds binding parameters for a zone */
193struct thermal_bind_params {
194 struct thermal_cooling_device *cdev;
195
196 /*
197 * This is a measure of 'how effectively these devices can
198 * cool 'this' thermal zone. The shall be determined by platform
199 * characterization. This is on a 'percentage' scale.
200 * See Documentation/thermal/sysfs-api.txt for more information.
201 */
202 int weight;
203
204 /*
205 * This is a bit mask that gives the binding relation between this
206 * thermal zone and cdev, for a particular trip point.
207 * See Documentation/thermal/sysfs-api.txt for more information.
208 */
209 int trip_mask;
210 int (*match) (struct thermal_zone_device *tz,
211 struct thermal_cooling_device *cdev);
212};
213
214/* Structure to define Thermal Zone parameters */
215struct thermal_zone_params {
Durgadoss Ra4a15482012-09-18 11:04:57 +0530216 char governor_name[THERMAL_NAME_LENGTH];
Durgadoss Ref873942012-09-18 11:04:55 +0530217 int num_tbps; /* Number of tbp entries */
218 struct thermal_bind_params *tbp;
219};
220
R.Durgadoss4cb18722010-10-27 03:33:29 +0530221struct thermal_genl_event {
222 u32 orig;
223 enum events event;
224};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530225
Durgadoss R23064082012-09-18 11:04:52 +0530226/* Function declarations */
Anton Vorontsov4b1bf582012-07-31 04:39:30 -0700227struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
Durgadoss R50125a92012-09-18 11:04:56 +0530228 void *, const struct thermal_zone_device_ops *,
229 const struct thermal_zone_params *, int, int);
Zhang Rui203d3d42008-01-17 15:51:08 +0800230void thermal_zone_device_unregister(struct thermal_zone_device *);
231
232int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
Zhang Rui9d998422012-06-26 16:35:57 +0800233 struct thermal_cooling_device *,
234 unsigned long, unsigned long);
Zhang Rui203d3d42008-01-17 15:51:08 +0800235int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
236 struct thermal_cooling_device *);
Matthew Garrettb1569e92008-12-03 17:55:32 +0000237void thermal_zone_device_update(struct thermal_zone_device *);
Durgadoss R23064082012-09-18 11:04:52 +0530238
Zhang Rui203d3d42008-01-17 15:51:08 +0800239struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
Alan Cox5b275ce2010-11-11 15:27:29 +0000240 const struct thermal_cooling_device_ops *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800241void thermal_cooling_device_unregister(struct thermal_cooling_device *);
Eduardo Valentin63c4d912013-04-05 12:32:28 +0000242struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
Eduardo Valentin837b26b2013-04-05 12:32:29 +0000243int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100244
Durgadoss R9b4298a2012-09-18 11:04:54 +0530245int get_tz_trend(struct thermal_zone_device *, int);
246struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
247 struct thermal_cooling_device *, int);
Durgadoss Rdc765482012-09-18 11:05:00 +0530248void thermal_cdev_update(struct thermal_cooling_device *);
Eduardo Valentin7b73c992013-04-23 21:48:14 +0000249void thermal_notify_framework(struct thermal_zone_device *, int);
Durgadoss Ra4a15482012-09-18 11:04:57 +0530250
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100251#ifdef CONFIG_NET
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000252extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
253 enum events event);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100254#else
Ezequiel Garciaf8b58702013-03-20 21:38:07 +0000255static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000256 enum events event)
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100257{
258 return 0;
259}
260#endif
Zhang Rui203d3d42008-01-17 15:51:08 +0800261
Len Browna0dd25b2008-02-09 04:01:48 -0500262#endif /* __THERMAL_H__ */