1 /*
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>
30 #include <linux/workqueue.h>
31
32 struct thermal_zone_device;
33 struct thermal_cooling_device;
34
35 enum thermal_device_mode {
36 THERMAL_DEVICE_DISABLED = 0,
37 THERMAL_DEVICE_ENABLED,
38 };
39
40 enum thermal_trip_type {
41 THERMAL_TRIP_ACTIVE = 0,
42 THERMAL_TRIP_PASSIVE,
43 THERMAL_TRIP_HOT,
44 THERMAL_TRIP_CRITICAL,
45 };
46
47 struct thermal_zone_device_ops {
48 int (*bind) (struct thermal_zone_device *,
49 struct thermal_cooling_device *);
50 int (*unbind) (struct thermal_zone_device *,
51 struct thermal_cooling_device *);
52 int (*get_temp) (struct thermal_zone_device *, unsigned long *);
53 int (*get_mode) (struct thermal_zone_device *,
54 enum thermal_device_mode *);
55 int (*set_mode) (struct thermal_zone_device *,
56 enum thermal_device_mode);
57 int (*get_trip_type) (struct thermal_zone_device *, int,
58 enum thermal_trip_type *);
59 int (*get_trip_temp) (struct thermal_zone_device *, int,
60 unsigned long *);
61 int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
62 int (*notify) (struct thermal_zone_device *, int,
63 enum thermal_trip_type);
64 };
65
66 struct thermal_cooling_device_ops {
67 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
68 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
69 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
70 };
71
72 #define THERMAL_TRIPS_NONE -1
73 #define THERMAL_MAX_TRIPS 12
74 #define THERMAL_NAME_LENGTH 20
75 struct thermal_cooling_device {
76 int id;
77 char type[THERMAL_NAME_LENGTH];
78 struct device device;
79 void *devdata;
80 const struct thermal_cooling_device_ops *ops;
81 struct list_head node;
82 };
83
84 #define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \
85 ((long)t-2732+5)/10 : ((long)t-2732-5)/10)
86 #define CELSIUS_TO_KELVIN(t) ((t)*10+2732)
87
88 struct thermal_zone_device {
89 int id;
90 char type[THERMAL_NAME_LENGTH];
91 struct device device;
92 void *devdata;
93 int trips;
94 int tc1;
95 int tc2;
96 int passive_delay;
97 int polling_delay;
98 int last_temperature;
99 bool passive;
100 unsigned int forced_passive;
101 const struct thermal_zone_device_ops *ops;
102 struct list_head cooling_devices;
103 struct idr idr;
104 struct mutex lock; /* protect cooling devices list */
105 struct list_head node;
106 struct delayed_work poll_queue;
107 };
108 /* Adding event notification support elements */
109 #define THERMAL_GENL_FAMILY_NAME "thermal_event"
110 #define THERMAL_GENL_VERSION 0x01
111 #define THERMAL_GENL_MCAST_GROUP_NAME "thermal_mc_grp"
112
113 enum events {
114 THERMAL_AUX0,
115 THERMAL_AUX1,
116 THERMAL_CRITICAL,
117 THERMAL_DEV_FAULT,
118 };
119
120 struct thermal_genl_event {
121 u32 orig;
122 enum events event;
123 };
124 /* attributes of thermal_genl_family */
125 enum {
126 THERMAL_GENL_ATTR_UNSPEC,
127 THERMAL_GENL_ATTR_EVENT,
128 __THERMAL_GENL_ATTR_MAX,
129 };
130 #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
131
132 /* commands supported by the thermal_genl_family */
133 enum {
134 THERMAL_GENL_CMD_UNSPEC,
135 THERMAL_GENL_CMD_EVENT,
136 __THERMAL_GENL_CMD_MAX,
137 };
138 #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
139
140 struct thermal_zone_device *thermal_zone_device_register(char *, int, void *,
141 const struct thermal_zone_device_ops *, int tc1, int tc2,
142 int passive_freq, int polling_freq);
143 void thermal_zone_device_unregister(struct thermal_zone_device *);
144
145 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
146 struct thermal_cooling_device *);
147 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
148 struct thermal_cooling_device *);
149 void thermal_zone_device_update(struct thermal_zone_device *);
150 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
151 const struct thermal_cooling_device_ops *);
152 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
153
154 #ifdef CONFIG_NET
155 extern int thermal_generate_netlink_event(u32 orig, enum events event);
156 #else
thermal_generate_netlink_event(u32 orig,enum events event)157 static inline int thermal_generate_netlink_event(u32 orig, enum events event)
158 {
159 return 0;
160 }
161 #endif
162
163 #endif /* __THERMAL_H__ */
164