[deliverable/linux.git] / drivers / thermal / thermal_core.h

/*
 *  thermal_core.h
 *
 *  Copyright (C) 2012  Intel Corp
 *  Author: Durgadoss R <durgadoss.r@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_CORE_H__
#define __THERMAL_CORE_H__

#include <linux/device.h>
#include <linux/thermal.h>

/* Initial state of a cooling device during binding */
#define THERMAL_NO_TARGET -1UL

/*
 * This structure is used to describe the behavior of
 * a certain cooling device on a certain trip point
 * in a certain thermal zone
 */
struct thermal_instance {
	int id;
	char name[THERMAL_NAME_LENGTH];
	struct thermal_zone_device *tz;
	struct thermal_cooling_device *cdev;
	int trip;
	bool initialized;
	unsigned long upper;	/* Highest cooling state for this trip point */
	unsigned long lower;	/* Lowest cooling state for this trip point */
	unsigned long target;	/* expected cooling state */
	char attr_name[THERMAL_NAME_LENGTH];
	struct device_attribute attr;
	char weight_attr_name[THERMAL_NAME_LENGTH];
	struct device_attribute weight_attr;
	struct list_head tz_node; /* node in tz->thermal_instances */
	struct list_head cdev_node; /* node in cdev->thermal_instances */
	unsigned int weight; /* The weight of the cooling device */
};

int thermal_register_governor(struct thermal_governor *);
void thermal_unregister_governor(struct thermal_governor *);

#ifdef CONFIG_THERMAL_GOV_STEP_WISE
int thermal_gov_step_wise_register(void);
void thermal_gov_step_wise_unregister(void);
#else
static inline int thermal_gov_step_wise_register(void) { return 0; }
static inline void thermal_gov_step_wise_unregister(void) {}
#endif /* CONFIG_THERMAL_GOV_STEP_WISE */

#ifdef CONFIG_THERMAL_GOV_FAIR_SHARE
int thermal_gov_fair_share_register(void);
void thermal_gov_fair_share_unregister(void);
#else
static inline int thermal_gov_fair_share_register(void) { return 0; }
static inline void thermal_gov_fair_share_unregister(void) {}
#endif /* CONFIG_THERMAL_GOV_FAIR_SHARE */

#ifdef CONFIG_THERMAL_GOV_BANG_BANG
int thermal_gov_bang_bang_register(void);
void thermal_gov_bang_bang_unregister(void);
#else
static inline int thermal_gov_bang_bang_register(void) { return 0; }
static inline void thermal_gov_bang_bang_unregister(void) {}
#endif /* CONFIG_THERMAL_GOV_BANG_BANG */

#ifdef CONFIG_THERMAL_GOV_USER_SPACE
int thermal_gov_user_space_register(void);
void thermal_gov_user_space_unregister(void);
#else
static inline int thermal_gov_user_space_register(void) { return 0; }
static inline void thermal_gov_user_space_unregister(void) {}
#endif /* CONFIG_THERMAL_GOV_USER_SPACE */

#ifdef CONFIG_THERMAL_GOV_POWER_ALLOCATOR
int thermal_gov_power_allocator_register(void);
void thermal_gov_power_allocator_unregister(void);
#else
static inline int thermal_gov_power_allocator_register(void) { return 0; }
static inline void thermal_gov_power_allocator_unregister(void) {}
#endif /* CONFIG_THERMAL_GOV_POWER_ALLOCATOR */

/* device tree support */
#ifdef CONFIG_THERMAL_OF
int of_parse_thermal_zones(void);
void of_thermal_destroy_zones(void);
int of_thermal_get_ntrips(struct thermal_zone_device *);
bool of_thermal_is_trip_valid(struct thermal_zone_device *, int);
const struct thermal_trip *
of_thermal_get_trip_points(struct thermal_zone_device *);
#else
static inline int of_parse_thermal_zones(void) { return 0; }
static inline void of_thermal_destroy_zones(void) { }
static inline int of_thermal_get_ntrips(struct thermal_zone_device *tz)
{
	return 0;
}
static inline bool of_thermal_is_trip_valid(struct thermal_zone_device *tz,
					    int trip)
{
	return false;
}
static inline const struct thermal_trip *
of_thermal_get_trip_points(struct thermal_zone_device *tz)
{
	return NULL;
}
#endif

#endif /* __THERMAL_CORE_H__ */
Commit	Line	Data
71350db4 D	1	/*
	2	* thermal_core.h
	3	*
	4	* Copyright (C) 2012 Intel Corp
	5	* Author: Durgadoss R <durgadoss.r@intel.com>
	6	*
	7	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; version 2 of the License.
	11	*
	12	* This program is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; if not, write to the Free Software Foundation, Inc.,
	19	* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
	20	*
	21	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	22	*/
	23
	24	#ifndef __THERMAL_CORE_H__
	25	#define __THERMAL_CORE_H__
	26
	27	#include <linux/device.h>
	28	#include <linux/thermal.h>
	29
	30	/* Initial state of a cooling device during binding */
	31	#define THERMAL_NO_TARGET -1UL
	32
	33	/*
	34	* This structure is used to describe the behavior of
	35	* a certain cooling device on a certain trip point
	36	* in a certain thermal zone
	37	*/
	38	struct thermal_instance {
	39	int id;
	40	char name[THERMAL_NAME_LENGTH];
	41	struct thermal_zone_device *tz;
	42	struct thermal_cooling_device *cdev;
	43	int trip;
bb431ba2	44	bool initialized;
71350db4 D	45	unsigned long upper; /* Highest cooling state for this trip point */
	46	unsigned long lower; /* Lowest cooling state for this trip point */
	47	unsigned long target; /* expected cooling state */
	48	char attr_name[THERMAL_NAME_LENGTH];
	49	struct device_attribute attr;
db916513 JM	50	char weight_attr_name[THERMAL_NAME_LENGTH];
db916513 JM	51	struct device_attribute weight_attr;
71350db4 D	52	struct list_head tz_node; /* node in tz->thermal_instances */
71350db4 D	53	struct list_head cdev_node; /* node in cdev->thermal_instances */
6cd9e9f6	54	unsigned int weight; /* The weight of the cooling device */
71350db4 D	55	};
71350db4 D	56
80a26a5c ZR	57	int thermal_register_governor(struct thermal_governor *);
	58	void thermal_unregister_governor(struct thermal_governor *);
	59
	60	#ifdef CONFIG_THERMAL_GOV_STEP_WISE
	61	int thermal_gov_step_wise_register(void);
	62	void thermal_gov_step_wise_unregister(void);
	63	#else
	64	static inline int thermal_gov_step_wise_register(void) { return 0; }
	65	static inline void thermal_gov_step_wise_unregister(void) {}
	66	#endif /* CONFIG_THERMAL_GOV_STEP_WISE */
	67
	68	#ifdef CONFIG_THERMAL_GOV_FAIR_SHARE
	69	int thermal_gov_fair_share_register(void);
	70	void thermal_gov_fair_share_unregister(void);
	71	#else
	72	static inline int thermal_gov_fair_share_register(void) { return 0; }
	73	static inline void thermal_gov_fair_share_unregister(void) {}
	74	#endif /* CONFIG_THERMAL_GOV_FAIR_SHARE */
	75
e4dbf98f PF	76	#ifdef CONFIG_THERMAL_GOV_BANG_BANG
	77	int thermal_gov_bang_bang_register(void);
	78	void thermal_gov_bang_bang_unregister(void);
	79	#else
	80	static inline int thermal_gov_bang_bang_register(void) { return 0; }
	81	static inline void thermal_gov_bang_bang_unregister(void) {}
	82	#endif /* CONFIG_THERMAL_GOV_BANG_BANG */
	83
80a26a5c ZR	84	#ifdef CONFIG_THERMAL_GOV_USER_SPACE
	85	int thermal_gov_user_space_register(void);
	86	void thermal_gov_user_space_unregister(void);
	87	#else
	88	static inline int thermal_gov_user_space_register(void) { return 0; }
	89	static inline void thermal_gov_user_space_unregister(void) {}
	90	#endif /* CONFIG_THERMAL_GOV_USER_SPACE */
	91
6b775e87 JM	92	#ifdef CONFIG_THERMAL_GOV_POWER_ALLOCATOR
	93	int thermal_gov_power_allocator_register(void);
	94	void thermal_gov_power_allocator_unregister(void);
	95	#else
	96	static inline int thermal_gov_power_allocator_register(void) { return 0; }
	97	static inline void thermal_gov_power_allocator_unregister(void) {}
	98	#endif /* CONFIG_THERMAL_GOV_POWER_ALLOCATOR */
	99
4e5e4705 EV	100	/* device tree support */
	101	#ifdef CONFIG_THERMAL_OF
	102	int of_parse_thermal_zones(void);
	103	void of_thermal_destroy_zones(void);
08dab66e	104	int of_thermal_get_ntrips(struct thermal_zone_device *);
a9bf2cc4	105	bool of_thermal_is_trip_valid(struct thermal_zone_device *, int);
ebc3193a	106	const struct thermal_trip *
ce8be778	107	of_thermal_get_trip_points(struct thermal_zone_device *);
4e5e4705 EV	108	#else
	109	static inline int of_parse_thermal_zones(void) { return 0; }
	110	static inline void of_thermal_destroy_zones(void) { }
08dab66e LM	111	static inline int of_thermal_get_ntrips(struct thermal_zone_device *tz)
	112	{
	113	return 0;
	114	}
a9bf2cc4 LM	115	static inline bool of_thermal_is_trip_valid(struct thermal_zone_device *tz,
	116	int trip)
	117	{
ce1d9491	118	return false;
a9bf2cc4	119	}
ebc3193a	120	static inline const struct thermal_trip *
ce8be778 LM	121	of_thermal_get_trip_points(struct thermal_zone_device *tz)
	122	{
	123	return NULL;
	124	}
4e5e4705 EV	125	#endif
4e5e4705 EV	126
71350db4	127	#endif /* __THERMAL_CORE_H__ */