[mirror_ubuntu-zesty-kernel.git] / include / linux / thermal.h

/*
 *  thermal.h  ($Revision: 0 $)
 *
 *  Copyright (C) 2008  Intel Corp
 *  Copyright (C) 2008  Zhang Rui <rui.zhang@intel.com>
 *  Copyright (C) 2008  Sujith Thomas <sujith.thomas@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#ifndef __THERMAL_H__
#define __THERMAL_H__

#include <linux/idr.h>
#include <linux/device.h>
#include <linux/workqueue.h>

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,
};

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 (*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);
};

#define THERMAL_NO_LIMIT -1UL /* no upper/lower limit requirement */

#define THERMAL_TRIPS_NONE -1
#define THERMAL_MAX_TRIPS 12
#define THERMAL_NAME_LENGTH 20
struct thermal_cooling_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
	void *devdata;
	const struct thermal_cooling_device_ops *ops;
	struct list_head node;
};

#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)

struct thermal_attr {
	struct device_attribute attr;
	char name[THERMAL_NAME_LENGTH];
};

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 tc1;
	int tc2;
	int passive_delay;
	int polling_delay;
	int last_temperature;
	bool passive;
	unsigned int forced_passive;
	const struct thermal_zone_device_ops *ops;
	struct list_head cooling_devices;
	struct idr idr;
	struct mutex lock;	/* protect cooling devices list */
	struct list_head node;
	struct delayed_work poll_queue;
};
/* Adding event notification support elements */
#define THERMAL_GENL_FAMILY_NAME                "thermal_event"
#define THERMAL_GENL_VERSION                    0x01
#define THERMAL_GENL_MCAST_GROUP_NAME           "thermal_mc_group"

enum events {
	THERMAL_AUX0,
	THERMAL_AUX1,
	THERMAL_CRITICAL,
	THERMAL_DEV_FAULT,
};

struct thermal_genl_event {
	u32 orig;
	enum events event;
};
/* attributes of thermal_genl_family */
enum {
	THERMAL_GENL_ATTR_UNSPEC,
	THERMAL_GENL_ATTR_EVENT,
	__THERMAL_GENL_ATTR_MAX,
};
#define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)

/* commands supported by the thermal_genl_family */
enum {
	THERMAL_GENL_CMD_UNSPEC,
	THERMAL_GENL_CMD_EVENT,
	__THERMAL_GENL_CMD_MAX,
};
#define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)

struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
		void *, const struct thermal_zone_device_ops *, int tc1,
		int tc2, int passive_freq, int polling_freq);
void thermal_zone_device_unregister(struct thermal_zone_device *);

int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
				     struct thermal_cooling_device *,
				     unsigned long, unsigned long);
int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
				       struct thermal_cooling_device *);
void thermal_zone_device_update(struct thermal_zone_device *);
struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
		const struct thermal_cooling_device_ops *);
void thermal_cooling_device_unregister(struct thermal_cooling_device *);

#ifdef CONFIG_NET
extern int thermal_generate_netlink_event(u32 orig, enum events event);
#else
static inline int thermal_generate_netlink_event(u32 orig, 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
	28	#include <linux/idr.h>
	29	#include <linux/device.h>
b1569e99	30	#include <linux/workqueue.h>
203d3d4a ZR	31
	32	struct thermal_zone_device;
	33	struct thermal_cooling_device;
	34
6503e5df MG	35	enum thermal_device_mode {
	36	THERMAL_DEVICE_DISABLED = 0,
	37	THERMAL_DEVICE_ENABLED,
	38	};
	39
	40	enum thermal_trip_type {
	41	THERMAL_TRIP_ACTIVE = 0,
	42	THERMAL_TRIP_PASSIVE,
	43	THERMAL_TRIP_HOT,
	44	THERMAL_TRIP_CRITICAL,
	45	};
	46
203d3d4a ZR	47	struct thermal_zone_device_ops {
	48	int (bind) (struct thermal_zone_device ,
	49	struct thermal_cooling_device *);
	50	int (unbind) (struct thermal_zone_device ,
	51	struct thermal_cooling_device *);
6503e5df MG	52	int (get_temp) (struct thermal_zone_device , unsigned long *);
	53	int (get_mode) (struct thermal_zone_device ,
	54	enum thermal_device_mode *);
	55	int (set_mode) (struct thermal_zone_device ,
	56	enum thermal_device_mode);
	57	int (get_trip_type) (struct thermal_zone_device , int,
	58	enum thermal_trip_type *);
	59	int (get_trip_temp) (struct thermal_zone_device , int,
	60	unsigned long *);
c56f5c03 D	61	int (set_trip_temp) (struct thermal_zone_device , int,
c56f5c03 D	62	unsigned long);
27365a6c D	63	int (get_trip_hyst) (struct thermal_zone_device , int,
	64	unsigned long *);
	65	int (set_trip_hyst) (struct thermal_zone_device , int,
	66	unsigned long);
9ec732ff	67	int (get_crit_temp) (struct thermal_zone_device , unsigned long *);
b1569e99 MG	68	int (notify) (struct thermal_zone_device , int,
b1569e99 MG	69	enum thermal_trip_type);
203d3d4a ZR	70	};
	71
	72	struct thermal_cooling_device_ops {
6503e5df MG	73	int (get_max_state) (struct thermal_cooling_device , unsigned long *);
	74	int (get_cur_state) (struct thermal_cooling_device , unsigned long *);
	75	int (set_cur_state) (struct thermal_cooling_device , unsigned long);
203d3d4a ZR	76	};
203d3d4a ZR	77
9d99842f ZR	78	#define THERMAL_NO_LIMIT -1UL /* no upper/lower limit requirement */
9d99842f ZR	79
203d3d4a	80	#define THERMAL_TRIPS_NONE -1
5f1a3f2a	81	#define THERMAL_MAX_TRIPS 12
203d3d4a ZR	82	#define THERMAL_NAME_LENGTH 20
	83	struct thermal_cooling_device {
	84	int id;
	85	char type[THERMAL_NAME_LENGTH];
	86	struct device device;
	87	void *devdata;
5b275ce2	88	const struct thermal_cooling_device_ops *ops;
203d3d4a ZR	89	struct list_head node;
	90	};
	91
041d4bbf ZR	92	#define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \
	93	((long)t-2732+5)/10 : ((long)t-2732-5)/10)
	94	#define CELSIUS_TO_KELVIN(t) ((t)*10+2732)
	95
c56f5c03 D	96	struct thermal_attr {
	97	struct device_attribute attr;
	98	char name[THERMAL_NAME_LENGTH];
	99	};
	100
203d3d4a ZR	101	struct thermal_zone_device {
	102	int id;
	103	char type[THERMAL_NAME_LENGTH];
	104	struct device device;
c56f5c03 D	105	struct thermal_attr *trip_temp_attrs;
c56f5c03 D	106	struct thermal_attr *trip_type_attrs;
27365a6c	107	struct thermal_attr *trip_hyst_attrs;
203d3d4a ZR	108	void *devdata;
203d3d4a ZR	109	int trips;
b1569e99 MG	110	int tc1;
	111	int tc2;
	112	int passive_delay;
	113	int polling_delay;
	114	int last_temperature;
	115	bool passive;
03a971a2	116	unsigned int forced_passive;
5b275ce2	117	const struct thermal_zone_device_ops *ops;
203d3d4a ZR	118	struct list_head cooling_devices;
	119	struct idr idr;
	120	struct mutex lock; /* protect cooling devices list */
	121	struct list_head node;
b1569e99	122	struct delayed_work poll_queue;
203d3d4a	123	};
4cb18728 D	124	/* Adding event notification support elements */
	125	#define THERMAL_GENL_FAMILY_NAME "thermal_event"
	126	#define THERMAL_GENL_VERSION 0x01
	127	#define THERMAL_GENL_MCAST_GROUP_NAME "thermal_mc_group"
	128
	129	enum events {
	130	THERMAL_AUX0,
	131	THERMAL_AUX1,
	132	THERMAL_CRITICAL,
	133	THERMAL_DEV_FAULT,
	134	};
	135
	136	struct thermal_genl_event {
	137	u32 orig;
	138	enum events event;
	139	};
	140	/* attributes of thermal_genl_family */
	141	enum {
	142	THERMAL_GENL_ATTR_UNSPEC,
	143	THERMAL_GENL_ATTR_EVENT,
	144	__THERMAL_GENL_ATTR_MAX,
	145	};
	146	#define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
	147
	148	/* commands supported by the thermal_genl_family */
	149	enum {
	150	THERMAL_GENL_CMD_UNSPEC,
	151	THERMAL_GENL_CMD_EVENT,
	152	__THERMAL_GENL_CMD_MAX,
	153	};
	154	#define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
203d3d4a	155
4b1bf587	156	struct thermal_zone_device thermal_zone_device_register(const char , int, int,
c56f5c03 D	157	void , const struct thermal_zone_device_ops , int tc1,
c56f5c03 D	158	int tc2, int passive_freq, int polling_freq);
203d3d4a ZR	159	void thermal_zone_device_unregister(struct thermal_zone_device *);
	160
	161	int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
9d99842f ZR	162	struct thermal_cooling_device *,
9d99842f ZR	163	unsigned long, unsigned long);
203d3d4a ZR	164	int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
203d3d4a ZR	165	struct thermal_cooling_device *);
b1569e99	166	void thermal_zone_device_update(struct thermal_zone_device *);
203d3d4a	167	struct thermal_cooling_device thermal_cooling_device_register(char , void *,
5b275ce2	168	const struct thermal_cooling_device_ops *);
203d3d4a	169	void thermal_cooling_device_unregister(struct thermal_cooling_device *);
af06216a RW	170
af06216a RW	171	#ifdef CONFIG_NET
2d58d7ea	172	extern int thermal_generate_netlink_event(u32 orig, enum events event);
af06216a	173	#else
2d58d7ea	174	static inline int thermal_generate_netlink_event(u32 orig, enum events event)
af06216a RW	175	{
	176	return 0;
	177	}
	178	#endif
203d3d4a	179
a0dd25b2	180	#endif /* __THERMAL_H__ */