[mirror_ubuntu-bionic-kernel.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)
#define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
#define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_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;
};

/**
 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
 *
 * Mandatory:
 * @get_temp: a pointer to a function that reads the sensor temperature.
 *
 * Optional:
 * @get_trend: a pointer to a function that reads the sensor temperature trend.
 */
struct thermal_zone_of_device_ops {
	int (*get_temp)(void *, long *);
	int (*get_trend)(void *, long *);
};

/**
 * struct thermal_trip - representation of a point in temperature domain
 * @np: pointer to struct device_node that this trip point was created from
 * @temperature: temperature value in miliCelsius
 * @hysteresis: relative hysteresis in miliCelsius
 * @type: trip point type
 */

struct thermal_trip {
	struct device_node *np;
	unsigned long int temperature;
	unsigned long int hysteresis;
	enum thermal_trip_type type;
};

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