[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;
struct thermal_instance;

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);
	int (*get_requested_power)(struct thermal_cooling_device *,
				   struct thermal_zone_device *, u32 *);
	int (*state2power)(struct thermal_cooling_device *,
			   struct thermal_zone_device *, unsigned long, u32 *);
	int (*power2state)(struct thermal_cooling_device *,
			   struct thermal_zone_device *, u32, 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)
static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
{
	return cdev->ops->get_requested_power && cdev->ops->state2power &&
		cdev->ops->power2state;
}

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