[deliverable/linux.git] / include / linux / thermal.h

/*
 *  thermal.h  ($Revision: 0 $)
 *
 *  Copyright (C) 2008  Intel Corp
 *  Copyright (C) 2008  Zhang Rui <rui.zhang@intel.com>
 *  Copyright (C) 2008  Sujith Thomas <sujith.thomas@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#ifndef __THERMAL_H__
#define __THERMAL_H__

#include <linux/idr.h>
#include <linux/device.h>
#include <linux/workqueue.h>

struct thermal_zone_device;
struct thermal_cooling_device;

enum thermal_device_mode {
	THERMAL_DEVICE_DISABLED = 0,
	THERMAL_DEVICE_ENABLED,
};

enum thermal_trip_type {
	THERMAL_TRIP_ACTIVE = 0,
	THERMAL_TRIP_PASSIVE,
	THERMAL_TRIP_HOT,
	THERMAL_TRIP_CRITICAL,
};

enum thermal_trend {
	THERMAL_TREND_STABLE, /* temperature is stable */
	THERMAL_TREND_RAISING, /* temperature is raising */
	THERMAL_TREND_DROPPING, /* temperature is dropping */
};

struct thermal_zone_device_ops {
	int (*bind) (struct thermal_zone_device *,
		     struct thermal_cooling_device *);
	int (*unbind) (struct thermal_zone_device *,
		       struct thermal_cooling_device *);
	int (*get_temp) (struct thermal_zone_device *, unsigned long *);
	int (*get_mode) (struct thermal_zone_device *,
			 enum thermal_device_mode *);
	int (*set_mode) (struct thermal_zone_device *,
		enum thermal_device_mode);
	int (*get_trip_type) (struct thermal_zone_device *, int,
		enum thermal_trip_type *);
	int (*get_trip_temp) (struct thermal_zone_device *, int,
			      unsigned long *);
	int (*set_trip_temp) (struct thermal_zone_device *, int,
			      unsigned long);
	int (*get_trip_hyst) (struct thermal_zone_device *, int,
			      unsigned long *);
	int (*set_trip_hyst) (struct thermal_zone_device *, int,
			      unsigned long);
	int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
	int (*get_trend) (struct thermal_zone_device *, int,
			  enum thermal_trend *);
	int (*notify) (struct thermal_zone_device *, int,
		       enum thermal_trip_type);
};

struct thermal_cooling_device_ops {
	int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
	int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
	int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
};

#define THERMAL_NO_LIMIT -1UL /* no upper/lower limit requirement */

#define THERMAL_TRIPS_NONE -1
#define THERMAL_MAX_TRIPS 12
#define THERMAL_NAME_LENGTH 20
struct thermal_cooling_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
	void *devdata;
	const struct thermal_cooling_device_ops *ops;
	struct list_head node;
};

#define KELVIN_TO_CELSIUS(t)	(long)(((long)t-2732 >= 0) ?	\
				((long)t-2732+5)/10 : ((long)t-2732-5)/10)
#define CELSIUS_TO_KELVIN(t)	((t)*10+2732)

struct thermal_attr {
	struct device_attribute attr;
	char name[THERMAL_NAME_LENGTH];
};

struct thermal_zone_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
	struct thermal_attr *trip_temp_attrs;
	struct thermal_attr *trip_type_attrs;
	struct thermal_attr *trip_hyst_attrs;
	void *devdata;
	int trips;
	int passive_delay;
	int polling_delay;
	int temperature;
	int last_temperature;
	bool passive;
	unsigned int forced_passive;
	const struct thermal_zone_device_ops *ops;
	struct list_head thermal_instances;
	struct idr idr;
	struct mutex lock; /* protect thermal_instances list */
	struct list_head node;
	struct delayed_work poll_queue;
};
/* Adding event notification support elements */
#define THERMAL_GENL_FAMILY_NAME                "thermal_event"
#define THERMAL_GENL_VERSION                    0x01
#define THERMAL_GENL_MCAST_GROUP_NAME           "thermal_mc_group"

enum events {
	THERMAL_AUX0,
	THERMAL_AUX1,
	THERMAL_CRITICAL,
	THERMAL_DEV_FAULT,
};

struct thermal_genl_event {
	u32 orig;
	enum events event;
};
/* attributes of thermal_genl_family */
enum {
	THERMAL_GENL_ATTR_UNSPEC,
	THERMAL_GENL_ATTR_EVENT,
	__THERMAL_GENL_ATTR_MAX,
};
#define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)

/* commands supported by the thermal_genl_family */
enum {
	THERMAL_GENL_CMD_UNSPEC,
	THERMAL_GENL_CMD_EVENT,
	__THERMAL_GENL_CMD_MAX,
};
#define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)

struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
		void *, const struct thermal_zone_device_ops *, int, int);
void thermal_zone_device_unregister(struct thermal_zone_device *);

int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
				     struct thermal_cooling_device *,
				     unsigned long, unsigned long);
int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
				       struct thermal_cooling_device *);
void thermal_zone_device_update(struct thermal_zone_device *);
struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
		const struct thermal_cooling_device_ops *);
void thermal_cooling_device_unregister(struct thermal_cooling_device *);

#ifdef CONFIG_NET
extern int thermal_generate_netlink_event(u32 orig, enum events event);
#else
static inline int thermal_generate_netlink_event(u32 orig, enum events event)
{
	return 0;
}
#endif

#endif /* __THERMAL_H__ */
Commit	Line	Data
203d3d4a ZR	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>
b1569e99	30	#include <linux/workqueue.h>
203d3d4a ZR	31
	32	struct thermal_zone_device;
	33	struct thermal_cooling_device;
	34
6503e5df MG	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
601f3d42 ZR	47	enum thermal_trend {
	48	THERMAL_TREND_STABLE, /* temperature is stable */
	49	THERMAL_TREND_RAISING, /* temperature is raising */
	50	THERMAL_TREND_DROPPING, /* temperature is dropping */
	51	};
	52
203d3d4a ZR	53	struct thermal_zone_device_ops {
	54	int (bind) (struct thermal_zone_device ,
	55	struct thermal_cooling_device *);
	56	int (unbind) (struct thermal_zone_device ,
	57	struct thermal_cooling_device *);
6503e5df MG	58	int (get_temp) (struct thermal_zone_device , unsigned long *);
	59	int (get_mode) (struct thermal_zone_device ,
	60	enum thermal_device_mode *);
	61	int (set_mode) (struct thermal_zone_device ,
	62	enum thermal_device_mode);
	63	int (get_trip_type) (struct thermal_zone_device , int,
	64	enum thermal_trip_type *);
	65	int (get_trip_temp) (struct thermal_zone_device , int,
	66	unsigned long *);
c56f5c03 D	67	int (set_trip_temp) (struct thermal_zone_device , int,
c56f5c03 D	68	unsigned long);
27365a6c D	69	int (get_trip_hyst) (struct thermal_zone_device , int,
	70	unsigned long *);
	71	int (set_trip_hyst) (struct thermal_zone_device , int,
	72	unsigned long);
9ec732ff	73	int (get_crit_temp) (struct thermal_zone_device , unsigned long *);
601f3d42 ZR	74	int (get_trend) (struct thermal_zone_device , int,
601f3d42 ZR	75	enum thermal_trend *);
b1569e99 MG	76	int (notify) (struct thermal_zone_device , int,
b1569e99 MG	77	enum thermal_trip_type);
203d3d4a ZR	78	};
	79
	80	struct thermal_cooling_device_ops {
6503e5df MG	81	int (get_max_state) (struct thermal_cooling_device , unsigned long *);
	82	int (get_cur_state) (struct thermal_cooling_device , unsigned long *);
	83	int (set_cur_state) (struct thermal_cooling_device , unsigned long);
203d3d4a ZR	84	};
203d3d4a ZR	85
9d99842f ZR	86	#define THERMAL_NO_LIMIT -1UL /* no upper/lower limit requirement */
9d99842f ZR	87
203d3d4a	88	#define THERMAL_TRIPS_NONE -1
5f1a3f2a	89	#define THERMAL_MAX_TRIPS 12
203d3d4a ZR	90	#define THERMAL_NAME_LENGTH 20
	91	struct thermal_cooling_device {
	92	int id;
	93	char type[THERMAL_NAME_LENGTH];
	94	struct device device;
	95	void *devdata;
5b275ce2	96	const struct thermal_cooling_device_ops *ops;
203d3d4a ZR	97	struct list_head node;
	98	};
	99
041d4bbf ZR	100	#define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \
	101	((long)t-2732+5)/10 : ((long)t-2732-5)/10)
	102	#define CELSIUS_TO_KELVIN(t) ((t)*10+2732)
	103
c56f5c03 D	104	struct thermal_attr {
	105	struct device_attribute attr;
	106	char name[THERMAL_NAME_LENGTH];
	107	};
	108
203d3d4a ZR	109	struct thermal_zone_device {
	110	int id;
	111	char type[THERMAL_NAME_LENGTH];
	112	struct device device;
c56f5c03 D	113	struct thermal_attr *trip_temp_attrs;
c56f5c03 D	114	struct thermal_attr *trip_type_attrs;
27365a6c	115	struct thermal_attr *trip_hyst_attrs;
203d3d4a ZR	116	void *devdata;
203d3d4a ZR	117	int trips;
b1569e99 MG	118	int passive_delay;
b1569e99 MG	119	int polling_delay;
601f3d42	120	int temperature;
b1569e99 MG	121	int last_temperature;
b1569e99 MG	122	bool passive;
03a971a2	123	unsigned int forced_passive;
5b275ce2	124	const struct thermal_zone_device_ops *ops;
2d374139	125	struct list_head thermal_instances;
203d3d4a	126	struct idr idr;
2d374139	127	struct mutex lock; /* protect thermal_instances list */
203d3d4a	128	struct list_head node;
b1569e99	129	struct delayed_work poll_queue;
203d3d4a	130	};
4cb18728 D	131	/* Adding event notification support elements */
	132	#define THERMAL_GENL_FAMILY_NAME "thermal_event"
	133	#define THERMAL_GENL_VERSION 0x01
	134	#define THERMAL_GENL_MCAST_GROUP_NAME "thermal_mc_group"
	135
	136	enum events {
	137	THERMAL_AUX0,
	138	THERMAL_AUX1,
	139	THERMAL_CRITICAL,
	140	THERMAL_DEV_FAULT,
	141	};
	142
	143	struct thermal_genl_event {
	144	u32 orig;
	145	enum events event;
	146	};
	147	/* attributes of thermal_genl_family */
	148	enum {
	149	THERMAL_GENL_ATTR_UNSPEC,
	150	THERMAL_GENL_ATTR_EVENT,
	151	__THERMAL_GENL_ATTR_MAX,
	152	};
	153	#define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
	154
	155	/* commands supported by the thermal_genl_family */
	156	enum {
	157	THERMAL_GENL_CMD_UNSPEC,
	158	THERMAL_GENL_CMD_EVENT,
	159	__THERMAL_GENL_CMD_MAX,
	160	};
	161	#define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
203d3d4a	162
4b1bf587	163	struct thermal_zone_device thermal_zone_device_register(const char , int, int,
1b7ddb84	164	void , const struct thermal_zone_device_ops , int, int);
203d3d4a ZR	165	void thermal_zone_device_unregister(struct thermal_zone_device *);
	166
	167	int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
9d99842f ZR	168	struct thermal_cooling_device *,
9d99842f ZR	169	unsigned long, unsigned long);
203d3d4a ZR	170	int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
203d3d4a ZR	171	struct thermal_cooling_device *);
b1569e99	172	void thermal_zone_device_update(struct thermal_zone_device *);
203d3d4a	173	struct thermal_cooling_device thermal_cooling_device_register(char , void *,
5b275ce2	174	const struct thermal_cooling_device_ops *);
203d3d4a	175	void thermal_cooling_device_unregister(struct thermal_cooling_device *);
af06216a RW	176
af06216a RW	177	#ifdef CONFIG_NET
2d58d7ea	178	extern int thermal_generate_netlink_event(u32 orig, enum events event);
af06216a	179	#else
2d58d7ea	180	static inline int thermal_generate_netlink_event(u32 orig, enum events event)
af06216a RW	181	{
	182	return 0;
	183	}
	184	#endif
203d3d4a	185
a0dd25b2	186	#endif /* __THERMAL_H__ */