[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/of.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)
#define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
#define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 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"
#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;
	struct device_node *np;
	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 - structure for a thermal zone
 * @id:		unique id number for each thermal zone
 * @type:	the thermal zone device type
 * @device:	&struct device for this thermal zone
 * @trip_temp_attrs:	attributes for trip points for sysfs: trip temperature
 * @trip_type_attrs:	attributes for trip points for sysfs: trip type
 * @trip_hyst_attrs:	attributes for trip points for sysfs: trip hysteresis
 * @devdata:	private pointer for device private data
 * @trips:	number of trip points the thermal zone supports
 * @passive_delay:	number of milliseconds to wait between polls when
 *			performing passive cooling.  Currenty only used by the
 *			step-wise governor
 * @polling_delay:	number of milliseconds to wait between polls when
 *			checking whether trip points have been crossed (0 for
 *			interrupt driven systems)
 * @temperature:	current temperature.  This is only for core code,
 *			drivers should use thermal_zone_get_temp() to get the
 *			current temperature
 * @last_temperature:	previous temperature read
 * @emul_temperature:	emulated temperature when using CONFIG_THERMAL_EMULATION
 * @passive:		1 if you've crossed a passive trip point, 0 otherwise.
 *			Currenty only used by the step-wise governor.
 * @forced_passive:	If > 0, temperature at which to switch on all ACPI
 *			processor cooling devices.  Currently only used by the
 *			step-wise governor.
 * @ops:	operations this &thermal_zone_device supports
 * @tzp:	thermal zone parameters
 * @governor:	pointer to the governor for this thermal zone
 * @thermal_instances:	list of &struct thermal_instance of this thermal zone
 * @idr:	&struct idr to generate unique id for this zone's cooling
 *		devices
 * @lock:	lock to protect thermal_instances list
 * @node:	node in thermal_tz_list (in thermal_core.c)
 * @poll_queue:	delayed work for polling
 */
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;
	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;
	struct list_head node;
	struct delayed_work poll_queue;
};

/**
 * struct thermal_governor - structure that holds thermal governor information
 * @name:	name of the governor
 * @throttle:	callback called for every trip point even if temperature is
 *		below the trip point temperature
 * @governor_list:	node in thermal_governor_list (in thermal_core.c)
 */
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;

	/*
	 * This is an array of cooling state limits. Must have exactly
	 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
	 * of tuples <lower-state upper-state> of state limits. Each trip
	 * will be associated with one state limit tuple when binding.
	 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
	 * on all trips.
	 */
	unsigned long *binding_limits;
	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];

	/*
	 * a boolean to indicate if the thermal to hwmon sysfs interface
	 * is required. when no_hwmon == false, a hwmon sysfs interface
	 * will be created. when no_hwmon == true, nothing will be done
	 */
	bool no_hwmon;

	int num_tbps;	/* Number of tbp entries */
	struct thermal_bind_params *tbp;
};

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

/* Function declarations */
#ifdef CONFIG_THERMAL_OF
struct thermal_zone_device *
thermal_zone_of_sensor_register(struct device *dev, int id,
				void *data, int (*get_temp)(void *, long *),
				int (*get_trend)(void *, long *));
void thermal_zone_of_sensor_unregister(struct device *dev,
				       struct thermal_zone_device *tz);
#else
static inline struct thermal_zone_device *
thermal_zone_of_sensor_register(struct device *dev, int id,
				void *data, int (*get_temp)(void *, long *),
				int (*get_trend)(void *, long *))
{
	return NULL;
}

static inline
void thermal_zone_of_sensor_unregister(struct device *dev,
				       struct thermal_zone_device *tz)
{
}

#endif
struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
		void *, 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 *);
struct thermal_cooling_device *
thermal_of_cooling_device_register(struct device_node *np, 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
a116b5d4	28	#include <linux/of.h>
203d3d4a ZR	29	#include <linux/idr.h>
203d3d4a ZR	30	#include <linux/device.h>
b1569e99	31	#include <linux/workqueue.h>
203d3d4a	32
23064088 D	33	#define THERMAL_TRIPS_NONE -1
	34	#define THERMAL_MAX_TRIPS 12
	35	#define THERMAL_NAME_LENGTH 20
	36
57df8106 ZR	37	/* invalid cooling state */
	38	#define THERMAL_CSTATE_INVALID -1UL
	39
23064088	40	/* No upper/lower limit requirement */
57df8106	41	#define THERMAL_NO_LIMIT THERMAL_CSTATE_INVALID
23064088 D	42
	43	/* Unit conversion macros */
	44	#define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \
	45	((long)t-2732+5)/10 : ((long)t-2732-5)/10)
	46	#define CELSIUS_TO_KELVIN(t) ((t)*10+2732)
7b83fd9d AL	47	#define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
7b83fd9d AL	48	#define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
23064088 D	49
	50	/* Adding event notification support elements */
	51	#define THERMAL_GENL_FAMILY_NAME "thermal_event"
	52	#define THERMAL_GENL_VERSION 0x01
73214f5d	53	#define THERMAL_GENL_MCAST_GROUP_NAME "thermal_mc_grp"
23064088	54
1f53ef17 ZR	55	/* Default Thermal Governor */
	56	#if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
	57	#define DEFAULT_THERMAL_GOVERNOR "step_wise"
	58	#elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
	59	#define DEFAULT_THERMAL_GOVERNOR "fair_share"
	60	#elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
	61	#define DEFAULT_THERMAL_GOVERNOR "user_space"
	62	#endif
a4a15485	63
203d3d4a ZR	64	struct thermal_zone_device;
	65	struct thermal_cooling_device;
	66
6503e5df MG	67	enum thermal_device_mode {
	68	THERMAL_DEVICE_DISABLED = 0,
	69	THERMAL_DEVICE_ENABLED,
	70	};
	71
	72	enum thermal_trip_type {
	73	THERMAL_TRIP_ACTIVE = 0,
	74	THERMAL_TRIP_PASSIVE,
	75	THERMAL_TRIP_HOT,
	76	THERMAL_TRIP_CRITICAL,
	77	};
	78
601f3d42 ZR	79	enum thermal_trend {
	80	THERMAL_TREND_STABLE, /* temperature is stable */
	81	THERMAL_TREND_RAISING, /* temperature is raising */
	82	THERMAL_TREND_DROPPING, /* temperature is dropping */
d069015e ZR	83	THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
d069015e ZR	84	THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
601f3d42 ZR	85	};
601f3d42 ZR	86
23064088 D	87	/* Events supported by Thermal Netlink */
	88	enum events {
	89	THERMAL_AUX0,
	90	THERMAL_AUX1,
	91	THERMAL_CRITICAL,
	92	THERMAL_DEV_FAULT,
	93	};
	94
	95	/* attributes of thermal_genl_family */
	96	enum {
	97	THERMAL_GENL_ATTR_UNSPEC,
	98	THERMAL_GENL_ATTR_EVENT,
	99	__THERMAL_GENL_ATTR_MAX,
	100	};
	101	#define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
	102
	103	/* commands supported by the thermal_genl_family */
	104	enum {
	105	THERMAL_GENL_CMD_UNSPEC,
	106	THERMAL_GENL_CMD_EVENT,
	107	__THERMAL_GENL_CMD_MAX,
	108	};
	109	#define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
	110
203d3d4a ZR	111	struct thermal_zone_device_ops {
	112	int (bind) (struct thermal_zone_device ,
	113	struct thermal_cooling_device *);
	114	int (unbind) (struct thermal_zone_device ,
	115	struct thermal_cooling_device *);
6503e5df MG	116	int (get_temp) (struct thermal_zone_device , unsigned long *);
	117	int (get_mode) (struct thermal_zone_device ,
	118	enum thermal_device_mode *);
	119	int (set_mode) (struct thermal_zone_device ,
	120	enum thermal_device_mode);
	121	int (get_trip_type) (struct thermal_zone_device , int,
	122	enum thermal_trip_type *);
	123	int (get_trip_temp) (struct thermal_zone_device , int,
	124	unsigned long *);
c56f5c03 D	125	int (set_trip_temp) (struct thermal_zone_device , int,
c56f5c03 D	126	unsigned long);
27365a6c D	127	int (get_trip_hyst) (struct thermal_zone_device , int,
	128	unsigned long *);
	129	int (set_trip_hyst) (struct thermal_zone_device , int,
	130	unsigned long);
9ec732ff	131	int (get_crit_temp) (struct thermal_zone_device , unsigned long *);
e6e238c3	132	int (set_emul_temp) (struct thermal_zone_device , unsigned long);
601f3d42 ZR	133	int (get_trend) (struct thermal_zone_device , int,
601f3d42 ZR	134	enum thermal_trend *);
b1569e99 MG	135	int (notify) (struct thermal_zone_device , int,
b1569e99 MG	136	enum thermal_trip_type);
203d3d4a ZR	137	};
	138
	139	struct thermal_cooling_device_ops {
6503e5df MG	140	int (get_max_state) (struct thermal_cooling_device , unsigned long *);
	141	int (get_cur_state) (struct thermal_cooling_device , unsigned long *);
	142	int (set_cur_state) (struct thermal_cooling_device , unsigned long);
203d3d4a ZR	143	};
203d3d4a ZR	144
203d3d4a ZR	145	struct thermal_cooling_device {
	146	int id;
	147	char type[THERMAL_NAME_LENGTH];
	148	struct device device;
4e5e4705	149	struct device_node *np;
203d3d4a	150	void *devdata;
5b275ce2	151	const struct thermal_cooling_device_ops *ops;
ce119f83	152	bool updated; /* true if the cooling device does not need update */
f4a821ce	153	struct mutex lock; /* protect thermal_instances list */
b5e4ae62	154	struct list_head thermal_instances;
203d3d4a ZR	155	struct list_head node;
	156	};
	157
c56f5c03 D	158	struct thermal_attr {
	159	struct device_attribute attr;
	160	char name[THERMAL_NAME_LENGTH];
	161	};
	162
c708a98f JM	163	/**
	164	* struct thermal_zone_device - structure for a thermal zone
	165	* @id: unique id number for each thermal zone
	166	* @type: the thermal zone device type
	167	* @device: &struct device for this thermal zone
	168	* @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
	169	* @trip_type_attrs: attributes for trip points for sysfs: trip type
	170	* @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
	171	* @devdata: private pointer for device private data
	172	* @trips: number of trip points the thermal zone supports
	173	* @passive_delay: number of milliseconds to wait between polls when
	174	* performing passive cooling. Currenty only used by the
	175	* step-wise governor
	176	* @polling_delay: number of milliseconds to wait between polls when
	177	* checking whether trip points have been crossed (0 for
	178	* interrupt driven systems)
	179	* @temperature: current temperature. This is only for core code,
	180	* drivers should use thermal_zone_get_temp() to get the
	181	* current temperature
	182	* @last_temperature: previous temperature read
	183	* @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
	184	* @passive: 1 if you've crossed a passive trip point, 0 otherwise.
	185	* Currenty only used by the step-wise governor.
	186	* @forced_passive: If > 0, temperature at which to switch on all ACPI
	187	* processor cooling devices. Currently only used by the
	188	* step-wise governor.
	189	* @ops: operations this &thermal_zone_device supports
	190	* @tzp: thermal zone parameters
	191	* @governor: pointer to the governor for this thermal zone
	192	* @thermal_instances: list of &struct thermal_instance of this thermal zone
	193	* @idr: &struct idr to generate unique id for this zone's cooling
	194	* devices
	195	* @lock: lock to protect thermal_instances list
	196	* @node: node in thermal_tz_list (in thermal_core.c)
	197	* @poll_queue: delayed work for polling
	198	*/
203d3d4a ZR	199	struct thermal_zone_device {
	200	int id;
	201	char type[THERMAL_NAME_LENGTH];
	202	struct device device;
c56f5c03 D	203	struct thermal_attr *trip_temp_attrs;
c56f5c03 D	204	struct thermal_attr *trip_type_attrs;
27365a6c	205	struct thermal_attr *trip_hyst_attrs;
203d3d4a ZR	206	void *devdata;
203d3d4a ZR	207	int trips;
b1569e99 MG	208	int passive_delay;
b1569e99 MG	209	int polling_delay;
601f3d42	210	int temperature;
b1569e99	211	int last_temperature;
e6e238c3	212	int emul_temperature;
908b9fb7	213	int passive;
03a971a2	214	unsigned int forced_passive;
4e5e4705	215	struct thermal_zone_device_ops *ops;
ef873947	216	const struct thermal_zone_params *tzp;
a4a15485	217	struct thermal_governor *governor;
2d374139	218	struct list_head thermal_instances;
203d3d4a	219	struct idr idr;
c708a98f	220	struct mutex lock;
203d3d4a	221	struct list_head node;
b1569e99	222	struct delayed_work poll_queue;
203d3d4a	223	};
4cb18728	224
c708a98f JM	225	/**
	226	* struct thermal_governor - structure that holds thermal governor information
	227	* @name: name of the governor
	228	* @throttle: callback called for every trip point even if temperature is
	229	* below the trip point temperature
	230	* @governor_list: node in thermal_governor_list (in thermal_core.c)
	231	*/
a4a15485 D	232	struct thermal_governor {
	233	char name[THERMAL_NAME_LENGTH];
	234	int (throttle)(struct thermal_zone_device tz, int trip);
	235	struct list_head governor_list;
a4a15485 D	236	};
a4a15485 D	237
ef873947 D	238	/* Structure that holds binding parameters for a zone */
	239	struct thermal_bind_params {
	240	struct thermal_cooling_device *cdev;
	241
	242	/*
	243	* This is a measure of 'how effectively these devices can
	244	* cool 'this' thermal zone. The shall be determined by platform
	245	* characterization. This is on a 'percentage' scale.
	246	* See Documentation/thermal/sysfs-api.txt for more information.
	247	*/
	248	int weight;
	249
	250	/*
	251	* This is a bit mask that gives the binding relation between this
	252	* thermal zone and cdev, for a particular trip point.
	253	* See Documentation/thermal/sysfs-api.txt for more information.
	254	*/
	255	int trip_mask;
a8892d83 EV	256
	257	/*
	258	* This is an array of cooling state limits. Must have exactly
	259	* 2 * thermal_zone.number_of_trip_points. It is an array consisting
	260	* of tuples <lower-state upper-state> of state limits. Each trip
	261	* will be associated with one state limit tuple when binding.
	262	* A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
	263	* on all trips.
	264	*/
	265	unsigned long *binding_limits;
ef873947 D	266	int (match) (struct thermal_zone_device tz,
	267	struct thermal_cooling_device *cdev);
	268	};
	269
	270	/* Structure to define Thermal Zone parameters */
	271	struct thermal_zone_params {
a4a15485	272	char governor_name[THERMAL_NAME_LENGTH];
ccba4ffd EV	273
	274	/*
	275	* a boolean to indicate if the thermal to hwmon sysfs interface
	276	* is required. when no_hwmon == false, a hwmon sysfs interface
	277	* will be created. when no_hwmon == true, nothing will be done
	278	*/
	279	bool no_hwmon;
	280
ef873947 D	281	int num_tbps; /* Number of tbp entries */
	282	struct thermal_bind_params *tbp;
	283	};
	284
4cb18728 D	285	struct thermal_genl_event {
	286	u32 orig;
	287	enum events event;
	288	};
203d3d4a	289
23064088	290	/* Function declarations */
4e5e4705 EV	291	#ifdef CONFIG_THERMAL_OF
	292	struct thermal_zone_device *
	293	thermal_zone_of_sensor_register(struct device *dev, int id,
	294	void data, int (get_temp)(void , long ),
	295	int (get_trend)(void , long *));
	296	void thermal_zone_of_sensor_unregister(struct device *dev,
	297	struct thermal_zone_device *tz);
	298	#else
	299	static inline struct thermal_zone_device *
	300	thermal_zone_of_sensor_register(struct device *dev, int id,
	301	void data, int (get_temp)(void , long ),
	302	int (get_trend)(void , long *))
	303	{
	304	return NULL;
	305	}
	306
	307	static inline
	308	void thermal_zone_of_sensor_unregister(struct device *dev,
	309	struct thermal_zone_device *tz)
	310	{
	311	}
	312
	313	#endif
4b1bf587	314	struct thermal_zone_device thermal_zone_device_register(const char , int, int,
4e5e4705	315	void , struct thermal_zone_device_ops ,
50125a9b	316	const struct thermal_zone_params *, int, int);
203d3d4a ZR	317	void thermal_zone_device_unregister(struct thermal_zone_device *);
	318
	319	int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
9d99842f ZR	320	struct thermal_cooling_device *,
9d99842f ZR	321	unsigned long, unsigned long);
203d3d4a ZR	322	int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
203d3d4a ZR	323	struct thermal_cooling_device *);
b1569e99	324	void thermal_zone_device_update(struct thermal_zone_device *);
23064088	325
203d3d4a	326	struct thermal_cooling_device thermal_cooling_device_register(char , void *,
5b275ce2	327	const struct thermal_cooling_device_ops *);
a116b5d4 EV	328	struct thermal_cooling_device *
	329	thermal_of_cooling_device_register(struct device_node np, char , void *,
	330	const struct thermal_cooling_device_ops *);
203d3d4a	331	void thermal_cooling_device_unregister(struct thermal_cooling_device *);
63c4d919	332	struct thermal_zone_device thermal_zone_get_zone_by_name(const char name);
837b26bb	333	int thermal_zone_get_temp(struct thermal_zone_device tz, unsigned long temp);
af06216a	334
9b4298a0 D	335	int get_tz_trend(struct thermal_zone_device *, int);
	336	struct thermal_instance get_thermal_instance(struct thermal_zone_device ,
	337	struct thermal_cooling_device *, int);
dc765482	338	void thermal_cdev_update(struct thermal_cooling_device *);
7b73c993	339	void thermal_notify_framework(struct thermal_zone_device *, int);
a4a15485	340
af06216a	341	#ifdef CONFIG_NET
8ab3e6a0 EV	342	extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
8ab3e6a0 EV	343	enum events event);
af06216a	344	#else
f8b58705	345	static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
8ab3e6a0	346	enum events event)
af06216a RW	347	{
	348	return 0;
	349	}
	350	#endif
203d3d4a	351
a0dd25b2	352	#endif /* __THERMAL_H__ */