[linux-block.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

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

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

/* 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"
#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;
	struct module		*owner;
};

/* 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 *);

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 notify_thermal_framework(struct thermal_zone_device *, int);

int thermal_register_governor(struct thermal_governor *);
void thermal_unregister_governor(struct thermal_governor *);

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