[GitHub/mt8127/android_kernel_alcatel_ttab.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>

#define THERMAL_TRIPS_NONE	-1
#define THERMAL_MAX_TRIPS	12
#define THERMAL_NAME_LENGTH	20

/* invalid cooling state */
#define THERMAL_CSTATE_INVALID -1UL

/* No upper/lower limit requirement */
#define THERMAL_NO_LIMIT	THERMAL_CSTATE_INVALID

/* Unit conversion macros */
#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)

/* 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_grp"

/* Default Thermal Governor */
#if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
#define DEFAULT_THERMAL_GOVERNOR       "step_wise"
#elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
#define DEFAULT_THERMAL_GOVERNOR       "fair_share"
#elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
#define DEFAULT_THERMAL_GOVERNOR       "user_space"
#elif defined(CONFIG_THERMAL_DEFAULT_GOV_BACKWARD_COMPATIBLE)
#define DEFAULT_THERMAL_GOVERNOR       "backward_compatible"
#endif

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 */
	THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
	THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
};

/* Events supported by Thermal Netlink */
enum events {
	THERMAL_AUX0,
	THERMAL_AUX1,
	THERMAL_CRITICAL,
	THERMAL_DEV_FAULT,
};

/* 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_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 (*set_emul_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);
};

struct thermal_cooling_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
	void *devdata;
	const struct thermal_cooling_device_ops *ops;
	bool updated; /* true if the cooling device does not need update */
	struct mutex lock; /* protect thermal_instances list */
	struct list_head thermal_instances;
	struct list_head node;
};

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;
	int emul_temperature;
	int passive;
	unsigned int forced_passive;
	const struct thermal_zone_device_ops *ops;
	const struct thermal_zone_params *tzp;
	struct thermal_governor *governor;
	struct list_head thermal_instances;
	struct idr idr;
	struct mutex lock; /* protect thermal_instances list */
	struct list_head node;
	struct delayed_work poll_queue;
};

/* Structure that holds thermal governor information */
struct thermal_governor {
	char name[THERMAL_NAME_LENGTH];
	int (*throttle)(struct thermal_zone_device *tz, int trip);
	struct list_head	governor_list;
};

/* Structure that holds binding parameters for a zone */
struct thermal_bind_params {
	struct thermal_cooling_device *cdev;

	/*
	 * This is a measure of 'how effectively these devices can
	 * cool 'this' thermal zone. The shall be determined by platform
	 * characterization. This is on a 'percentage' scale.
	 * See Documentation/thermal/sysfs-api.txt for more information.
	 */
	int weight;

	/*
	 * This is a bit mask that gives the binding relation between this
	 * thermal zone and cdev, for a particular trip point.
	 * See Documentation/thermal/sysfs-api.txt for more information.
	 */
	int trip_mask;
	int (*match) (struct thermal_zone_device *tz,
			struct thermal_cooling_device *cdev);
};

/* Structure to define Thermal Zone parameters */
struct thermal_zone_params {
	char governor_name[THERMAL_NAME_LENGTH];
	int num_tbps;	/* Number of tbp entries */
	struct thermal_bind_params *tbp;
};

struct thermal_genl_event {
	u32 orig;
	enum events event;
};

/* Function declarations */
struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
		void *, const struct thermal_zone_device_ops *,
		const struct thermal_zone_params *, 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 *);
struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);

int get_tz_trend(struct thermal_zone_device *, int);
struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
		struct thermal_cooling_device *, int);
void thermal_cdev_update(struct thermal_cooling_device *);
void thermal_notify_framework(struct thermal_zone_device *, int);

#ifdef CONFIG_NET
extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
						enum events event);
#else
static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
						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	31
23064088 D	32	#define THERMAL_TRIPS_NONE -1
	33	#define THERMAL_MAX_TRIPS 12
	34	#define THERMAL_NAME_LENGTH 20
	35
57df8106 ZR	36	/* invalid cooling state */
	37	#define THERMAL_CSTATE_INVALID -1UL
	38
23064088	39	/* No upper/lower limit requirement */
57df8106	40	#define THERMAL_NO_LIMIT THERMAL_CSTATE_INVALID
23064088 D	41
	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
73214f5d	50	#define THERMAL_GENL_MCAST_GROUP_NAME "thermal_mc_grp"
23064088	51
1f53ef17 ZR	52	/* 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"
6fa3eb70 S	59	#elif defined(CONFIG_THERMAL_DEFAULT_GOV_BACKWARD_COMPATIBLE)
6fa3eb70 S	60	#define DEFAULT_THERMAL_GOVERNOR "backward_compatible"
1f53ef17	61	#endif
a4a15485	62
203d3d4a ZR	63	struct thermal_zone_device;
	64	struct thermal_cooling_device;
	65
6503e5df MG	66	enum thermal_device_mode {
	67	THERMAL_DEVICE_DISABLED = 0,
	68	THERMAL_DEVICE_ENABLED,
	69	};
	70
	71	enum thermal_trip_type {
	72	THERMAL_TRIP_ACTIVE = 0,
	73	THERMAL_TRIP_PASSIVE,
	74	THERMAL_TRIP_HOT,
	75	THERMAL_TRIP_CRITICAL,
	76	};
	77
601f3d42 ZR	78	enum thermal_trend {
	79	THERMAL_TREND_STABLE, /* temperature is stable */
	80	THERMAL_TREND_RAISING, /* temperature is raising */
	81	THERMAL_TREND_DROPPING, /* temperature is dropping */
d069015e ZR	82	THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
d069015e ZR	83	THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
601f3d42 ZR	84	};
601f3d42 ZR	85
23064088 D	86	/* Events supported by Thermal Netlink */
	87	enum events {
	88	THERMAL_AUX0,
	89	THERMAL_AUX1,
	90	THERMAL_CRITICAL,
	91	THERMAL_DEV_FAULT,
	92	};
	93
	94	/* attributes of thermal_genl_family */
	95	enum {
	96	THERMAL_GENL_ATTR_UNSPEC,
	97	THERMAL_GENL_ATTR_EVENT,
	98	__THERMAL_GENL_ATTR_MAX,
	99	};
	100	#define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
	101
	102	/* commands supported by the thermal_genl_family */
	103	enum {
	104	THERMAL_GENL_CMD_UNSPEC,
	105	THERMAL_GENL_CMD_EVENT,
	106	__THERMAL_GENL_CMD_MAX,
	107	};
	108	#define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
	109
203d3d4a ZR	110	struct thermal_zone_device_ops {
	111	int (bind) (struct thermal_zone_device ,
	112	struct thermal_cooling_device *);
	113	int (unbind) (struct thermal_zone_device ,
	114	struct thermal_cooling_device *);
6503e5df MG	115	int (get_temp) (struct thermal_zone_device , unsigned long *);
	116	int (get_mode) (struct thermal_zone_device ,
	117	enum thermal_device_mode *);
	118	int (set_mode) (struct thermal_zone_device ,
	119	enum thermal_device_mode);
	120	int (get_trip_type) (struct thermal_zone_device , int,
	121	enum thermal_trip_type *);
	122	int (get_trip_temp) (struct thermal_zone_device , int,
	123	unsigned long *);
c56f5c03 D	124	int (set_trip_temp) (struct thermal_zone_device , int,
c56f5c03 D	125	unsigned long);
27365a6c D	126	int (get_trip_hyst) (struct thermal_zone_device , int,
	127	unsigned long *);
	128	int (set_trip_hyst) (struct thermal_zone_device , int,
	129	unsigned long);
9ec732ff	130	int (get_crit_temp) (struct thermal_zone_device , unsigned long *);
e6e238c3	131	int (set_emul_temp) (struct thermal_zone_device , unsigned long);
601f3d42 ZR	132	int (get_trend) (struct thermal_zone_device , int,
601f3d42 ZR	133	enum thermal_trend *);
b1569e99 MG	134	int (notify) (struct thermal_zone_device , int,
b1569e99 MG	135	enum thermal_trip_type);
203d3d4a ZR	136	};
	137
	138	struct thermal_cooling_device_ops {
6503e5df MG	139	int (get_max_state) (struct thermal_cooling_device , unsigned long *);
	140	int (get_cur_state) (struct thermal_cooling_device , unsigned long *);
	141	int (set_cur_state) (struct thermal_cooling_device , unsigned long);
203d3d4a ZR	142	};
203d3d4a ZR	143
203d3d4a ZR	144	struct thermal_cooling_device {
	145	int id;
	146	char type[THERMAL_NAME_LENGTH];
	147	struct device device;
	148	void *devdata;
5b275ce2	149	const struct thermal_cooling_device_ops *ops;
ce119f83	150	bool updated; /* true if the cooling device does not need update */
f4a821ce	151	struct mutex lock; /* protect thermal_instances list */
b5e4ae62	152	struct list_head thermal_instances;
203d3d4a ZR	153	struct list_head node;
	154	};
	155
c56f5c03 D	156	struct thermal_attr {
	157	struct device_attribute attr;
	158	char name[THERMAL_NAME_LENGTH];
	159	};
	160
203d3d4a ZR	161	struct thermal_zone_device {
	162	int id;
	163	char type[THERMAL_NAME_LENGTH];
	164	struct device device;
c56f5c03 D	165	struct thermal_attr *trip_temp_attrs;
c56f5c03 D	166	struct thermal_attr *trip_type_attrs;
27365a6c	167	struct thermal_attr *trip_hyst_attrs;
203d3d4a ZR	168	void *devdata;
203d3d4a ZR	169	int trips;
b1569e99 MG	170	int passive_delay;
b1569e99 MG	171	int polling_delay;
601f3d42	172	int temperature;
b1569e99	173	int last_temperature;
e6e238c3	174	int emul_temperature;
908b9fb7	175	int passive;
03a971a2	176	unsigned int forced_passive;
5b275ce2	177	const struct thermal_zone_device_ops *ops;
ef873947	178	const struct thermal_zone_params *tzp;
a4a15485	179	struct thermal_governor *governor;
2d374139	180	struct list_head thermal_instances;
203d3d4a	181	struct idr idr;
2d374139	182	struct mutex lock; /* protect thermal_instances list */
203d3d4a	183	struct list_head node;
b1569e99	184	struct delayed_work poll_queue;
203d3d4a	185	};
4cb18728	186
a4a15485 D	187	/* Structure that holds thermal governor information */
	188	struct thermal_governor {
	189	char name[THERMAL_NAME_LENGTH];
	190	int (throttle)(struct thermal_zone_device tz, int trip);
	191	struct list_head governor_list;
a4a15485 D	192	};
a4a15485 D	193
ef873947 D	194	/* Structure that holds binding parameters for a zone */
	195	struct thermal_bind_params {
	196	struct thermal_cooling_device *cdev;
	197
	198	/*
	199	* This is a measure of 'how effectively these devices can
	200	* cool 'this' thermal zone. The shall be determined by platform
	201	* characterization. This is on a 'percentage' scale.
	202	* See Documentation/thermal/sysfs-api.txt for more information.
	203	*/
	204	int weight;
	205
	206	/*
	207	* This is a bit mask that gives the binding relation between this
	208	* thermal zone and cdev, for a particular trip point.
	209	* See Documentation/thermal/sysfs-api.txt for more information.
	210	*/
	211	int trip_mask;
	212	int (match) (struct thermal_zone_device tz,
	213	struct thermal_cooling_device *cdev);
	214	};
	215
	216	/* Structure to define Thermal Zone parameters */
	217	struct thermal_zone_params {
a4a15485	218	char governor_name[THERMAL_NAME_LENGTH];
ef873947 D	219	int num_tbps; /* Number of tbp entries */
	220	struct thermal_bind_params *tbp;
	221	};
	222
4cb18728 D	223	struct thermal_genl_event {
	224	u32 orig;
	225	enum events event;
	226	};
203d3d4a	227
23064088	228	/* Function declarations */
4b1bf587	229	struct thermal_zone_device thermal_zone_device_register(const char , int, int,
50125a9b D	230	void , const struct thermal_zone_device_ops ,
50125a9b D	231	const struct thermal_zone_params *, int, int);
203d3d4a ZR	232	void thermal_zone_device_unregister(struct thermal_zone_device *);
	233
	234	int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
9d99842f ZR	235	struct thermal_cooling_device *,
9d99842f ZR	236	unsigned long, unsigned long);
203d3d4a ZR	237	int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
203d3d4a ZR	238	struct thermal_cooling_device *);
b1569e99	239	void thermal_zone_device_update(struct thermal_zone_device *);
23064088	240
203d3d4a	241	struct thermal_cooling_device thermal_cooling_device_register(char , void *,
5b275ce2	242	const struct thermal_cooling_device_ops *);
203d3d4a	243	void thermal_cooling_device_unregister(struct thermal_cooling_device *);
63c4d919	244	struct thermal_zone_device thermal_zone_get_zone_by_name(const char name);
837b26bb	245	int thermal_zone_get_temp(struct thermal_zone_device tz, unsigned long temp);
af06216a	246
9b4298a0 D	247	int get_tz_trend(struct thermal_zone_device *, int);
	248	struct thermal_instance get_thermal_instance(struct thermal_zone_device ,
	249	struct thermal_cooling_device *, int);
dc765482	250	void thermal_cdev_update(struct thermal_cooling_device *);
7b73c993	251	void thermal_notify_framework(struct thermal_zone_device *, int);
a4a15485	252
af06216a	253	#ifdef CONFIG_NET
8ab3e6a0 EV	254	extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
8ab3e6a0 EV	255	enum events event);
af06216a	256	#else
f8b58705	257	static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
8ab3e6a0	258	enum events event)
af06216a RW	259	{
	260	return 0;
	261	}
	262	#endif
203d3d4a	263
a0dd25b2	264	#endif /* __THERMAL_H__ */