[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>
#include <uapi/linux/thermal.h>

#define THERMAL_TRIPS_NONE	-1
#define THERMAL_MAX_TRIPS	12

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

/* No upper/lower limit requirement */
#define THERMAL_NO_LIMIT	((u32)~0)

/* Default weight of a bound cooling device */
#define THERMAL_WEIGHT_DEFAULT 0

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

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

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
 * @governor_data:	private pointer for governor data
 * @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;
	void *governor_data;
	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
 * @bind_to_tz: callback called when binding to a thermal zone.  If it
 *		returns 0, the governor is bound to the thermal zone,
 *		otherwise it fails.
 * @unbind_from_tz:	callback called when a governor is unbound from a
 *			thermal zone.
 * @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 (*bind_to_tz)(struct thermal_zone_device *tz);
	void (*unbind_from_tz)(struct thermal_zone_device *tz);
	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. It shall be determined by
	 * platform characterization. This value is relative to the
	 * rest of the weights so a cooling device whose weight is
	 * double that of another cooling device is twice as
	 * effective. 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.
 * @set_emul_temp: a pointer to a function that sets sensor emulated
 *		   temperature.
 */
struct thermal_zone_of_device_ops {
	int (*get_temp)(void *, long *);
	int (*get_trend)(void *, long *);
	int (*set_emul_temp)(void *, unsigned 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

#if IS_ENABLED(CONFIG_THERMAL)
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,
				     unsigned int);
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);
#else
static inline struct thermal_zone_device *thermal_zone_device_register(
	const char *type, int trips, int mask, void *devdata,
	struct thermal_zone_device_ops *ops,
	const struct thermal_zone_params *tzp,
	int passive_delay, int polling_delay)
{ return ERR_PTR(-ENODEV); }
static inline void thermal_zone_device_unregister(
	struct thermal_zone_device *tz)
{ }
static inline int thermal_zone_bind_cooling_device(
	struct thermal_zone_device *tz, int trip,
	struct thermal_cooling_device *cdev,
	unsigned long upper, unsigned long lower)
{ return -ENODEV; }
static inline int thermal_zone_unbind_cooling_device(
	struct thermal_zone_device *tz, int trip,
	struct thermal_cooling_device *cdev)
{ return -ENODEV; }
static inline void thermal_zone_device_update(struct thermal_zone_device *tz)
{ }
static inline struct thermal_cooling_device *
thermal_cooling_device_register(char *type, void *devdata,
	const struct thermal_cooling_device_ops *ops)
{ return ERR_PTR(-ENODEV); }
static inline struct thermal_cooling_device *
thermal_of_cooling_device_register(struct device_node *np,
	char *type, void *devdata, const struct thermal_cooling_device_ops *ops)
{ return ERR_PTR(-ENODEV); }
static inline void thermal_cooling_device_unregister(
	struct thermal_cooling_device *cdev)
{ }
static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
		const char *name)
{ return ERR_PTR(-ENODEV); }
static inline int thermal_zone_get_temp(
		struct thermal_zone_device *tz, unsigned long *temp)
{ return -ENODEV; }
static inline int get_tz_trend(struct thermal_zone_device *tz, int trip)
{ return -ENODEV; }
static inline struct thermal_instance *
get_thermal_instance(struct thermal_zone_device *tz,
	struct thermal_cooling_device *cdev, int trip)
{ return ERR_PTR(-ENODEV); }
static inline void thermal_cdev_update(struct thermal_cooling_device *cdev)
{ }
static inline void thermal_notify_framework(struct thermal_zone_device *tz,
	int trip)
{ }
#endif /* CONFIG_THERMAL */

#if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
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>
af6c9f16	32	#include <uapi/linux/thermal.h>
203d3d4a	33
23064088 D	34	#define THERMAL_TRIPS_NONE -1
23064088 D	35	#define THERMAL_MAX_TRIPS 12
23064088	36
57df8106 ZR	37	/* invalid cooling state */
	38	#define THERMAL_CSTATE_INVALID -1UL
	39
23064088	40	/* No upper/lower limit requirement */
a940cb34	41	#define THERMAL_NO_LIMIT ((u32)~0)
23064088	42
6cd9e9f6 KS	43	/* Default weight of a bound cooling device */
	44	#define THERMAL_WEIGHT_DEFAULT 0
	45
23064088 D	46	/* Unit conversion macros */
	47	#define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \
	48	((long)t-2732+5)/10 : ((long)t-2732-5)/10)
	49	#define CELSIUS_TO_KELVIN(t) ((t)*10+2732)
7b83fd9d AL	50	#define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
7b83fd9d AL	51	#define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
77e337c6 AL	52	#define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
77e337c6 AL	53	#define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732)
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
203d3d4a ZR	87	struct thermal_zone_device_ops {
	88	int (bind) (struct thermal_zone_device ,
	89	struct thermal_cooling_device *);
	90	int (unbind) (struct thermal_zone_device ,
	91	struct thermal_cooling_device *);
6503e5df MG	92	int (get_temp) (struct thermal_zone_device , unsigned long *);
	93	int (get_mode) (struct thermal_zone_device ,
	94	enum thermal_device_mode *);
	95	int (set_mode) (struct thermal_zone_device ,
	96	enum thermal_device_mode);
	97	int (get_trip_type) (struct thermal_zone_device , int,
	98	enum thermal_trip_type *);
	99	int (get_trip_temp) (struct thermal_zone_device , int,
	100	unsigned long *);
c56f5c03 D	101	int (set_trip_temp) (struct thermal_zone_device , int,
c56f5c03 D	102	unsigned long);
27365a6c D	103	int (get_trip_hyst) (struct thermal_zone_device , int,
	104	unsigned long *);
	105	int (set_trip_hyst) (struct thermal_zone_device , int,
	106	unsigned long);
9ec732ff	107	int (get_crit_temp) (struct thermal_zone_device , unsigned long *);
e6e238c3	108	int (set_emul_temp) (struct thermal_zone_device , unsigned long);
601f3d42 ZR	109	int (get_trend) (struct thermal_zone_device , int,
601f3d42 ZR	110	enum thermal_trend *);
b1569e99 MG	111	int (notify) (struct thermal_zone_device , int,
b1569e99 MG	112	enum thermal_trip_type);
203d3d4a ZR	113	};
	114
	115	struct thermal_cooling_device_ops {
6503e5df MG	116	int (get_max_state) (struct thermal_cooling_device , unsigned long *);
	117	int (get_cur_state) (struct thermal_cooling_device , unsigned long *);
	118	int (set_cur_state) (struct thermal_cooling_device , unsigned long);
203d3d4a ZR	119	};
203d3d4a ZR	120
203d3d4a ZR	121	struct thermal_cooling_device {
	122	int id;
	123	char type[THERMAL_NAME_LENGTH];
	124	struct device device;
4e5e4705	125	struct device_node *np;
203d3d4a	126	void *devdata;
5b275ce2	127	const struct thermal_cooling_device_ops *ops;
ce119f83	128	bool updated; /* true if the cooling device does not need update */
f4a821ce	129	struct mutex lock; /* protect thermal_instances list */
b5e4ae62	130	struct list_head thermal_instances;
203d3d4a ZR	131	struct list_head node;
	132	};
	133
c56f5c03 D	134	struct thermal_attr {
	135	struct device_attribute attr;
	136	char name[THERMAL_NAME_LENGTH];
	137	};
	138
c708a98f JM	139	/**
	140	* struct thermal_zone_device - structure for a thermal zone
	141	* @id: unique id number for each thermal zone
	142	* @type: the thermal zone device type
	143	* @device: &struct device for this thermal zone
	144	* @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
	145	* @trip_type_attrs: attributes for trip points for sysfs: trip type
	146	* @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
	147	* @devdata: private pointer for device private data
	148	* @trips: number of trip points the thermal zone supports
	149	* @passive_delay: number of milliseconds to wait between polls when
	150	* performing passive cooling. Currenty only used by the
	151	* step-wise governor
	152	* @polling_delay: number of milliseconds to wait between polls when
	153	* checking whether trip points have been crossed (0 for
	154	* interrupt driven systems)
	155	* @temperature: current temperature. This is only for core code,
	156	* drivers should use thermal_zone_get_temp() to get the
	157	* current temperature
	158	* @last_temperature: previous temperature read
	159	* @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
	160	* @passive: 1 if you've crossed a passive trip point, 0 otherwise.
	161	* Currenty only used by the step-wise governor.
	162	* @forced_passive: If > 0, temperature at which to switch on all ACPI
	163	* processor cooling devices. Currently only used by the
	164	* step-wise governor.
	165	* @ops: operations this &thermal_zone_device supports
	166	* @tzp: thermal zone parameters
	167	* @governor: pointer to the governor for this thermal zone
e33df1d2	168	* @governor_data: private pointer for governor data
c708a98f JM	169	* @thermal_instances: list of &struct thermal_instance of this thermal zone
	170	* @idr: &struct idr to generate unique id for this zone's cooling
	171	* devices
	172	* @lock: lock to protect thermal_instances list
	173	* @node: node in thermal_tz_list (in thermal_core.c)
	174	* @poll_queue: delayed work for polling
	175	*/
203d3d4a ZR	176	struct thermal_zone_device {
	177	int id;
	178	char type[THERMAL_NAME_LENGTH];
	179	struct device device;
c56f5c03 D	180	struct thermal_attr *trip_temp_attrs;
c56f5c03 D	181	struct thermal_attr *trip_type_attrs;
27365a6c	182	struct thermal_attr *trip_hyst_attrs;
203d3d4a ZR	183	void *devdata;
203d3d4a ZR	184	int trips;
b1569e99 MG	185	int passive_delay;
b1569e99 MG	186	int polling_delay;
601f3d42	187	int temperature;
b1569e99	188	int last_temperature;
e6e238c3	189	int emul_temperature;
908b9fb7	190	int passive;
03a971a2	191	unsigned int forced_passive;
4e5e4705	192	struct thermal_zone_device_ops *ops;
ef873947	193	const struct thermal_zone_params *tzp;
a4a15485	194	struct thermal_governor *governor;
e33df1d2	195	void *governor_data;
2d374139	196	struct list_head thermal_instances;
203d3d4a	197	struct idr idr;
c708a98f	198	struct mutex lock;
203d3d4a	199	struct list_head node;
b1569e99	200	struct delayed_work poll_queue;
203d3d4a	201	};
4cb18728	202
c708a98f JM	203	/**
	204	* struct thermal_governor - structure that holds thermal governor information
	205	* @name: name of the governor
e33df1d2 JM	206	* @bind_to_tz: callback called when binding to a thermal zone. If it
	207	* returns 0, the governor is bound to the thermal zone,
	208	* otherwise it fails.
	209	* @unbind_from_tz: callback called when a governor is unbound from a
	210	* thermal zone.
c708a98f JM	211	* @throttle: callback called for every trip point even if temperature is
	212	* below the trip point temperature
	213	* @governor_list: node in thermal_governor_list (in thermal_core.c)
	214	*/
a4a15485 D	215	struct thermal_governor {
a4a15485 D	216	char name[THERMAL_NAME_LENGTH];
e33df1d2 JM	217	int (bind_to_tz)(struct thermal_zone_device tz);
e33df1d2 JM	218	void (unbind_from_tz)(struct thermal_zone_device tz);
a4a15485 D	219	int (throttle)(struct thermal_zone_device tz, int trip);
a4a15485 D	220	struct list_head governor_list;
a4a15485 D	221	};
a4a15485 D	222
ef873947 D	223	/* Structure that holds binding parameters for a zone */
	224	struct thermal_bind_params {
	225	struct thermal_cooling_device *cdev;
	226
	227	/*
	228	* This is a measure of 'how effectively these devices can
bcdcbbc7 JM	229	* cool 'this' thermal zone. It shall be determined by
	230	* platform characterization. This value is relative to the
	231	* rest of the weights so a cooling device whose weight is
	232	* double that of another cooling device is twice as
	233	* effective. See Documentation/thermal/sysfs-api.txt for more
	234	* information.
ef873947 D	235	*/
	236	int weight;
	237
	238	/*
	239	* This is a bit mask that gives the binding relation between this
	240	* thermal zone and cdev, for a particular trip point.
	241	* See Documentation/thermal/sysfs-api.txt for more information.
	242	*/
	243	int trip_mask;
a8892d83 EV	244
	245	/*
	246	* This is an array of cooling state limits. Must have exactly
	247	* 2 * thermal_zone.number_of_trip_points. It is an array consisting
	248	* of tuples <lower-state upper-state> of state limits. Each trip
	249	* will be associated with one state limit tuple when binding.
	250	* A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
	251	* on all trips.
	252	*/
	253	unsigned long *binding_limits;
ef873947 D	254	int (match) (struct thermal_zone_device tz,
	255	struct thermal_cooling_device *cdev);
	256	};
	257
	258	/* Structure to define Thermal Zone parameters */
	259	struct thermal_zone_params {
a4a15485	260	char governor_name[THERMAL_NAME_LENGTH];
ccba4ffd EV	261
	262	/*
	263	* a boolean to indicate if the thermal to hwmon sysfs interface
	264	* is required. when no_hwmon == false, a hwmon sysfs interface
	265	* will be created. when no_hwmon == true, nothing will be done
	266	*/
	267	bool no_hwmon;
	268
ef873947 D	269	int num_tbps; /* Number of tbp entries */
	270	struct thermal_bind_params *tbp;
	271	};
	272
4cb18728 D	273	struct thermal_genl_event {
	274	u32 orig;
	275	enum events event;
	276	};
203d3d4a	277
2251aef6 EV	278	/**
	279	* struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
	280	*
	281	* Mandatory:
	282	* @get_temp: a pointer to a function that reads the sensor temperature.
	283	*
	284	* Optional:
	285	* @get_trend: a pointer to a function that reads the sensor temperature trend.
184a4bf6 LM	286	* @set_emul_temp: a pointer to a function that sets sensor emulated
184a4bf6 LM	287	* temperature.
2251aef6 EV	288	*/
	289	struct thermal_zone_of_device_ops {
	290	int (get_temp)(void , long *);
	291	int (get_trend)(void , long *);
184a4bf6	292	int (set_emul_temp)(void , unsigned long);
2251aef6 EV	293	};
2251aef6 EV	294
ad9914ac LM	295	/**
	296	* struct thermal_trip - representation of a point in temperature domain
	297	* @np: pointer to struct device_node that this trip point was created from
	298	* @temperature: temperature value in miliCelsius
	299	* @hysteresis: relative hysteresis in miliCelsius
	300	* @type: trip point type
	301	*/
	302
	303	struct thermal_trip {
	304	struct device_node *np;
	305	unsigned long int temperature;
	306	unsigned long int hysteresis;
	307	enum thermal_trip_type type;
	308	};
	309
23064088	310	/* Function declarations */
4e5e4705 EV	311	#ifdef CONFIG_THERMAL_OF
4e5e4705 EV	312	struct thermal_zone_device *
2251aef6 EV	313	thermal_zone_of_sensor_register(struct device dev, int id, void data,
2251aef6 EV	314	const struct thermal_zone_of_device_ops *ops);
4e5e4705 EV	315	void thermal_zone_of_sensor_unregister(struct device *dev,
	316	struct thermal_zone_device *tz);
	317	#else
	318	static inline struct thermal_zone_device *
2251aef6 EV	319	thermal_zone_of_sensor_register(struct device dev, int id, void data,
2251aef6 EV	320	const struct thermal_zone_of_device_ops *ops)
4e5e4705 EV	321	{
	322	return NULL;
	323	}
	324
	325	static inline
	326	void thermal_zone_of_sensor_unregister(struct device *dev,
	327	struct thermal_zone_device *tz)
	328	{
	329	}
	330
	331	#endif
12ca7188 NM	332
12ca7188 NM	333	#if IS_ENABLED(CONFIG_THERMAL)
4b1bf587	334	struct thermal_zone_device thermal_zone_device_register(const char , int, int,
4e5e4705	335	void , struct thermal_zone_device_ops ,
50125a9b	336	const struct thermal_zone_params *, int, int);
203d3d4a ZR	337	void thermal_zone_device_unregister(struct thermal_zone_device *);
	338
	339	int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
9d99842f	340	struct thermal_cooling_device *,
6cd9e9f6 KS	341	unsigned long, unsigned long,
6cd9e9f6 KS	342	unsigned int);
203d3d4a ZR	343	int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
203d3d4a ZR	344	struct thermal_cooling_device *);
b1569e99	345	void thermal_zone_device_update(struct thermal_zone_device *);
23064088	346
203d3d4a	347	struct thermal_cooling_device thermal_cooling_device_register(char , void *,
5b275ce2	348	const struct thermal_cooling_device_ops *);
a116b5d4 EV	349	struct thermal_cooling_device *
	350	thermal_of_cooling_device_register(struct device_node np, char , void *,
	351	const struct thermal_cooling_device_ops *);
203d3d4a	352	void thermal_cooling_device_unregister(struct thermal_cooling_device *);
63c4d919	353	struct thermal_zone_device thermal_zone_get_zone_by_name(const char name);
837b26bb	354	int thermal_zone_get_temp(struct thermal_zone_device tz, unsigned long temp);
af06216a	355
9b4298a0 D	356	int get_tz_trend(struct thermal_zone_device *, int);
	357	struct thermal_instance get_thermal_instance(struct thermal_zone_device ,
	358	struct thermal_cooling_device *, int);
dc765482	359	void thermal_cdev_update(struct thermal_cooling_device *);
7b73c993	360	void thermal_notify_framework(struct thermal_zone_device *, int);
12ca7188 NM	361	#else
	362	static inline struct thermal_zone_device *thermal_zone_device_register(
	363	const char type, int trips, int mask, void devdata,
	364	struct thermal_zone_device_ops *ops,
	365	const struct thermal_zone_params *tzp,
	366	int passive_delay, int polling_delay)
	367	{ return ERR_PTR(-ENODEV); }
	368	static inline void thermal_zone_device_unregister(
	369	struct thermal_zone_device *tz)
	370	{ }
	371	static inline int thermal_zone_bind_cooling_device(
	372	struct thermal_zone_device *tz, int trip,
	373	struct thermal_cooling_device *cdev,
	374	unsigned long upper, unsigned long lower)
	375	{ return -ENODEV; }
	376	static inline int thermal_zone_unbind_cooling_device(
	377	struct thermal_zone_device *tz, int trip,
	378	struct thermal_cooling_device *cdev)
	379	{ return -ENODEV; }
	380	static inline void thermal_zone_device_update(struct thermal_zone_device *tz)
	381	{ }
	382	static inline struct thermal_cooling_device *
	383	thermal_cooling_device_register(char type, void devdata,
	384	const struct thermal_cooling_device_ops *ops)
	385	{ return ERR_PTR(-ENODEV); }
	386	static inline struct thermal_cooling_device *
	387	thermal_of_cooling_device_register(struct device_node *np,
	388	char type, void devdata, const struct thermal_cooling_device_ops *ops)
	389	{ return ERR_PTR(-ENODEV); }
	390	static inline void thermal_cooling_device_unregister(
	391	struct thermal_cooling_device *cdev)
	392	{ }
	393	static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
	394	const char *name)
	395	{ return ERR_PTR(-ENODEV); }
	396	static inline int thermal_zone_get_temp(
	397	struct thermal_zone_device tz, unsigned long temp)
	398	{ return -ENODEV; }
	399	static inline int get_tz_trend(struct thermal_zone_device *tz, int trip)
	400	{ return -ENODEV; }
	401	static inline struct thermal_instance *
	402	get_thermal_instance(struct thermal_zone_device *tz,
	403	struct thermal_cooling_device *cdev, int trip)
	404	{ return ERR_PTR(-ENODEV); }
	405	static inline void thermal_cdev_update(struct thermal_cooling_device *cdev)
	406	{ }
	407	static inline void thermal_notify_framework(struct thermal_zone_device *tz,
	408	int trip)
	409	{ }
	410	#endif /* CONFIG_THERMAL */
	411
	412	#if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
8ab3e6a0 EV	413	extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
8ab3e6a0 EV	414	enum events event);
af06216a	415	#else
f8b58705	416	static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
8ab3e6a0	417	enum events event)
af06216a RW	418	{
	419	return 0;
	420	}
	421	#endif
203d3d4a	422
a0dd25b2	423	#endif /* __THERMAL_H__ */