blob: 47b4a27e6e97c27f1d2bd6cfab895f4e36adb37c [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
32struct thermal_zone_device;
33struct thermal_cooling_device;
34
Matthew Garrett6503e5d2008-11-27 17:48:13 +000035enum thermal_device_mode {
36 THERMAL_DEVICE_DISABLED = 0,
37 THERMAL_DEVICE_ENABLED,
38};
39
40enum thermal_trip_type {
41 THERMAL_TRIP_ACTIVE = 0,
42 THERMAL_TRIP_PASSIVE,
43 THERMAL_TRIP_HOT,
44 THERMAL_TRIP_CRITICAL,
45};
46
Zhang Rui203d3d42008-01-17 15:51:08 +080047struct 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 *);
Matthew Garrett6503e5d2008-11-27 17:48:13 +000052 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 *);
Zhang, Rui9ec732f2008-04-10 16:13:10 +080061 int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
Matthew Garrettb1569e92008-12-03 17:55:32 +000062 int (*notify) (struct thermal_zone_device *, int,
63 enum thermal_trip_type);
Zhang Rui203d3d42008-01-17 15:51:08 +080064};
65
66struct thermal_cooling_device_ops {
Matthew Garrett6503e5d2008-11-27 17:48:13 +000067 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);
Zhang Rui203d3d42008-01-17 15:51:08 +080070};
71
72#define THERMAL_TRIPS_NONE -1
Krzysztof Helt5f1a3f22008-04-15 14:34:47 -070073#define THERMAL_MAX_TRIPS 12
Zhang Rui203d3d42008-01-17 15:51:08 +080074#define THERMAL_NAME_LENGTH 20
75struct thermal_cooling_device {
76 int id;
77 char type[THERMAL_NAME_LENGTH];
78 struct device device;
79 void *devdata;
Alan Cox5b275ce2010-11-11 15:27:29 +000080 const struct thermal_cooling_device_ops *ops;
Zhang Rui203d3d42008-01-17 15:51:08 +080081 struct list_head node;
82};
83
Zhang Rui041d4bb2008-01-17 15:51:19 +080084#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
Zhang Rui203d3d42008-01-17 15:51:08 +080088struct thermal_zone_device {
89 int id;
90 char type[THERMAL_NAME_LENGTH];
91 struct device device;
92 void *devdata;
93 int trips;
Matthew Garrettb1569e92008-12-03 17:55:32 +000094 int tc1;
95 int tc2;
96 int passive_delay;
97 int polling_delay;
98 int last_temperature;
99 bool passive;
Matthew Garrett03a971a2008-12-03 18:00:38 +0000100 unsigned int forced_passive;
Alan Cox5b275ce2010-11-11 15:27:29 +0000101 const struct thermal_zone_device_ops *ops;
Zhang Rui203d3d42008-01-17 15:51:08 +0800102 struct list_head cooling_devices;
103 struct idr idr;
104 struct mutex lock; /* protect cooling devices list */
105 struct list_head node;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000106 struct delayed_work poll_queue;
Zhang Rui203d3d42008-01-17 15:51:08 +0800107};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530108/* 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_group"
112
113enum events {
114 THERMAL_AUX0,
115 THERMAL_AUX1,
116 THERMAL_CRITICAL,
117 THERMAL_DEV_FAULT,
118};
119
120struct thermal_genl_event {
121 u32 orig;
122 enum events event;
123};
124/* attributes of thermal_genl_family */
125enum {
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 */
133enum {
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)
Zhang Rui203d3d42008-01-17 15:51:08 +0800139
140struct thermal_zone_device *thermal_zone_device_register(char *, int, void *,
Alan Cox5b275ce2010-11-11 15:27:29 +0000141 const struct thermal_zone_device_ops *, int tc1, int tc2,
142 int passive_freq, int polling_freq);
Zhang Rui203d3d42008-01-17 15:51:08 +0800143void thermal_zone_device_unregister(struct thermal_zone_device *);
144
145int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
146 struct thermal_cooling_device *);
147int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
148 struct thermal_cooling_device *);
Matthew Garrettb1569e92008-12-03 17:55:32 +0000149void thermal_zone_device_update(struct thermal_zone_device *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800150struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
Alan Cox5b275ce2010-11-11 15:27:29 +0000151 const struct thermal_cooling_device_ops *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800152void thermal_cooling_device_unregister(struct thermal_cooling_device *);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100153
154#ifdef CONFIG_NET
R.Durgadoss4cb18722010-10-27 03:33:29 +0530155extern int generate_netlink_event(u32 orig, enum events event);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100156#else
157static inline int generate_netlink_event(u32 orig, enum events event)
158{
159 return 0;
160}
161#endif
Zhang Rui203d3d42008-01-17 15:51:08 +0800162
Len Browna0dd25b2008-02-09 04:01:48 -0500163#endif /* __THERMAL_H__ */