[linux-block.git] / include / linux / thermal.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  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>
 */

#ifndef __THERMAL_H__
#define __THERMAL_H__

#include <linux/of.h>
#include <linux/idr.h>
#include <linux/device.h>
#include <linux/sysfs.h>
#include <linux/workqueue.h>
#include <uapi/linux/thermal.h>

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

/* use value, which < 0K, to indicate an invalid/uninitialized temperature */
#define THERMAL_TEMP_INVALID	-274000

struct thermal_zone_device;
struct thermal_cooling_device;
struct thermal_instance;
struct thermal_attr;

enum thermal_trend {
	THERMAL_TREND_STABLE, /* temperature is stable */
	THERMAL_TREND_RAISING, /* temperature is raising */
	THERMAL_TREND_DROPPING, /* temperature is dropping */
};

/* Thermal notification reason */
enum thermal_notify_event {
	THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
	THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
	THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
	THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
	THERMAL_DEVICE_DOWN, /* Thermal device is down */
	THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
	THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
	THERMAL_TABLE_CHANGED, /* Thermal table(s) changed */
	THERMAL_EVENT_KEEP_ALIVE, /* Request for user space handler to respond */
};

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 *, int *);
	int (*set_trips) (struct thermal_zone_device *, int, int);
	int (*change_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, int *);
	int (*set_trip_temp) (struct thermal_zone_device *, int, int);
	int (*get_trip_hyst) (struct thermal_zone_device *, int, int *);
	int (*set_trip_hyst) (struct thermal_zone_device *, int, int);
	int (*get_crit_temp) (struct thermal_zone_device *, int *);
	int (*set_emul_temp) (struct thermal_zone_device *, int);
	int (*get_trend) (struct thermal_zone_device *, int,
			  enum thermal_trend *);
	void (*hot)(struct thermal_zone_device *);
	void (*critical)(struct thermal_zone_device *);
};

/**
 * struct thermal_trip - representation of a point in temperature domain
 * @temperature: temperature value in miliCelsius
 * @hysteresis: relative hysteresis in miliCelsius
 * @type: trip point type
 */
struct thermal_trip {
	int temperature;
	int hysteresis;
	enum thermal_trip_type 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 *, u32 *);
	int (*state2power)(struct thermal_cooling_device *, unsigned long, u32 *);
	int (*power2state)(struct thermal_cooling_device *, u32, unsigned long *);
};

struct thermal_cooling_device {
	int id;
	char *type;
	unsigned long max_state;
	struct device device;
	struct device_node *np;
	void *devdata;
	void *stats;
	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_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
 * @mode:		current mode of this thermal zone
 * @devdata:	private pointer for device private data
 * @trips:	an array of struct thermal_trip
 * @num_trips:	number of trip points the thermal zone supports
 * @trips_disabled;	bitmap for disabled trips
 * @passive_delay_jiffies: number of jiffies to wait between polls when
 *			performing passive cooling.
 * @polling_delay_jiffies: number of jiffies 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.
 * @prev_low_trip:	the low current temperature if you've crossed a passive
			trip point.
 * @prev_high_trip:	the above current temperature if you've crossed a
			passive trip point.
 * @need_update:	if equals 1, thermal_zone_device_update needs to be invoked.
 * @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
 * @ida:	&struct ida 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
 * @notify_event: Last notification event
 */
struct thermal_zone_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
	struct attribute_group trips_attribute_group;
	struct thermal_attr *trip_temp_attrs;
	struct thermal_attr *trip_type_attrs;
	struct thermal_attr *trip_hyst_attrs;
	enum thermal_device_mode mode;
	void *devdata;
	struct thermal_trip *trips;
	int num_trips;
	unsigned long trips_disabled;	/* bitmap for disabled trips */
	unsigned long passive_delay_jiffies;
	unsigned long polling_delay_jiffies;
	int temperature;
	int last_temperature;
	int emul_temperature;
	int passive;
	int prev_low_trip;
	int prev_high_trip;
	atomic_t need_update;
	struct thermal_zone_device_ops *ops;
	struct thermal_zone_params *tzp;
	struct thermal_governor *governor;
	void *governor_data;
	struct list_head thermal_instances;
	struct ida ida;
	struct mutex lock;
	struct list_head node;
	struct delayed_work poll_queue;
	enum thermal_notify_event notify_event;
};

/**
 * 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/driver-api/thermal/sysfs-api.rst 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/driver-api/thermal/sysfs-api.rst 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;

	/*
	 * Sustainable power (heat) that this thermal zone can dissipate in
	 * mW
	 */
	u32 sustainable_power;

	/*
	 * Proportional parameter of the PID controller when
	 * overshooting (i.e., when temperature is below the target)
	 */
	s32 k_po;

	/*
	 * Proportional parameter of the PID controller when
	 * undershooting
	 */
	s32 k_pu;

	/* Integral parameter of the PID controller */
	s32 k_i;

	/* Derivative parameter of the PID controller */
	s32 k_d;

	/* threshold below which the error is no longer accumulated */
	s32 integral_cutoff;

	/*
	 * @slope:	slope of a linear temperature adjustment curve.
	 * 		Used by thermal zone drivers.
	 */
	int slope;
	/*
	 * @offset:	offset of a linear temperature adjustment curve.
	 * 		Used by thermal zone drivers (default 0).
	 */
	int offset;
};

/* Function declarations */
#ifdef CONFIG_THERMAL_OF
struct thermal_zone_device *thermal_of_zone_register(struct device_node *sensor, int id, void *data,
						     const struct thermal_zone_device_ops *ops);

struct thermal_zone_device *devm_thermal_of_zone_register(struct device *dev, int id, void *data,
							  const struct thermal_zone_device_ops *ops);

void thermal_of_zone_unregister(struct thermal_zone_device *tz);

void devm_thermal_of_zone_unregister(struct device *dev, struct thermal_zone_device *tz);

void thermal_of_zone_unregister(struct thermal_zone_device *tz);

#else
static inline
struct thermal_zone_device *thermal_of_zone_register(struct device_node *sensor, int id, void *data,
						     const struct thermal_zone_device_ops *ops)
{
	return ERR_PTR(-ENOTSUPP);
}

static inline
struct thermal_zone_device *devm_thermal_of_zone_register(struct device *dev, int id, void *data,
							  const struct thermal_zone_device_ops *ops)
{
	return ERR_PTR(-ENOTSUPP);
}

static inline void thermal_of_zone_unregister(struct thermal_zone_device *tz)
{
}

static inline void devm_thermal_of_zone_unregister(struct device *dev,
						   struct thermal_zone_device *tz)
{
}
#endif

#ifdef CONFIG_THERMAL
struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
		void *, struct thermal_zone_device_ops *,
		struct thermal_zone_params *, int, int);

void thermal_zone_device_unregister(struct thermal_zone_device *);

struct thermal_zone_device *
thermal_zone_device_register_with_trips(const char *, struct thermal_trip *, int, int,
					void *, struct thermal_zone_device_ops *,
					struct thermal_zone_params *, int, int);

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 *,
				enum thermal_notify_event);

struct thermal_cooling_device *thermal_cooling_device_register(const char *,
		void *, const struct thermal_cooling_device_ops *);
struct thermal_cooling_device *
thermal_of_cooling_device_register(struct device_node *np, const char *, void *,
				   const struct thermal_cooling_device_ops *);
struct thermal_cooling_device *
devm_thermal_of_cooling_device_register(struct device *dev,
				struct device_node *np,
				char *type, void *devdata,
				const struct thermal_cooling_device_ops *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, int *temp);
int thermal_zone_get_slope(struct thermal_zone_device *tz);
int thermal_zone_get_offset(struct thermal_zone_device *tz);

int thermal_zone_device_enable(struct thermal_zone_device *tz);
int thermal_zone_device_disable(struct thermal_zone_device *tz);
void thermal_zone_device_critical(struct thermal_zone_device *tz);
#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,
	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 struct thermal_cooling_device *
thermal_cooling_device_register(const 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,
	const char *type, void *devdata,
	const struct thermal_cooling_device_ops *ops)
{ return ERR_PTR(-ENODEV); }
static inline struct thermal_cooling_device *
devm_thermal_of_cooling_device_register(struct device *dev,
				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, int *temp)
{ return -ENODEV; }
static inline int thermal_zone_get_slope(
		struct thermal_zone_device *tz)
{ return -ENODEV; }
static inline int thermal_zone_get_offset(
		struct thermal_zone_device *tz)
{ return -ENODEV; }

static inline int thermal_zone_device_enable(struct thermal_zone_device *tz)
{ return -ENODEV; }

static inline int thermal_zone_device_disable(struct thermal_zone_device *tz)
{ return -ENODEV; }
#endif /* CONFIG_THERMAL */

#endif /* __THERMAL_H__ */
Commit	Line	Data
7e3c0381	1	/* SPDX-License-Identifier: GPL-2.0 */
203d3d4a ZR	2	/*
	3	* thermal.h ($Revision: 0 $)
	4	*
	5	* Copyright (C) 2008 Intel Corp
	6	* Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
	7	* Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
203d3d4a ZR	8	*/
	9
	10	#ifndef __THERMAL_H__
	11	#define __THERMAL_H__
	12
a116b5d4	13	#include <linux/of.h>
203d3d4a ZR	14	#include <linux/idr.h>
203d3d4a ZR	15	#include <linux/device.h>
4d0fe749	16	#include <linux/sysfs.h>
b1569e99	17	#include <linux/workqueue.h>
af6c9f16	18	#include <uapi/linux/thermal.h>
203d3d4a	19
57df8106 ZR	20	/* invalid cooling state */
	21	#define THERMAL_CSTATE_INVALID -1UL
	22
23064088	23	/* No upper/lower limit requirement */
a940cb34	24	#define THERMAL_NO_LIMIT ((u32)~0)
23064088	25
6cd9e9f6 KS	26	/* Default weight of a bound cooling device */
	27	#define THERMAL_WEIGHT_DEFAULT 0
	28
bb431ba2 ZR	29	/* use value, which < 0K, to indicate an invalid/uninitialized temperature */
	30	#define THERMAL_TEMP_INVALID -274000
	31
203d3d4a ZR	32	struct thermal_zone_device;
203d3d4a ZR	33	struct thermal_cooling_device;
35b11d2e	34	struct thermal_instance;
c68df440	35	struct thermal_attr;
203d3d4a	36
601f3d42 ZR	37	enum thermal_trend {
	38	THERMAL_TREND_STABLE, /* temperature is stable */
	39	THERMAL_TREND_RAISING, /* temperature is raising */
	40	THERMAL_TREND_DROPPING, /* temperature is dropping */
	41	};
	42
0e70f466 SP	43	/* Thermal notification reason */
	44	enum thermal_notify_event {
	45	THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
	46	THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
	47	THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
	48	THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
	49	THERMAL_DEVICE_DOWN, /* Thermal device is down */
	50	THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
	51	THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
38e44da5	52	THERMAL_TABLE_CHANGED, /* Thermal table(s) changed */
88052319	53	THERMAL_EVENT_KEEP_ALIVE, /* Request for user space handler to respond */
0e70f466 SP	54	};
0e70f466 SP	55
203d3d4a ZR	56	struct thermal_zone_device_ops {
	57	int (bind) (struct thermal_zone_device ,
	58	struct thermal_cooling_device *);
	59	int (unbind) (struct thermal_zone_device ,
	60	struct thermal_cooling_device *);
17e8351a	61	int (get_temp) (struct thermal_zone_device , int *);
060c034a	62	int (set_trips) (struct thermal_zone_device , int, int);
f5e50bf4	63	int (change_mode) (struct thermal_zone_device ,
6503e5df MG	64	enum thermal_device_mode);
	65	int (get_trip_type) (struct thermal_zone_device , int,
	66	enum thermal_trip_type *);
17e8351a SH	67	int (get_trip_temp) (struct thermal_zone_device , int, int *);
	68	int (set_trip_temp) (struct thermal_zone_device , int, int);
	69	int (get_trip_hyst) (struct thermal_zone_device , int, int *);
	70	int (set_trip_hyst) (struct thermal_zone_device , int, int);
	71	int (get_crit_temp) (struct thermal_zone_device , int *);
	72	int (set_emul_temp) (struct thermal_zone_device , int);
601f3d42 ZR	73	int (get_trend) (struct thermal_zone_device , int,
601f3d42 ZR	74	enum thermal_trend *);
d7203eed DL	75	void (hot)(struct thermal_zone_device );
d7203eed DL	76	void (critical)(struct thermal_zone_device );
203d3d4a ZR	77	};
203d3d4a ZR	78
646274dd DL	79	/**
	80	* struct thermal_trip - representation of a point in temperature domain
	81	* @temperature: temperature value in miliCelsius
	82	* @hysteresis: relative hysteresis in miliCelsius
	83	* @type: trip point type
	84	*/
	85	struct thermal_trip {
	86	int temperature;
	87	int hysteresis;
	88	enum thermal_trip_type type;
	89	};
	90
203d3d4a	91	struct thermal_cooling_device_ops {
6503e5df MG	92	int (get_max_state) (struct thermal_cooling_device , unsigned long *);
	93	int (get_cur_state) (struct thermal_cooling_device , unsigned long *);
	94	int (set_cur_state) (struct thermal_cooling_device , unsigned long);
ecd1d2a3	95	int (get_requested_power)(struct thermal_cooling_device , u32 *);
	96	int (state2power)(struct thermal_cooling_device , unsigned long, u32 *);
	97	int (power2state)(struct thermal_cooling_device , u32, unsigned long *);
203d3d4a ZR	98	};
203d3d4a ZR	99
203d3d4a ZR	100	struct thermal_cooling_device {
203d3d4a ZR	101	int id;
58483761	102	char *type;
c408b3d1	103	unsigned long max_state;
203d3d4a	104	struct device device;
4e5e4705	105	struct device_node *np;
203d3d4a	106	void *devdata;
8ea22951	107	void *stats;
5b275ce2	108	const struct thermal_cooling_device_ops *ops;
ce119f83	109	bool updated; /* true if the cooling device does not need update */
f4a821ce	110	struct mutex lock; /* protect thermal_instances list */
b5e4ae62	111	struct list_head thermal_instances;
203d3d4a ZR	112	struct list_head node;
	113	};
	114
c708a98f JM	115	/**
	116	* struct thermal_zone_device - structure for a thermal zone
	117	* @id: unique id number for each thermal zone
	118	* @type: the thermal zone device type
	119	* @device: &struct device for this thermal zone
	120	* @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
	121	* @trip_type_attrs: attributes for trip points for sysfs: trip type
	122	* @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
cbba1d71	123	* @mode: current mode of this thermal zone
c708a98f	124	* @devdata: private pointer for device private data
fae11de5	125	* @trips: an array of struct thermal_trip
e5bfcd30	126	* @num_trips: number of trip points the thermal zone supports
81ad4276	127	* @trips_disabled; bitmap for disabled trips
17d399cd DL	128	* @passive_delay_jiffies: number of jiffies to wait between polls when
17d399cd DL	129	* performing passive cooling.
17d399cd DL	130	* @polling_delay_jiffies: number of jiffies to wait between polls when
	131	* checking whether trip points have been crossed (0 for
	132	* interrupt driven systems)
c708a98f JM	133	* @temperature: current temperature. This is only for core code,
	134	* drivers should use thermal_zone_get_temp() to get the
	135	* current temperature
	136	* @last_temperature: previous temperature read
	137	* @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
	138	* @passive: 1 if you've crossed a passive trip point, 0 otherwise.
060c034a SH	139	* @prev_low_trip: the low current temperature if you've crossed a passive
	140	trip point.
	141	* @prev_high_trip: the above current temperature if you've crossed a
	142	passive trip point.
4511f716	143	* @need_update: if equals 1, thermal_zone_device_update needs to be invoked.
c708a98f JM	144	* @ops: operations this &thermal_zone_device supports
	145	* @tzp: thermal zone parameters
	146	* @governor: pointer to the governor for this thermal zone
e33df1d2	147	* @governor_data: private pointer for governor data
c708a98f	148	* @thermal_instances: list of &struct thermal_instance of this thermal zone
b31ef828	149	* @ida: &struct ida to generate unique id for this zone's cooling
c708a98f JM	150	* devices
	151	* @lock: lock to protect thermal_instances list
	152	* @node: node in thermal_tz_list (in thermal_core.c)
	153	* @poll_queue: delayed work for polling
0e70f466	154	* @notify_event: Last notification event
c708a98f	155	*/
203d3d4a ZR	156	struct thermal_zone_device {
	157	int id;
	158	char type[THERMAL_NAME_LENGTH];
	159	struct device device;
4d0fe749	160	struct attribute_group trips_attribute_group;
c56f5c03 D	161	struct thermal_attr *trip_temp_attrs;
c56f5c03 D	162	struct thermal_attr *trip_type_attrs;
27365a6c	163	struct thermal_attr *trip_hyst_attrs;
cbba1d71	164	enum thermal_device_mode mode;
203d3d4a	165	void *devdata;
fae11de5	166	struct thermal_trip *trips;
e5bfcd30	167	int num_trips;
81ad4276	168	unsigned long trips_disabled; /* bitmap for disabled trips */
17d399cd DL	169	unsigned long passive_delay_jiffies;
17d399cd DL	170	unsigned long polling_delay_jiffies;
601f3d42	171	int temperature;
b1569e99	172	int last_temperature;
e6e238c3	173	int emul_temperature;
908b9fb7	174	int passive;
060c034a SH	175	int prev_low_trip;
060c034a SH	176	int prev_high_trip;
4511f716	177	atomic_t need_update;
4e5e4705	178	struct thermal_zone_device_ops *ops;
6b775e87	179	struct thermal_zone_params *tzp;
a4a15485	180	struct thermal_governor *governor;
e33df1d2	181	void *governor_data;
2d374139	182	struct list_head thermal_instances;
b31ef828	183	struct ida ida;
c708a98f	184	struct mutex lock;
203d3d4a	185	struct list_head node;
b1569e99	186	struct delayed_work poll_queue;
0e70f466	187	enum thermal_notify_event notify_event;
203d3d4a	188	};
4cb18728	189
c708a98f JM	190	/**
	191	* struct thermal_governor - structure that holds thermal governor information
	192	* @name: name of the governor
e33df1d2 JM	193	* @bind_to_tz: callback called when binding to a thermal zone. If it
	194	* returns 0, the governor is bound to the thermal zone,
	195	* otherwise it fails.
	196	* @unbind_from_tz: callback called when a governor is unbound from a
	197	* thermal zone.
c708a98f JM	198	* @throttle: callback called for every trip point even if temperature is
	199	* below the trip point temperature
	200	* @governor_list: node in thermal_governor_list (in thermal_core.c)
	201	*/
a4a15485 D	202	struct thermal_governor {
a4a15485 D	203	char name[THERMAL_NAME_LENGTH];
e33df1d2 JM	204	int (bind_to_tz)(struct thermal_zone_device tz);
e33df1d2 JM	205	void (unbind_from_tz)(struct thermal_zone_device tz);
a4a15485 D	206	int (throttle)(struct thermal_zone_device tz, int trip);
a4a15485 D	207	struct list_head governor_list;
a4a15485 D	208	};
a4a15485 D	209
ef873947 D	210	/* Structure that holds binding parameters for a zone */
	211	struct thermal_bind_params {
	212	struct thermal_cooling_device *cdev;
	213
	214	/*
	215	* This is a measure of 'how effectively these devices can
bcdcbbc7 JM	216	* cool 'this' thermal zone. It shall be determined by
	217	* platform characterization. This value is relative to the
	218	* rest of the weights so a cooling device whose weight is
	219	* double that of another cooling device is twice as
eaf7b460	220	* effective. See Documentation/driver-api/thermal/sysfs-api.rst for more
bcdcbbc7	221	* information.
ef873947 D	222	*/
	223	int weight;
	224
	225	/*
	226	* This is a bit mask that gives the binding relation between this
	227	* thermal zone and cdev, for a particular trip point.
eaf7b460	228	* See Documentation/driver-api/thermal/sysfs-api.rst for more information.
ef873947 D	229	*/
ef873947 D	230	int trip_mask;
a8892d83 EV	231
	232	/*
	233	* This is an array of cooling state limits. Must have exactly
	234	* 2 * thermal_zone.number_of_trip_points. It is an array consisting
	235	* of tuples <lower-state upper-state> of state limits. Each trip
	236	* will be associated with one state limit tuple when binding.
	237	* A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
	238	* on all trips.
	239	*/
	240	unsigned long *binding_limits;
ef873947 D	241	int (match) (struct thermal_zone_device tz,
	242	struct thermal_cooling_device *cdev);
	243	};
	244
	245	/* Structure to define Thermal Zone parameters */
	246	struct thermal_zone_params {
a4a15485	247	char governor_name[THERMAL_NAME_LENGTH];
ccba4ffd EV	248
	249	/*
	250	* a boolean to indicate if the thermal to hwmon sysfs interface
	251	* is required. when no_hwmon == false, a hwmon sysfs interface
	252	* will be created. when no_hwmon == true, nothing will be done
	253	*/
	254	bool no_hwmon;
	255
ef873947 D	256	int num_tbps; /* Number of tbp entries */
ef873947 D	257	struct thermal_bind_params *tbp;
6b775e87 JM	258
	259	/*
	260	* Sustainable power (heat) that this thermal zone can dissipate in
	261	* mW
	262	*/
	263	u32 sustainable_power;
	264
	265	/*
	266	* Proportional parameter of the PID controller when
	267	* overshooting (i.e., when temperature is below the target)
	268	*/
	269	s32 k_po;
	270
	271	/*
	272	* Proportional parameter of the PID controller when
	273	* undershooting
	274	*/
	275	s32 k_pu;
	276
	277	/* Integral parameter of the PID controller */
	278	s32 k_i;
	279
	280	/* Derivative parameter of the PID controller */
	281	s32 k_d;
	282
	283	/* threshold below which the error is no longer accumulated */
	284	s32 integral_cutoff;
9d0be7f4 EV	285
	286	/*
	287	* @slope: slope of a linear temperature adjustment curve.
	288	* Used by thermal zone drivers.
	289	*/
	290	int slope;
	291	/*
	292	* @offset: offset of a linear temperature adjustment curve.
	293	* Used by thermal zone drivers (default 0).
	294	*/
	295	int offset;
ef873947 D	296	};
ef873947 D	297
23064088	298	/* Function declarations */
4e5e4705	299	#ifdef CONFIG_THERMAL_OF
3fd6d6e2 DL	300	struct thermal_zone_device thermal_of_zone_register(struct device_node sensor, int id, void *data,
	301	const struct thermal_zone_device_ops *ops);
	302
	303	struct thermal_zone_device devm_thermal_of_zone_register(struct device dev, int id, void *data,
	304	const struct thermal_zone_device_ops *ops);
	305
	306	void thermal_of_zone_unregister(struct thermal_zone_device *tz);
	307
	308	void devm_thermal_of_zone_unregister(struct device dev, struct thermal_zone_device tz);
	309
f59ac19b DL	310	void thermal_of_zone_unregister(struct thermal_zone_device *tz);
f59ac19b DL	311
4e5e4705	312	#else
4e5e4705	313	static inline
f59ac19b DL	314	struct thermal_zone_device thermal_of_zone_register(struct device_node sensor, int id, void *data,
f59ac19b DL	315	const struct thermal_zone_device_ops *ops)
4e5e4705	316	{
f59ac19b	317	return ERR_PTR(-ENOTSUPP);
4e5e4705 EV	318	}
4e5e4705 EV	319
f59ac19b DL	320	static inline
	321	struct thermal_zone_device devm_thermal_of_zone_register(struct device dev, int id, void *data,
	322	const struct thermal_zone_device_ops *ops)
e498b498	323	{
f59ac19b	324	return ERR_PTR(-ENOTSUPP);
e498b498 LD	325	}
e498b498 LD	326
3fd6d6e2 DL	327	static inline void thermal_of_zone_unregister(struct thermal_zone_device *tz)
	328	{
	329	}
	330
f59ac19b DL	331	static inline void devm_thermal_of_zone_unregister(struct device *dev,
f59ac19b DL	332	struct thermal_zone_device *tz)
3fd6d6e2 DL	333	{
3fd6d6e2 DL	334	}
4e5e4705	335	#endif
12ca7188	336
60518260	337	#ifdef CONFIG_THERMAL
4b1bf587	338	struct thermal_zone_device thermal_zone_device_register(const char , int, int,
4e5e4705	339	void , struct thermal_zone_device_ops ,
6b775e87	340	struct thermal_zone_params *, int, int);
fae11de5	341
203d3d4a ZR	342	void thermal_zone_device_unregister(struct thermal_zone_device *);
203d3d4a ZR	343
fae11de5 DL	344	struct thermal_zone_device *
	345	thermal_zone_device_register_with_trips(const char , struct thermal_trip , int, int,
	346	void , struct thermal_zone_device_ops ,
	347	struct thermal_zone_params *, int, int);
	348
203d3d4a	349	int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
9d99842f	350	struct thermal_cooling_device *,
6cd9e9f6 KS	351	unsigned long, unsigned long,
6cd9e9f6 KS	352	unsigned int);
203d3d4a ZR	353	int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
203d3d4a ZR	354	struct thermal_cooling_device *);
0e70f466 SP	355	void thermal_zone_device_update(struct thermal_zone_device *,
0e70f466 SP	356	enum thermal_notify_event);
23064088	357
f991de53 JFD	358	struct thermal_cooling_device thermal_cooling_device_register(const char ,
f991de53 JFD	359	void , const struct thermal_cooling_device_ops );
a116b5d4	360	struct thermal_cooling_device *
f991de53	361	thermal_of_cooling_device_register(struct device_node np, const char , void *,
a116b5d4	362	const struct thermal_cooling_device_ops *);
b4ab114c GR	363	struct thermal_cooling_device *
	364	devm_thermal_of_cooling_device_register(struct device *dev,
	365	struct device_node *np,
	366	char type, void devdata,
	367	const struct thermal_cooling_device_ops *ops);
203d3d4a	368	void thermal_cooling_device_unregister(struct thermal_cooling_device *);
63c4d919	369	struct thermal_zone_device thermal_zone_get_zone_by_name(const char name);
17e8351a	370	int thermal_zone_get_temp(struct thermal_zone_device tz, int temp);
4a7069a3 RN	371	int thermal_zone_get_slope(struct thermal_zone_device *tz);
4a7069a3 RN	372	int thermal_zone_get_offset(struct thermal_zone_device *tz);
af06216a	373
ac5d9ecc AP	374	int thermal_zone_device_enable(struct thermal_zone_device *tz);
ac5d9ecc AP	375	int thermal_zone_device_disable(struct thermal_zone_device *tz);
d7203eed	376	void thermal_zone_device_critical(struct thermal_zone_device *tz);
12ca7188 NM	377	#else
	378	static inline struct thermal_zone_device *thermal_zone_device_register(
	379	const char type, int trips, int mask, void devdata,
	380	struct thermal_zone_device_ops *ops,
023b7b07	381	struct thermal_zone_params *tzp,
12ca7188 NM	382	int passive_delay, int polling_delay)
	383	{ return ERR_PTR(-ENODEV); }
	384	static inline void thermal_zone_device_unregister(
	385	struct thermal_zone_device *tz)
	386	{ }
12ca7188	387	static inline struct thermal_cooling_device *
fb836107	388	thermal_cooling_device_register(const char type, void devdata,
12ca7188 NM	389	const struct thermal_cooling_device_ops *ops)
	390	{ return ERR_PTR(-ENODEV); }
	391	static inline struct thermal_cooling_device *
	392	thermal_of_cooling_device_register(struct device_node *np,
fb836107 AB	393	const char type, void devdata,
fb836107 AB	394	const struct thermal_cooling_device_ops *ops)
12ca7188	395	{ return ERR_PTR(-ENODEV); }
b4ab114c GR	396	static inline struct thermal_cooling_device *
	397	devm_thermal_of_cooling_device_register(struct device *dev,
	398	struct device_node *np,
	399	char type, void devdata,
	400	const struct thermal_cooling_device_ops *ops)
	401	{
	402	return ERR_PTR(-ENODEV);
	403	}
12ca7188 NM	404	static inline void thermal_cooling_device_unregister(
	405	struct thermal_cooling_device *cdev)
	406	{ }
	407	static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
	408	const char *name)
	409	{ return ERR_PTR(-ENODEV); }
	410	static inline int thermal_zone_get_temp(
17e8351a	411	struct thermal_zone_device tz, int temp)
12ca7188	412	{ return -ENODEV; }
4a7069a3 RN	413	static inline int thermal_zone_get_slope(
	414	struct thermal_zone_device *tz)
	415	{ return -ENODEV; }
	416	static inline int thermal_zone_get_offset(
	417	struct thermal_zone_device *tz)
	418	{ return -ENODEV; }
f0129c23	419
ac5d9ecc AP	420	static inline int thermal_zone_device_enable(struct thermal_zone_device *tz)
	421	{ return -ENODEV; }
	422
	423	static inline int thermal_zone_device_disable(struct thermal_zone_device *tz)
	424	{ return -ENODEV; }
12ca7188 NM	425	#endif /* CONFIG_THERMAL */
12ca7188 NM	426
a0dd25b2	427	#endif /* __THERMAL_H__ */